Szybki start: tworzenie przepływów pracy i zarządzanie nimi za pomocą interfejsu wiersza polecenia platformy Azure w usłudze Azure Logic Apps

Artykuł
01/04/2024

Dotyczy: Azure Logic Apps (Zużycie)

W tym przewodniku Szybki start pokazano, jak tworzyć zautomatyzowane przepływy pracy uruchamiane w usłudze Azure Logic Apps i zarządzać nimi przy użyciu rozszerzenia usługi Logic Apps interfejsu wiersza polecenia platformy Azure (az logic). W wierszu polecenia możesz utworzyć aplikację logiki Zużycie w wielodostępnej usłudze Azure Logic Apps przy użyciu pliku JSON definicji przepływu pracy aplikacji logiki. Następnie możesz zarządzać aplikacją logiki, uruchamiając operacje, takie jak list, show (get), updatei delete z wiersza polecenia.

Ostrzeżenie

Rozszerzenie usługi Logic Apps interfejsu wiersza polecenia platformy Azure jest obecnie eksperymentalne i nie jest objęte pomocą techniczną. Użyj tego rozszerzenia interfejsu wiersza polecenia z ostrożnością, zwłaszcza jeśli zdecydujesz się używać rozszerzenia w środowiskach produkcyjnych.

Ten przewodnik Szybki start dotyczy obecnie tylko przepływów pracy aplikacji logiki zużycie, które są uruchamiane w wielodostępnych usługach Azure Logic Apps. Interfejs wiersza polecenia platformy Azure jest obecnie niedostępny dla przepływów pracy aplikacji logiki w warstwie Standardowa, które działają w usłudze Azure Logic Apps z jedną dzierżawą. Aby uzyskać więcej informacji, zapoznaj się z tematem Resource type and host differences in Azure Logic Apps (Różnice typów zasobów i hostów w usłudze Azure Logic Apps).

Jeśli dopiero zaczynasz korzystać z usługi Azure Logic Apps, dowiedz się, jak utworzyć pierwszy przepływ pracy aplikacji logiki Zużycie za pośrednictwem witryny Azure Portal, w programie Visual Studio i programie Visual Studio Code.

Wymagania wstępne

Konto platformy Azure z aktywną subskrypcją. Jeśli nie masz subskrypcji platformy Azure, utwórz bezpłatne konto.
Interfejs wiersza polecenia platformy Azure zainstalowany na komputerze lokalnym.
Rozszerzenie interfejsu wiersza polecenia usługi Azure Logic Apps zainstalowane na komputerze. Aby zainstalować to rozszerzenie, użyj tego polecenia: az extension add --name logic
Grupa zasobów platformy Azure, w której ma zostać utworzona aplikacja logiki.

Sprawdzanie wymagań wstępnych

Przed rozpoczęciem sprawdź poprawność środowiska:

Zaloguj się do witryny Azure Portal i sprawdź, czy subskrypcja jest aktywna, uruchamiając polecenie az login.
Sprawdź wersję interfejsu wiersza polecenia platformy Azure w terminalu lub oknie polecenia, uruchamiając polecenie az --version. Aby uzyskać najnowszą wersję, zobacz najnowsze informacje o wersji.

Jeśli nie masz najnowszej wersji, zaktualizuj instalację, postępując zgodnie z przewodnikiem instalacji systemu operacyjnego lub platformy.

Przykład — tworzenie grupy zasobów

Jeśli nie masz jeszcze grupy zasobów dla aplikacji logiki, utwórz grupę za pomocą polecenia az group create. Na przykład następujące polecenie tworzy grupę zasobów o nazwie testResourceGroup w lokalizacji westus.

az group create --name testResourceGroup --location westus

Dane wyjściowe są wyświetlane jako provisioningState Succeeded po pomyślnym utworzeniu grupy zasobów:

<...>
  "name": "testResourceGroup",
  "properties": {
    "provisioningState": "Succeeded"
  },
<...>

Definicja przepływu pracy

Przed utworzeniem nowej aplikacji logiki lub zaktualizowaniu istniejącej aplikacji logiki przy użyciu interfejsu wiersza polecenia platformy Azure potrzebna jest definicja przepływu pracy dla aplikacji logiki. W witrynie Azure Portal możesz wyświetlić podstawową definicję przepływu pracy aplikacji logiki w formacie JSON, przełączając się z widoku Projektant na Widok kodu.

Po uruchomieniu poleceń w celu utworzenia lub zaktualizowania aplikacji logiki definicja przepływu pracy zostanie przekazana jako wymagany parametr (--definition). Musisz utworzyć definicję przepływu pracy jako plik JSON, który jest zgodny ze schematem języka definicji przepływu pracy.

Tworzenie aplikacji logiki na podstawie interfejsu wiersza polecenia

Aby utworzyć przepływ pracy aplikacji logiki z poziomu interfejsu wiersza polecenia platformy Azure, użyj polecenia az logic workflow create z plikiem JSON definicji.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Polecenie musi zawierać następujące wymagane parametry:

