Udostępnij za pośrednictwem

Azure Sphere CLI

  • Artykuł

Ważne

Jest to dokumentacja usługi Azure Sphere (starsza wersja). Usługa Azure Sphere (starsza wersja) zostanie wycofana 27 września 2027 r., a użytkownicy muszą przeprowadzić migrację do usługi Azure Sphere (zintegrowanej) do tej pory. Użyj selektora wersji znajdującego się powyżej spisu treści, aby wyświetlić dokumentację usługi Azure Sphere (zintegrowaną).

Zestaw SDK usługi Azure Sphere udostępnia interfejs wiersza polecenia usługi Azure Sphere dostępny w powłoce poleceń programu PowerShell, wiersza polecenia systemu Windows lub systemu Linux. Interfejs wiersza polecenia usługi Azure Sphere to zestaw poleceń używanych do tworzenia zasobów usługi Azure Sphere i zarządzania nimi.

Interfejs wiersza polecenia usługi Azure Sphere jest instalowany wraz z wycofaniem klasycznego interfejsu wiersza polecenia usługi Azure Sphere w systemach Windows i Linux, dzięki czemu masz dostęp do dowolnego interfejsu. Aby użyć interfejsu wiersza polecenia usługi Azure Sphere:

  • W systemie Windows użyj programu PowerShell lub standardowego wiersza polecenia systemu Windows.
  • W systemie Linux użyj dowolnej powłoki poleceń.

Uruchamianie interfejsu wiersza polecenia usługi Azure Sphere

Teraz możesz uruchomić interfejs wiersza polecenia usługi Azure Sphere za pomocą azsphere polecenia z wiersza polecenia systemu Windows lub programu PowerShell. Zalecamy program PowerShell, ponieważ oferuje funkcję uzupełniania kart, która nie jest dostępna w wierszu polecenia systemu Windows.

W systemie Linux możesz uruchomić interfejs wiersza polecenia usługi Azure Sphere z poziomu dowolnego interfejsu wiersza polecenia (CLI). Podczas instalacji zostanie wyświetlone powiadomienie umożliwiające ustawienie interfejsu wiersza polecenia usługi Azure Sphere lub klasycznego interfejsu wiersza polecenia usługi Azure Sphere jako preferowanej domyślnej wersji interfejsu wiersza polecenia. Wpisz, Yes aby wybrać interfejs wiersza polecenia usługi Azure Sphere lub typ No , aby użyć klasycznego interfejsu wiersza polecenia usługi Azure Sphere. Aby uzyskać więcej informacji, zobacz Instalowanie zestawu Azure Sphere SDK .

Uwaga

Krótki formularz poleceń nie jest obsługiwany w wersji interfejsu wiersza polecenia usługi Azure Sphere. Zalecamy użycie funkcji uzupełniania kart, aby wyświetlić listę dostępnych poleceń. W systemie Windows skrót wiersza polecenia klasycznego dewelopera usługi Azure Sphere może być używany tylko z klasycznym interfejsem wiersza polecenia usługi Azure Sphere.

Funkcje wejściowe interfejsu wiersza polecenia

W tej sekcji opisano funkcje wejściowe dostępne w interfejsie wiersza polecenia usługi Azure Sphere:

Polecenia

Wszystkie polecenia w interfejsie wiersza polecenia usługi Azure Sphere zaczynają się od azsphere. Na przykład:

azsphere login
 ---------------------
 Name
 =====================
 bob@contoso.com
 ---------------------

Znajdowanie poleceń

Polecenia w interfejsie wiersza polecenia są zorganizowane w grupach. Pełne informacje pomocy dotyczące dostępnych poleceń i parametrów można wyświetlić przy użyciu klasycznego --help interfejsu wiersza polecenia usługi Azure Sphere i interfejsu wiersza polecenia usługi Azure Sphere.

Pełną listę poleceń można uzyskać, uruchamiając polecenie azsphere --help.

Na przykład:

  • W przypadku użycia azsphere --help klasycznego interfejsu wiersza polecenia usługi Azure Sphere lub azsphere -?
  • W przypadku użycia interfejsu azsphere --help wiersza polecenia usługi Azure Sphere lub azsphere -h

Parametry

Nazwa parametru jest poprzedzona podwójnymi łącznikami (--), które sygnalizuje, że słowo podążające za łącznikiem jest parametrem. Użyj spacji, aby oddzielić nazwę parametru i wartość. Parametry, które są wyrazami złożonymi, są oddzielone łącznikiem (-) w nowym interfejsie wiersza polecenia.

