Microsoft.Databricks ワークスペース 2023-09-15-preview

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

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.Databricks/workspaces@2023-09-15-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    authorizations: [
      {
        principalId: 'string'
        roleDefinitionId: 'string'
      }
    ]
    createdBy: {}
    defaultCatalog: {
      initialName: 'string'
      initialType: 'string'
    }
    encryption: {
      entities: {
        managedDisk: {
          keySource: 'string'
          keyVaultProperties: {
            keyName: 'string'
            keyVaultUri: 'string'
            keyVersion: 'string'
          }
          rotationToLatestKeyVersionEnabled: bool
        }
        managedServices: {
          keySource: 'string'
          keyVaultProperties: {
            keyName: 'string'
            keyVaultUri: 'string'
            keyVersion: 'string'
          }
        }
      }
    }
    enhancedSecurityCompliance: {
      automaticClusterUpdate: {
        value: 'string'
      }
      complianceSecurityProfile: {
        complianceStandards: [
          'string'
        ]
        value: 'string'
      }
      enhancedSecurityMonitoring: {
        value: 'string'
      }
    }
    managedDiskIdentity: {}
    managedResourceGroupId: 'string'
    parameters: {
      amlWorkspaceId: {
        value: 'string'
      }
      customPrivateSubnetName: {
        value: 'string'
      }
      customPublicSubnetName: {
        value: 'string'
      }
      customVirtualNetworkId: {
        value: 'string'
      }
      enableNoPublicIp: {
        value: bool
      }
      encryption: {
        value: {
          KeyName: 'string'
          keySource: 'string'
          keyvaulturi: 'string'
          keyversion: 'string'
        }
      }
      loadBalancerBackendPoolName: {
        value: 'string'
      }
      loadBalancerId: {
        value: 'string'
      }
      natGatewayName: {
        value: 'string'
      }
      prepareEncryption: {
        value: bool
      }
      publicIpName: {
        value: 'string'
      }
      requireInfrastructureEncryption: {
        value: bool
      }
      storageAccountName: {
        value: 'string'
      }
      storageAccountSkuName: {
        value: 'string'
      }
      vnetAddressPrefix: {
        value: 'string'
      }
    }
    publicNetworkAccess: 'string'
    requiredNsgRules: 'string'
    storageAccountIdentity: {}
    uiDefinitionUri: 'string'
    updatedBy: {}
  }
  sku: {
    name: 'string'
    tier: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

プロパティ値

AutomaticClusterUpdateDefinition

名前	形容	価値
価値		'Disabled' 'Enabled'

ComplianceSecurityProfileDefinition

名前	形容	価値
complianceStandards	ワークスペースに関連付けられているコンプライアンス標準。	次のいずれかを含む文字列配列: 'HIPAA' 'NONE' 'PCI_DSS'
価値		'Disabled' 'Enabled'

CreatedBy

名前	形容	価値

DefaultCatalogProperties

名前	形容	価値
initialName	既定のカタログの初期名を指定します。指定しない場合は、ワークスペースの名前が使用されます。	糸
initialType	既定のカタログの初期型を定義します。使用可能な値 (大文字と小文字を区別しない): HiveMetastore、UnityCatalog	'HiveMetastore' 'UnityCatalog'

暗号化

名前	形容	価値
KeyName	KeyVault キーの名前。	糸
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): 既定値、Microsoft.Keyvault	'Default' 'Microsoft.Keyvault'
keyvaulturi	KeyVault の URI。	糸
keyversion	KeyVault キーのバージョン。	糸

EncryptionEntitiesDefinition

名前	形容	価値
managedDisk	databricks マネージドディスクの暗号化プロパティ。	ManagedDiskEncryption の
managedServices	databricks マネージドサービスの暗号化プロパティ。	EncryptionV2

EncryptionV2

名前	形容	価値
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault	'Microsoft.Keyvault' (必須)
keyVaultProperties	暗号化用の Key Vault 入力プロパティ。	EncryptionV2KeyVaultProperties

EncryptionV2KeyVaultProperties

名前	形容	価値
keyName	KeyVault キーの名前。	string (必須)
keyVaultUri	KeyVault の URI。	string (必須)
keyVersion	KeyVault キーのバージョン。	string (必須)

EnhancedSecurityComplianceDefinition

名前	形容	価値
automaticClusterUpdate	自動クラスター更新機能の状態。	AutomaticClusterUpdateDefinition の
complianceSecurityProfile	コンプライアンスセキュリティプロファイル機能の状態。	ComplianceSecurityProfileDefinition
enhancedSecurityMonitoring	セキュリティ強化監視機能の状態。	EnhancedSecurityMonitoringDefinition の

EnhancedSecurityMonitoringDefinition

名前	形容	価値
価値		'Disabled' 'Enabled'

ManagedDiskEncryption

名前	形容	価値
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault	'Microsoft.Keyvault' (必須)
keyVaultProperties	暗号化用の Key Vault 入力プロパティ。	ManagedDiskEncryptionKeyVaultProperties の (必須)
rotationToLatestKeyVersionEnabled	マネージドディスク暗号化に最新のキーバージョンを自動的に使用するかどうかを指定します。	bool

ManagedDiskEncryptionKeyVaultProperties

名前	形容	価値
keyName	KeyVault キーの名前。	string (必須)
keyVaultUri	KeyVault の URI。	string (必須)
keyVersion	KeyVault キーのバージョン。	string (必須)

ManagedIdentityConfiguration

名前	形容	価値

Microsoft.Databricks/workspaces

