Sdílet prostřednictvím


Obory názvů Microsoft.EventGrid 2024-12-15-preview

  • nejnovější
  • 12. 12. 2024 ve verzi Preview
  • 2024-06-01-preview
  • z 12. 12. 2023 ve verzi Preview
  • 2023-06-01-preview

Definice prostředku Bicep

Typ prostředku oborů názvů je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.EventGrid/namespaces, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.EventGrid/namespaces@2024-12-15-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: {
          encodedIssuerCertificates: [
            {
              encodedCertificate: 'string'
              kid: 'string'
            }
          ]
          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 – objekty

Nastavte valueType vlastnost určit typ objektu.

Pro řetězcovépoužijte:

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

Hodnoty vlastností

ClientAuthenticationSettings

Jméno Popis Hodnota
alternativeAuthenticationNameSources Alternativní zdroje názvů ověřování související s nastavením ověřování klienta pro prostředek oboru názvů Řetězcové pole obsahující některou z těchto možností:
ClientCertificateDns
ClientCertificateEmail
ClientCertificateIp
ClientCertificateSubject
ClientCertificateUri
customJwtAuthentication Vlastní nastavení ověřování JWT pro prostředek oboru názvů customJwtAuthenticationSettings

ConnectionState

Jméno Popis Hodnota
ActionsRequired Požadované akce (pokud nějaké) řetězec
popis Popis stavu připojení řetězec
stav Stav připojení. "Schváleno"
Odpojeno
Čeká na vyřízení
Odmítnuto

CustomDomainConfiguration

Jméno Popis Hodnota
certificateUrl Adresa URL certifikátu, který se používá k publikování do vlastní domény. V současné době podporujeme pouze certifikáty uložené ve službě Azure Key Vault. I když adresa URL certifikátu může být
adresa URL s následujícím formátem https://{název_trezoru_klíčů}.vault.azure.net/certificates/{název_certifikátu}/{version-id} nebo neverzní adresa URL následujícího formátu (např.
https://contosovault.vault.azure.net/certificates/contosocertpodporujeme pouze neverzní adresu URL certifikátu (např. https://contosovault.vault.azure.net/certificates/contosocert)
řetězec
expectedTxtRecordName Byl očekáváný název záznamu DNS TXT. Event Grid vyhledá záznam TXT s tímto názvem v sadě záznamů DNS vlastního názvu domény, aby prokázal vlastnictví domény.
Hodnoty pod tímto záznamem TXT musí obsahovat očekávanou hodnotu záznamu TXT.
řetězec
expectedTxtRecordValue Očekávaná hodnota záznamu DNS TXT Event Grid vyhledá záznam TXT s touto hodnotou v sadě záznamů DNS vlastního názvu domény, aby prokázal vlastnictví domény. řetězec
fullyQualifiedDomainName Plně kvalifikovaný název domény (FQDN) pro vlastní doménu string (povinné)
identita Informace o identitě pro přístup k certifikátu pro vlastní doménu Tyto informace o identitě musí odpovídat identitě nastavené v oboru názvů. CustomDomainIdentity
validationState Stav ověření pro vlastní doménu. Jedná se o vlastnost jen pro čtení, která je zpočátku nastavená na Čeká na vyřízení a bude aktualizována na Schváleno službou Event Grid až po úspěšném ověření vlastnictví názvu domény. "Schváleno"
ErrorRetrievingDnsRecord
Čeká na vyřízení

CustomDomainIdentity

Jméno Popis Hodnota
typ Typ použité spravované identity. Může být buď SystemAssigned, nebo UserAssigned. SystemAssigned
UserAssigned
userAssignedIdentity Identita uživatele přidružená k prostředku. řetězec

CustomJwtAuthenticationManagedIdentity

Jméno Popis Hodnota
typ Typ použité spravované identity. Může být buď SystemAssigned, nebo UserAssigned. SystemAssigned
UserAssigned (povinné)
userAssignedIdentity Identita uživatele přidružená k prostředku. řetězec

CustomJwtAuthenticationSettings

Jméno Popis Hodnota
encodedIssuerCertificates Informace o zakódovaných veřejných certifikátech, které se používají k vlastnímu ověřování. EncodedIssuerCertificateInfo[]
issuerCertificates Informace o certifikátech, které se používají k ověření tokenu. V současné době podporujeme maximálně 2 certifikáty. IssuerCertificateInfo[]
tokenIssuer Byl očekáváný vystavitel tokenu JWT. řetězec

DynamicRoutingEnrichment

Jméno Popis Hodnota
klíč Klíč pro rozšiřování dynamického směrování řetězec
hodnota Hodnota rozšiřování dynamického směrování řetězec

EncodedIssuerCertificateInfo

Jméno Popis Hodnota
encodedCertificate Certifikát ve formátu pem string (povinné)
kůzle Identifikátor certifikátu. string (povinné)

Informace o identitě

Jméno Popis Hodnota
principalId ID objektu zabezpečení identity prostředku. řetězec
tenantId ID tenanta prostředku. řetězec
typ Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'
Tato vlastnost se v současné době nepoužívá a vyhrazena pro budoucí využití.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Jméno Popis Hodnota

InboundIpRule

Jméno Popis Hodnota
akce Akce, která se má provést na základě shody nebo žádné shody ipmasku Povolit
ipMask IP adresa v zápisu CIDR, např. 10.0.0.0/8. řetězec

IssuerCertificateInfo

Jméno Popis Hodnota
certificateUrl Adresa URL certifikátu služby Keyvault ve formátu https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. string (povinné)
identita Identita, která se použije pro přístup k certifikátu. customJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

Jméno Popis Hodnota
identita Informace o identitě prostředku oboru názvů IdentityInfo
umístění Umístění prostředku string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-zA-Z0-9-]*$ (povinné)
vlastnosti Vlastnosti prostředku oboru názvů oboru názvů properties
sku Představuje dostupné cenové úrovně skladové položky. NamespaceSku
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách

Obor názvůProperties

Jméno Popis Hodnota
inboundIpRules To se dá použít k omezení provozu z konkrétních IP adres místo všech IP adres. Poznámka: Tyto informace se považují pouze v případě, že je povolená technologie PublicNetworkAccess. InboundIpRule []
isZoneRedundant Jedná se o volitelnou vlastnost, která uživateli umožňuje určit, jestli prostředek oboru názvů podporuje funkci redundance zón nebo ne. Pokud je to
vlastnost není explicitně určena uživatelem, její výchozí hodnota závisí na následujících podmínkách:
a. Pro oblasti s povolenými zónami dostupnosti – Výchozí hodnota vlastnosti by byla true.
b. Pro oblasti s povolenou zónou dostupnosti – výchozí hodnota vlastnosti by byla false.
Po zadání nelze tuto vlastnost aktualizovat.
Bool
minimumTlsVersionAllowed Minimální verze protokolu TLS vydavatele může publikovat do tohoto oboru názvů. Podporuje se pouze protokol TLS verze 1.2. '1.0'
'1.1'
'1.2'
privateEndpointConnections Seznam připojení privátních koncových bodů PrivateEndpointConnection[]
publicNetworkAccess To určuje, jestli je provoz povolený přes veřejnou síť. Ve výchozím nastavení je povolená.
Další omezení konkrétních IP adres můžete provést konfigurací <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />
Zakázáno
Povoleno
SecuredByPerimeter
topicsConfiguration Informace o konfiguraci témat pro prostředek oboru názvů TopicsConfiguration
topicSpacesConfiguration Informace o konfiguraci prostorů témat pro prostředek oboru názvů TopicSpacesConfiguration

NamespaceSku

Jméno Popis Hodnota
kapacita Určuje počet jednotek propustnosti, které definují kapacitu oboru názvů. Výchozí hodnota vlastnosti je
1, který označuje 1 jednotku propustnosti = 1 MB/s příchozího přenosu dat a 2 MB/s na obor názvů. Minimální kapacita je 1 a
maximální povolená kapacita je 20.
Int
Jméno Název skladové položky. "Standardní"

PrivateEndpoint

Jméno Popis Hodnota
id Identifikátor ARM pro privátní koncový bod. řetězec

PrivateEndpointConnection

Jméno Popis Hodnota
vlastnosti Vlastnosti PrivateEndpointConnection. privateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Jméno Popis Hodnota
groupIds GroupIds from the private link service resource. string[]
privateEndpoint Prostředek privátního koncového bodu pro toto připojení. PrivateEndpoint
privateLinkServiceConnectionState Podrobnosti o stavu připojení ConnectionState
provisioningState Stav zřizování připojení privátního koncového bodu Zrušeno
Vytváření
Odstranění
Chyba
Úspěch
Aktualizace

