ApiUpdateContract interface

Paket:

@azure/arm-apimanagement

Details zum API-Update-Vertrag.

Eigenschaften

apiRevision	Beschreibt die Revision der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.
apiRevisionDescription	Beschreibung der API-Revision.
apiType	API-Typ.
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 enthalten.
displayName	API-Name.
isCurrent	Gibt an, ob die API-Revision die aktuelle API-Revision ist.
isOnline	Gibt an, ob über das Gateway auf die API-Revision zugegriffen werden kann. HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
license	Lizenzinformationen für die API.
path	Relative URL identifiziert diese API und alle zugehörigen Ressourcenpfade innerhalb der API-Verwaltungsdienstinstanz eindeutig. Sie wird an die API-Endpunktbasis-URL angefügt, die während der Erstellung der Dienstinstanz angegeben wurde, um eine öffentliche URL für diese API zu bilden.
protocols	Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können.
serviceUrl	Absolute URL des Back-End-Diensts, der diese API implementiert.
subscriptionKeyParameterNames	Protokolle, über die API verfügbar gemacht wird.
subscriptionRequired	Gibt an, ob für den Zugriff auf die API ein API- oder Produktabonnement erforderlich ist.
termsOfServiceUrl	Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.

Details zur Eigenschaft

apiRevision

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

apiRevision?: string

Eigenschaftswert

string

apiRevisionDescription

Beschreibung der API-Revision.

apiRevisionDescription?: string

Eigenschaftswert

string

apiType

API-Typ.

apiType?: string

Eigenschaftswert

string

apiVersion

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

apiVersion?: string

Eigenschaftswert

string

apiVersionDescription

Beschreibung der API-Version.

apiVersionDescription?: string

Eigenschaftswert

string

apiVersionSetId

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

apiVersionSetId?: string

Eigenschaftswert

string

authenticationSettings

Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.

authenticationSettings?: AuthenticationSettingsContract

Eigenschaftswert

AuthenticationSettingsContract

contact

Kontaktinformationen für die API.

contact?: ApiContactInformation

Eigenschaftswert

ApiContactInformation

description

Beschreibung der API. Kann HTML-Formatierungstags enthalten.

description?: string

Eigenschaftswert

string

displayName

API-Name.

displayName?: string

Eigenschaftswert

string

isCurrent

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

isCurrent?: boolean

Eigenschaftswert

boolean

isOnline

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

isOnline?: boolean

Eigenschaftswert

boolean

license

Lizenzinformationen für die API.

license?: ApiLicenseInformation

Eigenschaftswert

ApiLicenseInformation

path

Relative URL identifiziert diese API und alle zugehörigen Ressourcenpfade innerhalb der API-Verwaltungsdienstinstanz eindeutig. Sie wird an die API-Endpunktbasis-URL angefügt, die während der Erstellung der Dienstinstanz angegeben wurde, um eine öffentliche URL für diese API zu bilden.

path?: string

Eigenschaftswert

string

protocols

Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können.

protocols?: string[]

Eigenschaftswert

string[]

serviceUrl

Absolute URL des Back-End-Diensts, der diese API implementiert.

serviceUrl?: string

Eigenschaftswert

string

subscriptionKeyParameterNames

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

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Eigenschaftswert

SubscriptionKeyParameterNamesContract

subscriptionRequired

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

subscriptionRequired?: boolean

Eigenschaftswert

boolean

termsOfServiceUrl

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

termsOfServiceUrl?: string

Eigenschaftswert

string