Freigeben über


SchemaContract interface

Details des API-Schemavertrags.

Extends

Eigenschaften

components

Typendefinitionen. Wird nur für Swagger/OpenAPI v2/v3-Schemas verwendet, andernfalls NULL.

contentType

Muss ein gültiger Medientyp sein, der in einem Content-Type-Header verwendet wird, wie im RFC 2616 definiert. Medientyp des Schemadokuments (z. B. application/json, application/xml).
- SwaggerSchema verwenden application/vnd.ms-azure-apim.swagger.definitions+jsonWSDL
- Schema verwenden Schema verwenden application/vnd.ms-azure-apim.xsd+xml
OpenApi - Schema verwenden use
- application/vnd.oai.openapi.components+jsonWADL Schema use .application/vnd.ms-azure-apim.wadl.grammars+xml

definitions

Typendefinitionen. Wird nur für Swagger/OpenAPI v1-Schemas verwendet, andernfalls null.

value

Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt. Wird für andere Schemas als Swagger/OpenAPI verwendet.

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

components

Typendefinitionen. Wird nur für Swagger/OpenAPI v2/v3-Schemas verwendet, andernfalls NULL.

components?: Record<string, unknown>

Eigenschaftswert

Record<string, unknown>

contentType

Muss ein gültiger Medientyp sein, der in einem Content-Type-Header verwendet wird, wie im RFC 2616 definiert. Medientyp des Schemadokuments (z. B. application/json, application/xml).
- SwaggerSchema verwenden application/vnd.ms-azure-apim.swagger.definitions+jsonWSDL
- Schema verwenden Schema verwenden application/vnd.ms-azure-apim.xsd+xml
OpenApi - Schema verwenden use
- application/vnd.oai.openapi.components+jsonWADL Schema use .application/vnd.ms-azure-apim.wadl.grammars+xml

contentType?: string

Eigenschaftswert

string

definitions

Typendefinitionen. Wird nur für Swagger/OpenAPI v1-Schemas verwendet, andernfalls null.

definitions?: Record<string, unknown>

Eigenschaftswert

Record<string, unknown>

value

Json-Escapezeichenfolge, die das Dokument definiert, das das Schema darstellt. Wird für andere Schemas als Swagger/OpenAPI verwendet.

value?: 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