Modifier

Get-AzEventGridSubscriptionRegional

Module:
Az.EventGrid Module

List all event subscriptions from the given location under a specific Azure subscription.

Syntax

List (Default) 

Get-AzEventGridSubscriptionRegional
    -Location <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Top <Int32>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

List3 

Get-AzEventGridSubscriptionRegional
    -Location <String>
    -ResourceGroupName <String>
    -TopicTypeName <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Top <Int32>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

List1 

Get-AzEventGridSubscriptionRegional
    -Location <String>
    -ResourceGroupName <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Top <Int32>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

List2 

Get-AzEventGridSubscriptionRegional
    -Location <String>
    -TopicTypeName <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Top <Int32>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

Description

List all event subscriptions from the given location under a specific Azure subscription.

Examples

Example 1: List all event subscriptions from the given location under a specific Azure subscription.

Get-AzEventGridSubscriptionRegional -Location eastus

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

List all event subscriptions from the given location under a specific Azure subscription.

Example 2: List all event subscriptions from the given location under a specific Azure subscription.

Get-AzEventGridSubscriptionRegional -Location eastus -ResourceGroupName azps_test_group_eventgrid

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

List all event subscriptions from the given location under a specific Azure subscription.

Parameters

-DefaultProfile

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

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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'.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Location

Name of the location.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns true when the command succeeds

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ResourceGroup

Parameter sets

List3
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List1
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

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

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TopicTypeName

Name of the topic type.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

List3
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
List2
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

IEventSubscription