Microsoft.EventGrid 命名空間 2024-12-15-preview

• 最新
• 2024-12-15-preview
• 2024-06-01-preview
• 2023-12-15-preview
• 2023-06-01-preview

Bicep 資源定義

命名空間資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.EventGrid/namespaces 資源，請將下列 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 物件

設定 valueType 屬性，以指定物件的類型。

針對 String，請使用：

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

屬性值

ClientAuthenticationSettings

名字	描述	價值
alternativeAuthenticationNameSources	與命名空間資源之客戶端驗證設定相關的替代驗證名稱來源。	包含任何的字串數組： 'ClientCertificateDns' 'ClientCertificateEmail' 'ClientCertificateIp' 'ClientCertificateSubject' 'ClientCertificateUri'
customJwtAuthentication	命名空間資源的自定義 JWT 驗證設定。	CustomJwtAuthenticationSettings

ConnectionState

名字	描述	價值
actionsRequired	需要動作（如果有的話）。	字串
描述	連接狀態的描述。	字串
地位	線上的狀態。	「已核准」 'Disconnected' 'Pending' 'Rejected'

CustomDomainConfiguration

名字	描述	價值
certificateUrl	用於發佈至自定義網域之憑證的 URL。 我們目前僅支持儲存在 Azure Key Vault 中的憑證。 雖然憑證 URL 可以是 下列格式的版本 URL https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}，或下列格式的未版本 URL（例如， https://contosovault.vault.azure.net/certificates/contosocert，我們僅支援未反轉的憑證 URL（例如，https://contosovault.vault.azure.net/certificates/contosocert）	字串
expectedTxtRecordName	預期的 DNS TXT 記錄名稱。 事件方格會在自定義功能變數名稱的 DNS 記錄集中檢查具有此名稱的 TXT 記錄，以證明網域擁有權。 此 TXT 記錄下的值必須包含預期的 TXT 記錄值。	字串
expectedTxtRecordValue	預期的 DNS TXT 記錄值。 事件方格會在自定義功能變數名稱的 DNS 記錄集中檢查 TXT 記錄，以證明網域擁有權。	字串
fullyQualifiedDomainName	自定義網域的完整功能變數名稱 （FQDN）。	字串 （必要）
身份	用於存取自定義網域憑證的身分識別資訊。 此身分識別信息必須符合已在命名空間上設定的身分識別。	CustomDomainIdentity
validationState	自訂網域的驗證狀態。 這是唯讀屬性，一開始設定為 「擱置」，且只有在成功驗證域名擁有權之後，事件方格才會更新為「已核准」。	「已核准」 'ErrorRetrievingDnsRecord' 'Pending'

CustomDomainIdentity

名字	描述	價值
類型	所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

CustomJwtAuthenticationManagedIdentity

名字	描述	價值
類型	所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。	'SystemAssigned' 'UserAssigned' （必要）
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

CustomJwtAuthenticationSettings

名字	描述	價值
encodedIssuerCertificates	用於自定義驗證的編碼公開憑證相關信息。	EncodedIssuerCertificateInfo[]
issuerCertificates	用於令牌驗證之憑證的相關信息。 我們目前支援最多 2 個憑證。	IssuerCertificateInfo[]
tokenIssuer	預期的 JWT 令牌簽發者。	字串

DynamicRoutingEnrichment

名字	描述	價值
鑰匙	動態路由擴充金鑰。	字串
價值	動態路由擴充值。	字串

EncodedIssuerCertificateInfo

名字	描述	價值
encodedCertificate	Pem 格式的憑證。	字串 （必要）
孩子	憑證的標識碼。	字串 （必要）

IdentityInfo

名字	描述	價值
principalId	資源識別的主要標識碼。	字串
tenantId	資源的租用戶標識碼。	字串
類型	所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned'
userAssignedIdentities	與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼： '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 此屬性目前未使用，並保留供日後使用。	IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

名字	描述	價值

