Add-AzApiManagementRegion
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 インスタンスを指定します。
| 型: | PsApiManagement |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-Capacity
デプロイ リージョンの SKU 容量を指定します。
| 型: | Nullable<T>[Int32] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | 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 |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-PublicIpAddressId
stv2 Virtual Network デプロイへの統合のための Standard SKU PublicIpAddress ResoureId
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Sku
デプロイ リージョンの層を指定します。 有効な値は次の通りです。
- Developer
- Standard
- Premium
| 型: | Nullable<T>[PsApiManagementSku] |
| 指定可能な値: | Developer, Standard, Premium, Basic, Consumption, Isolated |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-VirtualNetwork
仮想ネットワーク構成を指定します。
| 型: | PsApiManagementVirtualNetwork |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Zone
API Management サービスのデプロイ先を示す可用性ゾーンの一覧。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
入力
出力
メモ
- このコマンドレットは、更新された PsApiManagement インスタンスをパイプラインに書き込みます。