次の方法で共有

Azure Functions Core Tools リファレンス

この記事では、Azure Functions Core Tools のリファレンス ドキュメントを提供します。これにより、ローカル コンピューターからAzure Functions プロジェクトを開発、管理、展開できます。 Core Tools の使用の詳細については、「Work with Azure Functions Core Toolsを参照してください。

Core Tools コマンドは次のコンテキストに分類され、それぞれが独自のアクション セットを提供します。

コマンドのコンテキスト 説明
func ローカル コンピューターで関数を作成して実行するコマンド。
func azure 発行など、Azure リソースを操作するコマンド。
func azurecontainerapps コンテナー化された関数アプリをAzure Container Appsにデプロイするコマンド。
func bundles 拡張機能バンドルを管理するコマンド。
func durable Durable Functionsを操作するコマンド。
func extensions 拡張機能をインストールして管理するコマンド。
func kubernetes Kubernetes とAzure Functionsを操作するコマンド。
func settings ローカル Functions ホストの環境設定を管理するコマンド。
func templates 使用可能な関数テンプレートを一覧表示するコマンド。

この記事のコマンドを使用する前に、 Core Tools をインストールします。

func init

特定の言語で新しい Functions プロジェクトを作成します。

func init [<PROJECT_FOLDER>]

<PROJECT_FOLDER> を指定すると、プロジェクトは、この名前の新しいフォルダー内に作成されます。 それ以外の場合は、現在のフォルダーが使用されます。

func init コマンドは、特に明記されていない限り、バージョン 1.x ではサポートされていないこれらのオプションをサポートしています。

オプション 説明
--bundles-channel、-c 拡張機能バンドルリリース チャネル。 サポートされている値は、 GA (既定)、 Preview、および Experimentalです。 .NET以外のプロジェクトにのみ適用されます。
--configuration-profile ホスト構成プロファイルを使用してプロジェクトを初期化します。 --configuration-profile オプションは現在プレビュー段階です。 詳細については、「 構成プロファイル」を参照してください。
--csx .NET関数を C# スクリプトとして作成します。これはバージョン 1.x の動作です。 --worker-runtime dotnet でのみ有効です。
--docker 選択した --worker-runtimeに基づいて基本イメージを使用して、コンテナーの Dockerfile を作成します。 このオプションは、コンテナー化された関数アプリをデプロイする場合に使用します。
--docker-only 既存のプロジェクトに Dockerfile を追加します。 local.settings.jsonで指定または設定されていない場合は、ワーカー ランタイムのプロンプトを 表示します 。 このオプションは、コンテナー化された関数アプリをデプロイしようとしていて、プロジェクトが既に存在する場合に使用します。
--force プロジェクトに既存のファイルがある場合でも、プロジェクトを初期化します。 この設定は、同じ名前の既存のファイルを上書きします。 プロジェクト フォルダー内の他のファイルには影響ありません。
--language、-l 言語固有のプロジェクトを初期化します。 現在、 --worker-runtime が node に設定されている場合にサポートされます。 オプションは typescript と javascript です。 --worker-runtime javascript または --worker-runtime typescript を使用することもできます。
--managed-dependencies マネージドの依存関係をインストールします。 現在、この機能は PowerShell worker ランタイムでのみサポートされています。
--model、-m 複数のモデルが使用可能な場合に、ターゲット言語のプログラミング モデルを設定します。 サポートされているオプションは、Python の場合は V1 と V2、Node.jsの場合は V3 および V4 です。 詳細については、Python開発者ガイドおよびNode.js開発者ガイドを参照してください。
--no-bundle host.jsonで拡張機能バンドルを構成しないでください。 .NET以外のプロジェクトにのみ適用されます。
--no-docs "作業の開始" ドキュメント ファイルの生成をスキップします。 Python プロジェクトに適用されます。
--skip-npm-install プロジェクトの作成後、 npm install の実行をスキップします。 Node.js プロジェクトに適用されます。
--source-control Git リポジトリを作成するかどうかを制御します。 既定では、リポジトリは作成されません。 true を指定すると、リポジトリが作成されます。
--worker-runtime プロジェクトの言語ランタイムを設定します。 サポートされる値は、 csharp、 dotnet、 dotnet-isolated、 javascript、 node (JavaScript)、 powershell、 python、および typescriptです。 Javaには、Maven を使用します。 プロジェクト ファイルだけが含まれる言語に依存しないプロジェクトを生成するには、custom を使用します。 設定しないと、初期化中にランタイムの選択を求められます。
--target-framework 関数アプリ プロジェクトのターゲット フレームワークを設定します。 --worker-runtime dotnet-isolated でのみ有効です。 サポートされている値は、net10.0 (プレビュー)、net9.0、net8.0 (既定値)、net6.0、および net48 (.NET Framework 4.8) です。

