az network private-endpoint dns-zone-group

Manage private endpoint dns zone group.

Commands

Name Description Type Status
az network private-endpoint dns-zone-group add

Add a private endpoint dns zone into a dns zone group.

Core GA
az network private-endpoint dns-zone-group create

Create a private endpoint dns zone group.

Core GA
az network private-endpoint dns-zone-group delete

Delete a private endpoint dns zone group.

Core GA
az network private-endpoint dns-zone-group list

List all private endpoint dns zone groups.

Core GA
az network private-endpoint dns-zone-group remove

Remove a private endpoint dns zone into a dns zone group.

Core GA
az network private-endpoint dns-zone-group show

Show a private endpoint dns zone group.

Core GA
az network private-endpoint dns-zone-group wait

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

Core GA

az network private-endpoint dns-zone-group add

Add a private endpoint dns zone into a dns zone group.

az network private-endpoint dns-zone-group add --endpoint-name
                                               --private-dns-zone
                                               --resource-group
                                               --zone-name
                                               [--name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Add a private endpoint dns zone group.

az network private-endpoint dns-zone-group add --endpoint-name MyPE -g MyRG -n MyZoneGroup --zone-name Zone1 --private-dns-zone PrivateDNSZone1

Required Parameters

--endpoint-name

Name of the private endpoint.

--private-dns-zone

Name or ID of the private dns zone.

--resource-group -g

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

--zone-name

Name of the resource that is unique within a resource group. This name can be used to access the resource.

Optional Parameters

--name -n

Name of the private dns zone group.

--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 network private-endpoint dns-zone-group create

Create a private endpoint dns zone group.

az network private-endpoint dns-zone-group create --endpoint-name
                                                  --name
                                                  --private-dns-zone
                                                  --resource-group
                                                  --zone-name
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create a private endpoint dns zone group.

az network private-endpoint dns-zone-group create --endpoint-name MyPE -g MyRG -n MyZoneGroup --zone-name Zone1 --private-dns-zone PrivateDNSZone1

Required Parameters

--endpoint-name

Name of the private endpoint.

--name -n

Name of the private dns zone group.

--private-dns-zone

Name or ID of the private dns zone.

--resource-group -g

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

--zone-name

Name of the private dns zone.

Optional Parameters

--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 network private-endpoint dns-zone-group delete

Delete a private endpoint dns zone group.

az network private-endpoint dns-zone-group delete [--endpoint-name]
                                                  [--ids]
                                                  [--name]
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                  [--resource-group]
                                                  [--subscription]

Examples

Delete a private endpoint dns zone group.

az network private-endpoint dns-zone-group delete --endpoint-name MyEndpoint --name MyPrivateDnsZoneGroup --resource-group MyResourceGroup

Optional Parameters

--endpoint-name

Name of the private endpoint.

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

Name of the private dns zone group.

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

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 network private-endpoint dns-zone-group list

List all private endpoint dns zone groups.

az network private-endpoint dns-zone-group list --endpoint-name
                                                --resource-group

Examples

List all private endpoint dns zone groups.

az network private-endpoint dns-zone-group list --endpoint-name MyEndpoint --resource-group MyResourceGroup

Required Parameters

--endpoint-name

Name of the private endpoint.

--resource-group -g

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

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 network private-endpoint dns-zone-group remove

Remove a private endpoint dns zone into a dns zone group.

az network private-endpoint dns-zone-group remove --endpoint-name
                                                  --name
                                                  --resource-group
                                                  --zone-name
                                                  [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Remove a private endpoint dns zone group.

az network private-endpoint dns-zone-group remove --endpoint-name MyPE -g MyRG -n MyZoneGroup --zone-name Zone1

Required Parameters

--endpoint-name

Name of the private endpoint.

--name -n

Name of the private dns zone group.

--resource-group -g

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

--zone-name

Name of the private dns zone.

Optional Parameters

--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 network private-endpoint dns-zone-group show

Show a private endpoint dns zone group.

az network private-endpoint dns-zone-group show [--endpoint-name]
                                                [--ids]
                                                [--name]
                                                [--resource-group]
                                                [--subscription]

Examples

Show a private endpoint dns zone group.

az network private-endpoint dns-zone-group show --endpoint-name MyEndpoint --name MyPrivateDnsZoneGroup --resource-group MyResourceGroup

Optional Parameters

--endpoint-name

Name of the private endpoint.

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

Name of the private dns zone group.

--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 network private-endpoint dns-zone-group wait

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

az network private-endpoint dns-zone-group wait [--created]
                                                [--custom]
                                                [--deleted]
                                                [--endpoint-name]
                                                [--exists]
                                                [--ids]
                                                [--interval]
                                                [--name]
                                                [--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
--endpoint-name

Name of the private endpoint.

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

Name of the private dns zone group.

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