Microsoft.Resources deploymentScripts 2023-08-01

[アーティクル]
12/20/2024

備考

デプロイ時にスクリプトを実行する方法については、「Bicep でのデプロイスクリプトの使用」または「ARM テンプレートでデプロイスクリプトを使用する」を参照してください。

Bicep リソース定義

deploymentScripts リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

resource symbolicname 'Microsoft.Resources/deploymentScripts@2023-08-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  tags: {
    {customized property}: 'string'
  }
  kind: 'string'
  // For remaining properties, see Microsoft.Resources/deploymentScripts objects
}

Microsoft.Resources/deploymentScripts オブジェクト

の種類 プロパティを設定して、オブジェクトの種類を指定します。

AzureCLIをする場合は、次を使用します。

{
  kind: 'AzureCLI'
  properties: {
    arguments: 'string'
    azCliVersion: 'string'
    cleanupPreference: 'string'
    containerSettings: {
      containerGroupName: 'string'
      subnetIds: [
        {
          id: 'string'
          name: 'string'
        }
      ]
    }
    environmentVariables: [
      {
        name: 'string'
        secureValue: 'string'
        value: 'string'
      }
    ]
    forceUpdateTag: 'string'
    primaryScriptUri: 'string'
    retentionInterval: 'string'
    scriptContent: 'string'
    storageAccountSettings: {
      storageAccountKey: 'string'
      storageAccountName: 'string'
    }
    supportingScriptUris: [
      'string'
    ]
    timeout: 'string'
  }
}

AzurePowerShellをする場合は、次のコマンドを使用します。

{
  kind: 'AzurePowerShell'
  properties: {
    arguments: 'string'
    azPowerShellVersion: 'string'
    cleanupPreference: 'string'
    containerSettings: {
      containerGroupName: 'string'
      subnetIds: [
        {
          id: 'string'
          name: 'string'
        }
      ]
    }
    environmentVariables: [
      {
        name: 'string'
        secureValue: 'string'
        value: 'string'
      }
    ]
    forceUpdateTag: 'string'
    primaryScriptUri: 'string'
    retentionInterval: 'string'
    scriptContent: 'string'
    storageAccountSettings: {
      storageAccountKey: 'string'
      storageAccountName: 'string'
    }
    supportingScriptUris: [
      'string'
    ]
    timeout: 'string'
  }
}

プロパティ値

AzureCliScript

名前	形容	価値
種類	スクリプトの種類。	'AzureCLI' (必須)
プロパティ	Azure CLI スクリプトオブジェクトのプロパティ。	AzureCliScriptProperties (必須)

AzureCliScriptProperties

名前	形容	価値
引数	スクリプトに渡すコマンドライン引数。引数はスペースで区切られます。例: -Name 青* -Location '米国西部 2'	糸
azCliVersion	使用する Azure CLI モジュールのバージョン。	string (必須)
cleanupPreference	スクリプトの実行が終了状態になったときのクリーンアップ設定。既定の設定は 'Always' です。	'Always' 'OnExpiration' 'OnSuccess'
containerSettings	コンテナーの設定。	ContainerConfiguration
environmentVariables	スクリプトに渡す環境変数。	EnvironmentVariable[]
forceUpdateTag	スクリプトリソースが変更されていない場合でも、デプロイスクリプトを強制的に実行する方法を取得または設定します。現在のタイムスタンプまたは GUID を指定できます。	糸
primaryScriptUri	スクリプトの URI。これは外部スクリプトのエントリポイントです。	糸
retentionInterval	サービスが終了状態に達した後にスクリプトリソースを保持する間隔。リソースは、この期間が経過すると削除されます。期間は ISO 8601 パターンに基づいています (たとえば、P1D は 1 日を意味します)。	string (必須)
scriptContent	スクリプト本文。	糸
storageAccountSettings	ストレージアカウントの設定。	StorageAccountConfiguration
supportingScriptUris	外部スクリプトのサポートファイル。	string[]
タイムアウト	ISO 8601 形式で指定されたスクリプト実行の最大許容時間。既定値は P1D です	糸

AzurePowerShellScript

名前	形容	価値
種類	スクリプトの種類。	'AzurePowerShell' (必須)
プロパティ	Azure PowerShell スクリプトオブジェクトのプロパティ。	AzurePowerShellScriptProperties (必須)

AzurePowerShellScriptProperties

