Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. quantum
  5. listWorkspaceKeys
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.5.1 published on Friday, Jun 6, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.quantum.listWorkspaceKeys

Explore with Pulumi AI

azure-native logo
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.5.1 published on Friday, Jun 6, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get the keys to use with the Quantum APIs. A key is used to authenticate and authorize access to the Quantum REST APIs. Only one key is needed at a time; two are given to provide seamless key regeneration.

    Uses Azure REST API version 2023-11-13-preview.

    Other available API versions: 2025-01-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native quantum [ApiVersion]. See the version guide for details.

    Using listWorkspaceKeys

    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 listWorkspaceKeys(args: ListWorkspaceKeysArgs, opts?: InvokeOptions): Promise<ListWorkspaceKeysResult>
function listWorkspaceKeysOutput(args: ListWorkspaceKeysOutputArgs, opts?: InvokeOptions): Output<ListWorkspaceKeysResult>
    def list_workspace_keys(resource_group_name: Optional[str] = None,
                        workspace_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> ListWorkspaceKeysResult
def list_workspace_keys_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                        workspace_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[ListWorkspaceKeysResult]
    func ListWorkspaceKeys(ctx *Context, args *ListWorkspaceKeysArgs, opts ...InvokeOption) (*ListWorkspaceKeysResult, error)
func ListWorkspaceKeysOutput(ctx *Context, args *ListWorkspaceKeysOutputArgs, opts ...InvokeOption) ListWorkspaceKeysResultOutput

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

    public static class ListWorkspaceKeys 
{
    public static Task<ListWorkspaceKeysResult> InvokeAsync(ListWorkspaceKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListWorkspaceKeysResult> Invoke(ListWorkspaceKeysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<ListWorkspaceKeysResult> listWorkspaceKeys(ListWorkspaceKeysArgs args, InvokeOptions options)
public static Output<ListWorkspaceKeysResult> listWorkspaceKeys(ListWorkspaceKeysArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:quantum:listWorkspaceKeys
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the quantum workspace resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    WorkspaceName string
    The name of the quantum workspace resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the quantum workspace resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    workspaceName string
    The name of the quantum workspace resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    workspace_name str
    The name of the quantum workspace resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    workspaceName String
    The name of the quantum workspace resource.

    listWorkspaceKeys Result

    The following output properties are available:

    PrimaryConnectionString string
    The connection string of the primary api key.
    SecondaryConnectionString string
    The connection string of the secondary api key.
    ApiKeyEnabled bool
    Indicator of enablement of the Quantum workspace Api keys.
    PrimaryKey Pulumi.AzureNative.Quantum.Outputs.ApiKeyResponse
    The quantum workspace primary api key.
    SecondaryKey Pulumi.AzureNative.Quantum.Outputs.ApiKeyResponse
    The quantum workspace secondary api key.
    PrimaryConnectionString string
    The connection string of the primary api key.
    SecondaryConnectionString string
    The connection string of the secondary api key.
    ApiKeyEnabled bool
    Indicator of enablement of the Quantum workspace Api keys.
    PrimaryKey ApiKeyResponse
    The quantum workspace primary api key.
    SecondaryKey ApiKeyResponse
    The quantum workspace secondary api key.
    primaryConnectionString String
    The connection string of the primary api key.
    secondaryConnectionString String
    The connection string of the secondary api key.
    apiKeyEnabled Boolean
    Indicator of enablement of the Quantum workspace Api keys.
    primaryKey ApiKeyResponse
    The quantum workspace primary api key.
    secondaryKey ApiKeyResponse
    The quantum workspace secondary api key.
    primaryConnectionString string
    The connection string of the primary api key.
    secondaryConnectionString string
    The connection string of the secondary api key.
    apiKeyEnabled boolean
    Indicator of enablement of the Quantum workspace Api keys.
    primaryKey ApiKeyResponse
    The quantum workspace primary api key.
    secondaryKey ApiKeyResponse
    The quantum workspace secondary api key.
    primary_connection_string str
    The connection string of the primary api key.
    secondary_connection_string str
    The connection string of the secondary api key.
    api_key_enabled bool
    Indicator of enablement of the Quantum workspace Api keys.
    primary_key ApiKeyResponse
    The quantum workspace primary api key.
    secondary_key ApiKeyResponse
    The quantum workspace secondary api key.
    primaryConnectionString String
    The connection string of the primary api key.
    secondaryConnectionString String
    The connection string of the secondary api key.
    apiKeyEnabled Boolean
    Indicator of enablement of the Quantum workspace Api keys.
    primaryKey Property Map
    The quantum workspace primary api key.
    secondaryKey Property Map
    The quantum workspace secondary api key.

    Supporting Types

    ApiKeyResponse

    Key string
    The Api key.
    CreatedAt string
    The creation time of the api key.
    Key string
    The Api key.
    CreatedAt string
    The creation time of the api key.
    key String
    The Api key.
    createdAt String
    The creation time of the api key.
    key string
    The Api key.
    createdAt string
    The creation time of the api key.
    key str
    The Api key.
    created_at str
    The creation time of the api key.
    key String
    The Api key.
    createdAt String
    The creation time of the api key.

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.5.1 published on Friday, Jun 6, 2025 by Pulumi
    pulumi/pulumi-azure-native