你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.ApiManagement service/apis/operations 2023-05-01-preview

• 最新
• 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
• 2016-10-10
• 2016-07-07

Bicep 资源定义

可以使用目标操作部署服务/apis/operations 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/apis/operations 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    displayName: 'string'
    method: 'string'
    policies: 'string'
    request: {
      description: 'string'
      headers: [
        {
          defaultValue: 'string'
          description: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any(Azure.Bicep.Types.Concrete.AnyType)
            }
          }
          name: 'string'
          required: bool
          schemaId: 'string'
          type: 'string'
          typeName: 'string'
          values: [
            'string'
          ]
        }
      ]
      queryParameters: [
        {
          defaultValue: 'string'
          description: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any(Azure.Bicep.Types.Concrete.AnyType)
            }
          }
          name: 'string'
          required: bool
          schemaId: 'string'
          type: 'string'
          typeName: 'string'
          values: [
            'string'
          ]
        }
      ]
      representations: [
        {
          contentType: 'string'
          examples: {
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any(Azure.Bicep.Types.Concrete.AnyType)
            }
          }
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              examples: {
                {customized property}: {
                  description: 'string'
                  externalValue: 'string'
                  summary: 'string'
                  value: any(Azure.Bicep.Types.Concrete.AnyType)
                }
              }
              name: 'string'
              required: bool
              schemaId: 'string'
              type: 'string'
              typeName: 'string'
              values: [
                'string'
              ]
            }
          ]
          schemaId: 'string'
          typeName: 'string'
        }
      ]
    }
    responses: [
      {
        description: 'string'
        headers: [
          {
            defaultValue: 'string'
            description: 'string'
            examples: {
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any(Azure.Bicep.Types.Concrete.AnyType)
              }
            }
            name: 'string'
            required: bool
            schemaId: 'string'
            type: 'string'
            typeName: 'string'
            values: [
              'string'
            ]
          }
        ]
        representations: [
          {
            contentType: 'string'
            examples: {
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any(Azure.Bicep.Types.Concrete.AnyType)
              }
            }
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                examples: {
                  {customized property}: {
                    description: 'string'
                    externalValue: 'string'
                    summary: 'string'
                    value: any(Azure.Bicep.Types.Concrete.AnyType)
                  }
                }
                name: 'string'
                required: bool
                schemaId: 'string'
                type: 'string'
                typeName: 'string'
                values: [
                  'string'
                ]
              }
            ]
            schemaId: 'string'
            typeName: 'string'
          }
        ]
        statusCode: int
      }
    ]
    templateParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        examples: {
          {customized property}: {
            description: 'string'
            externalValue: 'string'
            summary: 'string'
            value: any(Azure.Bicep.Types.Concrete.AnyType)
          }
        }
        name: 'string'
        required: bool
        schemaId: 'string'
        type: 'string'
        typeName: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

属性值

Microsoft.ApiManagement/service/apis/operations

名字	描述	价值
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）
父母	在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源外部的子资源。	类型资源的符号名称：服务/apis
性能	操作协定的属性。	OperationContractProperties

OperationContractProperties

名字	描述	价值
描述	操作的说明。 可能包括 HTML 格式标记。	字符串 约束： 最大长度 =
displayName	操作名称。	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）
方法	有效的 HTTP 操作方法。 典型的 Http 方法，如 GET、PUT、POST，但不仅限于它们。	string （必需）
政策	操作策略	字符串
请求	包含请求详细信息的实体。	RequestContract
反应	操作响应数组。	ResponseContract[]
templateParameters	URL 模板参数的集合。	ParameterContract[]
urlTemplate	标识此操作的目标资源的相对 URL 模板。 可能包括参数。 示例：/customers/{cid}/orders/{oid}/？date={date}	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）

ParameterContract

名字	描述	价值
defaultValue	默认参数值。	字符串
描述	参数说明。	字符串
例子	为参数定义的示例。	ParameterExamplesContract
名字	参数名称。	string （必需）
必填	指定参数是否是必需的。	bool
schemaId	架构标识符。	字符串
类型	参数类型。	string （必需）
typeName	由架构定义的类型名称。	字符串
值	参数值。	string[]

