Event Subscriptions - Create Or Update

イベント サブスクリプションを作成または更新します。
指定したスコープに基づいて、新しいイベント サブスクリプションを非同期に作成するか、既存のイベント サブスクリプションを更新します。

PUT https://management.azure.com/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}?api-version=2021-10-15-preview

URI パラメーター

Name In Required Type Description
eventSubscriptionName
path True
  • string

イベント サブスクリプションの名前。 イベント サブスクリプション名の長さは 3 ~ 64 文字で、英数字のみを使用する必要があります。

scope
path True
  • string

イベント サブスクリプションを作成または更新する必要があるリソースの識別子。 スコープには、サブスクリプション、リソース グループ、リソース プロバイダー名前空間に属する最上位レベルのリソース、または EventGrid トピックを指定できます。 たとえば、サブスクリプションには '/subscriptions/{subscriptionId}/' を、リソース グループには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' を使用します。 リソースの場合は '/subscriptions/{subscriptionId}/resourceGroupName}/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}'、EventGrid トピックの場合は '/subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' です。

api-version
query True
  • string

クライアント要求で使用する API のバージョン。

要求本文

Name Type Description
properties.deadLetterDestination DeadLetterDestination:

イベント サブスクリプションの配信不能の宛先。 配信不能の宛先に配信できないイベントは、配信不能の宛先に送信されます。 Azure Event Gridの ID を使用して、配信中または配信不能時に使用される認証トークンを取得します。

properties.deadLetterWithResourceIdentity

イベント サブスクリプションの配信不能の宛先。 配信不能の宛先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信中または配信不能時に使用される認証トークンを取得します。

properties.deliveryWithResourceIdentity

イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信中または配信不能時に使用される認証トークンを取得します。

properties.destination EventSubscriptionDestination:

イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信中または配信不能時に使用される認証トークンを取得します。

properties.eventDeliverySchema

イベント サブスクリプションのイベント配信スキーマ。

properties.expirationTimeUtc
  • string

イベント サブスクリプションの有効期限。

properties.filter

イベント サブスクリプションのフィルターに関する情報。

properties.labels
  • string[]

ユーザー定義ラベルの一覧。

properties.retryPolicy

イベントの再試行ポリシー。 これは、配信試行の最大数とイベントの有効期間を構成するために使用できます。

応答

Name Type Description
201 Created

EventSubscription CreateOrUpdate 要求が受け入れ済み。

Other Status Codes

エラー応答: ***

  • 400 無効な要求。

  • 500 内部サーバー エラー :

EventSubscriptions_CreateOrUpdateForCustomTopic
EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination
EventSubscriptions_CreateOrUpdateForResource
EventSubscriptions_CreateOrUpdateForResourceGroup
EventSubscriptions_CreateOrUpdateForSubscription

EventSubscriptions_CreateOrUpdateForCustomTopic

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "EventHub",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_AzureFunctionDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "AzureFunction",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Web/sites/ContosoSite/funtions/ContosoFunc"
      },
      "endpointType": "AzureFunction"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "EventHub",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      },
      "endpointType": "EventHub"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "HybridConnection",
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1"
      },
      "endpointType": "HybridConnection"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusQueueDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "ServiceBusQueue",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/queues/SBQ"
      },
      "endpointType": "ServiceBusQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_ServiceBusTopicDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "ServiceBusTopic",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.ServiceBus/namespaces/ContosoNamespace/topics/SBT"
      },
      "endpointType": "ServiceBusTopic"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "StorageQueue",
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1",
        "queueMessageTimeToLiveInSeconds": 300
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1",
        "queueMessageTimeToLiveInSeconds": 300
      },
      "endpointType": "StorageQueue"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1",
    "provisioningState": "Creating",
    "labels": null,
    "deadLetterDestination": {
      "endpointType": "StorageBlob",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "blobContainerName": "contosocontainer"
      }
    }
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "EventHub",
      "properties": {
        "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1",
  "name": "examplesubscription1",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForResource

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10",
  "name": "examplesubscription10",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForResourceGroup

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2",
  "name": "examplesubscription2",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

EventSubscriptions_CreateOrUpdateForSubscription

Sample Request

PUT https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3?api-version=2021-10-15-preview

{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://requestb.in/15ksip71"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://requestb.in/15ksip71"
      },
      "endpointType": "WebHook"
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "",
      "subjectEndsWith": ""
    },
    "provisioningState": "Succeeded",
    "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4"
  },
  "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3",
  "name": "examplesubscription3",
  "type": "Microsoft.EventGrid/eventSubscriptions"
}

