az synapse workspace

Referenz

Verwalten von Synapse-Arbeitsbereichen.

Befehle

az synapse workspace activate	Aktiviert einen Arbeitsbereich und ändert den Status des Status aus dem Ausstehen bis zum Erfolg, wenn der Arbeitsbereich zuerst bereitgestellt wird und doppelte Verschlüsselung aktiviert ist.
az synapse workspace check-name	Überprüfen Sie, ob ein Synapse-Arbeitsbereichsname verfügbar ist oder nicht.
az synapse workspace create	Erstellen Sie einen Synapse-Arbeitsbereich.
az synapse workspace delete	Löschen eines Synapse-Arbeitsbereichs.
az synapse workspace firewall-rule	Verwalten sie die Firewallregeln eines Arbeitsbereichs.
az synapse workspace firewall-rule create	Erstellen Sie eine Firewallregel.
az synapse workspace firewall-rule delete	Dient zum Löschen einer Firewallregel.
az synapse workspace firewall-rule list	Alle Firewallregeln auflisten.
az synapse workspace firewall-rule show	Rufen Sie eine Firewallregel ab.
az synapse workspace firewall-rule update	Aktualisieren einer Firewallregel.
az synapse workspace firewall-rule wait	Platzieren Sie die CLI in einem Wartenstatus, bis eine Bedingung einer Firewallregel erfüllt ist.
az synapse workspace key	Verwalten sie die Schlüssel des Arbeitsbereichs.
az synapse workspace key create	Erstellen Sie den Schlüssel eines Arbeitsbereichs.
az synapse workspace key delete	Löschen Sie den Schlüssel eines Arbeitsbereichs. Der Schlüssel beim aktiven Status kann nicht gelöscht werden.
az synapse workspace key list	Listenschlüssel unter dem angegebenen Arbeitsbereich.
az synapse workspace key show	Zeigen Sie den Schlüssel eines Arbeitsbereichs nach Name an.
az synapse workspace key wait	Platzieren Sie die CLI in einem Wartezeitzustand, bis eine Bedingung eines Arbeitsbereichsschlüssels erfüllt ist.
az synapse workspace list	Listet alle Synapse-Arbeitsbereiche auf.
az synapse workspace managed-identity	Verwalten der verwalteten Identität des Arbeitsbereichs.
az synapse workspace managed-identity grant-sql-access	Gewähren Sie den sql-Zugriff des Arbeitsbereichs auf verwaltete Identität.
az synapse workspace managed-identity revoke-sql-access	Widerrufen des sql-Zugriffs des Arbeitsbereichs auf verwaltete Identität.
az synapse workspace managed-identity show-sql-access	Anzeigen des SQL-Zugriffsstatus des Arbeitsbereichs auf verwaltete Identität.
az synapse workspace managed-identity wait	Platzieren Sie die CLI in einem Wartezeitzustand, bis eine Bedingung des SQL-Zugriffsstatus für verwaltete Identität erfüllt ist.
az synapse workspace show	Abrufen eines Synapse-Arbeitsbereichs.
az synapse workspace update	Aktualisieren eines Synapse-Arbeitsbereichs.
az synapse workspace wait	Platzieren Sie die CLI in einem Wartezeitzustand, bis eine Bedingung des Arbeitsbereichs erfüllt ist.

az synapse workspace activate

Bearbeiten

Aktiviert einen Arbeitsbereich und ändert den Status des Status aus dem Ausstehen bis zum Erfolg, wenn der Arbeitsbereich zuerst bereitgestellt wird und doppelte Verschlüsselung aktiviert ist.

