1. Packages
  2. Azure Native v2
  3. API Docs
  4. healthcareapis
  5. Workspace
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.healthcareapis.Workspace

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Workspace resource. Azure REST API version: 2023-02-28. Prior API version in Azure Native 1.x: 2022-05-15.

Other available API versions: 2023-09-06, 2023-11-01, 2023-12-01, 2024-03-01, 2024-03-31.

Example Usage

Create or update a workspace

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workspace = new AzureNative.HealthcareApis.Workspace("workspace", new()
    {
        Location = "westus",
        ResourceGroupName = "testRG",
        WorkspaceName = "workspace1",
    });

});
Copy
package main

import (
	healthcareapis "github.com/pulumi/pulumi-azure-native-sdk/healthcareapis/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := healthcareapis.NewWorkspace(ctx, "workspace", &healthcareapis.WorkspaceArgs{
			Location:          pulumi.String("westus"),
			ResourceGroupName: pulumi.String("testRG"),
			WorkspaceName:     pulumi.String("workspace1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.healthcareapis.Workspace;
import com.pulumi.azurenative.healthcareapis.WorkspaceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var workspace = new Workspace("workspace", WorkspaceArgs.builder()
            .location("westus")
            .resourceGroupName("testRG")
            .workspaceName("workspace1")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workspace = new azure_native.healthcareapis.Workspace("workspace", {
    location: "westus",
    resourceGroupName: "testRG",
    workspaceName: "workspace1",
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workspace = azure_native.healthcareapis.Workspace("workspace",
    location="westus",
    resource_group_name="testRG",
    workspace_name="workspace1")
Copy
resources:
  workspace:
    type: azure-native:healthcareapis:Workspace
    properties:
      location: westus
      resourceGroupName: testRG
      workspaceName: workspace1
Copy

Create Workspace Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Workspace(name: string, args: WorkspaceArgs, opts?: CustomResourceOptions);
@overload
def Workspace(resource_name: str,
              args: WorkspaceArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Workspace(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              resource_group_name: Optional[str] = None,
              location: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              workspace_name: Optional[str] = None)
func NewWorkspace(ctx *Context, name string, args WorkspaceArgs, opts ...ResourceOption) (*Workspace, error)
public Workspace(string name, WorkspaceArgs args, CustomResourceOptions? opts = null)
public Workspace(String name, WorkspaceArgs args)
public Workspace(String name, WorkspaceArgs args, CustomResourceOptions options)
type: azure-native:healthcareapis:Workspace
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. WorkspaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkspaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkspaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampleworkspaceResourceResourceFromHealthcareapis = new AzureNative.Healthcareapis.Workspace("exampleworkspaceResourceResourceFromHealthcareapis", new()
{
    ResourceGroupName = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
    WorkspaceName = "string",
});
Copy
example, err := healthcareapis.NewWorkspace(ctx, "exampleworkspaceResourceResourceFromHealthcareapis", &healthcareapis.WorkspaceArgs{
	ResourceGroupName: "string",
	Location:          "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
	WorkspaceName: "string",
})
Copy
var exampleworkspaceResourceResourceFromHealthcareapis = new Workspace("exampleworkspaceResourceResourceFromHealthcareapis", WorkspaceArgs.builder()
    .resourceGroupName("string")
    .location("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .workspaceName("string")
    .build());
Copy
exampleworkspace_resource_resource_from_healthcareapis = azure_native.healthcareapis.Workspace("exampleworkspaceResourceResourceFromHealthcareapis",
    resource_group_name=string,
    location=string,
    tags={
        string: string,
    },
    workspace_name=string)
Copy
const exampleworkspaceResourceResourceFromHealthcareapis = new azure_native.healthcareapis.Workspace("exampleworkspaceResourceResourceFromHealthcareapis", {
    resourceGroupName: "string",
    location: "string",
    tags: {
        string: "string",
    },
    workspaceName: "string",
});
Copy
type: azure-native:healthcareapis:Workspace
properties:
    location: string
    resourceGroupName: string
    tags:
        string: string
    workspaceName: string
Copy

Workspace Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Workspace resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group that contains the service instance.
Location Changes to this property will trigger replacement. string
The resource location.
Tags Dictionary<string, string>
Resource tags.
WorkspaceName 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.
Location Changes to this property will trigger replacement. string
The resource location.
Tags map[string]string
Resource tags.
WorkspaceName 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.
location Changes to this property will trigger replacement. String
The resource location.
tags Map<String,String>
Resource tags.
workspaceName 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.
location Changes to this property will trigger replacement. string
The resource location.
tags {[key: string]: string}
Resource tags.
workspaceName 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.
location Changes to this property will trigger replacement. str
The resource location.
tags Mapping[str, str]
Resource tags.
workspace_name 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.
location Changes to this property will trigger replacement. String
The resource location.
tags Map<String>
Resource tags.
workspaceName Changes to this property will trigger replacement. String
The name of workspace resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Workspace resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
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.
Id string
The provider-assigned unique ID for this managed resource.
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.
id String
The provider-assigned unique ID for this managed resource.
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.
id string
The provider-assigned unique ID for this managed resource.
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.
id str
The provider-assigned unique ID for this managed resource.
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.
id String
The provider-assigned unique ID for this managed resource.
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.

Supporting Types

PrivateEndpointConnectionResponse
, PrivateEndpointConnectionResponseArgs

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
, PrivateEndpointResponseArgs

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
, PrivateLinkServiceConnectionStateResponseArgs

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
, SystemDataResponseArgs

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
, WorkspaceResponsePropertiesArgs

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:healthcareapis:Workspace workspace1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi