Compartilhar via

az databricks workspace

  • Referência

Observação

Essa referência faz parte da extensão do 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 workspace do Databricks.

Comandos

Nome Description Tipo Status
az databricks workspace create

Criar um espaço de trabalho.

 Extensão GA
az databricks workspace delete

Exclua o workspace.

 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 workspace especificado.

 Extensão GA
az databricks workspace outbound-endpoint list

Liste a lista de pontos de extremidade que o workspace injetado pela 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, consulte 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 workspace do Databricks.

 Extensão GA
az databricks workspace private-endpoint-connection create

Crie o status de uma conexão de ponto de extremidade privado com o nome especificado.

 Extensão GA
az databricks workspace private-endpoint-connection delete

Exclua a conexão de ponto de extremidade privado com o nome especificado.

 Extensão GA
az databricks workspace private-endpoint-connection list

Listar conexões de ponto de extremidade privado do workspace.

 Extensão GA
az databricks workspace private-endpoint-connection show

Obtenha propriedades de conexão de ponto de extremidade privado para um workspace.

 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 workspace do Databricks.

 Extensão GA
az databricks workspace private-link-resource list

Listar recursos de link privado para um determinado workspace.

 Extensão GA
az databricks workspace private-link-resource show

Obtenha o recurso de link privado especificado para a ID do grupo fornecida (sub-recurso).

 Extensão GA
az databricks workspace show

Mostre 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 workspace do Databricks.

 Extensão GA
az databricks workspace vnet-peering create

Crie um emparelhamento de rede virtual para um workspace.

 Extensão GA
az databricks workspace vnet-peering delete

Exclua o emparelhamento vnet.

 Extensão GA
az databricks workspace vnet-peering list

Listar emparelhamentos de vnet em um workspace.

 Extensão GA
az databricks workspace vnet-peering show

Mostre o emparelhamento de 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

Criar um espaço 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 um workspace

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

Criar um workspace com identidade gerenciada para conta de armazenamento

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

Parâmetros Exigidos

--name -n

O nome do workspace.

--resource-group -g

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

Parâmetros Opcionais

--access-connector

Recurso do Conector de Acesso que será associado ao Databricks Workspace Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--default-catalog

Propriedades para a configuração do Catálogo Padrão durante a criação do workspace. Suporte a sintaxe abreviada, 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 aceitos: Disabled, Enabled
--disk-key-auto-rotation

Indique se a versão mais recente da chave deve ser usada automaticamente para a Criptografia de Disco Gerenciado.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--disk-key-name

O nome da chave do KeyVault.

--disk-key-vault

O URI do KeyVault.

--disk-key-version

A versão da chave do KeyVault.

--enable-no-public-ip

Sinalize para habilitar o recurso sem ip público.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enhanced-security-compliance

Contém configurações relacionadas ao Complemento de Segurança e Conformidade Aprimoradas. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--location -l

Local. 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 uma ID de recurso.

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

O nome da chave do KeyVault.

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

O URI do KeyVault.

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

A versão da chave do KeyVault.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--prepare-encryption

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

Valores aceitos: 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: Desabilitado, Habilitado.

Valores aceitos: Disabled, Enabled
--public-subnet

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

--require-infrastructure-encryption

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--required-nsg-rules

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

Valores aceitos: 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 as tags existentes. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--vnet

Nome da Rede Virtual ou ID do recurso.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az databricks workspace delete

Exclua o workspace.

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 workspace

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

Parâmetros Opcionais

--force-deletion

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--name -n

O nome do workspace.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 workspaces em um grupo de recursos

az databricks workspace list --resource-group MyResourceGroup

Listar espaços de trabalho na 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 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. Esse é o valor do token de uma resposta truncada anteriormente.

--resource-group -g

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

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az databricks workspace show

Mostre o espaço de trabalho.

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

Exemplos

Mostrar o espaço de trabalho

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

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--name -n

O nome do workspace.

--resource-group -g

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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 workspace.

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 para a conta de armazenamento.

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

Configurar a 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 da Microsoft

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

Parâmetros Opcionais

--access-connector

Recurso do Conector de Acesso que será associado ao Databricks Workspace Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--add

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

--default-catalog

Propriedades para a configuração do Catálogo Padrão durante a criação do workspace. Suporte a sintaxe abreviada, 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 aceitos: Disabled, Enabled
--disk-key-auto-rotation

Indique se a versão mais recente da chave deve ser usada automaticamente para a Criptografia de Disco Gerenciado.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--disk-key-name

O nome da chave do KeyVault.

--disk-key-vault

O URI do KeyVault.

--disk-key-version

A versão da chave do KeyVault.

--enable-no-public-ip

Sinalize para habilitar o recurso sem ip público.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--enhanced-security-compliance

Contém configurações relacionadas ao Complemento de Segurança e Conformidade Aprimoradas. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

--force-string

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--key-name

O nome da chave do KeyVault.

--key-source

A origem da chave de criptografia (provedor). Valores permitidos: Padrão, Microsoft.Keyvault.

Valores aceitos: Default, Microsoft.Keyvault
--key-vault

O URI do KeyVault.

--key-version

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

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

O nome da chave do KeyVault.

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

O URI do KeyVault.

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

A versão da chave do KeyVault.

--name -n

O nome do workspace.

--no-wait

Não aguarde a conclusão da operação de execução longa.

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--prepare-encryption

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

Valores aceitos: 0, 1, f, false, n, no, t, true, y, yes
--public-network-access

O tipo de acesso à rede para acessar o workspace. Defina o valor como desabilitado para acessar o workspace somente por meio de link privado.

Valores aceitos: 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 somente para uso interno. Valores permitidos: AllRules, NoAzureDatabricksRules, NoAzureServiceRules.

Valores aceitos: AllRules, NoAzureDatabricksRules, NoAzureServiceRules
--resource-group -g

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 do SKU da conta de armazenamento, por exemplo: Standard_GRS, Standard_LRS. Consulte https://aka.ms/storageskus as 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

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes. Suporte a sintaxe abreviada, json-file e yaml-file. Tente "??" para mostrar mais.

Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. 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'.

Valor padrão: 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.

Valor padrão: False
--exists

Aguarde até que o recurso exista.

Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--interval

Intervalo de sondagem em segundos.

Valor padrão: 30
--name -n

O nome do workspace.

--resource-group -g

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--timeout

Espera máxima em segundos.

Valor padrão: 3600
--updated

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

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento 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 aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

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

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.