Add-AzureRmApiManagementRegion

Adds new deployment regions to a PsApiManagement instance.

Syntax

Add-AzureRmApiManagementRegion
   -ApiManagement <PsApiManagement>
   -Location <String>
   [-Sku <PsApiManagementSku>]
   [-Capacity <Int32>]
   [-VirtualNetwork <PsApiManagementVirtualNetwork>]
   [-DefaultProfile <IAzureContextContainer>]
   [<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:Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Location

Specifies the location of the new deployment region amongst the supported region for Api Management service.

To obtain valid locations, use the cmdlet Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" | where {$_.ResourceTypes[0].ResourceTypeName -eq "service"} | Select-Object Locations

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:System.Nullable`1[System.Int32]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DefaultProfile

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
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:System.Nullable`1[Microsoft.Azure.Commands.ApiManagement.Models.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:Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

PsApiManagement

Parameter 'ApiManagement' accepts value of type 'PsApiManagement' from the pipeline

Outputs

Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement

Notes

  • The cmdlet writes updated PsApiManagement instance to pipeline.