Update-AzApiManagementRegion
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.PsApiManagementRegionMicrosoft.Azure.Commands.ApiManagement.Models.PsApiManagementMicrosoft.Azure.Commands.ApiManagement.Models.PsApiManagement の指定されたインスタンスの AdditionalRegions オブジェクトのコレクション内の既存のインスタンスを更新します。 このコマンドレットは、 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 Premium 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 インスタンスを指定します。
| 型: | PsApiManagement |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Capacity
デプロイ リージョンの新しい SKU 容量の値を指定します。
| 型: | Int32 |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
| 型: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-DisableGateway
フラグは、Premium SKU ApiManagement Service および非内部 VNET デプロイにのみ使用されます。 これは、ゲートウェイリージョンをローテーションから除外する場合に便利です。 これは、パッシブ モードで新しいリージョンを立ち上がり、テストしてから後で Live にすることもできます。
| 型: | Nullable<T>[Boolean] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Location
更新するデプロイ リージョンの場所を指定します。 Api Management サービスでサポートされているリージョン間の新しいデプロイ リージョンの場所を指定します。 有効な場所を取得するには、コマンドレット Get-AzResourceProvider -ProviderNamespace "Microsoft.ApiManagement" |where {$_.ResourceTypes[0]。ResourceTypeName -eq "service"} |Select-Object Locations
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-PublicIpAddressId
stv2 Virtual Network デプロイへの統合のための Standard SKU PublicIpAddress ResoureId
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Sku
デプロイ リージョンの新しい層の値を指定します。 有効な値は次の通りです。
- Developer
- Standard
- Premium
| 型: | PsApiManagementSku |
| 指定可能な値: | Developer, Standard, Premium, Basic, Consumption, Isolated |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-VirtualNetwork
デプロイ リージョンの仮想ネットワーク構成を指定します。 $nullを渡すと、リージョンの仮想ネットワーク構成が削除されます。
| 型: | PsApiManagementVirtualNetwork |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Zone
API Management サービスのデプロイ先を示す可用性ゾーンの一覧。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |