1. Packages
  2. Azure Native
  3. API Docs
  4. elasticsan
  5. getVolume
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

azure-native.elasticsan.getVolume

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi

    Get an Volume. Azure REST API version: 2021-11-20-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>
    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)
    // Output-based functions aren't available in Java yet
    
    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:

    Id string

    Azure resource identifier.

    Name string

    Azure resource name.

    StorageTarget Pulumi.AzureNative.ElasticSan.Outputs.IscsiTargetInfoResponse

    Storage target information

    SystemData Pulumi.AzureNative.ElasticSan.Outputs.SystemDataResponse

    Resource metadata required by ARM RPC

    Type string

    Azure resource type.

    VolumeId string

    Unique Id of the volume in GUID format

    CreationData Pulumi.AzureNative.ElasticSan.Outputs.SourceCreationDataResponse

    State of the operation on the resource.

    SizeGiB double

    Volume size.

    Tags Dictionary<string, string>

    Azure resource tags.

    Id string

    Azure resource identifier.

    Name string

    Azure resource name.

    StorageTarget IscsiTargetInfoResponse

    Storage target information

    SystemData SystemDataResponse

    Resource metadata required by ARM RPC

    Type string

    Azure resource type.

    VolumeId string

    Unique Id of the volume in GUID format

    CreationData SourceCreationDataResponse

    State of the operation on the resource.

    SizeGiB float64

    Volume size.

    Tags map[string]string

    Azure resource tags.

    id String

    Azure resource identifier.

    name String

    Azure resource name.

    storageTarget IscsiTargetInfoResponse

    Storage target information

    systemData SystemDataResponse

    Resource metadata required by ARM RPC

    type String

    Azure resource type.

    volumeId String

    Unique Id of the volume in GUID format

    creationData SourceCreationDataResponse

    State of the operation on the resource.

    sizeGiB Double

    Volume size.

    tags Map<String,String>

    Azure resource tags.

    id string

    Azure resource identifier.

    name string

    Azure resource name.

    storageTarget IscsiTargetInfoResponse

    Storage target information

    systemData SystemDataResponse

    Resource metadata required by ARM RPC

    type string

    Azure resource type.

    volumeId string

    Unique Id of the volume in GUID format

    creationData SourceCreationDataResponse

    State of the operation on the resource.

    sizeGiB number

    Volume size.

    tags {[key: string]: string}

    Azure resource tags.

    id str

    Azure resource identifier.

    name str

    Azure resource name.

    storage_target IscsiTargetInfoResponse

    Storage target information

    system_data SystemDataResponse

    Resource metadata required by ARM RPC

    type str

    Azure resource type.

    volume_id str

    Unique Id of the volume in GUID format

    creation_data SourceCreationDataResponse

    State of the operation on the resource.

    size_gi_b float

    Volume size.

    tags Mapping[str, str]

    Azure resource tags.

    id String

    Azure resource identifier.

    name String

    Azure resource name.

    storageTarget Property Map

    Storage target information

    systemData Property Map

    Resource metadata required by ARM RPC

    type String

    Azure resource type.

    volumeId String

    Unique Id of the volume in GUID format

    creationData Property Map

    State of the operation on the resource.

    sizeGiB Number

    Volume size.

    tags Map<String>

    Azure resource tags.

    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.

    SourceCreationDataResponse

    CreateSource string

    This enumerates the possible sources of a volume creation.

    SourceUri string

    If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point.

    CreateSource string

    This enumerates the possible sources of a volume creation.

    SourceUri string

    If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point.

    createSource String

    This enumerates the possible sources of a volume creation.

    sourceUri String

    If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point.

    createSource string

    This enumerates the possible sources of a volume creation.

    sourceUri string

    If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point.

    create_source str

    This enumerates the possible sources of a volume creation.

    source_uri str

    If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point.

    createSource String

    This enumerates the possible sources of a volume creation.

    sourceUri String

    If createOption is Copy, this is the ARM id of the source snapshot or disk. If createOption is Restore, this is the ARM-like id of the source disk restore point.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.9.0 published on Wednesday, Sep 27, 2023 by Pulumi