Udostępnij za pośrednictwem

Microsoft.EventGrid przestrzenie nazw 2024-06-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu przestrzeni nazw można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.EventGrid/namespaces, dodaj następujący kod Bicep do szablonu.

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'
  }
}

Obiekty StaticRoutingEnrichment

Ustaw właściwość valueType, aby określić typ obiektu.

W przypadkuciągów użyj:

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

Wartości właściwości

ClientAuthenticationSettings

Nazwa Opis Wartość
alternativeAuthenticationNameSources Alternatywne źródła nazw uwierzytelniania związane z ustawieniami uwierzytelniania klienta dla zasobu przestrzeni nazw. Tablica ciągów zawierająca dowolną z:
"ClientCertificateDns"
"ClientCertificateEmail"
"ClientCertificateIp"
"ClientCertificateSubject"
"ClientCertificateUri"
customJwtAuthentication Niestandardowe ustawienia uwierzytelniania JWT dla zasobu przestrzeni nazw. CustomJwtAuthenticationSettings

ConnectionState

Nazwa Opis Wartość
actionsRequired Wymagane akcje (jeśli istnieją). struna
opis Opis stanu połączenia. struna
stan Stan połączenia. "Zatwierdzone"
"Rozłączono"
"Oczekujące"
"Odrzucono"

CustomDomainConfiguration

Nazwa Opis Wartość
certificateUrl Adres URL certyfikatu używanego do publikowania w domenie niestandardowej. Obecnie obsługujemy certyfikaty przechowywane tylko w usłudze Azure Key Vault. Adres URL certyfikatu może być dowolny
versioned URL następującego formatu https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, lub niewersyfikowany adres URL następującego formatu (np.
https://contosovault.vault.azure.net/certificates/contosocertobsługujemy tylko adres URL niewersji certyfikatu (np. https://contosovault.vault.azure.net/certificates/contosocert)		 struna
expectedTxtRecordName Oczekiwana nazwa rekordu TXT DNS. Usługa Event Grid sprawdzi rekord TXT o tej nazwie w zestawie rekordów DNS niestandardowej nazwy domeny, aby udowodnić własność domeny.
Wartości w tym rekordzie TXT muszą zawierać oczekiwaną wartość rekordu TXT.		 struna
expectedTxtRecordValue Oczekiwana wartość rekordu TXT DNS. Usługa Event Grid sprawdzi rekord TXT z tą wartością w zestawie rekordów DNS niestandardowej nazwy domeny, aby udowodnić własność domeny. struna
fullyQualifiedDomainName W pełni kwalifikowana nazwa domeny (FQDN) dla domeny niestandardowej. ciąg (wymagany)
tożsamość Informacje o tożsamości na potrzeby uzyskiwania dostępu do certyfikatu dla domeny niestandardowej. Te informacje o tożsamości muszą być zgodne z tożsamością ustawioną w przestrzeni nazw. CustomDomainIdentity
validationState Stan weryfikacji domeny niestandardowej. Jest to właściwość tylko do odczytu i jest początkowo ustawiona na wartość "Oczekiwanie" i zostanie zaktualizowana do wartości "Zatwierdzone" przez usługę Event Grid dopiero po pomyślnym zweryfikowaniu własności nazwy domeny. "Zatwierdzone"
"ErrorRetrievingDnsRecord"
"Oczekujące"

CustomDomainIdentity

Nazwa Opis Wartość
typ Używany typ tożsamości zarządzanej. Może mieć wartość "SystemAssigned" lub "UserAssigned". "SystemAssigned"
"UserAssigned"
userAssignedIdentity Tożsamość użytkownika skojarzona z zasobem. struna

CustomJwtAuthenticationManagedIdentity

Nazwa Opis Wartość
typ Używany typ tożsamości zarządzanej. Może mieć wartość "SystemAssigned" lub "UserAssigned". "SystemAssigned"
"UserAssigned" (wymagane)
userAssignedIdentity Tożsamość użytkownika skojarzona z zasobem. struna

CustomJwtAuthenticationSettings

Nazwa Opis Wartość
issuerCertificates Informacje o certyfikacie używanym do weryfikacji tokenu. Obecnie obsługujemy maksymalnie 2 certyfikaty. IssuerCertificateInfo[]
tokenIssuer Oczekiwany wystawca tokenu JWT. struna

DynamicRoutingEnrichment

Nazwa Opis Wartość
klucz Klucz wzbogacania routingu dynamicznego. struna
wartość Wartość wzbogacania routingu dynamicznego. struna

IdentityInfo

Nazwa Opis Wartość
principalId Identyfikator podmiotu zabezpieczeń tożsamości zasobu. struna
tenantId Identyfikator dzierżawy zasobu. struna
typ Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość. "Brak"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w formularzu:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
Ta właściwość nie jest obecnie używana i zarezerwowana do użycia w przyszłości.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nazwa Opis Wartość

Ruch przychodzący irule

Nazwa Opis Wartość
akcja Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask. "Zezwalaj"
maska ip Adres IP w notacji CIDR, np. 10.0.0.0/8. struna

IssuerCertificateInfo

Nazwa Opis Wartość
certificateUrl Adres URL certyfikatu usługi Keyvault w formacie https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. ciąg (wymagany)
tożsamość Tożsamość, która będzie używana do uzyskiwania dostępu do certyfikatu. CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/przestrzenie nazw

Nazwa Opis Wartość
tożsamość Informacje o tożsamości zasobu przestrzeni nazw. IdentityInfo
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-zA-Z0-9-]*$ (wymagane)
Właściwości Właściwości zasobu Przestrzeni nazw. przestrzeni nazwWłaściwości
Numer jednostki magazynowej Reprezentuje dostępne warstwy cenowe jednostki SKU. Przestrzenie nazwSku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach

