Skip to content

Latest commit

 

History

History
228 lines (178 loc) · 5.54 KB

Get-AzEventGridPartnerNamespace.md

File metadata and controls

228 lines (178 loc) · 5.54 KB
Raw
external help file Module Name online version schema
Az.EventGrid-help.xml
Az.EventGrid
2.0.0

Get-AzEventGridPartnerNamespace

SYNOPSIS

Get properties of a partner namespace.

SYNTAX

List (Default)

Get-AzEventGridPartnerNamespace [-SubscriptionId <String[]>] [-Filter <String>] [-Top <Int32>]
 [-DefaultProfile <PSObject>] [-PassThru] [<CommonParameters>]

Get

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

List1

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

GetViaIdentity

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

DESCRIPTION

Get properties of a partner namespace.

EXAMPLES

Example 1: List properties of partner namespace.

Get-AzEventGridPartnerNamespace
Location Name                  ResourceGroupName
-------- ----                  -----------------
eastus   azps-partnernamespace azps_test_group_eventgrid

List properties of partner namespace.

Example 2: List properties of partner namespace.

Get-AzEventGridPartnerNamespace -ResourceGroupName azps_test_group_eventgrid
Location Name                  ResourceGroupName
-------- ----                  -----------------
eastus   azps-partnernamespace azps_test_group_eventgrid

List properties of partner namespace.

Example 3: Get properties of a partner namespace.

Get-AzEventGridPartnerNamespace -ResourceGroupName azps_test_group_eventgrid -Name azps-partnernamespace
Location Name                  ResourceGroupName
-------- ----                  -----------------
eastus   azps-partnernamespace azps_test_group_eventgrid

Get properties of a partner namespace.

PARAMETERS

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

Required: False
Position: Named
Default value: None
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: System.String
Parameter Sets: List, List1
Aliases:

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

-InputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IEventGridIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Name of the partner namespace.

Type: System.String
Parameter Sets: Get
Aliases: PartnerNamespaceName

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

-PassThru

Returns true when the command succeeds

Type: System.Management.Automation.SwitchParameter
Parameter Sets: List, List1
Aliases:

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

-ResourceGroupName

The name of the resource group within the user's subscription.

Type: System.String
Parameter Sets: Get, List1
Aliases: ResourceGroup

Required: True
Position: Named
Default value: None
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: System.String[]
Parameter Sets: List, Get, List1
Aliases:

Required: False
Position: Named
Default value: (Get-AzContext).Subscription.Id
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: System.Int32
Parameter Sets: List, List1
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IEventGridIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventGrid.Models.IPartnerNamespace

NOTES

RELATED LINKS