Get-AzEventGridClient
Get properties of a client.
Syntax
Get-AzEventGridClient
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-Filter <String>]
[-Top <Int32>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEventGridClient
-Name <String>
-NamespaceInputObject <IEventGridIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEventGridClient
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] Get-AzEventGridClient
-InputObject <IEventGridIdentity>
[-DefaultProfile <PSObject>]
[<CommonParameters>] Description
Get properties of a client.
Examples
Example 1: List properties of client.
Get-AzEventGridClient -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid
Name ResourceGroupName
---- -----------------
azps-client azps_test_group_eventgridList properties of client.
Example 2: Get properties of a client.
Get-AzEventGridClient -Name azps-client -NamespaceName azps-eventgridnamespace -ResourceGroupName azps_test_group_eventgrid
Name ResourceGroupName
---- -----------------
azps-client azps_test_group_eventgridGet properties of a client.
Example 3: Get properties of a client.
$namespace = Get-AzEventGridNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-eventgridnamespace
Get-AzEventGridClient -Name azps-client -NamespaceInputObject $namespace
Name ResourceGroupName
---- -----------------
azps-client azps_test_group_eventgridGet properties of a client.
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.
| Type: | String |
| Aliases: | ClientName |
| 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 |
