次の方法で共有

Remove-AzureRmApiManagementProduct

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

既存の API Management 製品を削除します。

警告

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

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

構文

Remove-AzureRmApiManagementProduct
      -Context <PsApiManagementContext>
      -ProductId <String>
      [-DeleteSubscriptions]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzureRmApiManagementProduct コマンドレットは、既存の API Management 製品を削除します。

例

例 1: 既存の製品とすべてのサブスクリプションを削除する

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Remove-AzureRmApiManagementProduct -Context $apimContext -Id "0123456789" -DeleteSubscriptions -Force

このコマンドは、既存の製品とすべてのサブスクリプションを削除します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:SwitchParameter
Aliases:cf
Position:Named
既定値:False
必須:False
Accept pipeline input:False
Accept wildcard characters:False

-Context

PsApiManagementContext オブジェクトのインスタンスを指定します。

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

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzureRmContext, AzureCredential
Position:Named
既定値:None
必須:False
Accept pipeline input:False
Accept wildcard characters:False

-DeleteSubscriptions

製品のサブスクリプションを削除するかどうかを示します。 このパラメーターを設定せず、サブスクリプションが存在する場合は、例外がスローされます。

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

-PassThru

このコマンドレットが成功した場合は $True の値を返し、失敗した場合は $False の値を返します。

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

-ProductId

既存の製品の識別子を指定します。

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

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

型:SwitchParameter
Aliases:wi
Position:Named
既定値:False
必須:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PsApiManagementContext

String

SwitchParameter

出力

Boolean