Microsoft.EventGrid 主題 2021-06-01-preview

發行項
01/15/2024

Bicep 資源定義

主題資源類型可以使用目標作業進行部署：

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

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

資源格式

若要建立 Microsoft.EventGrid/topics 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.EventGrid/topics@2021-06-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  kind: 'string'
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    disableLocalAuth: bool
    inboundIpRules: [
      {
        action: 'Allow'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    publicNetworkAccess: 'string'
  }
}

InputSchemaMapping 物件

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

針對 Json，請使用：

  inputSchemaMappingType: 'Json'
  properties: {
    dataVersion: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    eventTime: {
      sourceField: 'string'
    }
    eventType: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    id: {
      sourceField: 'string'
    }
    subject: {
      defaultValue: 'string'
      sourceField: 'string'
    }
    topic: {
      sourceField: 'string'
    }
  }

屬性值

topics

名稱	描述	值
NAME	資源名稱	字串 (必要) 字元限制：3-50 合法字元：英數字元和連字號。
location	資源的位置。	字串 (必要)
tags	資源的標記。	標記名稱和值的字典。請參閱範本中的標記
sku	主題的 SKU 定價層。	ResourceSku
kind	資源的種類。	'Azure' 'AzureArc'
extendedLocation	資源的擴充位置。	ExtendedLocation
身分識別	資源的身分識別資訊。	IdentityInfo
properties	主題的屬性。	TopicProperties

ExtendedLocation

名稱	描述	值
NAME	擴充位置的完整名稱。	字串
type	擴充位置的類型。	字串

IdentityInfo

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

IdentityInfoUserAssignedIdentities

名稱	描述	值
{自定義屬性}		UserIdentityProperties

UserIdentityProperties

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

TopicProperties

名稱	描述	值
disableLocalAuth	此布爾值是用來啟用或停用本機驗證。默認值為 false。當屬性設定為 true 時，如果允許使用者發佈至主題，則只會使用 AAD 令牌來驗證。	bool
inboundIpRules	這可用來限制來自特定IP的流量，而不是所有IP。注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。	InboundIpRule[]
inputSchema	這會決定事件方格應該預期發行至主題之傳入事件的格式。	'CloudEventSchemaV1_0' 'CustomEventSchema' 'EventGridSchema'
inputSchemaMapping	這可讓您使用自定義事件架構進行發佈。您可以指定 InputSchemaMapping，將來源架構的各種屬性對應至 EventGridEvent 架構的各種必要屬性。	InputSchemaMapping
publicNetworkAccess	這會判斷是否允許透過公用網路使用流量。默認會啟用。您可以設定 {seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” /} 來進一步限制特定 IP	'Disabled' 'Enabled'

InboundIpRule

名稱	描述	值
動作	要根據比對或不符合 IpMask 執行的動作。	'Allow'
ipMask	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。	字串

InputSchemaMapping

名稱	描述	值
inputSchemaMappingType	設定物件類型	需要 Json ()

JsonInputSchemaMapping

名稱	描述	值
inputSchemaMappingType	自定義對應的類型	'Json' (必要)
properties	輸入架構對應的 JSON 屬性	JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

名稱	描述	值
dataVersion	Event Grid 事件之 DataVersion 屬性的對應資訊。	JsonFieldWithDefault
eventTime	Event Grid 事件之 EventTime 屬性的對應資訊。	JsonField
eventType	Event Grid 事件之 EventType 屬性的對應資訊。	JsonFieldWithDefault
id	Event Grid 事件之 Id 屬性的對應資訊。	JsonField
主旨	Event Grid 事件之 Subject 屬性的對應資訊。	JsonFieldWithDefault
主題	Event Grid 事件之 Topic 屬性的對應資訊。	JsonField

JsonFieldWithDefault

名稱	描述	值
defaultValue	未提供 SourceField 時要用於對應的預設值，或者如果已發布 JSON 事件承載中沒有具有指定名稱的屬性，則為。	字串
sourceField	輸入事件架構中要作為對應來源的功能變數名稱。	字串

JsonField

