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

Channels - List By Partner Namespace

列出通道。
列出合作伙伴命名空间中的所有通道。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels?api-version=2021-10-15-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerNamespaces/{partnerNamespaceName}/channels?api-version=2021-10-15-preview&$filter={$filter}&$top={$top}

URI 参数

Name In Required Type Description
partnerNamespaceName
path True
  • string

合作伙伴命名空间的名称。

resourceGroupName
path True
  • string

合作伙伴订阅中的资源组的名称。

subscriptionId
path True
  • string

唯一标识Microsoft Azure订阅的订阅凭据。 此订阅 ID 是每个服务调用的 URI 的一部分。

api-version
query True
  • string

要与客户端请求一起使用的 API 版本。

$filter
query
  • string

用于使用 OData 语法筛选搜索结果的查询。 仅允许对“name”属性进行筛选,并且 OData 操作数量有限。 这些操作包括:“contains”函数以及以下逻辑操作:不等于) 的 eq (,对于不等于) ,则为 ne (。 不支持算术运算。 下面是有效的筛选器示例:$filter=contains (namE、“PATTERN”) 和 name ne “PATTERN-1”。 下面是无效的筛选器示例:$filter=location eq 'westus'。

$top
query
  • integer
int32

列表操作每页返回的结果数。 顶部参数的有效范围为 1 到 100。 如果未指定,则返回的默认结果数是每页 20 个项目。

响应

Name Type Description
200 OK

确定

Other Status Codes

错误响应: ***

  • 400 错误请求。

  • 500 内部服务器错误。

示例

Channels_ListByPartnerNamespace

Sample Request

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/channels?api-version=2021-10-15-preview

Sample Response

{
  "value": [
    {
      "properties": {
        "channelType": "PartnerTopic",
        "partnerTopicInfo": {
          "azureSubscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4",
          "resourceGroupName": "examplerg2",
          "name": "examplePartnerTopic1",
          "source": "ContosoCorp.Accounts.User1"
        },
        "messageForActivation": "Example message to approver",
        "expirationTimeIfNotActivatedUtc": "2021-10-21T22:50:25.410433Z",
        "readinessState": "NeverActivated",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/partnerNamespaces/examplePartnerNamespaceName1/changes/exampleChannelName1",
      "name": "exampleChannelName1",
      "type": "Microsoft.EventGrid/partnerNamespaces/channels"
    }
  ]
}

定义

AzureADPartnerClientAuthentication

Azure Active Directory合作伙伴客户端身份验证

Channel

频道信息。

ChannelProvisioningState

通道的预配状态。

ChannelsListResult

列表通道操作的结果

ChannelType

表示事件方向流的事件通道的类型。

createdByType

创建资源的标识的类型。

EventDefinitionKind

所使用的事件类型。

EventTypeInfo

通道的事件类型信息。

InlineEventProperties

有关每个内联事件的其他信息。

PartnerTopicInfo

通道的相应合作伙伴主题的属性。

ReadinessState

相应合作伙伴主题的就绪状态。

ResourceMoveChangeHistory

资源移动的更改历史记录。

systemData

与创建和上次修改资源相关的元数据。

WebhookPartnerDestinationInfo

有关合作伙伴目标的 WebHook 的信息。

AzureADPartnerClientAuthentication

Azure Active Directory合作伙伴客户端身份验证

Name Type Default Value Description
clientAuthenticationType string:
  • AzureAD
AzureAD

客户端身份验证的类型

properties.azureActiveDirectoryApplicationIdOrUri
  • string

Azure Active Directory应用程序 ID 或 URI,用于获取将作为传递请求中的持有者令牌包含的访问令牌。

properties.azureActiveDirectoryTenantId
  • string

Azure Active Directory租户 ID,用于获取将作为传递请求中的持有者令牌包含的访问令牌。

Channel

频道信息。

Name Type Description
id
  • string

资源的完全限定标识符。

name
  • string

资源的名称。

properties.channelType

表示事件方向流的事件通道的类型。

properties.expirationTimeIfNotActivatedUtc
  • string

通道的过期时间。 如果此计时器在从未激活相应的合作伙伴主题时过期,则会删除频道和相应的合作伙伴主题。

properties.messageForActivation
  • string

订阅者可在审批过程中使用的上下文或有用消息。

properties.partnerDestinationInfo PartnerDestinationInfo:

当 channelType 为 PartnerDestination 时,应填充此属性,并表示与通道对应的合作伙伴目标资源的相关信息。

properties.partnerTopicInfo

当 channelType 为 PartnerTopic 时,应填充此属性,并表示与通道对应的合作伙伴主题资源的相关信息。

properties.provisioningState

通道的预配状态。

properties.readinessState

相应合作伙伴主题的就绪状态。

systemData

与通道资源相关的系统元数据。

type
  • string

资源的类型。

ChannelProvisioningState

通道的预配状态。

Name Type Description
Canceled
  • string
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string
Updating
  • string

ChannelsListResult

列表通道操作的结果

Name Type Description
nextLink
  • string

频道下一页的链接。

value

通道的集合。

ChannelType

表示事件方向流的事件通道的类型。

Name Type Description
PartnerDestination
  • string
PartnerTopic
  • string

createdByType

创建资源的标识的类型。

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

EventDefinitionKind

所使用的事件类型。

Name Type Description
Inline
  • string

EventTypeInfo

通道的事件类型信息。

Name Type Description
inlineEventTypes

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

kind

所使用的事件类型。

InlineEventProperties

有关每个内联事件的其他信息。

Name Type Description
dataSchemaUrl
  • string

内联事件的 dataSchemaUrl。

description
  • string

内联事件的说明。

documentationUrl
  • string

内联事件的 documentationUrl。

PartnerTopicInfo

通道的相应合作伙伴主题的属性。

Name Type Description
azureSubscriptionId
  • string

订阅服务器的 Azure 订阅 ID。 与此 Azure 订阅关联的合作伙伴主题将在此 Azure 订阅下创建。

eventTypeInfo

合作伙伴主题的事件类型信息。 此信息由发布者提供,可供订阅者用来查看发布的不同类型的事件。

name
  • string

与频道关联的合作伙伴主题的名称。

resourceGroupName
  • string

订阅者的 Azure 资源组。 与此资源组关联的合作伙伴主题将在该资源组下创建。

source
  • string

源信息由发布者提供,用于确定事件源自的范围或上下文。 在创建合作伙伴主题的审批过程中,订阅者可以使用此信息。

ReadinessState

相应合作伙伴主题的就绪状态。

Name Type Description
Activated
  • string
NeverActivated
  • string

ResourceMoveChangeHistory

资源移动的更改历史记录。

Name Type Description
azureSubscriptionId
  • string

资源的 Azure 订阅 ID。

changedTimeUtc
  • string

更改资源的 UTC 时间戳。

resourceGroupName
  • string

资源的 Azure 资源组。

systemData

与创建和上次修改资源相关的元数据。

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

资源上次修改的时间戳 (UTC)

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

上次修改资源的标识的类型。

WebhookPartnerDestinationInfo

有关合作伙伴目标的 WebHook 的信息。

Name Type Default Value Description
azureSubscriptionId
  • string

订阅服务器的 Azure 订阅 ID。 与此 Azure 订阅关联的合作伙伴目标将在此 Azure 订阅下创建。

endpointServiceContext
  • string

合作伙伴目标终结点的其他上下文。

endpointType string:
  • WebHook
WebHook

合作伙伴目标的终结点类型

name
  • string

与频道关联的合作伙伴目标的名称。

properties.clientAuthentication PartnerClientAuthentication:

合作伙伴客户端身份验证

properties.endpointBaseUrl
  • string

表示合作伙伴目标的终结点的基本 URL。

properties.endpointUrl
  • string

表示合作伙伴目标的终结点的 URL。

resourceGroupName
  • string

订阅者的 Azure 资源组。 与此资源组关联的合作伙伴目标将创建。

resourceMoveChangeHistory

更改资源移动的历史记录。