az automation configuration

Reference

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
                                   --configuration-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

--description

Gets or sets the description of the configuration.

--location

Gets or sets the location of the resource.

--log-progress

Gets or sets progress log option.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--log-verbose

Gets or sets verbose log option.

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.

--source

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

--source-hash

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

--source-type

Gets or sets the content source type.

Accepted values: embeddedContent, uri

--source-version

Gets or sets the version of the content.

--tags

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az automation configuration delete

Delete the dsc configuration identified by configuration name.

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

Examples

Delete the DSC Configuration

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

Optional Parameters

--account --automation-account-name

The name of the automation account.

--configuration-name --name -n

The configuration name.

--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.

--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az automation configuration list

List a list of configurations.

az automation configuration list --account
                                 --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

--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.

--next-token

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

--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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az automation configuration show

Get the configuration identified by configuration name.

az automation configuration show [--account]
                                 [--configuration-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

--account --automation-account-name

The name of the automation account.

--configuration-name --name -n

The configuration name.

--ids

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az automation configuration show-content

Get the configuration script identified by configuration name.

az automation configuration show-content [--account]
                                         [--configuration-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

--account --automation-account-name

The name of the automation account.

--configuration-name --name -n

The configuration name.

--ids

--resource-group -g

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

az automation configuration update

Update the configuration identified by configuration name.

az automation configuration update [--account]
                                   [--add]
                                   [--configuration-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

--account --automation-account-name

The name of the automation account.

--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>.

--configuration-name --name -n

The configuration name.

--description

Gets or sets the description of the configuration.

--force-string

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--ids

--location

Gets or sets the location of the resource.

--log-progress

Gets or sets progress log option.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

--log-verbose

Gets or sets verbose log option.

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.

--remove

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

--resource-group -g

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

--set

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

--source

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

--source-hash

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

--source-type

Gets or sets the content source type.

Accepted values: embeddedContent, uri

--source-version

Gets or sets the version of the content.

--subscription

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

--tags

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--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.

Share via

az automation configuration

Commands

az automation configuration create

Examples

Required Parameters

Optional Parameters

az automation configuration delete

Examples

Optional Parameters

az automation configuration list

Examples

Required Parameters

Optional Parameters

az automation configuration show

Examples

Optional Parameters

az automation configuration show-content

Examples

Optional Parameters

az automation configuration update

Examples

Optional Parameters

Additional resources