Share via

az network dns record-set ns

  • Reference

Manage DNS NS records.

Commands

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

Add an NS record.

 Core GA
az network dns record-set ns create

Create an NS record set.

 Core GA
az network dns record-set ns delete

Delete an NS record set.

 Core GA
az network dns record-set ns list

List NS record sets in a zone.

 Core GA
az network dns record-set ns remove-record

Remove an NS record from its record set.

 Core GA
az network dns record-set ns show

Get an NS record set.

 Core GA
az network dns record-set ns update

Update an NS record set.

 Core GA

az network dns record-set ns add-record

Edit

Add an NS record.

az network dns record-set ns add-record --nsdname
                                        --record-set-name
                                        --resource-group
                                        --zone-name
                                        [--if-none-match]
                                        [--subscriptionid]
                                        [--ttl]

Examples

Add an NS record.

az network dns record-set ns add-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -d ns.mysite.com

Required Parameters

--nsdname -d

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

--subscriptionid -s

Subscription id to add name server record.

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

Edit

Create an NS record set.

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

Examples

Create an NS record set.

az network dns record-set ns 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

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

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

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

Edit

Delete an NS record set.

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

Examples

Delete an NS record set.

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

Optional Parameters

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

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

--resource-group -g

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

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

Default value: False
--zone-name -z

Name of the DNS 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 ns list

Edit

List NS record sets in a zone.

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

Examples

List NS record sets in a zone.

az network dns record-set ns 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

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

--next-token

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

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

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

--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 ns remove-record

Edit

Remove an NS 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 ns remove-record --nsdname
                                           --record-set-name
                                           --resource-group
                                           --zone-name
                                           [--keep-empty-record-set]

Examples

Remove an NS record from its record set.

az network dns record-set ns remove-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -d ns.mysite.com

Remove an NS record from its record set. (autogenerated)

az network dns record-set ns remove-record --keep-empty-record-set --nsdname ns.mysite.com --record-set-name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com

Required Parameters

--nsdname -d

Name server 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 ns show

Edit

Get an NS record set.

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

Examples

Get an NS record set.

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

Optional Parameters

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

--name -n

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

--subscription

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

--zone-name -z

Name of the DNS 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 ns update

Edit

Update an NS record set.

az network dns record-set ns 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 an NS record set.

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

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.

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.

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

--remove

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

--resource-group -g

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

--set

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

--subscription

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

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

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.