Parametr	Wartość	Opis
Definicja przepływu pracy	`--definition`	Plik JSON z definicją przepływu pracy aplikacji logiki.
Lokalizacja	`--location -l`	Region platformy Azure, w którym znajduje się aplikacja logiki.
Nazwisko	`--name -n`	Nazwa aplikacji logiki. Nazwa może zawierać tylko litery, cyfry, łączniki (`-`), podkreślenia (`_`), nawiasy (`()`) i kropki (`.`). Nazwa musi być również unikatowa w różnych regionach.
Nazwa grupy zasobów	`--resource-group -g`	Grupa zasobów platformy Azure, w której chcesz utworzyć aplikację logiki. Utwórz grupę zasobów przed rozpoczęciem, jeśli nie masz jeszcze grupy zasobów dla aplikacji logiki.

Możesz również uwzględnić dodatkowe parametry opcjonalne , aby skonfigurować mechanizmy kontroli dostępu aplikacji logiki, punkty końcowe, konto integracji, stan i tagi zasobów.

Przykład — tworzenie aplikacji logiki

W tym przykładzie przepływ pracy o nazwie testLogicApp jest tworzony w grupie testResourceGroup zasobów w lokalizacji westus. Plik testDefinition.json JSON zawiera definicję przepływu pracy.

az logic workflow create --resource-group "testResourceGroup" --location "westus" --name "testLogicApp" --definition "testDefinition.json"

Po pomyślnym utworzeniu przepływu pracy interfejs wiersza polecenia wyświetla kod JSON nowej definicji przepływu pracy. Jeśli tworzenie przepływu pracy zakończy się niepowodzeniem, zobacz listę możliwych błędów.

Aktualizowanie aplikacji logiki za pomocą interfejsu wiersza polecenia

Aby zaktualizować przepływ pracy aplikacji logiki z poziomu interfejsu wiersza polecenia platformy Azure, użyj polecenia az logic workflow create.

Polecenie musi zawierać te same wymagane parametry co podczas tworzenia aplikacji logiki. Możesz również dodać te same parametry opcjonalne co podczas tworzenia aplikacji logiki.

az logic workflow create --definition
                         --location
                         --name
                         --resource-group
                         [--access-control]
                         [--endpoints-configuration]
                         [--integration-account]
                         [--integration-service-environment]
                         [--state {Completed, Deleted, Disabled, Enabled, NotSpecified, Suspended}]
                         [--tags]

Przykład — aktualizowanie aplikacji logiki

W tym przykładzie przykładowy przepływ pracy utworzony w poprzedniej sekcji został zaktualizowany w celu użycia innego pliku definicji JSON, newTestDefinition.jsoni dodania dwóch tagów testTag1 zasobów oraz testTag2 wartości opisu.

az logic workflow create --resource-group "testResourceGroup" --location "westus" --name "testLogicApp" --definition "newTestDefinition.json" --tags "testTag1=testTagValue1" "testTag2=testTagValue"

Po pomyślnym zaktualizowaniu przepływu pracy interfejs wiersza polecenia wyświetla zaktualizowaną definicję przepływu pracy aplikacji logiki. Jeśli aktualizacja nie powiedzie się, zobacz listę możliwych błędów.

Usuwanie aplikacji logiki z interfejsu wiersza polecenia

Aby usunąć przepływ pracy aplikacji logiki z interfejsu wiersza polecenia platformy Azure, użyj polecenia az logic workflow delete.

Polecenie musi zawierać następujące wymagane parametry:

Parametr	Wartość	Opis
Nazwa/nazwisko	`--name -n`	Nazwa aplikacji logiki.
Nazwa grupy zasobów	`-resource-group -g`	Grupa zasobów, w której znajduje się aplikacja logiki.

Możesz również dołączyć opcjonalny parametr , aby pominąć monity o potwierdzenie, --yes -y.

az logic workflow delete --name
                         --resource-group
                         [--yes]

Następnie interfejs wiersza polecenia wyświetli monit o potwierdzenie usunięcia aplikacji logiki. Możesz pominąć monit o potwierdzenie, używając opcjonalnego parametru --yes -y za pomocą polecenia .

Are you sure you want to perform this operation? (y/n):

Aby potwierdzić usunięcie aplikacji logiki, wyświetl listę aplikacji logiki w interfejsie wiersza polecenia lub wyświetl aplikacje logiki w witrynie Azure Portal.

Przykład — usuwanie aplikacji logiki

W tym przykładzie przykładowy przepływ pracy utworzony w poprzedniej sekcji zostanie usunięty.

az logic workflow delete --resource-group "testResourceGroup" --name "testLogicApp"

Po otrzymaniu odpowiedzi na monit o potwierdzenie za pomocą ypolecenia aplikacja logiki zostanie usunięta.

Zagadnienia — usuwanie aplikacji logiki

Usunięcie aplikacji logiki wpływa na wystąpienia przepływu pracy w następujący sposób:

Usługa Azure Logic Apps pozwala anulować wszystkie przebiegi w toku i oczekujące.

