Pular para o conteúdo principal

credentials grupo de comando

nota

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 credentials dentro do Databricks CLI permite gerenciar credenciais para acessar serviços em sua nuvem tenant. Cada credencial está sujeita às políticas de controle de acesso do Unity Catalog, que controlam quais usuários e grupos podem acessar a credencial.

Uma credencial representa um mecanismo de autenticação e autorização para acessar o serviço em sua nuvem tenant. Para criar credenciais, é necessário ser um administrador do Databricks account ou possuir o privilégio CREATE SERVICE CREDENTIAL. O usuário que cria a credencial pode delegar a propriedade a outro usuário ou grupo para gerenciar as permissões sobre ela.

credenciais do databricks create-credential

Crie uma nova credencial. O tipo de credencial a ser criada é determinado pelo campo purpose, que deve ser SERVICE ou STORAGE.

O autor da chamada deve ser um administrador do metastore ou possuir o privilégio do metastore CREATE_STORAGE_CREDENTIAL para credenciais de armazenamento ou CREATE_SERVICE_CREDENTIAL para credenciais de serviço.

databricks credentials create-credential 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 strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

--purpose CredentialPurpose

Indica a finalidade da credencial. Valores suportados: SERVICE, STORAGE

--read-only

Se a credencial é utilizável apenas para operações de leitura

--skip-validation

Opcional

Bandeiras globais

Exemplos

O exemplo a seguir cria uma credencial de serviço chamada my-service-cred:

Bash
databricks credentials create-credential my-service-cred --purpose SERVICE

O exemplo a seguir cria uma credencial de armazenamento somente para leitura:

Bash
databricks credentials create-credential readonly-storage --purpose STORAGE --read-only

credenciais do databricks delete-credential

Exclua uma credencial de serviço ou armazenamento do metastore. O chamador deve ser proprietário da credencial.

databricks credentials delete-credential NAME_ARG [flags]

Argumentos

NAME_ARG

Nome da credencial

Opções

--force

Forçar uma atualização mesmo que existam serviços dependentes (quando o objetivo é SERVICE) ou locais externos dependentes e tabelas externas (quando o objetivo é STORAGE)

Bandeiras globais

Exemplos

O exemplo a seguir exclui uma credencial chamada my-service-cred:

Bash
databricks credentials delete-credential my-service-cred

O exemplo a seguir força a exclusão de uma credencial com dependências:

Bash
databricks credentials delete-credential my-storage-cred --force

databricks credenciais gerar-credencial-de-serviço-temporária

Gere uma credencial de serviço temporária utilizando a credencial de serviço especificada. O autor da chamada deve ser um administrador do metastore ou possuir o privilégio do metastore ACCESS na credencial do serviço.

databricks credentials generate-temporary-service-credential CREDENTIAL_NAME [flags]

Argumentos

CREDENTIAL_NAME

O nome da credencial de serviço utilizada para gerar uma credencial temporária.

Opções

--json JSON

As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

Bandeiras globais

Exemplos

O exemplo a seguir gera credenciais temporárias para uma credencial de serviço:

Bash
databricks credentials generate-temporary-service-credential my-service-cred

credenciais do databricks get-credential

Obtenha uma credencial de serviço ou armazenamento na metastore. O chamador deve ser administrador da Metastore, proprietário da credencial ou ter qualquer permissão na credencial.

databricks credentials get-credential NAME_ARG [flags]

Argumentos

NAME_ARG

Nome da credencial

Opções

Bandeiras globais

Exemplos

O exemplo a seguir obtém informações sobre uma credencial chamada my-service-cred:

Bash
databricks credentials get-credential my-service-cred

lista de credenciais do databricks - credenciais

Liste as credenciais. A lista é limitada somente às credenciais 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 credentials list-credentials [flags]

Opções

--max-results int

Número máximo de credenciais a serem devolvidas

--page-token string

Tokens opacos para recuperar a próxima página de resultados

--purpose CredentialPurpose

Devolva somente as credenciais para a finalidade especificada. Valores suportados: SERVICE, STORAGE

Bandeiras globais

Exemplos

O exemplo a seguir lista todas as credenciais:

Bash
databricks credentials list-credentials

O exemplo a seguir lista apenas credenciais de serviço:

Bash
databricks credentials list-credentials --purpose SERVICE

O exemplo a seguir lista credenciais com no máximo 10 resultados:

Bash
databricks credentials list-credentials --max-results 10

credencial de atualização de credenciais do databricks

Atualize uma credencial de serviço ou armazenamento no metastore.

O chamador deve ser o proprietário da credencial ou um administrador da metastore ou ter a permissão MANAGE. Se o chamador for um administrador da metastore, somente o campo owner poderá ser alterado.

databricks credentials update-credential NAME_ARG [flags]

Argumentos

NAME_ARG

Nome da credencial

Opções

--comment string

Comentário associado à credencial

--force

Forçar uma atualização mesmo que existam serviços dependentes (quando o objetivo é SERVICE) ou locais externos dependentes e tabelas externas (quando o objetivo é STORAGE)

--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 strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

--new-name string

Novo nome da credencial

--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

Forneça esse argumento verdadeiro para ignorar a validação da credencial atualizada

Bandeiras globais

Exemplos

O exemplo a seguir atualiza o comentário de uma credencial:

Bash
databricks credentials update-credential my-service-cred --comment "Updated service credential"

O exemplo a seguir renomeia uma credencial:

Bash
databricks credentials update-credential my-service-cred --new-name my-renamed-cred

O exemplo a seguir altera o proprietário de uma credencial:

Bash
databricks credentials update-credential my-service-cred --owner someone@example.com

O exemplo a seguir torna uma credencial somente para leitura:

Bash
databricks credentials update-credential my-storage-cred --read-only

credenciais do databricks validate-credential

Valide uma credencial.

Para credenciais de serviço (finalidade é SERVICE), é necessário fornecer o credential_name ou a credencial específica da nuvem.

Para credenciais de armazenamento (a finalidade é STORAGE), pelo menos uma de external_location_name e url precisa ser fornecida. 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 credential_name ou a credencial específica da nuvem devem ser fornecidas.

O chamador deve ser administrador da metastore ou proprietário da credencial ou ter a permissão necessária na metastore e na credencial (por exemplo, CREATE_EXTERNAL_LOCATION quando a finalidade é STORAGE).

databricks credentials validate-credential [flags]

Opções

--credential-name string

Obrigatório

--external-location-name string

O nome de um local externo existente para validar

--json JSON

As strings JSON em linha ou o @path para o arquivo JSON com o corpo da solicitação

--purpose CredentialPurpose

O objetivo da credencial. Valores suportados: SERVICE, STORAGE

--read-only

Se a credencial é utilizável apenas para operações de leitura

--url string

O URL de localização externa a ser validado

Bandeiras globais

Exemplos

O exemplo a seguir valida uma credencial de serviço:

Bash
databricks credentials validate-credential --credential-name my-service-cred --purpose SERVICE

O exemplo a seguir valida uma credencial de armazenamento em um local externo:

Bash
databricks credentials validate-credential --credential-name my-storage-cred --purpose STORAGE --external-location-name my-external-location

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