Remove-AzureRmApiManagementApiFromProduct

NAME Remove-AzureRmApiManagementApiFromProduct



SYNOPSIS

Removes an API from a product.





SYNTAX

Remove-AzureRmApiManagementApiFromProduct -ApiId <String> -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-PassThru]

-ProductId <String> [<CommonParameters>]





DESCRIPTION

The Remove-AzureRmApiManagementApiFromProduct cmdlet removes an Azure API Management API from a product.





PARAMETERS

-ApiId <String>

Specifies the ID of the API to remove from the product.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Context <PsApiManagementContext>

Specifies a PsApiManagementContext .



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PassThru [<SwitchParameter>]

Indicates that this cmdlet returns a value of $True if it succeeds, or $False, otherwise.



Required? false

Position? named

Default value False

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ProductId <String>

Specifies the ID of the product from which to remove the API.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None

This cmdlet does not accept any input.





OUTPUTS

bool







NOTES









Example 1: Remove an API from a product



PS C:\\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Remove-AzureRmApiManagementApiFromProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001" -PassThru



This commnd removes the specified API from a product.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... romproduct

Add-AzureRmApiManagementApiToProduct