Freigeben über


Microsoft.EventGrid-Domänen 2020-10-15-preview

Bicep-Ressourcendefinition

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 Bicep hinzu.

resource symbolicname 'Microsoft.EventGrid/domains@2020-10-15-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: {
    inboundIpRules: [
      {
        action: 'Allow'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    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. Siehe Tags in Vorlagen
sku Der SKU-Tarif für die Domäne. ResourceSku
Identität Identitätsinformationen für die Ressource. IdentityInfo
properties Eigenschaften der Domäne. 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
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 Domäne veröffentlicht werden. "CloudEventSchemaV1_0"
'CustomEventSchema'
'EventGridSchema'
inputSchemaMapping Informationen zum InputSchemaMapping, in dem die Informationen zur Zuordnungsereignisnutzlast angegeben wurden. InputSchemaMapping
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"

InboundIpRule

Name BESCHREIBUNG Wert
action Aktion, die basierend auf der Übereinstimmung oder keine Ü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": "2020-10-15-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": {
    "inboundIpRules": [
      {
        "action": "Allow",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "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 Der Ressourcentyp "Microsoft.EventGrid/domains"
apiVersion Die Version der Ressourcen-API "2020-10-15-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. Weitere Informationen finden Sie unter Tags in Vorlagen.
sku Der SKU-Tarif für die Domäne. ResourceSku
Identität Identitätsinformationen für die Ressource. IdentityInfo
properties Eigenschaften der Domäne. 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
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 Domäne veröffentlicht werden. "CloudEventSchemaV1_0"
"CustomEventSchema"
'EventGridSchema'
inputSchemaMapping Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat. InputSchemaMapping
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"

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"

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 im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventGrid/domains-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2020-10-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      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 Der Ressourcentyp "Microsoft.EventGrid/domains@2020-10-15-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 Domäne. ResourceSku
Identität Identitätsinformationen für die Ressource. IdentityInfo
properties Eigenschaften der Domäne. DomainProperties

IdentityInfo

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"
"SystemAssigned, UserAssigned"
"UserAssigned"
identity_ids 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.
Array von Benutzeridentitäts-IDs.

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
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 Domäne veröffentlicht werden. "CloudEventSchemaV1_0"
"CustomEventSchema"
"EventGridSchema"
inputSchemaMapping Informationen zum InputSchemaMapping, das die Informationen zur Zuordnungsereignisnutzlast angegeben hat. InputSchemaMapping
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"

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"