az synapse workspace
Gérer les espaces de travail Synapse.
Commandes
Nom | Description | Type | Statut |
---|---|---|---|
az synapse workspace activate |
Active un espace de travail et modifie son état de l’état en attente jusqu’à l’état de réussite lorsque l’espace de travail est configuré pour la première fois et que le chiffrement double est activé. |
Core | GA |
az synapse workspace check-name |
Vérifiez si un nom d’espace de travail Synapse est disponible ou non. |
Core | GA |
az synapse workspace create |
Créer un espace de travail Synapse. |
Core | GA |
az synapse workspace delete |
Supprimez un espace de travail Synapse. |
Core | GA |
az synapse workspace firewall-rule |
Gérer les règles de pare-feu d’un espace de travail. |
Core | GA |
az synapse workspace firewall-rule create |
Créez une règle de pare-feu. |
Core | GA |
az synapse workspace firewall-rule delete |
Supprimer une règle de pare-feu. |
Core | GA |
az synapse workspace firewall-rule list |
Répertorier toutes les règles de pare-feu. |
Core | GA |
az synapse workspace firewall-rule show |
Obtenir une règle de pare-feu. |
Core | GA |
az synapse workspace firewall-rule update |
Mettez à jour une règle de pare-feu. |
Core | GA |
az synapse workspace firewall-rule wait |
Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’une règle de pare-feu soit remplie. |
Core | GA |
az synapse workspace key |
Gérer les clés de l’espace de travail. |
Core | GA |
az synapse workspace key create |
Créez la clé d’un espace de travail. |
Core | GA |
az synapse workspace key delete |
Supprimez la clé d’un espace de travail. La clé à l’état actif ne peut pas être supprimée. |
Core | GA |
az synapse workspace key list |
Répertorier les clés sous l’espace de travail spécifié. |
Core | GA |
az synapse workspace key show |
Afficher la clé d’un espace de travail par nom. |
Core | GA |
az synapse workspace key wait |
Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’une clé d’espace de travail soit remplie. |
Core | GA |
az synapse workspace list |
Répertorier tous les espaces de travail Synapse. |
Core | GA |
az synapse workspace managed-identity |
Gérer l’identité managée de l’espace de travail. |
Core | GA |
az synapse workspace managed-identity grant-sql-access |
Accordez l’accès sql de l’espace de travail à l’identité managée. |
Core | GA |
az synapse workspace managed-identity revoke-sql-access |
Révoquez l’accès sql de l’espace de travail à l’identité managée. |
Core | GA |
az synapse workspace managed-identity show-sql-access |
Afficher l’état d’accès sql de l’espace de travail à l’identité managée. |
Core | GA |
az synapse workspace managed-identity wait |
Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition d’état d’accès sql à l’identité managée soit remplie. |
Core | GA |
az synapse workspace show |
Obtenir un espace de travail Synapse. |
Core | GA |
az synapse workspace update |
Mettez à jour un espace de travail Synapse. |
Core | GA |
az synapse workspace wait |
Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de l’espace de travail soit remplie. |
Core | GA |
az synapse workspace activate
Active un espace de travail et modifie son état de l’état en attente jusqu’à l’état de réussite lorsque l’espace de travail est configuré pour la première fois et que le chiffrement double est activé.
Lors de la création d’un espace de travail Azure Synapse Analytics, vous pouvez choisir de chiffrer toutes les données au repos dans l’espace de travail avec une clé gérée par le client qui fournira un double chiffrement à l’espace de travail. Vous devrez peut-être d’abord configurer l’environnement de chiffrement, par exemple pour créer un coffre de clés avec la protection contre la purge, activer et spécifier les stratégies d’accès au coffre de clés. Utilisez ensuite cette applet de commande pour activer le nouvel espace de travail Azure Synapse Analytics qui double chiffrement est activé à l’aide d’une clé gérée par le client.
az synapse workspace activate --key-identifier
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--workspace-name]
Exemples
activez un espace de travail.
az synapse workspace activate --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}
Paramètres obligatoires
URL du coffre de clés de la clé de chiffrement de l’espace de travail. doit être au format : https://{keyvaultname}.vault.azure.net/keys/{keyname}.
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom complet de la clé gérée par le client de l’espace de travail. Toutes les clés existantes sont disponibles à l’aide de l’applet de commande /"az synapse workspace key list/ ».
Ne pas attendre la fin de l’opération de longue durée.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Nom de l’espace de travail.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az synapse workspace check-name
Vérifiez si un nom d’espace de travail Synapse est disponible ou non.
az synapse workspace check-name --name
Exemples
Vérifiez si un nom d’espace de travail Synapse est disponible ou non.
az synapse workspace check-name --name testsynapseworkspace
Paramètres obligatoires
Le nom que vous vouliez case activée.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az synapse workspace create
Créer un espace de travail Synapse.
az synapse workspace create --file-system
--name
--resource-group
--sql-admin-login-password
--sql-admin-login-user
--storage-account
[--account-name]
[--allowed-tenant-ids]
[--cmk]
[--collaboration-branch]
[--enable-managed-virtual-network {false, true}]
[--host-name]
[--key-name]
[--last-commit-id]
[--location]
[--managed-rg-name]
[--no-wait]
[--prevent-data-exfiltration {false, true}]
[--project-name]
[--repository-name]
[--repository-type {AzureDevOpsGit, GitHub}]
[--root-folder]
[--tags]
[--tenant-id]
[--uami-id]
[--uami-id-in-encrypt]
[--use-sami-in-encrypt]
Exemples
Créer un espace de travail Synapse
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"
Créer un espace de travail Synapse avec l’ID de ressource de stockage
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"
Créer un espace de travail Synapse à l’aide de la clé gérée par le client
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
--key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname} --key-name testcmk \
--use-sami-in-encrypt True
Créer un espace de travail Synapse se connectant à Azure devops
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
--repository-type AzureDevOpsGit --account-name testuser --project-name testprj \
--repository-name testrepo --collaboration-branch main --last-commit-id 000000
Créer un espace de travail Synapse avec un groupe de ressources managé
az synapse workspace create --name testworkspace --resource-group rg \
--managed-rg-name managedrg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US"
Créer un espace de travail Synapse avec une identité managée affectée par l’utilisateur
az synapse workspace create --name testworkspace --resource-group rg \
--storage-account testadlsgen2 --file-system testfilesystem \
--sql-admin-login-user cliuser1 --sql-admin-login-password Password123! --location "East US" \
--uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Paramètres obligatoires
Système de fichiers du compte de stockage data lake.
Nom de l’espace de travail.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Mot de passe de connexion de l’administrateur sql.
Nom d’utilisateur de connexion de l’administrateur sql.
Nom ou ID de ressource du compte de stockage data lake.
Paramètres facultatifs
Nom du compte GitHub utilisé pour le dépôt ou le nom de l’organisation Azure devops.
Locataires Azure AD approuvés auxquels le trafic de données sortant est autorisé. Le locataire Azure AD de l’utilisateur actuel sera inclus par défaut. Utilisez (' dans PowerShell) pour désactiver tous les ID de locataire autorisés.
Clé gérée par le client utilisée pour chiffrer toutes les données au repos dans l’espace de travail. L’identificateur de clé doit être au format suivant : https://{keyvaultname}.vault.azure.net/keys/{keyname}.
Nom de la branche dans laquelle vous allez collaborer avec d’autres personnes et à partir de laquelle vous allez publier.
L’indicateur indique si activer le réseau virtuel managé.
Si vous utilisez github Enterprise Server, fournissez l’URL de serveur comme https://github.mydomain.com.Do si vous n’utilisez pas cette option avec GitHub Enterprise Cloud.
Nom complet de la clé gérée par le client de l’espace de travail. Toutes les clés existantes sont disponibles à l’aide de l’applet de commande « az synapse workspace key list ».
Dernier ID de validation.
Emplacement. Valeurs provenant de : az account list-locations
. Vous pouvez configurer le lieu par défaut en utilisant az configure --defaults location=<location>
.
Groupe de ressources géré par l’espace de travail. Le nom du groupe de ressources identifie de façon unique le groupe de ressources dans l’ID d’abonnement utilisateur.
Ne pas attendre la fin de l’opération de longue durée.
L’indicateur indique si l’exfiltration des données est activée.
Nom du projet auquel vous vous connectez.
Nom du référentiel auquel vous vous connectez.
Type de configuration du référentiel.
Le nom du dossier à l’emplacement de vos ressources JSON Azure synapse est importé. La valeur par défaut est /.
Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.
ID de locataire utilisé pour connecter Azure devops.
Liste de l’ID d’identité managée affectée par l’utilisateur pour l’espace de travail.
ID de ressource d’identité affecté par l’utilisateur utilisé dans le chiffrement de l’espace de travail.
Indique si vous utilisez l’identité affectée par le système dans Le chiffrement de l’espace de travail. Si vous utilisez uami, définissez True.Si ce n’est pas le cas, définissez False.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az synapse workspace delete
Supprimez un espace de travail Synapse.
az synapse workspace delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]
Exemples
Supprimez un espace de travail Synapse.
az synapse workspace delete --name testsynapseworkspace --resource-group rg
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom de l’espace de travail.
Ne pas attendre la fin de l’opération de longue durée.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Ne pas demander de confirmation.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az synapse workspace list
Répertorier tous les espaces de travail Synapse.
az synapse workspace list [--resource-group]
Exemples
Répertorier tous les espaces de travail Synapse sous un abonnement
az synapse workspace list
Répertorier tous les espaces de travail Synapse sous un groupe de ressources spécifique
az synapse workspace list --resource-group rg
Paramètres facultatifs
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az synapse workspace show
Obtenir un espace de travail Synapse.
az synapse workspace show [--ids]
[--name]
[--resource-group]
[--subscription]
Exemples
Obtenir un espace de travail Synapse.
az synapse workspace show --name testsynapseworkspace --resource-group rg
Paramètres facultatifs
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom de l’espace de travail.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az synapse workspace update
Mettez à jour un espace de travail Synapse.
az synapse workspace update [--account-name]
[--allowed-tenant-ids]
[--collaboration-branch]
[--host-name]
[--ids]
[--key-name]
[--last-commit-id]
[--name]
[--no-wait]
[--project-name]
[--repository-name]
[--repository-type {AzureDevOpsGit, GitHub}]
[--resource-group]
[--root-folder]
[--sql-admin-login-password]
[--subscription]
[--tags]
[--tenant-id]
[--uami-action {Add, Remove, Set}]
[--uami-id]
[--uami-id-in-encrypt]
[--use-sami-in-encrypt]
Exemples
Mettre à jour un espace de travail Synapse
az synapse workspace update --name fromcli4 --resource-group rg \
--tags key1=value1
Mettre à jour un espace de travail Synapse, ajouter une identité managée affectée par l’utilisateur
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Add --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Mettre à jour un espace de travail Synapse, supprimer l’identité managée affectée par l’utilisateur
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Remove --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Mettre à jour un espace de travail Synapse, réécrire l’identité managée affectée par l’utilisateur
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-action Set --uami-id "{your-first-uami-resourceid}" "{your-second-uami-resourceid}"
Mettre à jour un espace de travail Synapse, définir le chiffrement de l’espace de travail uami
az synapse workspace update --name fromcli4 --resource-group rg \
--uami-id-in-encrypt "{your-encrytion-uami-resourceid}" --use-sami-in-encrypt False
Paramètres facultatifs
Nom du compte GitHub utilisé pour le dépôt ou le nom de l’organisation Azure devops.
Locataires Azure AD approuvés auxquels le trafic de données sortant est autorisé. Le locataire Azure AD de l’utilisateur actuel sera inclus par défaut. Utilisez (' dans PowerShell) pour désactiver tous les ID de locataire autorisés.
Nom de la branche dans laquelle vous allez collaborer avec d’autres personnes et à partir de laquelle vous allez publier.
Si vous utilisez github Enterprise Server, fournissez l’URL de serveur comme https://github.mydomain.com.Do si vous n’utilisez pas cette option avec GitHub Enterprise Cloud.
Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».
Nom complet de la clé gérée par le client de l’espace de travail. Toutes les clés existantes sont disponibles à l’aide de l’applet de commande « az synapse workspace key list ».
Dernier ID de validation.
Nom de l’espace de travail.
Ne pas attendre la fin de l’opération de longue durée.
Nom du projet auquel vous vous connectez.
Nom du référentiel auquel vous vous connectez.
Type de configuration du référentiel.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Le nom du dossier à l’emplacement de vos ressources JSON Azure synapse est importé. La valeur par défaut est /.
Mot de passe de connexion de l’administrateur sql.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Balises séparées par l’espace : key[=value] [key[=value] ...]. Utilisez « » pour effacer les balises existantes.
ID de locataire utilisé pour connecter Azure devops.
L’action doit être spécifiée lorsque vous ajoutez/supprimez/définissez des identités managées affectées par l’utilisateur pour l’espace de travail. Les actions prises en charge sont : Ajouter, Supprimer, Set.Add signifie ajouter des identités managées affectées par l’utilisateur pour l’espace de travail, Supprimer les moyens de supprimer les identités managées affectées par l’utilisateur de l’espace de travail, Définir peut être utilisé lorsque vous souhaitez ajouter et supprimer des identités managées affectées par l’utilisateur en même temps, les identités actuelles seront couvertes par les identités spécifiées.
Liste de l’ID d’identité managée affectée par l’utilisateur pour l’espace de travail.
ID de ressource d’identité affecté par l’utilisateur utilisé dans le chiffrement de l’espace de travail.
Indique si vous utilisez l’identité affectée par le système dans Le chiffrement de l’espace de travail. Si vous utilisez uami, définissez True.Si ce n’est pas le cas, définissez False.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az synapse workspace wait
Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition de l’espace de travail soit remplie.
az synapse workspace wait --resource-group
--workspace-name
[--created]
[--custom]
[--deleted]
[--exists]
[--interval]
[--timeout]
[--updated]
Paramètres obligatoires
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom de l’espace de travail.
Paramètres facultatifs
Attendez la création avec « provisioningState » sur « Succeeded ».
Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Attendez la suppression.
Attendez que la ressource existe.
Intervalle d’interrogation en secondes.
Délai maximal d’attente en secondes.
Attendez la mise à jour avec provisioningState sur « Réussi ».
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.