你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement service/apis/schemas 2023-05-01-preview
Bicep 资源定义
可以使用面向以下操作部署服务/apis/架构资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/apis/schemas 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
contentType: 'string'
document: {
components: any()
definitions: any()
value: 'string'
}
}
}
属性值
service/apis/schemas
| 名称 | 说明 | 值 |
|---|---|---|
| name | 资源名称 了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| 父级 (parent) | 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为资源的符号名称： apis |
| properties | API 架构的属性。 | SchemaContractProperties |
SchemaContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| 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 - OData Schema 使用 application/vnd.ms-azure-apim.odata.schema - gRPC Schema 使用 text/protobuf。 |
字符串 (必需) |
| 文档 | 创建或更新 API 架构文档的属性。 | SchemaDocumentProperties (必需) |
SchemaDocumentProperties
| 名称 | 说明 | 值 |
|---|---|---|
| components | 类型定义。 仅用于 Swagger/OpenAPI v2/v3 架构，否则为 null。 | 对于 Bicep，可以使用 any () 函数。 |
| 定义 | 类型定义。 仅用于 Swagger/OpenAPI v1 架构，否则为 null。 | 对于 Bicep，可以使用 any () 函数。 |
| value | 用于定义表示架构的文档的 Json 转义字符串。 用于 Swagger/OpenAPI 以外的架构。 | 字符串 |
ARM 模板资源定义
可以使用面向以下操作部署服务/apis/架构资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/apis/schemas 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ApiManagement/service/apis/schemas",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
属性值
service/apis/schemas
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/apis/schemas” |
| apiVersion | 资源 API 版本 | “2023-05-01-preview” |
| name | 资源名称 了解如何在 JSON ARM 模板中为子资源设置名称和类型。 |
字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| properties | API 架构的属性。 | SchemaContractProperties |
SchemaContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| 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 - OData Schema 使用 application/vnd.ms-azure-apim.odata.schema - gRPC Schema 使用 text/protobuf。 |
字符串 (必需) |
| 文档 | 创建或更新 API 架构文档的属性。 | SchemaDocumentProperties (必需的) |
SchemaDocumentProperties
| 名称 | 说明 | 值 |
|---|---|---|
| components | 类型定义。 仅用于 Swagger/OpenAPI v2/v3 架构，否则为 null。 | |
| 定义 | 类型定义。 仅用于 Swagger/OpenAPI v1 架构，否则为 null。 | |
| value | 定义表示架构的文档的 Json 转义字符串。 用于 Swagger/OpenAPI 以外的架构。 | 字符串 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署服务/apis/schemas 资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
资源格式
若要创建 Microsoft.ApiManagement/service/apis/schemas 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/schemas@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
value = "string"
}
}
})
}
属性值
service/apis/schemas
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.ApiManagement/service/apis/schemas@2023-05-01-preview” |
| name | 资源名称 | 字符串 (必需) 字符限制：1-80 有效字符： 字母数字和连字符。 以字母开头且以字母数字结尾。 |
| parent_id | 此资源的父资源的 ID。 | 类型为 的资源的 ID： apis |
| properties | API 架构的属性。 | SchemaContractProperties |
SchemaContractProperties
| 名称 | 说明 | 值 |
|---|---|---|
| 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 - OData Schema 使用 application/vnd.ms-azure-apim.odata.schema - gRPC Schema 使用 text/protobuf。 |
字符串 (必需) |
| 文档 | 创建或更新 API 架构文档的属性。 | SchemaDocumentProperties (必需的) |
SchemaDocumentProperties
| 名称 | 说明 | 值 |
|---|---|---|
| components | 类型定义。 仅用于 Swagger/OpenAPI v2/v3 架构，否则为 null。 | |
| 定义 | 类型定义。 仅用于 Swagger/OpenAPI v1 架构，否则为 null。 | |
| value | 定义表示架构的文档的 Json 转义字符串。 用于 Swagger/OpenAPI 以外的架构。 | 字符串 |