名前	形容	価値
引数	スクリプトに渡すコマンドライン引数。引数はスペースで区切られます。例: -Name 青* -Location '米国西部 2'	糸
azPowerShellVersion	使用する Azure PowerShell モジュールのバージョン。	string (必須)
cleanupPreference	スクリプトの実行が終了状態になったときのクリーンアップ設定。既定の設定は 'Always' です。	'Always' 'OnExpiration' 'OnSuccess'
containerSettings	コンテナーの設定。	ContainerConfiguration
environmentVariables	スクリプトに渡す環境変数。	EnvironmentVariable[]
forceUpdateTag	スクリプトリソースが変更されていない場合でも、デプロイスクリプトを強制的に実行する方法を取得または設定します。現在のタイムスタンプまたは GUID を指定できます。	糸
primaryScriptUri	スクリプトの URI。これは外部スクリプトのエントリポイントです。	糸
retentionInterval	サービスが終了状態に達した後にスクリプトリソースを保持する間隔。リソースは、この期間が経過すると削除されます。期間は ISO 8601 パターンに基づいています (たとえば、P1D は 1 日を意味します)。	string (必須)
scriptContent	スクリプト本文。	糸
storageAccountSettings	ストレージアカウントの設定。	StorageAccountConfiguration
supportingScriptUris	外部スクリプトのサポートファイル。	string[]
タイムアウト	ISO 8601 形式で指定されたスクリプト実行の最大許容時間。既定値は P1D です	糸

ContainerConfiguration

名前	形容	価値
containerGroupName	コンテナーグループ名が指定されていない場合、名前は自動生成されます。 'containerGroupName' を指定しない場合は、システムが一意の名前を生成することを示します。これは、Azure Policy に非準拠としてフラグを設定する可能性があります。特定の名前付け規則が必要な Azure Policy がある場合、または名前を完全に制御する場合は、'containerGroupName' を使用します。 'containerGroupName' プロパティの長さは 1 ~ 63 文字にする必要があり、小文字、数字、ダッシュのみを含める必要があり、ダッシュで開始または終了することはできません。連続するダッシュは使用できません。 'containerGroupName' を指定するには、プロパティ { "containerSettings": { "containerGroupName": "contoso-container" } } に次のオブジェクトを追加します。 'containerGroupName' を指定しない場合は、'containerSettings' プロパティを追加しないでください。	糸制約：最小長 = 1 最大長 = 1
subnetIds	コンテナーグループのサブネットリソース ID。	ContainerGroupSubnetId[]

ContainerGroupSubnetId

名前	形容	価値
身分証明書	サブネットのリソース ID。	string (必須)
名前	サブネットのフレンドリ名。	糸

DeploymentScriptTags

名前	形容	価値

EnvironmentVariable

名前	形容	価値
名前	環境変数の名前。	string (必須)
secureValue	セキュリティで保護された環境変数の値。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
価値	環境変数の値。	糸

ManagedServiceIdentity

名前	形容	価値
種類	マネージド ID の種類。	'UserAssigned'
userAssignedIdentities	リソースに関連付けられているユーザー割り当てマネージド ID の一覧。キーは、マネージド ID の Azure リソース ID です。	ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前	形容	価値

Microsoft.Resources/deploymentScripts

名前	形容	価値
同一性	省略可能なプロパティ。このデプロイスクリプトに使用するマネージド ID。現時点では、ユーザー割り当て MSI のみがサポートされています。	ManagedServiceIdentity の
種類	AzureCliScriptの種類 'AzureCLI' に設定します。 AzurePowerShellScriptの種類 'AzurePowerShell' に設定します。	'AzureCLI' 'AzurePowerShell' (必須)
場所	デプロイスクリプトの ACI とストレージアカウントの場所。	string (必須)
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

StorageAccountConfiguration

名前	形容	価値
storageAccountKey	ストレージアカウントのアクセスキー。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
storageAccountName	ストレージアカウント名。	糸

UserAssignedIdentity

名前	形容	価値

クイックスタートのサンプル

次のクイックスタートサンプルでは、このリソースの種類をデプロイします。

