az network private-dns record-set cname
Manage Private DNS CNAME records.
Commands
Name | Description | Type | Status |
---|---|---|---|
az network private-dns record-set cname create |
Create an empty CNAME record set. |
Core | GA |
az network private-dns record-set cname delete |
Delete a CNAME record set and its associated record. |
Core | GA |
az network private-dns record-set cname list |
List the CNAME record set in a zone. |
Core | GA |
az network private-dns record-set cname remove-record |
Remove a CNAME record from its record set. |
Core | GA |
az network private-dns record-set cname set-record |
Set the value of a CNAME record. |
Core | GA |
az network private-dns record-set cname show |
Get the details of a CNAME record set. |
Core | GA |
az network private-dns record-set cname update |
Update a CNAME record set. |
Core | GA |
az network private-dns record-set cname create
Create an empty CNAME record set.
az network private-dns record-set cname create --name
--resource-group
--zone-name
[--metadata]
[--ttl]
Examples
Create an empty CNAME record set.
az network private-dns record-set cname create -g MyResourceGroup -z www.mysite.com -n MyRecordSet
Required Parameters
Name of the record set, relative to the name of the zone.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name of the Private DNS zone (without a terminating dot).
Optional Parameters
Metadata attached to the record set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Record set TTL (time-to-live).
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 record-set cname delete
Delete a CNAME record set and its associated record.
az network private-dns record-set cname delete [--ids]
[--if-match]
[--name]
[--resource-group]
[--subscription]
[--yes]
[--zone-name]
Examples
Delete a CNAME record set and its associated record.
az network private-dns record-set cname delete -g MyResourceGroup -z www.mysite.com -n MyRecordSet
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 record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
Name of the record set, relative to the name of the 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
.
Do not prompt for confirmation.
Name of the Private DNS zone (without a terminating dot).
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 record-set cname list
List the CNAME record set in a zone.
az network private-dns record-set cname list --resource-group
--zone-name
[--max-items]
[--next-token]
Examples
List the CNAME record set in a zone.
az network private-dns record-set cname 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>
.
Name of the Private DNS zone (without a terminating dot).
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.
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 record-set cname remove-record
Remove a CNAME record from its record set.
By default, if the last record in a set is removed, the record set is deleted. To retain the empty record set, include --keep-empty-record-set.
az network private-dns record-set cname remove-record --cname
--record-set-name
--resource-group
--zone-name
[--keep-empty-record-set]
Examples
Remove a CNAME record from its record set.
az network private-dns record-set cname remove-record -g MyResourceGroup -z www.mysite.com \
-n MyRecordSet -c www.contoso.com
Required Parameters
Canonical name.
The name of the record set relative to the 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
Keep the empty record set if the last record is removed.
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 record-set cname set-record
Set the value of a CNAME record.
az network private-dns record-set cname set-record --cname
--record-set-name
--resource-group
--zone-name
Examples
Set the value of a CNAME record.
az network private-dns record-set cname set-record -g MyResourceGroup -z www.mysite.com \
-n MyRecordSet -c www.contoso.com
Required Parameters
Canonical name.
The name of the record set relative to the zone. Creates a new record set if one does not exist.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Private DNS zone.
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 record-set cname show
Get the details of a CNAME record set.
az network private-dns record-set cname show [--ids]
[--name]
[--resource-group]
[--subscription]
[--zone-name]
Examples
Get the details of a CNAME record set.
az network private-dns record-set cname show -g MyResourceGroup -z www.mysite.com -n MyRecordSet
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 record set, relative to the name of the 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
.
Name of the Private DNS zone (without a terminating dot).
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 record-set cname update
Update a CNAME record set.
az network private-dns record-set cname update [--add]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--if-match]
[--metadata]
[--name]
[--remove]
[--resource-group]
[--set]
[--subscription]
[--zone-name]
Examples
Update a CNAME record set.
az network private-dns record-set cname update -g MyResourceGroup -z www.mysite.com -n MyRecordSet --metadata owner=WebTeam
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 record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
Metadata attached to the record set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Name of the record set, relative to the name of the zone.
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
.
Name of the Private DNS zone (without a terminating dot).
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.