RoutingEnrichments

Jméno Popis Hodnota
dynamický DynamicRoutingEnrichment[]
statický StaticRoutingEnrichment[]

RoutingIdentityInfo

Jméno Popis Hodnota
typ Typ identity směrování pro konfiguraci prostorů témat None (Žádný)
SystemAssigned
UserAssigned
userAssignedIdentity řetězec

StaticRoutingEnrichment

Jméno Popis Hodnota
klíč Klíč pro rozšiřování statického směrování řetězec
valueType Pro typ StaticStringRoutingEnrichmentnastavte hodnotu String . Řetězec (povinné)

StaticStringRoutingEnrichment

Jméno Popis Hodnota
hodnota Hodnota rozšiřování směrování typu řetězec. řetězec
valueType Typ hodnoty rozšíření statického směrování Například tato hodnota vlastnosti může být String. Řetězec (povinné)

TopicsConfiguration

Jméno Popis Hodnota
customDomains Seznam konfigurací vlastní domény pro obor názvů CustomDomainConfiguration[]

TopicSpacesConfiguration

Jméno Popis Hodnota
clientAuthentication Nastavení ověřování klientů pro konfiguraci prostorů témat clientAuthenticationSettings
customDomains Seznam konfigurací vlastní domény pro obor názvů CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Maximální počet relací na název ověřování. Výchozí hodnota vlastnosti je 1.
Minimální povolená hodnota je 1 a maximální povolená hodnota je 100.
Int
maximumSessionExpiryInHours Maximální platnost relace vyprší v hodinách. Výchozí hodnota vlastnosti je 1 hodina.
Minimální povolená hodnota je 1 hodina a maximální povolená hodnota je 8 hodin.
Int
routeTopicResourceId Plně kvalifikované ID prostředku Azure pro téma Event Gridu, do kterého se události budou směrovat z TopicSpaces v oboru názvů.
Tato vlastnost by měla být v následujícím formátu /subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}'.
Toto téma by se mělo nacházet ve stejné oblasti, ve které se nachází obor názvů.
řetězec
routingEnrichments Rozšíření směrování pro konfiguraci prostorů témat RoutingEnrichments
routingIdentityInfo Informace o identitě směrování pro konfiguraci prostorů témat RoutingIdentityInfo
stát Označuje, jestli je pro obor názvů povolená konfigurace Prostorů témat. Výchozí hodnota je zakázaná. Zakázáno
Povoleno

TrackedResourceTags

Jméno Popis Hodnota

UserIdentityProperties

Jméno Popis Hodnota
clientId ID klienta identity přiřazené uživatelem. řetězec
principalId ID objektu zabezpečení identity přiřazené uživatelem. řetězec

Definice prostředku šablony ARM

Typ prostředku oborů názvů je možné nasadit s operacemi, které cílí:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.EventGrid/namespaces, přidejte do šablony následující JSON.

