Compartilhar via

ApiContract interface

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

Detalhes da API.

Extends
ProxyResource

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 tiver controle de versão
apiVersionDescription

Descrição da versão da API.
apiVersionSet

Detalhes do conjunto de versões
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

A descrição da API. Pode incluir marcas de formatação HTML.
displayName

Nome da API. Deve ter de 1 a 300 caracteres.
isCurrent

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

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

A URL relativa que identifica exclusivamente esta 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 nessa API podem ser invocadas.
serviceUrl

A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2.000 caracteres.
sourceApiId

Identificador de API da API de origem.
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.

Propriedades herdadas

id

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name

O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes da propriedade

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

apiRevisionDescription

Descrição da Revisão da API.

apiRevisionDescription?: string

Valor da propriedade

string

apiType

Tipo de API.

apiType?: string

Valor da propriedade

string

apiVersion

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

apiVersion?: string

Valor da propriedade

string

apiVersionDescription

Descrição da versão da API.

apiVersionDescription?: string

Valor da propriedade

string

apiVersionSet

Detalhes do conjunto de versões

apiVersionSet?: ApiVersionSetContractDetails

Valor da propriedade

ApiVersionSetContractDetails

apiVersionSetId

Um identificador de recurso para o ApiVersionSet relacionado.

apiVersionSetId?: string

Valor da propriedade

string

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Valor da propriedade

AuthenticationSettingsContract

contact

Informações de contato para a API.

contact?: ApiContactInformation

Valor da propriedade

ApiContactInformation

description

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

description?: string

Valor da propriedade

string

displayName

Nome da API. Deve ter de 1 a 300 caracteres.

displayName?: string

Valor da propriedade

string

isCurrent

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

isCurrent?: boolean

Valor da propriedade

boolean

isOnline

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

license

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

license?: ApiLicenseInformation

Valor da propriedade

ApiLicenseInformation

path

A URL relativa que identifica exclusivamente esta 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 nessa API podem ser invocadas.

protocols?: string[]

Valor da propriedade

string[]

serviceUrl

A URL absoluta do serviço de back-end implementado esta API. Não pode ter mais de 2.000 caracteres.

serviceUrl?: string

Valor da propriedade

string

sourceApiId

Identificador de API da API de origem.

sourceApiId?: string

Valor da propriedade

string

subscriptionKeyParameterNames

Protocolos sobre os quais a API é disponibilizada.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valor da propriedade

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

subscriptionRequired?: boolean

Valor da propriedade

boolean

termsOfServiceUrl

Uma URL para os Termos de Serviço da API. DEVE estar no formato de uma URL.

termsOfServiceUrl?: string

Valor da propriedade

string

Detalhes das propriedades herdadas

id

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor da propriedade

string

Herdado deProxyResource.id

name

O nome do recurso OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor da propriedade

string

Herdado deProxyResource.name

type

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" OBSERVAÇÃO: essa propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor da propriedade

string

Herdado deProxyResource.type