SchemaContract interface
Detalles del contrato de esquema de API.
- Extends
Propiedades
| components | Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v2/v3; de lo contrario, es NULL. |
| content |
Debe ser un tipo de medio válido que se usa en un encabezado Content-Type tal como se define en RFC 2616. Tipo de medio del documento de esquema (por ejemplo, application/json, application/xml).
|
| definitions | Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v1; de lo contrario, es NULL. |
| provisioning |
El estado de aprovisionamiento NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo. |
| value | Cadena de escape json que define el documento que representa el esquema. Se usa para esquemas distintos de Swagger/OpenAPI. |
Propiedades heredadas
| id | Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo. |
| name | El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo. |
| type | Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo. |
Detalles de las propiedades
components
Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v2/v3; de lo contrario, es NULL.
components?: Record<string, unknown>
Valor de propiedad
Record<string, unknown>
contentType
Debe ser un tipo de medio válido que se usa en un encabezado Content-Type tal como se define en RFC 2616. Tipo de medio del documento de esquema (por ejemplo, application/json, application/xml).
-
SwaggerEsquema use application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Esquema use application/vnd.ms-azure-apim.xsd+xml
- OpenApiUso de esquema application/vnd.oai.openapi.components+json
- WADL Schemause application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schemause use .application/vnd.ms-azure-apim.odata.schema
- gRPC Schematext/protobuf
contentType?: string
Valor de propiedad
string
definitions
Definiciones de tipos. Se usa solo para esquemas swagger/OpenAPI v1; de lo contrario, es NULL.
definitions?: Record<string, unknown>
Valor de propiedad
Record<string, unknown>
provisioningState
El estado de aprovisionamiento NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
provisioningState?: string
Valor de propiedad
string
value
Cadena de escape json que define el documento que representa el esquema. Se usa para esquemas distintos de Swagger/OpenAPI.
value?: string
Valor de propiedad
string
Detalles de las propiedades heredadas
id
Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
id?: string
Valor de propiedad
string
heredado deProxyResource.id
name
El nombre del recurso NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
name?: string
Valor de propiedad
string
heredado deProxyResource.name
type
Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" NOTA: Esta propiedad no se serializará. Solo el servidor puede rellenarlo.
type?: string
Valor de propiedad
string
Heredado deProxyResource.type