Microsoft.Resources deploymentStacks 2022-08-01-preview
Bicep リソース定義
deploymentStacks リソースの種類は、次をターゲットとする操作でデプロイできます。
- 管理グループ - 管理グループの展開コマンドに関するページを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Resources/deploymentStacks リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Resources/deploymentStacks@2022-08-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
actionOnUnmanage: {
managementGroups: 'string'
resourceGroups: 'string'
resources: 'string'
}
debugSetting: {
detailLevel: 'string'
}
denySettings: {
applyToChildScopes: bool
excludedActions: [
'string'
]
excludedPrincipals: [
'string'
]
mode: 'string'
}
deploymentScope: 'string'
description: 'string'
error: {
error: {}
}
parameters: any()
parametersLink: {
contentVersion: 'string'
uri: 'string'
}
template: any()
templateLink: {
contentVersion: 'string'
id: 'string'
queryString: 'string'
relativePath: 'string'
uri: 'string'
}
}
}
プロパティ値
deploymentStacks
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 | string (必須) |
| location | デプロイ スタックの場所。 作成後に変更することはできません。 これは、サポートされている Azure の場所のいずれかである必要があります。 | string |
| tags | デプロイ スタック リソース タグ。 | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| properties | デプロイ スタックのプロパティ。 | DeploymentStackProperties |
DeploymentStackProperties
| 名前 | 説明 | 値 |
|---|---|---|
| actionOnUnmanage | スタックが更新された直後に管理されないリソースの動作を定義します。 | DeploymentStackPropertiesActionOnUnmanage (必須) |
| debugSetting | デプロイのデバッグ設定。 | DeploymentStacksDebugSetting |
| denySettings | スタックによってデプロイされたリソースをロックする方法を定義します。 | DenySettings (必須) |
| deploymentScope | 初期デプロイを作成するスコープ。 スコープが指定されていない場合、既定ではデプロイ スタックのスコープになります。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroupId}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') です。 | string |
| description | デプロイ スタックの説明。 | string 制約: 最大長 = 4096 |
| error | 失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは OData エラー応答形式にも従います)。 | ErrorResponse |
| parameters | テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルにリンクするのではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しません。 JObject または整形式の JSON 文字列を指定できます。 | Bicep の場合は、 any() 関数を使用できます。 |
| parametersLink | パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しません。 | DeploymentStacksParametersLink |
| template | テンプレートの内容。 この要素は、既存のテンプレートへのリンクではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたはテンプレート プロパティを使用しますが、両方は使用しません。 | Bicep の場合は、 any() 関数を使用できます。 |
| templateLink | テンプレートの URI。 templateLink プロパティまたはテンプレート プロパティを使用しますが、両方は使用しません。 | DeploymentStacksTemplateLink |
DeploymentStackPropertiesActionOnUnmanage
| 名前 | 説明 | 値 |
|---|---|---|
| managementGroups | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態になります。 | 'delete' 'detach' |
| resourceGroups | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態になります。 | 'delete' 'detach' |
| resources | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態のままになります。 | 'delete' 'detach' (必須) |
DeploymentStacksDebugSetting
| 名前 | 説明 | 値 |
|---|---|---|
| detailLevel | デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方でコンマで区切られています。 既定値は none です。 この値を設定する場合は、デプロイ中に渡される情報の種類を慎重に検討してください。 要求または応答に関する情報をログに記録することで、展開操作を通じて取得された機密データが公開される可能性があります。 | string |
DenySettings
| 名前 | 説明 | 値 |
|---|---|---|
| applyToChildScopes | DenySettings は子スコープに適用されます。 | [bool] |
| excludedActions | denySettings から除外されるロールベースの管理操作の一覧。 最大 200 個のアクションが許可されます。 denySetting モードが 'denyWriteAndDelete' に設定されている場合、'excludedActions': '*/read' と 'Microsoft.Authorization/locks/delete' に自動的に追加されます。 denySetting モードが 'denyDelete' に設定されている場合、次のアクションは自動的に 'excludedActions': 'Microsoft.Authorization/locks/delete' に追加されます。 重複するアクションは削除されます。 | string[] |
| excludedPrincipals | ロックから除外された AAD プリンシパル ID の一覧。 最大 5 つのプリンシパルが許可されます。 | string[] |
| mode | denySettings モード。 | 'denyDelete' 'denyWriteAndDelete' 'none' (必須) |
ErrorResponse
| 名前 | 説明 | 値 |
|---|---|---|
| error | error オブジェクト。 | ErrorDetail |
ErrorDetail
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
DeploymentStacksParametersLink
| 名前 | 説明 | 値 |
|---|---|---|
| contentVersion | 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 | string |
| uri | パラメーター ファイルの URI。 | string (必須) |
DeploymentStacksTemplateLink
| 名前 | 説明 | 値 |
|---|---|---|
| contentVersion | 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 | string |
| id | テンプレート スペックのリソース ID。id プロパティまたは uri プロパティを使用しますが、両方は使用しないでください。 | string |
| queryString | templateLink URI で使用するクエリ文字列 (SAS トークンなど)。 | string |
| relativePath | relativePath プロパティを使用すると、親に対する相対位置にリンクされたテンプレートをデプロイできます。 親テンプレートが TemplateSpec とリンクされている場合、TemplateSpec 内の成果物が参照されます。 親が URI とリンクされている場合、子デプロイは親 URI と relativePath URI の組み合わせになります | string |
| uri | デプロイするテンプレートの URI。 uri または id プロパティを使用しますが、両方は使用しないでください。 | string |
ARM テンプレート リソース定義
deploymentStacks リソースの種類は、次を対象とする操作でデプロイできます。
- 管理グループ - 管理グループの展開コマンドに関するページを参照してください
- サブスクリプション - サブスクリプションのデプロイ コマンドに関するページを参照してください
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Resources/deploymentStacks リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Resources/deploymentStacks",
"apiVersion": "2022-08-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"actionOnUnmanage": {
"managementGroups": "string",
"resourceGroups": "string",
"resources": "string"
},
"debugSetting": {
"detailLevel": "string"
},
"denySettings": {
"applyToChildScopes": "bool",
"excludedActions": [ "string" ],
"excludedPrincipals": [ "string" ],
"mode": "string"
},
"deploymentScope": "string",
"description": "string",
"error": {
"error": {}
},
"parameters": {},
"parametersLink": {
"contentVersion": "string",
"uri": "string"
},
"template": {},
"templateLink": {
"contentVersion": "string",
"id": "string",
"queryString": "string",
"relativePath": "string",
"uri": "string"
}
}
}
プロパティ値
deploymentStacks
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.Resources/deploymentStacks' |
| apiVersion | リソース API のバージョン | '2022-08-01-preview' |
| name | リソース名 | string (必須) |
| location | デプロイ スタックの場所。 作成後に変更することはできません。 サポートされている Azure の場所のいずれかである必要があります。 | string |
| tags | デプロイ スタック リソース タグ。 | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| properties | デプロイ スタックのプロパティ。 | DeploymentStackProperties |
DeploymentStackProperties
| 名前 | 説明 | 値 |
|---|---|---|
| actionOnUnmanage | スタックが更新された直後に管理されないリソースの動作を定義します。 | DeploymentStackPropertiesActionOnUnmanage (必須) |
| debugSetting | デプロイのデバッグ設定。 | DeploymentStacksDebugSetting |
| denySettings | スタックによってデプロイされたリソースをロックする方法を定義します。 | DenySettings (必須) |
| deploymentScope | 初期デプロイを作成するスコープ。 スコープが指定されていない場合、既定ではデプロイ スタックのスコープになります。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroupId}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') です。 | string |
| description | デプロイ スタックの説明。 | string 制約: 最大長 = 4096 |
| error | 失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは、OData エラー応答形式にも従います)。 | ErrorResponse |
| parameters | テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルにリンクするのではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。 JObject または整形式の JSON 文字列を指定できます。 | |
| parametersLink | パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。 | DeploymentStacksParametersLink |
| template | テンプレートの内容。 この要素は、既存のテンプレートにリンクするのではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。 | |
| templateLink | テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。 | DeploymentStacksTemplateLink |
DeploymentStackPropertiesActionOnUnmanage
| 名前 | 説明 | 値 |
|---|---|---|
| managementGroups | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態のままになります。 | 'delete' 'detach' |
| resourceGroups | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態のままになります。 | 'delete' 'detach' |
| resources | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態のままになります。 | 'delete' 'detach' (必須) |
DeploymentStacksDebugSetting
| 名前 | 説明 | 値 |
|---|---|---|
| detailLevel | デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方でコンマで区切られています。 既定値は none です。 この値を設定する場合は、デプロイ中に渡される情報の種類を慎重に検討してください。 要求または応答に関する情報をログに記録することで、展開操作を通じて取得された機密データが公開される可能性があります。 | string |
DenySettings
| 名前 | 説明 | 値 |
|---|---|---|
| applyToChildScopes | DenySettings は子スコープに適用されます。 | [bool] |
| excludedActions | denySettings から除外されるロールベースの管理操作の一覧。 最大 200 個のアクションが許可されます。 denySetting モードが 'denyWriteAndDelete' に設定されている場合、'excludedActions': '*/read' および 'Microsoft.Authorization/locks/delete' に次のアクションが自動的に追加されます。 denySetting モードが 'denyDelete' に設定されている場合、次のアクションが 'excludedActions' に自動的に追加されます: 'Microsoft.Authorization/locks/delete'。 重複するアクションは削除されます。 | string[] |
| excludedPrincipals | ロックから除外された AAD プリンシパル ID の一覧。 最大 5 つのプリンシパルが許可されます。 | string[] |
| mode | denySettings モード。 | 'denyDelete' 'denyWriteAndDelete' 'none' (必須) |
ErrorResponse
| 名前 | 説明 | 値 |
|---|---|---|
| error | error オブジェクト。 | ErrorDetail |
ErrorDetail
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
DeploymentStacksParametersLink
| 名前 | 説明 | 値 |
|---|---|---|
| contentVersion | 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 | string |
| uri | パラメーター ファイルの URI。 | string (必須) |
DeploymentStacksTemplateLink
| 名前 | 説明 | 値 |
|---|---|---|
| contentVersion | 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 | string |
| id | テンプレート スペックのリソース ID。id または uri プロパティを使用しますが、両方は使用しないでください。 | string |
| queryString | templateLink URI で使用されるクエリ文字列 (SAS トークンなど)。 | string |
| relativePath | relativePath プロパティを使用すると、親に対する相対位置にリンクされたテンプレートを配置できます。 親テンプレートが TemplateSpec とリンクされている場合、TemplateSpec 内の成果物が参照されます。 親が URI にリンクされている場合、子デプロイは親 URI と relativePath URI の組み合わせになります | string |
| uri | デプロイするテンプレートの URI。 uri または id プロパティを使用しますが、両方は使用しないでください。 | string |
Terraform (AzAPI プロバイダー) リソース定義
deploymentStacks リソースの種類は、次をターゲットとする操作でデプロイできます。
- 管理グループ
- サブスクリプション
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Resources/deploymentStacks リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Resources/deploymentStacks@2022-08-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
actionOnUnmanage = {
managementGroups = "string"
resourceGroups = "string"
resources = "string"
}
debugSetting = {
detailLevel = "string"
}
denySettings = {
applyToChildScopes = bool
excludedActions = [
"string"
]
excludedPrincipals = [
"string"
]
mode = "string"
}
deploymentScope = "string"
description = "string"
error = {
error = {}
}
parametersLink = {
contentVersion = "string"
uri = "string"
}
templateLink = {
contentVersion = "string"
id = "string"
queryString = "string"
relativePath = "string"
uri = "string"
}
}
})
}
プロパティ値
deploymentStacks
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.Resources/deploymentStacks@2022-08-01-preview" |
| name | リソース名 | string (必須) |
| location | デプロイ スタックの場所。 作成後に変更することはできません。 これは、サポートされている Azure の場所のいずれかである必要があります。 | string |
| parent_id | 管理グループに展開するには、その管理グループの ID を使用します。 サブスクリプションにデプロイするには、そのサブスクリプションの ID を使用します。 リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
| tags | デプロイ スタック リソース タグ。 | タグの名前と値のディクショナリ。 |
| properties | デプロイ スタックのプロパティ。 | DeploymentStackProperties |
DeploymentStackProperties
| 名前 | 説明 | 値 |
|---|---|---|
| actionOnUnmanage | スタックが更新された直後に管理されないリソースの動作を定義します。 | DeploymentStackPropertiesActionOnUnmanage (必須) |
| debugSetting | デプロイのデバッグ設定。 | DeploymentStacksDebugSetting |
| denySettings | スタックによってデプロイされたリソースをロックする方法を定義します。 | DenySettings (必須) |
| deploymentScope | 初期デプロイを作成するスコープ。 スコープが指定されていない場合、既定ではデプロイ スタックのスコープになります。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroupId}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') です。 | string |
| description | デプロイ スタックの説明。 | string 制約: 最大長 = 4096 |
| error | 失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答 (これは OData エラー応答形式にも従います)。 | ErrorResponse |
| parameters | テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルにリンクするのではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しません。 JObject または整形式の JSON 文字列を指定できます。 | |
| parametersLink | パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しません。 | DeploymentStacksParametersLink |
| template | テンプレートの内容。 この要素は、既存のテンプレートへのリンクではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたはテンプレート プロパティを使用しますが、両方は使用しません。 | |
| templateLink | テンプレートの URI。 templateLink プロパティまたはテンプレート プロパティを使用しますが、両方は使用しません。 | DeploymentStacksTemplateLink |
DeploymentStackPropertiesActionOnUnmanage
| 名前 | 説明 | 値 |
|---|---|---|
| managementGroups | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態になります。 | "delete" "デタッチ" |
| resourceGroups | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態になります。 | "delete" "デタッチ" |
| resources | デプロイ スタックが削除されたときにリソースに対して実行する必要があるアクションを指定します。 削除すると、Azure からリソースの削除が試みられます。 デタッチすると、リソースは現在の状態になります。 | "delete" "detach" (必須) |
DeploymentStacksDebugSetting
| 名前 | 説明 | 値 |
|---|---|---|
| detailLevel | デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方をコンマで区切って指定します。 既定値は none です。 この値を設定する場合は、デプロイ中に渡される情報の種類を慎重に検討してください。 要求または応答に関する情報をログに記録することで、展開操作を通じて取得された機密データが公開される可能性があります。 | string |
DenySettings
| 名前 | 説明 | 値 |
|---|---|---|
| applyToChildScopes | DenySettings は子スコープに適用されます。 | [bool] |
| excludedActions | denySettings から除外されるロールベースの管理操作の一覧。 最大 200 個のアクションが許可されます。 denySetting モードが 'denyWriteAndDelete' に設定されている場合、'excludedActions': '*/read' および 'Microsoft.Authorization/locks/delete' に次のアクションが自動的に追加されます。 denySetting モードが 'denyDelete' に設定されている場合、次のアクションが 'excludedActions' に自動的に追加されます: 'Microsoft.Authorization/locks/delete'。 重複するアクションは削除されます。 | string[] |
| excludedPrincipals | ロックから除外された AAD プリンシパル ID の一覧。 最大 5 つのプリンシパルが許可されます。 | string[] |
| mode | denySettings モード。 | "denyDelete" "denyWriteAndDelete" "none" (必須) |
ErrorResponse
| 名前 | 説明 | 値 |
|---|---|---|
| error | error オブジェクト。 | ErrorDetail |
ErrorDetail
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
DeploymentStacksParametersLink
| 名前 | 説明 | 値 |
|---|---|---|
| contentVersion | 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 | string |
| uri | パラメーター ファイルの URI。 | string (必須) |
DeploymentStacksTemplateLink
| 名前 | 説明 | 値 |
|---|---|---|
| contentVersion | 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 | string |
| id | テンプレート スペックのリソース ID。id または uri プロパティを使用しますが、両方は使用しないでください。 | string |
| queryString | templateLink URI で使用されるクエリ文字列 (SAS トークンなど)。 | string |
| relativePath | relativePath プロパティを使用すると、親に対する相対位置にリンクされたテンプレートを配置できます。 親テンプレートが TemplateSpec とリンクされている場合、TemplateSpec 内の成果物が参照されます。 親が URI にリンクされている場合、子デプロイは親 URI と relativePath URI の組み合わせになります | string |
| uri | デプロイするテンプレートの URI。 uri または id プロパティを使用しますが、両方は使用しないでください。 | string |
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示