Dokumentacja podstawowych narzędzi usługi Azure Functions

Ten artykuł zawiera dokumentację referencyjną narzędzi Azure Functions Core Tools, która umożliwia tworzenie i wdrażanie projektów usługi Azure Functions oraz zarządzanie nimi z komputera lokalnego. Aby dowiedzieć się więcej na temat korzystania z narzędzi Core Tools, zobacz Praca z narzędziami Azure Functions Core Tools.

Polecenia narzędzi Core Tools są zorganizowane w następujące konteksty, z których każda udostępnia unikatowy zestaw akcji.

Kontekst polecenia	opis
func	Polecenia używane do tworzenia i uruchamiania funkcji na komputerze lokalnym.
func azure	Polecenia do pracy z zasobami platformy Azure, w tym z publikowaniem.
func azurecontainerapps	Wdrażanie konteneryzowanej aplikacji funkcji w usłudze Azure Container Apps.
func durable	Polecenia do pracy z rozszerzeniami Durable Functions.
func extensions	Polecenia do instalowania rozszerzeń i zarządzania nimi.
func kubernetes	Polecenia do pracy z platformami Kubernetes i Azure Functions.
func settings	Polecenia do zarządzania ustawieniami środowiska dla lokalnego hosta usługi Functions.
func templates	Polecenia umożliwiające wyświetlenie listy dostępnych szablonów funkcji.

Przed użyciem poleceń w tym artykule należy zainstalować narzędzia Core Tools.

func init

Tworzy nowy projekt usługi Functions w określonym języku.

func init <PROJECT_FOLDER>

Po podaniu <PROJECT_FOLDER>elementu projekt zostanie utworzony w nowym folderze o tej nazwie. W przeciwnym razie używany jest bieżący folder.

func init obsługuje następujące opcje, które nie obsługują wersji 1.x, chyba że określono inaczej:

Opcja	Opis
--csx	Tworzy funkcje platformy .NET jako skrypt języka C#, który jest zachowaniem w wersji 1.x. Prawidłowe tylko z --worker-runtime dotnet.
--docker	Tworzy plik Dockerfile dla kontenera przy użyciu obrazu podstawowego opartego na wybranym --worker-runtimeobiekcie . Użyj tej opcji, gdy planujesz wdrożyć konteneryzowaną aplikację funkcji.
--docker-only	Dodaje plik Dockerfile do istniejącego projektu. Monituje o środowisko uruchomieniowe procesu roboczego, jeśli nie zostanie określony lub ustawiony w pliku local.settings.json. Użyj tej opcji, jeśli planujesz wdrożyć konteneryzowaną aplikację funkcji i projekt już istnieje.
--force	Zainicjuj projekt nawet wtedy, gdy w projekcie istnieją pliki. To ustawienie zastępuje istniejące pliki o tej samej nazwie. Nie ma to wpływu na inne pliki w folderze projektu.
--language	Inicjuje projekt specyficzny dla języka. Obecnie obsługiwane w przypadku --worker-runtime ustawienia wartości node. Opcje to typescript i javascript. Możesz również użyć polecenia --worker-runtime javascript lub --worker-runtime typescript.
--managed-dependencies	Instaluje zarządzane zależności. Obecnie tylko środowisko uruchomieniowe procesu roboczego programu PowerShell obsługuje tę funkcję.
--model	Ustawia żądany model programowania dla języka docelowego, gdy jest dostępny więcej niż jeden model. Obsługiwane opcje to V1 python V2 i V3 oraz V4 node.js. Aby uzyskać więcej informacji, zobacz przewodnik dla deweloperów języka Python i przewodnik dla deweloperów Node.js, odpowiednio.
--source-control	Określa, czy jest tworzone repozytorium Git. Domyślnie repozytorium nie jest tworzone. Po trueutworzeniu repozytorium.
--worker-runtime	Ustawia środowisko uruchomieniowe języka dla projektu. Obsługiwane wartości to: csharp, , dotnet-isolateddotnet, javascript, (nodeJavaScript), powershell, pythoni typescript. W przypadku języka Java użyj narzędzia Maven. Aby wygenerować projekt niezależny od języka przy użyciu tylko plików projektu, użyj polecenia custom. Jeśli nie zostanie ustawiona, podczas inicjowania zostanie wyświetlony monit o wybranie środowiska uruchomieniowego.
--target-framework	Ustawia platformę docelową projektu aplikacji funkcji. Prawidłowe tylko z --worker-runtime dotnet-isolated. Obsługiwane wartości to: net6.0 (wartość domyślna), net7.0, net8.0i net48 (.NET Framework 4.8).

Uwaga

Jeśli używasz opcji --docker lub --dockerfile , narzędzia Core Tools automatycznie tworzą plik Dockerfile dla funkcji C#, JavaScript, Python i PowerShell. W przypadku funkcji Języka Java należy ręcznie utworzyć plik Dockerfile. Aby uzyskać więcej informacji, zobacz Tworzenie konteneryzowanych aplikacji funkcji.

