Update-AzureRmApiManagementDeployment

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

API Management サービスのデプロイを更新します。

警告

AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。

AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。

構文

Update-AzureRmApiManagementDeployment
      -ResourceGroupName <String>
      -Name <String>
      -Location <String>
      -Sku <PsApiManagementSku>
      -Capacity <Int32>
      [-VirtualNetwork <PsApiManagementVirtualNetwork>]
      [-VpnType <PsApiManagementVpnType>]
      [-AdditionalRegions <System.Collections.Generic.IList`1[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion]>]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]
Update-AzureRmApiManagementDeployment
      -ApiManagement <PsApiManagement>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

説明

Update-AzureRmApiManagementDeployment コマンドレットは、API Management サービスの現在のデプロイを更新します。

例

例 1: ApiManagement インスタンスのデプロイを更新する

PS C:\>Update-AzureRmApiManagementDeployment -ResourceGroupName "Contoso" -Name "ContosoApi" -Sku "Standard" -Capacity 3

このコマンドは、API Management インスタンスのデプロイを 3 ユニットの容量標準に更新します。

例 2: ApiManagement インスタンスを取得して再スケーリングする

PS C:\>$ApiManagement = Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name "ContosoApi"
PS C:\> $ApiManagement.Sku = "Premium"
PS C:\> $ApiManagement.Capacity = 5
PS C:\> $ApiManagement.AddRegion("Central US", "Premium", 3)
PS C:\> Update-AzureRmApiManagementDeployment -ApiManagement $ApiManagement

この例では、Api Management インスタンスを取得し、それを 5 つの Premium ユニットにスケーリングした後、Premium リージョンにさらに 3 つのユニットを追加します。

例 3: 更新プログラムの展開 (外部 VNET)

PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.Network/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType "External"

このコマンドは、既存の API Management デプロイを更新し、外部 VpnType に参加します。

例 4: 更新プログラムの展開 (内部 VNET)

PS C:\> $virtualNetwork = New-AzureRmApiManagementVirtualNetwork -Location "East US" -SubnetResourceId "/subscriptions/a8ff56dc-3bc7-4174-a1e8-3726ab15d0e2/resourceGroups/Api-Default-WestUS/providers/Microsoft.ClassicNetwork/virtualNetworks/dfVirtualNetwork/subnets/backendSubnet"
PS C:\> Update-AzureRmApiManagementDeployment -ResourceGroupName "ContosoGroup" -Name "ContosoApi" -VirtualNetwork $virtualNetwork -VpnType "Internal"

このコマンドは、既存の API Management デプロイを更新し、内部 VpnType に参加します。

パラメーター

-AdditionalRegions

Azure API Management の追加のデプロイ リージョンを指定します。

Type:IList<T>[PsApiManagementRegion]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ApiManagement

デプロイ構成を 取得する PsApiManagement インスタンスを指定します。 インスタンスに必要なすべての変更が既に存在する場合は、このパラメーターを使用します。

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

-Capacity

マスター Azure API Management デプロイ リージョンの SKU 容量を指定します。

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
Default value:None
Required: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

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

-Name

このコマンドレットが更新する API Management の名前を指定します。

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

-PassThru

作業中の項目を表すオブジェクトを返します。 既定では、このコマンドレットによる出力はありません。

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

-ResourceGroupName

API Management が存在するリソース グループの名前を指定します。

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

-Sku

マスター Azure API Management デプロイ リージョンの層を指定します。 このパラメーターの有効値は、次のとおりです。

  • Developer
  • Standard
  • Premium
Type:PsApiManagementSku
Accepted values:Developer, Standard, Premium, Basic
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-VirtualNetwork

マスター Azure API Management デプロイ リージョンの仮想ネットワーク構成を指定します。

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

-VpnType

API Management デプロイの仮想ネットワークの種類を指定します。 このパラメーターの有効値は、次のとおりです。

  • なし。 API Management のデプロイは、仮想ネットワークの一部ではありません。 これが既定値です。
  • 外部。 API Management デプロイには、外部に接続する仮想アドレスがあります。
  • 内部。 API Management デプロイには、イントラネットに接続された仮想アドレスがあります。
Type:PsApiManagementVpnType
Accepted values:None, External, Internal
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

入力

PsApiManagement

パラメーター: ApiManagement (ByValue)

String

PsApiManagementSku

Int32

PsApiManagementVirtualNetwork

PsApiManagementVpnType

IList<T>[[Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion, Microsoft.Azure.Commands.ApiManagement, Version=6.1.2.0, Culture=neutral, PublicKeyToken=null]]

出力

PsApiManagement