Поделиться через

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

  • Статья

Определение ресурсов Bicep

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2023-09-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()
            }
          }
          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()
            }
          }
          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()
            }
          }
          formParameters: [
            {
              defaultValue: 'string'
              description: 'string'
              examples: {
                {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()
              }
            }
            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()
              }
            }
            formParameters: [
              {
                defaultValue: 'string'
                description: 'string'
                examples: {
                  {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()
          }
        }
        name: 'string'
        required: bool
        schemaId: 'string'
        type: 'string'
        typeName: 'string'
        values: [
          'string'
        ]
      }
    ]
    urlTemplate: 'string'
  }
}

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

service/apis/operations

Имя Описание Ценность
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в Bicep.		 строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.		 Символьное имя ресурса типа: API
свойства Свойства контракта операции. OperationContractProperties

OperationContractProperties

Имя Описание Ценность
описание Описание операции. Может включать теги форматирования HTML. струна

Ограничения целостности:
Максимальная длина = 1000
displayName Имя операции. строка (обязательно)

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

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 1000

RequestContract

Имя Описание Ценность
описание Описание запроса операции. струна
Заголовки Коллекция заголовков запросов операций. ParameterContract[]
queryParameters Коллекция параметров запроса запроса операции. ParameterContract[]
Представления Коллекция представлений запросов операций. RepresentationContract[]

ПараметрContract

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

ParameterExamplesContract

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

ParameterExampleContract

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

ПредставлениеContract

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

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2023-09-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"
  }
}

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

service/apis/operations

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/apis/operations"
apiVersion Версия API ресурсов '2023-09-01-preview'
имя Имя ресурса

Узнайте, как задать имена и типы дочерних ресурсов в шаблонах ARM JSON.		 строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
свойства Свойства контракта операции. OperationContractProperties

OperationContractProperties

Имя Описание Ценность
описание Описание операции. Может включать теги форматирования HTML. струна

Ограничения целостности:
Максимальная длина = 1000
displayName Имя операции. строка (обязательно)

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

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 1000

RequestContract

Имя Описание Ценность
описание Описание запроса операции. струна
Заголовки Коллекция заголовков запросов операций. ParameterContract[]
queryParameters Коллекция параметров запроса запроса операции. ParameterContract[]
Представления Коллекция представлений запросов операций. RepresentationContract[]

ПараметрContract

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

ParameterExamplesContract

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

ParameterExampleContract

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

ПредставлениеContract

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

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

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

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

  • групп ресурсов

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

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

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

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

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

service/apis/operations

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/apis/operations@2023-09-01-preview"
имя Имя ресурса строка (обязательно)

Ограничение символов: 1–80

Допустимые символы:
Буквенно-цифровые и дефисы.

Начните с буквы и заканчивается буквенно-цифровым.
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: API
свойства Свойства контракта операции. OperationContractProperties

OperationContractProperties

Имя Описание Ценность
описание Описание операции. Может включать теги форматирования HTML. струна

Ограничения целостности:
Максимальная длина = 1000
displayName Имя операции. строка (обязательно)

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

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 1000

RequestContract

Имя Описание Ценность
описание Описание запроса операции. струна
Заголовки Коллекция заголовков запросов операций. ParameterContract[]
queryParameters Коллекция параметров запроса запроса операции. ParameterContract[]
Представления Коллекция представлений запросов операций. RepresentationContract[]

ПараметрContract

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

ParameterExamplesContract

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

ParameterExampleContract

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

ПредставлениеContract

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

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