Na przykład: --component-id lub --application-update

Uproszczona identyfikacja obiektu

W interfejsie wiersza polecenia usługi Azure Sphere pojedynczy parametr służy do identyfikowania każdego typu obiektu. Oznacza to, że można podać identyfikator, nazwę, adres IP lub lokalizację odpowiednią dla tego parametru.

Można na przykład użyć identyfikatora dzierżawy lub nazwy dzierżawy w następującym poleceniu:

azsphere device list --tenant 143adbc9-1bf0-4be2-84a2-084a331d81cb

lub

azsphere device list --tenant MyTenant

Zostało to zaimplementowane dla parametrów --device, --tenant, --producti --device-group .

Na przykład:

azsphere device-group update --device-group CoffeeMaker/Development
   ------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------
   Id                                   TenantId                             OsFeedType ProductId                            Name      Description            UpdatePolicy                                               AllowCrashDumpsCollection
   ===============================================================================================================================================================================================================================================
   7f860cc1-4949-4000-a541-9a988ba4c3cd 143adbc9-1bf0-4be2-84a2-084a331d81cb Retail     6f52bead-700d-4289-bdc2-2f11f774270e Marketing Marketing device group Accept all updates from the Azure Sphere Security Service. False
   ------------------------------------ ------------------------------------ ---------- ------------------------------------ --------- ---------------------- ---------------------------------------------------------- -------------------------

Wiele wartości

Niektóre polecenia zezwalają na wiele wartości dla jednego parametru, w tym przypadku można podać parametr z każdą wartością lub jeden parametr, po którym następuje lista wartości rozdzielonych spacjami. Na przykład następujące dwa polecenia są równoważne:

azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 --executables filepath-2

azsphere image-package pack-application --package-directory myDirectory --destination myImagePackage --executables filepath-1 filepath-2

Wymagane i opcjonalne parametry

Po uruchomieniu azsphere <command> <sub-command> --help listy parametrów mających zastosowanie do tego polecenia jest wyświetlana. Ustawienie [Wymagane] wskazuje, czy parametr jest obowiązkowy do pomyślnego uruchomienia polecenia. Wszystkie inne parametry są opcjonalne.

Jeśli brakuje wymaganego parametru, zostanie wyświetlony monit o podanie wartości parametru.

Na przykład:

azsphere role delete --help

Command
    azsphere role delete : Deletes a role from a user in the current Azure Sphere tenant.

Arguments
    --role -r [Required] : Role to be deleted. Values from: azsphere role show-types.
    --user -u [Required] : The user from whom the role is being deleted. Specify user e-mail.
                           Values from: azsphere role list.

Tenant Selection Arguments
    --tenant -t          : The tenant to perform this operation in. Overrides the default selected
                           tenant. Specify tenant ID or tenant name. Values from: azsphere tenant
                           list.

Global Arguments
    --debug              : Increase logging verbosity to show all debug logs.
    --help -h            : Show this help message and exit.
    --only-show-errors   : Only show errors, suppressing warnings.
    --output -o          : Output format. Allowed values: json, jsonc, none, table, tsv, yaml,
                           yamlc. Default: table.
    --query              : JMESPath query string. See http://jmespath.org/ for more information and
                           examples.
    --verbose            : Increase logging verbosity. Use --debug for full debug logs.

Ścieżki wejściowe i wyjściowe

W interfejsie wiersza polecenia usługi Azure Sphere nazwy parametrów używane do określania ścieżki i nazwy pliku zostały zaktualizowane tak, aby były istotne dla kontekstu polecenia.

Na przykład:

azsphere image-package pack-application --package-directory C:\AppSamples\LocalSamples\HelloWorld\HelloWorld_HighLevelApp\out\ARM-Debug\approotHelloWorld_HighLevelApp --destination myimage.imagepackage

--package-directory W tym miejscu określa katalog wejściowy pakietu i --destination parametru określa ścieżkę i nazwę pliku dla wynikowego pakietu obrazu.

Uzupełnianie kart

