Import-AzApiManagementApi

Odwołanie

Moduł:: Az.ApiManagement

Importuje interfejs API z pliku lub adresu URL.

Składnia

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

Opis

Polecenie cmdlet Import-AzApiManagementApi importuje interfejs API usługi Azure API Management z pliku lub adresu URL w języku opisu aplikacji internetowej (WADL), języku opisu usług sieci Web (WSDL) lub formacie struktury Swagger.

Przykłady

Przykład 1. Importowanie interfejsu API z pliku WADL

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

To polecenie importuje interfejs API z określonego pliku WADL.

Przykład 2. Importowanie interfejsu API z pliku struktury Swagger

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

To polecenie importuje interfejs API z określonego pliku struktury Swagger.

Przykład 3. Importowanie interfejsu API z pliku struktury Swagger i aktualizowanie istniejącego interfejsu API

$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"

To polecenie importuje interfejs API z określonego pliku struktury Swagger i aktualizuje istniejący interfejs API.

Przykład 4. Importowanie interfejsu API z linku WADL

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

To polecenie importuje interfejs API z określonego linku WADL.

Przykład 5. Importowanie interfejsu API z otwartego linku interfejsu API

$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

To polecenie importuje interfejs API z określonego linku specyfikacji Open 3.0.

Przykład 6. Importowanie interfejsu API z otwartego linku interfejsu API do zestawu ApiVersion

$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

To polecenie importuje interfejs API z określonego dokumentu specyfikacji Open 3.0 i tworzy nowy interfejs APIVersion.

Przykład 7. Importowanie interfejsu API z linku GraphQL

$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

To polecenie importuje interfejs API z linku GraphQL.

Parametry

-ApiId

Określa identyfikator interfejsu API do zaimportowania. Jeśli nie określisz tego parametru, zostanie wygenerowany identyfikator.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ApiRevision

Identyfikator poprawki interfejsu API. Ten parametr jest opcjonalny. Jeśli nie zostanie określony, import zostanie wykonany do aktualnie aktywnej poprawki lub nowego interfejsu API.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ApiType

Ten parametr jest opcjonalny z wartością domyślną Http. Opcja Soap ma zastosowanie tylko podczas importowania WSDL i utworzy interfejs API przekazywania protokołu SOAP.

Typ:	Nullable<T>[PsApiManagementApiType]
Dopuszczalne wartości:	Http, Soap, WebSocket, GraphQL
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ApiVersion

Wersja interfejsu API do utworzenia. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ApiVersionSetId

Identyfikator zasobu powiązanego zestawu wersji interfejsu API. Ten parametr jest opcjonalny.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Context

Określa obiekt PsApiManagementContext.

Typ:	PsApiManagementContext
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-DefaultProfile

Poświadczenia, konto, dzierżawa i subskrypcja używane do komunikacji z platformą Azure.

Typ:	IAzureContextContainer
Aliasy:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Path

Określa ścieżkę internetowego interfejsu API jako ostatnią część publicznego adresu URL interfejsu API. Ten adres URL jest używany przez użytkowników interfejsu API do wysyłania żądań do usługi internetowej. Musi mieć długość od 1 do 400 znaków. Wartość domyślna to $Null.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Protocol

Protokoły internetowego interfejsu API (http, https). Protokoły, za pośrednictwem których udostępniono interfejs API. Ten parametr jest opcjonalny. Jeśli zostanie podany, zastąpi protokoły określone w dokumencie specyfikacji.

Typ:	PsApiManagementSchema[]
Dopuszczalne wartości:	Http, Https, Ws, Wss
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-ServiceUrl

Adres URL usługi internetowej uwidaczniającej interfejs API. Ten adres URL będzie używany tylko przez usługę Azure API Management i nie zostanie upubliczniony. Ten parametr jest opcjonalny. Jeśli zostanie podana, zastąpi element ServiceUrl określony w dokumencie Specyfikacje.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SpecificationFormat

Określa format specyfikacji. psdx_paramvalues Wadl, Wsdl i Swagger.

Typ:	PsApiManagementApiFormat
Dopuszczalne wartości:	Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SpecificationPath

Określa ścieżkę pliku specyfikacji.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-SpecificationUrl

Określa adres URL specyfikacji.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-WsdlEndpointName

Nazwa lokalna punktu końcowego WSDL (port) do zaimportowania. Musi mieć długość od 1 do 400 znaków. Ten parametr jest opcjonalny i wymagany tylko do importowania pliku Wsdl. Wartość domyślna to $null.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-WsdlServiceName

Nazwa lokalna usługi WSDL do zaimportowania. Musi mieć długość od 1 do 400 znaków. Ten parametr jest opcjonalny i wymagany tylko do importowania pliku Wsdl. Wartość domyślna to $null.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

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

Dane wyjściowe

PsApiManagementApi

Udostępnij za pośrednictwem

Import-AzApiManagementApi

Składnia

Opis

Przykłady

Przykład 1. Importowanie interfejsu API z pliku WADL

Przykład 2. Importowanie interfejsu API z pliku struktury Swagger

Przykład 3. Importowanie interfejsu API z pliku struktury Swagger i aktualizowanie istniejącego interfejsu API

Przykład 4. Importowanie interfejsu API z linku WADL

Przykład 5. Importowanie interfejsu API z otwartego linku interfejsu API

Przykład 6. Importowanie interfejsu API z otwartego linku interfejsu API do zestawu ApiVersion

Przykład 7. Importowanie interfejsu API z linku GraphQL

Parametry

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Dane wejściowe

Dane wyjściowe

Dodatkowe zasoby

Udostępnij za pośrednictwem

Import-AzApiManagementApi

Składnia

Opis

Przykłady

Przykład 1. Importowanie interfejsu API z pliku WADL

Przykład 2. Importowanie interfejsu API z pliku struktury Swagger

Przykład 3. Importowanie interfejsu API z pliku struktury Swagger i aktualizowanie istniejącego interfejsu API

Przykład 4. Importowanie interfejsu API z linku WADL

Przykład 5. Importowanie interfejsu API z otwartego linku interfejsu API

Przykład 6. Importowanie interfejsu API z otwartego linku interfejsu API do zestawu ApiVersion

Przykład 7. Importowanie interfejsu API z linku GraphQL

Parametry

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Dane wejściowe

Dane wyjściowe

Linki powiązane

Dodatkowe zasoby