Update-AzApiManagementRegion

Updates existing deployment region in PsApiManagement instance.

Syntax

Update-AzApiManagementRegion
      -ApiManagement <PsApiManagement>
      -Location <String>
      -Sku <PsApiManagementSku>
      -Capacity <Int32>
      [-VirtualNetwork <PsApiManagementVirtualNetwork>]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

The Update-AzApiManagementRegion cmdlet updates an existing instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion in a collection of AdditionalRegions objects of a provided instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. This cmdlet does not deploy anything but updates an instance of PsApiManagement in-memory. To update a deployment of an API Management use the modified PsApiManagementInstance to the Update-AzApiManagementDeployment cmdlet.

Examples

Example 1: Increases capacity of Additional Region in a PsApiManagement instance

PS C:\>$apimService = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName
PS C:\>$apimService = Update-AzApiManagementRegion -ApiManagement $apimService -Location "North Central US" -Capacity 2 -Sku Premium

# Set the ApiManagement service and Enable Msi idenity on the service
PS C:\>$updatedService = Set-AzApiManagement -InputObject $apimService -PassThru

This command gets the API Management Premium SKU service, having regions in South Central US and North Central US. It then increases the Capacity of the North Central US region to 2 using the Update-AzApiManagementRegion. The next cmdlet Set-AzApiManagement applies the configuration change to the Api Management service.

Parameters

-ApiManagement

Specifies the PsApiManagement instance to update an existing deployment region in.

Type:PsApiManagement
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Capacity

Specifies the new SKU capacity value for the deployment region.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-DefaultProfile

The credentials, account, tenant, and subscription used for communication with azure.

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Location

Specifies the location of the deployment region to update. Specifies the location of the new deployment region amongst the supported region for Api Management service. To obtain valid locations, use the cmdlet Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations

Type:String
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Sku

Specifies the new tier value for the deployment region. Valid values are:

  • Developer
  • Standard
  • Premium
Type:Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku
Accepted values:Developer, Standard, Premium, Basic, Consumption
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-VirtualNetwork

Specifies a virtual network configuration for the deployment region. Passing $null will remove virtual network configuration for the region.

Type:PsApiManagementVirtualNetwork
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Inputs

PsApiManagement

String

Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku

Int32

PsApiManagementVirtualNetwork

Outputs

PsApiManagement