Compartilhar via

ApiCreateOrUpdateProperties interface

  • Referência
Pacote:
@azure/arm-apimanagement

Criar ou atualizar propriedades da API.

Extends
ApiContractProperties

Propriedades

format

Formato do Conteúdo no qual a API está sendo importada.
soapApiType

Tipo de API a ser criada.

  • http cria uma API REST
  • soap cria uma API de passagem SOAP
  • websocket cria a API websocket
  • graphqlcria GraphQL API.
translateRequiredQueryParametersConduct

Estratégia de traduzir parâmetros de consulta necessários para os modelos. Por padrão, tem o valor 'template'. Valores possíveis: 'template', 'query'
value

Valor do conteúdo ao importar uma API.
wsdlSelector

Critérios para limitar a importação do WSDL a um subconjunto do documento.

Propriedades herdadas

apiRevision

Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada
apiRevisionDescription

Descrição da Revisão de API.
apiType

Tipo de API.
apiVersion

Indica o identificador de versão da API se a API for versão
apiVersionDescription

Descrição da versão da API.
apiVersionSet

Detalhes do conjunto de versões
apiVersionSetId

Um identificador de recurso para o ApiVersionSet relacionado.
authenticationSettings

Coleção de configurações de autenticação incluídas nessa API.
contact

Informações de contato para a API.
description

A descrição da API. Pode incluir marcas de formatação HTML.
displayName

Nome da API. Deve ter de 1 a 300 caracteres.
isCurrent

Indica se a revisão de API é a revisão de API atual.
isOnline

Indica se a revisão da API está acessível por meio do gateway. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
license

Informações de licença para a API.
path

A URL relativa que identifica exclusivamente esta API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do Ponto de Extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.
protocols

Descreve em quais protocolos as operações nessa API podem ser invocadas.
serviceUrl

A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2.000 caracteres.
sourceApiId

Identificador de API da API de origem.
subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.
subscriptionRequired

Especifica se uma assinatura de API ou produto é necessária para acessar a API.
termsOfServiceUrl

Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.

Detalhes da propriedade

format

Formato do Conteúdo no qual a API está sendo importada.

format?: string

Valor da propriedade

string

soapApiType

Tipo de API a ser criada.

  • http cria uma API REST
  • soap cria uma API de passagem SOAP
  • websocket cria a API websocket
  • graphqlcria GraphQL API.
soapApiType?: string

Valor da propriedade

string

translateRequiredQueryParametersConduct

Estratégia de traduzir parâmetros de consulta necessários para os modelos. Por padrão, tem o valor 'template'. Valores possíveis: 'template', 'query'

translateRequiredQueryParametersConduct?: string

Valor da propriedade

string

value

Valor do conteúdo ao importar uma API.

value?: string

Valor da propriedade

string

wsdlSelector

Critérios para limitar a importação do WSDL a um subconjunto do documento.

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Valor da propriedade

ApiCreateOrUpdatePropertiesWsdlSelector

Detalhes das propriedades herdadas

apiRevision

Descreve a revisão da API. Se nenhum valor for fornecido, a revisão padrão 1 será criada

apiRevision?: string

Valor da propriedade

string

Herdado deApiContractProperties.apiRevision

apiRevisionDescription

Descrição da Revisão de API.

apiRevisionDescription?: string

Valor da propriedade

string

Herdado deApiContractProperties.apiRevisionDescription

apiType

Tipo de API.

apiType?: string

Valor da propriedade

string

Herdado deApiContractProperties.apiType

apiVersion

Indica o identificador de versão da API se a API for versão

apiVersion?: string

Valor da propriedade

string

Herdado deApiContractProperties.apiVersion

apiVersionDescription

Descrição da versão da API.

apiVersionDescription?: string

Valor da propriedade

string

Herdado deApiContractProperties.apiVersionDescription

apiVersionSet

Detalhes do conjunto de versões

apiVersionSet?: ApiVersionSetContractDetails

Valor da propriedade

ApiVersionSetContractDetails

Herdado deApiContractProperties.apiVersionSet

apiVersionSetId

Um identificador de recurso para o ApiVersionSet relacionado.

apiVersionSetId?: string

Valor da propriedade

string

Herdado deApiContractProperties.apiVersionSetId

authenticationSettings

Coleção de configurações de autenticação incluídas nessa API.

authenticationSettings?: AuthenticationSettingsContract

Valor da propriedade

AuthenticationSettingsContract

Herdado deApiContractProperties.authenticationSettings

contact

Informações de contato para a API.

contact?: ApiContactInformation

Valor da propriedade

ApiContactInformation

Herdado deApiContractProperties.contact

description

A descrição da API. Pode incluir marcas de formatação HTML.

description?: string

Valor da propriedade

string

Herdado deApiContractProperties.description

displayName

Nome da API. Deve ter de 1 a 300 caracteres.

displayName?: string

Valor da propriedade

string

Herdado deApiContractProperties.displayName

isCurrent

Indica se a revisão de API é a revisão de API atual.

isCurrent?: boolean

Valor da propriedade

boolean

Herdado deApiContractProperties.isCurrent

isOnline

Indica se a revisão da API está acessível por meio do gateway. OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

isOnline?: boolean

Valor da propriedade

boolean

Herdado deApiContractProperties.isOnline

license

Informações de licença para a API.

license?: ApiLicenseInformation

Valor da propriedade

ApiLicenseInformation

Herdado deApiContractProperties.license

path

A URL relativa que identifica exclusivamente esta API e todos os seus caminhos de recurso dentro da instância do serviço de Gerenciamento de API. Ele é acrescentado à URL base do Ponto de Extremidade de API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.

path: string

Valor da propriedade

string

Herdado deApiContractProperties.path

protocols

Descreve em quais protocolos as operações nessa API podem ser invocadas.

protocols?: string[]

Valor da propriedade

string[]

Herdado deApiContractProperties.protocols

serviceUrl

A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2.000 caracteres.

serviceUrl?: string

Valor da propriedade

string

Herdado deApiContractProperties.serviceUrl

sourceApiId

Identificador de API da API de origem.

sourceApiId?: string

Valor da propriedade

string

Herdado deApiContractProperties.sourceApiId

subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor da propriedade

SubscriptionKeyParameterNamesContract

Herdado deApiContractProperties.subscriptionKeyParameterNames

subscriptionRequired

Especifica se uma assinatura de API ou produto é necessária para acessar a API.

subscriptionRequired?: boolean

Valor da propriedade

boolean

Herdado deApiContractProperties.subscriptionRequired

termsOfServiceUrl

Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.

termsOfServiceUrl?: string

Valor da propriedade

string

Herdado deApiContractProperties.termsOfServiceUrl