InboundIpRule

名字	描述	價值
行動	根據相符專案或 IpMask 不相符執行的動作。	'Allow'
ipMask	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。	字串

IssuerCertificateInfo

名字	描述	價值
certificateUrl	https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion 格式的 Keyvault 憑證 URL。	字串 （必要）
身份	將用來存取憑證的身分識別。	CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

名字	描述	價值
身份	命名空間資源的識別資訊。	IdentityInfo
位置	資源的位置。	字串 （必要）
名字	資源名稱	字串 約束： 最小長度 = 3 最大長度 = 50 模式 = ^[a-zA-Z0-9-]*$ （必要）
性能	命名空間資源的屬性。	NamespaceProperties
sku	代表可用的 Sku 定價層。	NamespaceSku
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤

NamespaceProperties

名字	描述	價值
inboundIpRules	這可用來限制來自特定IP的流量，而不是所有IP的流量。 注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。	InboundIpRule[]
isZoneRedundant	這是選擇性屬性，可讓使用者指定命名空間資源是否支援區域備援功能。 如果發生這種情況 屬性不是由用戶明確指定，其預設值取決於下列條件： 一個。 針對已啟用可用性區域的區域 - 預設屬性值為 true。 b. 針對已啟用非可用性區域的區域 - 預設屬性值會是 false。 指定之後，就無法更新這個屬性。	bool
minimumTlsVersionAllowed	允許發行者的最低 TLS 版本發佈至此命名空間。 僅支援 TLS 1.2 版。	'1.0' '1.1' '1.2'
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 您可以藉由設定 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules” />	'Disabled' 'Enabled' 'SecuredByPerimeter'
topicsConfiguration	命名空間資源的主題組態資訊	TopicsConfiguration
topicSpacesConfiguration	命名空間資源的主題空間組態資訊	TopicSpacesConfiguration

NamespaceSku

名字	描述	價值
能力	指定定義命名空間容量的輸送量單位數目。 屬性預設值為 1 表示 1 個輸送量單位 = 1MB/秒輸入，以及每個命名空間 2MB/秒的輸出。 最小容量為 1 和 最大允許容量為 20。	int
名字	SKU 的名稱。	'Standard'

PrivateEndpoint

名字	描述	價值
id	私人端點的ARM標識碼。	字串

PrivateEndpointConnection

名字	描述	價值
性能	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名字	描述	價值
groupIds	Private Link 服務資源的 GroupId。	string[]
privateEndpoint	此連線的私人端點資源。	PrivateEndpoint
privateLinkServiceConnectionState	線上狀態的詳細數據。	ConnectionState
provisioningState	私人端點聯機的布建狀態。	'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing'

RoutingEnrichments

名字	描述	價值
動態		DynamicRoutingEnrichment[]
靜態的		StaticRoutingEnrichment[]

RoutingIdentityInfo

名字	描述	價值
類型	主題空間設定的路由識別類型。	'None' 'SystemAssigned' 'UserAssigned'
userAssignedIdentity		字串

StaticRoutingEnrichment

名字	描述	價值
鑰匙	靜態路由擴充密鑰。	字串
valueType	針對 staticStringRoutingEnrichment 類型設定為 'String'，。	'String' （必要）

StaticStringRoutingEnrichment

名字	描述	價值
價值	字串類型路由擴充值。	字串
valueType	靜態路由擴充值類型。 例如，這個屬性值可以是 『String』。	'String' （必要）

TopicsConfiguration

名字	描述	價值
customDomains	命名空間的自定義網域組態清單。	CustomDomainConfiguration[]

TopicSpacesConfiguration

