Share via

az dns-resolver forwarding-rule

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

Manage forwarding rule with dns resolver.

Commands

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

Create a forwarding rule in a DNS forwarding ruleset.

az dns-resolver forwarding-rule create --domain-name
                                       --forwarding-rule-name
                                       --resource-group
                                       --ruleset-name
                                       --target-dns-servers
                                       [--forwarding-rule-state {Disabled, Enabled}]
                                       [--if-match]
                                       [--if-none-match]
                                       [--metadata]

Examples

Upsert forwarding rule in a DNS forwarding ruleset

az dns-resolver forwarding-rule create --ruleset-name "sampleDnsForwardingRuleset" --name "sampleForwardingRule" --domain-name "contoso.com." --forwarding-rule-state "Enabled" --metadata additionalProp1="value1" --target-dns-servers [{ip-address:"10.0.0.1",port:53},{ip-address:"10.0.0.2",port:53}] --resource-group "sampleResourceGroup"

Required Parameters

--domain-name

The domain name for the forwarding rule.

--forwarding-rule-name --name -n

The name of the forwarding rule.

--resource-group -g

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

--ruleset-name

The name of the DNS forwarding ruleset.

--target-dns-servers

DNS servers to forward the DNS query to. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--forwarding-rule-state

The state of forwarding rule.

Accepted values: Disabled, Enabled
--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.

--metadata

Metadata attached to the forwarding rule. Expect value: KEY1=VALUE1 KEY2=VALUE2 ... 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-rule delete

Deletes a forwarding rule in a DNS forwarding ruleset. WARNING: This operation cannot be undone.

az dns-resolver forwarding-rule delete [--forwarding-rule-name]
                                       [--ids]
                                       [--if-match]
                                       [--resource-group]
                                       [--ruleset-name]
                                       [--subscription]
                                       [--yes]

Examples

Delete forwarding rule in a DNS forwarding ruleset

az dns-resolver forwarding-rule delete --ruleset-name "sampleDnsForwardingRuleset" --name "sampleForwardingRule" --resource-group "sampleResourceGroup"

Optional Parameters

--forwarding-rule-name --name -n

The name of the forwarding rule.

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

--resource-group -g

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

--ruleset-name

The name of the DNS forwarding ruleset.

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

Lists forwarding rules in a DNS forwarding ruleset.

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

Examples

List forwarding rules in a DNS forwarding ruleset

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

Required Parameters

--resource-group -g

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

--ruleset-name

The name of the DNS forwarding ruleset.

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

Gets properties of a forwarding rule in a DNS forwarding ruleset.

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

Examples

Retrieve forwarding rule in a DNS forwarding ruleset

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

Optional Parameters

--forwarding-rule-name --name -n

The name of the forwarding rule.

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

--ruleset-name

The name of the DNS forwarding ruleset.

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

Update a forwarding rule in a DNS forwarding ruleset.

az dns-resolver forwarding-rule update [--forwarding-rule-name]
                                       [--forwarding-rule-state {Disabled, Enabled}]
                                       [--ids]
                                       [--if-match]
                                       [--metadata]
                                       [--resource-group]
                                       [--ruleset-name]
                                       [--subscription]
                                       [--target-dns-servers]

Examples

Update forwarding rule in a DNS forwarding ruleset

az dns-resolver forwarding-rule update --ruleset-name "sampleDnsForwardingRuleset" --name "sampleForwardingRule" --forwarding-rule-state "Disabled" --metadata additionalProp2="value2" --resource-group "sampleResourceGroup"

Optional Parameters

--forwarding-rule-name --name -n

The name of the forwarding rule.

--forwarding-rule-state

The state of forwarding rule.

Accepted values: Disabled, Enabled
--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.

--metadata

Metadata attached to the forwarding rule. Expect value: KEY1=VALUE1 KEY2=VALUE2 ... 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>.

--ruleset-name

The name of the DNS forwarding ruleset.

--subscription

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

--target-dns-servers

DNS servers to forward the DNS query to. 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.