Edit

Share via

Add-AzApiManagementRegion

  • Reference
Module:
Az.ApiManagement

Adds new deployment regions to a PsApiManagement instance.

Syntax

Add-AzApiManagementRegion
   -ApiManagement <PsApiManagement>
   -Location <String>
   [-Sku <PsApiManagementSku>]
   [-Capacity <Int32>]
   [-VirtualNetwork <PsApiManagementVirtualNetwork>]
   [-Zone <String[]>]
   [-DisableGateway <Boolean>]
   [-PublicIpAddressId <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Add-AzApiManagementRegion 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 Set-AzApiManagement.

Examples

Example 1: Add new deployment regions to a PsApiManagement instance

Add-AzApiManagementRegion -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

$service = Get-AzApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
$service = Add-AzApiManagementRegion -ApiManagement $service -Location $secondarylocation -VirtualNetwork $additionalRegionVirtualNetwork
$service = Set-AzApiManagement -InputObject $service -PassThru

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

-DisableGateway

Flag only meant to be used for Premium SKU ApiManagement Service and Non Internal VNET deployments. This is useful in case we want to take a gateway region out of rotation. This can also be used to standup a new region in Passive mode, test it and then make it Live later. Default behavior is to make the region live immediately.

Type:Nullable<T>[Boolean]
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-AzResourceProvider -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

-PublicIpAddressId

Standard SKU PublicIpAddress ResoureId for integration into stv2 Virtual Network Deployments

Type:String
Position:Named
Default value:None
Required:False
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, Consumption, Isolated
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

-Zone

A list of availability zones denoting where the api management service is deployed into.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Inputs

PsApiManagement

Outputs

PsApiManagement

Notes

  • The cmdlet writes updated PsApiManagement instance to pipeline.