次の方法で共有

Azure Functions Core Tools リファレンス

  • [アーティクル]

この記事は、Azure Functions Core Tools のリファレンス ドキュメントです。このドキュメントを使用して、お使いのローカル コンピューターから、Azure Functions プロジェクトを開発、管理、デプロイすることができます。 Core Tools の使用の詳細については、「Azure Functions Core Tools の操作」を参照してください。

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

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

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

func init

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

func init <PROJECT_FOLDER>

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

func init では、次のオプションをサポートします。特に注意書きがない限り、バージョン 1.x はサポートしません。

オプション 説明
--csx .NET 関数を C# スクリプトとして作成します。これはバージョン 1.x の動作です。 --worker-runtime dotnet でのみ有効です。
--docker 選択した --worker-runtime に基づく基本イメージを使用して、コンテナーの Dockerfile を作成します。 このオプションは、コンテナー化された関数アプリをデプロイする場合に使用します。
--docker-only 既存のプロジェクトに Dockerfile を追加します。 local.settings.json で設定されていないか指定されていない場合、worker ランタイムのプロンプトを表示します。 このオプションは、コンテナー化された関数アプリをデプロイしようとしていて、プロジェクトが既に存在する場合に使用します。
--force プロジェクトに既存のファイルがある場合でも、プロジェクトを初期化します。 この設定は、同じ名前の既存のファイルを上書きします。 プロジェクト フォルダー内の他のファイルには影響ありません。
--language 言語固有のプロジェクトを初期化します。 現時点では、--worker-runtime が node に設定されている場合にサポートされます。 オプションは typescript と javascript です。 --worker-runtime javascript または --worker-runtime typescript を使用することもできます。
--managed-dependencies マネージドの依存関係をインストールします。 現時点では、この機能は PowerShell worker ランタイムのみでサポートされています。
--model 複数のモデルが使用可能な場合に、ターゲット言語に必要なプログラミング モデルを設定します。 サポートされているオプションは、Python 用の V1 と V2、および Node.js 用の V3 と V4 です。 詳細については、 Python 開発者ガイド と 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 でのみ有効です。 サポートされている値は、 net9.0 (プレビュー)、 net8.0 (既定)、 net6.0、 net48 (.NET Framework 4.8) です。

Note

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

func logs

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

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

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

オプション 説明
--platform 関数アプリのホスティング プラットフォーム。 サポートされているオプション: kubernetes。
--name Azure 内での関数アプリの名前。

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

func new

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

func new

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

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

オプション 説明
--authlevel HTTP トリガーの承認レベルを設定できます。 サポートされる値は function、anonymous、admin です。 ローカルで実行される場合、承認は適用されません。 詳細については、「認可レベル」を参照してください。
--csx (バージョン 2.x 以降のバージョン。)バージョン 1.x およびポータルで使用されるものと同じ C# スクリプト (.csx) テンプレートを生成します。
--language, -l テンプレート プログラミング言語。C#、F#、JavaScript など。 このオプションは、バージョン 1.x で必須です。 バージョン2.x 以降のバージョンでは、言語はワーカー ランタイムによって定義されているため、このオプションは使用しません。
--name, -n 関数名。
--template, -t サポートされている各言語で使用可能なテンプレートの完全な一覧を表示するには、func templates list コマンドを使います。

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

func run

バージョン 1.x のみ。

関数を直接呼び出せるようにします。Azure portal 内の [テスト] タブを使用して関数を実行するのと似ています。 このアクションは、バージョン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 と Authentication ヘッダーを使用して、クロスオリジン認証済み要求を許可します。
--dotnet-isolated-debug true に設定されている場合、デバッグ対象の .NET 分離プロジェクトからデバッガーがアタッチされるまで、.NET ワーカー プロセスを一時停止します。
--enable-json-output 可能な場合は、コンソール ログを JSON として出力します。
--enableAuth 認可要件を備えた完全な認証処理パイプラインを有効にします。
--functions 読み込まれる関数のスペース区切りリスト。
--language-worker 言語ワーカーを構成するための引数。 たとえば、デバッグ ポートとその他の必要な引数を指定して、言語ワーカーのデバッグを有効にすることができます。
--no-build 実行前に現在のプロジェクトをビルドしません。 .NET クラス プロジェクトのみ。 既定値は、false です。
--password .pfx ファイルのパスワードまたはパスワードが格納されているファイルのいずれか。 --cert でのみ使用されます。
--port ローカル ポート。このポートでリッスンします。 既定値:7071。
--timeout Functions ホスト開始のタイムアウト (秒単位)。 既定値は20 秒。
--useHttps http://localhost:{port} ではなく https://localhost:{port} にバインドします。 既定では、このオプションにより、信頼された証明書がコンピューターに作成されます。

