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

Domains - List By Subscription

列出 Azure 订阅下的域。
列出 Azure 订阅下的所有域。

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

URI 参数

名称 必需 类型 说明
subscriptionId
path True

string

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

api-version
query True

string

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

$filter
query

string

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

$top
query

integer

int32

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

响应

名称 类型 说明
200 OK

DomainsListResult

确定

Other Status Codes

错误响应: ***

  • 400 错误请求。

  • 500 内部服务器错误。

示例

Domains_ListBySubscription

示例请求

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

示例响应

{
  "value": [
    {
      "properties": {
        "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1",
      "location": "westus2",
      "name": "exampledomain1",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "type": "Microsoft.EventGrid/domains"
    },
    {
      "properties": {
        "endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events",
        "provisioningState": "Succeeded"
      },
      "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2",
      "location": "westcentralus",
      "name": "exampledomain2",
      "tags": {
        "tag1": "value1",
        "tag2": "value2"
      },
      "type": "Microsoft.EventGrid/domains"
    }
  ]
}

定义

名称 说明
ConnectionState

ConnectionState 信息。

createdByType

创建资源的标识类型。

DataResidencyBoundary

资源Data Residency边界。

Domain

EventGrid 域。

DomainProvisioningState

事件网格域资源的预配状态。

DomainsListResult

列出域操作的结果。

IdentityInfo

资源的标识信息。

IdentityType

使用的托管标识的类型。 类型“SystemAssigned, UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

InboundIpRule
InputSchema

这决定了事件网格对发布到事件网格域资源的传入事件应采用的格式。

IpActionType

要根据 IpMask 的匹配项或不匹配执行的操作。

JsonField

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前用于“id”、“topic”和“eventtime”属性的映射中。 这表示输入事件架构中的字段。

JsonFieldWithDefault

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这目前在“subject”、“eventtype”和“dataversion”属性的映射中使用。 这表示输入事件架构中的字段以及要使用的默认值,并且至少应提供这两个属性中的一个。

JsonInputSchemaMapping

这允许使用自定义输入架构发布到事件网格。 这可用于将属性从自定义输入 JSON 架构映射到事件网格事件架构。

PersistedConnectionStatus

连接状态。

PrivateEndpoint

PrivateEndpoint 信息。

PrivateEndpointConnection
PublicNetworkAccess

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

ResourceProvisioningState

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

systemData

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

UserIdentityProperties

有关用户标识的信息。

ConnectionState

ConnectionState 信息。

名称 类型 说明
actionsRequired

string

如果有任何) , (所需的操作。

description

string

连接状态的说明。

status

PersistedConnectionStatus

连接状态。

createdByType

创建资源的标识类型。

名称 类型 说明
Application

string

Key

string

ManagedIdentity

string

User

string

DataResidencyBoundary

资源Data Residency边界。

名称 类型 说明
WithinGeopair

string

WithinRegion

string

Domain

EventGrid 域。

名称 类型 默认值 说明
id

string

资源的完全限定标识符。

identity

IdentityInfo

事件网格域资源的标识信息。

location

string

资源的位置。

name

string

资源的名称。

properties.autoCreateTopicWithFirstSubscription

boolean

True

此布尔值用于指定与此事件网格域资源关联的“所有”事件网格域主题的创建机制。 在此上下文中,当为 true) 时,可以自动管理域主题的创建 (;如果为 false) ,则可以创建自托管 (。 此属性的默认值为 true。 当此属性为 null 或设置为 true 时,事件网格负责在域主题范围内创建第一个事件订阅时自动创建域主题。 如果此属性设置为 false,则创建第一个事件订阅需要用户创建域主题。 如果用户希望完全控制域主题的创建时间,则可以使用自我管理模式,而自动管理模式则提供灵活性,可以让用户执行更少的操作和管理更少的资源。 另请注意,在自动管理的创建模式下,允许用户根据需要按需创建域主题。

properties.autoDeleteTopicWithLastSubscription

boolean

True

此布尔值用于指定与此事件网格域资源关联的“所有”事件网格域主题的删除机制。 在此上下文中,当为 true) 时,可以自动管理 (域主题的删除;如果为 false) ,则可以进行自我管理 (。 此属性的默认值为 true。 当此属性设置为 true 时,事件网格负责在删除域主题范围内的最后一个事件订阅时自动删除域主题。 如果此属性设置为 false,则用户需要在不再需要域主题时手动删除该主题 (例如,删除最后一个事件订阅并且需要清理资源) 。 如果用户希望完全控制何时需要删除域主题,则可以使用自我管理模式,而自动管理模式则提供灵活性,可以让用户执行更少的操作和管理更少的资源。

properties.dataResidencyBoundary

DataResidencyBoundary

资源Data Residency边界。

properties.disableLocalAuth

boolean

False

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

properties.endpoint

string

用于发布事件的事件网格域资源的终结点。

properties.inboundIpRules

InboundIpRule[]

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

properties.inputSchema

InputSchema

EventGridSchema

这决定了事件网格对发布到事件网格域资源的传入事件应采用的格式。

properties.inputSchemaMapping InputSchemaMapping:

JsonInputSchemaMapping

有关 InputSchemaMapping 的信息,它指定了有关映射事件有效负载的信息。

properties.metricResourceId

string

事件网格域资源的指标资源 ID。

properties.privateEndpointConnections

PrivateEndpointConnection[]

专用终结点连接列表。

properties.provisioningState

DomainProvisioningState

事件网格域资源的预配状态。

properties.publicNetworkAccess

PublicNetworkAccess

Enabled

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

systemData

systemData

与事件网格域资源相关的系统元数据。

tags

object

资源的标记。

type

string

资源的类型。

DomainProvisioningState

事件网格域资源的预配状态。

名称 类型 说明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

DomainsListResult

列出域操作的结果。

名称 类型 说明
nextLink

string

指向下一页域的链接。

value

Domain[]

域的集合。

IdentityInfo

资源的标识信息。

名称 类型 说明
principalId

string

资源标识的主体 ID。

tenantId

string

资源的租户 ID。

type

IdentityType

使用的托管标识的类型。 类型“SystemAssigned, UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

userAssignedIdentities

<string,  UserIdentityProperties>

与资源关联的用户标识列表。 用户标识字典键引用将是 ARM 资源 ID,格式为:“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 此属性当前未使用,保留以供将来使用。

IdentityType

使用的托管标识的类型。 类型“SystemAssigned, UserAssigned”包括隐式创建的标识和一组用户分配的标识。 类型“None”将删除任何标识。

名称 类型 说明
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

InboundIpRule

名称 类型 说明
action

IpActionType

要根据 IpMask 的匹配项或不匹配执行的操作。

ipMask

string

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

InputSchema

这决定了事件网格对发布到事件网格域资源的传入事件应采用的格式。

名称 类型 说明
CloudEventSchemaV1_0

string

CustomEventSchema

string

EventGridSchema

string

IpActionType

要根据 IpMask 的匹配项或不匹配执行的操作。

名称 类型 说明
Allow

string

JsonField

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这当前用于“id”、“topic”和“eventtime”属性的映射中。 这表示输入事件架构中的字段。

名称 类型 说明
sourceField

string

要用作映射源的输入事件架构中的字段的名称。

JsonFieldWithDefault

这用于表示事件网格事件架构中单个目标字段的输入架构映射的源。 这目前在“subject”、“eventtype”和“dataversion”属性的映射中使用。 这表示输入事件架构中的字段以及要使用的默认值,并且至少应提供这两个属性中的一个。

名称 类型 说明
defaultValue

string

如果未提供 SourceField,或者发布的 JSON 事件有效负载中没有具有指定名称的属性,则用于映射的默认值。

sourceField

string

要用作映射源的输入事件架构中的字段的名称。

JsonInputSchemaMapping

这允许使用自定义输入架构发布到事件网格。 这可用于将属性从自定义输入 JSON 架构映射到事件网格事件架构。

名称 类型 说明
inputSchemaMappingType string:

Json

自定义映射的类型

properties.dataVersion

JsonFieldWithDefault

事件网格事件的 DataVersion 属性的映射信息。

properties.eventTime

JsonField

事件网格事件的 EventTime 属性的映射信息。

properties.eventType

JsonFieldWithDefault

事件网格事件的 EventType 属性的映射信息。

properties.id

JsonField

事件网格事件的 Id 属性的映射信息。

properties.subject

JsonFieldWithDefault

事件网格事件的 Subject 属性的映射信息。

properties.topic

JsonField

事件网格事件的 Topic 属性的映射信息。

PersistedConnectionStatus

连接状态。

名称 类型 说明
Approved

string

Disconnected

string

Pending

string

Rejected

string

PrivateEndpoint

PrivateEndpoint 信息。

名称 类型 说明
id

string

专用终结点的 ARM 标识符。

PrivateEndpointConnection

名称 类型 说明
id

string

资源的完全限定标识符。

name

string

资源的名称。

properties.groupIds

string[]

专用链接服务资源的 GroupIds。

properties.privateEndpoint

PrivateEndpoint

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

properties.privateLinkServiceConnectionState

ConnectionState

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

properties.provisioningState

ResourceProvisioningState

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

type

string

资源的类型。

PublicNetworkAccess

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

名称 类型 说明
Disabled

string

Enabled

string

ResourceProvisioningState

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

名称 类型 说明
Canceled

string

Creating

string

Deleting

string

Failed

string

Succeeded

string

Updating

string

systemData

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

名称 类型 说明
createdAt

string

资源创建时间戳 (UTC) 。

createdBy

string

创建资源的标识。

createdByType

createdByType

创建资源的标识类型。

lastModifiedAt

string

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

lastModifiedBy

string

上次修改资源的标识。

lastModifiedByType

createdByType

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

UserIdentityProperties

有关用户标识的信息。

名称 类型 说明
clientId

string

用户分配标识的客户端 ID。

principalId

string

用户分配标识的主体 ID。