Skip to content

Commit 8a5ba32

Browse files
akshaysnguptaakshaysngupta
committed
help update
1 parent 7ff1390 commit 8a5ba32

File tree

4 files changed

+82
-23
lines changed

4 files changed

+82
-23
lines changed

‎src/Network/Network/help/Az.Network.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,9 @@ Gets the HTTP listener of an application gateway.
170170
### [Get-AzApplicationGatewayHttpListenerCustomError](Get-AzApplicationGatewayHttpListenerCustomError.md)
171171
Gets custom error(s) from a http listener of an application gateway.
172172

173+
### [Get-AzApplicationGatewayIdentity](Get-AzApplicationGatewayIdentity.md)
174+
Get identity assigned to the application gateway.
175+
173176
### [Get-AzApplicationGatewayIPConfiguration](Get-AzApplicationGatewayIPConfiguration.md)
174177
Gets the IP configuration of an application gateway.
175178

@@ -521,6 +524,9 @@ Creates a front-end port for an application gateway.
521524
### [New-AzApplicationGatewayHttpListener](New-AzApplicationGatewayHttpListener.md)
522525
Creates an HTTP listener for an application gateway.
523526

527+
### [New-AzApplicationGatewayIdentity](New-AzApplicationGatewayIdentity.md)
528+
Creates an identity object for an application gateway. This will hold reference to the user assigned identity.
529+
524530
### [New-AzApplicationGatewayIPConfiguration](New-AzApplicationGatewayIPConfiguration.md)
525531
Creates an IP configuration for an application gateway.
526532

@@ -805,6 +811,9 @@ Removes an HTTP listener from an application gateway.
805811
### [Remove-AzApplicationGatewayHttpListenerCustomError](Remove-AzApplicationGatewayHttpListenerCustomError.md)
806812
Removes a custom error from a http listener of an application gateway.
807813

814+
### [Remove-AzApplicationGatewayIdentity](Remove-AzApplicationGatewayIdentity.md)
815+
Removes a identity from an application gateway.
816+
808817
### [Remove-AzApplicationGatewayIPConfiguration](Remove-AzApplicationGatewayIPConfiguration.md)
809818
Removes an IP configuration from an application gateway.
810819

@@ -1039,6 +1048,9 @@ Modifies an HTTP listener for an application gateway.
10391048
### [Set-AzApplicationGatewayHttpListenerCustomError](Set-AzApplicationGatewayHttpListenerCustomError.md)
10401049
Updates a custom error in a http listener of an application gateway.
10411050

1051+
### [Set-AzApplicationGatewayIdentity](Set-AzApplicationGatewayIdentity.md)
1052+
Updates a identity assigned to the application gateway.
1053+
10421054
### [Set-AzApplicationGatewayIPConfiguration](Set-AzApplicationGatewayIPConfiguration.md)
10431055
Modifies an IP configuration for an application gateway.
10441056

@@ -1236,3 +1248,4 @@ Update-AzVpnGateway updates a scalable VPN Gateway to the appropriate goal state
12361248

12371249
### [Update-AzVpnSite](Update-AzVpnSite.md)
12381250
Updates a VpnSite representing a customer branch to an intended goal state.
1251+

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

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ Creates an application gateway.
1313

1414
## SYNTAX
1515

16+
### IdentityByUserAssignedIdentityId (Default)
1617
```
1718
New-AzApplicationGateway -Name <String> -ResourceGroupName <String> -Location <String>
1819
-Sku <PSApplicationGatewaySku> [-SslPolicy <PSApplicationGatewaySslPolicy>]
@@ -30,8 +31,30 @@ New-AzApplicationGateway -Name <String> -ResourceGroupName <String> -Location <S
3031
[-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>]
3132
[-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>]
3233
[-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>] [-EnableHttp2] [-EnableFIPS]
33-
[-Zone <String[]>] [-Tag <Hashtable>] [-UserAssignedIdentityId <String>]
34-
[-Identity <PSManagedServiceIdentity>] [-Force] [-AsJob]
34+
[-Zone <String[]>] [-Tag <Hashtable>] [-UserAssignedIdentityId <String>] [-Force] [-AsJob]
35+
[-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>]
36+
[-WhatIf] [-Confirm] [<CommonParameters>]
37+
```
38+
39+
### IdentityByIdentityObject
40+
```
41+
New-AzApplicationGateway -Name <String> -ResourceGroupName <String> -Location <String>
42+
-Sku <PSApplicationGatewaySku> [-SslPolicy <PSApplicationGatewaySslPolicy>]
43+
-GatewayIPConfigurations <PSApplicationGatewayIPConfiguration[]>
44+
[-SslCertificates <PSApplicationGatewaySslCertificate[]>]
45+
[-AuthenticationCertificates <PSApplicationGatewayAuthenticationCertificate[]>]
46+
[-TrustedRootCertificate <PSApplicationGatewayTrustedRootCertificate[]>]
47+
[-FrontendIPConfigurations <PSApplicationGatewayFrontendIPConfiguration[]>]
48+
-FrontendPorts <PSApplicationGatewayFrontendPort[]> [-Probes <PSApplicationGatewayProbe[]>]
49+
-BackendAddressPools <PSApplicationGatewayBackendAddressPool[]>
50+
-BackendHttpSettingsCollection <PSApplicationGatewayBackendHttpSettings[]>
51+
-HttpListeners <PSApplicationGatewayHttpListener[]> [-UrlPathMaps <PSApplicationGatewayUrlPathMap[]>]
52+
-RequestRoutingRules <PSApplicationGatewayRequestRoutingRule[]>
53+
[-RewriteRuleSet <PSApplicationGatewayRewriteRuleSet[]>]
54+
[-RedirectConfigurations <PSApplicationGatewayRedirectConfiguration[]>]
55+
[-WebApplicationFirewallConfiguration <PSApplicationGatewayWebApplicationFirewallConfiguration>]
56+
[-AutoscaleConfiguration <PSApplicationGatewayAutoscaleConfiguration>] [-EnableHttp2] [-EnableFIPS]
57+
[-Zone <String[]>] [-Tag <Hashtable>] -Identity <PSManagedServiceIdentity> [-Force] [-AsJob]
3558
[-CustomErrorConfiguration <PSApplicationGatewayCustomError[]>] [-DefaultProfile <IAzureContextContainer>]
3659
[-WhatIf] [-Confirm] [<CommonParameters>]
3760
```
@@ -94,6 +117,28 @@ The eighth command creates a rule for the listener.
94117
The ninth command sets the SKU.
95118
The tenth command creates the gateway using the objects set by the previous commands.
96119

120+
### Example 2: Create an application gateway with UserAssigned Identity
121+
```
122+
PS C:\> $ResourceGroup = New-AzResourceGroup -Name "ResourceGroup01" -Location "West US" -Tag @{Name = "Department"; Value = "Marketing"}
123+
PS C:\> $Subnet = New-AzVirtualNetworkSubnetConfig -Name "Subnet01" -AddressPrefix 10.0.0.0/24
124+
PS C:\> $VNet = New-AzvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01" -Location "West US" -AddressPrefix 10.0.0.0/16 -Subnet $Subnet
125+
PS C:\> $VNet = Get-AzvirtualNetwork -Name "VNet01" -ResourceGroupName "ResourceGroup01"
126+
PS C:\> $Subnet = Get-AzVirtualNetworkSubnetConfig -Name $Subnet01 -VirtualNetwork $VNet
127+
PS C:\> $GatewayIPconfig = New-AzApplicationGatewayIPConfiguration -Name "GatewayIp01" -Subnet $Subnet
128+
PS C:\> $Pool = New-AzApplicationGatewayBackendAddressPool -Name "Pool01" -BackendIPAddresses 10.10.10.1, 10.10.10.2, 10.10.10.3
129+
PS C:\> $PoolSetting = New-AzApplicationGatewayBackendHttpSettings -Name "PoolSetting01" -Port 80 -Protocol "Http" -CookieBasedAffinity "Disabled"
130+
PS C:\> $FrontEndPort = New-AzApplicationGatewayFrontendPort -Name "FrontEndPort01" -Port 80
131+
# Create a public IP address
132+
PS C:\> $PublicIp = New-AzPublicIpAddress -ResourceGroupName "ResourceGroup01" -Name "PublicIpName01" -Location "West US" -AllocationMethod "Dynamic"
133+
PS C:\> $FrontEndIpConfig = New-AzApplicationGatewayFrontendIPConfig -Name "FrontEndConfig01" -PublicIPAddress $PublicIp
134+
PS C:\> $Listener = New-AzApplicationGatewayHttpListener -Name "ListenerName01" -Protocol "Http" -FrontendIpConfiguration $FrontEndIpConfig -FrontendPort $FrontEndPort
135+
PS C:\> $Rule = New-AzApplicationGatewayRequestRoutingRule -Name "Rule01" -RuleType basic -BackendHttpSettings $PoolSetting -HttpListener $Listener -BackendAddressPool $Pool
136+
PS C:\> $Sku = New-AzApplicationGatewaySku -Name "Standard_Small" -Tier Standard -Capacity 2
137+
PS C:\> $Identity = New-AzUserAssignedIdentity -Name "Identity01" -ResourceGroupName "ResourceGroup01" -Location "West US"
138+
PS C:\> $AppgwIdentity = New-AzApplicationGatewayIdentity -UserAssignedIdentity $Identity.Id
139+
PS C:\> $Gateway = New-AzApplicationGateway -Name "AppGateway01" -ResourceGroupName "ResourceGroup01" -Location "West US" -Identity $AppgwIdentity -BackendAddressPools $Pool -BackendHttpSettingsCollection $PoolSetting -FrontendIpConfigurations $FrontEndIpConfig -GatewayIpConfigurations $GatewayIpConfig -FrontendPorts $FrontEndPort -HttpListeners $Listener -RequestRoutingRules $Rule -Sku $Sku
140+
```
141+
97142
## PARAMETERS
98143

