Microsoft.EventGrid-Domänen 2023-12-15-Preview
Bicep-Ressourcendefinition
Der Domänenressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/Domains-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.EventGrid/domains@2023-12-15-preview' = {
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
autoCreateTopicWithFirstSubscription: bool
autoDeleteTopicWithLastSubscription: bool
dataResidencyBoundary: 'string'
disableLocalAuth: bool
eventTypeInfo: {
inlineEventTypes: {
{customized property}: {
dataSchemaUrl: 'string'
description: 'string'
displayName: 'string'
documentationUrl: 'string'
}
}
kind: 'string'
}
inboundIpRules: [
{
action: 'string'
ipMask: 'string'
}
]
inputSchema: 'string'
inputSchemaMapping: {
inputSchemaMappingType: 'string'
// For remaining properties, see InputSchemaMapping objects
}
minimumTlsVersionAllowed: 'string'
publicNetworkAccess: 'string'
}
sku: {
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
InputSchemaMapping-Objekte
Legen Sie die inputSchemaMappingType--Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für JSON-:
{
inputSchemaMappingType: 'Json'
properties: {
dataVersion: {
defaultValue: 'string'
sourceField: 'string'
}
eventTime: {
sourceField: 'string'
}
eventType: {
defaultValue: 'string'
sourceField: 'string'
}
id: {
sourceField: 'string'
}
subject: {
defaultValue: 'string'
sourceField: 'string'
}
topic: {
sourceField: 'string'
}
}
}
Eigenschaftswerte
DomainProperties
| Name | Beschreibung | Wert |
|---|---|---|
| autoCreateTopicWithFirstSubscription | Dieser boolesche Wert wird verwendet, um den Erstellungsmechanismus für alle Ereignisrasterdomänenthemen anzugeben, die dieser Event Grid Domain-Ressource zugeordnet sind. In diesem Kontext kann die Erstellung des Domänenthemas automatisch verwaltet werden (wenn wahr) oder selbstverwaltet werden (wenn falsch). Der Standardwert für diese Eigenschaft ist true. Wenn diese Eigenschaft null ist oder auf "true" festgelegt ist, ist das Ereignisraster dafür verantwortlich, das Domänenthema automatisch zu erstellen, wenn das erste Ereignisabonnement erstellt im Bereich des Domänenthemas. Wenn diese Eigenschaft auf "false" festgelegt ist, muss beim Erstellen des ersten Ereignisabonnements ein Domänenthema erstellt werden. vom Benutzer. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die volle Kontrolle über das Erstellen des Domänenthemas wünscht, während der automatisch verwaltete Modus den Flexibilität, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten. Beachten Sie außerdem, dass der Benutzer im automatisch verwalteten Erstellungsmodus die Erstellung des domain topic on demand if needed. |
Bool |
| autoDeleteTopicWithLastSubscription | Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" die Ereignisrasterdomänenthemen anzugeben, die dieser Event Grid Domain-Ressource zugeordnet sind. In diesem Kontext kann das Löschen des Domänenthemas automatisch verwaltet werden (wenn wahr) oder selbstverwaltet werden (wenn falsch). Der Standardwert für diese Eigenschaft ist true. Wenn diese Eigenschaft auf "true" festgelegt ist, ist das Ereignisraster dafür verantwortlich, das Domänenthema automatisch zu löschen, wenn das letzte Ereignisabonnement im Bereich liegt. des Domänenthemas wird gelöscht. Wenn diese Eigenschaft auf "false" festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn er nicht mehr benötigt wird. (z. B. wenn das letzte Ereignisabonnement gelöscht wird und die Ressource bereinigt werden muss). Der Self-Management-Modus kann verwendet werden, wenn der Benutzer voll will Kontrolle darüber, wann das Domänenthema gelöscht werden muss, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger zu verwalten Ressourcen vom Benutzer. |
Bool |
| dataResidencyBoundary | Data Residency-Grenze der Ressource. | "WithinGeopair" "WithinRegion" |
| disableLocalAuth | Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist "false". Wenn die Eigenschaft auf "true" festgelegt ist, wird nur ein AAD-Token verwendet, um sich zu authentifizieren, wenn der Benutzer in der Domäne veröffentlichen darf. | Bool |
| eventTypeInfo | Ereignistypinformationen für die Domäne. Diese Informationen werden vom Herausgeber bereitgestellt und können vom Abonnent, um verschiedene Arten von Ereignissen anzuzeigen, die veröffentlicht werden. |
EventTypeInfo- |
| inboundIpRules | Dies kann verwendet werden, um den Datenverkehr von bestimmten IPs anstelle aller IPs einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist. | InboundIpRule-[] |
| inputSchema | Dadurch wird das Format bestimmt, das das Ereignisraster für eingehende Ereignisse erwarten soll, die in der Event Grid Domain Resource veröffentlicht wurden. | "CloudEventSchemaV1_0" 'CustomEventSchema' 'EventGridSchema' |
| inputSchemaMapping | Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat. | InputSchemaMapping- |
| minimumTlsVersionAllowed | Minimale TLS-Version des Herausgebers, die in dieser Domäne veröffentlicht werden darf | '1.0' '1.1' '1.2' |
| publicNetworkAccess | Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. Sie können auf bestimmte IPs weiter einschränken, indem Sie <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /> |
"Deaktiviert" "Aktiviert" "SecuredByPerimeter" |
EventTypeInfo
| Name | Beschreibung | Wert |
|---|---|---|
| inlineEventTypes | Eine Auflistung von Inlineereignistypen für die Ressource. Die Inlineereignistypschlüssel sind vom Typ Zeichenfolge, die den Namen des Ereignisses darstellt. Ein Beispiel für einen gültigen Inlineereignisnamen ist "Contoso.OrderCreated". Die Inlineereignistypwerte sind vom Typ "InlineEventProperties" und enthalten zusätzliche Informationen für jeden Inlineereignistyp. |
EventTypeInfoInlineEventTypes- |
| Art | Die Art des verwendeten Ereignistyps. | "Inline" |
EventTypeInfoInlineEventTypes
| Name | Beschreibung | Wert |
|---|
IdentityInfo
| Name | Beschreibung | Wert |
|---|---|---|
| principalId | Die Prinzipal-ID der Ressourcenidentität. | Schnur |
| tenantId | Die Mandanten-ID der Ressource. | Schnur |
| Art | Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten. | 'None' 'SystemAssigned' "SystemAssigned, UserAssigned" "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Diese Eigenschaft wird derzeit nicht verwendet und für die zukünftige Verwendung reserviert. |
IdentityInfoUserAssignedIdentities- |
IdentityInfoUserAssignedIdentities
| Name | Beschreibung | Wert |
|---|
InboundIpRule
| Name | Beschreibung | Wert |
|---|---|---|
| Aktion | Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll. | "Zulassen" |
| ipMask | IP-Adresse in CIDR-Notation z. B. 10.0.0.0/8. | Schnur |
InlineEventProperties
| Name | Beschreibung | Wert |
|---|---|---|
| dataSchemaUrl | The dataSchemaUrl for the inline event. | Schnur |
| Beschreibung | Die Beschreibung für das Inlineereignis. | Schnur |
| displayName | Der displayName für das Inlineereignis. | Schnur |
| documentationUrl | Die documentationUrl für das Inlineereignis. | Schnur |
InputSchemaMapping
| Name | Beschreibung | Wert |
|---|---|---|
| inputSchemaMappingType | Set to 'Json' for type JsonInputSchemaMapping. | "Json" (erforderlich) |
JsonField
| Name | Beschreibung | Wert |
|---|---|---|
| sourceField | Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. | Schnur |
JsonFieldWithDefault
| Name | Beschreibung | Wert |
|---|---|---|
| defaultValue | Der Standardwert, der für die Zuordnung verwendet werden soll, wenn kein SourceField bereitgestellt wird oder wenn keine Eigenschaft mit dem angegebenen Namen in der veröffentlichten JSON-Ereignisnutzlast vorhanden ist. | Schnur |
| sourceField | Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. | Schnur |
JsonInputSchemaMapping
| Name | Beschreibung | Wert |
|---|---|---|
| inputSchemaMappingType | Typ der benutzerdefinierten Zuordnung | "Json" (erforderlich) |
| Eigenschaften | JSON-Eigenschaften der Eingabeschemazuordnung | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| Name | Beschreibung | Wert |
|---|---|---|
| dataVersion | Die Zuordnungsinformationen für die DataVersion-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| eventTime | Die Zuordnungsinformationen für die EventTime-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
| eventType | Die Zuordnungsinformationen für die EventType-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| id | Die Zuordnungsinformationen für die ID-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
| Betreff | Die Zuordnungsinformationen für die Subject-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| Thema | Die Zuordnungsinformationen für die Topic-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
Microsoft.EventGrid/Domains
| Name | Beschreibung | Wert |
|---|---|---|
| Identität | Identitätsinformationen für die Event Grid Domain-Ressource. | IdentityInfo- |
| Ort | Speicherort der Ressource. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Eigenschaften | Eigenschaften der Event Grid Domain-Ressource. | DomainProperties- |
| Sku | Die Sku-Preisstufe für die Event Grid Domain-Ressource. | ResourceSku- |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
ResourceSku
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Sku-Name der Ressource. Mögliche Werte sind: Basic oder Premium. | "Einfach" "Premium" |
TrackedResourceTags
| Name | Beschreibung | Wert |
|---|
UserIdentityProperties
| Name | Beschreibung | Wert |
|---|---|---|
| clientId | Die Client-ID der vom Benutzer zugewiesenen Identität. | Schnur |
| principalId | Die Prinzipal-ID der vom Benutzer zugewiesenen Identität. | Schnur |
ARM-Vorlagenressourcendefinition
Der Domänenressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/Domains-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.EventGrid/domains",
"apiVersion": "2023-12-15-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"autoCreateTopicWithFirstSubscription": "bool",
"autoDeleteTopicWithLastSubscription": "bool",
"dataResidencyBoundary": "string",
"disableLocalAuth": "bool",
"eventTypeInfo": {
"inlineEventTypes": {
"{customized property}": {
"dataSchemaUrl": "string",
"description": "string",
"displayName": "string",
"documentationUrl": "string"
}
},
"kind": "string"
},
"inboundIpRules": [
{
"action": "string",
"ipMask": "string"
}
],
"inputSchema": "string",
"inputSchemaMapping": {
"inputSchemaMappingType": "string"
// For remaining properties, see InputSchemaMapping objects
},
"minimumTlsVersionAllowed": "string",
"publicNetworkAccess": "string"
},
"sku": {
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
InputSchemaMapping-Objekte
Legen Sie die inputSchemaMappingType--Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für JSON-:
{
"inputSchemaMappingType": "Json",
"properties": {
"dataVersion": {
"defaultValue": "string",
"sourceField": "string"
},
"eventTime": {
"sourceField": "string"
},
"eventType": {
"defaultValue": "string",
"sourceField": "string"
},
"id": {
"sourceField": "string"
},
"subject": {
"defaultValue": "string",
"sourceField": "string"
},
"topic": {
"sourceField": "string"
}
}
}
Eigenschaftswerte
DomainProperties
| Name | Beschreibung | Wert |
|---|---|---|
| autoCreateTopicWithFirstSubscription | Dieser boolesche Wert wird verwendet, um den Erstellungsmechanismus für alle Ereignisrasterdomänenthemen anzugeben, die dieser Event Grid Domain-Ressource zugeordnet sind. In diesem Kontext kann die Erstellung des Domänenthemas automatisch verwaltet werden (wenn wahr) oder selbstverwaltet werden (wenn falsch). Der Standardwert für diese Eigenschaft ist true. Wenn diese Eigenschaft null ist oder auf "true" festgelegt ist, ist das Ereignisraster dafür verantwortlich, das Domänenthema automatisch zu erstellen, wenn das erste Ereignisabonnement erstellt im Bereich des Domänenthemas. Wenn diese Eigenschaft auf "false" festgelegt ist, muss beim Erstellen des ersten Ereignisabonnements ein Domänenthema erstellt werden. vom Benutzer. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die volle Kontrolle über das Erstellen des Domänenthemas wünscht, während der automatisch verwaltete Modus den Flexibilität, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten. Beachten Sie außerdem, dass der Benutzer im automatisch verwalteten Erstellungsmodus die Erstellung des domain topic on demand if needed. |
Bool |
| autoDeleteTopicWithLastSubscription | Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" die Ereignisrasterdomänenthemen anzugeben, die dieser Event Grid Domain-Ressource zugeordnet sind. In diesem Kontext kann das Löschen des Domänenthemas automatisch verwaltet werden (wenn wahr) oder selbstverwaltet werden (wenn falsch). Der Standardwert für diese Eigenschaft ist true. Wenn diese Eigenschaft auf "true" festgelegt ist, ist das Ereignisraster dafür verantwortlich, das Domänenthema automatisch zu löschen, wenn das letzte Ereignisabonnement im Bereich liegt. des Domänenthemas wird gelöscht. Wenn diese Eigenschaft auf "false" festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn er nicht mehr benötigt wird. (z. B. wenn das letzte Ereignisabonnement gelöscht wird und die Ressource bereinigt werden muss). Der Self-Management-Modus kann verwendet werden, wenn der Benutzer voll will Kontrolle darüber, wann das Domänenthema gelöscht werden muss, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger zu verwalten Ressourcen vom Benutzer. |
Bool |
| dataResidencyBoundary | Data Residency-Grenze der Ressource. | "WithinGeopair" "WithinRegion" |
| disableLocalAuth | Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist "false". Wenn die Eigenschaft auf "true" festgelegt ist, wird nur ein AAD-Token verwendet, um sich zu authentifizieren, wenn der Benutzer in der Domäne veröffentlichen darf. | Bool |
| eventTypeInfo | Ereignistypinformationen für die Domäne. Diese Informationen werden vom Herausgeber bereitgestellt und können vom Abonnent, um verschiedene Arten von Ereignissen anzuzeigen, die veröffentlicht werden. |
EventTypeInfo- |
| inboundIpRules | Dies kann verwendet werden, um den Datenverkehr von bestimmten IPs anstelle aller IPs einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist. | InboundIpRule-[] |
| inputSchema | Dadurch wird das Format bestimmt, das das Ereignisraster für eingehende Ereignisse erwarten soll, die in der Event Grid Domain Resource veröffentlicht wurden. | "CloudEventSchemaV1_0" 'CustomEventSchema' 'EventGridSchema' |
| inputSchemaMapping | Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat. | InputSchemaMapping- |
| minimumTlsVersionAllowed | Minimale TLS-Version des Herausgebers, die in dieser Domäne veröffentlicht werden darf | '1.0' '1.1' '1.2' |
| publicNetworkAccess | Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. Sie können auf bestimmte IPs weiter einschränken, indem Sie <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /> |
"Deaktiviert" "Aktiviert" "SecuredByPerimeter" |
EventTypeInfo
| Name | Beschreibung | Wert |
|---|---|---|
| inlineEventTypes | Eine Auflistung von Inlineereignistypen für die Ressource. Die Inlineereignistypschlüssel sind vom Typ Zeichenfolge, die den Namen des Ereignisses darstellt. Ein Beispiel für einen gültigen Inlineereignisnamen ist "Contoso.OrderCreated". Die Inlineereignistypwerte sind vom Typ "InlineEventProperties" und enthalten zusätzliche Informationen für jeden Inlineereignistyp. |
EventTypeInfoInlineEventTypes- |
| Art | Die Art des verwendeten Ereignistyps. | "Inline" |
EventTypeInfoInlineEventTypes
| Name | Beschreibung | Wert |
|---|
IdentityInfo
| Name | Beschreibung | Wert |
|---|---|---|
| principalId | Die Prinzipal-ID der Ressourcenidentität. | Schnur |
| tenantId | Die Mandanten-ID der Ressource. | Schnur |
| Art | Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten. | 'None' 'SystemAssigned' "SystemAssigned, UserAssigned" "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Diese Eigenschaft wird derzeit nicht verwendet und für die zukünftige Verwendung reserviert. |
IdentityInfoUserAssignedIdentities- |
IdentityInfoUserAssignedIdentities
| Name | Beschreibung | Wert |
|---|
InboundIpRule
| Name | Beschreibung | Wert |
|---|---|---|
| Aktion | Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll. | "Zulassen" |
| ipMask | IP-Adresse in CIDR-Notation z. B. 10.0.0.0/8. | Schnur |
InlineEventProperties
| Name | Beschreibung | Wert |
|---|---|---|
| dataSchemaUrl | The dataSchemaUrl for the inline event. | Schnur |
| Beschreibung | Die Beschreibung für das Inlineereignis. | Schnur |
| displayName | Der displayName für das Inlineereignis. | Schnur |
| documentationUrl | Die documentationUrl für das Inlineereignis. | Schnur |
InputSchemaMapping
| Name | Beschreibung | Wert |
|---|---|---|
| inputSchemaMappingType | Set to 'Json' for type JsonInputSchemaMapping. | "Json" (erforderlich) |
JsonField
| Name | Beschreibung | Wert |
|---|---|---|
| sourceField | Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. | Schnur |
JsonFieldWithDefault
| Name | Beschreibung | Wert |
|---|---|---|
| defaultValue | Der Standardwert, der für die Zuordnung verwendet werden soll, wenn kein SourceField bereitgestellt wird oder wenn keine Eigenschaft mit dem angegebenen Namen in der veröffentlichten JSON-Ereignisnutzlast vorhanden ist. | Schnur |
| sourceField | Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. | Schnur |
JsonInputSchemaMapping
| Name | Beschreibung | Wert |
|---|---|---|
| inputSchemaMappingType | Typ der benutzerdefinierten Zuordnung | "Json" (erforderlich) |
| Eigenschaften | JSON-Eigenschaften der Eingabeschemazuordnung | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| Name | Beschreibung | Wert |
|---|---|---|
| dataVersion | Die Zuordnungsinformationen für die DataVersion-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| eventTime | Die Zuordnungsinformationen für die EventTime-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
| eventType | Die Zuordnungsinformationen für die EventType-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| id | Die Zuordnungsinformationen für die ID-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
| Betreff | Die Zuordnungsinformationen für die Subject-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| Thema | Die Zuordnungsinformationen für die Topic-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
Microsoft.EventGrid/Domains
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | "2023-12-15-preview" |
| Identität | Identitätsinformationen für die Event Grid Domain-Ressource. | IdentityInfo- |
| Ort | Speicherort der Ressource. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Eigenschaften | Eigenschaften der Event Grid Domain-Ressource. | DomainProperties- |
| Sku | Die Sku-Preisstufe für die Event Grid Domain-Ressource. | ResourceSku- |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Art | Der Ressourcentyp | "Microsoft.EventGrid/Domains" |
ResourceSku
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Sku-Name der Ressource. Mögliche Werte sind: Basic oder Premium. | "Einfach" "Premium" |
TrackedResourceTags
| Name | Beschreibung | Wert |
|---|
UserIdentityProperties
| Name | Beschreibung | Wert |
|---|---|---|
| clientId | Die Client-ID der vom Benutzer zugewiesenen Identität. | Schnur |
| principalId | Die Prinzipal-ID der vom Benutzer zugewiesenen Identität. | Schnur |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Domänenressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.EventGrid/domains-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/domains@2023-12-15-preview"
name = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
autoCreateTopicWithFirstSubscription = bool
autoDeleteTopicWithLastSubscription = bool
dataResidencyBoundary = "string"
disableLocalAuth = bool
eventTypeInfo = {
inlineEventTypes = {
{customized property} = {
dataSchemaUrl = "string"
description = "string"
displayName = "string"
documentationUrl = "string"
}
}
kind = "string"
}
inboundIpRules = [
{
action = "string"
ipMask = "string"
}
]
inputSchema = "string"
inputSchemaMapping = {
inputSchemaMappingType = "string"
// For remaining properties, see InputSchemaMapping objects
}
minimumTlsVersionAllowed = "string"
publicNetworkAccess = "string"
}
})
}
InputSchemaMapping-Objekte
Legen Sie die inputSchemaMappingType--Eigenschaft fest, um den Objekttyp anzugeben.
Verwenden Sie für JSON-:
{
inputSchemaMappingType = "Json"
properties = {
dataVersion = {
defaultValue = "string"
sourceField = "string"
}
eventTime = {
sourceField = "string"
}
eventType = {
defaultValue = "string"
sourceField = "string"
}
id = {
sourceField = "string"
}
subject = {
defaultValue = "string"
sourceField = "string"
}
topic = {
sourceField = "string"
}
}
}
Eigenschaftswerte
DomainProperties
| Name | Beschreibung | Wert |
|---|---|---|
| autoCreateTopicWithFirstSubscription | Dieser boolesche Wert wird verwendet, um den Erstellungsmechanismus für alle Ereignisrasterdomänenthemen anzugeben, die dieser Event Grid Domain-Ressource zugeordnet sind. In diesem Kontext kann die Erstellung des Domänenthemas automatisch verwaltet werden (wenn wahr) oder selbstverwaltet werden (wenn falsch). Der Standardwert für diese Eigenschaft ist true. Wenn diese Eigenschaft null ist oder auf "true" festgelegt ist, ist das Ereignisraster dafür verantwortlich, das Domänenthema automatisch zu erstellen, wenn das erste Ereignisabonnement erstellt im Bereich des Domänenthemas. Wenn diese Eigenschaft auf "false" festgelegt ist, muss beim Erstellen des ersten Ereignisabonnements ein Domänenthema erstellt werden. vom Benutzer. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die volle Kontrolle über das Erstellen des Domänenthemas wünscht, während der automatisch verwaltete Modus den Flexibilität, weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten. Beachten Sie außerdem, dass der Benutzer im automatisch verwalteten Erstellungsmodus die Erstellung des domain topic on demand if needed. |
Bool |
| autoDeleteTopicWithLastSubscription | Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" die Ereignisrasterdomänenthemen anzugeben, die dieser Event Grid Domain-Ressource zugeordnet sind. In diesem Kontext kann das Löschen des Domänenthemas automatisch verwaltet werden (wenn wahr) oder selbstverwaltet werden (wenn falsch). Der Standardwert für diese Eigenschaft ist true. Wenn diese Eigenschaft auf "true" festgelegt ist, ist das Ereignisraster dafür verantwortlich, das Domänenthema automatisch zu löschen, wenn das letzte Ereignisabonnement im Bereich liegt. des Domänenthemas wird gelöscht. Wenn diese Eigenschaft auf "false" festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn er nicht mehr benötigt wird. (z. B. wenn das letzte Ereignisabonnement gelöscht wird und die Ressource bereinigt werden muss). Der Self-Management-Modus kann verwendet werden, wenn der Benutzer voll will Kontrolle darüber, wann das Domänenthema gelöscht werden muss, während der automatisch verwaltete Modus die Flexibilität bietet, weniger Vorgänge auszuführen und weniger zu verwalten Ressourcen vom Benutzer. |
Bool |
| dataResidencyBoundary | Data Residency-Grenze der Ressource. | "WithinGeopair" "WithinRegion" |
| disableLocalAuth | Dieser boolesche Wert wird verwendet, um die lokale Authentifizierung zu aktivieren oder zu deaktivieren. Der Standardwert ist "false". Wenn die Eigenschaft auf "true" festgelegt ist, wird nur ein AAD-Token verwendet, um sich zu authentifizieren, wenn der Benutzer in der Domäne veröffentlichen darf. | Bool |
| eventTypeInfo | Ereignistypinformationen für die Domäne. Diese Informationen werden vom Herausgeber bereitgestellt und können vom Abonnent, um verschiedene Arten von Ereignissen anzuzeigen, die veröffentlicht werden. |
EventTypeInfo- |
| inboundIpRules | Dies kann verwendet werden, um den Datenverkehr von bestimmten IPs anstelle aller IPs einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist. | InboundIpRule-[] |
| inputSchema | Dadurch wird das Format bestimmt, das das Ereignisraster für eingehende Ereignisse erwarten soll, die in der Event Grid Domain Resource veröffentlicht wurden. | "CloudEventSchemaV1_0" 'CustomEventSchema' 'EventGridSchema' |
| inputSchemaMapping | Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat. | InputSchemaMapping- |
| minimumTlsVersionAllowed | Minimale TLS-Version des Herausgebers, die in dieser Domäne veröffentlicht werden darf | '1.0' '1.1' '1.2' |
| publicNetworkAccess | Dadurch wird ermittelt, ob Datenverkehr über das öffentliche Netzwerk zulässig ist. Standardmäßig ist sie aktiviert. Sie können auf bestimmte IPs weiter einschränken, indem Sie <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /> |
"Deaktiviert" "Aktiviert" "SecuredByPerimeter" |
EventTypeInfo
| Name | Beschreibung | Wert |
|---|---|---|
| inlineEventTypes | Eine Auflistung von Inlineereignistypen für die Ressource. Die Inlineereignistypschlüssel sind vom Typ Zeichenfolge, die den Namen des Ereignisses darstellt. Ein Beispiel für einen gültigen Inlineereignisnamen ist "Contoso.OrderCreated". Die Inlineereignistypwerte sind vom Typ "InlineEventProperties" und enthalten zusätzliche Informationen für jeden Inlineereignistyp. |
EventTypeInfoInlineEventTypes- |
| Art | Die Art des verwendeten Ereignistyps. | "Inline" |
EventTypeInfoInlineEventTypes
| Name | Beschreibung | Wert |
|---|
IdentityInfo
| Name | Beschreibung | Wert |
|---|---|---|
| principalId | Die Prinzipal-ID der Ressourcenidentität. | Schnur |
| tenantId | Die Mandanten-ID der Ressource. | Schnur |
| Art | Der Typ der verwendeten verwalteten Identität. Der Typ "SystemAssigned, UserAssigned" enthält sowohl eine implizit erstellte Identität als auch eine Reihe von vom Benutzer zugewiesenen Identitäten. Der Typ "None" entfernt alle Identitäten. | 'None' 'SystemAssigned' "SystemAssigned, UserAssigned" "UserAssigned" |
| userAssignedIdentities | Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Benutzeridentitätswörterbuchschlüsselverweise sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Diese Eigenschaft wird derzeit nicht verwendet und für die zukünftige Verwendung reserviert. |
IdentityInfoUserAssignedIdentities- |
IdentityInfoUserAssignedIdentities
| Name | Beschreibung | Wert |
|---|
InboundIpRule
| Name | Beschreibung | Wert |
|---|---|---|
| Aktion | Aktion, die basierend auf der Übereinstimmung oder ohne Übereinstimmung der IpMask ausgeführt werden soll. | "Zulassen" |
| ipMask | IP-Adresse in CIDR-Notation z. B. 10.0.0.0/8. | Schnur |
InlineEventProperties
| Name | Beschreibung | Wert |
|---|---|---|
| dataSchemaUrl | The dataSchemaUrl for the inline event. | Schnur |
| Beschreibung | Die Beschreibung für das Inlineereignis. | Schnur |
| displayName | Der displayName für das Inlineereignis. | Schnur |
| documentationUrl | Die documentationUrl für das Inlineereignis. | Schnur |
InputSchemaMapping
| Name | Beschreibung | Wert |
|---|---|---|
| inputSchemaMappingType | Set to 'Json' for type JsonInputSchemaMapping. | "Json" (erforderlich) |
JsonField
| Name | Beschreibung | Wert |
|---|---|---|
| sourceField | Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. | Schnur |
JsonFieldWithDefault
| Name | Beschreibung | Wert |
|---|---|---|
| defaultValue | Der Standardwert, der für die Zuordnung verwendet werden soll, wenn kein SourceField bereitgestellt wird oder wenn keine Eigenschaft mit dem angegebenen Namen in der veröffentlichten JSON-Ereignisnutzlast vorhanden ist. | Schnur |
| sourceField | Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. | Schnur |
JsonInputSchemaMapping
| Name | Beschreibung | Wert |
|---|---|---|
| inputSchemaMappingType | Typ der benutzerdefinierten Zuordnung | "Json" (erforderlich) |
| Eigenschaften | JSON-Eigenschaften der Eingabeschemazuordnung | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| Name | Beschreibung | Wert |
|---|---|---|
| dataVersion | Die Zuordnungsinformationen für die DataVersion-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| eventTime | Die Zuordnungsinformationen für die EventTime-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
| eventType | Die Zuordnungsinformationen für die EventType-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| id | Die Zuordnungsinformationen für die ID-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
| Betreff | Die Zuordnungsinformationen für die Subject-Eigenschaft des Event Grid-Ereignisses. | JsonFieldWithDefault- |
| Thema | Die Zuordnungsinformationen für die Topic-Eigenschaft des Event Grid-Ereignisses. | JsonField- |
Microsoft.EventGrid/Domains
| Name | Beschreibung | Wert |
|---|---|---|
| Identität | Identitätsinformationen für die Event Grid Domain-Ressource. | IdentityInfo- |
| Ort | Speicherort der Ressource. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| Eigenschaften | Eigenschaften der Event Grid Domain-Ressource. | DomainProperties- |
| Sku | Die Sku-Preisstufe für die Event Grid Domain-Ressource. | ResourceSku- |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
| Art | Der Ressourcentyp | "Microsoft.EventGrid/domains@2023-12-15-preview" |
ResourceSku
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Sku-Name der Ressource. Mögliche Werte sind: Basic oder Premium. | "Einfach" "Premium" |
TrackedResourceTags
| Name | Beschreibung | Wert |
|---|
UserIdentityProperties
| Name | Beschreibung | Wert |
|---|---|---|
| clientId | Die Client-ID der vom Benutzer zugewiesenen Identität. | Schnur |
| principalId | Die Prinzipal-ID der vom Benutzer zugewiesenen Identität. | Schnur |