Skip to content

Get-AzEventHub.md

Latest commit

 

History

History
246 lines (196 loc) · 5.94 KB

Get-AzEventHub.md

File metadata and controls

246 lines (196 loc) · 5.94 KB
Raw
external help file
Module Name Az.EventHub
online version https://learn.microsoft.com/powershell/module/az.eventhub/get-azeventhub
schema 2.0.0

Get-AzEventHub

SYNOPSIS

Gets an Event Hubs description for the specified Event Hub.

SYNTAX

List (Default)

Get-AzEventHub -NamespaceName <String> -ResourceGroupName <String> [-SubscriptionId <String[]>]
 [-Skip <Int32>] [-Top <Int32>] [-DefaultProfile <PSObject>] [<CommonParameters>]

Get

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

GetViaIdentity

Get-AzEventHub -InputObject <IEventHubIdentity> [-DefaultProfile <PSObject>] [<CommonParameters>]

GetViaIdentityNamespace

Get-AzEventHub -Name <String> -NamespaceInputObject <IEventHubIdentity> [-DefaultProfile <PSObject>]
 [<CommonParameters>]

DESCRIPTION

Gets an Event Hubs description for the specified Event Hub.

EXAMPLES

Example 1: Get an EventHub entity

Get-AzEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name myEventHub
ArchiveNameFormat            : Active
BlobContainer                :
CaptureEnabled               :
CleanupPolicy                : Compact
CreatedAt                    : 4/25/2023 4:05:57 AM
DataLakeAccountName          :
DataLakeFolderPath           :
DataLakeSubscriptionId       :
DestinationName              :
Encoding                     : Microsoft.EventHub/namespaces/eventhubs
Id                           : /subscriptions/subscriptionId/resourceGroups/myResourceGroup/providers/Microsoft.EventHub/namespaces/myNamespace/eventhubs/myEventHub
IntervalInSeconds            : est [Az.EventHub]>
Location                     : eastus
MessageRetentionInDay        : 9223372036854775807
Name                         : myEventntHub
PartitionCount               : 4
PartitionId                  : {0, 1, 2, 3}
ResourceGroupName            : myResourceGroup
RetentionTimeInHour          :
SizeLimitInBytes             :
SkipEmptyArchive             :
Status                       : Active
StorageAccountResourceId     :
SystemDataCreatedAt          :
SystemDataCreatedBy          :
SystemDataCreatedByType      :
SystemDataLastModifiedAt     :
SystemDataLastModifiedBy     :
SystemDataLastModifiedByType :
TombstoneRetentionTimeInHour :
Type                         : Microsoft.EventHub/namespaces/eventhubs
UpdatedAt                    : 4/25/2023 4:05:58 AM

Gets details of eventhub entity myEventHub from namespace myNamespace.

Example 2: List All EventHubs in a namespace

Get-AzEventHub -ResourceGroupName myResourceGroup -NamespaceName myNamespace

Lists all EventHub entities from namespace myNamespace.

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

-InputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity
Parameter Sets: GetViaIdentity
Aliases:

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

-Name

The Event Hub name

Type: System.String
Parameter Sets: Get, GetViaIdentityNamespace
Aliases: EventHubName

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

-NamespaceInputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventHubIdentity
Parameter Sets: GetViaIdentityNamespace
Aliases:

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

-NamespaceName

The Namespace name

Type: System.String
Parameter Sets: Get, List
Aliases:

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type: System.String
Parameter Sets: Get, List
Aliases:

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

-Skip

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

Type: System.Int32
Parameter Sets: List
Aliases:

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

-SubscriptionId

The ID of the target subscription.

Type: System.String[]
Parameter Sets: Get, List
Aliases:

Required: False
Position: Named
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False

-Top

May be used to limit the number of results to the most recent N usageDetails.

Type: System.Int32
Parameter Sets: List
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.EventHub.Models.IEventHubIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.EventHub.Models.IEventhub

NOTES

RELATED LINKS