Condividi tramite

ApiContract interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Dettagli dell'API.

Extends
ProxyResource

Proprietà

apiRevision

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1
apiRevisionDescription

Descrizione della revisione DELL'API.
apiType

Tipo di API.
apiVersion

Indica l'identificatore della versione dell'API se l'API è in versione
apiVersionDescription

Descrizione della versione dell'API.
apiVersionSet

Dettagli del set di versioni
apiVersionSetId

Identificatore di risorsa per ApiVersionSet correlato.
authenticationSettings

Raccolta di impostazioni di autenticazione incluse in questa API.
contact

Informazioni di contatto per l'API.
description

Descrizione dell'API. Può includere tag di formattazione HTML.
displayName

Nome API. Deve essere lungo da 1 a 300 caratteri.
isCurrent

Indica se la revisione dell'API è la revisione dell'API corrente.
isOnline

Indica se la revisione API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
license

Informazioni sulla licenza per l'API.
path

URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.
protocols

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.
serviceUrl

URL assoluto del servizio back-end che implementa questa API. Impossibile contenere più di 2000 caratteri.
sourceApiId

Identificatore API dell'API di origine.
subscriptionKeyParameterNames

Protocolli su cui è disponibile l'API.
subscriptionRequired

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.
termsOfServiceUrl

URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.

Proprietà ereditate

id

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
name

Nome della risorsa NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.
type

Tipo di risorsa. Nota su "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts": questa proprietà non verrà serializzata. Può essere popolato solo dal server.

Dettagli proprietà

apiRevision

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1

apiRevision?: string

Valore della proprietà

string

apiRevisionDescription

Descrizione della revisione DELL'API.

apiRevisionDescription?: string

Valore della proprietà

string

apiType

Tipo di API.

apiType?: string

Valore della proprietà

string

apiVersion

Indica l'identificatore della versione dell'API se l'API è in versione

apiVersion?: string

Valore della proprietà

string

apiVersionDescription

Descrizione della versione dell'API.

apiVersionDescription?: string

Valore della proprietà

string

apiVersionSet

Dettagli del set di versioni

apiVersionSet?: ApiVersionSetContractDetails

Valore della proprietà

ApiVersionSetContractDetails

apiVersionSetId

Identificatore di risorsa per ApiVersionSet correlato.

apiVersionSetId?: string

Valore della proprietà

string

authenticationSettings

Raccolta di impostazioni di autenticazione incluse in questa API.

authenticationSettings?: AuthenticationSettingsContract

Valore della proprietà

AuthenticationSettingsContract

contact

Informazioni di contatto per l'API.

contact?: ApiContactInformation

Valore della proprietà

ApiContactInformation

description

Descrizione dell'API. Può includere tag di formattazione HTML.

description?: string

Valore della proprietà

string

displayName

Nome API. Deve essere lungo da 1 a 300 caratteri.

displayName?: string

Valore della proprietà

string

isCurrent

Indica se la revisione dell'API è la revisione dell'API corrente.

isCurrent?: boolean

Valore della proprietà

boolean

isOnline

Indica se la revisione API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

isOnline?: boolean

Valore della proprietà

boolean

license

Informazioni sulla licenza per l'API.

license?: ApiLicenseInformation

Valore della proprietà

ApiLicenseInformation

path

URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.

path?: string

Valore della proprietà

string

protocols

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.

protocols?: string[]

Valore della proprietà

string[]

serviceUrl

URL assoluto del servizio back-end che implementa questa API. Impossibile contenere più di 2000 caratteri.

serviceUrl?: string

Valore della proprietà

string

sourceApiId

Identificatore API dell'API di origine.

sourceApiId?: string

Valore della proprietà

string

subscriptionKeyParameterNames

Protocolli su cui è disponibile l'API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valore della proprietà

SubscriptionKeyParameterNamesContract

subscriptionRequired

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.

subscriptionRequired?: boolean

Valore della proprietà

boolean

termsOfServiceUrl

URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.

termsOfServiceUrl?: string

Valore della proprietà

string

Dettagli proprietà ereditate

id

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

id?: string

Valore della proprietà

string

Ereditato daProxyResource.id

name

Nome della risorsa NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

name?: string

Valore della proprietà

string

Ereditato daProxyResource.name

type

Tipo di risorsa. Nota su "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts": questa proprietà non verrà serializzata. Può essere popolato solo dal server.

type?: string

Valore della proprietà

string

Ereditato daProxyResource.type