Przestrzeń nazwWłaściwości

Nazwa Opis Wartość
inboundIpRules Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: Są one traktowane tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona. inboundIpRule[]
isZoneRedundant Jest to właściwość opcjonalna i umożliwia użytkownikowi określenie, czy zasób przestrzeni nazw obsługuje funkcję nadmiarowości strefy, czy nie. Jeśli to
właściwość nie jest określona jawnie przez użytkownika. Jego wartość domyślna zależy od następujących warunków:
a. W przypadku regionów z włączonymi strefami dostępności — wartość właściwości domyślnej będzie prawdziwa.
b. W przypadku regionów z obsługą stref innych niż dostępność — domyślna wartość właściwości będzie fałszem.
Po określeniu tej właściwości nie można zaktualizować.		 Bool
minimumTlsVersionAllowed Minimalna wersja protokołu TLS wydawcy może być publikowana w tej przestrzeni nazw. Obsługiwane są tylko protokoły TLS w wersji 1.2. '1.0'
'1.1'
'1.2'
privateEndpointConnections Lista połączeń prywatnych punktów końcowych. PrivateEndpointConnection[]
publicNetworkAccess Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />		 "Wyłączone"
"Włączone"
"SecuredByPerimeter"
topicsConfiguration Informacje o konfiguracji tematów dla zasobu przestrzeni nazw TematyKonfiguracja
topicSpacesConfiguration Informacje o konfiguracji obszaru tematów dla zasobu przestrzeni nazw TopicSpacesConfiguration

Przestrzeń nazwSku

Nazwa Opis Wartość
pojemność Określa liczbę jednostek przepływności definiujących pojemność przestrzeni nazw. Wartość domyślna właściwości to
1, co oznacza 1 jednostkę przepływności = 1 MB/s ruchu przychodzącego i 2 MB/s ruchu wychodzącego na przestrzeń nazw. Minimalna pojemność to 1 i
maksymalna dozwolona pojemność to 20.		 Int
nazwa Nazwa jednostki SKU. "Standardowa"

PrivateEndpoint

Nazwa Opis Wartość
id Identyfikator usługi ARM dla prywatnego punktu końcowego. struna

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości Właściwości elementu PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
groupIds GroupIds z zasobu usługi łącza prywatnego. string[]
privateEndpoint Zasób prywatnego punktu końcowego dla tego połączenia. PrivateEndpoint
privateLinkServiceConnectionState Szczegółowe informacje o stanie połączenia. ConnectionState
provisioningState Stan aprowizacji połączenia prywatnego punktu końcowego. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"

RoutingEnrichments

Nazwa Opis Wartość
dynamiczny DynamicRoutingEnrichment[]
statyczny StaticRoutingEnrichment[]

RoutingIdentityInfo

Nazwa Opis Wartość
typ Typ tożsamości routingu dla konfiguracji miejsc tematów. "Brak"
"SystemAssigned"
"UserAssigned"
userAssignedIdentity struna

StaticRoutingEnrichment

