New-AzDatabricksWorkspace

Module:

Az.Databricks

Creates a new workspace.

Syntax

New-AzDatabricksWorkspace
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-ManagedResourceGroupName <String>]
   [-AmlWorkspaceId <String>]
   [-Authorization <IWorkspaceProviderAuthorization[]>]
   [-DefaultCatalogInitialType <InitialType>]
   [-EnableNoPublicIP]
   [-EncryptionKeyName <String>]
   [-EncryptionKeySource <KeySource>]
   [-EncryptionKeyVaultUri <String>]
   [-EncryptionKeyVersion <String>]
   [-LoadBalancerBackendPoolName <String>]
   [-LoadBalancerId <String>]
   [-ManagedDiskKeySource <EncryptionKeySource>]
   [-ManagedDiskKeyVaultPropertiesKeyName <String>]
   [-ManagedDiskKeyVaultPropertiesKeyVaultUri <String>]
   [-ManagedDiskKeyVaultPropertiesKeyVersion <String>]
   [-ManagedDiskRotationToLatestKeyVersionEnabled]
   [-ManagedServiceKeySource <EncryptionKeySource>]
   [-ManagedServicesKeyVaultPropertiesKeyName <String>]
   [-ManagedServicesKeyVaultPropertiesKeyVaultUri <String>]
   [-ManagedServicesKeyVaultPropertiesKeyVersion <String>]
   [-NatGatewayName <String>]
   [-PrepareEncryption]
   [-PrivateSubnetName <String>]
   [-PublicIPName <String>]
   [-PublicNetworkAccess <PublicNetworkAccess>]
   [-PublicSubnetName <String>]
   [-RequireInfrastructureEncryption]
   [-RequiredNsgRule <RequiredNsgRules>]
   [-Sku <String>]
   [-SkuTier <String>]
   [-StorageAccountName <String>]
   [-StorageAccountSku <String>]
   [-Tag <Hashtable>]
   [-UiDefinitionUri <String>]
   [-VirtualNetworkId <String>]
   [-VnetAddressPrefix <String>]
   [-EnhancedSecurityMonitoringValue <EnhancedSecurityMonitoringValue>]
   [-AutomaticClusterUpdateValue <AutomaticClusterUpdateValue>]
   [-ComplianceSecurityProfileComplianceStandard <ComplianceStandard[]>]
   [-ComplianceSecurityProfileValue <ComplianceSecurityProfileValue>]
   [-AccessConnectorId <String>]
   [-AccessConnectorIdentityType <IdentityType>]
   [-AccessConnectorUserAssignedIdentityId <String>]
   [-DefaultStorageFirewall <DefaultStorageFirewall>]
   [-DefaultProfile <PSObject>]
   [-AsJob]
   [-NoWait]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Creates a new workspace.

Examples

Example 1: Create a Databricks workspace.

New-AzDatabricksWorkspace -Name azps-databricks-workspace-t1 -ResourceGroupName azps_test_gp_db -Location eastus -ManagedResourceGroupName azps_test_gp_kv_t1 -Sku Premium

Name                         ResourceGroupName Location Managed Resource Group ID
----                         ----------------- -------- -------------------------
azps-databricks-workspace-t1 azps_test_gp_db   eastus   /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t1

This command creates a Databricks workspace.

Example 2: Create a Databricks workspace with a customized virtual network.

$dlg = New-AzDelegation -Name dbrdl -ServiceName "Microsoft.Databricks/workspaces"
$rdpRule = New-AzNetworkSecurityRuleConfig -Name azps-network-security-rule -Description "Allow RDP" -Access Allow -Protocol Tcp -Direction Inbound -Priority 100 -SourceAddressPrefix Internet -SourcePortRange * -DestinationAddressPrefix * -DestinationPortRange 3389
$networkSecurityGroup = New-AzNetworkSecurityGroup -ResourceGroupName azps_test_gp_db -Location eastus -Name azps-network-security-group -SecurityRules $rdpRule
$kvSubnet = New-AzVirtualNetworkSubnetConfig -Name azps-vnetwork-sub-kv -AddressPrefix "110.0.1.0/24" -ServiceEndpoint "Microsoft.KeyVault"
$priSubnet = New-AzVirtualNetworkSubnetConfig -Name azps-vnetwork-sub-pri -AddressPrefix "110.0.2.0/24" -NetworkSecurityGroup $networkSecurityGroup -Delegation $dlg
$pubSubnet = New-AzVirtualNetworkSubnetConfig -Name azps-vnetwork-sub-pub -AddressPrefix "110.0.3.0/24" -NetworkSecurityGroup $networkSecurityGroup -Delegation $dlg
$testVN = New-AzVirtualNetwork -Name azps-virtual-network -ResourceGroupName azps_test_gp_db -Location eastus -AddressPrefix "110.0.0.0/16" -Subnet $kvSubnet,$priSubnet,$pubSubnet
$vNetResId = (Get-AzVirtualNetwork -Name azps-virtual-network -ResourceGroupName azps_test_gp_db).Subnets[0].Id
$ruleSet = New-AzKeyVaultNetworkRuleSetObject -DefaultAction Allow -Bypass AzureServices -IpAddressRange "110.0.1.0/24" -VirtualNetworkResourceId $vNetResId
New-AzKeyVault -ResourceGroupName azps_test_gp_db -VaultName azps-keyvault -NetworkRuleSet $ruleSet -Location eastus -Sku 'Premium' -EnablePurgeProtection
New-AzDatabricksWorkspace -Name azps-databricks-workspace-t2 -ResourceGroupName azps_test_gp_db -Location eastus -ManagedResourceGroupName azps_test_gp_kv_t2 -VirtualNetworkId $testVN.Id -PrivateSubnetName $priSubnet.Name -PublicSubnetName $pubSubnet.Name -Sku Premium

