Azure Classic v5.43.0, May 6 23

azure.compute.Snapshot

Explore with Pulumi AI

Manages a Disk Snapshot.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
    {
        Location = "West Europe",
    });

    var exampleManagedDisk = new Azure.Compute.ManagedDisk("exampleManagedDisk", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        StorageAccountType = "Standard_LRS",
        CreateOption = "Empty",
        DiskSizeGb = 10,
    });

    var exampleSnapshot = new Azure.Compute.Snapshot("exampleSnapshot", new()
    {
        Location = exampleResourceGroup.Location,
        ResourceGroupName = exampleResourceGroup.Name,
        CreateOption = "Copy",
        SourceUri = exampleManagedDisk.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/compute"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleManagedDisk, err := compute.NewManagedDisk(ctx, "exampleManagedDisk", &compute.ManagedDiskArgs{
			Location:           exampleResourceGroup.Location,
			ResourceGroupName:  exampleResourceGroup.Name,
			StorageAccountType: pulumi.String("Standard_LRS"),
			CreateOption:       pulumi.String("Empty"),
			DiskSizeGb:         pulumi.Int(10),
		})
		if err != nil {
			return err
		}
		_, err = compute.NewSnapshot(ctx, "exampleSnapshot", &compute.SnapshotArgs{
			Location:          exampleResourceGroup.Location,
			ResourceGroupName: exampleResourceGroup.Name,
			CreateOption:      pulumi.String("Copy"),
			SourceUri:         exampleManagedDisk.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.compute.ManagedDisk;
import com.pulumi.azure.compute.ManagedDiskArgs;
import com.pulumi.azure.compute.Snapshot;
import com.pulumi.azure.compute.SnapshotArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleManagedDisk = new ManagedDisk("exampleManagedDisk", ManagedDiskArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .storageAccountType("Standard_LRS")
            .createOption("Empty")
            .diskSizeGb("10")
            .build());

        var exampleSnapshot = new Snapshot("exampleSnapshot", SnapshotArgs.builder()        
            .location(exampleResourceGroup.location())
            .resourceGroupName(exampleResourceGroup.name())
            .createOption("Copy")
            .sourceUri(exampleManagedDisk.id())
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_managed_disk = azure.compute.ManagedDisk("exampleManagedDisk",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    storage_account_type="Standard_LRS",
    create_option="Empty",
    disk_size_gb=10)
example_snapshot = azure.compute.Snapshot("exampleSnapshot",
    location=example_resource_group.location,
    resource_group_name=example_resource_group.name,
    create_option="Copy",
    source_uri=example_managed_disk.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleManagedDisk = new azure.compute.ManagedDisk("exampleManagedDisk", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    storageAccountType: "Standard_LRS",
    createOption: "Empty",
    diskSizeGb: 10,
});
const exampleSnapshot = new azure.compute.Snapshot("exampleSnapshot", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    createOption: "Copy",
    sourceUri: exampleManagedDisk.id,
});

resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleManagedDisk:
    type: azure:compute:ManagedDisk
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      storageAccountType: Standard_LRS
      createOption: Empty
      diskSizeGb: '10'
  exampleSnapshot:
    type: azure:compute:Snapshot
    properties:
      location: ${exampleResourceGroup.location}
      resourceGroupName: ${exampleResourceGroup.name}
      createOption: Copy
      sourceUri: ${exampleManagedDisk.id}

Create Snapshot Resource

new Snapshot(name: string, args: SnapshotArgs, opts?: CustomResourceOptions);

@overload
def Snapshot(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             create_option: Optional[str] = None,
             disk_size_gb: Optional[int] = None,
             encryption_settings: Optional[SnapshotEncryptionSettingsArgs] = None,
             incremental_enabled: Optional[bool] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             source_resource_id: Optional[str] = None,
             source_uri: Optional[str] = None,
             storage_account_id: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
@overload
def Snapshot(resource_name: str,
             args: SnapshotArgs,
             opts: Optional[ResourceOptions] = None)

func NewSnapshot(ctx *Context, name string, args SnapshotArgs, opts ...ResourceOption) (*Snapshot, error)

public Snapshot(string name, SnapshotArgs args, CustomResourceOptions? opts = null)

public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)

type: azure:compute:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SnapshotArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args SnapshotArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args SnapshotArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args SnapshotArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args SnapshotArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Snapshot Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Snapshot resource accepts the following input properties:

CreateOption string: Indicates how the snapshot is to be created. Possible values are Copy or Import.
ResourceGroupName string: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
DiskSizeGb int: The size of the Snapshotted Disk in GB.
EncryptionSettings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
IncrementalEnabled bool: Specifies if the Snapshot is incremental.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
SourceResourceId string: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
SourceUri string: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
StorageAccountId string: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

CreateOption string: Indicates how the snapshot is to be created. Possible values are Copy or Import.
ResourceGroupName string: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
DiskSizeGb int: The size of the Snapshotted Disk in GB.
EncryptionSettings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
IncrementalEnabled bool: Specifies if the Snapshot is incremental.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
SourceResourceId string: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
SourceUri string: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
StorageAccountId string: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.

createOption String: Indicates how the snapshot is to be created. Possible values are Copy or Import.
resourceGroupName String: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
diskSizeGb Integer: The size of the Snapshotted Disk in GB.
encryptionSettings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
incrementalEnabled Boolean: Specifies if the Snapshot is incremental.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
sourceResourceId String: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
sourceUri String: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
storageAccountId String: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
tags Map<String,String>: A mapping of tags to assign to the resource.

createOption string: Indicates how the snapshot is to be created. Possible values are Copy or Import.
resourceGroupName string: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
diskSizeGb number: The size of the Snapshotted Disk in GB.
encryptionSettings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
incrementalEnabled boolean: Specifies if the Snapshot is incremental.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
sourceResourceId string: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
sourceUri string: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
storageAccountId string: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

create_option str: Indicates how the snapshot is to be created. Possible values are Copy or Import.
resource_group_name str: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
disk_size_gb int: The size of the Snapshotted Disk in GB.
encryption_settings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
incremental_enabled bool: Specifies if the Snapshot is incremental.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
source_resource_id str: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
source_uri str: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
storage_account_id str: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
tags Mapping[str, str]: A mapping of tags to assign to the resource.

createOption String: Indicates how the snapshot is to be created. Possible values are Copy or Import.
resourceGroupName String: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
diskSizeGb Number: The size of the Snapshotted Disk in GB.
encryptionSettings Property Map: A encryption_settings block as defined below.
incrementalEnabled Boolean: Specifies if the Snapshot is incremental.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
sourceResourceId String: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
sourceUri String: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
storageAccountId String: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
tags Map<String>: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
TrustedLaunchEnabled bool: Whether Trusted Launch is enabled for the Snapshot.

Id string: The provider-assigned unique ID for this managed resource.
TrustedLaunchEnabled bool: Whether Trusted Launch is enabled for the Snapshot.

id String: The provider-assigned unique ID for this managed resource.
trustedLaunchEnabled Boolean: Whether Trusted Launch is enabled for the Snapshot.

id string: The provider-assigned unique ID for this managed resource.
trustedLaunchEnabled boolean: Whether Trusted Launch is enabled for the Snapshot.

id str: The provider-assigned unique ID for this managed resource.
trusted_launch_enabled bool: Whether Trusted Launch is enabled for the Snapshot.

id String: The provider-assigned unique ID for this managed resource.
trustedLaunchEnabled Boolean: Whether Trusted Launch is enabled for the Snapshot.

Look up Existing Snapshot Resource

Get an existing Snapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SnapshotState, opts?: CustomResourceOptions): Snapshot

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        create_option: Optional[str] = None,
        disk_size_gb: Optional[int] = None,
        encryption_settings: Optional[SnapshotEncryptionSettingsArgs] = None,
        incremental_enabled: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        source_resource_id: Optional[str] = None,
        source_uri: Optional[str] = None,
        storage_account_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        trusted_launch_enabled: Optional[bool] = None) -> Snapshot