名字	描述	價值
clientAuthentication	主題空間組態的客戶端驗證設定。	ClientAuthenticationSettings
customDomains	命名空間的自定義網域組態清單。	CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName	每個驗證名稱的會話數目上限。 屬性預設值為 1。 允許的最小值為 1，且允許的最大值為 100。	int
maximumSessionExpiryInHours	以小時為單位的會話到期上限。 屬性預設值為 1 小時。 允許的最小值為 1 小時，最大允許值為 8 小時。	int
routeTopicResourceId	事件方格主題的完整 Azure 資源識別符，事件將從命名空間下的 TopicSpaces 路由傳送至該主題。 此屬性的格式應該是 '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft。EventGrid/topics/{topicName}'。 本主題應該位於命名空間所在的相同區域中。	字串
routingEnrichments	主題空間設定的路由擴充	RoutingEnrichments
routingIdentityInfo	主題空間設定的路由識別資訊。	RoutingIdentityInfo
州	指出命名空間是否已啟用主題空間組態。 預設值為 Disabled。	'Disabled' 'Enabled'

TrackedResourceTags

名字	描述	價值

UserIdentityProperties

名字	描述	價值
clientId	使用者指派身分識別的用戶端標識碼。	字串
principalId	使用者指派身分識別的主體標識碼。	字串

ARM 樣本資源定義

命名空間資源類型可以使用目標作業來部署：

• 資源群組 - 請參閱 資源群組部署命令

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.EventGrid/namespaces 資源，請將下列 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 物件

設定 valueType 屬性，以指定物件的類型。

針對 String，請使用：

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

屬性值

ClientAuthenticationSettings

名字	描述	價值
alternativeAuthenticationNameSources	與命名空間資源之客戶端驗證設定相關的替代驗證名稱來源。	包含任何的字串數組： 'ClientCertificateDns' 'ClientCertificateEmail' 'ClientCertificateIp' 'ClientCertificateSubject' 'ClientCertificateUri'
customJwtAuthentication	命名空間資源的自定義 JWT 驗證設定。	CustomJwtAuthenticationSettings

ConnectionState

名字	描述	價值
actionsRequired	需要動作（如果有的話）。	字串
描述	連接狀態的描述。	字串
地位	線上的狀態。	「已核准」 'Disconnected' 'Pending' 'Rejected'

CustomDomainConfiguration

名字	描述	價值
certificateUrl	用於發佈至自定義網域之憑證的 URL。 我們目前僅支持儲存在 Azure Key Vault 中的憑證。 雖然憑證 URL 可以是 下列格式的版本 URL https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}，或下列格式的未版本 URL（例如， https://contosovault.vault.azure.net/certificates/contosocert，我們僅支援未反轉的憑證 URL（例如，https://contosovault.vault.azure.net/certificates/contosocert）	字串
expectedTxtRecordName	預期的 DNS TXT 記錄名稱。 事件方格會在自定義功能變數名稱的 DNS 記錄集中檢查具有此名稱的 TXT 記錄，以證明網域擁有權。 此 TXT 記錄下的值必須包含預期的 TXT 記錄值。	字串
expectedTxtRecordValue	預期的 DNS TXT 記錄值。 事件方格會在自定義功能變數名稱的 DNS 記錄集中檢查 TXT 記錄，以證明網域擁有權。	字串
fullyQualifiedDomainName	自定義網域的完整功能變數名稱 （FQDN）。	字串 （必要）
身份	用於存取自定義網域憑證的身分識別資訊。 此身分識別信息必須符合已在命名空間上設定的身分識別。	CustomDomainIdentity
validationState	自訂網域的驗證狀態。 這是唯讀屬性，一開始設定為 「擱置」，且只有在成功驗證域名擁有權之後，事件方格才會更新為「已核准」。	「已核准」 'ErrorRetrievingDnsRecord' 'Pending'

CustomDomainIdentity

名字	描述	價值
類型	所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

CustomJwtAuthenticationManagedIdentity

名字	描述	價值
類型	所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。	'SystemAssigned' 'UserAssigned' （必要）
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

CustomJwtAuthenticationSettings

