Freigeben über


Microsoft.EventGrid-Domänen 2023-06-01-preview

Bicep-Ressourcendefinition

Der Domänenressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Ä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-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    autoCreateTopicWithFirstSubscription: bool
    autoDeleteTopicWithLastSubscription: bool
    dataResidencyBoundary: 'string'
    disableLocalAuth: bool
    eventTypeInfo: {
      inlineEventTypes: {
        {customized property}: {
          dataSchemaUrl: 'string'
          description: 'string'
          displayName: 'string'
          documentationUrl: 'string'
        }
      }
      kind: 'Inline'
    }
    inboundIpRules: [
      {
        action: 'Allow'
        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 Typ des Objekts anzugeben.

Verwenden Sie für Json Folgendes:

  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

domains

Name BESCHREIBUNG Wert
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-50

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.
location Speicherort der Ressource. Zeichenfolge (erforderlich)
tags Tags der Ressource. Wörterbuch der Tagnamen und -werte. Weitere Informationen finden Sie unter Tags in Vorlagen.
sku Der SKU-Tarif für die Event Grid-Domänenressource. ResourceSku
Identität Identitätsinformationen für die Event Grid-Domänenressource. IdentityInfo
properties Eigenschaften der Event Grid-Domänenressource. DomainProperties

IdentityInfo

Name BESCHREIBUNG Wert
principalId Die Prinzipal-ID der Ressourcenidentität. Zeichenfolge
tenantId Die Mandanten-ID der Ressource. Zeichenfolge
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. "Keine"
"SystemAssigned"
'SystemAssigned, UserAssigned'
"UserAssigned"
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Verweise auf das Benutzeridentitätswörterbuch sind ARM-Ressourcen-IDs im Format:
"/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
{angepasste Eigenschaft} UserIdentityProperties

UserIdentityProperties

Name BESCHREIBUNG Wert
clientId Die Client-ID der vom Benutzer zugewiesenen Identität. Zeichenfolge
principalId Die Prinzipal-ID der vom Benutzer zugewiesenen Identität. Zeichenfolge

DomainProperties

Name BESCHREIBUNG Wert
autoCreateTopicWithFirstSubscription Dieser boolesche Wert wird verwendet, um den Erstellungsmechanismus für "alle" Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind.
In diesem Kontext kann die Erstellung eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“.
Wenn diese Eigenschaft null oder auf true festgelegt ist, ist Event Grid für die automatische Erstellung des Domänenthemas verantwortlich, wenn das erste Ereignisabonnement ist.
erstellt im Bereich des Domänenthemas. Wenn diese Eigenschaft auf false festgelegt ist, muss zum Erstellen des ersten Ereignisabonnements ein Domänenthema erstellt werden.
durch den Benutzer. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema erstellt wird, während der automatisch verwaltete Modus die
Flexibilität, um weniger Vorgänge auszuführen und weniger Ressourcen durch den Benutzer zu verwalten. Beachten Sie außerdem, dass der Benutzer im automatisch verwalteten Erstellungsmodus berechtigt ist, die
Domänenthema bei Bedarf.
bool
autoDeleteTopicWithLastSubscription Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind.
In diesem Kontext kann das Löschen des Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“.
Wenn diese Eigenschaft auf true festgelegt ist, ist Event Grid 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 es nicht mehr benötigt wird.
(Wenn z. B. das letzte Ereignisabonnement gelöscht wird und die Ressource bereinigt werden muss). Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer vollständig sein möchte.
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 durch den 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 das AAD-Token für die Authentifizierung verwendet, 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 IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist. InboundIpRule[]
inputSchema Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden. "CloudEventSchemaV1_0"
"CustomEventSchema"
'EventGridSchema'
inputSchemaMapping Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat. InputSchemaMapping
minimumTlsVersionAllowed Tls-Mindestversion des Herausgebers, der in dieser Domäne veröffentlicht werden darf 1.0
'1.1'
'1.2'
publicNetworkAccess Dadurch wird bestimmt, ob Datenverkehr über ein öffentliches Netzwerk zulässig ist. Standardmäßig ist es aktiviert.
Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /} konfigurieren.
"Deaktiviert"
"Aktiviert"

EventTypeInfo

Name BESCHREIBUNG Wert
inlineEventTypes Eine Auflistung von Inlineereignistypen für die Ressource. Die Schlüssel des Inlineereignistyps sind vom Typ string, der den Namen des Ereignisses darstellt.
Ein Beispiel für einen gültigen Inlineereignisnamen ist "Contoso.OrderCreated".
Die Werte des Inlineereignistyps sind vom Typ InlineEventProperties und enthalten zusätzliche Informationen für jeden Inlineereignistyp.
EventTypeInfoInlineEventTypes
kind Die Art des verwendeten Ereignistyps. "Inline"

EventTypeInfoInlineEventTypes

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} InlineEventProperties