注

--docker または --docker-only オプションを使用すると、Core Tools によって C#、JavaScript、Python、PowerShell 関数用の Dockerfile が自動的に作成されます。 Java関数の場合は、Dockerfile を手動で作成する必要があります。 詳細については、「コンテナー化された関数アプリの作成」を参照してください。

構成プロファイル

重要

構成プロファイルのサポートは現在プレビュー段階です。

--configuration-profile オプションを使用すると、プロジェクト構成と設定の定義済みのセットが作成されます。 構成プロファイルを指定すると、初期化によって他のすべての初期化手順がスキップされる場合があります。

プロファイル値 説明 特定のアクション
mcp-custom-handler カスタム ハンドラーを使用して、AI エージェントやその他の MCP クライアントが接続できる MCP (モデル コンテキスト プロトコル) サーバーをホストするプロジェクトを作成します。 • 特定のカスタム ハンドラー設定を使用して、host.json ファイル内の"configurationProfile": "mcp-custom-handler"要素を構成します。
•local.settings.jsonのtrueにMCP_EXTENSION_ENABLEDを設定します。

func logs

Kubernetes クラスター内で実行されている関数のログを取得します。

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

func logs コマンドでは、次のオプションがサポートされています。

オプション 説明
--platform 関数アプリのホスティング プラットフォーム。 有効なオプション: kubernetes。
--name Azureの関数アプリ名。

詳細については、KEDA を使用した Kubernetes の Azure Functions を参照してください。

func new

テンプレートに基づいて、現在のプロジェクト内に新しい関数を作成します。

func new

func new オプションを指定せずに --template を実行すると、テンプレートを選択するよう求められます。 バージョン 1.x では、言語も選択する必要があります。

func new コマンドでは、次のオプションがサポートされています。

オプション 説明
--authlevel、-a HTTP トリガーの承認レベルを設定します。 サポートされる値は function、anonymous、admin です。 ローカルで実行される場合、承認は適用されません。 詳細については、「認可レベル」を参照してください。
--csx (バージョン 2.x 以降のバージョン。)バージョン 1.x およびポータルで使用されるものと同じ C# スクリプト (.csx) テンプレートを生成します。
--file、-f 新しい関数のターゲット ファイル。 Python v2 プロジェクトの場合は、関数を追加するファイルを指定します (既定値は function_app.py)。 Node.js v4 プロジェクトの場合は、 src/functions フォルダー内の出力ファイル名を指定します。 コンパイル済みの.NET プロジェクトには適用されません。
--language、-l C# や JavaScript などのテンプレート プログラミング言語。 このオプションは、バージョン 1.x で必須です。 バージョン 2.x 以降のバージョンでは、言語がワーカー ランタイムによって定義されているため、このオプションを使用しないでください。
--name、-n 関数名。
--template、-t サポートされている各言語で使用可能なテンプレートの完全な一覧を表示するには、func templates list コマンドを使います。

詳細については、「関数を作成する」を参照してください。

func pack

実行可能な状態のプロジェクト コードを含む配置パッケージを作成します。 この方法は、 func azure functionapp publish コマンドの外部でローカル コンピューターでアプリの展開パッケージを手動で作成する必要がある場合に使用します。 既定では、 func pack は必要に応じてプロジェクトをビルドします。

func pack [<FOLDER_PATH>]

既定では、 func pack は現在のディレクトリをパッケージ化し、出力 .zip ファイルの名前はプロジェクトのルート フォルダーと同じです。 host.jsonプロジェクト ファイルを含むディレクトリでfunc packを実行します。 別のディレクトリでfunc packを実行する必要がある場合は、func pack ./myprojectrootのように、プロジェクト ルートへのパスとして<FOLDER_PATH>設定します。 特定の .zip ファイルが既に存在する場合は、最初に削除され、次に更新されたバージョンに置き換えられます。

func pack コマンドでは、次のオプションがサポートされています。

オプション 説明
--output、-o 配置 .zip パッケージ ファイルが作成される場所へのパスを設定します。
--no-build Projectは、パッキング前にビルドされていません。 C# アプリの場合は、バイナリを既に生成した場合にのみ使用します。 Node.js アプリの場合、 npm install と npm run build の両方がスキップされます。
--skip-install ベースの関数アプリ Node.jsパックするときに、 npm install の実行をスキップします。 カスタム npm モジュールの上書きを回避するために使用されます。
--build-native-deps Azureで使用Python環境に一致するイメージを使用して、依存関係をローカルにインストールします。 有効にすると、Core Tools によって Docker コンテナーが起動され、そのコンテナー内にアプリがビルドされ、 .python_packagesに復元されたすべての依存関係を含む .zip ファイルが作成されます。 Azureで Linux にデプロイするときにライブラリの潜在的な問題を回避するには、Windowsで実行するときにこのオプションを使用します。

func run

バージョン 1.x のみ。

関数を直接呼び出すことができます。これは、Azure ポータルの Test タブを使用して関数を実行するのと似ています。 このアクションは、バージョン1.x でのみサポートされています。 これ以降のバージョンでは、func start を使用し、関数エンドポイントを直接呼び出します。

func run

func run コマンドでは、次のオプションがサポートされています。

オプション 説明
--content 関数に渡されるインライン コンテンツ。
--debug 関数を実行する前に、デバッガーを、ホスト プロセスにアタッチします。
--file コンテンツとして使用するファイル名。
--no-interactive 入力のためのダイアログを表示しません。自動化のシナリオに便利です。
--timeout Functions ホストの準備が完了するまでの待機時間 (秒単位)。

たとえば、HTTP によってトリガーされる関数を呼び出してコンテンツ本文を渡すには、次のコマンドを実行します。

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

func start

ローカル ランタイム ホストを起動し、現在のフォルダーに関数プロジェクトを読み込みます。

具体的なコマンドは、ランタイム バージョンによって異なります。

func start

func start コマンドでは、次のオプションがサポートされています。

オプション 説明
--cert 秘密キーが含まれる .pfx ファイルへのパス。 --useHttps でのみサポートされます。
--cors CORS オリジンのコンマ区切りのリスト (スペースなし)。
--cors-credentials Cookie と認証ヘッダーを使用するクロスオリジン認証要求を許可します。
--dotnet-isolated-debug true に設定すると、デバッグ対象の分離されたプロジェクトからデバッガーがアタッチされるまで、.NETワーカー プロセス.NET一時停止します。
--enable-json-output 可能な場合は、コンソール ログを JSON として出力します。
--enableAuth 承認要件を持つ完全な認証処理パイプラインを有効にします。
--functions 読み込まれる関数のスペース区切りリスト。
--json-output-file 指定した場合、 --enable-json-outputを使用するときに出力の書き込みに使用されるファイルへのパス。
--language-worker 言語ワーカーを構成するための引数。 たとえば、言語ワーカーのデバッグを有効にするには、debug ポートとその他の必須引数を指定します。
--no-build 実行前に現在のプロジェクトをビルドしません。 .NET クラス プロジェクトの場合のみ。 既定値は false です。
--password .pfx ファイルのパスワードまたはパスワードが格納されているファイルのいずれか。 --cert でのみ使用されます。
--port、-p ローカル ポート。このポートでリッスンします。 既定値:7071。
--runtime 開始するホストのバージョンを設定します。 使用できる値は、 inproc6、 inproc8、および default (アウトプロセス ホストを実行します) です。
--timeout、-t Functions ホスト開始のタイムアウト (秒単位)。 既定値は20 秒。
--useHttps https://localhost:{port} ではなく http://localhost:{port} にバインドします。 既定では、このオプションにより、信頼された証明書がコンピューターに作成されます。
--user-log-level ユーザー ログの最小ログ レベルを設定します。 有効な値は、 Trace、 Debug、 Information、 Warning、 Error、 Critical、および Noneです。 この設定は、システム ログには影響しません。 分離されたプロジェクト.NET場合は、このオプションを有効にするために builder.Logging.SetMinimumLevel(LogLevel.Debug) を使用して、Program.cs の最小レベルも設定します。

プロジェクトが実行されている状態で、 個々の関数エンドポイントを確認します。

func azure functionapp

func azure functionapp コンテキストには、次のコマンドが含まれています。

すべての func azure functionapp コマンドでは、次のオプションがサポートされます。

オプション 説明
--slot 構成されている場合は、特定の名前付き デプロイ スロットをターゲットにします。
--access-token Azureで認証されたアクションを実行するために使用する、既定のトークン以外のアクセス トークンを提供します。
--access-token-stdin 標準入力から特定のアクセス トークンを読み取ります。 このオプションは、 az account get-access-tokenなどの前のコマンドからトークンを直接読み取る場合に使用します。
--management-url Azure クラウドの管理 URL を設定します。既定値は https://management.azure.com です。 関数アプリがソブリン クラウドで実行されている場合は、このオプションを使用します。
--subscription 既定のAzure サブスクリプションを設定します。

func azure functionapp fetch-app-settings

特定の関数アプリから設定を取得します。

func azure functionapp fetch-app-settings <APP_NAME>

詳細については、「アプリケーション設定のダウンロード」を参照してください。

設定は、プロジェクトの local.settings.json ファイルにダウンロードされます。 画面上の値は、セキュリティのためにマスクされます。 local.settings.json ファイル内の設定を保護するには、ローカル暗号化を有効にします。

func azure functionapp list-functions

指定した関数アプリの関数を一覧表示します。

func azure functionapp list-functions <APP_NAME>