定義

AzureFunctionEventSubscriptionDestination

イベント サブスクリプションの Azure 関数の宛先に関する情報。

BoolEqualsAdvancedFilter

BoolEquals 高度なフィルター。

createdByType

リソースを作成した ID の種類。

DeadLetterWithResourceIdentity

リソース ID を持つ配信不能な宛先に関する情報。

DeliveryWithResourceIdentity

リソース ID を持つイベント サブスクリプションの配信に関する情報。

DynamicDeliveryAttributeMapping

動的配信属性マッピングの詳細。

EventDeliverySchema

イベント サブスクリプションのイベント配信スキーマ。

EventHubEventSubscriptionDestination

イベント サブスクリプションのイベント ハブの送信先に関する情報。

EventSubscription

イベント サブスクリプション

EventSubscriptionFilter

イベント サブスクリプションのフィルター。

EventSubscriptionIdentity

イベント サブスクリプションを含む ID 情報。

EventSubscriptionIdentityType

使用されるマネージド ID の種類。 型 'SystemAssigned、UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、任意の ID を削除します。

EventSubscriptionProvisioningState

イベント サブスクリプションのプロビジョニング状態。

HybridConnectionEventSubscriptionDestination

イベント サブスクリプションの HybridConnection 変換先に関する情報。

IsNotNullAdvancedFilter

IsNotNull 高度なフィルター。

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined 高度なフィルター。

NumberGreaterThanAdvancedFilter

NumberGreaterThan 高度なフィルター。

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals Advanced Filter.

NumberInAdvancedFilter

NumberIn Advanced Filter。

NumberInRangeAdvancedFilter

NumberInRange 高度なフィルター。

NumberLessThanAdvancedFilter

NumberLessThan 高度なフィルター。

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals 高度なフィルター。

NumberNotInAdvancedFilter

NumberNotIn Advanced Filter。

NumberNotInRangeAdvancedFilter

NumberNotInRange 高度なフィルター。

PartnerEventSubscriptionDestination
RetryPolicy

イベント サブスクリプションの再試行ポリシーに関する情報。

ServiceBusQueueEventSubscriptionDestination

イベント サブスクリプションの Service Bus の宛先に関する情報。

ServiceBusTopicEventSubscriptionDestination

イベント サブスクリプションの Service Bus トピックの宛先に関する情報。

StaticDeliveryAttributeMapping

静的配信属性マッピングの詳細。

StorageBlobDeadLetterDestination

ストレージ BLOB ベースの配信不能宛先に関する情報。

StorageQueueEventSubscriptionDestination

イベント サブスクリプションのストレージ キューの宛先に関する情報。

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter。

StringContainsAdvancedFilter

StringContains 高度なフィルター。

StringEndsWithAdvancedFilter

StringEndsWith 高度なフィルター。

StringInAdvancedFilter

StringIn Advanced Filter。

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter。

StringNotContainsAdvancedFilter

StringNotContains 高度なフィルター。

StringNotEndsWithAdvancedFilter

StringNotEndsWith 高度なフィルター。

StringNotInAdvancedFilter

StringNotIn 高度なフィルター。

systemData

リソースの作成と最後の変更に関するメタデータ。

WebHookEventSubscriptionDestination

イベント サブスクリプションの Webhook 変換先に関する情報。

AzureFunctionEventSubscriptionDestination

イベント サブスクリプションの Azure 関数の宛先に関する情報。

Name Type Default Value Description
endpointType string:
  • AzureFunction