Nawet w przypadku dużego woluminu lub listy prac większość przebiegów jest anulowana przed zakończeniem lub rozpoczęciem. Jednak ukończenie procesu anulowania może zająć trochę czasu. W międzyczasie niektóre uruchomienia mogą zostać pobrane do wykonania, gdy środowisko uruchomieniowe działa przez proces anulowania.
Usługa Azure Logic Apps nie tworzy ani nie uruchamia nowych wystąpień przepływu pracy.
Jeśli usuniesz przepływ pracy, a następnie ponownie utworzysz ten sam przepływ pracy, utworzony ponownie przepływ pracy nie będzie miał tych samych metadanych co usunięty przepływ pracy. Musisz ponownie zapisać dowolny przepływ pracy, który nazwał usunięty przepływ pracy. W ten sposób obiekt wywołujący pobiera poprawne informacje dotyczące ponownie tworzonego przepływu pracy. W przeciwnym razie wywołania ponownego utworzenia przepływu pracy kończą się niepowodzeniem z powodu błędu Unauthorized . To zachowanie dotyczy również przepływów pracy, które używają artefaktów na kontach integracji i przepływach pracy wywołujących funkcje platformy Azure.

Wyświetlanie aplikacji logiki w interfejsie wiersza polecenia

Aby uzyskać określony przepływ pracy aplikacji logiki, użyj polecenia az logic workflow show.

az logic workflow show --name
                       --resource-group

Polecenie musi zawierać następujące wymagane parametry

Parametr	Wartość	Opis
Nazwa/nazwisko	`--name -n`	Nazwa aplikacji logiki.
Nazwa grupy zasobów	`--resource-group -g`	Nazwa grupy zasobów, w której znajduje się aplikacja logiki.

Przykład — pobieranie aplikacji logiki

W tym przykładzie aplikacja testLogicApp logiki w grupie testResourceGroup zasobów jest zwracana z pełnymi dziennikami na potrzeby debugowania.

az logic workflow show --resource-group "testResourceGroup" --name "testLogicApp" --debug

Wyświetlanie listy aplikacji logiki w interfejsie wiersza polecenia

Aby wyświetlić listę aplikacji logiki według subskrypcji, użyj polecenia az logic workflow list. To polecenie zwraca kod JSON dla przepływów pracy aplikacji logiki.

Wyniki można filtrować według następujących parametrów opcjonalnych:

Parametr	Wartość	Opis
Nazwa grupy zasobów	`--resource-group -g`	Nazwa grupy zasobów, według której chcesz filtrować wyniki.
Liczba towarów	`--top`	Liczba elementów uwzględnionych w wynikach.
Filtr	`--filter`	Typ filtru używanego na liście. Możesz filtrować według stanu (), wyzwalacza (`StateTrigger`) i identyfikatora przywoływnego zasobu (`ReferencedResourceId`).

az logic workflow list [--filter]
                       [--resource-group]
                       [--top]

Przykład — wyświetlanie listy aplikacji logiki

W tym przykładzie wszystkie włączone przepływy pracy w grupie testResourceGroup zasobów są zwracane w formacie tabeli ASCII.

az logic workflow list --resource-group "testResourceGroup" --filter "(State eq 'Enabled')" --output "table"

Błędy

Poniższy błąd wskazuje, że rozszerzenie interfejsu wiersza polecenia usługi Azure Logic Apps nie jest zainstalowane. Wykonaj kroki opisane w wymaganiach wstępnych, aby zainstalować rozszerzenie usługi Logic Apps na komputerze.

az: 'logic' is not in the 'az' command group. See 'az --help'. If the command is from an extension, please make sure the corresponding extension is installed. To learn more about extensions, please visit https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview

Poniższy błąd może wskazywać, że ścieżka pliku do przekazywania definicji przepływu pracy jest niepoprawna.

Expecting value: line 1 column 1 (char 0)

Parametry globalne

Możesz użyć następujących opcjonalnych parametrów globalnego interfejsu wiersza polecenia platformy Azure za pomocą poleceń az logic :

Parametr	Wartość	Opis
Format wyjściowy	`--output -o`	Zmień format danych wyjściowych z domyślnego formatu JSON.
Pokaż tylko błędy	`--only-show-errors`	Pomijanie ostrzeżeń i pokazywanie tylko błędów.
Pełne informacje	`--verbose`	Pokaż pełne dzienniki.
Debugowanie	`--debug`	Pokazuje wszystkie dzienniki debugowania.
Komunikat pomocy	`--help -h`	Pokaż okno dialogowe Pomocy.
Query	`--query`	Ustaw ciąg zapytania JMESPath dla danych wyjściowych JSON.

Następne kroki

Aby uzyskać więcej informacji na temat interfejsu wiersza polecenia platformy Azure, zobacz dokumentację interfejsu wiersza polecenia platformy Azure.

Dodatkowe przykłady skryptów interfejsu wiersza polecenia usługi Azure Logic Apps można znaleźć w przeglądarce przykładów kodu firmy Microsoft.

Następnie możesz utworzyć przykładową logikę aplikacji za pomocą interfejsu wiersza polecenia platformy Azure przy użyciu przykładowego skryptu i definicji przepływu pracy.

Tworzenie aplikacji logiki przy użyciu przykładowego skryptu.

Udostępnij za pośrednictwem