func azure functionapp list-functions コマンドでは、次のオプションがサポートされています。

オプション 説明
--show-keys 返される関数エンドポイント URL に関数レベルのアクセス キー値を含めます。

func azure functionapp logstream

ローカル コマンド プロンプトを、Azureの関数アプリのストリーミング ログに接続します。

func azure functionapp logstream <APP_NAME>

接続の既定のタイムアウトは 2 時間です。 タイムアウト値を秒単位で 指定して、SCM_LOGSTREAM_TIMEOUT という名前のアプリ設定を追加して、タイムアウトを変更します。 Flex 従量課金プランまたは従量課金プランの Linux では、まだサポートされていません。 これらのアプリについては、--browser オプションを使用して、ポータル内のログを表示します。

func azure functionapp logstream コマンドでは、次のオプションがサポートされています。

オプション 説明
--browser 既定のブラウザー Azure アプリケーション関数アプリの Insights Live Stream を開きます。

詳細については、 Azure Functionsを参照してください。

func azure functionapp publish

Azureの既存の関数アプリ リソースに Functions プロジェクトをデプロイします。

func azure functionapp publish <APP_NAME>

詳細については、「プロジェクト ファイルのデプロイ」を参照してください。

バージョンに基づいて、次の発行オプションが適用されます。

オプション 説明
--additional-packages ネイティブの依存関係を構築するときにインストールするパッケージの一覧 たとえば、 python3-dev libevent-devと指定します。
--build、-b Linux 関数アプリにデプロイするときにビルド アクションを実行します。 remote および local を受け入れます。
--build-native-deps 関数アプリを発行するときに、.wheels フォルダーの生成Pythonスキップします。
--csx C# スクリプト (.csx) プロジェクトを発行します。
--dotnet-cli-params コンパイル済みの C# (.csproj) 関数を発行すると、コア ツールは dotnet build --output bin/publishを呼び出します。 このオプションに渡されるすべてのパラメーターは、コマンド ラインに追加されます。
--dotnet-version dotnet-isolated アプリケーションの場合は、ターゲット .NET バージョン (たとえば、8.0) を指定します。
--force 特定のシナリオでの事前公開検証を無視します。
--list-ignored-files .funcignore ファイルに基づいて、発行中に無視されるファイルの一覧を表示します。
--list-included-files .funcignore ファイルに基づいて発行されたファイルの一覧を表示します。
--no-build Projectは、発行中にビルドされません。 Pythonの場合、pip installは実行されません。
--nozip 既定の Run-From-Package モードをオフにします。 展開パッケージから直接実行するのではなく、サーバー上の wwwroot フォルダーにファイルを抽出します。
--overwrite-settings、-y --publish-local-settings -iを使用するときに、アプリ設定を上書きするプロンプトを表示しない。
--publish-local-settings、-i local.settings.json の設定をAzureに発行し、設定が既に存在する場合は上書きするように求めます。 ローカル ストレージ エミュレーターを使用している場合は、まずアプリ設定を実際のストレージ接続に変更します。
--publish-settings-only、-o 設定のみを発行し、コンテンツをスキップします。 既定値は prompt です。
--show-keys ログに表示される URL にファンクション キーを追加します。

func azure storage fetch-connection-string

指定したAzure Storage アカウントの接続文字列を取得します。

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

詳細については、「ストレージ 接続文字列をダウンロードする」を参照してください。

func azurecontainerapps deploy

コンテナー化された関数アプリをAzure Container Apps環境にデプロイします。 関数アプリと環境で使用されるストレージ アカウントが既に存在している必要があります。 詳細については、「Azure FunctionsAzure Container Apps のホスティング」を参照>。

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>

適用するデプロイ オプションは、次のとおりです。

オプション 説明
--environment 既存の Container Apps 環境の名前。
--image-build ローカル Docker ビルドをスキップするには、 true に設定します。
--image-name タグ名を含む、コンテナー レジストリ内の既存のコンテナー イメージの名前。
--location デプロイのリージョン。 理想的には、このリージョンは環境とストレージ アカウントのリソースと同じです。
--name Container Apps 環境での関数アプリのデプロイに使用される名前。 この名前は、ポータルで関数アプリを管理するときにも表示されます。 この名前は、環境内で一意である必要があります。
--registry 設定すると、Docker ビルドが実行され、イメージが --registryのレジストリ セットにプッシュされます。 --registry で --image-name を使用することはできません。 Docker Hubの場合は、--registry-username も使用します。
--registry-password プライベート レジストリからイメージを取得するために使用されるパスワードまたはトークン。
--registry-username プライベート レジストリからイメージを取得するために使用されるユーザー名。
--resource-group 関数関連のリソースを作成するリソース グループ。
--storage-account 関数アプリによって使用されるストレージ アカウントの接続文字列。
--worker-runtime 関数アプリのランタイム言語を設定します。 このパラメーターは、 --image-name と --image-buildでのみ使用されます。それ以外の場合、言語はローカル ビルド中に決定されます。 サポートされる値は、 dotnet、 dotnetIsolated、 node、 python、 powershell、および custom です (カスタム ハンドラーの場合)。