InlineEventProperties

Name BESCHREIBUNG Wert
dataSchemaUrl Die dataSchemaUrl für das Inlineereignis. Zeichenfolge
description Die Beschreibung für das Inlineereignis. Zeichenfolge
displayName Der displayName für das Inlineereignis. Zeichenfolge
documentationUrl Die documentationUrl für das Inlineereignis. Zeichenfolge

InboundIpRule

Name BESCHREIBUNG Wert
action 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. Zeichenfolge

InputSchemaMapping

Name BESCHREIBUNG Wert
inputSchemaMappingType Festlegen des Objekttyps JSON ( erforderlich)

JsonInputSchemaMapping

Name BESCHREIBUNG Wert
inputSchemaMappingType Typ der benutzerdefinierten Zuordnung "Json" (erforderlich)
properties 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
subject Die Zuordnungsinformationen für die Subject-Eigenschaft des Event Grid-Ereignisses. JsonFieldWithDefault
topic Die Zuordnungsinformationen für die Topic-Eigenschaft des Event Grid-Ereignisses. JsonField

JsonFieldWithDefault

Name BESCHREIBUNG Wert
defaultValue Der Standardwert, der für die Zuordnung verwendet werden soll, wenn kein SourceField-Objekt angegeben wird oder wenn keine Eigenschaft mit dem angegebenen Namen in der veröffentlichten JSON-Ereignisnutzlast vorhanden ist. Zeichenfolge
sourceField Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. Zeichenfolge

JsonField

Name BESCHREIBUNG Wert
sourceField Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. Zeichenfolge

ResourceSku

Name BESCHREIBUNG Wert
name Der SKU-Name der Ressource. Die möglichen Werte sind: Basic oder Premium. "Basic"
"Premium"

Ressourcendefinition mit einer ARM-Vorlage

