< Back
Update-AzureRmApiManagementDeployment
Post
NAME Update-AzureRmApiManagementDeployment
SYNOPSIS
Updates deployment of an API Management Service.
SYNTAX
Update-AzureRmApiManagementDeployment [-AdditionalRegions
<System.Collections.Generic.IList`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion]>] -Capacity <Int32> [-DefaultProfile
<IAzureContextContainer>] -Location <String> -Name <String> [-PassThru] -ResourceGroupName <String> -Sku {Developer | Standard | Premium}
[-VirtualNetwork <PsApiManagementVirtualNetwork>] [-VpnType {None | External | Internal}] [<CommonParameters>]
Update-AzureRmApiManagementDeployment -ApiManagement <PsApiManagement> [-DefaultProfile <IAzureContextContainer>] [-PassThru] [<CommonParameters>]
DESCRIPTION
The Update-AzureRmApiManagementDeployment cmdlet updates current deployments of an API Management service.
PARAMETERS
-AdditionalRegions <System.Collections.Generic.IList`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion]>
Specifies additional deployment regions of Azure API Management.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ApiManagement <PsApiManagement>
Specifies the PsApiManagement instance to get deployment configuration from. Use this parameter if the instance already has all the required
changes.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Capacity <Int32>
Specifies the SKU capacity of the master Azure API Management deployment region.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <String>
Specifies the location of the master API Management deployment region.
To obtain valid locations, use the cmdlet Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where
{$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of API Management that this cmdlet updates.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of resource group under which API Management exists.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Sku <PsApiManagementSku>
Specifies the tier of the master Azure API Management deployment region.
The acceptable values for this parameter are:
- Developer
- Standard
- Premium
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetwork <PsApiManagementVirtualNetwork>
Specifies the Virtual Network configuration of the master Azure API Management deployment region.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VpnType <PsApiManagementVpnType>
Specifies the virtual network Type of the API Management deployment. The acceptable values for this parameter are:
- None. The API Management deployment is not part of any Virtual Network. This is the default value. - External. The API Management
deployment has an external facing virtual address. - Internal. The API Management deployment has an intranet facing virtual address.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PsApiManagement
Parameter 'ApiManagement' accepts value of type 'PsApiManagement' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement
NOTES
Example 1: Update a deployment of an ApiManagement instance
PS C:\\>Update-AzureRmApiManagementDeployment -ResourceGroupName "Contoso" -Name "ContosoApi" -Sku "Standard" -Capacity 3
This command updates deployment of an API Management instance to a three unit capacity standard.
Example 2: Get an ApiManagement instance and rescale it
PS C:\\>$ApiManagement = Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
PS C:\\> $ApiManagement.Sku = "Premium"
PS C:\\> $ApiManagement.Capacity = 5
PS C:\\> $ApiManagement.AddRegion("Central US", "Premium", 3)
PS C:\\> Update-AzureRmApiManagementDeployment -ApiManagement $ApiManagement
This example gets an Api Management instance, scales it to five premium units and then adds an additional three units to the premium region.
Example 3: Update deployment (external VNET)
PS C:\\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726
ab15d0e2/resourceGroups/Api-Default-West-US/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
PS C:\\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType
"External"
This command updates an existing API Management deployment and joins to an external VpnType .
Example 4: Update deployment (internal VNET)
PS C:\\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726
ab15d0e2/resourceGroups/Api-Default-West-US/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
PS C:\\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType
"Internal"
This command updates an existing API Management deployment and joins to an internal VpnType .
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Get-AzureRmApiManagement
SYNOPSIS
Updates deployment of an API Management Service.
SYNTAX
Update-AzureRmApiManagementDeployment [-AdditionalRegions
<System.Collections.Generic.IList`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion]>] -Capacity <Int32> [-DefaultProfile
<IAzureContextContainer>] -Location <String> -Name <String> [-PassThru] -ResourceGroupName <String> -Sku {Developer | Standard | Premium}
[-VirtualNetwork <PsApiManagementVirtualNetwork>] [-VpnType {None | External | Internal}] [<CommonParameters>]
Update-AzureRmApiManagementDeployment -ApiManagement <PsApiManagement> [-DefaultProfile <IAzureContextContainer>] [-PassThru] [<CommonParameters>]
DESCRIPTION
The Update-AzureRmApiManagementDeployment cmdlet updates current deployments of an API Management service.
PARAMETERS
-AdditionalRegions <System.Collections.Generic.IList`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion]>
Specifies additional deployment regions of Azure API Management.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ApiManagement <PsApiManagement>
Specifies the PsApiManagement instance to get deployment configuration from. Use this parameter if the instance already has all the required
changes.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Capacity <Int32>
Specifies the SKU capacity of the master Azure API Management deployment region.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Location <String>
Specifies the location of the master API Management deployment region.
To obtain valid locations, use the cmdlet Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where
{$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of API Management that this cmdlet updates.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-ResourceGroupName <String>
Specifies the name of resource group under which API Management exists.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Sku <PsApiManagementSku>
Specifies the tier of the master Azure API Management deployment region.
The acceptable values for this parameter are:
- Developer
- Standard
- Premium
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VirtualNetwork <PsApiManagementVirtualNetwork>
Specifies the Virtual Network configuration of the master Azure API Management deployment region.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-VpnType <PsApiManagementVpnType>
Specifies the virtual network Type of the API Management deployment. The acceptable values for this parameter are:
- None. The API Management deployment is not part of any Virtual Network. This is the default value. - External. The API Management
deployment has an external facing virtual address. - Internal. The API Management deployment has an intranet facing virtual address.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
PsApiManagement
Parameter 'ApiManagement' accepts value of type 'PsApiManagement' from the pipeline
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement
NOTES
Example 1: Update a deployment of an ApiManagement instance
PS C:\\>Update-AzureRmApiManagementDeployment -ResourceGroupName "Contoso" -Name "ContosoApi" -Sku "Standard" -Capacity 3
This command updates deployment of an API Management instance to a three unit capacity standard.
Example 2: Get an ApiManagement instance and rescale it
PS C:\\>$ApiManagement = Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
PS C:\\> $ApiManagement.Sku = "Premium"
PS C:\\> $ApiManagement.Capacity = 5
PS C:\\> $ApiManagement.AddRegion("Central US", "Premium", 3)
PS C:\\> Update-AzureRmApiManagementDeployment -ApiManagement $ApiManagement
This example gets an Api Management instance, scales it to five premium units and then adds an additional three units to the premium region.
Example 3: Update deployment (external VNET)
PS C:\\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726
ab15d0e2/resourceGroups/Api-Default-West-US/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
PS C:\\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType
"External"
This command updates an existing API Management deployment and joins to an external VpnType .
Example 4: Update deployment (internal VNET)
PS C:\\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726
ab15d0e2/resourceGroups/Api-Default-West-US/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
PS C:\\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType
"Internal"
This command updates an existing API Management deployment and joins to an internal VpnType .
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... deployment
Get-AzureRmApiManagement