1. Packages
  2. Azure Native v2
  3. API Docs
  4. servicebus
  5. listTopicKeys
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.servicebus.listTopicKeys

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets the primary and secondary connection strings for the topic. Azure REST API version: 2022-01-01-preview.

Other available API versions: 2022-10-01-preview, 2023-01-01-preview, 2024-01-01.

Using listTopicKeys

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 listTopicKeys(args: ListTopicKeysArgs, opts?: InvokeOptions): Promise<ListTopicKeysResult>
function listTopicKeysOutput(args: ListTopicKeysOutputArgs, opts?: InvokeOptions): Output<ListTopicKeysResult>
Copy
def list_topic_keys(authorization_rule_name: Optional[str] = None,
                    namespace_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    topic_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> ListTopicKeysResult
def list_topic_keys_output(authorization_rule_name: Optional[pulumi.Input[str]] = None,
                    namespace_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    topic_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[ListTopicKeysResult]
Copy
func ListTopicKeys(ctx *Context, args *ListTopicKeysArgs, opts ...InvokeOption) (*ListTopicKeysResult, error)
func ListTopicKeysOutput(ctx *Context, args *ListTopicKeysOutputArgs, opts ...InvokeOption) ListTopicKeysResultOutput
Copy

> Note: This function is named ListTopicKeys in the Go SDK.

public static class ListTopicKeys 
{
    public static Task<ListTopicKeysResult> InvokeAsync(ListTopicKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListTopicKeysResult> Invoke(ListTopicKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListTopicKeysResult> listTopicKeys(ListTopicKeysArgs args, InvokeOptions options)
public static Output<ListTopicKeysResult> listTopicKeys(ListTopicKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:servicebus:listTopicKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AuthorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
TopicName
This property is required.
Changes to this property will trigger replacement.
string
The topic name.
AuthorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
TopicName
This property is required.
Changes to this property will trigger replacement.
string
The topic name.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
String
The authorization rule name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
topicName
This property is required.
Changes to this property will trigger replacement.
String
The topic name.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
topicName
This property is required.
Changes to this property will trigger replacement.
string
The topic name.
authorization_rule_name
This property is required.
Changes to this property will trigger replacement.
str
The authorization rule name.
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The namespace name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the Resource group within the Azure subscription.
topic_name
This property is required.
Changes to this property will trigger replacement.
str
The topic name.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
String
The authorization rule name.
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
topicName
This property is required.
Changes to this property will trigger replacement.
String
The topic name.

listTopicKeys 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 authorization rule.
PrimaryConnectionString string
Primary connection string of the created namespace authorization rule.
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 authorization rule.
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 authorization rule.
PrimaryConnectionString string
Primary connection string of the created namespace authorization rule.
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 authorization rule.
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 authorization rule.
primaryConnectionString String
Primary connection string of the created namespace authorization rule.
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 authorization rule.
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 authorization rule.
primaryConnectionString string
Primary connection string of the created namespace authorization rule.
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 authorization rule.
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 authorization rule.
primary_connection_string str
Primary connection string of the created namespace authorization rule.
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 authorization rule.
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 authorization rule.
primaryConnectionString String
Primary connection string of the created namespace authorization rule.
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 authorization rule.
secondaryKey String
A base64-encoded 256-bit primary key for signing and validating the SAS token.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi