你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	管理组 ID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	DeploymentStackListResult	Azure作已成功完成。
Other Status Codes	ErrorResponse	意外错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: 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	定义如何锁定 Deployment 堆栈部署的资源。
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

对象

定义如何锁定 Deployment 堆栈部署的资源。

名称	类型	说明
applyToChildScopes	boolean	DenySettings 将应用于具有拒绝分配的每个托管资源的子资源范围。
excludedActions	string[]	从 denySettings 中排除的基于角色的管理作的列表。最多允许 200 个作。如果 denySetting 模式设置为“denyWriteAndDelete”，则以下操作会自动追加到“excludedActions”：“*/read”和“Microsoft.Authorization/locks/delete”。如果 denySetting 模式设置为“denyDelete”，则以下操作会自动追加到“excludedActions”：“Microsoft.Authorization/locks/delete”。将删除重复的操作。
excludedPrincipals	string[]	从锁中排除的 AAD 主体 ID 的列表。最多允许 5 个主体。
mode	DenySettingsMode	denySettings 模式，用于定义被拒绝的作。

DenySettingsMode

枚举

denySettings 模式，用于定义被拒绝的作。

值	说明
denyDelete	授权用户能够读取和修改资源，但无法删除。
denyWriteAndDelete	授权用户可以从资源中读取数据，但不能修改或删除它。
none	未应用 denyAssignments。

DenyStatusMode

枚举

应用于资源的 denyAssignment 设置。

值	说明
denyDelete	授权用户能够读取和修改资源，但无法删除。
notSupported	资源类型不支持 denyAssignments。
inapplicable	部署堆栈范围之外的资源不支持 denyAssignments。
denyWriteAndDelete	授权用户只能从资源读取，但不能修改或删除它。
removedBySystem	Azure 由于资源管理更改（管理组移动等）而删除了拒绝分配。
none	未应用 denyAssignments。

DeploymentParameter

对象

模板的部署参数。

名称	类型	说明
reference	KeyVaultParameterReference	Azure Key Vault 参数参考。
type	string	值的类型。
value		参数的输入值。

DeploymentStack

对象

部署堆栈对象。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 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	部署堆栈创建的部署资源的 resourceId。
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 属性或 parameters 属性，但不能同时使用两者。
properties.parametersLink	DeploymentStacksParametersLink	参数文件的 URI。使用此元素链接到现有参数文件。使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。
properties.provisioningState	DeploymentStackProvisioningState	部署堆栈的状态。
properties.resources	ManagedResourceReference[]	部署堆栈当前管理的资源数组。
properties.template		模板内容。如果要直接在请求中传递模板语法，而不是链接到现有模板，请使用此元素。它可以是 JObject 或格式正确的 JSON 字符串。使用 templateLink 属性或模板属性，但不能同时使用这两者。
properties.templateLink	DeploymentStacksTemplateLink	模板的 URI。使用 templateLink 属性或模板属性，但不能同时使用这两者。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
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	指定要记录以供调试的信息的类型。允许的值不为 none、requestContent、responseContent，或两者均用逗号分隔的 requestContent 和 responseContent。默认值为 none。设置此值时，请仔细考虑在部署期间传入的信息类型。通过记录有关请求或响应的信息，通过部署操作检索的敏感数据可能会公开。

DeploymentStacksParametersLink

对象

表示对部署参数的引用的实体。

名称	类型	说明
contentVersion	string	如果包含，则必须匹配模板中的 ContentVersion。
uri	string	参数文件的 URI。

DeploymentStacksTemplateLink

对象

表示对模板的引用的实体。

名称	类型	说明
contentVersion	string	如果包含，则必须匹配模板中的 ContentVersion。
id	string	模板规范的 resourceId。使用 id 或 uri 属性，但不能同时使用两者。
queryString	string	要与 templateLink URI 一起使用的查询字符串（例如 SAS 令牌）。
relativePath	string	relativePath 属性可用于在相对于父级的位置部署链接模板。如果父模板与 TemplateSpec 链接，则会引用 TemplateSpec 中的项目。如果父级与 URI 链接，则子级部署将是父级和 relativePath URI 的组合。
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 resourceId 中。

ManagedResourceReference

对象

托管资源模型。

名称	类型	默认值	说明
denyStatus	DenyStatusMode	none	应用于资源的 denyAssignment 设置。
id	string		由部署堆栈管理的资源的 ARM 资源 ID。
status	ResourceStatusMode	none	部署堆栈中资源的当前管理状态。

ResourceReference

对象

resourceId 模型。

名称	类型	说明
id	string	由部署堆栈管理的资源的 ARM 资源 ID。

ResourceReferenceExtended

对象

resourceId 扩展模型。这用于记录带有 resourceId 和相应错误的失败资源。

名称	类型	说明
error	ErrorDetail	错误详细信息。
id	string	由部署堆栈管理的资源的 ARM 资源 ID。

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

枚举