Der Domänenressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

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-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "autoCreateTopicWithFirstSubscription": "bool",
    "autoDeleteTopicWithLastSubscription": "bool",
    "dataResidencyBoundary": "string",
    "disableLocalAuth": "bool",
    "eventTypeInfo": {
      "inlineEventTypes": {
        "{customized property}": {
          "dataSchemaUrl": "string",
          "description": "string",
          "displayName": "string",
          "documentationUrl": "string"
        }
      },
      "kind": "Inline"
    },
    "inboundIpRules": [
      {
        "action": "Allow",
        "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 Typ des Objekts anzugeben.

Verwenden Sie für Json Folgendes:

  "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

domains

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.EventGrid/domains"
apiVersion Die Ressourcen-API-Version '2023-06-01-preview'
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-50

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.
location Speicherort der Ressource. Zeichenfolge (erforderlich)
tags Tags der Ressource. Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
sku Der SKU-Tarif für die Event Grid-Domänenressource. ResourceSku
Identität Identitätsinformationen für die Event Grid-Domänenressource. IdentityInfo
properties Eigenschaften der Event Grid-Domänenressource. DomainProperties

IdentityInfo

Name BESCHREIBUNG Wert
principalId Die Prinzipal-ID der Ressourcenidentität. Zeichenfolge
tenantId Die Mandanten-ID der Ressource. Zeichenfolge
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. "Keine"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Schlüsselverweise des Benutzeridentitätswörterbuchs sind ARM-Ressourcen-IDs in der Form:
'/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
{angepasste Eigenschaft} UserIdentityProperties

UserIdentityProperties

Name BESCHREIBUNG Wert
clientId Die Client-ID der benutzerseitig zugewiesenen Identität. Zeichenfolge
principalId Die Prinzipal-ID der benutzerseitig zugewiesenen Identität. Zeichenfolge

DomainProperties

Name BESCHREIBUNG Wert
autoCreateTopicWithFirstSubscription Dieser Boolesche Wert wird verwendet, um den Erstellungsmechanismus für "alle" der Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind.
In diesem Kontext kann die Erstellung eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“.
Wenn diese Eigenschaft NULL ist oder auf true festgelegt ist, ist Event Grid für die automatische Erstellung des Domänenthemas verantwortlich, wenn das erste Ereignisabonnement ist.
erstellt im Bereich des Domänenthemas. Wenn diese Eigenschaft auf false festgelegt ist, muss zum Erstellen des ersten Ereignisabonnements ein Domänenthema erstellt werden.
vom Benutzer. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema erstellt wird, während der automatisch verwaltete Modus die
Flexibilität, um 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 Möglichkeit hat, die
Domänenthema bei Bedarf nach Bedarf.
bool
autoDeleteTopicWithLastSubscription Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind.
In diesem Kontext kann das Löschen eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) sein. Der Standardwert dieser Eigenschaft ist „TRUE“.
Wenn diese Eigenschaft auf true festgelegt ist, ist Event Grid dafür verantwortlich, das Domänenthema automatisch zu löschen, wenn das letzte Ereignisabonnement im Bereich vorhanden ist.
des Domänenthemas wird gelöscht. Wenn diese Eigenschaft auf false festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn es nicht mehr benötigt wird.
(z. B. wenn das letzte Ereignisabonnement gelöscht wird und die Ressource bereinigt werden muss). Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer vollständig sein möchte.
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 des Benutzers.
bool
dataResidencyBoundary Data Residency Begrenzung der Ressource. "WithinGeopair"
"InnerhalbRegion"
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 das AAD-Token für die Authentifizierung verwendet, wenn der Benutzer die Veröffentlichung in der Domäne erlaubt. 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 IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist. InboundIpRule[]
inputSchema Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden. "CloudEventSchemaV1_0"
"CustomEventSchema"
'EventGridSchema'
inputSchemaMapping Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat. InputSchemaMapping
minimumTlsVersionAllowed Tls-Mindestversion des Herausgebers, der in dieser Domäne veröffentlicht werden darf 1.0
'1.1'
'1.2'
publicNetworkAccess Dadurch wird bestimmt, ob Datenverkehr über ein öffentliches Netzwerk zulässig ist. Standardmäßig ist es aktiviert.
Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /} konfigurieren.
"Deaktiviert"
"Aktiviert"

EventTypeInfo

Name BESCHREIBUNG Wert
inlineEventTypes Eine Auflistung von Inlineereignistypen für die Ressource. Die Schlüssel des Inlineereignistyps sind vom Typ string, der den Namen des Ereignisses darstellt.
Ein Beispiel für einen gültigen Inlineereignisnamen ist "Contoso.OrderCreated".
Die Werte des Inlineereignistyps sind vom Typ InlineEventProperties und enthalten zusätzliche Informationen für jeden Inlineereignistyp.
EventTypeInfoInlineEventTypes
kind Die Art des verwendeten Ereignistyps. "Inline"

EventTypeInfoInlineEventTypes

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} InlineEventProperties

InlineEventProperties

Name BESCHREIBUNG Wert
dataSchemaUrl Die dataSchemaUrl für das Inlineereignis. Zeichenfolge
description Die Beschreibung für das Inlineereignis. Zeichenfolge
displayName Der displayName für das Inlineereignis. Zeichenfolge
documentationUrl Die documentationUrl für das Inlineereignis. Zeichenfolge

InboundIpRule

Name BESCHREIBUNG Wert
action 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. Zeichenfolge

InputSchemaMapping

Name BESCHREIBUNG Wert
inputSchemaMappingType Festlegen des Objekttyps JSON (erforderlich)

JsonInputSchemaMapping

Name BESCHREIBUNG Wert
inputSchemaMappingType Typ der benutzerdefinierten Zuordnung "Json" (erforderlich)
properties 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
subject Die Zuordnungsinformationen für die Subject-Eigenschaft des Event Grid-Ereignisses. JsonFieldWithDefault
topic Die Zuordnungsinformationen für die Topic-Eigenschaft des Event Grid-Ereignisses. JsonField

