Update-AzDatabricksWorkspace
Syntax
UpdateExpanded (Default)
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]
[-EnhancedSecurityMonitoring <EnhancedSecurityMonitoringValue>]
[-AutomaticClusterUpdate <AutomaticClusterUpdateValue>]
[-ComplianceStandard <ComplianceStandard[]>]
[-EnhancedSecurityCompliance <ComplianceSecurityProfileValue>]
[-AccessConnectorId <String>]
[-AccessConnectorIdentityType <IdentityType>]
[-AccessConnectorUserAssignedIdentityId <String>]
[-DefaultStorageFirewall <DefaultStorageFirewall>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateViaIdentityExpanded
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]
[-EnhancedSecurityMonitoring <EnhancedSecurityMonitoringValue>]
[-AutomaticClusterUpdate <AutomaticClusterUpdateValue>]
[-ComplianceStandard <ComplianceStandard[]>]
[-EnhancedSecurityCompliance <ComplianceSecurityProfileValue>]
[-AccessConnectorId <String>]
[-AccessConnectorIdentityType <IdentityType>]
[-AccessConnectorUserAssignedIdentityId <String>]
[-DefaultStorageFirewall <DefaultStorageFirewall>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Examples
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:
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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AccessConnectorIdentityType
The identity type of the Access Connector Resource.
Parameter properties
Type: IdentityType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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'.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AmlWorkspaceId
The value which should be used for this field.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AsJob
Run the command as a job
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Authorization
The workspace provider authorizations.
To construct, see NOTES section for AUTHORIZATION properties and create a hash table.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AutomaticClusterUpdate
Status of automated cluster updates feature.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ComplianceStandard
Compliance standards associated with the workspace.
Parameter properties
Type: ComplianceStandard [ ]
Default value: None Supports wildcards: False DontShow: False Aliases: ComplianceSecurityProfileComplianceStandard
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultCatalogInitialType
Defines the initial type of the default catalog.
Possible values (case-insensitive): HiveMetastore, UnityCatalog
Parameter properties
Type: InitialType
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: PSObject
Default value: None Supports wildcards: False DontShow: False Aliases: AzureRMContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultStorageFirewall
Gets or Sets Default Storage Firewall configuration information
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnableNoPublicIP
The value which should be used for this field.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptionKeyName
The name of Key Vault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptionKeySource
The encryption keySource (provider).
Possible values (case-insensitive): Default, Microsoft.Keyvault
Parameter properties
Type: KeySource
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptionKeyVaultUri
The URI (DNS name) of the Key Vault.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptionKeyVersion
The version of KeyVault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnhancedSecurityCompliance
Status of Compliance Security Profile feature.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnhancedSecurityMonitoring
Status of Enhanced Security Monitoring feature.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity parameter.
To construct, see NOTES section for INPUTOBJECT properties and create a hash table.
UpdateViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultKeyName
The name of KeyVault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultKeyVersion
The version of KeyVault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultUri
The Uri of KeyVault.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedDiskKeySource
The encryption keySource (provider).
Possible values (case-insensitive): Microsoft.Keyvault
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedDiskKeyVaultPropertiesKeyName
The name of KeyVault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedDiskKeyVaultPropertiesKeyVaultUri
The URI of KeyVault.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedDiskKeyVaultPropertiesKeyVersion
The version of KeyVault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedDiskRotationToLatestKeyVersionEnabled
Indicate whether the latest key version should be automatically used for Managed Disk Encryption.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedServiceKeySource
The encryption keySource (provider).
Possible values (case-insensitive): Microsoft.Keyvault
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedServicesKeyVaultPropertiesKeyName
The name of KeyVault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedServicesKeyVaultPropertiesKeyVaultUri
The Uri of KeyVault.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ManagedServicesKeyVaultPropertiesKeyVersion
The version of KeyVault key.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the workspace.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: WorkspaceName
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NoWait
Run the command asynchronously
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PrepareEncryption
Prepare the workspace for encryption.
Enables the Managed Identity for managed storage account.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PublicNetworkAccess
The network access type for accessing workspace.
Set value to disabled to access workspace only via private link.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: RequiredNsgRules
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SkuTier
The SKU tier.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
UpdateExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
Resource tags.
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UiDefinitionUri
The blob URI where the UI definition file is located.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
