Import-AzApiManagementApi

Başvuru

Modül:: Az.ApiManagement

Api'yi bir dosyadan veya URL'den içeri aktarır.

Sözdizimi

Import-AzApiManagementApi
      -Context <PsApiManagementContext>
      [-ApiId <String>]
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      -SpecificationPath <String>
      [-Path <String>]
      [-WsdlServiceName <String>]
      [-WsdlEndpointName <String>]
      [-ApiType <PsApiManagementApiType>]
      [-Protocol <PsApiManagementSchema[]>]
      [-ServiceUrl <String>]
      [-ApiVersionSetId <String>]
      [-ApiVersion <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Import-AzApiManagementApi
      -Context <PsApiManagementContext>
      [-ApiId <String>]
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      -SpecificationUrl <String>
      [-Path <String>]
      [-WsdlServiceName <String>]
      [-WsdlEndpointName <String>]
      [-ApiType <PsApiManagementApiType>]
      [-Protocol <PsApiManagementSchema[]>]
      [-ServiceUrl <String>]
      [-ApiVersionSetId <String>]
      [-ApiVersion <String>]
      [-DefaultProfile <IAzureContextContainer>]
      [<CommonParameters>]

Description

Import-AzApiManagementApi cmdlet'i bir dosyadan veya Web Uygulaması Açıklama Dili (WADL), Web Hizmetleri Açıklama Dili (WSDL) veya Swagger biçimindeki bir URL'den Azure API Management API'sini içeri aktarır.

Örnekler

Örnek 1: WADL dosyasından API içeri aktarma

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationPath "C:\contoso\specifications\echoapi.wadl" -Path "apis"

Bu komut, belirtilen WADL dosyasından bir API'yi içeri aktarır.

Örnek 2: Swagger dosyasından API içeri aktarma

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis"

Bu komut, belirtilen Swagger dosyasından bir API'yi içeri aktarır.

Örnek 3: Swagger dosyasından BIR API'yi içeri aktarma ve mevcut BIR API'yi güncelleştirme

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -ApiId "26591405e27d4ff3a8d8478d7e60c7b0" -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis"

Bu komut, belirtilen Swagger dosyasından bir API'yi içeri aktarır ve var olan bir API'yi güncelleştirir.

Örnek 4: WADL bağlantısından API içeri aktarma

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationUrl "http://contoso.com/specifications/wadl/echoapi" -Path "apis"

Bu komut, belirtilen WADL bağlantısından bir API'yi içeri aktarır.

Örnek 5: Open Api Link'ten BIR API'yi içeri aktarma

$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $context -SpecificationFormat OpenApi -SpecificationUrl https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore.yaml -Path "petstore30"

ApiId                         : af3f57bab399455aa875d7050654e9d1
Name                          : Swagger Petstore
Description                   :
ServiceUrl                    : http://petstore.swagger.io/v1
Path                          : petstore30
ApiType                       : http
Protocols                     : {Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    :
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          :
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               :
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/af3f57bab399455aa875d7050654e9d1     
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

Bu komut, belirtilen Open 3.0 belirtimi bağlantısından bir API'yi içeri aktarır.

Örnek 6: Açık Api Bağlantısından API'yi ApiVersion Kümesine aktarma

$context = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $context -SpecificationPath "C:\contoso\specifications\uspto.yml" -SpecificationFormat OpenApi -Path uspostal -ApiVersionSetId 0d50e2cf-aaeb-4ea3-8a58-db9ec079c6cd -ApiVersion v2

ApiId                         : 6c3f20c66e5745b19229d06cd865948f
Name                          : USPTO Data Set API
Description                   : The Data Set API (DSAPI) allows the public users to discover and search USPTO exported data sets. This is a generic API that allows USPTO users to make any CSV based data files
                                searchable through API. With the help of GET call, it returns the list of data fields that are searchable. With the help of POST call, data can be fetched based on the filters on the    
                                field names. Please note that POST call is used to search the actual data. The reason for the POST call is that it allows users to specify any complex search criteria without worry      
                                about the GET size limitations as well as encoding of the input parameters.
ServiceUrl                    : https://developer.uspto.gov/ds-api
Path                          : uspostal
ApiType                       : http
Protocols                     : {Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    : v2
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          :
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/0d50e2cf-aaeb-4ea3-8a58-db9ec079c6cd
Id                            : /subscriptions/subid/resourceGroups/Api-Default-East-US/providers/Microsoft.ApiManagement/service/contoso/apis/6c3f20c66e5745b19229d06cd865948f    
ResourceGroupName             : Api-Default-East-US
ServiceName                   : contoso

Bu komut, belirtilen Open 3.0 belirtimi belgesinden bir API içeri aktarır ve yeni bir ApiVersion oluşturur.

Örnek 7: GraphQL bağlantısından API içeri aktarma

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Import-AzApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "GraphQL" -SpecificationUrl "http://contoso.com/graphql" -Path "graphqlapi"

ApiId                         : bg4g23csd067432zz853f0942341g3z1
Name                          : GraphQL Api
Description                   :
ServiceUrl                    : http://contoso.com/graphql
Path                          : graphqlapi
ApiType                       : graphql
Protocols                     : {Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    :
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          :
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               :
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/bg4g23csd067432zz853f0942341g3z1     
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

Bu komut GraphQL bağlantısından bir API içeri aktarır.

Parametreler

-ApiId

İçeri aktaracak API'nin kimliğini belirtir. Bu parametreyi belirtmezseniz, sizin için bir kimlik oluşturulur.

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

-ApiRevision

API Düzeltme tanımlayıcısı. Bu parametre isteğe bağlıdır. Belirtilmezse, içeri aktarma işlemi şu anda etkin olan düzeltmeye veya yeni bir API'ye yapılır.

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

-ApiType

Bu parametre, varsayılan Http değeriyle isteğe bağlıdır. Soap seçeneği yalnızca WSDL içeri aktarılırken geçerlidir ve soap geçiş API'sini oluşturur.

Tür:	Nullable<T>[PsApiManagementApiType]
Kabul edilen değerler:	Http, Soap, WebSocket, GraphQL
Position:	Named
Default value:	None
Gerekli:	False
İşlem hattı girişini kabul et:	True
Joker karakterleri kabul et:	False

-ApiVersion

Oluşturulacak Api'nin Api Sürümü. 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

-ApiVersionSetId

İlgili Api Sürüm Kümesi için bir kaynak 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

-Path

API'nin genel URL'sinin son bölümü olarak bir web API'si yolu belirtir. Bu URL, API tüketicileri tarafından web hizmetine istek göndermek için kullanılır. 1 ile 400 karakter uzunluğunda olmalıdır. Varsayılan değer $Null.

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

-Protocol

Web API protokolleri (http, https). API'nin kullanılabilir hale getirildiği protokoller. Bu parametre isteğe bağlıdır. Sağlanırsa, belirtimler belgesinde belirtilen protokolleri geçersiz kılar.

Tür:	PsApiManagementSchema[]
Kabul edilen değerler:	Http, Https, Ws, Wss
Position:	Named
Default value:	None
Gerekli:	False
İşlem hattı girişini kabul et:	True
Joker karakterleri kabul et:	False

-ServiceUrl

API'yi kullanıma açan web hizmetinin URL'si. Bu URL yalnızca Azure API Management tarafından kullanılır ve genel kullanıma açık hale getirilmeyecektir. Bu parametre isteğe bağlıdır. Sağlanırsa, Belirtimler belgesinde belirtilen ServiceUrl'ı geçersiz kılar.

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

-SpecificationFormat

Belirtim biçimini belirtir. Wadl, Wsdl ve Swagger'ı psdx_paramvalues.

Tür:	PsApiManagementApiFormat
Kabul edilen değerler:	Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Position:	Named
Default value:	None
Gerekli:	True
İşlem hattı girişini kabul et:	True
Joker karakterleri kabul et:	False

-SpecificationPath

Belirtim dosya yolunu belirtir.

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

-SpecificationUrl

Belirtim URL'sini belirtir.

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

-WsdlEndpointName

İçeri aktarılacak WSDL Uç Noktasının (bağlantı noktası) yerel adı. 1 ile 400 karakter uzunluğunda olmalıdır. Bu parametre isteğe bağlıdır ve yalnızca Wsdl'yi içeri aktarmak için gereklidir. Varsayılan değer $null.

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

-WsdlServiceName

İçeri aktarılacak WSDL Hizmetinin yerel adı. 1 ile 400 karakter uzunluğunda olmalıdır. Bu parametre isteğe bağlıdır ve yalnızca Wsdl'yi içeri aktarmak için gereklidir. Varsayılan değer $null.

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

Girişler

PsApiManagementContext

String

PsApiManagementApiFormat

Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApiType, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Çıkışlar

PsApiManagementApi

Aracılığıyla paylaş

Import-AzApiManagementApi

Sözdizimi

Description

Örnekler

Örnek 1: WADL dosyasından API içeri aktarma

Örnek 2: Swagger dosyasından API içeri aktarma

Örnek 3: Swagger dosyasından BIR API'yi içeri aktarma ve mevcut BIR API'yi güncelleştirme

Örnek 4: WADL bağlantısından API içeri aktarma

Örnek 5: Open Api Link'ten BIR API'yi içeri aktarma

Örnek 6: Açık Api Bağlantısından API'yi ApiVersion Kümesine aktarma

Örnek 7: GraphQL bağlantısından API içeri aktarma

Parametreler

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Girişler

Çıkışlar

Ek kaynaklar

Aracılığıyla paylaş

Import-AzApiManagementApi

Sözdizimi

Description

Örnekler

Örnek 1: WADL dosyasından API içeri aktarma

Örnek 2: Swagger dosyasından API içeri aktarma

Örnek 3: Swagger dosyasından BIR API'yi içeri aktarma ve mevcut BIR API'yi güncelleştirme

Örnek 4: WADL bağlantısından API içeri aktarma

Örnek 5: Open Api Link'ten BIR API'yi içeri aktarma

Örnek 6: Açık Api Bağlantısından API'yi ApiVersion Kümesine aktarma

Örnek 7: GraphQL bağlantısından API içeri aktarma

Parametreler

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Girişler

Çıkışlar

İlişkili Bağlantılar

Ek kaynaklar