Delen via


SchemaContract interface

Details van het API-schemacontract.

Uitbreiding

Eigenschappen

components

Typen definities. Alleen gebruikt voor Swagger/OpenAPI v2/v3-schema's, anders null.

contentType

Moet een geldig mediatype zijn dat wordt gebruikt in een content-type header zoals gedefinieerd in rfc 2616. Mediatype van het schemadocument (bijvoorbeeld application/json, application/xml).
- SwaggerSchemagebruik application/vnd.ms-azure-apim.swagger.definitions+json
WSDL - Schema gebruiken application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema gebruiken gebruik .application/vnd.oai.openapi.components+json
- WADL Schemaapplication/vnd.ms-azure-apim.wadl.grammars+xml

definitions

Typen definities. Wordt alleen gebruikt voor Swagger/OpenAPI v1-schema's, anders null.

value

Json escape-tekenreeks die het document definieert dat het schema vertegenwoordigt. Wordt gebruikt voor andere schema's dan Swagger/OpenAPI.

Overgenomen eigenschappen

id

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

name

De naam van de resource OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

type

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

Eigenschapdetails

components

Typen definities. Alleen gebruikt voor Swagger/OpenAPI v2/v3-schema's, anders null.

components?: Record<string, unknown>

Waarde van eigenschap

Record<string, unknown>

contentType

Moet een geldig mediatype zijn dat wordt gebruikt in een content-type header zoals gedefinieerd in rfc 2616. Mediatype van het schemadocument (bijvoorbeeld application/json, application/xml).
- SwaggerSchemagebruik application/vnd.ms-azure-apim.swagger.definitions+json
WSDL - Schema gebruiken application/vnd.ms-azure-apim.xsd+xml
- OpenApi Schema gebruiken gebruik .application/vnd.oai.openapi.components+json
- WADL Schemaapplication/vnd.ms-azure-apim.wadl.grammars+xml

contentType?: string

Waarde van eigenschap

string

definitions

Typen definities. Wordt alleen gebruikt voor Swagger/OpenAPI v1-schema's, anders null.

definitions?: Record<string, unknown>

Waarde van eigenschap

Record<string, unknown>

value

Json escape-tekenreeks die het document definieert dat het schema vertegenwoordigt. Wordt gebruikt voor andere schema's dan Swagger/OpenAPI.

value?: string

Waarde van eigenschap

string

Details van overgenomen eigenschap

id

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

id?: string

Waarde van eigenschap

string

Overgenomen vanProxyResource.id

name

De naam van de resource OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

name?: string

Waarde van eigenschap

string

Overgenomen vanProxyResource.name

type

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' OPMERKING: deze eigenschap wordt niet geserialiseerd. Deze kan alleen worden ingevuld door de server.

type?: string

Waarde van eigenschap

string

Overgenomen vanProxyResource.type