groupe de commandesstorage-credentials
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 storage-credentials au sein de l'interface CLI Databricks contient des commandes pour gérer les identifiants de stockage dans Unity Catalog. Un identifiant de stockage représente un mécanisme d'authentification et d'autorisation pour accéder aux données stockées sur votre tenant cloud. Chaque identifiant de stockage 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. Si un utilisateur n'a pas accès à un identifiant de stockage dans Unity Catalog, la requête échoue et Unity Catalog ne tente pas de s'authentifier auprès de votre tenant cloud au nom de l'utilisateur. Voir Gérer les identifiants de stockage.
databricks storage-credentials create
Créer un nouvel identifiant de stockage.
L'appelant doit être un administrateur de métastore ou disposer du privilège CREATE_STORAGE_CREDENTIAL sur le métastore.
databricks storage-credentials create 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 @chemin vers le fichier JSON avec le corps de la requête.
--read-only
Si l'identifiant est utilisable uniquement pour les opérations de lecture.
--skip-validation
Le fait de fournir la valeur true à cet argument permet d'ignorer la validation du credential créé.
Exemples
L’exemple suivant crée un nouvel identifiant de stockage :
databricks storage-credentials create my-storage-credential
L'exemple suivant crée un identifiant de stockage avec un commentaire :
databricks storage-credentials create my-storage-credential --comment "S3 credential for analytics data"
L’exemple suivant crée un identifiant de stockage en lecture seule :
databricks storage-credentials create my-storage-credential --read-only
databricks storage-credentials delete
Supprimer un identifiant de stockage du metastore. L'appelant doit être le propriétaire de l'identifiant de stockage.
databricks storage-credentials delete NAME [flags]
Arguments
NAME
Nom de l'identifiant de stockage.
Options
--force
Forcer une mise à jour même s'il existe des emplacements externes dépendants ou des tables externes (lorsque le but est STORAGE) ou des services dépendants (lorsque le but est SERVICE).
Exemples
L'exemple suivant supprime un identifiant de stockage :
databricks storage-credentials delete my-storage-credential
L'exemple suivant supprime un identifiant de stockage de manière forcée :
databricks storage-credentials delete my-storage-credential --force
databricks storage-credentials get
Obtenez un identifiant de stockage du métastore. L'appelant doit être un administrateur du metastore, le propriétaire de l'identifiant de stockage ou disposer d'une certaine autorisation sur l'identifiant de stockage.
databricks storage-credentials get NAME [flags]
Arguments
NAME
Nom de l'identifiant de stockage.
Options
Exemples
L'exemple suivant obtient des informations sur un identifiant de stockage :
databricks storage-credentials get my-storage-credential
databricks storage-credentials list
Lister les identifiants de stockage. La liste est limitée aux identifiants de stockage auxquels l'appelant est autorisé à 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 storage-credentials list [flags]
Options
--max-results int
Nombre maximal d'informations d'identification de stockage à renvoyer.
--page-token string
Jeton de pagination opaque pour aller à la page suivante basé sur la query précédente.
Exemples
L'exemple suivant répertorie tous les identifiants de stockage :
databricks storage-credentials list
mise à jour des identifiants de stockage Databricks
Mettre à jour un identifiant de stockage sur le metastore.
L'appelant doit être le propriétaire de l'identifiant de stockage ou un administrateur de métastore. Si l'appelant est un administrateur du métastore, seul le champ owner peut être modifié.
databricks storage-credentials update NAME [flags]
Arguments
NAME
Nom de l'identifiant de stockage.
Options
--comment string
Commentaire associé à l'identifiant.
--force
Forcer la mise à jour même s'il existe des emplacements externes dépendants ou des tables externes.
--isolation-mode IsolationMode
Que l'élément sécurisable actuel soit accessible depuis tous les workspaces ou un ensemble spécifique de workspaces. Valeurs prises en charge : [ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN]
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--new-name string
Nouveau nom pour l'identifiant de stockage.
--owner string
Nom d'utilisateur du propriétaire actuel de l'identifiant.
--read-only
Si l'identifiant est utilisable uniquement pour les opérations de lecture.
--skip-validation
Indiquer « vrai » pour cet argument ignore la validation de l'identifiant mis à jour.
Exemples
L'exemple suivant met à jour le commentaire d'un identifiant de stockage :
databricks storage-credentials update my-storage-credential --comment "Updated S3 credential"
L'exemple suivant modifie le propriétaire d'un identifiant de stockage :
databricks storage-credentials update my-storage-credential --owner someone@example.com
L'exemple suivant renomme un identifiant de stockage :
databricks storage-credentials update my-storage-credential --new-name updated-credential
databricks storage-credentials validate
Valider un identifiant de stockage. 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 chevauchantes.
Soit le storage_credential_name, soit l'identifiant spécifique au cloud doit être fourni.
L'appelant doit être un administrateur du métastore ou le propriétaire des informations d'identification du stockage ou disposer du privilège CREATE_EXTERNAL_LOCATION sur le métastore et les informations d'identification du stockage.
databricks storage-credentials validate [flags]
Options
--external-location-name string
Le nom d'un emplacement externe existant à valider.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--read-only
Si l’identifiant de stockage est utilisable uniquement pour les opérations de lecture.
--storage-credential-name string
Obligatoire.
--url string
L'URL de l'emplacement externe à valider.
Exemples
L’exemple suivant valide un identifiant de stockage par rapport à un emplacement externe :
databricks storage-credentials validate --storage-credential-name my-storage-credential --external-location-name my-external-location
L'exemple suivant valide un identifiant de stockage par rapport à une URL :
databricks storage-credentials validate --storage-credential-name my-storage-credential --url s3://my-bucket/path
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