Freigeben über

ApiContractProperties interface

  • Referenz
Paket:
@azure/arm-apimanagement

API-Entitätseigenschaften

Extends
ApiEntityBaseContract

Eigenschaften

apiVersionSet

Versionssatzdetails
displayName

API-Name. Muss 1 bis 300 Zeichen lang sein.
path

Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.
protocols

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.
serviceUrl

Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2000 Zeichen lang sein.
sourceApiId

API-Bezeichner der Quell-API.

Geerbte Eigenschaften

apiRevision

Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.
apiRevisionDescription

Beschreibung der API-Revision.
apiType

Typ der API.
apiVersion

Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.
apiVersionDescription

Beschreibung der API-Version.
apiVersionSetId

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.
authenticationSettings

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.
contact

Kontaktinformationen für die API.
description

Beschreibung der API. Kann HTML-Formatierungstags umfassen.
isCurrent

Gibt an, ob die API-Revision die aktuelle API-Revision ist.
isOnline

Gibt an, ob auf die API-Revision über das Gateway zugegriffen werden kann. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
license

Lizenzinformationen für die API.
subscriptionKeyParameterNames

Protokolle, über die die API verfügbar gemacht wird.
subscriptionRequired

Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.
termsOfServiceUrl

Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

Details zur Eigenschaft

apiVersionSet

Versionssatzdetails

apiVersionSet?: ApiVersionSetContractDetails

Eigenschaftswert

ApiVersionSetContractDetails

displayName

API-Name. Muss 1 bis 300 Zeichen lang sein.

displayName?: string

Eigenschaftswert

string

path

Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.

path: string

Eigenschaftswert

string

protocols

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

protocols?: string[]

Eigenschaftswert

string[]

serviceUrl

Absolute URL des Back-End-Diensts, der diese API implementiert. Darf nicht mehr als 2000 Zeichen lang sein.

serviceUrl?: string

Eigenschaftswert

string

sourceApiId

API-Bezeichner der Quell-API.

sourceApiId?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

apiRevision

Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.

apiRevision?: string

Eigenschaftswert

string

Geerbt vonApiEntityBaseContract.apiRevision

apiRevisionDescription

Beschreibung der API-Revision.

apiRevisionDescription?: string

Eigenschaftswert

string

Geerbt vonApiEntityBaseContract.apiRevisionDescription

apiType

Typ der API.

apiType?: string

Eigenschaftswert

string

Geerbt vonApiEntityBaseContract.apiType

apiVersion

Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.

apiVersion?: string

Eigenschaftswert

string

Geerbt vonApiEntityBaseContract.apiVersion

apiVersionDescription

Beschreibung der API-Version.

apiVersionDescription?: string

Eigenschaftswert

string

Geerbt vonApiEntityBaseContract.apiVersionDescription

apiVersionSetId

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

apiVersionSetId?: string

Eigenschaftswert

string

Geerbt vonApiEntityBaseContract.apiVersionSetId

authenticationSettings

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.

authenticationSettings?: AuthenticationSettingsContract

Eigenschaftswert

AuthenticationSettingsContract

Geerbt vonApiEntityBaseContract.authenticationSettings

contact

Kontaktinformationen für die API.

contact?: ApiContactInformation

Eigenschaftswert

ApiContactInformation

Geerbt vonApiEntityBaseContract.contact

description

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

description?: string

Eigenschaftswert

string

Geerbt vonApiEntityBaseContract.description

isCurrent

Gibt an, ob die API-Revision die aktuelle API-Revision ist.

isCurrent?: boolean

Eigenschaftswert

boolean

Geerbt vonApiEntityBaseContract.isCurrent

isOnline

Gibt an, ob auf die API-Revision über das Gateway zugegriffen werden kann. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

isOnline?: boolean

Eigenschaftswert

boolean

Geerbt vonApiEntityBaseContract.isOnline

license

Lizenzinformationen für die API.

license?: ApiLicenseInformation

Eigenschaftswert

ApiLicenseInformation

Geerbt vonApiEntityBaseContract.license

subscriptionKeyParameterNames

Protokolle, über die die API verfügbar gemacht wird.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Eigenschaftswert

SubscriptionKeyParameterNamesContract

Geerbt vonApiEntityBaseContract.subscriptionKeyParameterNames

subscriptionRequired

Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API erforderlich ist.

subscriptionRequired?: boolean

Eigenschaftswert

boolean

Geerbt vonApiEntityBaseContract.subscriptionRequired

termsOfServiceUrl

Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

termsOfServiceUrl?: string

Eigenschaftswert

string

Geerbt vonApiEntityBaseContract.termsOfServiceUrl