az network dns record-set ptr

Manage DNS PTR records.

Commands

Name	Description	Type	Status
az network dns record-set ptr add-record	Add a PTR record.	Core	GA
az network dns record-set ptr create	Create an empty PTR record set.	Core	GA
az network dns record-set ptr delete	Delete a PTR record set and all associated records.	Core	GA
az network dns record-set ptr list	List all PTR record sets in a zone.	Core	GA
az network dns record-set ptr remove-record	Remove a PTR record from its record set.	Core	GA
az network dns record-set ptr show	Get the details of a PTR record set.	Core	GA
az network dns record-set ptr update	Update a PTR record set.	Core	GA

az network dns record-set ptr add-record

Add a PTR record.

az network dns record-set ptr add-record --ptrdname
                                         --record-set-name
                                         --resource-group
                                         --zone-name
                                         [--if-none-match]
                                         [--ttl]

Examples

Add a PTR record.

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

Optional Parameters

--if-none-match

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

--ttl

Record set TTL (time-to-live).

default value: 3600

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network dns record-set ptr create

Create an empty PTR record set.

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

Examples

Create an empty PTR record set.

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

Create an empty PTR record set. (autogenerated)

az network dns record-set ptr create --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --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 overwriting 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.

--ttl

Record set TTL (time-to-live).

default value: 3600

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network dns record-set ptr delete

Delete a PTR record set and all associated records.

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

Examples

Delete a PTR record set and all associated records.

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

Delete a PTR record set and all associated records. (autogenerated)

az network dns record-set ptr delete --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --yes --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

Delete only if the resource with the same ETAG exists.

--yes -y

Do not prompt for confirmation.

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network dns record-set ptr list

List all PTR record sets in a zone.

az network dns record-set ptr list --resource-group
                                   --zone-name

Examples

List all PTR record sets in a zone.

az network dns record-set ptr list -g MyResourceGroup -z www.mysite.com

List all PTR record sets in a zone. (autogenerated)

az network dns record-set ptr list --resource-group MyResourceGroup --subscription MySubscription --zone-name 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.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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

Examples

Remove a PTR record from its record set.

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

Optional Parameters

--keep-empty-record-set

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

default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network dns record-set ptr show

Get the details of a PTR record set.

az network dns record-set ptr show --name
                                   --resource-group
                                   --zone-name

Examples

Get the details of a PTR record set.

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az network dns record-set ptr update

Update a PTR record set.

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

Examples

Update a PTR record set.

az network 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 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

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

default value: []

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

default value: False

--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 any concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing record set. Other values will be ignored.

--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 <indexToRemove> OR --remove propertyToRemove.

default value: []

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

default value: []

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

accepted values: json, jsonc, none, table, tsv, yaml, yamlc

default value: json

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

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

--verbose

Increase logging verbosity. Use --debug for full debug logs.