Compartilhar via

Import-AzApiManagementApi

Módulo:
Az.ApiManagement Module

Importa uma API de um arquivo ou uma URL.

Sintaxe

ImportFromLocalFile (Default) 

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

ImportFromUrl 

Import-AzApiManagementApi
    -Context <PsApiManagementContext>
    -SpecificationFormat <PsApiManagementApiFormat>
    -SpecificationUrl <String>
    [-ApiId <String>]
    [-ApiRevision <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 uma URL no formato WADL (Linguagem de Descrição do Aplicativo Web), WSDL (Linguagem de Descrição dos Serviços Web) 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 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 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.

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

$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 open 3.0 especificado.

$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 open 3.0 especificado e cria uma nova ApiVersion.

$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 importação da API. Se você não especificar esse parâmetro, uma ID será gerada para você.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ApiRevision

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ApiType

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

Propriedades do parâmetro

Tipo:

Nullable<T>[PsApiManagementApiType]

Valor padrão:None
Valores aceitos:Http, Soap, WebSocket, GraphQL
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ApiVersion

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ApiVersionSetId

Um identificador de recurso para o conjunto de versões da API relacionada. Esse parâmetro é opcional.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Context

Especifica um objeto PsApiManagementContext .

Propriedades do parâmetro

Tipo:PsApiManagementContext
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-DefaultProfile

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

Propriedades do parâmetro

Tipo:IAzureContextContainer
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Path

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Protocol

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

Propriedades do parâmetro

Tipo:

PsApiManagementSchema[]

Valor padrão:None
Valores aceitos:Http, Https, Ws, Wss
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-ServiceUrl

Uma URL do serviço Web expondo 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.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SpecificationFormat

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

Propriedades do parâmetro

Tipo:PsApiManagementApiFormat
Valor padrão:None
Valores aceitos:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson, GraphQL
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SpecificationPath

Especifica o caminho do arquivo de especificação.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ImportFromLocalFile
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-SpecificationUrl

Especifica a URL de especificação.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

ImportFromUrl
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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 só é necessário para importar o Wsdl. O valor padrão é $null.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-WsdlServiceName

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

PsApiManagementContext

String

PsApiManagementApiFormat

Nullable<T>

Saídas

PsApiManagementApi