Add-AzureRmApiManagementRegion

Reference

Module:: AzureRM.ApiManagement

Adds new deployment regions to a PsApiManagement instance.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

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.

Parameters

-ApiManagement

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

Type:	PsApiManagement
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Capacity

Specifies the SKU capacity of the deployment region.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

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

Type:	IAzureContextContainer
Aliases:	AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Sku

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

Developer
Standard
Premium

Type:	Nullable<T>[PsApiManagementSku]
Accepted values:	Developer, Standard, Premium, Basic
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VirtualNetwork

Specifies a virtual network configuration.

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

Inputs

PsApiManagement

Parameters: ApiManagement (ByValue)

Outputs