Skip to content

Commit 85617b3

Browse files
akshaysnguptaakshaysngupta
committed
help
1 parent 0067a4a commit 85617b3

File tree

5 files changed

+458
-1
lines changed

5 files changed

+458
-1
lines changed

‎src/Network/Network/help/Get-AzApplicationGatewayIdentity.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
3+
Module Name: Az.Network
4+
online version: https://docs.microsoft.com/en-us/powershell/module/az.network/get-azapplicationgatewayidentity
5+
schema: 2.0.0
6+
---
7+
8+
# Get-AzApplicationGatewayIdentity
9+
10+
## SYNOPSIS
11+
Get identity assigned to the application gateway.
12+
13+
## SYNTAX
14+
15+
```
16+
Get-AzApplicationGatewayIdentity -ApplicationGateway <PSApplicationGateway>
17+
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
The **Get-AzApplicationGatewayIdentity** cmdlet gets identity assigned to the application gateway.
22+
23+
## EXAMPLES
24+
25+
### Example 1
26+
```powershell
27+
PS C:\> $gw = Get-AzApplicationGateway -Name $appgwName -ResourceGroupName $resgpName
28+
PS C:\> $identity = Get-AzApplicationGatewayIdentity -ApplicationGateway $gw
29+
```
30+
31+
This examples shows how to get application gateway identity from Application Gateway.
32+
33+
## PARAMETERS
34+
35+
### -ApplicationGateway
36+
The applicationGateway
37+
38+
```yaml
39+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
40+
Parameter Sets: (All)
41+
Aliases:
42+
43+
Required: True
44+
Position: Named
45+
Default value: None
46+
Accept pipeline input: True (ByValue)
47+
Accept wildcard characters: False
48+
```
49+
50+
### -DefaultProfile
51+
The credentials, account, tenant, and subscription used for communication with Azure.
52+
53+
```yaml
54+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
55+
Parameter Sets: (All)
56+
Aliases: AzContext, AzureRmContext, AzureCredential
57+
58+
Required: False
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: False
62+
Accept wildcard characters: False
63+
```
64+
65+
### CommonParameters
66+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
67+
68+
## INPUTS
69+
70+
### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
71+
72+
## OUTPUTS
73+
74+
### Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity
75+
76+
## NOTES
77+
78+
## RELATED LINKS

‎src/Network/Network/help/New-AzApplicationGateway.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ New-AzApplicationGateway -Name <String> -ResourceGroupName <String> -Location <S
3030
[-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>]
3131
[-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>]
3232
[-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>] [-EnableHttp2] [-EnableFIPS]
33-
[-Zone <String[]>] [-Tag <Hashtable>] [-UserAssignedIdentityId <String>] [-Force] [-AsJob]
33+
[-Zone <String[]>] [-Tag <Hashtable>] [-UserAssignedIdentityId <String>]
34+
[-Identity <PSManagedServiceIdentity>] [-Force] [-AsJob]
3435
[-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>]
3536
[-WhatIf] [-Confirm] [<CommonParameters>]
3637
```
@@ -305,6 +306,21 @@ Accept pipeline input: True (ByPropertyName)
305306
Accept wildcard characters: False
306307
```
307308
309+
### -Identity
310+
Application Gateway Identity to be assigned to Application Gateway.
311+
312+
```yaml
313+
Type: Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity
314+
Parameter Sets: (All)
315+
Aliases:
316+
317+
Required: False
318+
Position: Named
319+
Default value: None
320+
Accept pipeline input: True (ByPropertyName)
321+
Accept wildcard characters: False
322+
```
323+
308324
### -Location
309325
Specifies the region in which to create the application gateway.
310326

‎src/Network/Network/help/New-AzApplicationGatewayIdentity.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
3+
Module Name: Az.Network
4+
online version: https://docs.microsoft.com/en-us/powershell/module/az.network/new-azapplicationgatewayidentity
5+
schema: 2.0.0
6+
---
7+
8+
# New-AzApplicationGatewayIdentity
9+
10+
## SYNOPSIS
11+
Creates an identity object for an application gateway. This will hold reference to the user assigned identity.
12+
13+
## SYNTAX
14+
15+
```
16+
New-AzApplicationGatewayIdentity -UserAssignedIdentityId <String> [-DefaultProfile <IAzureContextContainer>]
17+
[-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
**New-AzApplicationGatewayIdentity** cmdlet creates an application gateway identity object.
22+
23+
## EXAMPLES
24+
25+
### Example 1
26+
```powershell
27+
PS C:\>$identity = New-AzUserAssignedIdentity -Name $identityName -ResourceGroupName $rgName -Location $location
28+
PS C:\>$appgwIdentity = New-AzApplicationGatewayIdentity -UserAssignedIdentity $identity.Id
29+
```
30+
31+
In this example, we create a user assigned identity and then reference it in identity object used with Application Gateway.
32+
33+
## PARAMETERS
34+
35+
### -DefaultProfile
36+
The credentials, account, tenant, and subscription used for communication with Azure.
37+
38+
```yaml
39+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
40+
Parameter Sets: (All)
41+
Aliases: AzContext, AzureRmContext, AzureCredential
42+
43+
Required: False
44+
Position: Named
45+
Default value: None
46+
Accept pipeline input: False
47+
Accept wildcard characters: False
48+
```
49+
50+
### -UserAssignedIdentityId
51+
ResourceId of the user assigned identity to be assigned to Application Gateway.
52+
53+
```yaml
54+
Type: System.String
55+
Parameter Sets: (All)
56+
Aliases: UserAssignedIdentity
57+
58+
Required: True
59+
Position: Named
60+
Default value: None
61+
Accept pipeline input: True (ByPropertyName)
62+
Accept wildcard characters: False
63+
```
64+
65+
### -Confirm
66+
Prompts you for confirmation before running the cmdlet.
67+
68+
```yaml
69+
Type: System.Management.Automation.SwitchParameter
70+
Parameter Sets: (All)
71+
Aliases: cf
72+
73+
Required: False
74+
Position: Named
75+
Default value: None
76+
Accept pipeline input: False
77+
Accept wildcard characters: False
78+
```
79+
80+
### -WhatIf
81+
Shows what would happen if the cmdlet runs.
82+
The cmdlet is not run.
83+
84+
```yaml
85+
Type: System.Management.Automation.SwitchParameter
86+
Parameter Sets: (All)
87+
Aliases: wi
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### CommonParameters
97+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
98+
99+
## INPUTS
100+
101+
### System.String
102+
103+
## OUTPUTS
104+
105+
### Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity
106+
107+
## NOTES
108+
109+
## RELATED LINKS

‎src/Network/Network/help/Remove-AzApplicationGatewayIdentity.md

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
---
2+
external help file: Microsoft.Azure.PowerShell.Cmdlets.Network.dll-Help.xml
3+
Module Name: Az.Network
4+
online version: https://docs.microsoft.com/en-us/powershell/module/az.network/remove-azapplicationgatewayidentity
5+
schema: 2.0.0
6+
---
7+
8+
# Remove-AzApplicationGatewayIdentity
9+
10+
## SYNOPSIS
11+
Removes a identity from an application gateway.
12+
13+
## SYNTAX
14+
15+
```
16+
Remove-AzApplicationGatewayIdentity -ApplicationGateway <PSApplicationGateway> [-Force]
17+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
18+
```
19+
20+
## DESCRIPTION
21+
**Remove-AzApplicationGatewayIdentity** cmdlet removes identity from an application gateway.
22+
23+
## EXAMPLES
24+
25+
### Example 1
26+
```powershell
27+
PS C:\> $appgw = Remove-AzApplicationGatewayIdentity -ApplicationGateway $appgw
28+
PS C:\> $updatedgateway = Set-AzApplicationGateway -ApplicationGateway $appgw
29+
```
30+
31+
In this example, we remove identity from an existing application gateway.
32+
Note: If the gateway is referencing a keyvault secret, then it is also important to remove those ssl certificate references along this operation.
33+
34+
## PARAMETERS
35+
36+
### -ApplicationGateway
37+
The applicationGateway
38+
39+
```yaml
40+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
41+
Parameter Sets: (All)
42+
Aliases:
43+
44+
Required: True
45+
Position: Named
46+
Default value: None
47+
Accept pipeline input: True (ByValue)
48+
Accept wildcard characters: False
49+
```
50+
51+
### -DefaultProfile
52+
The credentials, account, tenant, and subscription used for communication with Azure.
53+
54+
```yaml
55+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
56+
Parameter Sets: (All)
57+
Aliases: AzContext, AzureRmContext, AzureCredential
58+
59+
Required: False
60+
Position: Named
61+
Default value: None
62+
Accept pipeline input: False
63+
Accept wildcard characters: False
64+
```
65+
66+
### -Force
67+
Do not ask for confirmation.
68+
69+
```yaml
70+
Type: System.Management.Automation.SwitchParameter
71+
Parameter Sets: (All)
72+
Aliases:
73+
74+
Required: False
75+
Position: Named
76+
Default value: None
77+
Accept pipeline input: False
78+
Accept wildcard characters: False
79+
```
80+
81+
### -Confirm
82+
Prompts you for confirmation before running the cmdlet.
83+
84+
```yaml
85+
Type: System.Management.Automation.SwitchParameter
86+
Parameter Sets: (All)
87+
Aliases: cf
88+
89+
Required: False
90+
Position: Named
91+
Default value: None
92+
Accept pipeline input: False
93+
Accept wildcard characters: False
94+
```
95+
96+
### -WhatIf
97+
Shows what would happen if the cmdlet runs.
98+
The cmdlet is not run.
99+
100+
```yaml
101+
Type: System.Management.Automation.SwitchParameter
102+
Parameter Sets: (All)
103+
Aliases: wi
104+
105+
Required: False
106+
Position: Named
107+
Default value: None
108+
Accept pipeline input: False
109+
Accept wildcard characters: False
110+
```
111+
112+
### CommonParameters
113+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
114+
115+
## INPUTS
116+
117+
### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
118+
119+
## OUTPUTS
120+
121+
### Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
122+
123+
## NOTES
124+
125+
## RELATED LINKS

0 commit comments

Comments
 (0)