Share via

az network vnet-gateway aad

Manage AAD(Azure Active Directory) authentication of a virtual network gateway.

Commands

Name Description Type Status
az network vnet-gateway aad assign

Assign/Update AAD(Azure Active Directory) authentication to a virtual network gateway.

 Core GA
az network vnet-gateway aad remove

Remove AAD(Azure Active Directory) authentication from a virtual network gateway.

 Core GA
az network vnet-gateway aad show

Show AAD(Azure Active Directory) authentication of a virtual network gateway.

 Core GA
az network vnet-gateway aad wait

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

 Core GA

az network vnet-gateway aad assign

Edit

Assign/Update AAD(Azure Active Directory) authentication to a virtual network gateway.

az network vnet-gateway aad assign --audience
                                   --gateway-name
                                   --issuer
                                   --resource-group
                                   --tenant
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Assign AAD authentication to a virtual network gateway

az network vnet-gateway aad assign --resource-group MyResourceGroup --gateway-name MyVnetGateway --tenant MyAADTenantURI --audience MyAADAudienceId --issuer MyAADIssuerURI

Required Parameters

--audience

The AADAudience ID of the VirtualNetworkGateway.

Property Value
Parameter group: AAD Authentication Arguments
--gateway-name

Virtual network gateway name.

--issuer

The AADIssuer URI of the VirtualNetworkGateway.

Property Value
Parameter group: AAD Authentication Arguments
--resource-group -g

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

--tenant

The AADTenant URI of the VirtualNetworkGateway.

Property Value
Parameter group: AAD Authentication 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.

--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
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 network vnet-gateway aad remove

Edit

Remove AAD(Azure Active Directory) authentication from a virtual network gateway.

az network vnet-gateway aad remove --gateway-name
                                   --resource-group
                                   [--no-wait]

Examples

Remove AAD information

az network vnet-gateway aad remove --resource-group MyResourceGroup --gateway-name MyVnetGateway

Required Parameters

--gateway-name

Virtual network gateway name.

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

--no-wait

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

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.

--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 network vnet-gateway aad show

Edit

Show AAD(Azure Active Directory) authentication of a virtual network gateway.

az network vnet-gateway aad show --gateway-name
                                 --resource-group

Examples

Show AAD information

az network vnet-gateway aad show --resource-group MyResourceGroup --gateway-name MyVnetGateway

Required Parameters

--gateway-name

Virtual network gateway name.

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

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 network vnet-gateway aad wait

Edit

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

az network vnet-gateway aad wait [--created]
                                 [--custom]
                                 [--deleted]
                                 [--exists]
                                 [--gateway-name]
                                 [--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
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--gateway-name

Virtual network gateway name.

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