Remove-AzApiManagementApiFromProduct

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

製品から API を削除します。

構文

Remove-AzApiManagementApiFromProduct
      -Context <PsApiManagementContext>
      -ProductId <String>
      -ApiId <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

説明

Remove-AzApiManagementApiFromProduct コマンドレットは、製品から Azure API Management API を削除します。

例

例 1: 製品から API を削除する

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApiFromProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001" -PassThru

このコマンドは、指定した API を製品から削除します。

パラメーター

-ApiId

製品から削除する API の ID を指定します。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
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

-PassThru

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

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

-ProductId

API の削除元となる製品の ID を指定します。

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

入力

PsApiManagementContext

String

SwitchParameter

出力

Boolean