@azure/storage-file-share 12.9.0-beta.1 → 12.9.0-beta.4
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/CHANGELOG.md +25 -4
- package/README.md +6 -5
- package/dist/index.js +955 -370
- package/dist/index.js.map +1 -1
- package/dist-esm/src/AccountSASSignatureValues.js +2 -2
- package/dist-esm/src/AccountSASSignatureValues.js.map +1 -1
- package/dist-esm/src/Clients.js +236 -112
- package/dist-esm/src/Clients.js.map +1 -1
- package/dist-esm/src/FileDownloadResponse.js +1 -1
- package/dist-esm/src/FileDownloadResponse.js.map +1 -1
- package/dist-esm/src/FileSASSignatureValues.js +1 -1
- package/dist-esm/src/FileSASSignatureValues.js.map +1 -1
- package/dist-esm/src/Pipeline.js +6 -6
- package/dist-esm/src/Pipeline.js.map +1 -1
- package/dist-esm/src/SASQueryParameters.js +2 -2
- package/dist-esm/src/SASQueryParameters.js.map +1 -1
- package/dist-esm/src/ShareServiceClient.js +8 -8
- package/dist-esm/src/ShareServiceClient.js.map +1 -1
- package/dist-esm/src/StorageClient.js.map +1 -1
- package/dist-esm/src/TelemetryPolicyFactory.js +1 -1
- package/dist-esm/src/TelemetryPolicyFactory.js.map +1 -1
- package/dist-esm/src/credentials/StorageSharedKeyCredential.js +1 -3
- package/dist-esm/src/credentials/StorageSharedKeyCredential.js.map +1 -1
- package/dist-esm/src/generated/src/models/index.js.map +1 -1
- package/dist-esm/src/generated/src/models/mappers.js +246 -0
- package/dist-esm/src/generated/src/models/mappers.js.map +1 -1
- package/dist-esm/src/generated/src/models/parameters.js +103 -37
- package/dist-esm/src/generated/src/models/parameters.js.map +1 -1
- package/dist-esm/src/generated/src/operations/directory.js +48 -0
- package/dist-esm/src/generated/src/operations/directory.js.map +1 -1
- package/dist-esm/src/generated/src/operations/file.js +51 -7
- package/dist-esm/src/generated/src/operations/file.js.map +1 -1
- package/dist-esm/src/generated/src/storageClientContext.js +2 -2
- package/dist-esm/src/generated/src/storageClientContext.js.map +1 -1
- package/dist-esm/src/generatedModels.js.map +1 -1
- package/dist-esm/src/index.browser.js.map +1 -1
- package/dist-esm/src/index.js.map +1 -1
- package/dist-esm/src/policies/StorageBrowserPolicy.js +1 -1
- package/dist-esm/src/policies/StorageBrowserPolicy.js.map +1 -1
- package/dist-esm/src/policies/StorageRetryPolicy.js +5 -5
- package/dist-esm/src/policies/StorageRetryPolicy.js.map +1 -1
- package/dist-esm/src/policies/StorageSharedKeyCredentialPolicy.js +4 -2
- package/dist-esm/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/src/policies/TelemetryPolicy.js +1 -1
- package/dist-esm/src/policies/TelemetryPolicy.js.map +1 -1
- package/dist-esm/src/utils/Batch.js.map +1 -1
- package/dist-esm/src/utils/RetriableReadableStream.js +1 -2
- package/dist-esm/src/utils/RetriableReadableStream.js.map +1 -1
- package/dist-esm/src/utils/constants.js +8 -8
- package/dist-esm/src/utils/constants.js.map +1 -1
- package/dist-esm/src/utils/tracing.js +2 -2
- package/dist-esm/src/utils/tracing.js.map +1 -1
- package/dist-esm/src/utils/utils.common.js +23 -1
- package/dist-esm/src/utils/utils.common.js.map +1 -1
- package/package.json +41 -43
- package/{typings → types}/3.1/storage-file-share.d.ts +271 -12
- package/{typings → types}/latest/storage-file-share.d.ts +235 -13
package/package.json
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@azure/storage-file-share",
|
3
3
|
"sdk-type": "client",
|
4
|
-
"version": "12.9.0-beta.
|
4
|
+
"version": "12.9.0-beta.4",
|
5
5
|
"description": "Microsoft Azure Storage SDK for JavaScript - File",
|
6
6
|
"main": "./dist/index.js",
|
7
7
|
"module": "./dist-esm/src/index.js",
|
@@ -15,11 +15,11 @@
|
|
15
15
|
"os": false,
|
16
16
|
"process": false
|
17
17
|
},
|
18
|
-
"types": "./
|
18
|
+
"types": "./types/latest/storage-file-share.d.ts",
|
19
19
|
"typesVersions": {
|
20
20
|
"<3.6": {
|
21
21
|
"*": [
|
22
|
-
"./
|
22
|
+
"./types/3.1/storage-file-share.d.ts"
|
23
23
|
]
|
24
24
|
}
|
25
25
|
},
|
@@ -28,20 +28,20 @@
|
|
28
28
|
},
|
29
29
|
"scripts": {
|
30
30
|
"audit": "node ../../../common/scripts/rush-audit.js && rimraf node_modules package-lock.json && npm i --package-lock-only 2>&1 && npm audit",
|
31
|
-
"build:browser": "tsc -p . &&
|
32
|
-
"build:node": "tsc -p . &&
|
33
|
-
"build:nodebrowser": "
|
34
|
-
"build:samples": "cross-env ONLY_NODE=true npm run build && npm run build:prep-samples",
|
31
|
+
"build:browser": "tsc -p . && dev-tool run bundle",
|
32
|
+
"build:node": "tsc -p . && dev-tool run bundle",
|
33
|
+
"build:nodebrowser": "dev-tool run bundle",
|
35
34
|
"build:prep-samples": "dev-tool samples prep && cd dist-samples && tsc",
|
36
|
-
"build:test": "tsc -p . &&
|
37
|
-
"build:types": "downlevel-dts
|
38
|
-
"build": "npm run clean && tsc -p . &&
|
39
|
-
"
|
40
|
-
"
|
41
|
-
"clean
|
35
|
+
"build:test": "tsc -p . && dev-tool run bundle",
|
36
|
+
"build:types": "downlevel-dts types/latest types/3.1",
|
37
|
+
"build": "npm run clean && tsc -p . && dev-tool run bundle && api-extractor run --local && npm run build:types",
|
38
|
+
"build:samples": "echo Obsolete.",
|
39
|
+
"check-format": "prettier --list-different --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
|
40
|
+
"clean": "rimraf dist dist-* types temp statistics.html coverage coverage-browser .nyc_output *.tgz *.log test*.xml TEST*.xml",
|
41
|
+
"clean:samples": "rimraf samples/v12/javascript/node_modules samples/v12/typescript/node_modules samples/v12/typescript/dist samples/v12/typescript/package-lock.json samples/v12/javascript/package-lock.json",
|
42
42
|
"extract-api": "tsc -p . && api-extractor run --local",
|
43
|
-
"execute:samples": "
|
44
|
-
"format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"*.{js,json}\"",
|
43
|
+
"execute:samples": "dev-tool samples run samples-dev",
|
44
|
+
"format": "prettier --write --config ../../../.prettierrc.json --ignore-path ../../../.prettierignore \"src/**/*.ts\" \"test/**/*.ts\" \"samples-dev/**/*.ts\" \"*.{js,json}\"",
|
45
45
|
"generate:client": "autorest --typescript ./swagger/README.md",
|
46
46
|
"integration-test:browser": "karma start --single-run",
|
47
47
|
"integration-test:node": "nyc mocha -r esm --require source-map-support/register --reporter ../../../common/tools/mocha-multi-reporter.js --full-trace -t 300000 \"dist-esm/test/*.spec.js\" \"dist-esm/test/node/*.spec.js\"",
|
@@ -53,17 +53,16 @@
|
|
53
53
|
"test:node": "npm run clean && npm run build:test && npm run unit-test:node",
|
54
54
|
"test": "npm run clean && npm run build:test && npm run unit-test",
|
55
55
|
"unit-test:browser": "karma start --single-run",
|
56
|
-
"unit-test:node": "mocha --require
|
57
|
-
"unit-test": "npm run unit-test:node && npm run unit-test:browser"
|
58
|
-
"docs": "typedoc --excludePrivate --excludeNotExported --excludeExternals --stripInternal --mode file --out ./dist/docs ./src"
|
56
|
+
"unit-test:node": "mocha -r esm --require ts-node/register --reporter ../../../common/tools/mocha-multi-reporter.js --timeout 1200000 --full-trace \"test/{,!(browser)/**/}*.spec.ts\"",
|
57
|
+
"unit-test": "npm run unit-test:node && npm run unit-test:browser"
|
59
58
|
},
|
60
59
|
"files": [
|
61
60
|
"BreakingChanges.md",
|
62
61
|
"ThirdPartyNotices.txt",
|
63
62
|
"dist/",
|
64
63
|
"dist-esm/src/",
|
65
|
-
"
|
66
|
-
"
|
64
|
+
"types/latest/storage-file-share.d.ts",
|
65
|
+
"types/3.1/storage-file-share.d.ts",
|
67
66
|
"README.md",
|
68
67
|
"LICENSE"
|
69
68
|
],
|
@@ -103,14 +102,22 @@
|
|
103
102
|
},
|
104
103
|
"//sampleConfiguration": {
|
105
104
|
"skip": [
|
106
|
-
"
|
107
|
-
"
|
108
|
-
"
|
105
|
+
"advancedRequestOptions.js",
|
106
|
+
"anonymousAuth.js",
|
107
|
+
"shareServiceClient.js",
|
109
108
|
"customPipeline.js",
|
110
|
-
"
|
111
|
-
"
|
112
|
-
"
|
113
|
-
]
|
109
|
+
"listFilesAndDirectories.js",
|
110
|
+
"listShares.js",
|
111
|
+
"sharedKeyAuth.js"
|
112
|
+
],
|
113
|
+
"productName": "Azure Storage File Share",
|
114
|
+
"productSlugs": [
|
115
|
+
"azure",
|
116
|
+
"azure-storage"
|
117
|
+
],
|
118
|
+
"requiredResources": {
|
119
|
+
"Azure Storage Account": "https://docs.microsoft.com/azure/storage/common/storage-account-overview"
|
120
|
+
}
|
114
121
|
},
|
115
122
|
"dependencies": {
|
116
123
|
"@azure/abort-controller": "^1.0.0",
|
@@ -122,23 +129,20 @@
|
|
122
129
|
"tslib": "^2.2.0"
|
123
130
|
},
|
124
131
|
"devDependencies": {
|
125
|
-
"@azure/storage-blob": "^12.9.0-beta.
|
132
|
+
"@azure/storage-blob": "^12.9.0-beta.3",
|
126
133
|
"@azure/dev-tool": "^1.0.0",
|
127
134
|
"@azure/eslint-plugin-azure-sdk": "^3.0.0",
|
128
135
|
"@azure/test-utils": "^1.0.0",
|
129
136
|
"@azure-tools/test-recorder": "^1.0.0",
|
130
137
|
"@azure/test-utils-perf": "^1.0.0",
|
131
138
|
"@microsoft/api-extractor": "^7.18.11",
|
132
|
-
"@
|
133
|
-
"@rollup/plugin-multi-entry": "^3.0.0",
|
134
|
-
"@rollup/plugin-node-resolve": "^8.0.0",
|
135
|
-
"@rollup/plugin-replace": "^2.2.0",
|
139
|
+
"@types/chai": "^4.1.6",
|
136
140
|
"@types/mocha": "^7.0.2",
|
137
141
|
"@types/node": "^12.0.0",
|
138
|
-
"
|
142
|
+
"chai": "^4.2.0",
|
139
143
|
"cross-env": "^7.0.2",
|
140
144
|
"dotenv": "^8.2.0",
|
141
|
-
"downlevel-dts": "
|
145
|
+
"downlevel-dts": "^0.8.0",
|
142
146
|
"es6-promise": "^4.2.5",
|
143
147
|
"eslint": "^7.15.0",
|
144
148
|
"esm": "^3.2.18",
|
@@ -157,19 +161,13 @@
|
|
157
161
|
"karma-mocha-reporter": "^2.2.5",
|
158
162
|
"karma-sourcemap-loader": "^0.3.8",
|
159
163
|
"mocha": "^7.1.1",
|
160
|
-
"mocha-junit-reporter": "^
|
161
|
-
"nyc": "^
|
162
|
-
"prettier": "^
|
164
|
+
"mocha-junit-reporter": "^2.0.0",
|
165
|
+
"nyc": "^15.0.0",
|
166
|
+
"prettier": "^2.5.1",
|
163
167
|
"puppeteer": "^10.2.0",
|
164
168
|
"rimraf": "^3.0.0",
|
165
|
-
"rollup": "^1.16.3",
|
166
|
-
"rollup-plugin-shim": "^1.0.0",
|
167
|
-
"rollup-plugin-sourcemaps": "^0.4.2",
|
168
|
-
"rollup-plugin-terser": "^5.1.1",
|
169
|
-
"rollup-plugin-visualizer": "^4.0.4",
|
170
169
|
"source-map-support": "^0.5.9",
|
171
170
|
"ts-node": "^10.0.0",
|
172
|
-
"typedoc": "0.15.2",
|
173
171
|
"typescript": "~4.2.0",
|
174
172
|
"util": "^0.12.1"
|
175
173
|
}
|
@@ -321,16 +321,16 @@ export declare interface CommonOptions {
|
|
321
321
|
}
|
322
322
|
/** Parameter group */
|
323
323
|
export declare interface CopyFileSmbInfo {
|
324
|
-
/** Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key. */
|
325
|
-
filePermissionCopyMode?: PermissionCopyModeType;
|
326
|
-
/** Specifies the option to overwrite the target file if it already exists and has read-only attribute set. */
|
327
|
-
ignoreReadOnly?: boolean;
|
328
324
|
/** Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file. */
|
329
325
|
fileAttributes?: string;
|
330
326
|
/** Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file. */
|
331
327
|
fileCreationTime?: string;
|
332
328
|
/** Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file. */
|
333
329
|
fileLastWriteTime?: string;
|
330
|
+
/** Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key. */
|
331
|
+
filePermissionCopyMode?: PermissionCopyModeType;
|
332
|
+
/** Specifies the option to overwrite the target file if it already exists and has read-only attribute set. */
|
333
|
+
ignoreReadOnly?: boolean;
|
334
334
|
/** Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state. */
|
335
335
|
setArchiveAttribute?: boolean;
|
336
336
|
}
|
@@ -767,6 +767,96 @@ export declare interface DirectoryProperties extends FileAndDirectorySetProperti
|
|
767
767
|
*/
|
768
768
|
abortSignal?: AbortSignalLike;
|
769
769
|
}
|
770
|
+
/** Defines headers for Directory_rename operation. */
|
771
|
+
export declare interface DirectoryRenameHeaders {
|
772
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
773
|
+
etag?: string;
|
774
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
775
|
+
lastModified?: Date;
|
776
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
777
|
+
requestId?: string;
|
778
|
+
/** Indicates the version of the File service used to execute the request. */
|
779
|
+
version?: string;
|
780
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
781
|
+
date?: Date;
|
782
|
+
/** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
|
783
|
+
isServerEncrypted?: boolean;
|
784
|
+
/** Key of the permission set for the file. */
|
785
|
+
filePermissionKey?: string;
|
786
|
+
/** Attributes set for the file. */
|
787
|
+
fileAttributes?: string;
|
788
|
+
/** Creation time for the file. */
|
789
|
+
fileCreationTime?: Date;
|
790
|
+
/** Last write time for the file. */
|
791
|
+
fileLastWriteTime?: Date;
|
792
|
+
/** Change time for the file. */
|
793
|
+
fileChangeTime?: Date;
|
794
|
+
/** The fileId of the file. */
|
795
|
+
fileId?: string;
|
796
|
+
/** The parent fileId of the directory. */
|
797
|
+
fileParentId?: string;
|
798
|
+
}
|
799
|
+
/**
|
800
|
+
* Options to configure the {@link ShareDirectoryClient.rename} operation.
|
801
|
+
*/
|
802
|
+
export declare interface DirectoryRenameOptions extends CommonOptions {
|
803
|
+
/**
|
804
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
805
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
806
|
+
*/
|
807
|
+
abortSignal?: AbortSignalLike;
|
808
|
+
/**
|
809
|
+
* Lease access condition for source file. Required if the source file has an active infinite lease.
|
810
|
+
*/
|
811
|
+
sourceLeaseAccessConditions?: LeaseAccessConditions;
|
812
|
+
/**
|
813
|
+
* Lease access condition for destination file. Required if the destination file has an active infinite lease.
|
814
|
+
*/
|
815
|
+
destinationLeaseAccessConditions?: LeaseAccessConditions;
|
816
|
+
/**
|
817
|
+
* Optional.
|
818
|
+
* Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.
|
819
|
+
*/
|
820
|
+
copyFileSmbInfo?: CopyFileSmbInfo;
|
821
|
+
/**
|
822
|
+
* Optional.
|
823
|
+
* The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
|
824
|
+
*/
|
825
|
+
timeoutInSeconds?: number;
|
826
|
+
/**
|
827
|
+
* Optional.
|
828
|
+
* A name-value pair to associate with a file storage object.
|
829
|
+
*/
|
830
|
+
metadata?: Metadata;
|
831
|
+
/**
|
832
|
+
* Optional.
|
833
|
+
* If specified the permission (security descriptor) shall be set for the directory/file.
|
834
|
+
*/
|
835
|
+
filePermission?: string;
|
836
|
+
/**
|
837
|
+
* Optional.
|
838
|
+
* Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
|
839
|
+
*/
|
840
|
+
filePermissionKey?: string;
|
841
|
+
/**
|
842
|
+
* Optional.
|
843
|
+
* A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value.
|
844
|
+
*/
|
845
|
+
replaceIfExists?: boolean;
|
846
|
+
/**
|
847
|
+
* Optional.
|
848
|
+
* A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.
|
849
|
+
*/
|
850
|
+
ignoreReadOnly?: boolean;
|
851
|
+
}
|
852
|
+
/** Contains response data for the rename operation. */
|
853
|
+
export declare type DirectoryRenameResponse = DirectoryRenameHeaders & {
|
854
|
+
/** The underlying HTTP response. */
|
855
|
+
_response: coreHttp.HttpResponse & {
|
856
|
+
/** The parsed HTTP response headers. */
|
857
|
+
parsedHeaders: DirectoryRenameHeaders;
|
858
|
+
};
|
859
|
+
};
|
770
860
|
/** Defines headers for Directory_setMetadata operation. */
|
771
861
|
export declare interface DirectorySetMetadataHeaders {
|
772
862
|
/** The ETag contains a value which represents the version of the directory, in quotes. */
|
@@ -1351,7 +1441,7 @@ export declare interface FileGetPropertiesHeaders {
|
|
1351
1441
|
[propertyName: string]: string;
|
1352
1442
|
};
|
1353
1443
|
/** Returns the type File. Reserved for future use. */
|
1354
|
-
fileType?:
|
1444
|
+
fileType?: string;
|
1355
1445
|
/** The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file. */
|
1356
1446
|
contentLength?: number;
|
1357
1447
|
/** The content type specified for the file. The default content type is 'application/octet-stream' */
|
@@ -1683,6 +1773,95 @@ export declare interface FileProperty {
|
|
1683
1773
|
lastModified?: Date;
|
1684
1774
|
etag?: string;
|
1685
1775
|
}
|
1776
|
+
/** Defines headers for File_rename operation. */
|
1777
|
+
export declare interface FileRenameHeaders {
|
1778
|
+
/** The ETag contains a value which represents the version of the file, in quotes. */
|
1779
|
+
etag?: string;
|
1780
|
+
/** Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory. */
|
1781
|
+
lastModified?: Date;
|
1782
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1783
|
+
requestId?: string;
|
1784
|
+
/** Indicates the version of the File service used to execute the request. */
|
1785
|
+
version?: string;
|
1786
|
+
/** A UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
1787
|
+
date?: Date;
|
1788
|
+
/** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
|
1789
|
+
isServerEncrypted?: boolean;
|
1790
|
+
/** Key of the permission set for the file. */
|
1791
|
+
filePermissionKey?: string;
|
1792
|
+
/** Attributes set for the file. */
|
1793
|
+
fileAttributes?: string;
|
1794
|
+
/** Creation time for the file. */
|
1795
|
+
fileCreationTime?: Date;
|
1796
|
+
/** Last write time for the file. */
|
1797
|
+
fileLastWriteTime?: Date;
|
1798
|
+
/** Change time for the file. */
|
1799
|
+
fileChangeTime?: Date;
|
1800
|
+
/** The fileId of the file. */
|
1801
|
+
fileId?: string;
|
1802
|
+
/** The parent fileId of the directory. */
|
1803
|
+
fileParentId?: string;
|
1804
|
+
}
|
1805
|
+
/**
|
1806
|
+
* Options to configure the {@link ShareFileClient.rename} operation.
|
1807
|
+
*/
|
1808
|
+
export declare interface FileRenameOptions extends CommonOptions {
|
1809
|
+
/**
|
1810
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
1811
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
1812
|
+
*/
|
1813
|
+
abortSignal?: AbortSignalLike;
|
1814
|
+
/**
|
1815
|
+
* Lease access condition for source file. Required if the source file has an active infinite lease.
|
1816
|
+
*/
|
1817
|
+
sourceLeaseAccessConditions?: LeaseAccessConditions;
|
1818
|
+
/**
|
1819
|
+
* Lease access condition for destination file. Required if the destination file has an active infinite lease.
|
1820
|
+
*/
|
1821
|
+
destinationLeaseAccessConditions?: LeaseAccessConditions;
|
1822
|
+
/**
|
1823
|
+
* Optional.
|
1824
|
+
* Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key.
|
1825
|
+
*/
|
1826
|
+
copyFileSmbInfo?: CopyFileSmbInfo;
|
1827
|
+
/**
|
1828
|
+
* A name-value pair to associate with a file storage object.
|
1829
|
+
*/
|
1830
|
+
metadata?: Metadata;
|
1831
|
+
/**
|
1832
|
+
* Optional.
|
1833
|
+
* The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting Timeouts for File Service Operations.</a>
|
1834
|
+
*/
|
1835
|
+
timeoutInSeconds?: number;
|
1836
|
+
/**
|
1837
|
+
* Optional.
|
1838
|
+
* If specified the permission (security descriptor) shall be set for the directory/file.
|
1839
|
+
*/
|
1840
|
+
filePermission?: string;
|
1841
|
+
/**
|
1842
|
+
* Optional.
|
1843
|
+
* Key of the permission to be set for the directory/file. Note: Only one of the filePermission or filePermissionKey should be specified.
|
1844
|
+
*/
|
1845
|
+
filePermissionKey?: string;
|
1846
|
+
/**
|
1847
|
+
* Optional.
|
1848
|
+
* A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value.
|
1849
|
+
*/
|
1850
|
+
replaceIfExists?: boolean;
|
1851
|
+
/**
|
1852
|
+
* Optional.
|
1853
|
+
* A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail.
|
1854
|
+
*/
|
1855
|
+
ignoreReadOnly?: boolean;
|
1856
|
+
}
|
1857
|
+
/** Contains response data for the rename operation. */
|
1858
|
+
export declare type FileRenameResponse = FileRenameHeaders & {
|
1859
|
+
/** The underlying HTTP response. */
|
1860
|
+
_response: coreHttp.HttpResponse & {
|
1861
|
+
/** The parsed HTTP response headers. */
|
1862
|
+
parsedHeaders: FileRenameHeaders;
|
1863
|
+
};
|
1864
|
+
};
|
1686
1865
|
/**
|
1687
1866
|
* Options to configure the {@link ShareFileClient.resize} operation.
|
1688
1867
|
*/
|
@@ -2036,13 +2215,6 @@ export declare class FileSystemAttributes {
|
|
2036
2215
|
*/
|
2037
2216
|
toString(): string;
|
2038
2217
|
}
|
2039
|
-
/**
|
2040
|
-
* Defines values for FileType.
|
2041
|
-
* Possible values include: 'File'
|
2042
|
-
* @readonly
|
2043
|
-
* @enum {string}
|
2044
|
-
*/
|
2045
|
-
export declare type FileType = "File";
|
2046
2218
|
/** Defines headers for File_uploadRangeFromURL operation. */
|
2047
2219
|
export declare interface FileUploadRangeFromURLHeaders {
|
2048
2220
|
/** The ETag contains a value which represents the version of the file, in quotes. */
|
@@ -2590,6 +2762,11 @@ export declare class SASQueryParameters {
|
|
2590
2762
|
* Inner value of getter ipRange.
|
2591
2763
|
*/
|
2592
2764
|
private readonly ipRangeInner?;
|
2765
|
+
/*
|
2766
|
+
* Optional. IP range allowed for this SAS.
|
2767
|
+
*
|
2768
|
+
* @readonly
|
2769
|
+
*/
|
2593
2770
|
readonly ipRange: SasIPRange | undefined;
|
2594
2771
|
/**
|
2595
2772
|
* Creates an instance of SASQueryParameters.
|
@@ -2787,6 +2964,9 @@ export declare class ShareClient extends StorageClient {
|
|
2787
2964
|
*/
|
2788
2965
|
private context;
|
2789
2966
|
private _name;
|
2967
|
+
/*
|
2968
|
+
* The name of the share
|
2969
|
+
*/
|
2790
2970
|
readonly name: string;
|
2791
2971
|
/**
|
2792
2972
|
* @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
|
@@ -2854,6 +3034,12 @@ export declare class ShareClient extends StorageClient {
|
|
2854
3034
|
* @returns The ShareDirectoryClient object for the given directory name.
|
2855
3035
|
*/
|
2856
3036
|
getDirectoryClient(directoryName: string): ShareDirectoryClient;
|
3037
|
+
/*
|
3038
|
+
* Gets the directory client for the root directory of this share.
|
3039
|
+
* Note that the root directory always exists and cannot be deleted.
|
3040
|
+
*
|
3041
|
+
* @readonly A new ShareDirectoryClient object for the root directory.
|
3042
|
+
*/
|
2857
3043
|
readonly rootDirectoryClient: ShareDirectoryClient;
|
2858
3044
|
/**
|
2859
3045
|
* Creates a new subdirectory under this share.
|
@@ -3255,8 +3441,17 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
3255
3441
|
private _shareName;
|
3256
3442
|
private _path;
|
3257
3443
|
private _name;
|
3444
|
+
/*
|
3445
|
+
* The share name corresponding to this directory client
|
3446
|
+
*/
|
3258
3447
|
readonly shareName: string;
|
3448
|
+
/*
|
3449
|
+
* The full path of the directory
|
3450
|
+
*/
|
3259
3451
|
readonly path: string;
|
3452
|
+
/*
|
3453
|
+
* The name of the directory
|
3454
|
+
*/
|
3260
3455
|
readonly name: string;
|
3261
3456
|
/**
|
3262
3457
|
* Creates an instance of DirectoryClient.
|
@@ -3709,6 +3904,27 @@ export declare class ShareDirectoryClient extends StorageClient {
|
|
3709
3904
|
* @param options -
|
3710
3905
|
*/
|
3711
3906
|
forceCloseHandle(handleId: string, options?: DirectoryForceCloseHandlesOptions): Promise<DirectoryForceCloseHandlesResponse>;
|
3907
|
+
/**
|
3908
|
+
* Renames a directory.
|
3909
|
+
* This API only supports renaming a directory in the same share.
|
3910
|
+
*
|
3911
|
+
* @param destinationPath - Specifies the destination path to rename to. The path will be encoded to put into a URL to specify the destination.
|
3912
|
+
* @param options - Options for the renaming operation.
|
3913
|
+
* @returns Response data for the file renaming operation.
|
3914
|
+
*
|
3915
|
+
* Example usage:
|
3916
|
+
*
|
3917
|
+
* ```js
|
3918
|
+
*
|
3919
|
+
* // Rename the directory
|
3920
|
+
* await diretoryClient.rename(destinationPath);
|
3921
|
+
* console.log("Renamed directory successfully!");
|
3922
|
+
* ```
|
3923
|
+
*/
|
3924
|
+
rename(destinationPath: string, options?: DirectoryRenameOptions): Promise<{
|
3925
|
+
destinationDirectoryClient: ShareDirectoryClient;
|
3926
|
+
directoryRenameResponse: DirectoryRenameResponse;
|
3927
|
+
}>;
|
3712
3928
|
}
|
3713
3929
|
/**
|
3714
3930
|
* Options to configure the {@link ShareClient.exists} operation.
|
@@ -3735,8 +3951,17 @@ export declare class ShareFileClient extends StorageClient {
|
|
3735
3951
|
private _shareName;
|
3736
3952
|
private _path;
|
3737
3953
|
private _name;
|
3954
|
+
/*
|
3955
|
+
* The share name corresponding to this file client
|
3956
|
+
*/
|
3738
3957
|
readonly shareName: string;
|
3958
|
+
/*
|
3959
|
+
* The full path of the file
|
3960
|
+
*/
|
3739
3961
|
readonly path: string;
|
3962
|
+
/*
|
3963
|
+
* The name of the file
|
3964
|
+
*/
|
3740
3965
|
readonly name: string;
|
3741
3966
|
/**
|
3742
3967
|
* Creates an instance of ShareFileClient.
|
@@ -4253,6 +4478,27 @@ export declare class ShareFileClient extends StorageClient {
|
|
4253
4478
|
* @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
|
4254
4479
|
*/
|
4255
4480
|
generateSasUrl(options: FileGenerateSasUrlOptions): string;
|
4481
|
+
/**
|
4482
|
+
* Renames a file.
|
4483
|
+
* This API only supports renaming a file in the same share.
|
4484
|
+
*
|
4485
|
+
* @param destinationPath - Specifies the destination path to rename to. The path will be encoded to put into a URL to specify the destination.
|
4486
|
+
* @param options - Options for the renaming operation.
|
4487
|
+
* @returns Response data for the file renaming operation.
|
4488
|
+
*
|
4489
|
+
* Example usage:
|
4490
|
+
*
|
4491
|
+
* ```js
|
4492
|
+
*
|
4493
|
+
* // Rename the file
|
4494
|
+
* await fileClient.rename(destinationPath);
|
4495
|
+
* console.log("Renamed file successfully!");
|
4496
|
+
* ```
|
4497
|
+
*/
|
4498
|
+
rename(destinationPath: string, options?: FileRenameOptions): Promise<{
|
4499
|
+
destinationFileClient: ShareFileClient;
|
4500
|
+
fileRenameResponse: FileRenameResponse;
|
4501
|
+
}>;
|
4256
4502
|
}
|
4257
4503
|
/** The list of file ranges */
|
4258
4504
|
export declare interface ShareFileRangeList {
|
@@ -4377,6 +4623,8 @@ export declare interface ShareGetPropertiesHeaders {
|
|
4377
4623
|
provisionedEgressMBps?: number;
|
4378
4624
|
/** Returns the current share next allowed quota downgrade time. */
|
4379
4625
|
nextAllowedQuotaDowngradeTime?: Date;
|
4626
|
+
/** Returns the current share provisioned bandwidth in megabits per second. */
|
4627
|
+
provisionedBandwidthMibps?: number;
|
4380
4628
|
/** When a share is leased, specifies whether the lease is of infinite or fixed duration. */
|
4381
4629
|
leaseDuration?: LeaseDurationType;
|
4382
4630
|
/** Lease state of the share. */
|
@@ -4517,7 +4765,17 @@ export declare class ShareLeaseClient {
|
|
4517
4765
|
private _url;
|
4518
4766
|
private fileOrShare;
|
4519
4767
|
private isShare;
|
4768
|
+
/*
|
4769
|
+
* Gets the lease Id.
|
4770
|
+
*
|
4771
|
+
* @readonly
|
4772
|
+
*/
|
4520
4773
|
readonly leaseId: string;
|
4774
|
+
/*
|
4775
|
+
* Gets the url.
|
4776
|
+
*
|
4777
|
+
* @readonly
|
4778
|
+
*/
|
4521
4779
|
readonly url: string;
|
4522
4780
|
/**
|
4523
4781
|
* Creates an instance of ShareLeaseClient.
|
@@ -4588,6 +4846,7 @@ export declare interface SharePropertiesInternal {
|
|
4588
4846
|
provisionedIops?: number;
|
4589
4847
|
provisionedIngressMBps?: number;
|
4590
4848
|
provisionedEgressMBps?: number;
|
4849
|
+
provisionedBandwidthMiBps?: number;
|
4591
4850
|
nextAllowedQuotaDowngradeTime?: Date;
|
4592
4851
|
deletedTime?: Date;
|
4593
4852
|
remainingRetentionDays?: number;
|