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. getWorkspace
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.getWorkspace

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

    Returns the Workspace resource associated with the given name.

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

    Other available API versions: 2022-01-10-preview, 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 getWorkspace

    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 getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>
    def get_workspace(resource_group_name: Optional[str] = None,
                  workspace_name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                  workspace_name: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
    func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

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

    public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:quantum:getWorkspace
  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.

    getWorkspace Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.Quantum.Outputs.WorkspaceResourcePropertiesResponse
    Gets or sets the properties. Define quantum workspace's specific properties.
    SystemData Pulumi.AzureNative.Quantum.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Identity Pulumi.AzureNative.Quantum.Outputs.ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties WorkspaceResourcePropertiesResponse
    Gets or sets the properties. Define quantum workspace's specific properties.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Identity ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties WorkspaceResourcePropertiesResponse
    Gets or sets the properties. Define quantum workspace's specific properties.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    identity ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties WorkspaceResourcePropertiesResponse
    Gets or sets the properties. Define quantum workspace's specific properties.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    identity ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties WorkspaceResourcePropertiesResponse
    Gets or sets the properties. Define quantum workspace's specific properties.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    identity ManagedServiceIdentityResponse
    The managed service identities assigned to this resource.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    Gets or sets the properties. Define quantum workspace's specific properties.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    identity Property Map
    The managed service identities assigned to this resource.
    tags Map<String>
    Resource tags.

    Supporting Types

    ManagedServiceIdentityResponse

    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.Quantum.Inputs.UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    PrincipalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    TenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    Type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    UserAssignedIdentities map[string]UserAssignedIdentityResponse
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<String,UserAssignedIdentityResponse>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId string
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId string
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type string
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principal_id str
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenant_id str
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type str
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
    principalId String
    The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
    tenantId String
    The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
    type String
    Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
    userAssignedIdentities Map<Property Map>
    The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

    ProviderResponse

    ApplicationName string
    The provider's marketplace application display name.
    InstanceUri string
    A Uri identifying the specific instance of this provider.
    ProviderId string
    Unique id of this provider.
    ProviderSku string
    The sku associated with pricing information for this provider.
    ProvisioningState string
    Provisioning status field
    ResourceUsageId string
    Id to track resource usage for the provider.
    ApplicationName string
    The provider's marketplace application display name.
    InstanceUri string
    A Uri identifying the specific instance of this provider.
    ProviderId string
    Unique id of this provider.
    ProviderSku string
    The sku associated with pricing information for this provider.
    ProvisioningState string
    Provisioning status field
    ResourceUsageId string
    Id to track resource usage for the provider.
    applicationName String
    The provider's marketplace application display name.
    instanceUri String
    A Uri identifying the specific instance of this provider.
    providerId String
    Unique id of this provider.
    providerSku String
    The sku associated with pricing information for this provider.
    provisioningState String
    Provisioning status field
    resourceUsageId String
    Id to track resource usage for the provider.
    applicationName string
    The provider's marketplace application display name.
    instanceUri string
    A Uri identifying the specific instance of this provider.
    providerId string
    Unique id of this provider.
    providerSku string
    The sku associated with pricing information for this provider.
    provisioningState string
    Provisioning status field
    resourceUsageId string
    Id to track resource usage for the provider.
    application_name str
    The provider's marketplace application display name.
    instance_uri str
    A Uri identifying the specific instance of this provider.
    provider_id str
    Unique id of this provider.
    provider_sku str
    The sku associated with pricing information for this provider.
    provisioning_state str
    Provisioning status field
    resource_usage_id str
    Id to track resource usage for the provider.
    applicationName String
    The provider's marketplace application display name.
    instanceUri String
    A Uri identifying the specific instance of this provider.
    providerId String
    Unique id of this provider.
    providerSku String
    The sku associated with pricing information for this provider.
    provisioningState String
    Provisioning status field
    resourceUsageId String
    Id to track resource usage for the provider.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    UserAssignedIdentityResponse

    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    ClientId string
    The client ID of the assigned identity.
    PrincipalId string
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.
    clientId string
    The client ID of the assigned identity.
    principalId string
    The principal ID of the assigned identity.
    client_id str
    The client ID of the assigned identity.
    principal_id str
    The principal ID of the assigned identity.
    clientId String
    The client ID of the assigned identity.
    principalId String
    The principal ID of the assigned identity.

    WorkspaceResourcePropertiesResponse

    EndpointUri string
    The URI of the workspace endpoint.
    ProvisioningState string
    Provisioning status field
    Usable string
    Whether the current workspace is ready to accept Jobs.
    ApiKeyEnabled bool
    Indicator of enablement of the Quantum workspace Api keys.
    Providers List<Pulumi.AzureNative.Quantum.Inputs.ProviderResponse>
    List of Providers selected for this Workspace
    StorageAccount string
    ARM Resource Id of the storage account associated with this workspace.
    EndpointUri string
    The URI of the workspace endpoint.
    ProvisioningState string
    Provisioning status field
    Usable string
    Whether the current workspace is ready to accept Jobs.
    ApiKeyEnabled bool
    Indicator of enablement of the Quantum workspace Api keys.
    Providers []ProviderResponse
    List of Providers selected for this Workspace
    StorageAccount string
    ARM Resource Id of the storage account associated with this workspace.
    endpointUri String
    The URI of the workspace endpoint.
    provisioningState String
    Provisioning status field
    usable String
    Whether the current workspace is ready to accept Jobs.
    apiKeyEnabled Boolean
    Indicator of enablement of the Quantum workspace Api keys.
    providers List<ProviderResponse>
    List of Providers selected for this Workspace
    storageAccount String
    ARM Resource Id of the storage account associated with this workspace.
    endpointUri string
    The URI of the workspace endpoint.
    provisioningState string
    Provisioning status field
    usable string
    Whether the current workspace is ready to accept Jobs.
    apiKeyEnabled boolean
    Indicator of enablement of the Quantum workspace Api keys.
    providers ProviderResponse[]
    List of Providers selected for this Workspace
    storageAccount string
    ARM Resource Id of the storage account associated with this workspace.
    endpoint_uri str
    The URI of the workspace endpoint.
    provisioning_state str
    Provisioning status field
    usable str
    Whether the current workspace is ready to accept Jobs.
    api_key_enabled bool
    Indicator of enablement of the Quantum workspace Api keys.
    providers Sequence[ProviderResponse]
    List of Providers selected for this Workspace
    storage_account str
    ARM Resource Id of the storage account associated with this workspace.
    endpointUri String
    The URI of the workspace endpoint.
    provisioningState String
    Provisioning status field
    usable String
    Whether the current workspace is ready to accept Jobs.
    apiKeyEnabled Boolean
    Indicator of enablement of the Quantum workspace Api keys.
    providers List<Property Map>
    List of Providers selected for this Workspace
    storageAccount String
    ARM Resource Id of the storage account associated with this workspace.

    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