Microsoft.Compute/disks 2019-03-01 - Bicep, ARM template & Terraform AzAPI reference

Bicep 资源定义

可以使用目标操作部署磁盘资源类型：

资源组 - 请参阅资源组部署命令

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

资源格式

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

resource symbolicname 'Microsoft.Compute/disks@2019-03-01' = {
  location: 'string'
  name: 'string'
  properties: {
    creationData: {
      createOption: 'string'
      imageReference: {
        id: 'string'
        lun: int
      }
      sourceResourceId: 'string'
      sourceUri: 'string'
      storageAccountId: 'string'
      uploadSizeBytes: int
    }
    diskIOPSReadWrite: int
    diskMBpsReadWrite: int
    diskSizeGB: int
    encryptionSettingsCollection: {
      enabled: bool
      encryptionSettings: [
        {
          diskEncryptionKey: {
            secretUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
          keyEncryptionKey: {
            keyUrl: 'string'
            sourceVault: {
              id: 'string'
            }
          }
        }
      ]
      encryptionSettingsVersion: 'string'
    }
    hyperVGeneration: 'string'
    osType: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
  zones: [
    'string'
  ]
}

属性值

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“Attach” “Copy” “Empty” “FromImage” “导入” “还原” “上传”（必需）
imageReference	磁盘源信息。	ImageDiskReference
sourceResourceId	如果 createOption 为 Copy，则这是源快照或磁盘的 ARM ID。	字符串
sourceUri	如果 createOption 为 Import，则这是要导入到托管磁盘中的 Blob 的 URI。	字符串
storageAccountId	如果 createOption 为 Import，则包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。仅当 Blob 位于其他订阅中时才必需	字符串
uploadSizeBytes	如果 createOption 为 Upload，则这是上传内容的大小，包括 VHD 页脚。此值应介于 20972032（VHD 页脚的 20 MiB + 512 字节）和35183298347520字节（VHD 页脚的 32 TiB + 512 字节）。	int

DiskProperties

名字	描述	价值
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
diskIOPSReadWrite	此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。一个操作可以在 4k 到 256k 字节之间传输。	int
diskMBpsReadWrite	此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法，其幂为 10。	int
diskSizeGB	如果 creationData.createOption 为 Empty，则此字段是必需的，并指示要创建的磁盘的大小。如果此字段可用于更新或创建其他选项，则表示调整大小。仅当磁盘未附加到正在运行的 VM 时，才允许重设大小，并且只能增加磁盘的大小。	int
encryptionSettingsCollection	用于 Azure 磁盘加密的加密设置集合可以包含每个磁盘或快照的多个加密设置。	EncryptionSettingsCollection
hyperVGeneration	虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。	“V1” “V2”
osType	操作系统类型。	“Linux” “Windows”

DiskSku

名字	描述	价值
名字	SKU 名称。	“Premium_LRS” “StandardSSD_LRS” “Standard_LRS” “UltraSSD_LRS”

EncryptionSettingsCollection

名字	描述	价值
启用	将此标志设置为 true，并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。将此标志设置为 false，并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。如果 Request 对象中的 EncryptionSettings 为 null，则现有设置保持不变。	bool （必需）
encryptionSettings	加密设置的集合，每个磁盘卷各有一个。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁盘使用哪种类型的加密。设置此字段后，无法覆盖它。 “1.0”对应于 AAD 应用的 Azure 磁盘加密。“1.1”对应于 Azure 磁盘加密。	字符串

EncryptionSettingsElement

名字	描述	价值
diskEncryptionKey	磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID	KeyVaultAndSecretReference
keyEncryptionKey	密钥保管库密钥 URL 和密钥加密密钥的保管库 ID。 KeyEncryptionKey 是可选的，当提供用于解包磁盘加密密钥时。	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/disks

名字	描述	价值
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	磁盘资源属性。	DiskProperties
sku	磁盘 SKU 名称。可以是Standard_LRS、Premium_LRS、StandardSSD_LRS或UltraSSD_LRS。	DiskSku
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
区	磁盘的逻辑区域列表。	string[]

ResourceTags

名字	描述	价值

SourceVault

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

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件	描述
创建磁盘 & 通过备份保管库启用保护	用于创建磁盘并通过备份保管库启用保护的模板
安装了 Portainer 和 Traefik 的 Windows Docker 主机	预安装了 Portainer 和 Traefik 的 Windows Docker 主机
使用 SSH Windows Server VM	部署启用了开放 SSH 的单个 Windows VM，以便可以使用基于密钥的身份验证通过 SSH 进行连接。

ARM 模板资源定义

可以使用目标操作部署磁盘资源类型：

资源组 - 请参阅资源组部署命令

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

资源格式

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

{
  "type": "Microsoft.Compute/disks",
  "apiVersion": "2019-03-01",
  "name": "string",
  "location": "string",
  "properties": {
    "creationData": {
      "createOption": "string",
      "imageReference": {
        "id": "string",
        "lun": "int"
      },
      "sourceResourceId": "string",
      "sourceUri": "string",
      "storageAccountId": "string",
      "uploadSizeBytes": "int"
    },
    "diskIOPSReadWrite": "int",
    "diskMBpsReadWrite": "int",
    "diskSizeGB": "int",
    "encryptionSettingsCollection": {
      "enabled": "bool",
      "encryptionSettings": [
        {
          "diskEncryptionKey": {
            "secretUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          },
          "keyEncryptionKey": {
            "keyUrl": "string",
            "sourceVault": {
              "id": "string"
            }
          }
        }
      ],
      "encryptionSettingsVersion": "string"
    },
    "hyperVGeneration": "string",
    "osType": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  },
  "zones": [ "string" ]
}

属性值

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“Attach” “Copy” “Empty” “FromImage” “导入” “还原” “上传”（必需）
imageReference	磁盘源信息。	ImageDiskReference
sourceResourceId	如果 createOption 为 Copy，则这是源快照或磁盘的 ARM ID。	字符串
sourceUri	如果 createOption 为 Import，则这是要导入到托管磁盘中的 Blob 的 URI。	字符串
storageAccountId	如果 createOption 为 Import，则包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。仅当 Blob 位于其他订阅中时才必需	字符串
uploadSizeBytes	如果 createOption 为 Upload，则这是上传内容的大小，包括 VHD 页脚。此值应介于 20972032（VHD 页脚的 20 MiB + 512 字节）和35183298347520字节（VHD 页脚的 32 TiB + 512 字节）。	int

DiskProperties

名字	描述	价值
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
diskIOPSReadWrite	此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。一个操作可以在 4k 到 256k 字节之间传输。	int
diskMBpsReadWrite	此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法，其幂为 10。	int
diskSizeGB	如果 creationData.createOption 为 Empty，则此字段是必需的，并指示要创建的磁盘的大小。如果此字段可用于更新或创建其他选项，则表示调整大小。仅当磁盘未附加到正在运行的 VM 时，才允许重设大小，并且只能增加磁盘的大小。	int
encryptionSettingsCollection	用于 Azure 磁盘加密的加密设置集合可以包含每个磁盘或快照的多个加密设置。	EncryptionSettingsCollection
hyperVGeneration	虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。	“V1” “V2”
osType	操作系统类型。	“Linux” “Windows”

DiskSku

名字	描述	价值
名字	SKU 名称。	“Premium_LRS” “StandardSSD_LRS” “Standard_LRS” “UltraSSD_LRS”

EncryptionSettingsCollection

名字	描述	价值
启用	将此标志设置为 true，并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。将此标志设置为 false，并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。如果 Request 对象中的 EncryptionSettings 为 null，则现有设置保持不变。	bool （必需）
encryptionSettings	加密设置的集合，每个磁盘卷各有一个。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁盘使用哪种类型的加密。设置此字段后，无法覆盖它。 “1.0”对应于 AAD 应用的 Azure 磁盘加密。“1.1”对应于 Azure 磁盘加密。	字符串

EncryptionSettingsElement

名字	描述	价值
diskEncryptionKey	磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID	KeyVaultAndSecretReference
keyEncryptionKey	密钥保管库密钥 URL 和密钥加密密钥的保管库 ID。 KeyEncryptionKey 是可选的，当提供用于解包磁盘加密密钥时。	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/disks

名字	描述	价值
apiVersion	API 版本	'2019-03-01'
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	磁盘资源属性。	DiskProperties
sku	磁盘 SKU 名称。可以是Standard_LRS、Premium_LRS、StandardSSD_LRS或UltraSSD_LRS。	DiskSku
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.Compute/disks”
区	磁盘的逻辑区域列表。	string[]

ResourceTags

名字	描述	价值

SourceVault

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

快速入门模板

以下快速入门模板部署此资源类型。

模板	描述
从 EfficientIP VHD 创建 VM	此模板从 EfficientIP VHD 创建 VM，并允许将其连接到可以驻留在另一个资源组中的现有 VNET，然后连接到虚拟机
从自定义 VHD 在新的或现有 vnet 中创建 VM	此模板从专用 VHD 创建一个 VM，并使你能够将其连接到一个新的或现有的 VNET，该 VNET 可以驻留在另一个资源组中，而不是虚拟机
创建磁盘 & 通过备份保管库启用保护	用于创建磁盘并通过备份保管库启用保护的模板
从现有 VHD 创建 VM 并将其连接到现有 VNET	此模板从 VHD（OS + 数据磁盘）创建 VM，并让你将其连接到可以驻留在另一个资源组中的现有 VNET，然后虚拟机
创建具有特定扇区大小的超级托管磁盘	此模板创建新的超级托管磁盘，允许用户指定扇区大小为 512 或 4096。
在可用性区域中部署 3 节点 Percona XtraDB 群集	此模板在 CentOS 6.5 或 Ubuntu 12.04 上部署 3 节点 MySQL 高可用性群集
在 UltraSSD 上 SQL VM 性能优化存储设置	使用 UltraSSD for SQL 日志文件创建具有性能优化存储设置的 SQL Server 虚拟机
安装了 Portainer 和 Traefik 的 Windows Docker 主机	预安装了 Portainer 和 Traefik 的 Windows Docker 主机
使用 SSH Windows Server VM	部署启用了开放 SSH 的单个 Windows VM，以便可以使用基于密钥的身份验证通过 SSH 进行连接。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署磁盘资源类型：

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/disks@2019-03-01"
  name = "string"
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  zones = [
    "string"
  ]
  body = jsonencode({
    properties = {
      creationData = {
        createOption = "string"
        imageReference = {
          id = "string"
          lun = int
        }
        sourceResourceId = "string"
        sourceUri = "string"
        storageAccountId = "string"
        uploadSizeBytes = int
      }
      diskIOPSReadWrite = int
      diskMBpsReadWrite = int
      diskSizeGB = int
      encryptionSettingsCollection = {
        enabled = bool
        encryptionSettings = [
          {
            diskEncryptionKey = {
              secretUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
            keyEncryptionKey = {
              keyUrl = "string"
              sourceVault = {
                id = "string"
              }
            }
          }
        ]
        encryptionSettingsVersion = "string"
      }
      hyperVGeneration = "string"
      osType = "string"
    }
  })
}

属性值

CreationData

名字	描述	价值
createOption	这会枚举磁盘创建可能的源。	“Attach” “Copy” “Empty” “FromImage” “导入” “还原” “上传”（必需）
imageReference	磁盘源信息。	ImageDiskReference
sourceResourceId	如果 createOption 为 Copy，则这是源快照或磁盘的 ARM ID。	字符串
sourceUri	如果 createOption 为 Import，则这是要导入到托管磁盘中的 Blob 的 URI。	字符串
storageAccountId	如果 createOption 为 Import，则包含要作为磁盘导入的 Blob 的存储帐户的 Azure 资源管理器标识符。仅当 Blob 位于其他订阅中时才必需	字符串
uploadSizeBytes	如果 createOption 为 Upload，则这是上传内容的大小，包括 VHD 页脚。此值应介于 20972032（VHD 页脚的 20 MiB + 512 字节）和35183298347520字节（VHD 页脚的 32 TiB + 512 字节）。	int

DiskProperties

名字	描述	价值
creationData	磁盘源信息。创建磁盘后，无法更改 CreationData 信息。	CreationData （必需）
diskIOPSReadWrite	此磁盘允许的 IOPS 数;只能为 UltraSSD 磁盘设置。一个操作可以在 4k 到 256k 字节之间传输。	int
diskMBpsReadWrite	此磁盘允许的带宽;只能为 UltraSSD 磁盘设置。 MBps 表示每秒数百万字节 - 此处的 MB 使用 ISO 表示法，其幂为 10。	int
diskSizeGB	如果 creationData.createOption 为 Empty，则此字段是必需的，并指示要创建的磁盘的大小。如果此字段可用于更新或创建其他选项，则表示调整大小。仅当磁盘未附加到正在运行的 VM 时，才允许重设大小，并且只能增加磁盘的大小。	int
encryptionSettingsCollection	用于 Azure 磁盘加密的加密设置集合可以包含每个磁盘或快照的多个加密设置。	EncryptionSettingsCollection
hyperVGeneration	虚拟机的虚拟机监控程序生成。仅适用于 OS 磁盘。	“V1” “V2”
osType	操作系统类型。	“Linux” “Windows”

DiskSku

名字	描述	价值
名字	SKU 名称。	“Premium_LRS” “StandardSSD_LRS” “Standard_LRS” “UltraSSD_LRS”

EncryptionSettingsCollection

名字	描述	价值
启用	将此标志设置为 true，并提供 DiskEncryptionKey 和可选 KeyEncryptionKey 以启用加密。将此标志设置为 false，并删除 DiskEncryptionKey 和 KeyEncryptionKey 以禁用加密。如果 Request 对象中的 EncryptionSettings 为 null，则现有设置保持不变。	bool （必需）
encryptionSettings	加密设置的集合，每个磁盘卷各有一个。	EncryptionSettingsElement[]
encryptionSettingsVersion	描述磁盘使用哪种类型的加密。设置此字段后，无法覆盖它。 “1.0”对应于 AAD 应用的 Azure 磁盘加密。“1.1”对应于 Azure 磁盘加密。	字符串

EncryptionSettingsElement

名字	描述	价值
diskEncryptionKey	磁盘加密密钥的 Key Vault 机密 URL 和保管库 ID	KeyVaultAndSecretReference
keyEncryptionKey	密钥保管库密钥 URL 和密钥加密密钥的保管库 ID。 KeyEncryptionKey 是可选的，当提供用于解包磁盘加密密钥时。	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/disks

名字	描述	价值
位置	资源位置	string （必需）
名字	资源名称	string （必需）
性能	磁盘资源属性。	DiskProperties
sku	磁盘 SKU 名称。可以是Standard_LRS、Premium_LRS、StandardSSD_LRS或UltraSSD_LRS。	DiskSku
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Compute/disks@2019-03-01”
区	磁盘的逻辑区域列表。	string[]

ResourceTags

名字	描述	价值

SourceVault

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

通过

Microsoft.Compute disks 2019-03-01

Bicep 资源定义

资源格式

属性值

CreationData

DiskProperties

DiskSku

EncryptionSettingsCollection

EncryptionSettingsElement

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/disks

ResourceTags

SourceVault

快速入门示例

ARM 模板资源定义

资源格式

属性值

CreationData

DiskProperties

DiskSku

EncryptionSettingsCollection

EncryptionSettingsElement

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/disks

ResourceTags

SourceVault

快速入门模板

Terraform （AzAPI 提供程序）资源定义

资源格式

属性值

CreationData

DiskProperties

DiskSku

EncryptionSettingsCollection

EncryptionSettingsElement

ImageDiskReference

KeyVaultAndKeyReference

KeyVaultAndSecretReference

Microsoft.Compute/disks

ResourceTags

SourceVault

反馈

其他资源