Get-AzApiManagementApi

  • Başvuru
Modül:
Az.ApiManagement

Bir API alır.

Sözdizimi

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'i bir veya daha fazla Azure API Management API'si alır.

Örnekler

Örnek 1: Tüm yönetim API'lerini alma

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

Bu komut, belirtilen bağlam için tüm API'leri alır.

Örnek 2: Kimliğine göre yönetim API'si alma

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

Bu komut, belirtilen kimlikle API'yi alır.

Örnek 3: Ada göre yönetim API'si alma

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

Bu komut, belirtilen ada sahip API'yi alır.

Örnek 4: GatewayId ile yönetim API'si alma

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

Bu komut, belirtilen GatewayId için API'yi alır.

Parametreler

-ApiId

Alınacak API'nin kimliğini belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ApiRevision

Belirli Api düzeltmesinin Düzeltme Tanımlayıcısı. Bu parametre isteğe bağlıdır.

Tür:String
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Context

PsApiManagementContext nesnesini belirtir.

Tür:PsApiManagementContext
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-DefaultProfile

Azure ile iletişim için kullanılan kimlik bilgileri, hesap, kiracı ve abonelik.

Tür:IAzureContextContainer
Diğer adlar:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Gerekli:False
İşlem hattı girişini kabul et:False
Joker karakterleri kabul et:False

-GatewayId

Belirtilirse tüm Ağ Geçidi API'lerini almaya çalışır.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-Name

Alınacak API'nin adını belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

-ProductId

API'nin alındığı ürünün kimliğini belirtir.

Tür:String
Position:Named
Default value:None
Gerekli:True
İşlem hattı girişini kabul et:True
Joker karakterleri kabul et:False

Girişler

PsApiManagementContext

String

Çıkışlar

PsApiManagementApi