azure-native.elasticsan.getVolume
Explore with Pulumi AI
Get an Volume.
Uses Azure REST API version 2024-05-01.
Other available API versions: 2021-11-20-preview, 2022-12-01-preview, 2023-01-01, 2024-06-01-preview, 2024-07-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native elasticsan [ApiVersion]. See the version guide for details.
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>def get_volume(elastic_san_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               volume_group_name: Optional[str] = None,
               volume_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetVolumeResult
def get_volume_output(elastic_san_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               volume_group_name: Optional[pulumi.Input[str]] = None,
               volume_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetVolumeResult]func LookupVolume(ctx *Context, args *LookupVolumeArgs, opts ...InvokeOption) (*LookupVolumeResult, error)
func LookupVolumeOutput(ctx *Context, args *LookupVolumeOutputArgs, opts ...InvokeOption) LookupVolumeResultOutput> 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)
}public static CompletableFuture<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
public static Output<GetVolumeResult> getVolume(GetVolumeArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:elasticsan:getVolume
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Elastic
San stringName  - The name of the ElasticSan.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Volume
Group stringName  - The name of the VolumeGroup.
 - Volume
Name string - The name of the Volume.
 
- Elastic
San stringName  - The name of the ElasticSan.
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - Volume
Group stringName  - The name of the VolumeGroup.
 - Volume
Name string - The name of the Volume.
 
- elastic
San StringName  - The name of the ElasticSan.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - volume
Group StringName  - The name of the VolumeGroup.
 - volume
Name String - The name of the Volume.
 
- elastic
San stringName  - The name of the ElasticSan.
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 - volume
Group stringName  - The name of the VolumeGroup.
 - volume
Name string - The name of the Volume.
 
- elastic_
san_ strname  - The name of the ElasticSan.
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 - volume_
group_ strname  - The name of the VolumeGroup.
 - volume_
name str - The name of the Volume.
 
- elastic
San StringName  - The name of the ElasticSan.
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 - volume
Group StringName  - The name of the VolumeGroup.
 - volume
Name String - The name of the Volume.
 
getVolume Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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
 - Provisioning
State string - State of the operation on the resource.
 - Size
Gi doubleB  - Volume size.
 - Storage
Target Pulumi.Azure Native. Elastic San. Outputs. Iscsi Target Info Response  - Storage target information
 - System
Data Pulumi.Azure Native. Elastic San. Outputs. System Data Response  - 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"
 - Volume
Id string - Unique Id of the volume in GUID format
 - Creation
Data Pulumi.Azure Native. Elastic San. Outputs. Source Creation Data Response  - State of the operation on the resource.
 - Managed
By Pulumi.Azure Native. Elastic San. Outputs. Managed By Info Response  - Parent resource information.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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
 - Provisioning
State string - State of the operation on the resource.
 - Size
Gi float64B  - Volume size.
 - Storage
Target IscsiTarget Info Response  - Storage target information
 - System
Data SystemData Response  - 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"
 - Volume
Id string - Unique Id of the volume in GUID format
 - Creation
Data SourceCreation Data Response  - State of the operation on the resource.
 - Managed
By ManagedBy Info Response  - Parent resource information.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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
 - provisioning
State String - State of the operation on the resource.
 - size
Gi DoubleB  - Volume size.
 - storage
Target IscsiTarget Info Response  - Storage target information
 - system
Data SystemData Response  - 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"
 - volume
Id String - Unique Id of the volume in GUID format
 - creation
Data SourceCreation Data Response  - State of the operation on the resource.
 - managed
By ManagedBy Info Response  - Parent resource information.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - 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
 - provisioning
State string - State of the operation on the resource.
 - size
Gi numberB  - Volume size.
 - storage
Target IscsiTarget Info Response  - Storage target information
 - system
Data SystemData Response  - 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"
 - volume
Id string - Unique Id of the volume in GUID format
 - creation
Data SourceCreation Data Response  - State of the operation on the resource.
 - managed
By ManagedBy Info Response  - Parent resource information.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - 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.
 - size_
gi_ floatb  - Volume size.
 - storage_
target IscsiTarget Info Response  - Storage target information
 - system_
data SystemData Response  - 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_
id str - Unique Id of the volume in GUID format
 - creation_
data SourceCreation Data Response  - State of the operation on the resource.
 - managed_
by ManagedBy Info Response  - Parent resource information.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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
 - provisioning
State String - State of the operation on the resource.
 - size
Gi NumberB  - Volume size.
 - storage
Target Property Map - Storage target information
 - system
Data 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"
 - volume
Id String - Unique Id of the volume in GUID format
 - creation
Data Property Map - State of the operation on the resource.
 - managed
By Property Map - Parent resource information.
 
Supporting Types
IscsiTargetInfoResponse   
- Provisioning
State string - State of the operation on the resource.
 - Target
Iqn string - iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
 - Target
Portal stringHostname  - iSCSI Target Portal Host Name
 - Target
Portal intPort  - iSCSI Target Portal Port
 - Status string
 - Operational status of the iSCSI Target.
 
- Provisioning
State string - State of the operation on the resource.
 - Target
Iqn string - iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
 - Target
Portal stringHostname  - iSCSI Target Portal Host Name
 - Target
Portal intPort  - iSCSI Target Portal Port
 - Status string
 - Operational status of the iSCSI Target.
 
- provisioning
State String - State of the operation on the resource.
 - target
Iqn String - iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
 - target
Portal StringHostname  - iSCSI Target Portal Host Name
 - target
Portal IntegerPort  - iSCSI Target Portal Port
 - status String
 - Operational status of the iSCSI Target.
 
- provisioning
State string - State of the operation on the resource.
 - target
Iqn string - iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
 - target
Portal stringHostname  - iSCSI Target Portal Host Name
 - target
Portal numberPort  - iSCSI Target Portal Port
 - status string
 - Operational status of the iSCSI Target.
 
- provisioning_
state str - State of the operation on the resource.
 - target_
iqn str - iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
 - target_
portal_ strhostname  - iSCSI Target Portal Host Name
 - target_
portal_ intport  - iSCSI Target Portal Port
 - status str
 - Operational status of the iSCSI Target.
 
- provisioning
State String - State of the operation on the resource.
 - target
Iqn String - iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
 - target
Portal StringHostname  - iSCSI Target Portal Host Name
 - target
Portal NumberPort  - iSCSI Target Portal Port
 - status String
 - Operational status of the iSCSI Target.
 
ManagedByInfoResponse   
- Resource
Id string - Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
 
- Resource
Id string - Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
 
- resource
Id String - Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
 
- resource
Id string - Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
 
- resource_
id str - Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
 
- resource
Id String - Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
 
SourceCreationDataResponse   
- Create
Source string - This enumerates the possible sources of a volume creation.
 - Source
Id string - Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
 
- Create
Source string - This enumerates the possible sources of a volume creation.
 - Source
Id string - Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
 
- create
Source String - This enumerates the possible sources of a volume creation.
 - source
Id String - Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
 
- create
Source string - This enumerates the possible sources of a volume creation.
 - source
Id string - Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
 
- create_
source str - This enumerates the possible sources of a volume creation.
 - source_
id str - Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
 
- create
Source String - This enumerates the possible sources of a volume creation.
 - source
Id String - Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
 
SystemDataResponse  
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- Created
At string - The timestamp of resource creation (UTC).
 - Created
By string - The identity that created the resource.
 - Created
By stringType  - The type of identity that created the resource.
 - Last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - Last
Modified stringBy  - The identity that last modified the resource.
 - Last
Modified stringBy Type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
- created
At string - The timestamp of resource creation (UTC).
 - created
By string - The identity that created the resource.
 - created
By stringType  - The type of identity that created the resource.
 - last
Modified stringAt  - The timestamp of resource last modification (UTC)
 - last
Modified stringBy  - The identity that last modified the resource.
 - last
Modified stringBy Type  - 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_ strtype  - The type of identity that created the resource.
 - last_
modified_ strat  - The timestamp of resource last modification (UTC)
 - last_
modified_ strby  - The identity that last modified the resource.
 - last_
modified_ strby_ type  - The type of identity that last modified the resource.
 
- created
At String - The timestamp of resource creation (UTC).
 - created
By String - The identity that created the resource.
 - created
By StringType  - The type of identity that created the resource.
 - last
Modified StringAt  - The timestamp of resource last modification (UTC)
 - last
Modified StringBy  - The identity that last modified the resource.
 - last
Modified StringBy Type  - The type of identity that last modified the resource.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0