Beim Erstellen eines Azure Synapse Analytics-Arbeitsbereichs können Sie auswählen, dass alle Daten im Arbeitsbereich mit einem vom Kunden verwalteten Schlüssel verschlüsselt werden, der eine doppelte Verschlüsselung für den Arbeitsbereich bereitstellt. Möglicherweise müssen Sie zuerst die Verschlüsselungsumgebung einrichten, z. B. zum Erstellen eines Schlüsseltresors mit aktiviertem Löschschutz und angeben Access-Polizeien für den Schlüsseltresor. Verwenden Sie dann dieses Cmdlet, um den neuen Azure Synapse Analytics-Arbeitsbereich zu aktivieren, der mit einem vom Kunden verwalteten Schlüssel aktiviert ist.

az synapse workspace activate --key-identifier
                              [--ids]
                              [--name]
                              [--no-wait]
                              [--resource-group]
                              [--workspace-name]

Beispiele

aktivieren Sie einen Arbeitsbereich.

az synapse workspace activate --name newkey --workspace-name testsynapseworkspace \
--resource-group rg --key-identifier https://{keyvaultname}.vault.azure.net/keys/{keyname}

Erforderliche Parameter

--key-identifier

Die Key Vault URL des Arbeitsbereichsverschlüsselungsschlüssels. sollte im Format von: https://{keyvaultname}.vault.azure.net/keys/{keyname}.

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte eine vollständige Ressourcen-ID sein, die alle Informationen der Argumente "Resource Id" enthält. Sie sollten entweder --ids oder andere Argumente "Resource Id" angeben.

--name -n

Der Benutzeranzeigename des Arbeitsbereichs mit verwaltetem Schlüssel. Alle vorhandenen Schlüssel finden Sie mithilfe von /"az synapse workspace key list/" cmdlet.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--workspace-name

Der Arbeitsbereichsname.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az synapse workspace check-name

Bearbeiten

Überprüfen Sie, ob ein Synapse-Arbeitsbereichsname verfügbar ist oder nicht.

az synapse workspace check-name --name

Beispiele

Überprüfen Sie, ob ein Synapse-Arbeitsbereichsname verfügbar ist oder nicht.

az synapse workspace check-name --name testsynapseworkspace

Erforderliche Parameter

--name -n

Der Name, den Sie überprüfen möchten.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az synapse workspace create

Bearbeiten

Erstellen Sie einen Synapse-Arbeitsbereich.

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]
                            [--no-wait]
                            [--prevent-data-exfiltration {false, true}]
                            [--project-name]
                            [--repository-name]
                            [--repository-type {AzureDevOpsGit, GitHub}]
                            [--root-folder]
                            [--tags]
                            [--tenant-id]

Beispiele

Erstellen eines Synapse-Arbeitsbereichs

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"

Erstellen eines Synapse-Arbeitsbereichs mit Speicherressourcen-ID

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"

Erstellen eines Synapse-Arbeitsbereichs mithilfe des vom Kunden verwalteten Schlüssels

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

Erstellen eines Synapse-Arbeitsbereichs, der mit azure devops verbunden ist

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

Erforderliche Parameter

--file-system

Das Dateisystem des Datenspeicherkontos des Datensees.

--name -n

Der Arbeitsbereichsname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--sql-admin-login-password -p

Das Anmeldekennwort für den SQL-Administrator.

--sql-admin-login-user -u

Der Benutzername des SQL-Administrators.

--storage-account

Der Name des Datenspeicherkontos oder der Ressourcen-ID des Datensees.

Optionale Parameter

--account-name

GitHub-Kontoname, der für das Repository oder den Azure Devops-Organisationsnamen verwendet wird.

--allowed-tenant-ids

Die genehmigten Azure AD-Mandanten, die ausgehenden Datenverkehr zulassen. Der Azure AD-Mandanten des aktuellen Benutzers wird standardmäßig eingeschlossen. Verwenden Sie ('' in PowerShell), um alle zulässigen Mandanten-IDs zu deaktivieren.

--cmk --key-identifier

Der vom Kunden verwaltete Schlüssel, der verwendet wird, um alle Daten im Arbeitsbereich zu verschlüsseln. Schlüsselbezeichner sollte im Format von: https://{keyvaultname}.vault.azure.net/keys/{keyname}.

--collaboration-branch

Der Verzweigungsname, an dem Sie mit anderen zusammenarbeiten und von denen Sie veröffentlichen werden.

--enable-managed-virtual-network --enable-managed-vnet

Das Flag gibt an, ob verwaltetes virtuelles Netzwerk aktiviert ist.

Zulässige Werte: false, true

--host-name

Wenn Sie github Enterprise Server verwenden, stellen Sie die Server-URL bereit, z https://github.mydomain.com.Do . B. diese Option nicht mit GitHub Enterprise Cloud zu verwenden.

--key-name

Der Benutzeranzeigename des Arbeitsbereichs mit verwaltetem Schlüssel. Alle vorhandenen Schlüssel finden Sie mithilfe des Cmdlets "az synapse workspace key list".

Standardwert: default

--last-commit-id

Die letzte Commit-ID.

--location -l

Der Standort. Werte aus: az account list-locations. Sie können den standardmäßig verwendeten Standort mit az configure --defaults location=<location> konfigurieren.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--prevent-data-exfiltration --prevent-exfiltration

Das Flag gibt an, ob Daten exfiltration aktiviert sind.

Zulässige Werte: false, true

--project-name

Der Projektname, mit dem Sie eine Verbindung herstellen.

--repository-name

Der Name des Repositorys, mit dem Sie eine Verbindung herstellen.

--repository-type

Der Repositorykonfigurationstyp.

Zulässige Werte: AzureDevOpsGit, GitHub

--root-folder

Der Name des Ordners an den Speicherort Ihrer Azure synapse JSON-Ressourcen wird importiert. Standard ist /.

Standardwert: /

--tags

Leergetrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--tenant-id

Die Mandanten-ID, die zum Verbinden von Azure devops verwendet wird.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az synapse workspace delete

Bearbeiten

Löschen eines Synapse-Arbeitsbereichs.

az synapse workspace delete [--ids]
                            [--name]
                            [--no-wait]
                            [--resource-group]
                            [--yes]

Beispiele

Löschen eines Synapse-Arbeitsbereichs.

az synapse workspace delete --name testsynapseworkspace --resource-group rg

Optionale Parameter

--ids

--name -n

Der Arbeitsbereichsname.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--yes -y

Nicht zur Bestätigung auffordern

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az synapse workspace list

Bearbeiten

Alle Synapse-Arbeitsbereiche auflisten.

az synapse workspace list [--resource-group]

Beispiele

Alle Synapse-Arbeitsbereiche unter einem Abonnement auflisten

az synapse workspace list

Alle Synapse-Arbeitsbereiche unter einer bestimmten Ressourcengruppe auflisten

az synapse workspace list --resource-group rg

Optionale Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az synapse workspace show

Bearbeiten

Rufen Sie einen Synapse-Arbeitsbereich ab.

az synapse workspace show [--ids]
                          [--name]
                          [--resource-group]

Beispiele

Rufen Sie einen Synapse-Arbeitsbereich ab.

az synapse workspace show --name testsynapseworkspace --resource-group rg

Optionale Parameter

--ids

Eine oder mehrere Ressourcen-IDs (durch Leerzeichen getrennt). Es sollte eine vollständige Ressourcen-ID sein, die alle Informationen von Argumenten der Ressource-ID enthält. Sie sollten entweder --ids oder andere Argumente für die Ressourcen-ID angeben.

--name -n

Der Arbeitsbereichsname.

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az synapse workspace update

Bearbeiten

Aktualisieren eines Synapse-Arbeitsbereichs.

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]
                            [--tags]
                            [--tenant-id]

Beispiele

Aktualisieren eines Synapse-Arbeitsbereichs

az synapse workspace update --name fromcli4 --resource-group rg \
  --tags key1=value1

