次の方法で共有


Microsoft.Resources deploymentStacks

Bicep リソース定義

deploymentStacks リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Resources/deploymentStacks リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Resources/deploymentStacks@2024-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  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'
    error: {}
    parameters: {
      {customized property}: {
        reference: {
          keyVault: {
            id: 'string'
          }
          secretName: 'string'
          secretVersion: 'string'
        }
        type: 'string'
        value: 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 デプロイ スタックが更新または削除された後に管理されなくなったリソースの動作を定義します。 ActionOnUnmanage (必須)
bypassStackOutOfSyncError スタック リソースの一覧が正しく同期されていないことを示すサービス エラーをバイパスするフラグ。 [bool]
debugSetting デプロイのデバッグ設定。 DeploymentStacksDebugSetting
denySettings スタックによってデプロイされたリソースをロックする方法を定義します。 DenySettings (必須)
deploymentScope 初期デプロイを作成するスコープ。 スコープが指定されていない場合、既定ではデプロイ スタックのスコープになります。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroupId}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') です。 string
description デプロイ スタックの説明。 最大長は 4096 文字です。 string

制約:
最大長 = 4096
error エラーの詳細。 ErrorDetail
parameters テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルにリンクするのではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。 DeploymentStackPropertiesParameters
parametersLink パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。 DeploymentStacksParametersLink
template テンプレートの内容。 この要素は、既存のテンプレートにリンクするのではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。 Bicep の場合は、 any() 関数を使用できます。
templateLink テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。 DeploymentStacksTemplateLink

ActionOnUnmanage

名前 説明
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' (必須)

ErrorDetail

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

DeploymentStackPropertiesParameters

名前 説明
{カスタマイズされたプロパティ} DeploymentParameterAutoGenerated

DeploymentParameterAutoGenerated

名前 説明
reference Azure Key Vault パラメーターリファレンス。 KeyVaultParameterReferenceAutoGenerated
値の型。 string
value パラメーターに値を入力します。 Bicep の場合は、 any() 関数を使用できます。

KeyVaultParameterReferenceAutoGenerated

名前 説明
keyVault Azure Key Vault リファレンス。 KeyVaultReferenceAutoGenerated (必須)
secretName Azure Key Vault シークレット名。 string (必須)
secretVersion Azure Key Vault シークレットのバージョン。 string

KeyVaultReferenceAutoGenerated

名前 説明
id Azure Key Vault resourceId。 string (必須)
名前 説明
contentVersion 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 string
uri パラメーター ファイルの URI。 string (必須)
名前 説明
contentVersion 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 string
id テンプレート スペックの resourceId。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": "2024-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "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",
    "error": {},
    "parameters": {
      "{customized property}": {
        "reference": {
          "keyVault": {
            "id": "string"
          },
          "secretName": "string",
          "secretVersion": "string"
        },
        "type": "string",
        "value": {}
      }
    },
    "parametersLink": {
      "contentVersion": "string",
      "uri": "string"
    },
    "template": {},
    "templateLink": {
      "contentVersion": "string",
      "id": "string",
      "queryString": "string",
      "relativePath": "string",
      "uri": "string"
    }
  }
}

プロパティ値

deploymentStacks

名前 説明
type リソースの種類 'Microsoft.Resources/deploymentStacks'
apiVersion リソース API のバージョン '2024-03-01'
name リソース名 string (必須)
location デプロイ スタックの場所。 作成後に変更することはできません。 サポートされている Azure の場所のいずれかである必要があります。 string
tags デプロイ スタック リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
properties デプロイ スタックのプロパティ。 DeploymentStackProperties

DeploymentStackProperties

名前 説明
actionOnUnmanage デプロイ スタックが更新または削除された後に管理されなくなったリソースの動作を定義します。 ActionOnUnmanage (必須)
bypassStackOutOfSyncError スタック リソースの一覧が正しく同期されていないことを示すサービス エラーをバイパスするフラグ。 [bool]
debugSetting デプロイのデバッグ設定。 DeploymentStacksDebugSetting
denySettings スタックによってデプロイされたリソースをロックする方法を定義します。 DenySettings (必須)
deploymentScope 初期デプロイを作成するスコープ。 スコープが指定されていない場合、既定ではデプロイ スタックのスコープになります。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroupId}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') です。 string
description デプロイ スタックの説明。 最大長は 4096 文字です。 string

