你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Microsoft.Compute snapshots 2016-04-30-preview

Bicep 资源定义

可以使用目标操作部署快照资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Compute/snapshots 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Compute/snapshots@2016-04-30-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    accountType: 'string'
    creationData: {
      createOption: 'string'
      imageReference: {
        id: 'string'
        lun: int
      }
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
    }
    diskSizeGB: int
    encryptionSettings: {
      diskEncryptionKey: {
        secretUrl: 'string'
        sourceVault: {
          id: 'string'
        }
      }
      enabled: bool
      keyEncryptionKey: {
        keyUrl: 'string'
        sourceVault: {
          id: 'string'
        }
      }
    }
    osType: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

CreationData

名字 描述 价值
createOption 这会枚举磁盘创建可能的源。 “Attach”
“Copy”
“Empty”
“FromImage”
“导入”
“还原”(必需)
imageReference 磁盘源信息。 ImageDiskReference
sourceResourceId 如果 createOption 为 Copy,则这是源快照或磁盘的 ARM ID。 如果 createOption 为 Restore,则这是源磁盘还原点的类似 ARM 的 ID。 字符串
sourceUri 如果 createOption 为 Import,则这是要导入到托管磁盘中的 Blob 的 SAS URI。 如果 createOption 为 Copy,则这是一个相对 URI,其中包含要复制到托管磁盘的源快照的 ID。 字符串
storageAccountId 如果 createOption 为 Import,则包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。 仅当 Blob 位于其他订阅中时才必需 字符串

DiskProperties

名字 描述 价值
accountType 磁盘的存储帐户类型。 “Premium_LRS”
“Standard_LRS”
creationData 磁盘源信息。 创建磁盘后,无法更改 CreationData 信息。 CreationData (必需)
diskSizeGB 如果 creationData.createOption 为 Empty,则此字段是必需的,并指示要创建的 VHD 的大小。 如果此字段可用于更新或创建其他选项,则表示调整大小。 仅当磁盘未附加到正在运行的 VM 时,才允许重设大小,并且只能增加磁盘的大小。 int
encryptionSettings 磁盘或快照的加密设置 EncryptionSettings
osType 操作系统类型。 “Linux”
“Windows”

EncryptionSettings

名字 描述 价值
diskEncryptionKey 磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID KeyVaultAndSecretReference
启用 将此标志设置为 true,并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。 将此标志设置为 false,并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。 如果 Request 对象中的 EncryptionSettings 为 null,则现有设置保持不变。 bool
keyEncryptionKey 密钥保管库密钥 URL 和密钥加密密钥的保管库 ID KeyVaultAndKeyReference

ImageDiskReference

名字 描述 价值
id 包含平台映像存储库或用户映像引用的相对 URI。 string (必需)
如果磁盘是从映像的数据磁盘创建的,则这是一个索引,指示要使用的映像中的数据磁盘。 对于 OS 磁盘,此字段为 null。 int

KeyVaultAndKeyReference

名字 描述 价值
keyUrl 指向 KeyVault 中的密钥或机密的 URL string (必需)
sourceVault 包含密钥或机密的 KeyVault 的资源 ID SourceVault (必需)

KeyVaultAndSecretReference

名字 描述 价值
secretUrl 指向 KeyVault 中的密钥或机密的 URL string (必需)
sourceVault 包含密钥或机密的 KeyVault 的资源 ID SourceVault (必需)

Microsoft.Compute/snapshots

名字 描述 价值
位置 资源位置 string (必需)
名字 资源名称 string (必需)
性能 磁盘资源属性。 DiskProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceTags

名字 描述 价值

SourceVault

名字 描述 价值
id 资源 ID 字符串

ARM 模板资源定义

可以使用目标操作部署快照资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Compute/snapshots 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Compute/snapshots",
  "apiVersion": "2016-04-30-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "accountType": "string",
    "creationData": {
      "createOption": "string",
      "imageReference": {
        "id": "string",
        "lun": "int"
      },
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string"
    },
    "diskSizeGB": "int",
    "encryptionSettings": {
      "diskEncryptionKey": {
        "secretUrl": "string",
        "sourceVault": {
          "id": "string"
        }
      },
      "enabled": "bool",
      "keyEncryptionKey": {
        "keyUrl": "string",
        "sourceVault": {
          "id": "string"
        }
      }
    },
    "osType": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

CreationData

名字 描述 价值
createOption 这会枚举磁盘创建可能的源。 “Attach”
“Copy”
“Empty”
“FromImage”
“导入”
“还原”(必需)
imageReference 磁盘源信息。 ImageDiskReference
sourceResourceId 如果 createOption 为 Copy,则这是源快照或磁盘的 ARM ID。 如果 createOption 为 Restore,则这是源磁盘还原点的类似 ARM 的 ID。 字符串
sourceUri 如果 createOption 为 Import,则这是要导入到托管磁盘中的 Blob 的 SAS URI。 如果 createOption 为 Copy,则这是一个相对 URI,其中包含要复制到托管磁盘的源快照的 ID。 字符串
storageAccountId 如果 createOption 为 Import,则包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。 仅当 Blob 位于其他订阅中时才必需 字符串

DiskProperties