dzienniki func

Pobiera dzienniki dla funkcji uruchomionych w klastrze Kubernetes.

func logs --platform kubernetes --name <APP_NAME>

Akcja func logs obsługuje następujące opcje:

Opcja	Opis
--platform	Platforma hostingowa dla aplikacji funkcji. Obsługiwane opcje: kubernetes.
--name	Nazwa aplikacji funkcji na platformie Azure.

Aby dowiedzieć się więcej, zobacz Temat Azure Functions on Kubernetes with KEDA (Usługa Azure Functions na platformie Kubernetes z usługą KEDA).

func new

Tworzy nową funkcję w bieżącym projekcie na podstawie szablonu.

func new

Po uruchomieniu func new--template bez opcji zostanie wyświetlony monit o wybranie szablonu. W wersji 1.x musisz również wybrać język.

Akcja func new obsługuje następujące opcje:

Opcja	Opis
--authlevel	Umożliwia ustawienie poziomu autoryzacji dla wyzwalacza HTTP. Obsługiwane wartości to: function, , adminanonymous. Autoryzacja nie jest wymuszana podczas uruchamiania lokalnego. Aby uzyskać więcej informacji, zobacz artykuł powiązania HTTP.
--csx	(Wersja 2.x lub nowsza). Generuje te same szablony skryptów języka C# (csx) używane w wersji 1.x i w portalu.
--language, -l	Język programowania szablonów, taki jak C#, F# lub JavaScript. Ta opcja jest wymagana w wersji 1.x. W wersji 2.x lub nowszej nie używasz tej opcji, ponieważ język jest definiowany przez środowisko uruchomieniowe procesu roboczego.
--name, -n	Nazwa funkcji.
--template, -t	func templates list Użyj polecenia , aby wyświetlić pełną listę dostępnych szablonów dla każdego obsługiwanego języka.

Aby dowiedzieć się więcej, zobacz Tworzenie funkcji.

func run

Tylko wersja 1.x.

Umożliwia bezpośrednie wywoływanie funkcji podobnej do uruchamiania funkcji przy użyciu karty Test w witrynie Azure Portal. Ta akcja jest obsługiwana tylko w wersji 1.x. W przypadku nowszych wersji użyj func start i wywołaj punkt końcowy funkcji bezpośrednio.

func run

Akcja func run obsługuje następujące opcje:

Opcja	Opis
--content	Zawartość śródliniowa przekazana do funkcji.
--debug	Przed uruchomieniem funkcji dołącz debuger do procesu hosta.
--file	Nazwa pliku do użycia jako zawartość.
--no-interactive	Nie wyświetla monitu o dane wejściowe, co jest przydatne w scenariuszach automatyzacji.
--timeout	Czas oczekiwania (w sekundach), aż lokalny host usługi Functions będzie gotowy.

Aby na przykład wywołać funkcję wyzwalaną przez protokół HTTP i przekazać treść zawartości, uruchom następujące polecenie:

func run MyHttpTrigger --content '{\"name\": \"Azure\"}'

start func

Uruchamia hosta lokalnego środowiska uruchomieniowego i ładuje projekt funkcji w bieżącym folderze.

Określone polecenie zależy od wersji środowiska uruchomieniowego.

Wersja 2.x+

func start

func start program obsługuje następujące opcje:

Opcja	Opis
--cert	Ścieżka do pliku pfx zawierającego klucz prywatny. Obsługiwane tylko w programie --useHttps.
--cors	Rozdzielona przecinkami lista źródeł CORS bez spacji.
--cors-credentials	Zezwalaj na żądania uwierzytelnione między źródłami przy użyciu plików cookie i nagłówka uwierzytelniania.
--dotnet-isolated-debug	Gdy jest ustawiona wartość true, wstrzymuje proces roboczy platformy .NET do momentu dołączenia debugera z izolowanego projektu platformy .NET.
--enable-json-output	Emituje dzienniki konsoli jako dane JSON, jeśli to możliwe.
--enableAuth	Włącz potok obsługi pełnego uwierzytelniania z wymaganiami dotyczącymi autoryzacji.
--functions	Rozdzielona spacjami lista funkcji do załadowania.
--language-worker	Argumenty konfigurowania procesu roboczego języka. Na przykład można włączyć debugowanie dla procesu roboczego języka, podając port debugowania i inne wymagane argumenty.
--no-build	Nie kompiluj bieżącego projektu przed uruchomieniem. Tylko w przypadku projektów klas platformy .NET. Wartość domyślna to false.
--password	Hasło lub plik zawierający hasło do pliku pfx. Używane tylko z --cert.
--port	Port lokalny do nasłuchiwania. Wartość domyślna: 7071.
--timeout	Limit czasu dla hosta usługi Functions do uruchomienia w sekundach. Wartość domyślna: 20 sekund.
--useHttps	Powiąż https://localhost:{port} z zamiast z http://localhost:{port}. Domyślnie ta opcja tworzy zaufany certyfikat na komputerze.