Name                         ResourceGroupName Location Managed Resource Group ID
----                         ----------------- -------- -------------------------
azps-databricks-workspace-t2 azps_test_gp_db   eastus   /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t2

This command creates a Databricks workspace with customized virtual network in a resource group.

Example 3: Create a Databricks workspace with enable encryption.

New-AzDatabricksWorkspace -Name azps-databricks-workspace-t3 -ResourceGroupName azps_test_gp_db -Location eastus -PrepareEncryption -ManagedResourceGroupName azps_test_gp_kv_t3 -Sku premium

Name                         ResourceGroupName Location Managed Resource Group ID
----                         ----------------- -------- -------------------------
azps-databricks-workspace-t3 azps_test_gp_db   eastus   /subscriptions/{subId}/resourceGroups/azps_test_gp_kv_t3

This command creates a Databricks workspace and sets it to prepare for encryption. Please refer to the examples of Update-AzDatabricksWorkspace for more settings to encryption.

Parameters

-AccessConnectorId

The resource ID of Azure Databricks Access Connector Resource.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AccessConnectorIdentityType

The identity type of the Access Connector Resource.

Type:	IdentityType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AccessConnectorUserAssignedIdentityId

The resource ID of the User Assigned Identity associated with the Access Connector Resource. This is required for type 'UserAssigned' and not valid for type 'SystemAssigned'.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AmlWorkspaceId

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

Run the command as a job

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Authorization

The workspace provider authorizations. To construct, see NOTES section for AUTHORIZATION properties and create a hash table.

Type:	IWorkspaceProviderAuthorization[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AutomaticClusterUpdateValue

Status of automated cluster updates feature.

Type:	AutomaticClusterUpdateValue
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ComplianceSecurityProfileComplianceStandard

Compliance standards associated with the workspace.

Type:	ComplianceStandard[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ComplianceSecurityProfileValue

Status of Compliance Security Profile feature.

Type:	ComplianceSecurityProfileValue
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultCatalogInitialType

Defines the initial type of the default catalog. Possible values (case-insensitive): HiveMetastore, UnityCatalog

Type:	InitialType
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultStorageFirewall

Gets or Sets Default Storage Firewall configuration information

Type:	DefaultStorageFirewall
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnableNoPublicIP

The value which should be used for this field.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EncryptionKeyName

The name of KeyVault key.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EncryptionKeySource

The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault

Type:	KeySource
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EncryptionKeyVaultUri

The Uri of KeyVault.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EncryptionKeyVersion

The version of KeyVault key.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EnhancedSecurityMonitoringValue

Status of Enhanced Security Monitoring feature.

Type:	EnhancedSecurityMonitoringValue
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerBackendPoolName

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LoadBalancerId

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

The geo-location where the resource lives

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedDiskKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault

Type:	EncryptionKeySource
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedDiskKeyVaultPropertiesKeyName

The name of KeyVault key.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedDiskKeyVaultPropertiesKeyVaultUri

The URI of KeyVault.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedDiskKeyVaultPropertiesKeyVersion

The version of KeyVault key.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedDiskRotationToLatestKeyVersionEnabled

Indicate whether the latest key version should be automatically used for Managed Disk Encryption.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedResourceGroupName

The managed resource group Id.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedServiceKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault

Type:	EncryptionKeySource
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedServicesKeyVaultPropertiesKeyName

The name of KeyVault key.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedServicesKeyVaultPropertiesKeyVaultUri

The Uri of KeyVault.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ManagedServicesKeyVaultPropertiesKeyVersion

The version of KeyVault key.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the workspace.

Type:	String
Aliases:	WorkspaceName
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-NatGatewayName

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NoWait

Run the command asynchronously

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PrepareEncryption

The value which should be used for this field.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PrivateSubnetName

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicIPName

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicNetworkAccess

The network access type for accessing workspace. Set value to disabled to access workspace only via private link.

Type:	PublicNetworkAccess
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PublicSubnetName

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredNsgRule

Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are 'AllRules' and 'NoAzureDatabricksRules'. 'NoAzureServiceRules' value is for internal use only.

Type:	RequiredNsgRules
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequireInfrastructureEncryption

The value which should be used for this field.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Sku

The SKU name.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SkuTier

The SKU tier.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StorageAccountName

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StorageAccountSku

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

Resource tags.

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UiDefinitionUri

The blob URI where the UI definition file is located.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VirtualNetworkId

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VnetAddressPrefix

The value which should be used for this field.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

IWorkspace