SchemaContract interface
Szczegóły kontraktu schematu interfejsu API.
- Rozszerzenie
Właściwości
| components | Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI v2/v3 o wartości null. |
| content |
Musi być prawidłowym typem nośnika używanym w nagłówku Content-Type zgodnie z definicją w dokumencie RFC 2616. Typ nośnika dokumentu schematu (np. application/json, application/xml).
|
| definitions | Definicje typów. Używany tylko w przypadku schematów struktury Swagger/OpenAPI w wersji 1, wartość null. |
| provisioning |
Stan aprowizacji UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer. |
| value | Ciąg ucieczki Json definiujący dokument reprezentujący schemat. Używany do schematów innych niż Swagger/OpenAPI. |
Właściwości dziedziczone
| id | W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /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żywany tylko w przypadku schematów struktury 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 zgodnie z definicją w dokumencie RFC 2616. Typ nośnika dokumentu schematu (np. application/json, application/xml).
-
Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Schema use application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema use use application/vnd.oai.openapi.components+json
- WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema use application/vnd.ms-azure-apim.odata.schema
- gRPC Schema use text/protobuf.
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, wartość null.
definitions?: Record<string, unknown>
Wartość właściwości
Record<string, unknown>
provisioningState
Stan aprowizacji UWAGA: Ta właściwość nie zostanie serializowana. Można go wypełnić tylko przez serwer.
provisioningState?: string
Wartość właściwości
string
value
Ciąg ucieczki Json definiujący dokument reprezentujący schemat. Używany do 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. Ex - /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