名前	形容	価値
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 3 最大長 = 3 (必須)
プロパティ	ワークスペースのプロパティ。	WorkspaceProperties (必須)
sku	リソースの SKU。	SKU
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください

SKU

名前	形容	価値
名前	SKU 名。	string (必須)
層	SKU レベル。	糸

TrackedResourceTags

名前	形容	価値

WorkspaceCustomBooleanParameter

名前	形容	価値
価値	このフィールドに使用する値。	bool (必須)

WorkspaceCustomParameters

名前	形容	価値
amlWorkspaceId	Databricks ワークスペースとリンクする Azure Machine Learning ワークスペースの ID	WorkspaceCustomStringParameter
customPrivateSubnetName	仮想ネットワーク内のプライベートサブネットの名前	WorkspaceCustomStringParameter
customPublicSubnetName	仮想ネットワーク内のパブリックサブネットの名前	WorkspaceCustomStringParameter
customVirtualNetworkId	この Databricks クラスターを作成する必要がある仮想ネットワークの ID	WorkspaceCustomStringParameter
enableNoPublicIp	パブリック IP を無効にする必要がありますか?	WorkspaceCustomBooleanParameter
暗号化	Customer-Managed キー (CMK) が有効なワークスペースの暗号化の詳細が含まれています。	WorkspaceEncryptionParameter
loadBalancerBackendPoolName	セキュリティで保護されたクラスター接続用の送信ロードバランサーバックエンドプールの名前 (パブリック IP なし)。	WorkspaceCustomStringParameter
loadBalancerId	セキュリティで保護されたクラスター接続 (パブリック IP なし) ワークスペースの送信ロードバランサーのリソース URI。	WorkspaceCustomStringParameter
natGatewayName	セキュリティで保護されたクラスター接続 (パブリック IP なし) ワークスペースサブネットの NAT ゲートウェイの名前。	WorkspaceCustomStringParameter
prepareEncryption	暗号化用にワークスペースを準備します。マネージドストレージアカウントのマネージド ID を有効にします。	WorkspaceCustomBooleanParameter
publicIpName	マネージド vNet を持つパブリック IP なしワークスペースのパブリック IP の名前。	WorkspaceCustomStringParameter
requireInfrastructureEncryption	保存データのプラットフォームマネージドキーによる暗号化のセカンダリレイヤーで DBFS ルートファイルシステムを有効にするかどうかを示すブール値。	WorkspaceCustomBooleanParameter
storageAccountName	既定の DBFS ストレージアカウント名。	WorkspaceCustomStringParameter
storageAccountSkuName	ストレージアカウント SKU 名 (例: Standard_GRS、Standard_LRS)。有効な入力については、https://aka.ms/storageskus を参照してください。	WorkspaceCustomStringParameter
vnetAddressPrefix	マネージド仮想ネットワークのアドレスプレフィックス。この入力の既定値は 10.139 です。	WorkspaceCustomStringParameter

WorkspaceCustomStringParameter

名前	形容	価値
価値	このフィールドに使用する値。	string (必須)

WorkspaceEncryptionParameter

名前	形容	価値
価値	このフィールドに使用する値。	暗号化

WorkspaceProperties

名前	形容	価値
権限	ワークスペースプロバイダーの承認。	WorkspaceProviderAuthorization[]
createdBy	ワークスペースを作成したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。	CreatedBy
defaultCatalog	ワークスペースの作成時の既定のカタログ構成のプロパティ。	DefaultCatalogProperties の
暗号化	databricks ワークスペースの暗号化プロパティ	WorkspacePropertiesEncryption
enhancedSecurityCompliance	セキュリティ強化およびコンプライアンスアドオンに関連する設定が含まれています。	EnhancedSecurityComplianceDefinition の
managedDiskIdentity	マネージドディスク暗号化に使用されるディスク暗号化セットのマネージド ID の詳細	ManagedIdentityConfiguration
managedResourceGroupId	マネージドリソースグループ ID。	string (必須)
パラメーター	ワークスペースのカスタムパラメーター。	WorkspaceCustomParameters
publicNetworkAccess	ワークスペースにアクセスするためのネットワークアクセスの種類。プライベートリンク経由でのみワークスペースにアクセスするには、値を無効に設定します。	'Disabled' 'Enabled'
requiredNsgRules	コントロールプレーン通信を制御するデータプレーン (クラスター) がプライベートエンドポイント経由で行われるかどうかを示す値を取得または設定します。サポートされている値は、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部でのみ使用されます。	'AllRules' 'NoAzureDatabricksRules' 'NoAzureServiceRules'
storageAccountIdentity	ストレージアカウントのマネージド ID の詳細	ManagedIdentityConfiguration
uiDefinitionUri	UI 定義ファイルが配置されている BLOB URI。	糸
updatedBy	ワークスペースを最後に更新したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。	CreatedBy

WorkspacePropertiesEncryption

名前	形容	価値
エンティティ	ワークスペースの暗号化エンティティ定義。	EncryptionEntitiesDefinition (必須)

WorkspaceProviderAuthorization

名前	形容	価値
principalId	プロバイダーのプリンシパル識別子。これは、プロバイダーが ARM を呼び出してワークスペースリソースを管理するために使用する ID です。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (必須)
roleDefinitionId	プロバイダーのロール定義識別子。このロールは、プロバイダーがワークスペースのコンテナーリソースグループに対して持つ必要があるすべてのアクセス許可を定義します。このロール定義には、リソースグループを削除するアクセス許可を持つことはできません。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (必須)

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

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

