Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. storsimple
  5. getVolume
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.storsimple.getVolume

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

Returns the properties of the specified volume name. Azure REST API version: 2017-06-01.

Using getVolume

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 getVolume(args: GetVolumeArgs, opts?: InvokeOptions): Promise<GetVolumeResult>
function getVolumeOutput(args: GetVolumeOutputArgs, opts?: InvokeOptions): Output<GetVolumeResult>
Copy
def get_volume(device_name: Optional[str] = None,
               manager_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               volume_container_name: Optional[str] = None,
               volume_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(device_name: Optional[pulumi.Input[str]] = None,
               manager_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               volume_container_name: Optional[pulumi.Input[str]] = None,
               volume_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]
Copy
func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput
Copy

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

public static class GetVolume 
{
    public static Task<GetVolumeResult> InvokeAsync(GetVolumeArgs args, InvokeOptions? opts = null)
    public static Output<GetVolumeResult> Invoke(GetVolumeInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storsimple:getVolume
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name
ManagerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
VolumeContainerName
This property is required.
Changes to this property will trigger replacement.
string
The volume container name.
VolumeName
This property is required.
Changes to this property will trigger replacement.
string
The volume name.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name
ManagerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
VolumeContainerName
This property is required.
Changes to this property will trigger replacement.
string
The volume container name.
VolumeName
This property is required.
Changes to this property will trigger replacement.
string
The volume name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name
managerName
This property is required.
Changes to this property will trigger replacement.
String
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name
volumeContainerName
This property is required.
Changes to this property will trigger replacement.
String
The volume container name.
volumeName
This property is required.
Changes to this property will trigger replacement.
String
The volume name.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name
managerName
This property is required.
Changes to this property will trigger replacement.
string
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name
volumeContainerName
This property is required.
Changes to this property will trigger replacement.
string
The volume container name.
volumeName
This property is required.
Changes to this property will trigger replacement.
string
The volume name.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name
manager_name
This property is required.
Changes to this property will trigger replacement.
str
The manager name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name
volume_container_name
This property is required.
Changes to this property will trigger replacement.
str
The volume container name.
volume_name
This property is required.
Changes to this property will trigger replacement.
str
The volume name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name
managerName
This property is required.
Changes to this property will trigger replacement.
String
The manager name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name
volumeContainerName
This property is required.
Changes to this property will trigger replacement.
String
The volume container name.
volumeName
This property is required.
Changes to this property will trigger replacement.
String
The volume name.

getVolume Result

The following output properties are available:

AccessControlRecordIds List<string>
The IDs of the access control records, associated with the volume.
BackupPolicyIds List<string>
The IDs of the backup policies, in which this volume is part of.
BackupStatus string
The backup status of the volume.
Id string
The path ID that uniquely identifies the object.
MonitoringStatus string
The monitoring status of the volume.
Name string
The name of the object.
OperationStatus string
The operation status on the volume.
SizeInBytes double
The size of the volume in bytes.
Type string
The hierarchical type of the object.
VolumeContainerId string
The ID of the volume container, in which this volume is created.
VolumeStatus string
The volume status.
VolumeType string
The type of the volume.
Kind string
The Kind of the object. Currently only Series8000 is supported
AccessControlRecordIds []string
The IDs of the access control records, associated with the volume.
BackupPolicyIds []string
The IDs of the backup policies, in which this volume is part of.
BackupStatus string
The backup status of the volume.
Id string
The path ID that uniquely identifies the object.
MonitoringStatus string
The monitoring status of the volume.
Name string
The name of the object.
OperationStatus string
The operation status on the volume.
SizeInBytes float64
The size of the volume in bytes.
Type string
The hierarchical type of the object.
VolumeContainerId string
The ID of the volume container, in which this volume is created.
VolumeStatus string
The volume status.
VolumeType string
The type of the volume.
Kind string
The Kind of the object. Currently only Series8000 is supported
accessControlRecordIds List<String>
The IDs of the access control records, associated with the volume.
backupPolicyIds List<String>
The IDs of the backup policies, in which this volume is part of.
backupStatus String
The backup status of the volume.
id String
The path ID that uniquely identifies the object.
monitoringStatus String
The monitoring status of the volume.
name String
The name of the object.
operationStatus String
The operation status on the volume.
sizeInBytes Double
The size of the volume in bytes.
type String
The hierarchical type of the object.
volumeContainerId String
The ID of the volume container, in which this volume is created.
volumeStatus String
The volume status.
volumeType String
The type of the volume.
kind String
The Kind of the object. Currently only Series8000 is supported
accessControlRecordIds string[]
The IDs of the access control records, associated with the volume.
backupPolicyIds string[]
The IDs of the backup policies, in which this volume is part of.
backupStatus string
The backup status of the volume.
id string
The path ID that uniquely identifies the object.
monitoringStatus string
The monitoring status of the volume.
name string
The name of the object.
operationStatus string
The operation status on the volume.
sizeInBytes number
The size of the volume in bytes.
type string
The hierarchical type of the object.
volumeContainerId string
The ID of the volume container, in which this volume is created.
volumeStatus string
The volume status.
volumeType string
The type of the volume.
kind string
The Kind of the object. Currently only Series8000 is supported
access_control_record_ids Sequence[str]
The IDs of the access control records, associated with the volume.
backup_policy_ids Sequence[str]
The IDs of the backup policies, in which this volume is part of.
backup_status str
The backup status of the volume.
id str
The path ID that uniquely identifies the object.
monitoring_status str
The monitoring status of the volume.
name str
The name of the object.
operation_status str
The operation status on the volume.
size_in_bytes float
The size of the volume in bytes.
type str
The hierarchical type of the object.
volume_container_id str
The ID of the volume container, in which this volume is created.
volume_status str
The volume status.
volume_type str
The type of the volume.
kind str
The Kind of the object. Currently only Series8000 is supported
accessControlRecordIds List<String>
The IDs of the access control records, associated with the volume.
backupPolicyIds List<String>
The IDs of the backup policies, in which this volume is part of.
backupStatus String
The backup status of the volume.
id String
The path ID that uniquely identifies the object.
monitoringStatus String
The monitoring status of the volume.
name String
The name of the object.
operationStatus String
The operation status on the volume.
sizeInBytes Number
The size of the volume in bytes.
type String
The hierarchical type of the object.
volumeContainerId String
The ID of the volume container, in which this volume is created.
volumeStatus String
The volume status.
volumeType String
The type of the volume.
kind String
The Kind of the object. Currently only Series8000 is supported

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