Get-AzureRmApiManagementProduct

NAME Get-AzureRmApiManagementProduct



SYNOPSIS

Gets a list or a particular product.





SYNTAX

Get-AzureRmApiManagementProduct -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -ProductId <String>

[<CommonParameters>]



Get-AzureRmApiManagementProduct -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-Title <String>] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-Context <PsApiManagementContext>

Specifies an instance of a PsApiManagementContext object.



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



-ProductId <String>

Specifies the identifier of the product to search for.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Title <String>

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



Required? false

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

Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct

The details of the Product in API Management service.



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

The list of Product in API Management service.





NOTES









Example 1: Get all products



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

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



This command get all API Management products.





Example 2: Get a product by ID



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

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



This command get an API Management product by ID.







RELATED LINKS

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

New-AzureRmApiManagementProduct

Remove-AzureRmApiManagementProduct

Set-AzureRmApiManagementProduct