Import-AzApiManagementApi

Referência

Módulo:: Az.ApiManagement

Importa uma API de um arquivo ou URL.

Sintaxe

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

O cmdlet Import-AzApiManagementApi importa uma API de Gerenciamento de API do Azure de um arquivo ou URL no formato WADL (Web Application Description Language), WSDL (Web Services Description Language) ou Swagger.

Exemplos

Exemplo 1: Importar uma API de um arquivo WADL

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

Esse comando importa uma API do arquivo WADL especificado.

Exemplo 2: Importar uma API de um arquivo do Swagger

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

Esse comando importa uma API do arquivo Swagger especificado.

Exemplo 3: importar uma API de um arquivo do Swagger e atualizar uma API existente

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

Esse comando importa uma API do arquivo Swagger especificado e atualiza uma API existente.

Exemplo 4: Importar uma API de um link 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"

Esse comando importa uma API do link WADL especificado.

Exemplo 5: Importar uma API de um link de API aberta

$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

Esse comando importa uma API do link de especificação do Open 3.0 especificado.

Exemplo 6: Importar uma API de um link de API aberto para um conjunto 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

Esse comando importa uma API do documento de especificação do Open 3.0 especificado e cria uma nova ApiVersion.

Exemplo 7: Importar uma API de um link do 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

Esse comando importa uma API do link do GraphQL.

Parâmetros

-ApiId

Especifica uma ID para a API importar. Se você não especificar esse parâmetro, uma ID será gerada para você.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-ApiRevision

Identificador de revisão da API. Esse parâmetro é opcional. Se não for especificado, a importação será feita para a revisão ativa no momento ou para uma nova API.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-ApiType

Esse parâmetro é opcional com um valor padrão de Http. A opção Soap só é aplicável ao importar WSDL e criará uma API de passagem SOAP.

Tipo:	Nullable<T>[PsApiManagementApiType]
Valores aceitos:	Http, Soap, WebSocket, GraphQL
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-ApiVersion

Versão da API da API a ser criada. Esse parâmetro é opcional.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-ApiVersionSetId

Um identificador de recurso para o Conjunto de Versões da API relacionado. Esse parâmetro é opcional.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Context

Especifica um objeto PsApiManagementContext .

Tipo:	PsApiManagementContext
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Tipo:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Path

Especifica um caminho da API Web como a última parte da URL pública da API. Essa URL é usada pelos consumidores de API para enviar solicitações ao serviço Web. Deve ter de 1 a 400 caracteres. O valor padrão é $Null.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Protocol

Protocolos de API Web (http, https). Protocolos pelos quais a API é disponibilizada. Esse parâmetro é opcional. Se fornecido, ele substituirá os protocolos especificados no documento de especificações.

Tipo:	PsApiManagementSchema[]
Valores aceitos:	Http, Https, Ws, Wss
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-ServiceUrl

Uma URL do serviço Web que expõe a API. Essa URL será usada apenas pelo Gerenciamento de API do Azure e não será tornada pública. Esse parâmetro é opcional. Se fornecido, ele substituirá o ServiceUrl especificado no documento Especificações.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-SpecificationFormat

Especifica o formato da especificação. psdx_paramvalues Wadl, Wsdl e Swagger.

Tipo:	PsApiManagementApiFormat
Valores aceitos:	Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-SpecificationPath

Especifica o caminho do arquivo de especificação.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-SpecificationUrl

Especifica a URL de especificação.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-WsdlEndpointName

Nome local do Ponto de Extremidade WSDL (porta) a ser importado. Deve ter de 1 a 400 caracteres. Esse parâmetro é opcional e necessário apenas para importar Wsdl. O valor padrão é $null.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-WsdlServiceName

Nome local do serviço WSDL a ser importado. Deve ter de 1 a 400 caracteres. Esse parâmetro é opcional e necessário apenas para importar Wsdl . O valor padrão é $null.

Tipo:	String
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

Entradas

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

Saídas

PsApiManagementApi

Compartilhar via

Import-AzApiManagementApi

Sintaxe

Description

Exemplos

Exemplo 1: Importar uma API de um arquivo WADL

Exemplo 2: Importar uma API de um arquivo do Swagger

Exemplo 3: importar uma API de um arquivo do Swagger e atualizar uma API existente

Exemplo 4: Importar uma API de um link WADL

Exemplo 5: Importar uma API de um link de API aberta

Exemplo 6: Importar uma API de um link de API aberto para um conjunto ApiVersion

Exemplo 7: Importar uma API de um link do GraphQL

Parâmetros

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Entradas

Saídas

Recursos adicionais

Compartilhar via

Import-AzApiManagementApi

Sintaxe

Description

Exemplos

Exemplo 1: Importar uma API de um arquivo WADL

Exemplo 2: Importar uma API de um arquivo do Swagger

Exemplo 3: importar uma API de um arquivo do Swagger e atualizar uma API existente

Exemplo 4: Importar uma API de um link WADL

Exemplo 5: Importar uma API de um link de API aberta

Exemplo 6: Importar uma API de um link de API aberto para um conjunto ApiVersion

Exemplo 7: Importar uma API de um link do GraphQL

Parâmetros

-ApiId

-ApiRevision

-ApiType

-ApiVersion

-ApiVersionSetId

-Context

-DefaultProfile

-Path

-Protocol

-ServiceUrl

-SpecificationFormat

-SpecificationPath

-SpecificationUrl

-WsdlEndpointName

-WsdlServiceName

Entradas

Saídas

Links Relacionados

Recursos adicionais