Microsoft.EventGrid partnerNamespaces/channels 2021-10-15-preview
Bicep 資源定義
partnerNamespaces/channels 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.EventGrid/partnerNamespaces/channels 資源,請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
channelType: 'string'
expirationTimeIfNotActivatedUtc: 'string'
messageForActivation: 'string'
partnerDestinationInfo: {
azureSubscriptionId: 'string'
endpointServiceContext: 'string'
name: 'string'
resourceGroupName: 'string'
resourceMoveChangeHistory: [
{
azureSubscriptionId: 'string'
changedTimeUtc: 'string'
resourceGroupName: 'string'
}
]
endpointType: 'string'
// For remaining properties, see PartnerDestinationInfo objects
}
partnerTopicInfo: {
azureSubscriptionId: 'string'
eventTypeInfo: {
inlineEventTypes: {
{customized property}: {
dataSchemaUrl: 'string'
description: 'string'
documentationUrl: 'string'
}
}
kind: 'string'
}
name: 'string'
resourceGroupName: 'string'
source: 'string'
}
provisioningState: 'string'
readinessState: 'string'
}
}
PartnerClientAuthentication 物件
設定 clientAuthenticationType 屬性來指定對象的類型。
針對 AzureAD,請使用:
{
clientAuthenticationType: 'AzureAD'
properties: {
azureActiveDirectoryApplicationIdOrUri: 'string'
azureActiveDirectoryTenantId: 'string'
}
}
PartnerDestinationInfo 物件
設定 endpointType 屬性,以指定對象的類型。
針對 WebHook,請使用:
{
endpointType: 'WebHook'
properties: {
clientAuthentication: {
clientAuthenticationType: 'string'
// For remaining properties, see PartnerClientAuthentication objects
}
endpointBaseUrl: 'string'
endpointUrl: 'string'
}
}
屬性值
AzureADPartnerClientAuthentication
名字 | 描述 | 價值 |
---|---|---|
clientAuthenticationType | 用戶端驗證的類型 | 'AzureAD' (必要) |
性能 | AzureAD ClientAuthentication 屬性 | AzureADPartnerClientAuthenticationProperties |
AzureADPartnerClientAuthenticationProperties
名字 | 描述 | 價值 |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | Azure Active Directory 應用程式識別碼或 URI,以取得存取令牌,這些令牌將包含在傳遞要求中作為持有人令牌。 | 字串 |
azureActiveDirectoryTenantId | 要取得存取令牌的 Azure Active Directory 租使用者標識碼,該令牌將包含在傳遞要求中作為持有人令牌。 | 字串 |
ChannelProperties
名字 | 描述 | 價值 |
---|---|---|
channelType | 事件通道的類型,表示事件的方向流程。 | 'PartnerDestination' 'PartnerTopic' |
expirationTimeIfNotActivatedUtc | 通道的到期時間。 如果此定時器在對應的合作夥伴主題從未啟用時過期, 頻道和對應的夥伴主題已刪除。 |
字串 |
messageForActivation | 訂閱者在核准程序期間可以使用的內容或實用訊息。 | 字串 |
partnerDestinationInfo | 當 channelType 為 PartnerDestination 時,應該填入此屬性,並代表對應至通道之夥伴目的地資源的相關信息。 | PartnerDestinationInfo |
partnerTopicInfo | 當 channelType 為 PartnerTopic 時,應該填入此屬性,並代表對應至通道之夥伴主題資源的相關信息。 | PartnerTopicInfo |
provisioningState | 通道的布建狀態。 | 'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing' |
readinessState | 對應夥伴主題的整備狀態。 | 'Activated' 'NeverActivated' |
EventTypeInfo
名字 | 描述 | 價值 |
---|---|---|
inlineEventTypes | 資源的內嵌事件類型集合。 內嵌事件類型索引鍵的類型為字串,代表事件的名稱。 有效的內嵌事件名稱範例是 「Contoso.OrderCreated」。。 內嵌事件類型值的類型為 InlineEventProperties,且會包含每個內嵌事件類型的其他資訊。 |
EventTypeInfoInlineEventTypes |
類 | 所使用的事件類型類型。 | 'Inline' |
EventTypeInfoInlineEventTypes
名字 | 描述 | 價值 |
---|
InlineEventProperties
名字 | 描述 | 價值 |
---|---|---|
dataSchemaUrl | 內嵌事件的 dataSchemaUrl。 | 字串 |
描述 | 內嵌事件的描述。 | 字串 |
documentationUrl | 內嵌事件的檔Url。 | 字串 |
Microsoft.EventGrid/partnerNamespaces/channels
名字 | 描述 | 價值 |
---|---|---|
名字 | 資源名稱 | 字串 (必要) |
父母 | 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。 如需詳細資訊,請參閱 父資源外部的子資源。 |
類型資源的符號名稱:partnerNamespaces |
性能 | 通道的屬性。 | ChannelProperties |
PartnerClientAuthentication
名字 | 描述 | 價值 |
---|---|---|
clientAuthenticationType | 針對 AzureADPartnerClientAuthentication 類型設定為 'AzureAD',。 | 'AzureAD' (必要) |
PartnerDestinationInfo
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 訂閱者的 Azure 訂用帳戶標識碼。 與通道相關聯的合作夥伴目的地將會是 在此 Azure 訂用帳戶下建立。 |
字串 |
endpointServiceContext | 合作夥伴目的地端點的其他內容。 | 字串 |
endpointType | 將 類型設定為 'WebHook' WebhookPartnerDestinationInfo。 | 'WebHook' (必要) |
名字 | 與通道相關聯的夥伴目的地名稱。 | 字串 |
resourceGroupName | 訂閱者的 Azure 資源群組。 與通道相關聯的合作夥伴目的地將會是 在此資源群組底下建立。 |
字串 |
resourceMoveChangeHistory | 變更資源移動的歷程記錄。 | ResourceMoveChangeHistory[] |
PartnerTopicInfo
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 訂閱者的 Azure 訂用帳戶標識碼。 與通道相關聯的合作夥伴主題將會是 在此 Azure 訂用帳戶下建立。 |
字串 |
eventTypeInfo | 合作夥伴主題的事件類型資訊。 此資訊是由發行者提供,而且可供 使用 訂閱者可檢視發行的不同事件類型。 |
EventTypeInfo |
名字 | 與通道相關聯的合作夥伴主題名稱。 | 字串 |
resourceGroupName | 訂閱者的 Azure 資源群組。 與通道相關聯的合作夥伴主題將會是 在此資源群組底下建立。 |
字串 |
源 | 發行者會提供來源資訊,以判斷事件的來源範圍或內容 源自於 。 在核准程式期間,訂閱者可以使用這項資訊 已建立合作夥伴主題。 |
字串 |
ResourceMoveChangeHistory
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 資源的 Azure 訂用帳戶標識碼。 | 字串 |
changedTimeUtc | 資源變更時的 UTC 時間戳。 | 字串 |
resourceGroupName | 資源的 Azure 資源群組。 | 字串 |
WebhookPartnerDestinationInfo
名字 | 描述 | 價值 |
---|---|---|
endpointType | 合作夥伴目的地的端點類型 | 'WebHook' (必要) |
性能 | 合作夥伴目的地的 WebHook 屬性。 | WebhookPartnerDestinationProperties |
WebhookPartnerDestinationProperties
名字 | 描述 | 價值 |
---|---|---|
clientAuthentication | 合作夥伴客戶端驗證 | PartnerClientAuthentication |
endpointBaseUrl | 代表夥伴目的地端點的基底 URL。 | 字串 |
endpointUrl | 表示合作夥伴目的地端點的 URL。 | 字串 |
ARM 樣本資源定義
partnerNamespaces/channels 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.EventGrid/partnerNamespaces/channels 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.EventGrid/partnerNamespaces/channels",
"apiVersion": "2021-10-15-preview",
"name": "string",
"properties": {
"channelType": "string",
"expirationTimeIfNotActivatedUtc": "string",
"messageForActivation": "string",
"partnerDestinationInfo": {
"azureSubscriptionId": "string",
"endpointServiceContext": "string",
"name": "string",
"resourceGroupName": "string",
"resourceMoveChangeHistory": [
{
"azureSubscriptionId": "string",
"changedTimeUtc": "string",
"resourceGroupName": "string"
}
],
"endpointType": "string"
// For remaining properties, see PartnerDestinationInfo objects
},
"partnerTopicInfo": {
"azureSubscriptionId": "string",
"eventTypeInfo": {
"inlineEventTypes": {
"{customized property}": {
"dataSchemaUrl": "string",
"description": "string",
"documentationUrl": "string"
}
},
"kind": "string"
},
"name": "string",
"resourceGroupName": "string",
"source": "string"
},
"provisioningState": "string",
"readinessState": "string"
}
}
PartnerClientAuthentication 物件
設定 clientAuthenticationType 屬性來指定對象的類型。
針對 AzureAD,請使用:
{
"clientAuthenticationType": "AzureAD",
"properties": {
"azureActiveDirectoryApplicationIdOrUri": "string",
"azureActiveDirectoryTenantId": "string"
}
}
PartnerDestinationInfo 物件
設定 endpointType 屬性,以指定對象的類型。
針對 WebHook,請使用:
{
"endpointType": "WebHook",
"properties": {
"clientAuthentication": {
"clientAuthenticationType": "string"
// For remaining properties, see PartnerClientAuthentication objects
},
"endpointBaseUrl": "string",
"endpointUrl": "string"
}
}
屬性值
AzureADPartnerClientAuthentication
名字 | 描述 | 價值 |
---|---|---|
clientAuthenticationType | 用戶端驗證的類型 | 'AzureAD' (必要) |
性能 | AzureAD ClientAuthentication 屬性 | AzureADPartnerClientAuthenticationProperties |
AzureADPartnerClientAuthenticationProperties
名字 | 描述 | 價值 |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | Azure Active Directory 應用程式識別碼或 URI,以取得存取令牌,這些令牌將包含在傳遞要求中作為持有人令牌。 | 字串 |
azureActiveDirectoryTenantId | 要取得存取令牌的 Azure Active Directory 租使用者標識碼,該令牌將包含在傳遞要求中作為持有人令牌。 | 字串 |
ChannelProperties
名字 | 描述 | 價值 |
---|---|---|
channelType | 事件通道的類型,表示事件的方向流程。 | 'PartnerDestination' 'PartnerTopic' |
expirationTimeIfNotActivatedUtc | 通道的到期時間。 如果此定時器在對應的合作夥伴主題從未啟用時過期, 頻道和對應的夥伴主題已刪除。 |
字串 |
messageForActivation | 訂閱者在核准程序期間可以使用的內容或實用訊息。 | 字串 |
partnerDestinationInfo | 當 channelType 為 PartnerDestination 時,應該填入此屬性,並代表對應至通道之夥伴目的地資源的相關信息。 | PartnerDestinationInfo |
partnerTopicInfo | 當 channelType 為 PartnerTopic 時,應該填入此屬性,並代表對應至通道之夥伴主題資源的相關信息。 | PartnerTopicInfo |
provisioningState | 通道的布建狀態。 | 'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing' |
readinessState | 對應夥伴主題的整備狀態。 | 'Activated' 'NeverActivated' |
EventTypeInfo
名字 | 描述 | 價值 |
---|---|---|
inlineEventTypes | 資源的內嵌事件類型集合。 內嵌事件類型索引鍵的類型為字串,代表事件的名稱。 有效的內嵌事件名稱範例是 「Contoso.OrderCreated」。。 內嵌事件類型值的類型為 InlineEventProperties,且會包含每個內嵌事件類型的其他資訊。 |
EventTypeInfoInlineEventTypes |
類 | 所使用的事件類型類型。 | 'Inline' |
EventTypeInfoInlineEventTypes
名字 | 描述 | 價值 |
---|
InlineEventProperties
名字 | 描述 | 價值 |
---|---|---|
dataSchemaUrl | 內嵌事件的 dataSchemaUrl。 | 字串 |
描述 | 內嵌事件的描述。 | 字串 |
documentationUrl | 內嵌事件的檔Url。 | 字串 |
Microsoft.EventGrid/partnerNamespaces/channels
名字 | 描述 | 價值 |
---|---|---|
apiVersion | API 版本 | '2021-10-15-preview' |
名字 | 資源名稱 | 字串 (必要) |
性能 | 通道的屬性。 | ChannelProperties |
類型 | 資源類型 | 'Microsoft.EventGrid/partnerNamespaces/channels' |
PartnerClientAuthentication
名字 | 描述 | 價值 |
---|---|---|
clientAuthenticationType | 針對 AzureADPartnerClientAuthentication 類型設定為 'AzureAD',。 | 'AzureAD' (必要) |
PartnerDestinationInfo
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 訂閱者的 Azure 訂用帳戶標識碼。 與通道相關聯的合作夥伴目的地將會是 在此 Azure 訂用帳戶下建立。 |
字串 |
endpointServiceContext | 合作夥伴目的地端點的其他內容。 | 字串 |
endpointType | 將 類型設定為 'WebHook' WebhookPartnerDestinationInfo。 | 'WebHook' (必要) |
名字 | 與通道相關聯的夥伴目的地名稱。 | 字串 |
resourceGroupName | 訂閱者的 Azure 資源群組。 與通道相關聯的合作夥伴目的地將會是 在此資源群組底下建立。 |
字串 |
resourceMoveChangeHistory | 變更資源移動的歷程記錄。 | ResourceMoveChangeHistory[] |
PartnerTopicInfo
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 訂閱者的 Azure 訂用帳戶標識碼。 與通道相關聯的合作夥伴主題將會是 在此 Azure 訂用帳戶下建立。 |
字串 |
eventTypeInfo | 合作夥伴主題的事件類型資訊。 此資訊是由發行者提供,而且可供 使用 訂閱者可檢視發行的不同事件類型。 |
EventTypeInfo |
名字 | 與通道相關聯的合作夥伴主題名稱。 | 字串 |
resourceGroupName | 訂閱者的 Azure 資源群組。 與通道相關聯的合作夥伴主題將會是 在此資源群組底下建立。 |
字串 |
源 | 發行者會提供來源資訊,以判斷事件的來源範圍或內容 源自於 。 在核准程式期間,訂閱者可以使用這項資訊 已建立合作夥伴主題。 |
字串 |
ResourceMoveChangeHistory
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 資源的 Azure 訂用帳戶標識碼。 | 字串 |
changedTimeUtc | 資源變更時的 UTC 時間戳。 | 字串 |
resourceGroupName | 資源的 Azure 資源群組。 | 字串 |
WebhookPartnerDestinationInfo
名字 | 描述 | 價值 |
---|---|---|
endpointType | 合作夥伴目的地的端點類型 | 'WebHook' (必要) |
性能 | 合作夥伴目的地的 WebHook 屬性。 | WebhookPartnerDestinationProperties |
WebhookPartnerDestinationProperties
名字 | 描述 | 價值 |
---|---|---|
clientAuthentication | 合作夥伴客戶端驗證 | PartnerClientAuthentication |
endpointBaseUrl | 代表夥伴目的地端點的基底 URL。 | 字串 |
endpointUrl | 表示合作夥伴目的地端點的 URL。 | 字串 |
Terraform (AzAPI 提供者) 資源定義
partnerNamespaces/channels 資源類型可以使用目標作業來部署:
- 資源群組
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.EventGrid/partnerNamespaces/channels 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview"
name = "string"
body = jsonencode({
properties = {
channelType = "string"
expirationTimeIfNotActivatedUtc = "string"
messageForActivation = "string"
partnerDestinationInfo = {
azureSubscriptionId = "string"
endpointServiceContext = "string"
name = "string"
resourceGroupName = "string"
resourceMoveChangeHistory = [
{
azureSubscriptionId = "string"
changedTimeUtc = "string"
resourceGroupName = "string"
}
]
endpointType = "string"
// For remaining properties, see PartnerDestinationInfo objects
}
partnerTopicInfo = {
azureSubscriptionId = "string"
eventTypeInfo = {
inlineEventTypes = {
{customized property} = {
dataSchemaUrl = "string"
description = "string"
documentationUrl = "string"
}
}
kind = "string"
}
name = "string"
resourceGroupName = "string"
source = "string"
}
provisioningState = "string"
readinessState = "string"
}
})
}
PartnerClientAuthentication 物件
設定 clientAuthenticationType 屬性來指定對象的類型。
針對 AzureAD,請使用:
{
clientAuthenticationType = "AzureAD"
properties = {
azureActiveDirectoryApplicationIdOrUri = "string"
azureActiveDirectoryTenantId = "string"
}
}
PartnerDestinationInfo 物件
設定 endpointType 屬性,以指定對象的類型。
針對 WebHook,請使用:
{
endpointType = "WebHook"
properties = {
clientAuthentication = {
clientAuthenticationType = "string"
// For remaining properties, see PartnerClientAuthentication objects
}
endpointBaseUrl = "string"
endpointUrl = "string"
}
}
屬性值
AzureADPartnerClientAuthentication
名字 | 描述 | 價值 |
---|---|---|
clientAuthenticationType | 用戶端驗證的類型 | 'AzureAD' (必要) |
性能 | AzureAD ClientAuthentication 屬性 | AzureADPartnerClientAuthenticationProperties |
AzureADPartnerClientAuthenticationProperties
名字 | 描述 | 價值 |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | Azure Active Directory 應用程式識別碼或 URI,以取得存取令牌,這些令牌將包含在傳遞要求中作為持有人令牌。 | 字串 |
azureActiveDirectoryTenantId | 要取得存取令牌的 Azure Active Directory 租使用者標識碼,該令牌將包含在傳遞要求中作為持有人令牌。 | 字串 |
ChannelProperties
名字 | 描述 | 價值 |
---|---|---|
channelType | 事件通道的類型,表示事件的方向流程。 | 'PartnerDestination' 'PartnerTopic' |
expirationTimeIfNotActivatedUtc | 通道的到期時間。 如果此定時器在對應的合作夥伴主題從未啟用時過期, 頻道和對應的夥伴主題已刪除。 |
字串 |
messageForActivation | 訂閱者在核准程序期間可以使用的內容或實用訊息。 | 字串 |
partnerDestinationInfo | 當 channelType 為 PartnerDestination 時,應該填入此屬性,並代表對應至通道之夥伴目的地資源的相關信息。 | PartnerDestinationInfo |
partnerTopicInfo | 當 channelType 為 PartnerTopic 時,應該填入此屬性,並代表對應至通道之夥伴主題資源的相關信息。 | PartnerTopicInfo |
provisioningState | 通道的布建狀態。 | 'Canceled' 'Creating' '刪除' 'Failed' 'Succeeded' 'Updateing' |
readinessState | 對應夥伴主題的整備狀態。 | 'Activated' 'NeverActivated' |
EventTypeInfo
名字 | 描述 | 價值 |
---|---|---|
inlineEventTypes | 資源的內嵌事件類型集合。 內嵌事件類型索引鍵的類型為字串,代表事件的名稱。 有效的內嵌事件名稱範例是 「Contoso.OrderCreated」。。 內嵌事件類型值的類型為 InlineEventProperties,且會包含每個內嵌事件類型的其他資訊。 |
EventTypeInfoInlineEventTypes |
類 | 所使用的事件類型類型。 | 'Inline' |
EventTypeInfoInlineEventTypes
名字 | 描述 | 價值 |
---|
InlineEventProperties
名字 | 描述 | 價值 |
---|---|---|
dataSchemaUrl | 內嵌事件的 dataSchemaUrl。 | 字串 |
描述 | 內嵌事件的描述。 | 字串 |
documentationUrl | 內嵌事件的檔Url。 | 字串 |
Microsoft.EventGrid/partnerNamespaces/channels
名字 | 描述 | 價值 |
---|---|---|
名字 | 資源名稱 | 字串 (必要) |
parent_id | 此資源為父系之資源的標識碼。 | 類型資源的標識碼:partnerNamespaces |
性能 | 通道的屬性。 | ChannelProperties |
類型 | 資源類型 | “Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview” |
PartnerClientAuthentication
名字 | 描述 | 價值 |
---|---|---|
clientAuthenticationType | 針對 AzureADPartnerClientAuthentication 類型設定為 'AzureAD',。 | 'AzureAD' (必要) |
PartnerDestinationInfo
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 訂閱者的 Azure 訂用帳戶標識碼。 與通道相關聯的合作夥伴目的地將會是 在此 Azure 訂用帳戶下建立。 |
字串 |
endpointServiceContext | 合作夥伴目的地端點的其他內容。 | 字串 |
endpointType | 將 類型設定為 'WebHook' WebhookPartnerDestinationInfo。 | 'WebHook' (必要) |
名字 | 與通道相關聯的夥伴目的地名稱。 | 字串 |
resourceGroupName | 訂閱者的 Azure 資源群組。 與通道相關聯的合作夥伴目的地將會是 在此資源群組底下建立。 |
字串 |
resourceMoveChangeHistory | 變更資源移動的歷程記錄。 | ResourceMoveChangeHistory[] |
PartnerTopicInfo
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 訂閱者的 Azure 訂用帳戶標識碼。 與通道相關聯的合作夥伴主題將會是 在此 Azure 訂用帳戶下建立。 |
字串 |
eventTypeInfo | 合作夥伴主題的事件類型資訊。 此資訊是由發行者提供,而且可供 使用 訂閱者可檢視發行的不同事件類型。 |
EventTypeInfo |
名字 | 與通道相關聯的合作夥伴主題名稱。 | 字串 |
resourceGroupName | 訂閱者的 Azure 資源群組。 與通道相關聯的合作夥伴主題將會是 在此資源群組底下建立。 |
字串 |
源 | 發行者會提供來源資訊,以判斷事件的來源範圍或內容 源自於 。 在核准程式期間,訂閱者可以使用這項資訊 已建立合作夥伴主題。 |
字串 |
ResourceMoveChangeHistory
名字 | 描述 | 價值 |
---|---|---|
azureSubscriptionId | 資源的 Azure 訂用帳戶標識碼。 | 字串 |
changedTimeUtc | 資源變更時的 UTC 時間戳。 | 字串 |
resourceGroupName | 資源的 Azure 資源群組。 | 字串 |
WebhookPartnerDestinationInfo
名字 | 描述 | 價值 |
---|---|---|
endpointType | 合作夥伴目的地的端點類型 | 'WebHook' (必要) |
性能 | 合作夥伴目的地的 WebHook 屬性。 | WebhookPartnerDestinationProperties |
WebhookPartnerDestinationProperties
名字 | 描述 | 價值 |
---|---|---|
clientAuthentication | 合作夥伴客戶端驗證 | PartnerClientAuthentication |
endpointBaseUrl | 代表夥伴目的地端點的基底 URL。 | 字串 |
endpointUrl | 表示合作夥伴目的地端點的 URL。 | 字串 |