az dns-resolver policy

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

Manage DNS Resolver Policy (DNS Security Policy).

Commands

Name	Description	Type	Status
az dns-resolver policy create	Create a DNS resolver policy.	Extension	GA
az dns-resolver policy delete	Delete a DNS resolver policy. WARNING: This operation cannot be undone.	Extension	GA
az dns-resolver policy dns-security-rule	Manage DNS security rules.	Extension	GA
az dns-resolver policy dns-security-rule create	Create a DNS security rule for a DNS resolver policy.	Extension	GA
az dns-resolver policy dns-security-rule delete	Delete a DNS security rule for a DNS resolver policy. WARNING: This operation cannot be undone.	Extension	GA
az dns-resolver policy dns-security-rule list	List DNS security rules for a DNS resolver policy.	Extension	GA
az dns-resolver policy dns-security-rule show	Get properties of a DNS security rule for a DNS resolver policy.	Extension	GA
az dns-resolver policy dns-security-rule update	Update a DNS security rule for a DNS resolver policy.	Extension	GA
az dns-resolver policy dns-security-rule wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az dns-resolver policy list	List DNS resolver policies in all resource groups of a subscription.	Extension	GA
az dns-resolver policy show	Get properties of a DNS resolver policy.	Extension	GA
az dns-resolver policy update	Update a DNS resolver policy.	Extension	GA
az dns-resolver policy virtual-network	Manage vnets relevant to dns resolver policy resources.	Extension	GA
az dns-resolver policy virtual-network list-dns-resolver-policy	Lists DNS resolver policy resource IDs linked to a virtual network.	Extension	GA
az dns-resolver policy vnet-link	Manage DNS resolver policy virtual network links.	Extension	GA
az dns-resolver policy vnet-link create	Create a DNS resolver policy virtual network link.	Extension	GA
az dns-resolver policy vnet-link delete	Delete a DNS resolver policy virtual network link. WARNING: This operation cannot be undone.	Extension	GA
az dns-resolver policy vnet-link list	List DNS resolver policy virtual network links.	Extension	GA
az dns-resolver policy vnet-link show	Get properties of a DNS resolver policy virtual network link.	Extension	GA
az dns-resolver policy vnet-link update	Update a DNS resolver policy virtual network link.	Extension	GA
az dns-resolver policy vnet-link wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az dns-resolver policy wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az dns-resolver policy create

Create a DNS resolver policy.

az dns-resolver policy create --dns-resolver-policy-name --name
                              --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 policy

az dns-resolver policy create --resource-group sampleResourceGroup --dns-resolver-policy-name sampleDnsResolverPolicy --location westus2 --tags "{key1:value1}"

Required Parameters

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

The name of the DNS resolver policy.

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

The geo-location where the resource lives 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

Resource tags. 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 policy delete

Delete a DNS resolver policy. WARNING: This operation cannot be undone.

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

Examples

Delete DNS resolver policy

az dns-resolver policy delete --resource-group sampleResourceGroup --dns-resolver-policy-name sampleDnsResolverPolicy

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-policy-name --name -n

The name of the DNS resolver policy.

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.

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

List DNS resolver policies in all resource groups of a subscription.

az dns-resolver policy list [--max-items]
                            [--next-token]
                            [--resource-group]
                            [--top]

Examples

List DNS resolver policies by subscription

az dns-resolver policy list

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

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

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

Get properties of a DNS resolver policy.

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

Examples

Retrieve DNS resolver policy

az dns-resolver policy show --resource-group sampleResourceGroup --dns-resolver-policy-name sampleDnsResolverPolicy

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-policy-name --name -n

The name of the DNS resolver policy.

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

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

Update a DNS resolver policy.

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

Examples

Update DNS resolver policy

az dns-resolver policy create --resource-group sampleResourceGroup --dns-resolver-policy-name sampleDnsResolverPolicy --location westus2 --tags "{key2:value2}"

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-policy-name --name -n

The name of the DNS resolver policy.

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

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.

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

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

Resource tags. 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 policy wait

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

az dns-resolver policy wait [--created]
                            [--custom]
                            [--deleted]
                            [--dns-resolver-policy-name --name]
                            [--exists]
                            [--ids]
                            [--interval]
                            [--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-policy-name --name -n

The name of the DNS resolver policy.

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

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

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