Bicep ファイル	形容
Azure Databricks All-in-one Templat VNetInjection-Pvtendpt	このテンプレートを使用すると、ネットワークセキュリティグループ、仮想ネットワーク、仮想ネットワークを含む Azure Databricks ワークスペース、およびプライベートエンドポイントを作成できます。
VNet インジェクション用の Azure Databricks オールインワンテンプレートの	このテンプレートを使用すると、ネットワークセキュリティグループ、仮想ネットワーク、NAT ゲートウェイ、および仮想ネットワークを含む Azure Databricks ワークスペースを作成できます。
カスタムアドレス範囲を使用して Azure Databricks ワークスペースをする	このテンプレートを使用すると、カスタム仮想ネットワークアドレス範囲を持つ Azure Databricks ワークスペースを作成できます。
VNet インジェクションを使用して Azure Databricks ワークスペースをする	このテンプレートを使用すると、カスタム仮想ネットワークを使用して Azure Databricks ワークスペースを作成できます。
既定のストレージファイアウォール用の AzureDatabricks テンプレートの	このテンプレートを使用すると、仮想ネットワークとシステム割り当てアクセスコネクタを使用して、ネットワークセキュリティグループ、仮想ネットワーク、プライベートエンドポイント、および既定のストレージファイアウォールが有効な Azure Databricks ワークスペースを作成できます。
NAT ゲートウェイを使用した VNet インジェクション用の AzureDatabricks テンプレートの	このテンプレートを使用すると、NAT ゲートウェイ、ネットワークセキュリティグループ、仮想ネットワーク、仮想ネットワークを含む Azure Databricks ワークスペースを作成できます。
VNetInjection と Load Balancer 用の AzureDatabricks テンプレートの	このテンプレートを使用すると、ロードバランサー、ネットワークセキュリティグループ、仮想ネットワーク、仮想ネットワークを含む Azure Databricks ワークスペースを作成できます。
Azure Databricks ワークスペースをデプロイする	このテンプレートを使用すると、Azure Databricks ワークスペースを作成できます。
CMK のすべての 3 つの形式で Azure Databricks ワークスペースをデプロイする	このテンプレートを使用すると、マネージドサービスを使用して Azure Databricks ワークスペースを作成し、DBFS 暗号化を使用して CMK を作成できます。
Managed Disks CMK を使用して Azure Databricks ワークスペースをデプロイ	このテンプレートを使用すると、Managed Disks CMK を使用して Azure Databricks ワークスペースを作成できます。
DBFS 暗号化用の CMK を使用して Azure Databricks WS をデプロイする	このテンプレートを使用すると、DBFS ルート暗号化用の CMK を使用して Azure Databricks ワークスペースを作成できます
Managed Services CMK を使用して Azure Databricks ワークスペースをデプロイする	このテンプレートを使用すると、Managed Services CMK を使用して Azure Databricks ワークスペースを作成できます。
Azure アーキテクチャに Sports Analytics をデプロイする	ADLS Gen 2 が有効な Azure ストレージアカウント、ストレージアカウントのリンクされたサービスを持つ Azure Data Factory インスタンス (デプロイされている場合は Azure SQL Database)、Azure Databricks インスタンスを作成します。テンプレートをデプロイするユーザーの AAD ID と ADF インスタンスのマネージド ID には、ストレージアカウントのストレージ BLOB データ共同作成者ロールが付与されます。 Azure Key Vault インスタンス、Azure SQL Database、Azure Event Hub (ストリーミングユースケース用) をデプロイするオプションもあります。 Azure Key Vault がデプロイされると、テンプレートをデプロイするユーザーのデータファクトリマネージド ID と AAD ID に Key Vault シークレットユーザーロールが付与されます。

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.Databricks/workspaces",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "authorizations": [
      {
        "principalId": "string",
        "roleDefinitionId": "string"
      }
    ],
    "createdBy": {
    },
    "defaultCatalog": {
      "initialName": "string",
      "initialType": "string"
    },
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "string",
          "keyVaultProperties": {
            "keyName": "string",
            "keyVaultUri": "string",
            "keyVersion": "string"
          },
          "rotationToLatestKeyVersionEnabled": "bool"
        },
        "managedServices": {
          "keySource": "string",
          "keyVaultProperties": {
            "keyName": "string",
            "keyVaultUri": "string",
            "keyVersion": "string"
          }
        }
      }
    },
    "enhancedSecurityCompliance": {
      "automaticClusterUpdate": {
        "value": "string"
      },
      "complianceSecurityProfile": {
        "complianceStandards": [ "string" ],
        "value": "string"
      },
      "enhancedSecurityMonitoring": {
        "value": "string"
      }
    },
    "managedDiskIdentity": {
    },
    "managedResourceGroupId": "string",
    "parameters": {
      "amlWorkspaceId": {
        "value": "string"
      },
      "customPrivateSubnetName": {
        "value": "string"
      },
      "customPublicSubnetName": {
        "value": "string"
      },
      "customVirtualNetworkId": {
        "value": "string"
      },
      "enableNoPublicIp": {
        "value": "bool"
      },
      "encryption": {
        "value": {
          "KeyName": "string",
          "keySource": "string",
          "keyvaulturi": "string",
          "keyversion": "string"
        }
      },
      "loadBalancerBackendPoolName": {
        "value": "string"
      },
      "loadBalancerId": {
        "value": "string"
      },
      "natGatewayName": {
        "value": "string"
      },
      "prepareEncryption": {
        "value": "bool"
      },
      "publicIpName": {
        "value": "string"
      },
      "requireInfrastructureEncryption": {
        "value": "bool"
      },
      "storageAccountName": {
        "value": "string"
      },
      "storageAccountSkuName": {
        "value": "string"
      },
      "vnetAddressPrefix": {
        "value": "string"
      }
    },
    "publicNetworkAccess": "string",
    "requiredNsgRules": "string",
    "storageAccountIdentity": {
    },
    "uiDefinitionUri": "string",
    "updatedBy": {
    }
  },
  "sku": {
    "name": "string",
    "tier": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

プロパティ値

AutomaticClusterUpdateDefinition

名前	形容	価値
価値		'Disabled' 'Enabled'

ComplianceSecurityProfileDefinition

名前	形容	価値
complianceStandards	ワークスペースに関連付けられているコンプライアンス標準。	次のいずれかを含む文字列配列: 'HIPAA' 'NONE' 'PCI_DSS'
価値		'Disabled' 'Enabled'

CreatedBy

名前	形容	価値

DefaultCatalogProperties

名前	形容	価値
initialName	既定のカタログの初期名を指定します。指定しない場合は、ワークスペースの名前が使用されます。	糸
initialType	既定のカタログの初期型を定義します。使用可能な値 (大文字と小文字を区別しない): HiveMetastore、UnityCatalog	'HiveMetastore' 'UnityCatalog'

暗号化

名前	形容	価値
KeyName	KeyVault キーの名前。	糸
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): 既定値、Microsoft.Keyvault	'Default' 'Microsoft.Keyvault'
keyvaulturi	KeyVault の URI。	糸
keyversion	KeyVault キーのバージョン。	糸

