Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Get-AzEventHubKey
- Module:
- Az.EventHub Module
Gets an EventHub SAS key
Syntax
GetExpandedNamespace (Default)
Get-AzEventHubKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[<CommonParameters>]
GetExpandedAlias
Get-AzEventHubKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
-AliasName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[<CommonParameters>]
GetExpandedEntity
Get-AzEventHubKey
-Name <String>
-NamespaceName <String>
-ResourceGroupName <String>
-EventHubName <String>
[-SubscriptionId <String[]>]
[-DefaultProfile <PSObject>]
[-AsJob]
[-NoWait]
[<CommonParameters>]
Description
Gets an EventHub SAS key
Examples
Example 1: Get keys of an EventHub Namespace authorization rule
Get-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -Name RootManageSharedAccessKey
AliasPrimaryConnectionString :
AliasSecondaryConnectionString :
KeyName : RootManageSharedAccessKey
PrimaryConnectionString : 000000000000
PrimaryKey : 000000000000
SecondaryConnectionString : {ConnectionString}
SecondaryKey : {ConnectionString}
Gets keys of authorization rule RootManageSharedAccessKey of EventHub namespace myNamespace.
Example 2: Get keys of an EventHub Entity authorization rule
Get-AzEventHubKey -ResourceGroupName myResourceGroup -NamespaceName myNamespace -EventHubName myEventHub -Name RootManageSharedAccessKey
AliasPrimaryConnectionString :
AliasSecondaryConnectionString :
KeyName : RootManageSharedAccessKey
PrimaryConnectionString : 000000000000
PrimaryKey : 000000000000
SecondaryConnectionString : {ConnectionString}
SecondaryKey : {ConnectionString}
Gets keys of authorization rule RootManageSharedAccessKey of EventHub entity myEventHub from namespace myNamespace.
Parameters
-AliasName
The name of the Disaster Recovery alias
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AsJob
Run the command as a job
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
-EventHubName
The name of the EventHub entity.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Name
The name of the Authorization Rule
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AuthorizationRuleName |
Parameter sets
-NamespaceName
The name of EventHub namespace
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NoWait
Run the command asynchronously
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ResourceGroupName
The name of the resource group. The name is case insensitive.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SubscriptionId
The ID of the target subscription.
Parameter properties
| Type: | String[] |
| Default value: | (Get-AzContext).Subscription.Id |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
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
IAccessKeys
Azure PowerShell
Feedback
Was this page helpful?