1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. getSnapshot

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

azure.compute.getSnapshot

azure logo

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-azure

    Use this data source to access information about an existing Snapshot.

    Example Usage

    using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Azure.Compute.GetSnapshot.InvokeAsync(new Azure.Compute.GetSnapshotArgs
        {
            Name = "my-snapshot",
            ResourceGroupName = "my-resource-group",
        }));
    }

}

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/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
	})
}

    Example coming soon!

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

const example = pulumi.output(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")

    Example coming soon!

    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 dictionary

    The following arguments are supported:

    Name string
    Specifies the name of the Snapshot.
    ResourceGroupName string
    Specifies the name of the resource group the Snapshot is located in.
    Name string
    Specifies the name of the Snapshot.
    ResourceGroupName string
    Specifies the name of the resource group the Snapshot is located in.
    name String
    Specifies the name of the Snapshot.
    resourceGroupName String
    Specifies the name of the resource group the Snapshot is located in.
    name string
    Specifies the name of the Snapshot.
    resourceGroupName string
    Specifies the name of the resource group the Snapshot is located in.
    name str
    Specifies the name of the Snapshot.
    resource_group_name str
    Specifies the name of the resource group the Snapshot is located in.
    name String
    Specifies the name of the Snapshot.
    resourceGroupName String
    Specifies the name of the resource group the Snapshot is located in.

    getSnapshot Result

    The following output properties are available:

    CreationOption string
    DiskSizeGb int
    The size of the Snapshotted Disk in GB.
    EncryptionSettings List<GetSnapshotEncryptionSetting>
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    OsType string
    ResourceGroupName string
    SourceResourceId string
    The reference to an existing snapshot.
    SourceUri string
    The URI to a Managed or Unmanaged Disk.
    StorageAccountId string
    The ID of an storage account.
    TimeCreated string
    CreationOption string
    DiskSizeGb int
    The size of the Snapshotted Disk in GB.
    EncryptionSettings []GetSnapshotEncryptionSetting
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    OsType string
    ResourceGroupName string
    SourceResourceId string
    The reference to an existing snapshot.
    SourceUri string
    The URI to a Managed or Unmanaged Disk.
    StorageAccountId string
    The ID of an storage account.
    TimeCreated string
    creationOption String
    diskSizeGb Integer
    The size of the Snapshotted Disk in GB.
    encryptionSettings List<GetSnapshotEncryptionSetting>
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    osType String
    resourceGroupName String
    sourceResourceId String
    The reference to an existing snapshot.
    sourceUri String
    The URI to a Managed or Unmanaged Disk.
    storageAccountId String
    The ID of an storage account.
    timeCreated String
    creationOption string
    diskSizeGb number
    The size of the Snapshotted Disk in GB.
    encryptionSettings GetSnapshotEncryptionSetting[]
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    osType string
    resourceGroupName string
    sourceResourceId string
    The reference to an existing snapshot.
    sourceUri string
    The URI to a Managed or Unmanaged Disk.
    storageAccountId string
    The ID of an storage account.
    timeCreated string
    creation_option str
    disk_size_gb int
    The size of the Snapshotted Disk in GB.
    encryption_settings Sequence[GetSnapshotEncryptionSetting]
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    os_type str
    resource_group_name str
    source_resource_id str
    The reference to an existing snapshot.
    source_uri str
    The URI to a Managed or Unmanaged Disk.
    storage_account_id str
    The ID of an storage account.
    time_created str
    creationOption String
    diskSizeGb Number
    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
    resourceGroupName String
    sourceResourceId String
    The reference to an existing snapshot.
    sourceUri String
    The URI to a Managed or Unmanaged Disk.
    storageAccountId String
    The ID of an storage account.
    timeCreated String

    Supporting Types

    GetSnapshotEncryptionSetting

    GetSnapshotEncryptionSettingDiskEncryptionKey

    GetSnapshotEncryptionSettingKeyEncryptionKey

    KeyUrl string
    SourceVaultId string
    KeyUrl string
    SourceVaultId string
    keyUrl String
    sourceVaultId String
    keyUrl string
    sourceVaultId string
    keyUrl String
    sourceVaultId String

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Viewing docs for Azure v4.42.0 (Older version)
    published on Monday, Mar 9, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-azure
      Try Pulumi Cloud free. Your team will thank you.