Get-AzEventGridTopicEventSubscription
Get properties of an event subscription of a topic.
Syntax
Get-AzEventGridTopicEventSubscription
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-TopicName <String>
[-Filter <String>]
[-Top <Int32>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Get-AzEventGridTopicEventSubscription
-EventSubscriptionName <String>
-TopicInputObject <IEventGridIdentity>
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Get-AzEventGridTopicEventSubscription
-EventSubscriptionName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
-TopicName <String>
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Get-AzEventGridTopicEventSubscription
-InputObject <IEventGridIdentity>
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>] Description
Get properties of an event subscription of a topic.
Examples
Example 1: List properties of event subscription of a topic.
Get-AzEventGridTopicEventSubscription -ResourceGroupName azps_test_group_eventgrid -TopicName azps-topic
Name ResourceGroupName
---- -----------------
azps-eventsub azps_test_group_eventgridList properties of event subscription of a topic.
Example 2: Get properties of an event subscription of a topic.
Get-AzEventGridTopicEventSubscription -ResourceGroupName azps_test_group_eventgrid -TopicName azps-topic -EventSubscriptionName azps-eventsub
Name ResourceGroupName
---- -----------------
azps-eventsub azps_test_group_eventgridGet properties of an event subscription of a topic.
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 |
-EventSubscriptionName
Name of the event subscription to be found. Event subscription names must be between 3 and 100 characters in length and use alphanumeric letters only.
| 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 |
-PassThru
Returns true when the command succeeds
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-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 |
-TopicInputObject
Identity Parameter
| Type: | IEventGridIdentity |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TopicName
Name of the topic.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |