Skip to content

Commit a57565d

Browse files
Regenerate help for Az.Network (#21533)
* docs: regenerate help for Az.Network * test: update static analysis exceptions * docs: fix autogeneration error * docs: minor wording update --------- Co-authored-by: Yunchi Wang <[email protected]>
1 parent b4fb4ea commit a57565d

File tree

535 files changed

+4985
-4110
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

535 files changed

+4985
-4110
lines changed

src/Network/Network/help/Add-AzApplicationGatewayAuthenticationCertificate.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ Accept wildcard characters: False
128128
```
129129
130130
### CommonParameters
131-
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).
131+
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).
132132
133133
## INPUTS
134134

src/Network/Network/help/Add-AzApplicationGatewayBackendAddressPool.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Accept wildcard characters: False
150150
```
151151
152152
### CommonParameters
153-
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).
153+
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).
154154
155155
## INPUTS
156156

src/Network/Network/help/Add-AzApplicationGatewayBackendHttpSetting.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ The first command gets the application gateway named ApplicationGateway01 that b
4242
Adds back-end HTTP settings to an application gateway. (autogenerated)
4343

4444
<!-- Aladdin Generated Example -->
45+
46+
4547
```powershell
4648
Add-AzApplicationGatewayBackendHttpSetting -ApplicationGateway <PSApplicationGateway> -CookieBasedAffinity Enabled -Name 'Setting02' -PickHostNameFromBackendAddress -Port 88 -Probe <PSApplicationGatewayProbe> -Protocol http -RequestTimeout <Int32>
4749
```
@@ -294,7 +296,7 @@ Accept wildcard characters: False
294296
```
295297
296298
### CommonParameters
297-
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).
299+
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).
298300
299301
## INPUTS
300302

src/Network/Network/help/Add-AzApplicationGatewayBackendSetting.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The first command gets the application gateway named ApplicationGateway01 that b
3939
Specifies the name of application gateway for which this cmdlet adds settings.
4040

4141
```yaml
42-
Type: PSApplicationGateway
42+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
4343
Parameter Sets: (All)
4444
Aliases:
4545

@@ -54,7 +54,7 @@ Accept wildcard characters: False
5454
The credentials, account, tenant, and subscription used for communication with Azure.
5555
5656
```yaml
57-
Type: IAzureContextContainer
57+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
5858
Parameter Sets: (All)
5959
Aliases: AzContext, AzureRmContext, AzureCredential
6060

@@ -69,7 +69,7 @@ Accept wildcard characters: False
6969
Sets host header to be sent to the backend servers.
7070
7171
```yaml
72-
Type: String
72+
Type: System.String
7373
Parameter Sets: (All)
7474
Aliases:
7575

@@ -84,7 +84,7 @@ Accept wildcard characters: False
8484
The name of the backend settings
8585
8686
```yaml
87-
Type: String
87+
Type: System.String
8888
Parameter Sets: (All)
8989
Aliases:
9090

@@ -99,7 +99,7 @@ Accept wildcard characters: False
9999
Flag if host header should be picked from the host name of the backend server.
100100
101101
```yaml
102-
Type: SwitchParameter
102+
Type: System.Management.Automation.SwitchParameter
103103
Parameter Sets: (All)
104104
Aliases:
105105

@@ -114,7 +114,7 @@ Accept wildcard characters: False
114114
Port
115115
116116
```yaml
117-
Type: Int32
117+
Type: System.Int32
118118
Parameter Sets: (All)
119119
Aliases:
120120

@@ -129,7 +129,7 @@ Accept wildcard characters: False
129129
Application gateway Probe
130130
131131
```yaml
132-
Type: PSApplicationGatewayProbe
132+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe
133133
Parameter Sets: (All)
134134
Aliases:
135135

@@ -144,7 +144,7 @@ Accept wildcard characters: False
144144
ID of the application gateway Probe
145145
146146
```yaml
147-
Type: String
147+
Type: System.String
148148
Parameter Sets: (All)
149149
Aliases:
150150

@@ -159,7 +159,7 @@ Accept wildcard characters: False
159159
Protocol
160160
161161
```yaml
162-
Type: String
162+
Type: System.String
163163
Parameter Sets: (All)
164164
Aliases:
165165
Accepted values: TCP, TLS
@@ -176,7 +176,7 @@ Timeout.
176176
Default value 30 seconds.
177177
178178
```yaml
179-
Type: Int32
179+
Type: System.Int32
180180
Parameter Sets: (All)
181181
Aliases:
182182

@@ -191,7 +191,7 @@ Accept wildcard characters: False
191191
Application gateway Trusted Root Certificates
192192
193193
```yaml
194-
Type: PSApplicationGatewayTrustedRootCertificate[]
194+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayTrustedRootCertificate[]
195195
Parameter Sets: (All)
196196
Aliases:
197197

src/Network/Network/help/Add-AzApplicationGatewayCustomError.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This command adds a custom error of http status code 502 to the application gate
3636

3737
### Example 2: Adds custom error to application gateway listener level
3838
```powershell
39-
$resourceGroupName = "resourceGroupName"
39+
$resourceGroupName = "resourceGroupName"
4040
$AppGWName = "applicationGatewayName"
4141
$customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm"
4242
$listenerName = "listenerName"
@@ -111,7 +111,7 @@ Accept wildcard characters: False
111111
```
112112
113113
### CommonParameters
114-
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+
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).
115115
116116
## INPUTS
117117

