通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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' = {
  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'
            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 通道的预配状态。 “已取消”
'Creating'
'正在删除'
“Failed”
'Succeeded'
“正在更新”
readinessState 相应合作伙伴主题的就绪状态。 'Activated'
“NeverActivated”

PartnerDestinationInfo

名称 说明 值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴目标将是
在此 Azure 订阅下创建。		 string
endpointServiceContext 合作伙伴目标终结点的其他上下文。 字符串
name 与通道关联的合作伙伴目标的名称。 string
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴目标将是
在此资源组下创建。		 string
resourceMoveChangeHistory 更改资源移动的历史记录。 ResourceMoveChangeHistory[]
endpointType 设置对象类型 需要 WebHook ()

ResourceMoveChangeHistory

名称 说明 值
azureSubscriptionId 资源的 Azure 订阅 ID。 字符串
changedTimeUtc 资源更改时的 UTC 时间戳。 string
resourceGroupName 资源的 Azure 资源组。 string

WebhookPartnerDestinationInfo

名称 说明 值
endpointType 合作伙伴目标的终结点类型 “WebHook” ()
properties 合作伙伴目标的 WebHook 属性。 WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

名称 说明 值
clientAuthentication 合作伙伴客户端身份验证 PartnerClientAuthentication
endpointBaseUrl 表示合作伙伴目标的终结点的基 URL。 string
endpointUrl 表示合作伙伴目标的终结点的 URL。 字符串

PartnerClientAuthentication

名称 说明 值
clientAuthenticationType 设置对象类型 需要 AzureAD ()

AzureADPartnerClientAuthentication

名称 说明 值
clientAuthenticationType 客户端身份验证的类型 需要“AzureAD” ()
properties AzureAD ClientAuthentication 属性 AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

名称 说明 值
azureActiveDirectoryApplicationIdOrUri Azure Active Directory 应用程序 ID 或 URI，用于获取将作为持有者令牌包含在传递请求中的访问令牌。 字符串
azureActiveDirectoryTenantId Azure Active Directory 租户 ID，用于获取将作为持有者令牌包含在传递请求中的访问令牌。 string

PartnerTopicInfo

名称 说明 值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴主题将是
在此 Azure 订阅下创建。		 string
eventTypeInfo 合作伙伴主题的事件类型信息。 此信息由发布者提供，可供
订阅者，用于查看发布的不同类型的事件。		 EventTypeInfo
name 与频道关联的合作伙伴主题的名称。 字符串
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴主题将是
在此资源组下创建。		 string
source 源信息由发布者提供，用于确定事件的范围或上下文
是发起的。 此信息可供订阅者在 审批过程中使用
已创建合作伙伴主题。
 字符串

EventTypeInfo

名称 说明 值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键属于字符串类型，表示事件的名称。
有效的内联事件名称的一个示例是“Contoso.OrderCreated”。
内联事件类型值为 InlineEventProperties 类型，将包含每个内联事件类型的附加信息。		 EventTypeInfoInlineEventTypes
kind 使用的事件类型类型。 “内联”

EventTypeInfoInlineEventTypes

名称 说明 值
{customized property} InlineEventProperties

InlineEventProperties

名称 说明 值
dataSchemaUrl 内联事件的 dataSchemaUrl。 字符串
description 内联事件的说明。 字符串
documentationUrl 内联事件的 documentationUrl。 字符串

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": "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

名称 说明 Value
type 资源类型 'Microsoft.EventGrid/partnerNamespaces/channels'
apiVersion 资源 API 版本 “2021-10-15-preview”
name 资源名称

了解如何在 JSON ARM 模板中设置子资源的名称和类型。		 字符串 (必需)
properties 通道的属性。 ChannelProperties

ChannelProperties

名称 说明 值
channelType 表示事件方向流的事件通道的类型。 “PartnerDestination”
“PartnerTopic”
expirationTimeIfNotActivatedUtc 通道的过期时间。 如果此计时器在相应合作伙伴主题从未激活时过期，
频道和相应的合作伙伴主题将被删除。		 字符串
messageForActivation 订阅者可以在审批过程中使用的上下文或有用消息。 字符串
partnerDestinationInfo 当 channelType 为 PartnerDestination 并表示与通道对应的合作伙伴目标资源的相关信息时，应填充此属性。 PartnerDestinationInfo
partnerTopicInfo 当 channelType 为 PartnerTopic 并表示与通道对应的合作伙伴主题资源的相关信息时，应填充此属性。 PartnerTopicInfo
provisioningState 通道的预配状态。 “已取消”
'Creating'
'正在删除'
“Failed”
'Succeeded'
“正在更新”
readinessState 相应合作伙伴主题的就绪状态。 'Activated'
“NeverActivated”

PartnerDestinationInfo

名称 说明 值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴目标将是
在此 Azure 订阅下创建。		 string
endpointServiceContext 合作伙伴目标终结点的其他上下文。 字符串
name 与通道关联的合作伙伴目标的名称。 string
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴目标将是
在此资源组下创建。		 string
resourceMoveChangeHistory 更改资源移动的历史记录。 ResourceMoveChangeHistory[]
endpointType 设置对象类型 需要 WebHook ()

ResourceMoveChangeHistory

