Get-​Azure​Rm​Api​Management​Product

Gets a list or a particular product.

Syntax

Get-AzureRmApiManagementProduct
   -Context <PsApiManagementContext>
   -ProductId <String>
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]
Get-AzureRmApiManagementProduct
   -Context <PsApiManagementContext>
   [-Title <String>]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Get all products

PS C:\>Get-AzureRmApiManagementProduct -Context $APImContext

This command get all API Management products.

Example 2: Get a product by ID

PS C:\>Get-AzureRmApiManagementProduct -Context $APImContext -ProductId "0123456789"

This command get an API Management product by ID.

Required Parameters

-Context

Specifies an instance of a PsApiManagementContext object.

Type:PsApiManagementContext
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
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 (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
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 (ByPropertyName)
Accept wildcard characters:False

Outputs

IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct>