Share via

az vmware workload-network dns-zone

  • Reference

Note

This reference is part of the vmware extension for the Azure CLI (version 2.54.0 or higher). The extension will automatically install the first time you run an az vmware workload-network dns-zone command. Learn more about extensions.

Commands to manage a DNS Zone workload network.

Commands

Name Description Type Status
az vmware workload-network dns-zone create

Create a DNS zone by id in a private cloud workload network.

 Extension GA
az vmware workload-network dns-zone delete

Delete a DNS zone by id in a private cloud workload network.

 Extension GA
az vmware workload-network dns-zone list

List of DNS zones in a private cloud workload network.

 Extension GA
az vmware workload-network dns-zone show

Get a DNS zone by id in a private cloud workload network.

 Extension GA
az vmware workload-network dns-zone update

Update a DNS zone by id in a private cloud workload network.

 Extension GA
az vmware workload-network dns-zone wait

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

 Extension GA

az vmware workload-network dns-zone create

Create a DNS zone by id in a private cloud workload network.

az vmware workload-network dns-zone create --dns-zone
                                           --private-cloud
                                           --resource-group
                                           [--display-name]
                                           [--dns-server-ips]
                                           [--dns-services]
                                           [--domain]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--revision]
                                           [--source-ip]

Examples

Create a DNS zone by ID in a workload network.

az vmware workload-network dns-zone create --resource-group group1 --private-cloud cloud1 --dns-zone dnsZone1 --display-name dnsZone1 --domain domain1 --dns-server-ips 1.1.1.1 --source-ip 8.8.8.8 --dns-services 1 --revision 1

Required Parameters

--dns-zone --name -n

NSX DNS Zone identifier. Generally the same as the DNS Zone's display name.

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

--display-name

Display name of the DNS Zone.

--dns-server-ips

DNS Server IP array of the DNS Zone. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--dns-services

Number of DNS Services using the DNS zone.

--domain

Domain names of the DNS Zone. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

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

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

NSX revision number.

--source-ip

Source IP of the DNS Zone.

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 vmware workload-network dns-zone delete

Delete a DNS zone by id in a private cloud workload network.

az vmware workload-network dns-zone delete [--dns-zone]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--private-cloud]
                                           [--resource-group]
                                           [--subscription]
                                           [--yes]

Examples

Delete a DNS zone by ID in a workload network.

az vmware workload-network dns-zone delete --resource-group group1 --private-cloud cloud1 --dns-zone dnsZone1

Optional Parameters

--dns-zone --name -n

NSX DNS Zone identifier. Generally the same as the DNS Zone's display 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.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-cloud -c

Name of the private cloud.

--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 vmware workload-network dns-zone list

List of DNS zones in a private cloud workload network.

az vmware workload-network dns-zone list --private-cloud
                                         --resource-group
                                         [--max-items]
                                         [--next-token]

Examples

List of DNS zones in a workload network.

az vmware workload-network dns-zone list --resource-group group1 --private-cloud cloud1

Required Parameters

--private-cloud -c

Name of the private cloud.

--resource-group -g

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

Optional Parameters

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

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 vmware workload-network dns-zone show

Get a DNS zone by id in a private cloud workload network.

az vmware workload-network dns-zone show [--dns-zone]
                                         [--ids]
                                         [--private-cloud]
                                         [--resource-group]
                                         [--subscription]

Examples

Get a DNS zone by ID in a workload network.

az vmware workload-network dns-zone show --resource-group group1 --private-cloud cloud1 --dns-zone dnsZone1

Optional Parameters

--dns-zone --name -n

NSX DNS Zone identifier. Generally the same as the DNS Zone's display 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.

--private-cloud -c

Name of the private cloud.

--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 vmware workload-network dns-zone update

Update a DNS zone by id in a private cloud workload network.

az vmware workload-network dns-zone update [--add]
                                           [--display-name]
                                           [--dns-server-ips]
                                           [--dns-services]
                                           [--dns-zone]
                                           [--domain]
                                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--ids]
                                           [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                           [--private-cloud]
                                           [--remove]
                                           [--resource-group]
                                           [--revision]
                                           [--set]
                                           [--source-ip]
                                           [--subscription]

Examples

Update a DNS zone by ID in a workload network.

az vmware workload-network dns-zone update --resource-group group1 --private-cloud cloud1 --dns-zone dnsZone1 --display-name dnsZone1 --domain domain1 --dns-server-ips 1.1.1.1 --source-ip 8.8.8.8 --dns-services 1 --revision 1

Optional Parameters

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

--display-name

Display name of the DNS Zone.

--dns-server-ips

DNS Server IP array of the DNS Zone. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--dns-services

Number of DNS Services using the DNS zone.

--dns-zone --name -n

NSX DNS Zone identifier. Generally the same as the DNS Zone's display name.

--domain

Domain names of the DNS Zone. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--private-cloud -c

Name of the private cloud.

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

--revision

NSX revision number.

--set

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

--source-ip

Source IP of the DNS Zone.

--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 vmware workload-network dns-zone wait

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

az vmware workload-network dns-zone wait [--created]
                                         [--custom]
                                         [--deleted]
                                         [--dns-zone]
                                         [--exists]
                                         [--ids]
                                         [--interval]
                                         [--private-cloud]
                                         [--resource-group]
                                         [--subscription]
                                         [--timeout]
                                         [--updated]

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--dns-zone --name -n

NSX DNS Zone identifier. Generally the same as the DNS Zone's display name.

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

Default value: 30
--private-cloud -c

Name of the private cloud.

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

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.