az network private-dns zone
Manage Private DNS zones.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az network private-dns zone create |
Create a Private DNS zone. |
Core | GA |
| az network private-dns zone delete |
Delete a Private DNS zone. |
Core | GA |
| az network private-dns zone export |
Export a Private DNS zone as a DNS zone file. |
Core | GA |
| az network private-dns zone import |
Create a Private DNS zone using a DNS zone file. |
Core | GA |
| az network private-dns zone list |
List Private DNS zones. |
Core | GA |
| az network private-dns zone show |
Get a Private DNS zone. |
Core | GA |
| az network private-dns zone update |
Update a Private DNS zone's properties. Does not modify Private DNS records or virtual network links within the zone. |
Core | GA |
| az network private-dns zone wait |
Place the CLI in a waiting state until a condition is met. |
Core | GA |
az network private-dns zone create
Create a Private DNS zone.
az network private-dns zone create --name
--resource-group
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--tags]Examples
Create a Private DNS zone using a fully qualified domain name.
az network private-dns zone create -g MyResourceGroup -n www.mysite.comRequired Parameters
Name of the Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Resource tags for the Private DNS zone. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network private-dns zone delete
Delete a Private DNS zone.
All DNS records in the zone will also be deleted. This operation cannot be undone. Private DNS zone cannot be deleted unless all virtual network links to it are removed.
az network private-dns zone delete [--ids]
[--if-match]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]Examples
Delete a Private DNS zone using a fully qualified domain name.
az network private-dns zone delete -g MyResourceGroup -n www.mysite.comRequired Parameters
Optional Parameters
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.
ETag of 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.
Name of the Private DNS zone.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network private-dns zone export
Export a Private DNS zone as a DNS zone file.
az network private-dns zone export --name
--resource-group
[--file-name]Examples
Export a Private DNS zone as a DNS zone file.
az network private-dns zone export -g MyResourceGroup -n www.mysite.com -f mysite_com_zone.txtRequired Parameters
The name of the Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Path to the Private DNS zone file to save.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network private-dns zone import
Create a Private DNS zone using a DNS zone file.
az network private-dns zone import --file-name
--name
--resource-groupExamples
Import a local zone file into a Private DNS zone resource.
az network private-dns zone import -g MyResourceGroup -n MyZone -f /path/to/zone/fileRequired Parameters
Path to the Private DNS zone file to import.
The name of the Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network private-dns zone list
List Private DNS zones.
az network private-dns zone list [--max-items]
[--next-token]
[--resource-group]Examples
List Private DNS zones in a resource group.
az network private-dns zone list -g MyResourceGroupRequired Parameters
Optional Parameters
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network private-dns zone show
Get a Private DNS zone.
az network private-dns zone show [--ids]
[--name]
[--resource-group]
[--subscription]Examples
Get a Private DNS zone using a fully qualified domain name.
az network private-dns zone show -g MyResourceGroup -n www.mysite.comRequired Parameters
Optional Parameters
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 of the Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network private-dns zone update
Update a Private DNS zone's properties. Does not modify Private DNS records or virtual network links within the zone.
az network private-dns zone 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}]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--tags]Examples
Update a Private DNS zone properties to change the user-defined value of a previously set tag.
az network private-dns zone update -g MyResourceGroup -n www.mysite.com --tags CostCenter=MarketingRequired Parameters
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.
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.
ETag of the Private DNS zone. Omit this value to always overwrite the current zone. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
Name of the Private DNS zone.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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 Private DNS zone. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az network private-dns zone wait
Place the CLI in a waiting state until a condition is met.
az network private-dns zone wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]Examples
Required Parameters
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.
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.
Polling interval in seconds.
Name of the Private DNS zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
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'.
Global Parameters
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.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
