Update-AzDatabricksWorkspace

Reference

Module:: Az.Databricks

Updates a workspace.

Syntax

Update-AzDatabricksWorkspace
      -Name <String>
      -ResourceGroupName <String>
      [-SubscriptionId <String>]
      [-PrepareEncryption]
      [-EncryptionKeySource <KeySource>]
      [-EncryptionKeyVaultUri <String>]
      [-EncryptionKeyName <String>]
      [-EncryptionKeyVersion <String>]
      [-KeyVaultKeyName <String>]
      [-KeyVaultKeyVersion <String>]
      [-KeyVaultUri <String>]
      [-AmlWorkspaceId <String>]
      [-SkuTier <String>]
      [-Authorization <IWorkspaceProviderAuthorization[]>]
      [-DefaultCatalogInitialType <InitialType>]
      [-ManagedDiskKeySource <EncryptionKeySource>]
      [-ManagedDiskKeyVaultPropertiesKeyName <String>]
      [-ManagedDiskKeyVaultPropertiesKeyVaultUri <String>]
      [-ManagedDiskKeyVaultPropertiesKeyVersion <String>]
      [-ManagedDiskRotationToLatestKeyVersionEnabled]
      [-ManagedServiceKeySource <EncryptionKeySource>]
      [-ManagedServicesKeyVaultPropertiesKeyName <String>]
      [-ManagedServicesKeyVaultPropertiesKeyVaultUri <String>]
      [-ManagedServicesKeyVaultPropertiesKeyVersion <String>]
      [-UiDefinitionUri <String>]
      [-Tag <Hashtable>]
      [-RequiredNsgRule <RequiredNsgRules>]
      [-PublicNetworkAccess <PublicNetworkAccess>]
      [-EnableNoPublicIP]
      [-EnhancedSecurityMonitoringValue <EnhancedSecurityMonitoringValue>]
      [-AutomaticClusterUpdateValue <AutomaticClusterUpdateValue>]
      [-ComplianceSecurityProfileComplianceStandard <ComplianceStandard[]>]
      [-ComplianceSecurityProfileValue <ComplianceSecurityProfileValue>]
      [-AccessConnectorId <String>]
      [-AccessConnectorIdentityType <IdentityType>]
      [-AccessConnectorUserAssignedIdentityId <String>]
      [-DefaultStorageFirewall <DefaultStorageFirewall>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-AzDatabricksWorkspace
      -InputObject <IDatabricksIdentity>
      [-PrepareEncryption]
      [-EncryptionKeySource <KeySource>]
      [-EncryptionKeyVaultUri <String>]
      [-EncryptionKeyName <String>]
      [-EncryptionKeyVersion <String>]
      [-KeyVaultKeyName <String>]
      [-KeyVaultKeyVersion <String>]
      [-KeyVaultUri <String>]
      [-AmlWorkspaceId <String>]
      [-SkuTier <String>]
      [-Authorization <IWorkspaceProviderAuthorization[]>]
      [-DefaultCatalogInitialType <InitialType>]
      [-ManagedDiskKeySource <EncryptionKeySource>]
      [-ManagedDiskKeyVaultPropertiesKeyName <String>]
      [-ManagedDiskKeyVaultPropertiesKeyVaultUri <String>]
      [-ManagedDiskKeyVaultPropertiesKeyVersion <String>]
      [-ManagedDiskRotationToLatestKeyVersionEnabled]
      [-ManagedServiceKeySource <EncryptionKeySource>]
      [-ManagedServicesKeyVaultPropertiesKeyName <String>]
      [-ManagedServicesKeyVaultPropertiesKeyVaultUri <String>]
      [-ManagedServicesKeyVaultPropertiesKeyVersion <String>]
      [-UiDefinitionUri <String>]
      [-Tag <Hashtable>]
      [-RequiredNsgRule <RequiredNsgRules>]
      [-PublicNetworkAccess <PublicNetworkAccess>]
      [-EnableNoPublicIP]
      [-EnhancedSecurityMonitoringValue <EnhancedSecurityMonitoringValue>]
      [-AutomaticClusterUpdateValue <AutomaticClusterUpdateValue>]
      [-ComplianceSecurityProfileComplianceStandard <ComplianceStandard[]>]
      [-ComplianceSecurityProfileValue <ComplianceSecurityProfileValue>]
      [-AccessConnectorId <String>]
      [-AccessConnectorIdentityType <IdentityType>]
      [-AccessConnectorUserAssignedIdentityId <String>]
      [-DefaultStorageFirewall <DefaultStorageFirewall>]
      [-DefaultProfile <PSObject>]
      [-AsJob]
      [-NoWait]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Updates a workspace.

Examples

Example 1: Updates the tags of a Databricks workspace.

Get-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t1 | Update-AzDatabricksWorkspace -Tag @{"key"="value"}

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 updates the tags of a Databricks workspace.

Example 2: Enable encryption on a Databricks workspace.

Update-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t2 -PrepareEncryption
$updWsp = Get-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t2
Set-AzKeyVaultAccessPolicy -VaultName azps-keyvault -ObjectId $updWsp.StorageAccountIdentityPrincipalId -PermissionsToKeys wrapkey,unwrapkey,get
Update-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t2 -EncryptionKeySource 'Microsoft.KeyVault' -EncryptionKeyVaultUri https://azps-keyvault.vault.azure.net/ -EncryptionKeyName azps-k1 -EncryptionKeyVersion a563a8021cba47109d93bd6d690621a7

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

Enabling encryption on a Databricks workspace takes three steps: 1.Please make sure that KeyVault has Purge protection enabled. 2.Update the workspace with -PrepareEncryption (if it was not created so). 3.Find StorageAccountIdentityPrincipalId in the output of the last step and grant key permissions to the principal. 4.Update the workspace again to fill in information about the encryption key:

-EncryptionKeySource
-EncryptionKeyVaultUri
-EncryptionKeyName
-EncryptionKeyVersion 5.Important! Please read the information in the following document in detail: https://learn.microsoft.com/en-us/azure/databricks/security/keys/cmk-managed-services-azure/customer-managed-key-managed-services-azure?WT.mc_id=Portal-Microsoft_Azure_Databricks#--use-the-azure-portal

Example 3: Disable encryption on a Databricks workspace.

Update-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t3 -EncryptionKeySource 'Default'

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

To disable encryption, simply set -EncryptionKeySource to 'Default'.

Example 4: Update NsgRule of the Databricks workspace.

Update-AzDatabricksWorkspace -ResourceGroupName azps_test_gp_db -Name azps-databricks-workspace-t2 -RequiredNsgRule 'AllRules'

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 updates NsgRule of the Databricks workspace.

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 credentials, account, tenant, and subscription used for communication with Azure.

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 Key Vault 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 (DNS name) of the Key Vault.

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

-InputObject

Identity parameter. To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

-KeyVaultKeyName

The name of KeyVault key.

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

-KeyVaultKeyVersion

The version of KeyVault key.

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

-KeyVaultUri

The Uri of KeyVault.

Type:	String
Position:	Named
Default value:	None
Required:	False
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

-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

-NoWait

Run the command asynchronously

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

-PrepareEncryption

Prepare the workspace for encryption. Enables the Managed Identity for managed storage account.

Type:	SwitchParameter
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

-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

-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

-SkuTier

The SKU tier.

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

-SubscriptionId

The ID of the target subscription.

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

-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

Inputs

IDatabricksIdentity

Outputs

IWorkspace

Share via

Update-AzDatabricksWorkspace

Syntax

Description

Examples

Example 1: Updates the tags of a Databricks workspace.

Example 2: Enable encryption on a Databricks workspace.

Example 3: Disable encryption on a Databricks workspace.

Example 4: Update NsgRule of the Databricks workspace.

Parameters

-AccessConnectorId

-AccessConnectorIdentityType

-AccessConnectorUserAssignedIdentityId

-AmlWorkspaceId

-AsJob

-Authorization

-AutomaticClusterUpdateValue

-ComplianceSecurityProfileComplianceStandard

-ComplianceSecurityProfileValue

-Confirm

-DefaultCatalogInitialType

-DefaultProfile

-DefaultStorageFirewall

-EnableNoPublicIP

-EncryptionKeyName

-EncryptionKeySource

-EncryptionKeyVaultUri

-EncryptionKeyVersion

-EnhancedSecurityMonitoringValue

-InputObject

-KeyVaultKeyName

-KeyVaultKeyVersion

-KeyVaultUri

-ManagedDiskKeySource

-ManagedDiskKeyVaultPropertiesKeyName

-ManagedDiskKeyVaultPropertiesKeyVaultUri

-ManagedDiskKeyVaultPropertiesKeyVersion

-ManagedDiskRotationToLatestKeyVersionEnabled

-ManagedServiceKeySource

-ManagedServicesKeyVaultPropertiesKeyName

-ManagedServicesKeyVaultPropertiesKeyVaultUri

-ManagedServicesKeyVaultPropertiesKeyVersion

-Name

-NoWait

-PrepareEncryption

-PublicNetworkAccess

-RequiredNsgRule

-ResourceGroupName

-SkuTier

-SubscriptionId

-Tag

-UiDefinitionUri

-WhatIf

Inputs

Outputs

Additional resources