Freigeben über


Microsoft.EventGrid-Namespaces 2024-06-01-preview

Bicep-Ressourcendefinition

Der Namespaces-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.EventGrid/Namespaces-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.EventGrid/namespaces@2024-06-01-preview' = {
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    inboundIpRules: [
      {
        action: 'string'
        ipMask: 'string'
      }
    ]
    isZoneRedundant: bool
    minimumTlsVersionAllowed: 'string'
    privateEndpointConnections: [
      {
        properties: {
          groupIds: [
            'string'
          ]
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    publicNetworkAccess: 'string'
    topicsConfiguration: {
      customDomains: [
        {
          certificateUrl: 'string'
          expectedTxtRecordName: 'string'
          expectedTxtRecordValue: 'string'
          fullyQualifiedDomainName: 'string'
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
          validationState: 'string'
        }
      ]
    }
    topicSpacesConfiguration: {
      clientAuthentication: {
        alternativeAuthenticationNameSources: [
          'string'
        ]
        customJwtAuthentication: {
          issuerCertificates: [
            {
              certificateUrl: 'string'
              identity: {
                type: 'string'
                userAssignedIdentity: 'string'
              }
            }
          ]
          tokenIssuer: 'string'
        }
      }
      customDomains: [
        {
          certificateUrl: 'string'
          expectedTxtRecordName: 'string'
          expectedTxtRecordValue: 'string'
          fullyQualifiedDomainName: 'string'
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
          validationState: 'string'
        }
      ]
      maximumClientSessionsPerAuthenticationName: int
      maximumSessionExpiryInHours: int
      routeTopicResourceId: 'string'
      routingEnrichments: {
        dynamic: [
          {
            key: 'string'
            value: 'string'
          }
        ]
        static: [
          {
            key: 'string'
            valueType: 'string'
            // For remaining properties, see StaticRoutingEnrichment objects
          }
        ]
      }
      routingIdentityInfo: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
      state: 'string'
    }
  }
  sku: {
    capacity: int
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

StaticRoutingEnrichment-Objekte

Legen Sie die valueType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Zeichenfolgen-:

{
  value: 'string'
  valueType: 'String'
}

Eigenschaftswerte

ClientAuthenticationSettings

Name Beschreibung Wert
alternativeAuthenticationNameSources Alternative Authentifizierungsnamenquellen im Zusammenhang mit Clientauthentifizierungseinstellungen für namespaceressource. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication Benutzerdefinierte JWT-Authentifizierungseinstellungen für Namespaceressource. CustomJwtAuthenticationSettings

ConnectionState

Name Beschreibung Wert
actionsRequired Erforderliche Aktionen (falls vorhanden). Schnur
Beschreibung Beschreibung des Verbindungszustands. Schnur
Status Status der Verbindung. "Genehmigt"
"Getrennt"
"Ausstehend"
"Abgelehnt"

CustomDomainConfiguration

Name Beschreibung Wert
certificateUrl Die URL für das Zertifikat, das für die Veröffentlichung in der benutzerdefinierten Domäne verwendet wird. Derzeit unterstützen wir zertifikate, die nur in Azure Key Vault gespeichert sind. Während die Zertifikat-URL eine der beiden sein kann
Versions-URL des folgenden Formats https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, oder nichtversionierte URL des folgenden Formats (z. B.
https://contosovault.vault.azure.net/certificates/contosocertunterstützen wir nur die nichtversionierte Zertifikat-URL (z. B. https://contosovault.vault.azure.net/certificates/contosocert)
Schnur
expectedTxtRecordName Dns TXT-Eintragsname erwartet. Das Ereignisraster sucht nach einem TXT-Eintrag mit diesem Namen im DNS-Eintragssatz des benutzerdefinierten Domänennamens, um den Besitz der Domäne nachzuweisen.
Die Werte unter diesem TXT-Eintrag müssen den erwarteten TXT-Eintragswert enthalten.
Schnur
expectedTxtRecordValue Dns TXT-Eintragswert erwartet. Event Grid sucht nach einem TXT-Eintrag mit diesem Wert im DNS-Eintragssatz des benutzerdefinierten Domänennamens, um den Besitz über die Domäne zu beweisen. Schnur
fullyQualifiedDomainName Vollqualifizierter Domänenname (Fully Qualified Domain Name, FQDN) für die benutzerdefinierte Domäne. Zeichenfolge (erforderlich)
Identität Identitätsinformationen für den Zugriff auf das Zertifikat für die benutzerdefinierte Domäne. Diese Identitätsinformationen müssen mit einer Identität übereinstimmen, die für den Namespace festgelegt wurde. CustomDomainIdentity-
validationState Überprüfungsstatus für die benutzerdefinierte Domäne. Dies ist eine schreibgeschützte Eigenschaft und wird zunächst auf "Ausstehend" festgelegt und erst nach der erfolgreichen Überprüfung des Besitzes des Domänennamens auf "Genehmigt" durch das Ereignisraster aktualisiert. "Genehmigt"
'ErrorRetrievingDnsRecord'
"Ausstehend"

CustomDomainIdentity

Name Beschreibung Wert
Art Der Typ der verwendeten verwalteten Identität. Kann entweder "SystemAssigned" oder "UserAssigned" sein. 'SystemAssigned'
"UserAssigned"
userAssignedIdentity Die der Ressource zugeordnete Benutzeridentität. Schnur

CustomJwtAuthenticationManagedIdentity

Name Beschreibung Wert
Art Der Typ der verwendeten verwalteten Identität. Kann entweder "SystemAssigned" oder "UserAssigned" sein. 'SystemAssigned'
"UserAssigned" (erforderlich)
userAssignedIdentity Die der Ressource zugeordnete Benutzeridentität. Schnur

CustomJwtAuthenticationSettings

Name Beschreibung Wert
issuerCertificates Informationen zum Zertifikat, das für die Tokenüberprüfung verwendet wird. Zurzeit unterstützen wir maximal 2 Zertifikate. IssuerCertificateInfo[]
tokenIssuer JWT-Tokenherausgeber erwartet. Schnur

DynamicRoutingEnrichment

Name Beschreibung Wert
Schlüssel Dynamischer Routinganreicherungsschlüssel. Schnur
Wert Dynamischer Routinganreicherungswert. Schnur

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

IssuerCertificateInfo

Name Beschreibung Wert
certificateUrl Keyvault-Zertifikat-URL im https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion Format. Zeichenfolge (erforderlich)
Identität Die Identität, die für den Zugriff auf das Zertifikat verwendet wird. CustomJwtAuthenticationManagedIdentity-

Microsoft.EventGrid/Namespaces

Name Beschreibung Wert
Identität Identitätsinformationen für die Namespaceressource. IdentityInfo-
Ort Speicherort der Ressource. Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-zA-Z0-9-]*$ (erforderlich)
Eigenschaften Eigenschaften der Namespaceressource. NamespaceProperties-
Sku Stellt die verfügbaren Sku-Preisstufen dar. NamespaceSku-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen

NamespaceProperties

Name Beschreibung Wert
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-[]
isZoneRedundant Dies ist eine optionale Eigenschaft und ermöglicht es dem Benutzer anzugeben, ob die Namespaceressource zonenredundanzfunktion unterstützt oder nicht. Wenn dies der Fall ist
eigenschaft wird nicht explizit vom Benutzer angegeben, der Standardwert hängt von den folgenden Bedingungen ab:
ein. Für aktivierte Verfügbarkeitszonen– Der Standardwert der Eigenschaft ist "true".
b. Für nicht verfügbare Zonen aktivierte Regionen – Der Standardwert der Eigenschaft wäre "false".
Nach der Angabe kann diese Eigenschaft nicht aktualisiert werden.
Bool
minimumTlsVersionAllowed Die minimale TLS-Version des Herausgebers darf in diesem Namespace veröffentlicht werden. Es wird nur TLS Version 1.2 unterstützt. '1.0'
'1.1'
'1.2'
privateEndpointConnections Liste der privaten Endpunktverbindungen. PrivateEndpointConnection[]
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.PubSub.NamespaceProperties.InboundIpRules" />
"Deaktiviert"
"Aktiviert"
"SecuredByPerimeter"
topicsConfiguration Themenkonfigurationsinformationen für die Namespaceressource TopicsConfiguration-
topicSpacesConfiguration Informationen zur Konfiguration von Themenräumen für die Namespaceressource TopicSpacesConfiguration-

NamespaceSku

Name Beschreibung Wert
Fassungsvermögen Gibt die Anzahl der Durchsatzeinheiten an, die die Kapazität für den Namespace definieren. Der Standardwert der Eigenschaft ist
1, die 1 Durchsatzeinheit = 1 MB/s-Eingangs- und 2 MB/s-Ausgang pro Namespace angibt. Min Kapazität ist 1 und
maximal zulässige Kapazität beträgt 20.
Int
Name Der Name der SKU. "Standard"

PrivateEndpoint

Name Beschreibung Wert
id Der ARM-Bezeichner für private Endpunkte. Schnur

PrivateEndpointConnection

Name Beschreibung Wert
Eigenschaften Eigenschaften der PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beschreibung Wert
groupIds GroupIds aus der Ressource für den privaten Linkdienst. string[]
privateEndpoint Die Private Endpoint-Ressource für diese Verbindung. PrivateEndpoint-
privateLinkServiceConnectionState Details zum Status der Verbindung. ConnectionState-
provisioningState Bereitstellungsstatus der privaten Endpunktverbindung. 'Abgebrochen'
"Erstellen"
"Löschen"
'Fehler'
"Erfolgreich"
"Aktualisieren"

RoutingEnrichments

Name Beschreibung Wert
dynamisch DynamicRoutingEnrichment[]
statisch StaticRoutingEnrichment[]

RoutingIdentityInfo

Name Beschreibung Wert
Art Routingidentitätstyp für die Konfiguration von Themenräumen. 'None'
'SystemAssigned'
"UserAssigned"
userAssignedIdentity Schnur

StaticRoutingEnrichment

Name Beschreibung Wert
Schlüssel Statischer Routinganreicherungsschlüssel. Schnur
valueType Set to 'String' for type StaticStringRoutingEnrichment. 'String' (erforderlich)

StaticStringRoutingEnrichment

Name Beschreibung Wert
Wert Zeichenfolgentyp-Routinganreicherungswert. Schnur
valueType Werttyp für statische Routinganreicherung. Für z.B. kann dieser Eigenschaftswert "String" sein. 'String' (erforderlich)

TopicsConfiguration

Name Beschreibung Wert
customDomains Liste der benutzerdefinierten Domänenkonfigurationen für den Namespace. CustomDomainConfiguration[]

TopicSpacesConfiguration

Name Beschreibung Wert
clientAuthentication Clientauthentifizierungseinstellungen für die Konfiguration von Themenräumen. ClientAuthenticationSettings-
customDomains Liste der benutzerdefinierten Domänenkonfigurationen für den Namespace. CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Die maximale Anzahl von Sitzungen pro Authentifizierungsname. Der Standardwert der Eigenschaft ist 1.
Der zulässige Min.-Wert ist 1, und der maximal zulässige Wert ist 100.
Int
maximumSessionExpiryInHours Der maximale Sitzungsablauf in Stunden. Der Standardwert der Eigenschaft beträgt 1 Stunde.
Der zulässige Min.-Wert beträgt 1 Stunde, und der maximal zulässige Wert beträgt 8 Stunden.
Int
routeTopicResourceId Vollqualifizierte Azure-Ressourcen-ID für das Ereignisrasterthema, an das Ereignisse unter einem Namespace von TopicSpaces weitergeleitet werden.
Diese Eigenschaft sollte im folgenden Format "/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft" vorliegen. EventGrid/topics/{topicName}'.
Dieses Thema sollte sich in derselben Region befinden, in der sich der Namespace befindet.
Schnur
routingEnrichments Routingerweiterungen für die Konfiguration von Themenräumen RoutingEnrichments
routingIdentityInfo Routingidentitätsinformationen für die Konfiguration von Themenräumen. RoutingIdentityInfo-
Zustand Geben Sie an, ob die Topic Spaces-Konfiguration für den Namespace aktiviert ist. Der Standardwert ist deaktiviert. "Deaktiviert"
"Aktiviert"

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 Namespaces-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

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

{
  "type": "Microsoft.EventGrid/namespaces",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "inboundIpRules": [
      {
        "action": "string",
        "ipMask": "string"
      }
    ],
    "isZoneRedundant": "bool",
    "minimumTlsVersionAllowed": "string",
    "privateEndpointConnections": [
      {
        "properties": {
          "groupIds": [ "string" ],
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "publicNetworkAccess": "string",
    "topicsConfiguration": {
      "customDomains": [
        {
          "certificateUrl": "string",
          "expectedTxtRecordName": "string",
          "expectedTxtRecordValue": "string",
          "fullyQualifiedDomainName": "string",
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          },
          "validationState": "string"
        }
      ]
    },
    "topicSpacesConfiguration": {
      "clientAuthentication": {
        "alternativeAuthenticationNameSources": [ "string" ],
        "customJwtAuthentication": {
          "issuerCertificates": [
            {
              "certificateUrl": "string",
              "identity": {
                "type": "string",
                "userAssignedIdentity": "string"
              }
            }
          ],
          "tokenIssuer": "string"
        }
      },
      "customDomains": [
        {
          "certificateUrl": "string",
          "expectedTxtRecordName": "string",
          "expectedTxtRecordValue": "string",
          "fullyQualifiedDomainName": "string",
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          },
          "validationState": "string"
        }
      ],
      "maximumClientSessionsPerAuthenticationName": "int",
      "maximumSessionExpiryInHours": "int",
      "routeTopicResourceId": "string",
      "routingEnrichments": {
        "dynamic": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "static": [ {
          "key": "string",
          "valueType": "string"
          // For remaining properties, see StaticRoutingEnrichment objects
        } ]
      },
      "routingIdentityInfo": {
        "type": "string",
        "userAssignedIdentity": "string"
      },
      "state": "string"
    }
  },
  "sku": {
    "capacity": "int",
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

StaticRoutingEnrichment-Objekte

Legen Sie die valueType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Zeichenfolgen-:

{
  "value": "string",
  "valueType": "String"
}

Eigenschaftswerte

ClientAuthenticationSettings

Name Beschreibung Wert
alternativeAuthenticationNameSources Alternative Authentifizierungsnamenquellen im Zusammenhang mit Clientauthentifizierungseinstellungen für namespaceressource. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication Benutzerdefinierte JWT-Authentifizierungseinstellungen für Namespaceressource. CustomJwtAuthenticationSettings

ConnectionState

Name Beschreibung Wert
actionsRequired Erforderliche Aktionen (falls vorhanden). Schnur
Beschreibung Beschreibung des Verbindungszustands. Schnur
Status Status der Verbindung. "Genehmigt"
"Getrennt"
"Ausstehend"
"Abgelehnt"

CustomDomainConfiguration

Name Beschreibung Wert
certificateUrl Die URL für das Zertifikat, das für die Veröffentlichung in der benutzerdefinierten Domäne verwendet wird. Derzeit unterstützen wir zertifikate, die nur in Azure Key Vault gespeichert sind. Während die Zertifikat-URL eine der beiden sein kann
Versions-URL des folgenden Formats https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, oder nichtversionierte URL des folgenden Formats (z. B.
https://contosovault.vault.azure.net/certificates/contosocertunterstützen wir nur die nichtversionierte Zertifikat-URL (z. B. https://contosovault.vault.azure.net/certificates/contosocert)
Schnur
expectedTxtRecordName Dns TXT-Eintragsname erwartet. Das Ereignisraster sucht nach einem TXT-Eintrag mit diesem Namen im DNS-Eintragssatz des benutzerdefinierten Domänennamens, um den Besitz der Domäne nachzuweisen.
Die Werte unter diesem TXT-Eintrag müssen den erwarteten TXT-Eintragswert enthalten.
Schnur
expectedTxtRecordValue Dns TXT-Eintragswert erwartet. Event Grid sucht nach einem TXT-Eintrag mit diesem Wert im DNS-Eintragssatz des benutzerdefinierten Domänennamens, um den Besitz über die Domäne zu beweisen. Schnur
fullyQualifiedDomainName Vollqualifizierter Domänenname (Fully Qualified Domain Name, FQDN) für die benutzerdefinierte Domäne. Zeichenfolge (erforderlich)
Identität Identitätsinformationen für den Zugriff auf das Zertifikat für die benutzerdefinierte Domäne. Diese Identitätsinformationen müssen mit einer Identität übereinstimmen, die für den Namespace festgelegt wurde. CustomDomainIdentity-
validationState Überprüfungsstatus für die benutzerdefinierte Domäne. Dies ist eine schreibgeschützte Eigenschaft und wird zunächst auf "Ausstehend" festgelegt und erst nach der erfolgreichen Überprüfung des Besitzes des Domänennamens auf "Genehmigt" durch das Ereignisraster aktualisiert. "Genehmigt"
'ErrorRetrievingDnsRecord'
"Ausstehend"

CustomDomainIdentity

Name Beschreibung Wert
Art Der Typ der verwendeten verwalteten Identität. Kann entweder "SystemAssigned" oder "UserAssigned" sein. 'SystemAssigned'
"UserAssigned"
userAssignedIdentity Die der Ressource zugeordnete Benutzeridentität. Schnur

CustomJwtAuthenticationManagedIdentity

Name Beschreibung Wert
Art Der Typ der verwendeten verwalteten Identität. Kann entweder "SystemAssigned" oder "UserAssigned" sein. 'SystemAssigned'
"UserAssigned" (erforderlich)
userAssignedIdentity Die der Ressource zugeordnete Benutzeridentität. Schnur

CustomJwtAuthenticationSettings

Name Beschreibung Wert
issuerCertificates Informationen zum Zertifikat, das für die Tokenüberprüfung verwendet wird. Zurzeit unterstützen wir maximal 2 Zertifikate. IssuerCertificateInfo[]
tokenIssuer JWT-Tokenherausgeber erwartet. Schnur

DynamicRoutingEnrichment

Name Beschreibung Wert
Schlüssel Dynamischer Routinganreicherungsschlüssel. Schnur
Wert Dynamischer Routinganreicherungswert. Schnur

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

IssuerCertificateInfo

Name Beschreibung Wert
certificateUrl Keyvault-Zertifikat-URL im https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion Format. Zeichenfolge (erforderlich)
Identität Die Identität, die für den Zugriff auf das Zertifikat verwendet wird. CustomJwtAuthenticationManagedIdentity-

Microsoft.EventGrid/Namespaces

Name Beschreibung Wert
apiVersion Die API-Version "2024-06-01-preview"
Identität Identitätsinformationen für die Namespaceressource. IdentityInfo-
Ort Speicherort der Ressource. Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-zA-Z0-9-]*$ (erforderlich)
Eigenschaften Eigenschaften der Namespaceressource. NamespaceProperties-
Sku Stellt die verfügbaren Sku-Preisstufen dar. NamespaceSku-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen
Art Der Ressourcentyp "Microsoft.EventGrid/Namespaces"

NamespaceProperties

Name Beschreibung Wert
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-[]
isZoneRedundant Dies ist eine optionale Eigenschaft und ermöglicht es dem Benutzer anzugeben, ob die Namespaceressource zonenredundanzfunktion unterstützt oder nicht. Wenn dies der Fall ist
eigenschaft wird nicht explizit vom Benutzer angegeben, der Standardwert hängt von den folgenden Bedingungen ab:
ein. Für aktivierte Verfügbarkeitszonen– Der Standardwert der Eigenschaft ist "true".
b. Für nicht verfügbare Zonen aktivierte Regionen – Der Standardwert der Eigenschaft wäre "false".
Nach der Angabe kann diese Eigenschaft nicht aktualisiert werden.
Bool
minimumTlsVersionAllowed Die minimale TLS-Version des Herausgebers darf in diesem Namespace veröffentlicht werden. Es wird nur TLS Version 1.2 unterstützt. '1.0'
'1.1'
'1.2'
privateEndpointConnections Liste der privaten Endpunktverbindungen. PrivateEndpointConnection[]
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.PubSub.NamespaceProperties.InboundIpRules" />
"Deaktiviert"
"Aktiviert"
"SecuredByPerimeter"
topicsConfiguration Themenkonfigurationsinformationen für die Namespaceressource TopicsConfiguration-
topicSpacesConfiguration Informationen zur Konfiguration von Themenräumen für die Namespaceressource TopicSpacesConfiguration-

NamespaceSku

Name Beschreibung Wert
Fassungsvermögen Gibt die Anzahl der Durchsatzeinheiten an, die die Kapazität für den Namespace definieren. Der Standardwert der Eigenschaft ist
1, die 1 Durchsatzeinheit = 1 MB/s-Eingangs- und 2 MB/s-Ausgang pro Namespace angibt. Min Kapazität ist 1 und
maximal zulässige Kapazität beträgt 20.
Int
Name Der Name der SKU. "Standard"

PrivateEndpoint

Name Beschreibung Wert
id Der ARM-Bezeichner für private Endpunkte. Schnur

PrivateEndpointConnection

Name Beschreibung Wert
Eigenschaften Eigenschaften der PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beschreibung Wert
groupIds GroupIds aus der Ressource für den privaten Linkdienst. string[]
privateEndpoint Die Private Endpoint-Ressource für diese Verbindung. PrivateEndpoint-
privateLinkServiceConnectionState Details zum Status der Verbindung. ConnectionState-
provisioningState Bereitstellungsstatus der privaten Endpunktverbindung. 'Abgebrochen'
"Erstellen"
"Löschen"
'Fehler'
"Erfolgreich"
"Aktualisieren"

RoutingEnrichments

Name Beschreibung Wert
dynamisch DynamicRoutingEnrichment[]
statisch StaticRoutingEnrichment[]

RoutingIdentityInfo

Name Beschreibung Wert
Art Routingidentitätstyp für die Konfiguration von Themenräumen. 'None'
'SystemAssigned'
"UserAssigned"
userAssignedIdentity Schnur

StaticRoutingEnrichment

Name Beschreibung Wert
Schlüssel Statischer Routinganreicherungsschlüssel. Schnur
valueType Set to 'String' for type StaticStringRoutingEnrichment. 'String' (erforderlich)

StaticStringRoutingEnrichment

Name Beschreibung Wert
Wert Zeichenfolgentyp-Routinganreicherungswert. Schnur
valueType Werttyp für statische Routinganreicherung. Für z.B. kann dieser Eigenschaftswert "String" sein. 'String' (erforderlich)

TopicsConfiguration

Name Beschreibung Wert
customDomains Liste der benutzerdefinierten Domänenkonfigurationen für den Namespace. CustomDomainConfiguration[]

TopicSpacesConfiguration

Name Beschreibung Wert
clientAuthentication Clientauthentifizierungseinstellungen für die Konfiguration von Themenräumen. ClientAuthenticationSettings-
customDomains Liste der benutzerdefinierten Domänenkonfigurationen für den Namespace. CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Die maximale Anzahl von Sitzungen pro Authentifizierungsname. Der Standardwert der Eigenschaft ist 1.
Der zulässige Min.-Wert ist 1, und der maximal zulässige Wert ist 100.
Int
maximumSessionExpiryInHours Der maximale Sitzungsablauf in Stunden. Der Standardwert der Eigenschaft beträgt 1 Stunde.
Der zulässige Min.-Wert beträgt 1 Stunde, und der maximal zulässige Wert beträgt 8 Stunden.
Int
routeTopicResourceId Vollqualifizierte Azure-Ressourcen-ID für das Ereignisrasterthema, an das Ereignisse unter einem Namespace von TopicSpaces weitergeleitet werden.
Diese Eigenschaft sollte im folgenden Format "/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft" vorliegen. EventGrid/topics/{topicName}'.
Dieses Thema sollte sich in derselben Region befinden, in der sich der Namespace befindet.
Schnur
routingEnrichments Routingerweiterungen für die Konfiguration von Themenräumen RoutingEnrichments
routingIdentityInfo Routingidentitätsinformationen für die Konfiguration von Themenräumen. RoutingIdentityInfo-
Zustand Geben Sie an, ob die Topic Spaces-Konfiguration für den Namespace aktiviert ist. Der Standardwert ist deaktiviert. "Deaktiviert"
"Aktiviert"

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 Namespaces-Ressourcentyp 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/Namespaces-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces@2024-06-01-preview"
  name = "string"
  identity = {
    principalId = "string"
    tenantId = "string"
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
        clientId = "string"
        principalId = "string"
      }
    }
  }
  location = "string"
  sku = {
    capacity = int
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      inboundIpRules = [
        {
          action = "string"
          ipMask = "string"
        }
      ]
      isZoneRedundant = bool
      minimumTlsVersionAllowed = "string"
      privateEndpointConnections = [
        {
          properties = {
            groupIds = [
              "string"
            ]
            privateEndpoint = {
              id = "string"
            }
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
            provisioningState = "string"
          }
        }
      ]
      publicNetworkAccess = "string"
      topicsConfiguration = {
        customDomains = [
          {
            certificateUrl = "string"
            expectedTxtRecordName = "string"
            expectedTxtRecordValue = "string"
            fullyQualifiedDomainName = "string"
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
            validationState = "string"
          }
        ]
      }
      topicSpacesConfiguration = {
        clientAuthentication = {
          alternativeAuthenticationNameSources = [
            "string"
          ]
          customJwtAuthentication = {
            issuerCertificates = [
              {
                certificateUrl = "string"
                identity = {
                  type = "string"
                  userAssignedIdentity = "string"
                }
              }
            ]
            tokenIssuer = "string"
          }
        }
        customDomains = [
          {
            certificateUrl = "string"
            expectedTxtRecordName = "string"
            expectedTxtRecordValue = "string"
            fullyQualifiedDomainName = "string"
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
            validationState = "string"
          }
        ]
        maximumClientSessionsPerAuthenticationName = int
        maximumSessionExpiryInHours = int
        routeTopicResourceId = "string"
        routingEnrichments = {
          dynamic = [
            {
              key = "string"
              value = "string"
            }
          ]
          static = [
            {
              key = "string"
              valueType = "string"
              // For remaining properties, see StaticRoutingEnrichment objects
            }
          ]
        }
        routingIdentityInfo = {
          type = "string"
          userAssignedIdentity = "string"
        }
        state = "string"
      }
    }
  })
}

