通过

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

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

  • 项目

Bicep 资源定义

可以使用目标操作部署 partnerNamespaces/channels 资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.EventGrid/partnerNamespaces/channels 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.EventGrid/partnerNamespaces/channels@2024-06-01-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'
            displayName: 'string'
            documentationUrl: 'string'
          }
        }
        kind: 'string'
      }
      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'
  }
}

属性值

AzureADPartnerClientAuthentication

名字 描述 价值
clientAuthenticationType 客户端身份验证的类型 “AzureAD”（必需）
性能 AzureAD ClientAuthentication 属性 AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

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

ChannelProperties

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

EventTypeInfo

名字 描述 价值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键是表示事件名称的类型字符串。
有效的内联事件名称示例是“Contoso.OrderCreated”。
内联事件类型值的类型为 InlineEventProperties，并且将包含每个内联事件类型的附加信息。		 EventTypeInfoInlineEventTypes
类 所使用的事件类型。 “内联”

EventTypeInfoInlineEventTypes

名字 描述 价值

InlineEventProperties

名字 描述 价值
dataSchemaUrl 内联事件的 dataSchemaUrl。 字符串
描述 内联事件的说明。 字符串
displayName 内联事件的 displayName。 字符串
documentationUrl 内联事件的 documentationUrl。 字符串

Microsoft.EventGrid/partnerNamespaces/channels

名字 描述 价值
名字 资源名称 string （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：partnerNamespaces
性能 通道的属性。 ChannelProperties

PartnerClientAuthentication

名字 描述 价值
clientAuthenticationType 对于 AzureADPartnerClientAuthentication，请设置为“AzureAD”。 “AzureAD”（必需）

PartnerDestinationInfo

名字 描述 价值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴目标将是
在此 Azure 订阅下创建。		 字符串
endpointServiceContext 合作伙伴目标终结点的其他上下文。 字符串
endpointType 对于 WebhookPartnerDestinationInfo类型，设置为“WebHook”。 “WebHook”（必需）
名字 与频道关联的合作伙伴目标的名称。 字符串
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴目标将是
在此资源组下创建。		 字符串
resourceMoveChangeHistory 更改资源移动的历史记录。 ResourceMoveChangeHistory[]

PartnerTopicInfo

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

ResourceMoveChangeHistory

名字 描述 价值
azureSubscriptionId 资源的 Azure 订阅 ID。 字符串
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": "2024-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": "string"
      },
      "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"
  }
}

属性值

AzureADPartnerClientAuthentication

名字 描述 价值
clientAuthenticationType 客户端身份验证的类型 “AzureAD”（必需）
性能 AzureAD ClientAuthentication 属性 AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

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

ChannelProperties

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

EventTypeInfo

名字 描述 价值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键是表示事件名称的类型字符串。
有效的内联事件名称示例是“Contoso.OrderCreated”。
内联事件类型值的类型为 InlineEventProperties，并且将包含每个内联事件类型的附加信息。		 EventTypeInfoInlineEventTypes
类 所使用的事件类型。 “内联”

EventTypeInfoInlineEventTypes

名字 描述 价值

InlineEventProperties

名字 描述 价值
dataSchemaUrl 内联事件的 dataSchemaUrl。 字符串
描述 内联事件的说明。 字符串
displayName 内联事件的 displayName。 字符串
documentationUrl 内联事件的 documentationUrl。 字符串

Microsoft.EventGrid/partnerNamespaces/channels

名字 描述 价值
apiVersion API 版本 '2024-06-01-preview'
名字 资源名称 string （必需）
性能 通道的属性。 ChannelProperties
类型 资源类型 “Microsoft.EventGrid/partnerNamespaces/channels”

PartnerClientAuthentication

名字 描述 价值
clientAuthenticationType 对于 AzureADPartnerClientAuthentication，请设置为“AzureAD”。 “AzureAD”（必需）

PartnerDestinationInfo

名字 描述 价值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴目标将是
在此 Azure 订阅下创建。		 字符串
endpointServiceContext 合作伙伴目标终结点的其他上下文。 字符串
endpointType 对于 WebhookPartnerDestinationInfo类型，设置为“WebHook”。 “WebHook”（必需）
名字 与频道关联的合作伙伴目标的名称。 字符串
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴目标将是
在此资源组下创建。		 字符串
resourceMoveChangeHistory 更改资源移动的历史记录。 ResourceMoveChangeHistory[]

PartnerTopicInfo

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

ResourceMoveChangeHistory

名字 描述 价值
azureSubscriptionId 资源的 Azure 订阅 ID。 字符串
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@2024-06-01-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"
              displayName = "string"
              documentationUrl = "string"
            }
          }
          kind = "string"
        }
        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"
  }
}

属性值

AzureADPartnerClientAuthentication

名字 描述 价值
clientAuthenticationType 客户端身份验证的类型 “AzureAD”（必需）
性能 AzureAD ClientAuthentication 属性 AzureADPartnerClientAuthenticationProperties

AzureADPartnerClientAuthenticationProperties

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

ChannelProperties

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

EventTypeInfo

名字 描述 价值
inlineEventTypes 资源的内联事件类型的集合。 内联事件类型键是表示事件名称的类型字符串。
有效的内联事件名称示例是“Contoso.OrderCreated”。
内联事件类型值的类型为 InlineEventProperties，并且将包含每个内联事件类型的附加信息。		 EventTypeInfoInlineEventTypes
类 所使用的事件类型。 “内联”

EventTypeInfoInlineEventTypes

名字 描述 价值

InlineEventProperties

名字 描述 价值
dataSchemaUrl 内联事件的 dataSchemaUrl。 字符串
描述 内联事件的说明。 字符串
displayName 内联事件的 displayName。 字符串
documentationUrl 内联事件的 documentationUrl。 字符串

Microsoft.EventGrid/partnerNamespaces/channels

名字 描述 价值
名字 资源名称 string （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：partnerNamespaces
性能 通道的属性。 ChannelProperties
类型 资源类型 “Microsoft.EventGrid/partnerNamespaces/channels@2024-06-01-preview”

PartnerClientAuthentication

名字 描述 价值
clientAuthenticationType 对于 AzureADPartnerClientAuthentication，请设置为“AzureAD”。 “AzureAD”（必需）

PartnerDestinationInfo

名字 描述 价值
azureSubscriptionId 订阅者的 Azure 订阅 ID。 与频道关联的合作伙伴目标将是
在此 Azure 订阅下创建。		 字符串
endpointServiceContext 合作伙伴目标终结点的其他上下文。 字符串
endpointType 对于 WebhookPartnerDestinationInfo类型，设置为“WebHook”。 “WebHook”（必需）
名字 与频道关联的合作伙伴目标的名称。 字符串
resourceGroupName 订阅者的 Azure 资源组。 与频道关联的合作伙伴目标将是
在此资源组下创建。		 字符串
resourceMoveChangeHistory 更改资源移动的历史记录。 ResourceMoveChangeHistory[]

PartnerTopicInfo

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

ResourceMoveChangeHistory

名字 描述 价值
azureSubscriptionId 资源的 Azure 订阅 ID。 字符串
changedTimeUtc 更改资源的 UTC 时间戳。 字符串
resourceGroupName 资源的 Azure 资源组。 字符串

WebhookPartnerDestinationInfo

名字 描述 价值
endpointType 合作伙伴目标的终结点类型 “WebHook”（必需）
性能 合作伙伴目标的 WebHook 属性。 WebhookPartnerDestinationProperties

WebhookPartnerDestinationProperties

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