Skip to content

Commit 8e1b595

Browse files
nickliu-msftnickliu-msft
authored
[Storage] [DataMovement] [API-Change] Changed ShareFilesStorageResourceProvider.FromFile/Directory to take a Uri over string (Azure#46446)
* Initial commit * Export API
1 parent 3288d38 commit 8e1b595

File tree

6 files changed

+45
-43
lines changed

6 files changed

+45
-43
lines changed

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
### Features Added
66

77
### Breaking Changes
8+
- Changed `FromDirectory(string directoryUri, ShareFileStorageResourceOptions options = default)` to `FromDirectory(Uri directoryUri, ShareFileStorageResourceOptions options = default)`
9+
- Changed `FromFile(string fileUri, ShareFileStorageResourceOptions options = default)` to `FromFile(Uri fileUri, ShareFileStorageResourceOptions options = default)`
810

911
### Bugs Fixed
1012
- Fixed bug where copying a Azure Storage Blob to a Share File would not be able to convert Content Language and Content Encoding to the `string[]` type.

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,11 @@ To create a share `StorageResource`, use the methods `FromFile` or `FromDirector
8484

8585
```C# Snippet:ResourceConstruction_Shares
8686
StorageResource directory = shares.FromDirectory(
87-
"http://myaccount.files.core.windows.net/share/path/to/directory");
87+
new Uri("http://myaccount.files.core.windows.net/share/path/to/directory"));
8888
StorageResource rootDirectory = shares.FromDirectory(
89-
"http://myaccount.files.core.windows.net/share");
89+
new Uri("http://myaccount.files.core.windows.net/share"));
9090
StorageResource file = shares.FromFile(
91-
"http://myaccount.files.core.windows.net/share/path/to/file.txt");
91+
new Uri("http://myaccount.files.core.windows.net/share/path/to/file.txt"));
9292
```
9393

9494
Storage resources can also be initialized with the appropriate client object from Azure.Storage.Files.Shares. Since these resources will use the credential already present in the client object, no credential is required in the provider when using `FromClient()`. **However**, a `ShareFilesStorageResourceProvider` must still have a credential if it is to be used in `TransferManagerOptions` for resuming a transfer.

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/api/Azure.Storage.DataMovement.Files.Shares.net6.0.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ public ShareFilesStorageResourceProvider(Azure.Storage.StorageSharedKeyCredentia
1919
public Azure.Storage.DataMovement.StorageResource FromClient(Azure.Storage.Files.Shares.ShareDirectoryClient client, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
2020
public Azure.Storage.DataMovement.StorageResource FromClient(Azure.Storage.Files.Shares.ShareFileClient client, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
2121
protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResource> FromDestinationAsync(Azure.Storage.DataMovement.DataTransferProperties properties, System.Threading.CancellationToken cancellationToken) { throw null; }
22-
public Azure.Storage.DataMovement.StorageResource FromDirectory(string directoryUri, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
23-
public Azure.Storage.DataMovement.StorageResource FromFile(string fileUri, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
22+
public Azure.Storage.DataMovement.StorageResource FromDirectory(System.Uri directoryUri, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
23+
public Azure.Storage.DataMovement.StorageResource FromFile(System.Uri fileUri, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
2424
protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResource> FromSourceAsync(Azure.Storage.DataMovement.DataTransferProperties properties, System.Threading.CancellationToken cancellationToken) { throw null; }
25-
public delegate Azure.AzureSasCredential GetAzureSasCredential(string uri, bool readOnly);
26-
public delegate Azure.Storage.StorageSharedKeyCredential GetStorageSharedKeyCredential(string uri, bool readOnly);
27-
public delegate Azure.Core.TokenCredential GetTokenCredential(string uri, bool readOnly);
25+
public delegate Azure.AzureSasCredential GetAzureSasCredential(System.Uri uri, bool readOnly);
26+
public delegate Azure.Storage.StorageSharedKeyCredential GetStorageSharedKeyCredential(System.Uri uri, bool readOnly);
27+
public delegate Azure.Core.TokenCredential GetTokenCredential(System.Uri uri, bool readOnly);
2828
}
2929
public partial class ShareFileStorageResourceOptions
3030
{

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/api/Azure.Storage.DataMovement.Files.Shares.netstandard2.0.cs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ public ShareFilesStorageResourceProvider(Azure.Storage.StorageSharedKeyCredentia
1919
public Azure.Storage.DataMovement.StorageResource FromClient(Azure.Storage.Files.Shares.ShareDirectoryClient client, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
2020
public Azure.Storage.DataMovement.StorageResource FromClient(Azure.Storage.Files.Shares.ShareFileClient client, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
2121
protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResource> FromDestinationAsync(Azure.Storage.DataMovement.DataTransferProperties properties, System.Threading.CancellationToken cancellationToken) { throw null; }
22-
public Azure.Storage.DataMovement.StorageResource FromDirectory(string directoryUri, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
23-
public Azure.Storage.DataMovement.StorageResource FromFile(string fileUri, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
22+
public Azure.Storage.DataMovement.StorageResource FromDirectory(System.Uri directoryUri, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
23+
public Azure.Storage.DataMovement.StorageResource FromFile(System.Uri fileUri, Azure.Storage.DataMovement.Files.Shares.ShareFileStorageResourceOptions options = null) { throw null; }
2424
protected override System.Threading.Tasks.Task<Azure.Storage.DataMovement.StorageResource> FromSourceAsync(Azure.Storage.DataMovement.DataTransferProperties properties, System.Threading.CancellationToken cancellationToken) { throw null; }
25-
public delegate Azure.AzureSasCredential GetAzureSasCredential(string uri, bool readOnly);
26-
public delegate Azure.Storage.StorageSharedKeyCredential GetStorageSharedKeyCredential(string uri, bool readOnly);
27-
public delegate Azure.Core.TokenCredential GetTokenCredential(string uri, bool readOnly);
25+
public delegate Azure.AzureSasCredential GetAzureSasCredential(System.Uri uri, bool readOnly);
26+
public delegate Azure.Storage.StorageSharedKeyCredential GetStorageSharedKeyCredential(System.Uri uri, bool readOnly);
27+
public delegate Azure.Core.TokenCredential GetTokenCredential(System.Uri uri, bool readOnly);
2828
}
2929
public partial class ShareFileStorageResourceOptions
3030
{

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/samples/Sample01b_HelloWorldAsync.cs‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ public async Task ResourceConstructionDemonstration()
5252
// Construct simple blob resources for data movement
5353
#region Snippet:ResourceConstruction_Shares
5454
StorageResource directory = shares.FromDirectory(
55-
"http://myaccount.files.core.windows.net/share/path/to/directory");
55+
new Uri("http://myaccount.files.core.windows.net/share/path/to/directory"));
5656
StorageResource rootDirectory = shares.FromDirectory(
57-
"http://myaccount.files.core.windows.net/share");
57+
new Uri("http://myaccount.files.core.windows.net/share"));
5858
StorageResource file = shares.FromFile(
59-
"http://myaccount.files.core.windows.net/share/path/to/file.txt");
59+
new Uri("http://myaccount.files.core.windows.net/share/path/to/file.txt"));
6060
#endregion
6161
}
6262
{
@@ -71,11 +71,11 @@ public async Task ResourceConstructionDemonstration()
7171
{
7272
StorageSharedKeyCredential sharedKeyCredential = new(StorageAccountName, StorageAccountKey);
7373
// Get blobs provider with credential
74-
AzureSasCredential GenerateSas(string uri, bool readOnly)
74+
AzureSasCredential GenerateSas(Uri uri, bool readOnly)
7575
{
7676
// Quick sample demonstrating minimal steps
7777
// Construct your SAS according to your needs
78-
ShareUriBuilder pathUri = new(new Uri(uri));
78+
ShareUriBuilder pathUri = new(uri);
7979
ShareSasBuilder sas = new(ShareSasPermissions.All, DateTimeOffset.Now.AddHours(1))
8080
{
8181
ShareName = pathUri.ShareName,
@@ -110,8 +110,8 @@ public async Task Upload()
110110
LocalFilesStorageResourceProvider files = new();
111111

112112
// Get a reference to a destination blobs
113-
string destinationFolderUri = share.GetDirectoryClient("sample-directory").Uri.ToString();
114-
string destinationFileUri = share.GetRootDirectoryClient().GetFileClient("sample-file").Uri.ToString();
113+
Uri destinationFolderUri = share.GetDirectoryClient("sample-directory").Uri;
114+
Uri destinationFileUri = share.GetRootDirectoryClient().GetFileClient("sample-file").Uri;
115115
TransferManager transferManager = new TransferManager(new TransferManagerOptions());
116116

117117
// Create simple transfer single blob upload job
@@ -153,8 +153,8 @@ public async Task Download()
153153
LocalFilesStorageResourceProvider files = new();
154154

155155
// Get a reference to a destination blobs
156-
string sourceDirectoryUri = share.GetDirectoryClient("sample-directory").Uri.ToString();
157-
string sourceFileUri = share.GetRootDirectoryClient().GetFileClient("sample-file").Uri.ToString();
156+
Uri sourceDirectoryUri = share.GetDirectoryClient("sample-directory").Uri;
157+
Uri sourceFileUri = share.GetRootDirectoryClient().GetFileClient("sample-file").Uri;
158158
TransferManager transferManager = new TransferManager(new TransferManagerOptions());
159159

160160
// Create simple transfer single blob upload job
@@ -192,10 +192,10 @@ public async Task Copy()
192192
ShareFilesStorageResourceProvider shares = new(new StorageSharedKeyCredential(StorageAccountName, StorageAccountKey));
193193

194194
// Get a reference to a destination blobs
195-
string sourceDirectoryUri = share.GetDirectoryClient("sample-directory-1").Uri.ToString();
196-
string destinationDirectoryUri = share.GetDirectoryClient("sample-directory-2").Uri.ToString();
197-
string sourceFileUri = share.GetRootDirectoryClient().GetFileClient("sample-file-1").Uri.ToString();
198-
string destinationFileUri = share.GetRootDirectoryClient().GetFileClient("sample-file-2").Uri.ToString();
195+
Uri sourceDirectoryUri = share.GetDirectoryClient("sample-directory-1").Uri;
196+
Uri destinationDirectoryUri = share.GetDirectoryClient("sample-directory-2").Uri;
197+
Uri sourceFileUri = share.GetRootDirectoryClient().GetFileClient("sample-file-1").Uri;
198+
Uri destinationFileUri = share.GetRootDirectoryClient().GetFileClient("sample-file-2").Uri;
199199
TransferManager transferManager = new TransferManager(new TransferManagerOptions());
200200

201201
// Create simple transfer single blob upload job

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/src/ShareFilesStorageResourceProvider.cs‎

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ public class ShareFilesStorageResourceProvider : StorageResourceProvider
2525
/// <param name="readOnly">
2626
/// Whether the permission can be read-only.
2727
/// </param>
28-
public delegate StorageSharedKeyCredential GetStorageSharedKeyCredential(string uri, bool readOnly);
28+
public delegate StorageSharedKeyCredential GetStorageSharedKeyCredential(Uri uri, bool readOnly);
2929

3030
/// <summary>
3131
/// Delegate for fetching a token credential for a given URI.
@@ -36,7 +36,7 @@ public class ShareFilesStorageResourceProvider : StorageResourceProvider
3636
/// <param name="readOnly">
3737
/// Whether the permission can be read-only.
3838
/// </param>
39-
public delegate TokenCredential GetTokenCredential(string uri, bool readOnly);
39+
public delegate TokenCredential GetTokenCredential(Uri uri, bool readOnly);
4040

4141
/// <summary>
4242
/// Delegate for fetching a SAS credential for a given URI.
@@ -47,7 +47,7 @@ public class ShareFilesStorageResourceProvider : StorageResourceProvider
4747
/// <param name="readOnly">
4848
/// Whether the permission can be read-only.
4949
/// </param>
50-
public delegate AzureSasCredential GetAzureSasCredential(string uri, bool readOnly);
50+
public delegate AzureSasCredential GetAzureSasCredential(Uri uri, bool readOnly);
5151

5252
private enum ResourceType
5353
{
@@ -229,8 +229,8 @@ protected override Task<StorageResource> FromSourceAsync(DataTransferProperties
229229
// Source share file data currently empty, so no specific properties to grab
230230

231231
return Task.FromResult(properties.IsContainer
232-
? FromDirectory(properties.SourceUri.AbsoluteUri)
233-
: FromFile(properties.SourceUri.AbsoluteUri));
232+
? FromDirectory(properties.SourceUri)
233+
: FromFile(properties.SourceUri));
234234
}
235235

236236
/// <inheritdoc/>
@@ -258,8 +258,8 @@ protected override Task<StorageResource> FromDestinationAsync(DataTransferProper
258258
FileMetadata = checkpointData.FileMetadata,
259259
};
260260
return Task.FromResult(properties.IsContainer
261-
? FromDirectory(properties.DestinationUri.AbsoluteUri, options)
262-
: FromFile(properties.DestinationUri.AbsoluteUri, options));
261+
? FromDirectory(properties.DestinationUri, options)
262+
: FromFile(properties.DestinationUri, options));
263263
}
264264

265265
/// <summary>
@@ -294,14 +294,14 @@ internal async Task<StorageResource> FromDestinationInternalHookAsync(
294294
/// <returns>
295295
/// The configured storage resource.
296296
/// </returns>
297-
public StorageResource FromDirectory(string directoryUri, ShareFileStorageResourceOptions options = default)
297+
public StorageResource FromDirectory(Uri directoryUri, ShareFileStorageResourceOptions options = default)
298298
{
299299
ShareDirectoryClient client = _credentialType switch
300300
{
301-
CredentialType.None => new ShareDirectoryClient(new Uri(directoryUri)),
302-
CredentialType.SharedKey => new ShareDirectoryClient(new Uri(directoryUri), _getStorageSharedKeyCredential(directoryUri, false)),
303-
CredentialType.Token => new ShareDirectoryClient(new Uri(directoryUri), _getTokenCredential(directoryUri, false)),
304-
CredentialType.Sas => new ShareDirectoryClient(new Uri(directoryUri), _getAzureSasCredential(directoryUri, false)),
301+
CredentialType.None => new ShareDirectoryClient(directoryUri),
302+
CredentialType.SharedKey => new ShareDirectoryClient(directoryUri, _getStorageSharedKeyCredential(directoryUri, false)),
303+
CredentialType.Token => new ShareDirectoryClient(directoryUri, _getTokenCredential(directoryUri, false)),
304+
CredentialType.Sas => new ShareDirectoryClient(directoryUri, _getAzureSasCredential(directoryUri, false)),
305305
_ => throw BadCredentialTypeException(_credentialType),
306306
};
307307
return new ShareDirectoryStorageResourceContainer(client, options);
@@ -320,15 +320,15 @@ public StorageResource FromDirectory(string directoryUri, ShareFileStorageResour
320320
/// The configured storage resource.
321321
/// </returns>
322322
public StorageResource FromFile(
323-
string fileUri,
323+
Uri fileUri,
324324
ShareFileStorageResourceOptions options = default)
325325
{
326326
ShareFileClient client = _credentialType switch
327327
{
328-
CredentialType.None => new ShareFileClient(new Uri(fileUri)),
329-
CredentialType.SharedKey => new ShareFileClient(new Uri(fileUri), _getStorageSharedKeyCredential(fileUri, false)),
330-
CredentialType.Token => new ShareFileClient(new Uri(fileUri), _getTokenCredential(fileUri, false)),
331-
CredentialType.Sas => new ShareFileClient(new Uri(fileUri), _getAzureSasCredential(fileUri, false)),
328+
CredentialType.None => new ShareFileClient(fileUri),
329+
CredentialType.SharedKey => new ShareFileClient(fileUri, _getStorageSharedKeyCredential(fileUri, false)),
330+
CredentialType.Token => new ShareFileClient(fileUri, _getTokenCredential(fileUri, false)),
331+
CredentialType.Sas => new ShareFileClient(fileUri, _getAzureSasCredential(fileUri, false)),
332332
_ => throw BadCredentialTypeException(_credentialType),
333333
};
334334
return new ShareFileStorageResource(client, options);

0 commit comments

Comments
 (0)