az databricks workspace

Nota

Essa referência faz parte da extensão databricks para a CLI do Azure (versão 2.57.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az databricks workspace . Saiba mais sobre extensões.

Comandos para gerenciar o espaço de trabalho databricks.

Comandos

Name	Description	Tipo	Status
az databricks workspace create	Crie uma nova área de trabalho.	Extensão	GA
az databricks workspace delete	Exclua o espaço de trabalho.	Extensão	GA
az databricks workspace list	Obtenha todos os espaços de trabalho.	Extensão	GA
az databricks workspace outbound-endpoint	Comandos para gerenciar pontos de extremidade no espaço de trabalho especificado.	Extensão	GA
az databricks workspace outbound-endpoint list	Liste a lista de pontos de extremidade que o Espaço de Trabalho Injetado VNET chama de Plano de Controle do Azure Databricks. Você deve configurar o acesso de saída com esses pontos de extremidade. Para obter mais informações, veja https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/udr.	Extensão	GA
az databricks workspace private-endpoint-connection	Comandos para gerenciar conexões de ponto de extremidade privado do espaço de trabalho databricks.	Extensão	GA
az databricks workspace private-endpoint-connection create	Crie o status de uma conexão de ponto de extremidade privada com o nome especificado.	Extensão	GA
az databricks workspace private-endpoint-connection delete	Exclua a conexão de ponto de extremidade privada com o nome especificado.	Extensão	GA
az databricks workspace private-endpoint-connection list	Liste conexões de ponto de extremidade privadas do espaço de trabalho.	Extensão	GA
az databricks workspace private-endpoint-connection show	Obtenha propriedades de conexão de ponto de extremidade privado para um espaço de trabalho.	Extensão	GA
az databricks workspace private-endpoint-connection update	Atualize o status de uma conexão de ponto de extremidade privado com o nome especificado.	Extensão	GA
az databricks workspace private-endpoint-connection wait	Coloque a CLI em um estado de espera até que uma condição seja atendida.	Extensão	GA
az databricks workspace private-link-resource	Comandos para gerenciar recursos de link privado do espaço de trabalho databricks.	Extensão	GA
az databricks workspace private-link-resource list	Listar recursos de link privado para um determinado espaço de trabalho.	Extensão	GA
az databricks workspace private-link-resource show	Obtenha o recurso de link privado especificado para uma determinada id de grupo (subrecurso).	Extensão	GA
az databricks workspace show	Mostrar o espaço de trabalho.	Extensão	GA
az databricks workspace update	Atualize o espaço de trabalho.	Extensão	GA
az databricks workspace vnet-peering	Comandos para gerenciar o emparelhamento vnet do espaço de trabalho databricks.	Extensão	GA
az databricks workspace vnet-peering create	Crie um emparelhamento vnet para um espaço de trabalho.	Extensão	GA
az databricks workspace vnet-peering delete	Exclua o emparelhamento vnet.	Extensão	GA
az databricks workspace vnet-peering list	Liste emparelhamentos vnet em um espaço de trabalho.	Extensão	GA
az databricks workspace vnet-peering show	Mostrar o emparelhamento vnet.	Extensão	GA
az databricks workspace vnet-peering update	Atualize o emparelhamento vnet.	Extensão	GA
az databricks workspace vnet-peering wait	Coloque a CLI em um estado de espera até que uma condição seja atendida.	Extensão	GA
az databricks workspace wait	Coloque a CLI em um estado de espera até que uma condição seja atendida.	Extensão	GA

az databricks workspace create

Crie uma nova área de trabalho.

az databricks workspace create --name
                               --resource-group
                               [--access-connector]
                               [--default-catalog]
                               [--default-storage-firewall {Disabled, Enabled}]
                               [--disk-key-auto-rotation {0, 1, f, false, n, no, t, true, y, yes}]
                               [--disk-key-name]
                               [--disk-key-vault]
                               [--disk-key-version]
                               [--enable-no-public-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--enhanced-security-compliance]
                               [--location]
                               [--managed-resource-group]
                               [--managed-services-key-name]
                               [--managed-services-key-vault]
                               [--managed-services-key-version]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--prepare-encryption {0, 1, f, false, n, no, t, true, y, yes}]
                               [--private-subnet]
                               [--public-network-access {Disabled, Enabled}]
                               [--public-subnet]
                               [--require-infrastructure-encryption {0, 1, f, false, n, no, t, true, y, yes}]
                               [--required-nsg-rules {AllRules, NoAzureDatabricksRules, NoAzureServiceRules}]
                               [--sku]
                               [--tags]
                               [--vnet]

Exemplos

Criar uma área de trabalho

az databricks workspace create --resource-group MyResourceGroup --name MyWorkspace --location westus --sku standard

Criar um espaço de trabalho com identidade gerenciada para conta de armazenamento

az databricks workspace create --resource-group MyResourceGroup --name MyWorkspace --location eastus2euap --sku premium --prepare-encryption

Parâmetros Obrigatórios

--name -n

