az network vnet-gateway aad

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

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

Commands

az network vnet-gateway aad assign	Assign/Update AAD(Azure Active Directory) authentication to a virtual network gateway.
az network vnet-gateway aad remove	Remove AAD(Azure Active Directory) authentication from a virtual network gateway.
az network vnet-gateway aad show	Show AAD(Azure Active Directory) authentication of a virtual network gateway.

az network vnet-gateway aad assign

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]

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.

--gateway-name

Virtual network gateway name.

--issuer

The AADIssuer URI of the VirtualNetworkGateway.

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

Optional Parameters

--no-wait

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

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.

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

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

--no-wait

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

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.

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

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.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

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