| external help file | Module Name | ms.assetid | online version | schema |
|---|---|---|---|---|
Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement.dll-Help.xml |
Az.ApiManagement |
B64E9C13-97A6-4E8B-92DB-EFAF8A48C5B8 |
2.0.0 |
Gets a list or a particular product.
Get-AzApiManagementProduct -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzApiManagementProduct -Context <PsApiManagementContext> -ProductId <String>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzApiManagementProduct -Context <PsApiManagementContext> [-Title <String>]
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
Get-AzApiManagementProduct -Context <PsApiManagementContext> -ApiId <String>
[-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]
The Get-AzApiManagementProduct cmdlet gets a list or a particular product.
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementProduct -Context $apimContextThis command get all API Management products.
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementProduct -Context $apimContext -ProductId "0123456789"This command get an API Management product by ID.
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$product = Get-AzApiManagementProduct -Context $apimContext -Title 'Starter'
$product | Select-Object -First 1This command selects the first API Management product by Title.
ApiId of the Api to find the correlated products. This parameter is optional.
Type: System.String
Parameter Sets: GetByApiId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies an instance of a PsApiManagementContext object.
Type: Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementContext
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: FalseThe credentials, account, tenant, and subscription used for communication with azure.
Type: Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Parameter Sets: (All)
Aliases: AzContext, AzureRmContext, AzureCredential
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSpecifies the identifier of the product to search for.
Type: System.String
Parameter Sets: GetByProductId
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseSpecifies the title of the product to look for. If specified, the cmdlet attempts to get the product by title.
Type: System.String
Parameter Sets: GetByTitle
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.