Add-​Azure​Rm​Api​Management​Region

Adds new deployment regions to a PsApiManagement instance.

Syntax

Add-AzureRmApiManagementRegion
   -ApiManagement <PsApiManagement>
   [-Capacity <Int32>]
   -Location <String>
   [-Sku <PsApiManagementSku>]
   [-VirtualNetwork <PsApiManagementVirtualNetwork>]
   [<CommonParameters>]

Description

The Add-AzureRmApiManagementRegion cmdlet adds new instance of type PsApiManagementRegion to the collection of AdditionalRegions of provided instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. This cmdlet does not deploy anything by itself but updates instance of PsApiManagement in-memory. To update a deployment of an API Management pass the modified PsApiManagement Instance to Update-AzureRmApiManagementDeployment.

Examples

Example 1: Add new deployment regions to a PsApiManagement instance

PS C:\>Add-AzureRmApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2

This command adds two premium SKU units and the region named East US to the PsApiManagement instance.

Example 2: Add new deployment regions to a PsApiManagement instance and then update deployment

PS C:\>Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" | Add-AzureRmApiManagementRegion -Location "East US" -Sku "Premium" -Capacity 2 | Update-AzureRmApiManagementDeployment

This command gets a PsApiManagement object, adds two premium SKU units for the region named East US, and then updates deployment.

Required Parameters

-ApiManagement

Specifies the PsApiManagement instance that this cmdlet adds additional deployment regions to.

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

Specifies the location of the new deployment region.

Valid values are:

  • North Central US
  • South Central US
  • Central US
  • West Europe
  • North Europe
  • West US
  • East US
  • East US 2
  • Japan East
  • Japan West
  • Brazil South
  • Southeast Asia
  • East Asia
  • Australia East
  • Australia Southeast
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-Capacity

Specifies the SKU capacity of the deployment region.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Sku

Specifies the tier of the deployment region. Valid values are:

  • Developer
  • Standard
  • Premium
Type:PsApiManagementSku
Parameter Sets:Developer, Standard, Premium
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VirtualNetwork

Specifies a virtual network configuration.

Type:PsApiManagementVirtualNetwork
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Notes

  • The cmdlet writes updated PsApiManagement instance to pipeline.