Add-AzureRmApiManagementRegion
PsApiManagement インスタンスに新しいデプロイ リージョンを追加します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Add-AzureRmApiManagementRegion
-ApiManagement <PsApiManagement>
-Location <String>
[-Sku <PsApiManagementSku>]
[-Capacity <Int32>]
[-VirtualNetwork <PsApiManagementVirtualNetwork>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Add-AzureRmApiManagementRegion コマンドレットは、PsApiManagementRegion 型の新しいインスタンスを、Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement 型の指定されたインスタンスの AdditionalRegions のコレクションに追加します。 このコマンドレットは単独では何もデプロイしませんが、PsApiManagement のインスタンスをメモリ内で更新します。 API Management のデプロイを更新するには、変更した PsApiManagement インスタンスを Update-AzureRmApiManagementDeployment に渡します。
例
例 1: PsApiManagement インスタンスに新しいデプロイ リージョンを追加する
PS C:\>Add-AzureRmApiManagementRegion -ApiManagement $ApiManagement -Location "East US" -Sku "Premium" -Capacity 2
このコマンドは、2 つの Premium SKU ユニットと米国東部というリージョンを PsApiManagement インスタンスに追加します。
例 2: PsApiManagement インスタンスに新しいデプロイ リージョンを追加し、デプロイを更新する
PS C:\>Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi" | Add-AzureRmApiManagementRegion -Location "East US" -Sku "Premium" -Capacity 2 | Update-AzureRmApiManagementDeployment
このコマンドは PsApiManagement オブジェクトを取得し、米国東部という名前のリージョンに 2 つの Premium SKU ユニットを追加してから、デプロイを更新します。
パラメーター
-ApiManagement
このコマンドレットが追加の デプロイ リージョンを追加する PsApiManagement インスタンスを指定します。
型: | PsApiManagement |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Capacity
デプロイ リージョンの SKU 容量を指定します。
型: | Nullable<T>[Int32] |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。
型: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Location
Api Management サービスでサポートされているリージョン間の新しいデプロイ リージョンの場所を指定します。 有効な場所を取得するには、コマンドレット Get-AzureRmResourceProvider -ProviderNamespace "Microsoft.ApiManagement" |where {$_.ResourceTypes[0]。ResourceTypeName -eq "service"} |Select-Object Locations
型: | String |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Sku
デプロイ リージョンの層を指定します。 有効な値は次の通りです。
- Developer
- Standard
- Premium
型: | Nullable<T>[PsApiManagementSku] |
承認された値: | Developer, Standard, Premium, Basic |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VirtualNetwork
仮想ネットワーク構成を指定します。
型: | PsApiManagementVirtualNetwork |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
パラメーター: ApiManagement (ByValue)
出力
メモ
- このコマンドレットは、更新された PsApiManagement インスタンスをパイプラインに書き込みます。