azure-native.devtestlab.Disk
Explore with Pulumi AI
A Disk.
Uses Azure REST API version 2018-09-15. In version 2.x of the Azure Native provider, it used API version 2018-09-15.
Create Disk Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Disk(name: string, args: DiskArgs, opts?: CustomResourceOptions);
@overload
def Disk(resource_name: str,
args: DiskArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Disk(resource_name: str,
opts: Optional[ResourceOptions] = None,
lab_name: Optional[str] = None,
user_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
leased_by_lab_vm_id: Optional[str] = None,
host_caching: Optional[str] = None,
disk_uri: Optional[str] = None,
disk_blob_name: Optional[str] = None,
location: Optional[str] = None,
managed_disk_id: Optional[str] = None,
name: Optional[str] = None,
disk_type: Optional[Union[str, StorageType]] = None,
storage_account_id: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
disk_size_gi_b: Optional[int] = None)
func NewDisk(ctx *Context, name string, args DiskArgs, opts ...ResourceOption) (*Disk, error)
public Disk(string name, DiskArgs args, CustomResourceOptions? opts = null)
type: azure-native:devtestlab:Disk
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DiskArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. DiskArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DiskArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. DiskArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. DiskArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeDiskResource = new AzureNative.DevTestLab.Disk("azure-nativeDiskResource", new()
{
LabName = "string",
UserName = "string",
ResourceGroupName = "string",
LeasedByLabVmId = "string",
HostCaching = "string",
DiskUri = "string",
DiskBlobName = "string",
Location = "string",
ManagedDiskId = "string",
Name = "string",
DiskType = "string",
StorageAccountId = "string",
Tags =
{
{ "string", "string" },
},
DiskSizeGiB = 0,
});
example, err := devtestlab.NewDisk(ctx, "azure-nativeDiskResource", &devtestlab.DiskArgs{
LabName: pulumi.String("string"),
UserName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
LeasedByLabVmId: pulumi.String("string"),
HostCaching: pulumi.String("string"),
DiskUri: pulumi.String("string"),
DiskBlobName: pulumi.String("string"),
Location: pulumi.String("string"),
ManagedDiskId: pulumi.String("string"),
Name: pulumi.String("string"),
DiskType: pulumi.String("string"),
StorageAccountId: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
DiskSizeGiB: pulumi.Int(0),
})
var azure_nativeDiskResource = new Disk("azure-nativeDiskResource", DiskArgs.builder()
.labName("string")
.userName("string")
.resourceGroupName("string")
.leasedByLabVmId("string")
.hostCaching("string")
.diskUri("string")
.diskBlobName("string")
.location("string")
.managedDiskId("string")
.name("string")
.diskType("string")
.storageAccountId("string")
.tags(Map.of("string", "string"))
.diskSizeGiB(0)
.build());
azure_native_disk_resource = azure_native.devtestlab.Disk("azure-nativeDiskResource",
lab_name="string",
user_name="string",
resource_group_name="string",
leased_by_lab_vm_id="string",
host_caching="string",
disk_uri="string",
disk_blob_name="string",
location="string",
managed_disk_id="string",
name="string",
disk_type="string",
storage_account_id="string",
tags={
"string": "string",
},
disk_size_gi_b=0)
const azure_nativeDiskResource = new azure_native.devtestlab.Disk("azure-nativeDiskResource", {
labName: "string",
userName: "string",
resourceGroupName: "string",
leasedByLabVmId: "string",
hostCaching: "string",
diskUri: "string",
diskBlobName: "string",
location: "string",
managedDiskId: "string",
name: "string",
diskType: "string",
storageAccountId: "string",
tags: {
string: "string",
},
diskSizeGiB: 0,
});
type: azure-native:devtestlab:Disk
properties:
diskBlobName: string
diskSizeGiB: 0
diskType: string
diskUri: string
hostCaching: string
labName: string
leasedByLabVmId: string
location: string
managedDiskId: string
name: string
resourceGroupName: string
storageAccountId: string
tags:
string: string
userName: string
Disk Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Disk resource accepts the following input properties:
- Lab
Name This property is required. Changes to this property will trigger replacement.
- The name of the lab.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- User
Name This property is required. Changes to this property will trigger replacement.
- The name of the user profile.
- Disk
Blob stringName - When backed by a blob, the name of the VHD blob without extension.
- Disk
Size intGi B - The size of the disk in Gibibytes.
- Disk
Type string | Pulumi.Azure Native. Dev Test Lab. Storage Type - The storage type for the disk (i.e. Standard, Premium).
- Disk
Uri string - When backed by a blob, the URI of underlying blob.
- Host
Caching string - The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
- Leased
By stringLab Vm Id - The resource ID of the VM to which this disk is leased.
- Location string
- The location of the resource.
- Managed
Disk stringId - When backed by managed disk, this is the ID of the compute disk resource.
- Name
Changes to this property will trigger replacement.
- The name of the disk.
- Storage
Account stringId - When backed by a blob, the storage account where the blob is.
- Dictionary<string, string>
- The tags of the resource.
- Lab
Name This property is required. Changes to this property will trigger replacement.
- The name of the lab.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- User
Name This property is required. Changes to this property will trigger replacement.
- The name of the user profile.
- Disk
Blob stringName - When backed by a blob, the name of the VHD blob without extension.
- Disk
Size intGi B - The size of the disk in Gibibytes.
- Disk
Type string | StorageType - The storage type for the disk (i.e. Standard, Premium).
- Disk
Uri string - When backed by a blob, the URI of underlying blob.
- Host
Caching string - The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
- Leased
By stringLab Vm Id - The resource ID of the VM to which this disk is leased.
- Location string
- The location of the resource.
- Managed
Disk stringId - When backed by managed disk, this is the ID of the compute disk resource.
- Name
Changes to this property will trigger replacement.
- The name of the disk.
- Storage
Account stringId - When backed by a blob, the storage account where the blob is.
- map[string]string
- The tags of the resource.
- lab
Name This property is required. Changes to this property will trigger replacement.
- The name of the lab.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- user
Name This property is required. Changes to this property will trigger replacement.
- The name of the user profile.
- disk
Blob StringName - When backed by a blob, the name of the VHD blob without extension.
- disk
Size IntegerGi B - The size of the disk in Gibibytes.
- disk
Type String | StorageType - The storage type for the disk (i.e. Standard, Premium).
- disk
Uri String - When backed by a blob, the URI of underlying blob.
- host
Caching String - The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
- leased
By StringLab Vm Id - The resource ID of the VM to which this disk is leased.
- location String
- The location of the resource.
- managed
Disk StringId - When backed by managed disk, this is the ID of the compute disk resource.
- name
Changes to this property will trigger replacement.
- The name of the disk.
- storage
Account StringId - When backed by a blob, the storage account where the blob is.
- Map<String,String>
- The tags of the resource.
- lab
Name This property is required. Changes to this property will trigger replacement.
- The name of the lab.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- user
Name This property is required. Changes to this property will trigger replacement.
- The name of the user profile.
- disk
Blob stringName - When backed by a blob, the name of the VHD blob without extension.
- disk
Size numberGi B - The size of the disk in Gibibytes.
- disk
Type string | StorageType - The storage type for the disk (i.e. Standard, Premium).
- disk
Uri string - When backed by a blob, the URI of underlying blob.
- host
Caching string - The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
- leased
By stringLab Vm Id - The resource ID of the VM to which this disk is leased.
- location string
- The location of the resource.
- managed
Disk stringId - When backed by managed disk, this is the ID of the compute disk resource.
- name
Changes to this property will trigger replacement.
- The name of the disk.
- storage
Account stringId - When backed by a blob, the storage account where the blob is.
- {[key: string]: string}
- The tags of the resource.
- lab_
name This property is required. Changes to this property will trigger replacement.
- The name of the lab.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- user_
name This property is required. Changes to this property will trigger replacement.
- The name of the user profile.
- disk_
blob_ strname - When backed by a blob, the name of the VHD blob without extension.
- disk_
size_ intgi_ b - The size of the disk in Gibibytes.
- disk_
type str | StorageType - The storage type for the disk (i.e. Standard, Premium).
- disk_
uri str - When backed by a blob, the URI of underlying blob.
- host_
caching str - The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
- leased_
by_ strlab_ vm_ id - The resource ID of the VM to which this disk is leased.
- location str
- The location of the resource.
- managed_
disk_ strid - When backed by managed disk, this is the ID of the compute disk resource.
- name
Changes to this property will trigger replacement.
- The name of the disk.
- storage_
account_ strid - When backed by a blob, the storage account where the blob is.
- Mapping[str, str]
- The tags of the resource.
- lab
Name This property is required. Changes to this property will trigger replacement.
- The name of the lab.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- user
Name This property is required. Changes to this property will trigger replacement.
- The name of the user profile.
- disk
Blob StringName - When backed by a blob, the name of the VHD blob without extension.
- disk
Size NumberGi B - The size of the disk in Gibibytes.
- disk
Type String | "Standard" | "Premium" | "StandardSSD" - The storage type for the disk (i.e. Standard, Premium).
- disk
Uri String - When backed by a blob, the URI of underlying blob.
- host
Caching String - The host caching policy of the disk (i.e. None, ReadOnly, ReadWrite).
- leased
By StringLab Vm Id - The resource ID of the VM to which this disk is leased.
- location String
- The location of the resource.
- managed
Disk StringId - When backed by managed disk, this is the ID of the compute disk resource.
- name
Changes to this property will trigger replacement.
- The name of the disk.
- storage
Account StringId - When backed by a blob, the storage account where the blob is.
- Map<String>
- The tags of the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the Disk resource produces the following output properties:
- Azure
Api stringVersion - The Azure API version of the resource.
- Created
Date string - The creation date of the disk.
- Id string
- The provider-assigned unique ID for this managed resource.
- Provisioning
State string - The provisioning status of the resource.
- Type string
- The type of the resource.
- Unique
Identifier string - The unique immutable identifier of a resource (Guid).
- Azure
Api stringVersion - The Azure API version of the resource.
- Created
Date string - The creation date of the disk.
- Id string
- The provider-assigned unique ID for this managed resource.
- Provisioning
State string - The provisioning status of the resource.
- Type string
- The type of the resource.
- Unique
Identifier string - The unique immutable identifier of a resource (Guid).
- azure
Api StringVersion - The Azure API version of the resource.
- created
Date String - The creation date of the disk.
- id String
- The provider-assigned unique ID for this managed resource.
- provisioning
State String - The provisioning status of the resource.
- type String
- The type of the resource.
- unique
Identifier String - The unique immutable identifier of a resource (Guid).
- azure
Api stringVersion - The Azure API version of the resource.
- created
Date string - The creation date of the disk.
- id string
- The provider-assigned unique ID for this managed resource.
- provisioning
State string - The provisioning status of the resource.
- type string
- The type of the resource.
- unique
Identifier string - The unique immutable identifier of a resource (Guid).
- azure_
api_ strversion - The Azure API version of the resource.
- created_
date str - The creation date of the disk.
- id str
- The provider-assigned unique ID for this managed resource.
- provisioning_
state str - The provisioning status of the resource.
- type str
- The type of the resource.
- unique_
identifier str - The unique immutable identifier of a resource (Guid).
- azure
Api StringVersion - The Azure API version of the resource.
- created
Date String - The creation date of the disk.
- id String
- The provider-assigned unique ID for this managed resource.
- provisioning
State String - The provisioning status of the resource.
- type String
- The type of the resource.
- unique
Identifier String - The unique immutable identifier of a resource (Guid).
Supporting Types
StorageType, StorageTypeArgs
- Standard
- Standard
- Premium
- Premium
- Standard
SSD - StandardSSD
- Storage
Type Standard - Standard
- Storage
Type Premium - Premium
- Storage
Type Standard SSD - StandardSSD
- Standard
- Standard
- Premium
- Premium
- Standard
SSD - StandardSSD
- Standard
- Standard
- Premium
- Premium
- Standard
SSD - StandardSSD
- STANDARD
- Standard
- PREMIUM
- Premium
- STANDARD_SSD
- StandardSSD
- "Standard"
- Standard
- "Premium"
- Premium
- "Standard
SSD" - StandardSSD
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:devtestlab:Disk {diskName} /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/users/{userName}/disks/{name}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0