Nazwa Opis Wartość
klucz Klucz wzbogacania routingu statycznego. struna
valueType Ustaw wartość "Ciąg" dla typu StaticStringRoutingEnrichment. "Ciąg" (wymagany)

StaticStringRoutingEnrichment

Nazwa Opis Wartość
wartość Wartość wzbogacania routingu typu ciągu. struna
valueType Typ wartości wzbogacania routingu statycznego. Na przykład ta wartość właściwości może mieć wartość "Ciąg". "Ciąg" (wymagany)

TematyKonfiguracja

Nazwa Opis Wartość
customDomains Lista konfiguracji domeny niestandardowej dla przestrzeni nazw. CustomDomainConfiguration[]

TopicSpacesConfiguration

Nazwa Opis Wartość
clientAuthentication Ustawienia uwierzytelniania klienta dla konfiguracji miejsc tematów. ClientAuthenticationSettings
customDomains Lista konfiguracji domeny niestandardowej dla przestrzeni nazw. CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Maksymalna liczba sesji na nazwę uwierzytelniania. Wartość domyślna właściwości to 1.
Minimalna dozwolona wartość to 1, a maksymalna dozwolona wartość to 100.		 Int
maximumSessionExpiryInHours Maksymalny czas wygaśnięcia sesji w godzinach. Wartość domyślna właściwości to 1 godzina.
Minimalna dozwolona wartość to 1 godzina, a maksymalna dozwolona wartość to 8 godzin.		 Int
routeTopicResourceId W pełni kwalifikowany identyfikator zasobu platformy Azure dla tematu usługi Event Grid, do którego będą kierowane zdarzenia z przestrzeni tematów w przestrzeni nazw.
Ta właściwość powinna mieć następujący format :/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}".
Ten temat powinien znajdować się w tym samym regionie, w którym znajduje się przestrzeń nazw.		 struna
routingEnrichments Wzbogacanie routingu dla konfiguracji obszarów tematów RoutingEnrichments
routingIdentityInfo Informacje o tożsamości routingu dla konfiguracji przestrzeni tematów. RoutingIdentityInfo
stan Określ, czy dla przestrzeni nazw włączono konfigurację funkcji Miejsca do tematu. Wartość domyślna to Wyłączone. "Wyłączone"
"Włączone"

TrackedResourceTags

Nazwa Opis Wartość

UserIdentityProperties

Nazwa Opis Wartość
clientId Identyfikator klienta tożsamości przypisanej przez użytkownika. struna
principalId Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika. struna

Definicja zasobu szablonu usługi ARM

Typ zasobu przestrzeni nazw można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.EventGrid/namespaces, dodaj następujący kod JSON do szablonu.

{
  "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"
  }
}

Obiekty StaticRoutingEnrichment

Ustaw właściwość valueType, aby określić typ obiektu.

W przypadkuciągów użyj:

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

Wartości właściwości

ClientAuthenticationSettings

Nazwa Opis Wartość
alternativeAuthenticationNameSources Alternatywne źródła nazw uwierzytelniania związane z ustawieniami uwierzytelniania klienta dla zasobu przestrzeni nazw. Tablica ciągów zawierająca dowolną z:
"ClientCertificateDns"
"ClientCertificateEmail"
"ClientCertificateIp"
"ClientCertificateSubject"
"ClientCertificateUri"
customJwtAuthentication Niestandardowe ustawienia uwierzytelniania JWT dla zasobu przestrzeni nazw. CustomJwtAuthenticationSettings

ConnectionState

Nazwa Opis Wartość
actionsRequired Wymagane akcje (jeśli istnieją). struna
opis Opis stanu połączenia. struna
stan Stan połączenia. "Zatwierdzone"
"Rozłączono"
"Oczekujące"
"Odrzucono"

CustomDomainConfiguration

