This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.eventhub.listEventHubKeys
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
Gets the ACS and SAS connection strings for the Event Hub. Azure REST API version: 2022-10-01-preview.
Other available API versions: 2023-01-01-preview, 2024-01-01, 2024-05-01-preview.
Using listEventHubKeys
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function listEventHubKeys(args: ListEventHubKeysArgs, opts?: InvokeOptions): Promise<ListEventHubKeysResult>
function listEventHubKeysOutput(args: ListEventHubKeysOutputArgs, opts?: InvokeOptions): Output<ListEventHubKeysResult>def list_event_hub_keys(authorization_rule_name: Optional[str] = None,
                        event_hub_name: Optional[str] = None,
                        namespace_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> ListEventHubKeysResult
def list_event_hub_keys_output(authorization_rule_name: Optional[pulumi.Input[str]] = None,
                        event_hub_name: Optional[pulumi.Input[str]] = None,
                        namespace_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[ListEventHubKeysResult]func ListEventHubKeys(ctx *Context, args *ListEventHubKeysArgs, opts ...InvokeOption) (*ListEventHubKeysResult, error)
func ListEventHubKeysOutput(ctx *Context, args *ListEventHubKeysOutputArgs, opts ...InvokeOption) ListEventHubKeysResultOutput> Note: This function is named ListEventHubKeys in the Go SDK.
public static class ListEventHubKeys 
{
    public static Task<ListEventHubKeysResult> InvokeAsync(ListEventHubKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListEventHubKeysResult> Invoke(ListEventHubKeysInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<ListEventHubKeysResult> listEventHubKeys(ListEventHubKeysArgs args, InvokeOptions options)
public static Output<ListEventHubKeysResult> listEventHubKeys(ListEventHubKeysArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:eventhub:listEventHubKeys
  arguments:
    # arguments dictionaryThe following arguments are supported:
- string
- The authorization rule name.
- EventHub stringName 
- The Event Hub name
- NamespaceName string
- The Namespace name
- ResourceGroup stringName 
- Name of the resource group within the azure subscription.
- string
- The authorization rule name.
- EventHub stringName 
- The Event Hub name
- NamespaceName string
- The Namespace name
- ResourceGroup stringName 
- Name of the resource group within the azure subscription.
- String
- The authorization rule name.
- eventHub StringName 
- The Event Hub name
- namespaceName String
- The Namespace name
- resourceGroup StringName 
- Name of the resource group within the azure subscription.
- string
- The authorization rule name.
- eventHub stringName 
- The Event Hub name
- namespaceName string
- The Namespace name
- resourceGroup stringName 
- Name of the resource group within the azure subscription.
- str
- The authorization rule name.
- event_hub_ strname 
- The Event Hub name
- namespace_name str
- The Namespace name
- resource_group_ strname 
- Name of the resource group within the azure subscription.
- String
- The authorization rule name.
- eventHub StringName 
- The Event Hub name
- namespaceName String
- The Namespace name
- resourceGroup StringName 
- Name of the resource group within the azure subscription.
listEventHubKeys Result
The following output properties are available:
- AliasPrimary stringConnection String 
- Primary connection string of the alias if GEO DR is enabled
- AliasSecondary stringConnection String 
- Secondary connection string of the alias if GEO DR is enabled
- KeyName string
- A string that describes the AuthorizationRule.
- PrimaryConnection stringString 
- Primary connection string of the created namespace AuthorizationRule.
- PrimaryKey string
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- SecondaryConnection stringString 
- Secondary connection string of the created namespace AuthorizationRule.
- SecondaryKey string
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- AliasPrimary stringConnection String 
- Primary connection string of the alias if GEO DR is enabled
- AliasSecondary stringConnection String 
- Secondary connection string of the alias if GEO DR is enabled
- KeyName string
- A string that describes the AuthorizationRule.
- PrimaryConnection stringString 
- Primary connection string of the created namespace AuthorizationRule.
- PrimaryKey string
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- SecondaryConnection stringString 
- Secondary connection string of the created namespace AuthorizationRule.
- SecondaryKey string
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- aliasPrimary StringConnection String 
- Primary connection string of the alias if GEO DR is enabled
- aliasSecondary StringConnection String 
- Secondary connection string of the alias if GEO DR is enabled
- keyName String
- A string that describes the AuthorizationRule.
- primaryConnection StringString 
- Primary connection string of the created namespace AuthorizationRule.
- primaryKey String
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondaryConnection StringString 
- Secondary connection string of the created namespace AuthorizationRule.
- secondaryKey String
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- aliasPrimary stringConnection String 
- Primary connection string of the alias if GEO DR is enabled
- aliasSecondary stringConnection String 
- Secondary connection string of the alias if GEO DR is enabled
- keyName string
- A string that describes the AuthorizationRule.
- primaryConnection stringString 
- Primary connection string of the created namespace AuthorizationRule.
- primaryKey string
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondaryConnection stringString 
- Secondary connection string of the created namespace AuthorizationRule.
- secondaryKey string
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- alias_primary_ strconnection_ string 
- Primary connection string of the alias if GEO DR is enabled
- alias_secondary_ strconnection_ string 
- Secondary connection string of the alias if GEO DR is enabled
- key_name str
- A string that describes the AuthorizationRule.
- primary_connection_ strstring 
- Primary connection string of the created namespace AuthorizationRule.
- primary_key str
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondary_connection_ strstring 
- Secondary connection string of the created namespace AuthorizationRule.
- secondary_key str
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- aliasPrimary StringConnection String 
- Primary connection string of the alias if GEO DR is enabled
- aliasSecondary StringConnection String 
- Secondary connection string of the alias if GEO DR is enabled
- keyName String
- A string that describes the AuthorizationRule.
- primaryConnection StringString 
- Primary connection string of the created namespace AuthorizationRule.
- primaryKey String
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
- secondaryConnection StringString 
- Secondary connection string of the created namespace AuthorizationRule.
- secondaryKey String
- A base64-encoded 256-bit primary key for signing and validating the SAS token.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi