Condividi tramite

ApiTagResourceContractProperties interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Proprietà del contratto API per le risorse tag.

Extends
ApiEntityBaseContract

Proprietà

id

Identificatore API nel modulo /apis/{apiId}.
name

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

Proprietà ereditate

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

Dettagli proprietà

id

Identificatore API nel modulo /apis/{apiId}.

id?: string

Valore della proprietà

string

name

Nome API.

name?: string

Valore della proprietà

string

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

Dettagli proprietà ereditate

apiRevision

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

apiRevision?: string

Valore della proprietà

string

Ereditato daApiEntityBaseContract.apiRevision

apiRevisionDescription

Descrizione della revisione DELL'API.

apiRevisionDescription?: string

Valore della proprietà

string

Ereditato daApiEntityBaseContract.apiRevisionDescription

apiType

Tipo di API.

apiType?: string

Valore della proprietà

string

Ereditato daApiEntityBaseContract.apiType

apiVersion

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

apiVersion?: string

Valore della proprietà

string

Ereditato daApiEntityBaseContract.apiVersion

apiVersionDescription

Descrizione della versione dell'API.

apiVersionDescription?: string

Valore della proprietà

string

Ereditato daApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Identificatore di risorsa per ApiVersionSet correlato.

apiVersionSetId?: string

Valore della proprietà

string

Ereditato daApiEntityBaseContract.apiVersionSetId

authenticationSettings

Raccolta di impostazioni di autenticazione incluse in questa API.

authenticationSettings?: AuthenticationSettingsContract

Valore della proprietà

AuthenticationSettingsContract

Ereditato daApiEntityBaseContract.authenticationSettings

contact

Informazioni di contatto per l'API.

contact?: ApiContactInformation

Valore della proprietà

ApiContactInformation

Ereditato daApiEntityBaseContract.contact

description

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

description?: string

Valore della proprietà

string

Ereditato daApiEntityBaseContract.description

isCurrent

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

isCurrent?: boolean

Valore della proprietà

boolean

Ereditato daApiEntityBaseContract.isCurrent

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

Ereditato daApiEntityBaseContract.isOnline

license

Informazioni sulla licenza per l'API.

license?: ApiLicenseInformation

Valore della proprietà

ApiLicenseInformation

Ereditato daApiEntityBaseContract.license

subscriptionKeyParameterNames

Protocolli su cui è disponibile l'API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valore della proprietà

SubscriptionKeyParameterNamesContract

Ereditato daApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

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

subscriptionRequired?: boolean

Valore della proprietà

boolean

Ereditato daApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

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

termsOfServiceUrl?: string

Valore della proprietà

string

Ereditato daApiEntityBaseContract.termsOfServiceUrl