Get-AzEventGridSubscription

  • Reference
Module:
Az.EventGrid

Get properties of an event subscription.

Syntax

Get-AzEventGridSubscription
   -Name <String>
   -Scope <String>
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]
Get-AzEventGridSubscription
   -InputObject <IEventGridIdentity>
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]
Get-AzEventGridSubscription
   -ProviderNamespace <String>
   -ResourceGroupName <String>
   -ResourceName <String>
   -ResourceTypeName <String>
   [-SubscriptionId <String[]>]
   [-Filter <String>]
   [-Top <Int32>]
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]
Get-AzEventGridSubscription
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   -DomainName <String>
   -TopicName <String>
   [-Filter <String>]
   [-Top <Int32>]
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]

Description

Get properties of an event subscription.

Examples

Example 1: Get properties of an event subscription.

Get-AzEventGridSubscription -ResourceGroupName azps_test_group_eventgrid -DomainName azps-domain -TopicName azps-topic

Name              ResourceGroupName
----              -----------------
azps-eventsubname azps_test_group_eventgrid

Get properties of an event subscription.

Example 2: Get properties of an event subscription.

Get-AzEventGridSubscription -Name azps-eventsub -Scope "/subscriptions/{subId}/resourceGroups/azps_test_group_eventgrid/providers/Microsoft.EventGrid/topics/azps-topic"

Name          ResourceGroupName
----          -----------------
azps-eventsub azps_test_group_eventgrid

Get properties of an event subscription.

Parameters

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DomainName

Name of the top level domain.

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

-Filter

The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.

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

-InputObject

Identity Parameter

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

-Name

Name of the event subscription.

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

-PassThru

Returns true when the command succeeds

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

-ProviderNamespace

Namespace of the provider of the topic.

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

-ResourceGroupName

The name of the resource group within the user's subscription.

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

-ResourceName

Name of the resource.

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

-ResourceTypeName

Name of the resource type.

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

-Scope

The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.

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

-SubscriptionId

Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Type:String[]
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Top

The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.

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

-TopicName

Name of the domain topic.

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

Inputs

IEventGridIdentity

Outputs

IEventSubscription