名稱	描述	值
sourceField	輸入事件架構中要作為對應來源的功能變數名稱。	字串

ResourceSku

名稱	描述	值
NAME	資源的 SKU 名稱。可能的值為：基本或進階。	'Basic' 'Premium'

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
建立自定義主題和訂用帳戶 Azure 事件方格	建立 Azure 事件方格自定義主題和 Webhook 訂用帳戶。最初由John Downs撰寫的範本。
使用 CloudEvents 自定義 Azure 事件方格主題/訂用帳戶	建立自定義 Azure 事件方格主題、具有 CloudEvents 架構的 Webhook 訂用帳戶，以及邏輯應用程式作為事件處理程式。最初由 Justin Yoo 撰寫的範本。
建立事件方格自定義主題和事件中樞處理程式	建立 Azure 事件方格自定義主題和事件中樞來處理事件。
建立自定義主題和佇列訂用帳戶 Azure 事件方格	建立 Azure 事件方格自定義主題和服務總線佇列訂用帳戶。最初由 Markus Meyer 撰寫的範本。
建立自定義主題訂用帳戶 Azure 事件方格	建立 Azure 事件方格自定義主題和服務總線主題訂用帳戶。最初由 Markus Meyer 撰寫的範本。

ARM 範本資源定義

主題資源類型可以使用目標作業進行部署：

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

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

資源格式

若要建立 Microsoft.EventGrid/topics 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.EventGrid/topics",
  "apiVersion": "2021-06-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "kind": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "disableLocalAuth": "bool",
    "inboundIpRules": [
      {
        "action": "Allow",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "publicNetworkAccess": "string"
  }
}

InputSchemaMapping 物件

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

針對 Json，請使用：

  "inputSchemaMappingType": "Json",
  "properties": {
    "dataVersion": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "eventTime": {
      "sourceField": "string"
    },
    "eventType": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "id": {
      "sourceField": "string"
    },
    "subject": {
      "defaultValue": "string",
      "sourceField": "string"
    },
    "topic": {
      "sourceField": "string"
    }
  }

屬性值

topics

名稱	描述	值
類型	資源類型	'Microsoft.EventGrid/topics'
apiVersion	資源 API 版本	'2021-06-01-preview'
NAME	資源名稱	字串 (必要) 字元限制：3-50 合法字元：英數字元和連字號。
location	資源的位置。	字串 (必要)
tags	資源的標記。	標記名稱和值的字典。請參閱範本中的標記
sku	主題的 SKU 定價層。	ResourceSku
kind	資源的種類。	'Azure' 'AzureArc'
extendedLocation	資源的擴充位置。	ExtendedLocation
身分識別	資源的身分識別資訊。	IdentityInfo
properties	主題的屬性。	TopicProperties

ExtendedLocation

名稱	描述	值
NAME	擴充位置的完整名稱。	字串
type	擴充位置的類型。	字串

IdentityInfo

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

IdentityInfoUserAssignedIdentities

名稱	描述	值
{自定義屬性}		UserIdentityProperties

UserIdentityProperties

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

TopicProperties

名稱	描述	值
disableLocalAuth	此布爾值是用來啟用或停用本機驗證。默認值為 false。當屬性設定為 true 時，如果允許使用者發佈至主題，則只會使用 AAD 令牌來驗證。	bool
inboundIpRules	這可用來限制來自特定IP的流量，而不是所有IP。注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。	InboundIpRule[]
inputSchema	這會決定事件方格應該預期發行至主題之傳入事件的格式。	'CloudEventSchemaV1_0' 'CustomEventSchema' 'EventGridSchema'
inputSchemaMapping	這可讓您使用自定義事件架構進行發佈。您可以指定 InputSchemaMapping，將來源架構的各種屬性對應至 EventGridEvent 架構的各種必要屬性。	InputSchemaMapping
publicNetworkAccess	這會判斷是否允許透過公用網路使用流量。默認會啟用。您可以設定 {seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” /} 來進一步限制特定 IP	'Disabled' 'Enabled'

InboundIpRule

名稱	描述	值
動作	要根據比對或不符合 IpMask 執行的動作。	'Allow'
ipMask	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。	字串

