Add volume id to volume data source

Author: ismirlia

ibm/service/power/data_source_ibm_pi_volume.go

@@ -26,11 +26,22 @@ func DataSourceIBMPIVolume() *schema.Resource {
 				Type:         schema.TypeString,
 				ValidateFunc: validation.NoZeroValues,
 			},
+			Arg_VolumeID: {
+				AtLeastOneOf:  []string{Arg_VolumeID, Arg_VolumeName},
+				ConflictsWith: []string{Arg_VolumeName},
+				Description:   "The volume ID.",
+				Optional:      true,
+				Type:          schema.TypeString,
+				ValidateFunc:  validation.NoZeroValues,
+			},
 			Arg_VolumeName: {
-				Description:  "Volume Name to be used for pvminstances",
-				Required:     true,
-				Type:         schema.TypeString,
-				ValidateFunc: validation.NoZeroValues,
+				AtLeastOneOf:  []string{Arg_VolumeID, Arg_VolumeName},
+				ConflictsWith: []string{Arg_VolumeID},
+				Deprecated:    "The pi_volume_name field is deprecated. Please use pi_volume_id instead",
+				Description:   "Volume Name to be used for pvminstances",
+				Optional:      true,
+				Type:          schema.TypeString,
+				ValidateFunc:  validation.NoZeroValues,
 			},
 
 			// Attributes
@@ -152,6 +163,11 @@ func DataSourceIBMPIVolume() *schema.Resource {
 				Set:         schema.HashString,
 				Type:        schema.TypeSet,
 			},
+			Attr_VolumeName: {
+				Computed:    true,
+				Description: "The name of the volume.",
+				Type:        schema.TypeString,
+			},
 			Attr_VolumePool: {
 				Computed:    true,
 				Description: "Volume pool, name of storage pool where the volume is located.",
@@ -166,15 +182,22 @@ func DataSourceIBMPIVolume() *schema.Resource {
 	}
 }
 
-func dataSourceIBMPIVolumeRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+func dataSourceIBMPIVolumeRead(ctx context.Context, d *schema.ResourceData, meta any) diag.Diagnostics {
 	sess, err := meta.(conns.ClientSession).IBMPISession()
 	if err != nil {
 		return diag.FromErr(err)
 	}
 
 	cloudInstanceID := d.Get(Arg_CloudInstanceID).(string)
+	var volumeID string
+	if v, ok := d.GetOk(Arg_VolumeID); ok {
+		volumeID = v.(string)
+	} else if v, ok := d.GetOk(Arg_VolumeName); ok {
+		volumeID = v.(string)
+	}
+
 	volumeC := instance.NewIBMPIVolumeClient(ctx, sess, cloudInstanceID)
-	volumedata, err := volumeC.Get(d.Get(Arg_VolumeName).(string))
+	volumedata, err := volumeC.Get(volumeID)
 	if err != nil {
 		return diag.FromErr(err)
 	}
@@ -205,14 +228,15 @@ func dataSourceIBMPIVolumeRead(ctx context.Context, d *schema.ResourceData, meta
 	d.Set(Attr_OutOfBandDeleted, volumedata.OutOfBandDeleted)
 	d.Set(Attr_PrimaryRole, volumedata.PrimaryRole)
 	d.Set(Attr_ReplicationEnabled, volumedata.ReplicationEnabled)
-	d.Set(Attr_ReplicationType, volumedata.ReplicationType)
 	if len(volumedata.ReplicationSites) > 0 {
 		d.Set(Attr_ReplicationSites, volumedata.ReplicationSites)
 	}
 	d.Set(Attr_ReplicationStatus, volumedata.ReplicationStatus)
-	d.Set(Attr_State, volumedata.State)
+	d.Set(Attr_ReplicationType, volumedata.ReplicationType)
 	d.Set(Attr_Shareable, volumedata.Shareable)
 	d.Set(Attr_Size, volumedata.Size)
+	d.Set(Attr_State, volumedata.State)
+	d.Set(Attr_VolumeName, volumedata.Name)
 	d.Set(Attr_VolumePool, volumedata.VolumePool)
 	d.Set(Attr_WWN, volumedata.Wwn)
 

ibm/service/power/data_source_ibm_pi_volume_test.go

@@ -31,9 +31,9 @@ func TestAccIBMPIVolumeDataSource_basic(t *testing.T) {
 func testAccCheckIBMPIVolumeDataSourceConfig() string {
 	return fmt.Sprintf(`
 		data "ibm_pi_volume" "testacc_ds_volume" {
-			pi_volume_name       = "%s"
-			pi_cloud_instance_id = "%s"
-		}`, acc.Pi_volume_name, acc.Pi_cloud_instance_id)
+			pi_cloud_instance_id = "%[1]s"
+			pi_volume_id         = "%[2]s"
+		}`, acc.Pi_cloud_instance_id, acc.Pi_volume_id)
 }
 
 func TestAccIBMPIVolumeDataSource_replication(t *testing.T) {
@@ -56,7 +56,7 @@ func TestAccIBMPIVolumeDataSource_replication(t *testing.T) {
 func testAccCheckIBMPIVolumeDataSourceReplicationConfig() string {
 	return fmt.Sprintf(`
 		data "ibm_pi_volume" "testacc_ds_volume" {
-			pi_volume_name       = "%s"
-			pi_cloud_instance_id = "%s"
-		}`, acc.Pi_replication_volume_name, acc.Pi_cloud_instance_id)
+			pi_cloud_instance_id = "%[1]s"
+			pi_volume_name       = "%[2]s"
+		}`, acc.Pi_cloud_instance_id, acc.Pi_replication_volume_id)
 }

website/docs/d/pi_volume.html.markdown

@@ -1,7 +1,7 @@
 ---
 subcategory: "Power Systems"
 layout: "ibm"
-page_title: "IBM: pi_volume"
+page_title: "IBM: ibm_pi_volume"
 description: |-
   Manages a volume in the Power Virtual Server cloud.
 ---
@@ -16,8 +16,8 @@ The following example retrieves information about the `volume_1` volume that is
 
 ```terraform
 data "ibm_pi_volume" "ds_volume" {
-  pi_volume_name       = "volume_1"
   pi_cloud_instance_id = "49fba6c9-23f8-40bc-9899-aca322ee7d5b"
+  pi_volume_id         = "7f8e2a9d-3b4c-4e4f-8e8d-f7e7e1e23456"
 }
 ```
 
@@ -42,14 +42,15 @@ Example usage:
 Review the argument references that you can specify for your data source.
 
 - `pi_cloud_instance_id` - (Required, String) The GUID of the service instance associated with an account.
-- `pi_volume_name` - (Required, String) The name of the volume for which you want to retrieve detailed information.
+- `pi_volume_id` - (Optional, String) The volume ID.
+- `pi_volume_name` - (Deprecated, Optional, String) The name of the volume. Please use `pi_volume_id` instead.
 
 ## Attribute Reference
 
 In addition to all argument reference list, you can access the following attribute references after your data source is created.
 
-- `auxiliary` - (Boolean) Indicates if the volume is auxiliary.
 - `auxiliary_volume_name` - (String) The auxiliary volume name.
+- `auxiliary` - (Boolean) Indicates if the volume is auxiliary.
 - `bootable` -  (Boolean) Indicates if the volume is boot capable.
 - `consistency_group_name` - (String) Consistency group name if volume is a part of volume group.
 - `creation_date` - (String) Date of volume creation.
@@ -72,5 +73,6 @@ In addition to all argument reference list, you can access the following attribu
 - `size` - (Integer) The size of the volume in GB.
 - `state` - (String) The state of the volume.
 - `user_tags` - (List) List of user tags attached to the resource.
+- `volume_name` - (String) The name of the volume.
 - `volume_pool` - (String) Volume pool, name of storage pool where the volume is located.
 - `wwn` - (String) The world wide name of the volume.