Partager via


credentials groupe de commande

Note

Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Le credentials groupe de commandes dans l’interface CLI Databricks vous permet de gérer les informations d’identification pour accéder aux services sur votre locataire cloud. Chaque informations d’identification est soumise aux stratégies de contrôle d’accès du catalogue Unity qui contrôlent les utilisateurs et les groupes qui peuvent accéder aux informations d’identification.

Les informations d’identification représentent un mécanisme d’authentification et d’autorisation pour accéder aux services sur votre locataire cloud. Pour créer des informations d’identification, vous devez être administrateur de compte Databricks ou avoir le CREATE SERVICE CREDENTIAL privilège. L’utilisateur qui crée les informations d’identification peut déléguer la propriété à un autre utilisateur ou groupe pour gérer les autorisations sur celui-ci.

databricks credentials create-credential

Créez un nouvel identifiant. Le type d’informations d’identification à créer est déterminé par le purpose champ, qui doit être soit SERVICE, soit STORAGE.

L’appelant doit être un administrateur du metastore ou avoir le privilège CREATE_STORAGE_CREDENTIAL du metastore pour les informations d’authentification de stockage, ou CREATE_SERVICE_CREDENTIAL pour les informations d’authentification du service.

databricks credentials create-credential NAME [flags]

Arguments

NAME

    Nom d'identification. Le nom doit être unique parmi les identifiants de stockage et de service du metastore.

Options

--comment string

    Commentaire associé aux informations d’identification

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

--purpose CredentialPurpose

    Indique l’usage des informations d'identification. Valeurs prises en charge : SERVICE, STORAGE

--read-only

    Indique si les informations d’identification sont utilisables uniquement pour les opérations de lecture

--skip-validation

    Optional

Indicateurs globaux

Examples

L’exemple suivant crée des informations d’identification de service nommées my-service-cred:

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

L’exemple suivant crée des informations d’identification de stockage en lecture seule :

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

databricks credentials delete-credential

Supprimez un service ou un identifiant de stockage du metastore. L’appelant doit être propriétaire des informations d’identification.

databricks credentials delete-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Nom des information d'identification

Options

--force

    Forcer une mise à jour même s’il existe des services dépendants (lorsque l’objectif est SERVICE) ou des emplacements externes dépendants et des tables externes (lorsque l’objectif est STORAGE)

Indicateurs globaux

Examples

L’exemple suivant supprime les informations d’identification nommées my-service-cred:

databricks credentials delete-credential my-service-cred

L’exemple suivant force la suppression d’un justificatif avec des dépendances associées :

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

Commande pour générer des informations d’identification temporaires : databricks credentials generate-temporary-service-credential

Créez des accès temporaires au service à l'aide des accès spécifiés du service. L’appelant doit être administrateur de metastore ou disposer du privilège de metastore ACCESS sur ces informations d'identification de service.

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

Arguments

CREDENTIAL_NAME

    Le nom de l'identifiant du service utilisé pour générer un identifiant temporaire

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Examples

L’exemple suivant génère des justificatifs d'identité temporaires pour un justificatif de service :

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

informations d’identification de databricks get-credential

Obtenez un service ou des informations d’identification de stockage à partir du metastore. L’appelant doit être administrateur de metastore, propriétaire des informations d’identification ou avoir une autorisation sur celles-ci.

databricks credentials get-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Nom des information d'identification

Options

Indicateurs globaux

Examples

L’exemple suivant obtient des informations sur un identifiant nommé my-service-cred:

databricks credentials get-credential my-service-cred

databricks credentials list-credentials

Répertorier les informations d’identification. La liste est limitée uniquement aux informations d’identification auxquelles l’appelant a l’autorisation d’accéder. Si l’appelant est un administrateur de metastore, la récupération des informations d’identification n’est pas restreinte. Il n’existe aucune garantie d’un classement spécifique des éléments dans le tableau.

databricks credentials list-credentials [flags]

Options

--max-results int

    Nombre maximal d’informations d’identification à retourner

--page-token string

    Jeton opaque pour récupérer la page suivante des résultats

