Compartilhar via


Grupo de comandos credentials

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer provisionamentos de Dados de Uso.

O credentials grupo de comandos dentro da CLI do Databricks permite que você gerencie credenciais para acessar serviços em seu locatário de nuvem. Cada credencial está sujeita a políticas de controle de acesso do Catálogo do Unity que controlam quais usuários e grupos podem acessar a credencial.

Uma credencial representa um mecanismo de autenticação e autorização para acessar serviços em seu locatário de nuvem. Para criar credenciais, você deve ser um administrador de conta do Databricks ou ter o CREATE SERVICE CREDENTIAL privilégio. O usuário que cria a credencial pode delegar a propriedade a outro usuário ou grupo para gerenciar permissões nele.

Databricks credenciais create-credential

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

O chamador deve ser um administrador metastore ou ter o privilégio CREATE_STORAGE_CREDENTIAL metastore para credenciais de armazenamento ou CREATE_SERVICE_CREDENTIAL para credenciais de serviço.

databricks credentials create-credential NAME [flags]

Arguments

NAME

    O nome da credencial. O nome deve ser exclusivo entre as credenciais de armazenamento e de serviço dentro do metastore.

Opções

--comment string

    Comentário associado à credencial

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação

--purpose CredentialPurpose

    Indica a finalidade da credencial. Valores com suporte: SERVICE, STORAGE

--read-only

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

--skip-validation

    Optional

Sinalizadores globais

Examples

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

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

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

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

credenciais de databricks delete-credential

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

databricks credentials delete-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Nome da credencial

Opções

--force

    Force uma atualização mesmo que existam serviços dependentes (quando o propósito for SERVICE) ou localizações externas ou tabelas externas (quando o propósito for STORAGE)

Sinalizadores globais

Examples

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

databricks credentials delete-credential my-service-cred

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

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

credenciais do databricks generate-temporary-service-credential

Gere uma credencial de serviço temporária usando a credencial de serviço especificada. O chamador deve ser um administrador do metastore ou ter o privilégio ACCESS do metastore na credencial de serviço.

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

Arguments

CREDENTIAL_NAME

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

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação

Sinalizadores globais

Examples

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

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

credenciais do Databricks get-credential

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

databricks credentials get-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Nome da credencial

Opções

Sinalizadores globais

Examples

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

databricks credentials get-credential my-service-cred

credenciais de databricks list-credentials

Listar credenciais. A lista é limitada apenas às credenciais que o chamador tem permissão para acessar. Se o chamador for um administrador do metastore, a recuperação de credenciais será irrestrita. Não há garantia de uma ordenação específica dos elementos na matriz.

databricks credentials list-credentials [flags]

Opções

--max-results int

    Número máximo de credenciais a serem retornadas

--page-token string

    Token opaco para recuperar a próxima página de resultados

--purpose CredentialPurpose

    Retorne somente credenciais para a finalidade especificada. Valores com suporte: SERVICE, STORAGE

Sinalizadores globais

Examples

O exemplo a seguir lista todas as credenciais:

databricks credentials list-credentials

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

databricks credentials list-credentials --purpose SERVICE

O exemplo a seguir lista as credenciais com um máximo de 10 resultados:

databricks credentials list-credentials --max-results 10

credenciais do Databricks update-credential

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

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

databricks credentials update-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Nome da credencial

Opções

--comment string

    Comentário associado à credencial

--force

    Force uma atualização mesmo que existam serviços dependentes (quando o propósito for SERVICE) ou localizações externas ou tabelas externas (quando o propósito for STORAGE)

--isolation-mode IsolationMode

    Se o protegível atual é acessível a partir de todos os espaços de trabalho ou de um conjunto específico de espaços de trabalho. Valores com suporte: ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN

--json JSON

    A cadeia de caracteres JSON inserida 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 proprietário atual da credencial

--read-only

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

--skip-validation

    Forneça true a esse argumento para ignorar o processo de validação das credenciais atualizadas

Sinalizadores globais

Examples

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

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

O exemplo a seguir renomeia uma credencial:

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

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

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

O exemplo a seguir torna uma credencial de somente leitura:

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

credenciais do databricks validate-credential

Valide uma credencial.

Para credenciais de serviço (a finalidade é SERVICE), deve ser fornecida a credential_name ou a credencial específica à nuvem.

Para credenciais de armazenamento (a finalidade é STORAGE), pelo menos uma delas 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 o external_location_name será ignorado ao verificar URLs sobrepostas. credential_name ou a credencial específica da nuvem deve ser fornecida.

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

databricks credentials validate-credential [flags]

Opções

--credential-name string

    Required

--external-location-name string

    O nome de uma localização externa existente para validação

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação

--purpose CredentialPurpose

    A finalidade da credencial. Valores com suporte: SERVICE, STORAGE

--read-only

    Se a credencial só pode ser usada para operações de leitura

--url string

    A URL de localização externa a ser validada

Sinalizadores globais

Examples

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

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

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

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

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

    Exiba ajuda para a CLI do Databricks ou o grupo de comandos relacionado ou o comando relacionado.

--log-file corda

    Uma cadeia de caracteres que representa o arquivo para o qual gravar logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desabilitado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor padrão é text.

-p, --profile corda

    O nome do perfil no arquivo ~/.databrickscfg para usar na execução do comando. Se esse sinalizador não for especificado, se existir, o perfil nomeado DEFAULT será usado.

--progress-format formato

    O formato para exibir logs de progresso: default, append, inplace, ou json

-t, --target corda

    Se aplicável, o destino do pacote a ser usado