az dns-resolver forwarding-ruleset

  • 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 forwarding-ruleset command. Learn more about extensions.

Manage forwarding ruleset with dns resolver.

Commands

Name Description Type Status
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 forwarding-ruleset create

Create a DNS forwarding ruleset.

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

Examples

Upsert DNS forwarding ruleset

az dns-resolver forwarding-ruleset create --name "samplednsForwardingRuleset" --location "westus2" --outbound-endpoints [{id:"/subscriptions/abdd4249-9f34-4cc6-8e42-c2e32110603e/resou rceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsResolvers/sampleDnsResolver/out boundEndpoints/sampleOutboundEndpoint0"},{id:"/subscriptions/abdd4249-9f3 4-4cc6-8e42-c2e32110603e/resourceGroups/sampleResourceGroup/providers/Microsoft.Network/dnsR esolvers/sampleDnsResolver/outboundEndpoints/sampleOutboundEndpoint1"}] --tags key1="value1" --resource-group "sampleResourceGroup"

Required Parameters

--dns-forwarding-ruleset-name --name -n

The name of the DNS forwarding ruleset.

--outbound-endpoints

The reference to the DNS resolver outbound endpoints that are used to route DNS queries matching the forwarding rules in the ruleset to the target DNS servers. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--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 forwarding-ruleset delete

Deletes a DNS forwarding ruleset. WARNING: This operation cannot be undone. All forwarding rules within the ruleset will be deleted.

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

Examples

Delete DNS forwarding ruleset

az dns-resolver forwarding-ruleset delete --name "samplednsForwardingRulesetName" --resource-group "sampleResourceGroup"

Optional Parameters

--dns-forwarding-ruleset-name --name -n

The name of the DNS forwarding ruleset.

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

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

Examples

List DNS forwarding rulesets by virtual network

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

List DNS forwarding rulesets by resource group

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

List DNS forwarding rulesets by subscription

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

Lists DNS forwarding ruleset resource IDs attached to a virtual network.

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

Examples

List DNS forwarding rulesets by virtual network

az dns-resolver forwarding-ruleset 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 forwarding-ruleset show

Gets a DNS forwarding ruleset properties.

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

Examples

Retrieve DNS forwarding ruleset

az dns-resolver forwarding-ruleset show --name "sampleDnsForwardingRuleset" --resource-group "sampleResourceGroup"

Optional Parameters

--dns-forwarding-ruleset-name --name -n

The name of the DNS forwarding ruleset.

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

--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 forwarding-ruleset update

Update a DNS forwarding ruleset.

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

Examples

Update DNS forwarding ruleset

az dns-resolver forwarding-ruleset update --name "sampleDnsForwardingRuleset" --tags key1="value1" --resource-group "sampleResourceGroup"

Optional Parameters

--dns-forwarding-ruleset-name --name -n

The name of the DNS forwarding ruleset.

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

--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 forwarding-ruleset wait

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

az dns-resolver forwarding-ruleset wait [--created]
                                        [--custom]
                                        [--deleted]
                                        [--dns-forwarding-ruleset-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-forwarding-ruleset-name --name -n

The name of the DNS forwarding ruleset.

--exists

Wait until the resource exists.

default value: False
--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.

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