Share via

Instantâneos do Microsoft.Compute 2023-10-02

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de instantâneos pode ser implantado com operações direcionadas:

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

Formato de recurso

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

resource symbolicname 'Microsoft.Compute/snapshots@2023-10-02' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    name: 'string'
  }
  extendedLocation: {
    name: 'string'
    type: 'EdgeZone'
  }
  properties: {
    completionPercent: int
    copyCompletionError: {
      errorCode: 'CopySourceNotFound'
      errorMessage: 'string'
    }
    creationData: {
      createOption: 'string'
      elasticSanResourceId: 'string'
      galleryImageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      imageReference: {
        communityGalleryImageId: 'string'
        id: 'string'
        lun: int
        sharedGalleryImageId: 'string'
      }
      logicalSectorSize: int
      performancePlus: bool
      provisionedBandwidthCopySpeed: 'string'
      securityDataUri: 'string'
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
      uploadSizeBytes: int
    }
    dataAccessAuthMode: 'string'
    diskAccessId: 'string'
    diskSizeGB: int
    encryption: {
      diskEncryptionSetId: 'string'
      type: 'string'
    }
    encryptionSettingsCollection: {
      enabled: bool
      encryptionSettings: [
        {
          diskEncryptionKey: {
            secretUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
          keyEncryptionKey: {
            keyUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
        }
      ]
      encryptionSettingsVersion: 'string'
    }
    hyperVGeneration: 'string'
    incremental: bool
    networkAccessPolicy: 'string'
    osType: 'string'
    publicNetworkAccess: 'string'
    purchasePlan: {
      name: 'string'
      product: 'string'
      promotionCode: 'string'
      publisher: 'string'
    }
    securityProfile: {
      secureVMDiskEncryptionSetId: 'string'
      securityType: 'string'
    }
    supportedCapabilities: {
      acceleratedNetwork: bool
      architecture: 'string'
      diskControllerTypes: 'string'
    }
    supportsHibernation: bool
  }
}

Valores de propriedade

snapshots

Nome Descrição Valor
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos, sublinhados, pontos e hifens.

Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local Localização do recurso cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
sku O nome do sku de instantâneos. Pode ser Standard_LRS, Premium_LRS ou Standard_ZRS. Esse é um parâmetro opcional para instantâneo incremental e o comportamento padrão é que o SKU será definido como o mesmo sku do instantâneo anterior SnapshotSku
extendedLocation O local estendido em que o instantâneo será criado. O local estendido não pode ser alterado. ExtendedLocation
properties Propriedades do recurso de instantâneo. SnapshotProperties

ExtendedLocation

Nome Descrição Valor
name O nome do local estendido. string
type O tipo do local estendido. 'EdgeZone'

SnapshotProperties

Nome Descrição Valor
completionPercent Porcentagem concluída para a cópia em segundo plano quando um recurso é criado por meio da operação CopyStart. INT
copyCompletionError Indica os detalhes do erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. CopyCompletionError
creationData Informações de origem do disco. As informações de CreationData não podem ser alteradas após a criação do disco. CreationData (obrigatório)
dataAccessAuthMode Requisitos de autenticação adicionais ao exportar ou carregar em um disco ou instantâneo. 'AzureActiveDirectory'
'None'
diskAccessId ID do ARM do recurso DiskAccess para usar pontos de extremidade privados em discos. string
diskSizeGB Se creationData.createOption for Empty, esse campo será obrigatório e indicará o tamanho do disco a ser criado. Se esse campo estiver presente para atualizações ou criação com outras opções, ele indicará um redimensionamento. Redimensionamentos só serão permitidos se o disco não estiver anexado a uma VM em execução e só puder aumentar o tamanho do disco. INT
criptografia A propriedade de criptografia pode ser usada para criptografar dados inativos com chaves gerenciadas pelo cliente ou chaves gerenciadas pela plataforma. Criptografia
encryptionSettingsCollection A coleção de configurações de criptografia usada é a Criptografia de Disco do Azure, pode conter várias configurações de criptografia por disco ou instantâneo. EncryptionSettingsCollection
hyperVGeneration A geração de hipervisor da Máquina Virtual. Aplicável somente a discos do sistema operacional. 'V1'
'V2'
incremental Se um instantâneo é incremental. Instantâneos incrementais no mesmo disco ocupam menos espaço do que instantâneos completos e podem ser difusivos. bool
networkAccessPolicy Política para acessar o disco por meio da rede. 'AllowAll'
'AllowPrivate'
'DenyAll'
osType O tipo de sistema operacional. 'Linux'
'Windows'
publicNetworkAccess Política para controlar a exportação no disco. 'Desabilitado'
'Enabled'
purchasePlan Informações do plano de compra para a imagem da qual o disco de origem do instantâneo foi criado originalmente. PurchasePlan
securityProfile Contém as informações relacionadas à segurança do recurso. DiskSecurityProfile
supportedCapabilities Lista de recursos com suporte para a imagem da qual o disco de origem do instantâneo foi criado originalmente. SupportedCapabilities
supportsHibernation Indica que o sistema operacional em uma instantâneo dá suporte à hibernação. bool

CopyCompletionError

Nome Descrição Valor
errorCode Indica o código de erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. 'CopySourceNotFound' (obrigatório)
errorMessage Indica a mensagem de erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. cadeia de caracteres (obrigatório)

CreationData

Nome Descrição Valor
createOption Isso enumera as possíveis fontes da criação de um disco. 'Anexar'
'Copy'
'CopyFromSanSnapshot'
'CopyStart'
'Vazio'
'FromImage'
'Importar'
'ImportSecure'
'Restore'
'Carregar'
'UploadPreparedSecure' (obrigatório)
elasticSanResourceId Obrigatório se createOption for CopyFromSanSnapshot. Essa é a ID do ARM da instantâneo de volume san elástico de origem. string
galleryImageReference Obrigatório se for criado a partir de uma Imagem da Galeria. A id/sharedGalleryImageId/communityGalleryImageId do ImageDiskReference será a ID do ARM da versão de imagem de galé compartilhada da qual criar um disco. ImageDiskReference
imageReference Informações de origem do disco para PIR ou imagens de usuário. ImageDiskReference
logicalSectorSize Tamanho do setor lógico em bytes para discos Ultra. Os valores compatíveis são 512 e 4096. O padrão é 4096. INT
performancePlus Defina esse sinalizador como true para obter um aumento no destino de desempenho do disco implantado, consulte aqui no respectivo destino de desempenho. Esse sinalizador só pode ser definido no tempo de criação do disco e não pode ser desabilitado após a habilitação. bool
provisionedBandwidthCopySpeed Se esse campo estiver definido em um instantâneo e createOption for CopyStart, o instantâneo será copiado em uma velocidade mais rápida. 'Avançado'
'None'
securityDataUri Se createOption for ImportSecure, esse será o URI de um blob a ser importado para o estado convidado da VM. string
sourceResourceId Se createOption for Copy, essa será a ID do ARM do instantâneo de origem ou do disco. string
sourceUri Se createOption for Import, esse será o URI de um blob a ser importado para um disco gerenciado. string
storageAccountId Obrigatório se createOption for Import. O identificador Resource Manager do Azure da conta de armazenamento que contém o blob a ser importado como um disco. string
uploadSizeBytes Se createOption for Upload, esse será o tamanho do conteúdo do upload, incluindo o rodapé VHD. Esse valor deve estar entre 20972032 (20 MiB + 512 bytes para o rodapé VHD) e 35183298347520 bytes (32 TiB + 512 bytes para o rodapé VHD). INT

ImageDiskReference

Nome Descrição Valor
communityGalleryImageId Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure da comunidade. string
id Um URI relativo que contém um Repositório de Imagens de Plataforma, uma imagem de usuário ou uma referência de imagem da Galeria de Computação do Azure. string
lun Se o disco for criado a partir do disco de dados de uma imagem, esse será um índice que indica quais discos de dados na imagem usar. Para discos do sistema operacional, esse campo é nulo. INT
sharedGalleryImageId Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure compartilhada direta. string

Criptografia

Nome Descrição Valor
diskEncryptionSetId ResourceId do conjunto de criptografia de disco a ser usado para habilitar a criptografia em repouso. string
type O tipo de chave usado para criptografar os dados do disco. 'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
'EncryptionAtRestWithPlatformKey'

EncryptionSettingsCollection

Nome Descrição Valor
Habilitado Defina esse sinalizador como true e forneça DiskEncryptionKey e KeyEncryptionKey opcional para habilitar a criptografia. Defina esse sinalizador como false e remova DiskEncryptionKey e KeyEncryptionKey para desabilitar a criptografia. Se EncryptionSettings for nulo no objeto de solicitação, as configurações existentes permanecerão inalteradas. bool (obrigatório)
encryptionSettings Uma coleção de configurações de criptografia, uma para cada volume de disco. EncryptionSettingsElement[]
encryptionSettingsVersion Descreve que tipo de criptografia é usado para os discos. Depois que esse campo for definido, ele não poderá ser substituído. '1.0' corresponde ao Azure Disk Encryption com o aplicativo AAD.'1.1' corresponde ao Azure Disk Encryption. string

EncryptionSettingsElement

Nome Descrição Valor
diskEncryptionKey Key Vault url secreta e id do cofre da chave de criptografia de disco KeyVaultAndSecretReference
keyEncryptionKey Key Vault a URL da Chave e a ID do cofre da chave de criptografia de chave. KeyEncryptionKey é opcional e quando fornecido é usado para desencapsular a chave de criptografia de disco. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Nome Descrição Valor
secretUrl URL apontando para uma chave ou segredo no KeyVault cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo SourceVault (obrigatório)

SourceVault

Nome Descrição Valor
id ID do recurso string

KeyVaultAndKeyReference

Nome Descrição Valor
keyUrl URL apontando para uma chave ou segredo no KeyVault cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo SourceVault (obrigatório)

PurchasePlan

Nome Descrição Valor
name A ID do plano. cadeia de caracteres (obrigatório)
product Especifica o produto da imagem do marketplace. Esse é o mesmo valor que Offer no elemento imageReference. cadeia de caracteres (obrigatório)
promotionCode O código de promoção da oferta. string
publicador A ID do editor. cadeia de caracteres (obrigatório)

DiskSecurityProfile

Nome Descrição Valor
secureVMDiskEncryptionSetId ResourceId do conjunto de criptografia de disco associado ao disco compatível com VM confidencial criptografado com chave gerenciada pelo cliente string
Securitytype Especifica o SecurityType da VM. Aplicável somente para discos do sistema operacional. 'ConfidentialVM_DiskEncryptedWithCustomerKey'
'ConfidentialVM_DiskEncryptedWithPlatformKey'
'ConfidentialVM_NonPersistedTPM'
'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey'
'TrustedLaunch'

SupportedCapabilities

Nome Descrição Valor
acceleratedNetwork True se a imagem da qual o disco do sistema operacional é criado dá suporte à rede acelerada. bool
Arquitetura Arquitetura de CPU compatível com um disco do sistema operacional. 'Arm64'
'x64'
diskControllerTypes Os controladores de disco aos quais um disco do sistema operacional dá suporte. Se definido, pode ser SCSI ou SCSI, NVME ou NVME, SCSI. string

SnapshotSku

Nome Descrição Valor
name O nome da SKU. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

{
  "type": "Microsoft.Compute/snapshots",
  "apiVersion": "2023-10-02",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "name": "string"
  },
  "extendedLocation": {
    "name": "string",
    "type": "EdgeZone"
  },
  "properties": {
    "completionPercent": "int",
    "copyCompletionError": {
      "errorCode": "CopySourceNotFound",
      "errorMessage": "string"
    },
    "creationData": {
      "createOption": "string",
      "elasticSanResourceId": "string",
      "galleryImageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "imageReference": {
        "communityGalleryImageId": "string",
        "id": "string",
        "lun": "int",
        "sharedGalleryImageId": "string"
      },
      "logicalSectorSize": "int",
      "performancePlus": "bool",
      "provisionedBandwidthCopySpeed": "string",
      "securityDataUri": "string",
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string",
      "uploadSizeBytes": "int"
    },
    "dataAccessAuthMode": "string",
    "diskAccessId": "string",
    "diskSizeGB": "int",
    "encryption": {
      "diskEncryptionSetId": "string",
      "type": "string"
    },
    "encryptionSettingsCollection": {
      "enabled": "bool",
      "encryptionSettings": [
        {
          "diskEncryptionKey": {
            "secretUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          },
          "keyEncryptionKey": {
            "keyUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          }
        }
      ],
      "encryptionSettingsVersion": "string"
    },
    "hyperVGeneration": "string",
    "incremental": "bool",
    "networkAccessPolicy": "string",
    "osType": "string",
    "publicNetworkAccess": "string",
    "purchasePlan": {
      "name": "string",
      "product": "string",
      "promotionCode": "string",
      "publisher": "string"
    },
    "securityProfile": {
      "secureVMDiskEncryptionSetId": "string",
      "securityType": "string"
    },
    "supportedCapabilities": {
      "acceleratedNetwork": "bool",
      "architecture": "string",
      "diskControllerTypes": "string"
    },
    "supportsHibernation": "bool"
  }
}

Valores de propriedade

snapshots

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.Compute/snapshots'
apiVersion A versão da API do recurso '2023-10-02'
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos, sublinhados, pontos e hifens.

Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local Localização do recurso cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas. Confira Marcas em modelos
sku O nome da SKU de instantâneos. Pode ser Standard_LRS, Premium_LRS ou Standard_ZRS. Esse é um parâmetro opcional para instantâneo incremental e o comportamento padrão é que o SKU será definido como o mesmo sku do instantâneo anterior SnapshotSku
extendedLocation O local estendido em que o instantâneo será criado. O local estendido não pode ser alterado. ExtendedLocation
properties Propriedades do recurso de instantâneo. SnapshotProperties

ExtendedLocation

Nome Descrição Valor
name O nome do local estendido. string
type O tipo do local estendido. 'EdgeZone'

SnapshotProperties

Nome Descrição Valor
completionPercent Porcentagem concluída para a cópia em segundo plano quando um recurso é criado por meio da operação CopyStart. INT
copyCompletionError Indica os detalhes do erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. CopyCompletionError
creationData Informações de origem do disco. As informações de CreationData não podem ser alteradas após a criação do disco. CreationData (obrigatório)
dataAccessAuthMode Requisitos de autenticação adicionais ao exportar ou carregar em um disco ou instantâneo. 'AzureActiveDirectory'
'None'
diskAccessId ID do ARM do recurso DiskAccess para usar pontos de extremidade privados em discos. string
diskSizeGB Se creationData.createOption for Empty, esse campo será obrigatório e indicará o tamanho do disco a ser criado. Se esse campo estiver presente para atualizações ou criação com outras opções, ele indicará um redimensionamento. Redimensionamentos só serão permitidos se o disco não estiver anexado a uma VM em execução e só puder aumentar o tamanho do disco. INT
criptografia A propriedade de criptografia pode ser usada para criptografar dados inativos com chaves gerenciadas pelo cliente ou chaves gerenciadas pela plataforma. Criptografia
encryptionSettingsCollection A coleção de configurações de criptografia usada é a Criptografia de Disco do Azure, pode conter várias configurações de criptografia por disco ou instantâneo. EncryptionSettingsCollection
hyperVGeneration A geração de hipervisor da Máquina Virtual. Aplicável somente a discos do sistema operacional. 'V1'
'V2'
incremental Se um instantâneo é incremental. Instantâneos incrementais no mesmo disco ocupam menos espaço do que instantâneos completos e podem ser difusivos. bool
networkAccessPolicy Política para acessar o disco por meio da rede. 'AllowAll'
'AllowPrivate'
'DenyAll'
osType O tipo de sistema operacional. 'Linux'
'Windows'
publicNetworkAccess Política para controlar a exportação no disco. 'Desabilitado'
'Enabled'
purchasePlan Informações do plano de compra para a imagem da qual o disco de origem do instantâneo foi criado originalmente. PurchasePlan
securityProfile Contém as informações relacionadas à segurança do recurso. DiskSecurityProfile
supportedCapabilities Lista de recursos com suporte para a imagem da qual o disco de origem do instantâneo foi criado originalmente. SupportedCapabilities
supportsHibernation Indica que o sistema operacional em uma instantâneo dá suporte à hibernação. bool

CopyCompletionError

Nome Descrição Valor
errorCode Indica o código de erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. 'CopySourceNotFound' (obrigatório)
errorMessage Indica a mensagem de erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. cadeia de caracteres (obrigatório)

CreationData

Nome Descrição Valor
createOption Isso enumera as possíveis fontes da criação de um disco. 'Anexar'
'Copy'
'CopyFromSanSnapshot'
'CopyStart'
'Vazio'
'FromImage'
'Importar'
'ImportSecure'
'Restore'
'Carregar'
'UploadPreparedSecure' (obrigatório)
elasticSanResourceId Obrigatório se createOption for CopyFromSanSnapshot. Essa é a ID do ARM da instantâneo de volume san elástico de origem. string
galleryImageReference Obrigatório se for criado a partir de uma Imagem da Galeria. A id/sharedGalleryImageId/communityGalleryImageId do ImageDiskReference será a ID do ARM da versão de imagem de galé compartilhada da qual criar um disco. ImageDiskReference
imageReference Informações de origem do disco para PIR ou imagens de usuário. ImageDiskReference
logicalSectorSize Tamanho do setor lógico em bytes para discos Ultra. Os valores compatíveis são 512 e 4096. O padrão é 4096. INT
performancePlus Defina esse sinalizador como true para obter um aumento na meta de desempenho do disco implantado, consulte aqui no respectivo destino de desempenho. Esse sinalizador só pode ser definido na hora de criação do disco e não pode ser desabilitado após a habilitação. bool
provisionedBandwidthCopySpeed Se esse campo for definido em um instantâneo e createOption for CopyStart, o instantâneo será copiado em uma velocidade mais rápida. 'Avançado'
'None'
securityDataUri Se createOption for ImportSecure, esse será o URI de um blob a ser importado para o estado de convidado da VM. string
sourceResourceId Se createOption for Copy, essa será a ID do ARM do instantâneo ou disco de origem. string
sourceUri Se createOption for Import, esse será o URI de um blob a ser importado para um disco gerenciado. string
storageAccountId Obrigatório se createOption for Import. O identificador de Resource Manager do Azure da conta de armazenamento que contém o blob a ser importado como um disco. string
uploadSizeBytes Se createOption for Upload, esse será o tamanho do conteúdo do upload, incluindo o rodapé do VHD. Esse valor deve estar entre 20972032 (20 MiB + 512 bytes para o rodapé VHD) e 35183298347520 bytes (32 TiB + 512 bytes para o rodapé VHD). INT

ImageDiskReference

Nome Descrição Valor
communityGalleryImageId Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure da comunidade. string
id Um URI relativo que contém um Repositório de Imagens de Plataforma, uma imagem de usuário ou uma referência de imagem da Galeria de Computação do Azure. string
lun Se o disco for criado a partir do disco de dados de uma imagem, esse será um índice que indica quais discos de dados na imagem usar. Para discos do sistema operacional, esse campo é nulo. INT
sharedGalleryImageId Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure compartilhada direta. string

Criptografia

Nome Descrição Valor
diskEncryptionSetId ResourceId do conjunto de criptografia de disco a ser usado para habilitar a criptografia em repouso. string
type O tipo de chave usado para criptografar os dados do disco. 'EncryptionAtRestWithCustomerKey'
'EncryptionAtRestWithPlatformAndCustomerKeys'
'EncryptionAtRestWithPlatformKey'

EncryptionSettingsCollection

Nome Descrição Valor
Habilitado Defina esse sinalizador como true e forneça DiskEncryptionKey e KeyEncryptionKey opcional para habilitar a criptografia. Defina esse sinalizador como false e remova DiskEncryptionKey e KeyEncryptionKey para desabilitar a criptografia. Se EncryptionSettings for nulo no objeto de solicitação, as configurações existentes permanecerão inalteradas. bool (obrigatório)
encryptionSettings Uma coleção de configurações de criptografia, uma para cada volume de disco. EncryptionSettingsElement[]
encryptionSettingsVersion Descreve que tipo de criptografia é usado para os discos. Depois que esse campo for definido, ele não poderá ser substituído. '1.0' corresponde ao Azure Disk Encryption com o aplicativo AAD.'1.1' corresponde ao Azure Disk Encryption. string

EncryptionSettingsElement

Nome Descrição Valor
diskEncryptionKey Key Vault url secreta e id do cofre da chave de criptografia de disco KeyVaultAndSecretReference
keyEncryptionKey Key Vault a URL da Chave e a ID do cofre da chave de criptografia de chave. KeyEncryptionKey é opcional e quando fornecido é usado para desencapsular a chave de criptografia de disco. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Nome Descrição Valor
secretUrl URL apontando para uma chave ou segredo no KeyVault cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo SourceVault (obrigatório)

SourceVault

Nome Descrição Valor
id ID do recurso string

KeyVaultAndKeyReference

Nome Descrição Valor
keyUrl URL apontando para uma chave ou segredo no KeyVault cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo SourceVault (obrigatório)

PurchasePlan

Nome Descrição Valor
name A ID do plano. cadeia de caracteres (obrigatório)
product Especifica o produto da imagem do marketplace. Esse é o mesmo valor que Offer no elemento imageReference. cadeia de caracteres (obrigatório)
promotionCode O código de promoção da oferta. string
publicador A ID do editor. cadeia de caracteres (obrigatório)

DiskSecurityProfile

Nome Descrição Valor
secureVMDiskEncryptionSetId ResourceId do conjunto de criptografia de disco associado ao disco compatível com VM confidencial criptografado com chave gerenciada pelo cliente string
Securitytype Especifica o SecurityType da VM. Aplicável somente para discos do sistema operacional. 'ConfidentialVM_DiskEncryptedWithCustomerKey'
'ConfidentialVM_DiskEncryptedWithPlatformKey'
'ConfidentialVM_NonPersistedTPM'
'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey'
'TrustedLaunch'

SupportedCapabilities

Nome Descrição Valor
acceleratedNetwork True se a imagem da qual o disco do sistema operacional é criado dá suporte à rede acelerada. bool
Arquitetura Arquitetura de CPU compatível com um disco do sistema operacional. 'Arm64'
'x64'
diskControllerTypes Os controladores de disco aos quais um disco do sistema operacional dá suporte. Se definido, pode ser SCSI ou SCSI, NVME ou NVME, SCSI. string

SnapshotSku

Nome Descrição Valor
name O nome da SKU. 'Premium_LRS'
'Standard_LRS'
'Standard_ZRS'

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

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

  • Grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/snapshots@2023-10-02"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      completionPercent = int
      copyCompletionError = {
        errorCode = "CopySourceNotFound"
        errorMessage = "string"
      }
      creationData = {
        createOption = "string"
        elasticSanResourceId = "string"
        galleryImageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        imageReference = {
          communityGalleryImageId = "string"
          id = "string"
          lun = int
          sharedGalleryImageId = "string"
        }
        logicalSectorSize = int
        performancePlus = bool
        provisionedBandwidthCopySpeed = "string"
        securityDataUri = "string"
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
        uploadSizeBytes = int
      }
      dataAccessAuthMode = "string"
      diskAccessId = "string"
      diskSizeGB = int
      encryption = {
        diskEncryptionSetId = "string"
        type = "string"
      }
      encryptionSettingsCollection = {
        enabled = bool
        encryptionSettings = [
          {
            diskEncryptionKey = {
              secretUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
            keyEncryptionKey = {
              keyUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
          }
        ]
        encryptionSettingsVersion = "string"
      }
      hyperVGeneration = "string"
      incremental = bool
      networkAccessPolicy = "string"
      osType = "string"
      publicNetworkAccess = "string"
      purchasePlan = {
        name = "string"
        product = "string"
        promotionCode = "string"
        publisher = "string"
      }
      securityProfile = {
        secureVMDiskEncryptionSetId = "string"
        securityType = "string"
      }
      supportedCapabilities = {
        acceleratedNetwork = bool
        architecture = "string"
        diskControllerTypes = "string"
      }
      supportsHibernation = bool
    }
    sku = {
      name = "string"
    }
    extendedLocation = {
      name = "string"
      type = "EdgeZone"
    }
  })
}

