Megosztás a következőn keresztül:

ApiContract interface

  • Referencia
Csomag:
@azure/arm-apimanagement

API-részletek.

Extends
ProxyResource

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

Verziókészlet részletei
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.
displayName

API-név. 1–300 karakter hosszúságúnak kell lennie.
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.
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. Legfeljebb 2000 karakter hosszú lehet.
sourceApiId

A forrás API API-azonosítója.
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.

Örökölt tulajdonságok

id

Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.
name

Az erőforrás neve MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.
type

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

Tulajdonság adatai

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

apiRevisionDescription

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

apiRevisionDescription?: string

Tulajdonság értéke

string

apiType

Az API típusa.

apiType?: string

Tulajdonság értéke

string

apiVersion

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

apiVersion?: string

Tulajdonság értéke

string

apiVersionDescription

Az API-verzió leírása.

apiVersionDescription?: string

Tulajdonság értéke

string

apiVersionSet

Verziókészlet részletei

apiVersionSet?: ApiVersionSetContractDetails

Tulajdonság értéke

ApiVersionSetContractDetails

apiVersionSetId

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

apiVersionSetId?: string

Tulajdonság értéke

string

authenticationSettings

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

authenticationSettings?: AuthenticationSettingsContract

Tulajdonság értéke

AuthenticationSettingsContract

contact

Az API kapcsolattartási adatai.

contact?: ApiContactInformation

Tulajdonság értéke

ApiContactInformation

description

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

description?: string

Tulajdonság értéke

string

displayName

API-név. 1–300 karakter hosszúságúnak kell lennie.

displayName?: string

Tulajdonság értéke

string

isCurrent

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

isCurrent?: boolean

Tulajdonság értéke

boolean

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

license

Az API licencadatai.

license?: ApiLicenseInformation

Tulajdonság értéke

ApiLicenseInformation

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. Legfeljebb 2000 karakter hosszú lehet.

serviceUrl?: string

Tulajdonság értéke

string

sourceApiId

A forrás API API-azonosítója.

sourceApiId?: string

Tulajdonság értéke

string

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Tulajdonság értéke

SubscriptionKeyParameterNamesContract

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

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ölt tulajdonság részletei

id

Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

id?: string

Tulajdonság értéke

string

örököltProxyResource.id

name

Az erőforrás neve MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

name?: string

Tulajdonság értéke

string

örököltProxyResource.name

type

Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" MEGJEGYZÉS: Ez a tulajdonság nem lesz szerializálva. Csak a kiszolgáló tudja feltölteni.

type?: string

Tulajdonság értéke

string

örököltProxyResource.type