Po uruchomieniu projektu można zweryfikować poszczególne punkty końcowe funkcji.

Wersja 1.x

func host start

func start program obsługuje następujące opcje:

Opcja	Opis
--cors	Rozdzielona przecinkami lista źródeł CORS bez spacji.
--port	Port lokalny do nasłuchiwania. Wartość domyślna: 7071.
--pause-on-error	Wstrzymaj więcej danych wejściowych przed zakończeniem procesu. Używane tylko podczas uruchamiania narzędzi Core Tools ze zintegrowanego środowiska projektowego (IDE).
--script-root	Służy do określania ścieżki do katalogu głównego aplikacji funkcji, która ma zostać uruchomiona lub wdrożona. Jest to używane w przypadku skompilowanych projektów, które generują pliki projektu w podfolderze. Na przykład podczas kompilowania projektu biblioteki klas języka C# pliki host.json, local.settings.json i function.json są generowane w podfolderze głównym z ścieżką, na przykład MyProject/bin/Debug/netstandard2.0. W tym przypadku ustaw prefiks jako --script-root MyProject/bin/Debug/netstandard2.0. Jest to katalog główny aplikacji funkcji podczas uruchamiania na platformie Azure.
--timeout	Limit czasu dla hosta usługi Functions do uruchomienia w sekundach. Wartość domyślna: 20 sekund.
--useHttps	Powiąż https://localhost:{port} z zamiast z http://localhost:{port}. Domyślnie ta opcja tworzy zaufany certyfikat na komputerze.

W wersji 1.x można również użyć func run polecenia , aby uruchomić określoną funkcję i przekazać do niej dane testowe.

func azure functionapp fetch-app-settings

Pobiera ustawienia z określonej aplikacji funkcji.

func azure functionapp fetch-app-settings <APP_NAME> 

Aby uzyskać więcej informacji, zobacz Pobieranie ustawień aplikacji.

Ustawienia są pobierane do pliku local.settings.json dla projektu. Wartości na ekranie są maskowane pod kątem zabezpieczeń. Ustawienia można chronić w pliku local.settings.json, włączając szyfrowanie lokalne.

func azure functionapp list-functions

Zwraca listę funkcji w określonej aplikacji funkcji.

func azure functionapp list-functions <APP_NAME>

func azure functionapp logstream

Połączenie lokalnego wiersza polecenia do przesyłania strumieniowego dzienników dla aplikacji funkcji na platformie Azure.

func azure functionapp logstream <APP_NAME>

Domyślny limit czasu połączenia wynosi 2 godziny. Limit czasu można zmienić, dodając ustawienie aplikacji o nazwie SCM_LOGSTREAM_TIMEOUT z wartością limitu czasu w sekundach. Nieobsługiwane jeszcze w przypadku aplikacji systemu Linux w planie Zużycie. W przypadku tych aplikacji użyj --browser opcji , aby wyświetlić dzienniki w portalu.

Akcja deploy obsługuje następujące opcje:

Opcja	Opis
--browser	Otwórz aplikacja systemu Azure Szczegółowe informacje Live Stream dla aplikacji funkcji w domyślnej przeglądarce.

Aby uzyskać więcej informacji, zobacz Włączanie dzienników wykonywania przesyłania strumieniowego w usłudze Azure Functions.

Publikowanie aplikacji funkcji platformy func

Wdraża projekt usługi Functions w istniejącym zasobie aplikacji funkcji na platformie Azure.

func azure functionapp publish <APP_NAME>

Aby uzyskać więcej informacji, zobacz Wdrażanie plików projektu.

Obowiązują następujące opcje publikowania na podstawie wersji:

Wersja 2.x+

Opcja	Opis
--access-token	Umożliwia użycie określonego tokenu dostępu podczas wykonywania uwierzytelnionych akcji platformy Azure.
--access-token-stdin	Odczytuje określony token dostępu ze standardowych danych wejściowych. Użyj tej funkcji podczas odczytywania tokenu bezpośrednio z poprzedniego polecenia, takiego jak az account get-access-token.
--additional-packages	Lista pakietów do zainstalowania podczas kompilowania zależności natywnych. Na przykład: python3-dev libevent-dev.
--build, -b	Wykonuje akcję kompilacji podczas wdrażania w aplikacji funkcji systemu Linux. Akceptuje: remote i local.
--build-native-deps	Pomija generowanie folderu podczas publikowania .wheels aplikacji funkcji języka Python.
--csx	Publikowanie projektu skryptu języka C# (csx).
--dotnet-cli-params	Podczas publikowania skompilowanych funkcji języka C# (csproj) podstawowe narzędzia wywołuje metodę dotnet build --output bin/publish. Wszystkie parametry przekazywane do tego polecenia są dołączane do wiersza polecenia.
--force	Ignoruj weryfikację wstępnego publikowania w niektórych scenariuszach.
--list-ignored-files	Wyświetla listę plików ignorowanych podczas publikowania .funcignore , która jest oparta na pliku.
--list-included-files	Wyświetla listę opublikowanych plików, które są oparte na .funcignore pliku.
--management-url	Ustawia adres URL zarządzania dla chmury. Użyj tej funkcji podczas uruchamiania w suwerennej chmurze.
--no-build	Projekt nie jest kompilowany podczas publikowania. W przypadku języka Python pip install nie jest wykonywane.
--nozip	Wyłącza tryb domyślny Run-From-Package .
--overwrite-settings -y	Pomiń monit o zastąpienie ustawień aplikacji, gdy --publish-local-settings -i jest używany.
--publish-local-settings -i	Ustawienia publikowania w pliku local.settings.json na platformie Azure wyświetlają monit o zastąpienie, jeśli ustawienie już istnieje. Jeśli używasz emulatora magazynu lokalnego, najpierw zmień ustawienie aplikacji na rzeczywiste połączenie magazynu.
--publish-settings-only, -o	Opublikuj tylko ustawienia i pomiń zawartość. Wartość domyślna to monit.
--slot	Opcjonalna nazwa określonego miejsca do opublikowania.
--subscription	Ustawia domyślną subskrypcję do użycia.

