-
Notifications
You must be signed in to change notification settings - Fork 180
/
ShareClient.yml
789 lines (714 loc) · 28.6 KB
/
ShareClient.yml
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
### YamlMime:TSType
name: ShareClient
uid: '@azure/storage-file-share.ShareClient'
package: '@azure/storage-file-share'
summary: >-
A ShareClient represents a URL to the Azure Storage share allowing you to
manipulate its directories and files.
fullName: ShareClient
remarks: ''
isDeprecated: false
type: class
constructors:
- name: ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)
uid: '@azure/storage-file-share.ShareClient.constructor_1'
package: '@azure/storage-file-share'
summary: Creates an instance of ShareClient.
remarks: ''
isDeprecated: false
syntax:
content: >-
new ShareClient(url: string, credential?: Credential_2 |
TokenCredential, options?: ShareClientOptions)
parameters:
- id: url
type: string
description: |-
A URL string pointing to Azure Storage file share, such as
"https://myaccount.file.core.windows.net/share". You can
append a SAS if using AnonymousCredential, such as
"https://myaccount.file.core.windows.net/share?sasString".
- id: credential
type: >-
<xref uid="@azure/storage-file-share.Credential" /> | <xref
uid="@azure/core-auth.TokenCredential" />
description: |-
Such as AnonymousCredential or StorageSharedKeyCredential.
If not specified, AnonymousCredential is used.
- id: options
type: <xref uid="@azure/storage-file-share.ShareClientOptions" />
description: Optional. Options to configure the HTTP pipeline.
- name: ShareClient(string, Pipeline, ShareClientConfig)
uid: '@azure/storage-file-share.ShareClient.constructor_2'
package: '@azure/storage-file-share'
summary: Creates an instance of ShareClient.
remarks: ''
isDeprecated: false
syntax:
content: >-
new ShareClient(url: string, pipeline: Pipeline, options?:
ShareClientConfig)
parameters:
- id: url
type: string
description: |-
A URL string pointing to Azure Storage file share, such as
"https://myaccount.file.core.windows.net/share". You can
append a SAS if using AnonymousCredential, such as
"https://myaccount.file.core.windows.net/share?sasString".
- id: pipeline
type: <xref uid="@azure/storage-file-share.Pipeline" />
description: |-
Call newPipeline() to create a default
pipeline, or provide a customized pipeline.
- id: options
type: <xref uid="@azure/storage-file-share.ShareClientConfig" />
description: ''
- name: ShareClient(string, string, ShareClientOptions)
uid: '@azure/storage-file-share.ShareClient.constructor'
package: '@azure/storage-file-share'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
new ShareClient(connectionString: string, name: string, options?:
ShareClientOptions)
parameters:
- id: connectionString
type: string
description: >-
Account connection string or a SAS connection string of an Azure
storage account.
[ Note - Account connection string can only be used in NODE.JS runtime. ]
Account connection string example -
`DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
SAS connection string example -
`BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString`
- id: name
type: string
description: Share name.
- id: options
type: <xref uid="@azure/storage-file-share.ShareClientOptions" />
description: Optional. Options to configure the HTTP pipeline.
properties:
- name: name
uid: '@azure/storage-file-share.ShareClient.name'
package: '@azure/storage-file-share'
summary: The name of the share
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: string name
return:
description: ''
type: string
- name: rootDirectoryClient
uid: '@azure/storage-file-share.ShareClient.rootDirectoryClient'
package: '@azure/storage-file-share'
summary: |-
Gets the directory client for the root directory of this share.
Note that the root directory always exists and cannot be deleted.
A new ShareDirectoryClient object for the root directory.
fullName: rootDirectoryClient
remarks: ''
isDeprecated: false
syntax:
content: ShareDirectoryClient rootDirectoryClient
return:
description: ''
type: <xref uid="@azure/storage-file-share.ShareDirectoryClient" />
inheritedProperties:
- name: accountName
uid: '@azure/storage-file-share.ShareClient.accountName'
package: '@azure/storage-file-share'
summary: ''
fullName: accountName
remarks: ''
isDeprecated: false
syntax:
content: 'accountName: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> StorageClient.accountName
- name: url
uid: '@azure/storage-file-share.ShareClient.url'
package: '@azure/storage-file-share'
summary: URL string value.
fullName: url
remarks: ''
isDeprecated: false
syntax:
content: 'url: string'
return:
description: ''
type: string
inheritanceDescription: <b>Inherited From</b> StorageClient.url
methods:
- name: create(ShareCreateOptions)
uid: '@azure/storage-file-share.ShareClient.create'
package: '@azure/storage-file-share'
summary: |-
Creates a new share under the specified account. If the share with
the same name already exists, the operation fails.
See https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
remarks: ''
isDeprecated: false
syntax:
content: >-
function create(options?: ShareCreateOptions):
Promise<ShareCreateResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareCreateOptions" />
description: Options to Share Create operation.
return:
description: Response data for the Share Create operation.
type: >-
Promise<<xref uid="@azure/storage-file-share.ShareCreateResponse"
/>>
- name: createDirectory(string, DirectoryCreateOptions)
uid: '@azure/storage-file-share.ShareClient.createDirectory'
package: '@azure/storage-file-share'
summary: >-
Creates a new subdirectory under this share.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
remarks: ''
isDeprecated: false
syntax:
content: >-
function createDirectory(directoryName: string, options?:
DirectoryCreateOptions): Promise<{ directoryClient:
ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse
}>
parameters:
- id: directoryName
type: string
description: ''
- id: options
type: <xref uid="@azure/storage-file-share.DirectoryCreateOptions" />
description: Options to Directory Create operation.
return:
description: >-
Directory creation response data and the corresponding directory
client.
type: >-
Promise<{ directoryClient: ShareDirectoryClient,
directoryCreateResponse: DirectoryCreateResponse }>
- name: createFile(string, number, FileCreateOptions)
uid: '@azure/storage-file-share.ShareClient.createFile'
package: '@azure/storage-file-share'
summary: >-
Creates a new file or replaces a file under the root directory of this
share.
Note it only initializes the file with no content.
See https://docs.microsoft.com/en-us/rest/api/storageservices/create-file
remarks: ''
isDeprecated: false
syntax:
content: >-
function createFile(fileName: string, size: number, options?:
FileCreateOptions): Promise<{ fileClient: ShareFileClient,
fileCreateResponse: FileCreateResponse }>
parameters:
- id: fileName
type: string
description: ''
- id: size
type: number
description: Specifies the maximum size in bytes for the file, up to 4 TB.
- id: options
type: <xref uid="@azure/storage-file-share.FileCreateOptions" />
description: Options to File Create operation.
return:
description: File creation response data and the corresponding file client.
type: >-
Promise<{ fileClient: ShareFileClient, fileCreateResponse:
FileCreateResponse }>
- name: createIfNotExists(ShareCreateOptions)
uid: '@azure/storage-file-share.ShareClient.createIfNotExists'
package: '@azure/storage-file-share'
summary: |-
Creates a new share under the specified account. If the share with
the same name already exists, it is not changed.
See https://docs.microsoft.com/en-us/rest/api/storageservices/create-share
remarks: ''
isDeprecated: false
syntax:
content: >-
function createIfNotExists(options?: ShareCreateOptions):
Promise<ShareCreateIfNotExistsResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareCreateOptions" />
description: ''
return:
description: ''
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareCreateIfNotExistsResponse" />>
- name: createPermission(string, ShareCreatePermissionOptions)
uid: '@azure/storage-file-share.ShareClient.createPermission'
package: '@azure/storage-file-share'
summary: >-
Creates a file permission (a security descriptor) at the share level.
The created security descriptor can be used for the files/directories in
the share.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission
remarks: ''
isDeprecated: false
syntax:
content: >-
function createPermission(filePermission: string, options?:
ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>
parameters:
- id: filePermission
type: string
description: File permission described in the SDDL
- id: options
type: >-
<xref uid="@azure/storage-file-share.ShareCreatePermissionOptions"
/>
description: Options to Share Create Permission operation.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareCreatePermissionResponse" />>
- name: createSnapshot(ShareCreateSnapshotOptions)
uid: '@azure/storage-file-share.ShareClient.createSnapshot'
package: '@azure/storage-file-share'
summary: Creates a read-only snapshot of a share.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createSnapshot(options?: ShareCreateSnapshotOptions):
Promise<ShareCreateSnapshotResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareCreateSnapshotOptions" />
description: Options to Share Create Snapshot operation.
return:
description: Response data for the Share Create Snapshot operation.
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareCreateSnapshotResponse" />>
- name: delete(ShareDeleteMethodOptions)
uid: '@azure/storage-file-share.ShareClient.delete'
package: '@azure/storage-file-share'
summary: >-
Marks the specified share for deletion. The share and any directories or
files
contained within it are later deleted during garbage collection.
See https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share
remarks: ''
isDeprecated: false
syntax:
content: >-
function delete(options?: ShareDeleteMethodOptions):
Promise<ShareDeleteResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareDeleteMethodOptions" />
description: Options to Share Delete operation.
return:
description: Response data for the Share Delete operation.
type: >-
Promise<<xref uid="@azure/storage-file-share.ShareDeleteResponse"
/>>
- name: deleteDirectory(string, DirectoryDeleteOptions)
uid: '@azure/storage-file-share.ShareClient.deleteDirectory'
package: '@azure/storage-file-share'
summary: >-
Removes the specified empty sub directory under this share.
Note that the directory must be empty before it can be deleted.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteDirectory(directoryName: string, options?:
DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>
parameters:
- id: directoryName
type: string
description: ''
- id: options
type: <xref uid="@azure/storage-file-share.DirectoryDeleteOptions" />
description: Options to Directory Delete operation.
return:
description: Directory deletion response data.
type: >-
Promise<<xref
uid="@azure/storage-file-share.DirectoryDeleteResponse" />>
- name: deleteFile(string, FileDeleteOptions)
uid: '@azure/storage-file-share.ShareClient.deleteFile'
package: '@azure/storage-file-share'
summary: >-
Removes a file under the root directory of this share from the storage
account.
When a file is successfully deleted, it is immediately removed from the
storage
account's index and is no longer accessible to clients. The file's data is
later
removed from the service during garbage collection.
Delete File will fail with status code 409 (Conflict) and error code
`SharingViolation`
if the file is open on an SMB client.
Delete File is not supported on a share snapshot, which is a read-only
copy of
a share. An attempt to perform this operation on a share snapshot will
fail with 400
(`InvalidQueryParameterValue`)
See https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteFile(fileName: string, options?: FileDeleteOptions):
Promise<FileDeleteResponse>
parameters:
- id: fileName
type: string
description: ''
- id: options
type: <xref uid="@azure/storage-file-share.FileDeleteOptions" />
description: Options to File Delete operation.
return:
description: Promise<FileDeleteResponse> File Delete response data.
type: >-
Promise<<xref uid="@azure/storage-file-share.FileDeleteResponse"
/>>
- name: deleteIfExists(ShareDeleteMethodOptions)
uid: '@azure/storage-file-share.ShareClient.deleteIfExists'
package: '@azure/storage-file-share'
summary: >-
Marks the specified share for deletion if it exists. The share and any
directories or files
contained within it are later deleted during garbage collection.
See https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteIfExists(options?: ShareDeleteMethodOptions):
Promise<ShareDeleteIfExistsResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareDeleteMethodOptions" />
description: ''
return:
description: ''
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareDeleteIfExistsResponse" />>
- name: exists(ShareExistsOptions)
uid: '@azure/storage-file-share.ShareClient.exists'
package: '@azure/storage-file-share'
summary: >-
Returns true if the Azrue share resource represented by this client
exists; false otherwise.
NOTE: use this function with care since an existing share might be deleted
by other clients or
applications. Vice versa new shares might be added by other clients or
applications after this
function completes.
remarks: ''
isDeprecated: false
syntax:
content: 'function exists(options?: ShareExistsOptions): Promise<boolean>'
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareExistsOptions" />
description: options to Exists operation.
return:
description: ''
type: Promise<boolean>
- name: generateSasUrl(ShareGenerateSasUrlOptions)
uid: '@azure/storage-file-share.ShareClient.generateSasUrl'
package: '@azure/storage-file-share'
summary: >-
Only available for ShareClient constructed with a shared key credential.
Generates a Service Shared Access Signature (SAS) URI based on the client
properties
and parameters passed in. The SAS is signed by the shared key credential
of the client.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
remarks: ''
isDeprecated: false
syntax:
content: 'function generateSasUrl(options: ShareGenerateSasUrlOptions): string'
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareGenerateSasUrlOptions" />
description: Optional parameters.
return:
description: >-
The SAS URI consisting of the URI to the resource represented by this
client, followed by the generated SAS token.
type: string
- name: getAccessPolicy(ShareGetAccessPolicyOptions)
uid: '@azure/storage-file-share.ShareClient.getAccessPolicy'
package: '@azure/storage-file-share'
summary: >-
Gets the permissions for the specified share. The permissions indicate
whether share data may be accessed publicly.
WARNING: JavaScript Date will potential lost precision when parsing start
and expiry string.
For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will
get "2018-12-31T03:44:23.882Z".
See
https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl
remarks: ''
isDeprecated: false
syntax:
content: >-
function getAccessPolicy(options?: ShareGetAccessPolicyOptions):
Promise<ShareGetAccessPolicyResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareGetAccessPolicyOptions" />
description: ''
return:
description: Response data for the Share Get Access Policy operation.
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareGetAccessPolicyResponse" />>
- name: getDirectoryClient(string)
uid: '@azure/storage-file-share.ShareClient.getDirectoryClient'
package: '@azure/storage-file-share'
summary: >-
Creates a
[ShareDirectoryClient](xref:@azure/storage-file-share.ShareDirectoryClient)
object.
remarks: ''
isDeprecated: false
syntax:
content: 'function getDirectoryClient(directoryName: string): ShareDirectoryClient'
parameters:
- id: directoryName
type: string
description: A directory name
return:
description: The ShareDirectoryClient object for the given directory name.
type: <xref uid="@azure/storage-file-share.ShareDirectoryClient" />
- name: getPermission(string, ShareGetPermissionOptions)
uid: '@azure/storage-file-share.ShareClient.getPermission'
package: '@azure/storage-file-share'
summary: >-
Gets the Security Descriptor Definition Language (SDDL) for a given file
permission key
which indicates a security descriptor.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission
remarks: ''
isDeprecated: false
syntax:
content: >-
function getPermission(filePermissionKey: string, options?:
ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>
parameters:
- id: filePermissionKey
type: string
description: >-
File permission key which indicates the security descriptor of the
permission.
- id: options
type: <xref uid="@azure/storage-file-share.ShareGetPermissionOptions" />
description: Options to Share Create Permission operation.
return:
description: ''
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareGetPermissionResponse" />>
- name: getProperties(ShareGetPropertiesOptions)
uid: '@azure/storage-file-share.ShareClient.getProperties'
package: '@azure/storage-file-share'
summary: >-
Returns all user-defined metadata and system properties for the specified
share.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties
WARNING: The `metadata` object returned in the response will have its keys
in lowercase, even if
they originally contained uppercase characters. This differs from the
metadata keys returned by
the `listShares` method of
[ShareServiceClient](xref:@azure/storage-file-share.ShareServiceClient)
using the `includeMetadata` option, which
will retain their original casing.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getProperties(options?: ShareGetPropertiesOptions):
Promise<ShareGetPropertiesResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareGetPropertiesOptions" />
description: ''
return:
description: Response data for the Share Get Properties operation.
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareGetPropertiesResponse" />>
- name: getStatistics(ShareGetStatisticsOptions)
uid: '@azure/storage-file-share.ShareClient.getStatistics'
package: '@azure/storage-file-share'
summary: Retrieves statistics related to the share.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getStatistics(options?: ShareGetStatisticsOptions):
Promise<ShareGetStatisticsResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareGetStatisticsOptions" />
description: ''
return:
description: Response data for the Share Get Statistics operation.
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareGetStatisticsResponse" />>
- name: setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)
uid: '@azure/storage-file-share.ShareClient.setAccessPolicy'
package: '@azure/storage-file-share'
summary: >-
Sets the permissions for the specified share. The permissions indicate
whether directories or files in a share may be accessed publicly.
When you set permissions for a share, the existing permissions are
replaced.
If no shareAcl provided, the existing share ACL will be
removed.
When you establish a stored access policy on a share, it may take up to 30
seconds to take effect.
During this interval, a shared access signature that is associated with
the stored access policy will
fail with status code 403 (Forbidden), until the access policy becomes
active.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl
remarks: ''
isDeprecated: false
syntax:
content: >-
function setAccessPolicy(shareAcl?: SignedIdentifier[], options?:
ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>
parameters:
- id: shareAcl
type: <xref uid="@azure/storage-file-share.SignedIdentifier" />[]
description: >-
Array of signed identifiers, each having a unique Id and details of
access policy.
- id: options
type: <xref uid="@azure/storage-file-share.ShareSetAccessPolicyOptions" />
description: ''
return:
description: Response data for the Share Set Access Policy operation.
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareSetAccessPolicyResponse" />>
- name: setMetadata(Metadata, ShareSetMetadataOptions)
uid: '@azure/storage-file-share.ShareClient.setMetadata'
package: '@azure/storage-file-share'
summary: >-
Sets one or more user-defined name-value pairs for the specified share.
If no option provided, or no metadata defined in the option parameter, the
share
metadata will be removed.
See
https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata
remarks: ''
isDeprecated: false
syntax:
content: >-
function setMetadata(metadata?: Metadata, options?:
ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>
parameters:
- id: metadata
type: <xref uid="@azure/storage-file-share.Metadata" />
description: >-
If no metadata provided, all existing directory metadata will be
removed.
- id: options
type: <xref uid="@azure/storage-file-share.ShareSetMetadataOptions" />
description: ''
return:
description: Response data for the Share Set Metadata operation.
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareSetMetadataResponse" />>
- name: setProperties(ShareSetPropertiesOptions)
uid: '@azure/storage-file-share.ShareClient.setProperties'
package: '@azure/storage-file-share'
summary: Sets properties of the share.
remarks: ''
isDeprecated: false
syntax:
content: >-
function setProperties(options?: ShareSetPropertiesOptions):
Promise<ShareSetPropertiesResponse>
parameters:
- id: options
type: <xref uid="@azure/storage-file-share.ShareSetPropertiesOptions" />
description: ''
return:
description: Response data for the Share Set Properties operation.
type: >-
Promise<<xref
uid="@azure/storage-file-share.ShareSetPropertiesResponse" />>
- name: setQuota(number, ShareSetQuotaOptions)
uid: '@azure/storage-file-share.ShareClient.setQuota'
package: '@azure/storage-file-share'
summary: Sets quota for the specified share.
remarks: ''
isDeprecated: true
customDeprecatedMessage: >-
Use
[setProperties](xref:@azure/storage-file-share.ShareClient.setProperties)
instead.
syntax:
content: >-
function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions):
Promise<ShareSetQuotaResponse>
parameters:
- id: quotaInGB
type: number
description: Specifies the maximum size of the share in gigabytes
- id: options
type: <xref uid="@azure/storage-file-share.ShareSetQuotaOptions" />
description: ''
return:
description: Response data for the Share Get Quota operation.
type: >-
Promise<<xref uid="@azure/storage-file-share.ShareSetQuotaResponse"
/>>
- name: withSnapshot(string)
uid: '@azure/storage-file-share.ShareClient.withSnapshot'
package: '@azure/storage-file-share'
summary: >-
Creates a new ShareClient object identical to the source but with the
specified snapshot timestamp.
Provide "" will remove the snapshot and return a URL to the base share.
remarks: ''
isDeprecated: false
syntax:
content: 'function withSnapshot(snapshot: string): ShareClient'
parameters:
- id: snapshot
type: string
description: The snapshot timestamp.
return:
description: >-
A new ShareClient object identical to the source but with the
specified snapshot timestamp
type: <xref uid="@azure/storage-file-share.ShareClient" />
extends: StorageClient