Bicep ファイル	形容
Helm を使用して Azure Container Service (AKS) をする	Helm を使用して Azure Container Service (AKS) を使用してマネージドクラスターをデプロイする
Azure Windows ベースラインを使用して Azure Image Builder をする	Azure Image Builder 環境を作成し、最新の Windows 更新プログラムと Azure Windows ベースラインが適用された Windows Server イメージを構築します。
ACR タスクを使用してコンテナーイメージをビルドする	このテンプレートでは、DeploymentScript を使用して ACR を調整し、コードリポジトリからコンテナーイメージをビルドします。
Dev Box サービスの構成	このテンプレートでは、Dev Box クイックスタートガイド (/azure/dev-box/quickstart-create-dev-box) に従って、すべての Dev Box 管理リソースが作成されます。作成されたすべてのリソースを表示することも、DevPortal.microsoft.com に直接移動して最初の Dev Box を作成することもできます。
URI から BLOB ストレージコンテナーにファイルをコピー	このモジュールでは、URI からファイルをダウンロードし、Azure storageAccount BLOB コンテナーにコピーします。 storageAccount は既に存在し、ソースファイルは URI にステージングされている必要があります。
データファクトリコピーデータツールの BLOB の作成に関するクイックスタート	このテンプレートでは、BLOB ストレージを作成し、データコピーツールのクイックスタート用のファイルをアップロードします
出力 & 複雑な入力を含む配置スクリプトを作成する	このテンプレートは、Az CLI デプロイスクリプトに複雑な入力、出力、ログを渡して読み取るためのベストプラクティスを示しています
出力 & 複雑な入力を含む配置スクリプトを作成する	このテンプレートでは、複雑な入力、出力、ログを Az Powershell デプロイスクリプトに渡して読み取るためのベストプラクティスを示します
WordPress サイトを作成する	このテンプレートは、コンテナーインスタンスに WordPress サイトを作成します
Prometheus で AKS を作成し、privae リンクを使用して Grafana	これにより、Azure grafana、AKS が作成され、オープンソースの監視およびアラートツールキットである Prometheus が Azure Kubernetes Service (AKS) クラスターにインストールされます。次に、Azure Managed Grafana のマネージドプライベートエンドポイントを使用してこの Prometheus サーバーに接続し、Grafana ダッシュボードに Prometheus データを表示します
Azure Machine Learning スイープジョブを作成する	このテンプレートでは、ハイパーパラメーター調整用の Azure Machine Learning スイープジョブが作成されます。
Azure Virtual Network Manager とサンプル VNET を作成する	このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソースグループにデプロイします。複数の接続トポロジとネットワークグループメンバーシップの種類をサポートします。
永続ストレージを使用してオンデマンド SFTP サーバーを作成する	このテンプレートは、Azure Container Instance (ACI) を使用するオンデマンド SFTP サーバーを示しています。
証明書を使用して Application Gateway を作成する	このテンプレートでは、Key Vault の自己署名証明書を生成し、Application Gateway から参照する方法を示します。
レジストリを使用してコンテナーアプリと環境を作成する	Azure Container Registry から基本的なコンテナーアプリを使用してコンテナーアプリ環境を作成します。また、Log Analytics ワークスペースをデプロイしてログを格納します。
Container Apps を使用して Dapr マイクロサービスアプリを作成する	Container Apps を使用して Dapr マイクロサービスアプリを作成します。
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します	Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。
単純な Azure Spring Apps マイクロサービスアプリケーションをデプロイする	このテンプレートは、Azure 上で実行する単純な Azure Spring Apps マイクロサービスアプリケーションをデプロイします。
静的 Web サイトをデプロイします	バッキングストレージアカウントを使用して静的 Web サイトをデプロイします
FinOps ハブの	このテンプレートでは、Data Lake ストレージや Data Factory を含む新しい FinOps ハブインスタンスが作成されます。
Front Door Standard/Premium と静的な Web サイトの配信元	このテンプレートは、Front Door Standard/Premium と Azure Storage の静的 Web サイトを作成し、静的 Web サイトにトラフィックを送信するように Front Door を構成します。
ACR へのコンテナーイメージのインポートの	このテンプレートでは、bicep レジストリから ACR のインポートモジュールを利用して、パブリックコンテナーイメージを Azure Container Registry にインポートします。
Azure Data Factory でさらに多くの方法が可能 - ワンクリックで Azure Data Factory	このテンプレートは、Azure BLOB から別の Azure BLOB へのコピーアクティビティ用のデータファクトリパイプラインを作成します
Azure Firewall Premium のテスト環境	このテンプレートでは、侵入検査検出 (IDPS)、TLS 検査、Web カテゴリのフィルター処理などの Premium 機能を備えた Azure Firewall Premium とファイアウォールポリシーを作成します
デプロイスクリプトを使用して Azure AD オブジェクトを作成	このサンプルでは、デプロイスクリプトを使用して Azure Active Directory にオブジェクトを作成します。

ARM テンプレートリソース定義

deploymentScripts リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの - リソースグループのデプロイコマンド参照

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

リソースの形式

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

{
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "name": "string",
  "tags": {
    "{customized property}": "string"
  },
  "kind": "string"
  // For remaining properties, see Microsoft.Resources/deploymentScripts objects
}

Microsoft.Resources/deploymentScripts オブジェクト

の種類 プロパティを設定して、オブジェクトの種類を指定します。

AzureCLIをする場合は、次を使用します。

{
  "kind": "AzureCLI",
  "properties": {
    "arguments": "string",
    "azCliVersion": "string",
    "cleanupPreference": "string",
    "containerSettings": {
      "containerGroupName": "string",
      "subnetIds": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    },
    "environmentVariables": [
      {
        "name": "string",
        "secureValue": "string",
        "value": "string"
      }
    ],
    "forceUpdateTag": "string",
    "primaryScriptUri": "string",
    "retentionInterval": "string",
    "scriptContent": "string",
    "storageAccountSettings": {
      "storageAccountKey": "string",
      "storageAccountName": "string"
    },
    "supportingScriptUris": [ "string" ],
    "timeout": "string"
  }
}