イベント サブスクリプションの送信先のエンドポイントの種類。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

配信属性の詳細。

properties.maxEventsPerBatch
  • integer
1

バッチあたりのイベントの最大数。

properties.preferredBatchSizeInKilobytes
  • integer
64

推奨されるバッチ サイズ (キロバイト単位)。

properties.resourceId
  • string

イベント サブスクリプションの Azure 関数の送信先のエンドポイントを表す Azure リソース ID。

BoolEqualsAdvancedFilter

BoolEquals 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • BoolEquals

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

value
  • boolean

ブール値のフィルター値。

createdByType

リソースを作成した ID の種類。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

DeadLetterWithResourceIdentity

リソース ID を持つ配信不能な宛先に関する情報。

Name Type Description
deadLetterDestination DeadLetterDestination:

イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID 設定を使用して、配信/配信不能中に使用される認証トークンを取得します。

identity

配信不能イベントの場合に使用する ID。

DeliveryWithResourceIdentity

リソース ID を持つイベント サブスクリプションの配信に関する情報。

Name Type Description
destination EventSubscriptionDestination:

イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。

identity

イベントを配信するときに使用する ID。

DynamicDeliveryAttributeMapping

動的配信属性マッピングの詳細。

Name Type Description
name
  • string

配信属性またはヘッダーの名前。

properties.sourceField
  • string

属性値を含むイベントの JSON パス。

type string:
  • Dynamic

配信属性またはヘッダー名の型。

EventDeliverySchema

イベント サブスクリプションのイベント配信スキーマ。

Name Type Description
CloudEventSchemaV1_0
  • string
CustomInputSchema
  • string
EventGridSchema
  • string

EventHubEventSubscriptionDestination

イベント サブスクリプションのイベント ハブの送信先に関する情報。

Name Type Description
endpointType string:
  • EventHub

イベント サブスクリプションの送信先のエンドポイントの種類。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

配信属性の詳細。

properties.resourceId
  • string

イベント サブスクリプションのイベント ハブの送信先のエンドポイントを表す Azure リソース ID。

EventSubscription

イベント サブスクリプション

Name Type Default Value Description
id
  • string

リソースの完全修飾識別子。

name
  • string

リソースの名前。

properties.deadLetterDestination DeadLetterDestination:

イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 Azure Event Gridの ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。

properties.deadLetterWithResourceIdentity

イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (トピックまたはドメイン) のマネージド ID 設定を使用して、配信/配信不能中に使用される認証トークンを取得します。

properties.deliveryWithResourceIdentity

イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID 設定を使用して、配信/配信不能中に使用される認証トークンを取得します。

properties.destination EventSubscriptionDestination:

イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 Azure Event Gridの ID を使用して、配信/配信不能の間に使用される認証トークンを取得します。

properties.eventDeliverySchema EventGridSchema

イベント サブスクリプションのイベント配信スキーマ。

properties.expirationTimeUtc
  • string

イベント サブスクリプションの有効期限。

properties.filter

イベント サブスクリプションのフィルターに関する情報。

properties.labels
  • string[]

ユーザー定義ラベルの一覧。

properties.provisioningState

イベント サブスクリプションのプロビジョニング状態。

properties.retryPolicy

イベントの再試行ポリシー。 これは、イベントの配信試行の最大数と有効期間を構成するために使用できます。

properties.topic
  • string

イベント サブスクリプションのトピックの名前。

systemData

イベント サブスクリプション リソースに関連するシステム メタデータ。

type
  • string

リソースの種類。

EventSubscriptionFilter

イベント サブスクリプションのフィルター。

Name Type Default Value Description
advancedFilters AdvancedFilter[]:

イベント サブスクリプションのフィルター処理に使用される高度なフィルターの配列。

enableAdvancedFilteringOnArrays
  • boolean

特異な値を想定するのではなく、値の配列に対して高度なフィルターを評価できるようにします。

includedEventTypes
  • string[]

イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。

isSubjectCaseSensitive
  • boolean