ParameterExampleContract

名字	描述	价值
描述	示例的长说明	字符串
externalValue	指向文本示例的 URL	字符串
总结	示例的简短说明	字符串
价值	示例值。 可以是基元值或对象。	任何

ParameterExamplesContract

名字	描述	价值

ParameterExamplesContract

名字	描述	价值

RepresentationContract

名字	描述	价值
contentType	为此表示形式指定已注册或自定义内容类型，例如 application/xml。	string （必需）
例子	为表示形式定义的示例。	ParameterExamplesContract
formParameters	表单参数的集合。 如果“contentType”值为“application/x-www-form-urlencoded”或“multipart/form-data”，则是必需的。	ParameterContract[]
schemaId	架构标识符。 仅当“contentType”值既不是“application/x-www-form-urlencoded”也不是“multipart/form-data”时适用。	字符串
typeName	由架构定义的类型名称。 仅当“contentType”值既不是“application/x-www-form-urlencoded”也不是“multipart/form-data”时适用。	字符串

RequestContract

名字	描述	价值
描述	操作请求说明。	字符串
头	操作请求标头的集合。	ParameterContract[]
queryParameters	操作请求查询参数的集合。	ParameterContract[]
交涉	操作请求表示形式的集合。	RepresentationContract[]

ResponseContract

名字	描述	价值
描述	操作响应说明。	字符串
头	操作响应标头的集合。	ParameterContract[]
交涉	操作响应表示形式的集合。	RepresentationContract[]
statusCode	操作响应 HTTP 状态代码。	int （必需）

ARM 模板资源定义

可以使用目标操作部署服务/apis/operations 资源类型：

• 资源组 - 请参阅 资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/apis/operations 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "method": "string",
    "policies": "string",
    "request": {
      "description": "string",
      "headers": [
        {
          "defaultValue": "string",
          "description": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "name": "string",
          "required": "bool",
          "schemaId": "string",
          "type": "string",
          "typeName": "string",
          "values": [ "string" ]
        }
      ],
      "queryParameters": [
        {
          "defaultValue": "string",
          "description": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "name": "string",
          "required": "bool",
          "schemaId": "string",
          "type": "string",
          "typeName": "string",
          "values": [ "string" ]
        }
      ],
      "representations": [
        {
          "contentType": "string",
          "examples": {
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "examples": {
                "{customized property}": {
                  "description": "string",
                  "externalValue": "string",
                  "summary": "string",
                  "value": {}
                }
              },
              "name": "string",
              "required": "bool",
              "schemaId": "string",
              "type": "string",
              "typeName": "string",
              "values": [ "string" ]
            }
          ],
          "schemaId": "string",
          "typeName": "string"
        }
      ]
    },
    "responses": [
      {
        "description": "string",
        "headers": [
          {
            "defaultValue": "string",
            "description": "string",
            "examples": {
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              }
            },
            "name": "string",
            "required": "bool",
            "schemaId": "string",
            "type": "string",
            "typeName": "string",
            "values": [ "string" ]
          }
        ],
        "representations": [
          {
            "contentType": "string",
            "examples": {
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              }
            },
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "examples": {
                  "{customized property}": {
                    "description": "string",
                    "externalValue": "string",
                    "summary": "string",
                    "value": {}
                  }
                },
                "name": "string",
                "required": "bool",
                "schemaId": "string",
                "type": "string",
                "typeName": "string",
                "values": [ "string" ]
              }
            ],
            "schemaId": "string",
            "typeName": "string"
          }
        ],
        "statusCode": "int"
      }
    ],
    "templateParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "examples": {
          "{customized property}": {
            "description": "string",
            "externalValue": "string",
            "summary": "string",
            "value": {}
          }
        },
        "name": "string",
        "required": "bool",
        "schemaId": "string",
        "type": "string",
        "typeName": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

属性值

Microsoft.ApiManagement/service/apis/operations