AzurePowerShellをする場合は、次のコマンドを使用します。

{
  "kind": "AzurePowerShell",
  "properties": {
    "arguments": "string",
    "azPowerShellVersion": "string",
    "cleanupPreference": "string",
    "containerSettings": {
      "containerGroupName": "string",
      "subnetIds": [
        {
          "id": "string",
          "name": "string"
        }
      ]
    },
    "environmentVariables": [
      {
        "name": "string",
        "secureValue": "string",
        "value": "string"
      }
    ],
    "forceUpdateTag": "string",
    "primaryScriptUri": "string",
    "retentionInterval": "string",
    "scriptContent": "string",
    "storageAccountSettings": {
      "storageAccountKey": "string",
      "storageAccountName": "string"
    },
    "supportingScriptUris": [ "string" ],
    "timeout": "string"
  }
}

プロパティ値

AzureCliScript

名前	形容	価値
種類	スクリプトの種類。	'AzureCLI' (必須)
プロパティ	Azure CLI スクリプトオブジェクトのプロパティ。	AzureCliScriptProperties (必須)

AzureCliScriptProperties

名前	形容	価値
引数	スクリプトに渡すコマンドライン引数。引数はスペースで区切られます。例: -Name 青* -Location '米国西部 2'	糸
azCliVersion	使用する Azure CLI モジュールのバージョン。	string (必須)
cleanupPreference	スクリプトの実行が終了状態になったときのクリーンアップ設定。既定の設定は 'Always' です。	'Always' 'OnExpiration' 'OnSuccess'
containerSettings	コンテナーの設定。	ContainerConfiguration
environmentVariables	スクリプトに渡す環境変数。	EnvironmentVariable[]
forceUpdateTag	スクリプトリソースが変更されていない場合でも、デプロイスクリプトを強制的に実行する方法を取得または設定します。現在のタイムスタンプまたは GUID を指定できます。	糸
primaryScriptUri	スクリプトの URI。これは外部スクリプトのエントリポイントです。	糸
retentionInterval	サービスが終了状態に達した後にスクリプトリソースを保持する間隔。リソースは、この期間が経過すると削除されます。期間は ISO 8601 パターンに基づいています (たとえば、P1D は 1 日を意味します)。	string (必須)
scriptContent	スクリプト本文。	糸
storageAccountSettings	ストレージアカウントの設定。	StorageAccountConfiguration
supportingScriptUris	外部スクリプトのサポートファイル。	string[]
タイムアウト	ISO 8601 形式で指定されたスクリプト実行の最大許容時間。既定値は P1D です	糸

AzurePowerShellScript

名前	形容	価値
種類	スクリプトの種類。	'AzurePowerShell' (必須)
プロパティ	Azure PowerShell スクリプトオブジェクトのプロパティ。	AzurePowerShellScriptProperties (必須)

AzurePowerShellScriptProperties

名前	形容	価値
引数	スクリプトに渡すコマンドライン引数。引数はスペースで区切られます。例: -Name 青* -Location '米国西部 2'	糸
azPowerShellVersion	使用する Azure PowerShell モジュールのバージョン。	string (必須)
cleanupPreference	スクリプトの実行が終了状態になったときのクリーンアップ設定。既定の設定は 'Always' です。	'Always' 'OnExpiration' 'OnSuccess'
containerSettings	コンテナーの設定。	ContainerConfiguration
environmentVariables	スクリプトに渡す環境変数。	EnvironmentVariable[]
forceUpdateTag	スクリプトリソースが変更されていない場合でも、デプロイスクリプトを強制的に実行する方法を取得または設定します。現在のタイムスタンプまたは GUID を指定できます。	糸
primaryScriptUri	スクリプトの URI。これは外部スクリプトのエントリポイントです。	糸
retentionInterval	サービスが終了状態に達した後にスクリプトリソースを保持する間隔。リソースは、この期間が経過すると削除されます。期間は ISO 8601 パターンに基づいています (たとえば、P1D は 1 日を意味します)。	string (必須)
scriptContent	スクリプト本文。	糸
storageAccountSettings	ストレージアカウントの設定。	StorageAccountConfiguration
supportingScriptUris	外部スクリプトのサポートファイル。	string[]
タイムアウト	ISO 8601 形式で指定されたスクリプト実行の最大許容時間。既定値は P1D です	糸

ContainerConfiguration