False

フィルターの SubjectBeginsWith プロパティと SubjectEndsWith プロパティを大文字と小文字を区別して比較するかどうかを指定します。

subjectBeginsWith
  • string

リソース パス プレフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 この形式は、イベントの発行元によって異なります。 このパスではワイルドカード文字はサポートされていません。

subjectEndsWith
  • string

リソース パス サフィックスに基づいてイベント サブスクリプションのイベントをフィルター処理する省略可能な文字列。 このパスではワイルドカード文字はサポートされていません。

EventSubscriptionIdentity

イベント サブスクリプションを含む ID 情報。

Name Type Description
type

使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は ID を削除します。

userAssignedIdentity
  • string

リソースに関連付けられているユーザー ID。

EventSubscriptionIdentityType

使用されるマネージド ID の種類。 型 'SystemAssigned、UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' は、任意の ID を削除します。

Name Type Description
SystemAssigned
  • string
UserAssigned
  • string

EventSubscriptionProvisioningState

イベント サブスクリプションのプロビジョニング状態。

Name Type Description
AwaitingManualAction
  • string
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

HybridConnectionEventSubscriptionDestination

イベント サブスクリプションの HybridConnection 変換先に関する情報。

Name Type Description
endpointType string:
  • HybridConnection

イベント サブスクリプションの送信先のエンドポイントの種類。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

配信属性の詳細。

properties.resourceId
  • string

イベント サブスクリプションの送信先であるハイブリッド接続の Azure リソース ID。

IsNotNullAdvancedFilter

IsNotNull 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • IsNotNull

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • IsNullOrUndefined

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

NumberGreaterThanAdvancedFilter

NumberGreaterThan 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • NumberGreaterThan

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

value
  • number

フィルター値。

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals Advanced Filter.

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • NumberGreaterThanOrEquals

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

value
  • number

フィルター値。

NumberInAdvancedFilter

NumberIn Advanced Filter。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • NumberIn

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • number[]

フィルター値のセット。

NumberInRangeAdvancedFilter

NumberInRange 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • NumberInRange

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • array[]

フィルター値のセット。

NumberLessThanAdvancedFilter

NumberLessThan 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • NumberLessThan

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

value
  • number

フィルター値。

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • NumberLessThanOrEquals

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

value
  • number

フィルター値。

NumberNotInAdvancedFilter

NumberNotIn Advanced Filter。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • NumberNotIn

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • number[]

フィルター値のセット。

NumberNotInRangeAdvancedFilter

NumberNotInRange 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • NumberNotInRange

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • array[]

フィルター値のセット。

PartnerEventSubscriptionDestination

Name Type Description
endpointType string:
  • PartnerDestination

イベント サブスクリプションの送信先のエンドポイントの種類。

properties.resourceId
  • string

イベント サブスクリプションのパートナーの送信先のエンドポイントを表す Azure リソース ID。

RetryPolicy

イベント サブスクリプションの再試行ポリシーに関する情報。

Name Type Default Value Description
eventTimeToLiveInMinutes
  • integer
1440

イベントの Time To Live (分単位)。

maxDeliveryAttempts
  • integer
30

イベントの配信再試行の最大数。

ServiceBusQueueEventSubscriptionDestination

イベント サブスクリプションの Service Bus の宛先に関する情報。

Name Type Description
endpointType string:
  • ServiceBusQueue

イベント サブスクリプションの送信先のエンドポイントの種類。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

配信属性の詳細。

properties.resourceId
  • string

イベント サブスクリプションの Service Bus 宛先のエンドポイントを表す Azure リソース ID。

ServiceBusTopicEventSubscriptionDestination

イベント サブスクリプションの Service Bus トピックの宛先に関する情報。

Name Type Description
endpointType string:
  • ServiceBusTopic

イベント サブスクリプションの送信先のエンドポイントの種類。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

配信属性の詳細。

properties.resourceId
  • string

イベント サブスクリプションの Service Bus トピックの宛先のエンドポイントを表す Azure リソース ID。

