tenant
Wichtig
Dies ist die Dokumentation zu Azure Sphere (Legacy). Azure Sphere (Legacy) wird am 27. September 2027 eingestellt, und Benutzer müssen bis zu diesem Zeitpunkt zu Azure Sphere (integriert) migrieren. Verwenden Sie die Versionsauswahl oberhalb des Inhaltsverzeichniss, um die Dokumentation zu Azure Sphere (Integriert) anzuzeigen.
Verwaltet einen Azure Sphere-Mandanten.
Wichtig
Die Befehle azsphere tenant download-ca-certificate, azsphere tenant download-ca-certificate-chain, und azsphere tenant download-validation-certificate sind veraltet. Verwenden Sie stattdessen azsphere ca-certificate download, azsphere ca-certificate download-chain, azsphere ca-certificate download-proof und azsphere ca-certificate list.
In der Azure Sphere CLI wird der Standardmandant nicht automatisch ausgewählt, wenn ein Mandant erstellt wird. Sie müssen den Befehl "azsphere tenant select " ausführen, um den Standardmandanten auszuwählen, der für den aktuellen Benutzer auf dem PC verwendet werden soll. Dadurch wird sichergestellt, dass der Standardmandant der richtige ist, der beim Ausführen eines einmaligen Vorgangs verwendet werden kann, der nicht rückgängig gemacht werden kann, z . B. das Anfordern des Geräts.
| Vorgang | Beschreibung |
|---|---|
| erstellen | Erstellt einen neuen Mandanten. |
| Downloadfehlerbericht | Gibt Fehlerinformationen für Geräte innerhalb des aktuellen Mandanten zurück. |
| list | Listet die verfügbaren Azure Sphere-Mandanten auf. |
| select | Wählt den standardmäßigen Azure Sphere-Mandanten aus, der auf diesem Computer verwendet werden soll. |
| show-selected | Zeigt den Standardmäßigen Azure Sphere-Mandanten für diesen Computer an. |
| Aktualisierung | Aktualisiert die Details des Mandanten, z. B. den Namen des Mandanten. |
create
Erstellt einen neuen Azure Sphere-Mandanten. Zum Ausführen dieses Befehls ist ein angeschlossenes Gerät erforderlich. Weitere Informationen finden Sie unter Erstellen eines Azure Sphere-Mandanten.
Wenn Sie bereits über einen Mandanten verfügen und sicher sind, dass ein anderer Mandant verwendet werden soll, verwenden Sie den Parameter --force-additional. Derzeit können Sie keinen Azure Sphere-Mandanten löschen.
Nachdem der Mandant erstellt wurde, führen Sie azsphere-Mandant aus , um den Standardmandanten auszuwählen, der für den aktuellen Benutzer auf diesem PC verwendet werden soll. Sie können Rollen für Benutzer im aktuellen Azure Sphere-Mandanten mithilfe des Azsphere-Rollen-Add-Befehls hinzufügen.
Der Befehlazsphere tenant create funktioniert mit einem lokal angeschlossenen Azure Sphere-Gerät. Wenn Sie versuchen, den Befehl ohne angeschlossenes Gerät auszuführen, wird eine Fehlermeldung angezeigt. Die Geräte-ID wird aufgezeichnet, wenn Sie einen Mandanten erstellen, und pro Gerät kann nur ein Mandant erstellt werden.
Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| -n, --name | String | Gibt einen Namen für den Mandanten an. Verwenden Sie bei der Benennung Ihres Mandanten alphanumerische Zeichen. Sonderzeichen sind nicht zulässig. Der Name darf 50 Zeichen nicht überschreiten und die Groß-/Kleinschreibung wird beachtet. |
Optionale Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| -d, --device | String | Gibt das Gerät an, auf dem der Befehl ausgeführt werden soll, wenn mehrere Geräte angeschlossen sind. Dieser Parameter ist erforderlich, wenn mehrere Geräte angefügt werden. Das aktuell angeschlossene Gerät wird standardmäßig verwendet. Sie können die Geräte-ID, DIE IP-Adresse oder die lokale Verbindungs-ID des angefügten Geräts angeben. Azure Sphere CLI unterstützt mehrere MT3620-Geräte unter Windows, aber Sie können jeweils nur ein Gerät unter Linux verbinden. Aus diesem Grund wird dieser Parameter für Windows, aber nicht für Linux unterstützt. Wenn Sie diesen Parameter mit dem Befehl unter Linux verwenden, wird ein Fehler zurückgegeben. |
| --force-additional | Boolean | Erzwingt das Erstellen eines neuen Azure Sphere-Mandanten. Verwenden Sie diesen Befehl nur, wenn Sie sicher sind, dass Sie das aktuelle Konto verwenden möchten, um einen neuen Azure Sphere-Mandanten mithilfe des angefügten Geräts zu erstellen. |
| --disable-confirm-prompt | Boolean | Deaktiviert die Bestätigungsaufforderung des Benutzers. |
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --only-show-errors | Zeigt nur Fehler an, wobei Warnungen unterdrückt werden. |
| -o, --output | Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), Table (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
Hinweis
Wenn Sie die klassische Azure Sphere CLI verwenden, finden Sie unter "Globale Parameter " weitere Informationen zu den verfügbaren Optionen.
Beispiel
azsphere tenant create --name MyTenant
Verwenden Sie die --force-additional Parameter und --disable-confirm-prompt parameter, wenn Sie sicher sind, dass Sie dieses Konto verwenden möchten, um einen neuen Azure Sphere-Mandanten mithilfe des angefügten Geräts zu erstellen. Ein Gerät, das zuvor zum Erstellen eines Azure Sphere-Mandanten verwendet wurde, kann nicht zum Erstellen eines neuen Mandanten verwendet werden.
azsphere tenant create --name MyTenant --force-additional
You have logged in with the following account:
bob@contoso.com
Do you want to use this account to create a new Azure Sphere tenant using the attached device?
You cannot change the tenant name 'MyTenant1' once it has been created.
Enter 'yes' to continue. Enter anything else to exit.
yes
> verbose: TraceId: c761ba73-761e-4df2-94f5-3f87384d71b7
Created a new Azure Sphere tenant:
--> Tenant Name: MyTenant1
--> Tenant ID: 768c2cd6-059a-49ad-9f53-89f5271cea15
Please use 'azsphere tenant select --tenant MyTenant' to select the created tenant.
Tipp
Nachdem Sie einen Mandanten erstellt haben, stellen Sie sicher, dass Sie azsphere-Mandant ausführen , um den Standardmandanten auszuwählen, der für den aktuellen Benutzer auf diesem PC verwendet werden soll.
download-error-report
Gibt Informationen zu Fehlern zurück, die von Geräten im aktuellen Mandanten gemeldet wurden.
Der Befehl pullt Ereignisdaten aus der Cloud des Azure Sphere-Sicherheitsdiensts und erfordert keine physische Verbindung mit einem bestimmten Gerät. Der Befehl azsphere tenant download-error-report kann im Kontext des aktuellen Mandanten verwendet werden und gibt Fehlerberichte für alle Geräte in diesem Mandanten zurück.
Hinweis
Es kann bis zu 24 Stunden dauern, bis kürzlich gemeldete Ereignisse zum Download verfügbar sind. Weitere Informationen finden Sie unter Sammeln und Interpretieren von Fehlerdaten.
Optionale Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| --Bestimmungsort | String | Gibt den Pfad und Dateinamen der Ausgabedatei an. |
| -t, --tenant | GUID oder Name | Gibt den Mandanten an, in dem dieser Vorgang ausgeführt werden soll. Überschreibt den ausgewählten Standardmandanten. Sie können entweder die Mandanten-ID oder den Mandantennamen angeben. |
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --only-show-errors | Zeigt nur Fehler an, wobei Warnungen unterdrückt werden. |
| -o, --output | Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), Table (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
Hinweis
Wenn Sie die klassische Azure Sphere CLI verwenden, finden Sie unter "Globale Parameter " weitere Informationen zu den verfügbaren Optionen.
Beispiel
azsphere tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
list
Listet Azure Sphere-Mandanten auf.
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --only-show-errors | Zeigt nur Fehler an, wobei Warnungen unterdrückt werden. |
| -o, --output | Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), Table (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
Hinweis
Wenn Sie die klassische Azure Sphere CLI verwenden, finden Sie unter "Globale Parameter " weitere Informationen zu den verfügbaren Optionen.
Beispiel
azsphere tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
select
Wählt den standardmäßigen Azure Sphere-Mandanten aus, der für den aktuellen Benutzer auf diesem PC verwendet werden soll.
Verwenden Sie zum Anzeigen des aktuellen Standardmandanten den Befehl azsphere tenant show-selected.
Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| -t, --tenant | GUID oder Name | Gibt den Mandanten an, in dem dieser Vorgang ausgeführt werden soll. Überschreibt den ausgewählten Standardmandanten. Sie können entweder die Mandanten-ID oder den Mandantennamen angeben. |
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --only-show-errors | Zeigt nur Fehler an, wobei Warnungen unterdrückt werden. |
| -o, --output | Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), Table (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
Hinweis
Wenn Sie die klassische Azure Sphere CLI verwenden, finden Sie unter "Globale Parameter " weitere Informationen zu den verfügbaren Optionen.
Beispiel
azsphere tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
show-selected
Zeigt die Details des Standardmäßigen Azure Sphere-Mandanten für den aktuellen Benutzer auf diesem PC an.
Dabei handelt es sich um den Mandanten, der mit dem Befehl azsphere tenant select ausgewählt wurde.
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --only-show-errors | Zeigt nur Fehler an, wobei Warnungen unterdrückt werden. |
| -o, --output | Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), Table (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
Hinweis
Wenn Sie die klassische Azure Sphere CLI verwenden, finden Sie unter "Globale Parameter " weitere Informationen zu den verfügbaren Optionen.
Beispiel
azsphere tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
aktualisieren
Aktualisiert die Details eines Mandanten, z. B. den Namen des Mandanten.
Erforderliche Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| -n, --new-name | String | Gibt einen neuen Namen für den Mandanten an. Verwenden Sie bei der Benennung Ihres Mandanten alphanumerische Zeichen. Sonderzeichen sind nicht zulässig. Der Name darf 50 Zeichen nicht überschreiten und die Groß-/Kleinschreibung wird beachtet. |
Optionale Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| -t, --tenant | GUID oder Name | Gibt den Mandanten an, in dem dieser Vorgang ausgeführt werden soll. Überschreibt den ausgewählten Standardmandanten. Sie können entweder die Mandanten-ID oder den Mandantennamen angeben. |
Globale Parameter
Die folgenden globalen Parameter sind für die Azure Sphere CLI verfügbar:
| Parameter | Beschreibung |
|---|---|
| --debug | Erhöht die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen. Wenn ein Fehler auftritt, stellen Sie beim Übermitteln eines Fehlerberichts die mit dem Flag --debug generierte Ausgabe bereit. |
| -h, --help | Druckt CLI-Referenzinformationen zu Befehlen und deren Argumenten und Listen verfügbarer Untergruppen und Befehle. |
| --only-show-errors | Zeigt nur Fehler an, wobei Warnungen unterdrückt werden. |
| -o, --output | Ändert das Ausgabeformat. Die verfügbaren Ausgabeformate sind json, jsonc (colorized JSON), tsv (Tab-Separated Values), Table (human-lesbare ASCII-Tabellen) und Yaml. Die CLI gibt standardmäßig table aus. Weitere Informationen zu den verfügbaren Ausgabeformaten finden Sie unter Ausgabeformat für Azure Sphere CLI-Befehle. |
| --query | Verwendet die JMESPath-Abfragesprache, um die von Azure Sphere Security Services zurückgegebene Ausgabe zu filtern. Weitere Informationen und Beispiele finden Sie im JMESPath-Lernprogramm und in der Abfrage der Azure CLI-Befehlsausgabe . |
| --verbose | Druckt Informationen zu Ressourcen, die während eines Vorgangs in Azure Sphere erstellt wurden, und andere nützliche Informationen. Verwenden Sie --debug, um vollständige Debugprotokolle zu erhalten. |
Hinweis
Wenn Sie die klassische Azure Sphere CLI verwenden, finden Sie unter "Globale Parameter " weitere Informationen zu den verfügbaren Optionen.
Beispiel
azsphere tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2 Administrator
Contributor
------------------------------------ --------------------- -------------
Tipp
Wenn Sie keinen Standardmandanten ausgewählt haben, wird eine Liste der verfügbaren Mandanten angezeigt. Legen Sie Ihren Standardmandanten fest, indem Sie eine der Optionen auswählen.