Wersja 1.x

Opcja	Opis
--overwrite-settings -y	Pomiń monit o zastąpienie ustawień aplikacji, gdy --publish-local-settings -i jest używany.
--publish-local-settings -i	Ustawienia publikowania w pliku local.settings.json na platformie Azure wyświetlają monit o zastąpienie, jeśli ustawienie już istnieje. Jeśli używasz emulatora usługi Microsoft Azure Storage, najpierw zmień ustawienie aplikacji na rzeczywiste połączenie magazynu.

func azure storage fetch-connection-string

Pobiera parametry połączenia dla określonego konta usługi Azure Storage.

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

Aby uzyskać więcej informacji, zobacz Pobieranie parametry połączenia magazynu.

func azurecontainerapps deploy

Wdraża konteneryzowaną aplikację funkcji w środowisku usługi Azure Container Apps. Zarówno konto magazynu używane przez aplikację funkcji, jak i środowisko muszą już istnieć. Aby uzyskać więcej informacji, zobacz Hostowanie usługi Azure Container Apps w usłudze Azure Functions.

func azurecontainerapps deploy --name <APP_NAME> --environment <ENVIRONMENT_NAME> --storage-account <STORAGE_CONNECTION> --resource-group <RESOURCE_GROUP> --image-name <IMAGE_NAME> --registry-server <REGISTRY_SERVER> --registry-username <USERNAME> --registry-password <PASSWORD>

Mają zastosowanie następujące opcje wdrażania:

Opcja	Opis
--access-token	Umożliwia użycie określonego tokenu dostępu podczas wykonywania uwierzytelnionych akcji platformy Azure.
--access-token-stdin	Odczytuje określony token dostępu ze standardowych danych wejściowych. Użyj tej funkcji podczas odczytywania tokenu bezpośrednio z poprzedniego polecenia, takiego jak az account get-access-token.
--environment	Nazwa istniejącego środowiska usługi Container Apps.
--image-build	Gdy jest ustawiona wartość true, pomija lokalną kompilację platformy Docker.
--image-name	Nazwa obrazu istniejącego kontenera w rejestrze kontenerów. Nazwa obrazu zawiera nazwę tagu.
--location	Region wdrożenia. W idealnym przypadku jest to ten sam region co zasoby środowiska i konta magazynu.
--management-url	Ustawia adres URL zarządzania dla chmury. Użyj tej funkcji podczas uruchamiania w suwerennej chmurze.
--name	Nazwa używana do wdrożenia aplikacji funkcji w środowisku Container Apps. Ta sama nazwa jest również używana podczas zarządzania aplikacją funkcji w portalu. Nazwa powinna być unikatowa w środowisku.
--registry	Po ustawieniu zostanie uruchomiona kompilacja platformy Docker, a obraz zostanie wypchnięty do rejestru ustawionego w pliku --registry. Nie można używać z --image-nameprogramem --registry . W przypadku usługi Docker Hub użyj również polecenia --registry-username.
--registry-password	Hasło lub token używany do pobierania obrazu z rejestru prywatnego.
--registry-username	Nazwa użytkownika używana do pobierania obrazu z rejestru prywatnego.
--resource-group	Grupa zasobów, w której mają zostać utworzone zasoby związane z funkcjami.
--storage-account	Parametry połączenia konta magazynu do użycia przez aplikację funkcji.
--subscription	Ustawia domyślną subskrypcję do użycia.
--worker-runtime	Ustawia język środowiska uruchomieniowego aplikacji funkcji. Ten parametr jest używany tylko z parametrami --image-name i --image-build, w przeciwnym razie język jest określany podczas kompilacji lokalnej. Obsługiwane wartości to: dotnet, , nodedotnetIsolatedpython, , powershelli custom (dla procedur obsługi klientów).

Ważne