名字	描述	价值
apiVersion	API 版本	'2023-05-01-preview'
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）
性能	操作协定的属性。	OperationContractProperties
类型	资源类型	“Microsoft.ApiManagement/service/apis/operations”

OperationContractProperties

名字	描述	价值
描述	操作的说明。 可能包括 HTML 格式标记。	字符串 约束： 最大长度 =
displayName	操作名称。	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）
方法	有效的 HTTP 操作方法。 典型的 Http 方法，如 GET、PUT、POST，但不仅限于它们。	string （必需）
政策	操作策略	字符串
请求	包含请求详细信息的实体。	RequestContract
反应	操作响应数组。	ResponseContract[]
templateParameters	URL 模板参数的集合。	ParameterContract[]
urlTemplate	标识此操作的目标资源的相对 URL 模板。 可能包括参数。 示例：/customers/{cid}/orders/{oid}/？date={date}	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）

ParameterContract

名字	描述	价值
defaultValue	默认参数值。	字符串
描述	参数说明。	字符串
例子	为参数定义的示例。	ParameterExamplesContract
名字	参数名称。	string （必需）
必填	指定参数是否是必需的。	bool
schemaId	架构标识符。	字符串
类型	参数类型。	string （必需）
typeName	由架构定义的类型名称。	字符串
值	参数值。	string[]

ParameterExampleContract

名字	描述	价值
描述	示例的长说明	字符串
externalValue	指向文本示例的 URL	字符串
总结	示例的简短说明	字符串
价值	示例值。 可以是基元值或对象。	任何

ParameterExamplesContract

名字	描述	价值

ParameterExamplesContract

名字	描述	价值

RepresentationContract

名字	描述	价值
contentType	为此表示形式指定已注册或自定义内容类型，例如 application/xml。	string （必需）
例子	为表示形式定义的示例。	ParameterExamplesContract
formParameters	表单参数的集合。 如果“contentType”值为“application/x-www-form-urlencoded”或“multipart/form-data”，则是必需的。	ParameterContract[]
schemaId	架构标识符。 仅当“contentType”值既不是“application/x-www-form-urlencoded”也不是“multipart/form-data”时适用。	字符串
typeName	由架构定义的类型名称。 仅当“contentType”值既不是“application/x-www-form-urlencoded”也不是“multipart/form-data”时适用。	字符串

RequestContract

名字	描述	价值
描述	操作请求说明。	字符串
头	操作请求标头的集合。	ParameterContract[]
queryParameters	操作请求查询参数的集合。	ParameterContract[]
交涉	操作请求表示形式的集合。	RepresentationContract[]

ResponseContract

名字	描述	价值
描述	操作响应说明。	字符串
头	操作响应标头的集合。	ParameterContract[]
交涉	操作响应表示形式的集合。	RepresentationContract[]
statusCode	操作响应 HTTP 状态代码。	int （必需）

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署服务/apis/operations 资源类型：

• 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/apis/operations 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      method = "string"
      policies = "string"
      request = {
        description = "string"
        headers = [
          {
            defaultValue = "string"
            description = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
                value = ?
              }
            }
            name = "string"
            required = bool
            schemaId = "string"
            type = "string"
            typeName = "string"
            values = [
              "string"
            ]
          }
        ]
        queryParameters = [
          {
            defaultValue = "string"
            description = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
                value = ?
              }
            }
            name = "string"
            required = bool
            schemaId = "string"
            type = "string"
            typeName = "string"
            values = [
              "string"
            ]
          }
        ]
        representations = [
          {
            contentType = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
                value = ?
              }
            }
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                examples = {
                  {customized property} = {
                    description = "string"
                    externalValue = "string"
                    summary = "string"
                    value = ?
                  }
                }
                name = "string"
                required = bool
                schemaId = "string"
                type = "string"
                typeName = "string"
                values = [
                  "string"
                ]
              }
            ]
            schemaId = "string"
            typeName = "string"
          }
        ]
      }
      responses = [
        {
          description = "string"
          headers = [
            {
              defaultValue = "string"
              description = "string"
              examples = {
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                  value = ?
                }
              }
              name = "string"
              required = bool
              schemaId = "string"
              type = "string"
              typeName = "string"
              values = [
                "string"
              ]
            }
          ]
          representations = [
            {
              contentType = "string"
              examples = {
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                  value = ?
                }
              }
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  examples = {
                    {customized property} = {
                      description = "string"
                      externalValue = "string"
                      summary = "string"
                      value = ?
                    }
                  }
                  name = "string"
                  required = bool
                  schemaId = "string"
                  type = "string"
                  typeName = "string"
                  values = [
                    "string"
                  ]
                }
              ]
              schemaId = "string"
              typeName = "string"
            }
          ]
          statusCode = int
        }
      ]
      templateParameters = [
        {
          defaultValue = "string"
          description = "string"
          examples = {
            {customized property} = {
              description = "string"
              externalValue = "string"
              summary = "string"
              value = ?
            }
          }
          name = "string"
          required = bool
          schemaId = "string"
          type = "string"
          typeName = "string"
          values = [
            "string"
          ]
        }
      ]
      urlTemplate = "string"
    }
  })
}