プロジェクトが実行中の場合に、個々の関数エンドポイントを確認できます。

func azure functionapp fetch-app-settings

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

func azure functionapp fetch-app-settings <APP_NAME>

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

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

func azure functionapp list-functions

指定された関数アプリ内の関数のリストを返します。

func azure functionapp list-functions <APP_NAME>

func azure functionapp logstream

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

func azure functionapp logstream <APP_NAME>

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

deploy アクションでは、次のオプションがサポートされています。

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

詳しくは、「Azure Functions で実行ログのストリーミングを有効にする」をご覧ください。

func azure functionapp publish

Azure 内の既存の function app リソースに Functions プロジェクトをデプロイします。

func azure functionapp publish <APP_NAME>

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

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

オプション 説明
--access-token 認証された azure アクションを実行するときに、特定のアクセス トークンを使用できます。
--access-token-stdin 標準入力から特定のアクセス トークンを読み取ります。 これは、az account get-access-token などの前のコマンドからトークンを直接読み取る場合に使用します。
--additional-packages ネイティブの依存関係を構築するときにインストールするパッケージの一覧 (例: python3-dev libevent-dev)。
--build, -b Linux 関数アプリにデプロイするときにビルド アクションを実行します。 remote および local を受け入れます。
--build-native-deps Python 関数アプリを発行するときに、.wheels フォルダーの生成をスキップします。
--csx C# スクリプト (.csx) プロジェクトを発行します。
--dotnet-cli-params コンパイル済み C# (.csproj) 関数を発行するとき、Core Tools によって dotnet build --output bin/publish が呼び出されます。 これに渡されるすべてのパラメーターは、コマンド ラインに追加されます。
--force 特定のシナリオで発行前の検証を無視します。
--list-ignored-files 発行時に無視されるファイルの一覧を表示します。これは、.funcignore ファイルに基づきます。
--list-included-files 発行されるファイルの一覧を表示します。これは、.funcignore ファイルに基づきます。
--management-url クラウドの管理 URL を設定します。 ソブリン クラウドで実行する場合は、これを使用します。
--no-build プロジェクトは発行中にはビルドされません。 Python の場合、pip install は実行されません。
--nozip 既定の Run-From-Package モードをオフにします。
--overwrite-settings -y --publish-local-settings -i を使用するときに、アプリの設定を上書きするプロンプトを抑制します。
--publish-local-settings -i local.settings.json の設定を Azure に発行し、設定が既に存在する場合は上書きを促します。 ローカル ストレージ エミュレーターを使用している場合は、まずアプリ設定を実際のストレージ接続に変更します。
--publish-settings-only, -o 設定のみを発行し、コンテンツをスキップします。 既定値は prompt です。
--slot 発行先の特定のスロットの名前 (省略可能)。
--subscription 使用する既定のサブスクリプションを設定します。

func azure storage fetch-connection-string

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

func azure storage fetch-connection-string <STORAGE_ACCOUNT_NAME>

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

func azurecontainerapps deploy

コンテナー化された関数アプリを Azure Container Apps 環境にデプロイします。 使用されるストレージ アカウントが関数アプリと環境の両方で既に存在している必要があります。 詳細については、「Azure Functions の Azure 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>

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

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

重要

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

func deploy

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

func durable delete-task-hub

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

func durable delete-task-hub

delete-task-hub アクションでは、次のオプションがサポートされています。

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