重要

ストレージ接続文字列とその他のサービス資格情報は重要なシークレットです。 func azurecontainerapps deployを使用するスクリプト ファイルを安全に格納し、パブリックにアクセスできるソース管理には保存しません。

func deploy

func deploy コマンドは非推奨です。 代わりに func kubernetes deploy を使用します。

func bundles add

host.json ファイルに拡張バンドル構成を追加します。

func bundles add

func bundles add コマンドでは、次のオプションがサポートされています。

オプション 説明
--force、-f 既存の拡張機能バンドル構成が存在する場合は上書きします。
--channel、-c 拡張機能バンドルリリース チャネル。 サポートされている値は、 GA (既定)、 Preview、および Experimentalです。

func bundles download

host.jsonで構成されている拡張機能バンドルをダウンロードします。

func bundles download

func bundles download コマンドでは、次のオプションがサポートされています。

オプション 説明
--force、-f 拡張機能バンドルが既に存在する場合でも、拡張機能バンドルの再ダウンロードを強制します。

func bundles list

ダウンロードした拡張機能バンドルを一覧表示します。

func bundles list

func bundles path

ダウンロードした拡張機能バンドルへのパスを取得します。

func bundles path

func durable delete-task-hub

Durable Functions タスク ハブ内のすべてのストレージ 成果物を削除します。

func durable delete-task-hub

func durable delete-task-hub コマンドでは、次のオプションがサポートされています。

オプション 説明
--connection-string-setting 使用するストレージ 接続文字列を含む設定の名前。
--task-hub-name 使用する Durable タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func durable get-history

指定したオーケストレーション インスタンスの履歴を返します。

func durable get-history --id <INSTANCE_ID>

func durable get-history コマンドでは、次のオプションがサポートされています。

オプション 説明
--id オーケストレーション インスタンスの ID。 (必須)
--connection-string-setting 使用するストレージ 接続文字列を持つ設定の名前。
--task-hub-name 使用する Durable タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func durable get-instances

すべてのオーケストレーションインスタンスの状態を返します。 このコマンドは、 top パラメーターを使用したページングをサポートします。

func durable get-instances

func durable get-instances コマンドでは、次のオプションがサポートされています。

オプション 説明
--continuation-token 返す要求の特定のページまたはセクションを示すトークン。
--connection-string-setting 使用するストレージ 接続文字列を含むアプリ設定の名前。
--created-after この日時 (UTC) より後に作成されたインスタンスを取得します。 すべての ISO 8601 形式の日時が受け入れられます。
--created-before 特定の日時 (UTC) より前に作成されたインスタンスを取得します。 すべての ISO 8601 形式の日時が受け入れられます。
--runtime-status running、completed、failedなど、特定の状態と一致する状態のインスタンスを取得します。 1 つ以上のスペース区切りの状態を指定できます。
--top 特定の要求で返されるレコードの数を制限します。
--task-hub-name 使用するDurable Functions タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func durable get-runtime-status

指定したオーケストレーション インスタンスの状態を返します。

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

func durable get-runtime-status コマンドでは、次のオプションがサポートされています。

オプション 説明
--connection-string-setting 使用するストレージ 接続文字列を含む設定の名前。
--id オーケストレーション インスタンスの ID。 (必須)
--show-input 設定すると、応答には関数の入力が含まれます。
--show-output 設定すると、応答に実行履歴が含まれます。
--task-hub-name 使用するDurable Functions タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func durable purge-history

指定したしきい値より古いオーケストレーションのオーケストレーション インスタンスの状態、履歴、および BLOB ストレージを消去します。

func durable purge-history

func durable purge-history コマンドでは、次のオプションがサポートされています。

オプション 説明
--connection-string-setting 使用するストレージ 接続文字列を含む設定の名前。
--created-after この日時 (UTC) より後に作成されたインスタンスの履歴を削除します。 ISO 8601 形式のすべての datetime 値が受け入れられます。
--created-before この日時 (UTC) より前に作成されたインスタンスの履歴を削除します。 ISO 8601 形式のすべての datetime 値が受け入れられます。
--runtime-status completed、terminated、canceled、failedなど、特定の状態と一致する状態のインスタンスの履歴を削除します。 1 つ以上のスペース区切りの状態を指定します。 --runtime-status を含めない場合、インスタンスの履歴は状態に関係なく削除されます。
--task-hub-name 使用するDurable Functions タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func durable raise-event

指定したオーケストレーション インスタンスにイベントを発生させます。

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