Nazwa Opis Wartość
certificateUrl Adres URL certyfikatu używanego do publikowania w domenie niestandardowej. Obecnie obsługujemy certyfikaty przechowywane tylko w usłudze Azure Key Vault. Adres URL certyfikatu może być dowolny
versioned URL następującego formatu https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, lub niewersyfikowany adres URL następującego formatu (np.
https://contosovault.vault.azure.net/certificates/contosocertobsługujemy tylko adres URL niewersji certyfikatu (np. https://contosovault.vault.azure.net/certificates/contosocert)		 struna
expectedTxtRecordName Oczekiwana nazwa rekordu TXT DNS. Usługa Event Grid sprawdzi rekord TXT o tej nazwie w zestawie rekordów DNS niestandardowej nazwy domeny, aby udowodnić własność domeny.
Wartości w tym rekordzie TXT muszą zawierać oczekiwaną wartość rekordu TXT.		 struna
expectedTxtRecordValue Oczekiwana wartość rekordu TXT DNS. Usługa Event Grid sprawdzi rekord TXT z tą wartością w zestawie rekordów DNS niestandardowej nazwy domeny, aby udowodnić własność domeny. struna
fullyQualifiedDomainName W pełni kwalifikowana nazwa domeny (FQDN) dla domeny niestandardowej. ciąg (wymagany)
tożsamość Informacje o tożsamości na potrzeby uzyskiwania dostępu do certyfikatu dla domeny niestandardowej. Te informacje o tożsamości muszą być zgodne z tożsamością ustawioną w przestrzeni nazw. CustomDomainIdentity
validationState Stan weryfikacji domeny niestandardowej. Jest to właściwość tylko do odczytu i jest początkowo ustawiona na wartość "Oczekiwanie" i zostanie zaktualizowana do wartości "Zatwierdzone" przez usługę Event Grid dopiero po pomyślnym zweryfikowaniu własności nazwy domeny. "Zatwierdzone"
"ErrorRetrievingDnsRecord"
"Oczekujące"

CustomDomainIdentity

Nazwa Opis Wartość
typ Używany typ tożsamości zarządzanej. Może mieć wartość "SystemAssigned" lub "UserAssigned". "SystemAssigned"
"UserAssigned"
userAssignedIdentity Tożsamość użytkownika skojarzona z zasobem. struna

CustomJwtAuthenticationManagedIdentity

Nazwa Opis Wartość
typ Używany typ tożsamości zarządzanej. Może mieć wartość "SystemAssigned" lub "UserAssigned". "SystemAssigned"
"UserAssigned" (wymagane)
userAssignedIdentity Tożsamość użytkownika skojarzona z zasobem. struna

CustomJwtAuthenticationSettings

Nazwa Opis Wartość
issuerCertificates Informacje o certyfikacie używanym do weryfikacji tokenu. Obecnie obsługujemy maksymalnie 2 certyfikaty. IssuerCertificateInfo[]
tokenIssuer Oczekiwany wystawca tokenu JWT. struna

DynamicRoutingEnrichment

Nazwa Opis Wartość
klucz Klucz wzbogacania routingu dynamicznego. struna
wartość Wartość wzbogacania routingu dynamicznego. struna

IdentityInfo

Nazwa Opis Wartość
principalId Identyfikator podmiotu zabezpieczeń tożsamości zasobu. struna
tenantId Identyfikator dzierżawy zasobu. struna
typ Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość. "Brak"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w formularzu:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
Ta właściwość nie jest obecnie używana i zarezerwowana do użycia w przyszłości.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nazwa Opis Wartość

Ruch przychodzący irule

Nazwa Opis Wartość
akcja Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask. "Zezwalaj"
maska ip Adres IP w notacji CIDR, np. 10.0.0.0/8. struna

IssuerCertificateInfo

Nazwa Opis Wartość
certificateUrl Adres URL certyfikatu usługi Keyvault w formacie https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. ciąg (wymagany)
tożsamość Tożsamość, która będzie używana do uzyskiwania dostępu do certyfikatu. CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/przestrzenie nazw

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2024-06-01-preview"
tożsamość Informacje o tożsamości zasobu przestrzeni nazw. IdentityInfo
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-zA-Z0-9-]*$ (wymagane)
Właściwości Właściwości zasobu Przestrzeni nazw. przestrzeni nazwWłaściwości
Numer jednostki magazynowej Reprezentuje dostępne warstwy cenowe jednostki SKU. Przestrzenie nazwSku
Tagi Tagi zasobów Słownik nazw tagów i wartości. Zobacz tagi w szablonach
typ Typ zasobu "Microsoft.EventGrid/namespaces"

Przestrzeń nazwWłaściwości

