Get-AzApiManagementProduct

Module:
Az.ApiManagement

Gets a list or a particular product.

Syntax

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>]

Description

The Get-AzApiManagementProduct cmdlet gets a list or a particular product.

Examples

Example 1: Get all products

PS C:\>$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzApiManagementProduct -Context $apimContext

This command get all API Management products.

Example 2: Get a product by ID

PS C:\>$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzApiManagementProduct -Context $apimContext -ProductId "0123456789"

This command get an API Management product by ID.

Parameters

-ApiId

ApiId of the Api to find the correlated products. This parameter is optional.

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

Specifies an instance of a PsApiManagementContext object.

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

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

Type:Microsoft.Azure.Commands.Common.Authentication.Abstractions.Core.IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProductId

Specifies the identifier of the product to search for.

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

Specifies the title of the product to look for. If specified, the cmdlet attempts to get the product by title.

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

Inputs

PsApiManagementContext

String

Outputs

PsApiManagementProduct