@azure/storage-file-datalake 12.27.0-alpha.20250530.1 → 12.27.0-alpha.20250611.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser/DataLakeFileSystemClient.d.ts +13 -13
- package/dist/browser/DataLakeFileSystemClient.js +13 -13
- package/dist/browser/DataLakeFileSystemClient.js.map +1 -1
- package/dist/browser/DataLakeServiceClient.d.ts +6 -6
- package/dist/browser/DataLakeServiceClient.js +6 -6
- package/dist/browser/DataLakeServiceClient.js.map +1 -1
- package/dist/browser/clients.d.ts +33 -33
- package/dist/browser/clients.js +23 -23
- package/dist/browser/clients.js.map +1 -1
- package/dist/browser/models.d.ts +1 -1
- package/dist/browser/models.js.map +1 -1
- package/dist/browser/sas/AccountSASPermissions.d.ts +1 -1
- package/dist/browser/sas/AccountSASPermissions.js +2 -2
- package/dist/browser/sas/AccountSASPermissions.js.map +1 -1
- package/dist/browser/sas/AccountSASResourceTypes.d.ts +1 -1
- package/dist/browser/sas/AccountSASResourceTypes.js +1 -1
- package/dist/browser/sas/AccountSASResourceTypes.js.map +1 -1
- package/dist/browser/sas/AccountSASSignatureValues.d.ts +3 -3
- package/dist/browser/sas/AccountSASSignatureValues.js +1 -1
- package/dist/browser/sas/AccountSASSignatureValues.js.map +1 -1
- package/dist/browser/sas/DataLakeSASSignatureValues.d.ts +1 -1
- package/dist/browser/sas/DataLakeSASSignatureValues.js +1 -1
- package/dist/browser/sas/DataLakeSASSignatureValues.js.map +1 -1
- package/dist/browser/sas/DirectorySASPermissions.d.ts +1 -1
- package/dist/browser/sas/DirectorySASPermissions.js +1 -1
- package/dist/browser/sas/DirectorySASPermissions.js.map +1 -1
- package/dist/browser/sas/FileSystemSASPermissions.d.ts +1 -1
- package/dist/browser/sas/FileSystemSASPermissions.js +1 -1
- package/dist/browser/sas/FileSystemSASPermissions.js.map +1 -1
- package/dist/browser/sas/SASQueryParameters.d.ts +2 -2
- package/dist/browser/sas/SASQueryParameters.js.map +1 -1
- package/dist/browser/utils/utils.common.d.ts +2 -2
- package/dist/browser/utils/utils.common.js +3 -3
- package/dist/browser/utils/utils.common.js.map +1 -1
- package/dist/commonjs/DataLakeFileSystemClient.d.ts +13 -13
- package/dist/commonjs/DataLakeFileSystemClient.js +13 -13
- package/dist/commonjs/DataLakeFileSystemClient.js.map +1 -1
- package/dist/commonjs/DataLakeServiceClient.d.ts +6 -6
- package/dist/commonjs/DataLakeServiceClient.js +6 -6
- package/dist/commonjs/DataLakeServiceClient.js.map +1 -1
- package/dist/commonjs/clients.d.ts +33 -33
- package/dist/commonjs/clients.js +23 -23
- package/dist/commonjs/clients.js.map +1 -1
- package/dist/commonjs/credentials/UserDelegationKeyCredential.d.ts +1 -1
- package/dist/commonjs/credentials/UserDelegationKeyCredential.js +1 -1
- package/dist/commonjs/credentials/UserDelegationKeyCredential.js.map +1 -1
- package/dist/commonjs/models.d.ts +1 -1
- package/dist/commonjs/models.js.map +1 -1
- package/dist/commonjs/sas/AccountSASPermissions.d.ts +1 -1
- package/dist/commonjs/sas/AccountSASPermissions.js +2 -2
- package/dist/commonjs/sas/AccountSASPermissions.js.map +1 -1
- package/dist/commonjs/sas/AccountSASResourceTypes.d.ts +1 -1
- package/dist/commonjs/sas/AccountSASResourceTypes.js +1 -1
- package/dist/commonjs/sas/AccountSASResourceTypes.js.map +1 -1
- package/dist/commonjs/sas/AccountSASSignatureValues.d.ts +3 -3
- package/dist/commonjs/sas/AccountSASSignatureValues.js +1 -1
- package/dist/commonjs/sas/AccountSASSignatureValues.js.map +1 -1
- package/dist/commonjs/sas/DataLakeSASSignatureValues.d.ts +1 -1
- package/dist/commonjs/sas/DataLakeSASSignatureValues.js +1 -1
- package/dist/commonjs/sas/DataLakeSASSignatureValues.js.map +1 -1
- package/dist/commonjs/sas/DirectorySASPermissions.d.ts +1 -1
- package/dist/commonjs/sas/DirectorySASPermissions.js +1 -1
- package/dist/commonjs/sas/DirectorySASPermissions.js.map +1 -1
- package/dist/commonjs/sas/FileSystemSASPermissions.d.ts +1 -1
- package/dist/commonjs/sas/FileSystemSASPermissions.js +1 -1
- package/dist/commonjs/sas/FileSystemSASPermissions.js.map +1 -1
- package/dist/commonjs/sas/SASQueryParameters.d.ts +2 -2
- package/dist/commonjs/sas/SASQueryParameters.js.map +1 -1
- package/dist/commonjs/utils/utils.common.d.ts +2 -2
- package/dist/commonjs/utils/utils.common.js +3 -3
- package/dist/commonjs/utils/utils.common.js.map +1 -1
- package/dist/esm/DataLakeFileSystemClient.d.ts +13 -13
- package/dist/esm/DataLakeFileSystemClient.js +13 -13
- package/dist/esm/DataLakeFileSystemClient.js.map +1 -1
- package/dist/esm/DataLakeServiceClient.d.ts +6 -6
- package/dist/esm/DataLakeServiceClient.js +6 -6
- package/dist/esm/DataLakeServiceClient.js.map +1 -1
- package/dist/esm/clients.d.ts +33 -33
- package/dist/esm/clients.js +23 -23
- package/dist/esm/clients.js.map +1 -1
- package/dist/esm/credentials/UserDelegationKeyCredential.d.ts +1 -1
- package/dist/esm/credentials/UserDelegationKeyCredential.js +1 -1
- package/dist/esm/credentials/UserDelegationKeyCredential.js.map +1 -1
- package/dist/esm/models.d.ts +1 -1
- package/dist/esm/models.js.map +1 -1
- package/dist/esm/sas/AccountSASPermissions.d.ts +1 -1
- package/dist/esm/sas/AccountSASPermissions.js +2 -2
- package/dist/esm/sas/AccountSASPermissions.js.map +1 -1
- package/dist/esm/sas/AccountSASResourceTypes.d.ts +1 -1
- package/dist/esm/sas/AccountSASResourceTypes.js +1 -1
- package/dist/esm/sas/AccountSASResourceTypes.js.map +1 -1
- package/dist/esm/sas/AccountSASSignatureValues.d.ts +3 -3
- package/dist/esm/sas/AccountSASSignatureValues.js +1 -1
- package/dist/esm/sas/AccountSASSignatureValues.js.map +1 -1
- package/dist/esm/sas/DataLakeSASSignatureValues.d.ts +1 -1
- package/dist/esm/sas/DataLakeSASSignatureValues.js +1 -1
- package/dist/esm/sas/DataLakeSASSignatureValues.js.map +1 -1
- package/dist/esm/sas/DirectorySASPermissions.d.ts +1 -1
- package/dist/esm/sas/DirectorySASPermissions.js +1 -1
- package/dist/esm/sas/DirectorySASPermissions.js.map +1 -1
- package/dist/esm/sas/FileSystemSASPermissions.d.ts +1 -1
- package/dist/esm/sas/FileSystemSASPermissions.js +1 -1
- package/dist/esm/sas/FileSystemSASPermissions.js.map +1 -1
- package/dist/esm/sas/SASQueryParameters.d.ts +2 -2
- package/dist/esm/sas/SASQueryParameters.js.map +1 -1
- package/dist/esm/utils/utils.common.d.ts +2 -2
- package/dist/esm/utils/utils.common.js +3 -3
- package/dist/esm/utils/utils.common.js.map +1 -1
- package/dist/react-native/DataLakeFileSystemClient.d.ts +13 -13
- package/dist/react-native/DataLakeFileSystemClient.js +13 -13
- package/dist/react-native/DataLakeFileSystemClient.js.map +1 -1
- package/dist/react-native/DataLakeServiceClient.d.ts +6 -6
- package/dist/react-native/DataLakeServiceClient.js +6 -6
- package/dist/react-native/DataLakeServiceClient.js.map +1 -1
- package/dist/react-native/clients.d.ts +33 -33
- package/dist/react-native/clients.js +23 -23
- package/dist/react-native/clients.js.map +1 -1
- package/dist/react-native/credentials/UserDelegationKeyCredential.d.ts +1 -1
- package/dist/react-native/credentials/UserDelegationKeyCredential.js +1 -1
- package/dist/react-native/credentials/UserDelegationKeyCredential.js.map +1 -1
- package/dist/react-native/models.d.ts +1 -1
- package/dist/react-native/models.js.map +1 -1
- package/dist/react-native/sas/AccountSASPermissions.d.ts +1 -1
- package/dist/react-native/sas/AccountSASPermissions.js +2 -2
- package/dist/react-native/sas/AccountSASPermissions.js.map +1 -1
- package/dist/react-native/sas/AccountSASResourceTypes.d.ts +1 -1
- package/dist/react-native/sas/AccountSASResourceTypes.js +1 -1
- package/dist/react-native/sas/AccountSASResourceTypes.js.map +1 -1
- package/dist/react-native/sas/AccountSASSignatureValues.d.ts +3 -3
- package/dist/react-native/sas/AccountSASSignatureValues.js +1 -1
- package/dist/react-native/sas/AccountSASSignatureValues.js.map +1 -1
- package/dist/react-native/sas/DataLakeSASSignatureValues.d.ts +1 -1
- package/dist/react-native/sas/DataLakeSASSignatureValues.js +1 -1
- package/dist/react-native/sas/DataLakeSASSignatureValues.js.map +1 -1
- package/dist/react-native/sas/DirectorySASPermissions.d.ts +1 -1
- package/dist/react-native/sas/DirectorySASPermissions.js +1 -1
- package/dist/react-native/sas/DirectorySASPermissions.js.map +1 -1
- package/dist/react-native/sas/FileSystemSASPermissions.d.ts +1 -1
- package/dist/react-native/sas/FileSystemSASPermissions.js +1 -1
- package/dist/react-native/sas/FileSystemSASPermissions.js.map +1 -1
- package/dist/react-native/sas/SASQueryParameters.d.ts +2 -2
- package/dist/react-native/sas/SASQueryParameters.js.map +1 -1
- package/dist/react-native/utils/utils.common.d.ts +2 -2
- package/dist/react-native/utils/utils.common.js +3 -3
- package/dist/react-native/utils/utils.common.js.map +1 -1
- package/package.json +1 -1
|
@@ -81,7 +81,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
81
81
|
/**
|
|
82
82
|
* Create a directory or path.
|
|
83
83
|
*
|
|
84
|
-
* @see https://learn.microsoft.com/
|
|
84
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
85
85
|
*
|
|
86
86
|
* @param resourceType - Resource type, "directory" or "file".
|
|
87
87
|
* @param options - Optional. Options when creating path.
|
|
@@ -90,7 +90,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
90
90
|
/**
|
|
91
91
|
* Create a directory or file. If the resource already exists, it is not changed.
|
|
92
92
|
*
|
|
93
|
-
* @see https://learn.microsoft.com/
|
|
93
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
94
94
|
*
|
|
95
95
|
* @param resourceType - Resource type, "directory" or "file".
|
|
96
96
|
* @param options -
|
|
@@ -109,7 +109,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
109
109
|
/**
|
|
110
110
|
* Delete current path (directory or file).
|
|
111
111
|
*
|
|
112
|
-
* @see https://learn.microsoft.com/
|
|
112
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
|
|
113
113
|
*
|
|
114
114
|
* @param recursive - Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
|
|
115
115
|
* @param options - Optional. Options when deleting path.
|
|
@@ -118,7 +118,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
118
118
|
/**
|
|
119
119
|
* Delete current path (directory or file) if it exists.
|
|
120
120
|
*
|
|
121
|
-
* @see https://learn.microsoft.com/
|
|
121
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
|
|
122
122
|
*
|
|
123
123
|
* @param recursive - Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
|
|
124
124
|
* @param options -
|
|
@@ -127,7 +127,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
127
127
|
/**
|
|
128
128
|
* Returns the access control data for a path (directory of file).
|
|
129
129
|
*
|
|
130
|
-
* @see https://learn.microsoft.com/
|
|
130
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
|
|
131
131
|
*
|
|
132
132
|
* @param options - Optional. Options when getting file access control.
|
|
133
133
|
*/
|
|
@@ -135,7 +135,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
135
135
|
/**
|
|
136
136
|
* Set the access control data for a path (directory of file).
|
|
137
137
|
*
|
|
138
|
-
* @see https://learn.microsoft.com/
|
|
138
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
139
139
|
*
|
|
140
140
|
* @param acl - The POSIX access control list for the file or directory.
|
|
141
141
|
* @param options - Optional. Options when setting path access control.
|
|
@@ -144,7 +144,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
144
144
|
/**
|
|
145
145
|
* Sets the Access Control on a path and sub paths.
|
|
146
146
|
*
|
|
147
|
-
* @see https://learn.microsoft.com/
|
|
147
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
148
148
|
*
|
|
149
149
|
* @param acl - The POSIX access control list for the file or directory.
|
|
150
150
|
* @param options - Optional. Options
|
|
@@ -153,7 +153,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
153
153
|
/**
|
|
154
154
|
* Modifies the Access Control on a path and sub paths.
|
|
155
155
|
*
|
|
156
|
-
* @see https://learn.microsoft.com/
|
|
156
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
157
157
|
*
|
|
158
158
|
* @param acl - The POSIX access control list for the file or directory.
|
|
159
159
|
* @param options - Optional. Options
|
|
@@ -162,7 +162,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
162
162
|
/**
|
|
163
163
|
* Removes the Access Control on a path and sub paths.
|
|
164
164
|
*
|
|
165
|
-
* @see https://learn.microsoft.com/
|
|
165
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
166
166
|
*
|
|
167
167
|
* @param acl - The POSIX access control list for the file or directory.
|
|
168
168
|
* @param options - Optional. Options
|
|
@@ -171,7 +171,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
171
171
|
/**
|
|
172
172
|
* Sets the file permissions on a path.
|
|
173
173
|
*
|
|
174
|
-
* @see https://learn.microsoft.com/
|
|
174
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
175
175
|
*
|
|
176
176
|
* @param permissions - The POSIX access permissions for the file owner, the file owning group, and others.
|
|
177
177
|
* @param options - Optional. Options when setting path permissions.
|
|
@@ -186,7 +186,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
186
186
|
* the methods of {@link DataLakeFileSystemClient} that list paths using the `includeMetadata` option, which
|
|
187
187
|
* will retain their original casing.
|
|
188
188
|
*
|
|
189
|
-
* @see https://learn.microsoft.com/
|
|
189
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
|
|
190
190
|
*
|
|
191
191
|
* @param options - Optional. Options when getting path properties.
|
|
192
192
|
*/
|
|
@@ -196,7 +196,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
196
196
|
*
|
|
197
197
|
* If no value provided, or no value provided for the specified blob HTTP headers,
|
|
198
198
|
* these blob HTTP headers without a value will be cleared.
|
|
199
|
-
* @see https://learn.microsoft.com/
|
|
199
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
|
|
200
200
|
*
|
|
201
201
|
* @param httpHeaders -
|
|
202
202
|
* @param options -
|
|
@@ -208,7 +208,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
208
208
|
* If no option provided, or no metadata defined in the parameter, the path
|
|
209
209
|
* metadata will be removed.
|
|
210
210
|
*
|
|
211
|
-
* @see https://learn.microsoft.com/
|
|
211
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
|
|
212
212
|
*
|
|
213
213
|
* @param metadata - Optional. Replace existing metadata with this value.
|
|
214
214
|
* If no value provided the existing metadata will be removed.
|
|
@@ -218,7 +218,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
218
218
|
/**
|
|
219
219
|
* Move directory or file within same file system.
|
|
220
220
|
*
|
|
221
|
-
* @see https://learn.microsoft.com/
|
|
221
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
222
222
|
*
|
|
223
223
|
* @param destinationPath - Destination directory path like "directory" or file path "directory/file".
|
|
224
224
|
* If the destinationPath is authenticated with SAS, add the SAS to the destination path like "directory/file?sasToken".
|
|
@@ -228,7 +228,7 @@ export declare class DataLakePathClient extends StorageClient {
|
|
|
228
228
|
/**
|
|
229
229
|
* Move directory or file to another file system.
|
|
230
230
|
*
|
|
231
|
-
* @see https://learn.microsoft.com/
|
|
231
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
232
232
|
*
|
|
233
233
|
* @param destinationFileSystem - Destination file system like "filesystem".
|
|
234
234
|
* @param destinationPath - Destination directory path like "directory" or file path "directory/file"
|
|
@@ -244,7 +244,7 @@ export declare class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
244
244
|
/**
|
|
245
245
|
* Create a directory.
|
|
246
246
|
*
|
|
247
|
-
* @see https://learn.microsoft.com/
|
|
247
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
248
248
|
*
|
|
249
249
|
* @param resourceType - Resource type, must be "directory" for DataLakeDirectoryClient.
|
|
250
250
|
* @param options - Optional. Options when creating directory.
|
|
@@ -253,7 +253,7 @@ export declare class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
253
253
|
/**
|
|
254
254
|
* Create a directory.
|
|
255
255
|
*
|
|
256
|
-
* @see https://learn.microsoft.com/
|
|
256
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
257
257
|
*
|
|
258
258
|
* @param options - Optional. Options when creating directory.
|
|
259
259
|
*/
|
|
@@ -261,7 +261,7 @@ export declare class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
261
261
|
/**
|
|
262
262
|
* Create a directory if it doesn't already exists.
|
|
263
263
|
*
|
|
264
|
-
* @see https://learn.microsoft.com/
|
|
264
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
265
265
|
*
|
|
266
266
|
* @param resourceType - Resource type, must be "directory" for DataLakeDirectoryClient.
|
|
267
267
|
* @param options -
|
|
@@ -270,7 +270,7 @@ export declare class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
270
270
|
/**
|
|
271
271
|
* Create a directory if it doesn't already exists.
|
|
272
272
|
*
|
|
273
|
-
* @see https://learn.microsoft.com/
|
|
273
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
274
274
|
*
|
|
275
275
|
* @param options -
|
|
276
276
|
*/
|
|
@@ -293,7 +293,7 @@ export declare class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
293
293
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
294
294
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
295
295
|
*
|
|
296
|
-
* @see https://learn.microsoft.com/
|
|
296
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
297
297
|
*
|
|
298
298
|
* @param options - Optional parameters.
|
|
299
299
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -303,7 +303,7 @@ export declare class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
303
303
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
304
304
|
* and parameters passed in.
|
|
305
305
|
*
|
|
306
|
-
* @see https://learn.microsoft.com/
|
|
306
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
307
307
|
*
|
|
308
308
|
* @param options - Optional parameters.
|
|
309
309
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -313,7 +313,7 @@ export declare class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
313
313
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
314
314
|
* and parameters passed in. The SAS is signed by the input user delegation key.
|
|
315
315
|
*
|
|
316
|
-
* @see https://learn.microsoft.com/
|
|
316
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
317
317
|
*
|
|
318
318
|
* @param options - Optional parameters.
|
|
319
319
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
|
@@ -324,7 +324,7 @@ export declare class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
324
324
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
325
325
|
* and parameters passed in The SAS is signed by the input user delegation key.
|
|
326
326
|
*
|
|
327
|
-
* @see https://learn.microsoft.com/
|
|
327
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
328
328
|
*
|
|
329
329
|
* @param options - Optional parameters.
|
|
330
330
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
|
@@ -371,7 +371,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
371
371
|
/**
|
|
372
372
|
* Create a file.
|
|
373
373
|
*
|
|
374
|
-
* @see https://learn.microsoft.com/
|
|
374
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
375
375
|
*
|
|
376
376
|
* @param resourceType - Resource type, must be "file" for DataLakeFileClient.
|
|
377
377
|
* @param options - Optional. Options when creating file.
|
|
@@ -380,7 +380,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
380
380
|
/**
|
|
381
381
|
* Create a file.
|
|
382
382
|
*
|
|
383
|
-
* @see https://learn.microsoft.com/
|
|
383
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
384
384
|
*
|
|
385
385
|
* @param options - Optional. Options when creating file.
|
|
386
386
|
*/
|
|
@@ -388,7 +388,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
388
388
|
/**
|
|
389
389
|
* Create a file if it doesn't already exists.
|
|
390
390
|
*
|
|
391
|
-
* @see https://learn.microsoft.com/
|
|
391
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
392
392
|
*
|
|
393
393
|
* @param resourceType - Resource type, must be "file" for DataLakeFileClient.
|
|
394
394
|
* @param options -
|
|
@@ -397,7 +397,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
397
397
|
/**
|
|
398
398
|
* Create a file if it doesn't already exists.
|
|
399
399
|
*
|
|
400
|
-
* @see https://learn.microsoft.com/
|
|
400
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
401
401
|
*
|
|
402
402
|
* @param options - Optional. Options when creating file.
|
|
403
403
|
*/
|
|
@@ -408,7 +408,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
408
408
|
* * In Node.js, data returns in a Readable stream readableStreamBody
|
|
409
409
|
* * In browsers, data returns in a promise contentAsBlob
|
|
410
410
|
*
|
|
411
|
-
* @see https://learn.microsoft.com/
|
|
411
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-blob
|
|
412
412
|
*
|
|
413
413
|
* * Example usage (Node.js):
|
|
414
414
|
*
|
|
@@ -485,7 +485,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
485
485
|
* Uploads data to be appended to a file. Data can only be appended to a file.
|
|
486
486
|
* To apply perviously uploaded data to a file, call flush.
|
|
487
487
|
*
|
|
488
|
-
* @see https://learn.microsoft.com/
|
|
488
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
489
489
|
*
|
|
490
490
|
* @param body - Content to be uploaded.
|
|
491
491
|
* @param offset - Append offset in bytes.
|
|
@@ -645,7 +645,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
645
645
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
646
646
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
647
647
|
*
|
|
648
|
-
* @see https://learn.microsoft.com/
|
|
648
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
649
649
|
*
|
|
650
650
|
* @param options - Optional parameters.
|
|
651
651
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -657,7 +657,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
657
657
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
658
658
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
659
659
|
*
|
|
660
|
-
* @see https://learn.microsoft.com/
|
|
660
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
661
661
|
*
|
|
662
662
|
* @param options - Optional parameters.
|
|
663
663
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -667,7 +667,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
667
667
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
668
668
|
* and parameters passed in. The SAS is signed by the input user delegation key.
|
|
669
669
|
*
|
|
670
|
-
* @see https://learn.microsoft.com/
|
|
670
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
671
671
|
*
|
|
672
672
|
* @param options - Optional parameters.
|
|
673
673
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
|
@@ -678,7 +678,7 @@ export declare class DataLakeFileClient extends DataLakePathClient {
|
|
|
678
678
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
679
679
|
* and parameters passed in. The SAS is signed by the input user delegation key.
|
|
680
680
|
*
|
|
681
|
-
* @see https://learn.microsoft.com/
|
|
681
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
682
682
|
*
|
|
683
683
|
* @param options - Optional parameters.
|
|
684
684
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
package/dist/commonjs/clients.js
CHANGED
|
@@ -155,7 +155,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
155
155
|
/**
|
|
156
156
|
* Create a directory or path.
|
|
157
157
|
*
|
|
158
|
-
* @see https://learn.microsoft.com/
|
|
158
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
159
159
|
*
|
|
160
160
|
* @param resourceType - Resource type, "directory" or "file".
|
|
161
161
|
* @param options - Optional. Options when creating path.
|
|
@@ -184,7 +184,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
184
184
|
/**
|
|
185
185
|
* Create a directory or file. If the resource already exists, it is not changed.
|
|
186
186
|
*
|
|
187
|
-
* @see https://learn.microsoft.com/
|
|
187
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/create
|
|
188
188
|
*
|
|
189
189
|
* @param resourceType - Resource type, "directory" or "file".
|
|
190
190
|
* @param options -
|
|
@@ -222,7 +222,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
222
222
|
/**
|
|
223
223
|
* Delete current path (directory or file).
|
|
224
224
|
*
|
|
225
|
-
* @see https://learn.microsoft.com/
|
|
225
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
|
|
226
226
|
*
|
|
227
227
|
* @param recursive - Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
|
|
228
228
|
* @param options - Optional. Options when deleting path.
|
|
@@ -256,7 +256,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
256
256
|
/**
|
|
257
257
|
* Delete current path (directory or file) if it exists.
|
|
258
258
|
*
|
|
259
|
-
* @see https://learn.microsoft.com/
|
|
259
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/delete
|
|
260
260
|
*
|
|
261
261
|
* @param recursive - Required and valid only when the resource is a directory. If "true", all paths beneath the directory will be deleted.
|
|
262
262
|
* @param options -
|
|
@@ -280,7 +280,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
280
280
|
/**
|
|
281
281
|
* Returns the access control data for a path (directory of file).
|
|
282
282
|
*
|
|
283
|
-
* @see https://learn.microsoft.com/
|
|
283
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/getproperties
|
|
284
284
|
*
|
|
285
285
|
* @param options - Optional. Options when getting file access control.
|
|
286
286
|
*/
|
|
@@ -294,7 +294,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
294
294
|
/**
|
|
295
295
|
* Set the access control data for a path (directory of file).
|
|
296
296
|
*
|
|
297
|
-
* @see https://learn.microsoft.com/
|
|
297
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
298
298
|
*
|
|
299
299
|
* @param acl - The POSIX access control list for the file or directory.
|
|
300
300
|
* @param options - Optional. Options when setting path access control.
|
|
@@ -308,7 +308,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
308
308
|
/**
|
|
309
309
|
* Sets the Access Control on a path and sub paths.
|
|
310
310
|
*
|
|
311
|
-
* @see https://learn.microsoft.com/
|
|
311
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
312
312
|
*
|
|
313
313
|
* @param acl - The POSIX access control list for the file or directory.
|
|
314
314
|
* @param options - Optional. Options
|
|
@@ -321,7 +321,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
321
321
|
/**
|
|
322
322
|
* Modifies the Access Control on a path and sub paths.
|
|
323
323
|
*
|
|
324
|
-
* @see https://learn.microsoft.com/
|
|
324
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
325
325
|
*
|
|
326
326
|
* @param acl - The POSIX access control list for the file or directory.
|
|
327
327
|
* @param options - Optional. Options
|
|
@@ -334,7 +334,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
334
334
|
/**
|
|
335
335
|
* Removes the Access Control on a path and sub paths.
|
|
336
336
|
*
|
|
337
|
-
* @see https://learn.microsoft.com/
|
|
337
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
338
338
|
*
|
|
339
339
|
* @param acl - The POSIX access control list for the file or directory.
|
|
340
340
|
* @param options - Optional. Options
|
|
@@ -347,7 +347,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
347
347
|
/**
|
|
348
348
|
* Sets the file permissions on a path.
|
|
349
349
|
*
|
|
350
|
-
* @see https://learn.microsoft.com/
|
|
350
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
351
351
|
*
|
|
352
352
|
* @param permissions - The POSIX access permissions for the file owner, the file owning group, and others.
|
|
353
353
|
* @param options - Optional. Options when setting path permissions.
|
|
@@ -367,7 +367,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
367
367
|
* the methods of {@link DataLakeFileSystemClient} that list paths using the `includeMetadata` option, which
|
|
368
368
|
* will retain their original casing.
|
|
369
369
|
*
|
|
370
|
-
* @see https://learn.microsoft.com/
|
|
370
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-blob-properties
|
|
371
371
|
*
|
|
372
372
|
* @param options - Optional. Options when getting path properties.
|
|
373
373
|
*/
|
|
@@ -382,7 +382,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
382
382
|
*
|
|
383
383
|
* If no value provided, or no value provided for the specified blob HTTP headers,
|
|
384
384
|
* these blob HTTP headers without a value will be cleared.
|
|
385
|
-
* @see https://learn.microsoft.com/
|
|
385
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-blob-properties
|
|
386
386
|
*
|
|
387
387
|
* @param httpHeaders -
|
|
388
388
|
* @param options -
|
|
@@ -405,7 +405,7 @@ class DataLakePathClient extends StorageClient_js_1.StorageClient {
|
|
|
405
405
|
* If no option provided, or no metadata defined in the parameter, the path
|
|
406
406
|
* metadata will be removed.
|
|
407
407
|
*
|
|
408
|
-
* @see https://learn.microsoft.com/
|
|
408
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/set-blob-metadata
|
|
409
409
|
*
|
|
410
410
|
* @param metadata - Optional. Replace existing metadata with this value.
|
|
411
411
|
* If no value provided the existing metadata will be removed.
|
|
@@ -511,7 +511,7 @@ class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
511
511
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
512
512
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
513
513
|
*
|
|
514
|
-
* @see https://learn.microsoft.com/
|
|
514
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
515
515
|
*
|
|
516
516
|
* @param options - Optional parameters.
|
|
517
517
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -529,7 +529,7 @@ class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
529
529
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
530
530
|
* and parameters passed in.
|
|
531
531
|
*
|
|
532
|
-
* @see https://learn.microsoft.com/
|
|
532
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
533
533
|
*
|
|
534
534
|
* @param options - Optional parameters.
|
|
535
535
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -545,7 +545,7 @@ class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
545
545
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
546
546
|
* and parameters passed in. The SAS is signed by the input user delegation key.
|
|
547
547
|
*
|
|
548
|
-
* @see https://learn.microsoft.com/
|
|
548
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
549
549
|
*
|
|
550
550
|
* @param options - Optional parameters.
|
|
551
551
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
|
@@ -561,7 +561,7 @@ class DataLakeDirectoryClient extends DataLakePathClient {
|
|
|
561
561
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
562
562
|
* and parameters passed in The SAS is signed by the input user delegation key.
|
|
563
563
|
*
|
|
564
|
-
* @see https://learn.microsoft.com/
|
|
564
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
565
565
|
*
|
|
566
566
|
* @param options - Optional parameters.
|
|
567
567
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
|
@@ -630,7 +630,7 @@ class DataLakeFileClient extends DataLakePathClient {
|
|
|
630
630
|
* * In Node.js, data returns in a Readable stream readableStreamBody
|
|
631
631
|
* * In browsers, data returns in a promise contentAsBlob
|
|
632
632
|
*
|
|
633
|
-
* @see https://learn.microsoft.com/
|
|
633
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/get-blob
|
|
634
634
|
*
|
|
635
635
|
* * Example usage (Node.js):
|
|
636
636
|
*
|
|
@@ -721,7 +721,7 @@ class DataLakeFileClient extends DataLakePathClient {
|
|
|
721
721
|
* Uploads data to be appended to a file. Data can only be appended to a file.
|
|
722
722
|
* To apply perviously uploaded data to a file, call flush.
|
|
723
723
|
*
|
|
724
|
-
* @see https://learn.microsoft.com/
|
|
724
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/datalakestoragegen2/path/update
|
|
725
725
|
*
|
|
726
726
|
* @param body - Content to be uploaded.
|
|
727
727
|
* @param offset - Append offset in bytes.
|
|
@@ -1129,7 +1129,7 @@ class DataLakeFileClient extends DataLakePathClient {
|
|
|
1129
1129
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
1130
1130
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
1131
1131
|
*
|
|
1132
|
-
* @see https://learn.microsoft.com/
|
|
1132
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
1133
1133
|
*
|
|
1134
1134
|
* @param options - Optional parameters.
|
|
1135
1135
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -1149,7 +1149,7 @@ class DataLakeFileClient extends DataLakePathClient {
|
|
|
1149
1149
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
1150
1150
|
* and parameters passed in. The SAS is signed by the shared key credential of the client.
|
|
1151
1151
|
*
|
|
1152
|
-
* @see https://learn.microsoft.com/
|
|
1152
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
1153
1153
|
*
|
|
1154
1154
|
* @param options - Optional parameters.
|
|
1155
1155
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
|
@@ -1165,7 +1165,7 @@ class DataLakeFileClient extends DataLakePathClient {
|
|
|
1165
1165
|
* Generates a Service Shared Access Signature (SAS) URI based on the client properties
|
|
1166
1166
|
* and parameters passed in. The SAS is signed by the input user delegation key.
|
|
1167
1167
|
*
|
|
1168
|
-
* @see https://learn.microsoft.com/
|
|
1168
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
1169
1169
|
*
|
|
1170
1170
|
* @param options - Optional parameters.
|
|
1171
1171
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|
|
@@ -1181,7 +1181,7 @@ class DataLakeFileClient extends DataLakePathClient {
|
|
|
1181
1181
|
* Generates string to sign for a Service Shared Access Signature (SAS) URI based on the client properties
|
|
1182
1182
|
* and parameters passed in. The SAS is signed by the input user delegation key.
|
|
1183
1183
|
*
|
|
1184
|
-
* @see https://learn.microsoft.com/
|
|
1184
|
+
* @see https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
|
|
1185
1185
|
*
|
|
1186
1186
|
* @param options - Optional parameters.
|
|
1187
1187
|
* @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
|