Partager via


SchemaContract interface

Détails du contrat de schéma d’API.

Extends

Propriétés

components

Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v2/v3 uniquement; sinon, null.

contentType

Doit être un type de média valide utilisé dans un en-tête Content-Type tel que défini dans la RFC 2616. Type de média du document de schéma (par exemple application/json, application/xml).
- SwaggerUtilisation du schéma Utilisation du schéma - application/vnd.ms-azure-apim.xsd+xmlOpenApi
Utilisation du schéma -
WADL Schemaapplication/vnd.oai.openapi.components+jsonutiliser .application/vnd.ms-azure-apim.wadl.grammars+xmlapplication/vnd.ms-azure-apim.swagger.definitions+json
- WSDL

definitions

Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v1 uniquement; sinon, null.

value

Chaîne d’échappement Json définissant le document représentant le schéma. Utilisé pour les schémas autres que Swagger/OpenAPI.

Propriétés héritées

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

Détails de la propriété

components

Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v2/v3 uniquement; sinon, null.

components?: Record<string, unknown>

Valeur de propriété

Record<string, unknown>

contentType

Doit être un type de média valide utilisé dans un en-tête Content-Type tel que défini dans la RFC 2616. Type de média du document de schéma (par exemple application/json, application/xml).
- SwaggerUtilisation du schéma Utilisation du schéma - application/vnd.ms-azure-apim.xsd+xmlOpenApi
Utilisation du schéma -
WADL Schemaapplication/vnd.oai.openapi.components+jsonutiliser .application/vnd.ms-azure-apim.wadl.grammars+xmlapplication/vnd.ms-azure-apim.swagger.definitions+json
- WSDL

contentType?: string

Valeur de propriété

string

definitions

Définitions de types. Utilisé pour les schémas Swagger/OpenAPI v1 uniquement; sinon, null.

definitions?: Record<string, unknown>

Valeur de propriété

Record<string, unknown>

value

Chaîne d’échappement Json définissant le document représentant le schéma. Utilisé pour les schémas autres que Swagger/OpenAPI.

value?: string

Valeur de propriété

string

Détails de la propriété héritée

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

id?: string

Valeur de propriété

string

Hérité deProxyResource.id

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

name?: string

Valeur de propriété

string

Hérité deProxyResource.name

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.

type?: string

Valeur de propriété

string

Hérité deProxyResource.type