func GetSnapshot(ctx *Context, name string, id IDInput, state *SnapshotState, opts ...ResourceOption) (*Snapshot, error)

public static Snapshot Get(string name, Input<string> id, SnapshotState? state, CustomResourceOptions? opts = null)

public static Snapshot get(String name, Output<String> id, SnapshotState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CreateOption string: Indicates how the snapshot is to be created. Possible values are Copy or Import.
DiskSizeGb int: The size of the Snapshotted Disk in GB.
EncryptionSettings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
IncrementalEnabled bool: Specifies if the Snapshot is incremental.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
SourceResourceId string: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
SourceUri string: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
StorageAccountId string: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
TrustedLaunchEnabled bool: Whether Trusted Launch is enabled for the Snapshot.

CreateOption string: Indicates how the snapshot is to be created. Possible values are Copy or Import.
DiskSizeGb int: The size of the Snapshotted Disk in GB.
EncryptionSettings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
IncrementalEnabled bool: Specifies if the Snapshot is incremental.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
SourceResourceId string: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
SourceUri string: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
StorageAccountId string: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
TrustedLaunchEnabled bool: Whether Trusted Launch is enabled for the Snapshot.

createOption String: Indicates how the snapshot is to be created. Possible values are Copy or Import.
diskSizeGb Integer: The size of the Snapshotted Disk in GB.
encryptionSettings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
incrementalEnabled Boolean: Specifies if the Snapshot is incremental.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
sourceResourceId String: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
sourceUri String: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
storageAccountId String: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
tags Map<String,String>: A mapping of tags to assign to the resource.
trustedLaunchEnabled Boolean: Whether Trusted Launch is enabled for the Snapshot.

createOption string: Indicates how the snapshot is to be created. Possible values are Copy or Import.
diskSizeGb number: The size of the Snapshotted Disk in GB.
encryptionSettings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
incrementalEnabled boolean: Specifies if the Snapshot is incremental.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
sourceResourceId string: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
sourceUri string: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
storageAccountId string: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
trustedLaunchEnabled boolean: Whether Trusted Launch is enabled for the Snapshot.

create_option str: Indicates how the snapshot is to be created. Possible values are Copy or Import.
disk_size_gb int: The size of the Snapshotted Disk in GB.
encryption_settings SnapshotEncryptionSettingsArgs: A encryption_settings block as defined below.
incremental_enabled bool: Specifies if the Snapshot is incremental.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
source_resource_id str: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
source_uri str: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
storage_account_id str: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
tags Mapping[str, str]: A mapping of tags to assign to the resource.
trusted_launch_enabled bool: Whether Trusted Launch is enabled for the Snapshot.

createOption String: Indicates how the snapshot is to be created. Possible values are Copy or Import.
diskSizeGb Number: The size of the Snapshotted Disk in GB.
encryptionSettings Property Map: A encryption_settings block as defined below.
incrementalEnabled Boolean: Specifies if the Snapshot is incremental.
location String: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name String: Specifies the name of the Snapshot resource. Changing this forces a new resource to be created.
resourceGroupName String: The name of the resource group in which to create the Snapshot. Changing this forces a new resource to be created.
sourceResourceId String: Specifies a reference to an existing snapshot, when create_option is Copy. Changing this forces a new resource to be created.
sourceUri String: Specifies the URI to a Managed or Unmanaged Disk. Changing this forces a new resource to be created.
storageAccountId String: Specifies the ID of an storage account. Used with source_uri to allow authorization during import of unmanaged blobs from a different subscription. Changing this forces a new resource to be created.
tags Map<String>: A mapping of tags to assign to the resource.
trustedLaunchEnabled Boolean: Whether Trusted Launch is enabled for the Snapshot.

Supporting Types

SnapshotEncryptionSettings

DiskEncryptionKey SnapshotEncryptionSettingsDiskEncryptionKey

A disk_encryption_key block as defined below.

Enabled bool

Deprecated:

Deprecated, Azure Disk Encryption is now configured directly by disk_encryption_key and key_encryption_key. To disable Azure Disk Encryption, please remove encryption_settings block. To enabled, specify a encryption_settings block`

KeyEncryptionKey SnapshotEncryptionSettingsKeyEncryptionKey