az vmware workload-network dns-service

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-service command. Learn more about extensions.

Commands to manage a DNS Service workload network.

Commands

Name	Description	Type	Status
az vmware workload-network dns-service create	Create a DNS service by id in a private cloud workload network.	Extension	GA
az vmware workload-network dns-service delete	Delete a DNS service by id in a private cloud workload network.	Extension	GA
az vmware workload-network dns-service list	List of DNS services in a private cloud workload network.	Extension	GA
az vmware workload-network dns-service show	Get a DNS service by id in a private cloud workload network.	Extension	GA
az vmware workload-network dns-service update	Update a DNS service by id in a private cloud workload network.	Extension	GA
az vmware workload-network dns-service wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az vmware workload-network dns-service create

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

az vmware workload-network dns-service create --dns-service
                                              --private-cloud
                                              --resource-group
                                              [--default-dns-zone]
                                              [--display-name]
                                              [--dns-service-ip]
                                              [--fqdn-zones]
                                              [--log-level {DEBUG, ERROR, FATAL, INFO, WARNING}]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--revision]

Examples

Create a DNS service by ID in a workload network.

az vmware workload-network dns-service create --resource-group group1 --private-cloud cloud1 --dns-service dnsService1 --display-name dnsService1 --dns-service-ip 5.5.5.5 --default-dns-zone defaultDnsZone1 --fqdn-zones fqdnZone1 --log-level INFO --revision 1

Required Parameters

--dns-service --name -n

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

--default-dns-zone

Default DNS zone of the DNS Service.

--display-name

Display name of the DNS Service.

--dns-service-ip

DNS service IP of the DNS Service.

--fqdn-zones

FQDN zones of the DNS Service. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--log-level

DNS Service log level.

Accepted values: DEBUG, ERROR, FATAL, INFO, WARNING

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

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

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

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

Examples

Delete a DNS service by ID in a workload network.

az vmware workload-network dns-service delete --resource-group group1 --private-cloud cloud1 --dns-service dnsService1

Optional Parameters

--dns-service --name -n

NSX DNS Service identifier. Generally the same as the DNS Service'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-service list

List of DNS services in a private cloud workload network.

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

Examples

List of DNS services in a workload network.

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

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

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

Examples

Get a DNS service by ID in a workload network.

az vmware workload-network dns-service show --resource-group group1 --private-cloud cloud1 --dns-service dnsService1

Optional Parameters

--dns-service --name -n

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

--ids

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

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

az vmware workload-network dns-service update [--add]
                                              [--default-dns-zone]
                                              [--display-name]
                                              [--dns-service]
                                              [--dns-service-ip]
                                              [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--fqdn-zones]
                                              [--ids]
                                              [--log-level {DEBUG, ERROR, FATAL, INFO, WARNING}]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--private-cloud]
                                              [--remove]
                                              [--resource-group]
                                              [--revision]
                                              [--set]
                                              [--subscription]

Examples

Update a DNS service by ID in a workload network.

az vmware workload-network dns-service update --resource-group group1 --private-cloud cloud1 --dns-service dnsService1 --display-name dnsService1 --dns-service-ip 5.5.5.5 --default-dns-zone defaultDnsZone1 --fqdn-zones fqdnZone1 --log-level INFO --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>.

--default-dns-zone

Default DNS zone of the DNS Service.

--display-name

Display name of the DNS Service.

--dns-service --name -n

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

--dns-service-ip

DNS service IP of the DNS Service.

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

--fqdn-zones

FQDN zones of the DNS Service. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

--log-level

DNS Service log level.

Accepted values: DEBUG, ERROR, FATAL, INFO, WARNING

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

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

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

az vmware workload-network dns-service wait [--created]
                                            [--custom]
                                            [--deleted]
                                            [--dns-service]
                                            [--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-service --name -n

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

--exists

Wait until the resource exists.

Default value: False

--ids

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

Share via

az vmware workload-network dns-service

Commands

az vmware workload-network dns-service create

Examples

Required Parameters

Optional Parameters

az vmware workload-network dns-service delete

Examples

Optional Parameters

az vmware workload-network dns-service list

Examples

Required Parameters

Optional Parameters

az vmware workload-network dns-service show

Examples

Optional Parameters

az vmware workload-network dns-service update

Examples

Optional Parameters

az vmware workload-network dns-service wait

Optional Parameters

Additional resources