名字	描述	價值
encodedIssuerCertificates	用於自定義驗證的編碼公開憑證相關信息。	EncodedIssuerCertificateInfo[]
issuerCertificates	用於令牌驗證之憑證的相關信息。 我們目前支援最多 2 個憑證。	IssuerCertificateInfo[]
tokenIssuer	預期的 JWT 令牌簽發者。	字串

DynamicRoutingEnrichment

名字	描述	價值
鑰匙	動態路由擴充金鑰。	字串
價值	動態路由擴充值。	字串

EncodedIssuerCertificateInfo

名字	描述	價值
encodedCertificate	Pem 格式的憑證。	字串 （必要）
孩子	憑證的標識碼。	字串 （必要）

IdentityInfo

名字	描述	價值
principalId	資源識別的主要標識碼。	字串
tenantId	資源的租用戶標識碼。	字串
類型	所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned'
userAssignedIdentities	與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼： '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 此屬性目前未使用，並保留供日後使用。	IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

名字	描述	價值

InboundIpRule

名字	描述	價值
行動	根據相符專案或 IpMask 不相符執行的動作。	'Allow'
ipMask	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。	字串

IssuerCertificateInfo

名字	描述	價值
certificateUrl	https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion 格式的 Keyvault 憑證 URL。	字串 （必要）
身份	將用來存取憑證的身分識別。	CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

名字	描述	價值
apiVersion	API 版本	'2024-12-15-preview'
身份	命名空間資源的識別資訊。	IdentityInfo
位置	資源的位置。	字串 （必要）
名字	資源名稱	字串 約束： 最小長度 = 3 最大長度 = 50 模式 = ^[a-zA-Z0-9-]*$ （必要）
性能	命名空間資源的屬性。	NamespaceProperties
sku	代表可用的 Sku 定價層。	NamespaceSku
標籤	資源標籤	標記名稱和值的字典。 請參閱範本中的 標籤
類型	資源類型	'Microsoft.EventGrid/namespaces'

NamespaceProperties

名字	描述	價值
inboundIpRules	這可用來限制來自特定IP的流量，而不是所有IP的流量。 注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。	InboundIpRule[]
isZoneRedundant	這是選擇性屬性，可讓使用者指定命名空間資源是否支援區域備援功能。 如果發生這種情況 屬性不是由用戶明確指定，其預設值取決於下列條件： 一個。 針對已啟用可用性區域的區域 - 預設屬性值為 true。 b. 針對已啟用非可用性區域的區域 - 預設屬性值會是 false。 指定之後，就無法更新這個屬性。	bool
minimumTlsVersionAllowed	允許發行者的最低 TLS 版本發佈至此命名空間。 僅支援 TLS 1.2 版。	'1.0' '1.1' '1.2'
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 您可以藉由設定 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules” />	'Disabled' 'Enabled' 'SecuredByPerimeter'
topicsConfiguration	命名空間資源的主題組態資訊	TopicsConfiguration
topicSpacesConfiguration	命名空間資源的主題空間組態資訊	TopicSpacesConfiguration

NamespaceSku

名字	描述	價值
能力	指定定義命名空間容量的輸送量單位數目。 屬性預設值為 1 表示 1 個輸送量單位 = 1MB/秒輸入，以及每個命名空間 2MB/秒的輸出。 最小容量為 1 和 最大允許容量為 20。	int
名字	SKU 的名稱。	'Standard'

PrivateEndpoint

名字	描述	價值
id	私人端點的ARM標識碼。	字串

PrivateEndpointConnection

名字	描述	價值
性能	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名字	描述	價值
groupIds	Private Link 服務資源的 GroupId。	string[]
privateEndpoint	此連線的私人端點資源。	PrivateEndpoint
privateLinkServiceConnectionState	線上狀態的詳細數據。	ConnectionState
provisioningState	私人端點聯機的布建狀態。	'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing'

RoutingEnrichments

名字	描述	價值
動態		DynamicRoutingEnrichment[]
靜態的		StaticRoutingEnrichment[]