StaticDeliveryAttributeMapping

静的配信属性マッピングの詳細。

Name Type Default Value Description
name
  • string

配信属性またはヘッダーの名前。

properties.isSecret
  • boolean
False

属性に機密情報が含まれているかどうかを示すブール型フラグ。

properties.value
  • string

配信属性の値。

type string:
  • Static

配信属性またはヘッダー名の型。

StorageBlobDeadLetterDestination

ストレージ BLOB ベースの配信不能宛先に関する情報。

Name Type Description
endpointType string:
  • StorageBlob

配信不能宛先のエンドポイントの種類

properties.blobContainerName
  • string

配信不能イベントの送信先であるストレージ BLOB コンテナーの名前

properties.resourceId
  • string

配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID

StorageQueueEventSubscriptionDestination

イベント サブスクリプションのストレージ キューの宛先に関する情報。

Name Type Description
endpointType string:
  • StorageQueue

イベント サブスクリプションの送信先のエンドポイントの種類。

properties.queueMessageTimeToLiveInSeconds
  • integer

ストレージ キュー メッセージの有効期間 (秒単位)。

properties.queueName
  • string

イベント サブスクリプションの宛先であるストレージ アカウントのストレージ キューの名前。

properties.resourceId
  • string

イベント サブスクリプションの送信先であるキューを含むストレージ アカウントの Azure リソース ID。

StringBeginsWithAdvancedFilter

StringBeginsWith Advanced Filter。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • StringBeginsWith

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • string[]

フィルター値のセット。

StringContainsAdvancedFilter

StringContains 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • StringContains

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • string[]

フィルター値のセット。

StringEndsWithAdvancedFilter

StringEndsWith 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • StringEndsWith

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • string[]

フィルター値のセット。

StringInAdvancedFilter

StringIn Advanced Filter。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • StringIn

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • string[]

フィルター値のセット。

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith Advanced Filter。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • StringNotBeginsWith

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • string[]

フィルター値のセット。

StringNotContainsAdvancedFilter

StringNotContains 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • StringNotContains

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • string[]

フィルター値のセット。

StringNotEndsWithAdvancedFilter

StringNotEndsWith 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • StringNotEndsWith

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • string[]

フィルター値のセット。

StringNotInAdvancedFilter

StringNotIn 高度なフィルター。

Name Type Description
key
  • string

フィルター処理するイベントのフィールド/プロパティ。

operatorType string:
  • StringNotIn

フィルター処理に使用される演算子型 (NumberIn、StringContains、BoolEquals など)。

values
  • string[]

フィルター値のセット。

systemData

リソースの作成と最後の変更に関するメタデータ。

Name Type Description
createdAt
  • string

リソース作成のタイムスタンプ (UTC)。

createdBy
  • string

リソースを作成した ID。

createdByType

リソースを作成した ID の種類。

lastModifiedAt
  • string

リソースの最終変更 (UTC) のタイムスタンプ

lastModifiedBy
  • string

リソースを最後に変更した ID。

lastModifiedByType

リソースを最後に変更した ID の種類。

WebHookEventSubscriptionDestination

イベント サブスクリプションの Webhook 変換先に関する情報。

Name Type Default Value Description
endpointType string:
  • WebHook

イベント サブスクリプションの送信先のエンドポイントの種類。

properties.azureActiveDirectoryApplicationIdOrUri
  • string

配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory アプリケーション ID または URI。

properties.azureActiveDirectoryTenantId
  • string

配信要求にベアラー トークンとして含まれるアクセス トークンを取得する Azure Active Directory テナント ID。

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

配信属性の詳細。

properties.endpointBaseUrl
  • string

イベント サブスクリプションの送信先のエンドポイントを表すベース URL。

properties.endpointUrl
  • string

イベント サブスクリプションの送信先のエンドポイントを表す URL。

properties.maxEventsPerBatch
  • integer
1

バッチあたりのイベントの最大数。

properties.preferredBatchSizeInKilobytes
  • integer
64

推奨されるバッチ サイズ (キロバイト単位)。