Nazwa Opis Wartość
inboundIpRules Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: Są one traktowane tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona. inboundIpRule[]
isZoneRedundant Jest to właściwość opcjonalna i umożliwia użytkownikowi określenie, czy zasób przestrzeni nazw obsługuje funkcję nadmiarowości strefy, czy nie. Jeśli to
właściwość nie jest określona jawnie przez użytkownika. Jego wartość domyślna zależy od następujących warunków:
a. W przypadku regionów z włączonymi strefami dostępności — wartość właściwości domyślnej będzie prawdziwa.
b. W przypadku regionów z obsługą stref innych niż dostępność — domyślna wartość właściwości będzie fałszem.
Po określeniu tej właściwości nie można zaktualizować.		 Bool
minimumTlsVersionAllowed Minimalna wersja protokołu TLS wydawcy może być publikowana w tej przestrzeni nazw. Obsługiwane są tylko protokoły TLS w wersji 1.2. '1.0'
'1.1'
'1.2'
privateEndpointConnections Lista połączeń prywatnych punktów końcowych. PrivateEndpointConnection[]
publicNetworkAccess Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />		 "Wyłączone"
"Włączone"
"SecuredByPerimeter"
topicsConfiguration Informacje o konfiguracji tematów dla zasobu przestrzeni nazw TematyKonfiguracja
topicSpacesConfiguration Informacje o konfiguracji obszaru tematów dla zasobu przestrzeni nazw TopicSpacesConfiguration

Przestrzeń nazwSku

Nazwa Opis Wartość
pojemność Określa liczbę jednostek przepływności definiujących pojemność przestrzeni nazw. Wartość domyślna właściwości to
1, co oznacza 1 jednostkę przepływności = 1 MB/s ruchu przychodzącego i 2 MB/s ruchu wychodzącego na przestrzeń nazw. Minimalna pojemność to 1 i
maksymalna dozwolona pojemność to 20.		 Int
nazwa Nazwa jednostki SKU. "Standardowa"

PrivateEndpoint

Nazwa Opis Wartość
id Identyfikator usługi ARM dla prywatnego punktu końcowego. struna

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości Właściwości elementu PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
groupIds GroupIds z zasobu usługi łącza prywatnego. string[]
privateEndpoint Zasób prywatnego punktu końcowego dla tego połączenia. PrivateEndpoint
privateLinkServiceConnectionState Szczegółowe informacje o stanie połączenia. ConnectionState
provisioningState Stan aprowizacji połączenia prywatnego punktu końcowego. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"

RoutingEnrichments

Nazwa Opis Wartość
dynamiczny DynamicRoutingEnrichment[]
statyczny StaticRoutingEnrichment[]

RoutingIdentityInfo

Nazwa Opis Wartość
typ Typ tożsamości routingu dla konfiguracji miejsc tematów. "Brak"
"SystemAssigned"
"UserAssigned"
userAssignedIdentity struna

StaticRoutingEnrichment

Nazwa Opis Wartość
klucz Klucz wzbogacania routingu statycznego. struna
valueType Ustaw wartość "Ciąg" dla typu StaticStringRoutingEnrichment. "Ciąg" (wymagany)

StaticStringRoutingEnrichment

Nazwa Opis Wartość
wartość Wartość wzbogacania routingu typu ciągu. struna
valueType Typ wartości wzbogacania routingu statycznego. Na przykład ta wartość właściwości może mieć wartość "Ciąg". "Ciąg" (wymagany)

TematyKonfiguracja

Nazwa Opis Wartość
customDomains Lista konfiguracji domeny niestandardowej dla przestrzeni nazw. CustomDomainConfiguration[]

TopicSpacesConfiguration

Nazwa Opis Wartość
clientAuthentication Ustawienia uwierzytelniania klienta dla konfiguracji miejsc tematów. ClientAuthenticationSettings
customDomains Lista konfiguracji domeny niestandardowej dla przestrzeni nazw. CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Maksymalna liczba sesji na nazwę uwierzytelniania. Wartość domyślna właściwości to 1.
Minimalna dozwolona wartość to 1, a maksymalna dozwolona wartość to 100.		 Int
maximumSessionExpiryInHours Maksymalny czas wygaśnięcia sesji w godzinach. Wartość domyślna właściwości to 1 godzina.
Minimalna dozwolona wartość to 1 godzina, a maksymalna dozwolona wartość to 8 godzin.		 Int
routeTopicResourceId W pełni kwalifikowany identyfikator zasobu platformy Azure dla tematu usługi Event Grid, do którego będą kierowane zdarzenia z przestrzeni tematów w przestrzeni nazw.
Ta właściwość powinna mieć następujący format :/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}".
Ten temat powinien znajdować się w tym samym regionie, w którym znajduje się przestrzeń nazw.		 struna
routingEnrichments Wzbogacanie routingu dla konfiguracji obszarów tematów RoutingEnrichments
routingIdentityInfo Informacje o tożsamości routingu dla konfiguracji przestrzeni tematów. RoutingIdentityInfo
stan Określ, czy dla przestrzeni nazw włączono konfigurację funkcji Miejsca do tematu. Wartość domyślna to Wyłączone. "Wyłączone"
"Włączone"

