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

Get-AzEventGridSubscription

模块:

Az.EventGrid

获取事件订阅的详细信息，或获取当前 Azure 订阅中所有事件订阅的列表。

语法

Get-AzEventGridSubscription
   [-EventSubscriptionName <String>]
   [-ResourceGroupName <String>]
   [-TopicName <String>]
   [-IncludeFullEndpointUrl]
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridSubscription
   [-EventSubscriptionName <String>]
   [-ResourceId] <String>
   [-IncludeFullEndpointUrl]
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridSubscription
   [-EventSubscriptionName <String>]
   [-ResourceGroupName <String>]
   [-DomainName <String>]
   [-DomainTopicName <String>]
   [-IncludeFullEndpointUrl]
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridSubscription
   [-ResourceGroupName <String>]
   [-TopicTypeName <String>]
   [-Location <String>]
   [-IncludeFullEndpointUrl]
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridSubscription
   [-InputObject] <PSTopic>
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridSubscription
   [-DomainInputObject] <PSDomain>
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridSubscription
   [-DomainTopicInputObject] <PSDomainTopic>
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridSubscription
   [-NextLink <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

说明

Get-AzEventGridSubscription cmdlet 获取指定事件网格订阅的详细信息，或当前 Azure 订阅或资源组中所有事件网格订阅的列表。 如果提供了事件订阅名称，则会返回单个事件网格订阅的详细信息。 如果未提供事件订阅名称，则返回所有事件订阅的列表。 此列表中返回的元素数由 Top 参数控制。 如果未指定 Top 值或$null，列表将包含所有事件订阅项。 否则，Top 将指示列表中要返回的最大元素数。 如果仍有更多事件订阅可用，则应在下一次调用中使用 NextLink 中的值来获取下一页的事件订阅。 最后，ODataQuery 参数用于对搜索结果执行筛选。 筛选查询仅使用 Name 属性遵循 OData 语法。 支持的操作包括：CONTAINS、eq（等于）、ne（不等于）、AND、OR 和 NOT。

示例

示例 1

Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -EventSubscriptionName EventSubscription1

获取为资源组“MyResourceGroupName”中的主题“Topic1”创建的事件订阅“EventSubscription1”的详细信息。

示例 2

Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -EventSubscriptionName EventSubscription1 -IncludeFullEndpointUrl

获取为资源组“MyResourceGroupName”中的主题“Topic1”创建的事件订阅“EventSubscription1”的详细信息，包括基于 Webhook 的事件订阅时的完整终结点 URL。

示例 3

Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1

获取为资源组“MyResourceGroupName”中没有分页的主题“Topic1”创建的所有事件订阅的列表。

示例 4

$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -TopicName Topic1 -Top 10 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink

列出为满足$odataFilter查询的资源组“MyResourceGroupName”中的主题“Topic1”创建的前 10 个事件订阅（如果有）。 如果有更多结果可用，$result。NextLink 不会$null。 为了获取事件订阅的下一页，用户应重新调用 Get-AzEventGridSubscription 并使用结果。从上一次调用获取的 NextLink。 调用方应在结果时停止。NextLink 变为$null。

示例 5

Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -EventSubscriptionName EventSubscription1

获取为资源组“MyResourceGroupName”创建的事件订阅“EventSubscription1”的详细信息。

示例 6

Get-AzEventGridSubscription -EventSubscriptionName EventSubscription1

获取为当前选定的 Azure 订阅创建的事件订阅“EventSubscription1”的详细信息。

示例 7

Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName

获取未分页的资源组“MyResourceGroupName”下创建的所有全局事件订阅的列表。

示例 8

$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Top 5 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink

列出在满足$odataFilter查询的资源组“MyResourceGroupName”下创建的前 5 个事件订阅（如果有）。 如果有更多结果可用，$result。NextLink 不会$null。 为了获取事件订阅的下一页，用户应重新调用 Get-AzEventGridSubscription 并使用结果。从上一次调用获取的 NextLink。 调用方应在结果时停止。NextLink 变为$null。

示例 9

Get-AzEventGridSubscription

获取在当前所选 Azure 订阅下创建的所有全局事件订阅的列表，无需分页。

示例 10

$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -Top 15 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink

列出在当前所选 Azure 订阅下创建的满足$odataFilter查询的前 15 个全局事件订阅（如果有）。 如果有更多结果可用，$result。NextLink 不会$null。 为了获取事件订阅的下一页，用户应重新调用 Get-AzEventGridSubscription 并使用结果。从上一次调用获取的 NextLink。 调用方应在结果时停止。NextLink 变为$null。

示例 11

Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Location westus2

获取未分页的指定位置“westus2”中资源组“MyResourceGroupName”下创建的所有区域事件订阅的列表。

示例 12

$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -ResourceGroupName MyResourceGroupName -Location westus2 -Top 15 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink

列出满足$odataFilter查询的指定位置“myResourceGroupName”下在资源组“MyResourceGroupName”下创建的前 15 个区域事件订阅（如果有）。 如果有更多结果可用，$result。NextLink 不会$null。 为了获取事件订阅的下一页，用户应重新调用 Get-AzEventGridSubscription 并使用结果。从上一次调用获取的 NextLink。 调用方应在结果时停止。NextLink 变为$null。

示例 13

Get-AzEventGridSubscription -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName"

获取为未分页的指定 EventHub 命名空间创建的所有事件订阅的列表。

示例 14

$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -ResourceId "/subscriptions/$subscriptionId/resourceGroups/$resourceGroupName/providers/Microsoft.EventHub/namespaces/$namespaceName" -Top 25 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink

列出为满足$odataFilter查询的指定 EventHub 命名空间创建的前 25 个事件订阅（如果有）。 如果有更多结果可用，$result。NextLink 不会$null。 为了获取事件订阅的下一页，用户应重新调用 Get-AzEventGridSubscription 并使用结果。从上一次调用获取的 NextLink。 调用方应在结果时停止。NextLink 变为$null。

示例 15

Get-AzEventGridSubscription -TopicTypeName "Microsoft.EventHub.Namespaces" -Location $location

获取为指定主题类型（EventHub 命名空间）创建的所有事件订阅的列表，而不分页。

示例 16

$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -TopicTypeName "Microsoft.EventHub.Namespaces" -Location $location -Top 15 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink

列出在满足$odataFilter查询的指定位置为指定主题类型（EventHub 命名空间）创建的前 15 个事件订阅（如果有）。 如果有更多结果可用，$result。NextLink 不会$null。 为了获取事件订阅的下一页，用户应重新调用 Get-AzEventGridSubscription 并使用结果。从上一次调用获取的 NextLink。 调用方应在结果时停止。NextLink 变为$null。

示例 17

Get-AzEventGridSubscription -TopicTypeName "Microsoft.Resources.ResourceGroups" -ResourceGroupName MyResourceGroupName

获取为没有分页的特定资源组创建的所有事件订阅的列表。

示例 18

$odataFilter = "Name ne 'ABCD'"
Get-AzEventGridSubscription -TopicTypeName "Microsoft.Resources.ResourceGroups" -ResourceGroupName MyResourceGroupName -Top 100 -ODataQuery $odataFilter
Get-AzEventGridSubscription $result.NextLink

列出为满足$odataFilter查询的特定资源组创建的前 100 个事件订阅（如果有）。 如果有更多结果可用，$result。NextLink 不会$null。 为了获取事件订阅的下一页，用户应重新调用 Get-AzEventGridSubscription 并使用结果。从上一次调用获取的 NextLink。 调用方应在结果时停止。NextLink 变为$null。

参数

-DefaultProfile

用于与 azure 通信的凭据、帐户、租户和订阅

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DomainInputObject

EventGrid 域对象。

Type:	PSDomain
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DomainName

EventGrid 域名。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-DomainTopicInputObject

EventGrid 域主题对象。

Type:	PSDomainTopic
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-DomainTopicName

EventGrid 域主题名称。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-EventSubscriptionName

事件订阅的名称

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-IncludeFullEndpointUrl

包括事件订阅目标的完整终结点 URL。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

EventGrid Topic 对象。

Type:	PSTopic
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Location

位置

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-NextLink

要获取的下一页资源的链接。 当仍有更多资源可供查询时，使用第一个 Get-AzEventGrid cmdlet 调用获取此值。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ODataQuery

用于筛选列表结果的 OData 查询。 目前仅允许对 Name 属性进行筛选。支持的操作包括：CONTAINS、eq（等于）、ne（不等于）、AND、OR 和 NOT。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceGroupName

资源组名称。

Type:	String
Aliases:	ResourceGroup
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-ResourceId

已创建事件订阅的资源的标识符。

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Top

用于筛选列表结果的 OData 查询。 目前仅允许对 Name 属性进行筛选。支持的操作包括：CONTAINS、eq（等于）、ne（不等于）、AND、OR 和 NOT。

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-TopicName

EventGrid 主题名称。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-TopicTypeName

TopicType 名称

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

输入

String

PSTopic

PSDomain

PSDomainTopic

Nullable<T>[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]

输出

PSEventSubscription