EncryptionEntitiesDefinition

名前	形容	価値
managedDisk	databricks マネージドディスクの暗号化プロパティ。	ManagedDiskEncryption の
managedServices	databricks マネージドサービスの暗号化プロパティ。	EncryptionV2

EncryptionV2

名前	形容	価値
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault	'Microsoft.Keyvault' (必須)
keyVaultProperties	暗号化用の Key Vault 入力プロパティ。	EncryptionV2KeyVaultProperties

EncryptionV2KeyVaultProperties

名前	形容	価値
keyName	KeyVault キーの名前。	string (必須)
keyVaultUri	KeyVault の URI。	string (必須)
keyVersion	KeyVault キーのバージョン。	string (必須)

EnhancedSecurityComplianceDefinition

名前	形容	価値
automaticClusterUpdate	自動クラスター更新機能の状態。	AutomaticClusterUpdateDefinition の
complianceSecurityProfile	コンプライアンスセキュリティプロファイル機能の状態。	ComplianceSecurityProfileDefinition
enhancedSecurityMonitoring	セキュリティ強化監視機能の状態。	EnhancedSecurityMonitoringDefinition の

EnhancedSecurityMonitoringDefinition

名前	形容	価値
価値		'Disabled' 'Enabled'

ManagedDiskEncryption

名前	形容	価値
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault	'Microsoft.Keyvault' (必須)
keyVaultProperties	暗号化用の Key Vault 入力プロパティ。	ManagedDiskEncryptionKeyVaultProperties の (必須)
rotationToLatestKeyVersionEnabled	マネージドディスク暗号化に最新のキーバージョンを自動的に使用するかどうかを指定します。	bool

ManagedDiskEncryptionKeyVaultProperties

名前	形容	価値
keyName	KeyVault キーの名前。	string (必須)
keyVaultUri	KeyVault の URI。	string (必須)
keyVersion	KeyVault キーのバージョン。	string (必須)

ManagedIdentityConfiguration

名前	形容	価値

Microsoft.Databricks/workspaces

名前	形容	価値
apiVersion	API のバージョン	'2023-09-15-preview'
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 3 最大長 = 3 (必須)
プロパティ	ワークスペースのプロパティ。	WorkspaceProperties (必須)
sku	リソースの SKU。	SKU
タグ	リソースタグ	タグ名と値のディクショナリ。テンプレートのタグを参照してください
種類	リソースの種類	'Microsoft.Databricks/workspaces'

SKU

名前	形容	価値
名前	SKU 名。	string (必須)
層	SKU レベル。	糸

TrackedResourceTags

名前	形容	価値

WorkspaceCustomBooleanParameter

名前	形容	価値
価値	このフィールドに使用する値。	bool (必須)

WorkspaceCustomParameters

名前	形容	価値
amlWorkspaceId	Databricks ワークスペースとリンクする Azure Machine Learning ワークスペースの ID	WorkspaceCustomStringParameter
customPrivateSubnetName	仮想ネットワーク内のプライベートサブネットの名前	WorkspaceCustomStringParameter
customPublicSubnetName	仮想ネットワーク内のパブリックサブネットの名前	WorkspaceCustomStringParameter
customVirtualNetworkId	この Databricks クラスターを作成する必要がある仮想ネットワークの ID	WorkspaceCustomStringParameter
enableNoPublicIp	パブリック IP を無効にする必要がありますか?	WorkspaceCustomBooleanParameter
暗号化	Customer-Managed キー (CMK) が有効なワークスペースの暗号化の詳細が含まれています。	WorkspaceEncryptionParameter
loadBalancerBackendPoolName	セキュリティで保護されたクラスター接続用の送信ロードバランサーバックエンドプールの名前 (パブリック IP なし)。	WorkspaceCustomStringParameter
loadBalancerId	セキュリティで保護されたクラスター接続 (パブリック IP なし) ワークスペースの送信ロードバランサーのリソース URI。	WorkspaceCustomStringParameter
natGatewayName	セキュリティで保護されたクラスター接続 (パブリック IP なし) ワークスペースサブネットの NAT ゲートウェイの名前。	WorkspaceCustomStringParameter
prepareEncryption	暗号化用にワークスペースを準備します。マネージドストレージアカウントのマネージド ID を有効にします。	WorkspaceCustomBooleanParameter
publicIpName	マネージド vNet を持つパブリック IP なしワークスペースのパブリック IP の名前。	WorkspaceCustomStringParameter
requireInfrastructureEncryption	保存データのプラットフォームマネージドキーによる暗号化のセカンダリレイヤーで DBFS ルートファイルシステムを有効にするかどうかを示すブール値。	WorkspaceCustomBooleanParameter
storageAccountName	既定の DBFS ストレージアカウント名。	WorkspaceCustomStringParameter
storageAccountSkuName	ストレージアカウント SKU 名 (例: Standard_GRS、Standard_LRS)。有効な入力については、https://aka.ms/storageskus を参照してください。	WorkspaceCustomStringParameter
vnetAddressPrefix	マネージド仮想ネットワークのアドレスプレフィックス。この入力の既定値は 10.139 です。	WorkspaceCustomStringParameter

