ApiTagResourceContractProperties interface

Csomag:

@azure/arm-apimanagement

API-szerződés tulajdonságai a címkeerőforrásokhoz.

Extends

ApiEntityBaseContract

Tulajdonságok

id	API-azonosító az /apis/{apiId} formában.
name	API-név.
path	Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát az API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végpontbázis URL-címéhez, hogy nyilvános URL-címet képezze ehhez az API-hoz.
protocols	Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.
serviceUrl	Az API-t implementáló háttérszolgáltatás abszolút URL-címe.

Örökölt tulajdonságok

apiRevision	Az API felülvizsgálatát ismerteti. Ha nincs megadva érték, a rendszer létrehozza az 1. alapértelmezett változatot
apiRevisionDescription	Az API-változat leírása.
apiType	Az API típusa.
apiVersion	Az API verzióazonosítóját jelzi, ha az API verziószámozott
apiVersionDescription	Az API-verzió leírása.
apiVersionSetId	A kapcsolódó ApiVersionSet erőforrás-azonosítója.
authenticationSettings	Az API-ba foglalt hitelesítési beállítások gyűjteménye.
contact	Az API kapcsolattartási adatai.
description	Az API leírása. HTML-formázási címkéket is tartalmazhat.
isCurrent	Azt jelzi, hogy az API-változat aktuális API-változat-e.
isOnline	Azt jelzi, hogy az API-változat elérhető-e az átjárón keresztül. MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.
license	Az API licencadatai.
subscriptionKeyParameterNames	Protokollok, amelyeken keresztül az API elérhetővé válik.
subscriptionRequired	Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez.
termsOfServiceUrl	Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie.

Tulajdonság adatai

id

API-azonosító az /apis/{apiId} formában.

id?: string

Tulajdonság értéke

string

name

API-név.

name?: string

Tulajdonság értéke

string

path

Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát az API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végpontbázis URL-címéhez, hogy nyilvános URL-címet képezze ehhez az API-hoz.

path?: string

Tulajdonság értéke

string

protocols

Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

protocols?: string[]

Tulajdonság értéke

string[]

serviceUrl

Az API-t implementáló háttérszolgáltatás abszolút URL-címe.

serviceUrl?: string

Tulajdonság értéke

string

Örökölt tulajdonság részletei

apiRevision

Az API felülvizsgálatát ismerteti. Ha nincs megadva érték, a rendszer létrehozza az 1. alapértelmezett változatot

apiRevision?: string

Tulajdonság értéke

string

örököltApiEntityBaseContract.apiRevision

apiRevisionDescription

Az API-változat leírása.

apiRevisionDescription?: string

Tulajdonság értéke

string

örököltApiEntityBaseContract.apiRevisionDescription

apiType

Az API típusa.

apiType?: string

Tulajdonság értéke

string

örököltApiEntityBaseContract.apiType

apiVersion

Az API verzióazonosítóját jelzi, ha az API verziószámozott

apiVersion?: string

Tulajdonság értéke

string

örököltApiEntityBaseContract.apiVersion

apiVersionDescription

Az API-verzió leírása.

apiVersionDescription?: string

Tulajdonság értéke

string

örököltApiEntityBaseContract.apiVersionDescription

apiVersionSetId

A kapcsolódó ApiVersionSet erőforrás-azonosítója.

apiVersionSetId?: string

Tulajdonság értéke

string

örököltApiEntityBaseContract.apiVersionSetId

authenticationSettings

Az API-ba foglalt hitelesítési beállítások gyűjteménye.

authenticationSettings?: AuthenticationSettingsContract

Tulajdonság értéke

AuthenticationSettingsContract

örököltApiEntityBaseContract.authenticationSettings

contact

Az API kapcsolattartási adatai.

contact?: ApiContactInformation

Tulajdonság értéke

ApiContactInformation

örököltApiEntityBaseContract.contact

description

Az API leírása. HTML-formázási címkéket is tartalmazhat.

description?: string

Tulajdonság értéke

string

örököltApiEntityBaseContract.description

isCurrent

Azt jelzi, hogy az API-változat aktuális API-változat-e.

isCurrent?: boolean

Tulajdonság értéke

boolean

örököltApiEntityBaseContract.isCurrent

isOnline

Azt jelzi, hogy az API-változat elérhető-e az átjárón keresztül. MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

isOnline?: boolean

Tulajdonság értéke

boolean

örököltApiEntityBaseContract.isOnline

license

Az API licencadatai.

license?: ApiLicenseInformation

Tulajdonság értéke

ApiLicenseInformation

örököltApiEntityBaseContract.license

subscriptionKeyParameterNames

Protokollok, amelyeken keresztül az API elérhetővé válik.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Tulajdonság értéke

SubscriptionKeyParameterNamesContract

örököltApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez.

subscriptionRequired?: boolean

Tulajdonság értéke

boolean

örököltApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie.

termsOfServiceUrl?: string

Tulajdonság értéke

string

örököltApiEntityBaseContract.termsOfServiceUrl