Развертывание Microsoft.ResourcesStacks 2024-03-01

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

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

  • группы управления. См. статью команды развертывания группы управленияподписки . См. команды развертывания подпискегруппы ресурсов. См. команды развертывания группы ресурсов

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

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

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

resource symbolicname 'Microsoft.Resources/deploymentStacks@2024-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    actionOnUnmanage: {
      managementGroups: 'string'
      resourceGroups: 'string'
      resources: 'string'
    }
    bypassStackOutOfSyncError: bool
    debugSetting: {
      detailLevel: 'string'
    }
    denySettings: {
      applyToChildScopes: bool
      excludedActions: [
        'string'
      ]
      excludedPrincipals: [
        'string'
      ]
      mode: 'string'
    }
    deploymentScope: 'string'
    description: 'string'
    parameters: {
      {customized property}: {
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        type: 'string'
        value: any(...)
      }
    }
    parametersLink: {
      contentVersion: 'string'
      uri: 'string'
    }
    template: {
      {customized property}: any(...)
    }
    templateLink: {
      contentVersion: 'string'
      id: 'string'
      queryString: 'string'
      relativePath: 'string'
      uri: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Microsoft.Resources/deploymentStacks

Имя Описание Ценность
местоположение Географическое расположение, в котором находится ресурс. Требуется для стеков с областью действия подписки и группы управления. Расположение наследуется от группы ресурсов для стеков с областью действия группы ресурсов. струна
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 90
Pattern = ^[-\w\._\(\)]+$ (обязательно)
свойства Свойства стека развертывания. DeploymentStackProperties (Свойства стека)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ДействиеНаОтмене управления

Имя Описание Ценность
управлениеГруппы Задаёт действие для новой неуправляемой группы управления ресурсами. "Delete"
"отсоединение"
resourceGroups Задаёт действие для новой неуправляемой группы ресурсов. "Delete"
"отсоединение"
ресурсы Указывает действие для нового неуправляемого ресурса. "Delete"
"отсоединение" (обязательно)

ЗапретитьНастройки

Имя Описание Ценность
applyToChildScopes DenySettings будет применяться к дочерним областям ресурсов каждого управляемого ресурса с назначением запрета. булевая переменная (bool)
исключенныеДействия Список операций управления на основе ролей, исключенных из denySettings. Разрешено до 200 действий. Если для режима denySetting задано значение "denyWriteAndDelete", то следующие действия автоматически добавляются в "excludedActions": "*/read" и "Microsoft.Authorization/locks/delete". Если для режима denySetting задано значение "denyDelete", то следующие действия автоматически добавляются в "исключенныеactions": "Microsoft.Authorization/locks/delete". Повторяющиеся действия будут удалены. строка[]
исключенныеPrincipals Список идентификаторов субъектов AAD, исключенных из блокировки. Разрешено до 5 субъектов. строка[]
режим Режим denySettings, определяющий запрещенные действия. "denyDelete"
"denyWriteAndDelete"
"none" (обязательный)

Параметр развертывания

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

DeploymentStackProperties (Свойства стека)

Имя Описание Ценность
actionOnUnmanage Определяет поведение ресурсов, которые больше не управляются после обновления или удаления стека развертывания. ActionOnUnmanage (обязательно)
bypassStackOutOfSyncError Флаг для обхода ошибок службы, указывающих, что список ресурсов стека неправильно синхронизирован. булевая переменная (bool)
debugSetting Параметр отладки развертывания. DeploymentStacksDebugSetting (Настройка отладки)
denySettings Определяет, как ресурсы, развернутые стеком, блокируются. DenySettings (обязательно)
deploymentScope Область создания начального развертывания. Если область не указана, она по умолчанию будет использоваться в области стека развертывания. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroupId}), подписка (формат :/subscriptions/{subscriptionId}), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}). струна
описание Описание стека развертывания. Максимальная длина 4096 символов. струна

Ограничения целостности:
Максимальная длина = 4096
Параметры Пары имен и значений, определяющие параметры развертывания для шаблона. Используйте этот элемент при предоставлении значений параметров непосредственно в запросе, а не связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Параметры DeploymentStackProperties
параметрыСсылка Универсальный код ресурса (URI) файла параметров. Используйте этот элемент, чтобы связаться с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. DeploymentStacksParametersLink (РазмещениеStacksParametersLink)
шаблон Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба. Шаблон DeploymentStackProperties
шаблонСсылка Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба. DeploymentStacksTemplateLink

Параметры DeploymentStackProperties

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

Шаблон DeploymentStackProperties

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

