Partilhar via

ApiEntityBaseContract interface

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

Detalhes do contrato base 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 recurso 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.
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.
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 recurso 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

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

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