Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. elasticsan
  5. getVolumeSnapshot
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.elasticsan.getVolumeSnapshot

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a Volume Snapshot. Azure REST API version: 2023-01-01.

Other available API versions: 2024-05-01, 2024-06-01-preview.

Using getVolumeSnapshot

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 getVolumeSnapshot(args: GetVolumeSnapshotArgs, opts?: InvokeOptions): Promise<GetVolumeSnapshotResult>
function getVolumeSnapshotOutput(args: GetVolumeSnapshotOutputArgs, opts?: InvokeOptions): Output<GetVolumeSnapshotResult>
Copy
def get_volume_snapshot(elastic_san_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        snapshot_name: Optional[str] = None,
                        volume_group_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetVolumeSnapshotResult
def get_volume_snapshot_output(elastic_san_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        snapshot_name: Optional[pulumi.Input[str]] = None,
                        volume_group_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetVolumeSnapshotResult]
Copy
func LookupVolumeSnapshot(ctx *Context, args *LookupVolumeSnapshotArgs, opts ...InvokeOption) (*LookupVolumeSnapshotResult, error)
func LookupVolumeSnapshotOutput(ctx *Context, args *LookupVolumeSnapshotOutputArgs, opts ...InvokeOption) LookupVolumeSnapshotResultOutput
Copy

> Note: This function is named LookupVolumeSnapshot in the Go SDK.

public static class GetVolumeSnapshot 
{
    public static Task<GetVolumeSnapshotResult> InvokeAsync(GetVolumeSnapshotArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeSnapshotResult> Invoke(GetVolumeSnapshotInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVolumeSnapshotResult> getVolumeSnapshot(GetVolumeSnapshotArgs args, InvokeOptions options)
public static Output<GetVolumeSnapshotResult> getVolumeSnapshot(GetVolumeSnapshotArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:elasticsan:getVolumeSnapshot
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ElasticSanName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ElasticSan.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SnapshotName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume snapshot within the given volume group.
VolumeGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VolumeGroup.
ElasticSanName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ElasticSan.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SnapshotName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume snapshot within the given volume group.
VolumeGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VolumeGroup.
elasticSanName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ElasticSan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
snapshotName
This property is required.
Changes to this property will trigger replacement.
String
The name of the volume snapshot within the given volume group.
volumeGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the VolumeGroup.
elasticSanName
This property is required.
Changes to this property will trigger replacement.
string
The name of the ElasticSan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
snapshotName
This property is required.
Changes to this property will trigger replacement.
string
The name of the volume snapshot within the given volume group.
volumeGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the VolumeGroup.
elastic_san_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the ElasticSan.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
snapshot_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the volume snapshot within the given volume group.
volume_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the VolumeGroup.
elasticSanName
This property is required.
Changes to this property will trigger replacement.
String
The name of the ElasticSan.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
snapshotName
This property is required.
Changes to this property will trigger replacement.
String
The name of the volume snapshot within the given volume group.
volumeGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the VolumeGroup.

getVolumeSnapshot Result

The following output properties are available:

CreationData Pulumi.AzureNative.ElasticSan.Outputs.SnapshotCreationDataResponse
Data used when creating a volume snapshot.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
State of the operation on the resource.
SourceVolumeSizeGiB double
Size of Source Volume
SystemData Pulumi.AzureNative.ElasticSan.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"
VolumeName string
Source Volume Name of a snapshot
CreationData SnapshotCreationDataResponse
Data used when creating a volume snapshot.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
ProvisioningState string
State of the operation on the resource.
SourceVolumeSizeGiB float64
Size of Source Volume
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"
VolumeName string
Source Volume Name of a snapshot
creationData SnapshotCreationDataResponse
Data used when creating a volume snapshot.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
State of the operation on the resource.
sourceVolumeSizeGiB Double
Size of Source Volume
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"
volumeName String
Source Volume Name of a snapshot
creationData SnapshotCreationDataResponse
Data used when creating a volume snapshot.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
provisioningState string
State of the operation on the resource.
sourceVolumeSizeGiB number
Size of Source Volume
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"
volumeName string
Source Volume Name of a snapshot
creation_data SnapshotCreationDataResponse
Data used when creating a volume snapshot.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
provisioning_state str
State of the operation on the resource.
source_volume_size_gi_b float
Size of Source Volume
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"
volume_name str
Source Volume Name of a snapshot
creationData Property Map
Data used when creating a volume snapshot.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
provisioningState String
State of the operation on the resource.
sourceVolumeSizeGiB Number
Size of Source Volume
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"
volumeName String
Source Volume Name of a snapshot

Supporting Types

SnapshotCreationDataResponse

SourceId This property is required. string
Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}"
SourceId This property is required. string
Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}"
sourceId This property is required. String
Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}"
sourceId This property is required. string
Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}"
source_id This property is required. str
Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}"
sourceId This property is required. String
Fully qualified resource ID of the volume. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ElasticSan/elasticSans/{elasticSanName}/volumegroups/{volumeGroupName}/volumes/{volumeName}"

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.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native