Update-AzureApplicationGateway
Updates an application gateway.
Note
The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.
The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.
Syntax
Default (Default)
Update-AzureApplicationGateway
-Name <String>
[-VnetName <String>]
[-Subnets <System.Collections.Generic.List`1[System.String]>]
[-InstanceCount <UInt32>]
[-GatewaySize <String>]
[-Description <String>]
[-Profile <AzureSMProfile>]
[<CommonParameters>]
Description
The Update-AzureApplicationGateway cmdlet updates an existing application gateway.
Examples
Example 1: Modify an application gateway by using its name
PS C:\> Stop-AzureApplicationGateway -Name "ApplicationGateway06"
PS C:\> Update-AzureApplicationGateway -Name "ApplicationGateway06" -VnetName "VirtualNetwork18" -Subnets @("Subnet05", "Subnet06")
The first command stops the application gateway named ApplicationGateway06. An application gateway must be stopped before you can modify the virtual network or subnets.
The second command modifies the virtual subnet and subnets for the application gateway named ApplicationGateway06.
Example 2: Modify additional properties of an application gateway
PS C:\> Update-AzureApplicationGateway -Name "ApplicationGateway06" -InstanceCount 2 -GatewaySize "Large" -Description "Updated application gateway"
This command modifies the instance count, gateway size, and description for the application gateway named ApplicationGateway06. This command does not modify the virtual network or subnets for the application gateway. Therefore, you do not have to stop the application gateway before you run this command.
Example 3: Modify an application gateway by using the pipeline
PS C:\> $ApplicationGateway = Get-AzureApplicationGateway -Name "ApplicationGateway06"
PS C:\> $ApplicationGateway.GatewaySize = "Medium"
PS C:\> $ApplicationGateway | Update-AzureApplicationGateway
The first command gets the application gateway named ApplicationGateway06 by using the Get-AzureApplicationGateway cmdlet. The command stores it in the $ApplicationGateway variable.
The second command assigns the GatewaySize property the value Medium.
The final command passes the updated $ApplicationGateway to the current cmdlet.
Parameters
-Description
Specifies a description that this cmdlet assigns to the application gateway.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-GatewaySize
Specifies the size that this cmdlet assigns to the application gateway. Valid values are:
- Small
- Medium
- Large
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-InstanceCount
Specifies the number of instances that this cmdlet assigns to the application gateway.
Parameter properties
| Type: | UInt32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Name
Specifies the name of the application gateway that this cmdlet updates.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-Profile
Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.
Parameter properties
| Type: | AzureSMProfile |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Subnets
Specifies an array of subnets in which this cmdlet deploys the application gateway.
You cannot update subnets while the application gateway is running. To stop the application gateway, use the Stop-AzureApplicationGateway cmdlet.
Parameter properties
| Type: | |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-VnetName
Specifies the virtual network in which this cmdlet deploys the application gateway.
You cannot update a virtual network while the application gateway is running. To stop the application gateway, use Stop-AzureApplicationGateway.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.