Update-AzApiManagementRegion

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

PsApiManagement インスタンスの既存のデプロイ リージョンを更新します。

構文

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

説明

Update-AzApiManagementRegion コマンドレットは、Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement 型の指定されたインスタンスの AdditionalRegions オブジェクトのコレクション内の、Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion 型の既存のインスタンスを更新します。 このコマンドレットは、PsApiManagement のインスタンスをメモリ内で更新する以外に何もデプロイしません。 API Management のデプロイを更新するには、変更した PsApiManagementInstance を Set-AzApiManagement コマンドレットに使用します。

例

例 1: PsApiManagement インスタンスの追加リージョンの容量を増やす

$apimService = Get-AzApiManagement -ResourceGroupName $resourceGroupName -Name $apiManagementName
$apimService = Update-AzApiManagementRegion -ApiManagement $apimService -Location "North Central US" -Capacity 2 -Sku Premium
$apimService = Set-AzApiManagement -InputObject $apimService -PassThru

このコマンドは、API Management プレミアム SKU サービスを取得します。リージョンは米国中南部と米国中北部にあります。 次に、Set-AzApiManagement を使用して、米国中北部リージョンの容量を 2 に増やします。 次のコマンドレット Set-AzApiManagement は、Api Management サービスに構成変更を適用します。

例 2

PsApiManagement インスタンスの既存のデプロイ リージョンを更新します。 (自動生成)

Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Capacity 2 -Location 'North Central US' -Sku Developer -VirtualNetwork <PsApiManagementVirtualNetwork>

パラメーター

-ApiManagement

既存のデプロイ リージョンを 更新する PsApiManagement インスタンスを指定します。

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

-Capacity

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

Type:Int32
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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:True
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:PsApiManagementSku
Accepted values:Developer, Standard, Premium, Basic, Consumption, Isolated
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VirtualNetwork

デプロイ リージョンの仮想ネットワーク構成を指定します。 $nullを渡すと、リージョンの仮想ネットワーク構成が削除されます。

Type:PsApiManagementVirtualNetwork
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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

String

PsApiManagementSku

Int32

PsApiManagementVirtualNetwork

出力

PsApiManagement