Udostępnij za pośrednictwem


SchemaContract interface

Szczegóły kontraktu schematu interfejsu API.

Rozszerzenie

Właściwości

components

Definicje typów. Używane tylko w przypadku schematów swagger/OpenAPI v2/v3 o wartości null.

contentType

Musi być prawidłowym typem nośnika używanym w nagłówku Content-Type zdefiniowanym w dokumencie RFC 2616. Typ nośnika dokumentu schematu (np. application/json, application/xml).
- SwaggerUżyj schematu użyj polecenia application/vnd.ms-azure-apim.xsd+xml
OpenApi - Użyj schematu.
WADL Schemaapplication/vnd.oai.openapi.components+json - application/vnd.ms-azure-apim.wadl.grammars+xmlapplication/vnd.ms-azure-apim.swagger.definitions+json
- WSDL

definitions

Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI w wersji 1, w przeciwnym razie ma wartość null.

value

Ciąg ucieczki Json definiujący dokument reprezentujący schemat. Służy do obsługi schematów innych niż Swagger/OpenAPI.

Właściwości dziedziczone

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

name

Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

Szczegóły właściwości

components

Definicje typów. Używane tylko w przypadku schematów swagger/OpenAPI v2/v3 o wartości null.

components?: Record<string, unknown>

Wartość właściwości

Record<string, unknown>

contentType

Musi być prawidłowym typem nośnika używanym w nagłówku Content-Type zdefiniowanym w dokumencie RFC 2616. Typ nośnika dokumentu schematu (np. application/json, application/xml).
- SwaggerUżyj schematu użyj polecenia application/vnd.ms-azure-apim.xsd+xml
OpenApi - Użyj schematu.
WADL Schemaapplication/vnd.oai.openapi.components+json - application/vnd.ms-azure-apim.wadl.grammars+xmlapplication/vnd.ms-azure-apim.swagger.definitions+json
- WSDL

contentType?: string

Wartość właściwości

string

definitions

Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI w wersji 1, w przeciwnym razie ma wartość null.

definitions?: Record<string, unknown>

Wartość właściwości

Record<string, unknown>

value

Ciąg ucieczki Json definiujący dokument reprezentujący schemat. Służy do obsługi schematów innych niż Swagger/OpenAPI.

value?: string

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

id

W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

id?: string

Wartość właściwości

string

Dziedziczone zProxyResource.id

name

Nazwa zasobu UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

name?: string

Wartość właściwości

string

Dziedziczone zProxyResource.name

type

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.

type?: string

Wartość właściwości

string

Dziedziczone zproxyResource.type