WorkspaceCustomStringParameter

名前	形容	価値
価値	このフィールドに使用する値。	string (必須)

WorkspaceEncryptionParameter

名前	形容	価値
価値	このフィールドに使用する値。	暗号化

WorkspaceProperties

名前	形容	価値
権限	ワークスペースプロバイダーの承認。	WorkspaceProviderAuthorization[]
createdBy	ワークスペースを作成したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。	CreatedBy
defaultCatalog	ワークスペースの作成時の既定のカタログ構成のプロパティ。	DefaultCatalogProperties の
暗号化	databricks ワークスペースの暗号化プロパティ	WorkspacePropertiesEncryption
enhancedSecurityCompliance	セキュリティ強化およびコンプライアンスアドオンに関連する設定が含まれています。	EnhancedSecurityComplianceDefinition の
managedDiskIdentity	マネージドディスク暗号化に使用されるディスク暗号化セットのマネージド ID の詳細	ManagedIdentityConfiguration
managedResourceGroupId	マネージドリソースグループ ID。	string (必須)
パラメーター	ワークスペースのカスタムパラメーター。	WorkspaceCustomParameters
publicNetworkAccess	ワークスペースにアクセスするためのネットワークアクセスの種類。プライベートリンク経由でのみワークスペースにアクセスするには、値を無効に設定します。	'Disabled' 'Enabled'
requiredNsgRules	コントロールプレーン通信を制御するデータプレーン (クラスター) がプライベートエンドポイント経由で行われるかどうかを示す値を取得または設定します。サポートされている値は、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部でのみ使用されます。	'AllRules' 'NoAzureDatabricksRules' 'NoAzureServiceRules'
storageAccountIdentity	ストレージアカウントのマネージド ID の詳細	ManagedIdentityConfiguration
uiDefinitionUri	UI 定義ファイルが配置されている BLOB URI。	糸
updatedBy	ワークスペースを最後に更新したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。	CreatedBy

WorkspacePropertiesEncryption

名前	形容	価値
エンティティ	ワークスペースの暗号化エンティティ定義。	EncryptionEntitiesDefinition (必須)

WorkspaceProviderAuthorization

名前	形容	価値
principalId	プロバイダーのプリンシパル識別子。これは、プロバイダーが ARM を呼び出してワークスペースリソースを管理するために使用する ID です。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (必須)
roleDefinitionId	プロバイダーのロール定義識別子。このロールは、プロバイダーがワークスペースのコンテナーリソースグループに対して持つ必要があるすべてのアクセス許可を定義します。このロール定義には、リソースグループを削除するアクセス許可を持つことはできません。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (必須)

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

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

