Microsoft.EventGrid partnerNamespaces/channels 2023-06-01-preview

發行項
01/15/2024

Bicep 資源定義

partnerNamespaces/channels 資源類型可以使用目標作業來部署：

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

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

資源格式

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

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2023-06-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
            displayName: 'string'
            documentationUrl: 'string'
          }
        }
        kind: 'Inline'
      }
      name: 'string'
      resourceGroupName: 'string'
      source: 'string'
    }
    provisioningState: 'string'
    readinessState: 'string'
  }
}

PartnerDestinationInfo 物件

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

針對 WebHook，請使用：

  endpointType: 'WebHook'
  properties: {
    clientAuthentication: {
      clientAuthenticationType: 'string'
      // For remaining properties, see PartnerClientAuthentication objects
    }
    endpointBaseUrl: 'string'
    endpointUrl: 'string'
  }

PartnerClientAuthentication 物件

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

針對 AzureAD，請使用：

  clientAuthenticationType: 'AzureAD'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
  }

屬性值

partnerNamespaces/channels

名稱	描述	值
NAME	資源名稱瞭解如何在 Bicep 中設定子資源的名稱和類型。	需要字串 ()
父系 (parent)	在 Bicep 中，您可以指定子資源的父資源。只有在父資源外部宣告子資源時，才需要新增此屬性。如需詳細資訊，請參閱父資源外部的子資源。	類型資源的符號名稱： partnerNamespaces
properties	通道的屬性。	ChannelProperties

ChannelProperties

名稱	描述	值
channelType	事件通道的類型，表示事件的方向流程。	'PartnerDestination' 'PartnerTopic'
expirationTimeIfNotActivatedUtc	通道的到期時間。如果此定時器在對應的夥伴主題從未啟用時到期，會刪除頻道和對應的合作夥伴主題。	字串
messageForActivation	訂閱者在核准程序期間可以使用的內容或實用訊息。	字串
partnerDestinationInfo	當 channelType 為 PartnerDestination 時，應該填入此屬性，並表示對應至通道之夥伴目的地資源的相關信息。	PartnerDestinationInfo
partnerTopicInfo	當 channelType 是 PartnerTopic 時，應該填入此屬性，並代表對應至通道之合作夥伴主題資源的相關信息。	PartnerTopicInfo
provisioningState	通道的布建狀態。	'Canceled' 'Creating' '刪除' 'Failed' 'IdleDueToMirroredPartnerDestinationDeletion' 'IdleDueToMirroredPartnerTopicDeletion' 'Succeeded' 'Updateing'
readinessState	對應合作夥伴主題的整備狀態。	'Activated' 'NeverActivated'

PartnerDestinationInfo

名稱	描述	值
azureSubscriptionId	訂閱者的 Azure 訂用帳戶標識碼。與通道相關聯的合作夥伴目的地將會是在此 Azure 訂用帳戶下建立。	字串
endpointServiceContext	夥伴目的地端點的其他內容。	字串
NAME	與通道相關聯的合作夥伴目的地名稱。	字串
resourceGroupName	訂閱者的 Azure 資源群組。與通道相關聯的合作夥伴目的地將會是在此資源群組下建立。	字串
resourceMoveChangeHistory	變更資源移動的歷程記錄。	ResourceMoveChangeHistory[]
endpointType	設定物件類型	需要 WebHook ()

ResourceMoveChangeHistory

名稱	描述	值
azureSubscriptionId	資源的 Azure 訂用帳戶標識碼。	字串
changedTimeUtc	變更資源的 UTC 時間戳。	字串
resourceGroupName	資源的 Azure 資源群組。	字串

WebhookPartnerDestinationInfo

名稱	描述	值
endpointType	合作夥伴目的地的端點類型	必要的『WebHook』 ()
properties	合作夥伴目的地的 WebHook 屬性。	WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

名稱	描述	值
clientAuthentication	合作夥伴客戶端驗證	PartnerClientAuthentication
endpointBaseUrl	代表夥伴目的地端點的基底 URL。	字串
endpointUrl	表示夥伴目的地端點的 URL。	字串