詳細については、Durable Functions のドキュメントをご覧ください。

func durable get-history

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

func durable get-history --id <INSTANCE_ID>

get-history アクションでは、次のオプションがサポートされています。

オプション 説明
--id オーケストレーション インスタンスの ID を指定します (必須)。
--connection-string-setting 使用するストレージ接続文字列を含む設定の名前 (省略可能)。
--task-hub-name 使用する持続的なタスク ハブの名前 (省略可能)。

詳細については、Durable Functions のドキュメントをご覧ください。

func durable get-instances

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

func durable get-instances

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>

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

purge-history アクションでは、次のオプションがサポートされています。

オプション 説明
--connection-string-setting 使用するストレージ接続文字列を含む設定の名前 (省略可能)。
--created-after 必要に応じて、この日付/時刻 (UTC) より後に作成されたインスタンスの履歴を削除します。 ISO 8601 形式のすべての datetime 値が受け入れられます。
--created-before 必要に応じて、この日付/時刻 (UTC) より前に作成されたインスタンスの履歴を削除します。 ISO 8601 形式のすべての datetime 値が受け入れられます。
--runtime-status 必要に応じて、completd、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>

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>

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>

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>

terminate アクションでは、次のオプションがサポートされています。

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

詳細については、Durable Functions のドキュメントをご覧ください。

func extensions install

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

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

install アクションでは、次のオプションがサポートされています。

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

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

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

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

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

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

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

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

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

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

func extensions sync

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

sync アクションでは、次のオプションがサポートされています。

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

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

func kubernetes deploy

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

func kubernetes deploy

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

次の Kubernetes デプロイ オプションを使用できます。

オプション 説明
--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 ビルドが実行され、その名前のレジストリにイメージがプッシュされます。 --image-name で --registry を使用することはできません。 Docker の場合は、ユーザー名を使用します。
--polling-interval HTTP 以外のトリガーをチェックするためのポーリングの間隔 (秒単位)。 既定値は 30 秒です。
--pull-secret プライベート レジストリの資格情報にアクセスするために使用されるシークレット。
--secret-name デプロイ内で使用する関数アプリの設定を含む既存の Kubernetes シークレット コレクションの名前。 既定の動作は、local.settings.jsonファイルの Values オブジェクトに基づいた設定の作成です。
--show-service-fqdn IP アドレスを使用する既定の動作ではなく、Kubernetes FQDN を使用した HTTP トリガーの URL を表示します。
--service-type Kubernetes Service の種類を設定します。 サポートされる値は、ClusterIP、NodePort、LoadBalancer (既定) です。
--use-config-map Secret オブジェクト (v1) ではなく ConfigMap オブジェクト (v1) を使用して、関数アプリの設定を構成します。 マップ名は、--config-map-name を使用して設定されます。

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

詳細については、「Kubernetes への関数アプリのデプロイ」を参照してください。

func kubernetes install

Kubernetes クラスターに KEDA をインストールします。

func kubernetes install

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

install アクションでは、次のオプションがサポートされています。

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

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

func kubernetes remove

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

func kubernetes remove

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

remove アクションでは、次のオプションがサポートされています。

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

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

func settings add

local.settings.jsonファイル内の Values コレクションに新しい設定を追加します。

func settings add <SETTING_NAME> <VALUE>

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

add アクションでは、次のオプションがサポートされています。

オプション 説明
--connectionString 名前と値の組を Values コレクションではなく ConnectionStrings コレクションに追加します。 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

local.settings.jsonファイル内の Values コレクションから既存の設定を削除します。

func settings delete <SETTING_NAME>

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

delete アクションでは、次のオプションがサポートされています。

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

func settings encrypt

local.settings.jsonファイルの Values コレクション内にある個々の項目の値を暗号化します。

func settings encrypt

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

func settings list

local.settings.jsonファイル内の Values コレクションに設定のリストを出力します。

func settings list

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

list アクションでは、次のオプションがサポートされています。

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

func templates list

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

list アクションでは、次のオプションがサポートされています。

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