Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
Замечания
Для Bicep рекомендуется использовать модули вместо этого типа ресурсов.
Определение ресурсов Bicep
Тип ресурса развертывания можно развернуть с помощью операций, предназначенных для следующих операций:
- Tenant — см. команды развертывания арендаторов Группы* управления — См. команды* развертывания группыуправления Подписка — См. команды* развертыванияподписки Группы ресурсов — См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Resources/deployments, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.Resources/deployments@2020-08-01' = {
scope: resourceSymbolicName or scope
location: 'string'
name: 'string'
properties: {
debugSetting: {
detailLevel: 'string'
}
mode: 'string'
onErrorDeployment: {
deploymentName: 'string'
type: 'string'
}
parameters: any(...)
parametersLink: {
contentVersion: 'string'
uri: 'string'
}
template: any(...)
templateLink: {
contentVersion: 'string'
id: 'string'
relativePath: 'string'
uri: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
Microsoft.Resources/развертывания
| Имя | Описание | Ценность |
|---|---|---|
| расположение | Расположение для хранения данных развертывания. | струна |
| имя | имя ресурса. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 64 (обязательно) |
| свойства | Свойства развертывания. | DeploymentPropertiesOrDeploymentPropertiesExtended (обязательно) |
| охват | Используется при создании ресурса в области, отличной от области развертывания. | Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения. |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
Настройка отладки
| Имя | Описание | Ценность |
|---|---|---|
| Уровень детализации | Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания. | струна |
DeploymentPropertiesOrDeploymentPropertiesExtended
| Имя | Описание | Ценность |
|---|---|---|
| debugSetting | Параметр отладки развертывания. | Настройка отладки |
| режим | Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы. | "Завершено" "Добавочный" (обязательный) |
| onErrorDeployment | Развертывание по поведению ошибок. | OnErrorDeploymentOrOnErrorDeploymentExtended |
| Параметры | Пары имен и значений, определяющие параметры развертывания для шаблона. Этот элемент используется для предоставления значений параметров непосредственно в запросе, а не ссылки на существующий файл параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Это может быть JObject или хорошо сформированная строка JSON. | любой |
| параметрыСсылка | Универсальный код ресурса (URI) файла параметров. Этот элемент используется для связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. | ПараметрыСсылка |
| шаблон | Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба. | любой |
| шаблонСсылка | Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба. | Ссылка на шаблон |
DeploymentTags
| Имя | Описание | Ценность |
|---|
OnErrorDeploymentOrOnErrorDeploymentExtended
| Имя | Описание | Ценность |
|---|---|---|
| имя_развертывания | Развертывание, используемое в случае ошибки. | струна |
| тип | Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment. | "LastSuccessful" "SpecificDeployment" |
ПараметрыСсылка
| Имя | Описание | Ценность |
|---|---|---|
| версия содержимого | Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. | струна |
| УРИ | URI файла параметров. | строка (обязательно) |
Ссылка на шаблон
| Имя | Описание | Ценность |
|---|---|---|
| версия содержимого | Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. | струна |
| идентификатор | Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба. | струна |
| relativePath | Применимо только в том случае, если эта ссылка на шаблон ссылается на спецификацию шаблона. Это свойство relativePath можно дополнительно использовать для ссылки на артефакт Template Spec по пути. | струна |
| УРИ | Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба. | струна |
Определение ресурса шаблона ARM
Тип ресурса развертывания можно развернуть с помощью операций, предназначенных для следующих операций:
- Tenant — см. команды развертывания арендаторов Группы* управления — См. команды* развертывания группыуправления Подписка — См. команды* развертыванияподписки Группы ресурсов — См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Resources/deployments, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.Resources/deployments",
"apiVersion": "2020-08-01",
"name": "string",
"location": "string",
"properties": {
"debugSetting": {
"detailLevel": "string"
},
"mode": "string",
"onErrorDeployment": {
"deploymentName": "string",
"type": "string"
},
"parameters": {},
"parametersLink": {
"contentVersion": "string",
"uri": "string"
},
"template": {},
"templateLink": {
"contentVersion": "string",
"id": "string",
"relativePath": "string",
"uri": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
Microsoft.Resources/развертывания
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2020-08-01' |
| расположение | Расположение для хранения данных развертывания. | струна |
| имя | имя ресурса. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 64 (обязательно) |
| свойства | Свойства развертывания. | DeploymentPropertiesOrDeploymentPropertiesExtended (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.Resources/deployments" |
Настройка отладки
| Имя | Описание | Ценность |
|---|---|---|
| Уровень детализации | Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания. | струна |
DeploymentPropertiesOrDeploymentPropertiesExtended
| Имя | Описание | Ценность |
|---|---|---|
| debugSetting | Параметр отладки развертывания. | Настройка отладки |
| режим | Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы. | "Завершено" "Добавочный" (обязательный) |
| onErrorDeployment | Развертывание по поведению ошибок. | OnErrorDeploymentOrOnErrorDeploymentExtended |
| Параметры | Пары имен и значений, определяющие параметры развертывания для шаблона. Этот элемент используется для предоставления значений параметров непосредственно в запросе, а не ссылки на существующий файл параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Это может быть JObject или хорошо сформированная строка JSON. | любой |
| параметрыСсылка | Универсальный код ресурса (URI) файла параметров. Этот элемент используется для связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. | ПараметрыСсылка |
| шаблон | Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба. | любой |
| шаблонСсылка | Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба. | Ссылка на шаблон |
DeploymentTags
| Имя | Описание | Ценность |
|---|
OnErrorDeploymentOrOnErrorDeploymentExtended
| Имя | Описание | Ценность |
|---|---|---|
| имя_развертывания | Развертывание, используемое в случае ошибки. | струна |
| тип | Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment. | "LastSuccessful" "SpecificDeployment" |
ПараметрыСсылка
| Имя | Описание | Ценность |
|---|---|---|
| версия содержимого | Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. | струна |
| УРИ | URI файла параметров. | строка (обязательно) |
Ссылка на шаблон
| Имя | Описание | Ценность |
|---|---|---|
| версия содержимого | Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. | струна |
| идентификатор | Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба. | струна |
| relativePath | Применимо только в том случае, если эта ссылка на шаблон ссылается на спецификацию шаблона. Это свойство relativePath можно дополнительно использовать для ссылки на артефакт Template Spec по пути. | струна |
| УРИ | Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба. | струна |
Примеры использования
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса развертывания можно развернуть с помощью операций, предназначенных для следующих операций:
- Арендатор* Управленческие группы* Подписка* Группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.Resources/deployments, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Resources/deployments@2020-08-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
debugSetting = {
detailLevel = "string"
}
mode = "string"
onErrorDeployment = {
deploymentName = "string"
type = "string"
}
parameters = ?
parametersLink = {
contentVersion = "string"
uri = "string"
}
template = ?
templateLink = {
contentVersion = "string"
id = "string"
relativePath = "string"
uri = "string"
}
}
}
}
Значения свойств
Microsoft.Resources/развертывания
| Имя | Описание | Ценность |
|---|---|---|
| расположение | Расположение для хранения данных развертывания. | струна |
| имя | имя ресурса. | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 64 (обязательно) |
| идентификатор_родителя | Идентификатор ресурса для применения этого ресурса расширения. | строка (обязательно) |
| свойства | Свойства развертывания. | DeploymentPropertiesOrDeploymentPropertiesExtended (обязательно) |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.Resources/deployments@2020-08-01" |
Настройка отладки
| Имя | Описание | Ценность |
|---|---|---|
| Уровень детализации | Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания. | струна |
DeploymentPropertiesOrDeploymentPropertiesExtended
| Имя | Описание | Ценность |
|---|---|---|
| debugSetting | Параметр отладки развертывания. | Настройка отладки |
| режим | Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы. | "Завершено" "Добавочный" (обязательный) |
| onErrorDeployment | Развертывание по поведению ошибок. | OnErrorDeploymentOrOnErrorDeploymentExtended |
| Параметры | Пары имен и значений, определяющие параметры развертывания для шаблона. Этот элемент используется для предоставления значений параметров непосредственно в запросе, а не ссылки на существующий файл параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Это может быть JObject или хорошо сформированная строка JSON. | любой |
| параметрыСсылка | Универсальный код ресурса (URI) файла параметров. Этот элемент используется для связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. | ПараметрыСсылка |
| шаблон | Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба. | любой |
| шаблонСсылка | Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба. | Ссылка на шаблон |
DeploymentTags
| Имя | Описание | Ценность |
|---|
OnErrorDeploymentOrOnErrorDeploymentExtended
| Имя | Описание | Ценность |
|---|---|---|
| имя_развертывания | Развертывание, используемое в случае ошибки. | струна |
| тип | Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment. | "LastSuccessful" "SpecificDeployment" |
ПараметрыСсылка
| Имя | Описание | Ценность |
|---|---|---|
| версия содержимого | Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. | струна |
| УРИ | URI файла параметров. | строка (обязательно) |
Ссылка на шаблон
| Имя | Описание | Ценность |
|---|---|---|
| версия содержимого | Если этот параметр включен, должен соответствовать ContentVersion в шаблоне. | струна |
| идентификатор | Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба. | струна |
| relativePath | Применимо только в том случае, если эта ссылка на шаблон ссылается на спецификацию шаблона. Это свойство relativePath можно дополнительно использовать для ссылки на артефакт Template Spec по пути. | струна |
| УРИ | Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба. | струна |
Примеры использования
Примеры Terraform
Простой пример развертывания Template Deployment.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "deployment" {
type = "Microsoft.Resources/deployments@2020-06-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
body = {
properties = {
mode = "Complete"
template = {
"$schema" = "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#"
contentVersion = "1.0.0.0"
parameters = {
storageAccountType = {
allowedValues = [
"Standard_LRS",
"Standard_GRS",
"Standard_ZRS",
]
defaultValue = "Standard_LRS"
metadata = {
description = "Storage Account type"
}
type = "string"
}
}
resources = [
{
apiVersion = "[variables('apiVersion')]"
location = "[variables('location')]"
name = "[variables('storageAccountName')]"
properties = {
accountType = "[parameters('storageAccountType')]"
}
type = "Microsoft.Storage/storageAccounts"
},
{
apiVersion = "[variables('apiVersion')]"
location = "[variables('location')]"
name = "[variables('publicIPAddressName')]"
properties = {
dnsSettings = {
domainNameLabel = "[variables('dnsLabelPrefix')]"
}
publicIPAllocationMethod = "[variables('publicIPAddressType')]"
}
type = "Microsoft.Network/publicIPAddresses"
},
]
variables = {
apiVersion = "2015-06-15"
dnsLabelPrefix = "[concat('terraform-tdacctest', uniquestring(resourceGroup().id))]"
location = "[resourceGroup().location]"
publicIPAddressName = "[concat('myPublicIp', uniquestring(resourceGroup().id))]"
publicIPAddressType = "Dynamic"
storageAccountName = "[concat(uniquestring(resourceGroup().id), 'storage')]"
}
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}