RoutingIdentityInfo

名字	描述	價值
類型	主題空間設定的路由識別類型。	'None' 'SystemAssigned' 'UserAssigned'
userAssignedIdentity		字串

StaticRoutingEnrichment

名字	描述	價值
鑰匙	靜態路由擴充密鑰。	字串
valueType	針對 staticStringRoutingEnrichment 類型設定為 'String'，。	'String' （必要）

StaticStringRoutingEnrichment

名字	描述	價值
價值	字串類型路由擴充值。	字串
valueType	靜態路由擴充值類型。 例如，這個屬性值可以是 『String』。	'String' （必要）

TopicsConfiguration

名字	描述	價值
customDomains	命名空間的自定義網域組態清單。	CustomDomainConfiguration[]

TopicSpacesConfiguration

名字	描述	價值
clientAuthentication	主題空間組態的客戶端驗證設定。	ClientAuthenticationSettings
customDomains	命名空間的自定義網域組態清單。	CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName	每個驗證名稱的會話數目上限。 屬性預設值為 1。 允許的最小值為 1，且允許的最大值為 100。	int
maximumSessionExpiryInHours	以小時為單位的會話到期上限。 屬性預設值為 1 小時。 允許的最小值為 1 小時，最大允許值為 8 小時。	int
routeTopicResourceId	事件方格主題的完整 Azure 資源識別符，事件將從命名空間下的 TopicSpaces 路由傳送至該主題。 此屬性的格式應該是 '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft。EventGrid/topics/{topicName}'。 本主題應該位於命名空間所在的相同區域中。	字串
routingEnrichments	主題空間設定的路由擴充	RoutingEnrichments
routingIdentityInfo	主題空間設定的路由識別資訊。	RoutingIdentityInfo
州	指出命名空間是否已啟用主題空間組態。 預設值為 Disabled。	'Disabled' 'Enabled'

TrackedResourceTags

名字	描述	價值

UserIdentityProperties

名字	描述	價值
clientId	使用者指派身分識別的用戶端標識碼。	字串
principalId	使用者指派身分識別的主體標識碼。	字串

Terraform （AzAPI 提供者） 資源定義

命名空間資源類型可以使用目標作業來部署：

• 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.EventGrid/namespaces 資源，請將下列 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 物件

設定 valueType 屬性，以指定物件的類型。

針對 String，請使用：

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

屬性值

ClientAuthenticationSettings

名字	描述	價值
alternativeAuthenticationNameSources	與命名空間資源之客戶端驗證設定相關的替代驗證名稱來源。	包含任何的字串數組： 'ClientCertificateDns' 'ClientCertificateEmail' 'ClientCertificateIp' 'ClientCertificateSubject' 'ClientCertificateUri'
customJwtAuthentication	命名空間資源的自定義 JWT 驗證設定。	CustomJwtAuthenticationSettings

ConnectionState

名字	描述	價值
actionsRequired	需要動作（如果有的話）。	字串
描述	連接狀態的描述。	字串
地位	線上的狀態。	「已核准」 'Disconnected' 'Pending' 'Rejected'

CustomDomainConfiguration

名字	描述	價值
certificateUrl	用於發佈至自定義網域之憑證的 URL。 我們目前僅支持儲存在 Azure Key Vault 中的憑證。 雖然憑證 URL 可以是 下列格式的版本 URL https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}，或下列格式的未版本 URL（例如， https://contosovault.vault.azure.net/certificates/contosocert，我們僅支援未反轉的憑證 URL（例如，https://contosovault.vault.azure.net/certificates/contosocert）	字串
expectedTxtRecordName	預期的 DNS TXT 記錄名稱。 事件方格會在自定義功能變數名稱的 DNS 記錄集中檢查具有此名稱的 TXT 記錄，以證明網域擁有權。 此 TXT 記錄下的值必須包含預期的 TXT 記錄值。	字串
expectedTxtRecordValue	預期的 DNS TXT 記錄值。 事件方格會在自定義功能變數名稱的 DNS 記錄集中檢查 TXT 記錄，以證明網域擁有權。	字串
fullyQualifiedDomainName	自定義網域的完整功能變數名稱 （FQDN）。	字串 （必要）
身份	用於存取自定義網域憑證的身分識別資訊。 此身分識別信息必須符合已在命名空間上設定的身分識別。	CustomDomainIdentity
validationState	自訂網域的驗證狀態。 這是唯讀屬性，一開始設定為 「擱置」，且只有在成功驗證域名擁有權之後，事件方格才會更新為「已核准」。	「已核准」 'ErrorRetrievingDnsRecord' 'Pending'