InputSchemaMapping

名稱	描述	值
inputSchemaMappingType	設定物件類型	需要 Json ()

JsonInputSchemaMapping

名稱	描述	值
inputSchemaMappingType	自定義對應的類型	'Json' (必要)
properties	輸入架構對應的 JSON 屬性	JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

名稱	描述	值
dataVersion	Event Grid 事件之 DataVersion 屬性的對應資訊。	JsonFieldWithDefault
eventTime	Event Grid 事件之 EventTime 屬性的對應資訊。	JsonField
eventType	Event Grid 事件之 EventType 屬性的對應資訊。	JsonFieldWithDefault
id	Event Grid 事件之 Id 屬性的對應資訊。	JsonField
主旨	Event Grid 事件之 Subject 屬性的對應資訊。	JsonFieldWithDefault
主題	Event Grid 事件之 Topic 屬性的對應資訊。	JsonField

JsonFieldWithDefault

名稱	描述	值
defaultValue	未提供SourceField時要用於對應的預設值，或在已發佈的 JSON 事件承載中沒有具有指定名稱的屬性時使用。	字串
sourceField	輸入事件架構中要作為對應來源的功能變數名稱。	字串

JsonField

名稱	描述	值
sourceField	輸入事件架構中要作為對應來源的功能變數名稱。	字串

ResourceSku

名稱	描述	值
NAME	資源的 SKU 名稱。可能的值為：基本或進階。	'Basic' 'Premium'

快速入門範本

下列快速入門範本會部署此資源類型。

範本	描述
建立自定義主題和訂用帳戶 Azure 事件方格	建立 Azure 事件方格自定義主題和 Webhook 訂用帳戶。最初由John Downs撰寫的範本。
使用 CloudEvents 自定義 Azure 事件方格主題/訂用帳戶	建立自定義 Azure 事件方格主題、具有 CloudEvents 架構的 Webhook 訂用帳戶，以及邏輯應用程式作為事件處理程式。最初由 Justin Yoo 撰寫的範本。
建立事件方格自定義主題和事件中樞處理程式	建立 Azure 事件方格自定義主題和事件中樞來處理事件。
建立自定義主題和佇列訂用帳戶 Azure 事件方格	建立 Azure 事件方格自定義主題和服務總線佇列訂用帳戶。最初由 Markus Meyer 撰寫的範本。
建立自定義主題訂用帳戶 Azure 事件方格	建立 Azure 事件方格自定義主題和服務總線主題訂用帳戶。最初由 Markus Meyer 撰寫的範本。

Terraform (AzAPI 提供者) 資源定義

主題資源類型可以使用目標作業進行部署：

資源群組

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

資源格式

若要建立 Microsoft.EventGrid/topics 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/topics@2021-06-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      disableLocalAuth = bool
      inboundIpRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      publicNetworkAccess = "string"
    }
    sku = {
      name = "string"
    }
    kind = "string"
    extendedLocation = {
      name = "string"
      type = "string"
    }
  })
}

InputSchemaMapping 物件

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

針對 Json，請使用：

  inputSchemaMappingType = "Json"
  properties = {
    dataVersion = {
      defaultValue = "string"
      sourceField = "string"
    }
    eventTime = {
      sourceField = "string"
    }
    eventType = {
      defaultValue = "string"
      sourceField = "string"
    }
    id = {
      sourceField = "string"
    }
    subject = {
      defaultValue = "string"
      sourceField = "string"
    }
    topic = {
      sourceField = "string"
    }
  }

屬性值

topics

名稱	描述	值
類型	資源類型	“Microsoft.EventGrid/topics@2021-06-01-preview”
NAME	資源名稱	字串 (必要) 字元限制：3-50 合法字元：英數字元和連字號。
location	資源的位置。	字串 (必要)
parent_id	若要部署至資源群組，請使用該資源群組的標識碼。	字串 (必要)
tags	資源的標記。	標記名稱和值的字典。
sku	主題的 SKU 定價層。	ResourceSku
kind	資源的種類。	“Azure” “AzureArc”
extendedLocation	資源的擴充位置。	ExtendedLocation
身分識別	資源的身分識別資訊。	IdentityInfo
properties	主題的屬性。	TopicProperties

