az network private-dns record-set ptr

Manage Private DNS PTR records.

Commands

az network private-dns record-set ptr add-record

Add a PTR record.

az network private-dns record-set ptr create

Create an empty PTR record set.

az network private-dns record-set ptr delete

Delete a PTR record set and all associated records.

az network private-dns record-set ptr list

List all PTR record sets in a zone.

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

Remove a PTR record from its record set.

az network private-dns record-set ptr show

Get the details of a PTR record set.

az network private-dns record-set ptr update

Update a PTR record set.

az network private-dns record-set ptr add-record

Add a PTR record.

az network private-dns record-set ptr add-record --ptrdname
                                                 --record-set-name
                                                 --resource-group
                                                 --zone-name
                                                 [--subscription]

Examples

Add a PTR record.

az network private-dns record-set ptr add-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -d another.site.com

Required Parameters

--ptrdname -d

PTR target domain 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.

Optional Parameters

--subscription

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

az network private-dns record-set ptr create

Create an empty PTR record set.

az network private-dns record-set ptr create --name
                                             --resource-group
                                             --zone-name
                                             [--metadata]
                                             [--subscription]
                                             [--ttl]

Examples

Create an empty PTR record set.

az network private-dns record-set ptr 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.

--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 private-dns record-set ptr delete

Delete a PTR record set and all associated records.

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

Examples

Delete a PTR record set and all associated records.

az network private-dns record-set ptr 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.

--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 private-dns record-set ptr list

List all PTR record sets in a zone.

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

Examples

List all PTR record sets in a zone.

az network private-dns record-set ptr 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.

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 private-dns record-set ptr remove-record

Remove a PTR 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 ptr remove-record --ptrdname
                                                    --record-set-name
                                                    --resource-group
                                                    --zone-name
                                                    [--keep-empty-record-set]
                                                    [--subscription]

Examples

Remove a PTR record from its record set.

az network private-dns record-set ptr remove-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -d another.site.com

Required Parameters

--ptrdname -d

PTR target domain 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.

--subscription

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

az network private-dns record-set ptr show

Get the details of a PTR record set.

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

Examples

Get the details of a PTR record set.

az network private-dns record-set ptr 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.

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 private-dns record-set ptr update

Update a PTR record set.

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

Examples

Update a PTR record set.

az network private-dns record-set ptr 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 overwriting 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=.

--subscription

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