Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The workspaces resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.Discovery/workspaces resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.Discovery/workspaces@2026-06-01' = {
location: 'string'
name: 'string'
properties: {
agentSubnetId: 'string'
customerManagedKeys: 'string'
keyVaultProperties: {
keyName: 'string'
keyVaultUri: 'string'
keyVersion: 'string'
}
logAnalyticsClusterId: 'string'
privateEndpointSubnetId: 'string'
publicNetworkAccess: 'string'
supercomputerIds: [
'string'
]
workspaceIdentity: {
id: 'string'
}
workspaceSubnetId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.Discovery/workspaces
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | WorkspaceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
Identity
| Name | Description | Value |
|---|---|---|
| id | The resource ID of the user assigned identity. | string (required) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The Key Name in Key Vault | string (required) |
| keyVaultUri | The Key Vault URI | string (required) |
| keyVersion | The Key Version in Key Vault | string |
TrackedResourceTags
| Name | Description | Value |
|---|
WorkspaceProperties
| Name | Description | Value |
|---|---|---|
| agentSubnetId | Agent Subnet ID for agent resources. | string |
| customerManagedKeys | Whether or not to use a customer managed key when encrypting data at rest | 'Disabled' 'Enabled' |
| keyVaultProperties | The key to use for encrypting data at rest when customer managed keys are enabled. | KeyVaultProperties |
| logAnalyticsClusterId | The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled. | string |
| privateEndpointSubnetId | Private Endpoint Subnet ID for private endpoint connections. | string |
| publicNetworkAccess | Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible. | 'Disabled' 'Enabled' |
| supercomputerIds | List of linked SuperComputers. | string[] |
| workspaceIdentity | Identity IDs used for leveraging Workspace resources. | Identity (required) |
| workspaceSubnetId | Function Subnet ID for workspace resources. | string |
ARM template resource definition
The workspaces resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands For a list of changed properties in each API version, see change log.
Usage Examples
Resource format
To create a Microsoft.Discovery/workspaces resource, add the following JSON to your template.
{
"type": "Microsoft.Discovery/workspaces",
"apiVersion": "2026-06-01",
"name": "string",
"location": "string",
"properties": {
"agentSubnetId": "string",
"customerManagedKeys": "string",
"keyVaultProperties": {
"keyName": "string",
"keyVaultUri": "string",
"keyVersion": "string"
},
"logAnalyticsClusterId": "string",
"privateEndpointSubnetId": "string",
"publicNetworkAccess": "string",
"supercomputerIds": [ "string" ],
"workspaceIdentity": {
"id": "string"
},
"workspaceSubnetId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.Discovery/workspaces
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2026-06-01' |
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | WorkspaceProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.Discovery/workspaces' |
Identity
| Name | Description | Value |
|---|---|---|
| id | The resource ID of the user assigned identity. | string (required) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The Key Name in Key Vault | string (required) |
| keyVaultUri | The Key Vault URI | string (required) |
| keyVersion | The Key Version in Key Vault | string |
TrackedResourceTags
| Name | Description | Value |
|---|
WorkspaceProperties
| Name | Description | Value |
|---|---|---|
| agentSubnetId | Agent Subnet ID for agent resources. | string |
| customerManagedKeys | Whether or not to use a customer managed key when encrypting data at rest | 'Disabled' 'Enabled' |
| keyVaultProperties | The key to use for encrypting data at rest when customer managed keys are enabled. | KeyVaultProperties |
| logAnalyticsClusterId | The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled. | string |
| privateEndpointSubnetId | Private Endpoint Subnet ID for private endpoint connections. | string |
| publicNetworkAccess | Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible. | 'Disabled' 'Enabled' |
| supercomputerIds | List of linked SuperComputers. | string[] |
| workspaceIdentity | Identity IDs used for leveraging Workspace resources. | Identity (required) |
| workspaceSubnetId | Function Subnet ID for workspace resources. | string |
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.Discovery/workspaces resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Discovery/workspaces@2026-06-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
properties = {
agentSubnetId = "string"
customerManagedKeys = "string"
keyVaultProperties = {
keyName = "string"
keyVaultUri = "string"
keyVersion = "string"
}
logAnalyticsClusterId = "string"
privateEndpointSubnetId = "string"
publicNetworkAccess = "string"
supercomputerIds = [
"string"
]
workspaceIdentity = {
id = "string"
}
workspaceSubnetId = "string"
}
}
}
Property Values
Microsoft.Discovery/workspaces
| Name | Description | Value |
|---|---|---|
| location | The geo-location where the resource lives | string (required) |
| name | The resource name | string Constraints: Pattern = ^[a-zA-Z0-9-]{3,24}$ (required) |
| properties | The resource-specific properties for this resource. | WorkspaceProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.Discovery/workspaces@2026-06-01" |
Identity
| Name | Description | Value |
|---|---|---|
| id | The resource ID of the user assigned identity. | string (required) |
KeyVaultProperties
| Name | Description | Value |
|---|---|---|
| keyName | The Key Name in Key Vault | string (required) |
| keyVaultUri | The Key Vault URI | string (required) |
| keyVersion | The Key Version in Key Vault | string |
TrackedResourceTags
| Name | Description | Value |
|---|
WorkspaceProperties
| Name | Description | Value |
|---|---|---|
| agentSubnetId | Agent Subnet ID for agent resources. | string |
| customerManagedKeys | Whether or not to use a customer managed key when encrypting data at rest | 'Disabled' 'Enabled' |
| keyVaultProperties | The key to use for encrypting data at rest when customer managed keys are enabled. | KeyVaultProperties |
| logAnalyticsClusterId | The Log Analytics Cluster to use for debug logs. This is required when Customer Managed Keys are enabled. | string |
| privateEndpointSubnetId | Private Endpoint Subnet ID for private endpoint connections. | string |
| publicNetworkAccess | Whether or not public network access is allowed for this resource. For security reasons, it is recommended to disable it whenever possible. | 'Disabled' 'Enabled' |
| supercomputerIds | List of linked SuperComputers. | string[] |
| workspaceIdentity | Identity IDs used for leveraging Workspace resources. | Identity (required) |
| workspaceSubnetId | Function Subnet ID for workspace resources. | string |