Notatka
Dostęp do tej strony wymaga autoryzacji. Może spróbować zalogować się lub zmienić katalogi.
Dostęp do tej strony wymaga autoryzacji. Możesz spróbować zmienić katalogi.
Ten artykuł zawiera dokumentację referencyjną Azure Functions Core Tools, która umożliwia opracowywanie i wdrażanie projektów Azure Functions z komputera lokalnego oraz zarządzanie nimi. Aby dowiedzieć się więcej na temat korzystania z narzędzi Core Tools, zobacz
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 służące do tworzenia i uruchamiania funkcji na komputerze lokalnym. |
func azure |
Polecenia do pracy z zasobami Azure, w tym z publikowaniem. |
func azurecontainerapps |
Polecenia umożliwiające wdrożenie konteneryzowanej aplikacji funkcji w celu Azure Container Apps. |
func bundles |
Polecenia do zarządzania pakietami rozszerzeń. |
func durable |
Polecenia do pracy z Durable Functions. |
func extensions |
Polecenia do instalowania rozszerzeń i zarządzania nimi. |
func kubernetes |
Polecenia do pracy z platformą 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 zainstaluj 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.
Polecenie func init obsługuje te opcje, które nie są obsługiwane w wersji 1.x, chyba że określono inaczej:
| Opcja | opis |
|---|---|
--bundles-channel, -c |
Kanał wydania pakietu rozszerzeń. Obsługiwane wartości to: GA (wartość domyślna), Previewi Experimental. Dotyczy tylko projektów innych niż .NET. |
--configuration-profile |
Inicjuje projekt z profilem konfiguracji hosta. Opcja --configuration-profile jest obecnie dostępna w wersji zapoznawczej. Aby uzyskać więcej informacji, zobacz Profile konfiguracji. |
--csx |
Tworzy .NET działa 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 na podstawie wybranego --worker-runtimeelementu . 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 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, -l |
Inicjuje projekt specyficzny dla języka. Obecnie obsługiwane, gdy --worker-runtime jest ustawiona wartość 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, -m |
Ustawia model programowania dla języka docelowego, gdy jest dostępny więcej niż jeden model. Obsługiwane opcje to V1 i V2 dla Python oraz V3 i V4 dla Node.js. Aby uzyskać więcej informacji, zobacz przewodnik dewelopera Python oraz przewodnik dla deweloperów Node.js. |
--no-bundle |
Nie konfiguruj pakietu rozszerzeń w programiehost.json. Dotyczy tylko projektów innych niż .NET. |
--no-docs |
Pomija generowanie plików dokumentacji "Wprowadzenie". Dotyczy projektów Python. |
--skip-npm-install |
Po utworzeniu projektu pomiń uruchamianie npm install . Dotyczy projektów Node.js. |
--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, , dotnetdotnet-isolated, javascript, ( node JavaScript), powershell, pythoni typescript. W przypadku Java użyj 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: net10.0 (wersja zapoznawcza), net9.0, net8.0 (ustawienie domyślne), net6.0 i net48 (.NET Framework 4.8). |
Uwaga
Jeśli używasz opcji --docker lub --docker-only, narzędzia Core Tools automatycznie tworzą plik Dockerfile dla języków C#, JavaScript, Python i PowerShell. W przypadku funkcji Java należy ręcznie utworzyć plik Dockerfile. Aby uzyskać więcej informacji, zobacz Tworzenie konteneryzowanych aplikacji funkcji.
Profile konfiguracji
Ważne
Obsługa profilów konfiguracji jest obecnie dostępna w wersji zapoznawczej.
W przypadku korzystania z --configuration-profile tej opcji tworzony jest wstępnie zdefiniowany zestaw konfiguracji i ustawień projektu. Po określeniu profilu konfiguracji inicjowanie może pominąć wszystkie inne kroki inicjowania.
| Wartość profilu | opis | Określone akcje |
|---|---|---|
mcp-custom-handler |
Tworzy projekt, który używa niestandardowych procedur obsługi do hostowania serwera MCP (Model Context Protocol), z którymi mogą nawiązywać połączenia agenci sztucznej inteligencji i inni klienci MCP. | • Konfiguruje "configurationProfile": "mcp-custom-handler" element w pliku host.json z określonymi niestandardowymi ustawieniami programu obsługi.• Ustawia MCP_EXTENSION_ENABLED wartość true w local.settings.json. |
func logs
Pobiera dzienniki dla funkcji uruchomionych w klastrze Kubernetes.
func logs --platform kubernetes --name <APP_NAME>
Polecenie func logs obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--platform |
Platforma hostingowa dla aplikacji funkcji. Prawidłowe opcje: kubernetes. |
--name |
Nazwa aplikacji funkcji w Azure. |
Aby uzyskać więcej informacji, zobacz Azure Functions na platformie Kubernetes z językiem KEDA.
func new
Tworzy nową funkcję w bieżącym projekcie na podstawie szablonu.
func new
Po uruchomieniu func new bez opcji --template zostanie wyświetlony monit o wybranie szablonu. W wersji 1.x należy również wybrać język.
Polecenie func new obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--authlevel, -a |
Ustawia poziom autoryzacji dla wyzwalacza HTTP. Obsługiwane wartości to: function, , anonymousadmin. Autoryzacja nie jest wymuszana podczas uruchamiania lokalnego. Aby uzyskać więcej informacji, zobacz Poziom autoryzacji. |
--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. |
--file, -f |
Plik docelowy nowej funkcji. W przypadku projektów Python w wersji 2 określa plik do dodania funkcji (domyślnie function_app.py). W przypadku projektów Node.js w wersji 4 określa nazwę pliku wyjściowego w folderze src/functions . Nie dotyczy skompilowanych projektów .NET. |
--language, -l |
Język programowania szablonów, taki jak C# lub JavaScript. Ta opcja jest wymagana w wersji 1.x. W wersji 2.x lub nowszej nie używaj 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 uzyskać więcej informacji, zobacz Tworzenie funkcji.
func pack
Tworzy pakiet wdrożeniowy zawierający kod projektu w stanie możliwy do uruchomienia. Użyj tej metody, jeśli musisz ręcznie utworzyć pakiet wdrożeniowy dla aplikacji na komputerze lokalnym poza poleceniem func azure functionapp publish . Domyślnie func pack kompiluje projekt w razie potrzeby.
func pack [<FOLDER_PATH>]
Domyślnie func pack pakietuje bieżący katalog, a plik wyjściowy .zip ma taką samą nazwę jak folder główny projektu. Uruchom polecenie func pack w katalogu zawierającym plik projektu host.json . Jeśli musisz uruchomić func pack polecenie w innym katalogu, ustaw <FOLDER_PATH> jako ścieżkę do katalogu głównego projektu, na przykład func pack ./myprojectroot. Jeśli określony plik .zip już istnieje, najpierw zostanie usunięty, a następnie zastąpiony zaktualizowaną wersją.
Polecenie func pack obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--output, -o |
Ustawia ścieżkę do lokalizacji, w której jest tworzony plik pakietu .zip wdrożenia. |
--no-build |
Project nie jest zbudowany przed pakowaniem. W przypadku aplikacji języka C# użyj tylko wtedy, gdy pliki binarne są już generowane. W przypadku Node.js aplikacji zarówno, jak npm install i npm run build są pomijane. |
--skip-install |
Pomija działanie npm install podczas pakowania Node.jsopartej na aplikacji funkcji. Służy do unikania zastępowania niestandardowych modułów npm. |
--build-native-deps |
Instaluje Python zależności lokalnie przy użyciu obrazu zgodnego ze środowiskiem używanym w Azure. Po włączeniu narzędzia Core Tools uruchamia kontener platformy Docker, kompiluje aplikację wewnątrz tego kontenera i tworzy plik .zip ze wszystkimi zależnościami przywróconymi w programie .python_packages. Użyj tej opcji podczas uruchamiania w Windows, aby uniknąć potencjalnych problemów z biblioteką podczas wdrażania w systemie Linux w Azure. |
func run
Tylko wersja 1.x.
Umożliwia bezpośrednie wywoływanie funkcji podobnej do uruchamiania funkcji przy użyciu Test w portalu Azure. 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
Polecenie 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\"}'
func start
Uruchamia hosta lokalnego środowiska uruchomieniowego i ładuje projekt funkcji w bieżącym folderze.
Określone polecenie zależy od wersji środowiska uruchomieniowego.
func start
Polecenie func start 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 |
Umożliwia uwierzytelnianie między źródłami żądań korzystających z plików cookie i nagłówka uwierzytelniania. |
--dotnet-isolated-debug |
Po ustawieniu wartości true wstrzymuje proces roboczy .NET do momentu dołączenia debugera z .NET debugowanego projektu. |
--enable-json-output |
Emituje dzienniki konsoli w formacie JSON, jeśli to możliwe. |
--enableAuth |
Umożliwia pełną obsługę potoku uwierzytelniania z wymaganiami autoryzacji. |
--functions |
Rozdzielona spacjami lista funkcji do załadowania. |
--json-output-file |
W przypadku podania ścieżki do pliku użytego do zapisania danych wyjściowych przy użyciu polecenia --enable-json-output. |
--language-worker |
Argumenty konfigurowania procesu roboczego języka. Można na przykład włączyć debugowanie dla procesu roboczego języka, podając port debug i inne wymagane argumenty. |
--no-build |
Nie kompiluj bieżącego projektu przed uruchomieniem. Tylko w przypadku projektów klasy .NET. Wartość domyślna to false. |
--password |
Hasło lub plik zawierający hasło do pliku pfx. Używane tylko z --cert. |
--port, -p |
Port lokalny do nasłuchiwania. Wartość domyślna: 7071. |
--runtime |
Ustawia wersję hosta do uruchomienia. Dozwolone wartości to: inproc6, inproc8i default (które uruchamia hosta poza procesem). |
--timeout, -t |
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. |
--user-log-level |
Ustawia minimalny poziom dziennika dla dzienników użytkowników. Prawidłowe wartości to: Trace, , Debug, InformationWarning, Error, Critical, i None. To ustawienie nie ma wpływu na dzienniki systemowe. W przypadku .NET izolowanych projektów ustaw również minimalny poziom w Program.cs przy użyciu builder.Logging.SetMinimumLevel(LogLevel.Debug), aby ta opcja została włączona. |
Po uruchomieniu projektu zweryfikuj poszczególne punkty końcowe funkcji.
func azure functionapp
Kontekst func azure functionapp zawiera następujące polecenia:
func azure functionapp fetch-app-settingsfunc azure functionapp list-functionsfunc azure functionapp logstreamfunc azure functionapp publish
Wszystkie func azure functionapp polecenia obsługują następujące opcje:
| Opcja | opis |
|---|---|
--slot |
Dotyczy określonego nazwanego miejsca wdrożenia, jeśli jest skonfigurowane. |
--access-token |
Udostępnia token dostępu, inny niż token domyślny, do użycia do wykonywania akcji uwierzytelnionych w Azure. |
--access-token-stdin |
Odczytuje określony token dostępu ze standardowych danych wejściowych. Użyj tej opcji podczas odczytywania tokenu bezpośrednio z poprzedniego polecenia, takiego jak az account get-access-token. |
--management-url |
Ustawia adres URL zarządzania dla chmury Azure, która domyślnie ma wartość https://management.azure.com. Użyj tej opcji, gdy aplikacja funkcji działa w suwerennej chmurze. |
--subscription |
Ustawia domyślną subskrypcję Azure. |
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 w pliku local.settings.json można chronić, włączając szyfrowanie lokalne.
func azure functionapp list-functions
Wyświetla listę funkcji w określonej aplikacji funkcji.
func azure functionapp list-functions <APP_NAME>
Polecenie func azure functionapp list-functions obsługuje tę opcję:
| Opcja | opis |
|---|---|
--show-keys |
Uwzględnij wartości klucza dostępu na poziomie funkcji w zwracanych adresach URL punktów końcowych funkcji. |
func azure functionapp logstream
Łączy lokalny wiersz polecenia z dziennikami przesyłania strumieniowego dla aplikacji funkcji w Azure.
func azure functionapp logstream <APP_NAME>
Domyślny limit czasu połączenia wynosi 2 godziny. Zmień limit czasu, dodając ustawienie aplikacji o nazwie SCM_LOGSTREAM_TIMEOUT z wartością limitu czasu w sekundach. Nieobsługiwane jeszcze w systemie Linux w planie Flex Consumption lub Consumption . W przypadku tych aplikacji użyj --browser opcji , aby wyświetlić dzienniki w portalu.
Polecenie func azure functionapp logstream obsługuje tę opcję:
| Opcja | opis |
|---|---|
--browser |
Otwórz usługę Azure Application Insights Live Stream dla aplikacji funkcji w domyślnej przeglądarce. |
Aby uzyskać więcej informacji, zobacz Włączenie dzienników wykonywania przesyłania strumieniowego w Azure Functions.
func azure functionapp publish
Wdraża projekt usługi Functions w istniejącym zasobie aplikacji funkcji w 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:
| Opcja | opis |
|---|---|
--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 .wheels podczas publikowania aplikacji funkcji Python. |
--csx |
Publikowanie projektu skryptu języka C# (csx). |
--dotnet-cli-params |
Po opublikowaniu skompilowanych funkcji języka C# (csproj) podstawowe narzędzia wywołają metodę dotnet build --output bin/publish. Wszystkie parametry przekazywane do tej opcji są dołączane do wiersza polecenia. |
--dotnet-version |
W przypadku aplikacji dotnet-isolated określa docelową wersję .NET (na przykład 8.0). |
--force |
Ignoruje weryfikację wstępnego publikowania w niektórych scenariuszach. |
--list-ignored-files |
Wyświetla listę plików ignorowanych podczas publikowania na podstawie pliku .funcignore . |
--list-included-files |
Wyświetla listę opublikowanych plików, które są oparte na pliku .funcignore . |
--no-build |
Project nie jest kompilowana podczas publikowania. W przypadku Python pip install nie jest uruchamiana. |
--nozip |
Wyłącza tryb domyślny Run-From-Package . Wyodrębnia pliki do wwwroot folderu na serwerze zamiast uruchamiać je bezpośrednio z pakietu wdrożeniowego. |
--overwrite-settings, -y |
Pomija monit o zastąpienie ustawień aplikacji podczas korzystania z polecenia --publish-local-settings -i. |
--publish-local-settings, -i |
Publikuje ustawienia w local.settings.json w celu Azure z monitem 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 |
Publikuje tylko ustawienia i pomija zawartość. Wartość domyślna to monit. |
--show-keys |
Dodaje klucze funkcji do adresów URL wyświetlanych w dziennikach. |
func azure storage fetch-connection-string
Pobiera connection string dla określonego konta Azure Storage.
func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>
Aby uzyskać więcej informacji, zobacz pobierz magazyn connection string.
func azurecontainerapps deploy
Wdraża konteneryzowaną aplikację funkcji w środowisku Azure Container Apps. Konto magazynu używane przez aplikację funkcji i środowisko muszą już istnieć. Aby uzyskać więcej informacji, zobacz Azure Container Apps hosting 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 |
|---|---|
--environment |
Nazwa istniejącego środowiska usługi Container Apps. |
--image-build |
Ustaw wartość , aby true pominąć lokalną kompilację platformy Docker. |
--image-name |
Nazwa istniejącego obrazu kontenera w rejestrze kontenerów, w tym nazwa tagu. |
--location |
Region wdrożenia. Najlepiej, aby ten region był taki sam jak zasoby środowiska i konta magazynu. |
--name |
Nazwa używana do wdrożenia aplikacji funkcji w środowisku Container Apps. Ta nazwa jest również wyświetlana podczas zarządzania aplikacją funkcji w portalu. Nazwa musi 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 --registryprogramem --image-name . W przypadku Docker Hub użyj również --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 |
Connection string konta magazynu do użycia przez aplikację funkcji. |
--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, , dotnetIsolatednodepython, , powershelli custom (dla procedur obsługi niestandardowych). |
Ważne
Parametry połączenia magazynu i inne poświadczenia usługi są ważnymi wpisami tajnymi. Bezpiecznie przechowuj pliki skryptów, które używają func azurecontainerapps deploy i nie przechowują 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 bundles add
Dodaje konfigurację pakietu rozszerzeń do pliku host.json .
func bundles add
Polecenie func bundles add obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--force, -f |
Zastępuje istniejącą konfigurację pakietu rozszerzeń, jeśli istnieje. |
--channel, -c |
Kanał wydania pakietu rozszerzeń. Obsługiwane wartości to: GA (wartość domyślna), Previewi Experimental. |
func bundles download
Pobiera pakiet rozszerzeń skonfigurowany w host.json.
func bundles download
Polecenie func bundles download obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--force, -f |
Wymusza ponowne pobranie pakietu rozszerzenia, nawet jeśli jest już obecne. |
func bundles list
Wyświetla listę pobranych pakietów rozszerzeń.
func bundles list
func bundles path
Pobiera ścieżkę do pobranego pakietu rozszerzenia.
func bundles path
func durable delete-task-hub
Usuwa wszystkie artefakty magazynu w centrum zadań Durable Functions.
func durable delete-task-hub
Polecenie func durable delete-task-hub obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--connection-string-setting |
Nazwa ustawienia, które zawiera connection string magazynu do użycia. |
--task-hub-name |
Nazwa centrum zadań Durable do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację Durable Functions.
func durable get-history
Zwraca historię określonego wystąpienia orkiestracji.
func durable get-history --id <INSTANCE_ID>
Polecenie func durable get-history obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--id |
Identyfikator wystąpienia aranżacji. (Wymagane) |
--connection-string-setting |
Nazwa ustawienia, które ma connection string magazynu do użycia. |
--task-hub-name |
Nazwa centrum zadań Durable do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację Durable Functions.
func durable get-instances
Zwraca stan wszystkich wystąpień aranżacji. To polecenie obsługuje stronicowanie z parametrem top .
func durable get-instances
Polecenie func durable get-instances obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--continuation-token |
Token wskazujący określoną stronę lub sekcję żądań do zwrócenia. |
--connection-string-setting |
Nazwa ustawienia aplikacji zawierającego connection string magazynu do użycia. |
--created-after |
Pobierz wystąpienia utworzone po tej dacie i godzinie (UTC). Akceptowane są wszystkie formatowane daty/godziny iso 8601. |
--created-before |
Pobierz wystąpienia utworzone przed określoną datą i godziną (UTC). Akceptowane są wszystkie formatowane daty/godziny iso 8601. |
--runtime-status |
Pobierz wystąpienia, których stan jest zgodny z określonym stanem, w tym running, completedi failed. Można podać jeden lub więcej stanów rozdzielonych spacjami. |
--top |
Ogranicz liczbę rekordów zwracanych w danym żądaniu. |
--task-hub-name |
Nazwa centrum zadań Durable Functions do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację Durable Functions.
func durable get-runtime-status
Zwraca stan określonego wystąpienia orkiestracji.
func durable get-runtime-status --id <INSTANCE_ID>
Polecenie func durable get-runtime-status obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--connection-string-setting |
Nazwa ustawienia zawierającego connection string magazynu do użycia. |
--id |
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 |
Nazwa centrum zadań Durable Functions do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację Durable Functions.
func durable purge-history
Przeczyszczanie stanu wystąpienia orkiestracji, historii i magazynu obiektów blob dla aranżacji starszych niż określony próg.
func durable purge-history
Polecenie func durable purge-history obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--connection-string-setting |
Nazwa ustawienia zawierającego connection string magazynu do użycia. |
--created-after |
Usuń historię wystąpień utworzonych po tej dacie/godzinie (UTC). Akceptowane są wszystkie wartości daty/godziny sformatowane w formacie ISO 8601. |
--created-before |
Usuń historię wystąpień utworzonych przed tą datą/godziną (UTC). Akceptowane są wszystkie wartości daty/godziny sformatowane w formacie ISO 8601. |
--runtime-status |
Usuń historię wystąpień, których stan jest zgodny z określonym stanem, w tym completed, terminated, canceledi failed. Podaj co najmniej jeden stan rozdzielony spacją. Jeśli nie dołączysz --runtime-status, historia wystąpień zostanie usunięta niezależnie od stanu. |
--task-hub-name |
Nazwa centrum zadań Durable Functions do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację 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>
Polecenie func durable raise-event obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--connection-string-setting |
Nazwa ustawienia zawierającego connection string magazynu do użycia. |
--event-data |
Dane przekazywane do zdarzenia , wbudowane lub z pliku JSON. W przypadku plików przedrostek ścieżki do pliku za pomocą znaku (@), na przykład @path/to/file.json. (Wymagane) |
--event-name |
Nazwa zdarzenia do wywołania. (Wymagane) |
--id |
Identyfikator wystąpienia aranżacji. (Wymagane) |
--task-hub-name |
Nazwa centrum zadań Durable Functions do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację Durable Functions.
func durable rewind
Przewija określone wystąpienie orkiestracji.
func durable rewind --id <INSTANCE_ID> --reason <REASON>
Polecenie func durable rewind obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--connection-string-setting |
Nazwa ustawienia zawierającego connection string magazynu do użycia. |
--id |
Identyfikator wystąpienia aranżacji. (Wymagane) |
--reason |
Przyczyna ponownego przewijania aranżacji. (Wymagane) |
--task-hub-name |
Nazwa centrum zadań Durable Functions do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację 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>
Polecenie func durable start-new obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--connection-string-setting |
Nazwa ustawienia zawierającego connection string 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. W przypadku plików prefiks ścieżki do pliku z znakiem ampersand (@), na przykład @path/to/file.json. (Wymagane) |
--task-hub-name |
Nazwa centrum zadań Durable Functions do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację Durable Functions.
func durable terminate
Kończy określone wystąpienie orkiestracji.
func durable terminate --id <INSTANCE_ID> --reason <REASON>
Polecenie func durable terminate obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--connection-string-setting |
Nazwa ustawienia zawierającego connection string magazynu do użycia. |
--id |
Określa identyfikator wystąpienia aranżacji. (Wymagane) |
--reason |
Przyczyna zakończenia aranżacji. (Wymagane) |
--task-hub-name |
Nazwa centrum zadań Durable Functions do użycia. |
Aby uzyskać więcej informacji, zobacz dokumentację Durable Functions.
func extensions install
Ręcznie instaluje rozszerzenia usługi Functions w projekcie innym niż .NET lub w projekcie skryptu języka C#.
func extensions install --package Microsoft.Azure.WebJobs.Extensions.<EXTENSION> --version <VERSION>
Polecenie func extensions install obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--configPath, -c |
Ścieżka katalogu zawierającego plik extensions.csproj. |
--csx |
Obsługa projektów skryptów języka C# (csx). |
--force, -f |
Zaktualizuj wersje istniejących rozszerzeń. |
--output, -o |
Ścieżka wyjściowa rozszerzeń. |
--package, -p |
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, -s |
Źródło źródła danych NuGet, jeśli nie jest używane NuGet.org. |
--version, -v |
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
Te zagadnienia mają zastosowanie w przypadku korzystania z programu func extensions install:
W przypadku skompilowanych projektów języka C# (zarówno w procesie przetwarzania, jak i izolowanego procesu roboczego) użyj 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 .NET.
Jeśli to możliwe, należy zamiast tego używać pakietów rozszerzeń. Oto 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ąć
extensionBundleobiekt z pliku host.json definiującego pakiet. Nie jest podejmowana żadna akcja, gdy pakiet rozszerzenia jest już ustawiony w pliku host.json .Przy pierwszym 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#.
func extensions sync
Instaluje wszystkie rozszerzenia dodane do aplikacji funkcji.
Polecenie func extensions sync obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--configPath, -c |
Ścieżka katalogu zawierającego plik extensions.csproj. |
--csx |
Obsługuje projekty skryptów języka C# (csx). |
--output, -o |
Ścieżka wyjściowa rozszerzeń. |
Ponownie generuje brakujący plik extensions.csproj. Nie wykonuje żadnej akcji, 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 .
Polecenie func kubernetes deploy obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--dry-run |
Wyświetla szablon wdrożenia bez wykonywania. |
--config-map-name |
Nazwa istniejącej mapy konfiguracji z ustawieniami aplikacji funkcji do użycia we wdrożeniu. Wymaga .--use-config-map Domyślne zachowanie polega na utworzeniu Values ustawień na podstawie obiektu w pliku local.settings.json . |
--cooldown-period |
Okres chłodzenia (w sekundach) po tym, jak wszystkie wyzwalacze nie są już aktywne przed skalowaniem wdrożenia z powrotem w dół do zera, z wartością domyślną 300 s. |
--ignore-errors |
Kontynuuj 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 |
Ustaw 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. |
--max-replicas |
Ustaw maksymalną liczbę replik, do których skaluje się narzędzie Horizontal Pod Autoscaler (HPA). |
--min-replicas |
Ustaw minimalną liczbę replik poniżej, która nie będzie skalowana przez narzędzie HPA. |
--mount-funckeys-as-containervolume |
Zainstaluj klucze dostępu jako wolumin kontenera. |
--name |
Nazwa używana do wdrożenia i innych artefaktów na platformie Kubernetes. |
--namespace |
Ustaw przestrzeń nazw Platformy Kubernetes do wdrożenia. Domyślnie jest używana domyślna przestrzeń nazw. |
--no-docker |
Odczytywanie funkcji 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 --registryprogramem --image-name . 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 ma ustawienia aplikacji funkcji do użycia we wdrożeniu. Domyślne zachowanie polega na utworzeniu Values ustawień na podstawie obiektu w pliku local.settings.json . |
--show-service-fqdn |
Wyświetl adresy URL wyzwalaczy HTTP przy użyciu nazwy FQDN platformy Kubernetes zamiast domyślnego zachowania przy użyciu adresu IP. |
--service-type |
Ustaw 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. |
--use-git-hash-version |
Użyj skrótu Git jako wersji obrazu kontenera. |
--write-configs |
Wyprowadź konfiguracje platformy Kubernetes jako pliki YAML zamiast wdrażania. |
--config-file |
Ścieżka pliku wyjściowego w przypadku używania polecenia --write-configs. Ustawienie domyślne: functions.yaml. |
--hash-files |
Pliki skrótu w celu określenia wersji obrazu. |
--image-build |
Gdy jest ustawiona wartość false, pomija kompilację platformy Docker. |
--key-secret-annotations |
Adnotacje do dodawania do klucza tajnego w key1=val1,key2=val2 formacie . |
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.
Azure Functions obsługuje hostowanie konteneryzowanych funkcji w Azure Container Apps lub w Azure Functions. Azure Functions nie obsługuje oficjalnie uruchamiania kontenerów bezpośrednio w klastrze Kubernetes ani w Azure Kubernetes Service (AKS). Aby uzyskać więcej informacji, zobacz obsługa kontenera Linux w Azure Functions.
func kubernetes delete
Usuwa wdrożenie usługi Functions z klastra Kubernetes.
func kubernetes delete --name <APP_NAME>
Polecenie func kubernetes delete obsługuje następujące opcje:
| Opcja | opis |
|---|---|
--name |
Nazwa wdrożenia i innych artefaktów na platformie Kubernetes. (Wymagane) |
--namespace |
Ustaw przestrzeń nazw kubernetes. Domyślnie jest używana default przestrzeń nazw. |
--registry |
Nazwa rejestru kontenerów. |
--image-name |
Obraz do użycia na potrzeby wdrożenia zasobnika. |
--keda-version |
Ustaw wersję KEDA. Prawidłowe opcje to v1 i v2 (wartość domyślna). |
func kubernetes install
Instaluje usługę KEDA w klastrze Kubernetes
func kubernetes install
Instaluje narzędzie KEDA do klastra zdefiniowanego w pliku konfiguracji kubectl.
Polecenie func kubernetes 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 |
Instaluje się w określonej przestrzeni nazw platformy Kubernetes. Jeśli nie zostanie ustawiona, zostanie użyta domyślna przestrzeń nazw. |
Aby uzyskać więcej informacji, 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 kubectl w pliku konfiguracji.
func kubernetes remove
Usuwa KEDA z klastra zdefiniowanego kubectl w pliku konfiguracji.
Polecenie func kubernetes remove obsługuje tę opcję:
| Opcja | opis |
|---|---|
--namespace |
Odinstalowuje z określonej przestrzeni nazw platformy Kubernetes. Jeśli nie zostanie ustawiona, zostanie użyta domyślna przestrzeń nazw. |
Aby uzyskać więcej informacji, zobacz Odinstalowywanie KEDA z platformy Kubernetes.
func settings add
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.
Polecenie func settings add obsługuje tę opcję:
| Opcja | opis |
|---|---|
--connectionString |
Dodaje parę name-value do ConnectionStrings kolekcji zamiast Values kolekcji. Użyj kolekcji ConnectionStrings tylko wtedy, gdy niektóre platformy tego wymagają. Aby uzyskać więcej informacji, zobacz pliklocal.settings.json. |
func settings decrypt
Odszyfrowuje zaszyfrowane wartości w Values kolekcji w pliku local.settings.json .
func settings decrypt
To polecenie odszyfrowuje również connection string wartości w kolekcji ConnectionStrings. W local.settings.json IsEncrypted jest również ustawiona wartość false. Szyfruj ustawienia lokalne, aby zmniejszyć ryzyko wycieku cennych informacji z local.settings.json. W Azure ustawienia aplikacji są zawsze przechowywane jako zaszyfrowane.
func settings delete
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.
Polecenie func settings delete obsługuje tę opcję:
| Opcja | opis |
|---|---|
--connectionString |
Usuwa parę name-value z ConnectionStrings kolekcji zamiast Values kolekcji. |
func settings encrypt
Szyfruje wartości poszczególnych elementów w Values kolekcji w pliku local.settings.json.
func settings encrypt
Wartości parametrów połączenia w ConnectionStrings kolekcji są również szyfrowane. W 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 local.settings.json. W Azure ustawienia aplikacji są zawsze przechowywane jako zaszyfrowane.
func settings list
Zwraca listę ustawień w Values kolekcji w pliku local.settings.json.
func settings list
Dane wyjściowe zawierają również parametry połączenia z kolekcji ConnectionStrings . Domyślnie wartości są maskowane pod kątem zabezpieczeń. Możesz użyć --showValue opcji , aby wyświetlić rzeczywistą wartość.
Polecenie func settings list obsługuje tę opcję:
| Opcja | opis |
|---|---|
--showValue, -a |
Pokaż rzeczywiste niezamaskowane wartości w danych wyjściowych. |
func templates list
Wyświetla listę dostępnych szablonów funkcji (wyzwalacza).
Polecenie func templates list obsługuje tę opcję:
| Opcja | opis |
|---|---|
--language, -l |
Język, dla którego mają być filtrowane zwrócone szablony. Zwraca wszystkie języki domyślnie. |
Opcje globalne
Te opcje są dostępne dla większości poleceń narzędzi Core Tools:
| Opcja | opis |
|---|---|
--script-root |
Ustawia katalog główny aplikacji funkcji i zmienia katalog roboczy polecenia. |
--verbose |
Włącza pełne dane wyjściowe na potrzeby szczegółowego rejestrowania. Nieobsługiwane przez wszystkie polecenia. |
--offline |
Działa w trybie offline bez wykonywania zewnętrznych wywołań sieciowych. Obsługiwane przez func start, func initi func new. Można również ustawić za pomocą zmiennej środowiskowej FUNCTIONS_CORE_TOOLS_OFFLINE . |
--version, -v |
Wyświetla wersję narzędzi Azure Functions Core Tools. |
--help, -h |
Wyświetla informacje pomocy. |
--pause-on-error |
Wstrzymuje dodatkowe dane wejściowe przed zakończeniem procesu. Przydatne podczas uruchamiania narzędzi Core Tools ze zintegrowanego środowiska projektowego (IDE). |