az dns-resolver vnet-link

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

Manage vnet link with dns resolver.

Commands

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

Create a virtual network link to a DNS forwarding ruleset.

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

Examples

Upsert virtual network link to a DNS forwarding ruleset

az dns-resolver vnet-link create --ruleset-name "sampleDnsForwardingRuleset" --metadata additionalProp1="value1" --id "/subscriptions/0403cfa9-9659-4f33-9f30-1f191c51d111/resourceG roups/sampleVnetResourceGroupName/providers/Microsoft.Network/virtualNetworks/sampleVirtualN etwork" --resource-group "sampleResourceGroup" --name "sampleVirtualNetworkLink"

Required Parameters

--id

Resource ID.

--name --virtual-network-link-name -n

The name of the virtual network link.

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

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes

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 vnet-link delete

Deletes a virtual network link to a DNS forwarding ruleset. WARNING: This operation cannot be undone.

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

Examples

Delete virtual network link to a DNS forwarding ruleset

az dns-resolver vnet-link delete --ruleset-name "sampleDnsForwardingRuleset" --resource- group "sampleResourceGroup" --name "sampleVirtualNetworkLink"

Optional Parameters

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

--name --virtual-network-link-name -n

The name of the virtual network link.

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

--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 vnet-link list

Lists virtual network links to a DNS forwarding ruleset.

az dns-resolver vnet-link list --resource-group
                               --ruleset-name
                               [--top]

Examples

List virtual network links to a DNS forwarding ruleset

az dns-resolver vnet-link 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 vnet-link show

Gets properties of a virtual network link to a DNS forwarding ruleset.

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

Examples

Retrieve virtual network link to a DNS forwarding ruleset

az dns-resolver vnet-link show --ruleset-name "sampleDnsForwardingRuleset" --resource-group "sampleResourceGroup" --name "sampleVirtualNetworkLink"

Optional Parameters

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

--name --virtual-network-link-name -n

The name of the virtual network link.

--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 vnet-link update

Updates a virtual network link to a DNS forwarding ruleset.

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

Examples

Update virtual network link to a DNS forwarding ruleset

az dns-resolver vnet-link update --ruleset-name "sampleDnsForwardingRuleset" --metadata additionalProp1="value1" --resource-group "sampleResourceGroup" --name "sampleVirtualNetworkLink"

Optional Parameters

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

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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.

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

--name --virtual-network-link-name -n

The name of the virtual network link.

--no-wait

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

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.

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--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 vnet-link wait

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

az dns-resolver vnet-link wait [--created]
                               [--custom]
                               [--deleted]
                               [--exists]
                               [--ids]
                               [--interval]
                               [--name]
                               [--resource-group]
                               [--ruleset-name]
                               [--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

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

--name --virtual-network-link-name -n

The name of the virtual network link.

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

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