az network private-dns record-set cname

Manage Private DNS CNAME records.

Commands

az network private-dns record-set cname create

Create an empty CNAME record set.

az network private-dns record-set cname delete

Delete a CNAME record set and its associated record.

az network private-dns record-set cname list

List the CNAME record set in a zone.

az network private-dns record-set cname remove-record

Remove a CNAME record from its record set.

az network private-dns record-set cname set-record

Set the value of a CNAME record.

az network private-dns record-set cname show

Get the details of a CNAME record set.

az network private-dns record-set cname update

Update a CNAME record set.

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

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

Optional Parameters

--metadata

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

--ttl

Record set TTL (time-to-live).

default value: 3600

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

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

Required Parameters

--name -n

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

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.

--yes -y

Do not prompt for confirmation.

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

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

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

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

--cname -c

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

Optional Parameters

--keep-empty-record-set

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

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

--cname -c

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

az network private-dns record-set cname show

Get the details of a CNAME record set.

az network private-dns record-set cname show --name
                                             --resource-group
                                             --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

Required Parameters

--name -n

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

az network private-dns record-set cname update

Update a CNAME record set.

az network private-dns record-set cname update --name
                                               --resource-group
                                               --zone-name
                                               [--add]
                                               [--force-string]
                                               [--if-match]
                                               [--metadata]
                                               [--remove]
                                               [--set]

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

Required Parameters

--name -n

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

Optional Parameters

--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 record set. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwritting concurrent changes.

--metadata

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

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