你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
SchemaContract interface
API 架构协定详细信息。
- 扩展
属性
| components | 类型定义。 仅用于 Swagger/OpenAPI v2/v3 架构，否则为 null。 |
| content |
必须是 RFC 2616 中定义的 Content-Type 标头中使用的有效媒体类型。 架构文档的媒体类型 (例如 application/json、application/xml) 。
|
| definitions | 类型定义。 仅用于 Swagger/OpenAPI v1 架构，否则为 null。 |
| value | 定义表示架构的文档的 Json 转义字符串。 用于 Swagger/OpenAPI 以外的架构。 |
继承属性
| id | 资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。 |
| name | 资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。 |
| type | 资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。 |
属性详细信息
components
类型定义。 仅用于 Swagger/OpenAPI v2/v3 架构，否则为 null。
components?: Record<string, unknown>属性值
Record<string, unknown>
contentType
必须是 RFC 2616 中定义的 Content-Type 标头中使用的有效媒体类型。 架构文档的媒体类型 (例如 application/json、application/xml) 。
-
Swagger架构使用 application/vnd.ms-azure-apim.swagger.definitions+json
- WSDL 架构使用 application/vnd.ms-azure-apim.xsd+xml
- OpenApi 架构使用 application/vnd.oai.openapi.components+json - WADL Schema 使用 。application/vnd.ms-azure-apim.wadl.grammars+xml
contentType?: string属性值
string
definitions
类型定义。 仅用于 Swagger/OpenAPI v1 架构，否则为 null。
definitions?: Record<string, unknown>属性值
Record<string, unknown>
value
定义表示架构的文档的 Json 转义字符串。 用于 Swagger/OpenAPI 以外的架构。
value?: string属性值
string
继承属性详细信息
id
资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会序列化。 它只能由服务器填充。
id?: string属性值
string
name
type
资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会序列化。 它只能由服务器填充。
type?: string属性值
string