我尝试将Azure的使用费用发布到Teams的频道中【订阅-日报编】
总结
将这篇文章中的Python程序注册到Azure Functions并自动运行，然后将结果作为Temas公司信息共享工具中的渠道POST，并希望能够在Azure使用费用减少的同时，提供一点帮助。
执行环境
macOS Big Sur 11.1
python 3.8.3
Azure CLI 2.28.0
Azure Functions Core Tools 3.0.3785
Azure Function Runtime Version: 3.2.0.0
macOS Big Sur 11.1
Python 3.8.3
Azure CLI 2.28.0
Azure 函数核心工具 3.0.3785
Azure 函数运行时版本：3.2.0.0
事前的准备
创建用于执行程序的 ServicePrincipal
根据这篇文章，ServicePrincipal的客户端密钥默认的有效期是一年，最长可以设置为两年。因此，我们可以通过Azure CLI按照以下步骤创建一个有效期为29年的ServicePrincipal（目前为止，已成功地创建）。
## 使用するテナントのAzure環境へのログイン
$ az login --tenant <tenant_id>
## 最初は２年で作成します（ロール割当なしで）
$ az ad sp create-for-rbac --name <ServicePrincial名> --skip-assignment --years 2
## 作成された内容を取得できることを確認します（いきなり29年で作成した場合、取得できません、、、）
$ az ad sp list --display-name <ServicePrincial名>
## その後、29年で再作成します（ロール割当なしで）
$ az ad sp create-for-rbac --name <ServicePrincial名> --skip-assignment --years 29
{
"appId": "xxxxxxxx-xxxx-4633-8080-xxxxxxxxxxxx", --> 関数アプリの構成で AZURE_CLIENT_ID として登録
"displayName": "<ServicePrincial名>",
"name": "xxxxxxxx-xxxx-4633-8080-xxxxxxxxxxxx",
"password": "hogehogehogehogehogehogehogehogege", --> 関数アプリの構成で AZURE_CLIENT_SECRET として登録
"tenant": "zzzzzzzz-cccc-4645-5757-zzzzzzzzzzzz" --> 関数アプリの構成で AZURE_TENANT_ID として登録
}
## 必要なスコープに必要なロールを割り与えます
## 今回は複数Subscriptionの利用料金を取得したいので、スコープ：Subscription ロール：Reader とします
$ APP_ID=$(az ad sp list --display-name <ServicePrincial名> --query '[].{ID:appId}' --output tsv)
$ az role assignment create --assignee $APP_ID --scope /subscriptions/<xxx-SubscriptionID> --role Reader
$ az role assignment create --assignee $APP_ID --scope /subscriptions/<yyy-SubscriptionID> --role Reader
$ az role assignment create --assignee $APP_ID --scope /subscriptions/<zzz-SubscriptionID> --role Reader
为通知程序执行结果而进行的Teams设置。
为了在Teams的频道中收到执行结果的通知，请按照这篇文章中的”事前准备”步骤，并进行Webhook的设置。将生成的Webhook URL复制下来。这个URL在配置函数应用程序时需要注册为ENDPOINT_TECH。
在Azure上创建所需的项目。
## 使用サブスクリプションを定義します
$ az account set --subscription '<Subscription名>'
## リソースグループの作成
$ az group create --resource-group <ResourceGroup名> --location japaneast
## ストレージアカウントの作成
az storage account create --name <StorageAccount名> --resource-group <ResourceGroup名> --location japaneast --sku Standard_LRS
## Functions（関数アプリ）の作成
az functionapp create ---resource-group <ResourceGroup名> --name <Functions名> --storage-account <StorageAccount名> --runtime python --runtime-version 3.7 --consumption-plan-location japaneast --os-type Linux --functions-version 2
## 作成した関数アプリの構成設定
### 関数アプリ実行のための ServicePrincipal 情報の定義
az functionapp config appsettings set -n <Functions名> -g <ResourceGroup名> \
--settings "AZURE_TENANT_ID=zzzzzzzz-cccc-4645-5757-zzzzzzzzzzzz"
az functionapp config appsettings set -n <Functions名> -g <ResourceGroup名> \
--settings "AZURE_CLIENT_ID=xxxxxxxx-xxxx-4633-8080-xxxxxxxxxxxx"
az functionapp config appsettings set -n <Functions名> -g <ResourceGroup名> \
--settings "AZURE_CLIENT_SECRET=hogehogehogehogehogehogehogehogege"
### 関数アプリの実行結果をTeamsのチャネルにPOST（Webhook)するための定義
az functionapp config appsettings set -n <Functions名> -g <ResourceGroup名> \
--settings "ENDPOINT_TECH=https://nnn.webhook.office.com/webhookb2/xxx/IncomingWebhook/yyy/zzz"
### 定義情報の確認
az functionapp config appsettings list -n <Functions名> -g <ResourceGroup名> -o table
创建本地环境以供功能使用
## Functionのプロジェクトディレクトリの作成
(base)$ mkdir Functions
(base)$ cd Functions
## プロジェクト用のPython仮想環境の構築
(base)$ python -m venv .venv
(base)$ source .venv/bin/activate
(.venv) (base)$ python --version
Python 3.8.3
## Functionのプロジェクトの作成
(.venv) (base)$ func init CostSummary --python
Writing requirements.txt
Writing .funcignore
Writing .gitignore
Writing host.json
Writing local.settings.json
Writing /Users/ituru/MyDevelops/AzureCostManagement/Functions/CostSummary/.vscode/extensions.json
## Functionの作成
(.venv) (base)$ cd CostSummary
(.venv) (base)$ func new
Select a number for template:
1. Azure Blob Storage trigger
2. Azure Cosmos DB trigger
3. Durable Functions activity
4. Durable Functions entity
5. Durable Functions HTTP starter
6. Durable Functions orchestrator
7. Azure Event Grid trigger
8. Azure Event Hub trigger
9. HTTP trigger
10. Kafka output
11. Kafka trigger
12. Azure Queue Storage trigger
13. RabbitMQ trigger
14. Azure Service Bus Queue trigger
15. Azure Service Bus Topic trigger
16. Timer trigger
Choose option: 16
Timer trigger
Function name: [TimerTrigger] CostSummaryDaily
Writing /Users/ituru/MyDevelops/AzureCostManagement/Functions/CostSummary/CostSummaryDaily/readme.md
Writing /Users/ituru/MyDevelops/AzureCostManagement/Functions/CostSummary/CostSummaryDaily/__init__.py
Writing /Users/ituru/MyDevelops/AzureCostManagement/Functions/CostSummary/CostSummaryDaily/function.json
The function "CostSummaryDaily" was created successfully from the "Timer trigger" template.
## ディレクトリ構成の確認
(.venv) (base)$ tree -a
.
├── .funcignore
├── .gitignore
├── .vscode
│ └── extensions.json
├── CostSummaryDaily
│ ├── __init__.py
│ ├── function.json
│ └── readme.md
├── getting_started.md
├── host.json
├── local.settings.json
└── requirements.txt
2 directories, 10 files
嵌入式的Python程序执行
执行程序
import logging
import azure.functions as func
import os
import time
import json
from datetime import datetime, timezone, timedelta
from azure.identity import DefaultAzureCredential
from azure.mgmt.resource import SubscriptionClient
from azure.mgmt.costmanagement import CostManagementClient
import requests
import pandas as pd
# Teams_endpoint = 'Microsoft Teamsの チャネルエンドポイント(Webhook)'
TEAMS_ENDPOINT = {
"TECH_ALL": os.environ['ENDPOINT_TECH']
}
# 接続しているテナントのサブスクリプションを操作するオブジェクトを取得
def GetSubscriptionObject():
subscription_client = SubscriptionClient(
credential=DefaultAzureCredential()
)
return subscription_client
# CostManagement情報 を操作するオブジェクトを取得
def GetCostManagementObject():
costmgmt_client = CostManagementClient(
credential=DefaultAzureCredential()
)
return costmgmt_client
# 指定した Subscription について CostManagement からコストを取得
def GetCostManagement(costmgmt_client, subs_id):
# Query costmanagement
SCOPE = '/subscriptions/{}'.format(subs_id)
costmanagement = costmgmt_client.query.usage(
SCOPE,
{
"type": "Usage",
"timeframe": "MonthToDate",
"dataset": {
"granularity": "None",
"aggregation": {
"totalCost": {
"name": "PreTaxCost",
"function": "Sum"
}
},
"grouping": [
{
"type": "Dimension",
"name": "ResourceGroup"
}
]
}
}
)
return costmanagement
# サブスクリプションIDを指定しリソースグループ毎に CostManagement情報を取得
def GetSubscriptionCsotManagement(day0):
# サブスクリプションを操作するオブジェクトの取得
subscription_list = GetSubscriptionObject()
# CostManagementを操作するオブジェクトの取得
costmgmt_client = GetCostManagementObject()
# 取得コストの キーと値
row_key = ["Subscription", "UsageCost"]
row_value = []
# サブスクリプション毎に CostManagement からコストを取得
for n, subs in enumerate(subscription_list.subscriptions.list()):
logging.info("\nサブスクリプション ： {}".format(subs.display_name))
costmanagement = GetCostManagement(costmgmt_client, subs.subscription_id)
# rowsカラムデータを取得し、コストの合計値の取得
SubTotalCost = sum(cost[0] for cost in costmanagement.rows)
# 表示させるコストデータのリスト化
if SubTotalCost > 0 :
val = [subs.display_name, round(SubTotalCost)]
row_value.append(val)
# 取得したコスト情報を辞書型に変換
row_dict = [dict(zip(row_key,item)) for item in row_value]
# コストで降順ソートする
rows = sorted(row_dict, key=lambda x:x['UsageCost'], reverse=True)
logging.info(rows)
# 取得したデータを DataFrame化から markdown 形式に変換
df=pd.DataFrame(rows)
teames_post_str = df.to_markdown()
# コストの合計値の取得
TotalCost = sum(cost[1] for cost in row_value)
logging.info("\n コスト合計: ¥{:,}".format(TotalCost) + "\n")
costmgmt_client.close()
subscription_list.close()
# TeamsEndpointへのPOST
teams_endpoint_post_summary(teames_post_str, '{:,}'.format(TotalCost), day0)
# TeamsEndpointへのデータPOST（まとめ）
def teams_endpoint_post_summary(teames_post_str, TotalCost, day0):
# Microsoft Teams へ送信する下ごしらえ
request = {
'title': '【 Azure : ' + day0 + ' 】 合計： ¥ ' + TotalCost,
'text': teames_post_str
}
# 環境変数の確認
try :
endpointurl = TEAMS_ENDPOINT['TECH_ALL']
except KeyError :
logging.info("\n ENDPOINTの環境変数が定義されていません！")
return
# Microsoft Teams へ送信する
response = requests.post(endpointurl, json.dumps(request))
logging.info(response)
def main(mytimer: func.TimerRequest) -> None:
# 日本時間の取得
JST = timezone(timedelta(hours=+9), 'JST')
today = datetime.now(JST)
if mytimer.past_due:
logging.info('■ ■ ■ The timer is past due! ■ ■ ■')
logging.info('■ ■ ■ Python timer trigger function (func-CostSummary) ran at %s ■ ■ ■', today)
start = time.time()
GetSubscriptionCsotManagement(today.strftime("%Y-%m-%d"))
generate_time = time.time() - start
logging.info("処理時間:{0}".format(generate_time) + " [sec]")
定义所需的Python软件包来执行
azure-functions
azure-identity
azure-mgmt-resource
azure-mgmt-costmanagement
tabulate
requests
pandas
設定執行時間表（定時觸發器）。
每天在日本时间17:20:00（每天在协调世界时8:20:00）执行。
{
"scriptFile": "__init__.py",
"bindings": [
{
"name": "mytimer",
"type": "timerTrigger",
"direction": "in",
"schedule": "0 20 8 * * *"
}
]
}
本地测试
运行程序
## Pythonパッケージのインストール
(.venv) (base)$ pip install -r requirements.txt
## Azure Functions 構成情報のローカルに設定
(.venv) (base)$ func azure functionapp fetch-app-settings <Functions名>
App Settings:
Loading FUNCTIONS_WORKER_RUNTIME = *****
Loading FUNCTIONS_EXTENSION_VERSION = *****
Loading AzureWebJobsStorage = *****
Loading WEBSITE_CONTENTAZUREFILECONNECTIONSTRING = *****
Loading WEBSITE_CONTENTSHARE = *****
Loading APPINSIGHTS_INSTRUMENTATIONKEY = *****
Loading AZURE_TENANT_ID = *****
Loading AZURE_CLIENT_ID = *****
Loading AZURE_CLIENT_SECRET = *****
Loading ENDPOINT_TECH = *****
Connection Strings:
## ローカル環境での実行
(.venv) (base)$ source ../.venv/bin/activate
(.venv) (base)$ func start --verbose
Found Python version 3.8.3 (python3).
%%%%%%
%%%%%%
@ %%%%%% @
@@ %%%%%% @@
@@@ %%%%%%%%%%% @@@
@@ %%%%%%%%%% @@
@@ %%%% @@
@@ %%% @@
@@ %% @@
%%
%
Azure Functions Core Tools
Core Tools Version: 3.0.3785 Commit hash: db6fe71b2f05d09757179d5618a07bba4b28826f (64-bit)
Function Runtime Version: 3.2.0.0
:
省略
:
[2021-10-02T03:48:00.398Z] Host started (526ms)
[2021-10-02T03:48:00.398Z] Job host started
[2021-10-02T03:48:04.946Z] Host lock lease acquired by instance ID '000000000000000000000000FFFFFFFF'.
:
省略
:
将应用程序部署到Azure
执行部署
(.venv) (base)$ func azure functionapp publish <Functions名>
Uploading 7.01 KB [###############################################################################]
Remote build in progress, please wait...
:
省略
:
Uploading built content /home/site/artifacts/functionappartifact.squashfs for linux consumption function app...
Resetting all workers for func-costsummary.azurewebsites.net
Deployment successful.
Remote build succeeded!
Syncing triggers...
Functions in func-CostSummary:
CostSummaryDaily - [timerTrigger]
只需要在时间到达时确认每天的Azure使用费用通知是否发送到Teams指定的频道。
总结
虽然遇到了各种问题，但终于成功在Azure Functions上运行了我自己开发的Python程序。Azure Function 好麻烦，我希望能够有像AWS一样简单顺畅的体验。
请参考下文
看到以下的文章，我受益匪浅，非常感谢。
在Mac上安装Python3并配置环境【最终版】
