Condividi tramite

ApiUpdateContract interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Dettagli del contratto di aggiornamento API.

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 è con versione
apiVersionDescription

Descrizione della versione dell'API.
apiVersionSetId

Identificatore di risorsa per l'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.
isCurrent

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

Indica se la revisione dell'API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolata 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.
subscriptionKeyParameterNames

Protocolli su cui viene resa disponibile l'API.
subscriptionRequired

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

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

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 è con versione

apiVersion?: string

Valore della proprietà

string

apiVersionDescription

Descrizione della versione dell'API.

apiVersionDescription?: string

Valore della proprietà

string

apiVersionSetId

Identificatore di risorsa per l'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.

displayName?: string

Valore della proprietà

string

isCurrent

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

isCurrent?: boolean

Valore della proprietà

boolean

isOnline

Indica se la revisione dell'API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolata 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.

serviceUrl?: string

Valore della proprietà

string

subscriptionKeyParameterNames

Protocolli su cui viene resa 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 per il servizio per l'API. DEVE essere nel formato di un URL.

termsOfServiceUrl?: string

Valore della proprietà

string