Microsoft.ApiManagement service/apis/schemas 2022-08-01
- 最新
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
Bicep 資源定義
您可以使用目標作業來部署服務/apis/schemas 資源類型:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/apis/schemas 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.ApiManagement/service/apis/schemas@2022-08-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
contentType: 'string'
document: {
components: any(Azure.Bicep.Types.Concrete.AnyType)
definitions: any(Azure.Bicep.Types.Concrete.AnyType)
value: 'string'
}
}
}
屬性值
Microsoft.ApiManagement/service/apis/schemas
名字 | 描述 | 價值 |
---|---|---|
名字 | 資源名稱 | 字串 約束: 最小長度 = 1 最大長度 = 1 (必要) |
父母 | 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。 如需詳細資訊,請參閱 父資源外部的子資源。 |
類型的資源符號名稱:service/apis |
性能 | API 架構的屬性。 | SchemaContractProperties |
SchemaContractProperties
名字 | 描述 | 價值 |
---|---|---|
contentType | 必須是 Content-Type 標頭中使用的有效媒體類型,如 RFC 2616 中所定義。 架構文件的媒體類型(例如 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 。 |
字串 (必要) |
公文 | 建立或更新 API 架構檔的屬性。 | SchemaDocumentProperties (必要) |
SchemaDocumentProperties
名字 | 描述 | 價值 |
---|---|---|
元件 | 類型定義。 僅用於 Swagger/OpenAPI v2/v3 架構,否則為 null。 | 任何 |
定義 | 類型定義。 僅用於 Swagger/OpenAPI v1 架構,否則為 null。 | 任何 |
價值 | 定義代表架構之檔的 Json 逸出字串。 用於 Swagger/OpenAPI 以外的架構。 | 字串 |
ARM 樣本資源定義
您可以使用目標作業來部署服務/apis/schemas 資源類型:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/apis/schemas 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.ApiManagement/service/apis/schemas",
"apiVersion": "2022-08-01",
"name": "string",
"properties": {
"contentType": "string",
"document": {
"components": {},
"definitions": {},
"value": "string"
}
}
}
屬性值
Microsoft.ApiManagement/service/apis/schemas
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2022-08-01' |
名字 | 資源名稱 | 字串 約束: 最小長度 = 1 最大長度 = 1 (必要) |
性能 | API 架構的屬性。 | SchemaContractProperties |
類型 | 資源類型 | 'Microsoft.ApiManagement/service/apis/schemas' |
SchemaContractProperties
名字 | 描述 | 價值 |
---|---|---|
contentType | 必須是 Content-Type 標頭中使用的有效媒體類型,如 RFC 2616 中所定義。 架構文件的媒體類型(例如 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 。 |
字串 (必要) |
公文 | 建立或更新 API 架構檔的屬性。 | SchemaDocumentProperties (必要) |
SchemaDocumentProperties
名字 | 描述 | 價值 |
---|---|---|
元件 | 類型定義。 僅用於 Swagger/OpenAPI v2/v3 架構,否則為 null。 | 任何 |
定義 | 類型定義。 僅用於 Swagger/OpenAPI v1 架構,否則為 null。 | 任何 |
價值 | 定義代表架構之檔的 Json 逸出字串。 用於 Swagger/OpenAPI 以外的架構。 | 字串 |
Terraform (AzAPI 提供者) 資源定義
您可以使用目標作業來部署服務/apis/schemas 資源類型:
- 資源群組
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/apis/schemas 資源,請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/schemas@2022-08-01"
name = "string"
body = jsonencode({
properties = {
contentType = "string"
document = {
components = ?
definitions = ?
value = "string"
}
}
})
}
屬性值
Microsoft.ApiManagement/service/apis/schemas
名字 | 描述 | 價值 |
---|---|---|
名字 | 資源名稱 | 字串 約束: 最小長度 = 1 最大長度 = 1 (必要) |
parent_id | 此資源為父系之資源的標識碼。 | 類型資源的標識碼:服務/apis |
性能 | API 架構的屬性。 | SchemaContractProperties |
類型 | 資源類型 | “Microsoft.ApiManagement/service/apis/schemas@2022-08-01” |
SchemaContractProperties
名字 | 描述 | 價值 |
---|---|---|
contentType | 必須是 Content-Type 標頭中使用的有效媒體類型,如 RFC 2616 中所定義。 架構文件的媒體類型(例如 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 。 |
字串 (必要) |
公文 | 建立或更新 API 架構檔的屬性。 | SchemaDocumentProperties (必要) |
SchemaDocumentProperties
名字 | 描述 | 價值 |
---|---|---|
元件 | 類型定義。 僅用於 Swagger/OpenAPI v2/v3 架構,否則為 null。 | 任何 |
定義 | 類型定義。 僅用於 Swagger/OpenAPI v1 架構,否則為 null。 | 任何 |
價值 | 定義代表架構之檔的 Json 逸出字串。 用於 Swagger/OpenAPI 以外的架構。 | 字串 |