名前	形容	価値
containerGroupName	コンテナーグループ名が指定されていない場合、名前は自動生成されます。 'containerGroupName' を指定しない場合は、システムが一意の名前を生成することを示します。これは、Azure Policy に非準拠としてフラグを設定する可能性があります。特定の名前付け規則が必要な Azure Policy がある場合、または名前を完全に制御する場合は、'containerGroupName' を使用します。 'containerGroupName' プロパティの長さは 1 ~ 63 文字にする必要があり、小文字、数字、ダッシュのみを含める必要があり、ダッシュで開始または終了することはできません。連続するダッシュは使用できません。 'containerGroupName' を指定するには、プロパティ { "containerSettings": { "containerGroupName": "contoso-container" } } に次のオブジェクトを追加します。 'containerGroupName' を指定しない場合は、'containerSettings' プロパティを追加しないでください。	糸制約：最小長 = 1 最大長 = 1
subnetIds	コンテナーグループのサブネットリソース ID。	ContainerGroupSubnetId[]

ContainerGroupSubnetId

名前	形容	価値
身分証明書	サブネットのリソース ID。	string (必須)
名前	サブネットのフレンドリ名。	糸

DeploymentScriptTags

名前	形容	価値

EnvironmentVariable

名前	形容	価値
名前	環境変数の名前。	string (必須)
secureValue	セキュリティで保護された環境変数の値。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
価値	環境変数の値。	糸

ManagedServiceIdentity

名前	形容	価値
種類	マネージド ID の種類。	'UserAssigned'
userAssignedIdentities	リソースに関連付けられているユーザー割り当てマネージド ID の一覧。キーは、マネージド ID の Azure リソース ID です。	ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前	形容	価値

Microsoft.Resources/deploymentScripts

名前	形容	価値
apiVersion	API のバージョン	'2023-08-01'
同一性	省略可能なプロパティ。このデプロイスクリプトに使用するマネージド ID。現時点では、ユーザー割り当て MSI のみがサポートされています。	ManagedServiceIdentity の
種類	AzureCliScriptの種類 'AzureCLI' に設定します。 AzurePowerShellScriptの種類 'AzurePowerShell' に設定します。	'AzureCLI' 'AzurePowerShell' (必須)
場所	デプロイスクリプトの ACI とストレージアカウントの場所。	string (必須)
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.Resources/deploymentScripts'

StorageAccountConfiguration

名前	形容	価値
storageAccountKey	ストレージアカウントのアクセスキー。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
storageAccountName	ストレージアカウント名。	糸

UserAssignedIdentity