CustomDomainIdentity

名字	描述	價值
類型	所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

CustomJwtAuthenticationManagedIdentity

名字	描述	價值
類型	所使用的受控識別類型。 可以是 'SystemAssigned' 或 'UserAssigned'。	'SystemAssigned' 'UserAssigned' （必要）
userAssignedIdentity	與資源相關聯的使用者身分識別。	字串

CustomJwtAuthenticationSettings

名字	描述	價值
encodedIssuerCertificates	用於自定義驗證的編碼公開憑證相關信息。	EncodedIssuerCertificateInfo[]
issuerCertificates	用於令牌驗證之憑證的相關信息。 我們目前支援最多 2 個憑證。	IssuerCertificateInfo[]
tokenIssuer	預期的 JWT 令牌簽發者。	字串

DynamicRoutingEnrichment

名字	描述	價值
鑰匙	動態路由擴充金鑰。	字串
價值	動態路由擴充值。	字串

EncodedIssuerCertificateInfo

名字	描述	價值
encodedCertificate	Pem 格式的憑證。	字串 （必要）
孩子	憑證的標識碼。	字串 （必要）

IdentityInfo

名字	描述	價值
principalId	資源識別的主要標識碼。	字串
tenantId	資源的租用戶標識碼。	字串
類型	所使用的受控識別類型。 類型 'SystemAssigned， UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 將會移除任何身分識別。	'None' 'SystemAssigned' 'SystemAssigned， UserAssigned' 'UserAssigned'
userAssignedIdentities	與資源相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源識別碼： '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 此屬性目前未使用，並保留供日後使用。	IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

名字	描述	價值

InboundIpRule

名字	描述	價值
行動	根據相符專案或 IpMask 不相符執行的動作。	'Allow'
ipMask	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。	字串

IssuerCertificateInfo

名字	描述	價值
certificateUrl	https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion 格式的 Keyvault 憑證 URL。	字串 （必要）
身份	將用來存取憑證的身分識別。	CustomJwtAuthenticationManagedIdentity

Microsoft.EventGrid/namespaces

名字	描述	價值
身份	命名空間資源的識別資訊。	IdentityInfo
位置	資源的位置。	字串 （必要）
名字	資源名稱	字串 約束： 最小長度 = 3 最大長度 = 50 模式 = ^[a-zA-Z0-9-]*$ （必要）
性能	命名空間資源的屬性。	NamespaceProperties
sku	代表可用的 Sku 定價層。	NamespaceSku
標籤	資源標籤	標記名稱和值的字典。
類型	資源類型	“Microsoft.EventGrid/namespaces@2024-12-15-preview”

NamespaceProperties