99144
### -AsJob
@@ -311,10 +356,10 @@ Application Gateway Identity to be assigned to Application Gateway.
311356
312357
```yaml
313358
Type: Microsoft.Azure.Commands.Network.Models.PSManagedServiceIdentity
314-
Parameter Sets: (All)
359+
Parameter Sets: IdentityByIdentityObject
315360
Aliases:
316361

317-
Required: False
362+
Required: True
318363
Position: Named
319364
Default value: None
320365
Accept pipeline input: True (ByPropertyName)
@@ -522,7 +567,7 @@ ResourceId of the user assigned identity to be assigned to Application Gateway.
522567
523568
```yaml
524569
Type: System.String
525-
Parameter Sets: (All)
570+
Parameter Sets: IdentityByUserAssignedIdentityId
526571
Aliases: UserAssignedIdentity
527572

528573
Required: False

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Creates a Autoscale Configuration for the Application Gateway.
1313
## SYNTAX
1414

1515
```
16-
New-AzApplicationGatewayAutoscaleConfiguration -MinCapacity <Int32> [-MaxCapacity <Int32>] [-DefaultProfile <IAzureContextContainer>]
17-
[-WhatIf] [-Confirm] [<CommonParameters>]
16+
New-AzApplicationGatewayAutoscaleConfiguration -MinCapacity <Int32> [-MaxCapacity <Int32>]
17+
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -48,30 +48,30 @@ Accept pipeline input: False
4848
Accept wildcard characters: False
4949
```
5050
51-
### -MinCapacity
52-
Minimum capacity units that will always be available [and charged] for application gateway.
51+
### -MaxCapacity
52+
Maximum capacity units that will always be available [and charged] for application gateway.
5353
5454
```yaml
55-
Type: System.Int32
55+
Type: System.Nullable`1[System.Int32]
5656
Parameter Sets: (All)
5757
Aliases:
5858

59-
Required: True
59+
Required: False
6060
Position: Named
6161
Default value: None
6262
Accept pipeline input: False
6363
Accept wildcard characters: False
6464
```
6565
66-
### -MaxCapacity
67-
Maximum capacity units that will always be available [and charged] for application gateway.
66+
### -MinCapacity
67+
Minimum capacity units that will always be available [and charged] for application gateway.
6868
6969
```yaml
7070
Type: System.Int32
7171
Parameter Sets: (All)
7272
Aliases:
7373

74-
Required: False
74+
Required: True
7575
Position: Named
7676
Default value: None
7777
Accept pipeline input: False

‎src/Network/Network/help/Set-AzApplicationGatewayAutoscaleConfiguration.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ Updates Autoscale Configuration of an application gateway.
1313
## SYNTAX
1414

1515
```
16-
Set-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> -MinCapacity <Int32> [-MaxCapacity <Int32>]
17-
[-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
16+
Set-AzApplicationGatewayAutoscaleConfiguration -ApplicationGateway <PSApplicationGateway> -MinCapacity <Int32>
17+
[-MaxCapacity <Int32>] [-DefaultProfile <IAzureContextContainer>] [-WhatIf] [-Confirm] [<CommonParameters>]
1818
```
1919

2020
## DESCRIPTION
@@ -65,29 +65,30 @@ Accept pipeline input: False
6565
Accept wildcard characters: False
6666
```
6767
68-
### -MinCapacity
69-
Minimum capcity for application gateway.
68+
### -MaxCapacity
69+
Maximum capcity for application gateway.
7070
7171
```yaml
72-
Type: System.Int32
72+
Type: System.Nullable`1[System.Int32]
7373
Parameter Sets: (All)
7474
Aliases:
7575

76-
Required: True
76+
Required: False
7777
Position: Named
7878
Default value: None
7979
Accept pipeline input: False
8080
Accept wildcard characters: False
8181
```
82-
### -MaxCapacity
83-
Maximum capcity for application gateway.
82+
83+
### -MinCapacity
84+
Minimum capcity for application gateway.
8485
8586
```yaml
8687
Type: System.Int32
8788
Parameter Sets: (All)
8889
Aliases:
8990

90-
Required: False
91+
Required: True
9192
Position: Named
9293
Default value: None
9394
Accept pipeline input: False

0 commit comments

Comments
 (0)