Skip to content

Latest commit

 

History

History
151 lines (106 loc) · 3.89 KB

about_PSDocs_Azure_Configuration.md

File metadata and controls

151 lines (106 loc) · 3.89 KB
Raw

PSDocs_Azure_Configuration

about_PSDocs_Azure_Configuration

SHORT DESCRIPTION

Describes PSDocs configuration options specific to PSDocs.Azure.

LONG DESCRIPTION

PSDocs exposes configuration options that can be used to customize execution of document generation. This topic describes what configuration options are available.

PSDocs configuration options can be specified by setting the configuration option in ps-docs.yaml. Additionally, configuration options can be configured in a baseline or set at runtime. For details of setting configuration options see PSDocs options

The following configurations options are available for use:

AZURE_SNIPPET_SKIP_DEFAULT_VALUE_FN

This configuration option determines if parameters with a function defaultValue are included in snippets. By default, a parameters with a function default value are not included in snippets. i.e. If a parameter default value is set to [resourceGroup.location] it is not included in snippets.

Syntax:

configuration:
  AZURE_SNIPPET_SKIP_DEFAULT_VALUE_FN: bool # Either true or false

Default:

# YAML: The default AZURE_SNIPPET_SKIP_DEFAULT_VALUE_FN configuration option
configuration:
  AZURE_SNIPPET_SKIP_DEFAULT_VALUE_FN: true

Example:

# YAML: Include parameters with a function default value in snippets.
configuration:
  AZURE_SNIPPET_SKIP_DEFAULT_VALUE_FN: false

AZURE_SNIPPET_SKIP_OPTIONAL_PARAMETER

This configuration option determines optional parameters are included in snippets. By default, optional parameters are included in snippets. To ignore optional parameter, set this option to false.

Syntax:

configuration:
  AZURE_SNIPPET_SKIP_OPTIONAL_PARAMETER: bool # Either true or false

Default:

# YAML: The default AZURE_SNIPPET_SKIP_OPTIONAL_PARAMETER configuration option
configuration:
  AZURE_SNIPPET_SKIP_OPTIONAL_PARAMETER: false

Example:

# YAML: Do not include optional parameters in snippets
configuration:
  AZURE_SNIPPET_SKIP_OPTIONAL_PARAMETER: true

AZURE_USE_PARAMETER_FILE_SNIPPET

This configuration option determines if a parameter file snippet is added to documentation. By default, a snippet is generated. To prevent a parameter file snippet being generated, set this option to false.

Syntax:

configuration:
  AZURE_USE_PARAMETER_FILE_SNIPPET: bool # Either true or false

Default:

# YAML: The default AZURE_USE_PARAMETER_FILE_SNIPPET configuration option
configuration:
  AZURE_USE_PARAMETER_FILE_SNIPPET: true

Example:

# YAML: Prevent parameter file snippet from being generated
configuration:
  AZURE_USE_PARAMETER_FILE_SNIPPET: false

AZURE_USE_COMMAND_LINE_SNIPPET

This configuration option determines if a command line snippet is added to documentation. By default, this command line snippet is not generated. To generate command line snippet, set this option to true.

Syntax:

configuration:
  AZURE_USE_COMMAND_LINE_SNIPPET: bool # Either true or false

Default:

# YAML: The default AZURE_USE_COMMAND_LINE_SNIPPET configuration option is to disable generation
configuration:
  AZURE_USE_COMMAND_LINE_SNIPPET: false

Example:

# YAML: To enable command line snippet
configuration:
  AZURE_USE_COMMAND_LINE_SNIPPET: true

NOTE

An online version of this document is available at https://github.com/Azure/PSDocs.Azure/blob/main/docs/concepts/en-US/about_PSDocs_Azure_Configuration.md.

KEYWORDS

  • Configuration
  • Document
  • Snippet