テンプレート	形容
Azure Databricks All-in-one Templat VNetInjection-Pvtendpt Azure にデプロイする	このテンプレートを使用すると、ネットワークセキュリティグループ、仮想ネットワーク、仮想ネットワークを含む Azure Databricks ワークスペース、およびプライベートエンドポイントを作成できます。
VNet インジェクション用の Azure Databricks オールインワンテンプレートの Azure にデプロイする	このテンプレートを使用すると、ネットワークセキュリティグループ、仮想ネットワーク、NAT ゲートウェイ、および仮想ネットワークを含む Azure Databricks ワークスペースを作成できます。
カスタムアドレス範囲を使用して Azure Databricks ワークスペースをする Azure にデプロイする	このテンプレートを使用すると、カスタム仮想ネットワークアドレス範囲を持つ Azure Databricks ワークスペースを作成できます。
VNet インジェクションを使用して Azure Databricks ワークスペースをする Azure にデプロイする	このテンプレートを使用すると、カスタム仮想ネットワークを使用して Azure Databricks ワークスペースを作成できます。
既定のストレージファイアウォール用の AzureDatabricks テンプレートの Azure にデプロイする	このテンプレートを使用すると、仮想ネットワークとシステム割り当てアクセスコネクタを使用して、ネットワークセキュリティグループ、仮想ネットワーク、プライベートエンドポイント、および既定のストレージファイアウォールが有効な Azure Databricks ワークスペースを作成できます。
NAT ゲートウェイを使用した VNet インジェクション用の AzureDatabricks テンプレートの Azure にデプロイする	このテンプレートを使用すると、NAT ゲートウェイ、ネットワークセキュリティグループ、仮想ネットワーク、仮想ネットワークを含む Azure Databricks ワークスペースを作成できます。
VNetInjection と Load Balancer 用の AzureDatabricks テンプレートの Azure にデプロイする	このテンプレートを使用すると、ロードバランサー、ネットワークセキュリティグループ、仮想ネットワーク、仮想ネットワークを含む Azure Databricks ワークスペースを作成できます。
既定のストレージファイアウォールを使用した AzureDatabricks テンプレートの Azure にデプロイする	このテンプレートを使用すると、Privateendpoint、3 つの形式の CMK、User-Assigned Access Connector を使用して、既定のストレージファイアウォールが有効な Azure Databricks ワークスペースを作成できます。
Azure Databricks ワークスペースをデプロイする Azure にデプロイする	このテンプレートを使用すると、Azure Databricks ワークスペースを作成できます。
CMK のすべての 3 つの形式で Azure Databricks ワークスペースをデプロイする Azure にデプロイする	このテンプレートを使用すると、マネージドサービスを使用して Azure Databricks ワークスペースを作成し、DBFS 暗号化を使用して CMK を作成できます。
Managed Disks CMK を使用して Azure Databricks ワークスペースをデプロイ Azure にデプロイする	このテンプレートを使用すると、Managed Disks CMK を使用して Azure Databricks ワークスペースを作成できます。
PE、CMK のすべてのフォームを使用して Azure Databricks ワークスペースをデプロイ Azure にデプロイする	このテンプレートを使用すると、PrivateEndpoint とマネージドサービスを使用して Azure Databricks ワークスペースを作成し、DBFS 暗号化を使用して CMK を作成できます。
DBFS 暗号化用の CMK を使用して Azure Databricks WS をデプロイする Azure にデプロイする	このテンプレートを使用すると、DBFS ルート暗号化用の CMK を使用して Azure Databricks ワークスペースを作成できます
Managed Services CMK を使用して Azure Databricks ワークスペースをデプロイする Azure にデプロイする	このテンプレートを使用すると、Managed Services CMK を使用して Azure Databricks ワークスペースを作成できます。
Azure アーキテクチャに Sports Analytics をデプロイする Azure にデプロイする	ADLS Gen 2 が有効な Azure ストレージアカウント、ストレージアカウントのリンクされたサービスを持つ Azure Data Factory インスタンス (デプロイされている場合は Azure SQL Database)、Azure Databricks インスタンスを作成します。テンプレートをデプロイするユーザーの AAD ID と ADF インスタンスのマネージド ID には、ストレージアカウントのストレージ BLOB データ共同作成者ロールが付与されます。 Azure Key Vault インスタンス、Azure SQL Database、Azure Event Hub (ストリーミングユースケース用) をデプロイするオプションもあります。 Azure Key Vault がデプロイされると、テンプレートをデプロイするユーザーのデータファクトリマネージド ID と AAD ID に Key Vault シークレットユーザーロールが付与されます。

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

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

リソースグループ

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Databricks/workspaces@2023-09-15-preview"
  name = "string"
  location = "string"
  sku = {
    name = "string"
    tier = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authorizations = [
        {
          principalId = "string"
          roleDefinitionId = "string"
        }
      ]
      createdBy = {
      }
      defaultCatalog = {
        initialName = "string"
        initialType = "string"
      }
      encryption = {
        entities = {
          managedDisk = {
            keySource = "string"
            keyVaultProperties = {
              keyName = "string"
              keyVaultUri = "string"
              keyVersion = "string"
            }
            rotationToLatestKeyVersionEnabled = bool
          }
          managedServices = {
            keySource = "string"
            keyVaultProperties = {
              keyName = "string"
              keyVaultUri = "string"
              keyVersion = "string"
            }
          }
        }
      }
      enhancedSecurityCompliance = {
        automaticClusterUpdate = {
          value = "string"
        }
        complianceSecurityProfile = {
          complianceStandards = [
            "string"
          ]
          value = "string"
        }
        enhancedSecurityMonitoring = {
          value = "string"
        }
      }
      managedDiskIdentity = {
      }
      managedResourceGroupId = "string"
      parameters = {
        amlWorkspaceId = {
          value = "string"
        }
        customPrivateSubnetName = {
          value = "string"
        }
        customPublicSubnetName = {
          value = "string"
        }
        customVirtualNetworkId = {
          value = "string"
        }
        enableNoPublicIp = {
          value = bool
        }
        encryption = {
          value = {
            KeyName = "string"
            keySource = "string"
            keyvaulturi = "string"
            keyversion = "string"
          }
        }
        loadBalancerBackendPoolName = {
          value = "string"
        }
        loadBalancerId = {
          value = "string"
        }
        natGatewayName = {
          value = "string"
        }
        prepareEncryption = {
          value = bool
        }
        publicIpName = {
          value = "string"
        }
        requireInfrastructureEncryption = {
          value = bool
        }
        storageAccountName = {
          value = "string"
        }
        storageAccountSkuName = {
          value = "string"
        }
        vnetAddressPrefix = {
          value = "string"
        }
      }
      publicNetworkAccess = "string"
      requiredNsgRules = "string"
      storageAccountIdentity = {
      }
      uiDefinitionUri = "string"
      updatedBy = {
      }
    }
  })
}

プロパティ値

AutomaticClusterUpdateDefinition

名前	形容	価値
価値		'Disabled' 'Enabled'

ComplianceSecurityProfileDefinition

名前	形容	価値
complianceStandards	ワークスペースに関連付けられているコンプライアンス標準。	次のいずれかを含む文字列配列: 'HIPAA' 'NONE' 'PCI_DSS'
価値		'Disabled' 'Enabled'

CreatedBy

名前	形容	価値

DefaultCatalogProperties