Parametry połączenia magazynu i inne poświadczenia usługi są ważnymi wpisami tajnymi. Pamiętaj, aby bezpiecznie przechowywać wszystkie pliki skryptów i func azurecontainerapps deploy nie przechowywać ich w żadnej publicznie dostępnej kontroli źródła.

func deploy

Polecenie func deploy jest przestarzałe. Zamiast tego użyj polecenia func kubernetes deploy.

func durable delete-task-hub

Usuwa wszystkie artefakty magazynu w centrum zadań Durable Functions.

func durable delete-task-hub

Akcja delete-task-hub obsługuje następujące opcje:

Opcja	Opis
--connection-string-setting	Opcjonalna nazwa ustawienia zawierającego parametry połączenia magazynu do użycia.
--task-hub-name	Opcjonalna nazwa rozszerzenia Durable Task Hub do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

func durable get-history

Zwraca historię określonego wystąpienia orkiestracji.

func durable get-history --id <INSTANCE_ID>

Akcja get-history obsługuje następujące opcje:

Opcja	Opis
--id	Określa identyfikator wystąpienia aranżacji (wymagane).
--connection-string-setting	Opcjonalna nazwa ustawienia zawierającego parametry połączenia magazynu do użycia.
--task-hub-name	Opcjonalna nazwa rozszerzenia Durable Task Hub do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

func durable get-instances

Zwraca stan wszystkich wystąpień aranżacji. Obsługuje stronicowanie przy użyciu parametru top .

func durable get-instances

Akcja get-instances obsługuje następujące opcje:

Opcja	Opis
--continuation-token	Opcjonalny token wskazujący konkretną stronę/sekcję żądań do zwrócenia.
--connection-string-setting	Opcjonalna nazwa ustawienia aplikacji, które zawiera parametry połączenia magazynu do użycia.
--created-after	Opcjonalnie pobierz wystąpienia utworzone po tej dacie/godzinie (UTC). Akceptowane są wszystkie formatowane daty/godziny iso 8601.
--created-before	Opcjonalnie pobierz wystąpienia utworzone przed określoną datą/godziną (UTC). Akceptowane są wszystkie formatowane daty/godziny iso 8601.
--runtime-status	Opcjonalnie pobierz wystąpienia, których stan jest zgodny z określonym stanem, w tym running, completedi failed. Można podać jeden lub więcej posągów rozdzielonych spacjami.
--top	Opcjonalnie ogranicz liczbę rekordów zwracanych w danym żądaniu.
--task-hub-name	Opcjonalna nazwa centrum zadań Durable Functions do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

func durable get-runtime-status

Zwraca stan określonego wystąpienia orkiestracji.

func durable get-runtime-status --id <INSTANCE_ID>

Akcja get-runtime-status obsługuje następujące opcje:

Opcja	Opis
--connection-string-setting	Opcjonalna nazwa ustawienia zawierającego parametry połączenia magazynu do użycia.
--id	Określa identyfikator wystąpienia aranżacji (wymagane).
--show-input	Po ustawieniu odpowiedź zawiera dane wejściowe funkcji.
--show-output	Po ustawieniu odpowiedź zawiera historię wykonywania.
--task-hub-name	Opcjonalna nazwa centrum zadań Durable Functions do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

func trwałe przeczyszczanie historii

Przeczyść stan wystąpienia orkiestracji, historię i magazyn obiektów blob na potrzeby aranżacji starszych niż określony próg.

func durable purge-history

Akcja purge-history obsługuje następujące opcje:

Opcja	Opis
--connection-string-setting	Opcjonalna nazwa ustawienia zawierającego parametry połączenia magazynu do użycia.
--created-after	Opcjonalnie usuń historię wystąpień utworzonych po tej dacie/godzinie (UTC). Akceptowane są wszystkie wartości daty/godziny sformatowane w formacie ISO 8601.
--created-before	Opcjonalnie usuń historię wystąpień utworzonych przed tą datą/godziną (UTC). Akceptowane są wszystkie wartości daty/godziny sformatowane w formacie ISO 8601.
--runtime-status	Opcjonalnie usuń historię wystąpień, których stan jest zgodny z określonym stanem, w tym completd, terminated, canceledi failed. Można podać jeden lub więcej posągów rozdzielonych spacjami. Jeśli nie dołączysz --runtime-status, historia wystąpień zostanie usunięta niezależnie od stanu.
--task-hub-name	Opcjonalna nazwa centrum zadań Durable Functions do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

func durable raise-event

Wywołuje zdarzenie do określonego wystąpienia orkiestracji.

func durable raise-event --event-name <EVENT_NAME> --event-data <DATA>

Akcja raise-event obsługuje następujące opcje:

Opcja	Opis
--connection-string-setting	Opcjonalna nazwa ustawienia zawierającego parametry połączenia magazynu do użycia.
--event-data	Dane przekazywane do zdarzenia , wbudowane lub z pliku JSON (wymagane). W przypadku plików prefiks ścieżki do pliku z znakiem ampersand (@), takim jak @path/to/file.json.
--event-name	Nazwa zdarzenia do wywołania (wymagane).
--id	Określa identyfikator wystąpienia aranżacji (wymagane).
--task-hub-name	Opcjonalna nazwa centrum zadań Durable Functions do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