名称 说明 值
azureSubscriptionId 资源的 Azure 订阅 ID。 字符串
changedTimeUtc 资源更改时的 UTC 时间戳。 字符串
resourceGroupName 资源的 Azure 资源组。 string

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 应用程序 ID 或 URI，用于获取将作为持有者令牌包含在传递请求中的访问令牌。 string
azureActiveDirectoryTenantId Azure Active Directory 租户 ID，用于获取将作为持有者令牌包含在传递请求中的访问令牌。 string

PartnerTopicInfo

名称 说明 值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴主题将是
在此 Azure 订阅下创建。		 string
eventTypeInfo 合作伙伴主题的事件类型信息。 此信息由发布者提供，可供
订阅者，用于查看发布的不同类型的事件。		 EventTypeInfo
name 与频道关联的合作伙伴主题的名称。 字符串
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴主题将是
在此资源组下创建。		 string
source 源信息由发布者提供，用于确定事件的范围或上下文
是发起的。 此信息可供订阅者在 审批过程中使用
已创建合作伙伴主题。
 字符串

EventTypeInfo

名称 说明 值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键属于字符串类型，表示事件的名称。
有效的内联事件名称的一个示例是“Contoso.OrderCreated”。
内联事件类型值的类型为 InlineEventProperties，并包含每个内联事件类型的附加信息。		 EventTypeInfoInlineEventTypes
kind 使用的事件类型。 “内联”

EventTypeInfoInlineEventTypes

名称 说明 值
{customized property} InlineEventProperties

InlineEventProperties

名称 说明 值
dataSchemaUrl 内联事件的 dataSchemaUrl。 string
description 内联事件的说明。 string
documentationUrl 内联事件的文档Url。 string

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"
  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"
              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

名称 说明 Value
type 资源类型 “Microsoft.EventGrid/partnerNamespaces/channels@2021-10-15-preview”
name 资源名称 字符串 (必需)
parent_id 此资源的父资源 ID。 类型为：partnerNamespaces 的资源的 ID
properties 通道的属性。 ChannelProperties

ChannelProperties

名称 说明 值
channelType 表示事件方向流的事件通道的类型。 “PartnerDestination”
“PartnerTopic”
expirationTimeIfNotActivatedUtc 通道的过期时间。 如果此计时器在相应合作伙伴主题从未激活时过期，
频道和相应的合作伙伴主题被删除。		 string
messageForActivation 订阅者可在审批过程中使用的上下文或有用消息。 字符串
partnerDestinationInfo 当 channelType 为 PartnerDestination 并表示与通道对应的合作伙伴目标资源的相关信息时，应填充此属性。 PartnerDestinationInfo
partnerTopicInfo 当 channelType 为 PartnerTopic 并且表示与通道对应的合作伙伴主题资源的相关信息时，应填充此属性。 PartnerTopicInfo
provisioningState 通道的预配状态。 “已取消”
“正在创建”
“正在删除”
“失败”
“成功”
“正在更新”
readinessState 相应合作伙伴主题的就绪状态。 “已激活”
“NeverActivated”

PartnerDestinationInfo

名称 说明 值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴目标将是
在此 Azure 订阅下创建。		 字符串
endpointServiceContext 合作伙伴目标终结点的其他上下文。 string
name 与通道关联的合作伙伴目标的名称。 字符串
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴目标将是
在此资源组下创建。		 string
resourceMoveChangeHistory 更改资源移动的历史记录。 ResourceMoveChangeHistory[]
endpointType 设置对象类型 需要 WebHook ()

ResourceMoveChangeHistory

名称 说明 值
azureSubscriptionId 资源的 Azure 订阅 ID。 string
changedTimeUtc 资源更改时的 UTC 时间戳。 string
resourceGroupName 资源的 Azure 资源组。 string

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 应用程序 ID 或 URI，用于获取将作为持有者令牌包含在传递请求中的访问令牌。 string
azureActiveDirectoryTenantId Azure Active Directory 租户 ID，用于获取将作为持有者令牌包含在传递请求中的访问令牌。 字符串

PartnerTopicInfo

名称 说明 值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴主题将是
在此 Azure 订阅下创建。		 string
eventTypeInfo 合作伙伴主题的事件类型信息。 此信息由发布者提供，可供
订阅者，用于查看发布的不同类型的事件。		 EventTypeInfo
name 与频道关联的合作伙伴主题的名称。 字符串
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴主题将是
在此资源组下创建。		 string
source 源信息由发布者提供，用于确定事件的范围或上下文
是发起的。 此信息可供订阅者在 审批过程中使用
已创建合作伙伴主题。
 string

EventTypeInfo

名称 说明 值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键属于字符串类型，表示事件的名称。
有效的内联事件名称的一个示例是“Contoso.OrderCreated”。
内联事件类型值为 InlineEventProperties 类型，将包含每个内联事件类型的附加信息。		 EventTypeInfoInlineEventTypes
kind 使用的事件类型类型。 “内联”

EventTypeInfoInlineEventTypes

名称 说明 值
{customized property} InlineEventProperties

InlineEventProperties

名称 说明 值
dataSchemaUrl 内联事件的 dataSchemaUrl。 字符串
description 内联事件的说明。 string
documentationUrl 内联事件的 documentationUrl。 字符串