Get-AzEventGridDomainTopicEventSubscription

Module:

Az.EventGrid Module

Get properties of a nested event subscription for a domain topic.

Syntax

List (Default)

Get-AzEventGridDomainTopicEventSubscription
    -DomainName <String>
    -ResourceGroupName <String>
    -TopicName <String>
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Top <Int32>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

Get

Get-AzEventGridDomainTopicEventSubscription
    -DomainName <String>
    -EventSubscriptionName <String>
    -ResourceGroupName <String>
    -TopicName <String>
    [-SubscriptionId <String[]>]
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

GetViaIdentityTopic

Get-AzEventGridDomainTopicEventSubscription
    -EventSubscriptionName <String>
    -TopicInputObject <IEventGridIdentity>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

GetViaIdentityDomain

Get-AzEventGridDomainTopicEventSubscription
    -EventSubscriptionName <String>
    -TopicName <String>
    -DomainInputObject <IEventGridIdentity>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

GetViaIdentity

Get-AzEventGridDomainTopicEventSubscription
    -InputObject <IEventGridIdentity>
    [-DefaultProfile <PSObject>]
    [-PassThru]
    [<CommonParameters>]

Description

Get properties of a nested event subscription for a domain topic.

Examples

Example 1: Get properties of a nested event subscription for a domain topic.

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

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

Get properties of a nested event subscription for a domain topic.

Example 2: Get properties of a nested event subscription for a domain topic.

Get-AzEventGridDomainTopicEventSubscription -DomainName azps-domain -ResourceGroupName azps_test_group_eventgrid -TopicName azps-topic -EventSubscriptionName azps-eventsubname

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

Get properties of a nested event subscription for a domain topic.

Example 3: Get properties of a nested event subscription for a domain topic.

$domainTopicObj = Get-AzEventGridDomainTopic -DomainName azps-domain -ResourceGroupName azps_test_group_eventgrid -Name azps-topic
Get-AzEventGridDomainTopicEventSubscription -TopicInputObject $domainTopicObj -EventSubscriptionName azps-eventsubname

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

Get properties of a nested event subscription for a domain topic.

Example 4: Get properties of a nested event subscription for a domain topic.

$domainObj = Get-AzEventGridDomain -ResourceGroupName azps_test_group_eventgrid -Name azps-domain
Get-AzEventGridDomainTopicEventSubscription -DomainInputObject $domainObj -TopicName azps-topic -EventSubscriptionName azps-eventsubname

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

Get properties of a nested event subscription for a domain topic.

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

-DomainInputObject

Identity Parameter

Parameter properties

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

Parameter sets

GetViaIdentityDomain

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

-DomainName

Name of the top level domain.

Parameter properties

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

Parameter sets

List

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

Get

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

-EventSubscriptionName

Name of the event subscription.

Parameter properties

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

Parameter sets

Get

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

GetViaIdentityTopic

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

GetViaIdentityDomain

Position:	Named
Mandatory:	True
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

List

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

-InputObject

Identity Parameter

Parameter properties

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

Parameter sets

GetViaIdentity

Position:	Named
Mandatory:	True
Value from pipeline:	True
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

List

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

Get

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

List

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

Get

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

List

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

-TopicInputObject

Identity Parameter

Parameter properties

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

Parameter sets

GetViaIdentityTopic

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

-TopicName

Name of the domain topic.

Parameter properties

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

Parameter sets

List

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

Get

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

GetViaIdentityDomain

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.

Inputs

IEventGridIdentity

Outputs

IEventSubscription