属性值

Microsoft.ApiManagement/service/apis/operations

名字	描述	价值
名字	资源名称	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）
parent_id	此资源的父资源的 ID。	类型资源的 ID：服务/apis
性能	操作协定的属性。	OperationContractProperties
类型	资源类型	“Microsoft.ApiManagement/service/apis/operations@2023-05-01-preview”

OperationContractProperties

名字	描述	价值
描述	操作的说明。 可能包括 HTML 格式标记。	字符串 约束： 最大长度 =
displayName	操作名称。	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）
方法	有效的 HTTP 操作方法。 典型的 Http 方法，如 GET、PUT、POST，但不仅限于它们。	string （必需）
政策	操作策略	字符串
请求	包含请求详细信息的实体。	RequestContract
反应	操作响应数组。	ResponseContract[]
templateParameters	URL 模板参数的集合。	ParameterContract[]
urlTemplate	标识此操作的目标资源的相对 URL 模板。 可能包括参数。 示例：/customers/{cid}/orders/{oid}/？date={date}	字符串 约束： 最小长度 = 1 最大长度 = 1 （必需）

ParameterContract

名字	描述	价值
defaultValue	默认参数值。	字符串
描述	参数说明。	字符串
例子	为参数定义的示例。	ParameterExamplesContract
名字	参数名称。	string （必需）
必填	指定参数是否是必需的。	bool
schemaId	架构标识符。	字符串
类型	参数类型。	string （必需）
typeName	由架构定义的类型名称。	字符串
值	参数值。	string[]

ParameterExampleContract

名字	描述	价值
描述	示例的长说明	字符串
externalValue	指向文本示例的 URL	字符串
总结	示例的简短说明	字符串
价值	示例值。 可以是基元值或对象。	任何

ParameterExamplesContract

名字	描述	价值

ParameterExamplesContract

名字	描述	价值

RepresentationContract

名字	描述	价值
contentType	为此表示形式指定已注册或自定义内容类型，例如 application/xml。	string （必需）
例子	为表示形式定义的示例。	ParameterExamplesContract
formParameters	表单参数的集合。 如果“contentType”值为“application/x-www-form-urlencoded”或“multipart/form-data”，则是必需的。	ParameterContract[]
schemaId	架构标识符。 仅当“contentType”值既不是“application/x-www-form-urlencoded”也不是“multipart/form-data”时适用。	字符串
typeName	由架构定义的类型名称。 仅当“contentType”值既不是“application/x-www-form-urlencoded”也不是“multipart/form-data”时适用。	字符串

RequestContract

名字	描述	价值
描述	操作请求说明。	字符串
头	操作请求标头的集合。	ParameterContract[]
queryParameters	操作请求查询参数的集合。	ParameterContract[]
交涉	操作请求表示形式的集合。	RepresentationContract[]

ResponseContract

名字	描述	价值
描述	操作响应说明。	字符串
头	操作响应标头的集合。	ParameterContract[]
交涉	操作响应表示形式的集合。	RepresentationContract[]
statusCode	操作响应 HTTP 状态代码。	int （必需）