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

Partner Namespaces - List By Subscription

列出 Azure 订阅下的合作伙伴命名空间。
列出 Azure 订阅下的所有合作伙伴命名空间。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2022-06-15
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2022-06-15&$filter={$filter}&$top={$top}

URI 参数

Name In Required Type Description
subscriptionId
path True
  • string

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

api-version
query True
  • string

要用于客户端请求的 API 的版本。

$filter
query
  • string

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

$top
query
  • integer
int32

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

响应

Name Type Description
200 OK

确定

Other Status Codes

错误响应: ***

  • 400 错误请求。

  • 500 内部服务器错误。

示例

PartnerNamespaces_ListBySubscription

Sample Request

GET https://management.azure.com/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/partnerNamespaces?api-version=2022-06-15

Sample Response

{
  "value": [
    {
      "properties": {
        "provisioningState": "Succeeded",
        "partnerRegistrationFullyQualifiedId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerRegistrations/ContosoCorpAccount1",
        "endpoint": "https://partnernamespace123.centraluseuap-1.eventgrid.azure.net/api/events"
      },
      "location": "Central US EUAP",
      "tags": {
        "key1": "value1",
        "key2": "value2",
        "key3": "value3"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/amh/providers/Microsoft.EventGrid/partnerNamespaces/partnerNamespace123",
      "name": "partnerNamespace123",
      "type": "Microsoft.EventGrid/partnerNamespaces"
    }
  ]
}

定义

ConnectionState

ConnectionState 信息。

createdByType

创建资源的标识的类型。

InboundIpRule
IpActionType

基于匹配项或 IpMask 不匹配执行的操作。

PartnerNamespace

EventGrid 合作伙伴命名空间。

PartnerNamespaceProvisioningState

合作伙伴命名空间的预配状态。

PartnerNamespacesListResult

列出合作伙伴命名空间操作的结果

PartnerTopicRoutingMode

这确定发布到此合作伙伴命名空间的事件是否应在事件有效负载中使用源属性,或者在与合作伙伴主题匹配时使用标头中的通道名称。 如果未指定任何属性,则源属性路由将用于匹配合作伙伴主题。

PersistedConnectionStatus

连接的状态。

PrivateEndpoint

PrivateEndpoint 信息。

PrivateEndpointConnection
PublicNetworkAccess

这确定是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP

ResourceProvisioningState

专用终结点连接的预配状态。

systemData

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

ConnectionState

ConnectionState 信息。

Name Type Description
actionsRequired
  • string

如果有任何) ,则需要 (操作。

description
  • string

连接状态的说明。

status

连接的状态。

createdByType

创建资源的标识的类型。

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

InboundIpRule

Name Type Description
action

基于匹配项或 IpMask 不匹配执行的操作。

ipMask
  • string

CIDR 表示法中的 IP 地址,例如 10.0.0.0/8。

IpActionType

基于匹配项或 IpMask 不匹配执行的操作。

Name Type Description
Allow
  • string

PartnerNamespace

EventGrid 合作伙伴命名空间。

Name Type Default Value Description
id
  • string

资源的完全限定标识符。

location
  • string

资源的位置。

name
  • string

资源的名称。

properties.disableLocalAuth
  • boolean
False

此布尔值用于启用或禁用本地身份验证。默认值为 false。 当属性设置为 true 时,如果允许用户发布到合作伙伴命名空间,则仅使用 AAD 令牌进行身份验证。

properties.endpoint
  • string

合作伙伴命名空间的终结点。

properties.inboundIpRules

这可用于限制来自特定 IP 而不是所有 IP 的流量。 注意:仅当启用了 PublicNetworkAccess 时,才会考虑这些内容。

properties.partnerRegistrationFullyQualifiedId
  • string

应与此合作伙伴命名空间关联的合作伙伴注册的完全限定 ARM ID。 采用以下格式:/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}。

properties.partnerTopicRoutingMode SourceEventAttribute

这确定发布到此合作伙伴命名空间的事件是否应在事件有效负载中使用源属性,或者在与合作伙伴主题匹配时使用标头中的通道名称。 如果未指定任何属性,则源属性路由将用于匹配合作伙伴主题。

properties.privateEndpointConnections
properties.provisioningState

合作伙伴命名空间的预配状态。

properties.publicNetworkAccess Enabled

这确定是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP

systemData

与合作伙伴命名空间资源相关的系统元数据。

tags
  • object

资源的标记。

type
  • string

资源的类型。

PartnerNamespaceProvisioningState

合作伙伴命名空间的预配状态。

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

PartnerNamespacesListResult

列出合作伙伴命名空间操作的结果

Name Type Description
nextLink
  • string

合作伙伴命名空间的下一页的链接。

value

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

PartnerTopicRoutingMode

这确定发布到此合作伙伴命名空间的事件是否应在事件有效负载中使用源属性,或者在与合作伙伴主题匹配时使用标头中的通道名称。 如果未指定任何属性,则源属性路由将用于匹配合作伙伴主题。

Name Type Description
ChannelNameHeader
  • string
SourceEventAttribute
  • string

PersistedConnectionStatus

连接的状态。

Name Type Description
Approved
  • string
Disconnected
  • string
Pending
  • string
Rejected
  • string

PrivateEndpoint

PrivateEndpoint 信息。

Name Type Description
id
  • string

专用终结点的 ARM 标识符。

PrivateEndpointConnection

Name Type Description
id
  • string

资源的完全限定标识符。

name
  • string

资源的名称。

properties.groupIds
  • string[]

专用链接服务资源的 GroupId。

properties.privateEndpoint

此连接的专用终结点资源。

properties.privateLinkServiceConnectionState

有关连接状态的详细信息。

properties.provisioningState

专用终结点连接的预配状态。

type
  • string

资源的类型。

PublicNetworkAccess

这确定是否允许通过公用网络流量。 默认情况下,它处于启用状态。 可以通过配置进一步限制为特定 IP

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceProvisioningState

专用终结点连接的预配状态。

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

systemData

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

Name Type Description
createdAt
  • string

资源创建时间戳 (UTC) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识的类型。

lastModifiedAt
  • string

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

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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