DeploymentStacksDebugSetting (Настройка отладки)

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

DeploymentStackTags

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

Ссылка на параметр KeyVault

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

Справочник по KeyVault

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

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

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

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

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

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

{
  "type": "Microsoft.Resources/deploymentStacks",
  "apiVersion": "2024-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "actionOnUnmanage": {
      "managementGroups": "string",
      "resourceGroups": "string",
      "resources": "string"
    },
    "bypassStackOutOfSyncError": "bool",
    "debugSetting": {
      "detailLevel": "string"
    },
    "denySettings": {
      "applyToChildScopes": "bool",
      "excludedActions": [ "string" ],
      "excludedPrincipals": [ "string" ],
      "mode": "string"
    },
    "deploymentScope": "string",
    "description": "string",
    "parameters": {
      "{customized property}": {
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "type": "string",
        "value": {}
      }
    },
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {
      "{customized property}": {}
    },
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Microsoft.Resources/deploymentStacks

Имя Описание Ценность
apiVersion Версия API '2024-03-01'
местоположение Географическое расположение, в котором находится ресурс. Требуется для стеков с областью действия подписки и группы управления. Расположение наследуется от группы ресурсов для стеков с областью действия группы ресурсов. струна
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 90
Pattern = ^[-\w\._\(\)]+$ (обязательно)
свойства Свойства стека развертывания. DeploymentStackProperties (Свойства стека)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.Resources/deploymentStacks"

ДействиеНаОтмене управления

Имя Описание Ценность
управлениеГруппы Задаёт действие для новой неуправляемой группы управления ресурсами. "Delete"
"отсоединение"
resourceGroups Задаёт действие для новой неуправляемой группы ресурсов. "Delete"
"отсоединение"
ресурсы Указывает действие для нового неуправляемого ресурса. "Delete"
"отсоединение" (обязательно)

ЗапретитьНастройки

Имя Описание Ценность
applyToChildScopes DenySettings будет применяться к дочерним областям ресурсов каждого управляемого ресурса с назначением запрета. булевая переменная (bool)
исключенныеДействия Список операций управления на основе ролей, исключенных из denySettings. Разрешено до 200 действий. Если для режима denySetting задано значение "denyWriteAndDelete", то следующие действия автоматически добавляются в "excludedActions": "*/read" и "Microsoft.Authorization/locks/delete". Если для режима denySetting задано значение "denyDelete", то следующие действия автоматически добавляются в "исключенныеactions": "Microsoft.Authorization/locks/delete". Повторяющиеся действия будут удалены. строка[]
исключенныеPrincipals Список идентификаторов субъектов AAD, исключенных из блокировки. Разрешено до 5 субъектов. строка[]
режим Режим denySettings, определяющий запрещенные действия. "denyDelete"
"denyWriteAndDelete"
"none" (обязательный)

Параметр развертывания

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

DeploymentStackProperties (Свойства стека)

Имя Описание Ценность
actionOnUnmanage Определяет поведение ресурсов, которые больше не управляются после обновления или удаления стека развертывания. ActionOnUnmanage (обязательно)
bypassStackOutOfSyncError Флаг для обхода ошибок службы, указывающих, что список ресурсов стека неправильно синхронизирован. булевая переменная (bool)
debugSetting Параметр отладки развертывания. DeploymentStacksDebugSetting (Настройка отладки)
denySettings Определяет, как ресурсы, развернутые стеком, блокируются. DenySettings (обязательно)
deploymentScope Область создания начального развертывания. Если область не указана, она по умолчанию будет использоваться в области стека развертывания. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroupId}), подписка (формат :/subscriptions/{subscriptionId}), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}). струна
описание Описание стека развертывания. Максимальная длина 4096 символов. струна

Ограничения целостности:
Максимальная длина = 4096
Параметры Пары имен и значений, определяющие параметры развертывания для шаблона. Используйте этот элемент при предоставлении значений параметров непосредственно в запросе, а не связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Параметры DeploymentStackProperties
параметрыСсылка Универсальный код ресурса (URI) файла параметров. Используйте этот элемент, чтобы связаться с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. DeploymentStacksParametersLink (РазмещениеStacksParametersLink)
шаблон Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба. Шаблон DeploymentStackProperties
шаблонСсылка Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба. DeploymentStacksTemplateLink

Параметры DeploymentStackProperties

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

Шаблон DeploymentStackProperties

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

DeploymentStacksDebugSetting (Настройка отладки)

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

DeploymentStackTags

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

Ссылка на параметр KeyVault

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

