Azure WebJobs をリモート デバッグする方法について
こんにちは。日本マイクロソフト Azure CIE サポートです。
今回は、Visual Studio を使用して Azure 上で動作している WebJobs をデバッグする方法についてご案内します。
事前準備
WebJobs をホストしている App Service の設定で、リモート デバッグが有効化されている必要があります。
Azure ポータルから対象の App Service を開き、[アプリケーション設定] の設定項目の中から [リモート デバッグ] を “オン” に設定し、使用する Visual Studio のバージョンを選択して、設定を [保存] してください。
方法 1 : サーバー エクスプローラーからデバッガーをアタッチする方法
本方法では、対象の WebJobs をホストしている App Service のサブスクリプションにおける管理者、共同管理者などの高い権限が必要となりますが、Visual Studio の画面上からの簡単な操作のみで WebJobs のデバッグを行っていただくことができます。以下に、手順をご案内します。
- Visual Studio 上でサーバー エクスプローラーのウィンドウを表示します。サーバー エクスプローラーが非表示になっている場合は、[Ctrl+Alt+S] キーを押下するなどして表示します。
- 対象の Azure サブスクリプション配下のツリーを展開し、デバッグ対象の WebJobs を表示して選択します。
- 右クリック メニューから、[デバッガーのアタッチ] を実行して、Visual Studio を WebJobs にアタッチします。
アタッチに成功したらデバッグ作業を行います。
- デバッグを終了するには、[デバッグ] メニューから [すべてデタッチ] を選択してプロセスからデバッガーをデタッチします。
方法 2 : [プロセスにアタッチ] メニューからデバッガーをアタッチする方法
本方法は、方法 1 とは異なり、発行プロファイルで設定されたユーザー名とパスワードが与えられればデバッグ作業を行うことが可能です。
なお、WebJobs は通常、Kudu と呼ばれる独立した SCM サイト上で動作していますが、本方法をご利用いただくには、予め設定を変更して、SCM サイトも App Service と同一のプロセス上で動作するよう変更されている必要があります。
※ 本設定を適用すると、現在実行中の WebJobs は再起動されますので、事前に本設定を適用していた場合を除き、運用中に発生した問題のトラブルシュートに本方法をご利用いただくことはできません。また、App Service が停止している場合は SCM の機能を使用することができなくなるため、App Service が停止している間は Git や MSDeploy を使用した管理やデプロイ作業を行うことはできなくなる点にご注意ください。
以下に、手順をご案内します。
- Azure ポータルから対象の App Service を開き、[アプリケーション設定] の [アプリ設定] に、以下の定義を追加して [保存] します。
キー : WEBSITE_DISABLE_SCM_SEPARATION
値 : true
これにより、SCM が独立したプロセスではなく App Service と同一のプロセス上で動作するようになります。
本設定を元に戻すには WEBSITE_DISABLE_SCM_SEPARATION を削除するか、キーの値を false に設定します。
- App Service の [概要] メニューから [発行プロファイル取得] を選択するなどして発行プロファイルのユーザー名とパスワードを取得します。
- Visual Studio の [デバッグ] メニューから、[プロセスにアタッチ] を選択します。
- [修飾子] の欄に対象の App Service のホスト名とポート番号 4020 を指定します。ホスト名とポート番号の間はコロン “:” で区切ります。
- 認証ダイアログが表示されたら、手順 2. で確認したユーザー名とパスワードを入力します。
ユーザー名には “ドメイン名\$ユーザー名” の形式で設定されているものを使用します。
- 認証に成功すると [選択可能なプロセス] の一覧が表示されるので、対象の WebJobs プロセスを選択して [アタッチ] を実行します。
アタッチに成功したらデバッグ作業を行います。
- デバッグを終了するには、[デバッグ] メニューから [すべてデタッチ] を選択してプロセスからデバッガーをデタッチします。
ローカル環境ではデバッグ作業を行うことが難しい場合などに、上記の方法がお役に立てましたら幸いです。
本情報の内容 (添付文書、リンク先などを含む) は、作成日時点でのものであり、予告なく変更される場合があります。