Condividi tramite

Get-AzApiManagementApi

  • Riferimento
Modulo:
Az.ApiManagement

Ottiene un'API.

Sintassi

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

Descrizione

Il cmdlet Get-AzApiManagementApi ottiene una o più API di Azure Gestione API.

Esempio

Esempio 1: Ottenere tutte le API di gestione

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

Questo comando ottiene tutte le API per il contesto specificato.

Esempio 2: Ottenere un'API di gestione in base all'ID

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

Questo comando ottiene l'API con l'ID specificato.

Esempio 3: Ottenere un'API di gestione in base al nome

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

Questo comando ottiene l'API con il nome specificato.

Esempio 4: Ottenere un'API di gestione tramite GatewayId

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

Questo comando ottiene l'API per l'ID gateway specificato.

Parametri

-ApiId

Specifica l'ID dell'API da ottenere.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-ApiRevision

Identificatore di revisione della revisione api specifica. Il parametro è facoltativo.

Tipo:String
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:True
Accept wildcard characters:False

-Context

Specifica un oggetto PsApiManagementContext .

Tipo:PsApiManagementContext
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
valore predefinito:None
Necessario:False
Accept pipeline input:False
Accept wildcard characters:False

-GatewayId

Se specificato tenterà di ottenere tutte le API del gateway.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifica il nome dell'API da ottenere.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

-ProductId

Specifica l'ID del prodotto per il quale ottenere l'API.

Tipo:String
Position:Named
valore predefinito:None
Necessario:True
Accept pipeline input:True
Accept wildcard characters:False

Input

PsApiManagementContext

String

Output

PsApiManagementApi