名字 描述 价值
accountType 磁盘的存储帐户类型。 “Premium_LRS”
“Standard_LRS”
creationData 磁盘源信息。 创建磁盘后,无法更改 CreationData 信息。 CreationData (必需)
diskSizeGB 如果 creationData.createOption 为 Empty,则此字段是必需的,并指示要创建的 VHD 的大小。 如果此字段可用于更新或创建其他选项,则表示调整大小。 仅当磁盘未附加到正在运行的 VM 时,才允许重设大小,并且只能增加磁盘的大小。 int
encryptionSettings 磁盘或快照的加密设置 EncryptionSettings
osType 操作系统类型。 “Linux”
“Windows”

EncryptionSettings

名字 描述 价值
diskEncryptionKey 磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID KeyVaultAndSecretReference
启用 将此标志设置为 true,并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。 将此标志设置为 false,并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。 如果 Request 对象中的 EncryptionSettings 为 null,则现有设置保持不变。 bool
keyEncryptionKey 密钥保管库密钥 URL 和密钥加密密钥的保管库 ID KeyVaultAndKeyReference

ImageDiskReference

名字 描述 价值
id 包含平台映像存储库或用户映像引用的相对 URI。 string (必需)
如果磁盘是从映像的数据磁盘创建的,则这是一个索引,指示要使用的映像中的数据磁盘。 对于 OS 磁盘,此字段为 null。 int

KeyVaultAndKeyReference

名字 描述 价值
keyUrl 指向 KeyVault 中的密钥或机密的 URL string (必需)
sourceVault 包含密钥或机密的 KeyVault 的资源 ID SourceVault (必需)

KeyVaultAndSecretReference

名字 描述 价值
secretUrl 指向 KeyVault 中的密钥或机密的 URL string (必需)
sourceVault 包含密钥或机密的 KeyVault 的资源 ID SourceVault (必需)

Microsoft.Compute/snapshots

名字 描述 价值
apiVersion API 版本 '2016-04-30-preview'
位置 资源位置 string (必需)
名字 资源名称 string (必需)
性能 磁盘资源属性。 DiskProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Compute/snapshots”

ResourceTags

名字 描述 价值

SourceVault

名字 描述 价值
id 资源 ID 字符串

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署快照资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Compute/snapshots 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/snapshots@2016-04-30-preview"
  name = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      accountType = "string"
      creationData = {
        createOption = "string"
        imageReference = {
          id = "string"
          lun = int
        }
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
      }
      diskSizeGB = int
      encryptionSettings = {
        diskEncryptionKey = {
          secretUrl = "string"
          sourceVault = {
            id = "string"
          }
        }
        enabled = bool
        keyEncryptionKey = {
          keyUrl = "string"
          sourceVault = {
            id = "string"
          }
        }
      }
      osType = "string"
    }
  })
}

属性值

CreationData

名字 描述 价值
createOption 这会枚举磁盘创建可能的源。 “Attach”
“Copy”
“Empty”
“FromImage”
“导入”
“还原”(必需)
imageReference 磁盘源信息。 ImageDiskReference
sourceResourceId 如果 createOption 为 Copy,则这是源快照或磁盘的 ARM ID。 如果 createOption 为 Restore,则这是源磁盘还原点的类似 ARM 的 ID。 字符串
sourceUri 如果 createOption 为 Import,则这是要导入到托管磁盘中的 Blob 的 SAS URI。 如果 createOption 为 Copy,则这是一个相对 URI,其中包含要复制到托管磁盘的源快照的 ID。 字符串
storageAccountId 如果 createOption 为 Import,则包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。 仅当 Blob 位于其他订阅中时才必需 字符串

DiskProperties

名字 描述 价值
accountType 磁盘的存储帐户类型。 “Premium_LRS”
“Standard_LRS”
creationData 磁盘源信息。 创建磁盘后,无法更改 CreationData 信息。 CreationData (必需)
diskSizeGB 如果 creationData.createOption 为 Empty,则此字段是必需的,并指示要创建的 VHD 的大小。 如果此字段可用于更新或创建其他选项,则表示调整大小。 仅当磁盘未附加到正在运行的 VM 时,才允许重设大小,并且只能增加磁盘的大小。 int
encryptionSettings 磁盘或快照的加密设置 EncryptionSettings
osType 操作系统类型。 “Linux”
“Windows”

EncryptionSettings

名字 描述 价值
diskEncryptionKey 磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID KeyVaultAndSecretReference
启用 将此标志设置为 true,并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。 将此标志设置为 false,并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。 如果 Request 对象中的 EncryptionSettings 为 null,则现有设置保持不变。 bool
keyEncryptionKey 密钥保管库密钥 URL 和密钥加密密钥的保管库 ID KeyVaultAndKeyReference

ImageDiskReference

名字 描述 价值
id 包含平台映像存储库或用户映像引用的相对 URI。 string (必需)
如果磁盘是从映像的数据磁盘创建的,则这是一个索引,指示要使用的映像中的数据磁盘。 对于 OS 磁盘,此字段为 null。 int

KeyVaultAndKeyReference

名字 描述 价值
keyUrl 指向 KeyVault 中的密钥或机密的 URL string (必需)
sourceVault 包含密钥或机密的 KeyVault 的资源 ID SourceVault (必需)

KeyVaultAndSecretReference

名字 描述 价值
secretUrl 指向 KeyVault 中的密钥或机密的 URL string (必需)
sourceVault 包含密钥或机密的 KeyVault 的资源 ID SourceVault (必需)

Microsoft.Compute/snapshots

名字 描述 价值
位置 资源位置 string (必需)
名字 资源名称 string (必需)
性能 磁盘资源属性。 DiskProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Compute/snapshots@2016-04-30-preview”

ResourceTags

名字 描述 价值

SourceVault

名字 描述 价值
id 资源 ID 字符串