PartnerClientAuthentication

名稱	描述	值
clientAuthenticationType	設定物件類型	AzureAD (必要)

AzureADPartnerClientAuthentication

名稱	描述	值
clientAuthenticationType	用戶端驗證的類型	必要) 的 'AzureAD' (
properties	AzureAD ClientAuthentication 屬性	AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

名稱	描述	值
azureActiveDirectoryApplicationIdOrUri	Azure Active Directory 應用程式識別碼或 URI，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。	字串
azureActiveDirectoryTenantId	Azure Active Directory 租使用者識別符，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。	字串

PartnerTopicInfo

名稱	描述	值
azureSubscriptionId	訂閱者的 Azure 訂用帳戶標識碼。與通道相關聯的合作夥伴主題將會是在此 Azure 訂用帳戶下建立。	字串
eventTypeInfo	合作夥伴主題的事件類型資訊。此資訊是由發行者提供，而且可由使用訂閱者可檢視發行的不同事件類型。	EventTypeInfo
NAME	與通道相關聯的合作夥伴主題名稱。	字串
resourceGroupName	訂閱者的 Azure 資源群組。與通道相關聯的合作夥伴主題將會是在此資源群組下建立。	字串
source	來源資訊是由發行者提供，以判斷事件的來源範圍或內容源自。訂閱者可以在核准程序期間使用這項資訊已建立合作夥伴主題。	字串

EventTypeInfo

名稱	描述	值
inlineEventTypes	資源的內嵌事件類型集合。內嵌事件類型索引鍵的類型字串，代表事件的名稱。有效的內嵌事件名稱範例是「Contoso.OrderCreated」。。內嵌事件類型值的類型為 InlineEventProperties，而且會包含每個內嵌事件類型的其他資訊。	EventTypeInfoInlineEventTypes
kind	所使用的事件類型。	'Inline'

EventTypeInfoInlineEventTypes

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

InlineEventProperties

名稱	描述	值
dataSchemaUrl	內嵌事件的 dataSchemaUrl。	字串
description	內嵌事件的描述。	字串
displayName	內嵌事件的 displayName。	字串
documentationUrl	內嵌事件的檔Url。	字串

ARM 範本資源定義

partnerNamespaces/channels 資源類型可以使用目標作業來部署：

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

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

資源格式

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

{
  "type": "Microsoft.EventGrid/partnerNamespaces/channels",
  "apiVersion": "2023-06-01-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",
            "displayName": "string",
            "documentationUrl": "string"
          }
        },
        "kind": "Inline"
      },
      "name": "string",
      "resourceGroupName": "string",
      "source": "string"
    },
    "provisioningState": "string",
    "readinessState": "string"
  }
}

PartnerDestinationInfo 物件

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

針對 WebHook，請使用：

  "endpointType": "WebHook",
  "properties": {
    "clientAuthentication": {
      "clientAuthenticationType": "string"
      // For remaining properties, see PartnerClientAuthentication objects
    },
    "endpointBaseUrl": "string",
    "endpointUrl": "string"
  }

PartnerClientAuthentication 物件

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

針對 AzureAD，請使用：

  "clientAuthenticationType": "AzureAD",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string"
  }

屬性值

partnerNamespaces/channels

名稱	描述	值
類型	資源類型	'Microsoft.EventGrid/partnerNamespaces/channels'
apiVersion	資源 API 版本	'2023-06-01-preview'
NAME	資源名稱瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。	需要字串 ()
properties	通道的屬性。	ChannelProperties

ChannelProperties

