次の方法で共有


Remove-AzureRmApiManagementApiRelease

特定の API リリースを削除します

警告

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

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

構文

Remove-AzureRmApiManagementApiRelease
      -Context <PsApiManagementContext>
      -ApiId <String>
      -ReleaseId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzureRmApiManagementApiRelease
      -InputObject <PsApiManagementApiRelease>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzureRmApiManagementApiRelease コマンドレットは、既存の API リリースを削除します。

例 1: API リリースを削除する

PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Remove-AzureRmApiManagementApiRelease -Context $apimContext -ApiId "echo-api" -ReleaseId "2"

このコマンドは、指定された ApiId と ReleaseId を持つ API リリースを削除します。

パラメーター

-ApiId

API の識別子。 このパラメーターは必須です。

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

-Confirm

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

型:SwitchParameter
Aliases:cf
Position:Named
既定値:None
必須: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

-InputObject

PsApiManagementApiRelease のインスタンス。 このパラメーターは必須です。

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

-PassThru

指定した場合、操作が成功した場合に true が書き込まれます。 このパラメーターは省略可能です。

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

-ReleaseId

API リリースの識別子。 このパラメーターは必須です。

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

-WhatIf

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

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

入力

PsApiManagementContext

PsApiManagementApiRelease

Parameters: InputObject (ByValue)

String

出力

Boolean