ApiTagResourceContractProperties interface

Pacote:

@azure/arm-apimanagement

Propriedades de contrato de API para os Recursos de tag.

Extends

ApiEntityBaseContract

Propriedades

id	Identificador de API no formato /apis/{apiId}.
name	Nome da 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.

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

id

Identificador de API no formato /apis/{apiId}.

id?: string

Valor de Propriedade

string

name

Nome da API.

name?: string

Valor de Propriedade

string

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

protocols

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

protocols?: string[]

Valor de Propriedade

string[]

serviceUrl

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

serviceUrl?: string

Valor de Propriedade

string

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

apiRevisionDescription

Descrição da revisão da API.

apiRevisionDescription?: string

Valor de Propriedade

string

herdado de ApiEntityBaseContract.apiRevisionDescription

apiType

Tipo de API.

apiType?: string

Valor de Propriedade

string

herdado de ApiEntityBaseContract.apiType

apiVersion

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

apiVersion?: string

Valor de Propriedade

string

herdado de ApiEntityBaseContract.apiVersion

apiVersionDescription

Descrição da versão da API.

apiVersionDescription?: string

Valor de Propriedade

string

herdado de ApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Um identificador de recurso para o ApiVersionSet relacionado.

apiVersionSetId?: string

Valor de Propriedade

string

herdado de ApiEntityBaseContract.apiVersionSetId

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Valor de Propriedade

AuthenticationSettingsContract

herdado deApiEntityBaseContract.authenticationSettings

contact

Informações de contato para a API.

contact?: ApiContactInformation

Valor de Propriedade

ApiContactInformation

herdado deApiEntityBaseContract.contact

description

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

description?: string

Valor de Propriedade

string

herdado deApiEntityBaseContract.description

isCurrent

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

isCurrent?: boolean

Valor de Propriedade

boolean

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

license

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

license?: ApiLicenseInformation

Valor de Propriedade

ApiLicenseInformation

herdado deApiEntityBaseContract.license

subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor de Propriedade

SubscriptionKeyParameterNamesContract

herdado deApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Valor de Propriedade

boolean

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