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-AzureApiManagementRegion

Update-AzureApiManagementRegion

microsoft.azure.commands.apimanagement.dll

Synopsis

Updates existing deployment region in PsApiManagement instance.

Syntax

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

Detailed Description

Update-AzureApiManagementRegion cmdlet updates (scales up/down or changes VPN configuration) existing instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion in 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: Add-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 update existing deployment region in.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Location <String>

Location of the deployment region to update.

Aliases

None

Required?

true

Position

named

Default value

None

Accept pipeline input?

true (ByPropertyName)

Accept wildcard characters?

false

-Sku <PsApiManagementSku>

New tier value for the 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>

New Sku capacity value for the 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 for the deployemnt region. Default value is $null. Passing $null will remove virtual network configuration for the region.

Aliases

None

Required?

false

Position

named

Default value

$null

Accept pipeline input?

true (ByPropertyName)

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

Examples