az dns-resolver outbound-endpoint

Note

This reference is part of the dns-resolver extension for the Azure CLI (version 2.70.0 or higher). The extension will automatically install the first time you run an az dns-resolver outbound-endpoint command. Learn more about extensions.

Manage outbound endpoint with dns resolver.

Commands

Name	Description	Type	Status
az dns-resolver outbound-endpoint create	Create an outbound endpoint for a DNS resolver.	Extension	GA
az dns-resolver outbound-endpoint delete	Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.	Extension	GA
az dns-resolver outbound-endpoint list	Lists outbound endpoints for a DNS resolver.	Extension	GA
az dns-resolver outbound-endpoint show	Gets properties of an outbound endpoint for a DNS resolver.	Extension	GA
az dns-resolver outbound-endpoint update	Updates an outbound endpoint for a DNS resolver.	Extension	GA
az dns-resolver outbound-endpoint wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az dns-resolver outbound-endpoint create

Create an outbound endpoint for a DNS resolver.

az dns-resolver outbound-endpoint create --dns-resolver-name
                                         --id
                                         --name --outbound-endpoint-name
                                         --resource-group
                                         [--if-match]
                                         [--if-none-match]
                                         [--___location]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--tags]

Examples

Upsert outbound endpoint for DNS resolver

az dns-resolver outbound-endpoint create --dns-resolver-name "sampleDnsResolver" --name "sampleOutboundEndpoint" --___location "westus2" --id "/subscriptions/0403cfa9-9659-4f33-9f30-1 f191c51d111/resourceGroups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNe tworks/sampleVirtualNetwork/subnets/sampleSubnet" --tags key1="value1" --resource-group "sampleResourceGroup"

Required Parameters

--dns-resolver-name

The name of the DNS resolver.

--id

Resource ID.

Property	Value
Parameter group:	Subnet Arguments

--name --outbound-endpoint-name -n

The name of the outbound endpoint for the DNS resolver.

--resource-group -g

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

Optional Parameters

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

--if-match

ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

--if-none-match

Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.

--___location -l

Location. Values from: az account list-locations. You can configure the default ___location using az configure --defaults ___location=<___location>. When not specified, the ___location of the resource group will be used.

Property	Value
Parameter group:	Parameters Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters 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 dns-resolver outbound-endpoint delete

Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.

az dns-resolver outbound-endpoint delete [--dns-resolver-name]
                                         [--ids]
                                         [--if-match]
                                         [--name --outbound-endpoint-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

Delete outbound endpoint for DNS resolver

az dns-resolver outbound-endpoint delete --dns-resolver-name "sampleDnsResolver" --name "sampleOutboundEndpoint" --resource-group "sampleResourceGroup"

Optional Parameters

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

--dns-resolver-name

The name of the DNS resolver.

Property	Value
Parameter group:	Resource Id 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 resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

--name --outbound-endpoint-name -n

The name of the outbound endpoint for the DNS resolver.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

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 dns-resolver outbound-endpoint list

Lists outbound endpoints for a DNS resolver.

az dns-resolver outbound-endpoint list --dns-resolver-name
                                       --resource-group
                                       [--max-items]
                                       [--next-token]
                                       [--top]

Examples

List outbound endpoints by DNS resolver

az dns-resolver outbound-endpoint list --dns-resolver-name "sampleDnsResolver" --resource- group "sampleResourceGroup"

Required Parameters

--dns-resolver-name

The name of the DNS resolver.

--resource-group -g

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

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

--top

The maximum number of results to return. If not specified, returns up to 100 results.

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 dns-resolver outbound-endpoint show

Gets properties of an outbound endpoint for a DNS resolver.

az dns-resolver outbound-endpoint show [--dns-resolver-name]
                                       [--ids]
                                       [--name --outbound-endpoint-name]
                                       [--resource-group]
                                       [--subscription]

Examples

Retrieve outbound endpoint for DNS resolver

az dns-resolver outbound-endpoint show --dns-resolver-name "sampleDnsResolver" --name "sampleOutboundEndpoint" --resource-group "sampleResourceGroup"

Optional Parameters

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

--dns-resolver-name

The name of the DNS resolver.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--name --outbound-endpoint-name -n

The name of the outbound endpoint for the DNS resolver.

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

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 dns-resolver outbound-endpoint update

Updates an outbound endpoint for a DNS resolver.

az dns-resolver outbound-endpoint update [--add]
                                         [--dns-resolver-name]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--if-match]
                                         [--name --outbound-endpoint-name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--subscription]
                                         [--tags]

Examples

Update outbound endpoint for DNS resolver

az dns-resolver outbound-endpoint update --dns-resolver-name "sampleDnsResolver" --name "sampleOutboundEndpoint" --tags key1="value1" --resource-group "sampleResourceGroup"

Optional Parameters

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

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

--dns-resolver-name

The name of the DNS resolver.

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

Property	Value
Parameter group:	Resource Id Arguments

--if-match

ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.

--name --outbound-endpoint-name -n

The name of the outbound endpoint for the DNS resolver.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Parameters 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 dns-resolver outbound-endpoint wait

Place the CLI in a waiting state until a condition is met.

az dns-resolver outbound-endpoint wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--dns-resolver-name]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--name --outbound-endpoint-name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

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

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--dns-resolver-name

The name of the DNS resolver.

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --outbound-endpoint-name -n

The name of the outbound endpoint for the DNS resolver.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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

--verbose

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

Property	Value
Default value:	False

Share via

az dns-resolver outbound-endpoint

Commands

az dns-resolver outbound-endpoint create

Examples

Required Parameters

Optional Parameters

az dns-resolver outbound-endpoint delete

Examples

Optional Parameters

az dns-resolver outbound-endpoint list

Examples

Required Parameters

Optional Parameters

az dns-resolver outbound-endpoint show

Examples

Optional Parameters

az dns-resolver outbound-endpoint update

Examples

Optional Parameters

az dns-resolver outbound-endpoint wait

Optional Parameters

Feedback