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

• Актуальная
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview

Определение ресурса Bicep

Тип ресурса service/workspaces/apis/operations можно развернуть с помощью операций, предназначенных для:

• Группы ресурсов — см. команды развертывания групп ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apis/operations, добавьте в шаблон следующий Bicep.

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/operations@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          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()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          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()
            }
            {customized property}: {
              description: 'string'
              externalValue: 'string'
              summary: 'string'
              value: any()
            }
          }
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              examples: {
                {customized property}: {
                  description: 'string'
                  externalValue: 'string'
                  summary: 'string'
                  value: any()
                }
                {customized property}: {
                  description: 'string'
                  externalValue: 'string'
                  summary: 'string'
                  value: any()
                }
              }
              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()
              }
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
            }
            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()
              }
              {customized property}: {
                description: 'string'
                externalValue: 'string'
                summary: 'string'
                value: any()
              }
            }
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                examples: {
                  {customized property}: {
                    description: 'string'
                    externalValue: 'string'
                    summary: 'string'
                    value: any()
                  }
                  {customized property}: {
                    description: 'string'
                    externalValue: 'string'
                    summary: 'string'
                    value: any()
                  }
                }
                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()
          }
          {customized property}: {
            description: 'string'
            externalValue: 'string'
            summary: 'string'
            value: any()
          }
        }
        name: 'string'
        required: bool
        schemaId: 'string'
        type: 'string'
        typeName: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

Значения свойств

service/workspaces/apis/operations

Имя	Описание	Значение
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.	string (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.	Символьное имя ресурса типа API
properties	Свойства контракта операции.	OperationContractProperties

OperationContractProperties

Имя	Описание	Значение
description	Описание операции. Может содержать теги форматирования HTML.	строка
displayName	Имя операции.	string (обязательно)
method	Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничиваются только ими.	string (обязательно)
политики	Политики операций	строка
запрос	Сущность, содержащая сведения о запросе.	RequestContract
responses	Массив ответов операции.	ResponseContract[]
templateParameters	Коллекция параметров шаблона URL-адреса.	ParameterContract[]
urlTemplate	Шаблон относительного URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: /customers/{cid}/orders/{oid}/?date={date}	string (обязательно)

RequestContract

Имя	Описание	Значение
description	Описание запроса операции.	строка
Заголовки	Набор заголовков запросов на операцию.	ParameterContract[]
queryParameters	Набор параметров запросов на операцию.	ParameterContract[]
representations	коллекция представлений запросов операций	RepresentationContract[]

ParameterContract

Имя	Описание	Значение
defaultValue	Значение параметра по умолчанию.	строка
description	Описание параметра.	строка
примеры	Пример, определенный для параметра .	ParameterExamplesContract
name	Имя параметра.	string (обязательно)
обязательно	Указывает, является ли параметр обязательным.	bool
schemaId	Идентификатор схемы.	строка
type	Тип параметра.	строка (обязательно)
typeName	Имя типа, определенное схемой.	строка
значения	Значения параметра.	string[]

ParameterExamplesContract

Имя	Описание	Значение
{настроенное свойство}		ParameterExampleContract
{настроенное свойство}		ParameterExampleContract

ParameterExampleContract

Имя	Описание	Значение
description	Подробное описание для примера	строка
externalValue	URL-адрес, указывающий на пример литерала.	строка
Итоги	Краткое описание примера	строка
value	Пример значения. Может быть примитивным значением или объектом .	Для Bicep можно использовать функцию any().

RepresentationContract

Имя	Описание	Значение
сontentType	Указывает зарегистрированный или пользовательский тип контента для этого представления, например application/xml.	строка (обязательно)
примеры	Пример, определенный для представления.	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.	строка

ResponseContract

Имя	Описание	Значение
description	Описание ответа операции.	строка
Заголовки	Коллекция заголовков ответа операции.	ParameterContract[]
representations	коллекция представлений ответов операций	RepresentationContract[]
statusCode	Код состояния HTTP ответа операции.	int (обязательно)

Определение ресурса шаблона ARM

Тип ресурса service/workspaces/apis/operations можно развернуть с помощью операций, предназначенных для:

• Группы ресурсов — см. команды развертывания группы ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apis/operations, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.ApiManagement/service/workspaces/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": {}
            },
            "{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": {}
            },
            "{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": {}
            },
            "{customized property}": {
              "description": "string",
              "externalValue": "string",
              "summary": "string",
              "value": {}
            }
          },
          "formParameters": [
            {
              "defaultValue": "string",
              "description": "string",
              "examples": {
                "{customized property}": {
                  "description": "string",
                  "externalValue": "string",
                  "summary": "string",
                  "value": {}
                },
                "{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": {}
              },
              "{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": {}
              },
              "{customized property}": {
                "description": "string",
                "externalValue": "string",
                "summary": "string",
                "value": {}
              }
            },
            "formParameters": [
              {
                "defaultValue": "string",
                "description": "string",
                "examples": {
                  "{customized property}": {
                    "description": "string",
                    "externalValue": "string",
                    "summary": "string",
                    "value": {}
                  },
                  "{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": {}
          },
          "{customized property}": {
            "description": "string",
            "externalValue": "string",
            "summary": "string",
            "value": {}
          }
        },
        "name": "string",
        "required": "bool",
        "schemaId": "string",
        "type": "string",
        "typeName": "string",
        "values": [ "string" ]
      }
    ],
    "urlTemplate": "string"
  }
}

