自動化

Azure関数で環境変数を設定する方法【サーバーとローカルで必要】

azure-environment-variable

PlayFab で Azure 関数を使う場合、リポジトリにコミットしたくない情報は環境変数として管理することが必要です。

この記事では、Azure 関数で環境変数を設定する方法について解説しています。

「サーバー側」と「ローカル側」の2種類で環境変数の設定が必要になるので、注意してください。

では、さっそく見ていきましょう。

Azure 関数で環境変数を設定する方法

サーバー側の環境変数を設定する

Azure 関数にアクセスして実行するときに使える環境変数を登録します。

Azure 公式ドキュメントのアプリケーションの設定にも記載がありますが、Azure ポータルから登録することができます。

まずは、Azure ポータルで「func」と検索し、「関数アプリ」を見つけてクリックします。

azure-environment-variable

環境変数を登録したいアプリを選びます。

azure-environment-variable

左のバーを下にスクロールして、「構成」を選びます。

azure-environment-variable

すると環境変数を登録する画面が出てくるので、「新しいアプリケーション設定」を選びましょう。

ペンギンくん
ペンギンくん
「環境変数」って名前じゃないんだね。
azure-environment-variable

今回は「PLAYFAB_TITLE_ID」という環境変数を登録してみます。

名前と値を入力したらOKしましょう。

azure-environment-variable
ペンギンくん
ペンギンくん
タイトルIDってどこでわかるの?
ねこじょーかー
ねこじょーかー
PlayFabの画面から確認ができるよ!

ここで終わりではありません。

最後に必ず「保存」をしましょう。

azure-environment-variable

ここで登録した「PLAYFAB_TITLE_ID」は、他の記事で使うことになるので残しておきましょう。

また、シークレットキーとして使用する「PLAYFAB_DEV_SECRET_KEY」も合わせて登録をしておくことをおすすめします。

これで、サーバー側の環境変数の設定は完了です。

ローカル側の環境変数を設定する

デバッグをする場合は、ローカルで環境変数を設定する必要があります。

Azure関数の機能を使ってプロジェクトを作成した場合は、「local.settings.json」というファイルができているはずです。

ローカルの場合は、「local.settings.json」に環境変数を登録していきます。

Windows や Mac についている環境変数の登録ではありません。

「Key:Value」の形式で登録することができます。

今回は、PLAYFAB_TITLE_ID PLAYFAB_DEV_SECRET_KEY を登録してみました。

local.settings.json
{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "dotnet",
    "PLAYFAB_DEV_SECRET_KEY": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX", // ←ここ!!
    "PLAYFAB_TITLE_ID": "XXXXX" // ←ここ!!
  }
}

ローカルの場合は、これで準備が整いました。

環境変数の呼び出し方

公式ドキュメントにも記載がありますが、「System.Environment.GetEnvironmentVariable」から取得することができます。

System.Environment.GetEnvironmentVariable("PLAYFAB_TITLE_ID", EnvironmentVariableTarget.Process);

 

ペンギンくん
ペンギンくん
呼び出しは簡単だね。理解できた!

まとめ

Azure 関数で環境変数を設定する方法について解説しました。

秘密にしておきたい情報を普通のクラスの定数として管理してしまうと、public なリポジトリにコミットしてしまうことになります。

情報が悪用されないようにするためにも、環境変数を使うようにしましょう。

最後にまとめを残しておきますね。

Azure 関数を使用した環境変数まとめ

サーバー側
  • Azure ポータルから設定できる
  • Azure 関数を呼び出したときに使用する
ローカル側
  • local.settings.json で設定する
  • デバッグの際に使用する
オンライン書籍「猫でもわかる PlayFab 入門」
playfab-book

日本で初めて、PlayFab の参考書を発売しました。

100時間以上の学習内容を凝縮した参考書です。入門として必要な知識は、すべてこの本に記載しました。

 

COMMENT

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です