az network private-dns record-set a

Reference

Manage Private DNS A records.

Commands

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

az network private-dns record-set a add-record

Edit

Add an A record.

az network private-dns record-set a add-record --ipv4-address
                                               --record-set-name
                                               --resource-group
                                               --zone-name

Examples

Add an A record.

az network private-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 Private 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 private-dns record-set a create

Edit

Create an empty A record set.

az network private-dns record-set a create --name
                                           --resource-group
                                           --zone-name
                                           [--metadata]
                                           [--ttl]

Examples

Create an empty A record set.

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

Required Parameters

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

--zone-name -z

Name of the Private DNS zone (without a terminating dot).

Optional Parameters

--metadata

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

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

Edit

Delete an A record set and all associated records.

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

Examples

Delete an A record set and all associated records.

az network private-dns record-set a 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 overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting 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 Private DNS zone (without a terminating dot).

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 private-dns record-set a list

Edit

List all A record sets in a zone.

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

Examples

List all A record sets in a zone.

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

Name of the Private 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.

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 private-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 private-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 private-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 Private DNS 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 private-dns record-set a show

Edit

Get the details of an A record set.

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

Examples

Get the details of an A record set.

az network private-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 Private DNS zone (without a terminating dot).

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 private-dns record-set a update

Edit

Update an A record set.

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

Examples

Update an A record set.

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

--metadata

Metadata attached to the record set. 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.

--zone-name -z

Name of the Private DNS zone (without a terminating dot).

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 private-dns record-set a

Commands

az network private-dns record-set a add-record

Examples

Required Parameters

az network private-dns record-set a create

Examples

Required Parameters

Optional Parameters

az network private-dns record-set a delete

Examples

Optional Parameters

az network private-dns record-set a list

Examples

Required Parameters

Optional Parameters

az network private-dns record-set a remove-record

Examples

Required Parameters

Optional Parameters

az network private-dns record-set a show

Examples

Optional Parameters

az network private-dns record-set a update

Examples

Optional Parameters

Additional resources