名前	形容	価値

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
Helm を使用して Azure Container Service (AKS) をする Azure にデプロイする	Helm を使用して Azure Container Service (AKS) を使用してマネージドクラスターをデプロイする
Azure Windows ベースラインを使用して Azure Image Builder をする Azure にデプロイする	Azure Image Builder 環境を作成し、最新の Windows 更新プログラムと Azure Windows ベースラインが適用された Windows Server イメージを構築します。
ACR タスクを使用してコンテナーイメージをビルドする Azure にデプロイする	このテンプレートでは、DeploymentScript を使用して ACR を調整し、コードリポジトリからコンテナーイメージをビルドします。
Dev Box サービスの構成 Azure にデプロイする	このテンプレートでは、Dev Box クイックスタートガイド (/azure/dev-box/quickstart-create-dev-box) に従って、すべての Dev Box 管理リソースが作成されます。作成されたすべてのリソースを表示することも、DevPortal.microsoft.com に直接移動して最初の Dev Box を作成することもできます。
URI から BLOB ストレージコンテナーにファイルをコピー Azure にデプロイする	このモジュールでは、URI からファイルをダウンロードし、Azure storageAccount BLOB コンテナーにコピーします。 storageAccount は既に存在し、ソースファイルは URI にステージングされている必要があります。
データファクトリコピーデータツールの BLOB の作成に関するクイックスタート Azure にデプロイする	このテンプレートでは、BLOB ストレージを作成し、データコピーツールのクイックスタート用のファイルをアップロードします
出力 & 複雑な入力を含む配置スクリプトを作成する Azure にデプロイする	このテンプレートは、Az CLI デプロイスクリプトに複雑な入力、出力、ログを渡して読み取るためのベストプラクティスを示しています
出力 & 複雑な入力を含む配置スクリプトを作成する Azure にデプロイする	このテンプレートでは、複雑な入力、出力、ログを Az Powershell デプロイスクリプトに渡して読み取るためのベストプラクティスを示します
WordPress サイトを作成する Azure にデプロイする	このテンプレートは、コンテナーインスタンスに WordPress サイトを作成します
Prometheus で AKS を作成し、privae リンクを使用して Grafana Azure にデプロイする	これにより、Azure grafana、AKS が作成され、オープンソースの監視およびアラートツールキットである Prometheus が Azure Kubernetes Service (AKS) クラスターにインストールされます。次に、Azure Managed Grafana のマネージドプライベートエンドポイントを使用してこの Prometheus サーバーに接続し、Grafana ダッシュボードに Prometheus データを表示します
Azure Machine Learning スイープジョブを作成する Azure にデプロイする	このテンプレートでは、ハイパーパラメーター調整用の Azure Machine Learning スイープジョブが作成されます。
Azure Virtual Network Manager とサンプル VNET を作成する Azure にデプロイする	このテンプレートは、Azure Virtual Network Manager とサンプル仮想ネットワークを名前付きリソースグループにデプロイします。複数の接続トポロジとネットワークグループメンバーシップの種類をサポートします。
永続ストレージを使用してオンデマンド SFTP サーバーを作成する Azure にデプロイする	このテンプレートは、Azure Container Instance (ACI) を使用するオンデマンド SFTP サーバーを示しています。
証明書を使用して Application Gateway を作成する Azure にデプロイする	このテンプレートでは、Key Vault の自己署名証明書を生成し、Application Gateway から参照する方法を示します。
ssh キーを作成して KeyVault に格納する Azure にデプロイする	このテンプレートでは、deploymentScript リソースを使用して ssh キーを生成し、秘密キーを keyVault に格納します。
レジストリを使用してコンテナーアプリと環境を作成する Azure にデプロイする	Azure Container Registry から基本的なコンテナーアプリを使用してコンテナーアプリ環境を作成します。また、Log Analytics ワークスペースをデプロイしてログを格納します。
Container Apps を使用して Dapr マイクロサービスアプリを作成する Azure にデプロイする	Container Apps を使用して Dapr マイクロサービスアプリを作成します。
Container Apps を使用して Dapr pub-sub servicebus アプリを作成します Azure にデプロイする	Container Apps を使用して Dapr pub-sub servicebus アプリを作成します。
単純な Azure Spring Apps マイクロサービスアプリケーションをデプロイする Azure にデプロイする	このテンプレートは、Azure 上で実行する単純な Azure Spring Apps マイクロサービスアプリケーションをデプロイします。
静的 Web サイトをデプロイします Azure にデプロイする	バッキングストレージアカウントを使用して静的 Web サイトをデプロイします
FinOps ハブの Azure にデプロイする	このテンプレートでは、Data Lake ストレージや Data Factory を含む新しい FinOps ハブインスタンスが作成されます。
Front Door Standard/Premium と静的な Web サイトの配信元 Azure にデプロイする	このテンプレートは、Front Door Standard/Premium と Azure Storage の静的 Web サイトを作成し、静的 Web サイトにトラフィックを送信するように Front Door を構成します。
リモートビルドを使用した Linux 上の関数アプリの使用計画の Azure にデプロイする	このテンプレートは、Linux 従量課金プランで関数アプリをプロビジョニングし、コードのデプロイ中にリモートビルドを実行します。アプリはオンデマンドで実行され、継続的なリソースコミットメントなしで、実行ごとに課金されます。
ACR へのコンテナーイメージのインポートの Azure にデプロイする	このテンプレートでは、bicep レジストリから ACR のインポートモジュールを利用して、パブリックコンテナーイメージを Azure Container Registry にインポートします。
ZIP アーカイブ URL から VHD BLOB をインポートする Azure にデプロイする	特殊化されたディスクイメージに基づいて仮想マシンをデプロイするには、VHD ファイルをストレージアカウントにインポートする必要があります。 1 つの ZIP に圧縮された複数の VHD ファイルがあり、ZIP アーカイブをフェッチするための URL を取得した場合、この ARM テンプレートを使用すると、既存のストレージアカウント BLOB コンテナーへのダウンロード、抽出、インポートのジョブが容易になります。
Azure Gateway の min.io Azure にデプロイする	Blob Storage によってサポートされる S3 準拠ストレージ API を提供する完全プライベート min.io Azure Gateway デプロイ
Azure Data Factory でさらに多くの方法が可能 - ワンクリックで Azure Data Factory Azure にデプロイする	このテンプレートは、Azure BLOB から別の Azure BLOB へのコピーアクティビティ用のデータファクトリパイプラインを作成します
Azure Firewall Premium のテスト環境 Azure にデプロイする	このテンプレートでは、侵入検査検出 (IDPS)、TLS 検査、Web カテゴリのフィルター処理などの Premium 機能を備えた Azure Firewall Premium とファイアウォールポリシーを作成します
デプロイスクリプトを使用して Azure AD オブジェクトを作成 Azure にデプロイする	このサンプルでは、デプロイスクリプトを使用して Azure Active Directory にオブジェクトを作成します。

Terraform (AzAPI プロバイダー) リソース定義

deploymentScripts リソースの種類は、次をターゲットとする操作でデプロイできます。

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  kind = "string"
  // For remaining properties, see Microsoft.Resources/deploymentScripts objects
}

Microsoft.Resources/deploymentScripts オブジェクト

