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. |
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 {false, true}
--resource-group
--virtual-network
--zone-name
[--no-wait]
[--subscription]
[--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
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
Required Parameters
The name of the virtual network link to the specified Private DNS zone.
Specify if the link is registration enabled.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of the virtual network.
The name of the Private DNS zone.
Optional Parameters
Do not wait for the long-running operation to finish.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags for the virtual network link.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
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 --name
--resource-group
--zone-name
[--if-match]
[--no-wait]
[--subscription]
[--yes]
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
Required Parameters
The name of the virtual network link to the specified Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Private DNS zone.
Optional Parameters
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.
Do not wait for the long-running operation to finish.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
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
[--query-examples]
[--subscription]
[--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
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Private DNS zone.
Optional Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The maximum number of virtual network links to return. If not specified, returns up to 100 virtual network links.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
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 --name
--resource-group
--zone-name
[--query-examples]
[--subscription]
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
Required Parameters
The name of the virtual network link to the specified Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Private DNS zone.
Optional Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
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 --name
--resource-group
--zone-name
[--add]
[--force-string]
[--if-match]
[--no-wait]
[--registration-enabled {false, true}]
[--remove]
[--set]
[--subscription]
[--tags]
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
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
Required Parameters
The name of the virtual network link to the specified Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Private DNS zone.
Optional Parameters
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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The ETag of the virtual network link to the Private DNS zone.
Do not wait for the long-running operation to finish.
Specify if the link is registration enabled.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags for the virtual network link.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
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 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]
Examples
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
Required Parameters
The name of the virtual network link to the specified Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Private DNS zone.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
Polling interval in seconds.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.