Freigeben über

ApiContract interface

  • Referenz
Paket:
@azure/arm-apimanagement

API-Details.

Extends
ProxyResource

Eigenschaften

apiRevision

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

Beschreibung der API-Revision.
apiType

Art der API.
apiVersion

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

Beschreibung der API-Version.
apiVersionSet

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

API-Name. Muss 1 bis 300 Zeichen lang sein.
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.
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.
subscriptionKeyParameterNames

Protokolle, für 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.

Geerbte Eigenschaften

id

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
name

Der Name der Ressource HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.
type

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

Details zur Eigenschaft

apiRevision

Beschreibt die Überarbeitung 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

Art der API.

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

apiVersionSet

Versionssatzdetails

apiVersionSet?: ApiVersionSetContractDetails

Eigenschaftswert

ApiVersionSetContractDetails

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

description?: string

Eigenschaftswert

string

displayName

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

displayName?: string

Eigenschaftswert

string

isCurrent

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

isCurrent?: boolean

Eigenschaftswert

boolean

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

license

Lizenzinformationen für die API.

license?: ApiLicenseInformation

Eigenschaftswert

ApiLicenseInformation

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

subscriptionKeyParameterNames

Protokolle, für die die API verfügbar gemacht wird.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Eigenschaftswert

SubscriptionKeyParameterNamesContract

subscriptionRequired

Gibt an, ob ein API- oder Produktabonnement für den Zugriff auf die API 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

Geerbte Eigenschaftsdetails

id

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

id?: string

Eigenschaftswert

string

Geerbt vonProxyResource.id

name

Der Name der Ressource HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

name?: string

Eigenschaftswert

string

Geerbt vonProxyResource.name

type

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts" HINWEIS: Diese Eigenschaft wird nicht serialisiert. Sie kann nur vom Server aufgefüllt werden.

type?: string

Eigenschaftswert

string

Geerbt vonProxyResource.type