Microsoft.EventGrid 名前空間/topics/eventSubscriptions 2023-06-01-preview
Bicep リソース定義
namespaces/topics/eventSubscriptions リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/namespaces/topics/eventSubscriptions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
deliveryConfiguration: {
deliveryMode: 'Queue'
queue: {
deadLetterDestinationWithResourceIdentity: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
eventTimeToLive: 'string'
maxDeliveryCount: int
receiveLockDurationInSeconds: int
}
}
eventDeliverySchema: 'CloudEventSchemaV1_0'
filtersConfiguration: {
filters: [
{
key: 'string'
operatorType: 'string'
// For remaining properties, see Filter objects
}
]
includedEventTypes: [
'string'
]
}
}
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
StorageBlob の場合は、次の値を使用します。
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
オブジェクトをフィルター処理する
オブジェクトの種類を指定するには、 operatorType プロパティを設定します。
BoolEquals の場合は、次の値を使用します。
operatorType: 'BoolEquals'
value: bool
IsNotNull の場合は、次の値を使用します。
operatorType: 'IsNotNull'
IsNullOrUndefined の場合は、次の値を使用します。
operatorType: 'IsNullOrUndefined'
NumberGreaterThan の場合は、次の値を使用します。
operatorType: 'NumberGreaterThan'
value: int
NumberGreaterThanOrEquals の場合は、次の値を使用します。
operatorType: 'NumberGreaterThanOrEquals'
value: int
NumberIn の場合は、次の値を使用します。
operatorType: 'NumberIn'
values: [
int
]
NumberInRange の場合は、次の値を使用します。
operatorType: 'NumberInRange'
values: [
[
int
]
]
NumberLessThan の場合は、次の値を使用します。
operatorType: 'NumberLessThan'
value: int
NumberLessThanOrEquals の場合は、次の値を使用します。
operatorType: 'NumberLessThanOrEquals'
value: int
NumberNotIn の場合は、次の値を使用します。
operatorType: 'NumberNotIn'
values: [
int
]
NumberNotInRange の場合は、次の値を使用します。
operatorType: 'NumberNotInRange'
values: [
[
int
]
]
StringBeginsWith の場合は、次の値を使用します。
operatorType: 'StringBeginsWith'
values: [
'string'
]
StringContains の場合は、次を使用します。
operatorType: 'StringContains'
values: [
'string'
]
StringEndsWith の場合は、次の値を使用します。
operatorType: 'StringEndsWith'
values: [
'string'
]
StringIn の場合は、次の値を使用します。
operatorType: 'StringIn'
values: [
'string'
]
StringNotBeginsWith の場合は、次の値を使用します。
operatorType: 'StringNotBeginsWith'
values: [
'string'
]
StringNotContains の場合は、次を使用します。
operatorType: 'StringNotContains'
values: [
'string'
]
StringNotEndsWith の場合は、次の値を使用します。
operatorType: 'StringNotEndsWith'
values: [
'string'
]
StringNotIn の場合は、次の値を使用します。
operatorType: 'StringNotIn'
values: [
'string'
]
プロパティ値
namespaces/topics/eventSubscriptions
名前 | 説明 | 値 |
---|---|---|
name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
種類のリソースのシンボル名: トピック |
properties | イベント サブスクリプションのプロパティ。 | SubscriptionProperties |
SubscriptionProperties
名前 | 説明 | 値 |
---|---|---|
deliveryConfiguration | イベント サブスクリプションの配信構成に関する情報。 | DeliveryConfiguration |
eventDeliverySchema | イベント サブスクリプションのイベント配信スキーマ。 | 'CloudEventSchemaV1_0' |
filtersConfiguration | イベント サブスクリプションのフィルターに関する情報。 | FiltersConfiguration |
DeliveryConfiguration
名前 | 説明 | 値 |
---|---|---|
deliveryMode | イベント サブスクリプションの配信モード。 | 'Queue' |
queue | deliveryMode が queue であり、キュー サブスクリプションに関する情報を表す場合は、このプロパティを設定する必要があります。 | QueueInfo |
QueueInfo
名前 | 説明 | 値 |
---|---|---|
deadLetterDestinationWithResourceIdentity | イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (つまり、トピック) のマネージド ID セットアップを使用して、配信/配信不能の間に使用される認証トークンを取得します。 |
DeadLetterWithResourceIdentity |
eventTimeToLive | メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、 (n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年の指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは、最小値が 1 分で、最大値が決定される省略可能なフィールドです トピックの EventRetentionInDays 値によって。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。 |
string |
maxDeliveryCount | イベントの最大配信数。 | INT |
receiveLockDurationInSeconds | メッセージが (クライアントによって) 受信され、受け入れ、解放、または拒否されるのを待機している最大期間 (秒単位)。 クライアントがメッセージを受信した後にこの時間が経過し、受け入れ済み (処理されていない)、リリースまたは拒否に移行されなかった場合は、 メッセージは再配信に使用できます。 これは省略可能なフィールドです。既定値は 60 秒、最小値は 60 秒、最大値は 300 秒です。 |
INT |
DeadLetterWithResourceIdentity
名前 | 説明 | 値 |
---|---|---|
deadLetterDestination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeadLetterDestination |
identity | 配信不能イベントの場合に使用する ID。 | EventSubscriptionIdentity |
DeadLetterDestination
名前 | 説明 | 値 |
---|---|---|
endpointType | オブジェクトの種類を設定する | StorageBlob (必須) |
StorageBlobDeadLetterDestination
名前 | 説明 | 値 |
---|---|---|
endpointType | 配信不能の宛先のエンドポイントの種類 | 'StorageBlob' (必須) |
properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
名前 | 説明 | 値 |
---|---|---|
blobContainerName | 配信不能イベントの送信先であるストレージ BLOB コンテナーの名前 | string |
resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | string |
EventSubscriptionIdentity
名前 | 説明 | 値 |
---|---|---|
type | 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 | 'SystemAssigned' 'UserAssigned' |
userAssignedIdentity | リソースに関連付けられているユーザー ID。 | string |
FiltersConfiguration
名前 | 説明 | 値 |
---|---|---|
filters | イベント サブスクリプションのフィルター処理に使用されるフィルターの配列。 | Filter[] |
includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
フィルター
名前 | 説明 | 値 |
---|---|---|
キー | フィルター処理するイベントのフィールド/プロパティ。 | string |
operatorType | オブジェクトの種類を設定する | BoolEquals です。 IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (必須) |
BoolEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'BoolEquals' (必須) |
value | ブール値フィルター値。 | [bool] |
IsNotNullFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'IsNotNull' (必須) |
IsNullOrUndefinedFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'IsNullOrUndefined' (必須) |
NumberGreaterThanFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThan' (必須) |
value | フィルター値。 | INT |
NumberGreaterThanOrEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThanOrEquals' (必須) |
value | フィルター値。 | INT |
NumberInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberIn' (必須) |
値 | フィルター値のセット。 | int[] |
NumberInRangeFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberInRange' (必須) |
値 | フィルター値のセット。 | int[][] |
NumberLessThanFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThan' (必須) |
value | フィルター値。 | INT |
NumberLessThanOrEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThanOrEquals' (必須) |
value | フィルター値。 | INT |
NumberNotInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotIn' (必須) |
値 | フィルター値のセット。 | int[] |
NumberNotInRangeFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotInRange' (必須) |
値 | フィルター値のセット。 | int[][] |
StringBeginsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringBeginsWith' (必須) |
値 | フィルター値のセット。 | string[] |
StringContainsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringContains' (必須) |
値 | フィルター値のセット。 | string[] |
StringEndsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringEndsWith' (必須) |
値 | フィルター値のセット。 | string[] |
StringInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringIn' (必須) |
値 | フィルター値のセット。 | string[] |
StringNotBeginsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotBeginsWith' (必須) |
値 | フィルター値のセット。 | string[] |
StringNotContainsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotContains' (必須) |
値 | フィルター値のセット。 | string[] |
StringNotEndsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotEndsWith' (必須) |
値 | フィルター値のセット。 | string[] |
StringNotInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotIn' (必須) |
値 | フィルター値のセット。 | string[] |
ARM テンプレート リソース定義
namespaces/topics/eventSubscriptions リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/namespaces/topics/eventSubscriptions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
"apiVersion": "2023-06-01-preview",
"name": "string",
"properties": {
"deliveryConfiguration": {
"deliveryMode": "Queue",
"queue": {
"deadLetterDestinationWithResourceIdentity": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"eventTimeToLive": "string",
"maxDeliveryCount": "int",
"receiveLockDurationInSeconds": "int"
}
},
"eventDeliverySchema": "CloudEventSchemaV1_0",
"filtersConfiguration": {
"filters": [
{
"key": "string",
"operatorType": "string"
// For remaining properties, see Filter objects
}
],
"includedEventTypes": [ "string" ]
}
}
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
StorageBlob の場合は、次の値を使用します。
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
オブジェクトをフィルター処理する
オブジェクトの種類を指定するには、 operatorType プロパティを設定します。
BoolEquals の場合は、次の値を使用します。
"operatorType": "BoolEquals",
"value": "bool"
IsNotNull の場合は、次の値を使用します。
"operatorType": "IsNotNull"
IsNullOrUndefined の場合は、次の値を使用します。
"operatorType": "IsNullOrUndefined"
NumberGreaterThan の場合は、次の値を使用します。
"operatorType": "NumberGreaterThan",
"value": "int"
NumberGreaterThanOrEquals の場合は、次の値を使用します。
"operatorType": "NumberGreaterThanOrEquals",
"value": "int"
NumberIn の場合は、次の値を使用します。
"operatorType": "NumberIn",
"values": [ "int" ]
NumberInRange の場合は、次の値を使用します。
"operatorType": "NumberInRange",
"values": [ [ "int" ] ]
NumberLessThan の場合は、次の値を使用します。
"operatorType": "NumberLessThan",
"value": "int"
NumberLessThanOrEquals の場合は、次の値を使用します。
"operatorType": "NumberLessThanOrEquals",
"value": "int"
NumberNotIn の場合は、次の値を使用します。
"operatorType": "NumberNotIn",
"values": [ "int" ]
NumberNotInRange の場合は、次の値を使用します。
"operatorType": "NumberNotInRange",
"values": [ [ "int" ] ]
StringBeginsWith の場合は、次の値を使用します。
"operatorType": "StringBeginsWith",
"values": [ "string" ]
StringContains の場合は、次を使用します。
"operatorType": "StringContains",
"values": [ "string" ]
StringEndsWith の場合は、次の値を使用します。
"operatorType": "StringEndsWith",
"values": [ "string" ]
StringIn の場合は、次の値を使用します。
"operatorType": "StringIn",
"values": [ "string" ]
StringNotBeginsWith の場合は、次の値を使用します。
"operatorType": "StringNotBeginsWith",
"values": [ "string" ]
StringNotContains の場合は、次を使用します。
"operatorType": "StringNotContains",
"values": [ "string" ]
StringNotEndsWith の場合は、次の値を使用します。
"operatorType": "StringNotEndsWith",
"values": [ "string" ]
StringNotIn の場合は、次の値を使用します。
"operatorType": "StringNotIn",
"values": [ "string" ]
プロパティ値
namespaces/topics/eventSubscriptions
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions' |
apiVersion | リソース API のバージョン | '2023-06-01-preview' |
name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) |
properties | イベント サブスクリプションのプロパティ。 | SubscriptionProperties |
SubscriptionProperties
名前 | 説明 | 値 |
---|---|---|
deliveryConfiguration | イベント サブスクリプションの配信構成に関する情報。 | DeliveryConfiguration |
eventDeliverySchema | イベント サブスクリプションのイベント配信スキーマ。 | 'CloudEventSchemaV1_0' |
filtersConfiguration | イベント サブスクリプションのフィルターに関する情報。 | FiltersConfiguration |
DeliveryConfiguration
名前 | 説明 | 値 |
---|---|---|
deliveryMode | イベント サブスクリプションの配信モード。 | 'Queue' |
queue | deliveryMode が queue であり、キュー サブスクリプションに関する情報を表す場合は、このプロパティを設定する必要があります。 | QueueInfo |
QueueInfo
名前 | 説明 | 値 |
---|---|---|
deadLetterDestinationWithResourceIdentity | イベント サブスクリプションの配信不能の宛先。 送信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (つまり、トピック) のマネージド ID セットアップを使用して、配信/配信不能の間に使用される認証トークンを取得します。 |
DeadLetterWithResourceIdentity |
eventTimeToLive | メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、 (n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年の指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは、最小値が 1 分で、最大値が決定される省略可能なフィールドです トピックの EventRetentionInDays 値によって。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。 |
string |
maxDeliveryCount | イベントの最大配信数。 | INT |
receiveLockDurationInSeconds | メッセージが (クライアントによって) 受信され、受け入れ、解放、または拒否されるのを待機している最大期間 (秒単位)。 クライアントがメッセージを受信した後にこの時間が経過し、受け入れ済み (処理されていない)、リリースまたは拒否に移行されなかった場合は、 メッセージは再配信に使用できます。 これは省略可能なフィールドです。既定値は 60 秒、最小値は 60 秒、最大値は 300 秒です。 |
INT |
DeadLetterWithResourceIdentity
名前 | 説明 | 値 |
---|---|---|
deadLetterDestination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeadLetterDestination |
identity | 配信不能イベントの場合に使用する ID。 | EventSubscriptionIdentity |
DeadLetterDestination
名前 | 説明 | 値 |
---|---|---|
endpointType | オブジェクトの種類を設定する | StorageBlob (必須) |
StorageBlobDeadLetterDestination
名前 | 説明 | 値 |
---|---|---|
endpointType | 配信不能の宛先のエンドポイントの種類 | 'StorageBlob' (必須) |
properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
名前 | 説明 | 値 |
---|---|---|
blobContainerName | 配信不能イベントの送信先であるストレージ BLOB コンテナーの名前 | string |
resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | string |
EventSubscriptionIdentity
名前 | 説明 | 値 |
---|---|---|
type | 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 | 'SystemAssigned' 'UserAssigned' |
userAssignedIdentity | リソースに関連付けられているユーザー ID。 | string |
FiltersConfiguration
名前 | 説明 | 値 |
---|---|---|
filters | イベント サブスクリプションのフィルター処理に使用されるフィルターの配列。 | Filter[] |
includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
フィルター
名前 | 説明 | 値 |
---|---|---|
キー | フィルター処理するイベントのフィールド/プロパティ。 | string |
operatorType | オブジェクトの種類を設定する | BoolEquals です。 IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (必須) |
BoolEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'BoolEquals' (必須) |
value | ブール値フィルター値。 | [bool] |
IsNotNullFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'IsNotNull' (必須) |
IsNullOrUndefinedFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'IsNullOrUndefined' (必須) |
NumberGreaterThanFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThan' (必須) |
value | フィルター値。 | INT |
NumberGreaterThanOrEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberGreaterThanOrEquals' (必須) |
value | フィルター値。 | INT |
NumberInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberIn' (必須) |
値 | フィルター値のセット。 | int[] |
NumberInRangeFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberInRange' (必須) |
値 | フィルター値のセット。 | int[][] |
NumberLessThanFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThan' (必須) |
value | フィルター値。 | INT |
NumberLessThanOrEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberLessThanOrEquals' (必須) |
value | フィルター値。 | INT |
NumberNotInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotIn' (必須) |
値 | フィルター値のセット。 | int[] |
NumberNotInRangeFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'NumberNotInRange' (必須) |
値 | フィルター値のセット。 | int[][] |
StringBeginsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringBeginsWith' (必須) |
値 | フィルター値のセット。 | string[] |
StringContainsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringContains' (必須) |
値 | フィルター値のセット。 | string[] |
StringEndsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringEndsWith' (必須) |
値 | フィルター値のセット。 | string[] |
StringInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringIn' (必須) |
値 | フィルター値のセット。 | string[] |
StringNotBeginsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotBeginsWith' (必須) |
値 | フィルター値のセット。 | string[] |
StringNotContainsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotContains' (必須) |
値 | フィルター値のセット。 | string[] |
StringNotEndsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotEndsWith' (必須) |
値 | フィルター値のセット。 | string[] |
StringNotInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | 'StringNotIn' (必須) |
値 | フィルター値のセット。 | string[] |
Terraform (AzAPI プロバイダー) リソース定義
namespaces/topics/eventSubscriptions リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.EventGrid/namespaces/topics/eventSubscriptions リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
deliveryConfiguration = {
deliveryMode = "Queue"
queue = {
deadLetterDestinationWithResourceIdentity = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
eventTimeToLive = "string"
maxDeliveryCount = int
receiveLockDurationInSeconds = int
}
}
eventDeliverySchema = "CloudEventSchemaV1_0"
filtersConfiguration = {
filters = [
{
key = "string"
operatorType = "string"
// For remaining properties, see Filter objects
}
]
includedEventTypes = [
"string"
]
}
}
})
}
DeadLetterDestination オブジェクト
endpointType プロパティを設定して、オブジェクトの種類を指定します。
StorageBlob の場合は、次の値を使用します。
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
オブジェクトをフィルター処理する
オブジェクトの種類を指定するには、 operatorType プロパティを設定します。
BoolEquals の場合は、次の値を使用します。
operatorType = "BoolEquals"
value = bool
IsNotNull の場合は、次の値を使用します。
operatorType = "IsNotNull"
IsNullOrUndefined の場合は、次の値を使用します。
operatorType = "IsNullOrUndefined"
NumberGreaterThan の場合は、次の値を使用します。
operatorType = "NumberGreaterThan"
value = int
NumberGreaterThanOrEquals の場合は、次の値を使用します。
operatorType = "NumberGreaterThanOrEquals"
value = int
NumberIn の場合は、次の値を使用します。
operatorType = "NumberIn"
values = [
int
]
NumberInRange の場合は、次の値を使用します。
operatorType = "NumberInRange"
values = [
[
int
]
]
NumberLessThan の場合は、次の値を使用します。
operatorType = "NumberLessThan"
value = int
NumberLessThanOrEquals の場合は、次の値を使用します。
operatorType = "NumberLessThanOrEquals"
value = int
NumberNotIn の場合は、次の値を使用します。
operatorType = "NumberNotIn"
values = [
int
]
NumberNotInRange の場合は、次の値を使用します。
operatorType = "NumberNotInRange"
values = [
[
int
]
]
StringBeginsWith の場合は、次の値を使用します。
operatorType = "StringBeginsWith"
values = [
"string"
]
StringContains の場合は、次の値を使用します。
operatorType = "StringContains"
values = [
"string"
]
StringEndsWith の場合は、次の値を使用します。
operatorType = "StringEndsWith"
values = [
"string"
]
StringIn の場合は、次の値を使用します。
operatorType = "StringIn"
values = [
"string"
]
StringNotBeginsWith の場合は、次の値を使用します。
operatorType = "StringNotBeginsWith"
values = [
"string"
]
StringNotContains の場合は、次の値を使用します。
operatorType = "StringNotContains"
values = [
"string"
]
StringNotEndsWith の場合は、次の値を使用します。
operatorType = "StringNotEndsWith"
values = [
"string"
]
StringNotIn の場合は、次の値を使用します。
operatorType = "StringNotIn"
values = [
"string"
]
プロパティ値
namespaces/topics/eventSubscriptions
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview" |
name | リソース名 | string (必須) |
parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: トピック |
properties | イベント サブスクリプションのプロパティ。 | SubscriptionProperties |
SubscriptionProperties
名前 | 説明 | 値 |
---|---|---|
deliveryConfiguration | イベント サブスクリプションの配信構成に関する情報。 | DeliveryConfiguration |
eventDeliverySchema | イベント サブスクリプションのイベント配信スキーマ。 | "CloudEventSchemaV1_0" |
filtersConfiguration | イベント サブスクリプションのフィルターに関する情報。 | FiltersConfiguration |
DeliveryConfiguration
名前 | 説明 | 値 |
---|---|---|
deliveryMode | イベント サブスクリプションの配信モード。 | "Queue" |
queue | このプロパティは、deliveryMode が queue であり、キュー サブスクリプションに関する情報を表す場合に設定する必要があります。 | QueueInfo |
QueueInfo
名前 | 説明 | 値 |
---|---|---|
deadLetterDestinationWithResourceIdentity | イベント サブスクリプションの配信不能の宛先。 配信先に配信できないイベントは、配信不能の宛先に送信されます。 親リソース (つまりトピック) のマネージド ID セットアップを使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeadLetterWithResourceIdentity |
eventTimeToLive | メッセージが発行された時点からサブスクリプションで使用できるメッセージの長さを決定する ISO 8601 形式の期間。 この期間の値は、'P(n)Y(n)M(n)DT(n)H(n)M(n)S' の形式で表されます。ここで、 - (n) は、(n) に続く各 time 要素の値に置き換えられます。 - P は期間 (または期間) 指定子であり、常に期間の先頭に配置されます。 - Y は年指定子であり、年数の値に従います。 - M は月の指定子であり、月数の値に従います。 - W は週指定子であり、週数の値に従います。 - D は日指定子であり、日数の値に従います。 - T は時間指定子であり、時間コンポーネントの前に置きます。 - H は時間指定子であり、時間数の値に従います。 - M は分指定子であり、分数の値に従います。 - S は 2 番目の指定子であり、秒数の値に従います。 この期間の値は、トピックの EventRetentionInDays より大きく設定することはできません。 これは省略可能なフィールドであり、最小値は 1 分で、最大値は決定されます トピックの EventRetentionInDays 値で指定します。 有効な値の例を次に示します。 - 'P0DT23H12M' または 'PT23H12M': 23 時間 12 分の期間。 - 'P1D' または 'P1DT0H0M0S': 1 日の期間。 |
string |
maxDeliveryCount | イベントの最大配信数。 | INT |
receiveLockDurationInSeconds | メッセージが (クライアントによって) 受信され、受け入れ、解放、または拒否されるのを待機している最大期間 (秒単位)。 クライアントがメッセージを受信した後にこの時間が経過し、受け入れ済み (未処理)、リリース済み、または拒否に移行されていない場合は、 メッセージは再配信に使用できます。 これは省略可能なフィールドです。既定値は 60 秒、最小値は 60 秒、最大は 300 秒です。 |
INT |
DeadLetterWithResourceIdentity
名前 | 説明 | 値 |
---|---|---|
deadLetterDestination | イベント サブスクリプションに対してイベントを配信する必要がある送信先に関する情報。 親リソース (トピックまたはドメイン) のマネージド ID 設定を使用して、配信/配信不能時に使用される認証トークンを取得します。 |
DeadLetterDestination |
identity | 配信不能イベントの際に使用する ID。 | EventSubscriptionIdentity |
DeadLetterDestination
名前 | 説明 | 値 |
---|---|---|
endpointType | オブジェクトの種類を設定する | StorageBlob (必須) |
StorageBlobDeadLetterDestination
名前 | 説明 | 値 |
---|---|---|
endpointType | 配信不能の宛先のエンドポイントの種類 | "StorageBlob" (必須) |
properties | ストレージ BLOB ベースの配信不能宛先のプロパティ | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
名前 | 説明 | 値 |
---|---|---|
blobContainerName | 配信不能イベントの送信先であるストレージ BLOB コンテナーの名前 | string |
resourceId | 配信不能イベントの送信先であるストレージ アカウントの Azure リソース ID | string |
EventSubscriptionIdentity
名前 | 説明 | 値 |
---|---|---|
type | 使用されるマネージド ID の種類。 型 'SystemAssigned, UserAssigned' には、暗黙的に作成された ID とユーザー割り当て ID のセットの両方が含まれます。 型 'None' では、任意の ID が削除されます。 | "SystemAssigned" "UserAssigned" |
userAssignedIdentity | リソースに関連付けられているユーザー ID。 | string |
FiltersConfiguration
名前 | 説明 | 値 |
---|---|---|
filters | イベント サブスクリプションのフィルター処理に使用されるフィルターの配列。 | Filter[] |
includedEventTypes | イベント サブスクリプションの一部である必要がある適用可能なイベントの種類の一覧。 すべての既定のイベントの種類をサブスクライブする場合は、IncludedEventTypes を null に設定します。 | string[] |
フィルター
名前 | 説明 | 値 |
---|---|---|
キー | フィルター処理するイベントのフィールド/プロパティ。 | string |
operatorType | オブジェクトの種類を設定する | BoolEquals です。 IsNotNull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (必須) |
BoolEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "BoolEquals" (必須) |
value | ブール値フィルター値。 | [bool] |
IsNotNullFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "IsNotNull" (必須) |
IsNullOrUndefinedFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "IsNullOrUndefined" (必須) |
NumberGreaterThanFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberGreaterThan" (必須) |
value | フィルター値。 | INT |
NumberGreaterThanOrEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberGreaterThanOrEquals" (必須) |
value | フィルター値。 | INT |
NumberInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberIn" (必須) |
値 | フィルター値のセット。 | int[] |
NumberInRangeFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberInRange" (必須) |
値 | フィルター値のセット。 | int[][] |
NumberLessThanFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberLessThan" (必須) |
value | フィルター値。 | INT |
NumberLessThanOrEqualsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberLessThanOrEquals" (必須) |
value | フィルター値。 | INT |
NumberNotInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberNotIn" (必須) |
値 | フィルター値のセット。 | int[] |
NumberNotInRangeFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "NumberNotInRange" (必須) |
値 | フィルター値のセット。 | int[][] |
StringBeginsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringBeginsWith" (必須) |
値 | フィルター値のセット。 | string[] |
StringContainsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringContains" (必須) |
値 | フィルター値のセット。 | string[] |
StringEndsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringEndsWith" (必須) |
値 | フィルター値のセット。 | string[] |
StringInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringIn" (必須) |
値 | フィルター値のセット。 | string[] |
StringNotBeginsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringNotBeginsWith" (必須) |
値 | フィルター値のセット。 | string[] |
StringNotContainsFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringNotContains" (必須) |
値 | フィルター値のセット。 | string[] |
StringNotEndsWithFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringNotEndsWith" (必須) |
値 | フィルター値のセット。 | string[] |
StringNotInFilter
名前 | 説明 | 値 |
---|---|---|
operatorType | フィルター処理に使用される演算子の型 (NumberIn、StringContains、BoolEquals など)。 | "StringNotIn" (必須) |
値 | フィルター値のセット。 | string[] |