We recommend using Azure Native.
Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi
azure.compute.getSnapshot
Explore with Pulumi AI
Use this data source to access information about an existing Snapshot.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = azure.compute.getSnapshot({
    name: "my-snapshot",
    resourceGroupName: "my-resource-group",
});
import pulumi
import pulumi_azure as azure
example = azure.compute.get_snapshot(name="my-snapshot",
    resource_group_name="my-resource-group")
package main
import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.LookupSnapshot(ctx, &compute.LookupSnapshotArgs{
			Name:              "my-snapshot",
			ResourceGroupName: "my-resource-group",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() => 
{
    var example = Azure.Compute.GetSnapshot.Invoke(new()
    {
        Name = "my-snapshot",
        ResourceGroupName = "my-resource-group",
    });
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.compute.ComputeFunctions;
import com.pulumi.azure.compute.inputs.GetSnapshotArgs;
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) {
        final var example = ComputeFunctions.getSnapshot(GetSnapshotArgs.builder()
            .name("my-snapshot")
            .resourceGroupName("my-resource-group")
            .build());
    }
}
variables:
  example:
    fn::invoke:
      function: azure:compute:getSnapshot
      arguments:
        name: my-snapshot
        resourceGroupName: my-resource-group
Using getSnapshot
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getSnapshot(args: GetSnapshotArgs, opts?: InvokeOptions): Promise<GetSnapshotResult>
function getSnapshotOutput(args: GetSnapshotOutputArgs, opts?: InvokeOptions): Output<GetSnapshotResult>def get_snapshot(name: Optional[str] = None,
                 resource_group_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(name: Optional[pulumi.Input[str]] = None,
                 resource_group_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetSnapshotResult]func LookupSnapshot(ctx *Context, args *LookupSnapshotArgs, opts ...InvokeOption) (*LookupSnapshotResult, error)
func LookupSnapshotOutput(ctx *Context, args *LookupSnapshotOutputArgs, opts ...InvokeOption) LookupSnapshotResultOutput> Note: This function is named LookupSnapshot in the Go SDK.
public static class GetSnapshot 
{
    public static Task<GetSnapshotResult> InvokeAsync(GetSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetSnapshotResult> Invoke(GetSnapshotInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
public static Output<GetSnapshotResult> getSnapshot(GetSnapshotArgs args, InvokeOptions options)
fn::invoke:
  function: azure:compute/getSnapshot:getSnapshot
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Name string
- Specifies the name of the Snapshot.
- ResourceGroup stringName 
- Specifies the name of the resource group the Snapshot is located in.
- Name string
- Specifies the name of the Snapshot.
- ResourceGroup stringName 
- Specifies the name of the resource group the Snapshot is located in.
- name String
- Specifies the name of the Snapshot.
- resourceGroup StringName 
- Specifies the name of the resource group the Snapshot is located in.
- name string
- Specifies the name of the Snapshot.
- resourceGroup stringName 
- Specifies the name of the resource group the Snapshot is located in.
- name str
- Specifies the name of the Snapshot.
- resource_group_ strname 
- Specifies the name of the resource group the Snapshot is located in.
- name String
- Specifies the name of the Snapshot.
- resourceGroup StringName 
- Specifies the name of the resource group the Snapshot is located in.
getSnapshot Result
The following output properties are available:
- CreationOption string
- DiskSize intGb 
- The size of the Snapshotted Disk in GB.
- EncryptionSettings List<GetSnapshot Encryption Setting> 
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- OsType string
- ResourceGroup stringName 
- SourceResource stringId 
- The reference to an existing snapshot.
- SourceUri string
- The URI to a Managed or Unmanaged Disk.
- StorageAccount stringId 
- The ID of an storage account.
- TimeCreated string
- TrustedLaunch boolEnabled 
- Whether Trusted Launch is enabled for the Snapshot.
- CreationOption string
- DiskSize intGb 
- The size of the Snapshotted Disk in GB.
- EncryptionSettings []GetSnapshot Encryption Setting 
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- OsType string
- ResourceGroup stringName 
- SourceResource stringId 
- The reference to an existing snapshot.
- SourceUri string
- The URI to a Managed or Unmanaged Disk.
- StorageAccount stringId 
- The ID of an storage account.
- TimeCreated string
- TrustedLaunch boolEnabled 
- Whether Trusted Launch is enabled for the Snapshot.
- creationOption String
- diskSize IntegerGb 
- The size of the Snapshotted Disk in GB.
- encryptionSettings List<GetSnapshot Encryption Setting> 
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- osType String
- resourceGroup StringName 
- sourceResource StringId 
- The reference to an existing snapshot.
- sourceUri String
- The URI to a Managed or Unmanaged Disk.
- storageAccount StringId 
- The ID of an storage account.
- timeCreated String
- trustedLaunch BooleanEnabled 
- Whether Trusted Launch is enabled for the Snapshot.
- creationOption string
- diskSize numberGb 
- The size of the Snapshotted Disk in GB.
- encryptionSettings GetSnapshot Encryption Setting[] 
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- osType string
- resourceGroup stringName 
- sourceResource stringId 
- The reference to an existing snapshot.
- sourceUri string
- The URI to a Managed or Unmanaged Disk.
- storageAccount stringId 
- The ID of an storage account.
- timeCreated string
- trustedLaunch booleanEnabled 
- Whether Trusted Launch is enabled for the Snapshot.
- creation_option str
- disk_size_ intgb 
- The size of the Snapshotted Disk in GB.
- encryption_settings Sequence[GetSnapshot Encryption Setting] 
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- os_type str
- resource_group_ strname 
- source_resource_ strid 
- The reference to an existing snapshot.
- source_uri str
- The URI to a Managed or Unmanaged Disk.
- storage_account_ strid 
- The ID of an storage account.
- time_created str
- trusted_launch_ boolenabled 
- Whether Trusted Launch is enabled for the Snapshot.
- creationOption String
- diskSize NumberGb 
- The size of the Snapshotted Disk in GB.
- encryptionSettings List<Property Map>
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- osType String
- resourceGroup StringName 
- sourceResource StringId 
- The reference to an existing snapshot.
- sourceUri String
- The URI to a Managed or Unmanaged Disk.
- storageAccount StringId 
- The ID of an storage account.
- timeCreated String
- trustedLaunch BooleanEnabled 
- Whether Trusted Launch is enabled for the Snapshot.
Supporting Types
GetSnapshotEncryptionSetting   
GetSnapshotEncryptionSettingDiskEncryptionKey      
- SecretUrl string
- SourceVault stringId 
- SecretUrl string
- SourceVault stringId 
- secretUrl String
- sourceVault StringId 
- secretUrl string
- sourceVault stringId 
- secret_url str
- source_vault_ strid 
- secretUrl String
- sourceVault StringId 
GetSnapshotEncryptionSettingKeyEncryptionKey      
- KeyUrl string
- SourceVault stringId 
- KeyUrl string
- SourceVault stringId 
- keyUrl String
- sourceVault StringId 
- keyUrl string
- sourceVault stringId 
- key_url str
- source_vault_ strid 
- keyUrl String
- sourceVault StringId 
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the azurermTerraform Provider.