--purpose CredentialPurpose

    Retournez uniquement les informations d’identification à des fins spécifiées. Valeurs prises en charge : SERVICE, STORAGE

Indicateurs globaux

Examples

L’exemple suivant répertorie toutes les informations d’identification :

databricks credentials list-credentials

L’exemple suivant répertorie uniquement les informations d’identification du service :

databricks credentials list-credentials --purpose SERVICE

L’exemple suivant répertorie les informations d’identification avec un maximum de 10 résultats :

databricks credentials list-credentials --max-results 10

databricks credentials update-credential

Mettez à jour un service ou des informations d’identification de stockage sur le metastore.

L’appelant doit être le propriétaire des informations d’identification, un administrateur de metastore ou disposer de l’autorisation MANAGE. Si l’appelant est un administrateur de metastore, seul le owner champ peut être modifié.

databricks credentials update-credential NAME_ARG [flags]

Arguments

NAME_ARG

    Nom des information d'identification

Options

--comment string

    Commentaire associé aux informations d’identification

--force

    Forcer une mise à jour même s’il existe des services dépendants (lorsque l’objectif est SERVICE) ou des emplacements externes dépendants et des tables externes (lorsque l’objectif est STORAGE)

--isolation-mode IsolationMode

    Indique si la ressource sécurisée est accessible depuis tous les espaces de travail ou uniquement depuis un ensemble spécifique. Valeurs prises en charge : ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

--new-name string

    Nouveau nom des informations d’identification

--owner string

    Nom d’utilisateur du propriétaire actuel des informations d’identification

--read-only

    Indique si les informations d’identification sont utilisables uniquement pour les opérations de lecture

--skip-validation

    Indiquez true à cet argument pour ignorer la validation des informations d’identification mises à jour

Indicateurs globaux

Examples

L’exemple suivant met à jour le commentaire d’une information d’identification :

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

L’exemple suivant renomme les informations d’identification :

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

L’exemple suivant modifie le propriétaire d’une information d’identification :

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

L'exemple suivant rend des informations d’identification en lecture seule :

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

informations d’identification databricks validate-credential

Validez les informations d’identification.

Pour les informations d’identification du service (le but est SERVICE), soit credential_name soit les informations d’identification spécifiques au cloud doivent être fournies.

Pour les informations d’identification de stockage (l'objectif est STORAGE), au moins une des external_location_name et url doit être fournie. Si un seul d’entre eux est fourni, il sera utilisé pour la validation. Et si les deux sont fournis, le url sera utilisé pour la validation et external_location_name sera ignoré lors de la vérification des URL qui se chevauchent. Soit les informations d’identification spécifiques à credential_name, soit celles spécifiques au cloud doivent être fournies.

L’appelant doit être un administrateur de metastore ou le propriétaire des informations d’identification ou disposer de l’autorisation requise sur le metastore et les informations d’identification (par exemple, CREATE_EXTERNAL_LOCATION lorsque l’objectif est STORAGE).

databricks credentials validate-credential [flags]

Options

--credential-name string

    Required

--external-location-name string

    Nom d’un emplacement externe existant à valider

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

--purpose CredentialPurpose

    Usage des informations d’identification. Valeurs prises en charge : SERVICE, STORAGE

--read-only

    Indique si les informations d’identification sont utilisables uniquement pour les opérations de lecture

--url string

    URL d’emplacement externe à valider

Indicateurs globaux

Examples

L’exemple suivant valide les informations d’identification d’un service :

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

L’exemple suivant valide les informations d’identification de stockage avec un emplacement externe :

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

Indicateurs globaux

--debug

  Active la journalisation du débogage.

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne

    Chaîne représentant le fichier dans lequel écrire les journaux de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format format

    Format des journaux : text ou json. La valeur par défaut est text.

--log-level chaîne

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne

    Nom du profil dans le ~/.databrickscfg fichier à utiliser pour exécuter la commande. Si cet indicateur n’est pas spécifié, s’il existe, le profil nommé DEFAULT est utilisé.

--progress-format format

    Format d’affichage des journaux d’activité de progression : default, append, inplace ou json

-t, --target chaîne

    Le cas échéant, la cible d’offre groupée à utiliser