az dns-resolver forwarding-rule

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

Property	Value
Parameter group:	Properties Arguments

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

Property	Value
Parameter group:	Properties Arguments

Optional Parameters

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

--forwarding-rule-state

The state of forwarding rule.

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

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

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

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

The name of the forwarding rule.

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.

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

--ruleset-name

The name of the DNS forwarding ruleset.

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

Lists forwarding rules in a DNS forwarding ruleset.

az dns-resolver forwarding-rule list --resource-group
                                     --ruleset-name
                                     [--max-items]
                                     [--next-token]
                                     [--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

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

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

az dns-resolver forwarding-rule show [--forwarding-rule-name --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

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

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

The name of the forwarding rule.

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

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

--ruleset-name

The name of the DNS forwarding ruleset.

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

Update a forwarding rule in a DNS forwarding ruleset.

az dns-resolver forwarding-rule update [--add]
                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                       [--forwarding-rule-name --name]
                                       [--forwarding-rule-state {Disabled, Enabled}]
                                       [--ids]
                                       [--if-match]
                                       [--metadata]
                                       [--remove]
                                       [--resource-group]
                                       [--ruleset-name]
                                       [--set]
                                       [--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

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

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

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

The name of the forwarding rule.

Property	Value
Parameter group:	Resource Id Arguments

--forwarding-rule-state

The state of forwarding rule.

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

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.

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

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

--ruleset-name

The name of the DNS forwarding ruleset.

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

--target-dns-servers

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

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