azure-native.azurestackhci.getSnapshot

Azure Native v3.16.0, Mar 20 26

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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(resource_group_name: Optional[str] = None,
                 snapshot_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetSnapshotResult
def get_snapshot_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                 snapshot_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-native:azurestackhci:getSnapshot
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group. The name is case insensitive.
SnapshotName string: Name of the snapshot

ResourceGroupName string: The name of the resource group. The name is case insensitive.
SnapshotName string: Name of the snapshot

resourceGroupName String: The name of the resource group. The name is case insensitive.
snapshotName String: Name of the snapshot

resourceGroupName string: The name of the resource group. The name is case insensitive.
snapshotName string: Name of the snapshot

resource_group_name str: The name of the resource group. The name is case insensitive.
snapshot_name str: Name of the snapshot

resourceGroupName String: The name of the resource group. The name is case insensitive.
snapshotName String: Name of the snapshot

getSnapshot Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
Properties Pulumi.AzureNative.AzureStackHCI.Outputs.SnapshotPropertiesResponse: The resource-specific properties for this resource.
SystemData Pulumi.AzureNative.AzureStackHCI.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ExtendedLocation Pulumi.AzureNative.AzureStackHCI.Outputs.ExtendedLocationResponse: The extendedLocation of the resource.
Tags Dictionary<string, string>: Resource tags.

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
Properties SnapshotPropertiesResponse: The resource-specific properties for this resource.
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
ExtendedLocation ExtendedLocationResponse: The extendedLocation of the resource.
Tags map[string]string: Resource tags.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
properties SnapshotPropertiesResponse: The resource-specific properties for this resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
extendedLocation ExtendedLocationResponse: The extendedLocation of the resource.
tags Map<String,String>: Resource tags.

azureApiVersion string: The Azure API version of the resource.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string: The geo-location where the resource lives
name string: The name of the resource
properties SnapshotPropertiesResponse: The resource-specific properties for this resource.
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
extendedLocation ExtendedLocationResponse: The extendedLocation of the resource.
tags {[key: string]: string}: Resource tags.

azure_api_version str: The Azure API version of the resource.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str: The geo-location where the resource lives
name str: The name of the resource
properties SnapshotPropertiesResponse: The resource-specific properties for this resource.
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
extended_location ExtendedLocationResponse: The extendedLocation of the resource.
tags Mapping[str, str]: Resource tags.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
properties Property Map: The resource-specific properties for this resource.
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
extendedLocation Property Map: The extendedLocation of the resource.
tags Map<String>: Resource tags.

Supporting Types

CreationDataResponse

CreateOption string: This enumerates the possible sources of a disk's creation
SourceUniqueId string: Unique ID of the source resource used for disk creation. Read-only and not required for disk creation.
SourceResourceId string: ARM ID of the source resource used for disk creation. Required when createOption is Copy

CreateOption string: This enumerates the possible sources of a disk's creation
SourceUniqueId string: Unique ID of the source resource used for disk creation. Read-only and not required for disk creation.
SourceResourceId string: ARM ID of the source resource used for disk creation. Required when createOption is Copy

createOption String: This enumerates the possible sources of a disk's creation
sourceUniqueId String: Unique ID of the source resource used for disk creation. Read-only and not required for disk creation.
sourceResourceId String: ARM ID of the source resource used for disk creation. Required when createOption is Copy

createOption string: This enumerates the possible sources of a disk's creation
sourceUniqueId string: Unique ID of the source resource used for disk creation. Read-only and not required for disk creation.
sourceResourceId string: ARM ID of the source resource used for disk creation. Required when createOption is Copy

create_option str: This enumerates the possible sources of a disk's creation
source_unique_id str: Unique ID of the source resource used for disk creation. Read-only and not required for disk creation.
source_resource_id str: ARM ID of the source resource used for disk creation. Required when createOption is Copy

createOption String: This enumerates the possible sources of a disk's creation
sourceUniqueId String: Unique ID of the source resource used for disk creation. Read-only and not required for disk creation.
sourceResourceId String: ARM ID of the source resource used for disk creation. Required when createOption is Copy

ExtendedLocationResponse

Name string: The name of the extended location.
Type string: The type of the extended location.

Name string: The name of the extended location.
Type string: The type of the extended location.

name String: The name of the extended location.
type String: The type of the extended location.

name string: The name of the extended location.
type string: The type of the extended location.

name str: The name of the extended location.
type str: The type of the extended location.

name String: The name of the extended location.
type String: The type of the extended location.

SnapshotPropertiesResponse

DiskSizeBytes double: The size of the disk in bytes.
ProvisioningState string: Provisioning state of the snapshot.
Status Pulumi.AzureNative.AzureStackHCI.Inputs.SnapshotStatusResponse: The observed state of snapshots
TimeCreated string: The time when the snapshot was created.
UniqueId string: Unique identifier for the snapshot.
CreationData Pulumi.AzureNative.AzureStackHCI.Inputs.CreationDataResponse: Data used when creating a snapshot

DiskSizeBytes float64: The size of the disk in bytes.
ProvisioningState string: Provisioning state of the snapshot.
Status SnapshotStatusResponse: The observed state of snapshots
TimeCreated string: The time when the snapshot was created.
UniqueId string: Unique identifier for the snapshot.
CreationData CreationDataResponse: Data used when creating a snapshot

diskSizeBytes Double: The size of the disk in bytes.
provisioningState String: Provisioning state of the snapshot.
status SnapshotStatusResponse: The observed state of snapshots
timeCreated String: The time when the snapshot was created.
uniqueId String: Unique identifier for the snapshot.
creationData CreationDataResponse: Data used when creating a snapshot

diskSizeBytes number: The size of the disk in bytes.
provisioningState string: Provisioning state of the snapshot.
status SnapshotStatusResponse: The observed state of snapshots
timeCreated string: The time when the snapshot was created.
uniqueId string: Unique identifier for the snapshot.
creationData CreationDataResponse: Data used when creating a snapshot

disk_size_bytes float: The size of the disk in bytes.
provisioning_state str: Provisioning state of the snapshot.
status SnapshotStatusResponse: The observed state of snapshots
time_created str: The time when the snapshot was created.
unique_id str: Unique identifier for the snapshot.
creation_data CreationDataResponse: Data used when creating a snapshot

diskSizeBytes Number: The size of the disk in bytes.
provisioningState String: Provisioning state of the snapshot.
status Property Map: The observed state of snapshots
timeCreated String: The time when the snapshot was created.
uniqueId String: Unique identifier for the snapshot.
creationData Property Map: Data used when creating a snapshot

SnapshotStatusProvisioningStatusResponse

Status string: The status of the operation performed on the snapshot [Succeeded, Failed, InProgress]
OperationId string: The ID of the operation performed on the snapshot

Status string: The status of the operation performed on the snapshot [Succeeded, Failed, InProgress]
OperationId string: The ID of the operation performed on the snapshot

status String: The status of the operation performed on the snapshot [Succeeded, Failed, InProgress]
operationId String: The ID of the operation performed on the snapshot

status string: The status of the operation performed on the snapshot [Succeeded, Failed, InProgress]
operationId string: The ID of the operation performed on the snapshot

status str: The status of the operation performed on the snapshot [Succeeded, Failed, InProgress]
operation_id str: The ID of the operation performed on the snapshot

status String: The status of the operation performed on the snapshot [Succeeded, Failed, InProgress]
operationId String: The ID of the operation performed on the snapshot

SnapshotStatusResponse

ErrorCode string: Snapshot provisioning error code
ErrorMessage string: Descriptive error message
ProvisioningStatus Pulumi.AzureNative.AzureStackHCI.Inputs.SnapshotStatusProvisioningStatusResponse: Provisioning status of the snapshot

ErrorCode string: Snapshot provisioning error code
ErrorMessage string: Descriptive error message
ProvisioningStatus SnapshotStatusProvisioningStatusResponse: Provisioning status of the snapshot

errorCode String: Snapshot provisioning error code
errorMessage String: Descriptive error message
provisioningStatus SnapshotStatusProvisioningStatusResponse: Provisioning status of the snapshot

errorCode string: Snapshot provisioning error code
errorMessage string: Descriptive error message
provisioningStatus SnapshotStatusProvisioningStatusResponse: Provisioning status of the snapshot

error_code str: Snapshot provisioning error code
error_message str: Descriptive error message
provisioning_status SnapshotStatusProvisioningStatusResponse: Provisioning status of the snapshot

errorCode String: Snapshot provisioning error code
errorMessage String: Descriptive error message
provisioningStatus Property Map: Provisioning status of the snapshot

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.