src/Network/Network/help/Add-AzApplicationGatewayFrontendIPConfig.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ The fourth command adds a front-end IP configuration named FrontendIP02 using $S
8181
Specifies the application gateway to which this cmdlet adds a front-end IP configuration.
8282

8383
```yaml
84-
Type: PSApplicationGateway
84+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
8585
Parameter Sets: (All)
8686
Aliases:
8787

@@ -96,7 +96,7 @@ Accept wildcard characters: False
9696
The credentials, account, tenant, and subscription used for communication with azure.
9797
9898
```yaml
99-
Type: IAzureContextContainer
99+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
100100
Parameter Sets: (All)
101101
Aliases: AzContext, AzureRmContext, AzureCredential
102102

@@ -111,7 +111,7 @@ Accept wildcard characters: False
111111
Specifies the name of the front-end IP configuration to add.
112112
113113
```yaml
114-
Type: String
114+
Type: System.String
115115
Parameter Sets: (All)
116116
Aliases:
117117

@@ -127,7 +127,7 @@ Specifies the private IP address to add as a front-end IP for the application ga
127127
If specified, this IP is statically allocated from the subnet.
128128
129129
```yaml
130-
Type: String
130+
Type: System.String
131131
Parameter Sets: (All)
132132
Aliases:
133133

@@ -142,7 +142,7 @@ Accept wildcard characters: False
142142
PrivateLinkConfiguration
143143
144144
```yaml
145-
Type: PSApplicationGatewayPrivateLinkConfiguration
145+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkConfiguration
146146
Parameter Sets: SetByResource
147147
Aliases:
148148

@@ -157,7 +157,7 @@ Accept wildcard characters: False
157157
PrivateLinkConfigurationId
158158
159159
```yaml
160-
Type: String
160+
Type: System.String
161161
Parameter Sets: SetByResourceId
162162
Aliases:
163163

@@ -172,7 +172,7 @@ Accept wildcard characters: False
172172
Specifies the public IP address which this cmdlet adds as a front-end IP address for the application gateway.
173173
174174
```yaml
175-
Type: PSPublicIpAddress
175+
Type: Microsoft.Azure.Commands.Network.Models.PSPublicIpAddress
176176
Parameter Sets: SetByResource
177177
Aliases:
178178

@@ -187,7 +187,7 @@ Accept wildcard characters: False
187187
Specifies the ID of the public IP address which this cmdlet adds as a front-end IP address for the application gateway.
188188
189189
```yaml
190-
Type: String
190+
Type: System.String
191191
Parameter Sets: SetByResourceId
192192
Aliases:
193193

@@ -205,7 +205,7 @@ If the *PrivateIPAddress* parameter is specified, it should belong to this subne
205205
If *PrivateIPAddress* is not specified, one of the IP addresses from this subnet is dynamically picked up as the front-end IP address of the application gateway.
206206
207207
```yaml
208-
Type: PSSubnet
208+
Type: Microsoft.Azure.Commands.Network.Models.PSSubnet
209209
Parameter Sets: SetByResource
210210
Aliases:
211211

@@ -223,7 +223,7 @@ If the *PrivateIPAddress* parameter is specified, it should belong to this subne
223223
Otherwise, one of the IP from this subnet is dynamically picked up as the front-end IP of the application gateway.
224224
225225
```yaml
226-
Type: String
226+
Type: System.String
227227
Parameter Sets: SetByResourceId
228228
Aliases:
229229

src/Network/Network/help/Add-AzApplicationGatewayFrontendPort.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ Accept wildcard characters: False
9595
```
9696
9797
### CommonParameters
98-
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+
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).
9999
100100
## INPUTS
101101

src/Network/Network/help/Add-AzApplicationGatewayHttpListenerCustomError.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Accept wildcard characters: False
9494
```
9595
9696
### 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).
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).
9898
9999
## INPUTS
100100

src/Network/Network/help/Add-AzApplicationGatewayIPConfiguration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ Accept wildcard characters: False
124124
```
125125
126126
### CommonParameters
127-
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).
127+
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).
128128
129129
## INPUTS
130130

src/Network/Network/help/Add-AzApplicationGatewayPrivateLinkConfiguration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The third command adds the private link configuration named privateLinkConfig01,
4040
The applicationGateway
4141

4242
```yaml
43-
Type: PSApplicationGateway
43+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
4444
Parameter Sets: (All)
4545
Aliases:
4646

@@ -55,7 +55,7 @@ Accept wildcard characters: False
5555
The credentials, account, tenant, and subscription used for communication with Azure.
5656
5757
```yaml
58-
Type: IAzureContextContainer
58+
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
5959
Parameter Sets: (All)
6060
Aliases: AzContext, AzureRmContext, AzureCredential
6161

@@ -70,7 +70,7 @@ Accept wildcard characters: False
7070
The list of ipConfiguration
7171
7272
```yaml
73-
Type: PSApplicationGatewayPrivateLinkIpConfiguration[]
73+
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkIpConfiguration[]
7474
Parameter Sets: (All)
7575
Aliases:
7676

@@ -85,7 +85,7 @@ Accept wildcard characters: False
8585
The name of the privateLink configuration
8686
8787
```yaml
88-
Type: String
88+
Type: System.String
8989
Parameter Sets: (All)
9090
Aliases:
9191

0 commit comments

Comments
 (0)