Deployment Stacks - List At Management Group

Служба:: Resource Management

Версия API:: 2022-08-01-preview

Выводит список стеков развертывания в указанной области.

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Resources/deploymentStacks?api-version=2022-08-01-preview

Параметры URI

Имя	В	Обязательно	Тип	Описание
managementGroupId	path	True	string minLength: 1	Идентификатор группы управления.
api-version	query	True	string minLength: 1	Версия API, используемая для этой операции.

Ответы

Имя	Тип	Описание
200 OK	DeploymentStackListResult	Операция Azure успешно завершена.
Other Status Codes	ErrorResponse	Непредвиденное сообщение об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

List management group Deployment stacks

Образец запроса

HTTP

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/deploymentStacks?api-version=2022-08-01-preview

Пример ответа

Код состояния:: 200

{
  "value": [
    {
      "id": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/deploymentStacks/simpleDeploymentStack",
      "type": "Microsoft.Resources/deploymentStacks",
      "name": "simpleDeploymentStack",
      "location": "eastus",
      "tags": {
        "tagkey": "tagVal"
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "Application",
        "createdAt": "2020-02-01T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
      },
      "properties": {
        "actionOnUnmanage": {
          "resources": "delete",
          "resourceGroups": "delete",
          "managementGroups": "detach"
        },
        "denySettings": {
          "mode": "denyDelete",
          "excludedPrincipals": [
            "principal"
          ],
          "excludedActions": [
            "action"
          ],
          "applyToChildScopes": false
        },
        "parameters": {
          "parameter1": {
            "value": "a string"
          }
        },
        "outputs": {
          "myOut": "myVal"
        },
        "duration": "PT1D12H"
      }
    },
    {
      "id": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/deploymentStacks/simpleDeploymentStack2",
      "type": "Microsoft.Resources/deploymentStacks",
      "name": "simpleDeploymentStack2",
      "location": "eastus",
      "tags": {
        "tagkey": "tagVal"
      },
      "systemData": {
        "createdBy": "string",
        "createdByType": "Application",
        "createdAt": "2020-02-01T01:01:01.1075056Z",
        "lastModifiedBy": "string",
        "lastModifiedByType": "Application",
        "lastModifiedAt": "2020-02-02T02:03:01.1974346Z"
      },
      "properties": {
        "deploymentId": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/deployments/simpleDeploymentStack2-20210301-3f41c",
        "provisioningState": "SucceededWithFailures",
        "resources": [
          {
            "id": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Resources/templateSpecs/templateSpec/versions/1.0",
            "status": "managed",
            "denyStatus": "denyDelete"
          },
          {
            "id": "/providers/Microsoft.Management/managementGroups/myMg/providers/Microsoft.Storage/storageAccounts/myStorageAccount",
            "status": "managed",
            "denyStatus": "denyDelete"
          }
        ],
        "actionOnUnmanage": {
          "resources": "delete",
          "resourceGroups": "delete",
          "managementGroups": "detach"
        },
        "denySettings": {
          "mode": "denyDelete",
          "excludedPrincipals": [
            "principal"
          ],
          "excludedActions": [
            "action"
          ],
          "applyToChildScopes": false
        },
        "parameters": {
          "parameter1": {
            "value": "a string"
          }
        },
        "outputs": {
          "myOut": "myVal"
        },
        "duration": "PT1D12H"
      }
    }
  ]
}

Определения

Имя	Описание
ActionOnUnmanage	Определяет поведение ресурсов, которые больше не управляются после обновления или удаления стека.
createdByType	Тип удостоверения, создавшего ресурс.
DenySettings	Определяет, как блокируются ресурсы, развернутые стеком развертывания.
DenySettingsMode	denySettings Режим, определяющий запрещенные действия.
DenyStatusMode	Параметры denyAssignment, примененные к ресурсу.
DeploymentParameter	Параметр развертывания для шаблона.
DeploymentStack	Объект стека развертывания.
DeploymentStackListResult	Ответ операции со списком DeploymentStack.
DeploymentStackProvisioningState	Состояние стека развертывания.
DeploymentStacksDebugSetting	Параметр отладки.
DeploymentStacksParametersLink	Сущность, представляющая ссылку на параметры развертывания.
DeploymentStacksTemplateLink	Сущность, представляющая ссылку на шаблон.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Ответ на ошибку
KeyVaultParameterReference	Справочник по параметрам Azure Key Vault.
KeyVaultReference	Справочник по Azure Key Vault.
ManagedResourceReference	Модель управляемых ресурсов.
ResourceReference	Модель resourceId.
ResourceReferenceExtended	Расширенная модель resourceId. Это используется для документирования сбойных ресурсов с помощью resourceId и соответствующей ошибки.
ResourceStatusMode	Текущее состояние управления ресурсом в стеке развертывания.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UnmanageActionManagementGroupMode	Указывает действие для нового неуправляемого ресурса.
UnmanageActionResourceGroupMode	Задаёт действие для новой неуправляемой группы ресурсов.
UnmanageActionResourceMode	Указывает действие для нового неуправляемого ресурса.

