az dns-resolver

Reference

Note

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

Manage Dns Resolver.

Commands

Name	Description	Type	Status
az dns-resolver create	Create a DNS resolver.	Extension	GA
az dns-resolver delete	Deletes a DNS resolver. WARNING: This operation cannot be undone.	Extension	GA
az dns-resolver forwarding-rule	Manage forwarding rule with dns resolver.	Extension	GA
az dns-resolver forwarding-rule create	Create a forwarding rule in a DNS forwarding ruleset.	Extension	GA
az dns-resolver forwarding-rule delete	Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.	Extension	GA
az dns-resolver forwarding-rule list	Lists forwarding rules in a DNS forwarding ruleset.	Extension	GA
az dns-resolver forwarding-rule show	Gets properties of a forwarding rule in a DNS forwarding ruleset.	Extension	GA
az dns-resolver forwarding-rule update	Update a forwarding rule in a DNS forwarding ruleset.	Extension	GA
az dns-resolver forwarding-ruleset	Manage forwarding ruleset with dns resolver.	Extension	GA
az dns-resolver forwarding-ruleset create	Create a DNS forwarding ruleset.	Extension	GA
az dns-resolver forwarding-ruleset delete	Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.	Extension	GA
az dns-resolver forwarding-ruleset list	Lists DNS forwarding ruleset resource IDs attached to a virtual network. And Lists DNS forwarding rulesets within a resource group. And Lists DNS forwarding rulesets in all resource groups of a subscription.	Extension	GA
az dns-resolver forwarding-ruleset list-by-virtual-network	Lists DNS forwarding ruleset resource IDs attached to a virtual network.	Extension	GA
az dns-resolver forwarding-ruleset show	Gets a DNS forwarding ruleset properties.	Extension	GA
az dns-resolver forwarding-ruleset update	Update a DNS forwarding ruleset.	Extension	GA
az dns-resolver forwarding-ruleset wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az dns-resolver inbound-endpoint	Manage inbound endpoint with dns resolver.	Extension	GA
az dns-resolver inbound-endpoint create	Create an inbound endpoint for a DNS resolver.	Extension	GA
az dns-resolver inbound-endpoint delete	Deletes an inbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.	Extension	GA
az dns-resolver inbound-endpoint list	Lists inbound endpoints for a DNS resolver.	Extension	GA
az dns-resolver inbound-endpoint show	Gets properties of an inbound endpoint for a DNS resolver.	Extension	GA
az dns-resolver inbound-endpoint update	Updates an inbound endpoint for a DNS resolver.	Extension	GA
az dns-resolver inbound-endpoint wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az dns-resolver list	Lists DNS resolver resource IDs linked to a virtual network. And Lists DNS resolvers within a resource group. And Lists DNS resolvers in all resource groups of a subscription.	Extension	GA
az dns-resolver list-by-virtual-network	Lists DNS resolver resource IDs linked to a virtual network.	Extension	GA
az dns-resolver outbound-endpoint	Manage outbound endpoint with dns resolver.	Extension	GA
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 show	Gets properties of a DNS resolver.	Extension	GA
az dns-resolver update	Updates a DNS resolver.	Extension	GA
az dns-resolver vnet-link	Manage vnet link with dns resolver.	Extension	GA
az dns-resolver vnet-link create	Create a virtual network link to a DNS forwarding ruleset.	Extension	GA
az dns-resolver vnet-link delete	Deletes a virtual network link to a DNS forwarding ruleset. WARNING: This operation cannot be undone.	Extension	GA
az dns-resolver vnet-link list	Lists virtual network links to a DNS forwarding ruleset.	Extension	GA
az dns-resolver vnet-link show	Gets properties of a virtual network link to a DNS forwarding ruleset.	Extension	GA
az dns-resolver vnet-link update	Updates a virtual network link to a DNS forwarding ruleset.	Extension	GA
az dns-resolver vnet-link wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az dns-resolver wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az dns-resolver create

Create a DNS resolver.

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

Examples

Upsert DNS resolver

az dns-resolver create --name "sampleDnsResolver" --location "westus2" --id "/subscriptions/ cbb1387e-4b03-44f2-ad41-58d4677b9873/resourceGroups/virtualNetworkResourceGroup/providers/Mi crosoft.Network/virtualNetworks/sampleVirtualNetwork" --tags key1="value1" --resource-group "sampleResourceGroup"

Required Parameters

--dns-resolver-name --name -n

The name of the DNS resolver.

--id

Resource ID.

--resource-group -g

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

Optional Parameters

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

--no-wait

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

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.

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 dns-resolver delete

Deletes a DNS resolver. WARNING: This operation cannot be undone.

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

Examples

Delete DNS resolver

az dns-resolver delete --name "sampleDnsResolver" --resource-group "sampleResourceGroup"

Optional Parameters

--dns-resolver-name --name -n

The name of the DNS resolver.

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

--no-wait

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

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

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

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

Lists DNS resolver resource IDs linked to a virtual network. And Lists DNS resolvers within a resource group. And Lists DNS resolvers in all resource groups of a subscription.

az dns-resolver list [--resource-group]
                     [--top]
                     [--virtual-network-name]

Examples

List DNS resolvers by virtual network

az dns-resolver list --resource-group "sampleResourceGroup" --virtual-network-name "sampleVirtualNetwork"

List DNS resolvers by resource group

az dns-resolver list --resource-group "sampleResourceGroup"

List DNS resolvers by subscription

az dns-resolver list

Optional Parameters

--resource-group -g

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

--top

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

--virtual-network-name

The name of the virtual network.

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 dns-resolver list-by-virtual-network

Lists DNS resolver resource IDs linked to a virtual network.

az dns-resolver list-by-virtual-network --resource-group
                                        --virtual-network-name
                                        [--top]

Examples

List DNS resolvers by virtual network

az dns-resolver list --resource-group "sampleResourceGroup" --virtual-network-name "sampleVirtualNetwork"

Required Parameters

--resource-group -g

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

--virtual-network-name

The name of the virtual network.

Optional Parameters

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

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

Gets properties of a DNS resolver.

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

Examples

Retrieve DNS resolver

az dns-resolver show --name "sampleDnsResolver" --resource-group "sampleResourceGroup"

Optional Parameters

--dns-resolver-name --name -n

The name of the DNS resolver.

--ids

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

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

Updates a DNS resolver.

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

Examples

Update DNS resolver

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

Optional Parameters

--dns-resolver-name --name -n

The name of the DNS resolver.

--ids

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

--no-wait

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

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

--subscription

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

--tags

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

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 dns-resolver wait

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

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

Optional Parameters

--created

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

Default value: False

--custom

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

--deleted

Wait until deleted.

Default value: False

--dns-resolver-name --name -n

The name of the DNS resolver.

--exists

Wait until the resource exists.

Default value: False

--ids

--interval

Polling interval in seconds.

Default value: 30

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

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.

Share via

az dns-resolver

Commands

az dns-resolver create

Examples

Required Parameters

Optional Parameters

az dns-resolver delete

Examples

Optional Parameters

az dns-resolver list

Examples

Optional Parameters

az dns-resolver list-by-virtual-network

Examples

Required Parameters

Optional Parameters

az dns-resolver show

Examples

Optional Parameters

az dns-resolver update

Examples

Optional Parameters

az dns-resolver wait

Optional Parameters

Additional resources