az network dns record-set txt

Manage DNS TXT records.

Commands

az network dns record-set txt add-record

Add a TXT record.

az network dns record-set txt create

Create an empty TXT record set.

az network dns record-set txt delete

Delete a TXT record set and all associated records.

az network dns record-set txt list

List all TXT record sets in a zone.

az network dns record-set txt remove-record

Remove a TXT record from its record set.

az network dns record-set txt show

Get the details of a TXT record set.

az network dns record-set txt update

Update a TXT record set.

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]
                                         [--subscription]

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.

--subscription

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

az network dns record-set txt create

Create an empty TXT record set.

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

Examples

Create an empty TXT record set.

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

Create an empty TXT record set. (autogenerated)

az network dns record-set txt create --name MyRecordSet --resource-group MyResourceGroup --ttl 30 --zone-name www.mysite.com

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

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 overwritting any concurrent changes.

--if-none-match

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

--metadata

Metadata in space-separated key=value pairs. This overwrites any existing metadata.

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

--ttl

Record set TTL (time-to-live).

default value: 3600

az network dns record-set txt delete

Delete a TXT record set and all associated records.

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

Examples

Delete a TXT record set and all associated records.

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

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

Optional Parameters

--if-match

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

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

az network dns record-set txt list

List all TXT record sets in a zone.

az network dns record-set txt list --resource-group
                                   --zone-name
                                   [--query-examples]
                                   [--subscription]

Examples

List all 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 zone.

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

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]
                                            [--subscription]

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.

--subscription

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

az network dns record-set txt show

Get the details of a TXT record set.

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

Examples

Get the details of a TXT record set.

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

Get the details of a TXT record set. (autogenerated)

az network dns record-set txt show --name MyRecordSet --resource-group MyResourceGroup --subscription MySubscription --zone-name www.mysite.com

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

Optional Parameters

--query-examples

Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.

--subscription

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

az network dns record-set txt update

Update a TXT record set.

az network dns record-set txt update --name
                                     --resource-group
                                     --zone-name
                                     [--add]
                                     [--force-string]
                                     [--if-match]
                                     [--if-none-match]
                                     [--metadata]
                                     [--remove]
                                     [--set]
                                     [--subscription]
                                     [--target-resource]

Examples

Update a TXT record set.

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

Update a TXT record set. (autogenerated)

az network dns record-set txt update --name MyRecordSet --resource-group MyResourceGroup --set tags.CostCenter=MyBusinessGroup --zone-name www.mysite.com

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

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.

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

--remove

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

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