trwałe przewijanie func

Przewija określone wystąpienie orkiestracji.

func durable rewind --id <INSTANCE_ID> --reason <REASON>

Akcja rewind obsługuje następujące opcje:

Opcja	Opis
--connection-string-setting	Opcjonalna nazwa ustawienia zawierającego parametry połączenia magazynu do użycia.
--id	Określa identyfikator wystąpienia aranżacji (wymagane).
--reason	Przyczyna ponownego przewijania aranżacji (wymagane).
--task-hub-name	Opcjonalna nazwa centrum zadań Durable Functions do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

func durable start-new

Uruchamia nowe wystąpienie określonej funkcji orkiestratora.

func durable start-new --id <INSTANCE_ID> --function-name <FUNCTION_NAME> --input <INPUT>

Akcja start-new obsługuje następujące opcje:

Opcja	Opis
--connection-string-setting	Opcjonalna nazwa ustawienia zawierającego parametry połączenia magazynu do użycia.
--function-name	Nazwa funkcji orkiestratora do uruchomienia (wymagane).
--id	Określa identyfikator wystąpienia aranżacji (wymagane).
--input	Dane wejściowe funkcji orkiestratora , wbudowane lub z pliku JSON (wymagane). W przypadku plików prefiks ścieżki do pliku z znakiem ampersand (@), takim jak @path/to/file.json.
--task-hub-name	Opcjonalna nazwa centrum zadań Durable Functions do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

trwałe zakończenie func

Zatrzymuje określone wystąpienie orkiestracji.

func durable terminate --id <INSTANCE_ID> --reason <REASON>

Akcja terminate obsługuje następujące opcje:

Opcja	Opis
--connection-string-setting	Opcjonalna nazwa ustawienia zawierającego parametry połączenia magazynu do użycia.
--id	Określa identyfikator wystąpienia aranżacji (wymagane).
--reason	Przyczyna zatrzymania aranżacji (wymagane).
--task-hub-name	Opcjonalna nazwa centrum zadań Durable Functions do użycia.

Aby dowiedzieć się więcej, zobacz dokumentację rozszerzenia Durable Functions.

Instalowanie rozszerzeń func

Ręcznie instaluje rozszerzenia usługi Functions w projekcie non-.NET lub w projekcie skryptu języka C#.

func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>

Akcja install obsługuje następujące opcje:

Opcja	Opis
--configPath	Ścieżka katalogu zawierającego plik extensions.csproj.
--csx	Obsługuje projekty skryptów języka C# (csx).
--force	Zaktualizuj wersje istniejących rozszerzeń.
--output	Ścieżka wyjściowa rozszerzeń.
--package	Identyfikator określonego pakietu rozszerzenia. Jeśli nie zostanie określony, zostaną zainstalowane wszystkie przywoływane rozszerzenia, tak jak w przypadku func extensions syncpolecenia .
--source	Źródło źródła danych NuGet, jeśli nie jest używane NuGet.org.
--version	Wersja pakietu rozszerzenia.

Poniższy przykład instaluje wersję 5.0.1 rozszerzenia usługi Event Hubs w projekcie lokalnym:

func extensions install --package Microsoft.Azure.WebJobs.Extensions.EventHubs --version 5.0.1

Podczas korzystania z programu func extensions installnależy wziąć pod uwagę następujące kwestie:

• W przypadku skompilowanych projektów języka C# (zarówno w procesie przetwarzania, jak i izolowanego procesu roboczego) należy użyć standardowych metod instalacji pakietów NuGet, takich jak dotnet add package.

• Aby ręcznie zainstalować rozszerzenia przy użyciu narzędzi Core Tools, musisz mieć zainstalowany zestaw SDK platformy .NET 6.0.

• Jeśli to możliwe, należy zamiast tego używać pakietów rozszerzeń. Poniżej przedstawiono kilka powodów, dla których może być konieczne ręczne zainstalowanie rozszerzeń:

  • Musisz uzyskać dostęp do określonej wersji rozszerzenia, która nie jest dostępna w pakiecie.
  • Musisz uzyskać dostęp do rozszerzenia niestandardowego, które nie jest dostępne w pakiecie.
  • Musisz uzyskać dostęp do określonej kombinacji rozszerzeń, które nie są dostępne w jednym pakiecie.

• Przed ręcznym zainstalowaniem rozszerzeń należy najpierw usunąć extensionBundle obiekt z pliku host.json, który definiuje pakiet. Nie jest podejmowana żadna akcja, gdy pakiet rozszerzenia jest już ustawiony w pliku host.json.

