Event Subscriptions - Create Or Update

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

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

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}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} '、EventGrid トピックには '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName} ' を使用します。

api-version
query True
  • string

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

要求本文

Name Type Description
properties.deadLetterDestination DeadLetterDestination:

イベントサブスクリプションの配信不能の宛先。

properties.deadLetterWithResourceIdentity

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

properties.deliveryWithResourceIdentity

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

properties.destination EventSubscriptionDestination:

イベントサブスクリプションに対してイベントを配信する必要がある宛先に関する情報。

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_EventHubDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination
EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination
EventSubscriptions_CreateOrUpdateForResource
EventSubscriptions_CreateOrUpdateForResourceGroup
EventSubscriptions_CreateOrUpdateForSubscription

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-12-01
{
  "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-12-01
{
  "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_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-12-01
{
  "properties": {
    "destination": {
      "endpointType": "StorageQueue",
      "properties": {
        "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg",
        "queueName": "queue1"
      }
    },
    "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"
      },
      "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-12-01
{
  "properties": {
    "destination": {
      "endpointType": "WebHook",
      "properties": {
        "endpointUrl": "https://azurefunctionexample.azurewebsites.net/runtime/webhooks/EventGrid?functionName=EventGridTrigger1&code=PASSWORDCODE"
      }
    },
    "filter": {
      "isSubjectCaseSensitive": false,
      "subjectBeginsWith": "ExamplePrefix",
      "subjectEndsWith": "ExampleSuffix"
    }
  }
}

Sample Response

{
  "properties": {
    "destination": {
      "properties": {
        "endpointBaseUrl": "https://azurefunctionexample.azurewebsites.net/runtime/webhooks/EventGrid"
      },
      "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-12-01
{
  "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-12-01
{
  "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-12-01
{
  "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 を持つ配信不能 destination に関する情報。

DeliveryWithResourceIdentity

リソース id を使用したイベントサブスクリプションの配信に関する情報。

DynamicDeliveryAttributeMapping

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

EventDeliverySchema

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

EventHubEventSubscriptionDestination

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

EventSubscription

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

EventSubscriptionFilter

イベントサブスクリプションをフィルター処理します。

EventSubscriptionIdentity

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

EventSubscriptionIdentityType

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

EventSubscriptionProvisioningState

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

HybridConnectionEventSubscriptionDestination

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

IsNotNullAdvancedFilter

IsNotNull 高度なフィルター。

IsNullOrUndefinedAdvancedFilter

IsNullOrUndefined 詳細フィルター。

NumberGreaterThanAdvancedFilter

NumberGreaterThan 高度なフィルター。

NumberGreaterThanOrEqualsAdvancedFilter

NumberGreaterThanOrEquals 高度なフィルター。

NumberInAdvancedFilter

NumberIn の高度なフィルター。

NumberInRangeAdvancedFilter

NumberInRange の高度なフィルター。

NumberLessThanAdvancedFilter

NumberLessThan 高度なフィルター。

NumberLessThanOrEqualsAdvancedFilter

NumberLessThanOrEquals 高度なフィルター。

NumberNotInAdvancedFilter

NumberNotIn 高度なフィルター。

NumberNotInRangeAdvancedFilter

NumberNotInRange 詳細フィルター。

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestination

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

StaticDeliveryAttributeMapping

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

StorageBlobDeadLetterDestination

ストレージ BLOB ベースの格納先に関する情報。

StorageQueueEventSubscriptionDestination

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

StringBeginsWithAdvancedFilter

StringBeginsWith 詳細フィルター。

StringContainsAdvancedFilter

StringContains の高度なフィルター。

StringEndsWithAdvancedFilter

StringEndsWith 詳細フィルター。

StringInAdvancedFilter

StringIn の高度なフィルター。

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith 詳細フィルター。

StringNotContainsAdvancedFilter

StringNotContains の高度なフィルター。

StringNotEndsWithAdvancedFilter

StringNotEndsWith 詳細フィルター。

StringNotInAdvancedFilter

StringNotIn 高度なフィルター。

systemData

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

WebHookEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

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

Name Type Description
endpointType string:
  • AzureFunction

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

properties.deliveryAttributeMappings DeliveryAttributeMapping[]:

配信属性の詳細。

properties.maxEventsPerBatch
  • integer

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

properties.preferredBatchSizeInKilobytes
  • integer

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

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 を持つ配信不能 destination に関する情報。

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 Description
id
  • string

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

name
  • string

リソースの名前。

properties.deadLetterDestination DeadLetterDestination:

イベントサブスクリプションの配信不能の宛先。

properties.deadLetterWithResourceIdentity

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

properties.deliveryWithResourceIdentity

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

properties.destination EventSubscriptionDestination:

イベントサブスクリプションに対してイベントを配信する必要がある宛先に関する情報。

properties.eventDeliverySchema

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

properties.expirationTimeUtc
  • string

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

properties.filter

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

properties.labels
  • string[]

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

properties.provisioningState

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

properties.retryPolicy

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

properties.topic
  • string

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

systemData

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

type
  • string

リソースの種類。

EventSubscriptionFilter

イベントサブスクリプションをフィルター処理します。

Name Type Description
advancedFilters AdvancedFilter[]:

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

enableAdvancedFilteringOnArrays
  • boolean

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

includedEventTypes
  • string[]

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

isSubjectCaseSensitive
  • boolean

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

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 destination に関する情報。

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 高度なフィルター。

Name Type Description
key
  • string

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

operatorType string:
  • NumberGreaterThanOrEquals

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

value
  • number

フィルター値。

NumberInAdvancedFilter

NumberIn の高度なフィルター。

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 高度なフィルター。

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[]

フィルター値のセット。

RetryPolicy

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

Name Type Description
eventTimeToLiveInMinutes
  • integer

イベントの有効期限 (分)。

maxDeliveryAttempts
  • integer

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

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 Description
name
  • string

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

properties.isSecret
  • boolean

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

properties.value
  • string

配信属性の値。

type string:
  • Static

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

StorageBlobDeadLetterDestination

ストレージ BLOB ベースの格納先に関する情報。

Name Type Description
endpointType string:
  • StorageBlob

行き出し先のエンドポイントの種類

properties.blobContainerName
  • string

deadletter イベントStorage BLOB コンテナーの名前

properties.resourceId
  • string

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

StorageQueueEventSubscriptionDestination

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

Name Type Description
endpointType string:
  • StorageQueue

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

properties.queueMessageTimeToLiveInSeconds
  • integer

キューメッセージの有効期間を秒単位で Storage します。

properties.queueName
  • string

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

properties.resourceId
  • string

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

StringBeginsWithAdvancedFilter

StringBeginsWith 詳細フィルター。

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 の高度なフィルター。

Name Type Description
key
  • string

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

operatorType string:
  • StringIn

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

values
  • string[]

フィルター値のセット。

StringNotBeginsWithAdvancedFilter

StringNotBeginsWith 詳細フィルター。

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 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

バッチごとのイベントの最大数。

properties.preferredBatchSizeInKilobytes
  • integer

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