azure-native.servicebus.listQueueKeys
Explore with Pulumi AI
Primary and secondary connection strings to the queue.
Uses Azure REST API version 2024-01-01.
Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native servicebus [ApiVersion]. See the version guide for details.
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>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]func ListQueueKeys(ctx *Context, args *ListQueueKeysArgs, opts ...InvokeOption) (*ListQueueKeysResult, error)
func ListQueueKeysOutput(ctx *Context, args *ListQueueKeysOutputArgs, opts ...InvokeOption) ListQueueKeysResultOutput> 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)
}public static CompletableFuture<ListQueueKeysResult> listQueueKeys(ListQueueKeysArgs args, InvokeOptions options)
public static Output<ListQueueKeysResult> listQueueKeys(ListQueueKeysArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:servicebus:listQueueKeys
  arguments:
    # arguments dictionaryThe following arguments are supported:
- string
 - The authorization rule name.
 - Namespace
Name string - The namespace name
 - Queue
Name string - The queue name.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- string
 - The authorization rule name.
 - Namespace
Name string - The namespace name
 - Queue
Name string - The queue name.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- String
 - The authorization rule name.
 - namespace
Name String - The namespace name
 - queue
Name String - The queue name.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- string
 - The authorization rule name.
 - namespace
Name string - The namespace name
 - queue
Name string - The queue name.
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- str
 - The authorization rule name.
 - namespace_
name str - The namespace name
 - queue_
name str - The queue name.
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 
- String
 - The authorization rule name.
 - namespace
Name String - The namespace name
 - queue
Name String - The queue name.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
listQueueKeys Result
The following output properties are available:
- Alias
Primary stringConnection String  - Primary connection string of the alias if GEO DR is enabled
 - Alias
Secondary stringConnection String  - Secondary connection string of the alias if GEO DR is enabled
 - Key
Name string - A string that describes the authorization rule.
 - Primary
Connection stringString  - Primary connection string of the created namespace authorization rule.
 - Primary
Key string - A base64-encoded 256-bit primary key for signing and validating the SAS token.
 - Secondary
Connection stringString  - Secondary connection string of the created namespace authorization rule.
 - Secondary
Key string - A base64-encoded 256-bit primary key for signing and validating the SAS token.
 
- Alias
Primary stringConnection String  - Primary connection string of the alias if GEO DR is enabled
 - Alias
Secondary stringConnection String  - Secondary connection string of the alias if GEO DR is enabled
 - Key
Name string - A string that describes the authorization rule.
 - Primary
Connection stringString  - Primary connection string of the created namespace authorization rule.
 - Primary
Key string - A base64-encoded 256-bit primary key for signing and validating the SAS token.
 - Secondary
Connection stringString  - Secondary connection string of the created namespace authorization rule.
 - Secondary
Key string - A base64-encoded 256-bit primary key for signing and validating the SAS token.
 
- alias
Primary StringConnection String  - Primary connection string of the alias if GEO DR is enabled
 - alias
Secondary StringConnection String  - Secondary connection string of the alias if GEO DR is enabled
 - key
Name String - A string that describes the authorization rule.
 - primary
Connection StringString  - Primary connection string of the created namespace authorization rule.
 - primary
Key String - A base64-encoded 256-bit primary key for signing and validating the SAS token.
 - secondary
Connection StringString  - Secondary connection string of the created namespace authorization rule.
 - secondary
Key String - A base64-encoded 256-bit primary key for signing and validating the SAS token.
 
- alias
Primary stringConnection String  - Primary connection string of the alias if GEO DR is enabled
 - alias
Secondary stringConnection String  - Secondary connection string of the alias if GEO DR is enabled
 - key
Name string - A string that describes the authorization rule.
 - primary
Connection stringString  - Primary connection string of the created namespace authorization rule.
 - primary
Key string - A base64-encoded 256-bit primary key for signing and validating the SAS token.
 - secondary
Connection stringString  - Secondary connection string of the created namespace authorization rule.
 - secondary
Key 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 authorization rule.
 - primary_
connection_ strstring  - 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_ strstring  - 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.
 
- alias
Primary StringConnection String  - Primary connection string of the alias if GEO DR is enabled
 - alias
Secondary StringConnection String  - Secondary connection string of the alias if GEO DR is enabled
 - key
Name String - A string that describes the authorization rule.
 - primary
Connection StringString  - Primary connection string of the created namespace authorization rule.
 - primary
Key String - A base64-encoded 256-bit primary key for signing and validating the SAS token.
 - secondary
Connection StringString  - Secondary connection string of the created namespace authorization rule.
 - secondary
Key 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