TrackedResourceTags

Nazwa Opis Wartość

UserIdentityProperties

Nazwa Opis Wartość
clientId Identyfikator klienta tożsamości przypisanej przez użytkownika. struna
principalId Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika. struna

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu przestrzeni nazw można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.EventGrid/namespaces, dodaj następujący program Terraform do szablonu.

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"
      }
    }
  })
}

Obiekty StaticRoutingEnrichment

Ustaw właściwość valueType, aby określić typ obiektu.

W przypadkuciągów użyj:

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

Wartości właściwości

ClientAuthenticationSettings

Nazwa Opis Wartość
alternativeAuthenticationNameSources Alternatywne źródła nazw uwierzytelniania związane z ustawieniami uwierzytelniania klienta dla zasobu przestrzeni nazw. Tablica ciągów zawierająca dowolną z:
"ClientCertificateDns"
"ClientCertificateEmail"
"ClientCertificateIp"
"ClientCertificateSubject"
"ClientCertificateUri"
customJwtAuthentication Niestandardowe ustawienia uwierzytelniania JWT dla zasobu przestrzeni nazw. CustomJwtAuthenticationSettings

ConnectionState

Nazwa Opis Wartość
actionsRequired Wymagane akcje (jeśli istnieją). struna
opis Opis stanu połączenia. struna
stan Stan połączenia. "Zatwierdzone"
"Rozłączono"
"Oczekujące"
"Odrzucono"

CustomDomainConfiguration

Nazwa Opis Wartość
certificateUrl Adres URL certyfikatu używanego do publikowania w domenie niestandardowej. Obecnie obsługujemy certyfikaty przechowywane tylko w usłudze Azure Key Vault. Adres URL certyfikatu może być dowolny
versioned URL następującego formatu https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, lub niewersyfikowany adres URL następującego formatu (np.
https://contosovault.vault.azure.net/certificates/contosocertobsługujemy tylko adres URL niewersji certyfikatu (np. https://contosovault.vault.azure.net/certificates/contosocert)		 struna
expectedTxtRecordName Oczekiwana nazwa rekordu TXT DNS. Usługa Event Grid sprawdzi rekord TXT o tej nazwie w zestawie rekordów DNS niestandardowej nazwy domeny, aby udowodnić własność domeny.
Wartości w tym rekordzie TXT muszą zawierać oczekiwaną wartość rekordu TXT.		 struna
expectedTxtRecordValue Oczekiwana wartość rekordu TXT DNS. Usługa Event Grid sprawdzi rekord TXT z tą wartością w zestawie rekordów DNS niestandardowej nazwy domeny, aby udowodnić własność domeny. struna
fullyQualifiedDomainName W pełni kwalifikowana nazwa domeny (FQDN) dla domeny niestandardowej. ciąg (wymagany)
tożsamość Informacje o tożsamości na potrzeby uzyskiwania dostępu do certyfikatu dla domeny niestandardowej. Te informacje o tożsamości muszą być zgodne z tożsamością ustawioną w przestrzeni nazw. CustomDomainIdentity
validationState Stan weryfikacji domeny niestandardowej. Jest to właściwość tylko do odczytu i jest początkowo ustawiona na wartość "Oczekiwanie" i zostanie zaktualizowana do wartości "Zatwierdzone" przez usługę Event Grid dopiero po pomyślnym zweryfikowaniu własności nazwy domeny. "Zatwierdzone"
"ErrorRetrievingDnsRecord"
"Oczekujące"

CustomDomainIdentity

Nazwa Opis Wartość
typ Używany typ tożsamości zarządzanej. Może mieć wartość "SystemAssigned" lub "UserAssigned". "SystemAssigned"
"UserAssigned"
userAssignedIdentity Tożsamość użytkownika skojarzona z zasobem. struna

CustomJwtAuthenticationManagedIdentity

Nazwa Opis Wartość
typ Używany typ tożsamości zarządzanej. Może mieć wartość "SystemAssigned" lub "UserAssigned". "SystemAssigned"
"UserAssigned" (wymagane)
userAssignedIdentity Tożsamość użytkownika skojarzona z zasobem. struna

CustomJwtAuthenticationSettings

Nazwa Opis Wartość
issuerCertificates Informacje o certyfikacie używanym do weryfikacji tokenu. Obecnie obsługujemy maksymalnie 2 certyfikaty. IssuerCertificateInfo[]
tokenIssuer Oczekiwany wystawca tokenu JWT. struna

DynamicRoutingEnrichment

Nazwa Opis Wartość
klucz Klucz wzbogacania routingu dynamicznego. struna
wartość Wartość wzbogacania routingu dynamicznego. struna

IdentityInfo

Nazwa Opis Wartość
principalId Identyfikator podmiotu zabezpieczeń tożsamości zasobu. struna
tenantId Identyfikator dzierżawy zasobu. struna
typ Używany typ tożsamości zarządzanej. Typ "SystemAssigned, UserAssigned" zawiera zarówno niejawnie utworzoną tożsamość, jak i zestaw tożsamości przypisanych przez użytkownika. Typ "None" usunie dowolną tożsamość. "Brak"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"
userAssignedIdentities Lista tożsamości użytkowników skojarzonych z zasobem. Odwołania do klucza słownika tożsamości użytkownika będą identyfikatorami zasobów usługi ARM w formularzu:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}".
Ta właściwość nie jest obecnie używana i zarezerwowana do użycia w przyszłości.		 IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Nazwa Opis Wartość

