Share via

az dnc controller

  • Preview

Note

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

Command group 'az dnc' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage controller with dnc.

Commands

Name Description Type Status
az dnc controller create

Create a dnc controller.

 Extension Preview
az dnc controller delete

Delete the DNC controller.

 Extension Preview
az dnc controller show

Get details about the specified dnc controller.

 Extension Preview
az dnc controller wait

Place the CLI in a waiting state until a condition is met.

 Extension Preview

az dnc controller create

Preview

Command group 'az dnc controller' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create a dnc controller.

az dnc controller create --name --resource-name
                         --resource-group
                         [--___location]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--purpose {prod, test}]
                         [--tags]

Examples

Create a controller

az dnc controller create --___location "West US" --resource-group "TestRG" --resource-name "testcontroller"

Create a test controller

az dnc controller create --___location "West US" --resource-group "TestRG" --resource-name "testcontroller" --purpose "test"

Required Parameters

--name --resource-name -n

The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.

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

--___location -l

Location of the resource.

Property Value
Parameter group: Parameters Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--purpose
Preview

The purpose of the dnc controller resource.

Property Value
Parameter group: Properties Arguments
Default value: prod
Accepted values: prod, test
--tags

The resource tags. 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 dnc controller delete

Preview

Command group 'az dnc controller' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the DNC controller.

az dnc controller delete [--ids]
                         [--name --resource-name]
                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                         [--resource-group]
                         [--subscription]
                         [--yes]

Examples

Delete a controller

az dnc controller delete --resource-group "TestRG" --resource-name "testcontroller"

Optional Parameters

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

--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
--name --resource-name -n

The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.

Property Value
Parameter group: Resource Id Arguments
--no-wait

Do not wait for the long-running operation to finish.

Property Value
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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 dnc controller show

Preview

Command group 'az dnc controller' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get details about the specified dnc controller.

az dnc controller show [--ids]
                       [--name --resource-name]
                       [--resource-group]
                       [--subscription]

Examples

Get details of a controller

az dnc controller show --resource-group "TestRG" --resource-name "testcontroller"

Optional Parameters

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

--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
--name --resource-name -n

The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.

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 dnc controller wait

Preview

Command group 'az dnc controller' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Place the CLI in a waiting state until a condition is met.

az dnc controller wait [--created]
                       [--custom]
                       [--deleted]
                       [--exists]
                       [--ids]
                       [--interval]
                       [--name --resource-name]
                       [--resource-group]
                       [--subscription]
                       [--timeout]
                       [--updated]

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--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
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --resource-name -n

The name of the resource. It must be a minimum of 3 characters, and a maximum of 63.

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

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
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