O nome do espaço de trabalho.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Opcionais

--access-connector

Access Connector Resource que será associado ao Databricks Workspace Support shorthand-syntax, json-file e yaml-file. Tente "??" para mostrar mais.

--default-catalog

Propriedades para configuração do Catálogo Padrão durante a criação do espaço de trabalho. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--default-storage-firewall

Obtém ou define informações de configuração do Firewall de Armazenamento Padrão.

Valores aceites: Disabled, Enabled

--disk-key-auto-rotation

Indique se a versão de chave mais recente deve ser usada automaticamente para criptografia de disco gerenciado.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--disk-key-name

O nome da chave KeyVault.

--disk-key-vault

O URI do KeyVault.

--disk-key-version

A versão da chave KeyVault.

--enable-no-public-ip

Sinalizador para ativar o recurso sem ip público.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--enhanced-security-compliance

Contém configurações relacionadas ao Complemento de Segurança Reforçada e Conformidade. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--location -l

Localização. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>. Quando não especificado, o local do grupo de recursos será usado.

--managed-resource-group

O grupo de recursos gerenciados a ser criado. Pode ser um nome ou um ID de recurso.

--managed-services-key-name --ms-key-name

O nome da chave KeyVault.

--managed-services-key-vault --ms-key-vault

O Uri do KeyVault.

--managed-services-key-version --ms-key-version

A versão da chave KeyVault.

--no-wait

Não espere que a operação de longa duração termine.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--prepare-encryption

Sinalize para habilitar a Identidade Gerenciada para a conta de armazenamento gerenciado para se preparar para a criptografia CMK.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--private-subnet

O nome de uma Sub-rede Privada dentro da Rede Virtual.

--public-network-access

A configuração para definir se o acesso à rede da Internet pública para os pontos de extremidade é permitido. Valores permitidos: Desativado, Habilitado.

Valores aceites: Disabled, Enabled

--public-subnet

O nome de uma Sub-rede Pública dentro da Rede Virtual.

--require-infrastructure-encryption

Sinalizador para habilitar o sistema de arquivos raiz DBFS com camada secundária de criptografia com chaves gerenciadas pela plataforma para dados em repouso.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--required-nsg-rules

O tipo de regra Nsg apenas para uso interno. Valores permitidos: AllRules, NoAzureDatabricksRules, NoAzureServiceRules.

Valores aceites: AllRules, NoAzureDatabricksRules, NoAzureServiceRules

--sku

O nome da camada de SKU. Valores permitidos: premium, standard, trial.

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--vnet

Nome da rede virtual ou ID do recurso.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az databricks workspace delete

Exclua o espaço de trabalho.

az databricks workspace delete [--force-deletion {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--resource-group]
                               [--subscription]
                               [--yes]

Exemplos

Excluir o espaço de trabalho

az databricks workspace delete --resource-group MyResourceGroup --name MyWorkspace -y

Parâmetros Opcionais

--force-deletion

Parâmetro opcional para reter os dados padrão do catálogo da unidade. Por padrão, os dados serão retidos se o Uc estiver habilitado no espaço de trabalho.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

Default value: False

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

O nome do espaço de trabalho.

--no-wait

Não espere que a operação de longa duração termine.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--yes -y

Não solicite confirmação.

Default value: False

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az databricks workspace list

Obtenha todos os espaços de trabalho.

az databricks workspace list [--max-items]
                             [--next-token]
                             [--resource-group]

Exemplos

Listar espaços de trabalho dentro de um grupo de recursos

az databricks workspace list --resource-group MyResourceGroup

Listar espaços de trabalho dentro da assinatura padrão

az databricks workspace list

Parâmetros Opcionais

--max-items

Número total de itens a serem retornados na saída do comando. Se o número total de itens disponíveis for maior do que o valor especificado, um token será fornecido na saída do comando. Para retomar a paginação, forneça o valor do token no --next-token argumento de um comando subsequente.

--next-token

Token para especificar por onde começar a paginar. Este é o valor de token de uma resposta truncada anteriormente.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az databricks workspace show

Mostrar o espaço de trabalho.

az databricks workspace show [--ids]
                             [--name]
                             [--resource-group]
                             [--subscription]

Exemplos

Mostrar a área de trabalho

az databricks workspace show --resource-group MyResourceGroup --name MyWorkspace

Parâmetros Opcionais

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

O nome do espaço de trabalho.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az databricks workspace update

Atualize o espaço de trabalho.

az databricks workspace update [--access-connector]
                               [--add]
                               [--default-catalog]
                               [--default-storage-firewall {Disabled, Enabled}]
                               [--disk-key-auto-rotation {0, 1, f, false, n, no, t, true, y, yes}]
                               [--disk-key-name]
                               [--disk-key-vault]
                               [--disk-key-version]
                               [--enable-no-public-ip {0, 1, f, false, n, no, t, true, y, yes}]
                               [--enhanced-security-compliance]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--key-name]
                               [--key-source {Default, Microsoft.Keyvault}]
                               [--key-vault]
                               [--key-version]
                               [--managed-services-key-name]
                               [--managed-services-key-vault]
                               [--managed-services-key-version]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--prepare-encryption {0, 1, f, false, n, no, t, true, y, yes}]
                               [--public-network-access {Disabled, Enabled}]
                               [--remove]
                               [--required-nsg-rules {AllRules, NoAzureDatabricksRules, NoAzureServiceRules}]
                               [--resource-group]
                               [--sa-sku-name]
                               [--set]
                               [--sku]
                               [--subscription]
                               [--tags]