の種類 プロパティを設定して、オブジェクトの種類を指定します。

AzureCLIをする場合は、次を使用します。

{
  kind = "AzureCLI"
  properties = {
    arguments = "string"
    azCliVersion = "string"
    cleanupPreference = "string"
    containerSettings = {
      containerGroupName = "string"
      subnetIds = [
        {
          id = "string"
          name = "string"
        }
      ]
    }
    environmentVariables = [
      {
        name = "string"
        secureValue = "string"
        value = "string"
      }
    ]
    forceUpdateTag = "string"
    primaryScriptUri = "string"
    retentionInterval = "string"
    scriptContent = "string"
    storageAccountSettings = {
      storageAccountKey = "string"
      storageAccountName = "string"
    }
    supportingScriptUris = [
      "string"
    ]
    timeout = "string"
  }
}

AzurePowerShellをする場合は、次のコマンドを使用します。

{
  kind = "AzurePowerShell"
  properties = {
    arguments = "string"
    azPowerShellVersion = "string"
    cleanupPreference = "string"
    containerSettings = {
      containerGroupName = "string"
      subnetIds = [
        {
          id = "string"
          name = "string"
        }
      ]
    }
    environmentVariables = [
      {
        name = "string"
        secureValue = "string"
        value = "string"
      }
    ]
    forceUpdateTag = "string"
    primaryScriptUri = "string"
    retentionInterval = "string"
    scriptContent = "string"
    storageAccountSettings = {
      storageAccountKey = "string"
      storageAccountName = "string"
    }
    supportingScriptUris = [
      "string"
    ]
    timeout = "string"
  }
}

プロパティ値

AzureCliScript

名前	形容	価値
種類	スクリプトの種類。	'AzureCLI' (必須)
プロパティ	Azure CLI スクリプトオブジェクトのプロパティ。	AzureCliScriptProperties (必須)

AzureCliScriptProperties

名前	形容	価値
引数	スクリプトに渡すコマンドライン引数。引数はスペースで区切られます。例: -Name 青* -Location '米国西部 2'	糸
azCliVersion	使用する Azure CLI モジュールのバージョン。	string (必須)
cleanupPreference	スクリプトの実行が終了状態になったときのクリーンアップ設定。既定の設定は 'Always' です。	'Always' 'OnExpiration' 'OnSuccess'
containerSettings	コンテナーの設定。	ContainerConfiguration
environmentVariables	スクリプトに渡す環境変数。	EnvironmentVariable[]
forceUpdateTag	スクリプトリソースが変更されていない場合でも、デプロイスクリプトを強制的に実行する方法を取得または設定します。現在のタイムスタンプまたは GUID を指定できます。	糸
primaryScriptUri	スクリプトの URI。これは外部スクリプトのエントリポイントです。	糸
retentionInterval	サービスが終了状態に達した後にスクリプトリソースを保持する間隔。リソースは、この期間が経過すると削除されます。期間は ISO 8601 パターンに基づいています (たとえば、P1D は 1 日を意味します)。	string (必須)
scriptContent	スクリプト本文。	糸
storageAccountSettings	ストレージアカウントの設定。	StorageAccountConfiguration
supportingScriptUris	外部スクリプトのサポートファイル。	string[]
タイムアウト	ISO 8601 形式で指定されたスクリプト実行の最大許容時間。既定値は P1D です	糸

AzurePowerShellScript

名前	形容	価値
種類	スクリプトの種類。	'AzurePowerShell' (必須)
プロパティ	Azure PowerShell スクリプトオブジェクトのプロパティ。	AzurePowerShellScriptProperties (必須)

AzurePowerShellScriptProperties

名前	形容	価値
引数	スクリプトに渡すコマンドライン引数。引数はスペースで区切られます。例: -Name 青* -Location '米国西部 2'	糸
azPowerShellVersion	使用する Azure PowerShell モジュールのバージョン。	string (必須)
cleanupPreference	スクリプトの実行が終了状態になったときのクリーンアップ設定。既定の設定は 'Always' です。	'Always' 'OnExpiration' 'OnSuccess'
containerSettings	コンテナーの設定。	ContainerConfiguration
environmentVariables	スクリプトに渡す環境変数。	EnvironmentVariable[]
forceUpdateTag	スクリプトリソースが変更されていない場合でも、デプロイスクリプトを強制的に実行する方法を取得または設定します。現在のタイムスタンプまたは GUID を指定できます。	糸
primaryScriptUri	スクリプトの URI。これは外部スクリプトのエントリポイントです。	糸
retentionInterval	サービスが終了状態に達した後にスクリプトリソースを保持する間隔。リソースは、この期間が経過すると削除されます。期間は ISO 8601 パターンに基づいています (たとえば、P1D は 1 日を意味します)。	string (必須)
scriptContent	スクリプト本文。	糸
storageAccountSettings	ストレージアカウントの設定。	StorageAccountConfiguration
supportingScriptUris	外部スクリプトのサポートファイル。	string[]
タイムアウト	ISO 8601 形式で指定されたスクリプト実行の最大許容時間。既定値は P1D です	糸