Valores de propriedade

snapshots

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.Compute/snapshots@2023-10-02"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos, sublinhados, pontos e hifens.

Comece com caractere alfanumérico. Termine com caractere alfanumérico ou sublinhado.
local Localização do recurso cadeia de caracteres (obrigatório)
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas Marcações de recursos Dicionário de nomes e valores de marcas.
sku O nome da SKU de instantâneos. Pode ser Standard_LRS, Premium_LRS ou Standard_ZRS. Esse é um parâmetro opcional para instantâneo incremental e o comportamento padrão é que o SKU será definido como o mesmo sku do instantâneo anterior SnapshotSku
extendedLocation O local estendido em que o instantâneo será criado. O local estendido não pode ser alterado. ExtendedLocation
properties Propriedades do recurso de instantâneo. SnapshotProperties

ExtendedLocation

Nome Descrição Valor
name O nome do local estendido. string
type O tipo do local estendido. "EdgeZone"

SnapshotProperties

Nome Descrição Valor
completionPercent Porcentagem concluída para a cópia em segundo plano quando um recurso é criado por meio da operação CopyStart. INT
copyCompletionError Indica os detalhes do erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. CopyCompletionError
creationData Informações de origem do disco. As informações de CreationData não podem ser alteradas após a criação do disco. CreationData (obrigatório)
dataAccessAuthMode Requisitos de autenticação adicionais ao exportar ou carregar em um disco ou instantâneo. "AzureActiveDirectory"
"None"
diskAccessId ID do ARM do recurso DiskAccess para usar pontos de extremidade privados em discos. string
diskSizeGB Se creationData.createOption for Empty, esse campo será obrigatório e indicará o tamanho do disco a ser criado. Se esse campo estiver presente para atualizações ou criação com outras opções, ele indicará um redimensionamento. Redimensionamentos só serão permitidos se o disco não estiver anexado a uma VM em execução e só puder aumentar o tamanho do disco. INT
criptografia A propriedade de criptografia pode ser usada para criptografar dados inativos com chaves gerenciadas pelo cliente ou chaves gerenciadas pela plataforma. Criptografia
encryptionSettingsCollection A coleção de configurações de criptografia usada é a Criptografia de Disco do Azure, pode conter várias configurações de criptografia por disco ou instantâneo. EncryptionSettingsCollection
hyperVGeneration A geração de hipervisor da Máquina Virtual. Aplicável somente a discos do sistema operacional. "V1"
"V2"
incremental Se um instantâneo é incremental. Instantâneos incrementais no mesmo disco ocupam menos espaço do que instantâneos completos e podem ser difusivos. bool
networkAccessPolicy Política para acessar o disco por meio da rede. "AllowAll"
"AllowPrivate"
"DenyAll"
osType O tipo de sistema operacional. “Linux”
“Windows”
publicNetworkAccess Política para controlar a exportação no disco. "Desabilitado"
"Habilitado"
purchasePlan Informações do plano de compra para a imagem da qual o disco de origem do instantâneo foi criado originalmente. PurchasePlan
securityProfile Contém as informações relacionadas à segurança do recurso. DiskSecurityProfile
supportedCapabilities Lista de recursos com suporte para a imagem da qual o disco de origem do instantâneo foi criado originalmente. SupportedCapabilities
supportsHibernation Indica que o sistema operacional em uma instantâneo dá suporte à hibernação. bool

