Import-AzApiManagementApi

Referenz

Modul:: Az.ApiManagement

Importiert eine API aus einer Datei oder einer URL.

Syntax

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

Beschreibung

Mit dem Cmdlet Import-AzApiManagementApi-Cmdlet wird eine Azure API-Verwaltungs-API aus einer Datei oder einer URL in der Web Application Description Language (WADL), der Web Services Description Language (WSDL) oder dem Swagger-Format importiert.

Beispiele

Beispiel 1: Importieren einer API aus einer WADL-Datei

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

Mit diesem Befehl wird eine API aus der angegebenen WADL-Datei importiert.

Beispiel 2: Importieren einer API aus einer Swagger-Datei

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

Mit diesem Befehl wird eine API aus der angegebenen Swagger-Datei importiert.

Beispiel 3: Importieren einer API aus einer Swagger-Datei und Aktualisieren einer vorhandenen 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"

Dieser Befehl importiert eine API aus der angegebenen Swagger-Datei und aktualisiert eine vorhandene API.

Beispiel 4: Importieren einer API aus einem WADL-Link

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

Mit diesem Befehl wird eine API aus dem angegebenen WADL-Link importiert.

Beispiel 5: Importieren einer API aus einem Offenen API-Link

$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

Dieser Befehl importiert eine API aus dem angegebenen Open 3.0-Spezifikationslink.

Beispiel 6: Importieren einer API aus einem Open-API-Link in einen ApiVersion-Satz

$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

Mit diesem Befehl wird eine API aus dem angegebenen Open 3.0-Spezifikationsdokument importiert und eine neue ApiVersion erstellt.

Beispiel 7: Importieren einer API aus einem GraphQL-Link

$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

Mit diesem Befehl wird eine API aus der GraphQL-Verknüpfung importiert.

Parameter

-ApiId

Gibt eine ID für die zu importierende API an. Wenn Sie diesen Parameter nicht angeben, wird eine ID für Sie generiert.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-ApiRevision

Bezeichner der API-Revision. Dieser Parameter ist optional. Wenn nicht angegeben, wird der Import auf die derzeit aktive Revision oder eine neue API durchgeführt.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-ApiType

Dieser Parameter ist optional mit einem Standardwert von Http. Die Soap-Option gilt nur beim Importieren von WSDL und erstellt eine SOAP-Passthrough-API.

Typ:	Nullable<T>[PsApiManagementApiType]
Zulässige Werte:	Http, Soap, WebSocket, GraphQL
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-ApiVersion

Api-Version der zu erstellenden API. Dieser Parameter ist optional.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-ApiVersionSetId

Ein Ressourcenbezeichner für den zugehörigen API-Versionssatz. Dieser Parameter ist optional.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Context

Gibt ein PsApiManagementContext- -Objekt an.

Typ:	PsApiManagementContext
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-DefaultProfile

Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.

Typ:	IAzureContextContainer
Aliase:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	False
Platzhalterzeichen akzeptieren:	False

-Path

Gibt einen Web-API-Pfad als letzten Teil der öffentlichen URL der API an. Diese URL wird von API-Consumern zum Senden von Anforderungen an den Webdienst verwendet. Muss 1 bis 400 Zeichen lang sein. Der Standardwert ist $Null.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-Protocol

Web-API-Protokolle (http, https). Protokolle, über die API verfügbar gemacht wird. Dieser Parameter ist optional. Wenn angegeben, werden die im Spezifikationsdokument angegebenen Protokolle außer Kraft gesetzt.

Typ:	PsApiManagementSchema[]
Zulässige Werte:	Http, Https, Ws, Wss
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-ServiceUrl

Eine URL des Webdiensts, der die API verfügbar gibt. Diese URL wird nur von Azure API Management verwendet und wird nicht öffentlich gemacht. Dieser Parameter ist optional. Wenn angegeben, wird der im Dokument "Spezifikationen" angegebene ServiceUrl außer Kraft gesetzt.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-SpecificationFormat

Gibt das Spezifikationsformat an. psdx_paramvalues Wadl, Wsdl und Swagger.

Typ:	PsApiManagementApiFormat
Zulässige Werte:	Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-SpecificationPath

Gibt den Pfad der Spezifikationsdatei an.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-SpecificationUrl

Gibt die Spezifikations-URL an.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	True
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-WsdlEndpointName

Lokaler Name des zu importierenden WSDL-Endpunkts (Port). Muss 1 bis 400 Zeichen lang sein. Dieser Parameter ist optional und nur für den Import von Wsdl erforderlich. Der Standardwert ist $null.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

-WsdlServiceName

Lokaler Name des zu importierenden WSDL-Diensts. Muss 1 bis 400 Zeichen lang sein. Dieser Parameter ist optional und nur für den Import von Wsdl erforderlich. Der Standardwert ist $null.

Typ:	String
Position:	Named
Standardwert:	None
Erforderlich:	False
Pipelineeingabe akzeptieren:	True
Platzhalterzeichen akzeptieren:	False

Eingaben

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

Ausgaben

PsApiManagementApi

Freigeben über

Import-AzApiManagementApi

Syntax

Beschreibung

Beispiele

Beispiel 1: Importieren einer API aus einer WADL-Datei

Beispiel 2: Importieren einer API aus einer Swagger-Datei

Beispiel 3: Importieren einer API aus einer Swagger-Datei und Aktualisieren einer vorhandenen API

Beispiel 4: Importieren einer API aus einem WADL-Link

Beispiel 5: Importieren einer API aus einem Offenen API-Link

Beispiel 6: Importieren einer API aus einem Open-API-Link in einen ApiVersion-Satz

Beispiel 7: Importieren einer API aus einem GraphQL-Link

Parameter

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Eingaben

Ausgaben

Zusätzliche Ressourcen

Freigeben über

Import-AzApiManagementApi

Syntax

Beschreibung

Beispiele

Beispiel 1: Importieren einer API aus einer WADL-Datei

Beispiel 2: Importieren einer API aus einer Swagger-Datei

Beispiel 3: Importieren einer API aus einer Swagger-Datei und Aktualisieren einer vorhandenen API

Beispiel 4: Importieren einer API aus einem WADL-Link

Beispiel 5: Importieren einer API aus einem Offenen API-Link

Beispiel 6: Importieren einer API aus einem Open-API-Link in einen ApiVersion-Satz

Beispiel 7: Importieren einer API aus einem GraphQL-Link

Parameter

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Eingaben

Ausgaben

Ähnliche Themen

Zusätzliche Ressourcen