Remove-AzureRmApiManagementApiFromProduct
製品から API を削除します。
警告
AzureRM PowerShell モジュールは、2024 年 2 月 29 日の時点で正式に非推奨になりました。 引き続きサポートを受け、更新を受け取れるようにするために、AzureRM から Az PowerShell モジュールに移行することをお勧めします。
AzureRM モジュールは引き続き機能する可能性がありますが、メインが維持またはサポートされなくなり、ユーザーの判断とリスクで引き続き使用できます。 Az モジュールへの移行に関するガイダンスについては、移行リソースを参照してください。
構文
Remove-AzureRmApiManagementApiFromProduct
-Context <PsApiManagementContext>
-ProductId <String>
-ApiId <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
説明
Remove-AzureRmApiManagementApiFromProduct コマンドレットは、製品から Azure API Management API を削除します。
例
例 1: 製品から API を削除する
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Remove-AzureRmApiManagementApiFromProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001" -PassThru
この commnd は、指定された API を製品から削除します。
パラメーター
-ApiId
製品から削除する API の ID を指定します。
型: | String |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | True |
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 |
-PassThru
このコマンドレットが成功した場合は $True の値を返し、それ以外の場合は$Falseを返します。
型: | SwitchParameter |
Position: | Named |
既定値: | None |
必須: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProductId
API の削除元となる製品の ID を指定します。
型: | String |
Position: | Named |
既定値: | None |
必須: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |