ApiEntityBaseContract interface

Pacote:

@azure/arm-apimanagement

Detalhes do contrato base da API.

Propriedades

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

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

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 estiver versionada

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 configurações de autenticação incluídas nesta API.

authenticationSettings?: AuthenticationSettingsContract

Valor de Propriedade

AuthenticationSettingsContract

contact

Informações de contato para a API.

contact?: ApiContactInformation

Valor de Propriedade

ApiContactInformation

description

Descrição da API. Pode incluir tags 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. Observação : esta propriedade não será serializada. Ele 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 uma API ou assinatura de Produto é necessária para acessar a API.

subscriptionRequired?: boolean

Valor de Propriedade

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

Valor de Propriedade

string