Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. elasticsan
  5. getVolume
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.elasticsan.getVolume

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

    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. 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 dictionary

    The following arguments are supported:

    ElasticSanName string
    The name of the ElasticSan.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeGroupName string
    The name of the VolumeGroup.
    VolumeName string
    The name of the Volume.
    ElasticSanName string
    The name of the ElasticSan.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    VolumeGroupName string
    The name of the VolumeGroup.
    VolumeName string
    The name of the Volume.
    elasticSanName String
    The name of the ElasticSan.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeGroupName String
    The name of the VolumeGroup.
    volumeName String
    The name of the Volume.
    elasticSanName string
    The name of the ElasticSan.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    volumeGroupName string
    The name of the VolumeGroup.
    volumeName string
    The name of the Volume.
    elastic_san_name str
    The name of the ElasticSan.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    volume_group_name str
    The name of the VolumeGroup.
    volume_name str
    The name of the Volume.
    elasticSanName String
    The name of the ElasticSan.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    volumeGroupName String
    The name of the VolumeGroup.
    volumeName String
    The name of the Volume.

    getVolume 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. 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.
    SizeGiB double
    Volume size.
    StorageTarget Pulumi.AzureNative.ElasticSan.Outputs.IscsiTargetInfoResponse
    Storage target information
    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"
    VolumeId string
    Unique Id of the volume in GUID format
    CreationData Pulumi.AzureNative.ElasticSan.Outputs.SourceCreationDataResponse
    State of the operation on the resource.
    ManagedBy Pulumi.AzureNative.ElasticSan.Outputs.ManagedByInfoResponse
    Parent resource information.
    AzureApiVersion string
    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
    ProvisioningState string
    State of the operation on the resource.
    SizeGiB float64
    Volume size.
    StorageTarget IscsiTargetInfoResponse
    Storage target information
    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"
    VolumeId string
    Unique Id of the volume in GUID format
    CreationData SourceCreationDataResponse
    State of the operation on the resource.
    ManagedBy ManagedByInfoResponse
    Parent resource information.
    azureApiVersion String
    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
    provisioningState String
    State of the operation on the resource.
    sizeGiB Double
    Volume size.
    storageTarget IscsiTargetInfoResponse
    Storage target information
    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"
    volumeId String
    Unique Id of the volume in GUID format
    creationData SourceCreationDataResponse
    State of the operation on the resource.
    managedBy ManagedByInfoResponse
    Parent resource information.
    azureApiVersion string
    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
    provisioningState string
    State of the operation on the resource.
    sizeGiB number
    Volume size.
    storageTarget IscsiTargetInfoResponse
    Storage target information
    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"
    volumeId string
    Unique Id of the volume in GUID format
    creationData SourceCreationDataResponse
    State of the operation on the resource.
    managedBy ManagedByInfoResponse
    Parent resource information.
    azure_api_version str
    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_b float
    Volume size.
    storage_target IscsiTargetInfoResponse
    Storage target information
    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_id str
    Unique Id of the volume in GUID format
    creation_data SourceCreationDataResponse
    State of the operation on the resource.
    managed_by ManagedByInfoResponse
    Parent resource information.
    azureApiVersion String
    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
    provisioningState String
    State of the operation on the resource.
    sizeGiB Number
    Volume size.
    storageTarget Property Map
    Storage target information
    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"
    volumeId String
    Unique Id of the volume in GUID format
    creationData Property Map
    State of the operation on the resource.
    managedBy Property Map
    Parent resource information.

    Supporting Types

    IscsiTargetInfoResponse

    ProvisioningState string
    State of the operation on the resource.
    TargetIqn string
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
    TargetPortalHostname string
    iSCSI Target Portal Host Name
    TargetPortalPort int
    iSCSI Target Portal Port
    Status string
    Operational status of the iSCSI Target.
    ProvisioningState string
    State of the operation on the resource.
    TargetIqn string
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
    TargetPortalHostname string
    iSCSI Target Portal Host Name
    TargetPortalPort int
    iSCSI Target Portal Port
    Status string
    Operational status of the iSCSI Target.
    provisioningState String
    State of the operation on the resource.
    targetIqn String
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
    targetPortalHostname String
    iSCSI Target Portal Host Name
    targetPortalPort Integer
    iSCSI Target Portal Port
    status String
    Operational status of the iSCSI Target.
    provisioningState string
    State of the operation on the resource.
    targetIqn string
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
    targetPortalHostname string
    iSCSI Target Portal Host Name
    targetPortalPort number
    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_hostname str
    iSCSI Target Portal Host Name
    target_portal_port int
    iSCSI Target Portal Port
    status str
    Operational status of the iSCSI Target.
    provisioningState String
    State of the operation on the resource.
    targetIqn String
    iSCSI Target IQN (iSCSI Qualified Name); example: "iqn.2005-03.org.iscsi:server".
    targetPortalHostname String
    iSCSI Target Portal Host Name
    targetPortalPort Number
    iSCSI Target Portal Port
    status String
    Operational status of the iSCSI Target.

    ManagedByInfoResponse

    ResourceId string
    Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
    ResourceId string
    Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
    resourceId String
    Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.
    resourceId 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.
    resourceId String
    Resource ID of the resource managing the volume, this is a restricted field and can only be set for internal use.

    SourceCreationDataResponse

    CreateSource string
    This enumerates the possible sources of a volume creation.
    SourceId string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    CreateSource string
    This enumerates the possible sources of a volume creation.
    SourceId string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    createSource String
    This enumerates the possible sources of a volume creation.
    sourceId String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    createSource string
    This enumerates the possible sources of a volume creation.
    sourceId 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}"
    createSource String
    This enumerates the possible sources of a volume creation.
    sourceId String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
    pulumi/pulumi-azure-native