カスタムリソースプロバイダーを作成して使用する

[アーティクル]
06/01/2023

カスタムリソースプロバイダーは、Azure とエンドポイントの間のコントラクトです。カスタムリソースプロバイダーを使って、Azure 上のワークフローを変更できます。このチュートリアルでは、カスタムリソースプロバイダーを作成する手順について説明します。 Azure カスタムリソースプロバイダーについてなじみがない場合は、Azure カスタムリソースプロバイダーの概要に関するページを参照してください。

カスタムリソースプロバイダーの作成

Note

このチュートリアルでは、エンドポイントの作成方法については取り上げません。 RESTFUL エンドポイントがない場合は、このチュートリアルの土台となっている、RESTful エンドポイントの作成に関するチュートリアルに従ってください。

エンドポイントを作成した後は、カスタムリソースプロバイダーを作成して、プロバイダーとエンドポイントの間のコントラクトを生成できます。カスタムリソースプロバイダーで、エンドポイント定義のリストを指定できます。

{
  "name": "myEndpointDefinition",
  "routingType": "Proxy",
  "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
}

プロパティ	必須	説明
name	はい	エンドポイント定義の名前。この名前は、次の場所の対応する API を通じて公開されます: /subscriptions/<サブスクリプション ID>/resourceGroups/<リソースグループ名>/providers/Microsoft.CustomProviders /resourceProviders/<リソースプロバイダー名>/<エンドポイント定義名>
routingType	いいえ	エンドポイントのコントラクトの種類。この値が指定されなかった場合は、"Proxy" が既定値となります。
endpoint	はい	要求をルーティングするエンドポイント。このエンドポイントによって応答が処理され、また要求の副作用があればそれも処理されます。

Azure 関数アプリのトリガー URL が endpoint の値になります。 <yourapp>、<funcname>、<functionkey> の各プレースホルダーは、作成した関数アプリの値に置き換える必要があります。

カスタムアクションとリソースを定義する

カスタムリソースプロバイダーには、actions プロパティと resourceTypes プロパティでモデル化されるエンドポイント定義のリストが含まれます。 actions プロパティは、カスタムリソースプロバイダーによって公開されるカスタムアクションに対応し、resourceTypes プロパティはカスタムリソースを表します。このチュートリアルのカスタムリソースプロバイダーには、myCustomAction という名前の actions プロパティと myCustomResources という名前の resourceTypes プロパティがあります。

{
  "properties": {
    "actions": [
      {
        "name": "myCustomAction",
        "routingType": "Proxy",
        "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
      }
    ],
    "resourceTypes": [
      {
        "name": "myCustomResources",
        "routingType": "Proxy",
        "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
      }
    ]
  },
  "location": "eastus"
}

カスタムリソースプロバイダーをデプロイする

Note

endpoint の値は、前のチュートリアルで作成した関数アプリのトリガー URL に置き換える必要があります。

前に示したカスタムリソースプロバイダーは、Azure Resource Manager テンプレートを使ってデプロイできます。

{
    "$schema": "http://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "resources": [
        {
            "type": "Microsoft.CustomProviders/resourceProviders",
            "name": "myCustomProvider",
            "apiVersion": "2018-09-01-preview",
            "location": "eastus",
            "properties": {
                "actions": [
                    {
                        "name": "myCustomAction",
                        "routingType": "Proxy",
                        "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
                    }
                ],
                "resourceTypes": [
                    {
                        "name": "myCustomResources",
                        "routingType": "Proxy",
                        "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
                    }
                ]
            }
        }
    ]
}

カスタムアクションとカスタムリソースを使用する

カスタムリソースプロバイダーを作成したら、新しい Azure API を使用できます。以下のセクションでは、カスタムリソースプロバイダーを呼び出して使用する方法を説明します。

カスタムアクション

Azure CLI

Note

{subscriptionId} と {resourceGroupName} の各プレースホルダーは、カスタムリソースプロバイダーのデプロイ先のサブスクリプションとリソースグループに置き換える必要があります。

az resource invoke-action --action myCustomAction \
                          --ids /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/myCustomProvider \
                          --request-body
                            '{
                                "hello": "world"
                            }'

パラメーター	必須	説明
action	はい	カスタムリソースプロバイダーで定義されているアクションの名前。
ids	はい	カスタムリソースプロバイダーのリソース ID。
request-body	いいえ	エンドポイントに送信される要求本文。