Развертывания Microsoft.Resources

Статья
12/17/2024

Замечания

Для Bicep рекомендуется использовать модули вместо этого типа ресурса.

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

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

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

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

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

resource symbolicname 'Microsoft.Resources/deployments@2024-11-01' = {
  scope: resourceSymbolicName or scope
  location: 'string'
  name: 'string'
  properties: {
    debugSetting: {
      detailLevel: 'string'
    }
    expressionEvaluationOptions: {
      scope: 'string'
    }
    mode: 'string'
    onErrorDeployment: {
      deploymentName: 'string'
      type: 'string'
    }
    parameters: {
      {customized property}: {
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        value: any(Azure.Bicep.Types.Concrete.AnyType)
      }
    }
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: any(Azure.Bicep.Types.Concrete.AnyType)
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
    validationLevel: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

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

DebugSetting

Имя	Описание	Ценность
detailLevel	Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания.	струна

DeploymentParameter

Имя	Описание	Ценность
ссылка	Справочник по параметру Azure Key Vault.	KeyVaultParameterReference
ценность	Входное значение параметра.	любой

DeploymentPropertiesOrDeploymentPropertiesExtended

Имя	Описание	Ценность
debugSetting	Параметр отладки развертывания.	DebugSetting
expressionEvaluationOptions	Указывает, вычисляются ли выражения шаблонов в пределах области родительского шаблона или вложенного шаблона. Применимо только к вложенным шаблонам. Если значение не указано, значение по умолчанию является внешним.	ExpressionEvaluationOptions
режим	Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.	"Завершено" "Добавочный" (обязательный)
onErrorDeployment	Развертывание по поведению ошибок.	OnErrorDeploymentOrOnErrorDeploymentExtended
Параметры	Пары имен и значений, определяющие параметры развертывания для шаблона. Этот элемент используется для предоставления значений параметров непосредственно в запросе, а не ссылки на существующий файл параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Это может быть JObject или хорошо сформированная строка JSON.	DeploymentPropertiesParameters
parametersLink	Универсальный код ресурса (URI) файла параметров. Этот элемент используется для связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба.	ParametersLink
шаблон	Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба.	любой
templateLink	Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба.	TemplateLink
validationLevel	Уровень проверки развертывания	"Поставщик" "ProviderNoRbac" "Шаблон"

DeploymentPropertiesParameters

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

DeploymentTags

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

ExpressionEvaluationOptions

Имя	Описание	Ценность
размах	Область, используемая для оценки параметров, переменных и функций в вложенном шаблоне.	"Внутренний" "NotSpecified" "Внешний"

KeyVaultParameterReference

Имя	Описание	Ценность
keyVault	Справочник по Azure Key Vault.	KeyVaultReference (обязательно)
secretName	Имя секрета Azure Key Vault.	строка (обязательно)
secretVersion	Версия секрета Azure Key Vault.	струна

KeyVaultReference

Имя	Описание	Ценность
идентификатор	Идентификатор ресурса Azure Key Vault.	строка (обязательно)

Microsoft.Resources/deployments

Имя	Описание	Ценность
местоположение	Расположение для хранения данных развертывания.	струна
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = `^[-\w\._]+$` (обязательно)
свойства	Свойства развертывания.	DeploymentPropertiesOrDeploymentPropertiesExtended (обязательно)
размах	Используется при создании ресурса в области, отличной от области развертывания.	Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения.
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах

OnErrorDeploymentOrOnErrorDeploymentExtended

Имя	Описание	Ценность
deploymentName	Развертывание, используемое в случае ошибки.	струна
тип	Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.	"LastSuccessful" "SpecificDeployment"

ParametersLink

Имя	Описание	Ценность
contentVersion	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.	струна
ури	URI файла параметров.	строка (обязательно)

TemplateLink

Имя	Описание	Ценность
contentVersion	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.	струна
идентификатор	Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба.	струна
queryString	Строка запроса (например, маркер SAS), используемая с универсальным кодом ресурса (URI) templateLink.	струна
relativePath	Свойство relativePath можно использовать для развертывания связанного шаблона в расположении относительно родительского элемента. Если родительский шаблон связан с TemplateSpec, это будет ссылаться на артефакт в TemplateSpec. Если родительский объект связан с универсальным кодом ресурса (URI), дочернее развертывание будет сочетанием родительских и относительных URIPath.	струна
ури	Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба.	струна

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

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

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

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

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

{
  "type": "Microsoft.Resources/deployments",
  "apiVersion": "2024-11-01",
  "name": "string",
  "location": "string",
  "properties": {
    "debugSetting": {
      "detailLevel": "string"
    },
    "expressionEvaluationOptions": {
      "scope": "string"
    },
    "mode": "string",
    "onErrorDeployment": {
      "deploymentName": "string",
      "type": "string"
    },
    "parameters": {
      "{customized property}": {
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "value": {}
      }
    },
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    },
    "validationLevel": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

DebugSetting

Имя	Описание	Ценность
detailLevel	Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания.	струна

DeploymentParameter

Имя	Описание	Ценность
ссылка	Справочник по параметру Azure Key Vault.	KeyVaultParameterReference
ценность	Входное значение параметра.	любой

DeploymentPropertiesOrDeploymentPropertiesExtended

Имя	Описание	Ценность
debugSetting	Параметр отладки развертывания.	DebugSetting
expressionEvaluationOptions	Указывает, вычисляются ли выражения шаблонов в пределах области родительского шаблона или вложенного шаблона. Применимо только к вложенным шаблонам. Если значение не указано, значение по умолчанию является внешним.	ExpressionEvaluationOptions
режим	Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.	"Завершено" "Добавочный" (обязательный)
onErrorDeployment	Развертывание по поведению ошибок.	OnErrorDeploymentOrOnErrorDeploymentExtended
Параметры	Пары имен и значений, определяющие параметры развертывания для шаблона. Этот элемент используется для предоставления значений параметров непосредственно в запросе, а не ссылки на существующий файл параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Это может быть JObject или хорошо сформированная строка JSON.	DeploymentPropertiesParameters
parametersLink	Универсальный код ресурса (URI) файла параметров. Этот элемент используется для связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба.	ParametersLink
шаблон	Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба.	любой
templateLink	Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба.	TemplateLink
validationLevel	Уровень проверки развертывания	"Поставщик" "ProviderNoRbac" "Шаблон"

DeploymentPropertiesParameters

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

DeploymentTags

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

ExpressionEvaluationOptions

Имя	Описание	Ценность
размах	Область, используемая для оценки параметров, переменных и функций в вложенном шаблоне.	"Внутренний" "NotSpecified" "Внешний"

KeyVaultParameterReference

Имя	Описание	Ценность
keyVault	Справочник по Azure Key Vault.	KeyVaultReference (обязательно)
secretName	Имя секрета Azure Key Vault.	строка (обязательно)
secretVersion	Версия секрета Azure Key Vault.	струна

KeyVaultReference

Имя	Описание	Ценность
идентификатор	Идентификатор ресурса Azure Key Vault.	строка (обязательно)

Microsoft.Resources/deployments

Имя	Описание	Ценность
apiVersion	Версия API	'2024-11-01'
местоположение	Расположение для хранения данных развертывания.	струна
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = `^[-\w\._]+$` (обязательно)
свойства	Свойства развертывания.	DeploymentPropertiesOrDeploymentPropertiesExtended (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов. См. теги в шаблонах
тип	Тип ресурса	"Microsoft.Resources/deployments"

OnErrorDeploymentOrOnErrorDeploymentExtended

Имя	Описание	Ценность
deploymentName	Развертывание, используемое в случае ошибки.	струна
тип	Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.	"LastSuccessful" "SpecificDeployment"

ParametersLink

Имя	Описание	Ценность
contentVersion	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.	струна
ури	URI файла параметров.	строка (обязательно)

TemplateLink

Имя	Описание	Ценность
contentVersion	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.	струна
идентификатор	Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба.	струна
queryString	Строка запроса (например, маркер SAS), используемая с универсальным кодом ресурса (URI) templateLink.	струна
relativePath	Свойство relativePath можно использовать для развертывания связанного шаблона в расположении относительно родительского элемента. Если родительский шаблон связан с TemplateSpec, это будет ссылаться на артефакт в TemplateSpec. Если родительский объект связан с универсальным кодом ресурса (URI), дочернее развертывание будет сочетанием родительских и относительных URIPath.	струна
ури	Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба.	струна

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deployments@2024-11-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      debugSetting = {
        detailLevel = "string"
      }
      expressionEvaluationOptions = {
        scope = "string"
      }
      mode = "string"
      onErrorDeployment = {
        deploymentName = "string"
        type = "string"
      }
      parameters = {
        {customized property} = {
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          value = ?
        }
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = ?
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
      validationLevel = "string"
    }
  })
}

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

DebugSetting

Имя	Описание	Ценность
detailLevel	Указывает тип сведений для входа в журнал для отладки. Допустимые значения не имеют значения, requestContent, responseContent или requestContent и responseContent, разделенные запятой. Значение по умолчанию — нет. При настройке этого значения внимательно рассмотрите тип информации, которую вы передаете во время развертывания. Ведение журнала сведений о запросе или ответе может потенциально предоставлять конфиденциальные данные, полученные с помощью операций развертывания.	струна

DeploymentParameter

Имя	Описание	Ценность
ссылка	Справочник по параметру Azure Key Vault.	KeyVaultParameterReference
ценность	Входное значение параметра.	любой

DeploymentPropertiesOrDeploymentPropertiesExtended

Имя	Описание	Ценность
debugSetting	Параметр отладки развертывания.	DebugSetting
expressionEvaluationOptions	Указывает, вычисляются ли выражения шаблонов в пределах области родительского шаблона или вложенного шаблона. Применимо только к вложенным шаблонам. Если значение не указано, значение по умолчанию является внешним.	ExpressionEvaluationOptions
режим	Режим, используемый для развертывания ресурсов. Это значение может быть добавочным или завершенным. В добавочном режиме ресурсы развертываются без удаления существующих ресурсов, не включенных в шаблон. В полном режиме ресурсы развертываются и существующие ресурсы в группе ресурсов, не включенные в шаблон, удаляются. Будьте осторожны при использовании режима завершения, так как вы можете непреднамеренно удалить ресурсы.	"Завершено" "Добавочный" (обязательный)
onErrorDeployment	Развертывание по поведению ошибок.	OnErrorDeploymentOrOnErrorDeploymentExtended
Параметры	Пары имен и значений, определяющие параметры развертывания для шаблона. Этот элемент используется для предоставления значений параметров непосредственно в запросе, а не ссылки на существующий файл параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Это может быть JObject или хорошо сформированная строка JSON.	DeploymentPropertiesParameters
parametersLink	Универсальный код ресурса (URI) файла параметров. Этот элемент используется для связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба.	ParametersLink
шаблон	Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба.	любой
templateLink	Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба.	TemplateLink
validationLevel	Уровень проверки развертывания	"Поставщик" "ProviderNoRbac" "Шаблон"

DeploymentPropertiesParameters

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

DeploymentTags

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

ExpressionEvaluationOptions

Имя	Описание	Ценность
размах	Область, используемая для оценки параметров, переменных и функций в вложенном шаблоне.	"Внутренний" "NotSpecified" "Внешний"

KeyVaultParameterReference

Имя	Описание	Ценность
keyVault	Справочник по Azure Key Vault.	KeyVaultReference (обязательно)
secretName	Имя секрета Azure Key Vault.	строка (обязательно)
secretVersion	Версия секрета Azure Key Vault.	струна

KeyVaultReference

Имя	Описание	Ценность
идентификатор	Идентификатор ресурса Azure Key Vault.	строка (обязательно)

Microsoft.Resources/deployments

Имя	Описание	Ценность
местоположение	Расположение для хранения данных развертывания.	струна
имя	Имя ресурса	струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = `^[-\w\._]+$` (обязательно)
parent_id	Идентификатор ресурса для применения этого ресурса расширения.	строка (обязательно)
свойства	Свойства развертывания.	DeploymentPropertiesOrDeploymentPropertiesExtended (обязательно)
Теги	Теги ресурсов	Словарь имен и значений тегов.
тип	Тип ресурса	"Microsoft.Resources/deployments@2024-11-01"

OnErrorDeploymentOrOnErrorDeploymentExtended

Имя	Описание	Ценность
deploymentName	Развертывание, используемое в случае ошибки.	струна
тип	Развертывание по типу поведения ошибки. Возможные значения: LastSuccessful и SpecificDeployment.	"LastSuccessful" "SpecificDeployment"

ParametersLink

Имя	Описание	Ценность
contentVersion	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.	струна
ури	URI файла параметров.	строка (обязательно)

TemplateLink

Имя	Описание	Ценность
contentVersion	Если этот параметр включен, должен соответствовать ContentVersion в шаблоне.	струна
идентификатор	Идентификатор ресурса спецификации шаблона. Используйте свойство идентификатора или URI, но не оба.	струна
queryString	Строка запроса (например, маркер SAS), используемая с универсальным кодом ресурса (URI) templateLink.	струна
relativePath	Свойство relativePath можно использовать для развертывания связанного шаблона в расположении относительно родительского элемента. Если родительский шаблон связан с TemplateSpec, это будет ссылаться на артефакт в TemplateSpec. Если родительский объект связан с универсальным кодом ресурса (URI), дочернее развертывание будет сочетанием родительских и относительных URIPath.	струна
ури	Универсальный код ресурса (URI) шаблона для развертывания. Используйте URI или свойство id, но не оба.	струна

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

Развертывания Microsoft.Resources

Замечания

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

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

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

DebugSetting

DeploymentParameter

DeploymentPropertiesOrDeploymentPropertiesExtended

DeploymentPropertiesParameters

DeploymentTags

ExpressionEvaluationOptions

KeyVaultParameterReference

KeyVaultReference

Microsoft.Resources/deployments

OnErrorDeploymentOrOnErrorDeploymentExtended

ParametersLink

TemplateLink

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

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

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

DebugSetting

DeploymentParameter

DeploymentPropertiesOrDeploymentPropertiesExtended

DeploymentPropertiesParameters

DeploymentTags

ExpressionEvaluationOptions

KeyVaultParameterReference

KeyVaultReference

Microsoft.Resources/deployments

OnErrorDeploymentOrOnErrorDeploymentExtended

ParametersLink

TemplateLink

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

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

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

DebugSetting

DeploymentParameter

DeploymentPropertiesOrDeploymentPropertiesExtended

DeploymentPropertiesParameters

DeploymentTags

ExpressionEvaluationOptions

KeyVaultParameterReference

KeyVaultReference

Microsoft.Resources/deployments

OnErrorDeploymentOrOnErrorDeploymentExtended

ParametersLink

TemplateLink

Обратная связь

Дополнительные ресурсы