Compartilhar via

ApiContractUpdateProperties interface

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

Propriedades do contrato de atualização de API.

Extends
ApiEntityBaseContract

Propriedades

displayName

Nome da API.
path

URL relativa identificando exclusivamente essa 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 nesta API podem ser invocadas.
serviceUrl

URL absoluta do serviço de back-end que implementa essa API.

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 for versão
apiVersionDescription

Descrição da versão da API.
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

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

Indica se a revisão da 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.
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

displayName

Nome da API.

displayName?: string

Valor da propriedade

string

path

URL relativa identificando exclusivamente essa 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

protocols

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

protocols?: string[]

Valor da propriedade

string[]

serviceUrl

URL absoluta do serviço de back-end que implementa essa API.

serviceUrl?: string

Valor da propriedade

string

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 deApiEntityBaseContract.apiRevision

apiRevisionDescription

Descrição da Revisão da API.

apiRevisionDescription?: string

Valor da propriedade

string

herdado deApiEntityBaseContract.apiRevisionDescription

apiType

Tipo de API.

apiType?: string

Valor da propriedade

string

herdado deApiEntityBaseContract.apiType

apiVersion

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

apiVersion?: string

Valor da propriedade

string

herdado deApiEntityBaseContract.apiVersion

apiVersionDescription

Descrição da versão da API.

apiVersionDescription?: string

Valor da propriedade

string

herdado deApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Um identificador de recurso para o ApiVersionSet relacionado.

apiVersionSetId?: string

Valor da propriedade

string

herdado deApiEntityBaseContract.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Valor da propriedade

AuthenticationSettingsContract

herdado deApiEntityBaseContract.authenticationSettings

contact

Informações de contato para a API.

contact?: ApiContactInformation

Valor da propriedade

ApiContactInformation

Herdado deApiEntityBaseContract.contact

description

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

description?: string

Valor da propriedade

string

herdado deApiEntityBaseContract.description

isCurrent

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

isCurrent?: boolean

Valor da propriedade

boolean

herdado deApiEntityBaseContract.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 deApiEntityBaseContract.isOnline

license

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

license?: ApiLicenseInformation

Valor da propriedade

ApiLicenseInformation

herdado deApiEntityBaseContract.license

subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor da propriedade

SubscriptionKeyParameterNamesContract

herdado deApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Valor da propriedade

boolean

herdado deApiEntityBaseContract.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 deApiEntityBaseContract.termsOfServiceUrl