Get-AzApiManagementProduct

リストまたは特定の製品を取得します。

構文

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

説明

Get-AzApiManagementProduct コマンドレットは、リストまたは特定の製品を取得します。

例 1: すべての製品を取得する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementProduct -Context $apimContext

このコマンドは、すべての API Management 製品を取得します。

例 2: ID で製品を取得する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementProduct -Context $apimContext -ProductId "0123456789"

このコマンドは、ID で API Management 製品を取得します。

例 2: タイトルで製品を取得する

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$product = Get-AzApiManagementProduct -Context $apimContext -Title 'Starter'
$product | Select-Object -First 1

このコマンドは、タイトルごとに最初の API Management 製品を選択します。

パラメーター

-ApiId

関連付けられた製品を検索する Api の ApiId。 このパラメーターは省略可能です。

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

-Context

PsApiManagementContext オブジェクトのインスタンスを指定します。

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

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション。

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProductId

検索する製品の識別子を指定します。

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

-Title

検索する製品のタイトルを指定します。 指定した場合、コマンドレットはタイトルで製品の取得を試みます。

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

入力

PsApiManagementContext

String

出力

PsApiManagementProduct