az network dns record-set a

Reference

Manage DNS A records.

Commands

Name	Description	Type	Status
az network dns record-set a add-record	Add an A record.	Core	GA
az network dns record-set a create	Create an A record set.	Core	GA
az network dns record-set a delete	Delete an A record set.	Core	GA
az network dns record-set a list	List A record sets in a zone.	Core	GA
az network dns record-set a remove-record	Remove an A record from its record set.	Core	GA
az network dns record-set a show	Get an A record set.	Core	GA
az network dns record-set a update	Update an A record set.	Core	GA

az network dns record-set a add-record

Edit

Add an A record.

az network dns record-set a add-record --ipv4-address
                                       --record-set-name
                                       --resource-group
                                       --zone-name
                                       [--if-none-match]
                                       [--ttl]

Examples

Add an A record.

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

Required Parameters

--ipv4-address -a

IPv4 address in string notation.

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

Edit

Create an A record set.

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

Examples

Create an A record set.

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

Edit

Delete an A record set.

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

Examples

Delete an A record set.

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

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

Edit

List A record sets in a zone.

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

Examples

List A record sets in a zone.

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

Edit

Remove an A 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 a remove-record --ipv4-address
                                          --record-set-name
                                          --resource-group
                                          --zone-name
                                          [--keep-empty-record-set]

Examples

Remove an A record from its record set.

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

Required Parameters

--ipv4-address -a

IPv4 address in string notation.

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

Edit

Get an A record set.

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

Examples

Get an A record set.

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

Optional Parameters

--ids

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

Edit

Update an A record set.

az network dns record-set a 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 A record set.

az network dns record-set a update -g MyResourceGroup -n MyRecordSet -z www.mysite.com --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

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

Share via

az network dns record-set a

Commands

az network dns record-set a add-record

Examples

Required Parameters

Optional Parameters

az network dns record-set a create

Examples

Required Parameters

Optional Parameters

az network dns record-set a delete

Examples

Optional Parameters

az network dns record-set a list

Examples

Required Parameters

Optional Parameters

az network dns record-set a remove-record

Examples

Required Parameters

Optional Parameters

az network dns record-set a show

Examples

Optional Parameters

az network dns record-set a update

Examples

Optional Parameters

Additional resources