CopyCompletionError

Nome Descrição Valor
errorCode Indica o código de erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. "CopySourceNotFound" (obrigatório)
errorMessage Indica a mensagem de erro se a cópia em segundo plano de um recurso criado por meio da operação CopyStart falhar. cadeia de caracteres (obrigatório)

CreationData

Nome Descrição Valor
createOption Isso enumera as possíveis fontes da criação de um disco. "Anexar"
"Copiar"
"CopyFromSanSnapshot"
"CopyStart"
"Empty"
"FromImage"
"Importar"
"ImportSecure"
"Restaurar"
"Carregar"
"UploadPreparedSecure" (obrigatório)
elasticSanResourceId Obrigatório se createOption for CopyFromSanSnapshot. Essa é a ID do ARM da instantâneo de volume san elástico de origem. string
galleryImageReference Obrigatório se for criado com base em uma Imagem da Galeria. A id/sharedGalleryImageId/communityGalleryImageId do ImageDiskReference será a ID do ARM da versão de imagem de galeria compartilhada da qual criar um disco. ImageDiskReference
imageReference Informações de origem do disco para PIR ou imagens de usuário. ImageDiskReference
logicalSectorSize Tamanho do setor lógico em bytes para discos Ultra. Os valores compatíveis são 512 e 4096. O padrão é 4096. INT
performancePlus Defina esse sinalizador como true para obter um aumento na meta de desempenho do disco implantado, consulte aqui no respectivo destino de desempenho. Esse sinalizador só pode ser definido na hora de criação do disco e não pode ser desabilitado após a habilitação. bool
provisionedBandwidthCopySpeed Se esse campo for definido em um instantâneo e createOption for CopyStart, o instantâneo será copiado em uma velocidade mais rápida. "Avançado"
"None"
securityDataUri Se createOption for ImportSecure, esse será o URI de um blob a ser importado para o estado de convidado da VM. string
sourceResourceId Se createOption for Copy, essa será a ID do ARM do instantâneo ou disco de origem. string
sourceUri Se createOption for Import, esse será o URI de um blob a ser importado para um disco gerenciado. string
storageAccountId Obrigatório se createOption for Import. O identificador de Resource Manager do Azure da conta de armazenamento que contém o blob a ser importado como um disco. string
uploadSizeBytes Se createOption for Upload, esse será o tamanho do conteúdo do upload, incluindo o rodapé do VHD. Esse valor deve estar entre 20972032 (20 MiB + 512 bytes para o rodapé VHD) e 35183298347520 bytes (32 TiB + 512 bytes para o rodapé VHD). INT

