Instantâneos Microsoft.Compute 2022-07-02
Definição de recurso do Bicep
O tipo de recurso de instantâneos pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Compute/snapshots, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.Compute/snapshots@2022-07-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'
galleryImageReference: {
communityGalleryImageId: 'string'
id: 'string'
lun: int
sharedGalleryImageId: 'string'
}
imageReference: {
communityGalleryImageId: 'string'
id: 'string'
lun: int
sharedGalleryImageId: 'string'
}
logicalSectorSize: int
performancePlus: bool
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
instantâneos
Nome | Descrição | Valor |
---|---|---|
name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 1-80 Carateres válidos: Alfanuméricos, carateres de sublinhado, períodos e hífenes. Comece com alfanumérico. Termine com alfanumérico ou caráter de sublinhado. |
localização | Localização do recurso | cadeia (obrigatório) |
etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
sku | O nome do SKU de instantâneos. Pode ser Standard_LRS, Premium_LRS ou Standard_ZRS. Este é um parâmetro opcional para instantâneo incremental e o comportamento predefinido é que o SKU será definido para o mesmo sku que o instantâneo anterior | SnapshotSku |
extendedLocation | A localização expandida onde o instantâneo será criado. Não é possível alterar a localização expandida. | ExtendedLocation |
propriedades | Propriedades do recurso de instantâneo. | SnapshotProperties |
ExtendedLocation
Nome | Descrição | Valor |
---|---|---|
name | O nome da localização expandida. | string |
tipo | O tipo de localização expandida. | "EdgeZone" |
SnapshotProperties
Nome | Descrição | Valor |
---|---|---|
completionPercent | Percentagem concluída para a cópia em segundo plano quando um recurso é criado através da operação CopyStart. | int |
copyCompletionError | Indica os detalhes do erro se a cópia em segundo plano de um recurso criado através da operação CopyStart falhar. | CopyCompletionError |
creationData | Informações de origem do disco. CreationData information cannot be changed after the disk has been created. | CreationData (obrigatório) |
dataAccessAuthMode | Requisitos de autenticação adicionais ao exportar ou carregar para um disco ou instantâneo. | "AzureActiveDirectory" "Nenhum" |
diskAccessId | ID arm do recurso DiskAccess para utilizar pontos finais privados em discos. | string |
diskSizeGB | Se creationData.createOption for Vazio, este campo é obrigatório e indica o tamanho do disco a criar. Se este campo estiver presente para atualizações ou criação com outras opções, indica um redimensionamento. Os redimensionamentos só são permitidos se o disco não estiver anexado a uma VM em execução e apenas pode aumentar o tamanho do disco. | int |
Encriptação | A propriedade encriptação pode ser utilizada para encriptar dados inativos com chaves geridas pelo cliente ou chaves geridas pela plataforma. | Encriptação |
encryptionSettingsCollection | A coleção de definições de encriptação utilizada é o Azure Disk Encryption, pode conter várias definições de encriptação por disco ou instantâneo. | EncryptionSettingsCollection |
hyperVGeneration | A geração do hipervisor da Máquina Virtual. Aplicável apenas a discos do SO. | 'V1' 'V2' |
incremental | Se um instantâneo é incremental. Os instantâneos incrementais no mesmo disco ocupam menos espaço do que os instantâneos completos e podem ser difundidos. | bool |
networkAccessPolicy | Política para aceder ao disco através da rede. | "PermitirTodos" "AllowPrivate" "DenyAll" |
osType | O tipo de Sistema Operativo. | 'Linux' 'Windows' |
publicNetworkAccess | Política para controlar a exportação no disco. | "Desativado" "Ativado" |
purchasePlan | Informações do plano de compra para a imagem a partir da qual o disco de origem do instantâneo foi originalmente criado. | Plano de Compra |
securityProfile | Contém as informações relacionadas com a segurança do recurso. | DiskSecurityProfile |
supportedCapabilities | Lista de capacidades suportadas para a imagem a partir da qual o disco de origem do instantâneo foi originalmente criado. | SupportedCapabilities |
supportsHibernation | Indica que o SO num instantâneo suporta 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 através 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 através da operação CopyStart falhar. | cadeia (obrigatório) |
CreationData
Nome | Descrição | Valor |
---|---|---|
createOption | Isto enumera as possíveis origens da criação de um disco. | "Anexar" 'Copiar' "CopyStart" "Vazio" 'FromImage' "Importar" "ImportSecure" "Restaurar" 'Carregar' "UploadPreparedSecure" (obrigatório) |
galleryImageReference | Necessário se criar a partir de uma Imagem da Galeria. O id/sharedGalleryImageId/communityGalleryImageId da ImageDiskReference será o ID do ARM da versão da imagem de cozinha partilhada a partir da qual criar um disco. | ImageDiskReference |
imageReference | Informações de origem do disco para imagens PIR ou de utilizador. | ImageDiskReference |
logicalSectorSize | Tamanho do setor lógico em bytes para discos Ultra. Os valores suportados são 512 ad 4096. 4096 é a predefinição. | int |
performancePlus | Defina este sinalizador como verdadeiro para obter um aumento no destino de desempenho do disco implementado. Veja aqui o respetivo destino de desempenho. Este sinalizador só pode ser definido no tempo de criação do disco e não pode ser desativado depois de ativado. | bool |
securityDataUri | Se createOption for ImportSecure, este é o URI de um blob a ser importado para o estado de convidado da VM. | string |
sourceResourceId | Se createOption for Copiar, este é o ID do ARM do instantâneo ou disco de origem. | string |
sourceUri | Se createOption for Importar, este é o URI de um blob a ser importado para um disco gerido. | string |
storageAccountId | Necessário se createOption for Importar. O identificador Resource Manager do Azure da conta de armazenamento que contém o blob a importar como um disco. | string |
uploadSizeBytes | Se createOption for Upload, este é o tamanho do conteúdo do carregamento, incluindo o rodapé VHD. Este valor deve estar entre 20972032 (20 MiB + 512 bytes para o rodapé VHD) e 35183298347520 bytes (32 Bytes TiB + 512 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 Imagem de Plataforma, uma imagem de utilizador 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, este é um índice que indica qual dos discos de dados na imagem utilizar. Para os discos do SO, este campo é nulo. | int |
sharedGalleryImageId | Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure partilhada diretamente. | string |
Encriptação
Nome | Descrição | Valor |
---|---|---|
diskEncryptionSetId | ResourceId do conjunto de encriptação de discos a utilizar para ativar a encriptação inativa. | string |
tipo | O tipo de chave utilizado para encriptar os dados do disco. | "EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey" |
EncryptionSettingsCollection
Nome | Descrição | Valor |
---|---|---|
ativado | Defina este sinalizador como verdadeiro e forneça DiskEncryptionKey e keyEncryptionKey opcional para ativar a encriptação. Defina este sinalizador como falso e remova DiskEncryptionKey e KeyEncryptionKey para desativar a encriptação. Se EncryptionSettings for nulo no objeto de pedido, as definições existentes permanecem inalteradas. | bool (obrigatório) |
encryptionSettings | Uma coleção de definições de encriptação, uma para cada volume de disco. | EncryptionSettingsElement[] |
encryptionSettingsVersion | Descreve que tipo de encriptação é utilizada para os discos. Uma vez definido este campo, não pode ser substituído. "1.0" corresponde ao Azure Disk Encryption com a aplicação AAD.'1.1' corresponde ao Azure Disk Encryption. | string |
EncryptionSettingsElement
Nome | Descrição | Valor |
---|---|---|
diskEncryptionKey | Key Vault o URL secreto e o ID do cofre da chave de encriptação do disco | KeyVaultAndSecretReference |
keyEncryptionKey | Key Vault o URL da chave e o ID do cofre da chave de encriptação. KeyEncryptionKey é opcional e, quando fornecido, é utilizado para desembrulhar a chave de encriptação do disco. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
Nome | Descrição | Valor |
---|---|---|
secretUrl | URL a apontar para uma chave ou segredo no KeyVault | cadeia (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 a apontar para uma chave ou segredo no KeyVault | cadeia (obrigatório) |
sourceVault | ID do recurso do KeyVault que contém a chave ou o segredo | SourceVault (obrigatório) |
Plano de Compra
Nome | Descrição | Valor |
---|---|---|
name | O ID do plano. | cadeia (obrigatório) |
produto | Especifica o produto da imagem a partir do marketplace. Este é o mesmo valor que a Oferta no elemento imageReference. | cadeia (obrigatório) |
promotionCode | O Código de Promoção da Oferta. | string |
publicador | O ID do editor. | cadeia (obrigatório) |
DiskSecurityProfile
Nome | Descrição | Valor |
---|---|---|
secureVMDiskEncryptionSetId | ResourceId do conjunto de encriptação de discos associado ao disco suportado pela VM Confidencial encriptado com a chave gerida pelo cliente | string |
securityType | Especifica o SecurityType da VM. Aplicável apenas a discos de SO. | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' "TrustedLaunch" |
SupportedCapabilities
Nome | Descrição | Valor |
---|---|---|
acceleratedNetwork | Verdadeiro se a imagem a partir da qual o disco do SO é criado suportar redes aceleradas. | bool |
arquitetura | Arquitetura da CPU suportada por um disco do SO. | 'Arm64' 'x64' |
diskControllerTypes | Os controladores de disco suportados por um disco do SO. Se definido, pode ser SCSI ou SCSI, NVME ou NVME, SCSI. | string |
SnapshotSku
Nome | Descrição | Valor |
---|---|---|
name | O nome do SKU. | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
Definição de recurso do modelo arm
O tipo de recurso de instantâneos pode ser implementado com operações que visam:
- Grupos de recursos – veja os comandos de implementação do grupo de recursos
Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Compute/snapshots, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.Compute/snapshots",
"apiVersion": "2022-07-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",
"galleryImageReference": {
"communityGalleryImageId": "string",
"id": "string",
"lun": "int",
"sharedGalleryImageId": "string"
},
"imageReference": {
"communityGalleryImageId": "string",
"id": "string",
"lun": "int",
"sharedGalleryImageId": "string"
},
"logicalSectorSize": "int",
"performancePlus": "bool",
"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
instantâneos
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | "Microsoft.Compute/snapshots" |
apiVersion | A versão da API de recursos | '2022-07-02' |
name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 1-80 Carateres válidos: Alfanuméricos, carateres de sublinhado, períodos e hífenes. Comece com alfanumérico. Termine com alfanumérico ou caráter de sublinhado. |
localização | Localização do recurso | cadeia (obrigatório) |
etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos |
sku | O nome do SKU de instantâneos. Pode ser Standard_LRS, Premium_LRS ou Standard_ZRS. Este é um parâmetro opcional para instantâneo incremental e o comportamento predefinido é que o SKU será definido para o mesmo sku que o instantâneo anterior | SnapshotSku |
extendedLocation | A localização expandida onde o instantâneo será criado. Não é possível alterar a localização expandida. | ExtendedLocation |
propriedades | Propriedades do recurso de instantâneo. | SnapshotProperties |
ExtendedLocation
Nome | Descrição | Valor |
---|---|---|
name | O nome da localização expandida. | string |
tipo | O tipo de localização expandida. | "EdgeZone" |
SnapshotProperties
Nome | Descrição | Valor |
---|---|---|
completionPercent | Percentagem concluída para a cópia em segundo plano quando um recurso é criado através da operação CopyStart. | int |
copyCompletionError | Indica os detalhes do erro se a cópia em segundo plano de um recurso criado através da operação CopyStart falhar. | CopyCompletionError |
creationData | Informações de origem do disco. CreationData information cannot be changed after the disk has been created. | CreationData (obrigatório) |
dataAccessAuthMode | Requisitos de autenticação adicionais ao exportar ou carregar para um disco ou instantâneo. | "AzureActiveDirectory" "Nenhum" |
diskAccessId | ID arm do recurso DiskAccess para utilizar pontos finais privados em discos. | string |
diskSizeGB | Se creationData.createOption for Vazio, este campo é obrigatório e indica o tamanho do disco a criar. Se este campo estiver presente para atualizações ou criação com outras opções, indica um redimensionamento. Os redimensionamentos só são permitidos se o disco não estiver anexado a uma VM em execução e apenas pode aumentar o tamanho do disco. | int |
Encriptação | A propriedade encriptação pode ser utilizada para encriptar dados inativos com chaves geridas pelo cliente ou chaves geridas pela plataforma. | Encriptação |
encryptionSettingsCollection | A coleção de definições de encriptação utilizada é o Azure Disk Encryption, pode conter várias definições de encriptação por disco ou instantâneo. | EncryptionSettingsCollection |
hyperVGeneration | A geração do hipervisor da Máquina Virtual. Aplicável apenas a discos do SO. | 'V1' 'V2' |
incremental | Se um instantâneo é incremental. Os instantâneos incrementais no mesmo disco ocupam menos espaço do que os instantâneos completos e podem ser difundidos. | bool |
networkAccessPolicy | Política para aceder ao disco através da rede. | "PermitirTodos" "AllowPrivate" "DenyAll" |
osType | O tipo de Sistema Operativo. | 'Linux' 'Windows' |
publicNetworkAccess | Política para controlar a exportação no disco. | "Desativado" "Ativado" |
purchasePlan | Informações do plano de compra para a imagem a partir da qual o disco de origem do instantâneo foi originalmente criado. | Plano de Compra |
securityProfile | Contém as informações relacionadas com a segurança do recurso. | DiskSecurityProfile |
supportedCapabilities | Lista de capacidades suportadas para a imagem a partir da qual o disco de origem do instantâneo foi originalmente criado. | SupportedCapabilities |
supportsHibernation | Indica que o SO num instantâneo suporta 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 através 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 através da operação CopyStart falhar. | cadeia (obrigatório) |
CreationData
Nome | Descrição | Valor |
---|---|---|
createOption | Isto enumera as possíveis origens da criação de um disco. | "Anexar" 'Copiar' "CopyStart" "Vazio" 'FromImage' "Importar" "ImportSecure" "Restaurar" 'Carregar' "UploadPreparedSecure" (obrigatório) |
galleryImageReference | Necessário se criar a partir de uma Imagem da Galeria. O id/sharedGalleryImageId/communityGalleryImageId da ImageDiskReference será o ID do ARM da versão da imagem de cozinha partilhada a partir da qual criar um disco. | ImageDiskReference |
imageReference | Informações de origem do disco para imagens PIR ou de utilizador. | ImageDiskReference |
logicalSectorSize | Tamanho do setor lógico em bytes para discos Ultra. Os valores suportados são 512 ad 4096. 4096 é a predefinição. | int |
performancePlus | Defina este sinalizador como verdadeiro para obter um aumento no destino de desempenho do disco implementado. Veja aqui o respetivo destino de desempenho. Este sinalizador só pode ser definido no tempo de criação do disco e não pode ser desativado depois de ativado. | bool |
securityDataUri | Se createOption for ImportSecure, este é o URI de um blob a ser importado para o estado de convidado da VM. | string |
sourceResourceId | Se createOption for Copiar, este é o ID do ARM do instantâneo ou disco de origem. | string |
sourceUri | Se createOption for Importar, este é o URI de um blob a ser importado para um disco gerido. | string |
storageAccountId | Necessário se createOption for Importar. O identificador Resource Manager do Azure da conta de armazenamento que contém o blob a importar como um disco. | string |
uploadSizeBytes | Se createOption for Upload, este é o tamanho do conteúdo do carregamento, incluindo o rodapé VHD. Este valor deve estar entre 20972032 (20 MiB + 512 bytes para o rodapé VHD) e 35183298347520 bytes (32 Bytes TiB + 512 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 Imagem de Plataforma, uma imagem de utilizador 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, este é um índice que indica qual dos discos de dados na imagem utilizar. Para os discos do SO, este campo é nulo. | int |
sharedGalleryImageId | Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure partilhada diretamente. | string |
Encriptação
Nome | Descrição | Valor |
---|---|---|
diskEncryptionSetId | ResourceId do conjunto de encriptação de discos a utilizar para ativar a encriptação inativa. | string |
tipo | O tipo de chave utilizado para encriptar os dados do disco. | "EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey" |
EncryptionSettingsCollection
Nome | Descrição | Valor |
---|---|---|
ativado | Defina este sinalizador como verdadeiro e forneça DiskEncryptionKey e keyEncryptionKey opcional para ativar a encriptação. Defina este sinalizador como falso e remova DiskEncryptionKey e KeyEncryptionKey para desativar a encriptação. Se EncryptionSettings for nulo no objeto de pedido, as definições existentes permanecem inalteradas. | bool (obrigatório) |
encryptionSettings | Uma coleção de definições de encriptação, uma para cada volume de disco. | EncryptionSettingsElement[] |
encryptionSettingsVersion | Descreve que tipo de encriptação é utilizada para os discos. Uma vez definido este campo, não pode ser substituído. "1.0" corresponde ao Azure Disk Encryption com a aplicação AAD.'1.1' corresponde ao Azure Disk Encryption. | string |
EncryptionSettingsElement
Nome | Descrição | Valor |
---|---|---|
diskEncryptionKey | Key Vault o URL secreto e o ID do cofre da chave de encriptação do disco | KeyVaultAndSecretReference |
keyEncryptionKey | Key Vault o URL da chave e o ID do cofre da chave de encriptação. KeyEncryptionKey é opcional e, quando fornecido, é utilizado para desembrulhar a chave de encriptação do disco. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
Nome | Descrição | Valor |
---|---|---|
secretUrl | URL a apontar para uma chave ou segredo no KeyVault | cadeia (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 a apontar para uma chave ou segredo no KeyVault | cadeia (obrigatório) |
sourceVault | ID do recurso do KeyVault que contém a chave ou o segredo | SourceVault (obrigatório) |
Plano de Compra
Nome | Descrição | Valor |
---|---|---|
name | O ID do plano. | cadeia (obrigatório) |
produto | Especifica o produto da imagem a partir do marketplace. Este é o mesmo valor que a Oferta no elemento imageReference. | cadeia (obrigatório) |
promotionCode | O Código de Promoção da Oferta. | string |
publicador | O ID do editor. | cadeia (obrigatório) |
DiskSecurityProfile
Nome | Descrição | Valor |
---|---|---|
secureVMDiskEncryptionSetId | ResourceId do conjunto de encriptação de disco associado ao disco suportado pela VM Confidencial encriptado com a chave gerida pelo cliente | string |
securityType | Especifica o SecurityType da VM. Aplicável apenas aos discos do SO. | 'ConfidentialVM_DiskEncryptedWithCustomerKey' 'ConfidentialVM_DiskEncryptedWithPlatformKey' 'ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey' "TrustedLaunch" |
SupportedCapabilities
Nome | Descrição | Valor |
---|---|---|
acceleratedNetwork | Verdadeiro se a imagem a partir da qual o disco do SO é criado suportar redes aceleradas. | bool |
arquitetura | Arquitetura da CPU suportada por um disco do SO. | 'Arm64' 'x64' |
diskControllerTypes | Os controladores de disco suportados por um disco do SO. Se definido, pode ser SCSI ou SCSI, NVME ou NVME, SCSI. | string |
SnapshotSku
Nome | Descrição | Valor |
---|---|---|
name | O nome do sku. | 'Premium_LRS' 'Standard_LRS' 'Standard_ZRS' |
Definição de recurso do Terraform (fornecedor AzAPI)
O tipo de recurso de instantâneos pode ser implementado com operações que visam:
- Grupos de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.
Formato do recurso
Para criar um recurso Microsoft.Compute/snapshots, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Compute/snapshots@2022-07-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"
galleryImageReference = {
communityGalleryImageId = "string"
id = "string"
lun = int
sharedGalleryImageId = "string"
}
imageReference = {
communityGalleryImageId = "string"
id = "string"
lun = int
sharedGalleryImageId = "string"
}
logicalSectorSize = int
performancePlus = bool
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
instantâneos
Nome | Descrição | Valor |
---|---|---|
tipo | O tipo de recurso | "Microsoft.Compute/snapshots@2022-07-02" |
name | O nome do recurso | cadeia (obrigatório) Limite de carateres: 1-80 Carateres válidos: Alfanuméricos, carateres de sublinhado, períodos e hífenes. Comece com alfanumérico. Termine com caráter alfanumérico ou caráter de sublinhado. |
localização | Localização do recurso | cadeia (obrigatório) |
parent_id | Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. | cadeia (obrigatório) |
etiquetas | Etiquetas de recursos | Dicionário de nomes e valores de etiquetas. |
sku | O nome do sku de instantâneos. Pode ser Standard_LRS, Premium_LRS ou Standard_ZRS. Este é um parâmetro opcional para instantâneo incremental e o comportamento predefinido é que o SKU será definido para o mesmo sku que o instantâneo anterior | SnapshotSku |
extendedLocation | A localização expandida onde o instantâneo será criado. Não é possível alterar a localização expandida. | ExtendedLocation |
propriedades | Propriedades do recurso de instantâneo. | SnapshotProperties |
ExtendedLocation
Nome | Descrição | Valor |
---|---|---|
name | O nome da localização expandida. | string |
tipo | O tipo de localização expandida. | "EdgeZone" |
SnapshotProperties
Nome | Descrição | Valor |
---|---|---|
completionPercent | Percentagem concluída para a cópia em segundo plano quando um recurso é criado através da operação CopyStart. | int |
copyCompletionError | Indica os detalhes do erro se a cópia em segundo plano de um recurso criado através da operação CopyStart falhar. | CopyCompletionError |
creationData | Informações de origem do disco. CreationData information cannot be changed after the disk has been created. | CreationData (obrigatório) |
dataAccessAuthMode | Requisitos de autenticação adicionais ao exportar ou carregar para um disco ou instantâneo. | "AzureActiveDirectory" "Nenhum" |
diskAccessId | ID arm do recurso DiskAccess para utilizar pontos finais privados em discos. | string |
diskSizeGB | Se creationData.createOption for Vazio, este campo é obrigatório e indica o tamanho do disco a criar. Se este campo estiver presente para atualizações ou criação com outras opções, indica um redimensionamento. Os redimensionamentos só são permitidos se o disco não estiver anexado a uma VM em execução e apenas pode aumentar o tamanho do disco. | int |
Encriptação | A propriedade encriptação pode ser utilizada para encriptar dados inativos com chaves geridas pelo cliente ou chaves geridas pela plataforma. | Encriptação |
encryptionSettingsCollection | A coleção de definições de encriptação utilizada é o Azure Disk Encryption, pode conter várias definições de encriptação por disco ou instantâneo. | EncryptionSettingsCollection |
hyperVGeneration | A geração do hipervisor da Máquina Virtual. Aplicável apenas a discos do SO. | "V1" "V2" |
incremental | Se um instantâneo é incremental. Os instantâneos incrementais no mesmo disco ocupam menos espaço do que os instantâneos completos e podem ser difundidos. | bool |
networkAccessPolicy | Política para aceder ao disco através da rede. | "PermitirTodos" "AllowPrivate" "DenyAll" |
osType | O tipo de Sistema Operativo. | "Linux" "Windows" |
publicNetworkAccess | Política para controlar a exportação no disco. | "Desativado" "Ativado" |
purchasePlan | Informações do plano de compra para a imagem a partir da qual o disco de origem do instantâneo foi originalmente criado. | Plano de Compra |
securityProfile | Contém as informações relacionadas com a segurança do recurso. | DiskSecurityProfile |
supportedCapabilities | Lista de capacidades suportadas para a imagem a partir da qual o disco de origem do instantâneo foi originalmente criado. | SupportedCapabilities |
supportsHibernation | Indica que o SO num instantâneo suporta 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 através 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 através da operação CopyStart falhar. | cadeia (obrigatório) |
CreationData
Nome | Descrição | Valor |
---|---|---|
createOption | Isto enumera as possíveis origens da criação de um disco. | "Anexar" "Copiar" "CopyStart" "Vazio" "FromImage" "Importar" "ImportSecure" "Restaurar" "Carregar" "UploadPreparedSecure" (obrigatório) |
galleryImageReference | Necessário se criar a partir de uma Imagem da Galeria. O id/sharedGalleryImageId/communityGalleryImageId da ImageDiskReference será o ID do ARM da versão da imagem de cozinha partilhada a partir da qual criar um disco. | ImageDiskReference |
imageReference | Informações de origem do disco para imagens PIR ou de utilizador. | ImageDiskReference |
logicalSectorSize | Tamanho do setor lógico em bytes para discos Ultra. Os valores suportados são 512 ad 4096. 4096 é a predefinição. | int |
performancePlus | Defina este sinalizador como verdadeiro para obter um aumento no destino de desempenho do disco implementado. Veja aqui o respetivo destino de desempenho. Este sinalizador só pode ser definido no tempo de criação do disco e não pode ser desativado depois de ativado. | bool |
securityDataUri | Se createOption for ImportSecure, este é o URI de um blob a ser importado para o estado de convidado da VM. | string |
sourceResourceId | Se createOption for Copiar, este é o ID do ARM do instantâneo ou disco de origem. | string |
sourceUri | Se createOption for Importar, este é o URI de um blob a ser importado para um disco gerido. | string |
storageAccountId | Necessário se createOption for Importar. O identificador Resource Manager do Azure da conta de armazenamento que contém o blob a importar como um disco. | string |
uploadSizeBytes | Se createOption for Upload, este é o tamanho do conteúdo do carregamento, incluindo o rodapé VHD. Este valor deve estar entre 20972032 (20 MiB + 512 bytes para o rodapé VHD) e 35183298347520 bytes (32 Bytes TiB + 512 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 Imagem de Plataforma, uma imagem de utilizador 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, este é um índice que indica qual dos discos de dados na imagem utilizar. Para os discos do SO, este campo é nulo. | int |
sharedGalleryImageId | Um URI relativo que contém uma referência de imagem da Galeria de Computação do Azure partilhada diretamente. | string |
Encriptação
Nome | Descrição | Valor |
---|---|---|
diskEncryptionSetId | ResourceId do conjunto de encriptação de discos a utilizar para ativar a encriptação inativa. | string |
tipo | O tipo de chave utilizado para encriptar os dados do disco. | "EncryptionAtRestWithCustomerKey" "EncryptionAtRestWithPlatformAndCustomerKeys" "EncryptionAtRestWithPlatformKey" |
EncryptionSettingsCollection
Nome | Descrição | Valor |
---|---|---|
ativado | Defina este sinalizador como verdadeiro e forneça DiskEncryptionKey e keyEncryptionKey opcional para ativar a encriptação. Defina este sinalizador como falso e remova DiskEncryptionKey e KeyEncryptionKey para desativar a encriptação. Se EncryptionSettings for nulo no objeto de pedido, as definições existentes permanecem inalteradas. | bool (obrigatório) |
encryptionSettings | Uma coleção de definições de encriptação, uma para cada volume de disco. | EncryptionSettingsElement[] |
encryptionSettingsVersion | Descreve que tipo de encriptação é utilizada para os discos. Uma vez definido este campo, não pode ser substituído. "1.0" corresponde ao Azure Disk Encryption com a aplicação AAD.'1.1' corresponde ao Azure Disk Encryption. | string |
EncryptionSettingsElement
Nome | Descrição | Valor |
---|---|---|
diskEncryptionKey | Key Vault o URL secreto e o ID do cofre da chave de encriptação do disco | KeyVaultAndSecretReference |
keyEncryptionKey | Key Vault o URL da chave e o ID do cofre da chave de encriptação. KeyEncryptionKey é opcional e, quando fornecido, é utilizado para desembrulhar a chave de encriptação do disco. | KeyVaultAndKeyReference |
KeyVaultAndSecretReference
Nome | Descrição | Valor |
---|---|---|
secretUrl | URL a apontar para uma chave ou segredo no KeyVault | cadeia (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 a apontar para uma chave ou segredo no KeyVault | cadeia (obrigatório) |
sourceVault | ID de recurso do KeyVault que contém a chave ou segredo | SourceVault (obrigatório) |
Plano de Compra
Nome | Descrição | Valor |
---|---|---|
name | O ID do plano. | cadeia (obrigatório) |
produto | Especifica o produto da imagem a partir do marketplace. Este é o mesmo valor que a Oferta no elemento imageReference. | cadeia (obrigatório) |
promotionCode | O Código de Promoção da Oferta. | string |
publicador | O ID do editor. | cadeia (obrigatório) |
DiskSecurityProfile
Nome | Descrição | Valor |
---|---|---|
secureVMDiskEncryptionSetId | ResourceId do conjunto de encriptação de disco associado ao disco suportado pela VM Confidencial encriptado com a chave gerida pelo cliente | string |
securityType | Especifica o SecurityType da VM. Aplicável apenas aos discos do SO. | "ConfidentialVM_DiskEncryptedWithCustomerKey" "ConfidentialVM_DiskEncryptedWithPlatformKey" "ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey" "TrustedLaunch" |
SupportedCapabilities
Nome | Descrição | Valor |
---|---|---|
acceleratedNetwork | Verdadeiro se a imagem a partir da qual o disco do SO é criado suportar redes aceleradas. | bool |
arquitetura | Arquitetura da CPU suportada por um disco do SO. | "Arm64" "x64" |
diskControllerTypes | Os controladores de disco suportados por um disco do SO. Se definido, pode ser SCSI ou SCSI, NVME ou NVME, SCSI. | string |
SnapshotSku
Nome | Descrição | Valor |
---|---|---|
name | O nome do sku. | "Premium_LRS" "Standard_LRS" "Standard_ZRS" |
Comentários
https://aka.ms/ContentUserFeedback.
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja:Submeter e ver comentários