Microsoft.EventGrid eventSubscriptions 2020-04-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp eventSubscriptions ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.
Verwenden Sie die scope
-Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in Bicep.
Der Ressourcentyp eventSubscriptions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
- Abonnements : Siehe Befehle zur Abonnementbereitstellung
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/eventSubscriptions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2020-04-01-preview' = {
name: 'string'
scope: resourceSymbolicName
properties: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
deliveryWithResourceIdentity: {
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema: 'string'
expirationTimeUtc: 'string'
filter: {
advancedFilters: [
{
key: 'string'
operatorType: 'string'
// For remaining properties, see AdvancedFilter objects
}
]
includedEventTypes: [
'string'
]
isSubjectCaseSensitive: bool
subjectBeginsWith: 'string'
subjectEndsWith: 'string'
}
labels: [
'string'
]
retryPolicy: {
eventTimeToLiveInMinutes: int
maxDeliveryAttempts: int
}
}
}
DeadLetterDestination-Objekte
Legen Sie die endpointType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für StorageBlob Folgendes:
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
EventSubscriptionDestination-Objekte
Legen Sie die endpointType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für AzureFunction Folgendes:
endpointType: 'AzureFunction'
properties: {
maxEventsPerBatch: int
preferredBatchSizeInKilobytes: int
resourceId: 'string'
}
Verwenden Sie für EventHub Folgendes:
endpointType: 'EventHub'
properties: {
resourceId: 'string'
}
Verwenden Sie für HybridConnection Folgendes:
endpointType: 'HybridConnection'
properties: {
resourceId: 'string'
}
Verwenden Sie für ServiceBusQueue Folgendes:
endpointType: 'ServiceBusQueue'
properties: {
resourceId: 'string'
}
Verwenden Sie für ServiceBusTopic Folgendes:
endpointType: 'ServiceBusTopic'
properties: {
resourceId: 'string'
}
Verwenden Sie für StorageQueue Folgendes:
endpointType: 'StorageQueue'
properties: {
queueName: 'string'
resourceId: 'string'
}
Verwenden Sie für WebHook Folgendes:
endpointType: 'WebHook'
properties: {
azureActiveDirectoryApplicationIdOrUri: 'string'
azureActiveDirectoryTenantId: 'string'
endpointUrl: 'string'
maxEventsPerBatch: int
preferredBatchSizeInKilobytes: int
}
AdvancedFilter-Objekte
Legen Sie die operatorType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für BoolEquals Folgendes:
operatorType: 'BoolEquals'
value: bool
Verwenden Sie für NumberGreaterThan Folgendes:
operatorType: 'NumberGreaterThan'
value: int
Verwenden Sie für NumberGreaterThanOrEquals Folgendes:
operatorType: 'NumberGreaterThanOrEquals'
value: int
Verwenden Sie für NumberIn Folgendes:
operatorType: 'NumberIn'
values: [
int
]
Verwenden Sie für NumberLessThan Folgendes:
operatorType: 'NumberLessThan'
value: int
Verwenden Sie für NumberLessThanOrEquals Folgendes:
operatorType: 'NumberLessThanOrEquals'
value: int
Verwenden Sie für NumberNotIn Folgendes:
operatorType: 'NumberNotIn'
values: [
int
]
Verwenden Sie für StringBeginsWith Folgendes:
operatorType: 'StringBeginsWith'
values: [
'string'
]
Verwenden Sie für StringContains Folgendes:
operatorType: 'StringContains'
values: [
'string'
]
Verwenden Sie für StringEndsWith Folgendes:
operatorType: 'StringEndsWith'
values: [
'string'
]
Verwenden Sie für StringIn Folgendes:
operatorType: 'StringIn'
values: [
'string'
]
Verwenden Sie für StringNotIn Folgendes:
operatorType: 'StringNotIn'
values: [
'string'
]
Eigenschaftswerte
eventSubscriptions
Name | BESCHREIBUNG | Wert |
---|---|---|
name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-64 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. |
scope | Verwenden Sie beim Erstellen einer Erweiterungsressource in einem bereich, der sich vom Bereitstellungsbereich unterscheidet. | Zielressource Legen Sie für Bicep diese Eigenschaft auf den symbolischen Namen der Ressource fest, um die Erweiterungsressource anzuwenden. |
properties | Eigenschaften des Ereignisabonnements. | EventSubscriptionProperties |
EventSubscriptionProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
deadLetterDestination | Das Ziel für unzustellbare Nachrichten des Ereignisabonnements. Jedes Ereignis, das nicht an sein Ziel übermittelt werden kann, wird an das Ziel für unzustellbare Nachrichten gesendet. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterDestination |
deadLetterWithResourceIdentity | Das Ziel für unzustellbare Nachrichten des Ereignisabonnements. Jedes Ereignis, das nicht an sein Ziel übermittelt werden kann, wird an das Ziel für unzustellbare Nachrichten gesendet. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. das Thema oder die Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. das Thema oder die Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeliveryWithResourceIdentity |
destination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
EventSubscriptionDestination |
eventDeliverySchema | Das Ereignisübermittlungsschema für das Ereignisabonnement. | "CloudEventSchemaV1_0" 'CustomInputSchema' 'EventGridSchema' |
expirationTimeUtc | Ablaufzeit des Ereignisabonnements. | Zeichenfolge |
filter | Informationen zum Filter für das Ereignisabonnement. | EventSubscriptionFilter |
Bezeichnungen | Liste der benutzerdefinierten Bezeichnungen. | string[] |
retryPolicy | Die Wiederholungsrichtlinie für Ereignisse. Dies kann verwendet werden, um die maximale Anzahl von Übermittlungsversuchen und die Dauer für Ereignisse zu konfigurieren. | RetryPolicy |
DeadLetterDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Festlegen des Objekttyps | StorageBlob (erforderlich) |
StorageBlobDeadLetterDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ziel des unzustellbaren Buchstabens | "StorageBlob" (erforderlich) |
properties | Die Eigenschaften des Speicherblob-basierten Deadletter-Ziels | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
blobContainerName | Der Name des Speicherblobcontainers, der das Ziel der Deadletterereignisse darstellt | Zeichenfolge |
resourceId | Die Azure-Ressourcen-ID des Speicherkontos, das das Ziel der Deadletterereignisse ist | Zeichenfolge |
DeadLetterWithResourceIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
deadLetterDestination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. das Thema oder die Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterDestination |
Identität | Die Identität, die bei Ereignissen mit unzustellbaren Buchstaben verwendet werden soll. | EventSubscriptionIdentity |
EventSubscriptionIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe benutzerseitig zugewiesener Identitäten. Der Typ "None" entfernt jede Identität. | "SystemAssigned" "UserAssigned" |
userAssignedIdentity | Die der Ressource zugeordnete Benutzeridentität. | Zeichenfolge |
DeliveryWithResourceIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
destination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
EventSubscriptionDestination |
Identität | Die Identität, die beim Übermitteln von Ereignissen verwendet werden soll. | EventSubscriptionIdentity |
EventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Festlegen des Objekttyps | AzureFunction EventHub HybridConnection ServiceBusQueue ServiceBusTopic StorageQueue WebHook (erforderlich) |
AzureFunctionEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "AzureFunction" (erforderlich) |
properties | Azure-Funktionseigenschaften des Ereignisabonnementsziels. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
maxEventsPerBatch | Maximale Anzahl von Ereignissen pro Batch. | INT |
preferredBatchSizeInKilobytes | Bevorzugte Batchgröße in Kilobyte. | INT |
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Azure-Funktionsziels eines Ereignisabonnements darstellt. | Zeichenfolge |
EventHubEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "EventHub" (erforderlich) |
properties | Event Hub-Eigenschaften des Ereignisabonnementziels. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt eines Event Hub-Ziels eines Ereignisabonnements darstellt. | Zeichenfolge |
HybridConnectionEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "HybridConnection" (erforderlich) |
properties | Hybridverbindung Eigenschaften des Ereignisabonnementziels. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID einer Hybridverbindung, die das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
ServiceBusQueueEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "ServiceBusQueue" (erforderlich) |
properties | Service Bus-Eigenschaften des Ereignisabonnementziels. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Service Bus-Ziels eines Ereignisabonnements darstellt. | Zeichenfolge |
ServiceBusTopicEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "ServiceBusTopic" (erforderlich) |
properties | Service Bus-Themeneigenschaften des Ereignisabonnementziels. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Service Bus-Themaziels eines Ereignisabonnements darstellt. | Zeichenfolge |
StorageQueueEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "StorageQueue" (erforderlich) |
properties | Speicherwarteschlangeneigenschaften des Ereignisabonnementziels. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
queueName | Der Name der Speicherwarteschlange unter einem Speicherkonto, das das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
resourceId | Die Azure-Ressourcen-ID des Speicherkontos, das die Warteschlange enthält, die das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
WebHookEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "WebHook" (erforderlich) |
properties | WebHook-Eigenschaften des Ereignisabonnementsziels. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | Die Azure Active Directory-Anwendungs-ID oder der URI zum Abrufen des Zugriffstokens, das als Bearertoken in Übermittlungsanforderungen enthalten wird. | Zeichenfolge |
azureActiveDirectoryTenantId | Die Azure Active Directory-Mandanten-ID zum Abrufen des Zugriffstokens, das als Bearertoken in Übermittlungsanforderungen enthalten wird. | Zeichenfolge |
endpointUrl | Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
maxEventsPerBatch | Maximale Anzahl von Ereignissen pro Batch. | INT |
preferredBatchSizeInKilobytes | Bevorzugte Batchgröße in Kb. | INT |
EventSubscriptionFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
advancedFilters | Ein Array erweiterter Filter, die zum Filtern von Ereignisabonnements verwendet werden. | AdvancedFilter[] |
includedEventTypes | Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn sie alle Standardereignistypen abonnieren möchten, legen Sie die IncludedEventTypes auf NULL fest. | string[] |
isSubjectCaseSensitive | Gibt an, ob die Eigenschaften SubjectBeginsWith und SubjectEndsWith des Filters sollte mit der Groß-/Kleinschreibung verglichen werden. |
bool |
subjectBeginsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix. Das Format hängt vom Herausgeber der Ereignisse ab. Wildcardzeichen werden in diesem Pfad nicht unterstützt. |
Zeichenfolge |
subjectEndsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix. Wildcardzeichen werden in diesem Pfad nicht unterstützt. |
Zeichenfolge |
AdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
Schlüssel | Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. | Zeichenfolge |
operatorType | Festlegen des Objekttyps | BoolEquals NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberLessThan NumberLessThanOrEquals NumberNotIn StringBeginsWith StringContains StringEndsWith StringIn StringNotIn (erforderlich) |
BoolEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "BoolEquals" (erforderlich) |
value | Der boolesche Filterwert. | bool |
NumberGreaterThanAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberGreaterThan" (erforderlich) |
value | Der Filterwert. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberGreaterThanOrEquals" (erforderlich) |
value | Der Filterwert. | INT |
NumberInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'NumberIn' (erforderlich) |
Werte | Der Satz von Filterwerten. | int[] |
NumberLessThanAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberLessThan" (erforderlich) |
value | Der Filterwert. | INT |
NumberLessThanOrEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberLessThanOrEquals" (erforderlich) |
value | Der Filterwert. | INT |
NumberNotInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'NumberNotIn' (erforderlich) |
Werte | Der Satz von Filterwerten. | int[] |
StringBeginsWithAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringBeginsWith' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringContainsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringContains' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringEndsWithAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringEndsWith' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringIn' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringNotInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringNotIn' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
RetryPolicy
Name | BESCHREIBUNG | Wert |
---|---|---|
eventTimeToLiveInMinutes | Gültigkeitsdauer (in Minuten) für Ereignisse. | INT |
maxDeliveryAttempts | Maximale Anzahl von Übermittlungsversuchen für Ereignisse. | INT |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen Azure Event Grid benutzerdefinierten Themas und Abonnements |
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Webhookabonnement. Vorlage, die ursprünglich von John Downs erstellt wurde. |
Benutzerdefiniertes Azure Event Grid Thema/Abonnement mit CloudEvents |
Erstellt ein benutzerdefiniertes Azure Event Grid Thema, ein Webhookabonnement mit CloudEvents-Schema und eine Logik-App als Ereignishandler. Vorlage, die ursprünglich von Justin Yoo erstellt wurde. |
Erstellen eines benutzerdefinierten Event Grid-Themas und eines Event Hub-Handlers |
Erstellt ein Azure Event Grid benutzerdefinierten Thema und Event Hub, um die Ereignisse zu behandeln. |
Erstellen eines Event Grid-Abonnements für Ressourcenereignisse |
Erstellt ein Event Grid-Abonnement für eine Ressourcengruppe oder ein Azure-Abonnement. |
Erstellen eines Azure Event Grid benutzerdefinierten Themas und eines Warteschlangenabonnements |
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Service Bus-Warteschlangenabonnement. Vorlage ursprünglich von Markus Meyer erstellt. |
Erstellen eines Azure Event Grid benutzerdefinierten Themenabonnements |
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Service Bus-Themenabonnement. Vorlage ursprünglich von Markus Meyer erstellt. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp eventSubscriptions ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.
Verwenden Sie die scope
-Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen. Weitere Informationen finden Sie unter Festlegen des Bereichs für Erweiterungsressourcen in ARM-Vorlagen.
Der Ressourcentyp eventSubscriptions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
- Abonnements : Siehe Befehle zur Abonnementbereitstellung
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/eventSubscriptions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2020-04-01-preview",
"name": "string",
"scope": "string",
"properties": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"deadLetterWithResourceIdentity": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"deliveryWithResourceIdentity": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"eventDeliverySchema": "string",
"expirationTimeUtc": "string",
"filter": {
"advancedFilters": [
{
"key": "string",
"operatorType": "string"
// For remaining properties, see AdvancedFilter objects
}
],
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ],
"retryPolicy": {
"eventTimeToLiveInMinutes": "int",
"maxDeliveryAttempts": "int"
}
}
}
DeadLetterDestination-Objekte
Legen Sie die endpointType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für StorageBlob Folgendes:
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
EventSubscriptionDestination-Objekte
Legen Sie die endpointType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für AzureFunction Folgendes:
"endpointType": "AzureFunction",
"properties": {
"maxEventsPerBatch": "int",
"preferredBatchSizeInKilobytes": "int",
"resourceId": "string"
}
Verwenden Sie für EventHub Folgendes:
"endpointType": "EventHub",
"properties": {
"resourceId": "string"
}
Verwenden Sie für HybridConnection Folgendes:
"endpointType": "HybridConnection",
"properties": {
"resourceId": "string"
}
Verwenden Sie für ServiceBusQueue Folgendes:
"endpointType": "ServiceBusQueue",
"properties": {
"resourceId": "string"
}
Verwenden Sie für ServiceBusTopic Folgendes:
"endpointType": "ServiceBusTopic",
"properties": {
"resourceId": "string"
}
Verwenden Sie für StorageQueue Folgendes:
"endpointType": "StorageQueue",
"properties": {
"queueName": "string",
"resourceId": "string"
}
Verwenden Sie für WebHook Folgendes:
"endpointType": "WebHook",
"properties": {
"azureActiveDirectoryApplicationIdOrUri": "string",
"azureActiveDirectoryTenantId": "string",
"endpointUrl": "string",
"maxEventsPerBatch": "int",
"preferredBatchSizeInKilobytes": "int"
}
AdvancedFilter-Objekte
Legen Sie die operatorType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für BoolEquals Folgendes:
"operatorType": "BoolEquals",
"value": "bool"
Verwenden Sie für NumberGreaterThan Folgendes:
"operatorType": "NumberGreaterThan",
"value": "int"
Verwenden Sie für NumberGreaterThanOrEquals Folgendes:
"operatorType": "NumberGreaterThanOrEquals",
"value": "int"
Verwenden Sie für NumberIn Folgendes:
"operatorType": "NumberIn",
"values": [ "int" ]
Verwenden Sie für NumberLessThan Folgendes:
"operatorType": "NumberLessThan",
"value": "int"
Verwenden Sie für NumberLessThanOrEquals Folgendes:
"operatorType": "NumberLessThanOrEquals",
"value": "int"
Verwenden Sie für NumberNotIn Folgendes:
"operatorType": "NumberNotIn",
"values": [ "int" ]
Verwenden Sie für StringBeginsWith Folgendes:
"operatorType": "StringBeginsWith",
"values": [ "string" ]
Verwenden Sie für StringContains Folgendes:
"operatorType": "StringContains",
"values": [ "string" ]
Verwenden Sie für StringEndsWith Folgendes:
"operatorType": "StringEndsWith",
"values": [ "string" ]
Verwenden Sie für StringIn Folgendes:
"operatorType": "StringIn",
"values": [ "string" ]
Verwenden Sie für StringNotIn Folgendes:
"operatorType": "StringNotIn",
"values": [ "string" ]
Eigenschaftswerte
eventSubscriptions
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.EventGrid/eventSubscriptions" |
apiVersion | Die Ressourcen-API-Version | "2020-04-01-preview" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-64 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. |
scope | Verwenden Sie beim Erstellen einer Erweiterungsressource in einem bereich, der sich vom Bereitstellungsbereich unterscheidet. | Zielressource Legen Sie für JSON den Wert auf den vollständigen Namen der Ressource fest, auf die die Erweiterungsressource angewendet werden soll. |
properties | Eigenschaften des Ereignisabonnements. | EventSubscriptionProperties |
EventSubscriptionProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
deadLetterDestination | Das Ziel für unzustellbare Nachrichten des Ereignisabonnements. Jedes Ereignis, das nicht an sein Ziel übermittelt werden kann, wird an das Ziel für unzustellbare Nachrichten gesendet. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterDestination |
deadLetterWithResourceIdentity | Das Ziel für unzustellbare Nachrichten des Ereignisabonnements. Jedes Ereignis, das nicht an sein Ziel übermittelt werden kann, wird an das Ziel für unzustellbare Nachrichten gesendet. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. Thema oder Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. Thema oder Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeliveryWithResourceIdentity |
destination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
EventSubscriptionDestination |
eventDeliverySchema | Das Ereignisübermittlungsschema für das Ereignisabonnement. | "CloudEventSchemaV1_0" 'CustomInputSchema' 'EventGridSchema' |
expirationTimeUtc | Ablaufzeit des Ereignisabonnements. | Zeichenfolge |
filter | Informationen zum Filter für das Ereignisabonnement. | EventSubscriptionFilter |
Bezeichnungen | Liste der benutzerdefinierten Bezeichnungen. | string[] |
retryPolicy | Die Wiederholungsrichtlinie für Ereignisse. Dies kann verwendet werden, um die maximale Anzahl von Übermittlungsversuchen und die Gültigkeitsdauer für Ereignisse zu konfigurieren. | RetryPolicy |
DeadLetterDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Festlegen des Objekttyps | StorageBlob (erforderlich) |
StorageBlobDeadLetterDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ziel für unzustellbare Nachrichten | "StorageBlob" (erforderlich) |
properties | Die Eigenschaften des Speicherblob-basierten Deadletter-Ziels | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
blobContainerName | Der Name des Storage-Blobcontainers, der das Ziel der Deadletter-Ereignisse ist. | Zeichenfolge |
resourceId | Die Azure-Ressourcen-ID des Speicherkontos, das das Ziel der Unzustellbaren Ereignisse ist | Zeichenfolge |
DeadLetterWithResourceIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
deadLetterDestination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. Thema oder Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterDestination |
Identität | Die Identität, die bei Ereignissen mit unzustellbaren Nachrichten verwendet werden soll. | EventSubscriptionIdentity |
EventSubscriptionIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" umfasst sowohl eine implizit erstellte Identität als auch eine Reihe von benutzerseitig zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten. | "SystemAssigned" "UserAssigned" |
userAssignedIdentity | Die der Ressource zugeordnete Benutzeridentität. | Zeichenfolge |
DeliveryWithResourceIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
destination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
EventSubscriptionDestination |
Identität | Die Identität, die beim Übermitteln von Ereignissen verwendet werden soll. | EventSubscriptionIdentity |
EventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Festlegen des Objekttyps | AzureFunction EventHub HybridConnection ServiceBusQueue ServiceBusTopic StorageQueue WebHook (erforderlich) |
AzureFunctionEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "AzureFunction" (erforderlich) |
properties | Azure-Funktionseigenschaften des Ereignisabonnementsziels. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
maxEventsPerBatch | Maximale Anzahl von Ereignissen pro Batch. | INT |
preferredBatchSizeInKilobytes | Bevorzugte Batchgröße in Kb. | INT |
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Azure-Funktionsziels eines Ereignisabonnements darstellt. | Zeichenfolge |
EventHubEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "EventHub" (erforderlich) |
properties | Event Hub-Eigenschaften des Ereignisabonnementsziels. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt eines Event Hub-Ziels eines Ereignisabonnements darstellt. | Zeichenfolge |
HybridConnectionEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "HybridConnection" (erforderlich) |
properties | Hybridverbindungseigenschaften des Ereignisabonnementsziels. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID einer Hybridverbindung, die das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
ServiceBusQueueEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "ServiceBusQueue" (erforderlich) |
properties | Service Bus-Eigenschaften des Ereignisabonnementsziels. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Service Bus-Ziels eines Ereignisabonnements darstellt. | Zeichenfolge |
ServiceBusTopicEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "ServiceBusTopic" (erforderlich) |
properties | Service Bus-Themeneigenschaften des Ereignisabonnementsziels. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Service Bus-Themaziels eines Ereignisabonnements darstellt. | Zeichenfolge |
StorageQueueEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "StorageQueue" (erforderlich) |
properties | Speicherwarteschlangeneigenschaften des Ereignisabonnementziels. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
queueName | Der Name der Speicherwarteschlange unter einem Speicherkonto, das das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
resourceId | Die Azure-Ressourcen-ID des Speicherkontos, das die Warteschlange enthält, die das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
WebHookEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "WebHook" (erforderlich) |
properties | WebHook-Eigenschaften des Ereignisabonnementziels. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | Die Azure Active Directory-Anwendungs-ID oder der URI zum Abrufen des Zugriffstokens, das als Bearertoken in Übermittlungsanforderungen enthalten ist. | Zeichenfolge |
azureActiveDirectoryTenantId | Die Azure Active Directory-Mandanten-ID zum Abrufen des Zugriffstokens, das als Bearertoken in Übermittlungsanforderungen enthalten ist. | Zeichenfolge |
endpointUrl | Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
maxEventsPerBatch | Maximale Anzahl von Ereignissen pro Batch. | INT |
preferredBatchSizeInKilobytes | Bevorzugte Batchgröße in Kilobyte. | INT |
EventSubscriptionFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
advancedFilters | Ein Array erweiterter Filter, die zum Filtern von Ereignisabonnements verwendet werden. | AdvancedFilter[] |
includedEventTypes | Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn alle Standardereignistypen abonniert werden sollen, legen Sie die IncludedEventTypes auf NULL fest. | string[] |
isSubjectCaseSensitive | Gibt an, ob die Eigenschaften SubjectBeginsWith und SubjectEndsWith des Filters sollte auf eine Weise verglichen werden, bei der die Groß-/Kleinschreibung beachtet wird. |
bool |
subjectBeginsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix. Das Format hängt vom Herausgeber der Ereignisse ab. In diesem Pfad werden keine Wildcardzeichen unterstützt. |
Zeichenfolge |
subjectEndsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix. In diesem Pfad werden keine Wildcardzeichen unterstützt. |
Zeichenfolge |
AdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
Schlüssel | Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. | Zeichenfolge |
operatorType | Festlegen des Objekttyps | BoolEquals NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberLessThan NumberLessThanOrEquals NumberNotIn StringBeginsWith StringContains StringEndsWith StringIn StringNotIn (erforderlich) |
BoolEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "BoolEquals" (erforderlich) |
value | Der boolesche Filterwert. | bool |
NumberGreaterThanAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberGreaterThan" (erforderlich) |
value | Der Filterwert. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberGreaterThanOrEquals" (erforderlich) |
value | Der Filterwert. | INT |
NumberInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'NumberIn' (erforderlich) |
Werte | Der Satz von Filterwerten. | int[] |
NumberLessThanAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberLessThan" (erforderlich) |
value | Der Filterwert. | INT |
NumberLessThanOrEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberLessThanOrEquals" (erforderlich) |
value | Der Filterwert. | INT |
NumberNotInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'NumberNotIn' (erforderlich) |
Werte | Der Satz von Filterwerten. | int[] |
StringBeginsWithAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringBeginsWith' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringContainsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringContains' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringEndsWithAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringEndsWith' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringIn' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringNotInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | 'StringNotIn' (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
RetryPolicy
Name | BESCHREIBUNG | Wert |
---|---|---|
eventTimeToLiveInMinutes | Gültigkeitsdauer (in Minuten) für Ereignisse. | INT |
maxDeliveryAttempts | Maximale Anzahl von Übermittlungsversuchen für Ereignisse. | INT |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen Azure Event Grid benutzerdefinierten Themas und Abonnements |
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Webhookabonnement. Vorlage, die ursprünglich von John Downs erstellt wurde. |
Benutzerdefiniertes Azure Event Grid Thema/Abonnement mit CloudEvents |
Erstellt ein benutzerdefiniertes Azure Event Grid Thema, ein Webhookabonnement mit CloudEvents-Schema und eine Logik-App als Ereignishandler. Vorlage, die ursprünglich von Justin Yoo erstellt wurde. |
Erstellen eines benutzerdefinierten Event Grid-Themas und eines Event Hub-Handlers |
Erstellt ein Azure Event Grid benutzerdefinierten Thema und Event Hub, um die Ereignisse zu behandeln. |
Erstellen eines Event Grid-Abonnements für Ressourcenereignisse |
Erstellt ein Event Grid-Abonnement für eine Ressourcengruppe oder ein Azure-Abonnement. |
Erstellen eines Azure Event Grid benutzerdefinierten Themas und eines Warteschlangenabonnements |
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Service Bus-Warteschlangenabonnement. Vorlage ursprünglich von Markus Meyer erstellt. |
Erstellen eines Azure Event Grid benutzerdefinierten Themenabonnements |
Erstellt ein Azure Event Grid benutzerdefiniertes Thema und ein Service Bus-Themenabonnement. Vorlage ursprünglich von Markus Meyer erstellt. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Ressourcentyp eventSubscriptions ist eine Erweiterungsressource, was bedeutet, dass Sie sie auf eine andere Ressource anwenden können.
Verwenden Sie die parent_id
-Eigenschaft für diese Ressource, um den Bereich für diese Ressource festzulegen.
Der Ressourcentyp eventSubscriptions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen
- Abonnements
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/eventSubscriptions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/eventSubscriptions@2020-04-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
deliveryWithResourceIdentity = {
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema = "string"
expirationTimeUtc = "string"
filter = {
advancedFilters = [
{
key = "string"
operatorType = "string"
// For remaining properties, see AdvancedFilter objects
}
]
includedEventTypes = [
"string"
]
isSubjectCaseSensitive = bool
subjectBeginsWith = "string"
subjectEndsWith = "string"
}
labels = [
"string"
]
retryPolicy = {
eventTimeToLiveInMinutes = int
maxDeliveryAttempts = int
}
}
})
}
DeadLetterDestination-Objekte
Legen Sie die endpointType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für StorageBlob Folgendes:
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
EventSubscriptionDestination-Objekte
Legen Sie die endpointType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für AzureFunction Folgendes:
endpointType = "AzureFunction"
properties = {
maxEventsPerBatch = int
preferredBatchSizeInKilobytes = int
resourceId = "string"
}
Verwenden Sie für EventHub Folgendes:
endpointType = "EventHub"
properties = {
resourceId = "string"
}
Verwenden Sie für HybridConnection Folgendes:
endpointType = "HybridConnection"
properties = {
resourceId = "string"
}
Verwenden Sie für ServiceBusQueue Folgendes:
endpointType = "ServiceBusQueue"
properties = {
resourceId = "string"
}
Verwenden Sie für ServiceBusTopic Folgendes:
endpointType = "ServiceBusTopic"
properties = {
resourceId = "string"
}
Verwenden Sie für StorageQueue Folgendes:
endpointType = "StorageQueue"
properties = {
queueName = "string"
resourceId = "string"
}
Verwenden Sie für WebHook Folgendes:
endpointType = "WebHook"
properties = {
azureActiveDirectoryApplicationIdOrUri = "string"
azureActiveDirectoryTenantId = "string"
endpointUrl = "string"
maxEventsPerBatch = int
preferredBatchSizeInKilobytes = int
}
AdvancedFilter-Objekte
Legen Sie die operatorType-Eigenschaft fest, um den Typ des Objekts anzugeben.
Verwenden Sie für BoolEquals Folgendes:
operatorType = "BoolEquals"
value = bool
Verwenden Sie für NumberGreaterThan Folgendes:
operatorType = "NumberGreaterThan"
value = int
Verwenden Sie für NumberGreaterThanOrEquals Folgendes:
operatorType = "NumberGreaterThanOrEquals"
value = int
Verwenden Sie für NumberIn Folgendes:
operatorType = "NumberIn"
values = [
int
]
Verwenden Sie für NumberLessThan Folgendes:
operatorType = "NumberLessThan"
value = int
Verwenden Sie für NumberLessThanOrEquals Folgendes:
operatorType = "NumberLessThanOrEquals"
value = int
Verwenden Sie für NumberNotIn Folgendes:
operatorType = "NumberNotIn"
values = [
int
]
Verwenden Sie für StringBeginsWith Folgendes:
operatorType = "StringBeginsWith"
values = [
"string"
]
Verwenden Sie für StringContains Folgendes:
operatorType = "StringContains"
values = [
"string"
]
Verwenden Sie für StringEndsWith Folgendes:
operatorType = "StringEndsWith"
values = [
"string"
]
Verwenden Sie für StringIn Folgendes:
operatorType = "StringIn"
values = [
"string"
]
Verwenden Sie für StringNotIn Folgendes:
operatorType = "StringNotIn"
values = [
"string"
]
Eigenschaftswerte
eventSubscriptions
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.EventGrid/eventSubscriptions@2020-04-01-preview" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 3-64 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. |
parent_id | Die ID der Ressource, auf die diese Erweiterungsressource angewendet werden soll. | Zeichenfolge (erforderlich) |
properties | Eigenschaften des Ereignisabonnements. | EventSubscriptionProperties |
EventSubscriptionProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
deadLetterDestination | Das Ziel für unzustellbare Nachrichten des Ereignisabonnements. Jedes Ereignis, das nicht an sein Ziel übermittelt werden kann, wird an das Ziel für unzustellbare Nachrichten gesendet. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterDestination |
deadLetterWithResourceIdentity | Das Ziel für unzustellbare Nachrichten des Ereignisabonnements. Jedes Ereignis, das nicht an sein Ziel übermittelt werden kann, wird an das Ziel für unzustellbare Nachrichten gesendet. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. das Thema oder die Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. das Thema oder die Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeliveryWithResourceIdentity |
destination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
EventSubscriptionDestination |
eventDeliverySchema | Das Ereignisübermittlungsschema für das Ereignisabonnement. | "CloudEventSchemaV1_0" "CustomInputSchema" "EventGridSchema" |
expirationTimeUtc | Ablaufzeit des Ereignisabonnements. | Zeichenfolge |
filter | Informationen zum Filter für das Ereignisabonnement. | EventSubscriptionFilter |
Bezeichnungen | Liste der benutzerdefinierten Bezeichnungen. | string[] |
retryPolicy | Die Wiederholungsrichtlinie für Ereignisse. Dies kann verwendet werden, um die maximale Anzahl von Übermittlungsversuchen und die Dauer für Ereignisse zu konfigurieren. | RetryPolicy |
DeadLetterDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Festlegen des Objekttyps | StorageBlob (erforderlich) |
StorageBlobDeadLetterDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ziel des unzustellbaren Buchstabens | "StorageBlob" (erforderlich) |
properties | Die Eigenschaften des Speicherblob-basierten Deadletter-Ziels | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
blobContainerName | Der Name des Speicherblobcontainers, der das Ziel der Deadletterereignisse darstellt | Zeichenfolge |
resourceId | Die Azure-Ressourcen-ID des Speicherkontos, das das Ziel der Deadletterereignisse ist | Zeichenfolge |
DeadLetterWithResourceIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
deadLetterDestination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet das Setup der verwalteten Identität für die übergeordnete Ressource (d. h. das Thema oder die Domäne), um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
DeadLetterDestination |
Identität | Die Identität, die bei Ereignissen mit unzustellbaren Buchstaben verwendet werden soll. | EventSubscriptionIdentity |
EventSubscriptionIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe benutzerseitig zugewiesener Identitäten. Der Typ "None" entfernt jede Identität. | "SystemAssigned" "UserAssigned" |
userAssignedIdentity | Die der Ressource zugeordnete Benutzeridentität. | Zeichenfolge |
DeliveryWithResourceIdentity
Name | BESCHREIBUNG | Wert |
---|---|---|
destination | Informationen zum Ziel, an dem Ereignisse für das Ereignisabonnement übermittelt werden müssen. Verwendet die Identität von Azure Event Grid, um die Authentifizierungstoken abzurufen, die während der Übermittlung/Unzustellbarkeit verwendet werden. |
EventSubscriptionDestination |
Identität | Die Identität, die beim Übermitteln von Ereignissen verwendet werden soll. | EventSubscriptionIdentity |
EventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Festlegen des Objekttyps | AzureFunction EventHub HybridConnection ServiceBusQueue ServiceBusTopic StorageQueue WebHook (erforderlich) |
AzureFunctionEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "AzureFunction" (erforderlich) |
properties | Azure-Funktionseigenschaften des Ereignisabonnementsziels. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
maxEventsPerBatch | Maximale Anzahl von Ereignissen pro Batch. | INT |
preferredBatchSizeInKilobytes | Bevorzugte Batchgröße in Kb. | INT |
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Azure-Funktionsziels eines Ereignisabonnements darstellt. | Zeichenfolge |
EventHubEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "EventHub" (erforderlich) |
properties | Event Hub-Eigenschaften des Ereignisabonnementsziels. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt eines Event Hub-Ziels eines Ereignisabonnements darstellt. | Zeichenfolge |
HybridConnectionEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "HybridConnection" (erforderlich) |
properties | Hybridverbindungseigenschaften des Ereignisabonnementsziels. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID einer Hybridverbindung, die das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
ServiceBusQueueEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "ServiceBusQueue" (erforderlich) |
properties | Service Bus-Eigenschaften des Ereignisabonnementsziels. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Service Bus-Ziels eines Ereignisabonnements darstellt. | Zeichenfolge |
ServiceBusTopicEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "ServiceBusTopic" (erforderlich) |
properties | Service Bus-Themeneigenschaften des Ereignisabonnementsziels. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
Name | BESCHREIBUNG | Wert |
---|---|---|
resourceId | Die Azure-Ressourcen-ID, die den Endpunkt des Service Bus-Themaziels eines Ereignisabonnements darstellt. | Zeichenfolge |
StorageQueueEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "StorageQueue" (erforderlich) |
properties | Speicherwarteschlangeneigenschaften des Ereignisabonnementsziels. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
queueName | Der Name der Speicherwarteschlange unter einem Speicherkonto, das das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
resourceId | Die Azure-Ressourcen-ID des Speicherkontos, das die Warteschlange enthält, die das Ziel eines Ereignisabonnements ist. | Zeichenfolge |
WebHookEventSubscriptionDestination
Name | BESCHREIBUNG | Wert |
---|---|---|
endpointType | Typ des Endpunkts für das Ereignisabonnementziel. | "WebHook" (erforderlich) |
properties | WebHook-Eigenschaften des Ereignisabonnementsziels. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Name | BESCHREIBUNG | Wert |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | Die Azure Active Directory-Anwendungs-ID oder der URI zum Abrufen des Zugriffstokens, das als Bearertoken in Übermittlungsanforderungen enthalten wird. | Zeichenfolge |
azureActiveDirectoryTenantId | Die Azure Active Directory-Mandanten-ID zum Abrufen des Zugriffstokens, das als Bearertoken in Übermittlungsanforderungen enthalten wird. | Zeichenfolge |
endpointUrl | Die URL, die den Endpunkt des Ziels eines Ereignisabonnements darstellt. | Zeichenfolge Einschränkungen: Vertraulicher Wert. Übergeben Sie als sicheren Parameter. |
maxEventsPerBatch | Maximale Anzahl von Ereignissen pro Batch. | INT |
preferredBatchSizeInKilobytes | Bevorzugte Batchgröße in Kb. | INT |
EventSubscriptionFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
advancedFilters | Ein Array erweiterter Filter, die zum Filtern von Ereignisabonnements verwendet werden. | AdvancedFilter[] |
includedEventTypes | Eine Liste der anwendbaren Ereignistypen, die Teil des Ereignisabonnements sein müssen. Wenn sie alle Standardereignistypen abonnieren möchten, legen Sie die IncludedEventTypes auf NULL fest. | string[] |
isSubjectCaseSensitive | Gibt an, ob die Eigenschaften SubjectBeginsWith und SubjectEndsWith des Filters sollte mit der Groß-/Kleinschreibung verglichen werden. |
bool |
subjectBeginsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadpräfix. Das Format hängt vom Herausgeber der Ereignisse ab. Wildcardzeichen werden in diesem Pfad nicht unterstützt. |
Zeichenfolge |
subjectEndsWith | Eine optionale Zeichenfolge zum Filtern von Ereignissen für ein Ereignisabonnement basierend auf einem Ressourcenpfadsuffix. Wildcardzeichen werden in diesem Pfad nicht unterstützt. |
Zeichenfolge |
AdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
Schlüssel | Das Feld/die Eigenschaft im Ereignis, basierend auf dem Sie filtern möchten. | Zeichenfolge |
operatorType | Festlegen des Objekttyps | BoolEquals NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberLessThan NumberLessThanOrEquals NumberNotIn StringBeginsWith StringContains StringEndsWith StringIn StringNotIn (erforderlich) |
BoolEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "BoolEquals" (erforderlich) |
value | Der boolesche Filterwert. | bool |
NumberGreaterThanAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberGreaterThan" (erforderlich) |
value | Der Filterwert. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberGreaterThanOrEquals" (erforderlich) |
value | Der Filterwert. | INT |
NumberInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberIn" (erforderlich) |
Werte | Der Satz von Filterwerten. | int[] |
NumberLessThanAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberLessThan" (erforderlich) |
value | Der Filterwert. | INT |
NumberLessThanOrEqualsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberLessThanOrEquals" (erforderlich) |
value | Der Filterwert. | INT |
NumberNotInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "NumberNotIn" (erforderlich) |
Werte | Der Satz von Filterwerten. | int[] |
StringBeginsWithAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "StringBeginsWith" (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringContainsAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "StringContains" (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringEndsWithAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "StringEndsWith" (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "StringIn" (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
StringNotInAdvancedFilter
Name | BESCHREIBUNG | Wert |
---|---|---|
operatorType | Der zum Filtern verwendete Operatortyp, z. B. NumberIn, StringContains, BoolEquals und andere. | "StringNotIn" (erforderlich) |
Werte | Der Satz von Filterwerten. | string[] |
RetryPolicy
Name | BESCHREIBUNG | Wert |
---|---|---|
eventTimeToLiveInMinutes | Gültigkeitsdauer (in Minuten) für Ereignisse. | INT |
maxDeliveryAttempts | Maximale Anzahl von Wiederholungsversuchen für Die Übermittlung für Ereignisse. | INT |