ActionOnUnmanage

Объект

Определяет поведение ресурсов, которые больше не управляются после обновления или удаления стека.

Имя	Тип	Описание
managementGroups	UnmanageActionManagementGroupMode	Задаёт действие для новой неуправляемой группы управления ресурсами.
resourceGroups	UnmanageActionResourceGroupMode	Задаёт действие для новой неуправляемой группы ресурсов.
resources	UnmanageActionResourceMode	Указывает действие для нового неуправляемого ресурса.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DenySettings

Объект

Определяет, как блокируются ресурсы, развернутые стеком развертывания.

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

DenySettingsMode

Перечисление

denySettings Режим, определяющий запрещенные действия.

Значение	Описание
denyDelete	Авторизованные пользователи могут читать и изменять ресурсы, но не могут удаляться.
denyWriteAndDelete	Авторизованные пользователи могут читать данные с ресурса, но не могут изменять или удалять его.
none	Запреты не применяются.

DenyStatusMode

Перечисление

Параметры denyAssignment, примененные к ресурсу.

Значение	Описание
denyDelete	Авторизованные пользователи могут читать и изменять ресурсы, но не могут удаляться.
notSupported	Тип ресурса не поддерживает denyAssignments.
inapplicable	denyAssignments не поддерживаются в ресурсах за пределами области стека развертывания.
denyWriteAndDelete	Авторизованные пользователи могут читать только из ресурса, но не могут изменять или удалять их.
removedBySystem	Отклонение назначения было удалено Azure из-за изменения управления ресурсами (перемещение группы управления и т. д.)
none	Запреты не применяются.

DeploymentParameter

Объект

Параметр развертывания для шаблона.

Имя	Тип	Описание
reference	KeyVaultParameterReference	Справочник по параметрам Azure Key Vault.
type	string	Тип значения.
value		Входное значение параметра.

DeploymentStack

Объект

Объект стека развертывания.

Имя	Тип	Описание
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Геолокация, в которой находится ресурс. Требуется для стеков с областью действия подписки и группы управления. Расположение наследуется от группы ресурсов для стеков с областью действия группы ресурсов.
name	string	Имя ресурса
properties.actionOnUnmanage	ActionOnUnmanage	Определяет поведение ресурсов, которые больше не управляются после обновления или удаления стека развертывания.
properties.debugSetting	DeploymentStacksDebugSetting	Параметр отладки развертывания.
properties.deletedResources	ResourceReference[]	Массив ресурсов, которые были удалены во время последнего обновления стека развертывания. Удаленный означает, что ресурс был удален из шаблона и были указаны соответствующие операции удаления.
properties.denySettings	DenySettings	Определяет, как ресурсы, развернутые стеком, блокируются.
properties.deploymentId	string	Идентификатор ресурса развертывания, созданного стеком развертывания.
properties.deploymentScope	string	Область создания начального развертывания. Если область не указана, она по умолчанию будет использоваться в области стека развертывания. Допустимые области: группа управления (формат :/providers/Microsoft.Management/managementGroups/{managementGroupId}), подписка (формат :/subscriptions/{subscriptionId}), группа ресурсов (формат :/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}).
properties.description	string maxLength: 4096	Описание стека развертывания. Максимальная длина 4096 символов.
properties.detachedResources	ResourceReference[]	Массив ресурсов, которые были отсоединены во время последнего обновления стека развертывания. Отсоединенный означает, что ресурс был удален из шаблона, но не были указаны соответствующие операции удаления. Таким образом, ресурс все еще существует, но больше не связан со стеком.
properties.duration	string	Продолжительность последнего успешного обновления стека развертывания.
properties.error	ErrorDetail	Сведения об ошибке.
properties.failedResources	ResourceReferenceExtended[]	Массив ресурсов, которые не смогли достичь состояния цели во время последнего обновления. Каждый resourceId сопровождается сообщением об ошибке.
properties.outputs		Выходные данные ресурса развертывания, созданные стеком развертывания.
properties.parameters	<string, DeploymentParameter>	Пары имен и значений, определяющие параметры развертывания для шаблона. Используйте этот элемент при предоставлении значений параметров непосредственно в запросе, а не связывания с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба.
properties.parametersLink	DeploymentStacksParametersLink	Универсальный код ресурса (URI) файла параметров. Используйте этот элемент, чтобы связаться с существующим файлом параметров. Используйте свойство parametersLink или свойство параметров, но не оба.
properties.provisioningState	DeploymentStackProvisioningState	Состояние стека развертывания.
properties.resources	ManagedResourceReference[]	Массив ресурсов, управляемых в настоящее время стеком развертывания.
properties.template		Содержимое шаблона. Этот элемент используется при передаче синтаксиса шаблона непосредственно в запросе, а не ссылки на существующий шаблон. Это может быть строка JObject или хорошо сформированная строка JSON. Используйте свойство templateLink или свойство шаблона, но не оба.
properties.templateLink	DeploymentStacksTemplateLink	Универсальный код ресурса (URI) шаблона. Используйте свойство templateLink или свойство шаблона, но не оба.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

