Compartilhar via


Microsoft.Compute diskEncryptionSets

Definição de recurso do Bicep

O tipo de recurso diskEncryptionSets pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Compute/diskEncryptionSets, adicione o Bicep a seguir ao modelo.

resource symbolicname 'Microsoft.Compute/diskEncryptionSets@2025-01-02' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    activeKey: {
      keyUrl: 'string'
      sourceVault: {
        id: 'string'
      }
    }
    encryptionType: 'string'
    federatedClientId: 'string'
    rotationToLatestKeyVersionEnabled: bool
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.Compute/diskEncryptionSets

Nome Descrição Valor
identidade A identidade gerenciada do conjunto de criptografia de disco. Ele deve receber permissão no cofre de chaves antes de poder ser usado para criptografar discos. EncryptionSetIdentity
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do EncryptionSet
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

CommonUserAssignedIdentitiesValue

Nome Descrição Valor

EncryptionSetIdentity

Nome Descrição Valor
tipo O tipo de Identidade Gerenciada usada pelo DiskEncryptionSet. Somente SystemAssigned tem suporte para novas criações. Os Conjuntos de Criptografia de Disco podem ser atualizados com o tipo de identidade None durante a migração da assinatura para um novo locatário do Azure Active Directory; isso fará com que os recursos criptografados percam o acesso às chaves. 'Nenhum'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas ao conjunto de criptografia de disco. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. EncryptionSetIdentityUserAssignedIdentities

EncryptionSetIdentityUserAssignedIdentities

Nome Descrição Valor

Propriedades do EncryptionSet

Nome Descrição Valor
Chave ativa A chave do cofre de chaves que atualmente é usada por esse conjunto de criptografia de disco. KeyForDiskEncryptionSet
tipo de criptografia O tipo de chave usado para criptografar os dados do disco. 'ConfidentialVmEncryptedWithCustomerKey'
'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
federatedClientId ID do cliente do aplicativo multilocatário para acessar o cofre de chaves em um locatário diferente. Definir o valor como 'None' limpará a propriedade. cadeia
rotationToLatestKeyVersionEnabled Defina esse sinalizador como true para habilitar a atualização automática desse conjunto de criptografia de disco para a versão mais recente da chave. Bool

KeyForDiskEncryptionSet

Nome Descrição Valor
keyUrl Url de chave totalmente com versão apontando para uma chave no KeyVault. O segmento de versão da URL é necessário independentemente do valor rotationToLatestKeyVersionEnabled. cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo. Essa propriedade é opcional e não pode ser usada se a assinatura do KeyVault não for a mesma que a assinatura do Conjunto de Criptografia de Disco. sourceVault

SourceVault

Nome Descrição Valor
id ID do recurso cadeia

TrackedResourceTags

Nome Descrição Valor

Exemplos de uso

Exemplos do Bicep

Um exemplo básico de implantação do Conjunto de Criptografia de Disco.

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

resource diskEncryptionSet 'Microsoft.Compute/diskEncryptionSets@2022-03-02' = {
  name: resourceName
  location: location
  properties: {
    activeKey: {
      keyUrl: key.properties.keyUriWithVersion
      sourceVault: {
        id: vault.id
      }
    }
    encryptionType: 'EncryptionAtRestWithCustomerKey'
    rotationToLatestKeyVersionEnabled: false
  }
}

resource vault 'Microsoft.KeyVault/vaults@2023-02-01' = {
  name: resourceName
  location: location
  properties: {
    accessPolicies: []
    enableSoftDelete: true
    sku: {
      family: 'A'
      name: 'standard'
    }
    tenantId: deployer().tenantId
  }
}

resource key 'Microsoft.KeyVault/vaults/keys@2023-02-01' = {
  parent: vault
  name: resourceName
  properties: {
    keyOps: [
      'encrypt'
      'decrypt'
      'sign'
      'verify'
      'wrapKey'
      'unwrapKey'
    ]
    keySize: 2048
    kty: 'RSA'
  }
}

Módulos verificados do Azure

O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.

Módulo Descrição
do Conjunto de Criptografia de Disco Módulo de recurso AVM para conjunto de criptografia de disco

Definição de recurso de modelo do ARM

O tipo de recurso diskEncryptionSets pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Compute/diskEncryptionSets, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.Compute/diskEncryptionSets",
  "apiVersion": "2025-01-02",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "activeKey": {
      "keyUrl": "string",
      "sourceVault": {
        "id": "string"
      }
    },
    "encryptionType": "string",
    "federatedClientId": "string",
    "rotationToLatestKeyVersionEnabled": "bool"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.Compute/diskEncryptionSets

Nome Descrição Valor
apiVersion A versão da API '2025-01-02'
identidade A identidade gerenciada do conjunto de criptografia de disco. Ele deve receber permissão no cofre de chaves antes de poder ser usado para criptografar discos. EncryptionSetIdentity
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do EncryptionSet
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.Compute/diskEncryptionSets'

CommonUserAssignedIdentitiesValue

Nome Descrição Valor

EncryptionSetIdentity

Nome Descrição Valor
tipo O tipo de Identidade Gerenciada usada pelo DiskEncryptionSet. Somente SystemAssigned tem suporte para novas criações. Os Conjuntos de Criptografia de Disco podem ser atualizados com o tipo de identidade None durante a migração da assinatura para um novo locatário do Azure Active Directory; isso fará com que os recursos criptografados percam o acesso às chaves. 'Nenhum'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas ao conjunto de criptografia de disco. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. EncryptionSetIdentityUserAssignedIdentities

EncryptionSetIdentityUserAssignedIdentities

Nome Descrição Valor

Propriedades do EncryptionSet

