pulumi-vsphere 4.10.0a1710245029__py3-none-any.whl → 4.13.0a1736836157__py3-none-any.whl

pulumi_vsphere/virtual_disk.py

@@ -4,9 +4,14 @@
 
 import copy
 import warnings
+import sys
 import pulumi
 import pulumi.runtime
 from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
 from . import _utilities
 
 __all__ = ['VirtualDiskArgs', 'VirtualDisk']
@@ -25,7 +30,9 @@ class VirtualDiskArgs:
         The set of arguments for constructing a VirtualDisk resource.
         :param pulumi.Input[str] datastore: The name of the datastore in which to create the
                disk.
-        :param pulumi.Input[int] size: Size of the disk (in GB).
+        :param pulumi.Input[int] size: Size of the disk (in GB). Decreasing the size of a disk is not possible.
+               If a disk of a smaller size is required then the original has to be destroyed along with its data and a new one has to be
+               created.
         :param pulumi.Input[str] vmdk_path: The path, including filename, of the virtual disk to
                be created.  This needs to end in `.vmdk`.
         :param pulumi.Input[str] adapter_type: The adapter type for this virtual disk. Can be
@@ -45,21 +52,21 @@ class VirtualDiskArgs:
                `create_directories` is enabled will not be deleted when the resource is
                destroyed.
         :param pulumi.Input[str] datacenter: The name of the datacenter in which to create the
-               disk. Can be omitted when when ESXi or if there is only one datacenter in
+               disk. Can be omitted when ESXi or if there is only one datacenter in
                your infrastructure.
         :param pulumi.Input[str] type: The type of disk to create. Can be one of
                `eagerZeroedThick`, `lazy`, or `thin`. Default: `eagerZeroedThick`. For
                information on what each kind of disk provisioning policy means, click
                [here][docs-vmware-vm-disk-provisioning].
                
