Share via

Add-AzApiManagementRegion

  • リファレンス
モジュール:
Az.ApiManagement

PsApiManagement インスタンスに新しいデプロイ リージョンを追加します。

構文

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

説明

Add-AzApiManagementRegion コマンドレットは、PsApiManagementRegion 型の新しいインスタンスを、Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement 型の指定されたインスタンスの AdditionalRegions のコレクションに追加します。 このコマンドレットは単独では何もデプロイしませんが、PsApiManagement のインスタンスをメモリ内で更新します。 API Management のデプロイを更新するには、変更した PsApiManagement インスタンスを Set-AzApiManagement に渡します。

例

例 1: PsApiManagement インスタンスに新しいデプロイ リージョンを追加する

Add-AzApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2

このコマンドは、2 つの Premium SKU ユニットと米国東部というリージョンを PsApiManagement インスタンスに追加します。

例 2: PsApiManagement インスタンスに新しいデプロイ リージョンを追加し、デプロイを更新する

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

このコマンドは PsApiManagement オブジェクトを取得し、米国東部という名前のリージョンに 2 つの Premium SKU ユニットを追加してから、デプロイを更新します。

パラメーター

-ApiManagement

このコマンドレットが追加の デプロイ リージョンを追加する PsApiManagement インスタンスを指定します。

Type:PsApiManagement
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Capacity

デプロイ リージョンの SKU 容量を指定します。

Type:Nullable<T>[Int32]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableGateway

フラグは、プレミアム SKU ApiManagement Service および非内部 VNET デプロイにのみ使用されます。 これは、ゲートウェイリージョンをローテーションから除外する場合に便利です。 これは、パッシブ モードで新しいリージョンを立ち上がり、テストしてから後で Live にすることもできます。 既定の動作では、リージョンを直ちに稼働させます。

Type:Nullable<T>[Boolean]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

Api Management サービスでサポートされているリージョン間の新しいデプロイ リージョンの場所を指定します。 有効な場所を取得するには、コマンドレット 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

stv2 Virtual Network デプロイへの統合のための Standard SKU PublicIpAddress ResoureId

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

-Sku

デプロイ リージョンの層を指定します。 有効な値は次の通りです。

  • 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

仮想ネットワーク構成を指定します。

Type:PsApiManagementVirtualNetwork
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Zone

API Management サービスのデプロイ先を示す可用性ゾーンの一覧。

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

入力

PsApiManagement

出力

PsApiManagement

メモ

  • このコマンドレットは、更新された PsApiManagement インスタンスをパイプラインに書き込みます。