1. Packages
  2. Azure Native
  3. API Docs
  4. signalrservice
  5. listSignalRKeys
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.signalrservice.listSignalRKeys

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Get the access keys of the resource.

Uses Azure REST API version 2024-03-01.

Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native signalrservice [ApiVersion]. See the version guide for details.

Using listSignalRKeys

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 listSignalRKeys(args: ListSignalRKeysArgs, opts?: InvokeOptions): Promise<ListSignalRKeysResult>
function listSignalRKeysOutput(args: ListSignalRKeysOutputArgs, opts?: InvokeOptions): Output<ListSignalRKeysResult>
Copy
def list_signal_r_keys(resource_group_name: Optional[str] = None,
                       resource_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> ListSignalRKeysResult
def list_signal_r_keys_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                       resource_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[ListSignalRKeysResult]
Copy
func ListSignalRKeys(ctx *Context, args *ListSignalRKeysArgs, opts ...InvokeOption) (*ListSignalRKeysResult, error)
func ListSignalRKeysOutput(ctx *Context, args *ListSignalRKeysOutputArgs, opts ...InvokeOption) ListSignalRKeysResultOutput
Copy

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

public static class ListSignalRKeys 
{
    public static Task<ListSignalRKeysResult> InvokeAsync(ListSignalRKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListSignalRKeysResult> Invoke(ListSignalRKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListSignalRKeysResult> listSignalRKeys(ListSignalRKeysArgs args, InvokeOptions options)
public static Output<ListSignalRKeysResult> listSignalRKeys(ListSignalRKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:signalrservice:listSignalRKeys
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ResourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
resource_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
resourceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.

listSignalRKeys Result

The following output properties are available:

PrimaryConnectionString string
Connection string constructed via the primaryKey
PrimaryKey string
The primary access key.
SecondaryConnectionString string
Connection string constructed via the secondaryKey
SecondaryKey string
The secondary access key.
PrimaryConnectionString string
Connection string constructed via the primaryKey
PrimaryKey string
The primary access key.
SecondaryConnectionString string
Connection string constructed via the secondaryKey
SecondaryKey string
The secondary access key.
primaryConnectionString String
Connection string constructed via the primaryKey
primaryKey String
The primary access key.
secondaryConnectionString String
Connection string constructed via the secondaryKey
secondaryKey String
The secondary access key.
primaryConnectionString string
Connection string constructed via the primaryKey
primaryKey string
The primary access key.
secondaryConnectionString string
Connection string constructed via the secondaryKey
secondaryKey string
The secondary access key.
primary_connection_string str
Connection string constructed via the primaryKey
primary_key str
The primary access key.
secondary_connection_string str
Connection string constructed via the secondaryKey
secondary_key str
The secondary access key.
primaryConnectionString String
Connection string constructed via the primaryKey
primaryKey String
The primary access key.
secondaryConnectionString String
Connection string constructed via the secondaryKey
secondaryKey String
The secondary access key.

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 v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi