klient
Důležité
Toto je dokumentace k Azure Sphere (starší verze). Azure Sphere (starší verze) se vyřazuje 27. září 2027 a uživatelé musí do této doby migrovat do Azure Sphere (integrované). K zobrazení dokumentace k Azure Sphere (integrované) použijte selektor verzí umístěný nad obsahem.
Spravuje tenanta Azure Sphere.
Důležité
Příkazy azsphere tenant download-ca-certificate, azsphere tenant download-ca-certificate-chaina azsphere tenant download-validation-certificate jsou zastaralé. Použijte azsphere ca-certificate download, azsphere ca-certificate download-chainazsphere ca-certificate download-proof, a azsphere ca-certificate list místo toho.
V Rozhraní příkazového řádku Azure Sphere se při vytvoření tenanta automaticky nevybere výchozí tenant. Pokud chcete vybrat výchozího tenanta pro aktuálního uživatele na počítači, musíte spustit příkaz azsphere tenant select . Tím zajistíte, že výchozí tenant je ten správný, který se má použít při jednorázové operaci, kterou nemůžete vrátit zpět, jako je deklarace zařízení.
| Operation | Popis |
|---|---|
| vytvoření | Vytvoří nového tenanta. |
| download-error-report | Vrátí informace o chybě pro zařízení v aktuálním tenantovi. |
| list | Zobrazí seznam dostupných tenantů Azure Sphere. |
| vybrat | Vybere výchozího tenanta Azure Sphere, který se použije na tomto počítači. |
| zobrazit vybrané | Zobrazuje výchozího tenanta Azure Sphere pro tento počítač. |
| update | Aktualizuje podrobnosti tenanta, například název tenanta. |
vytvoření
Vytvoří nového tenanta Azure Sphere. Ke spuštění tohoto příkazu se vyžaduje připojené zařízení. Další informace najdete v tématu Vytvoření tenanta Azure Sphere.
Pokud už tenanta máte a jste si jistí, že chcete jiný, použijte --force-additional parametr. V současné době nemůžete odstranit tenanta Azure Sphere.
Po vytvoření tenanta spusťte azsphere tenant select a vyberte výchozího tenanta, který se má použít pro aktuálního uživatele na tomto počítači. Role pro uživatele v aktuálním tenantovi Azure Sphere můžete přidat pomocí příkazu azsphere role add .
Příkaz azsphere tenant create funguje s místně připojeným zařízením Azure Sphere. Pokud se pokusíte příkaz bez připojeného zařízení, zobrazí se chyba. ID zařízení se zaznamená při vytváření tenanta a pro každé zařízení se dá vytvořit jenom jeden tenant.
Povinné parametry
| Parametr | Typ | Popis |
|---|---|---|
| -n, --name | String | Určuje název tenanta. Při pojmenování tenanta použijte alfanumerické znaky. Speciální znaky nejsou povoleny. Název nesmí překročit 50 znaků a rozlišují se malá a velká písmena. |
Volitelné parametry
| Parametr | Typ | Popis |
|---|---|---|
| -d, --device | String | Určuje zařízení, na kterém se má příkaz spustit, když je připojeno více zařízení. Tento parametr se vyžaduje, když je připojeno více zařízení. Aktuálně připojené zařízení se ve výchozím nastavení používá. Můžete zadat ID zařízení, IP adresu nebo ID místního připojení připojeného zařízení. Azure Sphere CLI podporuje více zařízení MT3620 ve Windows, ale v Linuxu můžete připojit jenom jedno zařízení najednou. Z tohoto důvodu se tento parametr podporuje pro Windows, ale ne pro Linux. Pokud použijete tento parametr s příkazem v Linuxu, vrátí se chyba. |
| --force-additional | Logická hodnota | Vynutí vytvoření nového tenanta Azure Sphere. Tento příkaz použijte jenom v případě, že jste si jisti, že chcete použít aktuální účet k vytvoření nového tenanta Azure Sphere pomocí připojeného zařízení. |
| --disable-confirm-prompt | Logická hodnota | Zakáže výzvu k potvrzení uživatele. |
Globální parametry
Pro Rozhraní příkazového řádku Azure Sphere jsou k dispozici následující globální parametry:
| Parametr | Popis |
|---|---|
| --ladicí | Zvyšuje úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění. Pokud narazíte na chybu, při odesílání zprávy o chybě zadejte výstup vygenerovaný pomocí příznaku --debug. |
| -h, --help | Vytiskne referenční informace rozhraní příkazového řádku o příkazech a jejich argumentech a seznamech dostupných podskupin a příkazů. |
| --only-show-errors | Zobrazuje pouze chyby a potlačuje upozornění. |
| -o, --output | Změní formát výstupu. Dostupné výstupní formáty jsou json, jsonc (barevné JSON), tsv (hodnoty oddělené tabulátory), tabulka (tabulky ASCII čitelné pro člověka) a yaml. Ve výchozím nastavení je výstup rozhraní příkazového řádku ve formátu table. Další informace o dostupných formátech výstupu najdete v tématu Formát výstupu pro příkazy Rozhraní příkazového řádku Azure Sphere. |
| --dotaz | Použije dotazovací jazyk JMESPath k filtrování výstupu vráceného ze služeb zabezpečení Azure Sphere. Další informace a příklady najdete v kurzu JMESPath a dotazování výstupu příkazu Azure CLI. |
| --užvaněný | Vytiskne informace o prostředcích vytvořených v Azure Sphere během operace a dalších užitečných informací. Pokud chcete zobrazit úplné protokoly ladění, použijte parametr --debug. |
Poznámka:
Pokud používáte Azure Sphere Classic CLI, další informace o dostupných možnostech najdete v tématu Globální parametry .
Příklad
azsphere tenant create --name MyTenant
--force-additional --disable-confirm-prompt Pokud jste si jistí, že chcete tento účet použít k vytvoření nového tenanta Azure Sphere pomocí připojeného zařízení, použijte parametry a parametry. Zařízení, které bylo dříve použito k vytvoření tenanta Azure Sphere, se nedá použít k vytvoření nového tenanta.
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.
Tip
Po vytvoření tenanta se ujistěte, že spuštěním příkazu azsphere tenant select vyberete výchozího tenanta, který se má použít pro aktuálního uživatele na tomto počítači.
download-error-report
Vrátí informace o chybách hlášených zařízeními v aktuálním tenantovi.
Tento příkaz načítá data událostí z cloudu azure Sphere Security Service a nevyžaduje fyzické připojení k určitému zařízení. Příkaz azsphere tenant download-error-report funguje v kontextu aktuálního tenanta a vrací chybové zprávy pro všechna zařízení v rámci tohoto tenanta.
Poznámka:
Stažení nedávno ohlášených událostí může trvat až 24 hodin. Další informace naleznete v tématu Shromažďování a interpretace chybových dat.
Volitelné parametry
| Parametr | Typ | Popis |
|---|---|---|
| --cíl | String | Určuje cestu a název souboru výstupního souboru. |
| -t, --tenant | IDENTIFIKÁTOR GUID nebo název | Určuje tenanta, ve které se má tato operace provést. Přepíše výchozího vybraného tenanta. Můžete zadat BUĎ ID tenanta, nebo název tenanta. |
Globální parametry
Pro Rozhraní příkazového řádku Azure Sphere jsou k dispozici následující globální parametry:
| Parametr | Popis |
|---|---|
| --ladicí | Zvyšuje úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění. Pokud narazíte na chybu, při odesílání zprávy o chybě zadejte výstup vygenerovaný pomocí příznaku --debug. |
| -h, --help | Vytiskne referenční informace rozhraní příkazového řádku o příkazech a jejich argumentech a seznamech dostupných podskupin a příkazů. |
| --only-show-errors | Zobrazuje pouze chyby a potlačuje upozornění. |
| -o, --output | Změní formát výstupu. Dostupné výstupní formáty jsou json, jsonc (barevné JSON), tsv (hodnoty oddělené tabulátory), tabulka (tabulky ASCII čitelné pro člověka) a yaml. Ve výchozím nastavení je výstup rozhraní příkazového řádku ve formátu table. Další informace o dostupných formátech výstupu najdete v tématu Formát výstupu pro příkazy Rozhraní příkazového řádku Azure Sphere. |
| --dotaz | Použije dotazovací jazyk JMESPath k filtrování výstupu vráceného ze služeb zabezpečení Azure Sphere. Další informace a příklady najdete v kurzu JMESPath a dotazování výstupu příkazu Azure CLI. |
| --užvaněný | Vytiskne informace o prostředcích vytvořených v Azure Sphere během operace a dalších užitečných informací. Pokud chcete zobrazit úplné protokoly ladění, použijte parametr --debug. |
Poznámka:
Pokud používáte Azure Sphere Classic CLI, další informace o dostupných možnostech najdete v tématu Globální parametry .
Příklad
azsphere tenant download-error-report --destination c:\error-report.csv --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
list
Zobrazí seznam tenantů Azure Sphere.
Globální parametry
Pro Rozhraní příkazového řádku Azure Sphere jsou k dispozici následující globální parametry:
| Parametr | Popis |
|---|---|
| --ladicí | Zvyšuje úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění. Pokud narazíte na chybu, při odesílání zprávy o chybě zadejte výstup vygenerovaný pomocí příznaku --debug. |
| -h, --help | Vytiskne referenční informace rozhraní příkazového řádku o příkazech a jejich argumentech a seznamech dostupných podskupin a příkazů. |
| --only-show-errors | Zobrazuje pouze chyby a potlačuje upozornění. |
| -o, --output | Změní formát výstupu. Dostupné výstupní formáty jsou json, jsonc (barevné JSON), tsv (hodnoty oddělené tabulátory), tabulka (tabulky ASCII čitelné pro člověka) a yaml. Ve výchozím nastavení je výstup rozhraní příkazového řádku ve formátu table. Další informace o dostupných formátech výstupu najdete v tématu Formát výstupu pro příkazy Rozhraní příkazového řádku Azure Sphere. |
| --dotaz | Použije dotazovací jazyk JMESPath k filtrování výstupu vráceného ze služeb zabezpečení Azure Sphere. Další informace a příklady najdete v kurzu JMESPath a dotazování výstupu příkazu Azure CLI. |
| --užvaněný | Vytiskne informace o prostředcích vytvořených v Azure Sphere během operace a dalších užitečných informací. Pokud chcete zobrazit úplné protokoly ladění, použijte parametr --debug. |
Poznámka:
Pokud používáte Azure Sphere Classic CLI, další informace o dostupných možnostech najdete v tématu Globální parametry .
Příklad
azsphere tenant list
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
Vyberte jednu z možností.
Vybere výchozího tenanta Azure Sphere, který se použije pro aktuálního uživatele na tomto počítači.
Pokud chcete zobrazit aktuálního výchozího tenanta, použijte příkaz azsphere tenant show-selected.
Povinné parametry
| Parametr | Typ | Popis |
|---|---|---|
| -t, --tenant | IDENTIFIKÁTOR GUID nebo název | Určuje tenanta, ve které se má tato operace provést. Přepíše výchozího vybraného tenanta. Můžete zadat BUĎ ID tenanta, nebo název tenanta. |
Globální parametry
Pro Rozhraní příkazového řádku Azure Sphere jsou k dispozici následující globální parametry:
| Parametr | Popis |
|---|---|
| --ladicí | Zvyšuje úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění. Pokud narazíte na chybu, při odesílání zprávy o chybě zadejte výstup vygenerovaný pomocí příznaku --debug. |
| -h, --help | Vytiskne referenční informace rozhraní příkazového řádku o příkazech a jejich argumentech a seznamech dostupných podskupin a příkazů. |
| --only-show-errors | Zobrazuje pouze chyby a potlačuje upozornění. |
| -o, --output | Změní formát výstupu. Dostupné výstupní formáty jsou json, jsonc (barevné JSON), tsv (hodnoty oddělené tabulátory), tabulka (tabulky ASCII čitelné pro člověka) a yaml. Ve výchozím nastavení je výstup rozhraní příkazového řádku ve formátu table. Další informace o dostupných formátech výstupu najdete v tématu Formát výstupu pro příkazy Rozhraní příkazového řádku Azure Sphere. |
| --dotaz | Použije dotazovací jazyk JMESPath k filtrování výstupu vráceného ze služeb zabezpečení Azure Sphere. Další informace a příklady najdete v kurzu JMESPath a dotazování výstupu příkazu Azure CLI. |
| --užvaněný | Vytiskne informace o prostředcích vytvořených v Azure Sphere během operace a dalších užitečných informací. Pokud chcete zobrazit úplné protokoly ladění, použijte parametr --debug. |
Poznámka:
Pokud používáte Azure Sphere Classic CLI, další informace o dostupných možnostech najdete v tématu Globální parametry .
Příklad
azsphere tenant select --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
zobrazit vybrané
Zobrazí podrobnosti o výchozím tenantovi Azure Sphere pro aktuálního uživatele na tomto počítači.
Toto je tenant vybraný příkazem azsphere tenant select .
Globální parametry
Pro Rozhraní příkazového řádku Azure Sphere jsou k dispozici následující globální parametry:
| Parametr | Popis |
|---|---|
| --ladicí | Zvyšuje úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění. Pokud narazíte na chybu, při odesílání zprávy o chybě zadejte výstup vygenerovaný pomocí příznaku --debug. |
| -h, --help | Vytiskne referenční informace rozhraní příkazového řádku o příkazech a jejich argumentech a seznamech dostupných podskupin a příkazů. |
| --only-show-errors | Zobrazuje pouze chyby a potlačuje upozornění. |
| -o, --output | Změní formát výstupu. Dostupné výstupní formáty jsou json, jsonc (barevné JSON), tsv (hodnoty oddělené tabulátory), tabulka (tabulky ASCII čitelné pro člověka) a yaml. Ve výchozím nastavení je výstup rozhraní příkazového řádku ve formátu table. Další informace o dostupných formátech výstupu najdete v tématu Formát výstupu pro příkazy Rozhraní příkazového řádku Azure Sphere. |
| --dotaz | Použije dotazovací jazyk JMESPath k filtrování výstupu vráceného ze služeb zabezpečení Azure Sphere. Další informace a příklady najdete v kurzu JMESPath a dotazování výstupu příkazu Azure CLI. |
| --užvaněný | Vytiskne informace o prostředcích vytvořených v Azure Sphere během operace a dalších užitečných informací. Pokud chcete zobrazit úplné protokoly ladění, použijte parametr --debug. |
Poznámka:
Pokud používáte Azure Sphere Classic CLI, další informace o dostupných možnostech najdete v tématu Globální parametry .
Příklad
azsphere tenant show-selected
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant Administrator
Contributor
------------------------------------ --------------------- -------------
update
Aktualizuje podrobnosti tenanta, například název tenanta.
Povinné parametry
| Parametr | Typ | Popis |
|---|---|---|
| -n, --new-name | String | Určuje nový název tenanta. Při pojmenování tenanta použijte alfanumerické znaky. Speciální znaky nejsou povoleny. Název nesmí překročit 50 znaků a rozlišují se malá a velká písmena. |
Volitelné parametry
| Parametr | Typ | Popis |
|---|---|---|
| -t, --tenant | IDENTIFIKÁTOR GUID nebo název | Určuje tenanta, ve které se má tato operace provést. Přepíše výchozího vybraného tenanta. Můžete zadat BUĎ ID tenanta, nebo název tenanta. |
Globální parametry
Pro Rozhraní příkazového řádku Azure Sphere jsou k dispozici následující globální parametry:
| Parametr | Popis |
|---|---|
| --ladicí | Zvyšuje úroveň podrobností protokolování, aby se zobrazily všechny protokoly ladění. Pokud narazíte na chybu, při odesílání zprávy o chybě zadejte výstup vygenerovaný pomocí příznaku --debug. |
| -h, --help | Vytiskne referenční informace rozhraní příkazového řádku o příkazech a jejich argumentech a seznamech dostupných podskupin a příkazů. |
| --only-show-errors | Zobrazuje pouze chyby a potlačuje upozornění. |
| -o, --output | Změní formát výstupu. Dostupné výstupní formáty jsou json, jsonc (barevné JSON), tsv (hodnoty oddělené tabulátory), tabulka (tabulky ASCII čitelné pro člověka) a yaml. Ve výchozím nastavení je výstup rozhraní příkazového řádku ve formátu table. Další informace o dostupných formátech výstupu najdete v tématu Formát výstupu pro příkazy Rozhraní příkazového řádku Azure Sphere. |
| --dotaz | Použije dotazovací jazyk JMESPath k filtrování výstupu vráceného ze služeb zabezpečení Azure Sphere. Další informace a příklady najdete v kurzu JMESPath a dotazování výstupu příkazu Azure CLI. |
| --užvaněný | Vytiskne informace o prostředcích vytvořených v Azure Sphere během operace a dalších užitečných informací. Pokud chcete zobrazit úplné protokoly ladění, použijte parametr --debug. |
Poznámka:
Pokud používáte Azure Sphere Classic CLI, další informace o dostupných možnostech najdete v tématu Globální parametry .
Příklad
azsphere tenant update --tenant a323c263-2aa3-2559-aabb-a3fc32631900 --new-name Tenant2
------------------------------------ --------------------- -------------
Id Name Roles
========================================================================
a323c263-2aa3-2559-aabb-a3fc32631900 Tenant2 Administrator
Contributor
------------------------------------ --------------------- -------------
Tip
Pokud jste nevybrali výchozího tenanta, zobrazí se seznam dostupných tenantů. Nastavte výchozího tenanta tak, že vyberete jednu z možností.