Uzupełnianie karty zapewnia pomoc w automatycznym uzupełnianiu wpisu polecenia w interfejsie wiersza polecenia. Uzupełnianie karty interfejsu wiersza polecenia usługi Azure Sphere jest obsługiwane dla grup, poleceń, nazw parametrów i wartości parametrów. Wpisz kilka znaków polecenia, a następnie naciśnij TAB , aby wybrać żądany tekst ukończenia. Jeśli wiele elementów zaczyna się od tekstu, który początkowo został wpisany, kontynuuj naciśnięcie TAB do momentu wyświetlenia żądanego elementu.

W systemie Windows program PowerShell 7.1 oferuje funkcję uzupełniania kart, która nie jest dostępna w wierszu polecenia systemu Windows.

Aby włączyć uzupełnianie kart w programie Windows PowerShell, uruchom polecenie Import-Module -name AzsphereCli. To polecenie umożliwia uzupełnianie kart tylko dla sesji. Możesz dodać skrypt do profilu programu PowerShell, aby dostosować środowisko i włączyć uzupełnianie kart dla każdej uruchomionej sesji programu PowerShell.

W systemie Linux interfejs wiersza polecenia usługi Azure Sphere obsługuje funkcję uzupełniania tabulacji dla poleceń w powłoce powłoki Bash.

Ponadto autouzupełnianie ułatwia odnajdywanie poleceń, parametrów i wartości parametrów, które są dostępne do użycia. Jest to dostępne za pomocą CTRL+Spacja w programie Windows PowerShell lub naciśnij TAB dwa razy w powłoce powłoki Bash systemu Linux.

Na przykład wpisz polecenie azsphere product update i użyj autouzupełniania, aby wyświetlić listę dostępnych parametrów.

Parametry autouzupełniania programu PowerShell

Podobnie wpisz azsphere product update --product i użyj autouzupełniania, aby wyświetlić listę dostępnych produktów w dzierżawie.

Produkty autouzupełniania programu PowerShell

Tryb interaktywny (wersja zapoznawcza)

Ważne

Ta funkcja jest dostępna w wersji zapoznawczej. Może zostać zmieniony lub usunięty w przyszłej wersji.

Nowy interfejs wiersza polecenia oferuje tryb interaktywny, który automatycznie wyświetla informacje pomocy i ułatwia wybieranie poleceń, poleceń podrzędnych, parametrów i wartości parametrów. Wprowadź tryb interaktywny za pomocą polecenia azsphere interactive. Wiersz polecenia zmieni się, aby wskazać azsphere>> , że teraz uruchamiasz polecenia w interaktywnej powłoce. Aby uzyskać więcej informacji, zobacz Tryb interaktywny interfejsu wiersza polecenia usługi Azure Sphere.

Tryb interaktywny usługi Azure Sphere

Funkcje wyjściowe interfejsu wiersza polecenia

W tej sekcji opisano funkcje wyjściowe dostępne w interfejsie wiersza polecenia usługi Azure Sphere:

W poniższych sekcjach opisano funkcje wyjściowe dostępne w nowym interfejsie wiersza polecenia:

Obsługiwane formaty danych wyjściowych

Dostępne formaty danych wyjściowych w nowym interfejsie wiersza polecenia to json, jsonc (kolorowane dane JSON), tsv (wartości rozdzielane tabulatorami), table (tabele ASCII czytelne dla człowieka) i yaml. Domyślnie interfejs wiersza polecenia zwraca format table. Aby dowiedzieć się więcej na temat dostępnych formatów danych wyjściowych, zobacz Obsługiwane formaty danych wyjściowych dla interfejsu wiersza polecenia usługi Azure Sphere.

Przekierowywanie i stronicowanie

Interfejs wiersza polecenia usługi Azure Sphere nie obsługuje interakcyjnej stronicowania. Można jednak przekierować standardowe dane wyjściowe polecenia do pliku. W poniższym przykładzie w przypadku wiersza polecenia systemu Windows, środowiska Windows PowerShell i powłoki powłoki Bash systemu Linux standardowe dane wyjściowe są wysyłane do output.txt, a do logs.txt jest wysyłany standardowy błąd.

azsphere device list --verbose > output.txt 2> logs.txt

Możesz również stronicować dane wyjściowe na ekranie, przesyłając potoki do istniejących narzędzi do stronicowania.

Na przykład:

  • W programie PowerShell (Windows): azsphere device list | Out-Host –Paging
  • W wierszu polecenia (Windows): azsphere device list | more
  • W powłoce Bash (Linux): azsphere device list | less

Uwaga

Ta operacja może być potencjalnie niska w zależności od ilości zwracanych danych.

Aby uzyskać więcej informacji na temat stronicowania klasycznego interfejsu wiersza polecenia usługi Azure Sphere, zobacz Paging and result redirection (Stronicowanie i przekierowywanie wyników).

Dane wyjściowe polecenia interfejsu wiersza polecenia zapytania

Interfejs wiersza polecenia usługi Azure Sphere używa argumentu --query do uruchomienia zapytania JMESPath w wynikach poleceń. JMESPath to język zapytań dla formatu JSON, który umożliwia wybieranie i modyfikowanie danych z danych wyjściowych interfejsu wiersza polecenia. Zapytania są uruchamiane w danych wyjściowych JSON przed dowolnym formatowaniem wyświetlania.

Argument --query jest obsługiwany przez wszystkie polecenia w interfejsie wiersza polecenia usługi Azure Sphere. Aby uzyskać więcej informacji i przykładów, zobacz Samouczek JMESPath i Wykonywanie zapytań o dane wyjściowe polecenia interfejsu wiersza polecenia platformy Azure.

Zgodność ze starszymi wersjami

Interfejs wiersza polecenia obsługuje zgodność z poprzednimi wersjami. W każdej wersji chcemy zachować zgodność z poprzednimi wersjami dla danych wejściowych (nazw poleceń, nazw parametrów, wartości parametrów) i danych wyjściowych w formacie JSON i YAML. W przypadkach, gdy taka zgodność nie jest możliwa, przed wprowadzeniem zmian otrzymamy co najmniej 6 miesięcy powiadomienia. Aby uzyskać więcej informacji, zobacz Ważne zmiany (funkcje wycofywania) w interfejsie wiersza polecenia usługi Azure Sphere.

Kody zakończenia

Pomyślne polecenie zwraca zero. Dowolna wartość niezerowa może być interpretowana jako kod błędu. Po powodzeniu dane wyjściowe JSON i YAML mają gwarancję umowną zgodną z poprzednimi wersjami.

Przekazywanie opinii

Jeśli znajdziesz usterkę w usłudze Azure Sphere, zgłoś problem w witrynie GitHub. Aby przekazać opinię z wiersza polecenia, użyj polecenia feedback.

Efektywne korzystanie z interfejsu wiersza polecenia usługi Azure Sphere

Interfejs wiersza polecenia usługi Azure Sphere może być używany z poziomu powłoki Bash, programu PowerShell lub okna wiersza polecenia. Oto kilka wskazówek dotyczących korzystania z interfejsu wiersza polecenia:

  • Używanie cudzysłowów w wartościach: jeśli podasz parametr, wartość zawierająca spacje, ujęć ją w cudzysłów. W powłoce Bash lub PowerShell interpretowane są zarówno cudzysłowy pojedyncze, jak i podwójne. W wierszu polecenia systemu Windows interpretowane są tylko podwójne cudzysłowy. Pojedyncze cudzysłowy są interpretowane jako część wartości. Na przykład azsphere product create --name "My Fridge Product". Aby uzyskać więcej informacji, zobacz Znaki cudzysłowu i znaki ucieczki.
  • Wiele poleceń usługi Azure Sphere wyświetla informacje w konsoli w formacie domyślnym table . Na przykład azsphere product device-group list --product DW100. Czasami wyświetlane informacje nie pasują poprawnie do konsoli. Może to spowodować problemy, jeśli chcesz skopiować i wkleić informacje. Zalecamy wypróbowanie następujących opcji:
    • Zmień rozmiar konsoli i ponownie uruchom polecenie.
    • Użyj danych wyjściowych JSON, aby uzyskać zwięzłe dane wyjściowe i skrypty. Na przykład azsphere product device-group list --product DW100 --output json.
    • Użyj uzupełniania tabulatorów w powłoce windows PowerShell lub powłoki Bash, aby automatycznie ukończyć wpis polecenia.
    • Użyj trybu interaktywnego, który udostępnia środowisko interaktywne, aby automatycznie wyświetlać informacje i ułatwia wybieranie poleceń i poleceń podrzędnych. Wprowadź tryb interaktywny za pomocą polecenia azsphere interactive. Wiersz polecenia zmieni się na azsphere>> , aby wskazać, że teraz uruchamiasz polecenia w interaktywnej powłoce.

Zobacz też