Служба Microsoft.ApiManagement/apis/operations 2016-10-10

• последние
• 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

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/operations@2016-10-10' = {
  parent: resourceSymbolicName
  description: 'string'
  method: 'string'
  name: 'string'
  request: {
    description: 'string'
    headers: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    queryParameters: [
      {
        defaultValue: 'string'
        description: 'string'
        name: 'string'
        required: bool
        type: 'string'
        values: [
          'string'
        ]
      }
    ]
    representations: [
      {
        contentType: 'string'
        sample: 'string'
      }
    ]
  }
  responses: [
    {
      description: 'string'
      representations: [
        {
          contentType: 'string'
          sample: 'string'
        }
      ]
      statusCode: int
    }
  ]
  templateParameters: [
    {
      defaultValue: 'string'
      description: 'string'
      name: 'string'
      required: bool
      type: 'string'
      values: [
        'string'
      ]
    }
  ]
  urlTemplate: 'string'
}

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

Microsoft.ApiManagement/service/apis/operations

Имя	Описание	Ценность
описание	Описание операции. Может включать теги форматирования HTML.	струна Ограничения целостности: Максимальная длина = 1000
метод	Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничены только ими.	строка (обязательно)
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно)
родитель	В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе "Дочерний ресурс вне родительского ресурса".	Символьное имя ресурса типа: service/apis
просьба	Сущность, содержащая сведения о запросе.	RequestContract
Ответы	Массив ответов операций.	ResultContract[]
templateParameters	Коллекция параметров шаблона URL-адреса.	ParameterContract[]
urlTemplate	Относительный шаблон URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: /customers/{cid}/orders/{oid}/?date={date}	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1000 (обязательно)

ПараметрContract

Имя	Описание	Ценность
значение по умолчанию	Значение параметра по умолчанию.	струна
описание	Описание параметра.	струна
имя	Имя параметра.	строка (обязательно)
Обязательно	является ли параметр обязательным или нет.	булевая переменная (bool)
тип	Тип параметра.	строка (обязательно)
Значения	Значения параметров.	строка[]

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

Имя	Описание	Ценность
Тип контента	Указывает зарегистрированный или пользовательский тип контента для этого представления, например application/xml.	строка (обязательно)
образец	Пример представления.	струна

RequestContract

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

ResultContract

Имя	Описание	Ценность
описание	Описание ответа операции.	струна
Представления	Коллекция представлений ответов операций.	ПредставлениеContract[]
statusCode	Код состояния HTTP ответа операции.	int Ограничения целостности: Минимальное значение = 100 Максимальное значение = 599 (обязательно)

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/apis/operations",
  "apiVersion": "2016-10-10",
  "name": "string",
  "description": "string",
  "method": "string",
  "request": {
    "description": "string",
    "headers": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "queryParameters": [
      {
        "defaultValue": "string",
        "description": "string",
        "name": "string",
        "required": "bool",
        "type": "string",
        "values": [ "string" ]
      }
    ],
    "representations": [
      {
        "contentType": "string",
        "sample": "string"
      }
    ]
  },
  "responses": [
    {
      "description": "string",
      "representations": [
        {
          "contentType": "string",
          "sample": "string"
        }
      ],
      "statusCode": "int"
    }
  ],
  "templateParameters": [
    {
      "defaultValue": "string",
      "description": "string",
      "name": "string",
      "required": "bool",
      "type": "string",
      "values": [ "string" ]
    }
  ],
  "urlTemplate": "string"
}

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

Microsoft.ApiManagement/service/apis/operations

Имя	Описание	Ценность
apiVersion	Версия API	'2016-10-10'
описание	Описание операции. Может включать теги форматирования HTML.	струна Ограничения целостности: Максимальная длина = 1000
метод	Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничены только ими.	строка (обязательно)
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно)
просьба	Сущность, содержащая сведения о запросе.	RequestContract
Ответы	Массив ответов операций.	ResultContract[]
templateParameters	Коллекция параметров шаблона URL-адреса.	ParameterContract[]
тип	Тип ресурса	"Microsoft.ApiManagement/service/apis/operations"
urlTemplate	Относительный шаблон URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: /customers/{cid}/orders/{oid}/?date={date}	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1000 (обязательно)