{
  "type": "Microsoft.EventGrid/namespaces",
  "apiVersion": "2024-12-15-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": {
          "encodedIssuerCertificates": [
            {
              "encodedCertificate": "string",
              "kid": "string"
            }
          ],
          "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 – objekty

Nastavte valueType vlastnost určit typ objektu.

Pro řetězcovépoužijte:

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

Hodnoty vlastností

ClientAuthenticationSettings

Jméno Popis Hodnota
alternativeAuthenticationNameSources Alternativní zdroje názvů ověřování související s nastavením ověřování klienta pro prostředek oboru názvů Řetězcové pole obsahující některou z těchto možností:
ClientCertificateDns
ClientCertificateEmail
ClientCertificateIp
ClientCertificateSubject
ClientCertificateUri
customJwtAuthentication Vlastní nastavení ověřování JWT pro prostředek oboru názvů customJwtAuthenticationSettings

ConnectionState

Jméno Popis Hodnota
ActionsRequired Požadované akce (pokud nějaké) řetězec
popis Popis stavu připojení řetězec
stav Stav připojení. "Schváleno"
Odpojeno
Čeká na vyřízení
Odmítnuto

CustomDomainConfiguration

Jméno Popis Hodnota
certificateUrl Adresa URL certifikátu, který se používá k publikování do vlastní domény. V současné době podporujeme pouze certifikáty uložené ve službě Azure Key Vault. I když adresa URL certifikátu může být
adresa URL s následujícím formátem https://{název_trezoru_klíčů}.vault.azure.net/certificates/{název_certifikátu}/{version-id} nebo neverzní adresa URL následujícího formátu (např.
https://contosovault.vault.azure.net/certificates/contosocertpodporujeme pouze neverzní adresu URL certifikátu (např. https://contosovault.vault.azure.net/certificates/contosocert)
řetězec
expectedTxtRecordName Byl očekáváný název záznamu DNS TXT. Event Grid vyhledá záznam TXT s tímto názvem v sadě záznamů DNS vlastního názvu domény, aby prokázal vlastnictví domény.
Hodnoty pod tímto záznamem TXT musí obsahovat očekávanou hodnotu záznamu TXT.
řetězec
expectedTxtRecordValue Očekávaná hodnota záznamu DNS TXT Event Grid vyhledá záznam TXT s touto hodnotou v sadě záznamů DNS vlastního názvu domény, aby prokázal vlastnictví domény. řetězec
fullyQualifiedDomainName Plně kvalifikovaný název domény (FQDN) pro vlastní doménu string (povinné)
identita Informace o identitě pro přístup k certifikátu pro vlastní doménu Tyto informace o identitě musí odpovídat identitě nastavené v oboru názvů. CustomDomainIdentity
validationState Stav ověření pro vlastní doménu. Jedná se o vlastnost jen pro čtení, která je zpočátku nastavená na Čeká na vyřízení a bude aktualizována na Schváleno službou Event Grid až po úspěšném ověření vlastnictví názvu domény. "Schváleno"
ErrorRetrievingDnsRecord
Čeká na vyřízení

CustomDomainIdentity

Jméno Popis Hodnota
typ Typ použité spravované identity. Může být buď SystemAssigned, nebo UserAssigned. SystemAssigned
UserAssigned
userAssignedIdentity Identita uživatele přidružená k prostředku. řetězec

CustomJwtAuthenticationManagedIdentity

Jméno Popis Hodnota
typ Typ použité spravované identity. Může být buď SystemAssigned, nebo UserAssigned. SystemAssigned
UserAssigned (povinné)
userAssignedIdentity Identita uživatele přidružená k prostředku. řetězec

CustomJwtAuthenticationSettings

Jméno Popis Hodnota
encodedIssuerCertificates Informace o zakódovaných veřejných certifikátech, které se používají k vlastnímu ověřování. EncodedIssuerCertificateInfo[]
issuerCertificates Informace o certifikátech, které se používají k ověření tokenu. V současné době podporujeme maximálně 2 certifikáty. IssuerCertificateInfo[]
tokenIssuer Byl očekáváný vystavitel tokenu JWT. řetězec

DynamicRoutingEnrichment

Jméno Popis Hodnota
klíč Klíč pro rozšiřování dynamického směrování řetězec
hodnota Hodnota rozšiřování dynamického směrování řetězec

EncodedIssuerCertificateInfo

Jméno Popis Hodnota
encodedCertificate Certifikát ve formátu pem string (povinné)
kůzle Identifikátor certifikátu. string (povinné)

Informace o identitě

Jméno Popis Hodnota
principalId ID objektu zabezpečení identity prostředku. řetězec
tenantId ID tenanta prostředku. řetězec
typ Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'
Tato vlastnost se v současné době nepoužívá a vyhrazena pro budoucí využití.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Jméno Popis Hodnota

InboundIpRule

Jméno Popis Hodnota
akce Akce, která se má provést na základě shody nebo žádné shody ipmasku Povolit
ipMask IP adresa v zápisu CIDR, např. 10.0.0.0/8. řetězec

IssuerCertificateInfo

Jméno Popis Hodnota
certificateUrl Adresa URL certifikátu služby Keyvault ve formátu https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. string (povinné)
identita Identita, která se použije pro přístup k certifikátu. customJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

Jméno Popis Hodnota
apiVersion Verze rozhraní API 2024-12-15-preview
identita Informace o identitě prostředku oboru názvů IdentityInfo
umístění Umístění prostředku string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-zA-Z0-9-]*$ (povinné)
vlastnosti Vlastnosti prostředku oboru názvů oboru názvů properties
sku Představuje dostupné cenové úrovně skladové položky. NamespaceSku
visačky Značky prostředků Slovník názvů a hodnot značek Viz Značky v šablonách
typ Typ prostředku Microsoft.EventGrid/namespaces

Obor názvůProperties

Jméno Popis Hodnota
inboundIpRules To se dá použít k omezení provozu z konkrétních IP adres místo všech IP adres. Poznámka: Tyto informace se považují pouze v případě, že je povolená technologie PublicNetworkAccess. InboundIpRule []
isZoneRedundant Jedná se o volitelnou vlastnost, která uživateli umožňuje určit, jestli prostředek oboru názvů podporuje funkci redundance zón nebo ne. Pokud je to
vlastnost není explicitně určena uživatelem, její výchozí hodnota závisí na následujících podmínkách:
a. Pro oblasti s povolenými zónami dostupnosti – Výchozí hodnota vlastnosti by byla true.
b. Pro oblasti s povolenou zónou dostupnosti – výchozí hodnota vlastnosti by byla false.
Po zadání nelze tuto vlastnost aktualizovat.
Bool
minimumTlsVersionAllowed Minimální verze protokolu TLS vydavatele může publikovat do tohoto oboru názvů. Podporuje se pouze protokol TLS verze 1.2. '1.0'
'1.1'
'1.2'
privateEndpointConnections Seznam připojení privátních koncových bodů PrivateEndpointConnection[]
publicNetworkAccess To určuje, jestli je provoz povolený přes veřejnou síť. Ve výchozím nastavení je povolená.
Další omezení konkrétních IP adres můžete provést konfigurací <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />
Zakázáno
Povoleno
SecuredByPerimeter
topicsConfiguration Informace o konfiguraci témat pro prostředek oboru názvů TopicsConfiguration
topicSpacesConfiguration Informace o konfiguraci prostorů témat pro prostředek oboru názvů TopicSpacesConfiguration

NamespaceSku

Jméno Popis Hodnota
kapacita Určuje počet jednotek propustnosti, které definují kapacitu oboru názvů. Výchozí hodnota vlastnosti je
1, který označuje 1 jednotku propustnosti = 1 MB/s příchozího přenosu dat a 2 MB/s na obor názvů. Minimální kapacita je 1 a
maximální povolená kapacita je 20.
Int
Jméno Název skladové položky. "Standardní"

PrivateEndpoint

Jméno Popis Hodnota
id Identifikátor ARM pro privátní koncový bod. řetězec

PrivateEndpointConnection

Jméno Popis Hodnota
vlastnosti Vlastnosti PrivateEndpointConnection. privateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Jméno Popis Hodnota
groupIds GroupIds from the private link service resource. string[]
privateEndpoint Prostředek privátního koncového bodu pro toto připojení. PrivateEndpoint
privateLinkServiceConnectionState Podrobnosti o stavu připojení ConnectionState
provisioningState Stav zřizování připojení privátního koncového bodu Zrušeno
Vytváření
Odstranění
Chyba
Úspěch
Aktualizace

RoutingEnrichments

Jméno Popis Hodnota
dynamický DynamicRoutingEnrichment[]
statický StaticRoutingEnrichment[]

RoutingIdentityInfo

Jméno Popis Hodnota
typ Typ identity směrování pro konfiguraci prostorů témat None (Žádný)
SystemAssigned
UserAssigned
userAssignedIdentity řetězec

StaticRoutingEnrichment

Jméno Popis Hodnota
klíč Klíč pro rozšiřování statického směrování řetězec
valueType Pro typ StaticStringRoutingEnrichmentnastavte hodnotu String . Řetězec (povinné)

StaticStringRoutingEnrichment

Jméno Popis Hodnota
hodnota Hodnota rozšiřování směrování typu řetězec. řetězec
valueType Typ hodnoty rozšíření statického směrování Například tato hodnota vlastnosti může být String. Řetězec (povinné)

TopicsConfiguration

Jméno Popis Hodnota
customDomains Seznam konfigurací vlastní domény pro obor názvů CustomDomainConfiguration[]

TopicSpacesConfiguration

Jméno Popis Hodnota
clientAuthentication Nastavení ověřování klientů pro konfiguraci prostorů témat clientAuthenticationSettings
customDomains Seznam konfigurací vlastní domény pro obor názvů CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Maximální počet relací na název ověřování. Výchozí hodnota vlastnosti je 1.
Minimální povolená hodnota je 1 a maximální povolená hodnota je 100.
Int
maximumSessionExpiryInHours Maximální platnost relace vyprší v hodinách. Výchozí hodnota vlastnosti je 1 hodina.
Minimální povolená hodnota je 1 hodina a maximální povolená hodnota je 8 hodin.
Int
routeTopicResourceId Plně kvalifikované ID prostředku Azure pro téma Event Gridu, do kterého se události budou směrovat z TopicSpaces v oboru názvů.
Tato vlastnost by měla být v následujícím formátu /subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}'.
Toto téma by se mělo nacházet ve stejné oblasti, ve které se nachází obor názvů.
řetězec
routingEnrichments Rozšíření směrování pro konfiguraci prostorů témat RoutingEnrichments
routingIdentityInfo Informace o identitě směrování pro konfiguraci prostorů témat RoutingIdentityInfo
stát Označuje, jestli je pro obor názvů povolená konfigurace Prostorů témat. Výchozí hodnota je zakázaná. Zakázáno
Povoleno

