az network dns record-set txt

Manage DNS TXT records.

Commands

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

az network dns record-set txt add-record

Add a TXT record.

az network dns record-set txt add-record --record-set-name
                                         --resource-group
                                         --value
                                         --zone-name
                                         [--if-none-match]

Examples

Add a TXT record.

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

Optional Parameters

--if-none-match

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

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

Create a TXT record set.

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

Examples

Create a TXT record set.

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

Delete a TXT record set.

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

Examples

Delete a TXT record set.

az network 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 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 txt list

List TXT record sets in a zone.

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

Examples

List TXT record sets in a zone.

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

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

Get a TXT record set.

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

Examples

Get a TXT record set.

az network 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 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 txt update

Update a TXT record set.

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

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

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

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