az network private-dns record-set txt

Manage Private DNS TXT records.

Commands

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

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

Add a TXT record.

az network private-dns record-set txt add-record --record-set-name
                                                 --resource-group
                                                 --value
                                                 --zone-name

Examples

Add a TXT record.

az network private-dns record-set txt add-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -v Owner=WebTeam

Required Parameters

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

--value -v

Space-separated list of text values which will be concatenated together.

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

Create an empty TXT record set.

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

Examples

Create an empty TXT record set.

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

Delete a TXT record set and all associated records.

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

Examples

Delete a TXT record set and all associated records.

az network private-dns record-set txt 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 txt list

List all TXT record sets in a zone.

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

Examples

List all TXT record sets in a zone.

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

Remove a TXT 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 txt remove-record --record-set-name
                                                    --resource-group
                                                    --value
                                                    --zone-name
                                                    [--keep-empty-record-set]

Examples

Remove a TXT record from its record set.

az network private-dns record-set txt remove-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -v Owner=WebTeam

Required Parameters

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

--value -v

Space-separated list of text values which will be concatenated together.

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

Get the details of a TXT record set.

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

Examples

Get the details of a TXT record set.

az network private-dns record-set txt 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 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 txt update

Update a TXT record set.

az network private-dns record-set txt 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 a TXT record set.

az network private-dns record-set txt 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.

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

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