名稱	描述	值
channelType	事件通道的類型，表示事件的方向流程。	'PartnerDestination' 'PartnerTopic'
expirationTimeIfNotActivatedUtc	通道的到期時間。如果此定時器在對應的夥伴主題從未啟用時到期，會刪除頻道和對應的合作夥伴主題。	字串
messageForActivation	訂閱者在核准程序期間可以使用的內容或實用訊息。	字串
partnerDestinationInfo	當 channelType 為 PartnerDestination 時，應該填入此屬性，並表示對應至通道之夥伴目的地資源的相關信息。	PartnerDestinationInfo
partnerTopicInfo	當 channelType 是 PartnerTopic 時，應該填入此屬性，並代表對應至通道之合作夥伴主題資源的相關信息。	PartnerTopicInfo
provisioningState	通道的布建狀態。	'Canceled' 'Creating' '刪除' 'Failed' 'IdleDueToMirroredPartnerDestinationDeletion' 'IdleDueToMirroredPartnerTopicDeletion' 'Succeeded' 'Updateing'
readinessState	對應合作夥伴主題的整備狀態。	'Activated' 'NeverActivated'

PartnerDestinationInfo

名稱	描述	值
azureSubscriptionId	訂閱者的 Azure 訂用帳戶標識碼。與通道相關聯的合作夥伴目的地將會是在此 Azure 訂用帳戶下建立。	字串
endpointServiceContext	夥伴目的地端點的其他內容。	字串
NAME	與通道相關聯的合作夥伴目的地名稱。	字串
resourceGroupName	訂閱者的 Azure 資源群組。與通道相關聯的合作夥伴目的地將會是在此資源群組下建立。	字串
resourceMoveChangeHistory	變更資源移動的歷程記錄。	ResourceMoveChangeHistory[]
endpointType	設定物件類型	需要 WebHook ()

ResourceMoveChangeHistory

名稱	描述	值
azureSubscriptionId	資源的 Azure 訂用帳戶標識碼。	字串
changedTimeUtc	資源變更時的 UTC 時間戳。	字串
resourceGroupName	資源的 Azure 資源群組。	字串

WebhookPartnerDestinationInfo

名稱	描述	值
endpointType	合作夥伴目的地的端點類型	需要『WebHook』 ()
properties	合作夥伴目的地的 WebHook 屬性。	WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

名稱	描述	值
clientAuthentication	合作夥伴客戶端驗證	PartnerClientAuthentication
endpointBaseUrl	代表夥伴目的地端點的基底 URL。	字串
endpointUrl	表示夥伴目的地端點的 URL。	字串

PartnerClientAuthentication

名稱	描述	值
clientAuthenticationType	設定物件類型	需要 AzureAD ()

AzureADPartnerClientAuthentication

名稱	描述	值
clientAuthenticationType	用戶端驗證的類型	需要『AzureAD』 ()
properties	AzureAD ClientAuthentication 屬性	AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

名稱	描述	值
azureActiveDirectoryApplicationIdOrUri	Azure Active Directory 應用程式識別碼或 URI，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。	字串
azureActiveDirectoryTenantId	Azure Active Directory 租使用者識別符，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。	字串

PartnerTopicInfo

名稱	描述	值
azureSubscriptionId	訂閱者的 Azure 訂用帳戶標識碼。與通道相關聯的合作夥伴主題將會是在此 Azure 訂用帳戶下建立。	字串
eventTypeInfo	合作夥伴主題的事件類型資訊。此資訊是由發行者提供，而且可由使用訂閱者可檢視發行的不同事件類型。	EventTypeInfo
NAME	與通道相關聯的合作夥伴主題名稱。	字串
resourceGroupName	訂閱者的 Azure 資源群組。與通道相關聯的合作夥伴主題將會是在此資源群組下建立。	字串
source	來源資訊是由發行者提供，以判斷事件的來源範圍或內容源自。訂閱者可以在核准程序期間使用這項資訊已建立合作夥伴主題。	字串

EventTypeInfo

名稱	描述	值
inlineEventTypes	資源的內嵌事件類型集合。內嵌事件類型索引鍵的類型字串，代表事件的名稱。有效的內嵌事件名稱範例是「Contoso.OrderCreated」。。內嵌事件類型值的類型為 InlineEventProperties，而且會包含每個內嵌事件類型的其他資訊。	EventTypeInfoInlineEventTypes
kind	所使用的事件類型。	'Inline'

EventTypeInfoInlineEventTypes

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

InlineEventProperties

