Share via

az network dns record-set naptr

  • Experimental

This command group is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage DNS NAPTR records.

Commands

Name Description Type Status
az network dns record-set naptr add-record

Add a NAPTR record.

 Core Experimental
az network dns record-set naptr create

Create an NAPTR record set.

 Core Experimental
az network dns record-set naptr delete

Delete an NAPTR record set.

 Core Experimental
az network dns record-set naptr list

List NAPTR record sets in a zone.

 Core Experimental
az network dns record-set naptr remove-record

Remove a NAPTR record from its record set.

 Core Experimental
az network dns record-set naptr show

Get an NAPTR record set.

 Core Experimental
az network dns record-set naptr update

Update an NAPTR record set.

 Core Experimental

az network dns record-set naptr add-record

Edit
Experimental

Command group 'network dns record-set naptr' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Add a NAPTR record.

az network dns record-set naptr add-record --flags
                                           --order
                                           --preference
                                           --record-set-name
                                           --regexp
                                           --replacement
                                           --resource-group
                                           --services
                                           --zone-name
                                           [--if-none-match]
                                           [--ttl]

Examples

Add a NAPTR record.

az network dns record-set naptr add-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet --flags "U" --order 10 --preference 20 --services "E2U+sip" --regexp "!^.*$!sip:customer-service@example.com!" --replacement .

Required Parameters

--flags

The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks.

--order

The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535.

--preference

The preference specifies the order in which NAPTR records with equal "order" values should be processed, low numbers being processed before high numbers. Valid values: 0-65535.

--record-set-name -n

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

--regexp

The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for "regexp" or a value for "replacement".

--replacement

The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for "regexp" or a value for "replacement". If you specify a value for "regexp", specify a dot (.) for "replacement".

--resource-group -g

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

--services

The services specific to DDDS applications. Enclose Services in quotation marks.

--zone-name -z

The name of the zone.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--if-none-match

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

--ttl

Record set TTL (time-to-live).

Property Value
Default value: 3600
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network dns record-set naptr create

Edit
Experimental

Command group 'network dns record-set naptr' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create an NAPTR record set.

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

Examples

Create an NAPTR record set.

az network dns record-set naptr create -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 DNS zone (without a terminating dot).

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

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

Property Value
Parameter group: Properties Arguments
--target-resource

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

--tm-profile --traffic-management-profile
Experimental

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

--ttl

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

Property Value
Parameter group: Properties Arguments
Default value: 3600
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network dns record-set naptr delete

Edit
Experimental

Command group 'network dns record-set naptr' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an NAPTR record set.

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

Examples

Delete an NAPTR record set.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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.

Property Value
Parameter group: Resource Id Arguments
--if-match

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

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

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
--zone-name -z

Name of the DNS zone.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az network dns record-set naptr list

Edit
Experimental

Command group 'network dns record-set naptr' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List NAPTR record sets in a zone.

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

Examples

List NAPTR record sets in a zone.

az network dns record-set naptr 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 DNS zone (without a terminating dot).

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

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.

Property Value
Parameter group: Pagination Arguments
--next-token

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

Property Value
Parameter group: Pagination Arguments
--recordsetnamesuffix

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

--top

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

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network dns record-set naptr remove-record

Edit
Experimental

Command group 'network dns record-set naptr' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Remove a NAPTR 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 naptr remove-record --flags
                                              --order
                                              --preference
                                              --record-set-name
                                              --regexp
                                              --replacement
                                              --resource-group
                                              --services
                                              --zone-name
                                              [--keep-empty-record-set]

Examples

Remove an NAPTR record from its record set.

az network dns record-set naptr remove-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet --flags "U" --order 10 --preference 20 --services "E2U+sip" --regexp "!^.*$!sip:customer-service@example.com!" --replacement .

Required Parameters

--flags

The flags specific to DDDS applications. Values currently defined in RFC 3404 are uppercase and lowercase letters "A", "P", "S", and "U", and the empty string, "". Enclose Flags in quotation marks.

--order

The order in which the NAPTR records MUST be processed in order to accurately represent the ordered list of rules. The ordering is from lowest to highest. Valid values: 0-65535.

--preference

The preference specifies the order in which NAPTR records with equal "order" values should be processed, low numbers being processed before high numbers. Valid values: 0-65535.

--record-set-name -n

The name of the record set relative to the zone.

--regexp

The regular expression that the DDDS application uses to convert an input value into an output value. For example: an IP phone system might use a regular expression to convert a phone number that is entered by a user into a SIP URI. Enclose the regular expression in quotation marks. Specify either a value for "regexp" or a value for "replacement".

--replacement

The replacement is a fully qualified domain name (FQDN) of the next domain name that you want the DDDS application to submit a DNS query for. The DDDS application replaces the input value with the value specified for replacement. Specify either a value for "regexp" or a value for "replacement". If you specify a value for "regexp", specify a dot (.) for "replacement".

--resource-group -g

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

--services

The services specific to DDDS applications. Enclose Services in quotation marks.

--zone-name -z

The name of the zone.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--keep-empty-record-set

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

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

Property Value
Default value: False

az network dns record-set naptr show

Edit
Experimental

Command group 'network dns record-set naptr' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get an NAPTR record set.

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

Examples

Get an NAPTR record set.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

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.

Property Value
Parameter group: Resource Id Arguments
--name -n

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

Property Value
Parameter group: Resource Id Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--zone-name -z

Name of the DNS zone.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False

az network dns record-set naptr update

Edit
Experimental

Command group 'network dns record-set naptr' is experimental and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update an NAPTR record set.

az network dns record-set naptr 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 --traffic-management-profile]
                                       [--zone-name]

Examples

Update an NAPTR record set.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property Value
Parameter group: Generic Update Arguments
--force-string

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

Property Value
Parameter group: Generic Update Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--ids

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.

Property Value
Parameter group: Resource Id Arguments
--if-match

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. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name -n

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

Property Value
Parameter group: Resource Id Arguments
--remove

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

Property Value
Parameter group: Generic Update Arguments
--resource-group -g

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

Property Value
Parameter group: Resource Id Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--subscription

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

Property Value
Parameter group: Resource Id Arguments
--target-resource

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

--tm-profile --traffic-management-profile
Experimental

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

--zone-name -z

Name of the DNS zone.

Property Value
Parameter group: Resource Id Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Property Value
Default value: False