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

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

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(pool_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               volume_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(pool_name: Optional[pulumi.Input[str]] = None,
               resource_group_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:containerstorage:getVolume
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

PoolName
This property is required.
Changes to this property will trigger replacement.
string
Pool Object
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VolumeName
This property is required.
Changes to this property will trigger replacement.
string
Volume Resource
PoolName
This property is required.
Changes to this property will trigger replacement.
string
Pool Object
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
VolumeName
This property is required.
Changes to this property will trigger replacement.
string
Volume Resource
poolName
This property is required.
Changes to this property will trigger replacement.
String
Pool Object
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
String
Volume Resource
poolName
This property is required.
Changes to this property will trigger replacement.
string
Pool Object
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
string
Volume Resource
pool_name
This property is required.
Changes to this property will trigger replacement.
str
Pool Object
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.
volume_name
This property is required.
Changes to this property will trigger replacement.
str
Volume Resource
poolName
This property is required.
Changes to this property will trigger replacement.
String
Pool Object
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
volumeName
This property is required.
Changes to this property will trigger replacement.
String
Volume Resource

getVolume Result

The following output properties are available:

CapacityGiB double
Requested capacity in GiB
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Labels Dictionary<string, string>
String KV pairs indicating labels
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
Status Pulumi.AzureNative.ContainerStorage.Outputs.ResourceOperationalStatusResponse
The status of the resource.
SystemData Pulumi.AzureNative.ContainerStorage.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"
VolumeType Pulumi.AzureNative.ContainerStorage.Outputs.VolumeTypeResponse
Properties of the volume
CapacityGiB float64
Requested capacity in GiB
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Labels map[string]string
String KV pairs indicating labels
Name string
The name of the resource
ProvisioningState string
The status of the last operation.
Status ResourceOperationalStatusResponse
The status of the 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"
VolumeType VolumeTypeResponse
Properties of the volume
capacityGiB Double
Requested capacity in GiB
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
labels Map<String,String>
String KV pairs indicating labels
name String
The name of the resource
provisioningState String
The status of the last operation.
status ResourceOperationalStatusResponse
The status of the 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"
volumeType VolumeTypeResponse
Properties of the volume
capacityGiB number
Requested capacity in GiB
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
labels {[key: string]: string}
String KV pairs indicating labels
name string
The name of the resource
provisioningState string
The status of the last operation.
status ResourceOperationalStatusResponse
The status of the 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"
volumeType VolumeTypeResponse
Properties of the volume
capacity_gi_b float
Requested capacity in GiB
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
labels Mapping[str, str]
String KV pairs indicating labels
name str
The name of the resource
provisioning_state str
The status of the last operation.
status ResourceOperationalStatusResponse
The status of the 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"
volume_type VolumeTypeResponse
Properties of the volume
capacityGiB Number
Requested capacity in GiB
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
labels Map<String>
String KV pairs indicating labels
name String
The name of the resource
provisioningState String
The status of the last operation.
status Property Map
The status of the 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"
volumeType Property Map
Properties of the volume

Supporting Types

ElasticSanVolumePropertiesResponse

TargetIqn This property is required. string
iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
TargetPortalHostname This property is required. string
iSCSI Target Portal Host Name
TargetPortalPort This property is required. int
iSCSI Target Portal Port
TargetIqn This property is required. string
iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
TargetPortalHostname This property is required. string
iSCSI Target Portal Host Name
TargetPortalPort This property is required. int
iSCSI Target Portal Port
targetIqn This property is required. String
iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
targetPortalHostname This property is required. String
iSCSI Target Portal Host Name
targetPortalPort This property is required. Integer
iSCSI Target Portal Port
targetIqn This property is required. string
iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
targetPortalHostname This property is required. string
iSCSI Target Portal Host Name
targetPortalPort This property is required. number
iSCSI Target Portal Port
target_iqn This property is required. str
iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
target_portal_hostname This property is required. str
iSCSI Target Portal Host Name
target_portal_port This property is required. int
iSCSI Target Portal Port
targetIqn This property is required. String
iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server"
targetPortalHostname This property is required. String
iSCSI Target Portal Host Name
targetPortalPort This property is required. Number
iSCSI Target Portal Port

ResourceOperationalStatusResponse

State This property is required. string
state of the resource
Message string
Reason for state.
State This property is required. string
state of the resource
Message string
Reason for state.
state This property is required. String
state of the resource
message String
Reason for state.
state This property is required. string
state of the resource
message string
Reason for state.
state This property is required. str
state of the resource
message str
Reason for state.
state This property is required. String
state of the resource
message String
Reason for state.

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.

VolumeTypeResponse

ElasticSan This property is required. Pulumi.AzureNative.ContainerStorage.Inputs.ElasticSanVolumePropertiesResponse
Properties of the ElasticSAN iSCSI target
ElasticSan This property is required. ElasticSanVolumePropertiesResponse
Properties of the ElasticSAN iSCSI target
elasticSan This property is required. ElasticSanVolumePropertiesResponse
Properties of the ElasticSAN iSCSI target
elasticSan This property is required. ElasticSanVolumePropertiesResponse
Properties of the ElasticSAN iSCSI target
elastic_san This property is required. ElasticSanVolumePropertiesResponse
Properties of the ElasticSAN iSCSI target
elasticSan This property is required. Property Map
Properties of the ElasticSAN iSCSI target

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