az network private-dns link vnet

Manage virtual network links to the specified Private DNS zone.

Commands

Name	Description	Type	Status
az network private-dns link vnet create	Create a virtual network link to the specified Private DNS zone.	Core	GA
az network private-dns link vnet delete	Delete a virtual network link to the specified private DNS zone.	Core	GA
az network private-dns link vnet list	List the virtual network links to the specified private DNS zone.	Core	GA
az network private-dns link vnet show	Get a virtual network link to the specified private DNS zone.	Core	GA
az network private-dns link vnet update	Update a virtual network link's properties. Does not modify virtual network within the link.	Core	GA
az network private-dns link vnet wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az network private-dns link vnet create

Create a virtual network link to the specified Private DNS zone.

az network private-dns link vnet create --name
                                        --registration-enabled {0, 1, f, false, n, no, t, true, y, yes}
                                        --resource-group
                                        --virtual-network
                                        --zone-name
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--tags]

Examples

Create a virtual network link to the specified private DNS zone.

az network private-dns link vnet create -g MyResourceGroup -n MyLinkName -z www.mysite.com -v MyVirtualNetworkId -e False

Required Parameters

--name -n

Name of the virtual network link to the specified private DNS zone.

--registration-enabled -e

Specify if the link is registration enabled.

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

--virtual-network -v

Name or ID of the virtual network.

--zone-name -z

Name of the private DNS zone.

Optional Parameters

--no-wait

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

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

--tags

Resource tags for the virtual network link. 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 network private-dns link vnet delete

Delete a virtual network link to the specified private DNS zone.

In case of a registration virtual network, all auto-registered DNS records in the zone for the virtual network will also be deleted. This operation cannot be undone.

az network private-dns link vnet delete [--ids]
                                        [--if-match]
                                        [--name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--resource-group]
                                        [--subscription]
                                        [--yes]
                                        [--zone-name]

Examples

Delete a virtual network link to the specified private DNS zone.

az network private-dns link vnet delete -g MyResourceGroup -z www.mysite.com -n MyLinkName

Optional Parameters

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

--if-match

ETag of the virtual network link to the private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

--name -n

Name of the virtual network link to the specified private DNS zone.

--no-wait

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

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

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

--zone-name -z

Name of the private 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 network private-dns link vnet list

List the virtual network links to the specified private DNS zone.

az network private-dns link vnet list --resource-group
                                      --zone-name
                                      [--max-items]
                                      [--next-token]
                                      [--top]

Examples

List virtual network links to the specified private DNS zone in a resource group.

az network private-dns link vnet list -g MyResourceGroup -z www.mysite.com

Required Parameters

--resource-group -g

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

--zone-name -z

Name of the private DNS zone.

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.

--top

Maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links.

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 network private-dns link vnet show

Get a virtual network link to the specified private DNS zone.

az network private-dns link vnet show [--ids]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]
                                      [--zone-name]

Examples

Get a virtual network link to the specified private DNS zone.

az network private-dns link vnet show -g MyResourceGroup -n MyLinkName -z www.mysite.com

Optional Parameters

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

--name -n

Name of the virtual network link to the specified private DNS zone.

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

--zone-name -z

Name of the private 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 network private-dns link vnet update

Update a virtual network link's properties. Does not modify virtual network within the link.

az network private-dns link vnet update [--add]
                                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--ids]
                                        [--if-match]
                                        [--name]
                                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--registration-enabled {0, 1, f, false, n, no, t, true, y, yes}]
                                        [--remove]
                                        [--resource-group]
                                        [--set]
                                        [--subscription]
                                        [--tags]
                                        [--zone-name]

Examples

Update a virtual network link properties to enable registration.

az network private-dns link vnet update -g MyResourceGroup -n MyLinkName -z www.mysite.com -e True

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

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

--if-match

ETag of the virtual network link to the private DNS zone. Omit this value to always overwrite the current virtual network link. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

--name -n

Name of the virtual network link to the specified private DNS zone.

--no-wait

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

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

--registration-enabled -e

Specify if the link is registration enabled.

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

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

--subscription

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

--tags

Resource tags for the virtual network link. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--zone-name -z

Name of the private 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 network private-dns link vnet wait

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

az network private-dns link vnet wait [--created]
                                      [--custom]
                                      [--deleted]
                                      [--exists]
                                      [--ids]
                                      [--interval]
                                      [--name]
                                      [--resource-group]
                                      [--subscription]
                                      [--timeout]
                                      [--updated]
                                      [--zone-name]

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

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

--name -n

Name of the virtual network link to the specified private DNS zone.

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

--zone-name -z

Name of the private 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.