az network private-dns record-set srv

Manage Private DNS SRV records.

Commands

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

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
                                                 [--acquire-policy-token]
                                                 [--change-reference]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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
                                             [--acquire-policy-token]
                                             [--change-reference]
                                             [--metadata]
                                             [--ttl]

Examples

Create an empty SRV record set.

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Default value:	3600

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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 [--acquire-policy-token]
                                             [--change-reference]
                                             [--ids]
                                             [--if-match]
                                             [--name]
                                             [--resource-group]
                                             [--subscription]
                                             [--yes]
                                             [--zone-name]

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	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.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

--zone-name -z

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

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
                                           [--max-items]
                                           [--next-token]

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

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
                                                    [--acquire-policy-token]
                                                    [--change-reference]
                                                    [--keep-empty-record-set]

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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--keep-empty-record-set

Keep the empty record set if the last record is removed.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az network private-dns record-set srv show

Get the details of an SRV record set.

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Resource Id Arguments

--name -n

Name of the record set, relative to the name of the zone.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--zone-name -z

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network private-dns record-set srv update

Update an SRV record set.

az network private-dns record-set srv update [--acquire-policy-token]
                                             [--add]
                                             [--change-reference]
                                             [--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 SRV record set.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

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

Property	Value
Parameter group:	Generic Update Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	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.

Property	Value
Parameter group:	Resource Id Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--zone-name -z

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False