Ruch przychodzący irule

Nazwa Opis Wartość
akcja Akcja do wykonania na podstawie dopasowania lub braku dopasowania maski IpMask. "Zezwalaj"
maska ip Adres IP w notacji CIDR, np. 10.0.0.0/8. struna

IssuerCertificateInfo

Nazwa Opis Wartość
certificateUrl Adres URL certyfikatu usługi Keyvault w formacie https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. ciąg (wymagany)
tożsamość Tożsamość, która będzie używana do uzyskiwania dostępu do certyfikatu. CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/przestrzenie nazw

Nazwa Opis Wartość
tożsamość Informacje o tożsamości zasobu przestrzeni nazw. IdentityInfo
lokalizacja Lokalizacja zasobu. ciąg (wymagany)
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 3
Maksymalna długość = 3
Wzorzec = ^[a-zA-Z0-9-]*$ (wymagane)
Właściwości Właściwości zasobu Przestrzeni nazw. przestrzeni nazwWłaściwości
Numer jednostki magazynowej Reprezentuje dostępne warstwy cenowe jednostki SKU. Przestrzenie nazwSku
Tagi Tagi zasobów Słownik nazw tagów i wartości.
typ Typ zasobu "Microsoft.EventGrid/namespaces@2024-06-01-preview"

Przestrzeń nazwWłaściwości

Nazwa Opis Wartość
inboundIpRules Może to służyć do ograniczania ruchu z określonych adresów IP zamiast wszystkich adresów IP. Uwaga: Są one traktowane tylko wtedy, gdy funkcja PublicNetworkAccess jest włączona. inboundIpRule[]
isZoneRedundant Jest to właściwość opcjonalna i umożliwia użytkownikowi określenie, czy zasób przestrzeni nazw obsługuje funkcję nadmiarowości strefy, czy nie. Jeśli to
właściwość nie jest określona jawnie przez użytkownika. Jego wartość domyślna zależy od następujących warunków:
a. W przypadku regionów z włączonymi strefami dostępności — wartość właściwości domyślnej będzie prawdziwa.
b. W przypadku regionów z obsługą stref innych niż dostępność — domyślna wartość właściwości będzie fałszem.
Po określeniu tej właściwości nie można zaktualizować.		 Bool
minimumTlsVersionAllowed Minimalna wersja protokołu TLS wydawcy może być publikowana w tej przestrzeni nazw. Obsługiwane są tylko protokoły TLS w wersji 1.2. '1.0'
'1.1'
'1.2'
privateEndpointConnections Lista połączeń prywatnych punktów końcowych. PrivateEndpointConnection[]
publicNetworkAccess Określa, czy ruch jest dozwolony za pośrednictwem sieci publicznej. Domyślnie jest on włączony.
Możesz dodatkowo ograniczyć do określonych adresów IP, konfigurując <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" />		 "Wyłączone"
"Włączone"
"SecuredByPerimeter"
topicsConfiguration Informacje o konfiguracji tematów dla zasobu przestrzeni nazw TematyKonfiguracja
topicSpacesConfiguration Informacje o konfiguracji obszaru tematów dla zasobu przestrzeni nazw TopicSpacesConfiguration

