Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. healthcareapis
  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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.healthcareapis.getWorkspace

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets the properties of the specified workspace.

Uses Azure REST API version 2024-03-31.

Other available API versions: 2022-10-01-preview, 2022-12-01, 2023-02-28, 2023-09-06, 2023-11-01, 2023-12-01, 2024-03-01, 2025-03-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native healthcareapis [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>
Copy
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]
Copy
func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:healthcareapis:getWorkspace
  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 that contains the service instance.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
WorkspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of workspace resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
string
The name of workspace resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group that contains the service instance.
workspace_name
This property is required.
Changes to this property will trigger replacement.
str
The name of workspace resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group that contains the service instance.
workspaceName
This property is required.
Changes to this property will trigger replacement.
String
The name of workspace resource.

getWorkspace Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
The resource identifier.
Name string
The resource name.
Properties Pulumi.AzureNative.HealthcareApis.Outputs.WorkspaceResponseProperties
Workspaces resource specific properties.
SystemData Pulumi.AzureNative.HealthcareApis.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
Etag string
An etag associated with the resource, used for optimistic concurrency when editing it.
Location string
The resource location.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
The resource identifier.
Name string
The resource name.
Properties WorkspaceResponseProperties
Workspaces resource specific properties.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The resource type.
Etag string
An etag associated with the resource, used for optimistic concurrency when editing it.
Location string
The resource location.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
The resource identifier.
name String
The resource name.
properties WorkspaceResponseProperties
Workspaces resource specific properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.
etag String
An etag associated with the resource, used for optimistic concurrency when editing it.
location String
The resource location.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
The resource identifier.
name string
The resource name.
properties WorkspaceResponseProperties
Workspaces resource specific properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The resource type.
etag string
An etag associated with the resource, used for optimistic concurrency when editing it.
location string
The resource location.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
The resource identifier.
name str
The resource name.
properties WorkspaceResponseProperties
Workspaces resource specific properties.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The resource type.
etag str
An etag associated with the resource, used for optimistic concurrency when editing it.
location str
The resource location.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
The resource identifier.
name String
The resource name.
properties Property Map
Workspaces resource specific properties.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The resource type.
etag String
An etag associated with the resource, used for optimistic concurrency when editing it.
location String
The resource location.
tags Map<String>
Resource tags.

Supporting Types

PrivateEndpointConnectionResponse

Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. Pulumi.AzureNative.HealthcareApis.Inputs.PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint Pulumi.AzureNative.HealthcareApis.Inputs.PrivateEndpointResponse
The resource of private end point.
Id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name This property is required. string
The name of the resource
PrivateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
ProvisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
Type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
PrivateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. string
The name of the resource
privateLinkServiceConnectionState This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. string
The provisioning state of the private endpoint connection resource.
type This property is required. string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. str
The name of the resource
private_link_service_connection_state This property is required. PrivateLinkServiceConnectionStateResponse
A collection of information about the state of the connection between service consumer and provider.
provisioning_state This property is required. str
The provisioning state of the private endpoint connection resource.
type This property is required. str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
private_endpoint PrivateEndpointResponse
The resource of private end point.
id This property is required. String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name This property is required. String
The name of the resource
privateLinkServiceConnectionState This property is required. Property Map
A collection of information about the state of the connection between service consumer and provider.
provisioningState This property is required. String
The provisioning state of the private endpoint connection resource.
type This property is required. String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
privateEndpoint Property Map
The resource of private end point.

PrivateEndpointResponse

Id This property is required. string
The ARM identifier for Private Endpoint
Id This property is required. string
The ARM identifier for Private Endpoint
id This property is required. String
The ARM identifier for Private Endpoint
id This property is required. string
The ARM identifier for Private Endpoint
id This property is required. str
The ARM identifier for Private Endpoint
id This property is required. String
The ARM identifier for Private Endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
ActionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
Description string
The reason for approval/rejection of the connection.
Status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired string
A message indicating if changes on the service provider require any updates on the consumer.
description string
The reason for approval/rejection of the connection.
status string
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actions_required str
A message indicating if changes on the service provider require any updates on the consumer.
description str
The reason for approval/rejection of the connection.
status str
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.
actionsRequired String
A message indicating if changes on the service provider require any updates on the consumer.
description String
The reason for approval/rejection of the connection.
status String
Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

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.

WorkspaceResponseProperties

PrivateEndpointConnections This property is required. List<Pulumi.AzureNative.HealthcareApis.Inputs.PrivateEndpointConnectionResponse>
The list of private endpoint connections that are set up for this resource.
ProvisioningState This property is required. string
The provisioning state.
PublicNetworkAccess This property is required. string
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
PrivateEndpointConnections This property is required. []PrivateEndpointConnectionResponse
The list of private endpoint connections that are set up for this resource.
ProvisioningState This property is required. string
The provisioning state.
PublicNetworkAccess This property is required. string
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
privateEndpointConnections This property is required. List<PrivateEndpointConnectionResponse>
The list of private endpoint connections that are set up for this resource.
provisioningState This property is required. String
The provisioning state.
publicNetworkAccess This property is required. String
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
privateEndpointConnections This property is required. PrivateEndpointConnectionResponse[]
The list of private endpoint connections that are set up for this resource.
provisioningState This property is required. string
The provisioning state.
publicNetworkAccess This property is required. string
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
private_endpoint_connections This property is required. Sequence[PrivateEndpointConnectionResponse]
The list of private endpoint connections that are set up for this resource.
provisioning_state This property is required. str
The provisioning state.
public_network_access This property is required. str
Control permission for data plane traffic coming from public networks while private endpoint is enabled.
privateEndpointConnections This property is required. List<Property Map>
The list of private endpoint connections that are set up for this resource.
provisioningState This property is required. String
The provisioning state.
publicNetworkAccess This property is required. String
Control permission for data plane traffic coming from public networks while private endpoint is enabled.

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native