Skip to content

Commit

Permalink
Regenerate help for Az.Network (#21533)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
prototypicalpro and wyunchi-ms authored Apr 20, 2023
1 parent b4fb4ea commit a57565d
Show file tree
Hide file tree
Showing 535 changed files with 4,985 additions and 4,110 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ The first command gets the application gateway named ApplicationGateway01 that b
Adds back-end HTTP settings to an application gateway. (autogenerated)

<!-- Aladdin Generated Example -->


```powershell
Add-AzApplicationGatewayBackendHttpSetting -ApplicationGateway <PSApplicationGateway> -CookieBasedAffinity Enabled -Name 'Setting02' -PickHostNameFromBackendAddress -Port 88 -Probe <PSApplicationGatewayProbe> -Protocol http -RequestTimeout <Int32>
```
Expand Down Expand Up @@ -294,7 +296,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
22 changes: 11 additions & 11 deletions src/Network/Network/help/Add-AzApplicationGatewayBackendSetting.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The first command gets the application gateway named ApplicationGateway01 that b
Specifies the name of application gateway for which this cmdlet adds settings.

```yaml
Type: PSApplicationGateway
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
Parameter Sets: (All)
Aliases:

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

Expand All @@ -69,7 +69,7 @@ Accept wildcard characters: False
Sets host header to be sent to the backend servers.
```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

Expand All @@ -84,7 +84,7 @@ Accept wildcard characters: False
The name of the backend settings
```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

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

Expand All @@ -114,7 +114,7 @@ Accept wildcard characters: False
Port
```yaml
Type: Int32
Type: System.Int32
Parameter Sets: (All)
Aliases:

Expand All @@ -129,7 +129,7 @@ Accept wildcard characters: False
Application gateway Probe
```yaml
Type: PSApplicationGatewayProbe
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayProbe
Parameter Sets: (All)
Aliases:

Expand All @@ -144,7 +144,7 @@ Accept wildcard characters: False
ID of the application gateway Probe
```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

Expand All @@ -159,7 +159,7 @@ Accept wildcard characters: False
Protocol
```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:
Accepted values: TCP, TLS
Expand All @@ -176,7 +176,7 @@ Timeout.
Default value 30 seconds.
```yaml
Type: Int32
Type: System.Int32
Parameter Sets: (All)
Aliases:

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ This command adds a custom error of http status code 502 to the application gate

### Example 2: Adds custom error to application gateway listener level
```powershell
$resourceGroupName = "resourceGroupName"
$resourceGroupName = "resourceGroupName"
$AppGWName = "applicationGatewayName"
$customError502Url = "https://mycustomerrorpages.blob.core.windows.net/errorpages/502.htm"
$listenerName = "listenerName"
Expand Down Expand Up @@ -111,7 +111,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The fourth command adds a front-end IP configuration named FrontendIP02 using $S
Specifies the application gateway to which this cmdlet adds a front-end IP configuration.

```yaml
Type: PSApplicationGateway
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
Parameter Sets: (All)
Aliases:

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

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

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

Expand All @@ -142,7 +142,7 @@ Accept wildcard characters: False
PrivateLinkConfiguration
```yaml
Type: PSApplicationGatewayPrivateLinkConfiguration
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGatewayPrivateLinkConfiguration
Parameter Sets: SetByResource
Aliases:

Expand All @@ -157,7 +157,7 @@ Accept wildcard characters: False
PrivateLinkConfigurationId
```yaml
Type: String
Type: System.String
Parameter Sets: SetByResourceId
Aliases:

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

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

Expand All @@ -205,7 +205,7 @@ If the *PrivateIPAddress* parameter is specified, it should belong to this subne
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.
```yaml
Type: PSSubnet
Type: Microsoft.Azure.Commands.Network.Models.PSSubnet
Parameter Sets: SetByResource
Aliases:

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The third command adds the private link configuration named privateLinkConfig01,
The applicationGateway

```yaml
Type: PSApplicationGateway
Type: Microsoft.Azure.Commands.Network.Models.PSApplicationGateway
Parameter Sets: (All)
Aliases:

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

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

Expand All @@ -85,7 +85,7 @@ Accept wildcard characters: False
The name of the privateLink configuration
```yaml
Type: String
Type: System.String
Parameter Sets: (All)
Aliases:

Expand Down
19 changes: 17 additions & 2 deletions src/Network/Network/help/Add-AzApplicationGatewayProbeConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Adds a health probe to an Application Gateway.
```
Add-AzApplicationGatewayProbeConfig -ApplicationGateway <PSApplicationGateway> -Name <String>
-Protocol <String> [-HostName <String>] [-Path <String>] -Interval <Int32> -Timeout <Int32>
-UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] [-MinServers <Int32>]
-UnhealthyThreshold <Int32> [-PickHostNameFromBackendHttpSettings] [-MinServers <Int32>] [-Port <Int32>]
[-Match <PSApplicationGatewayProbeHealthResponseMatch>] [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
```
Expand Down Expand Up @@ -177,6 +177,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -Port
Port that is used for probing the backend server
```yaml
Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### -Protocol
Specifies the protocol used to send probe.
This cmdlet supports HTTP only.
Expand Down Expand Up @@ -229,7 +244,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@ The second command adds the redirect configuration to the application gateway.
Adds a redirect configuration to an Application Gateway. (autogenerated)

<!-- Aladdin Generated Example -->


```powershell
Add-AzApplicationGatewayRedirectConfiguration -ApplicationGateway <PSApplicationGateway> -IncludePath $false -IncludeQueryString $false -Name 'Redirect01' -RedirectType Permanent -TargetListener <PSApplicationGatewayHttpListener>
```
Expand Down Expand Up @@ -197,7 +199,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Accept wildcard characters: False
```
### CommonParameters
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).
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).
## INPUTS
Expand Down
Loading

0 comments on commit a57565d

Please sign in to comment.