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
 

Update-AzureApiManagementDeployment

Update-AzureApiManagementDeployment

microsoft.azure.commands.apimanagement.dll

Synopsis

Updates deployment of an API Management Service.

Syntax

Update-AzureApiManagementDeployment [-ResourceGroupName] [-Name] [-Location] [-Sku] [-Capacity] [-VirtualNetwork] [-AdditionalRegions] [-PassThru] [-Profile] [<CommonParameters>]

Update-AzureApiManagementDeployment [-ApiManagement] [-PassThru] [-Profile] [<CommonParameters>]

Detailed Description

Update-AzureApiManagementDeployment cmdlet updates current deployment (scales, adds/removes additional deployment regions).

Parameters

-ResourceGroupName <String>

Name of resource group under which API Management exists.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Name <String>

Name of API Management.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Location <String>

Location of master API Management deployment region.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Sku <PsApiManagementSku>

The tier of master Azure API Management deployment region. Valid values are Developer, Standard and Premium.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Capacity <Int32>

Sku capacity of master Azure API Management deployment region.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-VirtualNetwork <PsApiManagementVirtualNetwork>

Virtual Network Configuration of master Azure API Management deployment region.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-AdditionalRegions <IList`1[PsApiManagementRegion]>

Additional deployment regions of Azure API Management.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Sends updated PsApiManagement to pipeline if operation succeeds.

Aliases

None

Required?

false

Position

named

Default value

None

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

-ApiManagement <PsApiManagement>

PsApiManagement instance to get deployment configuration from. Use the parameter the instance already has all the required changes (scale up/down, add/remove/update regions).

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

Input Type


Return Type


Notes

Examples

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

Command to update deployment of an ApiManagement to 3 unit ‘Standard’.

PS C:\> Update-AzureApiManagementDeployment -ResourceGroupName Contoso -Name ContosoApi –Sku “Standard” –Capacity 3

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

Script to get an ApiManagement, scale to 5 ‘Premium’ units and add additional 3 unit ‘Premium’ region.

$apiManagement = Get-AzureApiManagement –ResourceGroupName Contoso –Name ContosoApi
$apiManagement.Sku = “Premium”
$apiManagement.Capacity = 5
$apiManagement.AddRegion(“Central US”, “Premium”, 3)
Update-AzureApiManagementDeployment –ApiManagement $apiManagement