• Po pierwszym jawnym zainstalowaniu rozszerzenia plik projektu .NET o nazwie extensions.csproj jest dodawany do katalogu głównego projektu aplikacji. Ten plik definiuje zestaw pakietów NuGet wymaganych przez funkcje. Chociaż można pracować z odwołaniami pakietu NuGet w tym pliku, narzędzia Core Tools umożliwiają instalowanie rozszerzeń bez konieczności ręcznego edytowania tego pliku projektu języka C#.

Synchronizacja rozszerzeń func

Instaluje wszystkie rozszerzenia dodane do aplikacji funkcji.

Akcja sync obsługuje następujące opcje:

Opcja	Opis
--configPath	Ścieżka katalogu zawierającego plik extensions.csproj.
--csx	Obsługuje projekty skryptów języka C# (csx).
--output	Ścieżka wyjściowa rozszerzeń.

Ponownie generuje brakujący plik extensions.csproj. Nie jest podejmowana żadna akcja, gdy pakiet rozszerzenia jest zdefiniowany w pliku host.json.

func kubernetes deploy

Wdraża projekt usługi Functions jako niestandardowy kontener platformy Docker w klastrze Kubernetes.

func kubernetes deploy 

To polecenie kompiluje projekt jako kontener niestandardowy i publikuje go w klastrze Kubernetes. Kontenery niestandardowe muszą mieć plik Dockerfile. Aby utworzyć aplikację przy użyciu pliku Dockerfile, użyj --dockerfile opcji z poleceniem func init .

Dostępne są następujące opcje wdrażania platformy Kubernetes:

Opcja	Opis
--dry-run	Opcjonalnie wyświetla szablon wdrożenia bez wykonywania.
--config-map-name	Opcjonalna nazwa istniejącej mapy konfiguracji z ustawieniami aplikacji funkcji do użycia we wdrożeniu. Wymaga .--use-config-map Domyślnym zachowaniem jest utworzenie ustawień na Values podstawie obiektu w pliku local.settings.json.
--cooldown-period	Okres ochładzania (w sekundach) po tym, jak wszystkie wyzwalacze nie są już aktywne, zanim wdrożenie zostanie przeskalowane z powrotem do zera z wartością domyślną 300 s.
--ignore-errors	Kontynuuje wdrażanie po wystąpieniu błędu przez zasób. Domyślne zachowanie polega na zatrzymaniu działania po błędzie.
--image-name	Nazwa obrazu, który ma być używany do wdrożenia zasobnika i z którego mają być odczytywane funkcje.
--keda-version	Ustawia wersję KEDA do zainstalowania. Prawidłowe opcje to: v1 i v2 (ustawienie domyślne).
--keys-secret-name	Nazwa kolekcji kluczy tajnych kubernetes do użycia do przechowywania kluczy dostępu funkcji.
--max-replicas	Ustawia maksymalną liczbę replik, dla których skalowanie narzędzia Horizontal Pod Autoscaler (HPA).
--min-replicas	Ustawia minimalną liczbę replik poniżej, do której nie będzie skalowana funkcja HPA.
--mount-funckeys-as-containervolume	Instaluje klucze dostępu funkcji jako wolumin kontenera.
--name	Nazwa używana do wdrożenia i innych artefaktów na platformie Kubernetes.
--namespace	Ustawia przestrzeń nazw Platformy Kubernetes, do której ma zostać wdrożona wartość domyślna, domyślnie w domyślnej przestrzeni nazw.
--no-docker	Funkcje są odczytywane z bieżącego katalogu zamiast z obrazu. Wymaga instalowania systemu plików obrazu.
--registry	Po ustawieniu zostanie uruchomiona kompilacja platformy Docker, a obraz zostanie wypchnięty do rejestru tej nazwy. Nie można używać z --image-nameprogramem --registry . W przypadku platformy Docker użyj swojej nazwy użytkownika.
--polling-interval	Interwał sondowania (w sekundach) do sprawdzania wyzwalaczy innych niż HTTP z wartością domyślną 30s.
--pull-secret	Wpis tajny używany do uzyskiwania dostępu do poświadczeń rejestru prywatnego.
--secret-name	Nazwa istniejącej kolekcji wpisów tajnych Kubernetes, która zawiera ustawienia aplikacji funkcji do użycia we wdrożeniu. Domyślnym zachowaniem jest utworzenie ustawień na Values podstawie obiektu w pliku local.settings.json.
--show-service-fqdn	Wyświetla adresy URL wyzwalaczy HTTP z nazwą FQDN platformy Kubernetes zamiast domyślnego zachowania przy użyciu adresu IP.
--service-type	Ustawia typ usługi Kubernetes Service. Obsługiwane wartości to: ClusterIP, NodePorti LoadBalancer (ustawienie domyślne).
--use-config-map	ConfigMap Użyj obiektu (wersja 1) zamiast Secret obiektu (wersja 1), aby skonfigurować ustawienia aplikacji funkcji. Nazwa mapy jest ustawiona przy użyciu polecenia --config-map-name.

