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


Служба Microsoft.ApiManagement/workspaces/apiVersionSets 2023-09-01-preview

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

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

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

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

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    displayName: 'string'
    versionHeaderName: 'string'
    versioningScheme: 'string'
    versionQueryName: 'string'
  }
}

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

service/workspaces/apiVersionSets

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

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

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

ApiVersionSetContractProperties

Имя Описание Ценность
описание Описание набора версий API. струна
displayName Имя набора версий API строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
versionHeaderName Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
versioningScheme Значение, определяющее расположение идентификатора версии API в HTTP-запросе. "Заголовок"
"Запрос"
"Сегмент" (обязательный)
versionQueryName Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. струна

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

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

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

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

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

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

{
  "type": "Microsoft.ApiManagement/service/workspaces/apiVersionSets",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "displayName": "string",
    "versionHeaderName": "string",
    "versioningScheme": "string",
    "versionQueryName": "string"
  }
}

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

service/workspaces/apiVersionSets

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

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

ApiVersionSetContractProperties

Имя Описание Ценность
описание Описание набора версий API. струна
displayName Имя набора версий API строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
versionHeaderName Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
versioningScheme Значение, определяющее расположение идентификатора версии API в HTTP-запросе. "Заголовок"
"Запрос"
"Сегмент" (обязательный)
versionQueryName Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. струна

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

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      displayName = "string"
      versionHeaderName = "string"
      versioningScheme = "string"
      versionQueryName = "string"
    }
  })
}

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

service/workspaces/apiVersionSets

Имя Описание Ценность
тип Тип ресурса "Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-09-01-preview"
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: рабочих областей
свойства Свойства контракта API VersionSet. ApiVersionSetContractProperties

ApiVersionSetContractProperties

Имя Описание Ценность
описание Описание набора версий API. струна
displayName Имя набора версий API строка (обязательно)

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
versionHeaderName Имя параметра заголовка HTTP, указывающего версию API, если для versioningScheme задано значение header. струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 100
versioningScheme Значение, определяющее расположение идентификатора версии API в HTTP-запросе. "Заголовок"
"Запрос"
"Сегмент" (обязательный)
versionQueryName Имя параметра запроса, указывающего версию API, если для versioningScheme задано значение query. струна

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