ПараметрContract

Имя	Описание	Ценность
значение по умолчанию	Значение параметра по умолчанию.	струна
описание	Описание параметра.	струна
имя	Имя параметра.	строка (обязательно)
Обязательно	является ли параметр обязательным или нет.	булевая переменная (bool)
тип	Тип параметра.	строка (обязательно)
Значения	Значения параметров.	строка[]

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

Имя	Описание	Ценность
Тип контента	Указывает зарегистрированный или пользовательский тип контента для этого представления, например application/xml.	строка (обязательно)
образец	Пример представления.	струна

RequestContract

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

ResultContract

Имя	Описание	Ценность
описание	Описание ответа операции.	струна
Представления	Коллекция представлений ответов операций.	ПредставлениеContract[]
statusCode	Код состояния HTTP ответа операции.	int Ограничения целостности: Минимальное значение = 100 Максимальное значение = 599 (обязательно)

Примеры использования

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/operations@2016-10-10"
  name = "string"
  parent_id = "string"
  body = {
    description = "string"
    method = "string"
    request = {
      description = "string"
      headers = [
        {
          defaultValue = "string"
          description = "string"
          name = "string"
          required = bool
          type = "string"
          values = [
            "string"
          ]
        }
      ]
      queryParameters = [
        {
          defaultValue = "string"
          description = "string"
          name = "string"
          required = bool
          type = "string"
          values = [
            "string"
          ]
        }
      ]
      representations = [
        {
          contentType = "string"
          sample = "string"
        }
      ]
    }
    responses = [
      {
        description = "string"
        representations = [
          {
            contentType = "string"
            sample = "string"
          }
        ]
        statusCode = int
      }
    ]
    templateParameters = [
      {
        defaultValue = "string"
        description = "string"
        name = "string"
        required = bool
        type = "string"
        values = [
          "string"
        ]
      }
    ]
    urlTemplate = "string"
  }
}

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

Microsoft.ApiManagement/service/apis/operations

Имя	Описание	Ценность
описание	Описание операции. Может включать теги форматирования HTML.	струна Ограничения целостности: Максимальная длина = 1000
метод	Допустимый метод операции HTTP. Типичные методы HTTP, такие как GET, PUT, POST, но не ограничены только ими.	строка (обязательно)
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 256 Pattern = ^[^*#&+:<>?]+$ (обязательно)
parent_id	Идентификатор ресурса, который является родительским для этого ресурса.	Идентификатор ресурса типа: service/apis
просьба	Сущность, содержащая сведения о запросе.	RequestContract
Ответы	Массив ответов операций.	ResultContract[]
templateParameters	Коллекция параметров шаблона URL-адреса.	ParameterContract[]
тип	Тип ресурса	"Microsoft.ApiManagement/service/apis/operations@2016-10-10"
urlTemplate	Относительный шаблон URL-адреса, определяющий целевой ресурс для этой операции. Может включать параметры. Пример: /customers/{cid}/orders/{oid}/?date={date}	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1000 (обязательно)

ПараметрContract

Имя	Описание	Ценность
значение по умолчанию	Значение параметра по умолчанию.	струна
описание	Описание параметра.	струна
имя	Имя параметра.	строка (обязательно)
Обязательно	является ли параметр обязательным или нет.	булевая переменная (bool)
тип	Тип параметра.	строка (обязательно)
Значения	Значения параметров.	строка[]

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

Имя	Описание	Ценность
Тип контента	Указывает зарегистрированный или пользовательский тип контента для этого представления, например application/xml.	строка (обязательно)
образец	Пример представления.	струна

RequestContract

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

ResultContract

Имя	Описание	Ценность
описание	Описание ответа операции.	струна
Представления	Коллекция представлений ответов операций.	ПредставлениеContract[]
statusCode	Код состояния HTTP ответа операции.	int Ограничения целостности: Минимальное значение = 100 Максимальное значение = 599 (обязательно)