Partilhar via


SchemaContract interface

Detalhes do contrato de esquema de API.

Extends

Propriedades

components

Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v2/v3, null caso contrário.

contentType

Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type, conforme definido na RFC 2616. Tipo de mídia do documento do esquema (por exemplo, application/json, application/xml).
- Swagger Esquema usar application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Esquema usar application/vnd.ms-azure-apim.xsd+xml
- OpenApi Esquema usar application/vnd.oai.openapi.components+json
- WADL Schema usar application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema usar application/vnd.ms-azure-apim.odata.schema
- gRPC Schema usar text/protobuf.

definitions

Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v1, nulo caso contrário.

provisioningState

O estado de provisionamento NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

value

Json escapou da cadeia de caracteres definindo o documento que representa o esquema. Usado para esquemas diferentes de Swagger/OpenAPI.

Propriedades Herdadas

id

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name

O nome do recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

Detalhes de Propriedade

components

Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v2/v3, null caso contrário.

components?: Record<string, unknown>

Valor de Propriedade

Record<string, unknown>

contentType

Deve ser um tipo de mídia válido usado em um cabeçalho Content-Type, conforme definido na RFC 2616. Tipo de mídia do documento do esquema (por exemplo, application/json, application/xml).
- Swagger Esquema usar application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL Esquema usar application/vnd.ms-azure-apim.xsd+xml
- OpenApi Esquema usar application/vnd.oai.openapi.components+json
- WADL Schema usar application/vnd.ms-azure-apim.wadl.grammars+xml
- OData Schema usar application/vnd.ms-azure-apim.odata.schema
- gRPC Schema usar text/protobuf.

contentType?: string

Valor de Propriedade

string

definitions

Definições de tipos. Usado apenas para esquemas Swagger/OpenAPI v1, nulo caso contrário.

definitions?: Record<string, unknown>

Valor de Propriedade

Record<string, unknown>

provisioningState

O estado de provisionamento NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

provisioningState?: string

Valor de Propriedade

string

value

Json escapou da cadeia de caracteres definindo o documento que representa o esquema. Usado para esquemas diferentes de Swagger/OpenAPI.

value?: string

Valor de Propriedade

string

Detalhes da Propriedade Herdada

id

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

id?: string

Valor de Propriedade

string

herdado deProxyResource.id

name

O nome do recurso NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

name?: string

Valor de Propriedade

string

herdada deProxyResource.name

type

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts" NOTA: Esta propriedade não será serializada. Ele só pode ser preenchido pelo servidor.

type?: string

Valor de Propriedade

string

herdado de ProxyResource.type