az network private-dns link vnet

Manage virtual network links to the specified Private DNS zone.

Commands

az network private-dns link vnet create

Create a virtual network link to the specified Private DNS zone.
az network private-dns link vnet delete

Delete a virtual network link to the specified Private DNS zone.
az network private-dns link vnet list

List the virtual network links to the specified Private DNS zone.
az network private-dns link vnet show

Get a virtual network link to the specified Private DNS zone.
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 wait

Place the CLI in a waiting state until a condition of the virtual network link to the specified Private DNS zone is met.
Edit

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

az network private-dns link vnet create --name
                                        --registration-enabled {false, true}
                                        --resource-group
                                        --virtual-network
                                        --zone-name
                                        [--no-wait]
                                        [--subscription]
                                        [--tags]

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

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

az network private-dns link vnet create --name MyLinkName --registration-enabled true --resource-group MyResourceGroup --subscription MySubscription --tags CostCenter=Marketing --virtual-network MyVirtualNetworkId --zone-name www.mysite.com
--name -n

The name of the virtual network link to the specified Private DNS zone.

--registration-enabled -e

Specify if the link is registration enabled.

accepted values: false, true
--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

The name of the Private DNS zone.

--no-wait

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

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

Edit

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 --name
                                        --resource-group
                                        --zone-name
                                        [--if-match]
                                        [--no-wait]
                                        [--subscription]
                                        [--yes]

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

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

--zone-name -z

The name of the Private DNS zone.

--if-match

The ETag of the virtual network link to the Private DNS zone. Omit this value to always delete the current zone. Specify the last-seen ETag value to prevent accidentally deleting any concurrent changes.

--no-wait

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

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

Edit

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

az network private-dns link vnet list --resource-group
                                      --zone-name
                                      [--query-examples]
                                      [--subscription]
                                      [--top]

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
--resource-group -g

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

--zone-name -z

The name of the Private DNS zone.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

--top

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

Edit

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

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

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

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

--zone-name -z

The name of the Private DNS zone.

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

Edit

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

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

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

Update a virtual network link's properties (autogenerated)

az network private-dns link vnet update --name MyLinkName --registration-enabled true --resource-group MyResourceGroup --tags CostCenter=Marketing --zone-name www.mysite.com
--name -n

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

--zone-name -z

The name of the Private DNS zone.

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

--if-match

The ETag of the virtual network link to the Private DNS zone.

--no-wait

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

--registration-enabled -e

Specify if the link is registration enabled.

accepted values: false, true
--remove

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

--set

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

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

Edit

Place the CLI in a waiting state until a condition of the virtual network link to the specified Private DNS zone is met.

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

Pause executing next line of CLI script until the virtual network link to the specified Private DNS zone is successfully provisioned.

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

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

--zone-name -z

The name of the Private DNS zone.

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--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'.