Partilhar via

ApiCreateOrUpdateProperties interface

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

API Criar ou atualizar propriedades.

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
  • graphql cria a API GraphQL.
translateRequiredQueryParametersConduct

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

Valor de conteúdo ao importar uma API.
wsdlSelector

Critérios para limitar a importação de 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 da API.
apiType

Tipo de API.
apiVersion

Indica o identificador de versão da API se a API estiver versionada
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 nesta API.
contact

Informações de contato para a API.
description

Descrição da API. Pode incluir tags de formatação HTML.
displayName

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

Indica se a revisão da API é a revisão atual da api.
isOnline

Indica se a revisão da API está acessível através do gateway. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
license

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

URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API. Ele é anexado à URL base do ponto de extremidade da 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 nesta API podem ser invocadas.
serviceUrl

URL absoluta do serviço de back-end que implementa esta API. Não pode ter mais de 2000 caracteres.
sourceApiId

Identificador de API da API de origem.
subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.
subscriptionRequired

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

Um URL para os Termos de Serviço da API. DEVE estar no formato de um URL.

Detalhes de Propriedade

format

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

format?: string

Valor de 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
  • graphql cria a API GraphQL.
soapApiType?: string

Valor de Propriedade

string

translateRequiredQueryParametersConduct

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

translateRequiredQueryParametersConduct?: string

Valor de Propriedade

string

value

Valor de conteúdo ao importar uma API.

value?: string

Valor de Propriedade

string

wsdlSelector

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

wsdlSelector?: ApiCreateOrUpdatePropertiesWsdlSelector

Valor de Propriedade

ApiCreateOrUpdatePropertiesWsdlSelector

Detalhes da Propriedade Herdada

apiRevision

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

apiRevision?: string

Valor de Propriedade

string

herdado de ApiContractProperties.apiRevision

apiRevisionDescription

Descrição da revisão da API.

apiRevisionDescription?: string

Valor de Propriedade

string

herdado de ApiContractProperties.apiRevisionDescription

apiType

Tipo de API.

apiType?: string

Valor de Propriedade

string

herdado de ApiContractProperties.apiType

apiVersion

Indica o identificador de versão da API se a API estiver versionada

apiVersion?: string

Valor de Propriedade

string

herdado de ApiContractProperties.apiVersion

apiVersionDescription

Descrição da versão da API.

apiVersionDescription?: string

Valor de Propriedade

string

herdado de ApiContractProperties.apiVersionDescription

apiVersionSet

Detalhes do conjunto de versões

apiVersionSet?: ApiVersionSetContractDetails

Valor de Propriedade

ApiVersionSetContractDetails

herdado de ApiContractProperties.apiVersionSet

apiVersionSetId

Um identificador de recurso para o ApiVersionSet relacionado.

apiVersionSetId?: string

Valor de Propriedade

string

herdado de ApiContractProperties.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Valor de Propriedade

AuthenticationSettingsContract

herdado deApiContractProperties.authenticationSettings

contact

Informações de contato para a API.

contact?: ApiContactInformation

Valor de Propriedade

ApiContactInformation

herdado deApiContractProperties.contact

description

Descrição da API. Pode incluir tags de formatação HTML.

description?: string

Valor de Propriedade

string

herdado deApiContractProperties.description

displayName

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

displayName?: string

Valor de Propriedade

string

herdado de ApiContractProperties.displayName

isCurrent

Indica se a revisão da API é a revisão atual da api.

isCurrent?: boolean

Valor de Propriedade

boolean

herdado de ApiContractProperties.isCurrent

isOnline

Indica se a revisão da API está acessível através do gateway. Observação : esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

isOnline?: boolean

Valor de Propriedade

boolean

herdado deApiContractProperties.isOnline

license

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

license?: ApiLicenseInformation

Valor de Propriedade

ApiLicenseInformation

herdado deApiContractProperties.license

path

URL relativa que identifica exclusivamente essa API e todos os seus caminhos de recursos dentro da instância do serviço de Gerenciamento de API. Ele é anexado à URL base do ponto de extremidade da API especificada durante a criação da instância de serviço para formar uma URL pública para essa API.

path: string

Valor de Propriedade

string

herdado de ApiContractProperties.path

protocols

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

protocols?: string[]

Valor de Propriedade

string[]

herdado deApiContractProperties.protocols

serviceUrl

URL absoluta do serviço de back-end que implementa esta API. Não pode ter mais de 2000 caracteres.

serviceUrl?: string

Valor de Propriedade

string

herdado de ApiContractProperties.serviceUrl

sourceApiId

Identificador de API da API de origem.

sourceApiId?: string

Valor de Propriedade

string

herdado de ApiContractProperties.sourceApiId

subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor de Propriedade

SubscriptionKeyParameterNamesContract

herdado deApiContractProperties.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Valor de Propriedade

boolean

herdado deApiContractProperties.subscriptionRequired

termsOfServiceUrl

Um URL para os Termos de Serviço da API. DEVE estar no formato de um URL.

termsOfServiceUrl?: string

Valor de Propriedade

string

herdado de ApiContractProperties.termsOfServiceUrl