DeploymentStackListResult

Объект

Ответ операции со списком DeploymentStack.

Имя	Тип	Описание
nextLink	string (uri)	Ссылка на следующую страницу элементов
value	DeploymentStack[]	Элементы DeploymentStack на этой странице

DeploymentStackProvisioningState

Перечисление

Состояние стека развертывания.

Значение	Описание
creating	В настоящее время создается стек развертывания
validating	В настоящее время выполняется проверка стека развертывания
waiting	Стек развертывания в настоящее время ожидает
deploying	Стек развертывания в настоящее время развертывается
canceling	Стек развертывания отменяется
updatingDenyAssignments	Стек развертывания обновляет запретные назначения
deletingResources	Стек развертывания удаляет ресурсы
succeeded	Стек развертывания успешно завершен
failed	Сбой стека развертывания
canceled	Стек развертывания был отменен
deleting	Стек развертывания удаляется

DeploymentStacksDebugSetting

Объект

Параметр отладки.

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

DeploymentStacksParametersLink

Объект

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

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

DeploymentStacksTemplateLink

Объект

Сущность, представляющая ссылку на шаблон.

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

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

KeyVaultParameterReference

Объект

Справочник по параметрам Azure Key Vault.

Имя	Тип	Описание
keyVault	KeyVaultReference	Справочник по Azure Key Vault.
secretName	string	Имя секрета Azure Key Vault.
secretVersion	string	Секретная версия Azure Key Vault.

KeyVaultReference

Объект

Справочник по Azure Key Vault.

Имя	Тип	Описание
id	string	Идентификатор ресурса Azure Key Vault.

ManagedResourceReference

Объект

Модель управляемых ресурсов.

Имя	Тип	Default value	Описание
denyStatus	DenyStatusMode	none	Параметры denyAssignment, примененные к ресурсу.
id	string		Идентификатор ресурса ARM ресурса, управляемого стеком развертывания.
status	ResourceStatusMode	none	Текущее состояние управления ресурсом в стеке развертывания.

ResourceReference

Объект

Модель resourceId.

Имя	Тип	Описание
id	string	Идентификатор ресурса ARM ресурса, управляемого стеком развертывания.

ResourceReferenceExtended

Объект

Расширенная модель resourceId. Это используется для документирования сбойных ресурсов с помощью resourceId и соответствующей ошибки.

Имя	Тип	Описание
error	ErrorDetail	Сведения об ошибке.
id	string	Идентификатор ресурса ARM ресурса, управляемого стеком развертывания.

ResourceStatusMode

Перечисление

Текущее состояние управления ресурсом в стеке развертывания.

Значение	Описание
managed	Этот ресурс управляется стеком развертывания.
removeDenyFailed	Не удается удалить назначение запрета в ресурсе.
deleteFailed	Не удается удалить ресурс из Azure. Удаление будет извлечено в следующем развертывании стека или может быть удалено вручную.
none	Нет состояния управления.

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UnmanageActionManagementGroupMode

Перечисление

Указывает действие для нового неуправляемого ресурса.

Значение	Описание
delete	Удалите управляющие группы из Azure.
detach	Оставьте управленческие группы в Azure.

UnmanageActionResourceGroupMode

Перечисление

Задаёт действие для новой неуправляемой группы ресурсов.

Значение	Описание
delete	Удалите группы ресурсов из Azure.
detach	Оставьте группы ресурсов в Azure.

UnmanageActionResourceMode

Перечисление

Указывает действие для нового неуправляемого ресурса.

Значение	Описание
delete	Удалить ресурсы из Azure
detach	Храните ресурсы в Azure

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

Deployment Stacks - List At Management Group

Параметры URI

Ответы

Безопасность

azure_auth

Области

Примеры

List management group Deployment stacks

Образец запроса

Пример ответа

Определения

ActionOnUnmanage

createdByType

DenySettings

DenySettingsMode

DenyStatusMode

DeploymentParameter

DeploymentStack

DeploymentStackListResult

DeploymentStackProvisioningState

DeploymentStacksDebugSetting

DeploymentStacksParametersLink

DeploymentStacksTemplateLink

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultParameterReference

KeyVaultReference

ManagedResourceReference

ResourceReference

ResourceReferenceExtended

ResourceStatusMode

systemData

UnmanageActionManagementGroupMode

UnmanageActionResourceGroupMode

UnmanageActionResourceMode