-               [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
+               [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
         """
         pulumi.set(__self__, "datastore", datastore)
         pulumi.set(__self__, "size", size)
         pulumi.set(__self__, "vmdk_path", vmdk_path)
         if adapter_type is not None:
-            warnings.warn("""this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""", DeprecationWarning)
-            pulumi.log.warn("""adapter_type is deprecated: this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""")
+            warnings.warn("""this attribute has no effect on controller types - please use scsi_type in VirtualMachine instead""", DeprecationWarning)
+            pulumi.log.warn("""adapter_type is deprecated: this attribute has no effect on controller types - please use scsi_type in VirtualMachine instead""")
         if adapter_type is not None:
             pulumi.set(__self__, "adapter_type", adapter_type)
         if create_directories is not None:
@@ -86,7 +93,9 @@ class VirtualDiskArgs:
     @pulumi.getter
     def size(self) -> pulumi.Input[int]:
         """
-        Size of the disk (in GB).
+        Size of the disk (in GB). Decreasing the size of a disk is not possible.
+        If a disk of a smaller size is required then the original has to be destroyed along with its data and a new one has to be
+        created.
         """
         return pulumi.get(self, "size")
 
@@ -109,6 +118,7 @@ class VirtualDiskArgs:
 
     @property
     @pulumi.getter(name="adapterType")
+    @_utilities.deprecated("""this attribute has no effect on controller types - please use scsi_type in VirtualMachine instead""")
     def adapter_type(self) -> Optional[pulumi.Input[str]]:
         """
         The adapter type for this virtual disk. Can be
@@ -121,9 +131,6 @@ class VirtualDiskArgs:
         disk controller types. This parameter will be removed in future versions of the
         vSphere provider.
         """
-        warnings.warn("""this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""", DeprecationWarning)
-        pulumi.log.warn("""adapter_type is deprecated: this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""")
-
         return pulumi.get(self, "adapter_type")
 
     @adapter_type.setter
@@ -153,7 +160,7 @@ class VirtualDiskArgs:
     def datacenter(self) -> Optional[pulumi.Input[str]]:
         """
         The name of the datacenter in which to create the
-        disk. Can be omitted when when ESXi or if there is only one datacenter in
+        disk. Can be omitted when ESXi or if there is only one datacenter in
         your infrastructure.
         """
         return pulumi.get(self, "datacenter")
@@ -171,7 +178,7 @@ class VirtualDiskArgs:
         information on what each kind of disk provisioning policy means, click
         [here][docs-vmware-vm-disk-provisioning].
 
-        [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
+        [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
         """
         return pulumi.get(self, "type")
 
@@ -209,23 +216,25 @@ class _VirtualDiskState:
                `create_directories` is enabled will not be deleted when the resource is
                destroyed.
         :param pulumi.Input[str] datacenter: The name of the datacenter in which to create the
-               disk. Can be omitted when when ESXi or if there is only one datacenter in
+               disk. Can be omitted when ESXi or if there is only one datacenter in
                your infrastructure.
         :param pulumi.Input[str] datastore: The name of the datastore in which to create the
                disk.
-        :param pulumi.Input[int] size: Size of the disk (in GB).
+        :param pulumi.Input[int] size: Size of the disk (in GB). Decreasing the size of a disk is not possible.
+               If a disk of a smaller size is required then the original has to be destroyed along with its data and a new one has to be
+               created.
         :param pulumi.Input[str] type: The type of disk to create. Can be one of
                `eagerZeroedThick`, `lazy`, or `thin`. Default: `eagerZeroedThick`. For
                information on what each kind of disk provisioning policy means, click
                [here][docs-vmware-vm-disk-provisioning].
                
-               [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
+               [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
         :param pulumi.Input[str] vmdk_path: The path, including filename, of the virtual disk to
                be created.  This needs to end in `.vmdk`.
         """
         if adapter_type is not None:
-            warnings.warn("""this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""", DeprecationWarning)
-            pulumi.log.warn("""adapter_type is deprecated: this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""")
+            warnings.warn("""this attribute has no effect on controller types - please use scsi_type in VirtualMachine instead""", DeprecationWarning)
+            pulumi.log.warn("""adapter_type is deprecated: this attribute has no effect on controller types - please use scsi_type in VirtualMachine instead""")
         if adapter_type is not None:
             pulumi.set(__self__, "adapter_type", adapter_type)
         if create_directories is not None:
@@ -243,6 +252,7 @@ class _VirtualDiskState:
 
     @property
     @pulumi.getter(name="adapterType")
+    @_utilities.deprecated("""this attribute has no effect on controller types - please use scsi_type in VirtualMachine instead""")
     def adapter_type(self) -> Optional[pulumi.Input[str]]:
         """
         The adapter type for this virtual disk. Can be
@@ -255,9 +265,6 @@ class _VirtualDiskState:
         disk controller types. This parameter will be removed in future versions of the
         vSphere provider.
         """
-        warnings.warn("""this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""", DeprecationWarning)
-        pulumi.log.warn("""adapter_type is deprecated: this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""")
-
         return pulumi.get(self, "adapter_type")
 
     @adapter_type.setter
@@ -287,7 +294,7 @@ class _VirtualDiskState:
     def datacenter(self) -> Optional[pulumi.Input[str]]:
         """
         The name of the datacenter in which to create the
-        disk. Can be omitted when when ESXi or if there is only one datacenter in
+        disk. Can be omitted when ESXi or if there is only one datacenter in
         your infrastructure.
         """
         return pulumi.get(self, "datacenter")
@@ -313,7 +320,9 @@ class _VirtualDiskState:
     @pulumi.getter
     def size(self) -> Optional[pulumi.Input[int]]:
         """
-        Size of the disk (in GB).
+        Size of the disk (in GB). Decreasing the size of a disk is not possible.
+        If a disk of a smaller size is required then the original has to be destroyed along with its data and a new one has to be
+        created.
         """
         return pulumi.get(self, "size")
 
@@ -330,7 +339,7 @@ class _VirtualDiskState:
         information on what each kind of disk provisioning policy means, click
         [here][docs-vmware-vm-disk-provisioning].
 
-        [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
+        [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
         """
         return pulumi.get(self, "type")
 
@@ -366,7 +375,44 @@ class VirtualDisk(pulumi.CustomResource):
                  vmdk_path: Optional[pulumi.Input[str]] = None,
                  __props__=None):
         """
-        Create a VirtualDisk resource with the given unique name, props, and options.
+        The `VirtualDisk` resource can be used to create virtual disks outside
+        of any given `VirtualMachine`
+        resource. These disks can be attached to a virtual machine by creating a disk
+        block with the `attach` parameter.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        datastore = vsphere.get_datacenter(name="datastore-01")
+        virtual_disk = vsphere.VirtualDisk("virtual_disk",
+            size=40,
+            type="thin",
+            vmdk_path="/foo/foo.vmdk",
+            create_directories=True,
+            datacenter=datacenter.name,
+            datastore=datastore_vsphere_datastore["name"])
+        ```
+
+        ## Import
+
+        An existing virtual disk can be imported into this resource
+
+        via supplying the full datastore path to the virtual disk. An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/virtualDisk:VirtualDisk virtual_disk \\
+        ```
+
+          '{"virtual_disk_path": "/dc-01/[datastore-01]foo/bar.vmdk", \\ "create_directories": "true"}'
+
+        The above would import the virtual disk located at `foo/bar.vmdk` in the `datastore-01`
+
+        datastore of the `dc-01` datacenter with `create_directories` set as `true`.
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[str] adapter_type: The adapter type for this virtual disk. Can be
@@ -386,17 +432,19 @@ class VirtualDisk(pulumi.CustomResource):
                `create_directories` is enabled will not be deleted when the resource is
                destroyed.
         :param pulumi.Input[str] datacenter: The name of the datacenter in which to create the
-               disk. Can be omitted when when ESXi or if there is only one datacenter in
+               disk. Can be omitted when ESXi or if there is only one datacenter in
                your infrastructure.
         :param pulumi.Input[str] datastore: The name of the datastore in which to create the
                disk.
-        :param pulumi.Input[int] size: Size of the disk (in GB).
+        :param pulumi.Input[int] size: Size of the disk (in GB). Decreasing the size of a disk is not possible.
+               If a disk of a smaller size is required then the original has to be destroyed along with its data and a new one has to be
+               created.
         :param pulumi.Input[str] type: The type of disk to create. Can be one of
                `eagerZeroedThick`, `lazy`, or `thin`. Default: `eagerZeroedThick`. For
                information on what each kind of disk provisioning policy means, click
                [here][docs-vmware-vm-disk-provisioning].
                
-               [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
+               [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
         :param pulumi.Input[str] vmdk_path: The path, including filename, of the virtual disk to
                be created.  This needs to end in `.vmdk`.
         """
@@ -407,7 +455,44 @@ class VirtualDisk(pulumi.CustomResource):
                  args: VirtualDiskArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
-        Create a VirtualDisk resource with the given unique name, props, and options.
+        The `VirtualDisk` resource can be used to create virtual disks outside
+        of any given `VirtualMachine`
+        resource. These disks can be attached to a virtual machine by creating a disk
+        block with the `attach` parameter.
+
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_vsphere as vsphere
+
+        datacenter = vsphere.get_datacenter(name="dc-01")
+        datastore = vsphere.get_datacenter(name="datastore-01")
+        virtual_disk = vsphere.VirtualDisk("virtual_disk",
+            size=40,
+            type="thin",
+            vmdk_path="/foo/foo.vmdk",
+            create_directories=True,
+            datacenter=datacenter.name,
+            datastore=datastore_vsphere_datastore["name"])
+        ```
+
+        ## Import
+
+        An existing virtual disk can be imported into this resource
+
+        via supplying the full datastore path to the virtual disk. An example is below:
+
+        ```sh
+        $ pulumi import vsphere:index/virtualDisk:VirtualDisk virtual_disk \\
+        ```
+
+          '{"virtual_disk_path": "/dc-01/[datastore-01]foo/bar.vmdk", \\ "create_directories": "true"}'
+
+        The above would import the virtual disk located at `foo/bar.vmdk` in the `datastore-01`
+
+        datastore of the `dc-01` datacenter with `create_directories` set as `true`.
+
         :param str resource_name: The name of the resource.
         :param VirtualDiskArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -493,17 +578,19 @@ class VirtualDisk(pulumi.CustomResource):
                `create_directories` is enabled will not be deleted when the resource is
                destroyed.
         :param pulumi.Input[str] datacenter: The name of the datacenter in which to create the
-               disk. Can be omitted when when ESXi or if there is only one datacenter in
+               disk. Can be omitted when ESXi or if there is only one datacenter in
                your infrastructure.
         :param pulumi.Input[str] datastore: The name of the datastore in which to create the
                disk.
-        :param pulumi.Input[int] size: Size of the disk (in GB).
+        :param pulumi.Input[int] size: Size of the disk (in GB). Decreasing the size of a disk is not possible.
+               If a disk of a smaller size is required then the original has to be destroyed along with its data and a new one has to be
+               created.
         :param pulumi.Input[str] type: The type of disk to create. Can be one of
                `eagerZeroedThick`, `lazy`, or `thin`. Default: `eagerZeroedThick`. For
                information on what each kind of disk provisioning policy means, click
                [here][docs-vmware-vm-disk-provisioning].
                
-               [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
+               [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
         :param pulumi.Input[str] vmdk_path: The path, including filename, of the virtual disk to
                be created.  This needs to end in `.vmdk`.
         """
@@ -522,6 +609,7 @@ class VirtualDisk(pulumi.CustomResource):
 
     @property
     @pulumi.getter(name="adapterType")
+    @_utilities.deprecated("""this attribute has no effect on controller types - please use scsi_type in VirtualMachine instead""")
     def adapter_type(self) -> pulumi.Output[Optional[str]]:
         """
         The adapter type for this virtual disk. Can be
@@ -534,9 +622,6 @@ class VirtualDisk(pulumi.CustomResource):
         disk controller types. This parameter will be removed in future versions of the
         vSphere provider.
         """
-        warnings.warn("""this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""", DeprecationWarning)
-        pulumi.log.warn("""adapter_type is deprecated: this attribute has no effect on controller types - please use scsi_type in vsphere_virtual_machine instead""")
-
         return pulumi.get(self, "adapter_type")
 
     @property
@@ -558,7 +643,7 @@ class VirtualDisk(pulumi.CustomResource):
     def datacenter(self) -> pulumi.Output[Optional[str]]:
         """
         The name of the datacenter in which to create the
-        disk. Can be omitted when when ESXi or if there is only one datacenter in
+        disk. Can be omitted when ESXi or if there is only one datacenter in
         your infrastructure.
         """
         return pulumi.get(self, "datacenter")
@@ -576,7 +661,9 @@ class VirtualDisk(pulumi.CustomResource):
     @pulumi.getter
     def size(self) -> pulumi.Output[int]:
         """
-        Size of the disk (in GB).
+        Size of the disk (in GB). Decreasing the size of a disk is not possible.
+        If a disk of a smaller size is required then the original has to be destroyed along with its data and a new one has to be
+        created.
         """
         return pulumi.get(self, "size")
 
@@ -589,7 +676,7 @@ class VirtualDisk(pulumi.CustomResource):
         information on what each kind of disk provisioning policy means, click
         [here][docs-vmware-vm-disk-provisioning].
 
-        [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.vm_admin.doc/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
+        [docs-vmware-vm-disk-provisioning]: https://docs.vmware.com/en/VMware-vSphere/8.0/vsphere-vm-administration/GUID-4C0F4D73-82F2-4B81-8AA7-1DD752A8A5AC.html
         """
         return pulumi.get(self, "type")