Exemplos

Atualize as tags do espaço de trabalho.

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --tags key1=value1 key2=value2

Limpe as tags do espaço de trabalho.

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --tags ""

Prepare-se para a criptografia CMK atribuindo identidade à conta de armazenamento.

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --prepare-encryption

Configurar criptografia CMK

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --key-source Microsoft.KeyVault --key-name MyKey --key-vault https://myKeyVault.vault.azure.net/ --key-version 00000000000000000000000000000000

Reverter a criptografia para chaves gerenciadas pela Microsoft

az databricks workspace update --resource-group MyResourceGroup --name MyWorkspace --key-source Default

Parâmetros Opcionais

--access-connector

Access Connector Resource que será associado ao Databricks Workspace Support shorthand-syntax, json-file e yaml-file. Tente "??" para mostrar mais.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valor de chave. Exemplo: --add property.listProperty <key=value, string ou JSON string>.

--default-catalog

Propriedades para configuração do Catálogo Padrão durante a criação do espaço de trabalho. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--default-storage-firewall

Obtém ou define informações de configuração do Firewall de Armazenamento Padrão.

Valores aceites: Disabled, Enabled

--disk-key-auto-rotation

Indique se a versão de chave mais recente deve ser usada automaticamente para criptografia de disco gerenciado.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--disk-key-name

O nome da chave KeyVault.

--disk-key-vault

O URI do KeyVault.

--disk-key-version

A versão da chave KeyVault.

--enable-no-public-ip

Sinalizador para ativar o recurso sem ip público.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--enhanced-security-compliance

Contém configurações relacionadas ao Complemento de Segurança Reforçada e Conformidade. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

--force-string

Ao usar 'set' ou 'add', preserve literais de string em vez de tentar converter para JSON.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--key-name

O nome da chave KeyVault.

--key-source

A fonte da chave de criptografia (provedor). Valores permitidos: Default, Microsoft.Keyvault.

Valores aceites: Default, Microsoft.Keyvault

--key-vault

O Uri do KeyVault.

--key-version

A versão da chave KeyVault. É opcional ao atualizar a CMK.

--managed-services-key-name --ms-key-name

O nome da chave KeyVault.

--managed-services-key-vault --ms-key-vault

O Uri do KeyVault.

--managed-services-key-version --ms-key-version

A versão da chave KeyVault.

--name -n

O nome do espaço de trabalho.

--no-wait

Não espere que a operação de longa duração termine.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--prepare-encryption

Sinalize para habilitar a Identidade Gerenciada para a conta de armazenamento gerenciado para se preparar para a criptografia CMK.

Valores aceites: 0, 1, f, false, n, no, t, true, y, yes

--public-network-access

O tipo de acesso à rede para acessar o espaço de trabalho. Defina o valor como desativado para acessar o espaço de trabalho somente via link privado.

Valores aceites: Disabled, Enabled

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list OR --remove propertyToRemove.

--required-nsg-rules

O tipo de regra Nsg apenas para uso interno. Valores permitidos: AllRules, NoAzureDatabricksRules, NoAzureServiceRules.

Valores aceites: AllRules, NoAzureDatabricksRules, NoAzureServiceRules

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--sa-sku-name --storage-account-sku-name

Nome da SKU da conta de armazenamento, por exemplo: Standard_GRS, Standard_LRS. Consulte https://aka.ms/storageskus para obter entradas válidas.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a ser definido. Exemplo: --set property1.property2=.

--sku

O nome da camada de SKU. Valores permitidos: premium, standard, trial.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar tags existentes. Suporta sintaxe taquigráfica, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az databricks workspace wait

Coloque a CLI em um estado de espera até que uma condição seja atendida.

az databricks workspace wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

Parâmetros Opcionais

--created

Aguarde até ser criado com 'provisioningState' em 'Succeeded'.

Default value: False

--custom

Aguarde até que a condição satisfaça uma consulta JMESPath personalizada. Por exemplo, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Aguarde até ser excluído.

Default value: False

--exists

Aguarde até que o recurso exista.

Default value: False

--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--interval

Intervalo de sondagem em segundos.

Default value: 30

--name -n

O nome do espaço de trabalho.

--resource-group -g

o nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--timeout

Espera máxima em segundos.

Default value: 3600

--updated

Aguarde até ser atualizado com provisioningState em 'Succeeded'.

Default value: False

Parâmetros de Globais

--debug

Aumente a verbosidade do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.