storage-credentials
grupo de comando
Esta informação se aplica a Databricks CLI versões 0.205 e acima. A CLI do Databricks está em pré-visualização pública.
Databricks CLI O uso está sujeito à LicençaDatabricks e à Política de PrivacidadeDatabricks, incluindo qualquer disposição sobre Dados de Uso.
O grupo de comandos storage-credentials
dentro do Databricks CLI contém comandos para gerenciar credenciais de armazenamento no Unity Catalog. Uma credencial de armazenamento representa um mecanismo de autenticação e autorização para acessar dados armazenados em sua nuvem tenant. Cada credencial de armazenamento está sujeita às políticas de controle de acesso do Unity Catalog, que controlam quais usuários e grupos podem acessar a credencial. Se um usuário não tiver acesso a uma credencial de armazenamento em Unity Catalog, a solicitação falhará e Unity Catalog não tentará autenticar-se no seu cloud tenant em nome do usuário. Consulte gerenciar credenciais de armazenamento.
as credenciais de armazenamento do databricks criam
Crie uma nova credencial de armazenamento.
O chamador deve ser administrador da metastore ou ter o privilégio CREATE_STORAGE_CREDENTIAL
na metastore.
databricks storage-credentials create NAME [flags]
Argumentos
NAME
O nome da credencial. O nome deve ser exclusivo entre as credenciais de armazenamento e serviço no metastore.
Opções
--comment string
Comentário associado à credencial.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--read-only
Se a credencial é utilizável apenas para operações de leitura.
--skip-validation
Fornecer esse argumento verdadeiro ignora a validação da credencial criada.
Exemplos
O exemplo a seguir cria uma nova credencial de armazenamento:
databricks storage-credentials create my-storage-credential
O exemplo a seguir cria uma credencial de armazenamento com um comentário:
databricks storage-credentials create my-storage-credential --comment "S3 credential for analytics data"
O exemplo a seguir cria uma credencial de armazenamento somente para leitura:
databricks storage-credentials create my-storage-credential --read-only
exclusão de credenciais de armazenamento do databricks
Exclua uma credencial de armazenamento da metastore. O chamador deve ser proprietário da credencial de armazenamento.
databricks storage-credentials delete NAME [flags]
Argumentos
NAME
Nome da credencial de armazenamento.
Opções
--force
Forçar uma atualização mesmo que existam locais externos dependentes ou tabelas externas (quando o objetivo é STORAGE
) ou serviço dependente (quando o objetivo é SERVICE
).
Exemplos
O exemplo a seguir exclui uma credencial de armazenamento:
databricks storage-credentials delete my-storage-credential
O exemplo a seguir força a exclusão de uma credencial de armazenamento:
databricks storage-credentials delete my-storage-credential --force
as credenciais de armazenamento do databricks obtêm
Obtenha uma credencial de armazenamento na metastore. O chamador deve ser administrador da metastore, proprietário da credencial de armazenamento ou ter alguma permissão na credencial de armazenamento.
databricks storage-credentials get NAME [flags]
Argumentos
NAME
Nome da credencial de armazenamento.
Opções
Exemplos
O exemplo a seguir obtém informações sobre uma credencial de armazenamento:
databricks storage-credentials get my-storage-credential
lista de credenciais de armazenamento do databricks
Liste as credenciais de armazenamento. A lista é limitada somente às credenciais de armazenamento que o chamador tem permissão para acessar. Se o chamador for um administrador da metastore, a recuperação das credenciais é irrestrita. Não há garantia de uma ordem específica dos elementos na matriz.
databricks storage-credentials list [flags]
Opções
--max-results int
Número máximo de credenciais de armazenamento a serem devolvidas.
--page-token string
Tokens de paginação opacos para avançar para a próxima página com base na consulta anterior.
Exemplos
O exemplo a seguir lista todas as credenciais de armazenamento:
databricks storage-credentials list
atualização das credenciais de armazenamento do databricks
Atualize uma credencial de armazenamento na metastore.
O chamador deve ser o proprietário da credencial de armazenamento ou um administrador da metastore. Se o chamador for um administrador da metastore, somente o campo owner
poderá ser alterado.
databricks storage-credentials update NAME [flags]
Argumentos
NAME
Nome da credencial de armazenamento.
Opções
--comment string
Comentário associado à credencial.
--force
Força a atualização mesmo se houver locais externos dependentes ou tabelas externas.
--isolation-mode IsolationMode
Se o recurso protegido atual está acessível a partir de todo o espaço de trabalho ou de um conjunto específico de espaços de trabalho. Valores suportados: [ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--new-name string
Novo nome para a credencial de armazenamento.
--owner string
Nome de usuário do atual proprietário da credencial.
--read-only
Se a credencial é utilizável apenas para operações de leitura.
--skip-validation
Fornecer esse argumento de forma fiel ignora a validação da credencial atualizada.
Exemplos
O exemplo a seguir atualiza o comentário de uma credencial de armazenamento:
databricks storage-credentials update my-storage-credential --comment "Updated S3 credential"
O exemplo a seguir altera o proprietário de uma credencial de armazenamento:
databricks storage-credentials update my-storage-credential --owner someone@example.com
O exemplo a seguir renomeia uma credencial de armazenamento:
databricks storage-credentials update my-storage-credential --new-name updated-credential
validação das credenciais de armazenamento do databricks
Valide uma credencial de armazenamento. Pelo menos um dos external_location_name
e url
precisa ser fornecido. Se apenas um deles for fornecido, ele será usado para validação. E se ambos forem fornecidos, o url
será usado para validação e external_location_name
será ignorado ao verificar a sobreposição de URLs.
A credencial storage_credential_name
ou a credencial específica da nuvem devem ser fornecidas.
O chamador deve ser administrador da metastore ou proprietário da credencial de armazenamento ou ter o privilégio CREATE_EXTERNAL_LOCATION
na metastore e na credencial de armazenamento.
databricks storage-credentials validate [flags]
Opções
--external-location-name string
O nome de um local externo existente a ser validado.
--json JSON
As cadeias de caracteres JSON ou o caminho @path para o arquivo JSON com o corpo da solicitação.
--read-only
Se a credencial de armazenamento é utilizável apenas para operações de leitura.
--storage-credential-name string
Obrigatório.
--url string
O URL de localização externa a ser validado.
Exemplos
O exemplo a seguir valida uma credencial de armazenamento em um local externo:
databricks storage-credentials validate --storage-credential-name my-storage-credential --external-location-name my-external-location
O exemplo a seguir valida uma credencial de armazenamento em relação a um URL:
databricks storage-credentials validate --storage-credential-name my-storage-credential --url s3://my-bucket/path
Bandeiras globais
--debug
Se deve habilitar o registro de depuração.
-h
ou --help
Exibir ajuda para o comando Databricks CLI ou para o grupo de comandos relacionado ou para o comando relacionado.
--log-file
string
Uma string que representa o arquivo no qual a saída logs deve ser gravada. Se este sinalizador não for especificado, o default deverá gravar a saída logs no stderr.
--log-format
Formato
O tipo de formato do log, text
ou json
. O valor de default é text
.
--log-level
string
Uma string que representa o nível de formato do log. Se não for especificado, o nível de formato do log será desativado.
-o, --output
Tipo
O tipo de saída do comando, text
ou json
. O valor de default é text
.
-p, --profile
string
O nome do perfil no arquivo ~/.databrickscfg
a ser utilizado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil chamado DEFAULT
será usado.
--progress-format
Formato
O formato para exibir o progresso logs: default
, append
, inplace
ou json
-t, --target
string
Se aplicável, o destino do pacote a ser usado