Значения свойств

service/workspaces/apis/operations

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.ApiManagement/service/workspaces/apis/operations
версия_API	Версия API ресурсов	'2023-05-01-preview'
name	имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.	строка (обязательно)
properties	Свойства контракта операции.	OperationContractProperties

OperationContractProperties

Имя	Описание	Значение
description	Описание операции. Может содержать теги форматирования HTML.	строка
displayName	Имя операции.	string (обязательно)
method	Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничиваются только ими.	string (обязательно)
политики	Политики операций	строка
запрос	Сущность, содержащая сведения о запросе.	RequestContract
responses	Массив ответов операции.	ResponseContract[]
templateParameters	Коллекция параметров шаблона URL-адреса.	ParameterContract[]
urlTemplate	Шаблон относительного URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: /customers/{cid}/orders/{oid}/?date={date}	string (обязательно)

RequestContract

Имя	Описание	Значение
description	Описание запроса операции.	строка
Заголовки	Набор заголовков запросов на операцию.	ParameterContract[]
queryParameters	Набор параметров запросов на операцию.	ParameterContract[]
representations	коллекция представлений запросов операций	RepresentationContract[]

ParameterContract

Имя	Описание	Значение
defaultValue	Значение параметра по умолчанию.	строка
description	Описание параметра.	строка
примеры	Пример, определенный для параметра .	ParameterExamplesContract
name	Имя параметра.	string (обязательно)
обязательно	Указывает, является ли параметр обязательным.	bool
schemaId	Идентификатор схемы.	строка
type	Тип параметра.	string (обязательно)
typeName	Имя типа, определенное схемой.	строка
значения	Значения параметра.	string[]

ParameterExamplesContract

Имя	Описание	Значение
{настраиваемое свойство}		ParameterExampleContract
{настраиваемое свойство}		ParameterExampleContract

ParameterExampleContract

Имя	Описание	Значение
description	Длинное описание для примера	строка
externalValue	URL-адрес, указывающий на пример литерала.	строка
Итоги	Краткое описание примера	строка
value	Пример значения. Может быть примитивным значением или объектом .

RepresentationContract

Имя	Описание	Значение
сontentType	Указывает зарегистрированный или пользовательский тип контента для этого представления, например 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.	строка

ResponseContract

Имя	Описание	Значение
description	Описание ответа операции.	строка
Заголовки	Коллекция заголовков ответа операции.	ParameterContract[]
representations	коллекция представлений ответов операций	RepresentationContract[]
statusCode	Код состояния HTTP ответа операции.	int (обязательно)

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса service/workspaces/apis/operations можно развернуть с помощью операций, предназначенных для:

• Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apis/operations, добавьте следующую terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/apis/operations@2023-05-01-preview"
  name = "string"
  parent_id = "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"
              }
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
            }
            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"
              }
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
            }
            name = "string"
            required = bool
            schemaId = "string"
            type = "string"
            typeName = "string"
            values = [
              "string"
            ]
          }
        ]
        representations = [
          {
            contentType = "string"
            examples = {
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
              {customized property} = {
                description = "string"
                externalValue = "string"
                summary = "string"
              }
            }
            formParameters = [
              {
                defaultValue = "string"
                description = "string"
                examples = {
                  {customized property} = {
                    description = "string"
                    externalValue = "string"
                    summary = "string"
                  }
                  {customized property} = {
                    description = "string"
                    externalValue = "string"
                    summary = "string"
                  }
                }
                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"
                }
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
              }
              name = "string"
              required = bool
              schemaId = "string"
              type = "string"
              typeName = "string"
              values = [
                "string"
              ]
            }
          ]
          representations = [
            {
              contentType = "string"
              examples = {
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
                {customized property} = {
                  description = "string"
                  externalValue = "string"
                  summary = "string"
                }
              }
              formParameters = [
                {
                  defaultValue = "string"
                  description = "string"
                  examples = {
                    {customized property} = {
                      description = "string"
                      externalValue = "string"
                      summary = "string"
                    }
                    {customized property} = {
                      description = "string"
                      externalValue = "string"
                      summary = "string"
                    }
                  }
                  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"
            }
            {customized property} = {
              description = "string"
              externalValue = "string"
              summary = "string"
            }
          }
          name = "string"
          required = bool
          schemaId = "string"
          type = "string"
          typeName = "string"
          values = [
            "string"
          ]
        }
      ]
      urlTemplate = "string"
    }
  })
}

Значения свойств

service/workspaces/apis/operations

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.ApiManagement/service/workspaces/apis/operations@2023-05-01-preview"
name	имя ресурса.	string (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа API
properties	Свойства контракта операции.	OperationContractProperties

OperationContractProperties

Имя	Описание	Значение
description	Описание операции. Может содержать теги форматирования HTML.	строка
displayName	Имя операции.	string (обязательно)
method	Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничиваются только ими.	string (обязательно)
политики	Политики операций	строка
запрос	Сущность, содержащая сведения о запросе.	RequestContract
responses	Массив ответов операции.	ResponseContract[]
templateParameters	Коллекция параметров шаблона URL-адреса.	ParameterContract[]
urlTemplate	Шаблон относительного URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: /customers/{cid}/orders/{oid}/?date={date}	string (обязательно)

RequestContract

Имя	Описание	Значение
description	Описание запроса операции.	строка
Заголовки	Набор заголовков запросов на операцию.	ParameterContract[]
queryParameters	Набор параметров запросов на операцию.	ParameterContract[]
representations	коллекция представлений запросов операций	RepresentationContract[]

ParameterContract

Имя	Описание	Значение
defaultValue	Значение параметра по умолчанию.	строка
description	Описание параметра.	строка
примеры	Пример, определенный для параметра .	ParameterExamplesContract
name	Имя параметра.	string (обязательно)
обязательно	Указывает, является ли параметр обязательным.	bool
schemaId	Идентификатор схемы.	строка
type	Тип параметра.	string (обязательно)
typeName	Имя типа, определенное схемой.	строка
значения	Значения параметра.	string[]

ParameterExamplesContract

Имя	Описание	Значение
{настраиваемое свойство}		ParameterExampleContract
{настраиваемое свойство}		ParameterExampleContract

ParameterExampleContract

Имя	Описание	Значение
description	Длинное описание для примера	строка
externalValue	URL-адрес, указывающий на пример литерала.	строка
Итоги	Краткое описание примера	строка
value	Пример значения. Может быть примитивным значением или объектом .

RepresentationContract

Имя	Описание	Значение
сontentType	Указывает зарегистрированный или пользовательский тип контента для этого представления, например 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.	строка

ResponseContract

Имя	Описание	Значение
description	Описание ответа операции.	строка
Заголовки	Коллекция заголовков ответа операции.	ParameterContract[]
representations	коллекция представлений ответов операций	RepresentationContract[]
statusCode	Код состояния HTTP ответа операции.	int (обязательно)