Partilhar via

ApiUpdateContract interface

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

Detalhes do contrato de atualização da API.

Propriedades

apiRevision

Descreve a revisão da API. Se não for fornecido nenhum valor, é criada a revisão predefinida 1
apiRevisionDescription

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

Tipo de API.
apiVersion

Indica o identificador de versão da API se a API tiver uma versão
apiVersionDescription

Descrição da Versão da API.
apiVersionSetId

Um identificador de recursos para o ApiVersionSet relacionado.
authenticationSettings

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

Informações de contacto da API.
description

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

Nome da API.
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. NOTA: esta propriedade não será serializada. Só pode ser preenchido pelo servidor.
license

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

O URL relativo identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API.
protocols

Descreve os protocolos que as operações nesta API podem ser invocadas.
serviceUrl

URL absoluto do serviço de back-end que implementa esta API.
subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.
subscriptionRequired

Especifica se é necessária uma subscrição de API ou Produto para aceder à API.
termsOfServiceUrl

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

Detalhes de Propriedade

apiRevision

Descreve a revisão da API. Se não for fornecido nenhum valor, é criada a revisão predefinida 1

apiRevision?: string

Valor de Propriedade

string

apiRevisionDescription

Descrição da Revisão da API.

apiRevisionDescription?: string

Valor de Propriedade

string

apiType

Tipo de API.

apiType?: string

Valor de Propriedade

string

apiVersion

Indica o identificador de versão da API se a API tiver uma versão

apiVersion?: string

Valor de Propriedade

string

apiVersionDescription

Descrição da Versão da API.

apiVersionDescription?: string

Valor de Propriedade

string

apiVersionSetId

Um identificador de recursos para o ApiVersionSet relacionado.

apiVersionSetId?: string

Valor de Propriedade

string

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Valor de Propriedade

AuthenticationSettingsContract

contact

Informações de contacto da API.

contact?: ApiContactInformation

Valor de Propriedade

ApiContactInformation

description

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

description?: string

Valor de Propriedade

string

displayName

Nome da API.

displayName?: string

Valor de Propriedade

string

isCurrent

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

isCurrent?: boolean

Valor de Propriedade

boolean

isOnline

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

isOnline?: boolean

Valor de Propriedade

boolean

license

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

license?: ApiLicenseInformation

Valor de Propriedade

ApiLicenseInformation

path

O URL relativo identifica exclusivamente esta API e todos os respetivos caminhos de recursos na instância do serviço Gestão de API. É anexado ao URL base do ponto final da API especificado durante a criação da instância de serviço para formar um URL público para esta API.

path?: string

Valor de Propriedade

string

protocols

Descreve os protocolos que as operações nesta API podem ser invocadas.

protocols?: string[]

Valor de Propriedade

string[]

serviceUrl

URL absoluto do serviço de back-end que implementa esta API.

serviceUrl?: string

Valor de Propriedade

string

subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor de Propriedade

SubscriptionKeyParameterNamesContract

subscriptionRequired

Especifica se é necessária uma subscrição de API ou Produto para aceder à API.

subscriptionRequired?: boolean

Valor de Propriedade

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

Valor de Propriedade

string