/
ShareFileClient.cs
6789 lines (6513 loc) · 299 KB
/
ShareFileClient.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
using System;
using System.Buffers;
using System.Collections.Generic;
using System.ComponentModel;
using System.Diagnostics;
using System.IO;
using System.Runtime.InteropServices;
using System.Threading;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Pipeline;
using Azure.Storage.Files.Shares.Models;
using Azure.Storage.Shared;
using Azure.Storage.Sas;
using Metadata = System.Collections.Generic.IDictionary<string, string>;
using System.Net.Http.Headers;
using System.Linq;
#pragma warning disable SA1402 // File may only contain a single type
namespace Azure.Storage.Files.Shares
{
/// <summary>
/// The <see cref="ShareFileClient"/> allows you to manipulate Azure Storage files.
/// </summary>
public class ShareFileClient
{
/// <summary>
/// The directory's primary <see cref="Uri"/> endpoint.
/// </summary>
private readonly Uri _uri;
/// <summary>
/// Gets the directory's primary <see cref="Uri"/> endpoint.
/// </summary>
public virtual Uri Uri => _uri;
/// <summary>
/// <see cref="ShareClientConfiguration"/>.
/// </summary>
private readonly ShareClientConfiguration _clientConfiguration;
/// <summary>
/// <see cref="ShareClientConfiguration"/>.
/// </summary>
internal virtual ShareClientConfiguration ClientConfiguration => _clientConfiguration;
/// <summary>
/// FileRestClient.
/// </summary>
private readonly FileRestClient _fileRestClient;
/// <summary>
/// FileRestClient.
/// </summary>
internal virtual FileRestClient FileRestClient => _fileRestClient;
/// <summary>
/// The Storage account name corresponding to the file client.
/// </summary>
private string _accountName;
/// <summary>
/// Gets the Storage account name corresponding to the file client.
/// </summary>
public virtual string AccountName
{
get
{
SetNameFieldsIfNull();
return _accountName;
}
}
/// <summary>
/// The share name corresponding to the file client.
/// </summary>
private string _shareName;
/// <summary>
/// Gets the share name corresponding to the file client.
/// </summary>
public virtual string ShareName
{
get
{
SetNameFieldsIfNull();
return _shareName;
}
}
/// <summary>
/// The name of the file.
/// </summary>
private string _name;
/// <summary>
/// Gets the name of the file.
/// </summary>
public virtual string Name
{
get
{
SetNameFieldsIfNull();
return _name;
}
}
/// <summary>
/// The path of the file.
/// </summary>
private string _path;
/// <summary>
/// Gets the path of the file.
/// </summary>
public virtual string Path
{
get
{
SetNameFieldsIfNull();
return _path;
}
}
/// <summary>
/// Determines whether the client is able to generate a SAS.
/// If the client is authenticated with a <see cref="StorageSharedKeyCredential"/>.
/// </summary>
public virtual bool CanGenerateSasUri => ClientConfiguration.SharedKeyCredential != null;
//const string fileType = "file";
//// FileMaxUploadRangeBytes indicates the maximum number of bytes that can be sent in a call to UploadRange.
//public const Int64 FileMaxUploadRangeBytes = 4 * Constants.MB; // 4MB
//// FileMaxSizeInBytes indicates the maxiumum file size, in bytes.
//public const Int64 FileMaxSizeInBytes = 1 * Constants.TB; // 1TB
#region ctors
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/>
/// class for mocking.
/// </summary>
protected ShareFileClient()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/> class.
/// </summary>
/// <param name="connectionString">
/// A connection string includes the authentication information
/// required for your application to access data in an Azure Storage
/// account at runtime.
///
/// For more information, see
/// <see href="https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string">
/// Configure Azure Storage connection strings</see>
/// </param>
/// <param name="shareName">
/// The name of the share in the storage account to reference.
/// </param>
/// <param name="filePath">
/// The path of the file in the storage account to reference.
/// </param>
public ShareFileClient(string connectionString, string shareName, string filePath)
: this(connectionString, shareName, filePath, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/> class.
/// </summary>
/// <param name="connectionString">
/// A connection string includes the authentication information
/// required for your application to access data in an Azure Storage
/// account at runtime.
///
/// For more information, see
/// <see href="https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string">
/// Configure Azure Storage connection strings</see>
/// </param>
/// <param name="shareName">
/// The name of the share in the storage account to reference.
/// </param>
/// <param name="filePath">
/// The path of the file in the storage account to reference.
/// </param>
/// <param name="options">
/// Optional <see cref="ShareClientOptions"/> that define the transport
/// pipeline policies for authentication, retries, etc., that are
/// applied to every request.
/// </param>
public ShareFileClient(
string connectionString,
string shareName,
string filePath,
ShareClientOptions options)
{
options ??= new ShareClientOptions();
var conn = StorageConnectionString.Parse(connectionString);
ShareUriBuilder uriBuilder =
new ShareUriBuilder(conn.FileEndpoint)
{
ShareName = shareName,
DirectoryOrFilePath = filePath
};
_uri = uriBuilder.ToUri();
_clientConfiguration = new ShareClientConfiguration(
pipeline: options.Build(conn.Credentials),
sharedKeyCredential: conn.Credentials as StorageSharedKeyCredential,
clientDiagnostics: new ClientDiagnostics(options),
clientOptions: options);
_fileRestClient = BuildFileRestClient(_uri);
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/> class.
/// </summary>
/// <param name="fileUri">
/// A <see cref="Uri"/> referencing the file that includes the
/// name of the account, the name of the share, and the path of the
/// file.
/// </param>
/// <param name="options">
/// Optional <see cref="ShareClientOptions"/> that define the transport
/// pipeline policies for authentication, retries, etc., that are
/// applied to every request.
/// </param>
public ShareFileClient(
Uri fileUri,
ShareClientOptions options = default)
: this(
fileUri: fileUri,
authentication: (HttpPipelinePolicy)null,
options: options,
storageSharedKeyCredential: null,
sasCredential: null,
tokenCredential: null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/> class.
/// </summary>
/// <param name="fileUri">
/// A <see cref="Uri"/> referencing the file that includes the
/// name of the account, the name of the share, and the path of the
/// file.
/// </param>
/// <param name="credential">
/// The shared key credential used to sign requests.
/// </param>
/// <param name="options">
/// Optional <see cref="ShareClientOptions"/> that define the transport
/// pipeline policies for authentication, retries, etc., that are
/// applied to every request.
/// </param>
public ShareFileClient(
Uri fileUri,
StorageSharedKeyCredential credential,
ShareClientOptions options = default)
: this(
fileUri: fileUri,
authentication: credential.AsPolicy(),
options: options,
storageSharedKeyCredential: credential,
sasCredential: null,
tokenCredential: null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/> class.
/// </summary>
/// <param name="fileUri">
/// A <see cref="Uri"/> referencing the file that includes the
/// name of the account, the name of the share, and the path of the
/// file.
/// Must not contain shared access signature, which should be passed in the second parameter.
/// </param>
/// <param name="credential">
/// The shared access signature credential used to sign requests.
/// </param>
/// <param name="options">
/// Optional <see cref="ShareClientOptions"/> that define the transport
/// pipeline policies for authentication, retries, etc., that are
/// applied to every request.
/// </param>
/// <remarks>
/// This constructor should only be used when shared access signature needs to be updated during lifespan of this client.
/// </remarks>
public ShareFileClient(
Uri fileUri,
AzureSasCredential credential,
ShareClientOptions options = default)
: this(
fileUri,
credential.AsPolicy<ShareUriBuilder>(fileUri),
options,
storageSharedKeyCredential: null,
sasCredential: credential,
tokenCredential: null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/>
/// class.
///
/// Note that <see cref="ShareClientOptions.ShareTokenIntent"/> is currently required for token authentication.
/// </summary>
/// <param name="fileUri">
/// A <see cref="Uri"/> referencing the file that includes the
/// name of the account, the name of the share, and the path of the
/// file.
/// </param>
/// <param name="credential">
/// The token credential used to sign requests.
/// </param>
/// <param name="options">
/// Optional client options that define the transport pipeline
/// policies for authentication, retries, etc., that are applied to
/// every request.
/// </param>
public ShareFileClient(
Uri fileUri,
TokenCredential credential,
ShareClientOptions options = default)
: this(
fileUri: fileUri,
authentication: credential.AsPolicy(
string.IsNullOrEmpty(options?.Audience?.ToString()) ? ShareAudience.DefaultAudience.CreateDefaultScope() : options.Audience.Value.CreateDefaultScope(),
options),
options: options ?? new ShareClientOptions(),
storageSharedKeyCredential: null,
sasCredential: null,
tokenCredential: credential)
{
Errors.VerifyHttpsTokenAuth(fileUri);
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/>
/// class.
/// </summary>
/// <param name="fileUri">
/// A <see cref="Uri"/> referencing the file that includes the
/// name of the account, the name of the share, and the path of the
/// file.
/// </param>
/// <param name="diagnostics">
/// The diagnostics from the parent client.
/// </param>
/// <param name="options">
/// Optional client options that define the transport pipeline
/// policies for authentication, retries, etc., that are applied to
/// every request.
/// </param>
internal ShareFileClient(
Uri fileUri,
ClientDiagnostics diagnostics,
ShareClientOptions options)
{
Argument.AssertNotNull(fileUri, nameof(fileUri));
options ??= new ShareClientOptions();
_uri = fileUri;
_clientConfiguration = new ShareClientConfiguration(
pipeline: options.Build(),
sharedKeyCredential: default,
clientDiagnostics: diagnostics,
clientOptions: options);
_fileRestClient = BuildFileRestClient(fileUri);
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/>
/// class.
/// </summary>
/// <param name="fileUri">
/// A <see cref="Uri"/> referencing the file that includes the
/// name of the account, the name of the share, and the path of the
/// file.
/// </param>
/// <param name="authentication">
/// An optional authentication policy used to sign requests.
/// </param>
/// <param name="options">
/// Optional client options that define the transport pipeline
/// policies for authentication, retries, etc., that are applied to
/// every request.
/// </param>
/// <param name="storageSharedKeyCredential">
/// The shared key credential used to sign requests.
/// </param>
/// <param name="sasCredential">
/// The SAS credential used to sign requests.
/// </param>
/// <param name="tokenCredential">
/// The token credential used to sign requests.
/// </param>
internal ShareFileClient(
Uri fileUri,
HttpPipelinePolicy authentication,
ShareClientOptions options,
StorageSharedKeyCredential storageSharedKeyCredential,
AzureSasCredential sasCredential,
TokenCredential tokenCredential)
{
Argument.AssertNotNull(fileUri, nameof(fileUri));
options ??= new ShareClientOptions();
_uri = fileUri;
_clientConfiguration = new ShareClientConfiguration(
pipeline: options.Build(authentication),
sharedKeyCredential: storageSharedKeyCredential,
sasCredential: sasCredential,
tokenCredential: tokenCredential,
clientDiagnostics: new ClientDiagnostics(options),
clientOptions: options)
{
Audience = options.Audience ?? ShareAudience.DefaultAudience,
};
_fileRestClient = BuildFileRestClient(fileUri);
}
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/> class.
/// </summary>
/// <param name="fileUri">
/// A <see cref="Uri"/> referencing the file that includes the
/// name of the account, the name of the share, and the path of the file.
/// </param>
/// <param name="clientConfiguration">
/// <see cref="ShareClientConfiguration"/>.
/// </param>
internal ShareFileClient(
Uri fileUri,
ShareClientConfiguration clientConfiguration)
{
_uri = fileUri;
_clientConfiguration = clientConfiguration;
_fileRestClient = BuildFileRestClient(fileUri);
}
private FileRestClient BuildFileRestClient(Uri uri)
{
return new FileRestClient(
clientDiagnostics: _clientConfiguration.ClientDiagnostics,
pipeline: _clientConfiguration.Pipeline,
url: uri.AbsoluteUri,
version: _clientConfiguration.ClientOptions.Version.ToVersionString(),
fileRequestIntent: _clientConfiguration.ClientOptions.ShareTokenIntent,
allowTrailingDot: _clientConfiguration.ClientOptions.AllowTrailingDot,
fileRangeWriteFromUrl: "update",
allowSourceTrailingDot: _clientConfiguration.ClientOptions.AllowSourceTrailingDot);
}
#endregion ctors
/// <summary>
/// Initializes a new instance of the <see cref="ShareFileClient"/>
/// class with an identical <see cref="Uri"/> source but the specified
/// <paramref name="shareSnapshot"/> timestamp.
///
/// For more information, see
/// <see href="https://docs.microsoft.com/rest/api/storageservices/snapshot-share">
/// Snapshot Share</see>.
/// </summary>
/// <remarks>
/// Pass null or empty string to remove the snapshot returning a URL to the base file.
/// </remarks>
/// <param name="shareSnapshot">
/// The snapshot identifier.
/// </param>
/// <returns>
/// A new <see cref="ShareFileClient"/> instance.
/// </returns>
public virtual ShareFileClient WithSnapshot(string shareSnapshot)
{
var builder = new ShareUriBuilder(Uri) { Snapshot = shareSnapshot };
return new ShareFileClient(builder.ToUri(), ClientConfiguration);
}
/// <summary>
/// Sets the various name fields if they are currently null.
/// </summary>
private void SetNameFieldsIfNull()
{
if (_name == null || _shareName == null || _accountName == null || _path == null)
{
var builder = new ShareUriBuilder(Uri);
_name = builder.LastDirectoryOrFileName;
_shareName = builder.ShareName;
_accountName = builder.AccountName;
_path = builder.DirectoryOrFilePath;
}
}
#region internal static accessors for Azure.Storage.DataMovement.Blobs
/// <summary>
/// Get a <see cref="ShareFileClient"/>'s <see cref="HttpAuthorization"/>
/// for passing the authorization when performing service to service copy
/// where OAuth is necessary to authenticate the source.
/// </summary>
/// <param name="client">
/// The storage client which to generate the
/// authorization header off of.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>The BlobServiceClient's HttpPipeline.</returns>
protected static async Task<HttpAuthorization> GetCopyAuthorizationHeaderAsync(
ShareFileClient client,
CancellationToken cancellationToken = default)
{
if (client.ClientConfiguration.TokenCredential != default)
{
AccessToken accessToken = await client.ClientConfiguration.TokenCredential.GetTokenAsync(
new TokenRequestContext(new string[] { client.ClientConfiguration.Audience.CreateDefaultScope() }),
cancellationToken).ConfigureAwait(false);
return new HttpAuthorization(
Constants.CopyHttpAuthorization.BearerScheme,
accessToken.Token);
}
return default;
}
#endregion internal static accessors for Azure.Storage.DataMovement.Blobs
#region Create
/// <summary>
/// Creates a new file or replaces an existing file.
///
/// For more information, see
/// <see href="https://docs.microsoft.com/rest/api/storageservices/create-file">
/// Create File</see>.
/// </summary>
/// <remarks>
/// This method only initializes the file.
/// To add content, use <see cref="UploadRangeAsync(HttpRange, Stream, byte[], IProgress{long}, ShareFileRequestConditions, CancellationToken)"/>.
/// </remarks>
/// <param name="maxSize">
/// Required. Specifies the maximum size for the file.
/// </param>
/// <param name="httpHeaders">
/// Optional standard HTTP header properties that can be set for the file.
/// </param>
/// <param name="metadata">
/// Optional custom metadata to set for the file.
/// </param>
/// <param name="smbProperties">
/// Optional SMB properties to set for the file.
/// </param>
/// <param name="filePermission">
/// Optional file permission to set for the file.
/// </param>
/// <param name="conditions">
/// Optional <see cref="ShareFileRequestConditions"/> to add conditions
/// on creating the file.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// A <see cref="Response{StorageFileInfo}"/> describing the
/// state of the file.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
public virtual Response<ShareFileInfo> Create(
long maxSize,
ShareFileHttpHeaders httpHeaders = default,
Metadata metadata = default,
FileSmbProperties smbProperties = default,
string filePermission = default,
ShareFileRequestConditions conditions = default,
CancellationToken cancellationToken = default) =>
CreateInternal(
maxSize,
httpHeaders,
metadata,
smbProperties,
filePermission,
conditions,
async: false,
cancellationToken)
.EnsureCompleted();
/// <summary>
/// Creates a new file or replaces an existing file.
///
/// For more information, see
/// <see href="https://docs.microsoft.com/rest/api/storageservices/create-file">
/// Create File</see>.
/// </summary>
/// <remarks>
/// This method only initializes the file.
/// To add content, use <see cref="UploadRangeAsync(HttpRange, Stream, byte[], IProgress{long}, ShareFileRequestConditions, CancellationToken)"/>.
/// </remarks>
/// <param name="maxSize">
/// Required. Specifies the maximum size for the file.
/// </param>
/// <param name="httpHeaders">
/// Optional standard HTTP header properties that can be set for the file.
/// </param>
/// <param name="metadata">
/// Optional custom metadata to set for the file.
/// </param>
/// <param name="smbProperties">
/// Optional SMB properties to set for the file.
/// </param>
/// <param name="filePermission">
/// Optional file permission to set for the file.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// A <see cref="Response{StorageFileInfo}"/> describing the
/// state of the file.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
#pragma warning disable AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
[EditorBrowsable(EditorBrowsableState.Never)]
public virtual Response<ShareFileInfo> Create(
#pragma warning restore AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
long maxSize,
ShareFileHttpHeaders httpHeaders,
Metadata metadata,
FileSmbProperties smbProperties,
string filePermission,
CancellationToken cancellationToken) =>
CreateInternal(
maxSize,
httpHeaders,
metadata,
smbProperties,
filePermission,
conditions: default,
async: false,
cancellationToken)
.EnsureCompleted();
/// <summary>
/// Creates a new file or replaces an existing file.
///
/// For more information, see
/// <see href="https://docs.microsoft.com/rest/api/storageservices/create-file">
/// Create File</see>.
/// </summary>
/// <remarks>
/// This method only initializes the file.
/// To add content, use <see cref="UploadRangeAsync(HttpRange, Stream, byte[], IProgress{long}, ShareFileRequestConditions, CancellationToken)"/>.
/// </remarks>
/// <param name="maxSize">
/// Required. Specifies the maximum size for the file.
/// </param>
/// <param name="httpHeaders">
/// Optional standard HTTP header properties that can be set for the file.
/// </param>
/// <param name="metadata">
/// Optional custom metadata to set for the file.
/// </param>
/// <param name="smbProperties">
/// Optional SMB properties to set for the file.
/// </param>
/// <param name="filePermission">
/// Optional file permission to set for the file.
/// </param>
/// <param name="conditions">
/// Optional <see cref="ShareFileRequestConditions"/> to add conditions
/// on creating the file.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// A <see cref="Response{StorageFileInfo}"/> describing the
/// state of the file.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
public virtual async Task<Response<ShareFileInfo>> CreateAsync(
long maxSize,
ShareFileHttpHeaders httpHeaders = default,
Metadata metadata = default,
FileSmbProperties smbProperties = default,
string filePermission = default,
ShareFileRequestConditions conditions = default,
CancellationToken cancellationToken = default) =>
await CreateInternal(
maxSize,
httpHeaders,
metadata,
smbProperties,
filePermission,
conditions,
async: true,
cancellationToken)
.ConfigureAwait(false);
/// <summary>
/// Creates a new file or replaces an existing file.
///
/// For more information, see
/// <see href="https://docs.microsoft.com/rest/api/storageservices/create-file">
/// Create File</see>.
/// </summary>
/// <remarks>
/// This method only initializes the file.
/// To add content, use <see cref="UploadRangeAsync(HttpRange, Stream, byte[], IProgress{long}, ShareFileRequestConditions, CancellationToken)"/>.
/// </remarks>
/// <param name="maxSize">
/// Required. Specifies the maximum size for the file.
/// </param>
/// <param name="httpHeaders">
/// Optional standard HTTP header properties that can be set for the file.
/// </param>
/// <param name="metadata">
/// Optional custom metadata to set for the file.
/// </param>
/// <param name="smbProperties">
/// Optional SMB properties to set for the file.
/// </param>
/// <param name="filePermission">
/// Optional file permission to set for the file.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// A <see cref="Response{StorageFileInfo}"/> describing the
/// state of the file.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
#pragma warning disable AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
[EditorBrowsable(EditorBrowsableState.Never)]
public virtual async Task<Response<ShareFileInfo>> CreateAsync(
#pragma warning restore AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
long maxSize,
ShareFileHttpHeaders httpHeaders,
Metadata metadata,
FileSmbProperties smbProperties,
string filePermission,
CancellationToken cancellationToken) =>
await CreateInternal(
maxSize,
httpHeaders,
metadata,
smbProperties,
filePermission,
conditions: default,
async: true,
cancellationToken)
.ConfigureAwait(false);
/// <summary>
/// Creates a new file or replaces an existing file.
///
/// For more information, see
/// <see href="https://docs.microsoft.com/rest/api/storageservices/create-file">
/// Create File</see>.
/// </summary>
/// <remarks>
/// This method only initializes the file.
/// To add content, use <see cref="UploadRangeAsync(HttpRange, Stream, byte[], IProgress{long}, ShareFileRequestConditions, CancellationToken)"/>.
/// </remarks>
/// <param name="maxSize">
/// Required. Specifies the maximum size for the file.
/// </param>
/// <param name="httpHeaders">
/// Optional standard HTTP header properties that can be set for the file.
/// </param>
/// <param name="metadata">
/// Optional custom metadata to set for the file.
/// </param>
/// <param name="smbProperties">
/// Optional SMB properties to set for the file.
/// </param>
/// <param name="filePermission">
/// Optional file permission to set on the file.
/// </param>
/// <param name="conditions">
/// Optional <see cref="ShareFileRequestConditions"/> to add conditions
/// on creating the file.
/// </param>
/// <param name="async">
/// Whether to invoke the operation asynchronously.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <param name="operationName">
/// Optional. To indicate if the name of the operation.
/// </param>
/// <returns>
/// A <see cref="Response{StorageFileInfo}"/> describing the
/// state of the file.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
private async Task<Response<ShareFileInfo>> CreateInternal(
long maxSize,
ShareFileHttpHeaders httpHeaders,
Metadata metadata,
FileSmbProperties smbProperties,
string filePermission,
ShareFileRequestConditions conditions,
bool async,
CancellationToken cancellationToken,
string operationName = default)
{
using (ClientConfiguration.Pipeline.BeginLoggingScope(nameof(ShareFileClient)))
{
ClientConfiguration.Pipeline.LogMethodEnter(
nameof(ShareFileClient),
message:
$"{nameof(Uri)}: {Uri}\n" +
$"{nameof(maxSize)}: {maxSize}\n" +
$"{nameof(httpHeaders)}: {httpHeaders}");
operationName ??= $"{nameof(ShareFileClient)}.{nameof(Create)}";
DiagnosticScope scope = ClientConfiguration.ClientDiagnostics.CreateScope(operationName);
try
{
scope.Start();
FileSmbProperties smbProps = smbProperties ?? new FileSmbProperties();
ShareExtensions.AssertValidFilePermissionAndKey(filePermission, smbProps.FilePermissionKey);
if (filePermission == null && smbProps.FilePermissionKey == null)
{
filePermission = Constants.File.FilePermissionInherit;
}
ResponseWithHeaders<FileCreateHeaders> response;
if (async)
{
response = await FileRestClient.CreateAsync(
fileContentLength: maxSize,
fileAttributes: smbProps.FileAttributes?.ToAttributesString() ?? Constants.File.FileAttributesNone,
fileCreationTime: smbProps.FileCreatedOn.ToFileDateTimeString() ?? Constants.File.FileTimeNow,
fileLastWriteTime: smbProps.FileLastWrittenOn.ToFileDateTimeString() ?? Constants.File.FileTimeNow,
fileChangeTime: smbProps.FileChangedOn.ToFileDateTimeString(),
metadata: metadata,
filePermission: filePermission,
filePermissionKey: smbProps.FilePermissionKey,
fileHttpHeaders: httpHeaders.ToFileHttpHeaders(),
leaseAccessConditions: conditions,
cancellationToken: cancellationToken)
.ConfigureAwait(false);
}
else
{
response = FileRestClient.Create(
fileContentLength: maxSize,
fileAttributes: smbProps.FileAttributes?.ToAttributesString() ?? Constants.File.FileAttributesNone,
fileCreationTime: smbProps.FileCreatedOn.ToFileDateTimeString() ?? Constants.File.FileTimeNow,
fileLastWriteTime: smbProps.FileLastWrittenOn.ToFileDateTimeString() ?? Constants.File.FileTimeNow,
fileChangeTime: smbProps.FileChangedOn.ToFileDateTimeString(),
metadata: metadata,
filePermission: filePermission,
filePermissionKey: smbProps.FilePermissionKey,
fileHttpHeaders: httpHeaders.ToFileHttpHeaders(),
leaseAccessConditions: conditions,
cancellationToken: cancellationToken);
}
return Response.FromValue(
response.ToShareFileInfo(),
response.GetRawResponse());
}
catch (Exception ex)
{
ClientConfiguration.Pipeline.LogException(ex);
scope.Failed(ex);
throw;
}
finally
{
ClientConfiguration.Pipeline.LogMethodExit(nameof(ShareFileClient));
scope.Dispose();
}
}
}
#endregion Create
#region Exists
/// <summary>
/// The <see cref="Exists"/> operation can be called on a
/// <see cref="ShareFileClient"/> to see if the associated file
/// exists in the share on the storage account.
/// </summary>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// Returns true if the file exists.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
public virtual Response<bool> Exists(
CancellationToken cancellationToken = default) =>
ExistsInternal(
async: false,
cancellationToken: cancellationToken).EnsureCompleted();
/// <summary>
/// The <see cref="Exists"/> operation can be called on a
/// <see cref="ShareFileClient"/> to see if the associated file
/// exists in the share on the storage account.
/// </summary>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// Returns true if the file exists.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
public virtual async Task<Response<bool>> ExistsAsync(
CancellationToken cancellationToken = default) =>
await ExistsInternal(
async: true,
cancellationToken: cancellationToken).ConfigureAwait(false);
/// <summary>
/// The <see cref="ExistsInternal"/> operation can be called on a
/// <see cref="ShareFileClient"/> to see if the associated file
/// exists in the share on the storage account.
/// </summary>
/// <param name="async">
/// Whether to invoke the operation asynchronously.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <param name="operationName">
/// Optional. To indicate if the name of the operation.
/// </param>
/// <returns>
/// Returns true if the file exists.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
private async Task<Response<bool>> ExistsInternal(
bool async,
CancellationToken cancellationToken,
string operationName = default)
{
using (ClientConfiguration.Pipeline.BeginLoggingScope(nameof(ShareFileClient)))
{
ClientConfiguration.Pipeline.LogMethodEnter(
nameof(ShareFileClient),
message:
$"{nameof(Uri)}: {Uri}");
try
{
Response<ShareFileProperties> response = await GetPropertiesInternal(
conditions: default,
async: async,
cancellationToken: cancellationToken,
operationName: operationName ?? $"{nameof(ShareFileClient)}.{nameof(Exists)}")
.ConfigureAwait(false);