カスタム リソースを Azure REST API に追加する

この記事では、カスタム リソースを実装する Azure カスタム リソース プロバイダー エンドポイントの作成に関する要件とベスト プラクティスについて説明します。 Azure カスタム リソースプロバイダーについてよくご存じでない場合は、カスタム リソースプロバイダーの概要に関するページを参照してください。

リソース エンドポイントの定義方法

エンドポイントはサービスを指す URL であり、サービスと Azure 間の基になるコントラクトを実装するものです。 エンドポイントはカスタム リソース プロバイダー内に定義されており、一般にアクセス可能な URL にすることができます。 次のサンプルには、endpointURLによって実装される、myCustomResource と呼ばれるresourceTypeが含まれています。

サンプルの ResourceProvider:

{
  "properties": {
    "resourceTypes": [
      {
        "name": "myCustomResource",
        "routingType": "Proxy, Cache",
        "endpoint": "https://{endpointURL}/"
      }
    ]
  },
  "location": "eastus",
  "type": "Microsoft.CustomProviders/resourceProviders",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}",
  "name": "{resourceProviderName}"
}

リソース エンドポイントの構築

resourceTypeを実装するエンドポイントでは、Azure で新しい API 向けに要求と応答を処理する必要があります。 resourceType のあるカスタム リソース プロバイダーが作成されると、Azure に API の新しいセットが生成されます。 この場合、resourceType により、シングル リソース上で CRUD を実行するための PUT、GET、DELETE 用と、すべての既存リソースを取得するための GET 用に、新しい Azure リソース API が生成されます。

1 つのリソースの操作 (PUT、GET、および DELETE):

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResource/{myCustomResourceName}

すべてのリソースを取得 (GET):

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResource

カスタム リソースの場合、カスタム リソース プロバイダーが 2 種類の routingTypes として "Proxy" および "Proxy, Cache" を提供します。

プロキシのルーティングの種類

"Proxy" routingType は、すべての要求メソッドを、カスタム リソース プロバイダーで指定されたエンドポイントにプロキシします。 "Proxy" を使用するのは次の場合です。

• 応答の完全な制御が必要。
• システムを既存のリソースと統合する。

"Proxy" リソースの詳細については、カスタム リソース プロキシ リファレンスを参照してください

プロキシ キャッシュ ルーティングの種類

"Proxy, Cache" routingType は、PUT および DELETE 要求メソッドのみを、カスタム リソース プロバイダーで指定されたエンドポイントにプロキシします。 カスタム リソース プロバイダーは、そのキャッシュに格納されている内容に基づいて、自動的に GET 要求を返します。 カスタム リソースがキャッシュでマークされている場合、カスタム リソース プロバイダーはさらに応答内のフィールドを追加/上書きして、API を Azure 準拠にします。 "Proxy, Cache" を使用するのは次の場合です。

• 既存のリソースがない新しいシステムを作成する。
• 既存の Azure エコシステムと連携する。

"Proxy, Cache" リソースの詳細については、カスタム リソース キャッシュ リファレンスを参照してください

カスタム リソースの作成

カスタム リソース プロバイダーからカスタム リソースを作成するには、主に 2 つの方法があります。

• Azure CLI
• Azure Resource Manager のテンプレート

Azure CLI

カスタム リソースを作成します。

az resource create --is-full-object \
                   --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{resourceTypeName}/{customResourceName} \
                   --properties \
                    '{
                        "location": "eastus",
                        "properties": {
                            "myProperty1": "myPropertyValue1",
                            "myProperty2": {
                                "myProperty3": "myPropertyValue3"
                            }
                        }
                    }'

Azure のカスタム リソースを削除します。

az resource delete --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{resourceTypeName}/{customResourceName}

Azure のカスタム リソースを取得します。

az resource show --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/{resourceTypeName}/{customResourceName}

Azure Resource Manager テンプレート

Azure Resource Manager テンプレートは、id、name、および type がダウンストリーム エンドポイントから正しく返されることを要求します。 返されるリソース応答は次の形式である必要があります。

エンドポイントの応答のサンプル:

{
  "properties": {
    "myProperty1": "myPropertyValue1",
    "myProperty2": {
        "myProperty3": "myPropertyValue3"
    }
  },
  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{customResourceName}",
  "name": "{customResourceName}",
  "type": "Microsoft.CustomProviders/resourceProviders/{resourceTypeName}"
}

サンプルの Azure Resource Manager テンプレート:

{
    "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "resources": [
        {
            "type": "Microsoft.CustomProviders/resourceProviders/{resourceTypeName}",
            "name": "{resourceProviderName}/{customResourceName}",
            "apiVersion": "2018-09-01-preview",
            "location": "eastus",
            "properties": {
                "myProperty1": "myPropertyValue1",
                "myProperty2": {
                    "myProperty3": "myPropertyValue3"
                }
            }
        }
    ]
}

次のステップ

• Azure カスタム リソースプロバイダーの概要
• クイック スタート: Azure カスタム リソースプロバイダーの作成とカスタム リソースのデプロイ
• チュートリアル:Azure でカスタム アクションとカスタム リソースを作成する
• 方法: カスタム アクションを Azure REST API に追加する
• リファレンス: カスタム リソースのプロキシのリファレンス
• リファレンス: カスタム リソースのキャッシュのリファレンス