Share via


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 a PTR record set.

Core GA
az network dns record-set ptr delete

Delete a PTR record set.

Core GA
az network dns record-set ptr list

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

Experimental Preview Deprecated

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
Experimental Preview Deprecated

PTR target domain name.

--record-set-name -n
Experimental Preview Deprecated

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

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--zone-name -z
Experimental Preview Deprecated

The name of the zone.

Optional Parameters

--if-none-match
Experimental Preview Deprecated

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

--ttl
Experimental Preview Deprecated

Record set TTL (time-to-live).

Default value: 3600
Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az network dns record-set ptr create

Experimental Preview Deprecated

Create a PTR record set.

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

Examples

Create a PTR record set.

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

Required Parameters

--name -n
Experimental Preview Deprecated

The name of the record set, relative to the name of the zone.

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--zone-name -z
Experimental Preview Deprecated

The name of the DNS zone (without a terminating dot).

Optional Parameters

--if-match
Experimental Preview Deprecated

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
Experimental Preview Deprecated

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
Experimental Preview Deprecated

The metadata attached to the record set. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--target-resource
Experimental Preview Deprecated

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

--tm-profile --traffic-management-profile
Experimental Preview Deprecated

A reference to an Azure Traffic Manager Profile resource from where the DNS resource value is taken.

--ttl
Experimental Preview Deprecated

The TTL (time-to-live) of the records in the record set.

Default value: 3600
Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az network dns record-set ptr delete

Experimental Preview Deprecated

Delete a PTR record set.

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

Examples

Delete a PTR record set.

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

Required Parameters

Optional Parameters

--ids
Experimental Preview Deprecated

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.

--if-match
Experimental Preview Deprecated

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.

--name -n
Experimental Preview Deprecated

Name of the record set, relative to the name of the zone.

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription
Experimental Preview Deprecated

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

--yes -y
Experimental Preview Deprecated

Do not prompt for confirmation.

Default value: False
--zone-name -z
Experimental Preview Deprecated

Name of the DNS zone.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az network dns record-set ptr list

Experimental Preview Deprecated

List PTR record sets in a zone.

az network dns record-set ptr list --resource-group
                                   --zone-name
                                   [--max-items]
                                   [--next-token]
                                   [--recordsetnamesuffix]
                                   [--top]

Examples

List PTR record sets in a zone.

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

Required Parameters

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--zone-name -z
Experimental Preview Deprecated

The name of the DNS zone (without a terminating dot).

Optional Parameters

--max-items
Experimental Preview Deprecated

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.

--next-token
Experimental Preview Deprecated

Token to specify where to start paginating. This is the token value from a previously truncated response.

--recordsetnamesuffix
Experimental Preview Deprecated

The suffix label of the record set name that has to be used to filter the record set enumerations. If this parameter is specified, Enumeration will return only records that end with ..

--top
Experimental Preview Deprecated

The maximum number of record sets to return. If not specified, returns up to 100 record sets.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az network dns record-set ptr remove-record

Experimental Preview Deprecated

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
Experimental Preview Deprecated

PTR target domain name.

--record-set-name -n
Experimental Preview Deprecated

The name of the record set relative to the zone.

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--zone-name -z
Experimental Preview Deprecated

The name of the zone.

Optional Parameters

--keep-empty-record-set
Experimental Preview Deprecated

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

Default value: False
Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az network dns record-set ptr show

Experimental Preview Deprecated

Get a PTR record set.

az network dns record-set ptr show [--ids]
                                   [--name]
                                   [--resource-group]
                                   [--subscription]
                                   [--zone-name]

Examples

Get a PTR record set.

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

Required Parameters

Optional Parameters

--ids
Experimental Preview Deprecated

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 -n
Experimental Preview Deprecated

Name of the record set, relative to the name of the zone.

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--subscription
Experimental Preview Deprecated

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

--zone-name -z
Experimental Preview Deprecated

Name of the DNS zone.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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

az network dns record-set ptr update

Experimental Preview Deprecated

Update a PTR record set.

az network dns record-set ptr update [--add]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--ids]
                                     [--if-match]
                                     [--if-none-match]
                                     [--metadata]
                                     [--name]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--subscription]
                                     [--target-resource]
                                     [--tm-profile]
                                     [--zone-name]

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

Optional Parameters

--add
Experimental Preview Deprecated

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
Experimental Preview Deprecated

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids
Experimental Preview Deprecated

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.

--if-match
Experimental Preview Deprecated

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
Experimental Preview Deprecated

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
Experimental Preview Deprecated

Metadata in space-separated key=value pairs. This overwrites any existing metadata. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name -n
Experimental Preview Deprecated

Name of the record set, relative to the name of the zone.

--remove
Experimental Preview Deprecated

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g
Experimental Preview Deprecated

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--target-resource
Experimental Preview Deprecated

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

--tm-profile --traffic-management-profile
Experimental Preview Deprecated

A reference to an Azure Traffic Manager Profile resource from where the DNS resource value is taken.

--zone-name -z
Experimental Preview Deprecated

Name of the DNS zone.

Global Parameters
--debug
Experimental Preview Deprecated

Increase logging verbosity to show all debug logs.

--help -h
Experimental Preview Deprecated

Show this help message and exit.

--only-show-errors
Experimental Preview Deprecated

Only show errors, suppressing warnings.

--output -o
Experimental Preview Deprecated

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query
Experimental Preview Deprecated

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

--subscription
Experimental Preview Deprecated

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

--verbose
Experimental Preview Deprecated

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