Справочник по KeyVault

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

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

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

  • Управленческие группы* Подписка* Группы ресурсов Список изменённых свойств в каждой версии API см. журнал изменений.

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Resources/deploymentStacks@2024-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      actionOnUnmanage = {
        managementGroups = "string"
        resourceGroups = "string"
        resources = "string"
      }
      bypassStackOutOfSyncError = bool
      debugSetting = {
        detailLevel = "string"
      }
      denySettings = {
        applyToChildScopes = bool
        excludedActions = [
          "string"
        ]
        excludedPrincipals = [
          "string"
        ]
        mode = "string"
      }
      deploymentScope = "string"
      description = "string"
      parameters = {
        {customized property} = {
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          type = "string"
          value = ?
        }
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      template = {
        {customized property} = ?
      }
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
    }
  }
}

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

Microsoft.Resources/deploymentStacks

Имя Описание Ценность
местоположение Географическое расположение, в котором находится ресурс. Требуется для стеков с областью действия подписки и группы управления. Расположение наследуется от группы ресурсов для стеков с областью действия группы ресурсов. струна
имя Имя ресурса струна

Ограничения целостности:
Минимальная длина = 1
Максимальная длина = 90
Pattern = ^[-\w\._\(\)]+$ (обязательно)
свойства Свойства стека развертывания. DeploymentStackProperties (Свойства стека)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.Resources/deploymentStacks@2024-03-01"

ДействиеНаОтмене управления

Имя Описание Ценность
управлениеГруппы Задаёт действие для новой неуправляемой группы управления ресурсами. "Delete"
"отсоединение"
resourceGroups Задаёт действие для новой неуправляемой группы ресурсов. "Delete"
"отсоединение"
ресурсы Указывает действие для нового неуправляемого ресурса. "Delete"
"отсоединение" (обязательно)

ЗапретитьНастройки

Имя Описание Ценность
applyToChildScopes DenySettings будет применяться к дочерним областям ресурсов каждого управляемого ресурса с назначением запрета. булевая переменная (bool)
исключенныеДействия Список операций управления на основе ролей, исключенных из denySettings. Разрешено до 200 действий. Если для режима denySetting задано значение "denyWriteAndDelete", то следующие действия автоматически добавляются в "excludedActions": "*/read" и "Microsoft.Authorization/locks/delete". Если для режима denySetting задано значение "denyDelete", то следующие действия автоматически добавляются в "исключенныеactions": "Microsoft.Authorization/locks/delete". Повторяющиеся действия будут удалены. строка[]
исключенныеPrincipals Список идентификаторов субъектов AAD, исключенных из блокировки. Разрешено до 5 субъектов. строка[]
режим Режим denySettings, определяющий запрещенные действия. "denyDelete"
"denyWriteAndDelete"
"none" (обязательный)

Параметр развертывания

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

DeploymentStackProperties (Свойства стека)

Имя Описание Ценность
actionOnUnmanage Определяет поведение ресурсов, которые больше не управляются после обновления или удаления стека развертывания. ActionOnUnmanage (обязательно)
bypassStackOutOfSyncError Флаг для обхода ошибок службы, указывающих, что список ресурсов стека неправильно синхронизирован. булевая переменная (bool)
debugSetting Параметр отладки развертывания. DeploymentStacksDebugSetting (Настройка отладки)
denySettings Определяет, как ресурсы, развернутые стеком, блокируются. DenySettings (обязательно)
deploymentScope Область создания начального развертывания. Если область не указана, она по умолчанию будет использоваться в области стека развертывания. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroupId}), подписка (формат :/subscriptions/{subscriptionId}), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}). струна
описание Описание стека развертывания. Максимальная длина 4096 символов. струна

Ограничения целостности:
Максимальная длина = 4096
Параметры Пары имен и значений, определяющие параметры развертывания для шаблона. Используйте этот элемент при предоставлении значений параметров непосредственно в запросе, а не связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. Параметры DeploymentStackProperties
параметрыСсылка Универсальный код ресурса (URI) файла параметров. Используйте этот элемент, чтобы связаться с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба. DeploymentStacksParametersLink (РазмещениеStacksParametersLink)
шаблон Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба. Шаблон DeploymentStackProperties
шаблонСсылка Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба. DeploymentStacksTemplateLink

Параметры DeploymentStackProperties

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

Шаблон DeploymentStackProperties

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

DeploymentStacksDebugSetting (Настройка отладки)

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

DeploymentStackTags

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

Ссылка на параметр KeyVault

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

Справочник по KeyVault

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