Get-AzEventGridPartnerRegistration

Reference

Module:: Az.EventGrid

Gets the details of an Event Grid partner registration, or gets a list of Event Grid partner registrations.

Syntax

Get-AzEventGridPartnerRegistration
   [-ResourceGroupName <String>]
   [-ODataQuery <String>]
   [-Top <Int32>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridPartnerRegistration
   -ResourceGroupName <String>
   -Name <String>
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzEventGridPartnerRegistration
   [-NextLink <String>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

The Get-AzEventGridPartnerRegistration cmdlet either gets the details of a specified Event Grid partner registration, or a list of all partner registrations at either the specified resource group or current Azure subscription scope. If the partner registration name is provided, the details of a single partner registration is returned. If the partner registration name is not provided but the resource group name is provided, a list of partner registrations is returned. If neither the partner registration name or the resource group name is provided, a list of partner registrations in the current Azure subscription is returned.

Examples

Example 1

Get-AzEventGridPartnerRegistration -ResourceGroupName MyResourceGroupName -Name PartnerRegistration1

Gets the details of Event Grid partner registration `PartnerRegistration1` in resource group `MyResourceGroupName`.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Event Grid partner registration name.

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

-NextLink

The link for the next page of resources to be obtained. This value is obtained with the first Get-AzEventGrid cmdlet call when more resources are still available to be queried.

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

-ODataQuery

The OData query used for filtering the list results. Filtering is currently allowed on the Name property only.The supported operations include: CONTAINS, eq (for equal), ne (for not equal), AND, OR and NOT.

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

-ResourceGroupName

The name of the resource group.

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

-Top

The maximum number of resources to be obtained. Valid value is between 1 and 100. If top value is specified and more results are still available, the result will contain a link to the next page to be queried in NextLink. If the Top value is not specified, the full list of resources will be returned at once.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

Inputs

String

Nullable<T>[[System.Int32, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

Outputs

PSPartnerRegistrationListInstance

PSPartnerRegistration