1. Packages
  2. Azure Native v2
  3. API Docs
  4. servicebus
  5. listQueueKeys
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.listQueueKeys

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

Primary and secondary connection strings to the queue. Azure REST API version: 2022-01-01-preview.

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

Using listQueueKeys

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 listQueueKeys(args: ListQueueKeysArgs, opts?: InvokeOptions): Promise<ListQueueKeysResult>
function listQueueKeysOutput(args: ListQueueKeysOutputArgs, opts?: InvokeOptions): Output<ListQueueKeysResult>
Copy
def list_queue_keys(authorization_rule_name: Optional[str] = None,
                    namespace_name: Optional[str] = None,
                    queue_name: Optional[str] = None,
                    resource_group_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> ListQueueKeysResult
def list_queue_keys_output(authorization_rule_name: Optional[pulumi.Input[str]] = None,
                    namespace_name: Optional[pulumi.Input[str]] = None,
                    queue_name: Optional[pulumi.Input[str]] = None,
                    resource_group_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[ListQueueKeysResult]
Copy
func ListQueueKeys(ctx *Context, args *ListQueueKeysArgs, opts ...InvokeOption) (*ListQueueKeysResult, error)
func ListQueueKeysOutput(ctx *Context, args *ListQueueKeysOutputArgs, opts ...InvokeOption) ListQueueKeysResultOutput
Copy

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

public static class ListQueueKeys 
{
    public static Task<ListQueueKeysResult> InvokeAsync(ListQueueKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListQueueKeysResult> Invoke(ListQueueKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListQueueKeysResult> listQueueKeys(ListQueueKeysArgs args, InvokeOptions options)
public static Output<ListQueueKeysResult> listQueueKeys(ListQueueKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:servicebus:listQueueKeys
  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
QueueName
This property is required.
Changes to this property will trigger replacement.
string
The queue name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
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
QueueName
This property is required.
Changes to this property will trigger replacement.
string
The queue name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
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
queueName
This property is required.
Changes to this property will trigger replacement.
String
The queue name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.
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
queueName
This property is required.
Changes to this property will trigger replacement.
string
The queue name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the Resource group within the Azure subscription.
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
queue_name
This property is required.
Changes to this property will trigger replacement.
str
The queue 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.
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
queueName
This property is required.
Changes to this property will trigger replacement.
String
The queue name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the Resource group within the Azure subscription.

listQueueKeys 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