func durable raise-event コマンドでは、次のオプションがサポートされています。

オプション 説明
--connection-string-setting 使用するストレージ 接続文字列を含む設定の名前。
--event-data インラインまたは JSON ファイルからイベントに渡すデータ。 ファイルの場合は、@path/to/file.jsonのように、ファイルへのパスの前にアットマーク (@) を付けます。 (必須)
--event-name 発生させるイベントの名前。 (必須)
--id オーケストレーション インスタンスの ID。 (必須)
--task-hub-name 使用するDurable Functions タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func durable rewind

指定されたオーケストレーション インスタンスを巻き戻します。

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

func durable rewind コマンドでは、次のオプションがサポートされています。

オプション 説明
--connection-string-setting 使用するストレージ 接続文字列を含む設定の名前。
--id オーケストレーション インスタンスの ID。 (必須)
--reason オーケストレーションを巻き戻す理由。 (必須)
--task-hub-name 使用するDurable Functions タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func durable start-new

指定されたオーケストレーター関数の新しいインスタンスを開始します。

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

func durable start-new コマンドでは、次のオプションがサポートされています。

オプション 説明
--connection-string-setting 使用するストレージ 接続文字列を含む設定の名前。
--function-name 開始するオーケストレーター関数の名前。 (必須)
--id オーケストレーション インスタンスの ID を指定します。 (必須)
--input インラインまたは JSON ファイルからのオーケストレーター関数への入力。 ファイルの場合は、ファイルへのパスの前にアンパサンド (@) を付けます (例: @path/to/file.json)。 (必須)
--task-hub-name 使用するDurable Functions タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func durable terminate

指定したオーケストレーション インスタンスを終了します。

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

func durable terminate コマンドでは、次のオプションがサポートされています。

オプション 説明
--connection-string-setting 使用するストレージ 接続文字列を含む設定の名前。
--id オーケストレーション インスタンスの ID を指定します。 (必須)
--reason オーケストレーションを終了する理由。 (必須)
--task-hub-name 使用するDurable Functions タスク ハブの名前。

詳細については、Durable Functions ドキュメントを参照してください。

func extensions install

.NET以外のプロジェクトまたは C# スクリプト プロジェクトに Functions 拡張機能を手動でインストールします。

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

func extensions install コマンドでは、次のオプションがサポートされています。

オプション 説明
--configPath、-c extensions.csproj ファイルを含むディレクトリのパス。
--csx C# スクリプト (.csx) プロジェクトをサポートします。
--force、-f 既存の拡張機能のバージョンを更新します。
--output、-o 拡張機能の出力パス。
--package、-p 特定の拡張パッケージの識別子。 指定しない場合は、func extensions sync と同様に、参照されている拡張機能すべてがインストールされます。
--source、-s NuGet.org が使用されていない場合は、NuGet によってソースが提供されます。
--version、-v 拡張機能パッケージのバージョン。

次の例では、Event Hubs 拡張機能のバージョン 5.0.1 をローカル プロジェクトにインストールします。

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

func extensions installを使用する場合は、次の考慮事項が適用されます。

  • コンパイル済み C# プロジェクト (インプロセスと分離ワーカー プロセスの両方) の場合は、代わりに標準の NuGet パッケージのインストール方法 ( dotnet add package など) を使用します。

  • Core Tools を使用して拡張機能を手動でインストールするには、.NET SDK がインストールされている必要があります。

  • 可能な場合は、代わりに拡張機能バンドルを使用する必要があります。 拡張機能を手動でインストールする必要がある理由は次のとおりです。

    • バンドルで利用できない特定のバージョンの拡張機能にアクセスする必要がある。
    • バンドルで利用できないカスタム拡張機能にアクセスする必要がある。
    • 1 つのバンドルで利用できない特定の組み合わせの拡張機能にアクセスする必要がある。

  • 拡張機能を手動でインストールする前に、バンドルを定義するhost.jsonファイルからextensionBundle オブジェクトを削除する必要があります。 host.json ファイルに拡張機能バンドルが既に設定されている場合、アクションは実行されません。

  • 拡張機能を初めて明示的にインストールすると、extensions.csproj という名前の.NET プロジェクト ファイルがアプリ プロジェクトのルートに追加されます。 このファイルによって、関数に必要とされる NuGet パッケージのセットが定義されます。 このファイルで NuGet パッケージ参照を使用することができますが、Core Tools では、C# プロジェクト ファイルを手動編集しなくても拡張機能をインストールできます。

func extensions sync

追加されたすべての拡張機能を関数アプリにインストールします。

func extensions sync コマンドでは、次のオプションがサポートされています。

オプション 説明
--configPath、-c extensions.csproj ファイルを含むディレクトリのパス。
--csx C# スクリプト (.csx) プロジェクトをサポートします。
--output、-o 拡張機能の出力パス。

