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
Authorization URL (承認 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	リソースを作成した ID の種類。
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

Object

スタックが更新または削除された後に管理されなくなったリソースの動作を定義します。

名前	型	説明
managementGroups	UnmanageActionManagementGroupMode	新たに管理されていないリソース管理グループのためのアクションを指定します。
resourceGroups	UnmanageActionResourceGroupMode	新たに管理されていないリソースグループのためのアクションを指定します。
resources	UnmanageActionResourceMode	新しく管理されていないリソースに対するアクションを指定します。

createdByType

列挙

リソースを作成した ID の種類。

値	説明
User
Application
ManagedIdentity
Key

DenySettings

Object

デプロイメント・スタックによってデプロイされたリソースのロック方法を定義します。

名前	型	説明
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	denyAssignment は適用されていません。

DenyStatusMode

列挙

リソースに適用される denyAssignment 設定。

値	説明
denyDelete	承認されたユーザーはリソースの読み取りと変更を行うことができますが、削除することはできません。
notSupported	リソースの種類は denyAssignments をサポートしていません。
inapplicable	denyAssignment は、デプロイ スタックのスコープ外のリソースではサポートされていません。
denyWriteAndDelete	承認されたユーザーはリソースからのみ読み取ることができますが、変更や削除はできません。
removedBySystem	リソース管理の変更 (管理グループの移動など) により、Azure によって拒否割り当てが削除されました
none	denyAssignment は適用されていません。

DeploymentParameter

Object

テンプレートのデプロイ パラメーター。

名前	型	説明
reference	KeyVaultParameterReference	Azure Key Vault パラメーター リファレンス。
type	string	値の型。
value		パラメータに入力する値。

DeploymentStack

Object

デプロイ スタック オブジェクト。

名前	型	説明
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 プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
properties.templateLink	DeploymentStacksTemplateLink	テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
systemData	systemData	createdBy と modifiedBy 情報を含む Azure Resource Manager メタデータ。
tags	object	リソース タグ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

DeploymentStackListResult

Object

DeploymentStack リスト操作の応答。

名前	型	説明
nextLink	string (uri)	項目の次のページへのリンク
value	DeploymentStack[]	このページの DeploymentStack 項目

DeploymentStackProvisioningState

列挙

デプロイ スタックの状態。

値	説明
creating	デプロイスタックは現在作成中です
validating	デプロイ スタックは現在検証中です
waiting	デプロイスタックは現在待機中です
deploying	デプロイ スタックは現在デプロイ中です
canceling	デプロイ スタックがキャンセルされています
updatingDenyAssignments	デプロイ スタックは拒否割り当てを更新しています
deletingResources	デプロイ スタックがリソースを削除しています
succeeded	デプロイ スタックは正常に完了しました
failed	デプロイ スタックが失敗しました
canceled	デプロイスタックが取り消されました
deleting	デプロイ スタックが削除されています

DeploymentStacksDebugSetting

Object

デバッグ設定。

名前	型	説明
detailLevel	string	デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方でコンマで区切られています。 既定値は none です。 この値を設定するときは、デプロイ中に渡される情報の種類を慎重に検討してください。 要求または応答に関する情報をログに記録することで、展開操作を通じて取得された機密データが公開される可能性があります。

DeploymentStacksParametersLink

Object

デプロイ パラメーターへの参照を表すエンティティ。

名前	型	説明
contentVersion	string	含まれている場合は、テンプレートの ContentVersion と一致する必要があります。
uri	string	パラメーター ファイルの URI。

DeploymentStacksTemplateLink

Object

テンプレートへの参照を表すエンティティ。

名前	型	説明
contentVersion	string	含まれている場合は、テンプレートの ContentVersion と一致する必要があります。
id	string	テンプレート仕様の resourceId。id プロパティまたは uri プロパティのいずれかを使用しますが、両方を使用することはできません。
queryString	string	templateLink URI で使用するクエリ文字列 (SAS トークンなど)。
relativePath	string	relativePath プロパティを使用すると、親に対する相対位置にリンクされたテンプレートを配置できます。 親テンプレートが TemplateSpec にリンクされている場合、TemplateSpec 内の成果物が参照されます。 親が URI にリンクされている場合、子デプロイは親 URI と relativePath URI の組み合わせになります。
uri	string	デプロイするテンプレートの URI。 uri または id プロパティを使用しますが、両方は使用しないでください。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

KeyVaultParameterReference

Object

Azure Key Vault パラメーター リファレンス。

名前	型	説明
keyVault	KeyVaultReference	Azure Key Vault リファレンス。
secretName	string	Azure Key Vault シークレット名。
secretVersion	string	Azure Key Vault シークレット バージョン。

KeyVaultReference

Object

Azure Key Vault リファレンス。

名前	型	説明
id	string	Azure Key Vault resourceId です。

ManagedResourceReference

Object

マネージド リソース モデル。

名前	型	規定値	説明
denyStatus	DenyStatusMode	none	リソースに適用される denyAssignment 設定。
id	string		デプロイ スタックによって管理されるリソースの ARM リソース ID。
status	ResourceStatusMode	none	デプロイ スタック内のリソースの現在の管理状態。

ResourceReference

Object

resourceId モデル。

名前	型	説明
id	string	デプロイ スタックによって管理されるリソースの ARM リソース ID。

ResourceReferenceExtended

Object

resourceId 拡張モデル。 これは、障害が発生したリソースを resourceId と対応するエラーで文書化するために使用されます。

名前	型	説明
error	ErrorDetail	エラーの詳細。
id	string	デプロイ スタックによって管理されるリソースの ARM リソース ID。

ResourceStatusMode

列挙

デプロイ スタック内のリソースの現在の管理状態。

値	説明
managed	このリソースは、デプロイ スタックによって管理されます。
removeDenyFailed	リソースの拒否割り当てを削除できません。
deleteFailed	Azure からリソースを削除できません。 削除は、次のスタックデプロイで再試行されるか、手動で削除できます。
none	管理状態はありません。

systemData

Object

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string (date-time)	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string (date-time)	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

UnmanageActionManagementGroupMode

列挙

新しく管理されていないリソースに対するアクションを指定します。

値	説明
delete	Azureから管理グループを削除してください。
detach	管理グループはAzureに残してください。

UnmanageActionResourceGroupMode

列挙

新たに管理されていないリソースグループのためのアクションを指定します。

値	説明
delete	Azureからリソースグループを削除してください。
detach	リソースグループはAzureに残してください。

UnmanageActionResourceMode

列挙

新しく管理されていないリソースに対するアクションを指定します。

値	説明
delete	Azureからリソースを削除してください
detach	リソースはAzureに残しておきます