Partilhar 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 estiver versionada
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 nesta API.
contact

Informações de contato para a API.
description

Descrição da API. Pode incluir tags 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 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.
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. Não pode ter mais de 2000 caracteres.
sourceApiId

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

Propriedades Herdadas

id

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
name

O nome do recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.
type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

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

apiVersionSet

Detalhes do conjunto de versões

apiVersionSet?: ApiVersionSetContractDetails

Valor de Propriedade

ApiVersionSetContractDetails

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

displayName

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

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

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. Não pode ter mais de 2000 caracteres.

serviceUrl?: string

Valor de Propriedade

string

sourceApiId

Identificador de API da API de origem.

sourceApiId?: string

Valor de Propriedade

string

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

Detalhes da Propriedade Herdada

id

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor de Propriedade

string

herdado deProxyResource.id

name

O nome do recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor de Propriedade

string

herdada deProxyResource.name

type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor de Propriedade

string

herdado de ProxyResource.type