ImageDiskReference

Nome Descrição Valor
communityGalleryImageId Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure da comunidade. string
id Um URI relativo que contém um Repositório de Imagens de Plataforma, uma imagem de usuário ou uma referência de imagem da Galeria de Computação do Azure. string
lun Se o disco for criado a partir do disco de dados de uma imagem, esse será um índice que indica quais discos de dados na imagem usar. Para discos do sistema operacional, esse campo é nulo. INT
sharedGalleryImageId Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure compartilhada direta. string

Criptografia

Nome Descrição Valor
diskEncryptionSetId ResourceId do conjunto de criptografia de disco a ser usado para habilitar a criptografia em repouso. string
type O tipo de chave usado para criptografar os dados do disco. "EncryptionAtRestWithCustomerKey"
"EncryptionAtRestWithPlatformAndCustomerKeys"
"EncryptionAtRestWithPlatformKey"

EncryptionSettingsCollection

Nome Descrição Valor
Habilitado Defina esse sinalizador como true e forneça DiskEncryptionKey e KeyEncryptionKey opcional para habilitar a criptografia. Defina esse sinalizador como false e remova DiskEncryptionKey e KeyEncryptionKey para desabilitar a criptografia. Se EncryptionSettings for nulo no objeto de solicitação, as configurações existentes permanecerão inalteradas. bool (obrigatório)
encryptionSettings Uma coleção de configurações de criptografia, uma para cada volume de disco. EncryptionSettingsElement[]
encryptionSettingsVersion Descreve que tipo de criptografia é usado para os discos. Depois que esse campo for definido, ele não poderá ser substituído. '1.0' corresponde ao Azure Disk Encryption com o aplicativo AAD.'1.1' corresponde ao Azure Disk Encryption. string

