az network private-dns record-set srv

Manage Private DNS SRV records.

Commands

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

Add an SRV record.

az network private-dns record-set srv create

Create an empty SRV record set.

az network private-dns record-set srv delete

Delete an SRV record set and all associated records.

az network private-dns record-set srv list

List all SRV record sets in a zone.

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

Remove an SRV record from its record set.

az network private-dns record-set srv show

Get the details of an SRV record set.

az network private-dns record-set srv update

Update an SRV record set.

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

Add an SRV record.

az network private-dns record-set srv add-record --port
                                                 --priority
                                                 --record-set-name
                                                 --resource-group
                                                 --target
                                                 --weight
                                                 --zone-name
                                                 [--subscription]

Examples

Add an SRV record.

az network private-dns record-set srv add-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -t webserver.mysite.com -r 8081 -p 10 -w 10

Required Parameters

--port -r

Service port.

--priority -p

Priority metric.

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

--target -t

Target domain name.

--weight -w

Weight metric.

--zone-name -z

The name of the Private DNS zone.

Optional Parameters

--subscription

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

az network private-dns record-set srv create

Create an empty SRV record set.

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

Examples

Create an empty SRV record set.

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

Create an empty SRV record set. (autogenerated)

az network private-dns record-set srv create --name MyRecordSet --resource-group MyResourceGroup --ttl 300 --zone-name www.mysite.com

Required Parameters

--name -n

The name of the record set, relative to the name of the Private DNS 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

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

--ttl

Record set TTL (time-to-live).

default value: 3600

az network private-dns record-set srv delete

Delete an SRV record set and all associated records.

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

Examples

Delete an SRV record set and all associated records.

az network private-dns record-set srv 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 Private DNS 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

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

List all SRV record sets in a zone.

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

Examples

List all SRV record sets in a zone.

az network private-dns record-set srv 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 Private DNS 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 private-dns record-set srv remove-record

Remove an SRV 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 srv remove-record --port
                                                    --priority
                                                    --record-set-name
                                                    --resource-group
                                                    --target
                                                    --weight
                                                    --zone-name
                                                    [--keep-empty-record-set]
                                                    [--subscription]

Examples

Remove an SRV record from its record set.

az network private-dns record-set srv remove-record -g MyResourceGroup -z www.mysite.com \
    -n MyRecordSet -t webserver.mysite.com -r 8081 -p 10 -w 10

Required Parameters

--port -r

Service port.

--priority -p

Priority metric.

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

--target -t

Target domain name.

--weight -w

Weight metric.

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

--subscription

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

az network private-dns record-set srv show

Get the details of an SRV record set.

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

Examples

Get the details of an SRV record set.

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

Required Parameters

--name -n

The name of the record set, relative to the name of the Private DNS 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

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

Update an SRV record set.

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

Examples

Update an SRV record set.

az network private-dns record-set srv update -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 Private DNS 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

--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 overwriting concurrent changes.

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