Optionale Parameter

--account-name

GitHub-Kontoname, der für den Repository- oder Azure Devops-Organisationsnamen verwendet wird.

--allowed-tenant-ids

Die genehmigten Azure AD-Mandanten, für die ausgehender Datenverkehr zulässig ist. Der Azure AD-Mandant des aktuellen Benutzers wird standardmäßig eingeschlossen. Verwenden Sie ('' in PowerShell), um alle zulässigen Mandanten-IDs zu deaktivieren.

--collaboration-branch

Der Verzweigungsname, in dem Sie mit anderen zusammenarbeiten und von denen Sie veröffentlichen.

--host-name

Wenn Sie github Enterprise Server verwenden, stellen Sie eine Server-URL bereit, wie https://github.mydomain.com.Do sie diese Option nicht mit GitHub Enterprise Cloud verwenden.

--ids

--key-name

Der Name der vom Kunden verwalteten Arbeitsbereichsanzeige. Alle vorhandenen Schlüssel finden Sie mithilfe des Cmdlets "az synapse workspace key list".

--last-commit-id

Die letzte Commit-ID.

--name -n

Der Arbeitsbereichsname.

--no-wait

Nicht auf den Abschluss lang andauernder Vorgänge warten

--project-name

Der Projektname, mit dem Sie eine Verbindung herstellen.

--repository-name

Der Name des Repositorys, mit dem Sie eine Verbindung herstellen.

--repository-type

Der Repositorykonfigurationstyp.

Zulässige Werte: AzureDevOpsGit, GitHub

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--root-folder

Der Name des Ordners an den Speicherort Ihrer Azure Synapse JSON-Ressourcen wird importiert. Der Standardwert ist /.

--sql-admin-login-password -p

Das Anmeldekennwort des SQL-Administrators.

--tags

Leerzeichentrennte Tags: key[=value] [key[=value] ...]. Verwenden Sie "", um vorhandene Tags zu löschen.

--tenant-id

Die Mandanten-ID, die zum Verbinden von Azure devops verwendet wird.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az synapse workspace wait

Bearbeiten

Platzieren Sie die CLI in einem Wartezustand, bis eine Bedingung des Arbeitsbereichs erfüllt ist.

az synapse workspace wait --resource-group
                          --workspace-name
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--interval]
                          [--timeout]
                          [--updated]

Erforderliche Parameter

--resource-group -g

Name der Ressourcengruppe Sie können die Standardgruppe mit az configure --defaults group=<name> konfigurieren.

--workspace-name

Den Namen des Arbeitsbereichs

Optionale Parameter

--created

Warten Sie, bis Sie mit "provisioningState" unter "Erfolgreich" erstellt wurden.

--custom

Warten Sie, bis die Bedingung eine benutzerdefinierte JMESPath-Abfrage erfüllt. Beispiel: provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Warten Sie, bis sie gelöscht wurde.

--exists

Warten Sie, bis die Ressource vorhanden ist.

--interval

Abfrageintervall in Sekunden.

Standardwert: 30

--timeout

Maximale Wartezeit in Sekunden.

Standardwert: 3600

--updated

Warten Sie, bis die Aktualisierung mit provisioningState unter "Erfolgreich" ausgeführt wurde.

Globale Parameter

--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

az synapse workspace

Befehle

az synapse workspace activate

Beispiele

Erforderliche Parameter

Optionale Parameter

az synapse workspace check-name

Beispiele

Erforderliche Parameter

az synapse workspace create

Beispiele

Erforderliche Parameter

Optionale Parameter

az synapse workspace delete

Beispiele

Optionale Parameter

az synapse workspace list

Beispiele

Optionale Parameter

az synapse workspace show

Beispiele

Optionale Parameter

az synapse workspace update

Beispiele

Optionale Parameter

az synapse workspace wait

Erforderliche Parameter

Optionale Parameter

Feedback