次の方法で共有


Remove-AzApiManagementProduct

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

構文

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

説明

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

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

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementProduct -Context $apimContext -ProductId "0123456789" -DeleteSubscriptions

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

パラメーター

-Confirm

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

型:SwitchParameter
Aliases:cf
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-Context

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

型:PsApiManagementContext
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-DefaultProfile

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

型:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-DeleteSubscriptions

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-PassThru

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

型:SwitchParameter
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-ProductId

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

型:String
配置:Named
規定値:None
必須:True
パイプライン入力を受け取る:True
ワイルドカード文字を受け取る:False

-WhatIf

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

型:SwitchParameter
Aliases:wi
配置:Named
規定値:False
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

入力

PsApiManagementContext

String

SwitchParameter

出力

Boolean