Get-AzEventGridChannel

Module:

Az.EventGrid

Get properties of a channel.

Syntax

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

Get-AzEventGridChannel
   -Name <String>
   -PartnerNamespaceInputObject <IEventGridIdentity>
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]

Get-AzEventGridChannel
   -Name <String>
   -PartnerNamespaceName <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String[]>]
   [-DefaultProfile <PSObject>]
   [-PassThru]
   [<CommonParameters>]

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

Description

Get properties of a channel.

Examples

Example 1: List properties of channel.

Get-AzEventGridChannel -ResourceGroupName azps_test_group_eventgrid -PartnerNamespaceName azps-partnernamespace

Name         ResourceGroupName
----         -----------------
azps-channel azps_test_group_eventgrid

List properties of channel.

Example 2: Get properties of a channel.

Get-AzEventGridChannel -ResourceGroupName azps_test_group_eventgrid -PartnerNamespaceName azps-partnernamespace -Name azps-channel

Name         ResourceGroupName
----         -----------------
azps-channel azps_test_group_eventgrid

Get properties of a channel.

Example 3: Get properties of a channel.

$partnerNamespace = Get-AzEventGridPartnerNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-partnernamespace
Get-AzEventGridChannel -PartnerNamespaceInputObject $partnerNamespace -Name azps-channel

Name         ResourceGroupName
----         -----------------
azps-channel azps_test_group_eventgrid

Get properties of a channel.

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 channel.

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

-PartnerNamespaceInputObject

Identity Parameter

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

-PartnerNamespaceName

Name of the partner namespace.

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

-PassThru

Returns true when the command succeeds

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

-ResourceGroupName

The name of the resource group within the partners 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

IChannel