Przestrzeń nazwSku

Nazwa Opis Wartość
pojemność Określa liczbę jednostek przepływności definiujących pojemność przestrzeni nazw. Wartość domyślna właściwości to
1, co oznacza 1 jednostkę przepływności = 1 MB/s ruchu przychodzącego i 2 MB/s ruchu wychodzącego na przestrzeń nazw. Minimalna pojemność to 1 i
maksymalna dozwolona pojemność to 20.		 Int
nazwa Nazwa jednostki SKU. "Standardowa"

PrivateEndpoint

Nazwa Opis Wartość
id Identyfikator usługi ARM dla prywatnego punktu końcowego. struna

PrivateEndpointConnection

Nazwa Opis Wartość
Właściwości Właściwości elementu PrivateEndpointConnection. PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Nazwa Opis Wartość
groupIds GroupIds z zasobu usługi łącza prywatnego. string[]
privateEndpoint Zasób prywatnego punktu końcowego dla tego połączenia. PrivateEndpoint
privateLinkServiceConnectionState Szczegółowe informacje o stanie połączenia. ConnectionState
provisioningState Stan aprowizacji połączenia prywatnego punktu końcowego. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"

RoutingEnrichments

Nazwa Opis Wartość
dynamiczny DynamicRoutingEnrichment[]
statyczny StaticRoutingEnrichment[]

RoutingIdentityInfo

Nazwa Opis Wartość
typ Typ tożsamości routingu dla konfiguracji miejsc tematów. "Brak"
"SystemAssigned"
"UserAssigned"
userAssignedIdentity struna

StaticRoutingEnrichment

Nazwa Opis Wartość
klucz Klucz wzbogacania routingu statycznego. struna
valueType Ustaw wartość "Ciąg" dla typu StaticStringRoutingEnrichment. "Ciąg" (wymagany)

StaticStringRoutingEnrichment

Nazwa Opis Wartość
wartość Wartość wzbogacania routingu typu ciągu. struna
valueType Typ wartości wzbogacania routingu statycznego. Na przykład ta wartość właściwości może mieć wartość "Ciąg". "Ciąg" (wymagany)

TematyKonfiguracja

Nazwa Opis Wartość
customDomains Lista konfiguracji domeny niestandardowej dla przestrzeni nazw. CustomDomainConfiguration[]

TopicSpacesConfiguration

Nazwa Opis Wartość
clientAuthentication Ustawienia uwierzytelniania klienta dla konfiguracji miejsc tematów. ClientAuthenticationSettings
customDomains Lista konfiguracji domeny niestandardowej dla przestrzeni nazw. CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName Maksymalna liczba sesji na nazwę uwierzytelniania. Wartość domyślna właściwości to 1.
Minimalna dozwolona wartość to 1, a maksymalna dozwolona wartość to 100.		 Int
maximumSessionExpiryInHours Maksymalny czas wygaśnięcia sesji w godzinach. Wartość domyślna właściwości to 1 godzina.
Minimalna dozwolona wartość to 1 godzina, a maksymalna dozwolona wartość to 8 godzin.		 Int
routeTopicResourceId W pełni kwalifikowany identyfikator zasobu platformy Azure dla tematu usługi Event Grid, do którego będą kierowane zdarzenia z przestrzeni tematów w przestrzeni nazw.
Ta właściwość powinna mieć następujący format :/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topics/{topicName}".
Ten temat powinien znajdować się w tym samym regionie, w którym znajduje się przestrzeń nazw.		 struna
routingEnrichments Wzbogacanie routingu dla konfiguracji obszarów tematów RoutingEnrichments
routingIdentityInfo Informacje o tożsamości routingu dla konfiguracji przestrzeni tematów. RoutingIdentityInfo
stan Określ, czy dla przestrzeni nazw włączono konfigurację funkcji Miejsca do tematu. Wartość domyślna to Wyłączone. "Wyłączone"
"Włączone"

TrackedResourceTags

Nazwa Opis Wartość

UserIdentityProperties

Nazwa Opis Wartość
clientId Identyfikator klienta tożsamości przypisanej przez użytkownika. struna
principalId Identyfikator podmiotu zabezpieczeń tożsamości przypisanej przez użytkownika. struna