[Storage] STG105 Files GET APIs by File ID

sdk/storage/azure-storage-file-share/CHANGELOG.md

@@ -3,6 +3,8 @@
 ## 12.33.0-beta.1 (Unreleased)
 
 ### Features Added
+- Added support for retrieving file and directory properties by file ID
+- Added support for retrieving a file's hard links by file ID on SMB shares.
 - Added support for change feed on premium file shares. Added `ShareCreateOptions.setChangeFeedEnabled`,
   `setChangeFeedRetentionInDays` and `ShareSetPropertiesOptions.setChangeFeedEnabled`,
   `setChangeFeedRetentionInDays` to enable and configure change feed.

sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/ShareAsyncClient.java

@@ -21,6 +21,7 @@
 import com.azure.storage.common.implementation.SasImplUtils;
 import com.azure.storage.common.implementation.StorageImplUtils;
 import com.azure.storage.file.share.implementation.AzureFileStorageImpl;
+import com.azure.storage.file.share.implementation.ShareErrors;
 import com.azure.storage.file.share.implementation.models.SharePermission;
 import com.azure.storage.file.share.implementation.util.ModelHelper;
 import com.azure.storage.file.share.implementation.util.ShareSasImplUtil;
@@ -173,6 +174,27 @@ public ShareDirectoryAsyncClient getDirectoryClient(String directoryName) {
             serviceVersion, sasToken);
     }
 
+    /**
+     * Creates a directory client that addresses a directory by its file ID.
+     *
+     * <p>Call {@link ShareDirectoryAsyncClient#getProperties()} on the returned client to retrieve properties without
+     * knowing the directory path. Obtain the ID from {@link FileSmbProperties#getFileId()} in a path-based properties
+     * response. Other service operations require a path-addressed client.</p>
+     *
+     * <pre>{@code
+     * Mono<ShareDirectoryProperties> properties = shareAsyncClient.getDirectoryClientByFileId(fileId).getProperties();
+     * }</pre>
+     *
+     * @param fileId The file ID of the directory.
+     * @return A client for interacting with the directory by ID.
+     * @throws IllegalArgumentException If {@code fileId} is null or blank.
+     */
+    public ShareDirectoryAsyncClient getDirectoryClientByFileId(String fileId) {
+        ShareErrors.validateFileId(fileId);
+        return new ShareDirectoryAsyncClient(azureFileStorageClient, shareName, "", fileId, snapshot, accountName,
+            serviceVersion, sasToken);
+    }
+
     /**
      * Constructs a {@link ShareFileAsyncClient} that interacts with the specified file.
      *
@@ -187,6 +209,28 @@ public ShareFileAsyncClient getFileClient(String filePath) {
             serviceVersion, sasToken);
     }
 
+    /**
+     * Creates a file client that addresses a file by its file ID.
+     *
+     * <p>Call {@link ShareFileAsyncClient#getProperties()} on the returned client to retrieve properties without knowing
+     * the file path. Obtain the ID from {@link FileSmbProperties#getFileId()} in a path-based properties response.
+     * The returned client supports property retrieval and {@link ShareFileAsyncClient#getFileLinks()} (SMB only).
+     * Other service operations require a path-addressed client.</p>
+     *
+     * <pre>{@code
+     * Mono<ShareFileProperties> properties = shareAsyncClient.getFileClientByFileId(fileId).getProperties();
+     * }</pre>
+     *
+     * @param fileId The file ID of the file.
+     * @return A client for interacting with the file by ID.
+     * @throws IllegalArgumentException If {@code fileId} is null or blank.
+     */
+    public ShareFileAsyncClient getFileClientByFileId(String fileId) {
+        ShareErrors.validateFileId(fileId);
+        return new ShareFileAsyncClient(azureFileStorageClient, shareName, "", fileId, snapshot, accountName,
+            serviceVersion, sasToken);
+    }
+
     /**
      * Creates a new {@link ShareAsyncClient} linked to the {@code snapshot} of this share resource.
      *

sdk/storage/azure-storage-file-share/src/main/java/com/azure/storage/file/share/ShareClient.java

@@ -22,6 +22,7 @@
 import com.azure.storage.common.implementation.SasImplUtils;
 import com.azure.storage.common.implementation.StorageImplUtils;
 import com.azure.storage.file.share.implementation.AzureFileStorageImpl;
+import com.azure.storage.file.share.implementation.ShareErrors;
 import com.azure.storage.file.share.implementation.models.SharePermission;
 import com.azure.storage.file.share.implementation.models.ShareSignedIdentifierWrapper;
 import com.azure.storage.file.share.implementation.models.ShareStats;
@@ -180,6 +181,27 @@ public ShareDirectoryClient getDirectoryClient(String directoryName) {
             serviceVersion, sasToken);
     }
 
+    /**
+     * Creates a directory client that addresses a directory by its file ID.
+     *
+     * <p>Call {@link ShareDirectoryClient#getProperties()} on the returned client to retrieve properties without
+     * knowing the directory path. Obtain the ID from {@link FileSmbProperties#getFileId()} in a path-based properties
+     * response. Other service operations require a path-addressed client.</p>
+     *
+     * <pre>{@code
+     * ShareDirectoryProperties properties = shareClient.getDirectoryClientByFileId(fileId).getProperties();
+     * }</pre>
+     *
+     * @param fileId The file ID of the directory.
+     * @return A client for interacting with the directory by ID.
+     * @throws IllegalArgumentException If {@code fileId} is null or blank.
+     */
+    public ShareDirectoryClient getDirectoryClientByFileId(String fileId) {
+        ShareErrors.validateFileId(fileId);
+        return new ShareDirectoryClient(azureFileStorageClient, shareName, "", fileId, snapshot, accountName,
+            serviceVersion, sasToken);
+    }
+
     /**
      * Constructs a {@link ShareFileClient} that interacts with the specified file.
      *
@@ -196,6 +218,30 @@ public ShareFileClient getFileClient(String filePath) {
             azureFileStorageClient, shareName, filePath, snapshot, accountName, serviceVersion, sasToken);
     }
 
+    /**
+     * Creates a file client that addresses a file by its file ID.
+     *
+     * <p>Call {@link ShareFileClient#getProperties()} on the returned client to retrieve properties without knowing
+     * the file path. Obtain the ID from {@link FileSmbProperties#getFileId()} in a path-based properties response.
+     * The returned client supports property retrieval and {@link ShareFileClient#getFileLinks()} (SMB only).
+     * Other service operations require a path-addressed client.</p>
+     *
+     * <pre>{@code
+     * ShareFileProperties properties = shareClient.getFileClientByFileId(fileId).getProperties();
+     * }</pre>
+     *
+     * @param fileId The file ID of the file.
+     * @return A client for interacting with the file by ID.
+     * @throws IllegalArgumentException If {@code fileId} is null or blank.
+     */
+    public ShareFileClient getFileClientByFileId(String fileId) {
+        ShareErrors.validateFileId(fileId);
+        ShareFileAsyncClient asyncClient = new ShareFileAsyncClient(azureFileStorageClient, shareName, "", fileId,
+            snapshot, accountName, serviceVersion, sasToken);
+        return new ShareFileClient(asyncClient, azureFileStorageClient, shareName, "", fileId, snapshot, accountName,
+            serviceVersion, sasToken);
+    }
+
     /**
      * Creates a new {@link ShareAsyncClient} linked to the {@code snapshot} of this share resource.
      *