Azure カスタムリソースプロバイダーのリソースオンボードの概要

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

Azure カスタムリソースプロバイダーリソースのオンボードは、Azure リソースの種類の拡張モデルです。これにより、既存の Azure リソースに対して大規模に操作や管理を適用できます。詳細については、Azure カスタムリソースプロバイダーで Azure を拡張する方法に関する説明を参照してください。この記事では、次の内容について説明します。

リソースのオンボードでできること。
リソースのオンボードの基本事項および使用方法。
作業を開始するためのガイドとコードサンプルを見つけられる場所

重要

現在、カスタムリソースプロバイダーはパブリックプレビュー段階です。このプレビューバージョンはサービスレベルアグリーメントなしで提供されており、運用環境のワークロードに使用することは推奨されません。特定の機能はサポート対象ではなく、機能が制限されることがあります。詳しくは、Microsoft Azure プレビューの追加使用条件に関するページをご覧ください。

リソースのオンボードでできること

Azure カスタムリソースプロバイダーのカスタムリソースと同様に、リソースのオンボードはエンドポイントへの "オンボード" 要求をプロキシするコントラクトを定義します。カスタムリソースとは異なり、リソースのオンボードでは新しいリソースの種類は作成されません。代わりに、既存のリソースの種類を拡張することができます。また、リソースのオンボードは Azure Policy と連携するため、リソースの管理と構成を大規模に行うことができます。リソースのオンボードのワークフローの例を次に示します。

仮想マシン拡張機能に対してインストールおよび管理を行う。
Azure ストレージアカウントの既定値をアップロードして構成する。
ベースライン診断設定を大規模に有効にする。

リソースのオンボードの基本事項

Azure カスタムリソースプロバイダーを使用してリソースのオンボードを構成するには、Microsoft.CustomProviders/resourceProviders および Microsoft.CustomProviders/associations のリソースの種類を使用します。カスタムリソースプロバイダーのリソースのオンボードを有効にするには、構成プロセス中に、"Extension" を含む routingType で、"associations" という resourceType を作成します。 Microsoft.CustomProviders/associations と Microsoft.CustomProviders/resourceProviders は、同じリソースグループに属している必要はありません。

Azure カスタムリソースプロバイダーの例を次に示します。

{
  "properties": {
    "resourceTypes": [
      {
        "name": "associations",
        "routingType": "Proxy,Cache,Extension",
        "endpoint": "https://microsoft.com/"
      }
    ]
  },
  "location": "eastus"
}

プロパティ	必須	説明
name	はい	エンドポイント定義の名前。リソースのオンボードの場合、名前は "associations" である必要があります。
routingType	はい	エンドポイントとのコントラクトの種類を決定します。リソースのオンボードの場合、有効な routingTypes は "Proxy,Cache,Extension" および "Webhook,Cache,Extension" です。
endpoint	はい	要求をルーティングするエンドポイント。これにより、応答と、要求の副作用がすべて処理されます。

associations のリソースの種類でカスタムリソースプロバイダーを作成すると、Microsoft.CustomProviders/associations を使用してターゲットを指定できます。 Microsoft.CustomProviders/associations は、他のすべての Azure リソースを拡張できる拡張リソースです。 Microsoft.CustomProviders/associations のインスタンスが作成されると、それは targetResourceId プロパティを取得します。これは、有効な Microsoft.CustomProviders/resourceProviders または Microsoft.Solutions/applications リソース ID である必要があります。このような場合、要求は、作成した Microsoft.CustomProviders/resourceProviders インスタンスの associations のリソースの種類に転送されます。

Note

Microsoft.Solutions/applications リソース ID が targetResourceId として指定されている場合は、"public" という名前の管理対象リソースグループにデプロイされた Microsoft.CustomProviders/resourceProviders が必要です。

Azure カスタムリソースプロバイダーの関連付けの例:

{
  "properties": {
    "targetResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}",
    ...
  }
}

プロパティ	必須	説明
targetResourceId	はい	Microsoft.CustomProviders/resourceProviders または Microsoft.Solutions/applications のリソース ID。

リソースのオンボードの使用方法

リソースのオンボードは、Microsoft.CustomProviders/associations 拡張リソースで他のリソースを拡張することによって機能します。次の例では、要求は仮想マシンに対して行われますが、どのリソースも拡張できます。

まず、associations のリソースの種類を持つカスタムリソースプロバイダーリソースを作成します。これにより、カスタムリソースプロバイダーをターゲットとする、対応する Microsoft.CustomProviders/associations リソースが作成されたときに使用されるコールバック URL が宣言されます。

Microsoft.CustomProviders/resourceProviders の作成要求の例:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

{
  "properties": {
    "resourceTypes": [
      {
        "name": "associations",
        "routingType": "Proxy,Cache,Extension",
        "endpoint": "https://{myCustomEndpoint}/"
      }
    ]
  },
  "location": "{location}"
}

カスタムリソースプロバイダーを作成したら、他のリソースをターゲットにして、カスタムリソースプロバイダーの副作用をそれらに適用できます。

Microsoft.CustomProviders/associations の作成要求の例:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.CustomProviders/associations/{associationName}?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

{
  "properties": {
    "targetResourceId": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}",
    "myProperty1": "myPropertyValue1",
    "myProperty2": {
        "myProperty3" : "myPropertyValue3"
    }
  }
}

この要求は、作成したカスタムリソースプロバイダーで指定したエンドポイントに転送されます。これは、次の形式で targetResourceId によって参照されます。

PUT https://{endpointURL}/?api-version=2018-09-01-preview
Content-Type: application/json
X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/associations/{associationName}
X-MS-CustomProviders-ExtensionPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}/providers/Microsoft.CustomProviders/associations/{associationName}
X-MS-CustomProviders-ExtendedResource: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}

{
  "properties": {
    "myProperty1": "myPropertyValue1",
    "myProperty2": {
        "myProperty3" : "myPropertyValue3"
    }
  }
}

エンドポイントは、application/json Content-Type と有効な JSON 応答本文で応答する必要があります。 JSON の properties オブジェクトの下で返されるフィールドは、関連付けの返される応答に追加されます。

ヘルプの表示

Azure カスタムリソースプロバイダーの開発に関する質問がある場合、Stack Overflow で確認してみてください。同様の質問が既に回答されていることもあるため、投稿する前にまず確認してください。 azure-custom-providers タグを追加して早く応答を受け取りましょう。

次のステップ

この記事では、カスタムリソースプロバイダーについて学習しました。詳細については、次の記事を参照してください。

Azure カスタム リソース プロバイダーのリソース オンボードの概要