Narzędzia Core Tools używają lokalnego interfejsu wiersza polecenia platformy Docker do kompilowania i publikowania obrazu. Upewnij się, że platforma Docker jest już zainstalowana lokalnie. Uruchom polecenie , docker login aby nawiązać połączenie z kontem.

Aby dowiedzieć się więcej, zobacz Wdrażanie aplikacji funkcji na platformie Kubernetes.

Instalacja rozwiązania func kubernetes

Instaluje usługę KEDA w klastrze Kubernetes.

func kubernetes install 

Instaluje narzędzie KEDA do klastra zdefiniowanego w pliku konfiguracji kubectl.

Akcja install obsługuje następujące opcje:

Opcja	Opis
--dry-run	Wyświetla szablon wdrożenia bez wykonywania.
--keda-version	Ustawia wersję KEDA do zainstalowania. Prawidłowe opcje to: v1 i v2 (ustawienie domyślne).
--namespace	Obsługuje instalację w określonej przestrzeni nazw platformy Kubernetes. Jeśli nie zostanie ustawiona, zostanie użyta domyślna przestrzeń nazw.

Aby dowiedzieć się więcej, zobacz Managing KEDA and functions in Kubernetes (Zarządzanie funkcją KEDA i funkcjami na platformie Kubernetes).

func kubernetes remove

Usuwa KEDA z klastra Kubernetes zdefiniowanego w pliku konfiguracji kubectl.

func kubernetes remove 

Usuwa KEDA z klastra zdefiniowanego w pliku konfiguracji kubectl.

Akcja remove obsługuje następujące opcje:

Opcja	Opis
--namespace	Obsługuje odinstalowywanie z określonej przestrzeni nazw platformy Kubernetes. Jeśli nie zostanie ustawiona, zostanie użyta domyślna przestrzeń nazw.

Aby dowiedzieć się więcej, zobacz Odinstalowywanie KEDA z platformy Kubernetes.

Dodaj ustawienia func

Dodaje nowe ustawienie do Values kolekcji w pliku local.settings.json.

func settings add <SETTING_NAME> <VALUE>

Zastąp <SETTING_NAME> ciąg nazwą ustawienia aplikacji i <VALUE> wartością ustawienia.

Akcja add obsługuje następującą opcję:

Opcja	Opis
--connectionString	Dodaje parę name-value do ConnectionStrings kolekcji zamiast Values kolekcji. Kolekcji należy używać ConnectionStrings tylko wtedy, gdy są wymagane przez niektóre struktury. Aby dowiedzieć się więcej, zobacz plik local.settings.json.

Odszyfrowywanie ustawień func

Odszyfrowuje wcześniej zaszyfrowane wartości w Values kolekcji w pliku local.settings.json.

func settings decrypt

Połączenie wartości ciągów w ConnectionStrings kolekcji są również odszyfrowywane. W pliku local.settings.json IsEncrypted jest również ustawiona wartość false. Szyfruj ustawienia lokalne, aby zmniejszyć ryzyko wycieku cennych informacji z pliku local.settings.json. Na platformie Azure ustawienia aplikacji są zawsze przechowywane jako zaszyfrowane.

Usuwanie ustawień func

Usuwa istniejące ustawienie z Values kolekcji w pliku local.settings.json.

func settings delete <SETTING_NAME>

Zastąp <SETTING_NAME> ciąg nazwą ustawienia aplikacji i <VALUE> wartością ustawienia.

Akcja delete obsługuje następującą opcję:

Opcja	Opis
--connectionString	Usuwa parę name-value z ConnectionStrings kolekcji zamiast z Values kolekcji.

Szyfrowanie ustawień func

Szyfruje wartości poszczególnych elementów w Values kolekcji w pliku local.settings.json.

func settings encrypt

Połączenie wartości ciągów ConnectionStrings w kolekcji są również szyfrowane. W pliku local.settings.json IsEncrypted jest również ustawiona wartość true, która określa, że lokalne środowisko uruchomieniowe odszyfrowuje ustawienia przed ich użyciem. Szyfruj ustawienia lokalne, aby zmniejszyć ryzyko wycieku cennych informacji z pliku local.settings.json. Na platformie Azure ustawienia aplikacji są zawsze przechowywane jako zaszyfrowane.

Lista ustawień funkcji func

Zwraca listę ustawień w Values kolekcji w pliku local.settings.json.

func settings list

ciągi Połączenie ion z ConnectionStrings kolekcji również są danymi wyjściowymi. Domyślnie wartości są maskowane pod kątem zabezpieczeń. Możesz użyć --showValue opcji , aby wyświetlić rzeczywistą wartość.

Akcja list obsługuje następującą opcję:

Opcja	Opis
--showValue	Pokazuje rzeczywiste niezamaskowane wartości w danych wyjściowych.

Lista szablonów func

Wyświetla listę dostępnych szablonów funkcji (wyzwalacza).

Akcja list obsługuje następującą opcję:

Opcja	Opis
--language	Język, dla którego mają być filtrowane zwrócone szablony. Wartość domyślna to zwracanie wszystkich języków.