groupe de commandesaccount workspaces
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 account workspaces au sein de la Databricks CLI contient des commandes pour gérer les Workspace pour votre compte. Un workspace Databricks est un environnement pour accéder à tous vos assets Databricks. Le Workspace organise les objets (Notebooks, bibliothèques et Experimentations) en dossiers, et fournit un accès aux données et aux Ressources de calcul telles que les clusters et les Jobs. Consultez Créer un Workspace.
Ces commandes sont disponibles si votre compte utilise la version E2 de la plateforme ou un plan personnalisé sélectionné qui autorise plusieurs workspaces par compte.
créer des workspaces de compte Databricks
Créez un nouveau workspace à l'aide d'une configuration d'informations d'identification et d'une configuration de stockage, d'une configuration réseau facultative (si vous utilisez un Virtual Private Cloud (VPC) géré par le client), d'une configuration de clé de services gérés facultative (si vous utilisez des clés gérées par le client pour les services gérés) et d'une configuration de clé de stockage facultative (si vous utilisez des clés gérées par le client pour le stockage).
Cette opération est asynchrone. Une réponse avec le code d'état HTTP 200 signifie que la requête a été acceptée et est en cours, mais ne signifie pas que le Workspace a été déployé avec succès et qu'il est en cours d'exécution. Le statut initial du Workspace est généralement PROVISIONNEMENT. Utilisez le champ ID du Workspace (workspace_id) dans la réponse pour identifier le nouveau Workspace et effectuer des requêtes GET répétées avec l'ID du Workspace et vérifier son statut. Le Workspace devient disponible lorsque le statut passe à RUNNING.
databricks account workspaces create [flags]
Options
--workspace-name string
Le nom lisible par l'homme du Workspace.
--deployment-name string
Le nom de déploiement définit une partie du sous-domaine pour le workspace.
--aws-region string
La région AWS du workspace.
--cloud string
Le nom du cloud.
--location string
La région Google Cloud du plan de données du workspace dans votre compte Google (par exemple, us-east4).
--credentials-id string
ID de l'objet de configuration des identifiants du Workspace.
--storage-configuration-id string
ID de l'objet de configuration du stockage du Workspace.
--network-id string
L'ID de l'objet de configuration réseau du Workspace.
--managed-services-customer-managed-key-id string
L'ID de l'objet de configuration de la clé de chiffrement des services gérés du Workspace.
--storage-customer-managed-key-id string
L'ID de l'objet de configuration de la clé de chiffrement du stockage du Workspace.
--private-access-settings-id string
ID de l'objet de paramètres d'accès privé du Workspace.
--network-connectivity-config-id string
L'ID d'objet de la configuration de connectivité réseau.
--compute-mode CustomerFacingComputeMode
Si le mode compute est SERVERLESS, un Workspace serverless est créé. Valeurs prises en charge : HYBRID, SERVERLESS.
--pricing-tier PricingTier
Le niveau de tarification pour le Workspace. Valeurs prises en charge : COMMUNITY_EDITION, DEDICATED, ENTERPRISE, PREMIUM, STANDARD, UNKNOWN.
--no-wait
Ne pas attendre d'atteindre l'état d'exécution.
--timeout duration
Durée maximale pour atteindre l'état RUNNING (default 20m0s).
--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 crée un Workspace à l'aide de JSON :
databricks account workspaces create --json '{"workspace_name": "my-workspace", "deployment_name": "my-workspace-deployment", "aws_region": "us-west-2", "credentials_id": "cred-abc123", "storage_configuration_id": "storage-xyz789"}'
L'exemple suivant crée un Workspace à l'aide d'un fichier JSON :
databricks account workspaces create --json @workspace.json
L'exemple suivant crée un Workspace avec des indicateurs de ligne de commande :
databricks account workspaces create --workspace-name "my-workspace" --deployment-name "my-workspace-deployment" --aws-region "us-west-2" --credentials-id "cred-abc123" --storage-configuration-id "storage-xyz789"
Supprimer les workspaces du compte Databricks
Supprimer un workspace Databricks, spécifié par son ID.
databricks account workspaces delete WORKSPACE_ID [flags]
Arguments
WORKSPACE_ID
Un ID entier unique pour le workspace.
Options
Exemples
L'exemple suivant supprime un Workspace par ID :
databricks account workspaces delete 123456789
Récupérer les workspaces du compte Databricks
Obtenez des informations, y compris l'état, pour un Workspace Databricks, spécifié par son ID. Dans la réponse, le champ workspace_status indique le statut actuel. Après la création initiale du Workspace (qui est asynchrone), effectuez des requêtes GET répétées avec l'ID du Workspace et vérifiez son statut. Le Workspace devient disponible lorsque le statut passe à EN COURS D'EXÉCUTION.
databricks account workspaces get WORKSPACE_ID [flags]
Arguments
WORKSPACE_ID
Un ID entier unique pour le workspace.
Options
Exemples
L'exemple suivant obtient un workspace par ID :
databricks account workspaces get 123456789
Liste des workspaces de compte Databricks
Répertoriez les workspaces Databricks pour un compte.
databricks account workspaces list [flags]
Options
Exemples
L'exemple suivant répertorie tous les workspaces :
databricks account workspaces list
Mise à jour des Workspace du compte Databricks
Mettre à jour une configuration de Workspace.
databricks account workspaces update WORKSPACE_ID [flags]
Arguments
WORKSPACE_ID
Un ID entier unique pour le workspace.
Options
--workspace-name string
Le nom lisible par l'homme du Workspace.
--deployment-name string
Le nom de déploiement du workspace.
--aws-region string
La région AWS du workspace.
--cloud string
Le nom du cloud.
--location string
La région Google Cloud du plan de données du workspace dans votre compte Google (par exemple, us-east4).
--credentials-id string
ID de l'objet de configuration des identifiants du Workspace.
--storage-configuration-id string
ID de l'objet de configuration du stockage du Workspace.
--network-id string
Si ce Workspace est un Virtual Private Cloud (VPC) géré par le client, l'ID réseau sera renseigné.
--managed-services-customer-managed-key-id string
ID de la configuration de clé pour le chiffrement des services gérés.
--storage-customer-managed-key-id string
ID de la configuration de clé pour le chiffrement du stockage Workspace.
--private-access-settings-id string
ID de l'objet de paramètres d'accès privé du Workspace.
--network-connectivity-config-id string
L'ID d'objet de la configuration de connectivité réseau.
--expected-workspace-status WorkspaceStatus
Un champ appartenant au client utilisé pour indiquer le statut du Workspace que le client s'attend à avoir. Valeurs prises en charge : BANNED, CANCELLING, FAILED, NOT_PROVISIONED, PROVISIONING, RUNNING.
--update-mask string
Le masque de champ doit être une chaîne unique, avec plusieurs champs séparés par des virgules (sans espaces).
--no-wait
Ne pas attendre d'atteindre l'état d'exécution.
--timeout duration
Durée maximale pour atteindre l'état RUNNING (default 20m0s).
--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 met à jour un nom de Workspace :
databricks account workspaces update 123456789 --workspace-name "updated-workspace-name"
L'exemple suivant met à jour un Workspace à l'aide de JSON :
databricks account workspaces update 123456789 --json '{"workspace_name": "updated-workspace-name", "credentials_id": "cred-new123"}'
L'exemple suivant met à jour un Workspace à l'aide d'un fichier JSON :
databricks account workspaces update 123456789 --json @update-workspace.json
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