您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的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=2020-10-15-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains?api-version=2020-10-15-preview&$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"函数以及以下逻辑操作:not、and 或 eq (表示等于) ,ne (表示不等于) 。 不支持算术运算。 下面是有效的筛选器示例:$filter=contains (namE, 'PATTERN') name ne 'PATTERN-1'。 以下不是有效的筛选器示例:$filter=location eq 'westus'。

$top
query
  • integer
int32

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

响应

Name Type Description
200 OK

确定

Other Status Codes

错误响应: ?

  • 400 错误的请求。

  • 500 内部服务器错误。

示例

Domains_ListBySubscription

Sample Request

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

Sample Response

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

创建资源的标识类型。

Domain

EventGrid 域。

DomainProvisioningState

域的预配状态。

DomainsListResult

列出域操作的结果

IdentityInfo

资源的标识信息。

IdentityType

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

InboundIpRule
InputSchema

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

IpActionType

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

JsonField

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

JsonFieldWithDefault

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

JsonInputSchemaMapping

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

PersistedConnectionStatus

连接的状态。

PrivateEndpoint

PrivateEndpoint 信息。

PrivateEndpointConnection
PublicNetworkAccess

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

ResourceProvisioningState

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

ResourceSku

描述 EventGrid 资源 SKU。

Sku

资源的 SKU 名称。 可能的值为:"基本"或"高级"。

systemData

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

UserIdentityProperties

有关用户标识的信息。

ConnectionState

ConnectionState 信息。

Name Type Description
actionsRequired
  • string

如果有任何 (,) 。

description
  • string

连接状态的说明。

status

连接的状态。

createdByType

创建资源的标识类型。

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

Domain

EventGrid 域。

Name Type Description
id
  • string

资源的完全限定标识符。

identity

资源的标识信息。

location
  • string

资源的位置。

name
  • string

资源的名称。

properties.endpoint
  • string

域的终结点。

properties.inboundIpRules

这可用于限制来自特定 IP 的流量,而不是所有 IP 的流量。 注意:只有在启用了 PublicNetworkAccess 时,才考虑这些参数。

properties.inputSchema

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

properties.inputSchemaMapping InputSchemaMapping:

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

properties.metricResourceId
  • string

域的指标资源 ID。

properties.privateEndpointConnections

专用终结点连接的列表。

properties.provisioningState

域的预配状态。

properties.publicNetworkAccess

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

sku

域的 SKU 定价层。

systemData

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

tags
  • object

资源的标记。

type
  • string

资源的类型。

DomainProvisioningState

域的预配状态。

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

DomainsListResult

列出域操作的结果

Name Type Description
nextLink
  • string

域的下一页的链接

value

域的集合

IdentityInfo

资源的标识信息。

Name Type Description
principalId
  • string

资源标识的主体 ID。

tenantId
  • string

资源的租户 ID。

type

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

userAssignedIdentities

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

IdentityType

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

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned, UserAssigned
  • string
UserAssigned
  • string

InboundIpRule

Name Type Description
action

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

ipMask
  • string

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

InputSchema

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

Name Type Description
CloudEventSchemaV1_0
  • string
CustomEventSchema
  • string
EventGridSchema
  • string

IpActionType

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

Name Type Description
Allow
  • string

JsonField

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

Name Type Description
sourceField
  • string

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

JsonFieldWithDefault

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

Name Type Description
defaultValue
  • string

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

sourceField
  • string

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

JsonInputSchemaMapping

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

Name Type Description
inputSchemaMappingType string:
  • Json

自定义映射的类型

properties.dataVersion

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

properties.eventTime

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

properties.eventType

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

properties.id

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

properties.subject

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

properties.topic

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

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

ResourceSku

描述 EventGrid 资源 SKU。

Name Type Description
name

资源的 SKU 名称。 可能的值为:"基本"或"高级"。

Sku

资源的 SKU 名称。 可能的值为:"基本"或"高级"。

Name Type Description
Basic
  • string
Premium
  • string

systemData

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

Name Type Description
createdAt
  • string

UTC (资源创建) 。

createdBy
  • string

创建资源的标识。

createdByType

创建资源的标识类型。

lastModifiedAt
  • string

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

lastModifiedBy
  • string

上次修改资源的标识。

lastModifiedByType

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

UserIdentityProperties

有关用户标识的信息。

Name Type Description
clientId
  • string

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

principalId
  • string

用户分配标识的主体 ID。