名前	形容	価値
initialName	既定のカタログの初期名を指定します。指定しない場合は、ワークスペースの名前が使用されます。	糸
initialType	既定のカタログの初期型を定義します。使用可能な値 (大文字と小文字を区別しない): HiveMetastore、UnityCatalog	'HiveMetastore' 'UnityCatalog'

暗号化

名前	形容	価値
KeyName	KeyVault キーの名前。	糸
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): 既定値、Microsoft.Keyvault	'Default' 'Microsoft.Keyvault'
keyvaulturi	KeyVault の URI。	糸
keyversion	KeyVault キーのバージョン。	糸

EncryptionEntitiesDefinition

名前	形容	価値
managedDisk	databricks マネージドディスクの暗号化プロパティ。	ManagedDiskEncryption の
managedServices	databricks マネージドサービスの暗号化プロパティ。	EncryptionV2

EncryptionV2

名前	形容	価値
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault	'Microsoft.Keyvault' (必須)
keyVaultProperties	暗号化用の Key Vault 入力プロパティ。	EncryptionV2KeyVaultProperties

EncryptionV2KeyVaultProperties

名前	形容	価値
keyName	KeyVault キーの名前。	string (必須)
keyVaultUri	KeyVault の URI。	string (必須)
keyVersion	KeyVault キーのバージョン。	string (必須)

EnhancedSecurityComplianceDefinition

名前	形容	価値
automaticClusterUpdate	自動クラスター更新機能の状態。	AutomaticClusterUpdateDefinition の
complianceSecurityProfile	コンプライアンスセキュリティプロファイル機能の状態。	ComplianceSecurityProfileDefinition
enhancedSecurityMonitoring	セキュリティ強化監視機能の状態。	EnhancedSecurityMonitoringDefinition の

EnhancedSecurityMonitoringDefinition

名前	形容	価値
価値		'Disabled' 'Enabled'

ManagedDiskEncryption

名前	形容	価値
keySource	暗号化 keySource (プロバイダー)。使用可能な値 (大文字と小文字を区別): Microsoft.Keyvault	'Microsoft.Keyvault' (必須)
keyVaultProperties	暗号化用の Key Vault 入力プロパティ。	ManagedDiskEncryptionKeyVaultProperties の (必須)
rotationToLatestKeyVersionEnabled	マネージドディスク暗号化に最新のキーバージョンを自動的に使用するかどうかを指定します。	bool

ManagedDiskEncryptionKeyVaultProperties

名前	形容	価値
keyName	KeyVault キーの名前。	string (必須)
keyVaultUri	KeyVault の URI。	string (必須)
keyVersion	KeyVault キーのバージョン。	string (必須)

ManagedIdentityConfiguration

名前	形容	価値

Microsoft.Databricks/workspaces

名前	形容	価値
場所	リソースが存在する地理的な場所	string (必須)
名前	リソース名	糸制約：最小長 = 3 最大長 = 3 (必須)
プロパティ	ワークスペースのプロパティ。	WorkspaceProperties (必須)
sku	リソースの SKU。	SKU
タグ	リソースタグ	タグ名と値のディクショナリ。
種類	リソースの種類	"Microsoft.Databricks/workspaces@2023-09-15-preview"

SKU

名前	形容	価値
名前	SKU 名。	string (必須)
層	SKU レベル。	糸

TrackedResourceTags

名前	形容	価値

WorkspaceCustomBooleanParameter

名前	形容	価値
価値	このフィールドに使用する値。	bool (必須)

WorkspaceCustomParameters

名前	形容	価値
amlWorkspaceId	Databricks ワークスペースとリンクする Azure Machine Learning ワークスペースの ID	WorkspaceCustomStringParameter
customPrivateSubnetName	仮想ネットワーク内のプライベートサブネットの名前	WorkspaceCustomStringParameter
customPublicSubnetName	仮想ネットワーク内のパブリックサブネットの名前	WorkspaceCustomStringParameter
customVirtualNetworkId	この Databricks クラスターを作成する必要がある仮想ネットワークの ID	WorkspaceCustomStringParameter
enableNoPublicIp	パブリック IP を無効にする必要がありますか?	WorkspaceCustomBooleanParameter
暗号化	Customer-Managed キー (CMK) が有効なワークスペースの暗号化の詳細が含まれています。	WorkspaceEncryptionParameter
loadBalancerBackendPoolName	セキュリティで保護されたクラスター接続用の送信ロードバランサーバックエンドプールの名前 (パブリック IP なし)。	WorkspaceCustomStringParameter
loadBalancerId	セキュリティで保護されたクラスター接続 (パブリック IP なし) ワークスペースの送信ロードバランサーのリソース URI。	WorkspaceCustomStringParameter
natGatewayName	セキュリティで保護されたクラスター接続 (パブリック IP なし) ワークスペースサブネットの NAT ゲートウェイの名前。	WorkspaceCustomStringParameter
prepareEncryption	暗号化用にワークスペースを準備します。マネージドストレージアカウントのマネージド ID を有効にします。	WorkspaceCustomBooleanParameter
publicIpName	マネージド vNet を持つパブリック IP なしワークスペースのパブリック IP の名前。	WorkspaceCustomStringParameter
requireInfrastructureEncryption	保存データのプラットフォームマネージドキーによる暗号化のセカンダリレイヤーで DBFS ルートファイルシステムを有効にするかどうかを示すブール値。	WorkspaceCustomBooleanParameter
storageAccountName	既定の DBFS ストレージアカウント名。	WorkspaceCustomStringParameter
storageAccountSkuName	ストレージアカウント SKU 名 (例: Standard_GRS、Standard_LRS)。有効な入力については、https://aka.ms/storageskus を参照してください。	WorkspaceCustomStringParameter
vnetAddressPrefix	マネージド仮想ネットワークのアドレスプレフィックス。この入力の既定値は 10.139 です。	WorkspaceCustomStringParameter

