Microsoft.EventGrid partnerTopics 2023-12-15-preview
Bicep 資源定義
partnerTopics 資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.EventGrid/partnerTopics 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.EventGrid/partnerTopics@2023-12-15-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
properties: {
activationState: 'string'
eventTypeInfo: {
inlineEventTypes: {
{customized property}: {
dataSchemaUrl: 'string'
description: 'string'
displayName: 'string'
documentationUrl: 'string'
}
}
kind: 'Inline'
}
expirationTimeIfNotActivatedUtc: 'string'
messageForActivation: 'string'
partnerRegistrationImmutableId: 'string'
partnerTopicFriendlyDescription: 'string'
source: 'string'
}
}
屬性值
partnerTopics
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 | 需要字串 () |
| location | 資源的位置。 | 需要字串 () |
| tags | 資源的標記。 | 標記名稱和值的字典。 請參閱 範本中的標籤 |
| 身分識別 | 合作夥伴主題資源的身分識別資訊。 | IdentityInfo |
| properties | 合作夥伴主題的屬性。 | PartnerTopicProperties |
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 | 使用者指派身分識別的主體標識碼。 | 字串 |
PartnerTopicProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| activationState | 合作夥伴主題的啟用狀態。 | 'Activated' 'Deactivated' 'NeverActivated' |
| eventTypeInfo | 來自對應事件通道的事件類型資訊。 | EventTypeInfo |
| expirationTimeIfNotActivatedUtc | 合作夥伴主題的到期時間。 如果此定時器在合作夥伴主題仍然未啟用時到期，則為 刪除合作夥伴主題和對應的事件通道。 |
字串 |
| messageForActivation | 訂閱者在核准程序期間可以使用的內容或實用訊息。 | 字串 |
| partnerRegistrationImmutableId | 對應夥伴註冊的 immutableId。 | 字串 約束： 最小長度 = 36 最大長度 = 36 模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| partnerTopicFriendlyDescription | 關於主題的易記描述。 這可由發行者/合作夥伴設定，以顯示客戶合作夥伴主題的自定義描述。 這有助於移除客戶建立合作夥伴主題來源的任何模棱兩可。 |
字串 |
| source | 與此合作夥伴主題相關聯的來源。 這代表唯一的合作夥伴資源。 | 字串 |
EventTypeInfo
| 名稱 | 描述 | 值 |
|---|---|---|
| inlineEventTypes | 資源的內嵌事件類型集合。 內嵌事件類型索引鍵的類型字串，代表事件的名稱。 有效的內嵌事件名稱範例是 「Contoso.OrderCreated」。。 內嵌事件類型值的類型為 InlineEventProperties，而且會包含每個內嵌事件類型的其他資訊。 |
EventTypeInfoInlineEventTypes |
| kind | 所使用的事件類型。 | 'Inline' |
EventTypeInfoInlineEventTypes
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | InlineEventProperties |
InlineEventProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| dataSchemaUrl | 內嵌事件的 dataSchemaUrl。 | 字串 |
| description | 內嵌事件的描述。 | 字串 |
| displayName | 內嵌事件的 displayName。 | 字串 |
| documentationUrl | 內嵌事件的 documentationUrl。 | 字串 |
ARM 範本資源定義
partnerTopics 資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.EventGrid/partnerTopics 資源，請將下列 JSON 新增至您的範本。
{
"type": "Microsoft.EventGrid/partnerTopics",
"apiVersion": "2023-12-15-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"properties": {
"activationState": "string",
"eventTypeInfo": {
"inlineEventTypes": {
"{customized property}": {
"dataSchemaUrl": "string",
"description": "string",
"displayName": "string",
"documentationUrl": "string"
}
},
"kind": "Inline"
},
"expirationTimeIfNotActivatedUtc": "string",
"messageForActivation": "string",
"partnerRegistrationImmutableId": "string",
"partnerTopicFriendlyDescription": "string",
"source": "string"
}
}
屬性值
partnerTopics
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.EventGrid/partnerTopics' |
| apiVersion | 資源 API 版本 | '2023-12-15-preview' |
| NAME | 資源名稱 | 字串 (必要) |
| location | 資源的位置。 | 字串 (必要) |
| tags | 資源的標記。 | 標記名稱和值的字典。 請參閱 範本中的標記 |
| 身分識別 | 合作夥伴主題資源的身分識別資訊。 | IdentityInfo |
| properties | 合作夥伴主題的屬性。 | PartnerTopicProperties |
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 | 使用者指派身分識別的主體標識碼。 | 字串 |
PartnerTopicProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| activationState | 合作夥伴主題的啟用狀態。 | 'Activated' 'Deactivated' 'NeverActivated' |
| eventTypeInfo | 來自對應事件通道的事件類型資訊。 | EventTypeInfo |
| expirationTimeIfNotActivatedUtc | 合作夥伴主題的到期時間。 如果此定時器在合作夥伴主題仍然未啟用時到期， 合作夥伴主題和對應的事件通道會被刪除。 |
字串 |
| messageForActivation | 訂閱者可在核准程序期間使用的內容或實用訊息。 | 字串 |
| partnerRegistrationImmutableId | 對應夥伴註冊的 immutableId。 | 字串 約束： 最小長度 = 36 最大長度 = 36 模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| partnerTopicFriendlyDescription | 關於主題的易記描述。 這可由發行者/合作夥伴設定，以顯示客戶合作夥伴主題的自定義描述。 這有助於移除客戶建立合作夥伴主題來源的任何模棱兩可。 |
字串 |
| source | 與此合作夥伴主題相關聯的來源。 這代表唯一的合作夥伴資源。 | 字串 |
EventTypeInfo
| 名稱 | 描述 | 值 |
|---|---|---|
| inlineEventTypes | 資源的內嵌事件類型集合。 內嵌事件類型索引鍵的類型字串，代表事件的名稱。 有效的內嵌事件名稱範例是 「Contoso.OrderCreated」。。 內嵌事件類型值的類型為 InlineEventProperties，而且會包含每個內嵌事件類型的其他資訊。 |
EventTypeInfoInlineEventTypes |
| kind | 所使用的事件類型。 | 'Inline' |
EventTypeInfoInlineEventTypes
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | InlineEventProperties |
InlineEventProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| dataSchemaUrl | 內嵌事件的 dataSchemaUrl。 | 字串 |
| description | 內嵌事件的描述。 | 字串 |
| displayName | 內嵌事件的 displayName。 | 字串 |
| documentationUrl | 內嵌事件的 documentationUrl。 | 字串 |
Terraform (AzAPI 提供者) 資源定義
partnerTopics 資源類型可以使用目標作業來部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
資源格式
若要建立 Microsoft.EventGrid/partnerTopics 資源，請將下列 Terraform 新增至您的範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/partnerTopics@2023-12-15-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
activationState = "string"
eventTypeInfo = {
inlineEventTypes = {
{customized property} = {
dataSchemaUrl = "string"
description = "string"
displayName = "string"
documentationUrl = "string"
}
}
kind = "Inline"
}
expirationTimeIfNotActivatedUtc = "string"
messageForActivation = "string"
partnerRegistrationImmutableId = "string"
partnerTopicFriendlyDescription = "string"
source = "string"
}
})
}
屬性值
partnerTopics
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.EventGrid/partnerTopics@2023-12-15-preview” |
| NAME | 資源名稱 | 需要字串 () |
| location | 資源的位置。 | 需要字串 () |
| parent_id | 若要部署至資源群組，請使用該資源群組的標識碼。 | 需要字串 () |
| tags | 資源的標記。 | 標記名稱和值的字典。 |
| 身分識別 | 合作夥伴主題資源的身分識別資訊。 | IdentityInfo |
| properties | 合作夥伴主題的屬性。 | PartnerTopicProperties |
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 | 使用者指派身分識別的主體標識碼。 | 字串 |
PartnerTopicProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| activationState | 合作夥伴主題的啟用狀態。 | “Activated” “已停用” “NeverActivated” |
| eventTypeInfo | 來自對應事件通道的事件類型資訊。 | EventTypeInfo |
| expirationTimeIfNotActivatedUtc | 合作夥伴主題的到期時間。 如果此定時器在合作夥伴主題仍然未啟用時到期，則為 刪除合作夥伴主題和對應的事件通道。 |
字串 |
| messageForActivation | 訂閱者在核准程序期間可以使用的內容或實用訊息。 | 字串 |
| partnerRegistrationImmutableId | 對應夥伴註冊的 immutableId。 | 字串 約束： 最小長度 = 36 最大長度 = 36 模式 = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ |
| partnerTopicFriendlyDescription | 關於主題的易記描述。 這可由發行者/合作夥伴設定，以顯示客戶合作夥伴主題的自定義描述。 這有助於移除客戶建立合作夥伴主題來源的任何模棱兩可。 |
字串 |
| source | 與此合作夥伴主題相關聯的來源。 這代表唯一的夥伴資源。 | 字串 |
EventTypeInfo
| 名稱 | 描述 | 值 |
|---|---|---|
| inlineEventTypes | 資源的內嵌事件類型集合。 內嵌事件類型索引鍵的類型字串，代表事件的名稱。 有效的內嵌事件名稱範例是 「Contoso.OrderCreated」。。 內嵌事件類型值的類型為 InlineEventProperties，而且會包含每個內嵌事件類型的其他資訊。 |
EventTypeInfoInlineEventTypes |
| kind | 所使用的事件類型。 | “內嵌” |
EventTypeInfoInlineEventTypes
| 名稱 | 描述 | 值 |
|---|---|---|
| {自定義屬性} | InlineEventProperties |
InlineEventProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| dataSchemaUrl | 內嵌事件的 dataSchemaUrl。 | 字串 |
| description | 內嵌事件的描述。 | 字串 |
| displayName | 內嵌事件的 displayName。 | 字串 |
| documentationUrl | 內嵌事件的 documentationUrl。 | 字串 |