Share via

Microsoft.DevCenter devcenters/encryptionSets 2024-10-01-preview

Bicep resource definition

The devcenters/encryptionSets 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.DevCenter/devcenters/encryptionSets resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DevCenter/devcenters/encryptionSets@2024-10-01-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    devboxDisksEncryptionEnableStatus: 'string'
    keyEncryptionKeyUrl: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.DevCenter/devcenters/encryptionSets

Name Description Value
identity Managed identity properties ManagedServiceIdentity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: devcenters
properties Properties of a devcenter encryption set. DevCenterEncryptionSetProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

DevCenterEncryptionSetProperties

Name Description Value
devboxDisksEncryptionEnableStatus Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption using DevCenter CMK is enabled or not. 'Disabled'
'Enabled'
keyEncryptionKeyUrl Key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (required)
userAssignedIdentities 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. UserAssignedIdentities

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

ARM template resource definition

The devcenters/encryptionSets 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.DevCenter/devcenters/encryptionSets resource, add the following JSON to your template.

{
  "type": "Microsoft.DevCenter/devcenters/encryptionSets",
  "apiVersion": "2024-10-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "devboxDisksEncryptionEnableStatus": "string",
    "keyEncryptionKeyUrl": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DevCenter/devcenters/encryptionSets

Name Description Value
apiVersion The api version '2024-10-01-preview'
identity Managed identity properties ManagedServiceIdentity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$ (required)
properties Properties of a devcenter encryption set. DevCenterEncryptionSetProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.DevCenter/devcenters/encryptionSets'

DevCenterEncryptionSetProperties

Name Description Value
devboxDisksEncryptionEnableStatus Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption using DevCenter CMK is enabled or not. 'Disabled'
'Enabled'
keyEncryptionKeyUrl Key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (required)
userAssignedIdentities 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. UserAssignedIdentities

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The devcenters/encryptionSets 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.DevCenter/devcenters/encryptionSets resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DevCenter/devcenters/encryptionSets@2024-10-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      devboxDisksEncryptionEnableStatus = "string"
      keyEncryptionKeyUrl = "string"
    }
  }
}

Property Values

Microsoft.DevCenter/devcenters/encryptionSets

Name Description Value
identity Managed identity properties ManagedServiceIdentity
location The geo-location where the resource lives string (required)
name The resource name string

Constraints:
Min length = 3
Max length = 63
Pattern = ^[a-zA-Z0-9][a-zA-Z0-9-]{2,25}$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: devcenters
properties Properties of a devcenter encryption set. DevCenterEncryptionSetProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.DevCenter/devcenters/encryptionSets@2024-10-01-preview"

DevCenterEncryptionSetProperties

Name Description Value
devboxDisksEncryptionEnableStatus Devbox disk encryption enable or disable status. Indicates if Devbox disks encryption using DevCenter CMK is enabled or not. 'Disabled'
'Enabled'
keyEncryptionKeyUrl Key encryption key Url, versioned or non-versioned. Ex: https://contosovault.vault.azure.net/keys/contosokek/562a4bb76b524a1493a6afe8e536ee78 or https://contosovault.vault.azure.net/keys/contosokek. string

ManagedServiceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). 'None'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned' (required)
userAssignedIdentities 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. UserAssignedIdentities

TrackedResourceTags

Name Description Value

UserAssignedIdentities

Name Description Value

UserAssignedIdentity

Name Description Value