Update-AzureRmApiManagementRegion

Updates existing deployment region in PsApiManagement instance.

Syntax

Update-AzureRmApiManagementRegion
      -ApiManagement <PsApiManagement>
      -Location <String>
      -Sku <PsApiManagementSku>
      -Capacity <Int32>
      [-VirtualNetwork <PsApiManagementVirtualNetwork>]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

The Update-AzureRmApiManagementRegion cmdlet updates an existing instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion in a collection of AdditionalRegions objects of a provided instance of type Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement. This cmdlet does not deploy anything but updates an instance of PsApiManagement in-memory. To update a deployment of an API Management use the modified PsApiManagementInstance to the Update-AzureRmApiManagementDeployment cmdlet.

Required Parameters

-ApiManagement

Specifies the PsApiManagement instance to update an existing deployment region in.

Type:Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Capacity

Specifies the new SKU capacity value for the deployment region.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Location

Specifies the location of the deployment region to update.

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:True (ByPropertyName)
Accept wildcard characters:False
-Sku

Specifies the new tier value for the deployment region.

Valid values are:

  • Developer
  • Standard
  • Premium
Type:Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementSku
Parameter Sets:Developer, Standard, Premium
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

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

Specifies a virtual network configuration for the deployment region. Passing $null will remove virtual network configuration for the region.

Type:Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementVirtualNetwork
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Inputs

PsApiManagement

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

Outputs

Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement