SchemaContract interface
Information om API-schemakontrakt.
- Extends
Egenskaper
components | Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null. |
content |
Måste vara en giltig medietyp som används i en Content-Type-rubrik enligt definitionen i RFC 2616. Medietyp för schemadokumentet (t.ex. application/json, application/xml).
|
definitions | Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null. |
value | Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI. |
Ärvda egenskaper
id | Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern. |
name | Namnet på resursen Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern. |
type | Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" OBS! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern. |
Egenskapsinformation
components
Typer av definitioner. Används endast för Swagger/OpenAPI v2/v3-scheman, annars null.
components?: Record<string, unknown>
Egenskapsvärde
Record<string, unknown>
contentType
Måste vara en giltig medietyp som används i en Content-Type-rubrik enligt definitionen i RFC 2616. Medietyp för schemadokumentet (t.ex. 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 .application/vnd.ms-azure-apim.wadl.grammars+xml
application/vnd.oai.openapi.components+json
- WADL Schema
contentType?: string
Egenskapsvärde
string
definitions
Typer av definitioner. Används endast för Swagger/OpenAPI v1-scheman, annars null.
definitions?: Record<string, unknown>
Egenskapsvärde
Record<string, unknown>
value
Json-undantagen sträng som definierar dokumentet som representerar schemat. Används för andra scheman än Swagger/OpenAPI.
value?: string
Egenskapsvärde
string
Information om ärvda egenskaper
id
Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} Obs! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
id?: string
Egenskapsvärde
string
Ärvd frånProxyResource.id
name
Namnet på resursen Obs! Den här egenskapen serialiseras inte. Den kan bara fyllas i av servern.
name?: string
Egenskapsvärde
string
Ärvd frånProxyResource.name
type
Resurstypen. T.ex. "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts" OBS! Den här egenskapen kommer inte att serialiseras. Den kan bara fyllas i av servern.
type?: string
Egenskapsvärde
string
Ärvd frånProxyResource.type