次の方法で共有

Remove-AzureRmApiManagementRegion

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

PsApiManagement インスタンスから既存のデプロイ リージョンを削除します。

警告

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

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

構文

Remove-AzureRmApiManagementRegion
      -ApiManagement <PsApiManagement>
      -Location <String>
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

説明

Remove-AzureRmApiManagementRegion コマンドレットは、Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagementRegion 型のインスタンスを、指定された Microsoft.Azure.Commands.ApiManagement.Models.PsApiManagement 型のインスタンスの AdditionalRegions のコレクションから削除します。 このコマンドレットは、単独ではデプロイを変更しませんが、メモリ内の PsApiManagement のインスタンスを更新します。 API Management のデプロイを更新するには、変更した PsApiManagementInstance を Update-AzureRmApiManagement に 渡します。

例

例 1: PsApiManagement インスタンスからリージョンを削除する

PS C:\>Remove-AzureRmApiManagementRegion -ApiManagement $ApiManagement -Location "East US"

このコマンドは、PsApiManagement インスタンスから米国東部という名前のリージョンを削除します。

例 2: 一連のコマンドを使用して PsApiManagement インスタンスからリージョンを削除する

PS C:\>Get-AzureRmApiManagement -ResourceGroupName "Contoso" -Name ContosoApi | Remove-AzureRmApiManagementRegion -Location "East US" | Update-AzureRmApiManagementDeployment

この最初のコマンドは、Contoso という名前の Contoso という名前の リソース グループから PsApiManagement のインスタンスを取得します。 最後のコマンドは、そのインスタンスから米国東部という名前のリージョンを削除し、デプロイを更新します。

パラメーター

-ApiManagement

このコマンドレットが追加の デプロイ リージョンを削除する PsApiManagement インスタンスを指定します。

型:PsApiManagement
Position:Named
既定値:None
必須:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

型: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:True
Accept wildcard characters:False

入力

PsApiManagement

パラメーター: ApiManagement (ByValue)

String

出力

PsApiManagement