EncryptionSettingsElement

Nome Descrição Valor
diskEncryptionKey Key Vault url secreta e id do cofre da chave de criptografia de disco KeyVaultAndSecretReference
keyEncryptionKey Key Vault a URL da Chave e a ID do cofre da chave de criptografia de chave. KeyEncryptionKey é opcional e quando fornecido é usado para desencapsular a chave de criptografia de disco. KeyVaultAndKeyReference

KeyVaultAndSecretReference

Nome Descrição Valor
secretUrl URL apontando para uma chave ou segredo no KeyVault cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo SourceVault (obrigatório)

SourceVault

Nome Descrição Valor
id ID do recurso string

KeyVaultAndKeyReference

Nome Descrição Valor
keyUrl URL apontando para uma chave ou segredo no KeyVault cadeia de caracteres (obrigatório)
sourceVault ID do recurso do KeyVault que contém a chave ou o segredo SourceVault (obrigatório)

PurchasePlan

Nome Descrição Valor
name A ID do plano. cadeia de caracteres (obrigatório)
product Especifica o produto da imagem do marketplace. Esse é o mesmo valor que Offer no elemento imageReference. cadeia de caracteres (obrigatório)
promotionCode O código de promoção da oferta. string
publicador A ID do editor. cadeia de caracteres (obrigatório)

DiskSecurityProfile

Nome Descrição Valor
secureVMDiskEncryptionSetId ResourceId do conjunto de criptografia de disco associado ao disco compatível com VM confidencial criptografado com chave gerenciada pelo cliente string
Securitytype Especifica o SecurityType da VM. Aplicável somente para discos do sistema operacional. "ConfidentialVM_DiskEncryptedWithCustomerKey"
"ConfidentialVM_DiskEncryptedWithPlatformKey"
"ConfidentialVM_NonPersistedTPM"
"ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey"
"TrustedLaunch"

SupportedCapabilities

Nome Descrição Valor
acceleratedNetwork True se a imagem da qual o disco do sistema operacional é criado dá suporte à rede acelerada. bool
Arquitetura Arquitetura de CPU compatível com um disco do sistema operacional. "Arm64"
"x64"
diskControllerTypes Os controladores de disco aos quais um disco do sistema operacional dá suporte. Se definido, pode ser SCSI ou SCSI, NVME ou NVME, SCSI. string

SnapshotSku

Nome Descrição Valor
name O nome da SKU. "Premium_LRS"
"Standard_LRS"
"Standard_ZRS"