Import-AzApiManagementApi

Referens

Modul:: Az.ApiManagement

Importerar ett API från en fil eller en 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>]

Description

Cmdleten Import-AzApiManagementApi importerar ett Azure API Management API från en fil eller en URL i WADL (Web Application Description Language), Web Services Description Language (WSDL) eller Swagger-format.

Exempel

Exempel 1: Importera ett API från en WADL-fil

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

Det här kommandot importerar ett API från den angivna WADL-filen.

Exempel 2: Importera ett API från en Swagger-fil

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

Det här kommandot importerar ett API från den angivna Swagger-filen.

Exempel 3: Importera ett API från en Swagger-fil och uppdatera ett befintligt 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"

Det här kommandot importerar ett API från den angivna Swagger-filen och uppdaterar ett befintligt API.

Exempel 4: Importera ett API från en WADL-länk

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

Det här kommandot importerar ett API från den angivna WADL-länken.

Exempel 5: Importera ett API från en Öppen API-länk

$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

Det här kommandot importerar ett API från den angivna öppna 3.0-specifikationslänken.

Exempel 6: Importera ett API från en Öppen API-länk till en ApiVersion-uppsättning

$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

Det här kommandot importerar ett API från det angivna öppna 3.0-specifikationsdokumentet och skapar en ny ApiVersion.

Exempel 7: Importera ett API från en GraphQL-länk

$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

Det här kommandot importerar ett API från GraphQL-länken.

Parametrar

-ApiId

Anger ett ID för API:et som ska importeras. Om du inte anger den här parametern genereras ett ID åt dig.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-ApiRevision

Identifierare för API Revision. Den här parametern är valfri. Om det inte anges görs importen till den aktuella aktiva revisionen eller ett nytt API.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-ApiType

Den här parametern är valfri med standardvärdet Http. Soap-alternativet gäller endast vid import av WSDL och skapar ett SOAP-API för genomströmning.

Typ:	Nullable<T>[PsApiManagementApiType]
Godkända värden:	Http, Soap, WebSocket, GraphQL
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-ApiVersion

Api-version av API:et som ska skapas. Den här parametern är valfri.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-ApiVersionSetId

En resursidentifierare för den relaterade API-versionsuppsättningen. Den här parametern är valfri.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-Context

Anger ett PsApiManagementContext- objekt.

Typ:	PsApiManagementContext
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:	IAzureContextContainer
Alias:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	False
Godkänn jokertecken:	False

-Path

Anger en webb-API-sökväg som den sista delen av API:ets offentliga URL. Den här URL:en används av API-konsumenter för att skicka begäranden till webbtjänsten. Måste vara mellan 1 och 400 tecken långt. Standardvärdet är $Null.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-Protocol

Webb-API-protokoll (http, https). Protokoll som API:et görs tillgängligt för. Den här parametern är valfri. Om det tillhandahålls åsidosätter det de protokoll som anges i specifikationerna i dokumentet.

Typ:	PsApiManagementSchema[]
Godkända värden:	Http, Https, Ws, Wss
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-ServiceUrl

En URL till webbtjänsten som exponerar API:et. Den här URL:en används endast av Azure API Management och kommer inte att offentliggöras. Den här parametern är valfri. Om den tillhandahålls åsidosätter den ServiceUrl som anges i dokumentet Specifikationer.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-SpecificationFormat

Anger specifikationsformatet. psdx_paramvalues Wadl, Wsdl och Swagger.

Typ:	PsApiManagementApiFormat
Godkända värden:	Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-SpecificationPath

Anger sökvägen till specifikationsfilen.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-SpecificationUrl

Anger specifikations-URL:en.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	True
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-WsdlEndpointName

Lokalt namn på den WSDL-slutpunkt (port) som ska importeras. Måste vara mellan 1 och 400 tecken långt. Den här parametern är valfri och krävs endast för import av Wsdl. Standardvärdet är $null.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

-WsdlServiceName

Lokalt namn på WSDL-tjänsten som ska importeras. Måste vara mellan 1 och 400 tecken långt. Den här parametern är valfri och krävs endast för att importera Wsdl . Standardvärdet är $null.

Typ:	String
Position:	Named
Standardvärde:	None
Obligatorisk:	False
Godkänn pipeline-indata:	True
Godkänn jokertecken:	False

Indata

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

Utdata

PsApiManagementApi

Dela via

Import-AzApiManagementApi

Syntax

Description

Exempel

Exempel 1: Importera ett API från en WADL-fil

Exempel 2: Importera ett API från en Swagger-fil

Exempel 3: Importera ett API från en Swagger-fil och uppdatera ett befintligt API

Exempel 4: Importera ett API från en WADL-länk

Exempel 5: Importera ett API från en Öppen API-länk

Exempel 6: Importera ett API från en Öppen API-länk till en ApiVersion-uppsättning

Exempel 7: Importera ett API från en GraphQL-länk

Parametrar

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Indata

Utdata

Ytterligare resurser

Dela via

Import-AzApiManagementApi

Syntax

Description

Exempel

Exempel 1: Importera ett API från en WADL-fil

Exempel 2: Importera ett API från en Swagger-fil

Exempel 3: Importera ett API från en Swagger-fil och uppdatera ett befintligt API

Exempel 4: Importera ett API från en WADL-länk

Exempel 5: Importera ett API från en Öppen API-länk

Exempel 6: Importera ett API från en Öppen API-länk till en ApiVersion-uppsättning

Exempel 7: Importera ett API från en GraphQL-länk

Parametrar

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Indata

Utdata

Relaterade länkar

Ytterligare resurser