Get-AzApiManagementApi

  • 參考
模組:
Az.ApiManagement

取得 API。

Syntax

Get-AzApiManagementApi
   -Context <PsApiManagementContext>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementApi
   -Context <PsApiManagementContext>
   -ApiId <String>
   [-ApiRevision <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementApi
   -Context <PsApiManagementContext>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementApi
   -Context <PsApiManagementContext>
   -ProductId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
Get-AzApiManagementApi
   -Context <PsApiManagementContext>
   -GatewayId <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Get-AzApiManagementApi Cmdlet 會取得一或多個 Azure API 管理 API。

範例

範例 1：取得所有管理 API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementApi -Context $ApiMgmtContext

此命令會取得指定內容的所有 API。

範例 2：依標識符取得管理 API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId $ApiId

此命令會取得具有指定識別碼的 API。

範例 3：依名稱取得管理 API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi"

此命令會取得具有指定名稱的 API。

範例 4：依 GatewayId 取得管理 API

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Get-AzApiManagementApi -Context $ApiMgmtContext -GatewayId "g01"

此命令會取得指定 GatewayId 的 API。

參數

-ApiId

指定要取得的 API 識別碼。

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

-ApiRevision

特定 Api 修訂的修訂標識碼。 這是選擇性參數。

Type:String
Position:Named
Default value:None
Required:False
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

-GatewayId

如果指定 ，則會嘗試取得所有閘道 API。

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

-Name

指定要取得的 API 名稱。

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

-ProductId

指定要取得 API 的產品識別碼。

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

輸入

PsApiManagementContext

String

輸出

PsApiManagementApi