ContainerConfiguration

名前	形容	価値
containerGroupName	コンテナーグループ名が指定されていない場合、名前は自動生成されます。 'containerGroupName' を指定しない場合は、システムが一意の名前を生成することを示します。これは、Azure Policy に非準拠としてフラグを設定する可能性があります。特定の名前付け規則が必要な Azure Policy がある場合、または名前を完全に制御する場合は、'containerGroupName' を使用します。 'containerGroupName' プロパティの長さは 1 ~ 63 文字にする必要があり、小文字、数字、ダッシュのみを含める必要があり、ダッシュで開始または終了することはできません。連続するダッシュは使用できません。 'containerGroupName' を指定するには、プロパティ { "containerSettings": { "containerGroupName": "contoso-container" } } に次のオブジェクトを追加します。 'containerGroupName' を指定しない場合は、'containerSettings' プロパティを追加しないでください。	糸制約：最小長 = 1 最大長 = 1
subnetIds	コンテナーグループのサブネットリソース ID。	ContainerGroupSubnetId[]

ContainerGroupSubnetId

名前	形容	価値
身分証明書	サブネットのリソース ID。	string (必須)
名前	サブネットのフレンドリ名。	糸

DeploymentScriptTags

名前	形容	価値

EnvironmentVariable

名前	形容	価値
名前	環境変数の名前。	string (必須)
secureValue	セキュリティで保護された環境変数の値。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
価値	環境変数の値。	糸

ManagedServiceIdentity

名前	形容	価値
種類	マネージド ID の種類。	'UserAssigned'
userAssignedIdentities	リソースに関連付けられているユーザー割り当てマネージド ID の一覧。キーは、マネージド ID の Azure リソース ID です。	ManagedServiceIdentityUserAssignedIdentities の

ManagedServiceIdentityUserAssignedIdentities

名前	形容	価値

Microsoft.Resources/deploymentScripts

名前	形容	価値
同一性	省略可能なプロパティ。このデプロイスクリプトに使用するマネージド ID。現時点では、ユーザー割り当て MSI のみがサポートされています。	ManagedServiceIdentity の
種類	AzureCliScriptの種類 'AzureCLI' に設定します。 AzurePowerShellScriptの種類 'AzurePowerShell' に設定します。	'AzureCLI' 'AzurePowerShell' (必須)
場所	デプロイスクリプトの ACI とストレージアカウントの場所。	string (必須)
名前	リソース名	糸制約：最小長 = 1 最大長 = 1 (必須)
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.Resources/deploymentScripts@2023-08-01"

StorageAccountConfiguration

名前	形容	価値
storageAccountKey	ストレージアカウントのアクセスキー。	糸制約：機密性の高い値。セキュリティで保護されたパラメーターとして渡します。
storageAccountName	ストレージアカウント名。	糸

UserAssignedIdentity

名前	形容	価値

次の方法で共有

Microsoft.Resources deploymentScripts 2023-08-01

備考

Bicep リソース定義

リソースの形式

Microsoft.Resources/deploymentScripts オブジェクト

プロパティ値

AzureCliScript

AzureCliScriptProperties

AzurePowerShellScript

AzurePowerShellScriptProperties

ContainerConfiguration

ContainerGroupSubnetId

DeploymentScriptTags

EnvironmentVariable

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Resources/deploymentScripts

StorageAccountConfiguration

UserAssignedIdentity

クイック スタートのサンプル

ARM テンプレート リソース定義

リソースの形式

Microsoft.Resources/deploymentScripts オブジェクト

プロパティ値

AzureCliScript

AzureCliScriptProperties

AzurePowerShellScript

AzurePowerShellScriptProperties

ContainerConfiguration

ContainerGroupSubnetId

DeploymentScriptTags

EnvironmentVariable

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Resources/deploymentScripts

StorageAccountConfiguration

UserAssignedIdentity

クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソースの形式

Microsoft.Resources/deploymentScripts オブジェクト

プロパティ値

AzureCliScript

AzureCliScriptProperties

AzurePowerShellScript

AzurePowerShellScriptProperties

ContainerConfiguration

ContainerGroupSubnetId

DeploymentScriptTags

EnvironmentVariable

ManagedServiceIdentity

ManagedServiceIdentityUserAssignedIdentities

Microsoft.Resources/deploymentScripts

StorageAccountConfiguration

UserAssignedIdentity

フィードバック

その他のリソース

クイックスタートのサンプル

ARM テンプレートリソース定義

クイックスタートテンプレート