groupe de commandescredentials
L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.
Le groupe de commandes credentials au sein de la CLI Databricks vous permet de gérer les identifiants pour accéder aux services sur votre tenant cloud. Chaque identifiant est soumis aux politiques de contrôle d'accès de Unity Catalog qui contrôlent quels utilisateurs et groupes peuvent accéder à l'identifiant.
Pour les commandes de gestion des configurations d'identifiants inter-comptes de votre compte Databricks, consultez le account credentials groupe de commandes.
Un identifiant représente un mécanisme d'authentification et d'autorisation pour accéder aux services sur votre tenant cloud. Pour créer des identifiants, vous devez être administrateur de compte Databricks ou disposer du privilège CREATE SERVICE CREDENTIAL. L'utilisateur qui crée l'identifiant peut déléguer la propriété à un autre utilisateur ou groupe pour gérer les autorisations y afférentes.
databricks credentials créer-identifiant
Créer un nouvel identifiant. Le type d'identifiant à créer est déterminé par le champ purpose, qui doit être soit SERVICE, soit STORAGE.
L'appelant doit être un administrateur de métastore ou disposer du privilège de métastore CREATE_STORAGE_CREDENTIAL pour les informations d'identification de stockage, ou CREATE_SERVICE_CREDENTIAL pour les informations d'identification de service.
databricks credentials create-credential NAME [flags]
Arguments
NAME
Nom de l'identifiant. Le nom doit être unique parmi les identifiants de stockage et de service au sein du métastore.
Options
--comment string
Commentaire associé à l’identifiant
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
--purpose CredentialPurpose
Indique l'objectif de l'identifiant. Valeurs supportées : SERVICE, STORAGE
--read-only
Si l’identifiant est utilisable uniquement pour les opérations de lecture
--skip-validation
Facultatif
Exemples
L'exemple suivant crée un identifiant de service nommé my-service-cred:
databricks credentials create-credential my-service-cred --purpose SERVICE
L’exemple suivant crée un identifiant de stockage en lecture seule :
databricks credentials create-credential readonly-storage --purpose STORAGE --read-only
databricks credentials delete-credential
Supprimez un identifiant de service ou de stockage du metastore. L'appelant doit être le propriétaire de l'identifiant.
databricks credentials delete-credential NAME_ARG [flags]
Arguments
NAME_ARG
Nom de l'identifiant
Options
--force
Forcer une mise à jour même s'il existe des services dépendants (lorsque l'objectif est SERVICE) ou des emplacements externes et des tables externes dépendants (lorsque l'objectif est STORAGE).
Exemples
L'exemple suivant supprime un identifiant nommé my-service-cred:
databricks credentials delete-credential my-service-cred
L'exemple suivant force la suppression d'un identifiant avec des dépendances :
databricks credentials delete-credential my-storage-cred --force
Databricks credentials generate-temporary-service-credential
Générez un identifiant de service temporaire à l'aide de l'identifiant de service spécifié. L'appelant doit être un administrateur de métastore ou disposer du privilège de métastore ACCESS sur les identifiants de service.
databricks credentials generate-temporary-service-credential CREDENTIAL_NAME [flags]
Arguments
CREDENTIAL_NAME
Le nom de l'identifiant de service utilisé pour générer un identifiant temporaire.
Options
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
Exemples
L'exemple suivant génère des identifiants temporaires pour un identifiant de service :
databricks credentials generate-temporary-service-credential my-service-cred
databricks credentials get-credential
Obtenez un identifiant de service ou de stockage du metastore. L'appelant doit être un administrateur de métastore, le propriétaire de l'identifiant, ou avoir toute permission sur l'identifiant.
databricks credentials get-credential NAME_ARG [flags]
Arguments
NAME_ARG
Nom de l'identifiant
Options
Exemples
L'exemple suivant fournit des informations sur un identifiant nommé my-service-cred:
databricks credentials get-credential my-service-cred
databricks credentials list-credentials
Lister les identifiants. 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 du métastore, la récupération des identifiants est illimitée. Il n'y a aucune garantie d'un ordre spécifique des éléments dans le tableau.
databricks credentials list-credentials [flags]
Options
--max-results int
Nombre maximal d'identifiants à renvoyer
--page-token string
Jeton opaque pour récupérer la page suivante de résultats
--purpose CredentialPurpose
Renvoie uniquement les identifiants pour l’usage spécifié. Valeurs supportées : SERVICE, STORAGE
Exemples
L'exemple suivant répertorie tous les identifiants :
databricks credentials list-credentials
L'exemple suivant répertorie uniquement les identifiants de 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
Mettre à jour un identifiant de service ou de stockage sur le métastore.
L'appelant doit être le propriétaire de l'identifiant ou un administrateur du métastore ou disposer de l'autorisation MANAGE. Si l'appelant est un administrateur du métastore, seul le champ owner peut être modifié.
databricks credentials update-credential NAME_ARG [flags]
Arguments
NAME_ARG
Nom de l'identifiant
Options
--comment string
Commentaire associé à l’identifiant
--force
Forcer une mise à jour même s'il existe des services dépendants (lorsque l'objectif est SERVICE) ou des emplacements externes et des tables externes dépendants (lorsque l'objectif est STORAGE).
--isolation-mode IsolationMode
Que l'élément sécurisable actuel soit accessible depuis tous les workspaces ou un ensemble spécifique de workspaces. Valeurs supportées : ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
--new-name string
Nouveau nom d’identifiant
--owner string
Nom d'utilisateur du propriétaire actuel des identifiants
--read-only
Si l’identifiant est utilisable uniquement pour les opérations de lecture
--skip-validation
Indiquez « true » pour cet argument pour ignorer la validation de l'identifiant mis à jour.
Exemples
L'exemple suivant met à jour le commentaire d'un identifiant :
databricks credentials update-credential my-service-cred --comment "Updated service credential"
L'exemple suivant renomme une information d'identification :
databricks credentials update-credential my-service-cred --new-name my-renamed-cred
L'exemple suivant modifie le propriétaire d'un identifiant :
databricks credentials update-credential my-service-cred --owner someone@example.com
L'exemple suivant rend une information d'identification en lecture seule :
databricks credentials update-credential my-storage-cred --read-only
databricks credentials validate-credential
Valider un identifiant.
Pour les identifiants de service (l’objectif est SERVICE), le credential_name ou l’identifiant spécifique au cloud doit être fourni.
Pour les identifiants de stockage (l’objectif est STORAGE), au moins l’un de external_location_name et url doit être fourni. 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 le external_location_name sera ignoré lors de la vérification des URL qui se chevauchent. Soit le credential_name, soit l'identifiant spécifique au cloud doit être fourni.
L'appelant doit être un administrateur de métastore ou le propriétaire des informations d'identification, ou disposer de l'autorisation requise sur le métastore et les informations d'identification (par exemple, CREATE_EXTERNAL_LOCATION lorsque l'objectif est STORAGE).
databricks credentials validate-credential [flags]
Options
--credential-name string
Obligatoire
--external-location-name string
Le nom d'un emplacement externe existant à valider
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
--purpose CredentialPurpose
L'objectif de l'identifiant. Valeurs supportées : SERVICE, STORAGE
--read-only
Si l'identifiant n'est utilisable que pour les opérations de lecture
--url string
L'URL de l'emplacement externe à valider
Exemples
L'exemple suivant valide un identifiant de service :
databricks credentials validate-credential --credential-name my-service-cred --purpose SERVICE
L'exemple suivant valide un identifiant de stockage avec un emplacement externe :
databricks credentials validate-credential --credential-name my-storage-cred --purpose STORAGE --external-location-name my-external-location
Drapeaux globaux
--debug
Activer ou non la journalisation de débogage.
-h OU --help
Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.
--log-file chaîne
Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.
--log-format Format
Le type de format de log, text ou json. La valeur par default est text.
--log-level chaîne
Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.
-o, --output Type
Le type de sortie de commande, text ou json. La valeur par default est text.
-p, --profile chaîne
Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.
--progress-format Format
Le format pour afficher les logs de progression : default, append, inplace ou json
-t, --target chaîne
Le cas échéant, la cible de bundle à utiliser