Microsoft.HealthcareApis workspaces

Bicep resource definition

The workspaces resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HealthcareApis/workspaces resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.HealthcareApis/workspaces@2025-04-01-preview' = {
  etag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    publicNetworkAccess: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.HealthcareApis/workspaces

Name Description Value
etag An etag associated with the resource, used for optimistic concurrency when editing it. string
location The common properties for any location based resource, tracked or proxy. string
name The resource name string

Constraints:
Min length = 3
Max length = 24 (required)
properties Workspaces resource specific properties. WorkspaceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

WorkspaceProperties

Name Description Value
publicNetworkAccess Control permission for data plane traffic coming from public networks while private endpoint is enabled. 'Disabled'
'Enabled'

WorkspaceTags

Name Description Value

Usage Examples

Bicep Samples

A basic example of deploying Healthcare Workspace.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource workspace 'Microsoft.HealthcareApis/workspaces@2022-12-01' = {
  name: resourceName
  location: location
}

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module Description
Healthcare API Workspace AVM Resource Module for Healthcare API Workspace

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Configure FHIR service to enable $import This template provisions FHIR service to enable $import for initial data loading
Deploy the MedTech service The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service.
Deploy the MedTech service including an Azure IoT Hub The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service.

ARM template resource definition

The workspaces resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HealthcareApis/workspaces resource, add the following JSON to your template.

{
  "type": "Microsoft.HealthcareApis/workspaces",
  "apiVersion": "2025-04-01-preview",
  "name": "string",
  "etag": "string",
  "location": "string",
  "properties": {
    "publicNetworkAccess": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.HealthcareApis/workspaces

Name Description Value
apiVersion The api version '2025-04-01-preview'
etag An etag associated with the resource, used for optimistic concurrency when editing it. string
location The common properties for any location based resource, tracked or proxy. string
name The resource name string

Constraints:
Min length = 3
Max length = 24 (required)
properties Workspaces resource specific properties. WorkspaceProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.HealthcareApis/workspaces'

WorkspaceProperties

Name Description Value
publicNetworkAccess Control permission for data plane traffic coming from public networks while private endpoint is enabled. 'Disabled'
'Enabled'

WorkspaceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Configure FHIR service to enable $import

Deploy to Azure		 This template provisions FHIR service to enable $import for initial data loading
Deploy the MedTech service

Deploy to Azure		 The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service.
Deploy the MedTech service including an Azure IoT Hub

Deploy to Azure		 The MedTech service is one of the Azure Health Data Services designed to ingest device data from multiple devices, transform the device data into FHIR Observations, which are then persisted in the Azure Health Data Services FHIR service.

Terraform (AzAPI provider) resource definition

The workspaces resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.HealthcareApis/workspaces resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.HealthcareApis/workspaces@2025-04-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    properties = {
      publicNetworkAccess = "string"
    }
  }
}

Property Values

Microsoft.HealthcareApis/workspaces

Name Description Value
etag An etag associated with the resource, used for optimistic concurrency when editing it. string
location The common properties for any location based resource, tracked or proxy. string
name The resource name string

Constraints:
Min length = 3
Max length = 24 (required)
properties Workspaces resource specific properties. WorkspaceProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.HealthcareApis/workspaces@2025-04-01-preview"

WorkspaceProperties

Name Description Value
publicNetworkAccess Control permission for data plane traffic coming from public networks while private endpoint is enabled. 'Disabled'
'Enabled'

WorkspaceTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Healthcare Workspace.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "workspace" {
  type                      = "Microsoft.HealthcareApis/workspaces@2022-12-01"
  parent_id                 = azapi_resource.resourceGroup.id
  name                      = var.resource_name
  location                  = var.location
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on