Udostępnij za pośrednictwem

Azure Sphere CLI

  • Artykuł

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

Środowisko platformy Azure Sphere CLI jest instalowane razem z wycofywanym klasycznym interfejsem CLI azure Sphere zarówno w systemie Windows , jak i linux, dzięki czemu masz dostęp do obu interfejsów. Aby użyć platformy Azure Sphere CLI:

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

Uruchamianie środowiska Azure Sphere CLI

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

W systemie Linux możesz uruchomić platformę Azure Sphere CLI z dowolnego interfejsu wiersza polecenia (CLI). Podczas instalacji jest wyświetlane powiadomienie, które umożliwia ustawienie środowiska Azure Sphere CLI lub azure Sphere jako preferowanej domyślnej wersji cli. Wpisz, Yes aby wybrać platformę Azure Sphere CLI lub typ No , aby użyć klasycznej platformy Azure Sphere CLI. Aby uzyskać więcej informacji , zobacz Instalowanie pakietu Azure Sphere SDK .

Uwaga

Krótki formularz poleceń nie jest obsługiwany w wersji Azure Sphere CLI. Zalecamy wyświetlenie listy dostępnych poleceń za pomocą funkcji uzupełniania karty . W systemie Windows skrót wiersza polecenia Azure Sphere Classic Developer Command Prompt może być używany tylko z klasycznym interfejsem cli platformy Azure Sphere.

Funkcje wprowadzania informacji o interfejsie użytkownika

W tej sekcji opisano funkcje wprowadzania dostępne w witrynie Azure Sphere CLI:

Polecenia

Wszystkie polecenia w interfejsie cli platformy Azure Sphere zaczynają się od azsphere. Na przykład:

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

Znajdowanie poleceń

Polecenia w wierszu polecenia są uporządkowane w grupach. Możesz wyświetlić pełne informacje pomocy dotyczące dostępnych poleceń i parametrów, korzystając z --help klasycznych platform Azure Sphere CLI i Azure Sphere CLI.

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

Na przykład:

  • W przypadku używania klasycznego środowiska cli w usłudze azsphere --help Azure Sphere lub azsphere -?
  • W przypadku używania środowiska azsphere --help Azure Sphere CLI lub azsphere -h

Parametry

Nazwa parametru jest poprzedzona podwójnymi łącznikami (--), co sygnalizuje, że wyraz następujący po łączniku jest parametrem. Oddziel nazwę parametru od wartości za pomocą spacji. Parametry będące wyrazami złożonymi są oddzielone łącznikiem (-) w nowym wierszu polecenia.

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

Uproszczona identyfikacja obiektów

W interfejsie cli platformy Azure Sphere pojedynczy parametr jest używany do identyfikowania każdego typu obiektu. Oznacza to, że dla tego parametru możesz podać identyfikator, nazwę, adres IP lub lokalizację.

Na przykład możesz 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 --device, --tenant, --product, i --device-group parametrów.

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 takim przypadku można podać parametr z każdą wartością lub pojedynczy parametr, po którym następuje lista wartości rozdzielonych spacjami. Na przykład dwa następujące 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 zostanie wyświetlona azsphere <command> <sub-command> --help lista parametrów mających zastosowanie do tego polecenia. Ustawienie [Wymagane] wskazuje, czy parametr jest obowiązkowy do pomyślnego uruchomienia polecenia. Wszystkie pozostałe 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ścia i wyjścia

W witrynie Azure Sphere CLI nazwy parametrów użyte do określenia ścieżki i nazwy pliku zostały zaktualizowane w celu uwzględnienia 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 Tutaj określa katalog wprowadzania dla pakietu i --destination parametru określa ścieżkę i nazwę pliku dla wynikowego pakietu obrazów.

Ukończenie tabulatora

Ukończenie tabulatora ułatwia automatyczne uzupełnianie wpisu polecenia w interfejsie wiersza polecenia. Ukończenie karty Kula 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 klawisz TAB , aby zaznaczyć żądany tekst zakończenia. Jeśli wiele elementów zaczyna się od początkowo wpisanego tekstu, naciskaj klawisz TAB , aż pojawi się odpowiedni element.

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

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

W systemie Linux środowisko Azure Sphere CLI obsługuje funkcję uzupełniania karty dla poleceń w powłoce Bash.

Ponadto autouzupełnianie ułatwia odnajdowanie poleceń, parametrów i wartości parametrów, których można używać. Jest to dostępne za pomocą klawiszy CTRL+Spacja w Windows PowerShell lub dwukrotnego naciśnięcia klawisza TAB w powłoki Linux Bash.

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 — produkt i użyj autouzupełniania, aby wyświetlić listę dostępnych produktów w twojej dzierżawie.

Produkty autouzupełniania programu PowerShell

Tryb interakcyjny (podgląd)

Ważne

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

Nowy interfejs użytkownika udostępnia tryb interakcyjny, który automatycznie wyświetla informacje pomocy i ułatwia wybieranie poleceń, podzbiorów, parametrów i wartości parametrów. Wprowadź tryb interakcyjny za pomocą interakcyjnego polecenia azsphere . Wiersz polecenia zmieni się, aby wskazać azsphere>> , że obecnie są uruchomione polecenia w interakcyjnej powłoce. Aby uzyskać więcej informacji, zobacz Interakcyjny tryb środowiska Azure Sphere CLI.

Tryb interakcyjny Azure Sphere

Funkcje wyjściowe interfejsu cli

W tej sekcji wyjaśniono funkcje wyjściowe dostępne w interfejsie platformy Azure Sphere CLI:

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

Obsługiwane formaty wyjściowe

Dostępne formaty wyjściowe w nowym interfejsie użytkownika to: , jsonc (kolorowe JSON), tsv (wartości oddzielone tabulatorami), table (czytelne dla człowieka tabele ASCII) i yaml.json Domyślnie wynik tableinterfejsu. Aby dowiedzieć się więcej o dostępnych formatach wyjściowych, zobacz Obsługiwane formaty wyjściowe dla środowiska Azure Sphere CLI.

Przekierowywanie i podział na paginy

Platforma Azure Sphere CLI nie obsługuje interakcyjnego podziału na strony. Możesz jednak przekierować standardowe dane wyjściowe polecenia do pliku. W poniższym przykładzie dla wiersza polecenia systemu Windows, powłoki Windows PowerShell i powłoki Linux Bash standardowe dane wyjściowe są wysyłane do output.txt, a błąd standardowy jest wysyłany do logs.txt.

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

Można również przejść na strony danych wyjściowych na ekranie, łącząc je z istniejącymi narzędziami do tworzenia podziałów na strony.

Na przykład:

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

Uwaga

Ta operacja może działać wolno w zależności od ilości zwracanych danych.

Aby uzyskać więcej informacji na temat podziałów na strony w klasycznym interfejsie platformy Azure Sphere, zobacz Przekierowywanie stronicowania i wyniku.

Dane wyjściowe polecenia CLI kwerendy

Interfejs kuli platformy Azure używa tego argumentu --query do uruchamiania zapytania JMESPath na podstawie wyników poleceń. JMESPath to język zapytań dla formatu JSON, który umożliwia wybieranie i modyfikowanie danych w wynikach interfejsu cli. Zapytania są uruchamiane na wyjściu JSON przed dowolnym formatowaniem wyświetlania.

Argument --query jest obsługiwany przez wszystkie polecenia w interfejsie platformy Azure Sphere CLI. Aby uzyskać więcej informacji i przykładów, zobacz Samouczek programu JMESPath i Dane wyjściowe poleceń interfejsu platformy Azure CLI.

Zgodność z poprzednimi wersjami

Środowisko obsługi klienta obsługuje zgodność z poprzednimi wersjami. W każdej wersji chcemy zachować zgodność z poprzednimi wersjami zarówno dla danych wejściowych (nazw poleceń, nazw parametrów, wartości parametrów), jak i ich danych wyjściowych w JSON i YAML. W przypadkach, gdy taka zgodność nie jest możliwa, przed wprowadzeniem zmian poinformujemy o tym z co najmniej 6-miesięcznym wyprzedzeniem. Aby uzyskać więcej informacji, zobacz Ważne zmiany (wycofywanie funkcji) w interfejsie platformy Azure Sphere CLI.

Kody wyjścia

Pomyślne polecenie zwraca wartość zero. Każdą wartość inną niż zero można zinterpretować jako kod błędu. Po sukcesie produkty JSON i YAML mają gwarancję umowną zgodną z poprzednimi wersjami.

Przekaż opinię

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

Efektywne używanie środowiska Azure Sphere CLI

Funkcji Azure Sphere CLI można używać z poziomu powłoki Bash, programu PowerShell lub okna wiersza polecenia. Oto kilka porad dotyczących korzystania z interfejsu cli:

  • Używanie cudzysłowów w wartościach: Jeśli parametr zawiera spacje, należy ująć go w cudzysłów. W programach Bash i PowerShell interpretowane są zarówno pojedynczy, jak i podwójny cudzysłów. W wierszu polecenia systemu Windows interpretowane są tylko cudzysłowy podwójne. 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 Cudzysłowy i znaki anulowania.
  • 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 uruchom polecenie ponownie.
    • Użyj danych wyjściowych JSON do zwięzłych celów wyjściowych i skryptów. Na przykład azsphere product device-group list --product DW100 --output json.
    • Użyj tabulatora w Windows PowerShell lub powłoki Bash, aby automatycznie ukończyć wpis polecenia.
    • Użyj trybu interakcyjnego , który zapewnia środowisko interakcyjne, aby automatycznie wyświetlać informacje i ułatwia wybieranie poleceń i pod poleceń. Wprowadź tryb interakcyjny za pomocą interakcyjnego polecenia azsphere . Wiersz polecenia zmieni się w azsphere>> , aby wskazać, że teraz są uruchomione polecenia w interakcyjnej powłoce.

Zobacz też