JsonFieldWithDefault

Name BESCHREIBUNG Wert
defaultValue Der Standardwert, der für die Zuordnung verwendet werden soll, wenn kein SourceField-Objekt angegeben wird oder wenn keine Eigenschaft mit dem angegebenen Namen in der veröffentlichten JSON-Ereignisnutzlast vorhanden ist. Zeichenfolge
sourceField Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. Zeichenfolge

JsonField

Name BESCHREIBUNG Wert
sourceField Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. Zeichenfolge

ResourceSku

Name BESCHREIBUNG Wert
name Der SKU-Name der Ressource. Die möglichen Werte sind: Basic oder Premium. "Basic"
"Premium"

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Domänenressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • 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 Der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2023-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      autoCreateTopicWithFirstSubscription = bool
      autoDeleteTopicWithLastSubscription = bool
      dataResidencyBoundary = "string"
      disableLocalAuth = bool
      eventTypeInfo = {
        inlineEventTypes = {
          {customized property} = {
            dataSchemaUrl = "string"
            description = "string"
            displayName = "string"
            documentationUrl = "string"
          }
        }
        kind = "Inline"
      }
      inboundIpRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      minimumTlsVersionAllowed = "string"
      publicNetworkAccess = "string"
    }
    sku = {
      name = "string"
    }
  })
}

InputSchemaMapping-Objekte

Legen Sie die inputSchemaMappingType-Eigenschaft fest, um den Typ des Objekts anzugeben.

Verwenden Sie für Json Folgendes:

  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

domains

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.EventGrid/domains@2023-06-01-preview"
name Der Ressourcenname Zeichenfolge (erforderlich)

Zeichenlimit: 3-50

Gültige Zeichen:
Alphanumerische Zeichen und Bindestriche.
location Speicherort der Ressource. Zeichenfolge (erforderlich)
parent_id Verwenden Sie zum Bereitstellen in einer Ressourcengruppe die ID dieser Ressourcengruppe. Zeichenfolge (erforderlich)
tags Tags der Ressource. Wörterbuch der Tagnamen und -werte.
sku Der SKU-Tarif für die Event Grid-Domänenressource. ResourceSku
Identität Identitätsinformationen für die Event Grid-Domänenressource. IdentityInfo
properties Eigenschaften der Event Grid-Domänenressource. DomainProperties

IdentityInfo

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"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids Die Liste der Benutzeridentitäten, die der Ressource zugeordnet sind. Die Schlüsselverweise des Benutzeridentitätswörterbuchs sind ARM-Ressourcen-IDs in der Form:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Diese Eigenschaft wird derzeit nicht verwendet und für die zukünftige Verwendung reserviert.
Array von Benutzeridentitäts-IDs.

IdentityInfoUserAssignedIdentities

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} UserIdentityProperties

UserIdentityProperties

Name BESCHREIBUNG Wert
clientId Die Client-ID der benutzerseitig zugewiesenen Identität. Zeichenfolge
principalId Die Prinzipal-ID der benutzerseitig zugewiesenen Identität. Zeichenfolge

DomainProperties

