Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-AzureApiManagementRegion

Add-AzureApiManagementRegion

microsoft.azure.commands.apimanagement.dll

Synopsis

Adds new deployment region to PsApiManagement instance.

Syntax

Add-AzureApiManagementRegion [-ApiManagement] [-Location] [-Sku] [-Capacity] [-VirtualNetwork] [-Profile] [<CommonParameters>]

Detailed Description

Add-AzureApiManagementRegion cmdlet adds new instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion to 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. Related cmdltes are: Update-AzureApiManagementRegion and Remove-AzureApiManagementRegion. To actually update a deployment of an API Management pass the modified PsApiManagementInstance to Update-AzureApiManagement cmdlet.

Parameters

-ApiManagement <PsApiManagement>

PsApiManagement instance to add additional deployment region to.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Location <String>

Location of the new deployment region.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Sku <Nullable`1[PsApiManagementSku]>

Tier of the deployment region. Valid values are Developer, Standard and Premium. Default value is Developer.

Aliases

None

Required?

false

Position

named

Default value

Developer

Accept pipeline input?

false

Accept wildcard characters?

false

-Capacity <Nullable`1[Int32]>

Sku capacity of the deployment region. Default value is 1.

Aliases

None

Required?

false

Position

named

Default value

1

Accept pipeline input?

false

Accept wildcard characters?

false

-VirtualNetwork <PsApiManagementVirtualNetwork>

Virtual network configuration. Default value is $null.

Aliases

None

Required?

false

Position

named

Default value

$null

Accept pipeline input?

false

Accept wildcard characters?

false

-Profile <AzureProfile>

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

The cmdlet writes updated PsApiManagement instance to pipeline.

Examples

-------------------------- Example 1 --------------------------

Add new 2 units ‘Premium’ region to the PsApiManagement instance.

PS C:\> Add-AzureApiManagementRegion –ApiManagement $apiManagement -Location “East US” -Sku “Premium” –Capacity 2

-------------------------- Example 2 --------------------------

Script to get a PsApiManagement, add 2 ‘Premium’ units region and update deployment.

PS C:\> Get-AzureApiManagement –ResourceGroupName Contoso –Name ContosoApi |
Add-AzureApiManagementRegion -Location “East US” -Sku “Premium” –Capacity 2 |
Update-AzureApiManagementDeployments