不足している extensions.csproj ファイルを再生成します。 host.json ファイルで拡張バンドルが定義されている場合は、何も行いません。

func kubernetes deploy

Functions プロジェクトをカスタム Docker コンテナーとして Kubernetes クラスターにデプロイします。

func kubernetes deploy

このコマンドでは、ご自身のプロジェクトをカスタム コンテナーとしてビルドし、Kubernetes クラスターに発行します。 カスタム コンテナーには、Dockerfile が必要です。 Dockerfile でアプリを作成するには、--dockerfile コマンドで func init オプションを使用します。

func kubernetes deploy コマンドでは、次のオプションがサポートされています。

オプション 説明
--dry-run 実行前にデプロイ テンプレートを表示します。
--config-map-name デプロイで使用する 関数アプリ設定 を含む既存の構成マップの名前。 --use-config-map が必要です。 既定の動作では、local.settings.jsonファイル内のValues オブジェクトに基づいて設定を作成します。
--cooldown-period デプロイがゼロにスケールダウンする前に、すべてのトリガーがアクティブでなくなった後のクールダウン期間 (秒単位) は、既定値は 300 秒です。
--ignore-errors リソースからエラーが返された後、デプロイを続行します。 既定の動作では、エラーの発生時に停止します。
--image-name ポッドのデプロイに使用するイメージの名前。このイメージから関数を読み取ります。
--keda-version インストールする KEDA のバージョンを設定します。 有効なオプションは v1 と v2 です (既定)。
--keys-secret-name access キーの格納に使用する Kubernetes Secrets コレクションの名前。
--max-replicas ポッドの水平オートスケーラー (HPA) がスケーリングするレプリカの最大数を設定します。
--min-replicas HPA がスケーリングしない最小レプリカ数を設定します。
--mount-funckeys-as-containervolume アクセス キーをコンテナー ボリュームとしてマウントします。
--name Kubernetes 内のデプロイと他の成果物に使用される名前。
--namespace デプロイする Kubernetes 名前空間を設定します。 既定値は既定の名前空間です。
--no-docker イメージからではなく、現在のディレクトリから関数を読み取ります。 イメージ ファイルシステムをマウントする必要があります。
--registry 設定すると、Docker ビルドが実行され、その名前のレジストリにイメージがプッシュされます。 --registry で --image-name を使用することはできません。 Docker の場合は、ユーザー名を使用します。
--polling-interval HTTP 以外のトリガーをチェックするためのポーリングの間隔 (秒単位)。 既定値は 30 秒です。
--pull-secret プライベート レジストリの資格情報にアクセスするために使用されるシークレット。
--secret-name デプロイで使用する 関数アプリ設定 を持つ既存の Kubernetes Secrets コレクションの名前。 既定の動作では、local.settings.jsonファイル内のValues オブジェクトに基づいて設定を作成します。
--show-service-fqdn IP アドレスを使用する既定の動作ではなく、Kubernetes FQDN を使用して HTTP トリガーの URL を表示します。
--service-type Kubernetes Service の種類を設定します。 サポートされる値は、ClusterIP、NodePort、LoadBalancer (既定) です。
--use-config-map ConfigMap オブジェクト (v1) ではなく Secret オブジェクト (v1) を使用して、関数アプリの設定を構成します。 マップ名は、--config-map-name を使用して設定されます。
--use-git-hash-version コンテナー イメージのバージョンとして Git ハッシュを使用します。
--write-configs デプロイするのではなく、Kubernetes 構成を YAML ファイルとして出力します。
--config-file --write-configs使用時の出力ファイル パス。 既定値: functions.yaml。
--hash-files ハッシュしてイメージのバージョンを決定するファイル。
--image-build falseに設定すると、Docker ビルドはスキップされます。
--key-secret-annotations キー シークレットに追加する注釈 ( key1=val1,key2=val2 形式)。

Core Tools はローカルの Docker CLI を使って、イメージをビルドおよび発行します。 Docker がローカルに既にインストールされていることを確認します。 ご自身のアカウントに接続するには、docker login コマンドを実行します。

Azure Functionsでは、Azure Container AppsまたはAzure Functionsでコンテナー化された関数のホストがサポートされます。 Azure Functionsでは、Kubernetes クラスターまたは Azure Kubernetes Service (AKS) でコンテナーを直接実行することは正式にはサポートされていません。 詳細については、「Azure Functions での Linux コンテナーのサポート」を参照してください。

func kubernetes delete

Kubernetes クラスターから Functions デプロイを削除します。

func kubernetes delete --name <APP_NAME>

func kubernetes delete コマンドでは、次のオプションがサポートされています。

