az network dns record-set cname

Manage DNS CNAME records.

Commands

az network dns record-set cname create

Create an empty CNAME record set.

az network dns record-set cname delete

Delete a CNAME record set and its associated record.

az network dns record-set cname list

List the CNAME record set in a zone.

az network dns record-set cname remove-record

Remove a CNAME record from its record set.

az network dns record-set cname set-record

Set the value of a CNAME record.

az network dns record-set cname show

Get the details of a CNAME record set.

az network dns record-set cname create

Create an empty CNAME record set.

az network dns record-set cname create --name
                                       --resource-group
                                       --zone-name
                                       [--if-match]
                                       [--if-none-match]
                                       [--metadata]
                                       [--subscription]
                                       [--target-resource]
                                       [--ttl]

Examples

Create an empty CNAME record set.

az network dns record-set cname create -g MyResourceGroup -z www.mysite.com -n MyRecordSet

Create an empty CNAME record set. (autogenerated)

az network dns record-set cname create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com

Required Parameters

--name -n

The name of the record set, relative to the name of the 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 zone.

Optional Parameters

--if-match

The etag of the record set. Omit this value to always overwrite the current record set. Specify the last-seen etag value to prevent accidentally overwritting any concurrent changes.

--if-none-match

Create the record set only if it does not already exist.

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

--subscription

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

--target-resource

ID of an Azure resource from which the DNS resource value is taken.

--ttl

Record set TTL (time-to-live).

default value: 3600

az network dns record-set cname delete

Delete a CNAME record set and its associated record.

az network dns record-set cname delete --name
                                       --resource-group
                                       --zone-name
                                       [--if-match]
                                       [--subscription]
                                       [--yes]

Examples

Delete a CNAME record set and its associated record.

az network dns record-set cname delete -g MyResourceGroup -z www.mysite.com -n MyRecordSet

Required Parameters

--name -n

The name of the record set, relative to the name of the 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 zone.

Optional Parameters

--if-match

The etag of the record set. Omit this value to always delete the current record set. Specify the last-seen etag value to prevent accidentally deleting any concurrent changes.

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

az network dns record-set cname list

List the CNAME record set in a zone.

az network dns record-set cname list --resource-group
                                     --zone-name
                                     [--query-examples]
                                     [--subscription]

Examples

List the CNAME record set in a zone.

az network dns record-set cname 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

The name of the zone.

Optional Parameters

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

az network 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 dns record-set cname remove-record --cname
                                              --record-set-name
                                              --resource-group
                                              --zone-name
                                              [--keep-empty-record-set]
                                              [--subscription]

Examples

Remove a CNAME record from its record set.

az network dns record-set cname remove-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -c www.contoso.com

Required Parameters

--cname -c

Value of the cname record-set. It should be Canonical name.

--record-set-name -n

The name of the record set relative to the 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 zone.

Optional Parameters

--keep-empty-record-set

Keep the empty record set if the last record is removed.

--subscription

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

az network dns record-set cname set-record

Set the value of a CNAME record.

az network dns record-set cname set-record --cname
                                           --record-set-name
                                           --resource-group
                                           --zone-name
                                           [--if-none-match]
                                           [--subscription]
                                           [--ttl]

Examples

Set the value of a CNAME record.

az network dns record-set cname set-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -c www.contoso.com

Required Parameters

--cname -c

Value of the cname record-set. It should be Canonical name.

--record-set-name -n

The name of the record set relative to the zone. Creates a new record set if one does not exist.

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

Optional Parameters

--if-none-match

Create the record set only if it does not already exist.

--subscription

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

--ttl

Record set TTL (time-to-live).

default value: 3600

az network dns record-set cname show

Get the details of a CNAME record set.

az network dns record-set cname show --name
                                     --resource-group
                                     --zone-name
                                     [--query-examples]
                                     [--subscription]

Examples

Get the details of a CNAME record set.

az network dns record-set cname show -g MyResourceGroup -z www.mysite.com -n MyRecordSet

Required Parameters

--name -n

The name of the record set, relative to the name of the 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 zone.

Optional Parameters

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