-
Notifications
You must be signed in to change notification settings - Fork 4.5k
/
DataLakePathClient.cs
4015 lines (3808 loc) · 178 KB
/
DataLakePathClient.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.Collections.Generic;
using System.ComponentModel;
using System.Globalization;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Core.Pipeline;
using Azure.Storage.Blobs;
using Azure.Storage.Blobs.Specialized;
using Azure.Storage.Common;
using Azure.Storage.Files.DataLake.Models;
using Azure.Storage.Sas;
using Azure.Storage.Shared;
using Metadata = System.Collections.Generic.IDictionary<string, string>;
#pragma warning disable SA1402 // File may only contain a single type
namespace Azure.Storage.Files.DataLake
{
/// <summary>
/// A PathClient represents a URI to the Azure DataLake service allowing you to manipulate a file or directory.
/// </summary>
public class DataLakePathClient
{
/// <summary>
/// A <see cref="BlockBlobClient"/> associated with the path.
/// </summary>
internal readonly BlockBlobClient _blockBlobClient;
/// <summary>
/// A <see cref="BlockBlobClient"/> associated with the path.
/// </summary>
internal virtual BlockBlobClient BlobClient => _blockBlobClient;
/// <summary>
/// A <see cref="DataLakeFileSystemClient"/> associated with Directory's parent File System.
/// </summary>
internal readonly DataLakeFileSystemClient _fileSystemClient;
/// <summary>
/// A <see cref="DataLakeFileSystemClient"/> associated with Directory's parent File System.
/// </summary>
internal virtual DataLakeFileSystemClient FileSystemClient => _fileSystemClient;
/// <summary>
/// The paths's primary <see cref="Uri"/> endpoint.
/// </summary>
private readonly Uri _uri;
/// <summary>
/// The paths's blob <see cref="Uri"/> endpoint.
/// </summary>
private readonly Uri _blobUri;
/// <summary>
/// The paths's blob <see cref="Uri"/> endpoint.
/// </summary>
internal virtual Uri BlobUri => _blobUri;
/// <summary>
/// The path's dfs <see cref="Uri"/> endpoint.
/// </summary>
private readonly Uri _dfsUri;
/// <summary>
/// DFS Uri
/// </summary>
internal virtual Uri DfsUri => _dfsUri;
/// <summary>
/// Gets the directory's primary <see cref="Uri"/> endpoint.
/// </summary>
public virtual Uri Uri => _uri;
/// <summary>
/// <see cref="DataLakeClientConfiguration"/>.
/// </summary>
private readonly DataLakeClientConfiguration _clientConfiguration;
/// <summary>
/// <see cref="DataLakeClientConfiguration"/>.
/// </summary>
internal virtual DataLakeClientConfiguration ClientConfiguration => _clientConfiguration;
/// <summary>
/// The Storage account name corresponding to the directory client.
/// </summary>
private string _accountName;
/// <summary>
/// Gets the Storage account name corresponding to the directory client.
/// </summary>
public virtual string AccountName
{
get
{
SetNameFieldsIfNull();
return _accountName;
}
}
/// <summary>
/// The file system name corresponding to the directory client.
/// </summary>
private string _fileSystemName;
/// <summary>
/// Gets the file system name name corresponding to the directory client.
/// </summary>
public virtual string FileSystemName
{
get
{
SetNameFieldsIfNull();
return _fileSystemName;
}
}
/// <summary>
/// The path corresponding to the path client.
/// </summary>
private string _path;
/// <summary>
/// Gets the path corresponding to the path client.
/// </summary>
public virtual string Path
{
get
{
SetNameFieldsIfNull();
return _path;
}
}
/// <summary>
/// The name of the file or directory.
/// </summary>
private string _name;
/// <summary>
/// Gets the name of the file or directory.
/// </summary>
public virtual string Name
{
get
{
SetNameFieldsIfNull();
return _name;
}
}
/// <summary>
/// Indicates whether the client is able to generate a SAS uri.
/// Client can generate a SAS url if it is authenticated with a <see cref="StorageSharedKeyCredential"/>.
/// </summary>
public virtual bool CanGenerateSasUri => ClientConfiguration.SharedKeyCredential != null;
/// <summary>
/// <see cref="PathRestClient"/> pointed at the DFS endpoint.
/// </summary>
private readonly PathRestClient _pathRestClient;
/// <summary>
/// <see cref="PathRestClient"/> pointed at the DFS endpoint.
/// </summary>
internal virtual PathRestClient PathRestClient => _pathRestClient;
/// <summary>
/// <see cref="PathRestClient"/> pointed at the Blob endpoint.
/// </summary>
private readonly PathRestClient _blobPathRestClient;
/// <summary>
/// <see cref="PathRestClient"/> pointed at the Blob endpoint.
/// </summary>
internal virtual PathRestClient BlobPathRestClient => _blobPathRestClient;
#region ctors
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class for mocking.
/// </summary>
protected DataLakePathClient()
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// </param>
public DataLakePathClient(Uri pathUri)
: this(pathUri, options: null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// </param>
/// <param name="options">
/// Optional <see cref="DataLakeClientOptions"/> that define the transport
/// pipeline policies for authentication, retries, etc., that are
/// applied to every request.
/// </param>
public DataLakePathClient(Uri pathUri, DataLakeClientOptions options)
: this(
pathUri,
(HttpPipelinePolicy)null,
options,
storageSharedKeyCredential: null,
sasCredential: null,
tokenCredential: null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>.
/// </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 href="https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string">
/// Configure Azure Storage connection strings</see>
/// </param>
/// <param name="fileSystemName">
/// The name of the file system containing this path.
/// </param>
/// <param name="path">
/// The path to the file or directory.
/// </param>
public DataLakePathClient(string connectionString, string fileSystemName, string path)
: this(connectionString, fileSystemName, path, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>.
/// </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 href="https://docs.microsoft.com/azure/storage/common/storage-configure-connection-string">
/// Configure Azure Storage connection strings</see>
/// </param>
/// <param name="fileSystemName">
/// The name of the file system containing this path.
/// </param>
/// <param name="path">
/// The path to the file or directory.
/// </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 DataLakePathClient(
string connectionString,
string fileSystemName,
string path,
DataLakeClientOptions options)
{
Argument.AssertNotNullOrWhiteSpace(fileSystemName, nameof(fileSystemName));
StorageConnectionString conn = StorageConnectionString.Parse(connectionString);
StorageSharedKeyCredential sharedKeyCredential = conn.Credentials as StorageSharedKeyCredential;
DataLakeUriBuilder uriBuilder = new DataLakeUriBuilder(conn.BlobEndpoint)
{
FileSystemName = fileSystemName,
DirectoryOrFilePath = path
};
options ??= new DataLakeClientOptions();
_uri = uriBuilder.ToUri();
_blobUri = uriBuilder.ToBlobUri();
_dfsUri = uriBuilder.ToDfsUri();
_clientConfiguration = new DataLakeClientConfiguration(
pipeline: options.Build(conn.Credentials),
sharedKeyCredential: sharedKeyCredential,
clientDiagnostics: new ClientDiagnostics(options),
clientOptions: options,
customerProvidedKey: options.CustomerProvidedKey);
_blockBlobClient = BlockBlobClientInternals.Create(
_blobUri,
_clientConfiguration);
(PathRestClient dfsPathRestClient, PathRestClient blobPathRestClient) = BuildPathRestClients(_dfsUri, _blobUri);
_pathRestClient = dfsPathRestClient;
_blobPathRestClient = blobPathRestClient;
DataLakeErrors.VerifyHttpsCustomerProvidedKey(_uri, _clientConfiguration.CustomerProvidedKey);
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// </param>
/// <param name="credential">
/// The shared key credential used to sign requests.
/// </param>
public DataLakePathClient(Uri pathUri, StorageSharedKeyCredential credential)
: this(
pathUri,
credential.AsPolicy(),
options: null,
storageSharedKeyCredential: credential,
sasCredential: null,
tokenCredential: null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// </param>
/// <param name="credential">
/// The shared key 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 DataLakePathClient(Uri pathUri, StorageSharedKeyCredential credential, DataLakeClientOptions options)
: this(
pathUri,
credential.AsPolicy(),
options,
storageSharedKeyCredential: credential,
sasCredential: null,
tokenCredential: null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// 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>
/// <remarks>
/// This constructor should only be used when shared access signature needs to be updated during lifespan of this client.
/// </remarks>
public DataLakePathClient(Uri pathUri, AzureSasCredential credential)
: this(pathUri, credential, null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// 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 client options 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 DataLakePathClient(Uri pathUri, AzureSasCredential credential, DataLakeClientOptions options)
: this(
pathUri,
credential.AsPolicy<DataLakeUriBuilder>(pathUri),
options,
storageSharedKeyCredential: null,
sasCredential: credential,
tokenCredential: null)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// </param>
/// <param name="credential">
/// The token credential used to sign requests.
/// </param>
public DataLakePathClient(Uri pathUri, TokenCredential credential)
: this(pathUri, credential, null)
{
Errors.VerifyHttpsTokenAuth(pathUri);
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// </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 DataLakePathClient(Uri pathUri, TokenCredential credential, DataLakeClientOptions options)
: this(
pathUri,
credential.AsPolicy(
string.IsNullOrEmpty(options?.Audience?.ToString()) ? DataLakeAudience.DefaultAudience.CreateDefaultScope() : options.Audience.Value.CreateDefaultScope(),
options),
options,
storageSharedKeyCredential: null,
sasCredential: null,
tokenCredential: credential)
{
Errors.VerifyHttpsTokenAuth(pathUri);
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>.
/// </summary>
/// <param name="fileSystemClient"><see cref="DataLakeFileSystemClient"/> of the path's File System.</param>
/// <param name="path">The path to the <see cref="DataLakePathClient"/>.</param>
public DataLakePathClient(DataLakeFileSystemClient fileSystemClient, string path)
: this((new DataLakeUriBuilder(fileSystemClient.Uri) { DirectoryOrFilePath = path }).ToDfsUri(),
fileSystemClient.ClientConfiguration)
{
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
///
/// This will create an instance that uses the same diagnostics as another
/// client. This client will be used within another API call of the parent
/// client (namely Rename). This is in the case that the new child client
/// has different credentials than the parent client.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the resource that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// </param>
/// <param name="diagnostics">
/// The diagnostics from the parent client.
/// </param>
/// <param name="options">
/// Optional <see cref="DataLakeClientOptions"/> that define the transport
/// pipeline policies for authentication, retries, etc., that are
/// applied to every request.
/// </param>
internal DataLakePathClient(
Uri pathUri,
ClientDiagnostics diagnostics,
DataLakeClientOptions options)
{
Argument.AssertNotNull(pathUri, nameof(pathUri));
DataLakeUriBuilder uriBuilder = new DataLakeUriBuilder(pathUri);
options ??= new DataLakeClientOptions();
_uri = pathUri;
_blobUri = uriBuilder.ToBlobUri();
_dfsUri = uriBuilder.ToDfsUri();
_clientConfiguration = new DataLakeClientConfiguration(
pipeline: options.Build(),
sharedKeyCredential: default,
clientDiagnostics: diagnostics,
clientOptions: options,
customerProvidedKey: options.CustomerProvidedKey);
_blockBlobClient = BlockBlobClientInternals.Create(_blobUri, _clientConfiguration);
uriBuilder.DirectoryOrFilePath = null;
_fileSystemClient = new DataLakeFileSystemClient(
uriBuilder.ToDfsUri(),
_clientConfiguration);
(PathRestClient dfsPathRestClient, PathRestClient blobPathRestClient) = BuildPathRestClients(_dfsUri, _blobUri);
_pathRestClient = dfsPathRestClient;
_blobPathRestClient = blobPathRestClient;
DataLakeErrors.VerifyHttpsCustomerProvidedKey(_uri, _clientConfiguration.CustomerProvidedKey);
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the path that includes the
/// name of the account, the name of the file system, and the path to
/// the resource.
/// </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 DataLakePathClient(
Uri pathUri,
HttpPipelinePolicy authentication,
DataLakeClientOptions options,
StorageSharedKeyCredential storageSharedKeyCredential,
AzureSasCredential sasCredential,
TokenCredential tokenCredential)
{
Argument.AssertNotNull(pathUri, nameof(pathUri));
DataLakeUriBuilder uriBuilder = new DataLakeUriBuilder(pathUri);
options ??= new DataLakeClientOptions();
_uri = pathUri;
_blobUri = uriBuilder.ToBlobUri();
_dfsUri = uriBuilder.ToDfsUri();
_clientConfiguration = new DataLakeClientConfiguration(
pipeline: options.Build(authentication),
sharedKeyCredential: storageSharedKeyCredential,
sasCredential: sasCredential,
tokenCredential: tokenCredential,
clientDiagnostics: new ClientDiagnostics(options),
clientOptions: options,
customerProvidedKey: options.CustomerProvidedKey);
_blockBlobClient = BlockBlobClientInternals.Create(_blobUri, _clientConfiguration);
uriBuilder.DirectoryOrFilePath = null;
_fileSystemClient = new DataLakeFileSystemClient(
uriBuilder.ToDfsUri(),
_clientConfiguration);
(PathRestClient dfsPathRestClient, PathRestClient blobPathRestClient) = BuildPathRestClients(_dfsUri, _blobUri);
_pathRestClient = dfsPathRestClient;
_blobPathRestClient = blobPathRestClient;
DataLakeErrors.VerifyHttpsCustomerProvidedKey(_uri, _clientConfiguration.CustomerProvidedKey);
}
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class.
/// </summary>
/// <param name="pathUri">
/// A <see cref="Uri"/> referencing the directory that includes the
/// name of the account, the name of the file system, and the path to the
/// resource.
/// </param>
/// <param name="clientConfiguration">
/// <see cref="DataLakeClientConfiguration"/>.
/// </param>
internal DataLakePathClient(
Uri pathUri,
DataLakeClientConfiguration clientConfiguration)
{
var uriBuilder = new DataLakeUriBuilder(pathUri);
_uri = pathUri;
_blobUri = uriBuilder.ToBlobUri();
_dfsUri = uriBuilder.ToDfsUri();
_clientConfiguration = clientConfiguration;
_blockBlobClient = BlockBlobClientInternals.Create(
_blobUri,
_clientConfiguration);
uriBuilder.DirectoryOrFilePath = null;
_fileSystemClient = new DataLakeFileSystemClient(
uriBuilder.ToDfsUri(),
_clientConfiguration);
(PathRestClient dfsPathRestClient, PathRestClient blobPathRestClient) = BuildPathRestClients(_dfsUri, _blobUri);
_pathRestClient = dfsPathRestClient;
_blobPathRestClient = blobPathRestClient;
DataLakeErrors.VerifyHttpsCustomerProvidedKey(_uri, _clientConfiguration.CustomerProvidedKey);
}
internal DataLakePathClient(
Uri fileSystemUri,
string directoryOrFilePath,
DataLakeClientConfiguration clientConfiguration)
{
DataLakeUriBuilder uriBuilder = new DataLakeUriBuilder(fileSystemUri)
{
DirectoryOrFilePath = directoryOrFilePath
};
_uri = uriBuilder.ToUri();
_blobUri = uriBuilder.ToBlobUri();
_dfsUri = uriBuilder.ToDfsUri();
_clientConfiguration = clientConfiguration;
_blockBlobClient = BlockBlobClientInternals.Create(
_blobUri,
_clientConfiguration);
uriBuilder.DirectoryOrFilePath = null;
_fileSystemClient = new DataLakeFileSystemClient(
uriBuilder.ToDfsUri(),
clientConfiguration);
(PathRestClient dfsPathRestClient, PathRestClient blobPathRestClient) = BuildPathRestClients(_dfsUri, _blobUri);
_pathRestClient = dfsPathRestClient;
_blobPathRestClient = blobPathRestClient;
DataLakeErrors.VerifyHttpsCustomerProvidedKey(_uri, _clientConfiguration.CustomerProvidedKey);
}
private (PathRestClient DfsPathClient, PathRestClient BlobPathClient) BuildPathRestClients(Uri dfsUri, Uri blobUri)
{
PathRestClient dfsPathRestClient = new PathRestClient(
clientDiagnostics: _clientConfiguration.ClientDiagnostics,
pipeline: _clientConfiguration.Pipeline,
url: dfsUri.AbsoluteUri,
version: _clientConfiguration.ClientOptions.Version.ToVersionString());
PathRestClient blobPathRestClient = new PathRestClient(
clientDiagnostics: _clientConfiguration.ClientDiagnostics,
pipeline: _clientConfiguration.Pipeline,
url: blobUri.AbsoluteUri,
version: _clientConfiguration.ClientOptions.Version.ToVersionString());
return (dfsPathRestClient, blobPathRestClient);
}
/// <summary>
/// Helper to access protected static members of BlockBlobClient
/// that should not be exposed directly to customers.
/// </summary>
private class BlockBlobClientInternals : BlockBlobClient
{
public static BlockBlobClient Create(
Uri uri,
DataLakeClientConfiguration clientConfiguration)
{
var options = new BlobClientOptions(clientConfiguration.ClientOptions.Version.AsBlobsVersion())
{
Diagnostics = { IsDistributedTracingEnabled = clientConfiguration.ClientDiagnostics.IsActivityEnabled },
CustomerProvidedKey = clientConfiguration.CustomerProvidedKey.ToBlobCustomerProvidedKey(),
};
clientConfiguration.TransferValidation.CopyTo(options.TransferValidation);
return BlockBlobClient.CreateClient(
uri,
options,
clientConfiguration.Pipeline);
}
}
#endregion
/// <summary>
/// Initializes a new instance of the <see cref="DataLakePathClient"/>
/// class with an identical <see cref="Uri"/> source but the specified
/// <paramref name="customerProvidedKey"/>.
///
/// </summary>
/// <param name="customerProvidedKey">The customer provided key.</param>
/// <returns>A new <see cref="DataLakePathClient"/> instance.</returns>
/// <remarks>
/// Pass null to remove the customer provide key in the returned <see cref="DataLakePathClient"/>.
/// </remarks>
public DataLakePathClient WithCustomerProvidedKey(Models.DataLakeCustomerProvidedKey? customerProvidedKey)
{
DataLakeClientConfiguration newClientConfiguration = DataLakeClientConfiguration.DeepCopy(ClientConfiguration);
newClientConfiguration.CustomerProvidedKey = customerProvidedKey;
return new DataLakePathClient(
pathUri: Uri,
clientConfiguration: newClientConfiguration);
}
/// <summary>
/// Converts metadata in DFS metadata string
/// </summary>
internal static string BuildMetadataString(Metadata metadata)
{
if (metadata == null)
{
return null;
}
StringBuilder sb = new StringBuilder();
foreach (KeyValuePair<string, string> kv in metadata)
{
sb.Append(kv.Key);
sb.Append('=');
byte[] valueBytes = Encoding.UTF8.GetBytes(kv.Value);
sb.Append(Convert.ToBase64String(valueBytes));
sb.Append(',');
}
sb.Remove(sb.Length - 1, 1);
return sb.ToString();
}
/// <summary>
/// Sets the various name fields if they are currently null.
/// </summary>
internal virtual void SetNameFieldsIfNull()
{
if (_fileSystemName == null
|| _accountName == null
|| _path == null
|| _name == null)
{
var builder = new DataLakeUriBuilder(Uri);
_fileSystemName = builder.FileSystemName;
_accountName = builder.AccountName;
_path = builder.DirectoryOrFilePath;
_name = builder.LastDirectoryOrFileName;
}
}
#region Create
/// <summary>
/// The <see cref="Create(PathResourceType, DataLakePathCreateOptions, CancellationToken)"/> operation creates a file or directory.
/// If the path already exists, it will be overwritten. If you don't intent to overwrite
/// an existing path, consider using the <see cref="CreateIfNotExists(PathResourceType, DataLakePathCreateOptions, CancellationToken)"/> API.
///
/// For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
/// </summary>
/// <param name="resourceType">
/// Resource type of this path - file or directory.
/// </param>
/// <param name="options">
/// Optional parameters.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// A <see cref="Response{PathInfo}"/> describing the
/// newly created path.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
public virtual Response<PathInfo> Create(
PathResourceType resourceType,
DataLakePathCreateOptions options = default,
CancellationToken cancellationToken = default)
{
return CreateInternal(
resourceType: resourceType,
httpHeaders: options?.HttpHeaders,
metadata: options?.Metadata,
permissions: options?.AccessOptions?.Permissions,
umask: options?.AccessOptions?.Umask,
owner: options?.AccessOptions?.Owner,
group: options?.AccessOptions?.Group,
accessControlList: options?.AccessOptions?.AccessControlList,
leaseId: options?.LeaseId,
leaseDuration: options?.LeaseDuration,
timeToExpire: options?.ScheduleDeletionOptions?.TimeToExpire,
expiresOn: options?.ScheduleDeletionOptions?.ExpiresOn,
encryptionContext: options?.EncryptionContext,
conditions: options?.Conditions,
async: false,
cancellationToken)
.EnsureCompleted();
}
/// <summary>
/// The <see cref="CreateAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken)"/> operation creates a file or directory.
/// If the path already exists, it will be overwritten. If you don't intent to overwrite
/// an existing path, consider using the <see cref="CreateIfNotExistsAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken)"/> API.
///
/// For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
/// </summary>
/// <param name="resourceType">
/// Resource type of this path - file or directory.
/// </param>
/// <param name="options">
/// Optional parameters.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// A <see cref="Response{PathInfo}"/> describing the
/// newly created path.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
public virtual async Task<Response<PathInfo>> CreateAsync(
PathResourceType resourceType,
DataLakePathCreateOptions options = default,
CancellationToken cancellationToken = default)
{
return await CreateInternal(
resourceType: resourceType,
httpHeaders: options?.HttpHeaders,
metadata: options?.Metadata,
permissions: options?.AccessOptions?.Permissions,
umask: options?.AccessOptions?.Umask,
owner: options?.AccessOptions?.Owner,
group: options?.AccessOptions?.Group,
accessControlList: options?.AccessOptions?.AccessControlList,
leaseId: options?.LeaseId,
leaseDuration: options?.LeaseDuration,
timeToExpire: options?.ScheduleDeletionOptions?.TimeToExpire,
expiresOn: options?.ScheduleDeletionOptions?.ExpiresOn,
encryptionContext: options?.EncryptionContext,
conditions: options?.Conditions,
async: true,
cancellationToken)
.ConfigureAwait(false);
}
/// <summary>
/// The <see cref="Create(PathResourceType, PathHttpHeaders, Metadata, string, string, DataLakeRequestConditions, CancellationToken)"/>
/// operation creates a file or directory.
/// If the path already exists, it will be overwritten. If you don't intent to overwrite
/// an existing path, consider using the <see cref="CreateIfNotExists(PathResourceType, DataLakePathCreateOptions, CancellationToken)"/> API.
///
/// For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
/// </summary>
/// <param name="resourceType">
/// Resource type of this path - file or directory.
/// </param>
/// <param name="httpHeaders">
/// Optional standard HTTP header properties that can be set for the
/// new file or directory..
/// </param>
/// <param name="metadata">
/// Optional custom metadata to set for this file or directory.
/// </param>
/// <param name="permissions">
/// Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access
/// permissions for the file owner, the file owning group, and others. Each class may be granted read,
/// write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit
/// octal notation (e.g. 0766) are supported.
/// </param>
/// <param name="umask">
/// Optional and only valid if Hierarchical Namespace is enabled for the account.
/// When creating a file or directory and the parent folder does not have a default ACL,
/// the umask restricts the permissions of the file or directory to be created. The resulting
/// permission is given by p bitwise-and ^u, where p is the permission and u is the umask. For example,
/// if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is
/// 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified
/// in 4-digit octal notation (e.g. 0766).
/// </param>
/// <param name="conditions">
/// Optional <see cref="DataLakeRequestConditions"/> to add
/// conditions on the creation of this file or directory.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// A <see cref="Response{PathInfo}"/> describing the
/// newly created path.
/// </returns>
/// <remarks>
/// A <see cref="RequestFailedException"/> will be thrown if
/// a failure occurs.
/// </remarks>
[EditorBrowsable(EditorBrowsableState.Never)]
#pragma warning disable AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
public virtual Response<PathInfo> Create(
#pragma warning restore AZC0002 // DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.
PathResourceType resourceType,
PathHttpHeaders httpHeaders,
Metadata metadata,
string permissions,
string umask,
DataLakeRequestConditions conditions,
CancellationToken cancellationToken)
{
return CreateInternal(
resourceType: resourceType,
httpHeaders: httpHeaders,
metadata: metadata,
permissions: permissions,
umask: umask,
owner: null,
group: null,
accessControlList: null,
leaseId: null,
leaseDuration: null,
timeToExpire: null,
expiresOn: null,
encryptionContext: null,
conditions: conditions,
async: false,
cancellationToken)
.EnsureCompleted();
}
/// <summary>
/// The <see cref="CreateAsync(PathResourceType, PathHttpHeaders, Metadata, string, string, DataLakeRequestConditions, CancellationToken)"/>
/// operation creates a file or directory.
/// If the path already exists, it will be overwritten. If you don't intent to overwrite
/// an existing path, consider using the <see cref="CreateIfNotExistsAsync(PathResourceType, DataLakePathCreateOptions, CancellationToken)"/> API.
///
/// For more information, see https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create.
/// </summary>
/// <param name="resourceType">
/// Resource type of this path - file or directory.
/// </param>
/// <param name="httpHeaders">
/// Optional standard HTTP header properties that can be set for the
/// new file or directory.
/// </param>
/// <param name="metadata">
/// Optional custom metadata to set for this file or directory.
/// </param>
/// <param name="permissions">
/// Optional and only valid if Hierarchical Namespace is enabled for the account. Sets POSIX access
/// permissions for the file owner, the file owning group, and others. Each class may be granted read,
/// write, or execute permission. The sticky bit is also supported. Both symbolic (rwxrw-rw-) and 4-digit
/// octal notation (e.g. 0766) are supported.
/// </param>
/// <param name="umask">
/// Optional and only valid if Hierarchical Namespace is enabled for the account.
/// When creating a file or directory and the parent folder does not have a default ACL,
/// the umask restricts the permissions of the file or directory to be created. The resulting
/// permission is given by p bitwise-and ^u, where p is the permission and u is the umask. For example,
/// if p is 0777 and u is 0057, then the resulting permission is 0720. The default permission is
/// 0777 for a directory and 0666 for a file. The default umask is 0027. The umask must be specified
/// in 4-digit octal notation (e.g. 0766).
/// </param>
/// <param name="conditions">
/// Optional <see cref="DataLakeRequestConditions"/> to add
/// conditions on the creation of this file or directory.
/// </param>
/// <param name="cancellationToken">
/// Optional <see cref="CancellationToken"/> to propagate
/// notifications that the operation should be cancelled.
/// </param>
/// <returns>
/// A <see cref="Response{PathInfo}"/> describing the
/// newly created path.
/// </returns>