オプション 説明
--name Kubernetes でのデプロイとその他の成果物の名前。 (必須)
--namespace Kubernetes 名前空間を設定します。 既定値は、 default 名前空間です。
--registry コンテナー レジストリの名前。
--image-name ポッドのデプロイに使用するイメージ。
--keda-version KEDA のバージョンを設定します。 有効なオプションは、 v1 と v2 (既定値) です。

func kubernetes install

Kubernetes クラスターに KEDA をインストールする

func kubernetes install

kubectl 構成ファイル内で定義されているクラスターに KEDA をインストールします。

func kubernetes install コマンドでは、次のオプションがサポートされています。

オプション 説明
--dry-run デプロイ テンプレートを実行せずに表示します。
--keda-version インストールする KEDA のバージョンを設定します。 有効なオプションは v1 と v2 です (既定)。
--namespace 特定の Kubernetes 名前空間にインストールします。 設定しない場合は、既定の名前空間が使用されます。

詳細については、 Kubernetes での KEDA と関数の管理を参照してください。

func kubernetes remove

kubectl構成ファイルで定義されている Kubernetes クラスターから KEDA を削除します。

func kubernetes remove

kubectl構成ファイルで定義されているクラスターから KEDA を削除します。

func kubernetes remove コマンドでは、次のオプションがサポートされています。

オプション 説明
--namespace 特定の Kubernetes 名前空間からアンインストールします。 設定しない場合は、既定の名前空間が使用されます。

詳細については、「 Kubernetes からの KEDA のアンインストール」を参照してください。

func settings add

Values内の コレクションに新しい設定を追加します。

func settings add <SETTING_NAME> <VALUE>

<SETTING_NAME>をアプリ設定の名前に置き換えます。

func settings add コマンドでは、次のオプションがサポートされています。

オプション 説明
--connectionString 名前と値の組を ConnectionStrings コレクションではなく Values コレクションに追加します。 ConnectionStrings コレクションは、特定のフレームワークで必要な場合にのみ使用します。 詳細については、 local.settings.json ファイルを参照してください。

func settings decrypt

local.settings.json ファイル内のValues コレクション内の暗号化された値を復号化します。

func settings decrypt

このコマンドは、ConnectionStrings コレクション内の接続文字列値も復号化します。 また、local.settings.json では、IsEncrypted が false に設定されます。 貴重な情報が local.settings.json から漏洩するリスクを減らすために、ローカル設定は暗号化されます。 Azureでは、アプリケーション設定は常に暗号化されて格納されます。

func settings delete

Values内の コレクションから既存の設定を削除します。

func settings delete <SETTING_NAME>

<SETTING_NAME> はアプリ設定の名前に、<VALUE> はその設定の値に置き換えます。

func settings delete コマンドでは、次のオプションがサポートされています。

オプション 説明
--connectionString Values コレクションではなく、ConnectionStrings コレクションから名前と値のペアを削除します。

func settings encrypt

Valuesの コレクション内にある個々の項目の値を暗号化します。

func settings encrypt

ConnectionStrings コレクション内の接続文字列の値も暗号化されます。 また、local.settings.json では、IsEncrypted が true に設定されます。これにより、ローカル ランタイムが設定を使用する前に暗号化を解除することが指定されます。 貴重な情報が local.settings.json から漏洩するリスクを減らすために、ローカル設定は暗号化されます。 Azureでは、アプリケーション設定は常に暗号化された状態で格納されます。

func settings list

Values内の コレクションに設定のリストを出力します。

func settings list

出力には、 ConnectionStrings コレクションからの接続文字列も含まれます。 既定では値はセキュリティのためにマスクされます。 --showValue オプションを使用すると、実際の値を表示することができます。

func settings list コマンドでは、次のオプションがサポートされています。

オプション 説明
--showValue、-a マスクされていない実際の値を出力に表示します。

func templates list

使用可能な関数 (トリガー) テンプレートを一覧表示します。

func templates list コマンドでは、次のオプションがサポートされています。

オプション 説明
--language、-l 返されたテンプレートをフィルター処理するための言語。 既定ですべての言語を返します。

グローバル オプション

これらのオプションは、ほとんどの Core Tools コマンドで使用できます。

オプション 説明
--script-root 関数アプリのルート ディレクトリを設定し、コマンドの作業ディレクトリを変更します。
--verbose 詳細なログ記録の詳細出力を有効にします。 すべてのコマンドではサポートされていません。
--offline 外部ネットワーク呼び出しを行わずにオフライン モードで実行されます。 func start、func init、およびfunc newでサポートされます。 FUNCTIONS_CORE_TOOLS_OFFLINE環境変数を使用して設定することもできます。
--version、-v Azure Functions Core Tools のバージョンを表示します。
--help、-h ヘルプ情報を表示します。
--pause-on-error プロセスを終了する前に、追加の入力を一時停止します。 統合開発環境 (IDE) から Core Tools を起動するときに便利です。
  • Last updated on