Microsoft.Databricks ワークスペース
- [アーティクル]
-
-
Bicep リソース定義
ワークスペース リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Databricks/workspaces リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Databricks/workspaces@2023-02-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
tier: 'string'
}
properties: {
authorizations: [
{
principalId: 'string'
roleDefinitionId: 'string'
}
]
createdBy: {}
encryption: {
entities: {
managedDisk: {
keySource: 'Microsoft.Keyvault'
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
rotationToLatestKeyVersionEnabled: bool
}
managedServices: {
keySource: 'Microsoft.Keyvault'
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: '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: {}
}
}
プロパティ値
workspaces
| 名前 |
説明 |
値 |
| name |
リソース名 |
string (必須)
文字制限: 3 から 64
有効な文字:
英数字、アンダースコア、およびハイフン |
| location |
リソースが保存されている地理的な場所 |
string (必須) |
| tags |
リソース タグ。 |
タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
| sku |
リソースの SKU。 |
SKU |
| properties |
ワークスペースのプロパティ。 |
WorkspaceProperties (必須) |
WorkspaceProperties
| 名前 |
説明 |
値 |
| 承認 |
ワークスペース プロバイダーの承認。 |
WorkspaceProviderAuthorization[] |
| createdBy |
ワークスペースを作成したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。 |
CreatedBy |
| 暗号化 (encryption) |
databricks ワークスペースの暗号化プロパティ |
WorkspacePropertiesEncryption |
| managedDiskIdentity |
マネージド ディスク暗号化に使用されるディスク暗号化セットのマネージド ID の詳細 |
ManagedIdentityConfiguration |
| managedResourceGroupId |
マネージド リソース グループ ID。 |
string (必須) |
| parameters |
ワークスペースのカスタム パラメーター。 |
WorkspaceCustomParameters |
| publicNetworkAccess |
ワークスペースにアクセスするためのネットワーク アクセスの種類。 プライベート リンク経由でのみワークスペースにアクセスするには、値を disabled に設定します。 |
'Disabled'
'Enabled' |
| requiredNsgRules |
コントロール プレーン通信を制御するデータ プレーン (クラスター) がプライベート エンドポイント経由で行われるかどうかを示す値を取得または設定します。 サポートされている値は、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部使用専用です。 |
'AllRules'
'NoAzureDatabricksRules'
'NoAzureServiceRules' |
| storageAccountIdentity |
ストレージ アカウントのマネージド ID の詳細 |
ManagedIdentityConfiguration |
| uiDefinitionUri |
UI 定義ファイルが配置されている BLOB URI。 |
string |
| updatedBy |
ワークスペースを最後に更新したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。 |
CreatedBy |
WorkspaceProviderAuthorization
| 名前 |
説明 |
値 |
| principalId |
プロバイダーのプリンシパル識別子。 これは、プロバイダーが ARM を呼び出してワークスペース リソースを管理するために使用する ID です。 |
string (必須) |
| roleDefinitionId |
プロバイダーのロール定義識別子。 このロールは、ワークスペースのコンテナー リソース グループに対してプロバイダーが持つ必要があるすべてのアクセス許可を定義します。 このロール定義には、リソース グループを削除するためのアクセス許可を持つことはできません。 |
string (必須) |
CreatedBy
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
WorkspacePropertiesEncryption
EncryptionEntitiesDefinition
ManagedDiskEncryption
| 名前 |
説明 |
値 |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字は区別されません): Microsoft.Keyvault |
'Microsoft.Keyvault' (必須) |
| keyVaultProperties |
暗号化用の入力プロパティをKey Vaultします。 |
ManagedDiskEncryptionKeyVaultProperties (必須) |
| rotationToLatestKeyVersionEnabled |
マネージド ディスク暗号化に最新のキー バージョンを自動的に使用するかどうかを示します。 |
[bool] |
ManagedDiskEncryptionKeyVaultProperties
| 名前 |
説明 |
値 |
| keyName |
KeyVault キーの名前。 |
string (必須) |
| keyVaultUri |
KeyVault の URI。 |
string (必須) |
| keyVersion |
KeyVault キーのバージョン。 |
string (必須) |
EncryptionV2
| 名前 |
説明 |
値 |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字は区別されません): Microsoft.Keyvault |
'Microsoft.Keyvault' (必須) |
| keyVaultProperties |
暗号化用の入力プロパティをKey Vaultします。 |
EncryptionV2KeyVaultProperties |
EncryptionV2KeyVaultProperties
| 名前 |
説明 |
値 |
| keyName |
KeyVault キーの名前。 |
string (必須) |
| keyVaultUri |
KeyVault の URI。 |
string (必須) |
| keyVersion |
KeyVault キーのバージョン。 |
string (必須) |
ManagedIdentityConfiguration
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
WorkspaceCustomParameters
WorkspaceCustomStringParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
string (必須) |
WorkspaceCustomBooleanParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
bool (必須) |
WorkspaceEncryptionParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
暗号化 |
暗号化
| 名前 |
説明 |
値 |
| キー名 |
KeyVault キーの名前。 |
string |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字を区別しない): 既定値、Microsoft.Keyvault |
'Default'
'Microsoft.Keyvault' |
| keyvaulturi |
KeyVault の URI。 |
string |
| keyversion |
KeyVault キーのバージョン。 |
string |
Sku
| 名前 |
説明 |
値 |
| name |
SKU 名。 |
string (必須) |
| レベル |
SKU レベル。 |
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
ARM テンプレート リソース定義
ワークスペースリソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Databricks/workspaces リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Databricks/workspaces",
"apiVersion": "2023-02-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string",
"tier": "string"
},
"properties": {
"authorizations": [
{
"principalId": "string",
"roleDefinitionId": "string"
}
],
"createdBy": {},
"encryption": {
"entities": {
"managedDisk": {
"keySource": "Microsoft.Keyvault",
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string"
},
"rotationToLatestKeyVersionEnabled": "bool"
},
"managedServices": {
"keySource": "Microsoft.Keyvault",
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "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": {}
}
}
プロパティ値
workspaces
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
'Microsoft.Databricks/workspaces' |
| apiVersion |
リソース API のバージョン |
'2023-02-01' |
| name |
リソース名 |
string (必須)
文字数制限: 3 から 64
有効な文字:
英数字、アンダースコア、およびハイフン |
| location |
リソースが保存されている地理的な場所 |
string (必須) |
| tags |
リソース タグ。 |
タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
| sku |
リソースの SKU。 |
SKU |
| properties |
ワークスペースのプロパティ。 |
WorkspaceProperties (必須) |
WorkspaceProperties
| 名前 |
説明 |
値 |
| 承認 |
ワークスペース プロバイダーの承認。 |
WorkspaceProviderAuthorization[] |
| createdBy |
ワークスペースを作成したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。 |
CreatedBy |
| 暗号化 (encryption) |
databricks ワークスペースの暗号化プロパティ |
WorkspacePropertiesEncryption |
| managedDiskIdentity |
マネージド ディスク暗号化に使用されるディスク暗号化セットのマネージド ID の詳細 |
ManagedIdentityConfiguration |
| managedResourceGroupId |
マネージド リソース グループ ID。 |
string (必須) |
| parameters |
ワークスペースのカスタム パラメーター。 |
WorkspaceCustomParameters |
| publicNetworkAccess |
ワークスペースにアクセスするためのネットワーク アクセスの種類。 プライベート リンク経由でのみワークスペースにアクセスするには、値を disabled に設定します。 |
'Disabled'
'Enabled' |
| requiredNsgRules |
プライベート エンドポイント経由でプレーン通信を制御するデータ プレーン (クラスター) を示す値を取得または設定します。 サポートされている値は、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部使用専用です。 |
'AllRules'
'NoAzureDatabricksRules'
'NoAzureServiceRules' |
| storageAccountIdentity |
ストレージ アカウントのマネージド ID の詳細 |
ManagedIdentityConfiguration |
| uiDefinitionUri |
UI 定義ファイルが配置されている BLOB URI。 |
string |
| updatedBy |
ワークスペースを最後に更新したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。 |
CreatedBy |
WorkspaceProviderAuthorization
| 名前 |
説明 |
値 |
| principalId |
プロバイダーのプリンシパル識別子。 これは、プロバイダーが ARM を呼び出してワークスペース リソースを管理するために使用する ID です。 |
string (必須) |
| roleDefinitionId |
プロバイダーのロール定義識別子。 このロールは、ワークスペースのコンテナー リソース グループに対してプロバイダーが持つ必要があるすべてのアクセス許可を定義します。 このロール定義には、リソース グループを削除するためのアクセス許可を持つことはできません。 |
string (必須) |
CreatedBy
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
WorkspacePropertiesEncryption
EncryptionEntitiesDefinition
ManagedDiskEncryption
| 名前 |
説明 |
値 |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字は区別されません): Microsoft.Keyvault |
'Microsoft.Keyvault' (必須) |
| keyVaultProperties |
暗号化用の入力プロパティをKey Vaultします。 |
ManagedDiskEncryptionKeyVaultProperties (必須) |
| rotationToLatestKeyVersionEnabled |
マネージド ディスク暗号化に最新のキー バージョンを自動的に使用するかどうかを示します。 |
[bool] |
ManagedDiskEncryptionKeyVaultProperties
| 名前 |
説明 |
値 |
| keyName |
KeyVault キーの名前。 |
string (必須) |
| keyVaultUri |
KeyVault の URI。 |
string (必須) |
| keyVersion |
KeyVault キーのバージョン。 |
string (必須) |
EncryptionV2
| 名前 |
説明 |
値 |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字は区別されません): Microsoft.Keyvault |
'Microsoft.Keyvault' (必須) |
| keyVaultProperties |
暗号化用の入力プロパティをKey Vaultします。 |
EncryptionV2KeyVaultProperties |
EncryptionV2KeyVaultProperties
| 名前 |
説明 |
値 |
| keyName |
KeyVault キーの名前。 |
string (必須) |
| keyVaultUri |
KeyVault の URI。 |
string (必須) |
| keyVersion |
KeyVault キーのバージョン。 |
string (必須) |
ManagedIdentityConfiguration
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
WorkspaceCustomParameters
WorkspaceCustomStringParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
string (必須) |
WorkspaceCustomBooleanParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
bool (必須) |
WorkspaceEncryptionParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
暗号化 |
暗号化
| 名前 |
説明 |
値 |
| キー名 |
KeyVault キーの名前。 |
string |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字を区別しない): 既定値、Microsoft.Keyvault |
'Default'
'Microsoft.Keyvault' |
| keyvaulturi |
KeyVault の URI。 |
string |
| keyversion |
KeyVault キーのバージョン。 |
string |
Sku
| 名前 |
説明 |
値 |
| name |
SKU 名。 |
string (必須) |
| レベル |
SKU レベル。 |
string |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
ワークスペースリソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
Microsoft.Databricks/workspaces リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Databricks/workspaces@2023-02-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
authorizations = [
{
principalId = "string"
roleDefinitionId = "string"
}
]
createdBy = {}
encryption = {
entities = {
managedDisk = {
keySource = "Microsoft.Keyvault"
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
}
rotationToLatestKeyVersionEnabled = bool
}
managedServices = {
keySource = "Microsoft.Keyvault"
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "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"
}
})
}
プロパティ値
workspaces
| 名前 |
説明 |
値 |
| type |
リソースの種類 |
"Microsoft.Databricks/workspaces@2023-02-01" |
| name |
リソース名 |
string (必須)
文字数制限: 3 から 64
有効な文字:
英数字、アンダースコア、およびハイフン |
| location |
リソースが保存されている地理的な場所 |
string (必須) |
| parent_id |
リソース グループにデプロイするには、そのリソース グループの ID を使用します。 |
string (必須) |
| tags |
リソース タグ。 |
タグ名と値のディクショナリ。 |
| sku |
リソースの SKU。 |
SKU |
| properties |
ワークスペースのプロパティ。 |
WorkspaceProperties (必須) |
WorkspaceProperties
| 名前 |
説明 |
値 |
| 承認 |
ワークスペース プロバイダーの承認。 |
WorkspaceProviderAuthorization[] |
| createdBy |
ワークスペースを作成したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。 |
CreatedBy |
| 暗号化 (encryption) |
databricks ワークスペースの暗号化プロパティ |
WorkspacePropertiesEncryption |
| managedDiskIdentity |
マネージド ディスク暗号化に使用されるディスク暗号化セットのマネージド ID の詳細 |
ManagedIdentityConfiguration |
| managedResourceGroupId |
マネージド リソース グループ ID。 |
string (必須) |
| parameters |
ワークスペースのカスタム パラメーター。 |
WorkspaceCustomParameters |
| publicNetworkAccess |
ワークスペースにアクセスするためのネットワーク アクセスの種類。 プライベート リンク経由でのみワークスペースにアクセスするには、値を disabled に設定します。 |
"無効"
"有効" |
| requiredNsgRules |
プライベート エンドポイント経由でプレーン通信を制御するデータ プレーン (クラスター) を示す値を取得または設定します。 サポートされている値は、'AllRules' と 'NoAzureDatabricksRules' です。 'NoAzureServiceRules' 値は内部使用専用です。 |
"AllRules"
"NoAzureDatabricksRules"
"NoAzureServiceRules" |
| storageAccountIdentity |
ストレージ アカウントのマネージド ID の詳細 |
ManagedIdentityConfiguration |
| uiDefinitionUri |
UI 定義ファイルが配置されている BLOB URI。 |
string |
| updatedBy |
ワークスペースを最後に更新したエンティティのオブジェクト ID、PUID、アプリケーション ID を示します。 |
CreatedBy |
WorkspaceProviderAuthorization
| 名前 |
説明 |
値 |
| principalId |
プロバイダーのプリンシパル識別子。 これは、プロバイダーが ARM を呼び出してワークスペース リソースを管理するために使用する ID です。 |
string (必須) |
| roleDefinitionId |
プロバイダーのロール定義識別子。 このロールは、ワークスペースのコンテナー リソース グループに対してプロバイダーが持つ必要があるすべてのアクセス許可を定義します。 このロール定義には、リソース グループを削除するためのアクセス許可を持つことはできません。 |
string (必須) |
CreatedBy
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
WorkspacePropertiesEncryption
EncryptionEntitiesDefinition
ManagedDiskEncryption
| 名前 |
説明 |
値 |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字は区別されません): Microsoft.Keyvault |
"Microsoft.Keyvault" (必須) |
| keyVaultProperties |
暗号化用の入力プロパティをKey Vaultします。 |
ManagedDiskEncryptionKeyVaultProperties (必須) |
| rotationToLatestKeyVersionEnabled |
マネージド ディスク暗号化に最新のキー バージョンを自動的に使用するかどうかを示します。 |
[bool] |
ManagedDiskEncryptionKeyVaultProperties
| 名前 |
説明 |
値 |
| keyName |
KeyVault キーの名前。 |
string (必須) |
| keyVaultUri |
KeyVault の URI。 |
string (必須) |
| keyVersion |
KeyVault キーのバージョン。 |
string (必須) |
EncryptionV2
| 名前 |
説明 |
値 |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字は区別されません): Microsoft.Keyvault |
"Microsoft.Keyvault" (必須) |
| keyVaultProperties |
暗号化用の入力プロパティをKey Vaultします。 |
EncryptionV2KeyVaultProperties |
EncryptionV2KeyVaultProperties
| 名前 |
説明 |
値 |
| keyName |
KeyVault キーの名前。 |
string (必須) |
| keyVaultUri |
KeyVault の URI。 |
string (必須) |
| keyVersion |
KeyVault キーのバージョン。 |
string (必須) |
ManagedIdentityConfiguration
このオブジェクトには、デプロイ中に設定するプロパティは含まれません。 すべてのプロパティは ReadOnly です。
WorkspaceCustomParameters
WorkspaceCustomStringParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
string (必須) |
WorkspaceCustomBooleanParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
bool (必須) |
WorkspaceEncryptionParameter
| 名前 |
説明 |
値 |
| value |
このフィールドに使用する値。 |
暗号化 |
暗号化
| 名前 |
説明 |
値 |
| キー名 |
KeyVault キーの名前。 |
string |
| keySource |
暗号化キーソース (プロバイダー)。 使用できる値 (大文字と小文字を区別しない): 既定値、Microsoft.Keyvault |
"Default"
"Microsoft.Keyvault" |
| keyvaulturi |
KeyVault の URI。 |
string |
| keyversion |
KeyVault キーのバージョン。 |
string |
Sku
| 名前 |
説明 |
値 |
| name |
SKU 名。 |
string (必須) |
| レベル |
SKU レベル。 |
string |
