Remove-AzApiManagementPolicy

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

指定したスコープから API Management ポリシーを削除します。

構文

Remove-AzApiManagementPolicy
      -Context <PsApiManagementContext>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementPolicy
      -Context <PsApiManagementContext>
      -ProductId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementPolicy
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-AzApiManagementPolicy
      -Context <PsApiManagementContext>
      -ApiId <String>
      -OperationId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Remove-AzApiManagementPolicy コマンドレットは、指定されたスコープから API Management ポリシーを削除します。

例

例 1: テナント レベルのポリシーを削除する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementPolicy -Context $apimContext

このコマンドは、API Management からテナント レベルのポリシーを削除します。

例 2: 製品スコープ ポリシーを削除する

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

このコマンドは、API Management から製品スコープ ポリシーを削除します。

例 3: API スコープ ポリシーを削除する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210"

このコマンドは、API Management から API スコープ ポリシーを削除します。

例 4: 操作スコープ ポリシーを削除する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777"

このコマンドは、API Management から操作スコープ ポリシーを削除します。

パラメーター

-ApiId

既存の API の識別子を指定します。 このパラメーターを指定すると、コマンドレットによって API スコープ ポリシーが削除されます。

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

-Confirm

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

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

-Context

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

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

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-OperationId

既存の操作の識別子を指定します。 ApiId パラメーターでこのパラメーターを指定すると、このコマンドレットによって操作スコープ ポリシーが削除されます。

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

-PassThru

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

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

-ProductId

既存の製品の識別子を指定します。 このパラメーターを指定すると、コマンドレットによって製品スコープ ポリシーが削除されます。

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

-WhatIf

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

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

入力

PsApiManagementContext

String

SwitchParameter

出力

Boolean