1. Packages
  2. Azure Native
  3. API Docs
  4. eventhub
  5. listEventHubKeys
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.30.0 published on Friday, Feb 23, 2024 by Pulumi

azure-native.eventhub.listEventHubKeys

Explore with Pulumi AI

azure-native logo
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.30.0 published on Friday, Feb 23, 2024 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: 2015-08-01, 2023-01-01-preview, 2024-01-01.

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:eventhub:listEventHubKeys
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AuthorizationRuleName string
    The authorization rule name.
    EventHubName string
    The Event Hub name
    NamespaceName string
    The Namespace name
    ResourceGroupName string
    Name of the resource group within the azure subscription.
    AuthorizationRuleName string
    The authorization rule name.
    EventHubName string
    The Event Hub name
    NamespaceName string
    The Namespace name
    ResourceGroupName string
    Name of the resource group within the azure subscription.
    authorizationRuleName String
    The authorization rule name.
    eventHubName String
    The Event Hub name
    namespaceName String
    The Namespace name
    resourceGroupName String
    Name of the resource group within the azure subscription.
    authorizationRuleName string
    The authorization rule name.
    eventHubName string
    The Event Hub name
    namespaceName string
    The Namespace name
    resourceGroupName string
    Name of the resource group within the azure subscription.
    authorization_rule_name str
    The authorization rule name.
    event_hub_name str
    The Event Hub name
    namespace_name str
    The Namespace name
    resource_group_name str
    Name of the resource group within the azure subscription.
    authorizationRuleName String
    The authorization rule name.
    eventHubName String
    The Event Hub name
    namespaceName String
    The Namespace name
    resourceGroupName String
    Name of the resource group within the azure subscription.

    listEventHubKeys Result

    The following output properties are available:

    AliasPrimaryConnectionString string
    Primary connection string of the alias if GEO DR is enabled
    AliasSecondaryConnectionString string
    Secondary connection string of the alias if GEO DR is enabled
    KeyName string
    A string that describes the AuthorizationRule.
    PrimaryConnectionString string
    Primary connection string of the created namespace AuthorizationRule.
    PrimaryKey string
    A base64-encoded 256-bit primary key for signing and validating the SAS token.
    SecondaryConnectionString string
    Secondary connection string of the created namespace AuthorizationRule.
    SecondaryKey string
    A base64-encoded 256-bit primary key for signing and validating the SAS token.
    AliasPrimaryConnectionString string
    Primary connection string of the alias if GEO DR is enabled
    AliasSecondaryConnectionString string
    Secondary connection string of the alias if GEO DR is enabled
    KeyName string
    A string that describes the AuthorizationRule.
    PrimaryConnectionString string
    Primary connection string of the created namespace AuthorizationRule.
    PrimaryKey string
    A base64-encoded 256-bit primary key for signing and validating the SAS token.
    SecondaryConnectionString string
    Secondary connection string of the created namespace AuthorizationRule.
    SecondaryKey string
    A base64-encoded 256-bit primary key for signing and validating the SAS token.
    aliasPrimaryConnectionString String
    Primary connection string of the alias if GEO DR is enabled
    aliasSecondaryConnectionString String
    Secondary connection string of the alias if GEO DR is enabled
    keyName String
    A string that describes the AuthorizationRule.
    primaryConnectionString String
    Primary connection string of the created namespace AuthorizationRule.
    primaryKey String
    A base64-encoded 256-bit primary key for signing and validating the SAS token.
    secondaryConnectionString String
    Secondary connection string of the created namespace AuthorizationRule.
    secondaryKey String
    A base64-encoded 256-bit primary key for signing and validating the SAS token.
    aliasPrimaryConnectionString string
    Primary connection string of the alias if GEO DR is enabled
    aliasSecondaryConnectionString string
    Secondary connection string of the alias if GEO DR is enabled
    keyName string
    A string that describes the AuthorizationRule.
    primaryConnectionString string
    Primary connection string of the created namespace AuthorizationRule.
    primaryKey string
    A base64-encoded 256-bit primary key for signing and validating the SAS token.
    secondaryConnectionString string
    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_connection_string str
    Primary connection string of the alias if GEO DR is enabled
    alias_secondary_connection_string str
    Secondary connection string of the alias if GEO DR is enabled
    key_name str
    A string that describes the AuthorizationRule.
    primary_connection_string str
    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_string str
    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.
    aliasPrimaryConnectionString String
    Primary connection string of the alias if GEO DR is enabled
    aliasSecondaryConnectionString String
    Secondary connection string of the alias if GEO DR is enabled
    keyName String
    A string that describes the AuthorizationRule.
    primaryConnectionString String
    Primary connection string of the created namespace AuthorizationRule.
    primaryKey String
    A base64-encoded 256-bit primary key for signing and validating the SAS token.
    secondaryConnectionString String
    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
    azure-native logo
    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.30.0 published on Friday, Feb 23, 2024 by Pulumi