Get-AzEventGridClientGroup

Module:

Az.EventGrid

Get properties of a client group.

Syntax

Get-AzEventGridClientGroup
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-Filter <String>]
   [-Top <Int32>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzEventGridClientGroup
   -Name <String>
   -NamespaceInputObject <IEventGridIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzEventGridClientGroup
   -Name <String>
   -NamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzEventGridClientGroup
   -InputObject <IEventGridIdentity>
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get properties of a client group.

Examples

Example 1: List properties of client group.

Get-AzEventGridClientGroup -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid

Name             ResourceGroupName
----             -----------------
$all             azps_test_group_eventgrid
azps-clientgroup azps_test_group_eventgrid

List properties of client group.

Example 2: Get properties of a client group.

Get-AzEventGridClientGroup -Name azps-clientgroup -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid

Name             ResourceGroupName
----             -----------------
azps-clientgroup azps_test_group_eventgrid

Get properties of a client group.

Example 3: Get properties of a client group.

$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Get-AzEventGridClientGroup -Name azps-clientgroup -NamespaceInputObject $namespace

Name             ResourceGroupName
----             -----------------
azps-clientgroup azps_test_group_eventgrid

Get properties of a client group.

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

-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 client group.

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

-NamespaceInputObject

Identity Parameter

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

-NamespaceName

Name of the namespace.

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

-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

Inputs

IEventGridIdentity

Outputs

IClientGroup