名稱	描述	值
dataSchemaUrl	內嵌事件的 dataSchemaUrl。	字串
description	內嵌事件的描述。	字串
displayName	內嵌事件的 displayName。	字串
documentationUrl	內嵌事件的 documentationUrl。	字串

Terraform (AzAPI 提供者) 資源定義

partnerNamespaces/channels 資源類型可以使用目標作業來部署：

資源群組

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

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/partnerNamespaces/channels@2023-06-01-preview"
  name = "string"
  parent_id = "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"
              displayName = "string"
              documentationUrl = "string"
            }
          }
          kind = "Inline"
        }
        name = "string"
        resourceGroupName = "string"
        source = "string"
      }
      provisioningState = "string"
      readinessState = "string"
    }
  })
}

PartnerDestinationInfo 物件

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

針對 WebHook，請使用：

  endpointType = "WebHook"
  properties = {
    clientAuthentication = {
      clientAuthenticationType = "string"
      // For remaining properties, see PartnerClientAuthentication objects
    }
    endpointBaseUrl = "string"
    endpointUrl = "string"
  }

PartnerClientAuthentication 物件

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

針對 AzureAD，請使用：

  clientAuthenticationType = "AzureAD"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
  }

屬性值

partnerNamespaces/channels

名稱	描述	值
類型	資源類型	“Microsoft.EventGrid/partnerNamespaces/channels@2023-06-01-preview”
NAME	資源名稱	字串 (必要)
parent_id	此資源之父系的資源標識碼。	類型資源的標識碼： partnerNamespaces
properties	通道的屬性。	ChannelProperties

ChannelProperties

名稱	描述	值
channelType	事件通道的類型，表示事件的方向流程。	“PartnerDestination” “PartnerTopic”
expirationTimeIfNotActivatedUtc	通道的到期時間。如果這個定時器在對應的夥伴主題從未啟用時到期，系統會刪除頻道和對應的合作夥伴主題。	字串
messageForActivation	訂閱者可在核准程序期間使用的內容或實用訊息。	字串
partnerDestinationInfo	當 channelType 為 PartnerDestination 時，應該填入此屬性，並代表與通道對應的合作夥伴目的地資源相關信息。	PartnerDestinationInfo
partnerTopicInfo	當 channelType 是 PartnerTopic 時，應該填入此屬性，並代表對應至通道的合作夥伴主題資源相關信息。	PartnerTopicInfo
provisioningState	通道的布建狀態。	“Canceled” “建立” “刪除” “Failed” “IdleDueToMirroredPartnerDestinationDeletion” “IdleDueToMirroredPartnerTopicDeletion” “Succeeded” “Updateing”
readinessState	對應夥伴主題的整備狀態。	“Activated” “NeverActivated”

PartnerDestinationInfo

名稱	描述	值
azureSubscriptionId	訂閱者的 Azure 訂用帳戶標識碼。與通道相關聯的合作夥伴目的地將是在此 Azure 訂用帳戶下建立。	字串
endpointServiceContext	合作夥伴目的地端點的其他內容。	字串
NAME	與通道相關聯的合作夥伴目的地名稱。	字串
resourceGroupName	訂閱者的 Azure 資源群組。與通道相關聯的合作夥伴目的地將是在此資源群組下建立。	字串
resourceMoveChangeHistory	變更資源移動的歷程記錄。	ResourceMoveChangeHistory[]
endpointType	設定物件類型	需要 WebHook ()

ResourceMoveChangeHistory

名稱	描述	值
azureSubscriptionId	資源的 Azure 訂用帳戶標識碼。	字串
changedTimeUtc	變更資源的 UTC 時間戳。	字串
resourceGroupName	資源的 Azure 資源群組。	字串

WebhookPartnerDestinationInfo

名稱	描述	值
endpointType	合作夥伴目的地的端點類型	“WebHook” (必要)
properties	合作夥伴目的地的 WebHook 屬性。	WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

名稱	描述	值
clientAuthentication	合作夥伴客戶端驗證	PartnerClientAuthentication
endpointBaseUrl	代表夥伴目的地端點的基底 URL。	字串
endpointUrl	表示夥伴目的地端點的 URL。	字串

PartnerClientAuthentication

名稱	描述	值
clientAuthenticationType	設定物件類型	AzureAD (必要)

AzureADPartnerClientAuthentication

名稱	描述	值
clientAuthenticationType	用戶端驗證的類型	“AzureAD” (必要)
properties	AzureAD ClientAuthentication 屬性	AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

名稱	描述	值
azureActiveDirectoryApplicationIdOrUri	Azure Active Directory 應用程式識別碼或 URI，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。	字串
azureActiveDirectoryTenantId	Azure Active Directory 租使用者識別符，以取得將包含在傳遞要求中作為持有人令牌的存取令牌。	字串

PartnerTopicInfo

名稱	描述	值
azureSubscriptionId	訂閱者的 Azure 訂用帳戶標識碼。與通道相關聯的合作夥伴主題將會是在此 Azure 訂用帳戶下建立。	字串
eventTypeInfo	合作夥伴主題的事件類型資訊。此資訊是由發行者提供，而且可由使用訂閱者可檢視發行的不同事件類型。	EventTypeInfo
NAME	與通道相關聯的合作夥伴主題名稱。	字串
resourceGroupName	訂閱者的 Azure 資源群組。與通道相關聯的合作夥伴主題將會是在此資源群組下建立。	字串
source	來源資訊是由發行者提供，以判斷事件的來源範圍或內容源自。在核准程式期間，訂閱者可以使用這項資訊已建立合作夥伴主題。	字串

EventTypeInfo

名稱	描述	值
inlineEventTypes	資源的內嵌事件類型集合。內嵌事件類型索引鍵的類型字串，代表事件的名稱。有效的內嵌事件名稱範例是「Contoso.OrderCreated」。。內嵌事件類型值的類型為 InlineEventProperties，而且會包含每個內嵌事件類型的其他資訊。	EventTypeInfoInlineEventTypes
kind	所使用的事件類型。	“內嵌”

EventTypeInfoInlineEventTypes

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

InlineEventProperties

名稱	描述	值
dataSchemaUrl	內嵌事件的 dataSchemaUrl。	字串
description	內嵌事件的描述。	字串
displayName	內嵌事件的 displayName。	字串
documentationUrl	內嵌事件的檔Url。	字串

共用方式為

Microsoft.EventGrid partnerNamespaces/channels 2023-06-01-preview

Bicep 資源定義

資源格式

PartnerDestinationInfo 物件

PartnerClientAuthentication 物件

屬性值

partnerNamespaces/channels

ChannelProperties

PartnerDestinationInfo

ResourceMoveChangeHistory

WebhookPartnerDestinationInfo

WebhookPartnerDestinationProperties

PartnerClientAuthentication

AzureADPartnerClientAuthentication

AzureADPartnerClientAuthenticationProperties

PartnerTopicInfo

EventTypeInfo

EventTypeInfoInlineEventTypes

InlineEventProperties

ARM 範本資源定義

資源格式

PartnerDestinationInfo 物件

PartnerClientAuthentication 物件

屬性值

partnerNamespaces/channels

ChannelProperties

PartnerDestinationInfo

ResourceMoveChangeHistory

WebhookPartnerDestinationInfo

WebhookPartnerDestinationProperties

PartnerClientAuthentication

AzureADPartnerClientAuthentication

AzureADPartnerClientAuthenticationProperties

PartnerTopicInfo

EventTypeInfo

EventTypeInfoInlineEventTypes

InlineEventProperties

Terraform (AzAPI 提供者) 資源定義

資源格式

PartnerDestinationInfo 物件

PartnerClientAuthentication 物件

屬性值

partnerNamespaces/channels

ChannelProperties

PartnerDestinationInfo

ResourceMoveChangeHistory

WebhookPartnerDestinationInfo

WebhookPartnerDestinationProperties

PartnerClientAuthentication

AzureADPartnerClientAuthentication

AzureADPartnerClientAuthenticationProperties

PartnerTopicInfo

EventTypeInfo

EventTypeInfoInlineEventTypes

InlineEventProperties

意見反應

其他資源