StaticRoutingEnrichment-Objekte

Legen Sie die valueType-Eigenschaft fest, um den Objekttyp anzugeben.

Verwenden Sie für Zeichenfolgen-:

{
  value = "string"
  valueType = "String"
}

Eigenschaftswerte

ClientAuthenticationSettings

Name Beschreibung Wert
alternativeAuthenticationNameSources Alternative Authentifizierungsnamenquellen im Zusammenhang mit Clientauthentifizierungseinstellungen für namespaceressource. Zeichenfolgenarray, das eine der folgenden Elemente enthält:
'ClientCertificateDns'
'ClientCertificateEmail'
'ClientCertificateIp'
'ClientCertificateSubject'
'ClientCertificateUri'
customJwtAuthentication Benutzerdefinierte JWT-Authentifizierungseinstellungen für Namespaceressource. CustomJwtAuthenticationSettings

ConnectionState

Name Beschreibung Wert
actionsRequired Erforderliche Aktionen (falls vorhanden). Schnur
Beschreibung Beschreibung des Verbindungszustands. Schnur
Status Status der Verbindung. "Genehmigt"
"Getrennt"
"Ausstehend"
"Abgelehnt"

CustomDomainConfiguration

Name Beschreibung Wert
certificateUrl Die URL für das Zertifikat, das für die Veröffentlichung in der benutzerdefinierten Domäne verwendet wird. Derzeit unterstützen wir zertifikate, die nur in Azure Key Vault gespeichert sind. Während die Zertifikat-URL eine der beiden sein kann
Versions-URL des folgenden Formats https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, oder nichtversionierte URL des folgenden Formats (z. B.
https://contosovault.vault.azure.net/certificates/contosocertunterstützen wir nur die nichtversionierte Zertifikat-URL (z. B. https://contosovault.vault.azure.net/certificates/contosocert)
Schnur
expectedTxtRecordName Dns TXT-Eintragsname erwartet. Das Ereignisraster sucht nach einem TXT-Eintrag mit diesem Namen im DNS-Eintragssatz des benutzerdefinierten Domänennamens, um den Besitz der Domäne nachzuweisen.
Die Werte unter diesem TXT-Eintrag müssen den erwarteten TXT-Eintragswert enthalten.
Schnur
expectedTxtRecordValue Dns TXT-Eintragswert erwartet. Event Grid sucht nach einem TXT-Eintrag mit diesem Wert im DNS-Eintragssatz des benutzerdefinierten Domänennamens, um den Besitz über die Domäne zu beweisen. Schnur
fullyQualifiedDomainName Vollqualifizierter Domänenname (Fully Qualified Domain Name, FQDN) für die benutzerdefinierte Domäne. Zeichenfolge (erforderlich)
Identität Identitätsinformationen für den Zugriff auf das Zertifikat für die benutzerdefinierte Domäne. Diese Identitätsinformationen müssen mit einer Identität übereinstimmen, die für den Namespace festgelegt wurde. CustomDomainIdentity-
validationState Überprüfungsstatus für die benutzerdefinierte Domäne. Dies ist eine schreibgeschützte Eigenschaft und wird zunächst auf "Ausstehend" festgelegt und erst nach der erfolgreichen Überprüfung des Besitzes des Domänennamens auf "Genehmigt" durch das Ereignisraster aktualisiert. "Genehmigt"
'ErrorRetrievingDnsRecord'
"Ausstehend"

CustomDomainIdentity

Name Beschreibung Wert
Art Der Typ der verwendeten verwalteten Identität. Kann entweder "SystemAssigned" oder "UserAssigned" sein. 'SystemAssigned'
"UserAssigned"
userAssignedIdentity Die der Ressource zugeordnete Benutzeridentität. Schnur

CustomJwtAuthenticationManagedIdentity

Name Beschreibung Wert
Art Der Typ der verwendeten verwalteten Identität. Kann entweder "SystemAssigned" oder "UserAssigned" sein. 'SystemAssigned'
"UserAssigned" (erforderlich)
userAssignedIdentity Die der Ressource zugeordnete Benutzeridentität. Schnur

CustomJwtAuthenticationSettings

Name Beschreibung Wert
issuerCertificates Informationen zum Zertifikat, das für die Tokenüberprüfung verwendet wird. Zurzeit unterstützen wir maximal 2 Zertifikate. IssuerCertificateInfo[]
tokenIssuer JWT-Tokenherausgeber erwartet. Schnur

DynamicRoutingEnrichment

Name Beschreibung Wert
Schlüssel Dynamischer Routinganreicherungsschlüssel. Schnur
Wert Dynamischer Routinganreicherungswert. Schnur

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

IssuerCertificateInfo

Name Beschreibung Wert
certificateUrl Keyvault-Zertifikat-URL im https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion Format. Zeichenfolge (erforderlich)
Identität Die Identität, die für den Zugriff auf das Zertifikat verwendet wird. CustomJwtAuthenticationManagedIdentity-

Microsoft.EventGrid/Namespaces

Name Beschreibung Wert
Identität Identitätsinformationen für die Namespaceressource. IdentityInfo-
Ort Speicherort der Ressource. Zeichenfolge (erforderlich)
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 3
Max. Länge = 3
Pattern = ^[a-zA-Z0-9-]*$ (erforderlich)
Eigenschaften Eigenschaften der Namespaceressource. NamespaceProperties-
Sku Stellt die verfügbaren Sku-Preisstufen dar. NamespaceSku-
Schilder Ressourcentags Wörterbuch der Tagnamen und -werte.
Art Der Ressourcentyp "Microsoft.EventGrid/namespaces@2024-06-01-preview"

NamespaceProperties

Name Beschreibung Wert
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-[]
isZoneRedundant Dies ist eine optionale Eigenschaft und ermöglicht es dem Benutzer anzugeben, ob die Namespaceressource zonenredundanzfunktion unterstützt oder nicht. Wenn dies der Fall ist
eigenschaft wird nicht explizit vom Benutzer angegeben, der Standardwert hängt von den folgenden Bedingungen ab:
ein. Für aktivierte Verfügbarkeitszonen– Der Standardwert der Eigenschaft ist "true".
b. Für nicht verfügbare Zonen aktivierte Regionen – Der Standardwert der Eigenschaft wäre "false".
Nach der Angabe kann diese Eigenschaft nicht aktualisiert werden.
Bool
minimumTlsVersionAllowed Die minimale TLS-Version des Herausgebers darf in diesem Namespace veröffentlicht werden. Es wird nur TLS Version 1.2 unterstützt. '1.0'
'1.1'
'1.2'
privateEndpointConnections Liste der privaten Endpunktverbindungen. PrivateEndpointConnection[]
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.PubSub.NamespaceProperties.InboundIpRules" />
"Deaktiviert"
"Aktiviert"
"SecuredByPerimeter"
topicsConfiguration Themenkonfigurationsinformationen für die Namespaceressource TopicsConfiguration-
topicSpacesConfiguration Informationen zur Konfiguration von Themenräumen für die Namespaceressource TopicSpacesConfiguration-

NamespaceSku

Name Beschreibung Wert
Fassungsvermögen Gibt die Anzahl der Durchsatzeinheiten an, die die Kapazität für den Namespace definieren. Der Standardwert der Eigenschaft ist
1, die 1 Durchsatzeinheit = 1 MB/s-Eingangs- und 2 MB/s-Ausgang pro Namespace angibt. Min Kapazität ist 1 und
maximal zulässige Kapazität beträgt 20.
Int
Name Der Name der SKU. "Standard"

PrivateEndpoint

Name Beschreibung Wert
id Der ARM-Bezeichner für private Endpunkte. Schnur

PrivateEndpointConnection

Name Beschreibung Wert
Eigenschaften Eigenschaften der PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name Beschreibung Wert
groupIds GroupIds aus der Ressource für den privaten Linkdienst. string[]
privateEndpoint Die Private Endpoint-Ressource für diese Verbindung. PrivateEndpoint-
privateLinkServiceConnectionState Details zum Status der Verbindung. ConnectionState-
provisioningState Bereitstellungsstatus der privaten Endpunktverbindung. 'Abgebrochen'
"Erstellen"
"Löschen"
'Fehler'
"Erfolgreich"
"Aktualisieren"

RoutingEnrichments

Name Beschreibung Wert
dynamisch DynamicRoutingEnrichment[]
statisch StaticRoutingEnrichment[]

RoutingIdentityInfo

Name Beschreibung Wert
Art Routingidentitätstyp für die Konfiguration von Themenräumen. 'None'
'SystemAssigned'
"UserAssigned"
userAssignedIdentity Schnur

StaticRoutingEnrichment

Name Beschreibung Wert
Schlüssel Statischer Routinganreicherungsschlüssel. Schnur
valueType Set to 'String' for type StaticStringRoutingEnrichment. 'String' (erforderlich)

StaticStringRoutingEnrichment

Name Beschreibung Wert
Wert Zeichenfolgentyp-Routinganreicherungswert. Schnur
valueType Werttyp für statische Routinganreicherung. Für z.B. kann dieser Eigenschaftswert "String" sein. 'String' (erforderlich)

TopicsConfiguration

Name Beschreibung Wert
customDomains Liste der benutzerdefinierten Domänenkonfigurationen für den Namespace. CustomDomainConfiguration[]

TopicSpacesConfiguration

Name Beschreibung Wert
clientAuthentication Clientauthentifizierungseinstellungen für die Konfiguration von Themenräumen. ClientAuthenticationSettings-
customDomains Liste der benutzerdefinierten Domänenkonfigurationen für den Namespace. CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Die maximale Anzahl von Sitzungen pro Authentifizierungsname. Der Standardwert der Eigenschaft ist 1.
Der zulässige Min.-Wert ist 1, und der maximal zulässige Wert ist 100.
Int
maximumSessionExpiryInHours Der maximale Sitzungsablauf in Stunden. Der Standardwert der Eigenschaft beträgt 1 Stunde.
Der zulässige Min.-Wert beträgt 1 Stunde, und der maximal zulässige Wert beträgt 8 Stunden.
Int
routeTopicResourceId Vollqualifizierte Azure-Ressourcen-ID für das Ereignisrasterthema, an das Ereignisse unter einem Namespace von TopicSpaces weitergeleitet werden.
Diese Eigenschaft sollte im folgenden Format "/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft" vorliegen. EventGrid/topics/{topicName}'.
Dieses Thema sollte sich in derselben Region befinden, in der sich der Namespace befindet.
Schnur
routingEnrichments Routingerweiterungen für die Konfiguration von Themenräumen RoutingEnrichments
routingIdentityInfo Routingidentitätsinformationen für die Konfiguration von Themenräumen. RoutingIdentityInfo-
Zustand Geben Sie an, ob die Topic Spaces-Konfiguration für den Namespace aktiviert ist. Der Standardwert ist deaktiviert. "Deaktiviert"
"Aktiviert"

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