Microsoft.ApiManagement service/workspaces/apiVersionSets 2023-03-01-preview
Определение ресурса Bicep
Тип ресурса service/workspaces/apiVersionSets можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apiVersionSets, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
displayName: 'string'
versionHeaderName: 'string'
versioningScheme: 'string'
versionQueryName: 'string'
}
}
Значения свойств
service/workspaces/apiVersionSets
| Имя | Описание | Значение |
|---|---|---|
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в Bicep. |
строка (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: workspaces |
| properties | API VersionSet, свойства контракта. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Имя | Описание | Значение |
|---|---|---|
| description | Описание набора версий API. | строка |
| displayName | Имя набора версий API | строка (обязательно) |
| versionHeaderName | Имя параметра заголовка HTTP, указывающего версию API, если versioningScheme имеет значение header. |
строка |
| versioningScheme | Значение , определяющее расположение идентификатора версии API в HTTP-запросе. | "Заголовок" "Запрос" Segment (обязательный) |
| versionQueryName | Имя параметра запроса, указывающего версию API, если versioningScheme имеет значение query. |
строка |
Определение ресурса шаблона ARM
Тип ресурса service/workspaces/apiVersionSets можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apiVersionSets, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.ApiManagement/service/workspaces/apiVersionSets",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"description": "string",
"displayName": "string",
"versionHeaderName": "string",
"versioningScheme": "string",
"versionQueryName": "string"
}
}
Значения свойств
service/workspaces/apiVersionSets
| Имя | Описание | Значение |
|---|---|---|
| тип | Тип ресурса | Microsoft.ApiManagement/service/workspaces/apiVersionSets |
| версия_API | Версия API ресурсов | '2023-03-01-preview' |
| name | имя ресурса. Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM. |
строка (обязательно) |
| properties | API VersionSet, свойства контракта. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Имя | Описание | Значение |
|---|---|---|
| description | Описание набора версий API. | строка |
| displayName | Имя набора версий API | строка (обязательно) |
| versionHeaderName | Имя параметра заголовка HTTP, указывающего версию API, если versioningScheme имеет значение header. |
строка |
| versioningScheme | Значение , определяющее расположение идентификатора версии API в HTTP-запросе. | "Заголовок" "Запрос" Segment (обязательный) |
| versionQueryName | Имя параметра запроса, указывающего версию API, если versioningScheme имеет значение query. |
строка |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса service/workspaces/apiVersionSets можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.ApiManagement/service/workspaces/apiVersionSets, добавьте в шаблон следующую terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apiVersionSets@2023-03-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-03-01-preview" |
| name | имя ресурса. | строка (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: workspaces |
| properties | API VersionSet, свойства контракта. | ApiVersionSetContractProperties |
ApiVersionSetContractProperties
| Имя | Описание | Значение |
|---|---|---|
| description | Описание набора версий API. | строка |
| displayName | Имя набора версий API | строка (обязательно) |
| versionHeaderName | Имя параметра заголовка HTTP, указывающего версию API, если versioningScheme имеет значение header. |
строка |
| versioningScheme | Значение , определяющее расположение идентификатора версии API в HTTP-запросе. | Заголовок "Запрос" "Segment" (обязательно) |
| versionQueryName | Имя параметра запроса, указывающего версию API, если versioningScheme имеет значение query. |
строка |