制約:
最大長 = 4096
error エラーの詳細。 ErrorDetail
parameters テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルにリンクするのではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。 DeploymentStackPropertiesParameters
parametersLink パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。 DeploymentStacksParametersLink
template テンプレートの内容。 この要素は、既存のテンプレートにリンクするのではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
templateLink テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。 DeploymentStacksTemplateLink

ActionOnUnmanage

名前 説明
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' (必須)

ErrorDetail

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

DeploymentStackPropertiesParameters

名前 説明
{カスタマイズされたプロパティ} DeploymentParameterAutoGenerated

DeploymentParameterAutoGenerated

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

KeyVaultParameterReferenceAutoGenerated

名前 説明
keyVault Azure Key Vault リファレンス。 KeyVaultReferenceAutoGenerated (必須)
secretName Azure Key Vault シークレット名。 string (必須)
secretVersion Azure Key Vault シークレットのバージョン。 string

KeyVaultReferenceAutoGenerated

名前 説明
id Azure Key Vault resourceId。 string (必須)
名前 説明
contentVersion 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 string
uri パラメーター ファイルの URI。 string (必須)
名前 説明
contentVersion 含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 string
id テンプレート スペックの resourceId。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@2024-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    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"
      error = {}
      parameters = {
        {customized property} = {
          reference = {
            keyVault = {
              id = "string"
            }
            secretName = "string"
            secretVersion = "string"
          }
          type = "string"
        }
      }
      parametersLink = {
        contentVersion = "string"
        uri = "string"
      }
      templateLink = {
        contentVersion = "string"
        id = "string"
        queryString = "string"
        relativePath = "string"
        uri = "string"
      }
    }
  })
}

プロパティ値

deploymentStacks

名前 説明
type リソースの種類 "Microsoft.Resources/deploymentStacks@2024-03-01"
name リソース名 string (必須)
location デプロイ スタックの場所。 作成後に変更することはできません。 これは、サポートされている Azure の場所のいずれかである必要があります。 string
parent_id 管理グループに展開するには、その管理グループの ID を使用します。 サブスクリプションにデプロイするには、そのサブスクリプションの ID を使用します。 リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags デプロイ スタック リソース タグ。 タグの名前と値のディクショナリ。
properties デプロイ スタックのプロパティ。 DeploymentStackProperties

DeploymentStackProperties

名前 説明
actionOnUnmanage デプロイ スタックの更新または削除後に管理されなくなったリソースの動作を定義します。 ActionOnUnmanage (必須)
bypassStackOutOfSyncError スタック リソース リストが正しく同期されていないことを示すサービス エラーをバイパスするフラグ。 [bool]
debugSetting デプロイのデバッグ設定。 DeploymentStacksDebugSetting
denySettings スタックによってデプロイされたリソースをロックする方法を定義します。 DenySettings (必須)
deploymentScope 初期デプロイを作成するスコープ。 スコープが指定されていない場合、既定ではデプロイ スタックのスコープになります。 有効なスコープは、管理グループ (形式: '/providers/Microsoft.Management/managementGroups/{managementGroupId}')、サブスクリプション (形式: '/subscriptions/{subscriptionId}')、リソース グループ (形式: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}') です。 string
description デプロイ スタックの説明。 最大長は 4096 文字です。 string

制約:
最大長 = 4096
error エラーの詳細。 ErrorDetail
parameters テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルにリンクするのではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しません。 DeploymentStackPropertiesParameters
parametersLink パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しないでください。 DeploymentStacksParametersLink
template テンプレートの内容。 この要素は、既存のテンプレートにリンクするのではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
templateLink テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。 DeploymentStacksTemplateLink

ActionOnUnmanage

名前 説明
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" (必須)

ErrorDetail

このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。

DeploymentStackPropertiesParameters

名前 説明
{カスタマイズされたプロパティ} DeploymentParameterAutoGenerated

DeploymentParameterAutoGenerated

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

KeyVaultParameterReferenceAutoGenerated

名前 説明
keyVault Azure Key Vault リファレンス。 KeyVaultReferenceAutoGenerated (必須)
secretName Azure Key Vault シークレット名。 string (必須)
secretVersion Azure Key Vault シークレットのバージョン。 string

KeyVaultReferenceAutoGenerated

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