New-AzApplicationGatewayIdentity

Module:

Az.Network

Creates an identity object for an application gateway. This will hold reference to the user assigned identity.

Syntax

New-AzApplicationGatewayIdentity
   -UserAssignedIdentityId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

New-AzApplicationGatewayIdentity cmdlet creates an application gateway identity object.

Examples

Example 1

$identity = New-AzUserAssignedIdentity -Name $identityName -ResourceGroupName $rgName -Location $location
$appgwIdentity = New-AzApplicationGatewayIdentity -UserAssignedIdentity $identity.Id
$gateway = New-AzApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -Identity $appgwIdentity <..>

In this example, we create a user assigned identity and then reference it in identity object used with Application Gateway.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserAssignedIdentityId

ResourceId of the user assigned identity to be assigned to Application Gateway.

Type:	String
Aliases:	UserAssignedIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String

Outputs

PSManagedServiceIdentity