ExtendedLocation

名稱	描述	值
NAME	擴充位置的完整名稱。	字串
type	擴充位置的類型。	字串

IdentityInfo

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

IdentityInfoUserAssignedIdentities

名稱	描述	值
{自定義屬性}		UserIdentityProperties

UserIdentityProperties

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

TopicProperties

名稱	描述	值
disableLocalAuth	此布爾值是用來啟用或停用本機驗證。默認值為 false。當屬性設定為 true 時，如果允許使用者發佈至主題，則只會使用 AAD 令牌來驗證。	bool
inboundIpRules	這可用來限制來自特定IP的流量，而不是所有IP。注意：只有在啟用 PublicNetworkAccess 時，才會考慮這些專案。	InboundIpRule[]
inputSchema	這會決定事件方格應該預期發行至主題之傳入事件的格式。	“CloudEventSchemaV1_0” “CustomEventSchema” “EventGridSchema”
inputSchemaMapping	這可讓您使用自定義事件架構進行發佈。您可以指定 InputSchemaMapping，將來源架構的各種屬性對應至 EventGridEvent 架構的各種必要屬性。	InputSchemaMapping
publicNetworkAccess	這會判斷是否允許透過公用網路使用流量。默認會啟用。您可以設定 {seealso cref=“P：Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.InboundIpRules” /} 來進一步限制特定 IP	“Disabled” “Enabled”

InboundIpRule

名稱	描述	值
動作	要根據比對或不符合 IpMask 執行的動作。	“允許”
ipMask	CIDR 表示法中的IP位址，例如10.0.0.0.0/8。	字串

InputSchemaMapping

名稱	描述	值
inputSchemaMappingType	設定物件類型	需要 Json ()

JsonInputSchemaMapping

名稱	描述	值
inputSchemaMappingType	自定義對應的類型	必要) 「Json」 (
properties	輸入架構對應的 JSON 屬性	JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

名稱	描述	值
dataVersion	Event Grid 事件之 DataVersion 屬性的對應資訊。	JsonFieldWithDefault
eventTime	Event Grid 事件之 EventTime 屬性的對應資訊。	JsonField
eventType	Event Grid 事件之 EventType 屬性的對應資訊。	JsonFieldWithDefault
id	Event Grid 事件之 Id 屬性的對應資訊。	JsonField
主旨	Event Grid 事件之 Subject 屬性的對應資訊。	JsonFieldWithDefault
主題	Event Grid 事件之 Topic 屬性的對應資訊。	JsonField

JsonFieldWithDefault

名稱	描述	值
defaultValue	未提供SourceField時要用於對應的預設值，或在已發佈的 JSON 事件承載中沒有具有指定名稱的屬性時使用。	字串
sourceField	輸入事件架構中要作為對應來源的功能變數名稱。	字串

JsonField

名稱	描述	值
sourceField	輸入事件架構中要作為對應來源的功能變數名稱。	字串

ResourceSku

名稱	描述	值
NAME	資源的 SKU 名稱。可能的值為：基本或進階。	"Basic" “Premium”

共用方式為

Microsoft.EventGrid 主題 2021-06-01-preview

Bicep 資源定義

資源格式

InputSchemaMapping 物件

屬性值

topics

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

TopicProperties

InboundIpRule

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

ResourceSku

快速入門範本

ARM 範本資源定義

資源格式

InputSchemaMapping 物件

屬性值

topics

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

TopicProperties

InboundIpRule

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

ResourceSku

快速入門範本

Terraform (AzAPI 提供者) 資源定義

資源格式

InputSchemaMapping 物件

屬性值

topics

ExtendedLocation

IdentityInfo

IdentityInfoUserAssignedIdentities

UserIdentityProperties

TopicProperties

InboundIpRule

InputSchemaMapping

JsonInputSchemaMapping

JsonInputSchemaMappingProperties

JsonFieldWithDefault

JsonField

ResourceSku

意見反應

其他資源