Nome Descrição Valor
Chave ativa A chave do cofre de chaves que atualmente é usada por esse conjunto de criptografia de disco. KeyForDiskEncryptionSet
tipo de criptografia O tipo de chave usado para criptografar os dados do disco. 'ConfidentialVmEncryptedWithCustomerKey'
'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
federatedClientId ID do cliente do aplicativo multilocatário para acessar o cofre de chaves em um locatário diferente. Definir o valor como 'None' limpará a propriedade. cadeia
rotationToLatestKeyVersionEnabled Defina esse sinalizador como true para habilitar a atualização automática desse conjunto de criptografia de disco para a versão mais recente da chave. Bool

KeyForDiskEncryptionSet

Nome Descrição Valor
keyUrl Url de chave totalmente com versão apontando para uma chave no KeyVault. O segmento de versão da URL é necessário independentemente do valor rotationToLatestKeyVersionEnabled. cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo. Essa propriedade é opcional e não pode ser usada se a assinatura do KeyVault não for a mesma que a assinatura do Conjunto de Criptografia de Disco. sourceVault

SourceVault

Nome Descrição Valor
id ID do recurso cadeia

TrackedResourceTags

Nome Descrição Valor

Exemplos de uso

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso diskEncryptionSets pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.Compute/diskEncryptionSets, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/diskEncryptionSets@2025-01-02"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      activeKey = {
        keyUrl = "string"
        sourceVault = {
          id = "string"
        }
      }
      encryptionType = "string"
      federatedClientId = "string"
      rotationToLatestKeyVersionEnabled = bool
    }
  }
}

Valores de propriedade

Microsoft.Compute/diskEncryptionSets

Nome Descrição Valor
identidade A identidade gerenciada do conjunto de criptografia de disco. Ele deve receber permissão no cofre de chaves antes de poder ser usado para criptografar discos. EncryptionSetIdentity
local A localização geográfica onde o recurso reside cadeia de caracteres (obrigatório)
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades do EncryptionSet
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.Compute/diskEncryptionSets@2025-01-02"

CommonUserAssignedIdentitiesValue

Nome Descrição Valor

EncryptionSetIdentity

Nome Descrição Valor
tipo O tipo de Identidade Gerenciada usada pelo DiskEncryptionSet. Somente SystemAssigned tem suporte para novas criações. Os Conjuntos de Criptografia de Disco podem ser atualizados com o tipo de identidade None durante a migração da assinatura para um novo locatário do Azure Active Directory; isso fará com que os recursos criptografados percam o acesso às chaves. 'Nenhum'
'SystemAssigned'
'SystemAssigned, UserAssigned'
'UserAssigned'
Identidades Atribuídas pelo Usuário A lista de identidades de usuário associadas ao conjunto de criptografia de disco. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. EncryptionSetIdentityUserAssignedIdentities

EncryptionSetIdentityUserAssignedIdentities

Nome Descrição Valor

Propriedades do EncryptionSet

Nome Descrição Valor
Chave ativa A chave do cofre de chaves que atualmente é usada por esse conjunto de criptografia de disco. KeyForDiskEncryptionSet
tipo de criptografia O tipo de chave usado para criptografar os dados do disco. 'ConfidentialVmEncryptedWithCustomerKey'
'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
federatedClientId ID do cliente do aplicativo multilocatário para acessar o cofre de chaves em um locatário diferente. Definir o valor como 'None' limpará a propriedade. cadeia
rotationToLatestKeyVersionEnabled Defina esse sinalizador como true para habilitar a atualização automática desse conjunto de criptografia de disco para a versão mais recente da chave. Bool

KeyForDiskEncryptionSet

Nome Descrição Valor
keyUrl Url de chave totalmente com versão apontando para uma chave no KeyVault. O segmento de versão da URL é necessário independentemente do valor rotationToLatestKeyVersionEnabled. cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo. Essa propriedade é opcional e não pode ser usada se a assinatura do KeyVault não for a mesma que a assinatura do Conjunto de Criptografia de Disco. sourceVault

SourceVault

Nome Descrição Valor
id ID do recurso cadeia

TrackedResourceTags

Nome Descrição Valor

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação do Conjunto de Criptografia de Disco.

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

provider "azurerm" {
  features {
  }
}

provider "azapi" {
  skip_provider_registration = false
}

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

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

data "azurerm_client_config" "current" {
}

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

resource "azapi_resource" "vault" {
  type      = "Microsoft.KeyVault/vaults@2023-02-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      sku = {
        family = "A"
        name   = "standard"
      }
      accessPolicies   = []
      enableSoftDelete = true
      tenantId         = data.azurerm_client_config.current.tenant_id
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.accessPolicies]
  }
}

data "azapi_resource_id" "key" {
  type      = "Microsoft.KeyVault/vaults/keys@2023-02-01"
  parent_id = azapi_resource.vault.id
  name      = var.resource_name
}

resource "azapi_resource_action" "key" {
  type        = "Microsoft.KeyVault/vaults/keys@2023-02-01"
  resource_id = data.azapi_resource_id.key.id
  method      = "PUT"
  body = {
    properties = {
      keySize = 2048
      kty     = "RSA"
      keyOps  = ["encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey"]
    }
  }
  response_export_values = ["*"]
}

resource "azapi_resource" "diskEncryptionSet" {
  type      = "Microsoft.Compute/diskEncryptionSets@2022-03-02"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      activeKey = {
        keyUrl = azapi_resource_action.key.output.properties.keyUriWithVersion
        sourceVault = {
          id = azapi_resource.vault.id
        }
      }
      encryptionType                    = "EncryptionAtRestWithCustomerKey"
      rotationToLatestKeyVersionEnabled = false
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Módulos verificados do Azure

O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.

Módulo Descrição
do Conjunto de Criptografia de Disco Módulo de recurso AVM para conjunto de criptografia de disco