แชร์ผ่าน

az automation configuration

Note

This reference is part of the automation extension for the Azure CLI (version 2.55.0 or higher). The extension will automatically install the first time you run an az automation configuration command. Learn more about extensions.

Manage Dsc Configuration.

Commands

Name Description Type Status
az automation configuration create

Create the configuration identified by configuration name.

 Extension GA
az automation configuration delete

Delete the dsc configuration identified by configuration name.

 Extension GA
az automation configuration list

List a list of configurations.

 Extension GA
az automation configuration show

Get the configuration identified by configuration name.

 Extension GA
az automation configuration show-content

Get the configuration script identified by configuration name.

 Extension GA
az automation configuration update

Update the configuration identified by configuration name.

 Extension GA

az automation configuration create

Create the configuration identified by configuration name.

az automation configuration create --account --automation-account-name
                                   --configuration-name --name
                                   --resource-group
                                   [--description]
                                   [--location]
                                   [--log-progress {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--log-verbose {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--parameters]
                                   [--source]
                                   [--source-hash]
                                   [--source-type {embeddedContent, uri}]
                                   [--source-version]
                                   [--tags]

Examples

Create DSC Configuration that setups a server

az automation configuration create -g rg --automation-account-name myAutomationAccount -n SetupServer --location westus2 --source-type embeddedContent --source "Configuration SetupServer {
Node localhost {
WindowsFeature IIS {
Name = "Web-Server";
Ensure = "Present"
}
}
}"

Required Parameters

--account --automation-account-name

The name of the automation account.

--configuration-name --name -n

The create or update parameters for configuration.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--description

Gets or sets the description of the configuration.

Property Value
Parameter group: Properties Arguments
--location

Gets or sets the location of the resource.

Property Value
Parameter group: Parameters Arguments
--log-progress

Gets or sets progress log option.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--log-verbose

Gets or sets verbose log option.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--parameters

Gets or sets the configuration parameters. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--source

Gets or sets the value of the content. This is based on the content source type.

Property Value
Parameter group: Source Arguments
--source-hash

Gets or sets the hash. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Source Arguments
--source-type

Gets or sets the content source type.

Property Value
Parameter group: Source Arguments
Accepted values: embeddedContent, uri
--source-version

Gets or sets the version of the content.

Property Value
Parameter group: Source Arguments
--tags

Gets or sets the tags attached to the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Parameters Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az automation configuration delete

Delete the dsc configuration identified by configuration name.

az automation configuration delete [--account --automation-account-name]
                                   [--configuration-name --name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Examples

Delete the DSC Configuration

az automation configuration list -g rg --automation-account-name myAutomationAccount

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account --automation-account-name

The name of the automation account.

Property Value
Parameter group: Resource Id Arguments
--configuration-name --name -n

The configuration name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az automation configuration list

List a list of configurations.

az automation configuration list --account --automation-account-name
                                 --resource-group
                                 [--filter]
                                 [--inlinecount]
                                 [--max-items]
                                 [--next-token]
                                 [--skip]
                                 [--top]

Examples

List all DSC Configurations

az automation configuration list -g rg --automation-account-name myAutomationAccount

Required Parameters

--account --automation-account-name

The name of the automation account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--filter

The filter to apply on the operation.

--inlinecount

Return total rows.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property Value
Parameter group: Pagination Arguments
--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property Value
Parameter group: Pagination Arguments
--skip

The number of rows to skip.

--top

The number of rows to take.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az automation configuration show

Get the configuration identified by configuration name.

az automation configuration show [--account --automation-account-name]
                                 [--configuration-name --name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Examples

Get the configuration by its name

az automation configuration show -g rg --automation-account-name myAutomationAccount -n SetupServer

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account --automation-account-name

The name of the automation account.

Property Value
Parameter group: Resource Id Arguments
--configuration-name --name -n

The configuration name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az automation configuration show-content

Get the configuration script identified by configuration name.

az automation configuration show-content [--account --automation-account-name]
                                         [--configuration-name --name]
                                         [--ids]
                                         [--resource-group]
                                         [--subscription]

Examples

Show the script content of DSC Configuration

az automation configuration show-content -g rg --automation-account-name myAutomationAccount -n SetupServer

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account --automation-account-name

The name of the automation account.

Property Value
Parameter group: Resource Id Arguments
--configuration-name --name -n

The configuration name.

Property Value
Parameter group: Resource Id Arguments
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az automation configuration update

Update the configuration identified by configuration name.

az automation configuration update [--account --automation-account-name]
                                   [--add]
                                   [--configuration-name --name]
                                   [--description]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--location]
                                   [--log-progress {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--log-verbose {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--parameters]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--source]
                                   [--source-hash]
                                   [--source-type {embeddedContent, uri}]
                                   [--source-version]
                                   [--subscription]
                                   [--tags]

Examples

Update script in DSC Configuration

az automation configuration update -g rg --automation-account-name myAutomationAccount -n SetupServer --location westus2 --source-type embeddedContent --source "Configuration SetupServer {
Node localhostServer {
WindowsFeature IIS {
Name = "Web-Server";
Ensure = "Present"
}
}
}"

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account --automation-account-name

The name of the automation account.

Property Value
Parameter group: Resource Id Arguments
--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property Value
Parameter group: Generic Update Arguments
--configuration-name --name -n

The configuration name.

Property Value
Parameter group: Resource Id Arguments
--description

Gets or sets the description of the configuration.

Property Value
Parameter group: Properties Arguments
--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property Value
Parameter group: Resource Id Arguments
--location

Gets or sets the location of the resource.

Property Value
Parameter group: Parameters Arguments
--log-progress

Gets or sets progress log option.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--log-verbose

Gets or sets verbose log option.

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--parameters

Gets or sets the configuration parameters. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Properties Arguments
--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property Value
Parameter group: Resource Id Arguments
--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property Value
Parameter group: Generic Update Arguments
--source

Gets or sets the value of the content. This is based on the content source type.

Property Value
Parameter group: Source Arguments
--source-hash

Gets or sets the hash. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Source Arguments
--source-type

Gets or sets the content source type.

Property Value
Parameter group: Source Arguments
Accepted values: embeddedContent, uri
--source-version

Gets or sets the version of the content.

Property Value
Parameter group: Source Arguments
--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property Value
Parameter group: Resource Id Arguments
--tags

Gets or sets the tags attached to the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property Value
Parameter group: Parameters Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False