Name BESCHREIBUNG Wert
autoCreateTopicWithFirstSubscription Dieser Boolesche Wert wird verwendet, um den Erstellungsmechanismus für "alle" der Event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind.
In diesem Kontext kann die Erstellung eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) erfolgen. Der Standardwert dieser Eigenschaft ist „TRUE“.
Wenn diese Eigenschaft NULL ist oder auf true festgelegt ist, ist Event Grid für die automatische Erstellung des Domänenthemas verantwortlich, wenn das erste Ereignisabonnement ist.
erstellt im Bereich des Domänenthemas. Wenn diese Eigenschaft auf false festgelegt ist, muss zum Erstellen des ersten Ereignisabonnements ein Domänenthema erstellt werden.
vom Benutzer. Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer die vollständige Kontrolle darüber haben möchte, wann das Domänenthema erstellt wird, während der automatisch verwaltete Modus die
Flexibilität, um 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 Möglichkeit hat, die
Domänenthema bei Bedarf nach Bedarf.
bool
autoDeleteTopicWithLastSubscription Dieser boolesche Wert wird verwendet, um den Löschmechanismus für "alle" event Grid-Domänenthemen anzugeben, die dieser Event Grid-Domänenressource zugeordnet sind.
In diesem Kontext kann das Löschen eines Domänenthemas automatisch verwaltet (wenn true) oder selbstverwaltet (wenn false) sein. Der Standardwert dieser Eigenschaft ist „TRUE“.
Wenn diese Eigenschaft auf true festgelegt ist, ist Event Grid dafür verantwortlich, das Domänenthema automatisch zu löschen, wenn das letzte Ereignisabonnement im Bereich vorhanden ist.
des Domänenthemas wird gelöscht. Wenn diese Eigenschaft auf false festgelegt ist, muss der Benutzer das Domänenthema manuell löschen, wenn es nicht mehr benötigt wird.
(z. B. wenn das letzte Ereignisabonnement gelöscht wird und die Ressource bereinigt werden muss). Der Selbstverwaltungsmodus kann verwendet werden, wenn der Benutzer vollständig sein möchte.
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 des Benutzers.
bool
dataResidencyBoundary Data Residency Begrenzung 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 das AAD-Token für die Authentifizierung verwendet, wenn der Benutzer die Veröffentlichung in der Domäne erlaubt. 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 IP-Adressen anstelle aller IP-Adressen einzuschränken. Hinweis: Diese werden nur berücksichtigt, wenn PublicNetworkAccess aktiviert ist. InboundIpRule[]
inputSchema Dadurch wird das Format bestimmt, das Event Grid für eingehende Ereignisse erwarten sollte, die in der Event Grid-Domänenressource veröffentlicht werden. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Informationen zum InputSchemaMapping, in dem die Informationen zur Zuordnungsereignisnutzlast angegeben wurden. 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 es aktiviert.
Sie können weitere Einschränkungen auf bestimmte IP-Adressen durchführen, indem Sie {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /} konfigurieren.
"Deaktiviert"
"Aktiviert"

EventTypeInfo

Name BESCHREIBUNG Wert
inlineEventTypes Eine Auflistung von Inlineereignistypen für die Ressource. Die Schlüssel des Inlineereignistyps sind vom Typ Zeichenfolge, die den Namen des Ereignisses darstellt.
Ein Beispiel für einen gültigen Inlineereignisnamen ist "Contoso.OrderCreated".
Die Werte des Inlineereignistyps sind vom Typ InlineEventProperties und enthalten zusätzliche Informationen für jeden Inlineereignistyp.
EventTypeInfoInlineEventTypes
kind Die Art des verwendeten Ereignistyps. "Inline"

EventTypeInfoInlineEventTypes

Name BESCHREIBUNG Wert
{angepasste Eigenschaft} InlineEventProperties

InlineEventProperties

Name BESCHREIBUNG Wert
dataSchemaUrl Das dataSchemaUrl für das Inlineereignis. Zeichenfolge
description Die Beschreibung für das Inlineereignis. Zeichenfolge
displayName Der displayName für das Inlineereignis. Zeichenfolge
documentationUrl Die documentationUrl für das Inlineereignis. Zeichenfolge

InboundIpRule

Name BESCHREIBUNG Wert
action 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. Zeichenfolge

InputSchemaMapping

Name BESCHREIBUNG Wert
inputSchemaMappingType Festlegen des Objekttyps JSON (erforderlich)

JsonInputSchemaMapping

Name BESCHREIBUNG Wert
inputSchemaMappingType Typ der benutzerdefinierten Zuordnung "Json" (erforderlich)
properties 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
subject Die Zuordnungsinformationen für die Subject-Eigenschaft des Event Grid-Ereignisses. JsonFieldWithDefault
topic Die Zuordnungsinformationen für die Topic-Eigenschaft des Event Grid-Ereignisses. JsonField

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. Zeichenfolge
sourceField Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. Zeichenfolge

JsonField

Name BESCHREIBUNG Wert
sourceField Name eines Felds im Eingabeereignisschema, das als Quelle einer Zuordnung verwendet werden soll. Zeichenfolge

ResourceSku

Name BESCHREIBUNG Wert
name Der SKU-Name der Ressource. Die möglichen Werte sind: Basic oder Premium. „Basic“
"Premium"