ApiContract interface
API-Details.
- Extends
Eigenschaften
| api |
Beschreibt die Revision der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt. |
| api |
Beschreibung der API-Revision. |
| api |
API-Typ. |
| api |
Gibt den Versionsbezeichner der API an, wenn die API versioniert ist. |
| api |
Beschreibung der API-Version. |
| api |
Versionssatzdetails |
| api |
Ein Ressourcenbezeichner für das zugehörige ApiVersionSet. |
| authentication |
Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind. |
| contact | Kontaktinformationen für die API. |
| description | Beschreibung der API. Kann HTML-Formatierungstags enthalten. |
| display |
API-Name. Muss 1 bis 300 Zeichen lang sein. |
| is |
Gibt an, ob die API-Revision die aktuelle API-Revision ist. |
| is |
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. |
| service |
Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang. |
| source |
API-ID der Quell-API. |
| subscription |
Protokolle, über die API verfügbar gemacht wird. |
| subscription |
Gibt an, ob für den Zugriff auf die API ein API- oder Produktabonnement erforderlich ist. |
| terms |
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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden. |
| name | Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden. |
| type | Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden. |
Details zur Eigenschaft
apiRevision
Beschreibt die Revision der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.
apiRevision?: stringEigenschaftswert
string
apiRevisionDescription
Beschreibung der API-Revision.
apiRevisionDescription?: stringEigenschaftswert
string
apiType
API-Typ.
apiType?: stringEigenschaftswert
string
apiVersion
Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.
apiVersion?: stringEigenschaftswert
string
apiVersionDescription
Beschreibung der API-Version.
apiVersionDescription?: stringEigenschaftswert
string
apiVersionSet
Versionssatzdetails
apiVersionSet?: ApiVersionSetContractDetailsEigenschaftswert
apiVersionSetId
Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.
apiVersionSetId?: stringEigenschaftswert
string
authenticationSettings
Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.
authenticationSettings?: AuthenticationSettingsContractEigenschaftswert
contact
Kontaktinformationen für die API.
contact?: ApiContactInformationEigenschaftswert
description
Beschreibung der API. Kann HTML-Formatierungstags enthalten.
description?: stringEigenschaftswert
string
displayName
API-Name. Muss 1 bis 300 Zeichen lang sein.
displayName?: stringEigenschaftswert
string
isCurrent
Gibt an, ob die API-Revision die aktuelle API-Revision ist.
isCurrent?: booleanEigenschaftswert
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?: booleanEigenschaftswert
boolean
license
Lizenzinformationen für die API.
license?: ApiLicenseInformationEigenschaftswert
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?: stringEigenschaftswert
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. Maximal 2000 Zeichen lang.
serviceUrl?: stringEigenschaftswert
string
sourceApiId
API-ID der Quell-API.
sourceApiId?: stringEigenschaftswert
string
subscriptionKeyParameterNames
Protokolle, über die API verfügbar gemacht wird.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContractEigenschaftswert
subscriptionRequired
Gibt an, ob für den Zugriff auf die API ein API- oder Produktabonnement erforderlich ist.
subscriptionRequired?: booleanEigenschaftswert
boolean
termsOfServiceUrl
Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL vorliegen.
termsOfServiceUrl?: stringEigenschaftswert
string
Geerbte Eigenschaftsdetails
id
Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} HINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
id?: stringEigenschaftswert
string
geerbt vonProxyResource.id
name
Der Name der RessourcenHINWEIS: Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
name?: stringEigenschaftswert
string
geerbt vonProxyResource.name
type
Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts": Diese Eigenschaft wird nicht serialisiert. Er kann nur vom Server aufgefüllt werden.
type?: stringEigenschaftswert
string