名字	描述	價值
inboundIpRules	這可用來限制來自特定IP的流量，而不是所有IP的流量。 注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。	InboundIpRule[]
isZoneRedundant	這是選擇性屬性，可讓使用者指定命名空間資源是否支援區域備援功能。 如果發生這種情況 屬性不是由用戶明確指定，其預設值取決於下列條件： 一個。 針對已啟用可用性區域的區域 - 預設屬性值為 true。 b. 針對已啟用非可用性區域的區域 - 預設屬性值會是 false。 指定之後，就無法更新這個屬性。	bool
minimumTlsVersionAllowed	允許發行者的最低 TLS 版本發佈至此命名空間。 僅支援 TLS 1.2 版。	'1.0' '1.1' '1.2'
privateEndpointConnections	私人端點連線的清單。	PrivateEndpointConnection[]
publicNetworkAccess	這會判斷是否允許透過公用網路傳輸流量。 默認會啟用。 您可以藉由設定 <seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules” />	'Disabled' 'Enabled' 'SecuredByPerimeter'
topicsConfiguration	命名空間資源的主題組態資訊	TopicsConfiguration
topicSpacesConfiguration	命名空間資源的主題空間組態資訊	TopicSpacesConfiguration

NamespaceSku

名字	描述	價值
能力	指定定義命名空間容量的輸送量單位數目。 屬性預設值為 1 表示 1 個輸送量單位 = 1MB/秒輸入，以及每個命名空間 2MB/秒的輸出。 最小容量為 1 和 最大允許容量為 20。	int
名字	SKU 的名稱。	'Standard'

PrivateEndpoint

名字	描述	價值
id	私人端點的ARM標識碼。	字串

PrivateEndpointConnection

名字	描述	價值
性能	PrivateEndpointConnection 的屬性。	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

名字	描述	價值
groupIds	Private Link 服務資源的 GroupId。	string[]
privateEndpoint	此連線的私人端點資源。	PrivateEndpoint
privateLinkServiceConnectionState	線上狀態的詳細數據。	ConnectionState
provisioningState	私人端點聯機的布建狀態。	'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing'

RoutingEnrichments

名字	描述	價值
動態		DynamicRoutingEnrichment[]
靜態的		StaticRoutingEnrichment[]

RoutingIdentityInfo

名字	描述	價值
類型	主題空間設定的路由識別類型。	'None' 'SystemAssigned' 'UserAssigned'
userAssignedIdentity		字串

StaticRoutingEnrichment

名字	描述	價值
鑰匙	靜態路由擴充密鑰。	字串
valueType	針對 staticStringRoutingEnrichment 類型設定為 'String'，。	'String' （必要）

StaticStringRoutingEnrichment

名字	描述	價值
價值	字串類型路由擴充值。	字串
valueType	靜態路由擴充值類型。 例如，這個屬性值可以是 『String』。	'String' （必要）

TopicsConfiguration

名字	描述	價值
customDomains	命名空間的自定義網域組態清單。	CustomDomainConfiguration[]

TopicSpacesConfiguration

名字	描述	價值
clientAuthentication	主題空間組態的客戶端驗證設定。	ClientAuthenticationSettings
customDomains	命名空間的自定義網域組態清單。	CustomDomainConfiguration[]
maximumClientSessionsPerAuthenticationName	每個驗證名稱的會話數目上限。 屬性預設值為 1。 允許的最小值為 1，且允許的最大值為 100。	int
maximumSessionExpiryInHours	以小時為單位的會話到期上限。 屬性預設值為 1 小時。 允許的最小值為 1 小時，最大允許值為 8 小時。	int
routeTopicResourceId	事件方格主題的完整 Azure 資源識別符，事件將從命名空間下的 TopicSpaces 路由傳送至該主題。 此屬性的格式應該是 '/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft。EventGrid/topics/{topicName}'。 本主題應該位於命名空間所在的相同區域中。	字串
routingEnrichments	主題空間設定的路由擴充	RoutingEnrichments
routingIdentityInfo	主題空間設定的路由識別資訊。	RoutingIdentityInfo
州	指出命名空間是否已啟用主題空間組態。 預設值為 Disabled。	'Disabled' 'Enabled'

TrackedResourceTags

名字	描述	價值

UserIdentityProperties

名字	描述	價值
clientId	使用者指派身分識別的用戶端標識碼。	字串
principalId	使用者指派身分識別的主體標識碼。	字串