Aller au contenu principal

groupe de commandesenvironments

remarque

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 environments au sein de la CLI Databricks vous permet de gérer les ressources d'environnement. L'API Environments fournit des capacités de gestion pour différents types d'environnements, y compris les environnements de base au niveau du Workspace qui définissent la version de l'environnement et les dépendances à utiliser dans les Notebooks et Jobs Serverless.

databricks environments create-workspace-base-environment

Créez un nouvel environnement de base de workspace. Il s'agit d'une opération de longue durée qui génère de manière asynchrone un environnement matérialisé pour optimiser la résolution des dépendances.

databricks environments create-workspace-base-environment DISPLAY_NAME [flags]

Arguments

DISPLAY_NAME

Nom d'affichage lisible par l'homme pour l'environnement de base du workspace.

Options

--base-environment-type BaseEnvironmentType

Le type d'environnement de base (CPU ou GPU). Valeurs supportées : CPU, GPU

--filepath string

Le chemin des fichiers du workspace ou des volumes Unity Catalog vers le fichier YAML de l'environnement.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--name string

Le nom de la ressource de l'environnement de base du Workspace.

--no-wait

N'attendez pas d'atteindre l'état DONE.

--request-id string

Un identifiant unique pour cette requête.

--timeout duration

Durée maximale pour atteindre l'état DONE.

--workspace-base-environment-id string

L’ID à utiliser pour l’environnement de base du Workspace, qui deviendra le composant final du nom de la ressource.

Indicateurs globaux

Exemples

L'exemple suivant crée un environnement de base de workspace CPU :

Bash
databricks environments create-workspace-base-environment "My Python Env" --base-environment-type CPU --filepath /Workspace/environments/env.yaml

databricks environments delete-workspace-base-environment

Supprimer un environnement de base de Workspace. La suppression d'un environnement de base peut avoir un impact sur les Notebooks et les Jobs liés. Cette opération est irréversible.

databricks environments delete-workspace-base-environment NAME [flags]

Arguments

NAME

Obligatoire. Le nom de la ressource de l'environnement de base du Workspace à supprimer. Format : workspace-base-environments/{workspace_base_environment}.

Options

Indicateurs globaux

Exemples

L'exemple suivant supprime un environnement de base de Workspace :

Bash
databricks environments delete-workspace-base-environment workspace-base-environments/my-env-id

databricks environments get-default-workspace-base-environment

Obtenez la configuration de l'environnement de base du Workspace default. Retourne les paramètres d'environnement de base default actuels pour le compute CPU et GPU.

databricks environments get-default-workspace-base-environment NAME [flags]

Arguments

NAME

Un nom de ressource statique de l'environnement de base du Workspace default. Format : default-workspace-base-environment.

Options

Indicateurs globaux

Exemples

L'exemple suivant obtient l'environnement de base du Workspace default :

Bash
databricks environments get-default-workspace-base-environment default-workspace-base-environment

databricks environments get-opération

Obtenir le statut d'une opération de longue durée. Les clients peuvent utiliser cette méthode pour interroger le résultat de l'opération.

databricks environments get-operation NAME [flags]

Arguments

NAME

Le nom de la ressource d'opération.

Options

Indicateurs globaux

Exemples

L'exemple suivant permet d'obtenir l'état d'une opération de longue durée :

Bash
databricks environments get-operation operations/1234567890

databricks environments get-workspace-base-environment

Obtenez un environnement de base de Workspace par son nom.

databricks environments get-workspace-base-environment NAME [flags]

Arguments

NAME

Obligatoire. Le nom de la ressource de l'environnement de base du Workspace à récupérer. Format : workspace-base-environments/{workspace_base_environment}.

Options

Indicateurs globaux

Exemples

L’exemple suivant obtient un environnement de base de Workspace :

Bash
databricks environments get-workspace-base-environment workspace-base-environments/my-env-id

databricks environments list-workspace-base-environments

Répertorier tous les environnements de base du workspace dans le workspace.

databricks environments list-workspace-base-environments [flags]

Arguments

Aucun

Options

--page-size int

Le nombre maximum d'environnements à renvoyer par page.

--page-token string

Jeton de page pour la pagination.

Indicateurs globaux

Exemples

L'exemple suivant liste tous les environnements de base du Workspace :

Bash
databricks environments list-workspace-base-environments

databricks environnements refresh-Workspace-base-environment

refresh l’environnement matérialisé pour un environnement de base du Workspace. Il s’agit d’une Opération de longue durée qui régénère de manière asynchrone l’environnement matérialisé. L'environnement matérialisé existant reste disponible jusqu'à son expiration.

databricks environments refresh-workspace-base-environment NAME [flags]

Arguments

NAME

Obligatoire. Le nom de la ressource de l'environnement de base du workspace à refresh. Format : workspace-base-environments/{workspace_base_environment}.

Options

--no-wait

N'attendez pas d'atteindre l'état DONE.

--timeout duration

Durée maximale pour atteindre l'état DONE.

Indicateurs globaux

Exemples

L'exemple suivant refresh un environnement de base de Workspace :

Bash
databricks environments refresh-workspace-base-environment workspace-base-environments/my-env-id

databricks environments update-default-workspace-base-environment

Mettez à jour la configuration de l’environnement de base du Workspace default. Définit les environnements de base spécifiés comme les default du Workspace pour le compute CPU et/ou GPU.

databricks environments update-default-workspace-base-environment NAME UPDATE_MASK [flags]

Arguments

NAME

Le nom de la ressource de cette ressource singleton. Format : default-workspace-base-environment.

UPDATE_MASK

Masque de champ spécifiant les champs à mettre à jour. Chemins de champ valides : cpu_workspace_base_environment, gpu_workspace_base_environment. Utilisez * pour mettre à jour tous les champs.

Options

--cpu-workspace-base-environment string

L’environnement de base du Workspace par default pour le compute CPU.

--gpu-workspace-base-environment string

L’environnement de base default du Workspace pour le compute GPU.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--name string

Le nom de cette Ressource singleton.

Indicateurs globaux

Exemples

L'exemple suivant définit l'environnement de base du workspace CPU par default :

Bash
databricks environments update-default-workspace-base-environment default-workspace-base-environment cpu_workspace_base_environment --cpu-workspace-base-environment workspace-base-environments/my-cpu-env

databricks environments update-workspace-base-environment

Mettre à jour un environnement de base de workspace existant. Il s’agit d’une Opération de longue durée qui régénère de manière asynchrone l’environnement matérialisé. L'environnement matérialisé existant reste disponible jusqu'à son expiration.

databricks environments update-workspace-base-environment NAME DISPLAY_NAME [flags]

Arguments

NAME

Le nom de la ressource de l'environnement de base du workspace. Format : workspace-base-environments/{workspace_base_environment}.

DISPLAY_NAME

Nom d'affichage lisible par l'homme pour l'environnement de base du workspace.

Options

--base-environment-type BaseEnvironmentType

Le type d'environnement de base (CPU ou GPU). Valeurs supportées : CPU, GPU

--filepath string

Le chemin des fichiers du Workspace ou des volumes Unity Catalog vers le fichier YAML de l'environnement.

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--name string

Le nom de la ressource de l'environnement de base du Workspace.

--no-wait

N'attendez pas d'atteindre l'état DONE.

--timeout duration

Durée maximale pour atteindre l'état DONE.

Indicateurs globaux

Exemples

L'exemple suivant met à jour un environnement de base Workspace :

Bash
databricks environments update-workspace-base-environment workspace-base-environments/my-env-id "Updated Python Env" --filepath /Workspace/environments/updated-env.yaml

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