Get-AzEventGridSystemTopic
Get properties of a system topic.
Syntax
List (Default)
Get-AzEventGridSystemTopic
[-SubscriptionId <String[]>]
[-Filter <String>]
[-Top <Int32>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>]
Get
Get-AzEventGridSystemTopic
-Name <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>]
List1
Get-AzEventGridSystemTopic
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-Filter <String>]
[-Top <Int32>]
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>]
GetViaIdentity
Get-AzEventGridSystemTopic
-InputObject <IEventGridIdentity>
[-DefaultProfile <PSObject>]
[-PassThru]
[<CommonParameters>]
Description
Get properties of a system topic.
Examples
Example 1: List properties of system topic.
Get-AzEventGridSystemTopic
Location Name ResourceGroupName
-------- ---- -----------------
eastus azps-systopic azps_test_group_eventgrid
List properties of system topic.
Example 2: List properties of system topic.
Get-AzEventGridSystemTopic -ResourceGroupName azps_test_group_eventgrid
Location Name ResourceGroupName
-------- ---- -----------------
eastus azps-systopic azps_test_group_eventgrid
List properties of system topic.
Example 3: Get properties of a system topic.
Get-AzEventGridSystemTopic -ResourceGroupName azps_test_group_eventgrid -Name azps-systopic
Location Name ResourceGroupName
-------- ---- -----------------
eastus azps-systopic azps_test_group_eventgrid
Get properties of a system 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
-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
List1
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
GetViaIdentity
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-Name
Name of the system topic.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: SystemTopicName
Parameter sets
Get
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
Get
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
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
List1
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
List1
Position: Named Mandatory: False 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