WorkspaceCustomStringParameter

名前	形容	価値
価値	このフィールドに使用する値。	string (必須)

WorkspaceEncryptionParameter

名前	形容	価値
価値	このフィールドに使用する値。	暗号化

WorkspaceProperties

名前	形容	価値
権限	ワークスペースプロバイダーの承認。	WorkspaceProviderAuthorization[]
createdBy	ワークスペースを作成したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。	CreatedBy
defaultCatalog	ワークスペースの作成時の既定のカタログ構成のプロパティ。	DefaultCatalogProperties の
暗号化	databricks ワークスペースの暗号化プロパティ	WorkspacePropertiesEncryption
enhancedSecurityCompliance	セキュリティ強化およびコンプライアンスアドオンに関連する設定が含まれています。	EnhancedSecurityComplianceDefinition の
managedDiskIdentity	マネージドディスク暗号化に使用されるディスク暗号化セットのマネージド ID の詳細	ManagedIdentityConfiguration
managedResourceGroupId	マネージドリソースグループ ID。	string (必須)
パラメーター	ワークスペースのカスタムパラメーター。	WorkspaceCustomParameters
publicNetworkAccess	ワークスペースにアクセスするためのネットワークアクセスの種類。プライベートリンク経由でのみワークスペースにアクセスするには、値を無効に設定します。	'Disabled' 'Enabled'
requiredNsgRules	コントロールプレーン通信を制御するデータプレーン (クラスター) がプライベートエンドポイント経由で行われるかどうかを示す値を取得または設定します。サポートされている値は、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部でのみ使用されます。	'AllRules' 'NoAzureDatabricksRules' 'NoAzureServiceRules'
storageAccountIdentity	ストレージアカウントのマネージド ID の詳細	ManagedIdentityConfiguration
uiDefinitionUri	UI 定義ファイルが配置されている BLOB URI。	糸
updatedBy	ワークスペースを最後に更新したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。	CreatedBy

WorkspacePropertiesEncryption

名前	形容	価値
エンティティ	ワークスペースの暗号化エンティティ定義。	EncryptionEntitiesDefinition (必須)

WorkspaceProviderAuthorization

名前	形容	価値
principalId	プロバイダーのプリンシパル識別子。これは、プロバイダーが ARM を呼び出してワークスペースリソースを管理するために使用する ID です。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (必須)
roleDefinitionId	プロバイダーのロール定義識別子。このロールは、プロバイダーがワークスペースのコンテナーリソースグループに対して持つ必要があるすべてのアクセス許可を定義します。このロール定義には、リソースグループを削除するアクセス許可を持つことはできません。	糸制約：最小長 = 36 最大長 = 36 パターン = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (必須)

次の方法で共有

Microsoft.Databricks ワークスペース 2023-09-15-preview

Bicep リソース定義

リソースの形式

プロパティ値

AutomaticClusterUpdateDefinition

ComplianceSecurityProfileDefinition

CreatedBy

DefaultCatalogProperties

暗号化

EncryptionEntitiesDefinition

EncryptionV2

EncryptionV2KeyVaultProperties

EnhancedSecurityComplianceDefinition

EnhancedSecurityMonitoringDefinition

ManagedDiskEncryption

ManagedDiskEncryptionKeyVaultProperties

ManagedIdentityConfiguration

Microsoft.Databricks/workspaces

SKU

TrackedResourceTags

WorkspaceCustomBooleanParameter

WorkspaceCustomParameters

WorkspaceCustomStringParameter

WorkspaceEncryptionParameter

WorkspaceProperties

WorkspacePropertiesEncryption

WorkspaceProviderAuthorization

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

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

リソースの形式

プロパティ値

AutomaticClusterUpdateDefinition

ComplianceSecurityProfileDefinition

CreatedBy

DefaultCatalogProperties

暗号化

EncryptionEntitiesDefinition

EncryptionV2

EncryptionV2KeyVaultProperties

EnhancedSecurityComplianceDefinition

EnhancedSecurityMonitoringDefinition

ManagedDiskEncryption

ManagedDiskEncryptionKeyVaultProperties

ManagedIdentityConfiguration

Microsoft.Databricks/workspaces

SKU

TrackedResourceTags

WorkspaceCustomBooleanParameter

WorkspaceCustomParameters

WorkspaceCustomStringParameter

WorkspaceEncryptionParameter

WorkspaceProperties

WorkspacePropertiesEncryption

WorkspaceProviderAuthorization

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

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

リソースの形式

プロパティ値

AutomaticClusterUpdateDefinition

ComplianceSecurityProfileDefinition

CreatedBy

DefaultCatalogProperties

暗号化

EncryptionEntitiesDefinition

EncryptionV2

EncryptionV2KeyVaultProperties

EnhancedSecurityComplianceDefinition

EnhancedSecurityMonitoringDefinition

ManagedDiskEncryption

ManagedDiskEncryptionKeyVaultProperties

ManagedIdentityConfiguration

Microsoft.Databricks/workspaces

SKU

TrackedResourceTags

WorkspaceCustomBooleanParameter

WorkspaceCustomParameters

WorkspaceCustomStringParameter

WorkspaceEncryptionParameter

WorkspaceProperties

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

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

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