TrackedResourceTags

Jméno Popis Hodnota

UserIdentityProperties

Jméno Popis Hodnota
clientId ID klienta identity přiřazené uživatelem. řetězec
principalId ID objektu zabezpečení identity přiřazené uživatelem. řetězec

Definice prostředku Terraformu (poskytovatel AzAPI)

Typ prostředku oborů názvů je možné nasadit s operacemi, které cílí:

  • skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.EventGrid/namespaces, přidejte do šablony následující Terraform.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces@2024-12-15-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 = {
            encodedIssuerCertificates = [
              {
                encodedCertificate = "string"
                kid = "string"
              }
            ]
            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 – objekty

Nastavte valueType vlastnost určit typ objektu.

Pro řetězcovépoužijte:

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

Hodnoty vlastností

ClientAuthenticationSettings

Jméno Popis Hodnota
alternativeAuthenticationNameSources Alternativní zdroje názvů ověřování související s nastavením ověřování klienta pro prostředek oboru názvů Řetězcové pole obsahující některou z těchto možností:
ClientCertificateDns
ClientCertificateEmail
ClientCertificateIp
ClientCertificateSubject
ClientCertificateUri
customJwtAuthentication Vlastní nastavení ověřování JWT pro prostředek oboru názvů customJwtAuthenticationSettings

ConnectionState

Jméno Popis Hodnota
ActionsRequired Požadované akce (pokud nějaké) řetězec
popis Popis stavu připojení řetězec
stav Stav připojení. "Schváleno"
Odpojeno
Čeká na vyřízení
Odmítnuto

CustomDomainConfiguration

Jméno Popis Hodnota
certificateUrl Adresa URL certifikátu, který se používá k publikování do vlastní domény. V současné době podporujeme pouze certifikáty uložené ve službě Azure Key Vault. I když adresa URL certifikátu může být
adresa URL s následujícím formátem https://{název_trezoru_klíčů}.vault.azure.net/certificates/{název_certifikátu}/{version-id} nebo neverzní adresa URL následujícího formátu (např.
https://contosovault.vault.azure.net/certificates/contosocertpodporujeme pouze neverzní adresu URL certifikátu (např. https://contosovault.vault.azure.net/certificates/contosocert)
řetězec
expectedTxtRecordName Byl očekáváný název záznamu DNS TXT. Event Grid vyhledá záznam TXT s tímto názvem v sadě záznamů DNS vlastního názvu domény, aby prokázal vlastnictví domény.
Hodnoty pod tímto záznamem TXT musí obsahovat očekávanou hodnotu záznamu TXT.
řetězec
expectedTxtRecordValue Očekávaná hodnota záznamu DNS TXT Event Grid vyhledá záznam TXT s touto hodnotou v sadě záznamů DNS vlastního názvu domény, aby prokázal vlastnictví domény. řetězec
fullyQualifiedDomainName Plně kvalifikovaný název domény (FQDN) pro vlastní doménu string (povinné)
identita Informace o identitě pro přístup k certifikátu pro vlastní doménu Tyto informace o identitě musí odpovídat identitě nastavené v oboru názvů. CustomDomainIdentity
validationState Stav ověření pro vlastní doménu. Jedná se o vlastnost jen pro čtení, která je zpočátku nastavená na Čeká na vyřízení a bude aktualizována na Schváleno službou Event Grid až po úspěšném ověření vlastnictví názvu domény. "Schváleno"
ErrorRetrievingDnsRecord
Čeká na vyřízení

CustomDomainIdentity

Jméno Popis Hodnota
typ Typ použité spravované identity. Může být buď SystemAssigned, nebo UserAssigned. SystemAssigned
UserAssigned
userAssignedIdentity Identita uživatele přidružená k prostředku. řetězec

CustomJwtAuthenticationManagedIdentity

Jméno Popis Hodnota
typ Typ použité spravované identity. Může být buď SystemAssigned, nebo UserAssigned. SystemAssigned
UserAssigned (povinné)
userAssignedIdentity Identita uživatele přidružená k prostředku. řetězec

CustomJwtAuthenticationSettings

Jméno Popis Hodnota
encodedIssuerCertificates Informace o zakódovaných veřejných certifikátech, které se používají k vlastnímu ověřování. EncodedIssuerCertificateInfo[]
issuerCertificates Informace o certifikátech, které se používají k ověření tokenu. V současné době podporujeme maximálně 2 certifikáty. IssuerCertificateInfo[]
tokenIssuer Byl očekáváný vystavitel tokenu JWT. řetězec

DynamicRoutingEnrichment

Jméno Popis Hodnota
klíč Klíč pro rozšiřování dynamického směrování řetězec
hodnota Hodnota rozšiřování dynamického směrování řetězec

EncodedIssuerCertificateInfo

Jméno Popis Hodnota
encodedCertificate Certifikát ve formátu pem string (povinné)
kůzle Identifikátor certifikátu. string (povinné)

Informace o identitě

Jméno Popis Hodnota
principalId ID objektu zabezpečení identity prostředku. řetězec
tenantId ID tenanta prostředku. řetězec
typ Typ použité spravované identity. Typ SystemAssigned, UserAssigned zahrnuje implicitně vytvořenou identitu i sadu identit přiřazených uživatelem. Typ None odebere jakoukoli identitu. None (Žádný)
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
userAssignedIdentities Seznam identit uživatelů přidružených k prostředku. Odkazy na klíč slovníku identit uživatele budou ID prostředků ARM ve formuláři:
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'
Tato vlastnost se v současné době nepoužívá a vyhrazena pro budoucí využití.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Jméno Popis Hodnota

InboundIpRule

Jméno Popis Hodnota
akce Akce, která se má provést na základě shody nebo žádné shody ipmasku Povolit
ipMask IP adresa v zápisu CIDR, např. 10.0.0.0/8. řetězec

IssuerCertificateInfo

Jméno Popis Hodnota
certificateUrl Adresa URL certifikátu služby Keyvault ve formátu https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. string (povinné)
identita Identita, která se použije pro přístup k certifikátu. customJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

Jméno Popis Hodnota
identita Informace o identitě prostředku oboru názvů IdentityInfo
umístění Umístění prostředku string (povinné)
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 3
Maximální délka = 3
Model = ^[a-zA-Z0-9-]*$ (povinné)
vlastnosti Vlastnosti prostředku oboru názvů oboru názvů properties
sku Představuje dostupné cenové úrovně skladové položky. NamespaceSku
visačky Značky prostředků Slovník názvů a hodnot značek
typ Typ prostředku Microsoft.EventGrid/namespaces@2024-12-15-preview

Obor názvůProperties

Jméno Popis Hodnota
inboundIpRules To se dá použít k omezení provozu z konkrétních IP adres místo všech IP adres. Poznámka: Tyto informace se považují pouze v případě, že je povolená technologie PublicNetworkAccess. InboundIpRule []
isZoneRedundant Jedná se o volitelnou vlastnost, která uživateli umožňuje určit, jestli prostředek oboru názvů podporuje funkci redundance zón nebo ne. Pokud je to
vlastnost není explicitně určena uživatelem, její výchozí hodnota závisí na následujících podmínkách:
a. Pro oblasti s povolenými zónami dostupnosti – Výchozí hodnota vlastnosti by byla true.
b. Pro oblasti s povolenou zónou dostupnosti – výchozí hodnota vlastnosti by byla false.
Po zadání nelze tuto vlastnost aktualizovat.
Bool
minimumTlsVersionAllowed Minimální verze protokolu TLS vydavatele může publikovat do tohoto oboru názvů. Podporuje se pouze protokol TLS verze 1.2. '1.0'
'1.1'
'1.2'
privateEndpointConnections Seznam připojení privátních koncových bodů PrivateEndpointConnection[]
publicNetworkAccess To určuje, jestli je provoz povolený přes veřejnou síť. Ve výchozím nastavení je povolená.
Další omezení konkrétních IP adres můžete provést konfigurací <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />
Zakázáno
Povoleno
SecuredByPerimeter
topicsConfiguration Informace o konfiguraci témat pro prostředek oboru názvů TopicsConfiguration
topicSpacesConfiguration Informace o konfiguraci prostorů témat pro prostředek oboru názvů TopicSpacesConfiguration

NamespaceSku

Jméno Popis Hodnota
kapacita Určuje počet jednotek propustnosti, které definují kapacitu oboru názvů. Výchozí hodnota vlastnosti je
1, který označuje 1 jednotku propustnosti = 1 MB/s příchozího přenosu dat a 2 MB/s na obor názvů. Minimální kapacita je 1 a
maximální povolená kapacita je 20.
Int
Jméno Název skladové položky. "Standardní"

PrivateEndpoint

Jméno Popis Hodnota
id Identifikátor ARM pro privátní koncový bod. řetězec

PrivateEndpointConnection

Jméno Popis Hodnota
vlastnosti Vlastnosti PrivateEndpointConnection. privateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Jméno Popis Hodnota
groupIds GroupIds from the private link service resource. string[]
privateEndpoint Prostředek privátního koncového bodu pro toto připojení. PrivateEndpoint
privateLinkServiceConnectionState Podrobnosti o stavu připojení ConnectionState
provisioningState Stav zřizování připojení privátního koncového bodu Zrušeno
Vytváření
Odstranění
Chyba
Úspěch
Aktualizace

RoutingEnrichments

Jméno Popis Hodnota
dynamický DynamicRoutingEnrichment[]
statický StaticRoutingEnrichment[]

RoutingIdentityInfo

Jméno Popis Hodnota
typ Typ identity směrování pro konfiguraci prostorů témat None (Žádný)
SystemAssigned
UserAssigned
userAssignedIdentity řetězec

StaticRoutingEnrichment

Jméno Popis Hodnota
klíč Klíč pro rozšiřování statického směrování řetězec
valueType Pro typ StaticStringRoutingEnrichmentnastavte hodnotu String . Řetězec (povinné)

StaticStringRoutingEnrichment

Jméno Popis Hodnota
hodnota Hodnota rozšiřování směrování typu řetězec. řetězec
valueType Typ hodnoty rozšíření statického směrování Například tato hodnota vlastnosti může být String. Řetězec (povinné)

TopicsConfiguration

Jméno Popis Hodnota
customDomains Seznam konfigurací vlastní domény pro obor názvů CustomDomainConfiguration[]

TopicSpacesConfiguration

Jméno Popis Hodnota
clientAuthentication Nastavení ověřování klientů pro konfiguraci prostorů témat clientAuthenticationSettings
customDomains Seznam konfigurací vlastní domény pro obor názvů CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Maximální počet relací na název ověřování. Výchozí hodnota vlastnosti je 1.
Minimální povolená hodnota je 1 a maximální povolená hodnota je 100.
Int
maximumSessionExpiryInHours Maximální platnost relace vyprší v hodinách. Výchozí hodnota vlastnosti je 1 hodina.
Minimální povolená hodnota je 1 hodina a maximální povolená hodnota je 8 hodin.
Int
routeTopicResourceId Plně kvalifikované ID prostředku Azure pro téma Event Gridu, do kterého se události budou směrovat z TopicSpaces v oboru názvů.
Tato vlastnost by měla být v následujícím formátu /subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}'.
Toto téma by se mělo nacházet ve stejné oblasti, ve které se nachází obor názvů.
řetězec
routingEnrichments Rozšíření směrování pro konfiguraci prostorů témat RoutingEnrichments
routingIdentityInfo Informace o identitě směrování pro konfiguraci prostorů témat RoutingIdentityInfo
stát Označuje, jestli je pro obor názvů povolená konfigurace Prostorů témat. Výchozí hodnota je zakázaná. Zakázáno
Povoleno

TrackedResourceTags

Jméno Popis Hodnota

UserIdentityProperties

Jméno Popis Hodnota
clientId ID klienta identity přiřazené uživatelem. řetězec
principalId ID objektu zabezpečení identity přiřazené uživatelem. řetězec