diff --git a/action.yml b/action.yml
index 5c4669759..6ee88fe3d 100644
--- a/action.yml
+++ b/action.yml
@@ -26,6 +26,10 @@ inputs:
allow-prereleases:
description: "When 'true', a version range passed to 'python-version' input will match prerelease versions if no GA versions are found. Only 'x.y' version range is supported for CPython."
default: false
+ ignore-platform-version:
+ description: "Ignore the specific platform version to allow usage on Debian"
+ default: ""
+ required: false
outputs:
python-version:
description: "The installed Python or PyPy version. Useful when given a version range as input."
diff --git a/dist/cache-save/index.js b/dist/cache-save/index.js
index aa4501f96..97f59b476 100644
--- a/dist/cache-save/index.js
+++ b/dist/cache-save/index.js
@@ -809,7 +809,7 @@ const util = __importStar(__nccwpck_require__(3837));
const utils = __importStar(__nccwpck_require__(1518));
const constants_1 = __nccwpck_require__(8840);
const requestUtils_1 = __nccwpck_require__(3981);
-const abort_controller_1 = __nccwpck_require__(2557);
+const abort_controller_1 = __nccwpck_require__(6079);
/**
* Pipes the body of a HTTP response to a stream
*
@@ -2736,6 +2736,253 @@ class SearchState {
exports.SearchState = SearchState;
//# sourceMappingURL=internal-search-state.js.map
+/***/ }),
+
+/***/ 6079:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+///
+const listenersMap = new WeakMap();
+const abortedMap = new WeakMap();
+/**
+ * An aborter instance implements AbortSignal interface, can abort HTTP requests.
+ *
+ * - Call AbortSignal.none to create a new AbortSignal instance that cannot be cancelled.
+ * Use `AbortSignal.none` when you are required to pass a cancellation token but the operation
+ * cannot or will not ever be cancelled.
+ *
+ * @example
+ * Abort without timeout
+ * ```ts
+ * await doAsyncWork(AbortSignal.none);
+ * ```
+ */
+class AbortSignal {
+ constructor() {
+ /**
+ * onabort event listener.
+ */
+ this.onabort = null;
+ listenersMap.set(this, []);
+ abortedMap.set(this, false);
+ }
+ /**
+ * Status of whether aborted or not.
+ *
+ * @readonly
+ */
+ get aborted() {
+ if (!abortedMap.has(this)) {
+ throw new TypeError("Expected `this` to be an instance of AbortSignal.");
+ }
+ return abortedMap.get(this);
+ }
+ /**
+ * Creates a new AbortSignal instance that will never be aborted.
+ *
+ * @readonly
+ */
+ static get none() {
+ return new AbortSignal();
+ }
+ /**
+ * Added new "abort" event listener, only support "abort" event.
+ *
+ * @param _type - Only support "abort" event
+ * @param listener - The listener to be added
+ */
+ addEventListener(
+ // tslint:disable-next-line:variable-name
+ _type, listener) {
+ if (!listenersMap.has(this)) {
+ throw new TypeError("Expected `this` to be an instance of AbortSignal.");
+ }
+ const listeners = listenersMap.get(this);
+ listeners.push(listener);
+ }
+ /**
+ * Remove "abort" event listener, only support "abort" event.
+ *
+ * @param _type - Only support "abort" event
+ * @param listener - The listener to be removed
+ */
+ removeEventListener(
+ // tslint:disable-next-line:variable-name
+ _type, listener) {
+ if (!listenersMap.has(this)) {
+ throw new TypeError("Expected `this` to be an instance of AbortSignal.");
+ }
+ const listeners = listenersMap.get(this);
+ const index = listeners.indexOf(listener);
+ if (index > -1) {
+ listeners.splice(index, 1);
+ }
+ }
+ /**
+ * Dispatches a synthetic event to the AbortSignal.
+ */
+ dispatchEvent(_event) {
+ throw new Error("This is a stub dispatchEvent implementation that should not be used. It only exists for type-checking purposes.");
+ }
+}
+/**
+ * Helper to trigger an abort event immediately, the onabort and all abort event listeners will be triggered.
+ * Will try to trigger abort event for all linked AbortSignal nodes.
+ *
+ * - If there is a timeout, the timer will be cancelled.
+ * - If aborted is true, nothing will happen.
+ *
+ * @internal
+ */
+// eslint-disable-next-line @azure/azure-sdk/ts-use-interface-parameters
+function abortSignal(signal) {
+ if (signal.aborted) {
+ return;
+ }
+ if (signal.onabort) {
+ signal.onabort.call(signal);
+ }
+ const listeners = listenersMap.get(signal);
+ if (listeners) {
+ // Create a copy of listeners so mutations to the array
+ // (e.g. via removeListener calls) don't affect the listeners
+ // we invoke.
+ listeners.slice().forEach((listener) => {
+ listener.call(signal, { type: "abort" });
+ });
+ }
+ abortedMap.set(signal, true);
+}
+
+// Copyright (c) Microsoft Corporation.
+/**
+ * This error is thrown when an asynchronous operation has been aborted.
+ * Check for this error by testing the `name` that the name property of the
+ * error matches `"AbortError"`.
+ *
+ * @example
+ * ```ts
+ * const controller = new AbortController();
+ * controller.abort();
+ * try {
+ * doAsyncWork(controller.signal)
+ * } catch (e) {
+ * if (e.name === 'AbortError') {
+ * // handle abort error here.
+ * }
+ * }
+ * ```
+ */
+class AbortError extends Error {
+ constructor(message) {
+ super(message);
+ this.name = "AbortError";
+ }
+}
+/**
+ * An AbortController provides an AbortSignal and the associated controls to signal
+ * that an asynchronous operation should be aborted.
+ *
+ * @example
+ * Abort an operation when another event fires
+ * ```ts
+ * const controller = new AbortController();
+ * const signal = controller.signal;
+ * doAsyncWork(signal);
+ * button.addEventListener('click', () => controller.abort());
+ * ```
+ *
+ * @example
+ * Share aborter cross multiple operations in 30s
+ * ```ts
+ * // Upload the same data to 2 different data centers at the same time,
+ * // abort another when any of them is finished
+ * const controller = AbortController.withTimeout(30 * 1000);
+ * doAsyncWork(controller.signal).then(controller.abort);
+ * doAsyncWork(controller.signal).then(controller.abort);
+ *```
+ *
+ * @example
+ * Cascaded aborting
+ * ```ts
+ * // All operations can't take more than 30 seconds
+ * const aborter = Aborter.timeout(30 * 1000);
+ *
+ * // Following 2 operations can't take more than 25 seconds
+ * await doAsyncWork(aborter.withTimeout(25 * 1000));
+ * await doAsyncWork(aborter.withTimeout(25 * 1000));
+ * ```
+ */
+class AbortController {
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+ constructor(parentSignals) {
+ this._signal = new AbortSignal();
+ if (!parentSignals) {
+ return;
+ }
+ // coerce parentSignals into an array
+ if (!Array.isArray(parentSignals)) {
+ // eslint-disable-next-line prefer-rest-params
+ parentSignals = arguments;
+ }
+ for (const parentSignal of parentSignals) {
+ // if the parent signal has already had abort() called,
+ // then call abort on this signal as well.
+ if (parentSignal.aborted) {
+ this.abort();
+ }
+ else {
+ // when the parent signal aborts, this signal should as well.
+ parentSignal.addEventListener("abort", () => {
+ this.abort();
+ });
+ }
+ }
+ }
+ /**
+ * The AbortSignal associated with this controller that will signal aborted
+ * when the abort method is called on this controller.
+ *
+ * @readonly
+ */
+ get signal() {
+ return this._signal;
+ }
+ /**
+ * Signal that any operations passed this controller's associated abort signal
+ * to cancel any remaining work and throw an `AbortError`.
+ */
+ abort() {
+ abortSignal(this._signal);
+ }
+ /**
+ * Creates a new AbortSignal instance that will abort after the provided ms.
+ * @param ms - Elapsed time in milliseconds to trigger an abort.
+ */
+ static timeout(ms) {
+ const signal = new AbortSignal();
+ const timer = setTimeout(abortSignal, ms, signal);
+ // Prevent the active Timer from keeping the Node.js event loop active.
+ if (typeof timer.unref === "function") {
+ timer.unref();
+ }
+ return signal;
+ }
+}
+
+exports.AbortController = AbortController;
+exports.AbortError = AbortError;
+exports.AbortSignal = AbortSignal;
+//# sourceMappingURL=index.js.map
+
+
/***/ }),
/***/ 3771:
@@ -7417,7 +7664,7 @@ class HttpClient {
}
const usingSsl = parsedUrl.protocol === 'https:';
proxyAgent = new undici_1.ProxyAgent(Object.assign({ uri: proxyUrl.href, pipelining: !this._keepAlive ? 0 : 1 }, ((proxyUrl.username || proxyUrl.password) && {
- token: `${proxyUrl.username}:${proxyUrl.password}`
+ token: `Basic ${Buffer.from(`${proxyUrl.username}:${proxyUrl.password}`).toString('base64')}`
})));
this._proxyAgentDispatcher = proxyAgent;
if (usingSsl && this._ignoreSslError) {
@@ -7531,11 +7778,11 @@ function getProxyUrl(reqUrl) {
})();
if (proxyVar) {
try {
- return new URL(proxyVar);
+ return new DecodedURL(proxyVar);
}
catch (_a) {
if (!proxyVar.startsWith('http://') && !proxyVar.startsWith('https://'))
- return new URL(`http://${proxyVar}`);
+ return new DecodedURL(`http://${proxyVar}`);
}
}
else {
@@ -7594,201 +7841,214 @@ function isLoopbackAddress(host) {
hostLower.startsWith('[::1]') ||
hostLower.startsWith('[0:0:0:0:0:0:0:1]'));
}
-//# sourceMappingURL=proxy.js.map
-
-/***/ }),
-
-/***/ 1962:
-/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
-
-"use strict";
-
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
- Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
- o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
- if (mod && mod.__esModule) return mod;
- var result = {};
- if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
- __setModuleDefault(result, mod);
- return result;
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
- return new (P || (P = Promise))(function (resolve, reject) {
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
- step((generator = generator.apply(thisArg, _arguments || [])).next());
- });
-};
-var _a;
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getCmdPath = exports.tryGetExecutablePath = exports.isRooted = exports.isDirectory = exports.exists = exports.READONLY = exports.UV_FS_O_EXLOCK = exports.IS_WINDOWS = exports.unlink = exports.symlink = exports.stat = exports.rmdir = exports.rm = exports.rename = exports.readlink = exports.readdir = exports.open = exports.mkdir = exports.lstat = exports.copyFile = exports.chmod = void 0;
-const fs = __importStar(__nccwpck_require__(7147));
-const path = __importStar(__nccwpck_require__(1017));
-_a = fs.promises
-// export const {open} = 'fs'
-, exports.chmod = _a.chmod, exports.copyFile = _a.copyFile, exports.lstat = _a.lstat, exports.mkdir = _a.mkdir, exports.open = _a.open, exports.readdir = _a.readdir, exports.readlink = _a.readlink, exports.rename = _a.rename, exports.rm = _a.rm, exports.rmdir = _a.rmdir, exports.stat = _a.stat, exports.symlink = _a.symlink, exports.unlink = _a.unlink;
-// export const {open} = 'fs'
-exports.IS_WINDOWS = process.platform === 'win32';
-// See https://github.com/nodejs/node/blob/d0153aee367422d0858105abec186da4dff0a0c5/deps/uv/include/uv/win.h#L691
-exports.UV_FS_O_EXLOCK = 0x10000000;
-exports.READONLY = fs.constants.O_RDONLY;
-function exists(fsPath) {
- return __awaiter(this, void 0, void 0, function* () {
- try {
- yield exports.stat(fsPath);
- }
- catch (err) {
- if (err.code === 'ENOENT') {
- return false;
- }
- throw err;
- }
- return true;
- });
-}
-exports.exists = exists;
-function isDirectory(fsPath, useStat = false) {
- return __awaiter(this, void 0, void 0, function* () {
- const stats = useStat ? yield exports.stat(fsPath) : yield exports.lstat(fsPath);
- return stats.isDirectory();
- });
-}
-exports.isDirectory = isDirectory;
-/**
- * On OSX/Linux, true if path starts with '/'. On Windows, true for paths like:
- * \, \hello, \\hello\share, C:, and C:\hello (and corresponding alternate separator cases).
- */
-function isRooted(p) {
- p = normalizeSeparators(p);
- if (!p) {
- throw new Error('isRooted() parameter "p" cannot be empty');
+class DecodedURL extends URL {
+ constructor(url, base) {
+ super(url, base);
+ this._decodedUsername = decodeURIComponent(super.username);
+ this._decodedPassword = decodeURIComponent(super.password);
}
- if (exports.IS_WINDOWS) {
- return (p.startsWith('\\') || /^[A-Z]:/i.test(p) // e.g. \ or \hello or \\hello
- ); // e.g. C: or C:\hello
+ get username() {
+ return this._decodedUsername;
}
- return p.startsWith('/');
-}
-exports.isRooted = isRooted;
-/**
- * Best effort attempt to determine whether a file exists and is executable.
- * @param filePath file path to check
- * @param extensions additional file extensions to try
- * @return if file exists and is executable, returns the file path. otherwise empty string.
- */
-function tryGetExecutablePath(filePath, extensions) {
- return __awaiter(this, void 0, void 0, function* () {
- let stats = undefined;
- try {
- // test file exists
- stats = yield exports.stat(filePath);
- }
- catch (err) {
- if (err.code !== 'ENOENT') {
- // eslint-disable-next-line no-console
- console.log(`Unexpected error attempting to determine if executable file exists '${filePath}': ${err}`);
- }
- }
- if (stats && stats.isFile()) {
- if (exports.IS_WINDOWS) {
- // on Windows, test for valid extension
- const upperExt = path.extname(filePath).toUpperCase();
- if (extensions.some(validExt => validExt.toUpperCase() === upperExt)) {
- return filePath;
- }
- }
- else {
- if (isUnixExecutable(stats)) {
- return filePath;
- }
- }
- }
- // try each extension
- const originalFilePath = filePath;
- for (const extension of extensions) {
- filePath = originalFilePath + extension;
- stats = undefined;
- try {
- stats = yield exports.stat(filePath);
- }
- catch (err) {
- if (err.code !== 'ENOENT') {
- // eslint-disable-next-line no-console
- console.log(`Unexpected error attempting to determine if executable file exists '${filePath}': ${err}`);
- }
- }
- if (stats && stats.isFile()) {
- if (exports.IS_WINDOWS) {
- // preserve the case of the actual file (since an extension was appended)
- try {
- const directory = path.dirname(filePath);
- const upperName = path.basename(filePath).toUpperCase();
- for (const actualName of yield exports.readdir(directory)) {
- if (upperName === actualName.toUpperCase()) {
- filePath = path.join(directory, actualName);
- break;
- }
- }
- }
- catch (err) {
- // eslint-disable-next-line no-console
- console.log(`Unexpected error attempting to determine the actual case of the file '${filePath}': ${err}`);
- }
- return filePath;
- }
- else {
- if (isUnixExecutable(stats)) {
- return filePath;
- }
- }
- }
- }
- return '';
- });
-}
-exports.tryGetExecutablePath = tryGetExecutablePath;
-function normalizeSeparators(p) {
- p = p || '';
- if (exports.IS_WINDOWS) {
- // convert slashes on Windows
- p = p.replace(/\//g, '\\');
- // remove redundant slashes
- return p.replace(/\\\\+/g, '\\');
+ get password() {
+ return this._decodedPassword;
}
- // remove redundant slashes
- return p.replace(/\/\/+/g, '/');
}
-// on Mac/Linux, test the execute bit
-// R W X R W X R W X
-// 256 128 64 32 16 8 4 2 1
-function isUnixExecutable(stats) {
- return ((stats.mode & 1) > 0 ||
- ((stats.mode & 8) > 0 && stats.gid === process.getgid()) ||
- ((stats.mode & 64) > 0 && stats.uid === process.getuid()));
-}
-// Get the path of cmd.exe in windows
-function getCmdPath() {
- var _a;
- return (_a = process.env['COMSPEC']) !== null && _a !== void 0 ? _a : `cmd.exe`;
-}
-exports.getCmdPath = getCmdPath;
-//# sourceMappingURL=io-util.js.map
+//# sourceMappingURL=proxy.js.map
/***/ }),
-/***/ 7436:
+/***/ 1962:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+ o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+ if (mod && mod.__esModule) return mod;
+ var result = {};
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+ __setModuleDefault(result, mod);
+ return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+ return new (P || (P = Promise))(function (resolve, reject) {
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
+ });
+};
+var _a;
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.getCmdPath = exports.tryGetExecutablePath = exports.isRooted = exports.isDirectory = exports.exists = exports.READONLY = exports.UV_FS_O_EXLOCK = exports.IS_WINDOWS = exports.unlink = exports.symlink = exports.stat = exports.rmdir = exports.rm = exports.rename = exports.readlink = exports.readdir = exports.open = exports.mkdir = exports.lstat = exports.copyFile = exports.chmod = void 0;
+const fs = __importStar(__nccwpck_require__(7147));
+const path = __importStar(__nccwpck_require__(1017));
+_a = fs.promises
+// export const {open} = 'fs'
+, exports.chmod = _a.chmod, exports.copyFile = _a.copyFile, exports.lstat = _a.lstat, exports.mkdir = _a.mkdir, exports.open = _a.open, exports.readdir = _a.readdir, exports.readlink = _a.readlink, exports.rename = _a.rename, exports.rm = _a.rm, exports.rmdir = _a.rmdir, exports.stat = _a.stat, exports.symlink = _a.symlink, exports.unlink = _a.unlink;
+// export const {open} = 'fs'
+exports.IS_WINDOWS = process.platform === 'win32';
+// See https://github.com/nodejs/node/blob/d0153aee367422d0858105abec186da4dff0a0c5/deps/uv/include/uv/win.h#L691
+exports.UV_FS_O_EXLOCK = 0x10000000;
+exports.READONLY = fs.constants.O_RDONLY;
+function exists(fsPath) {
+ return __awaiter(this, void 0, void 0, function* () {
+ try {
+ yield exports.stat(fsPath);
+ }
+ catch (err) {
+ if (err.code === 'ENOENT') {
+ return false;
+ }
+ throw err;
+ }
+ return true;
+ });
+}
+exports.exists = exists;
+function isDirectory(fsPath, useStat = false) {
+ return __awaiter(this, void 0, void 0, function* () {
+ const stats = useStat ? yield exports.stat(fsPath) : yield exports.lstat(fsPath);
+ return stats.isDirectory();
+ });
+}
+exports.isDirectory = isDirectory;
+/**
+ * On OSX/Linux, true if path starts with '/'. On Windows, true for paths like:
+ * \, \hello, \\hello\share, C:, and C:\hello (and corresponding alternate separator cases).
+ */
+function isRooted(p) {
+ p = normalizeSeparators(p);
+ if (!p) {
+ throw new Error('isRooted() parameter "p" cannot be empty');
+ }
+ if (exports.IS_WINDOWS) {
+ return (p.startsWith('\\') || /^[A-Z]:/i.test(p) // e.g. \ or \hello or \\hello
+ ); // e.g. C: or C:\hello
+ }
+ return p.startsWith('/');
+}
+exports.isRooted = isRooted;
+/**
+ * Best effort attempt to determine whether a file exists and is executable.
+ * @param filePath file path to check
+ * @param extensions additional file extensions to try
+ * @return if file exists and is executable, returns the file path. otherwise empty string.
+ */
+function tryGetExecutablePath(filePath, extensions) {
+ return __awaiter(this, void 0, void 0, function* () {
+ let stats = undefined;
+ try {
+ // test file exists
+ stats = yield exports.stat(filePath);
+ }
+ catch (err) {
+ if (err.code !== 'ENOENT') {
+ // eslint-disable-next-line no-console
+ console.log(`Unexpected error attempting to determine if executable file exists '${filePath}': ${err}`);
+ }
+ }
+ if (stats && stats.isFile()) {
+ if (exports.IS_WINDOWS) {
+ // on Windows, test for valid extension
+ const upperExt = path.extname(filePath).toUpperCase();
+ if (extensions.some(validExt => validExt.toUpperCase() === upperExt)) {
+ return filePath;
+ }
+ }
+ else {
+ if (isUnixExecutable(stats)) {
+ return filePath;
+ }
+ }
+ }
+ // try each extension
+ const originalFilePath = filePath;
+ for (const extension of extensions) {
+ filePath = originalFilePath + extension;
+ stats = undefined;
+ try {
+ stats = yield exports.stat(filePath);
+ }
+ catch (err) {
+ if (err.code !== 'ENOENT') {
+ // eslint-disable-next-line no-console
+ console.log(`Unexpected error attempting to determine if executable file exists '${filePath}': ${err}`);
+ }
+ }
+ if (stats && stats.isFile()) {
+ if (exports.IS_WINDOWS) {
+ // preserve the case of the actual file (since an extension was appended)
+ try {
+ const directory = path.dirname(filePath);
+ const upperName = path.basename(filePath).toUpperCase();
+ for (const actualName of yield exports.readdir(directory)) {
+ if (upperName === actualName.toUpperCase()) {
+ filePath = path.join(directory, actualName);
+ break;
+ }
+ }
+ }
+ catch (err) {
+ // eslint-disable-next-line no-console
+ console.log(`Unexpected error attempting to determine the actual case of the file '${filePath}': ${err}`);
+ }
+ return filePath;
+ }
+ else {
+ if (isUnixExecutable(stats)) {
+ return filePath;
+ }
+ }
+ }
+ }
+ return '';
+ });
+}
+exports.tryGetExecutablePath = tryGetExecutablePath;
+function normalizeSeparators(p) {
+ p = p || '';
+ if (exports.IS_WINDOWS) {
+ // convert slashes on Windows
+ p = p.replace(/\//g, '\\');
+ // remove redundant slashes
+ return p.replace(/\\\\+/g, '\\');
+ }
+ // remove redundant slashes
+ return p.replace(/\/\/+/g, '/');
+}
+// on Mac/Linux, test the execute bit
+// R W X R W X R W X
+// 256 128 64 32 16 8 4 2 1
+function isUnixExecutable(stats) {
+ return ((stats.mode & 1) > 0 ||
+ ((stats.mode & 8) > 0 && stats.gid === process.getgid()) ||
+ ((stats.mode & 64) > 0 && stats.uid === process.getuid()));
+}
+// Get the path of cmd.exe in windows
+function getCmdPath() {
+ var _a;
+ return (_a = process.env['COMSPEC']) !== null && _a !== void 0 ? _a : `cmd.exe`;
+}
+exports.getCmdPath = getCmdPath;
+//# sourceMappingURL=io-util.js.map
+
+/***/ }),
+
+/***/ 7436:
/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
"use strict";
@@ -8094,24375 +8354,12611 @@ function copyFile(srcFile, destFile, force) {
/***/ }),
-/***/ 2557:
-/***/ ((__unused_webpack_module, exports) => {
+/***/ 4100:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
"use strict";
Object.defineProperty(exports, "__esModule", ({ value: true }));
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-///
-const listenersMap = new WeakMap();
-const abortedMap = new WeakMap();
-/**
- * An aborter instance implements AbortSignal interface, can abort HTTP requests.
- *
- * - Call AbortSignal.none to create a new AbortSignal instance that cannot be cancelled.
- * Use `AbortSignal.none` when you are required to pass a cancellation token but the operation
- * cannot or will not ever be cancelled.
- *
- * @example
- * Abort without timeout
- * ```ts
- * await doAsyncWork(AbortSignal.none);
- * ```
- */
-class AbortSignal {
- constructor() {
- /**
- * onabort event listener.
- */
- this.onabort = null;
- listenersMap.set(this, []);
- abortedMap.set(this, false);
- }
- /**
- * Status of whether aborted or not.
- *
- * @readonly
- */
- get aborted() {
- if (!abortedMap.has(this)) {
- throw new TypeError("Expected `this` to be an instance of AbortSignal.");
- }
- return abortedMap.get(this);
- }
- /**
- * Creates a new AbortSignal instance that will never be aborted.
- *
- * @readonly
- */
- static get none() {
- return new AbortSignal();
- }
- /**
- * Added new "abort" event listener, only support "abort" event.
- *
- * @param _type - Only support "abort" event
- * @param listener - The listener to be added
- */
- addEventListener(
- // tslint:disable-next-line:variable-name
- _type, listener) {
- if (!listenersMap.has(this)) {
- throw new TypeError("Expected `this` to be an instance of AbortSignal.");
- }
- const listeners = listenersMap.get(this);
- listeners.push(listener);
- }
- /**
- * Remove "abort" event listener, only support "abort" event.
- *
- * @param _type - Only support "abort" event
- * @param listener - The listener to be removed
- */
- removeEventListener(
- // tslint:disable-next-line:variable-name
- _type, listener) {
- if (!listenersMap.has(this)) {
- throw new TypeError("Expected `this` to be an instance of AbortSignal.");
- }
- const listeners = listenersMap.get(this);
- const index = listeners.indexOf(listener);
- if (index > -1) {
- listeners.splice(index, 1);
- }
- }
- /**
- * Dispatches a synthetic event to the AbortSignal.
- */
- dispatchEvent(_event) {
- throw new Error("This is a stub dispatchEvent implementation that should not be used. It only exists for type-checking purposes.");
- }
-}
-/**
- * Helper to trigger an abort event immediately, the onabort and all abort event listeners will be triggered.
- * Will try to trigger abort event for all linked AbortSignal nodes.
- *
- * - If there is a timeout, the timer will be cancelled.
- * - If aborted is true, nothing will happen.
- *
- * @internal
- */
-// eslint-disable-next-line @azure/azure-sdk/ts-use-interface-parameters
-function abortSignal(signal) {
- if (signal.aborted) {
- return;
- }
- if (signal.onabort) {
- signal.onabort.call(signal);
- }
- const listeners = listenersMap.get(signal);
- if (listeners) {
- // Create a copy of listeners so mutations to the array
- // (e.g. via removeListener calls) don't affect the listeners
- // we invoke.
- listeners.slice().forEach((listener) => {
- listener.call(signal, { type: "abort" });
+var coreRestPipeline = __nccwpck_require__(9146);
+var tslib = __nccwpck_require__(4351);
+var coreAuth = __nccwpck_require__(8834);
+var coreUtil = __nccwpck_require__(637);
+var coreHttpCompat = __nccwpck_require__(5083);
+var coreClient = __nccwpck_require__(7611);
+var coreXml = __nccwpck_require__(7309);
+var logger$1 = __nccwpck_require__(9497);
+var abortController = __nccwpck_require__(7559);
+var crypto = __nccwpck_require__(6113);
+var coreTracing = __nccwpck_require__(9363);
+var stream = __nccwpck_require__(2781);
+var coreLro = __nccwpck_require__(334);
+var events = __nccwpck_require__(2361);
+var fs = __nccwpck_require__(7147);
+var util = __nccwpck_require__(3837);
+var buffer = __nccwpck_require__(4300);
+
+function _interopNamespaceDefault(e) {
+ var n = Object.create(null);
+ if (e) {
+ Object.keys(e).forEach(function (k) {
+ if (k !== 'default') {
+ var d = Object.getOwnPropertyDescriptor(e, k);
+ Object.defineProperty(n, k, d.get ? d : {
+ enumerable: true,
+ get: function () { return e[k]; }
+ });
+ }
});
}
- abortedMap.set(signal, true);
+ n.default = e;
+ return Object.freeze(n);
}
+var coreHttpCompat__namespace = /*#__PURE__*/_interopNamespaceDefault(coreHttpCompat);
+var coreClient__namespace = /*#__PURE__*/_interopNamespaceDefault(coreClient);
+var fs__namespace = /*#__PURE__*/_interopNamespaceDefault(fs);
+var util__namespace = /*#__PURE__*/_interopNamespaceDefault(util);
+
// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * This error is thrown when an asynchronous operation has been aborted.
- * Check for this error by testing the `name` that the name property of the
- * error matches `"AbortError"`.
- *
- * @example
- * ```ts
- * const controller = new AbortController();
- * controller.abort();
- * try {
- * doAsyncWork(controller.signal)
- * } catch (e) {
- * if (e.name === 'AbortError') {
- * // handle abort error here.
- * }
- * }
- * ```
+ * The `@azure/logger` configuration for this package.
*/
-class AbortError extends Error {
- constructor(message) {
- super(message);
- this.name = "AbortError";
- }
-}
+const logger = logger$1.createClientLogger("storage-blob");
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * An AbortController provides an AbortSignal and the associated controls to signal
- * that an asynchronous operation should be aborted.
- *
- * @example
- * Abort an operation when another event fires
- * ```ts
- * const controller = new AbortController();
- * const signal = controller.signal;
- * doAsyncWork(signal);
- * button.addEventListener('click', () => controller.abort());
- * ```
- *
- * @example
- * Share aborter cross multiple operations in 30s
- * ```ts
- * // Upload the same data to 2 different data centers at the same time,
- * // abort another when any of them is finished
- * const controller = AbortController.withTimeout(30 * 1000);
- * doAsyncWork(controller.signal).then(controller.abort);
- * doAsyncWork(controller.signal).then(controller.abort);
- *```
- *
- * @example
- * Cascaded aborting
- * ```ts
- * // All operations can't take more than 30 seconds
- * const aborter = Aborter.timeout(30 * 1000);
- *
- * // Following 2 operations can't take more than 25 seconds
- * await doAsyncWork(aborter.withTimeout(25 * 1000));
- * await doAsyncWork(aborter.withTimeout(25 * 1000));
- * ```
+ * The base class from which all request policies derive.
*/
-class AbortController {
- // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
- constructor(parentSignals) {
- this._signal = new AbortSignal();
- if (!parentSignals) {
- return;
- }
- // coerce parentSignals into an array
- if (!Array.isArray(parentSignals)) {
- // eslint-disable-next-line prefer-rest-params
- parentSignals = arguments;
- }
- for (const parentSignal of parentSignals) {
- // if the parent signal has already had abort() called,
- // then call abort on this signal as well.
- if (parentSignal.aborted) {
- this.abort();
- }
- else {
- // when the parent signal aborts, this signal should as well.
- parentSignal.addEventListener("abort", () => {
- this.abort();
- });
- }
- }
- }
- /**
- * The AbortSignal associated with this controller that will signal aborted
- * when the abort method is called on this controller.
- *
- * @readonly
- */
- get signal() {
- return this._signal;
- }
+class BaseRequestPolicy {
/**
- * Signal that any operations passed this controller's associated abort signal
- * to cancel any remaining work and throw an `AbortError`.
+ * The main method to implement that manipulates a request/response.
*/
- abort() {
- abortSignal(this._signal);
- }
+ constructor(
/**
- * Creates a new AbortSignal instance that will abort after the provided ms.
- * @param ms - Elapsed time in milliseconds to trigger an abort.
+ * The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
*/
- static timeout(ms) {
- const signal = new AbortSignal();
- const timer = setTimeout(abortSignal, ms, signal);
- // Prevent the active Timer from keeping the Node.js event loop active.
- if (typeof timer.unref === "function") {
- timer.unref();
- }
- return signal;
- }
-}
-
-exports.AbortController = AbortController;
-exports.AbortError = AbortError;
-exports.AbortSignal = AbortSignal;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 9645:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-
-var coreUtil = __nccwpck_require__(1333);
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * A static-key-based credential that supports updating
- * the underlying key value.
- */
-class AzureKeyCredential {
+ _nextPolicy,
/**
- * The value of the key to be used in authentication
+ * The options that can be passed to a given request policy.
*/
- get key() {
- return this._key;
+ _options) {
+ this._nextPolicy = _nextPolicy;
+ this._options = _options;
}
/**
- * Create an instance of an AzureKeyCredential for use
- * with a service client.
- *
- * @param key - The initial value of the key to use in authentication
+ * Get whether or not a log with the provided log level should be logged.
+ * @param logLevel - The log level of the log that will be logged.
+ * @returns Whether or not a log with the provided log level should be logged.
*/
- constructor(key) {
- if (!key) {
- throw new Error("key must be a non-empty string");
- }
- this._key = key;
+ shouldLog(logLevel) {
+ return this._options.shouldLog(logLevel);
}
/**
- * Change the value of the key.
- *
- * Updates will take effect upon the next request after
- * updating the key value.
- *
- * @param newKey - The new key value to be used
+ * Attempt to log the provided message to the provided logger. If no logger was provided or if
+ * the log level does not meat the logger's threshold, then nothing will be logged.
+ * @param logLevel - The log level of this log.
+ * @param message - The message of this log.
*/
- update(newKey) {
- this._key = newKey;
+ log(logLevel, message) {
+ this._options.log(logLevel, message);
}
}
// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const SDK_VERSION = "12.24.0";
+const SERVICE_VERSION = "2024-08-04";
+const BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES = 256 * 1024 * 1024; // 256MB
+const BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES = 4000 * 1024 * 1024; // 4000MB
+const BLOCK_BLOB_MAX_BLOCKS = 50000;
+const DEFAULT_BLOCK_BUFFER_SIZE_BYTES = 8 * 1024 * 1024; // 8MB
+const DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES = 4 * 1024 * 1024; // 4MB
+const DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS = 5;
+const REQUEST_TIMEOUT = 100 * 1000; // In ms
/**
- * A static name/key-based credential that supports updating
- * the underlying name and key values.
+ * The OAuth scope to use with Azure Storage.
*/
-class AzureNamedKeyCredential {
- /**
- * The value of the key to be used in authentication.
- */
- get key() {
- return this._key;
+const StorageOAuthScopes = "https://storage.azure.com/.default";
+const URLConstants = {
+ Parameters: {
+ FORCE_BROWSER_NO_CACHE: "_",
+ SIGNATURE: "sig",
+ SNAPSHOT: "snapshot",
+ VERSIONID: "versionid",
+ TIMEOUT: "timeout",
+ },
+};
+const HTTPURLConnection = {
+ HTTP_ACCEPTED: 202,
+ HTTP_CONFLICT: 409,
+ HTTP_NOT_FOUND: 404,
+ HTTP_PRECON_FAILED: 412,
+ HTTP_RANGE_NOT_SATISFIABLE: 416,
+};
+const HeaderConstants = {
+ AUTHORIZATION: "Authorization",
+ AUTHORIZATION_SCHEME: "Bearer",
+ CONTENT_ENCODING: "Content-Encoding",
+ CONTENT_ID: "Content-ID",
+ CONTENT_LANGUAGE: "Content-Language",
+ CONTENT_LENGTH: "Content-Length",
+ CONTENT_MD5: "Content-Md5",
+ CONTENT_TRANSFER_ENCODING: "Content-Transfer-Encoding",
+ CONTENT_TYPE: "Content-Type",
+ COOKIE: "Cookie",
+ DATE: "date",
+ IF_MATCH: "if-match",
+ IF_MODIFIED_SINCE: "if-modified-since",
+ IF_NONE_MATCH: "if-none-match",
+ IF_UNMODIFIED_SINCE: "if-unmodified-since",
+ PREFIX_FOR_STORAGE: "x-ms-",
+ RANGE: "Range",
+ USER_AGENT: "User-Agent",
+ X_MS_CLIENT_REQUEST_ID: "x-ms-client-request-id",
+ X_MS_COPY_SOURCE: "x-ms-copy-source",
+ X_MS_DATE: "x-ms-date",
+ X_MS_ERROR_CODE: "x-ms-error-code",
+ X_MS_VERSION: "x-ms-version",
+ X_MS_CopySourceErrorCode: "x-ms-copy-source-error-code",
+};
+const ETagNone = "";
+const ETagAny = "*";
+const SIZE_1_MB = 1 * 1024 * 1024;
+const BATCH_MAX_REQUEST = 256;
+const BATCH_MAX_PAYLOAD_IN_BYTES = 4 * SIZE_1_MB;
+const HTTP_LINE_ENDING = "\r\n";
+const HTTP_VERSION_1_1 = "HTTP/1.1";
+const EncryptionAlgorithmAES25 = "AES256";
+const DevelopmentConnectionString = `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;`;
+const StorageBlobLoggingAllowedHeaderNames = [
+ "Access-Control-Allow-Origin",
+ "Cache-Control",
+ "Content-Length",
+ "Content-Type",
+ "Date",
+ "Request-Id",
+ "traceparent",
+ "Transfer-Encoding",
+ "User-Agent",
+ "x-ms-client-request-id",
+ "x-ms-date",
+ "x-ms-error-code",
+ "x-ms-request-id",
+ "x-ms-return-client-request-id",
+ "x-ms-version",
+ "Accept-Ranges",
+ "Content-Disposition",
+ "Content-Encoding",
+ "Content-Language",
+ "Content-MD5",
+ "Content-Range",
+ "ETag",
+ "Last-Modified",
+ "Server",
+ "Vary",
+ "x-ms-content-crc64",
+ "x-ms-copy-action",
+ "x-ms-copy-completion-time",
+ "x-ms-copy-id",
+ "x-ms-copy-progress",
+ "x-ms-copy-status",
+ "x-ms-has-immutability-policy",
+ "x-ms-has-legal-hold",
+ "x-ms-lease-state",
+ "x-ms-lease-status",
+ "x-ms-range",
+ "x-ms-request-server-encrypted",
+ "x-ms-server-encrypted",
+ "x-ms-snapshot",
+ "x-ms-source-range",
+ "If-Match",
+ "If-Modified-Since",
+ "If-None-Match",
+ "If-Unmodified-Since",
+ "x-ms-access-tier",
+ "x-ms-access-tier-change-time",
+ "x-ms-access-tier-inferred",
+ "x-ms-account-kind",
+ "x-ms-archive-status",
+ "x-ms-blob-append-offset",
+ "x-ms-blob-cache-control",
+ "x-ms-blob-committed-block-count",
+ "x-ms-blob-condition-appendpos",
+ "x-ms-blob-condition-maxsize",
+ "x-ms-blob-content-disposition",
+ "x-ms-blob-content-encoding",
+ "x-ms-blob-content-language",
+ "x-ms-blob-content-length",
+ "x-ms-blob-content-md5",
+ "x-ms-blob-content-type",
+ "x-ms-blob-public-access",
+ "x-ms-blob-sequence-number",
+ "x-ms-blob-type",
+ "x-ms-copy-destination-snapshot",
+ "x-ms-creation-time",
+ "x-ms-default-encryption-scope",
+ "x-ms-delete-snapshots",
+ "x-ms-delete-type-permanent",
+ "x-ms-deny-encryption-scope-override",
+ "x-ms-encryption-algorithm",
+ "x-ms-if-sequence-number-eq",
+ "x-ms-if-sequence-number-le",
+ "x-ms-if-sequence-number-lt",
+ "x-ms-incremental-copy",
+ "x-ms-lease-action",
+ "x-ms-lease-break-period",
+ "x-ms-lease-duration",
+ "x-ms-lease-id",
+ "x-ms-lease-time",
+ "x-ms-page-write",
+ "x-ms-proposed-lease-id",
+ "x-ms-range-get-content-md5",
+ "x-ms-rehydrate-priority",
+ "x-ms-sequence-number-action",
+ "x-ms-sku-name",
+ "x-ms-source-content-md5",
+ "x-ms-source-if-match",
+ "x-ms-source-if-modified-since",
+ "x-ms-source-if-none-match",
+ "x-ms-source-if-unmodified-since",
+ "x-ms-tag-count",
+ "x-ms-encryption-key-sha256",
+ "x-ms-copy-source-error-code",
+ "x-ms-copy-source-status-code",
+ "x-ms-if-tags",
+ "x-ms-source-if-tags",
+];
+const StorageBlobLoggingAllowedQueryParameters = [
+ "comp",
+ "maxresults",
+ "rscc",
+ "rscd",
+ "rsce",
+ "rscl",
+ "rsct",
+ "se",
+ "si",
+ "sip",
+ "sp",
+ "spr",
+ "sr",
+ "srt",
+ "ss",
+ "st",
+ "sv",
+ "include",
+ "marker",
+ "prefix",
+ "copyid",
+ "restype",
+ "blockid",
+ "blocklisttype",
+ "delimiter",
+ "prevsnapshot",
+ "ske",
+ "skoid",
+ "sks",
+ "skt",
+ "sktid",
+ "skv",
+ "snapshot",
+];
+const BlobUsesCustomerSpecifiedEncryptionMsg = "BlobUsesCustomerSpecifiedEncryption";
+const BlobDoesNotUseCustomerSpecifiedEncryption = "BlobDoesNotUseCustomerSpecifiedEncryption";
+/// List of ports used for path style addressing.
+/// Path style addressing means that storage account is put in URI's Path segment in instead of in host.
+const PathStylePorts = [
+ "10000",
+ "10001",
+ "10002",
+ "10003",
+ "10004",
+ "10100",
+ "10101",
+ "10102",
+ "10103",
+ "10104",
+ "11000",
+ "11001",
+ "11002",
+ "11003",
+ "11004",
+ "11100",
+ "11101",
+ "11102",
+ "11103",
+ "11104",
+];
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Reserved URL characters must be properly escaped for Storage services like Blob or File.
+ *
+ * ## URL encode and escape strategy for JS SDKs
+ *
+ * When customers pass a URL string into XxxClient classes constructor, the URL string may already be URL encoded or not.
+ * But before sending to Azure Storage server, the URL must be encoded. However, it's hard for a SDK to guess whether the URL
+ * string has been encoded or not. We have 2 potential strategies, and chose strategy two for the XxxClient constructors.
+ *
+ * ### Strategy One: Assume the customer URL string is not encoded, and always encode URL string in SDK.
+ *
+ * This is what legacy V2 SDK does, simple and works for most of the cases.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b:",
+ * SDK will encode it to "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b%3A",
+ * SDK will encode it to "http://account.blob.core.windows.net/con/b%253A" and send to server. A blob named "b%3A" will be created.
+ *
+ * But this strategy will make it not possible to create a blob with "?" in it's name. Because when customer URL string is
+ * "http://account.blob.core.windows.net/con/blob?name", the "?name" will be treated as URL paramter instead of blob name.
+ * If customer URL string is "http://account.blob.core.windows.net/con/blob%3Fname", a blob named "blob%3Fname" will be created.
+ * V2 SDK doesn't have this issue because it doesn't allow customer pass in a full URL, it accepts a separate blob name and encodeURIComponent for it.
+ * We cannot accept a SDK cannot create a blob name with "?". So we implement strategy two:
+ *
+ * ### Strategy Two: SDK doesn't assume the URL has been encoded or not. It will just escape the special characters.
+ *
+ * This is what V10 Blob Go SDK does. It accepts a URL type in Go, and call url.EscapedPath() to escape the special chars unescaped.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b:",
+ * SDK will escape ":" like "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b%3A",
+ * There is no special characters, so send "http://account.blob.core.windows.net/con/b%3A" to server. A blob named "b:" will be created.
+ * - When customer URL string is "http://account.blob.core.windows.net/con/b%253A",
+ * There is no special characters, so send "http://account.blob.core.windows.net/con/b%253A" to server. A blob named "b%3A" will be created.
+ *
+ * This strategy gives us flexibility to create with any special characters. But "%" will be treated as a special characters, if the URL string
+ * is not encoded, there shouldn't a "%" in the URL string, otherwise the URL is not a valid URL.
+ * If customer needs to create a blob with "%" in it's blob name, use "%25" instead of "%". Just like above 3rd sample.
+ * And following URL strings are invalid:
+ * - "http://account.blob.core.windows.net/con/b%"
+ * - "http://account.blob.core.windows.net/con/b%2"
+ * - "http://account.blob.core.windows.net/con/b%G"
+ *
+ * Another special character is "?", use "%2F" to represent a blob name with "?" in a URL string.
+ *
+ * ### Strategy for containerName, blobName or other specific XXXName parameters in methods such as `containerClient.getBlobClient(blobName)`
+ *
+ * We will apply strategy one, and call encodeURIComponent for these parameters like blobName. Because what customers passes in is a plain name instead of a URL.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata
+ *
+ * @param url -
+ */
+function escapeURLPath(url) {
+ const urlParsed = new URL(url);
+ let path = urlParsed.pathname;
+ path = path || "/";
+ path = escape(path);
+ urlParsed.pathname = path;
+ return urlParsed.toString();
+}
+function getProxyUriFromDevConnString(connectionString) {
+ // Development Connection String
+ // https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#connect-to-the-emulator-account-using-the-well-known-account-name-and-key
+ let proxyUri = "";
+ if (connectionString.search("DevelopmentStorageProxyUri=") !== -1) {
+ // CONNECTION_STRING=UseDevelopmentStorage=true;DevelopmentStorageProxyUri=http://myProxyUri
+ const matchCredentials = connectionString.split(";");
+ for (const element of matchCredentials) {
+ if (element.trim().startsWith("DevelopmentStorageProxyUri=")) {
+ proxyUri = element.trim().match("DevelopmentStorageProxyUri=(.*)")[1];
+ }
+ }
}
- /**
- * The value of the name to be used in authentication.
- */
- get name() {
- return this._name;
+ return proxyUri;
+}
+function getValueInConnString(connectionString, argument) {
+ const elements = connectionString.split(";");
+ for (const element of elements) {
+ if (element.trim().startsWith(argument)) {
+ return element.trim().match(argument + "=(.*)")[1];
+ }
}
- /**
- * Create an instance of an AzureNamedKeyCredential for use
- * with a service client.
- *
- * @param name - The initial value of the name to use in authentication.
- * @param key - The initial value of the key to use in authentication.
- */
- constructor(name, key) {
- if (!name || !key) {
- throw new TypeError("name and key must be non-empty strings");
+ return "";
+}
+/**
+ * Extracts the parts of an Azure Storage account connection string.
+ *
+ * @param connectionString - Connection string.
+ * @returns String key value pairs of the storage account's url and credentials.
+ */
+function extractConnectionStringParts(connectionString) {
+ let proxyUri = "";
+ if (connectionString.startsWith("UseDevelopmentStorage=true")) {
+ // Development connection string
+ proxyUri = getProxyUriFromDevConnString(connectionString);
+ connectionString = DevelopmentConnectionString;
+ }
+ // Matching BlobEndpoint in the Account connection string
+ let blobEndpoint = getValueInConnString(connectionString, "BlobEndpoint");
+ // Slicing off '/' at the end if exists
+ // (The methods that use `extractConnectionStringParts` expect the url to not have `/` at the end)
+ blobEndpoint = blobEndpoint.endsWith("/") ? blobEndpoint.slice(0, -1) : blobEndpoint;
+ if (connectionString.search("DefaultEndpointsProtocol=") !== -1 &&
+ connectionString.search("AccountKey=") !== -1) {
+ // Account connection string
+ let defaultEndpointsProtocol = "";
+ let accountName = "";
+ let accountKey = Buffer.from("accountKey", "base64");
+ let endpointSuffix = "";
+ // Get account name and key
+ accountName = getValueInConnString(connectionString, "AccountName");
+ accountKey = Buffer.from(getValueInConnString(connectionString, "AccountKey"), "base64");
+ if (!blobEndpoint) {
+ // BlobEndpoint is not present in the Account connection string
+ // Can be obtained from `${defaultEndpointsProtocol}://${accountName}.blob.${endpointSuffix}`
+ defaultEndpointsProtocol = getValueInConnString(connectionString, "DefaultEndpointsProtocol");
+ const protocol = defaultEndpointsProtocol.toLowerCase();
+ if (protocol !== "https" && protocol !== "http") {
+ throw new Error("Invalid DefaultEndpointsProtocol in the provided Connection String. Expecting 'https' or 'http'");
+ }
+ endpointSuffix = getValueInConnString(connectionString, "EndpointSuffix");
+ if (!endpointSuffix) {
+ throw new Error("Invalid EndpointSuffix in the provided Connection String");
+ }
+ blobEndpoint = `${defaultEndpointsProtocol}://${accountName}.blob.${endpointSuffix}`;
}
- this._name = name;
- this._key = key;
+ if (!accountName) {
+ throw new Error("Invalid AccountName in the provided Connection String");
+ }
+ else if (accountKey.length === 0) {
+ throw new Error("Invalid AccountKey in the provided Connection String");
+ }
+ return {
+ kind: "AccountConnString",
+ url: blobEndpoint,
+ accountName,
+ accountKey,
+ proxyUri,
+ };
}
- /**
- * Change the value of the key.
- *
- * Updates will take effect upon the next request after
- * updating the key value.
- *
- * @param newName - The new name value to be used.
- * @param newKey - The new key value to be used.
- */
- update(newName, newKey) {
- if (!newName || !newKey) {
- throw new TypeError("newName and newKey must be non-empty strings");
+ else {
+ // SAS connection string
+ let accountSas = getValueInConnString(connectionString, "SharedAccessSignature");
+ let accountName = getValueInConnString(connectionString, "AccountName");
+ // if accountName is empty, try to read it from BlobEndpoint
+ if (!accountName) {
+ accountName = getAccountNameFromUrl(blobEndpoint);
}
- this._name = newName;
- this._key = newKey;
+ if (!blobEndpoint) {
+ throw new Error("Invalid BlobEndpoint in the provided SAS Connection String");
+ }
+ else if (!accountSas) {
+ throw new Error("Invalid SharedAccessSignature in the provided SAS Connection String");
+ }
+ // client constructors assume accountSas does *not* start with ?
+ if (accountSas.startsWith("?")) {
+ accountSas = accountSas.substring(1);
+ }
+ return { kind: "SASConnString", url: blobEndpoint, accountName, accountSas };
}
}
/**
- * Tests an object to determine whether it implements NamedKeyCredential.
+ * Internal escape method implemented Strategy Two mentioned in escapeURL() description.
*
- * @param credential - The assumed NamedKeyCredential to be tested.
+ * @param text -
*/
-function isNamedKeyCredential(credential) {
- return (coreUtil.isObjectWithProperties(credential, ["name", "key"]) &&
- typeof credential.key === "string" &&
- typeof credential.name === "string");
+function escape(text) {
+ return encodeURIComponent(text)
+ .replace(/%2F/g, "/") // Don't escape for "/"
+ .replace(/'/g, "%27") // Escape for "'"
+ .replace(/\+/g, "%20")
+ .replace(/%25/g, "%"); // Revert encoded "%"
}
-
-// Copyright (c) Microsoft Corporation.
/**
- * A static-signature-based credential that supports updating
- * the underlying signature value.
+ * Append a string to URL path. Will remove duplicated "/" in front of the string
+ * when URL path ends with a "/".
+ *
+ * @param url - Source URL string
+ * @param name - String to be appended to URL
+ * @returns An updated URL string
*/
-class AzureSASCredential {
- /**
- * The value of the shared access signature to be used in authentication
- */
- get signature() {
- return this._signature;
- }
- /**
- * Create an instance of an AzureSASCredential for use
- * with a service client.
- *
- * @param signature - The initial value of the shared access signature to use in authentication
- */
- constructor(signature) {
- if (!signature) {
- throw new Error("shared access signature must be a non-empty string");
+function appendToURLPath(url, name) {
+ const urlParsed = new URL(url);
+ let path = urlParsed.pathname;
+ path = path ? (path.endsWith("/") ? `${path}${name}` : `${path}/${name}`) : name;
+ urlParsed.pathname = path;
+ return urlParsed.toString();
+}
+/**
+ * Set URL parameter name and value. If name exists in URL parameters, old value
+ * will be replaced by name key. If not provide value, the parameter will be deleted.
+ *
+ * @param url - Source URL string
+ * @param name - Parameter name
+ * @param value - Parameter value
+ * @returns An updated URL string
+ */
+function setURLParameter(url, name, value) {
+ const urlParsed = new URL(url);
+ const encodedName = encodeURIComponent(name);
+ const encodedValue = value ? encodeURIComponent(value) : undefined;
+ // mutating searchParams will change the encoding, so we have to do this ourselves
+ const searchString = urlParsed.search === "" ? "?" : urlParsed.search;
+ const searchPieces = [];
+ for (const pair of searchString.slice(1).split("&")) {
+ if (pair) {
+ const [key] = pair.split("=", 2);
+ if (key !== encodedName) {
+ searchPieces.push(pair);
+ }
}
- this._signature = signature;
}
- /**
- * Change the value of the signature.
- *
- * Updates will take effect upon the next request after
- * updating the signature value.
- *
- * @param newSignature - The new shared access signature value to be used
- */
- update(newSignature) {
- if (!newSignature) {
- throw new Error("shared access signature must be a non-empty string");
- }
- this._signature = newSignature;
+ if (encodedValue) {
+ searchPieces.push(`${encodedName}=${encodedValue}`);
}
+ urlParsed.search = searchPieces.length ? `?${searchPieces.join("&")}` : "";
+ return urlParsed.toString();
}
/**
- * Tests an object to determine whether it implements SASCredential.
+ * Get URL parameter by name.
*
- * @param credential - The assumed SASCredential to be tested.
+ * @param url -
+ * @param name -
*/
-function isSASCredential(credential) {
- return (coreUtil.isObjectWithProperties(credential, ["signature"]) && typeof credential.signature === "string");
+function getURLParameter(url, name) {
+ var _a;
+ const urlParsed = new URL(url);
+ return (_a = urlParsed.searchParams.get(name)) !== null && _a !== void 0 ? _a : undefined;
}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
/**
- * Tests an object to determine whether it implements TokenCredential.
+ * Set URL host.
*
- * @param credential - The assumed TokenCredential to be tested.
+ * @param url - Source URL string
+ * @param host - New host string
+ * @returns An updated URL string
*/
-function isTokenCredential(credential) {
- // Check for an object with a 'getToken' function and possibly with
- // a 'signRequest' function. We do this check to make sure that
- // a ServiceClientCredentials implementor (like TokenClientCredentials
- // in ms-rest-nodeauth) doesn't get mistaken for a TokenCredential if
- // it doesn't actually implement TokenCredential also.
- const castCredential = credential;
- return (castCredential &&
- typeof castCredential.getToken === "function" &&
- (castCredential.signRequest === undefined || castCredential.getToken.length > 0));
+function setURLHost(url, host) {
+ const urlParsed = new URL(url);
+ urlParsed.hostname = host;
+ return urlParsed.toString();
}
-
-exports.AzureKeyCredential = AzureKeyCredential;
-exports.AzureNamedKeyCredential = AzureNamedKeyCredential;
-exports.AzureSASCredential = AzureSASCredential;
-exports.isNamedKeyCredential = isNamedKeyCredential;
-exports.isSASCredential = isSASCredential;
-exports.isTokenCredential = isTokenCredential;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 4607:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-
-var uuid = __nccwpck_require__(3415);
-var util = __nccwpck_require__(3837);
-var tslib = __nccwpck_require__(4351);
-var xml2js = __nccwpck_require__(6189);
-var coreUtil = __nccwpck_require__(1333);
-var logger$1 = __nccwpck_require__(3233);
-var coreAuth = __nccwpck_require__(9645);
-var os = __nccwpck_require__(2037);
-var http = __nccwpck_require__(3685);
-var https = __nccwpck_require__(5687);
-var abortController = __nccwpck_require__(2557);
-var tunnel = __nccwpck_require__(4294);
-var stream = __nccwpck_require__(2781);
-var FormData = __nccwpck_require__(6279);
-var node_fetch = __nccwpck_require__(467);
-var coreTracing = __nccwpck_require__(4175);
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-function _interopNamespace(e) {
- if (e && e.__esModule) return e;
- var n = Object.create(null);
- if (e) {
- Object.keys(e).forEach(function (k) {
- if (k !== 'default') {
- var d = Object.getOwnPropertyDescriptor(e, k);
- Object.defineProperty(n, k, d.get ? d : {
- enumerable: true,
- get: function () { return e[k]; }
- });
- }
- });
- }
- n["default"] = e;
- return Object.freeze(n);
-}
-
-var xml2js__namespace = /*#__PURE__*/_interopNamespace(xml2js);
-var os__namespace = /*#__PURE__*/_interopNamespace(os);
-var http__namespace = /*#__PURE__*/_interopNamespace(http);
-var https__namespace = /*#__PURE__*/_interopNamespace(https);
-var tunnel__namespace = /*#__PURE__*/_interopNamespace(tunnel);
-var FormData__default = /*#__PURE__*/_interopDefaultLegacy(FormData);
-var node_fetch__default = /*#__PURE__*/_interopDefaultLegacy(node_fetch);
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
/**
- * A collection of HttpHeaders that can be sent with a HTTP request.
+ * Get URL path from an URL string.
+ *
+ * @param url - Source URL string
*/
-function getHeaderKey(headerName) {
- return headerName.toLowerCase();
-}
-function isHttpHeadersLike(object) {
- if (object && typeof object === "object") {
- const castObject = object;
- if (typeof castObject.rawHeaders === "function" &&
- typeof castObject.clone === "function" &&
- typeof castObject.get === "function" &&
- typeof castObject.set === "function" &&
- typeof castObject.contains === "function" &&
- typeof castObject.remove === "function" &&
- typeof castObject.headersArray === "function" &&
- typeof castObject.headerValues === "function" &&
- typeof castObject.headerNames === "function" &&
- typeof castObject.toJson === "function") {
- return true;
- }
+function getURLPath(url) {
+ try {
+ const urlParsed = new URL(url);
+ return urlParsed.pathname;
+ }
+ catch (e) {
+ return undefined;
}
- return false;
}
/**
- * A collection of HTTP header key/value pairs.
+ * Get URL scheme from an URL string.
+ *
+ * @param url - Source URL string
*/
-class HttpHeaders {
- constructor(rawHeaders) {
- this._headersMap = {};
- if (rawHeaders) {
- for (const headerName in rawHeaders) {
- this.set(headerName, rawHeaders[headerName]);
- }
- }
- }
- /**
- * Set a header in this collection with the provided name and value. The name is
- * case-insensitive.
- * @param headerName - The name of the header to set. This value is case-insensitive.
- * @param headerValue - The value of the header to set.
- */
- set(headerName, headerValue) {
- this._headersMap[getHeaderKey(headerName)] = {
- name: headerName,
- value: headerValue.toString().trim(),
- };
- }
- /**
- * Get the header value for the provided header name, or undefined if no header exists in this
- * collection with the provided name.
- * @param headerName - The name of the header.
- */
- get(headerName) {
- const header = this._headersMap[getHeaderKey(headerName)];
- return !header ? undefined : header.value;
- }
- /**
- * Get whether or not this header collection contains a header entry for the provided header name.
- */
- contains(headerName) {
- return !!this._headersMap[getHeaderKey(headerName)];
- }
- /**
- * Remove the header with the provided headerName. Return whether or not the header existed and
- * was removed.
- * @param headerName - The name of the header to remove.
- */
- remove(headerName) {
- const result = this.contains(headerName);
- delete this._headersMap[getHeaderKey(headerName)];
- return result;
- }
- /**
- * Get the headers that are contained this collection as an object.
- */
- rawHeaders() {
- return this.toJson({ preserveCase: true });
- }
- /**
- * Get the headers that are contained in this collection as an array.
- */
- headersArray() {
- const headers = [];
- for (const headerKey in this._headersMap) {
- headers.push(this._headersMap[headerKey]);
- }
- return headers;
- }
- /**
- * Get the header names that are contained in this collection.
- */
- headerNames() {
- const headerNames = [];
- const headers = this.headersArray();
- for (let i = 0; i < headers.length; ++i) {
- headerNames.push(headers[i].name);
- }
- return headerNames;
- }
- /**
- * Get the header values that are contained in this collection.
- */
- headerValues() {
- const headerValues = [];
- const headers = this.headersArray();
- for (let i = 0; i < headers.length; ++i) {
- headerValues.push(headers[i].value);
- }
- return headerValues;
- }
- /**
- * Get the JSON object representation of this HTTP header collection.
- */
- toJson(options = {}) {
- const result = {};
- if (options.preserveCase) {
- for (const headerKey in this._headersMap) {
- const header = this._headersMap[headerKey];
- result[header.name] = header.value;
- }
- }
- else {
- for (const headerKey in this._headersMap) {
- const header = this._headersMap[headerKey];
- result[getHeaderKey(header.name)] = header.value;
- }
- }
- return result;
- }
- /**
- * Get the string representation of this HTTP header collection.
- */
- toString() {
- return JSON.stringify(this.toJson({ preserveCase: true }));
+function getURLScheme(url) {
+ try {
+ const urlParsed = new URL(url);
+ return urlParsed.protocol.endsWith(":") ? urlParsed.protocol.slice(0, -1) : urlParsed.protocol;
}
- /**
- * Create a deep clone/copy of this HttpHeaders collection.
- */
- clone() {
- const resultPreservingCasing = {};
- for (const headerKey in this._headersMap) {
- const header = this._headersMap[headerKey];
- resultPreservingCasing[header.name] = header.value;
- }
- return new HttpHeaders(resultPreservingCasing);
+ catch (e) {
+ return undefined;
}
}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
/**
- * Encodes a string in base64 format.
- * @param value - The string to encode
+ * Get URL path and query from an URL string.
+ *
+ * @param url - Source URL string
*/
-function encodeString(value) {
- return Buffer.from(value).toString("base64");
+function getURLPathAndQuery(url) {
+ const urlParsed = new URL(url);
+ const pathString = urlParsed.pathname;
+ if (!pathString) {
+ throw new RangeError("Invalid url without valid path.");
+ }
+ let queryString = urlParsed.search || "";
+ queryString = queryString.trim();
+ if (queryString !== "") {
+ queryString = queryString.startsWith("?") ? queryString : `?${queryString}`; // Ensure query string start with '?'
+ }
+ return `${pathString}${queryString}`;
}
/**
- * Encodes a byte array in base64 format.
- * @param value - The Uint8Aray to encode
+ * Get URL query key value pairs from an URL string.
+ *
+ * @param url -
*/
-function encodeByteArray(value) {
- // Buffer.from accepts | -- the TypeScript definition is off here
- // https://nodejs.org/api/buffer.html#buffer_class_method_buffer_from_arraybuffer_byteoffset_length
- const bufferValue = value instanceof Buffer ? value : Buffer.from(value.buffer);
- return bufferValue.toString("base64");
+function getURLQueries(url) {
+ let queryString = new URL(url).search;
+ if (!queryString) {
+ return {};
+ }
+ queryString = queryString.trim();
+ queryString = queryString.startsWith("?") ? queryString.substring(1) : queryString;
+ let querySubStrings = queryString.split("&");
+ querySubStrings = querySubStrings.filter((value) => {
+ const indexOfEqual = value.indexOf("=");
+ const lastIndexOfEqual = value.lastIndexOf("=");
+ return (indexOfEqual > 0 && indexOfEqual === lastIndexOfEqual && lastIndexOfEqual < value.length - 1);
+ });
+ const queries = {};
+ for (const querySubString of querySubStrings) {
+ const splitResults = querySubString.split("=");
+ const key = splitResults[0];
+ const value = splitResults[1];
+ queries[key] = value;
+ }
+ return queries;
}
/**
- * Decodes a base64 string into a byte array.
- * @param value - The base64 string to decode
+ * Append a string to URL query.
+ *
+ * @param url - Source URL string.
+ * @param queryParts - String to be appended to the URL query.
+ * @returns An updated URL string.
*/
-function decodeString(value) {
- return Buffer.from(value, "base64");
+function appendToURLQuery(url, queryParts) {
+ const urlParsed = new URL(url);
+ let query = urlParsed.search;
+ if (query) {
+ query += "&" + queryParts;
+ }
+ else {
+ query = queryParts;
+ }
+ urlParsed.search = query;
+ return urlParsed.toString();
}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * A set of constants used internally when processing requests.
- */
-const Constants = {
- /**
- * The core-http version
- */
- coreHttpVersion: "3.0.4",
- /**
- * Specifies HTTP.
- */
- HTTP: "http:",
- /**
- * Specifies HTTPS.
- */
- HTTPS: "https:",
- /**
- * Specifies HTTP Proxy.
- */
- HTTP_PROXY: "HTTP_PROXY",
- /**
- * Specifies HTTPS Proxy.
- */
- HTTPS_PROXY: "HTTPS_PROXY",
- /**
- * Specifies NO Proxy.
- */
- NO_PROXY: "NO_PROXY",
- /**
- * Specifies ALL Proxy.
- */
- ALL_PROXY: "ALL_PROXY",
- HttpConstants: {
- /**
- * Http Verbs
- */
- HttpVerbs: {
- PUT: "PUT",
- GET: "GET",
- DELETE: "DELETE",
- POST: "POST",
- MERGE: "MERGE",
- HEAD: "HEAD",
- PATCH: "PATCH",
- },
- StatusCodes: {
- TooManyRequests: 429,
- ServiceUnavailable: 503,
- },
- },
- /**
- * Defines constants for use with HTTP headers.
- */
- HeaderConstants: {
- /**
- * The Authorization header.
- */
- AUTHORIZATION: "authorization",
- AUTHORIZATION_SCHEME: "Bearer",
- /**
- * The Retry-After response-header field can be used with a 503 (Service
- * Unavailable) or 349 (Too Many Requests) responses to indicate how long
- * the service is expected to be unavailable to the requesting client.
- */
- RETRY_AFTER: "Retry-After",
- /**
- * The UserAgent header.
- */
- USER_AGENT: "User-Agent",
- },
-};
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Default key used to access the XML attributes.
- */
-const XML_ATTRKEY = "$";
-/**
- * Default key used to access the XML value content.
- */
-const XML_CHARKEY = "_";
-
-// Copyright (c) Microsoft Corporation.
-const validUuidRegex = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/i;
/**
- * Encodes an URI.
+ * Rounds a date off to seconds.
*
- * @param uri - The URI to be encoded.
- * @returns The encoded URI.
+ * @param date -
+ * @param withMilliseconds - If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned;
+ * If false, YYYY-MM-DDThh:mm:ssZ will be returned.
+ * @returns Date string in ISO8061 format, with or without 7 milliseconds component
*/
-function encodeUri(uri) {
- return encodeURIComponent(uri)
- .replace(/!/g, "%21")
- .replace(/"/g, "%27")
- .replace(/\(/g, "%28")
- .replace(/\)/g, "%29")
- .replace(/\*/g, "%2A");
+function truncatedISO8061Date(date, withMilliseconds = true) {
+ // Date.toISOString() will return like "2018-10-29T06:34:36.139Z"
+ const dateString = date.toISOString();
+ return withMilliseconds
+ ? dateString.substring(0, dateString.length - 1) + "0000" + "Z"
+ : dateString.substring(0, dateString.length - 5) + "Z";
}
/**
- * Returns a stripped version of the Http Response which only contains body,
- * headers and the status.
+ * Base64 encode.
*
- * @param response - The Http Response
- * @returns The stripped version of Http Response.
+ * @param content -
*/
-function stripResponse(response) {
- const strippedResponse = {};
- strippedResponse.body = response.bodyAsText;
- strippedResponse.headers = response.headers;
- strippedResponse.status = response.status;
- return strippedResponse;
+function base64encode(content) {
+ return !coreUtil.isNode ? btoa(content) : Buffer.from(content).toString("base64");
}
/**
- * Returns a stripped version of the Http Request that does not contain the
- * Authorization header.
+ * Generate a 64 bytes base64 block ID string.
*
- * @param request - The Http Request object
- * @returns The stripped version of Http Request.
+ * @param blockIndex -
*/
-function stripRequest(request) {
- const strippedRequest = request.clone();
- if (strippedRequest.headers) {
- strippedRequest.headers.remove("authorization");
+function generateBlockID(blockIDPrefix, blockIndex) {
+ // To generate a 64 bytes base64 string, source string should be 48
+ const maxSourceStringLength = 48;
+ // A blob can have a maximum of 100,000 uncommitted blocks at any given time
+ const maxBlockIndexLength = 6;
+ const maxAllowedBlockIDPrefixLength = maxSourceStringLength - maxBlockIndexLength;
+ if (blockIDPrefix.length > maxAllowedBlockIDPrefixLength) {
+ blockIDPrefix = blockIDPrefix.slice(0, maxAllowedBlockIDPrefixLength);
}
- return strippedRequest;
+ const res = blockIDPrefix +
+ padStart(blockIndex.toString(), maxSourceStringLength - blockIDPrefix.length, "0");
+ return base64encode(res);
}
/**
- * Validates the given uuid as a string
+ * Delay specified time interval.
*
- * @param uuid - The uuid as a string that needs to be validated
- * @returns True if the uuid is valid; false otherwise.
+ * @param timeInMs -
+ * @param aborter -
+ * @param abortError -
*/
-function isValidUuid(uuid) {
- return validUuidRegex.test(uuid);
+async function delay(timeInMs, aborter, abortError) {
+ return new Promise((resolve, reject) => {
+ /* eslint-disable-next-line prefer-const */
+ let timeout;
+ const abortHandler = () => {
+ if (timeout !== undefined) {
+ clearTimeout(timeout);
+ }
+ reject(abortError);
+ };
+ const resolveHandler = () => {
+ if (aborter !== undefined) {
+ aborter.removeEventListener("abort", abortHandler);
+ }
+ resolve();
+ };
+ timeout = setTimeout(resolveHandler, timeInMs);
+ if (aborter !== undefined) {
+ aborter.addEventListener("abort", abortHandler);
+ }
+ });
}
/**
- * Generated UUID
+ * String.prototype.padStart()
*
- * @returns RFC4122 v4 UUID.
+ * @param currentString -
+ * @param targetLength -
+ * @param padString -
*/
-function generateUuid() {
- return uuid.v4();
+function padStart(currentString, targetLength, padString = " ") {
+ // @ts-expect-error: TS doesn't know this code needs to run downlevel sometimes
+ if (String.prototype.padStart) {
+ return currentString.padStart(targetLength, padString);
+ }
+ padString = padString || " ";
+ if (currentString.length > targetLength) {
+ return currentString;
+ }
+ else {
+ targetLength = targetLength - currentString.length;
+ if (targetLength > padString.length) {
+ padString += padString.repeat(targetLength / padString.length);
+ }
+ return padString.slice(0, targetLength) + currentString;
+ }
}
/**
- * Executes an array of promises sequentially. Inspiration of this method is here:
- * https://pouchdb.com/2015/05/18/we-have-a-problem-with-promises.html. An awesome blog on promises!
+ * If two strings are equal when compared case insensitive.
*
- * @param promiseFactories - An array of promise factories(A function that return a promise)
- * @param kickstart - Input to the first promise that is used to kickstart the promise chain.
- * If not provided then the promise chain starts with undefined.
- * @returns A chain of resolved or rejected promises
- */
-function executePromisesSequentially(promiseFactories, kickstart) {
- let result = Promise.resolve(kickstart);
- promiseFactories.forEach((promiseFactory) => {
- result = result.then(promiseFactory);
- });
- return result;
-}
-/**
- * Converts a Promise to a callback.
- * @param promise - The Promise to be converted to a callback
- * @returns A function that takes the callback `(cb: Function) => void`
- * @deprecated generated code should instead depend on responseToBody
+ * @param str1 -
+ * @param str2 -
*/
-// eslint-disable-next-line @typescript-eslint/ban-types
-function promiseToCallback(promise) {
- if (typeof promise.then !== "function") {
- throw new Error("The provided input is not a Promise.");
- }
- // eslint-disable-next-line @typescript-eslint/ban-types
- return (cb) => {
- promise
- .then((data) => {
- // eslint-disable-next-line promise/no-callback-in-promise
- return cb(undefined, data);
- })
- .catch((err) => {
- // eslint-disable-next-line promise/no-callback-in-promise
- cb(err);
- });
- };
+function iEqual(str1, str2) {
+ return str1.toLocaleLowerCase() === str2.toLocaleLowerCase();
}
/**
- * Converts a Promise to a service callback.
- * @param promise - The Promise of HttpOperationResponse to be converted to a service callback
- * @returns A function that takes the service callback (cb: ServiceCallback): void
- */
-function promiseToServiceCallback(promise) {
- if (typeof promise.then !== "function") {
- throw new Error("The provided input is not a Promise.");
- }
- return (cb) => {
- promise
- .then((data) => {
- return process.nextTick(cb, undefined, data.parsedBody, data.request, data);
- })
- .catch((err) => {
- process.nextTick(cb, err);
- });
- };
-}
-function prepareXMLRootList(obj, elementName, xmlNamespaceKey, xmlNamespace) {
- if (!Array.isArray(obj)) {
- obj = [obj];
+ * Extracts account name from the url
+ * @param url - url to extract the account name from
+ * @returns with the account name
+ */
+function getAccountNameFromUrl(url) {
+ const parsedUrl = new URL(url);
+ let accountName;
+ try {
+ if (parsedUrl.hostname.split(".")[1] === "blob") {
+ // `${defaultEndpointsProtocol}://${accountName}.blob.${endpointSuffix}`;
+ accountName = parsedUrl.hostname.split(".")[0];
+ }
+ else if (isIpEndpointStyle(parsedUrl)) {
+ // IPv4/IPv6 address hosts... Example - http://192.0.0.10:10001/devstoreaccount1/
+ // Single word domain without a [dot] in the endpoint... Example - http://localhost:10001/devstoreaccount1/
+ // .getPath() -> /devstoreaccount1/
+ accountName = parsedUrl.pathname.split("/")[1];
+ }
+ else {
+ // Custom domain case: "https://customdomain.com/containername/blob".
+ accountName = "";
+ }
+ return accountName;
}
- if (!xmlNamespaceKey || !xmlNamespace) {
- return { [elementName]: obj };
+ catch (error) {
+ throw new Error("Unable to extract accountName with provided information.");
}
- const result = { [elementName]: obj };
- result[XML_ATTRKEY] = { [xmlNamespaceKey]: xmlNamespace };
- return result;
-}
-/**
- * Applies the properties on the prototype of sourceCtors to the prototype of targetCtor
- * @param targetCtor - The target object on which the properties need to be applied.
- * @param sourceCtors - An array of source objects from which the properties need to be taken.
- */
-function applyMixins(targetCtorParam, sourceCtors) {
- const castTargetCtorParam = targetCtorParam;
- sourceCtors.forEach((sourceCtor) => {
- Object.getOwnPropertyNames(sourceCtor.prototype).forEach((name) => {
- castTargetCtorParam.prototype[name] = sourceCtor.prototype[name];
- });
- });
}
-const validateISODuration = /^(-|\+)?P(?:([-+]?[0-9,.]*)Y)?(?:([-+]?[0-9,.]*)M)?(?:([-+]?[0-9,.]*)W)?(?:([-+]?[0-9,.]*)D)?(?:T(?:([-+]?[0-9,.]*)H)?(?:([-+]?[0-9,.]*)M)?(?:([-+]?[0-9,.]*)S)?)?$/;
-/**
- * Indicates whether the given string is in ISO 8601 format.
- * @param value - The value to be validated for ISO 8601 duration format.
- * @returns `true` if valid, `false` otherwise.
- */
-function isDuration(value) {
- return validateISODuration.test(value);
+function isIpEndpointStyle(parsedUrl) {
+ const host = parsedUrl.host;
+ // Case 1: Ipv6, use a broad regex to find out candidates whose host contains two ':'.
+ // Case 2: localhost(:port) or host.docker.internal, use broad regex to match port part.
+ // Case 3: Ipv4, use broad regex which just check if host contains Ipv4.
+ // For valid host please refer to https://man7.org/linux/man-pages/man7/hostname.7.html.
+ return (/^.*:.*:.*$|^(localhost|host.docker.internal)(:[0-9]+)?$|^(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])){3}(:[0-9]+)?$/.test(host) ||
+ (Boolean(parsedUrl.port) && PathStylePorts.includes(parsedUrl.port)));
}
/**
- * Replace all of the instances of searchValue in value with the provided replaceValue.
- * @param value - The value to search and replace in.
- * @param searchValue - The value to search for in the value argument.
- * @param replaceValue - The value to replace searchValue with in the value argument.
- * @returns The value where each instance of searchValue was replaced with replacedValue.
+ * Convert Tags to encoded string.
+ *
+ * @param tags -
*/
-function replaceAll(value, searchValue, replaceValue) {
- return !value || !searchValue ? value : value.split(searchValue).join(replaceValue || "");
+function toBlobTagsString(tags) {
+ if (tags === undefined) {
+ return undefined;
+ }
+ const tagPairs = [];
+ for (const key in tags) {
+ if (Object.prototype.hasOwnProperty.call(tags, key)) {
+ const value = tags[key];
+ tagPairs.push(`${encodeURIComponent(key)}=${encodeURIComponent(value)}`);
+ }
+ }
+ return tagPairs.join("&");
}
/**
- * Determines whether the given entity is a basic/primitive type
- * (string, number, boolean, null, undefined).
- * @param value - Any entity
- * @returns true is it is primitive type, false otherwise.
+ * Convert Tags type to BlobTags.
+ *
+ * @param tags -
*/
-function isPrimitiveType(value) {
- return (typeof value !== "object" && typeof value !== "function") || value === null;
-}
-function getEnvironmentValue(name) {
- if (process.env[name]) {
- return process.env[name];
+function toBlobTags(tags) {
+ if (tags === undefined) {
+ return undefined;
}
- else if (process.env[name.toLowerCase()]) {
- return process.env[name.toLowerCase()];
+ const res = {
+ blobTagSet: [],
+ };
+ for (const key in tags) {
+ if (Object.prototype.hasOwnProperty.call(tags, key)) {
+ const value = tags[key];
+ res.blobTagSet.push({
+ key,
+ value,
+ });
+ }
}
- return undefined;
+ return res;
}
/**
- * @internal
- * @returns true when input is an object type that is not null, Array, RegExp, or Date.
+ * Covert BlobTags to Tags type.
+ *
+ * @param tags -
*/
-function isObject(input) {
- return (typeof input === "object" &&
- input !== null &&
- !Array.isArray(input) &&
- !(input instanceof RegExp) &&
- !(input instanceof Date));
+function toTags(tags) {
+ if (tags === undefined) {
+ return undefined;
+ }
+ const res = {};
+ for (const blobTag of tags.blobTagSet) {
+ res[blobTag.key] = blobTag.value;
+ }
+ return res;
}
-
-// Copyright (c) Microsoft Corporation.
-// This file contains utility code to serialize and deserialize network operations according to `OperationSpec` objects generated by AutoRest.TypeScript from OpenAPI specifications.
/**
- * Used to map raw response objects to final shapes.
- * Helps packing and unpacking Dates and other encoded types that are not intrinsic to JSON.
- * Also allows pulling values from headers, as well as inserting default values and constants.
+ * Convert BlobQueryTextConfiguration to QuerySerialization type.
+ *
+ * @param textConfiguration -
*/
-class Serializer {
- constructor(
- /**
- * The provided model mapper.
- */
- modelMappers = {},
- /**
- * Whether the contents are XML or not.
- */
- isXML) {
- this.modelMappers = modelMappers;
- this.isXML = isXML;
+function toQuerySerialization(textConfiguration) {
+ if (textConfiguration === undefined) {
+ return undefined;
}
- /**
- * Validates constraints, if any. This function will throw if the provided value does not respect those constraints.
- * @param mapper - The definition of data models.
- * @param value - The value.
- * @param objectName - Name of the object. Used in the error messages.
- * @deprecated Removing the constraints validation on client side.
- */
- validateConstraints(mapper, value, objectName) {
- const failValidation = (constraintName, constraintValue) => {
- throw new Error(`"${objectName}" with value "${value}" should satisfy the constraint "${constraintName}": ${constraintValue}.`);
- };
- if (mapper.constraints && value != undefined) {
- const valueAsNumber = value;
- const { ExclusiveMaximum, ExclusiveMinimum, InclusiveMaximum, InclusiveMinimum, MaxItems, MaxLength, MinItems, MinLength, MultipleOf, Pattern, UniqueItems, } = mapper.constraints;
- if (ExclusiveMaximum != undefined && valueAsNumber >= ExclusiveMaximum) {
- failValidation("ExclusiveMaximum", ExclusiveMaximum);
- }
- if (ExclusiveMinimum != undefined && valueAsNumber <= ExclusiveMinimum) {
- failValidation("ExclusiveMinimum", ExclusiveMinimum);
- }
- if (InclusiveMaximum != undefined && valueAsNumber > InclusiveMaximum) {
- failValidation("InclusiveMaximum", InclusiveMaximum);
- }
- if (InclusiveMinimum != undefined && valueAsNumber < InclusiveMinimum) {
- failValidation("InclusiveMinimum", InclusiveMinimum);
- }
- const valueAsArray = value;
- if (MaxItems != undefined && valueAsArray.length > MaxItems) {
- failValidation("MaxItems", MaxItems);
- }
- if (MaxLength != undefined && valueAsArray.length > MaxLength) {
- failValidation("MaxLength", MaxLength);
- }
- if (MinItems != undefined && valueAsArray.length < MinItems) {
- failValidation("MinItems", MinItems);
- }
- if (MinLength != undefined && valueAsArray.length < MinLength) {
- failValidation("MinLength", MinLength);
- }
- if (MultipleOf != undefined && valueAsNumber % MultipleOf !== 0) {
- failValidation("MultipleOf", MultipleOf);
- }
- if (Pattern) {
- const pattern = typeof Pattern === "string" ? new RegExp(Pattern) : Pattern;
- if (typeof value !== "string" || value.match(pattern) === null) {
- failValidation("Pattern", Pattern);
- }
- }
- if (UniqueItems &&
- valueAsArray.some((item, i, ar) => ar.indexOf(item) !== i)) {
- failValidation("UniqueItems", UniqueItems);
- }
- }
- }
- /**
- * Serialize the given object based on its metadata defined in the mapper.
- *
- * @param mapper - The mapper which defines the metadata of the serializable object.
- * @param object - A valid Javascript object to be serialized.
- * @param objectName - Name of the serialized object.
- * @param options - additional options to deserialization.
- * @returns A valid serialized Javascript object.
- */
- serialize(mapper, object, objectName, options = {}) {
- var _a, _b, _c;
- const updatedOptions = {
- rootName: (_a = options.rootName) !== null && _a !== void 0 ? _a : "",
- includeRoot: (_b = options.includeRoot) !== null && _b !== void 0 ? _b : false,
- xmlCharKey: (_c = options.xmlCharKey) !== null && _c !== void 0 ? _c : XML_CHARKEY,
- };
- let payload = {};
- const mapperType = mapper.type.name;
- if (!objectName) {
- objectName = mapper.serializedName;
- }
- if (mapperType.match(/^Sequence$/i) !== null) {
- payload = [];
- }
- if (mapper.isConstant) {
- object = mapper.defaultValue;
- }
- // This table of allowed values should help explain
- // the mapper.required and mapper.nullable properties.
- // X means "neither undefined or null are allowed".
- // || required
- // || true | false
- // nullable || ==========================
- // true || null | undefined/null
- // false || X | undefined
- // undefined || X | undefined/null
- const { required, nullable } = mapper;
- if (required && nullable && object === undefined) {
- throw new Error(`${objectName} cannot be undefined.`);
- }
- if (required && !nullable && object == undefined) {
- throw new Error(`${objectName} cannot be null or undefined.`);
- }
- if (!required && nullable === false && object === null) {
- throw new Error(`${objectName} cannot be null.`);
- }
- if (object == undefined) {
- payload = object;
- }
- else {
- if (mapperType.match(/^any$/i) !== null) {
- payload = object;
- }
- else if (mapperType.match(/^(Number|String|Boolean|Object|Stream|Uuid)$/i) !== null) {
- payload = serializeBasicTypes(mapperType, objectName, object);
- }
- else if (mapperType.match(/^Enum$/i) !== null) {
- const enumMapper = mapper;
- payload = serializeEnumType(objectName, enumMapper.type.allowedValues, object);
- }
- else if (mapperType.match(/^(Date|DateTime|TimeSpan|DateTimeRfc1123|UnixTime)$/i) !== null) {
- payload = serializeDateTypes(mapperType, object, objectName);
- }
- else if (mapperType.match(/^ByteArray$/i) !== null) {
- payload = serializeByteArrayType(objectName, object);
- }
- else if (mapperType.match(/^Base64Url$/i) !== null) {
- payload = serializeBase64UrlType(objectName, object);
- }
- else if (mapperType.match(/^Sequence$/i) !== null) {
- payload = serializeSequenceType(this, mapper, object, objectName, Boolean(this.isXML), updatedOptions);
- }
- else if (mapperType.match(/^Dictionary$/i) !== null) {
- payload = serializeDictionaryType(this, mapper, object, objectName, Boolean(this.isXML), updatedOptions);
- }
- else if (mapperType.match(/^Composite$/i) !== null) {
- payload = serializeCompositeType(this, mapper, object, objectName, Boolean(this.isXML), updatedOptions);
- }
- }
- return payload;
- }
- /**
- * Deserialize the given object based on its metadata defined in the mapper.
- *
- * @param mapper - The mapper which defines the metadata of the serializable object.
- * @param responseBody - A valid Javascript entity to be deserialized.
- * @param objectName - Name of the deserialized object.
- * @param options - Controls behavior of XML parser and builder.
- * @returns A valid deserialized Javascript object.
- */
- deserialize(mapper, responseBody, objectName, options = {}) {
- var _a, _b, _c;
- const updatedOptions = {
- rootName: (_a = options.rootName) !== null && _a !== void 0 ? _a : "",
- includeRoot: (_b = options.includeRoot) !== null && _b !== void 0 ? _b : false,
- xmlCharKey: (_c = options.xmlCharKey) !== null && _c !== void 0 ? _c : XML_CHARKEY,
- };
- if (responseBody == undefined) {
- if (this.isXML && mapper.type.name === "Sequence" && !mapper.xmlIsWrapped) {
- // Edge case for empty XML non-wrapped lists. xml2js can't distinguish
- // between the list being empty versus being missing,
- // so let's do the more user-friendly thing and return an empty list.
- responseBody = [];
- }
- // specifically check for undefined as default value can be a falsey value `0, "", false, null`
- if (mapper.defaultValue !== undefined) {
- responseBody = mapper.defaultValue;
- }
- return responseBody;
- }
- let payload;
- const mapperType = mapper.type.name;
- if (!objectName) {
- objectName = mapper.serializedName;
- }
- if (mapperType.match(/^Composite$/i) !== null) {
- payload = deserializeCompositeType(this, mapper, responseBody, objectName, updatedOptions);
- }
- else {
- if (this.isXML) {
- const xmlCharKey = updatedOptions.xmlCharKey;
- const castResponseBody = responseBody;
- /**
- * If the mapper specifies this as a non-composite type value but the responseBody contains
- * both header ("$" i.e., XML_ATTRKEY) and body ("#" i.e., XML_CHARKEY) properties,
- * then just reduce the responseBody value to the body ("#" i.e., XML_CHARKEY) property.
- */
- if (castResponseBody[XML_ATTRKEY] != undefined &&
- castResponseBody[xmlCharKey] != undefined) {
- responseBody = castResponseBody[xmlCharKey];
- }
- }
- if (mapperType.match(/^Number$/i) !== null) {
- payload = parseFloat(responseBody);
- if (isNaN(payload)) {
- payload = responseBody;
- }
- }
- else if (mapperType.match(/^Boolean$/i) !== null) {
- if (responseBody === "true") {
- payload = true;
- }
- else if (responseBody === "false") {
- payload = false;
- }
- else {
- payload = responseBody;
- }
- }
- else if (mapperType.match(/^(String|Enum|Object|Stream|Uuid|TimeSpan|any)$/i) !== null) {
- payload = responseBody;
- }
- else if (mapperType.match(/^(Date|DateTime|DateTimeRfc1123)$/i) !== null) {
- payload = new Date(responseBody);
- }
- else if (mapperType.match(/^UnixTime$/i) !== null) {
- payload = unixTimeToDate(responseBody);
- }
- else if (mapperType.match(/^ByteArray$/i) !== null) {
- payload = decodeString(responseBody);
- }
- else if (mapperType.match(/^Base64Url$/i) !== null) {
- payload = base64UrlToByteArray(responseBody);
- }
- else if (mapperType.match(/^Sequence$/i) !== null) {
- payload = deserializeSequenceType(this, mapper, responseBody, objectName, updatedOptions);
- }
- else if (mapperType.match(/^Dictionary$/i) !== null) {
- payload = deserializeDictionaryType(this, mapper, responseBody, objectName, updatedOptions);
- }
- }
- if (mapper.isConstant) {
- payload = mapper.defaultValue;
- }
- return payload;
- }
-}
-function trimEnd(str, ch) {
- let len = str.length;
- while (len - 1 >= 0 && str[len - 1] === ch) {
- --len;
- }
- return str.substr(0, len);
-}
-function bufferToBase64Url(buffer) {
- if (!buffer) {
- return undefined;
- }
- if (!(buffer instanceof Uint8Array)) {
- throw new Error(`Please provide an input of type Uint8Array for converting to Base64Url.`);
- }
- // Uint8Array to Base64.
- const str = encodeByteArray(buffer);
- // Base64 to Base64Url.
- return trimEnd(str, "=").replace(/\+/g, "-").replace(/\//g, "_");
-}
-function base64UrlToByteArray(str) {
- if (!str) {
- return undefined;
- }
- if (str && typeof str.valueOf() !== "string") {
- throw new Error("Please provide an input of type string for converting to Uint8Array");
- }
- // Base64Url to Base64.
- str = str.replace(/-/g, "+").replace(/_/g, "/");
- // Base64 to Uint8Array.
- return decodeString(str);
-}
-function splitSerializeName(prop) {
- const classes = [];
- let partialclass = "";
- if (prop) {
- const subwords = prop.split(".");
- for (const item of subwords) {
- if (item.charAt(item.length - 1) === "\\") {
- partialclass += item.substr(0, item.length - 1) + ".";
- }
- else {
- partialclass += item;
- classes.push(partialclass);
- partialclass = "";
- }
- }
+ switch (textConfiguration.kind) {
+ case "csv":
+ return {
+ format: {
+ type: "delimited",
+ delimitedTextConfiguration: {
+ columnSeparator: textConfiguration.columnSeparator || ",",
+ fieldQuote: textConfiguration.fieldQuote || "",
+ recordSeparator: textConfiguration.recordSeparator,
+ escapeChar: textConfiguration.escapeCharacter || "",
+ headersPresent: textConfiguration.hasHeaders || false,
+ },
+ },
+ };
+ case "json":
+ return {
+ format: {
+ type: "json",
+ jsonTextConfiguration: {
+ recordSeparator: textConfiguration.recordSeparator,
+ },
+ },
+ };
+ case "arrow":
+ return {
+ format: {
+ type: "arrow",
+ arrowConfiguration: {
+ schema: textConfiguration.schema,
+ },
+ },
+ };
+ case "parquet":
+ return {
+ format: {
+ type: "parquet",
+ },
+ };
+ default:
+ throw Error("Invalid BlobQueryTextConfiguration.");
}
- return classes;
}
-function dateToUnixTime(d) {
- if (!d) {
+function parseObjectReplicationRecord(objectReplicationRecord) {
+ if (!objectReplicationRecord) {
return undefined;
}
- if (typeof d.valueOf() === "string") {
- d = new Date(d);
- }
- return Math.floor(d.getTime() / 1000);
-}
-function unixTimeToDate(n) {
- if (!n) {
+ if ("policy-id" in objectReplicationRecord) {
+ // If the dictionary contains a key with policy id, we are not required to do any parsing since
+ // the policy id should already be stored in the ObjectReplicationDestinationPolicyId.
return undefined;
}
- return new Date(n * 1000);
-}
-function serializeBasicTypes(typeName, objectName, value) {
- if (value !== null && value !== undefined) {
- if (typeName.match(/^Number$/i) !== null) {
- if (typeof value !== "number") {
- throw new Error(`${objectName} with value ${value} must be of type number.`);
- }
- }
- else if (typeName.match(/^String$/i) !== null) {
- if (typeof value.valueOf() !== "string") {
- throw new Error(`${objectName} with value "${value}" must be of type string.`);
- }
- }
- else if (typeName.match(/^Uuid$/i) !== null) {
- if (!(typeof value.valueOf() === "string" && isValidUuid(value))) {
- throw new Error(`${objectName} with value "${value}" must be of type string and a valid uuid.`);
- }
+ const orProperties = [];
+ for (const key in objectReplicationRecord) {
+ const ids = key.split("_");
+ const policyPrefix = "or-";
+ if (ids[0].startsWith(policyPrefix)) {
+ ids[0] = ids[0].substring(policyPrefix.length);
}
- else if (typeName.match(/^Boolean$/i) !== null) {
- if (typeof value !== "boolean") {
- throw new Error(`${objectName} with value ${value} must be of type boolean.`);
- }
+ const rule = {
+ ruleId: ids[1],
+ replicationStatus: objectReplicationRecord[key],
+ };
+ const policyIndex = orProperties.findIndex((policy) => policy.policyId === ids[0]);
+ if (policyIndex > -1) {
+ orProperties[policyIndex].rules.push(rule);
}
- else if (typeName.match(/^Stream$/i) !== null) {
- const objectType = typeof value;
- if (objectType !== "string" &&
- objectType !== "function" &&
- !(value instanceof ArrayBuffer) &&
- !ArrayBuffer.isView(value) &&
- !((typeof Blob === "function" || typeof Blob === "object") && value instanceof Blob)) {
- throw new Error(`${objectName} must be a string, Blob, ArrayBuffer, ArrayBufferView, or a function returning NodeJS.ReadableStream.`);
- }
+ else {
+ orProperties.push({
+ policyId: ids[0],
+ rules: [rule],
+ });
}
}
- return value;
+ return orProperties;
}
-function serializeEnumType(objectName, allowedValues, value) {
- if (!allowedValues) {
- throw new Error(`Please provide a set of allowedValues to validate ${objectName} as an Enum Type.`);
- }
- const isPresent = allowedValues.some((item) => {
- if (typeof item.valueOf() === "string") {
- return item.toLowerCase() === value.toLowerCase();
- }
- return item === value;
- });
- if (!isPresent) {
- throw new Error(`${value} is not a valid value for ${objectName}. The valid values are: ${JSON.stringify(allowedValues)}.`);
- }
- return value;
+function httpAuthorizationToString(httpAuthorization) {
+ return httpAuthorization ? httpAuthorization.scheme + " " + httpAuthorization.value : undefined;
}
-function serializeByteArrayType(objectName, value) {
- let returnValue = "";
- if (value != undefined) {
- if (!(value instanceof Uint8Array)) {
- throw new Error(`${objectName} must be of type Uint8Array.`);
- }
- returnValue = encodeByteArray(value);
+function BlobNameToString(name) {
+ if (name.encoded) {
+ return decodeURIComponent(name.content);
}
- return returnValue;
-}
-function serializeBase64UrlType(objectName, value) {
- let returnValue = "";
- if (value != undefined) {
- if (!(value instanceof Uint8Array)) {
- throw new Error(`${objectName} must be of type Uint8Array.`);
- }
- returnValue = bufferToBase64Url(value) || "";
+ else {
+ return name.content;
}
- return returnValue;
}
-function serializeDateTypes(typeName, value, objectName) {
- if (value != undefined) {
- if (typeName.match(/^Date$/i) !== null) {
- if (!(value instanceof Date ||
- (typeof value.valueOf() === "string" && !isNaN(Date.parse(value))))) {
- throw new Error(`${objectName} must be an instanceof Date or a string in ISO8601 format.`);
- }
- value =
- value instanceof Date
- ? value.toISOString().substring(0, 10)
- : new Date(value).toISOString().substring(0, 10);
- }
- else if (typeName.match(/^DateTime$/i) !== null) {
- if (!(value instanceof Date ||
- (typeof value.valueOf() === "string" && !isNaN(Date.parse(value))))) {
- throw new Error(`${objectName} must be an instanceof Date or a string in ISO8601 format.`);
- }
- value = value instanceof Date ? value.toISOString() : new Date(value).toISOString();
- }
- else if (typeName.match(/^DateTimeRfc1123$/i) !== null) {
- if (!(value instanceof Date ||
- (typeof value.valueOf() === "string" && !isNaN(Date.parse(value))))) {
- throw new Error(`${objectName} must be an instanceof Date or a string in RFC-1123 format.`);
- }
- value = value instanceof Date ? value.toUTCString() : new Date(value).toUTCString();
- }
- else if (typeName.match(/^UnixTime$/i) !== null) {
- if (!(value instanceof Date ||
- (typeof value.valueOf() === "string" && !isNaN(Date.parse(value))))) {
- throw new Error(`${objectName} must be an instanceof Date or a string in RFC-1123/ISO8601 format ` +
- `for it to be serialized in UnixTime/Epoch format.`);
- }
- value = dateToUnixTime(value);
- }
- else if (typeName.match(/^TimeSpan$/i) !== null) {
- if (!isDuration(value)) {
- throw new Error(`${objectName} must be a string in ISO 8601 format. Instead was "${value}".`);
- }
- }
- }
- return value;
+function ConvertInternalResponseOfListBlobFlat(internalResponse) {
+ return Object.assign(Object.assign({}, internalResponse), { segment: {
+ blobItems: internalResponse.segment.blobItems.map((blobItemInteral) => {
+ const blobItem = Object.assign(Object.assign({}, blobItemInteral), { name: BlobNameToString(blobItemInteral.name) });
+ return blobItem;
+ }),
+ } });
}
-function serializeSequenceType(serializer, mapper, object, objectName, isXml, options) {
- if (!Array.isArray(object)) {
- throw new Error(`${objectName} must be of type Array.`);
- }
- const elementType = mapper.type.element;
- if (!elementType || typeof elementType !== "object") {
- throw new Error(`element" metadata for an Array must be defined in the ` +
- `mapper and it must of type "object" in ${objectName}.`);
- }
- const tempArray = [];
- for (let i = 0; i < object.length; i++) {
- const serializedValue = serializer.serialize(elementType, object[i], objectName, options);
- if (isXml && elementType.xmlNamespace) {
- const xmlnsKey = elementType.xmlNamespacePrefix
- ? `xmlns:${elementType.xmlNamespacePrefix}`
- : "xmlns";
- if (elementType.type.name === "Composite") {
- tempArray[i] = Object.assign({}, serializedValue);
- tempArray[i][XML_ATTRKEY] = { [xmlnsKey]: elementType.xmlNamespace };
- }
- else {
- tempArray[i] = {};
- tempArray[i][options.xmlCharKey] = serializedValue;
- tempArray[i][XML_ATTRKEY] = { [xmlnsKey]: elementType.xmlNamespace };
- }
+function ConvertInternalResponseOfListBlobHierarchy(internalResponse) {
+ var _a;
+ return Object.assign(Object.assign({}, internalResponse), { segment: {
+ blobPrefixes: (_a = internalResponse.segment.blobPrefixes) === null || _a === void 0 ? void 0 : _a.map((blobPrefixInternal) => {
+ const blobPrefix = Object.assign(Object.assign({}, blobPrefixInternal), { name: BlobNameToString(blobPrefixInternal.name) });
+ return blobPrefix;
+ }),
+ blobItems: internalResponse.segment.blobItems.map((blobItemInteral) => {
+ const blobItem = Object.assign(Object.assign({}, blobItemInteral), { name: BlobNameToString(blobItemInteral.name) });
+ return blobItem;
+ }),
+ } });
+}
+function* ExtractPageRangeInfoItems(getPageRangesSegment) {
+ let pageRange = [];
+ let clearRange = [];
+ if (getPageRangesSegment.pageRange)
+ pageRange = getPageRangesSegment.pageRange;
+ if (getPageRangesSegment.clearRange)
+ clearRange = getPageRangesSegment.clearRange;
+ let pageRangeIndex = 0;
+ let clearRangeIndex = 0;
+ while (pageRangeIndex < pageRange.length && clearRangeIndex < clearRange.length) {
+ if (pageRange[pageRangeIndex].start < clearRange[clearRangeIndex].start) {
+ yield {
+ start: pageRange[pageRangeIndex].start,
+ end: pageRange[pageRangeIndex].end,
+ isClear: false,
+ };
+ ++pageRangeIndex;
}
else {
- tempArray[i] = serializedValue;
+ yield {
+ start: clearRange[clearRangeIndex].start,
+ end: clearRange[clearRangeIndex].end,
+ isClear: true,
+ };
+ ++clearRangeIndex;
}
}
- return tempArray;
-}
-function serializeDictionaryType(serializer, mapper, object, objectName, isXml, options) {
- if (typeof object !== "object") {
- throw new Error(`${objectName} must be of type object.`);
- }
- const valueType = mapper.type.value;
- if (!valueType || typeof valueType !== "object") {
- throw new Error(`"value" metadata for a Dictionary must be defined in the ` +
- `mapper and it must of type "object" in ${objectName}.`);
- }
- const tempDictionary = {};
- for (const key of Object.keys(object)) {
- const serializedValue = serializer.serialize(valueType, object[key], objectName, options);
- // If the element needs an XML namespace we need to add it within the $ property
- tempDictionary[key] = getXmlObjectValue(valueType, serializedValue, isXml, options);
+ for (; pageRangeIndex < pageRange.length; ++pageRangeIndex) {
+ yield {
+ start: pageRange[pageRangeIndex].start,
+ end: pageRange[pageRangeIndex].end,
+ isClear: false,
+ };
}
- // Add the namespace to the root element if needed
- if (isXml && mapper.xmlNamespace) {
- const xmlnsKey = mapper.xmlNamespacePrefix ? `xmlns:${mapper.xmlNamespacePrefix}` : "xmlns";
- const result = tempDictionary;
- result[XML_ATTRKEY] = { [xmlnsKey]: mapper.xmlNamespace };
- return result;
+ for (; clearRangeIndex < clearRange.length; ++clearRangeIndex) {
+ yield {
+ start: clearRange[clearRangeIndex].start,
+ end: clearRange[clearRangeIndex].end,
+ isClear: true,
+ };
}
- return tempDictionary;
}
/**
- * Resolves the additionalProperties property from a referenced mapper.
- * @param serializer - The serializer containing the entire set of mappers.
- * @param mapper - The composite mapper to resolve.
- * @param objectName - Name of the object being serialized.
+ * Escape the blobName but keep path separator ('/').
*/
-function resolveAdditionalProperties(serializer, mapper, objectName) {
- const additionalProperties = mapper.type.additionalProperties;
- if (!additionalProperties && mapper.type.className) {
- const modelMapper = resolveReferencedMapper(serializer, mapper, objectName);
- return modelMapper === null || modelMapper === void 0 ? void 0 : modelMapper.type.additionalProperties;
+function EscapePath(blobName) {
+ const split = blobName.split("/");
+ for (let i = 0; i < split.length; i++) {
+ split[i] = encodeURIComponent(split[i]);
}
- return additionalProperties;
+ return split.join("/");
}
/**
- * Finds the mapper referenced by `className`.
- * @param serializer - The serializer containing the entire set of mappers
- * @param mapper - The composite mapper to resolve
- * @param objectName - Name of the object being serialized
+ * A typesafe helper for ensuring that a given response object has
+ * the original _response attached.
+ * @param response - A response object from calling a client operation
+ * @returns The same object, but with known _response property
*/
-function resolveReferencedMapper(serializer, mapper, objectName) {
- const className = mapper.type.className;
- if (!className) {
- throw new Error(`Class name for model "${objectName}" is not provided in the mapper "${JSON.stringify(mapper, undefined, 2)}".`);
+function assertResponse(response) {
+ if (`_response` in response) {
+ return response;
}
- return serializer.modelMappers[className];
+ throw new TypeError(`Unexpected response object ${response}`);
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * Resolves a composite mapper's modelProperties.
- * @param serializer - The serializer containing the entire set of mappers
- * @param mapper - The composite mapper to resolve
+ * RetryPolicy types.
*/
-function resolveModelProperties(serializer, mapper, objectName) {
- let modelProps = mapper.type.modelProperties;
- if (!modelProps) {
- const modelMapper = resolveReferencedMapper(serializer, mapper, objectName);
- if (!modelMapper) {
- throw new Error(`mapper() cannot be null or undefined for model "${mapper.type.className}".`);
- }
- modelProps = modelMapper === null || modelMapper === void 0 ? void 0 : modelMapper.type.modelProperties;
- if (!modelProps) {
- throw new Error(`modelProperties cannot be null or undefined in the ` +
- `mapper "${JSON.stringify(modelMapper)}" of type "${mapper.type.className}" for object "${objectName}".`);
- }
- }
- return modelProps;
-}
-function serializeCompositeType(serializer, mapper, object, objectName, isXml, options) {
- if (getPolymorphicDiscriminatorRecursively(serializer, mapper)) {
- mapper = getPolymorphicMapper(serializer, mapper, object, "clientName");
- }
- if (object != undefined) {
- const payload = {};
- const modelProps = resolveModelProperties(serializer, mapper, objectName);
- for (const key of Object.keys(modelProps)) {
- const propertyMapper = modelProps[key];
- if (propertyMapper.readOnly) {
- continue;
- }
- let propName;
- let parentObject = payload;
- if (serializer.isXML) {
- if (propertyMapper.xmlIsWrapped) {
- propName = propertyMapper.xmlName;
- }
- else {
- propName = propertyMapper.xmlElementName || propertyMapper.xmlName;
- }
- }
- else {
- const paths = splitSerializeName(propertyMapper.serializedName);
- propName = paths.pop();
- for (const pathName of paths) {
- const childObject = parentObject[pathName];
- if (childObject == undefined &&
- (object[key] != undefined || propertyMapper.defaultValue !== undefined)) {
- parentObject[pathName] = {};
- }
- parentObject = parentObject[pathName];
- }
- }
- if (parentObject != undefined) {
- if (isXml && mapper.xmlNamespace) {
- const xmlnsKey = mapper.xmlNamespacePrefix
- ? `xmlns:${mapper.xmlNamespacePrefix}`
- : "xmlns";
- parentObject[XML_ATTRKEY] = Object.assign(Object.assign({}, parentObject[XML_ATTRKEY]), { [xmlnsKey]: mapper.xmlNamespace });
- }
- const propertyObjectName = propertyMapper.serializedName !== ""
- ? objectName + "." + propertyMapper.serializedName
- : objectName;
- let toSerialize = object[key];
- const polymorphicDiscriminator = getPolymorphicDiscriminatorRecursively(serializer, mapper);
- if (polymorphicDiscriminator &&
- polymorphicDiscriminator.clientName === key &&
- toSerialize == undefined) {
- toSerialize = mapper.serializedName;
- }
- const serializedValue = serializer.serialize(propertyMapper, toSerialize, propertyObjectName, options);
- if (serializedValue !== undefined && propName != undefined) {
- const value = getXmlObjectValue(propertyMapper, serializedValue, isXml, options);
- if (isXml && propertyMapper.xmlIsAttribute) {
- // XML_ATTRKEY, i.e., $ is the key attributes are kept under in xml2js.
- // This keeps things simple while preventing name collision
- // with names in user documents.
- parentObject[XML_ATTRKEY] = parentObject[XML_ATTRKEY] || {};
- parentObject[XML_ATTRKEY][propName] = serializedValue;
- }
- else if (isXml && propertyMapper.xmlIsWrapped) {
- parentObject[propName] = { [propertyMapper.xmlElementName]: value };
- }
- else {
- parentObject[propName] = value;
- }
- }
- }
- }
- const additionalPropertiesMapper = resolveAdditionalProperties(serializer, mapper, objectName);
- if (additionalPropertiesMapper) {
- const propNames = Object.keys(modelProps);
- for (const clientPropName in object) {
- const isAdditionalProperty = propNames.every((pn) => pn !== clientPropName);
- if (isAdditionalProperty) {
- payload[clientPropName] = serializer.serialize(additionalPropertiesMapper, object[clientPropName], objectName + '["' + clientPropName + '"]', options);
- }
- }
- }
- return payload;
+exports.StorageRetryPolicyType = void 0;
+(function (StorageRetryPolicyType) {
+ /**
+ * Exponential retry. Retry time delay grows exponentially.
+ */
+ StorageRetryPolicyType[StorageRetryPolicyType["EXPONENTIAL"] = 0] = "EXPONENTIAL";
+ /**
+ * Linear retry. Retry time delay grows linearly.
+ */
+ StorageRetryPolicyType[StorageRetryPolicyType["FIXED"] = 1] = "FIXED";
+})(exports.StorageRetryPolicyType || (exports.StorageRetryPolicyType = {}));
+// Default values of StorageRetryOptions
+const DEFAULT_RETRY_OPTIONS$1 = {
+ maxRetryDelayInMs: 120 * 1000,
+ maxTries: 4,
+ retryDelayInMs: 4 * 1000,
+ retryPolicyType: exports.StorageRetryPolicyType.EXPONENTIAL,
+ secondaryHost: "",
+ tryTimeoutInMs: undefined, // Use server side default timeout strategy
+};
+const RETRY_ABORT_ERROR$1 = new abortController.AbortError("The operation was aborted.");
+/**
+ * Retry policy with exponential retry and linear retry implemented.
+ */
+class StorageRetryPolicy extends BaseRequestPolicy {
+ /**
+ * Creates an instance of RetryPolicy.
+ *
+ * @param nextPolicy -
+ * @param options -
+ * @param retryOptions -
+ */
+ constructor(nextPolicy, options, retryOptions = DEFAULT_RETRY_OPTIONS$1) {
+ super(nextPolicy, options);
+ // Initialize retry options
+ this.retryOptions = {
+ retryPolicyType: retryOptions.retryPolicyType
+ ? retryOptions.retryPolicyType
+ : DEFAULT_RETRY_OPTIONS$1.retryPolicyType,
+ maxTries: retryOptions.maxTries && retryOptions.maxTries >= 1
+ ? Math.floor(retryOptions.maxTries)
+ : DEFAULT_RETRY_OPTIONS$1.maxTries,
+ tryTimeoutInMs: retryOptions.tryTimeoutInMs && retryOptions.tryTimeoutInMs >= 0
+ ? retryOptions.tryTimeoutInMs
+ : DEFAULT_RETRY_OPTIONS$1.tryTimeoutInMs,
+ retryDelayInMs: retryOptions.retryDelayInMs && retryOptions.retryDelayInMs >= 0
+ ? Math.min(retryOptions.retryDelayInMs, retryOptions.maxRetryDelayInMs
+ ? retryOptions.maxRetryDelayInMs
+ : DEFAULT_RETRY_OPTIONS$1.maxRetryDelayInMs)
+ : DEFAULT_RETRY_OPTIONS$1.retryDelayInMs,
+ maxRetryDelayInMs: retryOptions.maxRetryDelayInMs && retryOptions.maxRetryDelayInMs >= 0
+ ? retryOptions.maxRetryDelayInMs
+ : DEFAULT_RETRY_OPTIONS$1.maxRetryDelayInMs,
+ secondaryHost: retryOptions.secondaryHost
+ ? retryOptions.secondaryHost
+ : DEFAULT_RETRY_OPTIONS$1.secondaryHost,
+ };
}
- return object;
-}
-function getXmlObjectValue(propertyMapper, serializedValue, isXml, options) {
- if (!isXml || !propertyMapper.xmlNamespace) {
- return serializedValue;
+ /**
+ * Sends request.
+ *
+ * @param request -
+ */
+ async sendRequest(request) {
+ return this.attemptSendRequest(request, false, 1);
}
- const xmlnsKey = propertyMapper.xmlNamespacePrefix
- ? `xmlns:${propertyMapper.xmlNamespacePrefix}`
- : "xmlns";
- const xmlNamespace = { [xmlnsKey]: propertyMapper.xmlNamespace };
- if (["Composite"].includes(propertyMapper.type.name)) {
- if (serializedValue[XML_ATTRKEY]) {
- return serializedValue;
- }
- else {
- const result = Object.assign({}, serializedValue);
- result[XML_ATTRKEY] = xmlNamespace;
- return result;
+ /**
+ * Decide and perform next retry. Won't mutate request parameter.
+ *
+ * @param request -
+ * @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then
+ * the resource was not found. This may be due to replication delay. So, in this
+ * case, we'll never try the secondary again for this operation.
+ * @param attempt - How many retries has been attempted to performed, starting from 1, which includes
+ * the attempt will be performed by this method call.
+ */
+ async attemptSendRequest(request, secondaryHas404, attempt) {
+ const newRequest = request.clone();
+ const isPrimaryRetry = secondaryHas404 ||
+ !this.retryOptions.secondaryHost ||
+ !(request.method === "GET" || request.method === "HEAD" || request.method === "OPTIONS") ||
+ attempt % 2 === 1;
+ if (!isPrimaryRetry) {
+ newRequest.url = setURLHost(newRequest.url, this.retryOptions.secondaryHost);
}
- }
- const result = {};
- result[options.xmlCharKey] = serializedValue;
- result[XML_ATTRKEY] = xmlNamespace;
- return result;
-}
-function isSpecialXmlProperty(propertyName, options) {
- return [XML_ATTRKEY, options.xmlCharKey].includes(propertyName);
-}
-function deserializeCompositeType(serializer, mapper, responseBody, objectName, options) {
- var _a, _b;
- const xmlCharKey = (_a = options.xmlCharKey) !== null && _a !== void 0 ? _a : XML_CHARKEY;
- if (getPolymorphicDiscriminatorRecursively(serializer, mapper)) {
- mapper = getPolymorphicMapper(serializer, mapper, responseBody, "serializedName");
- }
- const modelProps = resolveModelProperties(serializer, mapper, objectName);
- let instance = {};
- const handledPropertyNames = [];
- for (const key of Object.keys(modelProps)) {
- const propertyMapper = modelProps[key];
- const paths = splitSerializeName(modelProps[key].serializedName);
- handledPropertyNames.push(paths[0]);
- const { serializedName, xmlName, xmlElementName } = propertyMapper;
- let propertyObjectName = objectName;
- if (serializedName !== "" && serializedName !== undefined) {
- propertyObjectName = objectName + "." + serializedName;
+ // Set the server-side timeout query parameter "timeout=[seconds]"
+ if (this.retryOptions.tryTimeoutInMs) {
+ newRequest.url = setURLParameter(newRequest.url, URLConstants.Parameters.TIMEOUT, Math.floor(this.retryOptions.tryTimeoutInMs / 1000).toString());
}
- const headerCollectionPrefix = propertyMapper.headerCollectionPrefix;
- if (headerCollectionPrefix) {
- const dictionary = {};
- for (const headerKey of Object.keys(responseBody)) {
- if (headerKey.startsWith(headerCollectionPrefix)) {
- dictionary[headerKey.substring(headerCollectionPrefix.length)] = serializer.deserialize(propertyMapper.type.value, responseBody[headerKey], propertyObjectName, options);
- }
- handledPropertyNames.push(headerKey);
+ let response;
+ try {
+ logger.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? "Primary" : "Secondary"}`);
+ response = await this._nextPolicy.sendRequest(newRequest);
+ if (!this.shouldRetry(isPrimaryRetry, attempt, response)) {
+ return response;
}
- instance[key] = dictionary;
+ secondaryHas404 = secondaryHas404 || (!isPrimaryRetry && response.status === 404);
}
- else if (serializer.isXML) {
- if (propertyMapper.xmlIsAttribute && responseBody[XML_ATTRKEY]) {
- instance[key] = serializer.deserialize(propertyMapper, responseBody[XML_ATTRKEY][xmlName], propertyObjectName, options);
- }
- else if (propertyMapper.xmlIsMsText) {
- if (responseBody[xmlCharKey] !== undefined) {
- instance[key] = responseBody[xmlCharKey];
- }
- else if (typeof responseBody === "string") {
- // The special case where xml parser parses "content" into JSON of
- // `{ name: "content"}` instead of `{ name: { "_": "content" }}`
- instance[key] = responseBody;
- }
+ catch (err) {
+ logger.error(`RetryPolicy: Caught error, message: ${err.message}, code: ${err.code}`);
+ if (!this.shouldRetry(isPrimaryRetry, attempt, response, err)) {
+ throw err;
}
- else {
- const propertyName = xmlElementName || xmlName || serializedName;
- if (propertyMapper.xmlIsWrapped) {
- /* a list of wrapped by
- For the xml example below
-
- ...
- ...
-
- the responseBody has
- {
- Cors: {
- CorsRule: [{...}, {...}]
- }
- }
- xmlName is "Cors" and xmlElementName is"CorsRule".
- */
- const wrapped = responseBody[xmlName];
- const elementList = (_b = wrapped === null || wrapped === void 0 ? void 0 : wrapped[xmlElementName]) !== null && _b !== void 0 ? _b : [];
- instance[key] = serializer.deserialize(propertyMapper, elementList, propertyObjectName, options);
- handledPropertyNames.push(xmlName);
- }
- else {
- const property = responseBody[propertyName];
- instance[key] = serializer.deserialize(propertyMapper, property, propertyObjectName, options);
- handledPropertyNames.push(propertyName);
+ }
+ await this.delay(isPrimaryRetry, attempt, request.abortSignal);
+ return this.attemptSendRequest(request, secondaryHas404, ++attempt);
+ }
+ /**
+ * Decide whether to retry according to last HTTP response and retry counters.
+ *
+ * @param isPrimaryRetry -
+ * @param attempt -
+ * @param response -
+ * @param err -
+ */
+ shouldRetry(isPrimaryRetry, attempt, response, err) {
+ if (attempt >= this.retryOptions.maxTries) {
+ logger.info(`RetryPolicy: Attempt(s) ${attempt} >= maxTries ${this.retryOptions
+ .maxTries}, no further try.`);
+ return false;
+ }
+ // Handle network failures, you may need to customize the list when you implement
+ // your own http client
+ const retriableErrors = [
+ "ETIMEDOUT",
+ "ESOCKETTIMEDOUT",
+ "ECONNREFUSED",
+ "ECONNRESET",
+ "ENOENT",
+ "ENOTFOUND",
+ "TIMEOUT",
+ "EPIPE",
+ "REQUEST_SEND_ERROR", // For default xhr based http client provided in ms-rest-js
+ ];
+ if (err) {
+ for (const retriableError of retriableErrors) {
+ if (err.name.toUpperCase().includes(retriableError) ||
+ err.message.toUpperCase().includes(retriableError) ||
+ (err.code && err.code.toString().toUpperCase() === retriableError)) {
+ logger.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);
+ return true;
}
}
}
- else {
- // deserialize the property if it is present in the provided responseBody instance
- let propertyInstance;
- let res = responseBody;
- // traversing the object step by step.
- for (const item of paths) {
- if (!res)
- break;
- res = res[item];
- }
- propertyInstance = res;
- const polymorphicDiscriminator = mapper.type.polymorphicDiscriminator;
- // checking that the model property name (key)(ex: "fishtype") and the
- // clientName of the polymorphicDiscriminator {metadata} (ex: "fishtype")
- // instead of the serializedName of the polymorphicDiscriminator (ex: "fish.type")
- // is a better approach. The generator is not consistent with escaping '\.' in the
- // serializedName of the property (ex: "fish\.type") that is marked as polymorphic discriminator
- // and the serializedName of the metadata polymorphicDiscriminator (ex: "fish.type"). However,
- // the clientName transformation of the polymorphicDiscriminator (ex: "fishtype") and
- // the transformation of model property name (ex: "fishtype") is done consistently.
- // Hence, it is a safer bet to rely on the clientName of the polymorphicDiscriminator.
- if (polymorphicDiscriminator &&
- key === polymorphicDiscriminator.clientName &&
- propertyInstance == undefined) {
- propertyInstance = mapper.serializedName;
- }
- let serializedValue;
- // paging
- if (Array.isArray(responseBody[key]) && modelProps[key].serializedName === "") {
- propertyInstance = responseBody[key];
- const arrayInstance = serializer.deserialize(propertyMapper, propertyInstance, propertyObjectName, options);
- // Copy over any properties that have already been added into the instance, where they do
- // not exist on the newly de-serialized array
- for (const [k, v] of Object.entries(instance)) {
- if (!Object.prototype.hasOwnProperty.call(arrayInstance, k)) {
- arrayInstance[k] = v;
- }
- }
- instance = arrayInstance;
+ // If attempt was against the secondary & it returned a StatusNotFound (404), then
+ // the resource was not found. This may be due to replication delay. So, in this
+ // case, we'll never try the secondary again for this operation.
+ if (response || err) {
+ const statusCode = response ? response.status : err ? err.statusCode : 0;
+ if (!isPrimaryRetry && statusCode === 404) {
+ logger.info(`RetryPolicy: Secondary access with 404, will retry.`);
+ return true;
}
- else if (propertyInstance !== undefined || propertyMapper.defaultValue !== undefined) {
- serializedValue = serializer.deserialize(propertyMapper, propertyInstance, propertyObjectName, options);
- instance[key] = serializedValue;
+ // Server internal error or server timeout
+ if (statusCode === 503 || statusCode === 500) {
+ logger.info(`RetryPolicy: Will retry for status code ${statusCode}.`);
+ return true;
}
}
- }
- const additionalPropertiesMapper = mapper.type.additionalProperties;
- if (additionalPropertiesMapper) {
- const isAdditionalProperty = (responsePropName) => {
- for (const clientPropName in modelProps) {
- const paths = splitSerializeName(modelProps[clientPropName].serializedName);
- if (paths[0] === responsePropName) {
- return false;
- }
- }
+ // [Copy source error code] Feature is pending on service side, skip retry on copy source error for now.
+ // if (response) {
+ // // Retry select Copy Source Error Codes.
+ // if (response?.status >= 400) {
+ // const copySourceError = response.headers.get(HeaderConstants.X_MS_CopySourceErrorCode);
+ // if (copySourceError !== undefined) {
+ // switch (copySourceError) {
+ // case "InternalError":
+ // case "OperationTimedOut":
+ // case "ServerBusy":
+ // return true;
+ // }
+ // }
+ // }
+ // }
+ if ((err === null || err === void 0 ? void 0 : err.code) === "PARSE_ERROR" && (err === null || err === void 0 ? void 0 : err.message.startsWith(`Error "Error: Unclosed root tag`))) {
+ logger.info("RetryPolicy: Incomplete XML response likely due to service timeout, will retry.");
return true;
- };
- for (const responsePropName in responseBody) {
- if (isAdditionalProperty(responsePropName)) {
- instance[responsePropName] = serializer.deserialize(additionalPropertiesMapper, responseBody[responsePropName], objectName + '["' + responsePropName + '"]', options);
- }
}
+ return false;
}
- else if (responseBody) {
- for (const key of Object.keys(responseBody)) {
- if (instance[key] === undefined &&
- !handledPropertyNames.includes(key) &&
- !isSpecialXmlProperty(key, options)) {
- instance[key] = responseBody[key];
+ /**
+ * Delay a calculated time between retries.
+ *
+ * @param isPrimaryRetry -
+ * @param attempt -
+ * @param abortSignal -
+ */
+ async delay(isPrimaryRetry, attempt, abortSignal) {
+ let delayTimeInMs = 0;
+ if (isPrimaryRetry) {
+ switch (this.retryOptions.retryPolicyType) {
+ case exports.StorageRetryPolicyType.EXPONENTIAL:
+ delayTimeInMs = Math.min((Math.pow(2, attempt - 1) - 1) * this.retryOptions.retryDelayInMs, this.retryOptions.maxRetryDelayInMs);
+ break;
+ case exports.StorageRetryPolicyType.FIXED:
+ delayTimeInMs = this.retryOptions.retryDelayInMs;
+ break;
}
}
- }
- return instance;
-}
-function deserializeDictionaryType(serializer, mapper, responseBody, objectName, options) {
- const value = mapper.type.value;
- if (!value || typeof value !== "object") {
- throw new Error(`"value" metadata for a Dictionary must be defined in the ` +
- `mapper and it must of type "object" in ${objectName}`);
- }
- if (responseBody) {
- const tempDictionary = {};
- for (const key of Object.keys(responseBody)) {
- tempDictionary[key] = serializer.deserialize(value, responseBody[key], objectName, options);
- }
- return tempDictionary;
- }
- return responseBody;
-}
-function deserializeSequenceType(serializer, mapper, responseBody, objectName, options) {
- const element = mapper.type.element;
- if (!element || typeof element !== "object") {
- throw new Error(`element" metadata for an Array must be defined in the ` +
- `mapper and it must of type "object" in ${objectName}`);
- }
- if (responseBody) {
- if (!Array.isArray(responseBody)) {
- // xml2js will interpret a single element array as just the element, so force it to be an array
- responseBody = [responseBody];
- }
- const tempArray = [];
- for (let i = 0; i < responseBody.length; i++) {
- tempArray[i] = serializer.deserialize(element, responseBody[i], `${objectName}[${i}]`, options);
- }
- return tempArray;
- }
- return responseBody;
-}
-function getPolymorphicMapper(serializer, mapper, object, polymorphicPropertyName) {
- const polymorphicDiscriminator = getPolymorphicDiscriminatorRecursively(serializer, mapper);
- if (polymorphicDiscriminator) {
- const discriminatorName = polymorphicDiscriminator[polymorphicPropertyName];
- if (discriminatorName != undefined) {
- const discriminatorValue = object[discriminatorName];
- if (discriminatorValue != undefined) {
- const typeName = mapper.type.uberParent || mapper.type.className;
- const indexDiscriminator = discriminatorValue === typeName
- ? discriminatorValue
- : typeName + "." + discriminatorValue;
- const polymorphicMapper = serializer.modelMappers.discriminators[indexDiscriminator];
- if (polymorphicMapper) {
- mapper = polymorphicMapper;
- }
- }
+ else {
+ delayTimeInMs = Math.random() * 1000;
}
+ logger.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);
+ return delay(delayTimeInMs, abortSignal, RETRY_ABORT_ERROR$1);
}
- return mapper;
-}
-function getPolymorphicDiscriminatorRecursively(serializer, mapper) {
- return (mapper.type.polymorphicDiscriminator ||
- getPolymorphicDiscriminatorSafely(serializer, mapper.type.uberParent) ||
- getPolymorphicDiscriminatorSafely(serializer, mapper.type.className));
-}
-function getPolymorphicDiscriminatorSafely(serializer, typeName) {
- return (typeName &&
- serializer.modelMappers[typeName] &&
- serializer.modelMappers[typeName].type.polymorphicDiscriminator);
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * Utility function that serializes an object that might contain binary information into a plain object, array or a string.
+ * StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects.
*/
-function serializeObject(toSerialize) {
- const castToSerialize = toSerialize;
- if (toSerialize == undefined)
- return undefined;
- if (toSerialize instanceof Uint8Array) {
- toSerialize = encodeByteArray(toSerialize);
- return toSerialize;
- }
- else if (toSerialize instanceof Date) {
- return toSerialize.toISOString();
- }
- else if (Array.isArray(toSerialize)) {
- const array = [];
- for (let i = 0; i < toSerialize.length; i++) {
- array.push(serializeObject(toSerialize[i]));
- }
- return array;
+class StorageRetryPolicyFactory {
+ /**
+ * Creates an instance of StorageRetryPolicyFactory.
+ * @param retryOptions -
+ */
+ constructor(retryOptions) {
+ this.retryOptions = retryOptions;
}
- else if (typeof toSerialize === "object") {
- const dictionary = {};
- for (const property in toSerialize) {
- dictionary[property] = serializeObject(castToSerialize[property]);
- }
- return dictionary;
+ /**
+ * Creates a StorageRetryPolicy object.
+ *
+ * @param nextPolicy -
+ * @param options -
+ */
+ create(nextPolicy, options) {
+ return new StorageRetryPolicy(nextPolicy, options, this.retryOptions);
}
- return toSerialize;
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * Utility function to create a K:V from a list of strings
+ * Credential policy used to sign HTTP(S) requests before sending. This is an
+ * abstract class.
*/
-function strEnum(o) {
- const result = {};
- for (const key of o) {
- result[key] = key;
+class CredentialPolicy extends BaseRequestPolicy {
+ /**
+ * Sends out request.
+ *
+ * @param request -
+ */
+ sendRequest(request) {
+ return this._nextPolicy.sendRequest(this.signRequest(request));
+ }
+ /**
+ * Child classes must implement this method with request signing. This method
+ * will be executed in {@link sendRequest}.
+ *
+ * @param request -
+ */
+ signRequest(request) {
+ // Child classes must override this method with request signing. This method
+ // will be executed in sendRequest().
+ return request;
}
- return result;
}
-/**
- * String enum containing the string types of property mappers.
- */
-// eslint-disable-next-line @typescript-eslint/no-redeclare
-const MapperType = strEnum([
- "Base64Url",
- "Boolean",
- "ByteArray",
- "Composite",
- "Date",
- "DateTime",
- "DateTimeRfc1123",
- "Dictionary",
- "Enum",
- "Number",
- "Object",
- "Sequence",
- "String",
- "Stream",
- "TimeSpan",
- "UnixTime",
-]);
// Copyright (c) Microsoft Corporation.
-function isWebResourceLike(object) {
- if (object && typeof object === "object") {
- const castObject = object;
- if (typeof castObject.url === "string" &&
- typeof castObject.method === "string" &&
- typeof castObject.headers === "object" &&
- isHttpHeadersLike(castObject.headers) &&
- typeof castObject.validateRequestProperties === "function" &&
- typeof castObject.prepare === "function" &&
- typeof castObject.clone === "function") {
- return true;
+// Licensed under the MIT license.
+/*
+ * We need to imitate .Net culture-aware sorting, which is used in storage service.
+ * Below tables contain sort-keys for en-US culture.
+ */
+const table_lv0 = new Uint32Array([
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x71c, 0x0, 0x71f, 0x721,
+ 0x723, 0x725, 0x0, 0x0, 0x0, 0x72d, 0x803, 0x0, 0x0, 0x733, 0x0, 0xd03, 0xd1a, 0xd1c, 0xd1e,
+ 0xd20, 0xd22, 0xd24, 0xd26, 0xd28, 0xd2a, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0xe02, 0xe09, 0xe0a,
+ 0xe1a, 0xe21, 0xe23, 0xe25, 0xe2c, 0xe32, 0xe35, 0xe36, 0xe48, 0xe51, 0xe70, 0xe7c, 0xe7e, 0xe89,
+ 0xe8a, 0xe91, 0xe99, 0xe9f, 0xea2, 0xea4, 0xea6, 0xea7, 0xea9, 0x0, 0x0, 0x0, 0x743, 0x744, 0x748,
+ 0xe02, 0xe09, 0xe0a, 0xe1a, 0xe21, 0xe23, 0xe25, 0xe2c, 0xe32, 0xe35, 0xe36, 0xe48, 0xe51, 0xe70,
+ 0xe7c, 0xe7e, 0xe89, 0xe8a, 0xe91, 0xe99, 0xe9f, 0xea2, 0xea4, 0xea6, 0xea7, 0xea9, 0x0, 0x74c,
+ 0x0, 0x750, 0x0,
+]);
+const table_lv2 = new Uint32Array([
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12,
+ 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12, 0x12,
+ 0x12, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+]);
+const table_lv4 = new Uint32Array([
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x8012, 0x0, 0x0, 0x0, 0x0, 0x0, 0x8212, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+ 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
+]);
+function compareHeader(lhs, rhs) {
+ if (isLessThan(lhs, rhs))
+ return -1;
+ return 1;
+}
+function isLessThan(lhs, rhs) {
+ const tables = [table_lv0, table_lv2, table_lv4];
+ let curr_level = 0;
+ let i = 0;
+ let j = 0;
+ while (curr_level < tables.length) {
+ if (curr_level === tables.length - 1 && i !== j) {
+ return i > j;
+ }
+ const weight1 = i < lhs.length ? tables[curr_level][lhs[i].charCodeAt(0)] : 0x1;
+ const weight2 = j < rhs.length ? tables[curr_level][rhs[j].charCodeAt(0)] : 0x1;
+ if (weight1 === 0x1 && weight2 === 0x1) {
+ i = 0;
+ j = 0;
+ ++curr_level;
+ }
+ else if (weight1 === weight2) {
+ ++i;
+ ++j;
+ }
+ else if (weight1 === 0) {
+ ++i;
+ }
+ else if (weight2 === 0) {
+ ++j;
+ }
+ else {
+ return weight1 < weight2;
}
}
return false;
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * Creates a new WebResource object.
- *
- * This class provides an abstraction over a REST call by being library / implementation agnostic and wrapping the necessary
- * properties to initiate a request.
- */
-class WebResource {
- constructor(url, method, body, query, headers, streamResponseBody, withCredentials, abortSignal, timeout, onUploadProgress, onDownloadProgress, proxySettings, keepAlive, decompressResponse, streamResponseStatusCodes) {
- this.streamResponseBody = streamResponseBody;
- this.streamResponseStatusCodes = streamResponseStatusCodes;
- this.url = url || "";
- this.method = method || "GET";
- this.headers = isHttpHeadersLike(headers) ? headers : new HttpHeaders(headers);
- this.body = body;
- this.query = query;
- this.formData = undefined;
- this.withCredentials = withCredentials || false;
- this.abortSignal = abortSignal;
- this.timeout = timeout || 0;
- this.onUploadProgress = onUploadProgress;
- this.onDownloadProgress = onDownloadProgress;
- this.proxySettings = proxySettings;
- this.keepAlive = keepAlive;
- this.decompressResponse = decompressResponse;
- this.requestId = this.headers.get("x-ms-client-request-id") || generateUuid();
- }
- /**
- * Validates that the required properties such as method, url, headers["Content-Type"],
- * headers["accept-language"] are defined. It will throw an error if one of the above
- * mentioned properties are not defined.
- */
- validateRequestProperties() {
- if (!this.method) {
- throw new Error("WebResource.method is required.");
- }
- if (!this.url) {
- throw new Error("WebResource.url is required.");
- }
- }
- /**
- * Prepares the request.
- * @param options - Options to provide for preparing the request.
- * @returns Returns the prepared WebResource (HTTP Request) object that needs to be given to the request pipeline.
- */
- prepare(options) {
- if (!options) {
- throw new Error("options object is required");
- }
- if (options.method === undefined ||
- options.method === null ||
- typeof options.method.valueOf() !== "string") {
- throw new Error("options.method must be a string.");
- }
- if (options.url && options.pathTemplate) {
- throw new Error("options.url and options.pathTemplate are mutually exclusive. Please provide exactly one of them.");
- }
- if ((options.pathTemplate === undefined ||
- options.pathTemplate === null ||
- typeof options.pathTemplate.valueOf() !== "string") &&
- (options.url === undefined ||
- options.url === null ||
- typeof options.url.valueOf() !== "string")) {
- throw new Error("Please provide exactly one of options.pathTemplate or options.url.");
- }
- // set the url if it is provided.
- if (options.url) {
- if (typeof options.url !== "string") {
- throw new Error('options.url must be of type "string".');
- }
- this.url = options.url;
- }
- // set the method
- if (options.method) {
- const validMethods = ["GET", "PUT", "HEAD", "DELETE", "OPTIONS", "POST", "PATCH", "TRACE"];
- if (validMethods.indexOf(options.method.toUpperCase()) === -1) {
- throw new Error('The provided method "' +
- options.method +
- '" is invalid. Supported HTTP methods are: ' +
- JSON.stringify(validMethods));
- }
- }
- this.method = options.method.toUpperCase();
- // construct the url if path template is provided
- if (options.pathTemplate) {
- const { pathTemplate, pathParameters } = options;
- if (typeof pathTemplate !== "string") {
- throw new Error('options.pathTemplate must be of type "string".');
- }
- if (!options.baseUrl) {
- options.baseUrl = "https://management.azure.com";
- }
- const baseUrl = options.baseUrl;
- let url = baseUrl +
- (baseUrl.endsWith("/") ? "" : "/") +
- (pathTemplate.startsWith("/") ? pathTemplate.slice(1) : pathTemplate);
- const segments = url.match(/({[\w-]*\s*[\w-]*})/gi);
- if (segments && segments.length) {
- if (!pathParameters) {
- throw new Error(`pathTemplate: ${pathTemplate} has been provided. Hence, options.pathParameters must also be provided.`);
- }
- segments.forEach(function (item) {
- const pathParamName = item.slice(1, -1);
- const pathParam = pathParameters[pathParamName];
- if (pathParam === null ||
- pathParam === undefined ||
- !(typeof pathParam === "string" || typeof pathParam === "object")) {
- const stringifiedPathParameters = JSON.stringify(pathParameters, undefined, 2);
- throw new Error(`pathTemplate: ${pathTemplate} contains the path parameter ${pathParamName}` +
- ` however, it is not present in parameters: ${stringifiedPathParameters}.` +
- `The value of the path parameter can either be a "string" of the form { ${pathParamName}: "some sample value" } or ` +
- `it can be an "object" of the form { "${pathParamName}": { value: "some sample value", skipUrlEncoding: true } }.`);
- }
- if (typeof pathParam.valueOf() === "string") {
- url = url.replace(item, encodeURIComponent(pathParam));
- }
- if (typeof pathParam.valueOf() === "object") {
- if (!pathParam.value) {
- throw new Error(`options.pathParameters[${pathParamName}] is of type "object" but it does not contain a "value" property.`);
- }
- if (pathParam.skipUrlEncoding) {
- url = url.replace(item, pathParam.value);
- }
- else {
- url = url.replace(item, encodeURIComponent(pathParam.value));
- }
- }
- });
- }
- this.url = url;
- }
- // append query parameters to the url if they are provided. They can be provided with pathTemplate or url option.
- if (options.queryParameters) {
- const queryParameters = options.queryParameters;
- if (typeof queryParameters !== "object") {
- throw new Error(`options.queryParameters must be of type object. It should be a JSON object ` +
- `of "query-parameter-name" as the key and the "query-parameter-value" as the value. ` +
- `The "query-parameter-value" may be fo type "string" or an "object" of the form { value: "query-parameter-value", skipUrlEncoding: true }.`);
- }
- // append question mark if it is not present in the url
- if (this.url && this.url.indexOf("?") === -1) {
- this.url += "?";
- }
- // construct queryString
- const queryParams = [];
- // We need to populate this.query as a dictionary if the request is being used for Sway's validateRequest().
- this.query = {};
- for (const queryParamName in queryParameters) {
- const queryParam = queryParameters[queryParamName];
- if (queryParam) {
- if (typeof queryParam === "string") {
- queryParams.push(queryParamName + "=" + encodeURIComponent(queryParam));
- this.query[queryParamName] = encodeURIComponent(queryParam);
- }
- else if (typeof queryParam === "object") {
- if (!queryParam.value) {
- throw new Error(`options.queryParameters[${queryParamName}] is of type "object" but it does not contain a "value" property.`);
- }
- if (queryParam.skipUrlEncoding) {
- queryParams.push(queryParamName + "=" + queryParam.value);
- this.query[queryParamName] = queryParam.value;
- }
- else {
- queryParams.push(queryParamName + "=" + encodeURIComponent(queryParam.value));
- this.query[queryParamName] = encodeURIComponent(queryParam.value);
- }
- }
- }
- } // end-of-for
- // append the queryString
- this.url += queryParams.join("&");
- }
- // add headers to the request if they are provided
- if (options.headers) {
- const headers = options.headers;
- for (const headerName of Object.keys(options.headers)) {
- this.headers.set(headerName, headers[headerName]);
- }
- }
- // ensure accept-language is set correctly
- if (!this.headers.get("accept-language")) {
- this.headers.set("accept-language", "en-US");
- }
- // ensure the request-id is set correctly
- if (!this.headers.get("x-ms-client-request-id") && !options.disableClientRequestId) {
- this.headers.set("x-ms-client-request-id", this.requestId);
- }
- // default
- if (!this.headers.get("Content-Type")) {
- this.headers.set("Content-Type", "application/json; charset=utf-8");
- }
- // set the request body. request.js automatically sets the Content-Length request header, so we need not set it explicitly
- this.body = options.body;
- if (options.body !== undefined && options.body !== null) {
- // body as a stream special case. set the body as-is and check for some special request headers specific to sending a stream.
- if (options.bodyIsStream) {
- if (!this.headers.get("Transfer-Encoding")) {
- this.headers.set("Transfer-Encoding", "chunked");
- }
- if (this.headers.get("Content-Type") !== "application/octet-stream") {
- this.headers.set("Content-Type", "application/octet-stream");
- }
- }
- else {
- if (options.serializationMapper) {
- this.body = new Serializer(options.mappers).serialize(options.serializationMapper, options.body, "requestBody");
- }
- if (!options.disableJsonStringifyOnBody) {
- this.body = JSON.stringify(options.body);
- }
- }
- }
- if (options.spanOptions) {
- this.spanOptions = options.spanOptions;
- }
- if (options.tracingContext) {
- this.tracingContext = options.tracingContext;
- }
- this.abortSignal = options.abortSignal;
- this.onDownloadProgress = options.onDownloadProgress;
- this.onUploadProgress = options.onUploadProgress;
- return this;
- }
- /**
- * Clone this WebResource HTTP request object.
- * @returns The clone of this WebResource HTTP request object.
- */
- clone() {
- const result = new WebResource(this.url, this.method, this.body, this.query, this.headers && this.headers.clone(), this.streamResponseBody, this.withCredentials, this.abortSignal, this.timeout, this.onUploadProgress, this.onDownloadProgress, this.proxySettings, this.keepAlive, this.decompressResponse, this.streamResponseStatusCodes);
- if (this.formData) {
- result.formData = this.formData;
- }
- if (this.operationSpec) {
- result.operationSpec = this.operationSpec;
- }
- if (this.shouldDeserialize) {
- result.shouldDeserialize = this.shouldDeserialize;
- }
- if (this.operationResponseGetter) {
- result.operationResponseGetter = this.operationResponseGetter;
- }
- return result;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * A class that handles the query portion of a URLBuilder.
+ * StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.
*/
-class URLQuery {
- constructor() {
- this._rawQuery = {};
- }
+class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
/**
- * Get whether or not there any query parameters in this URLQuery.
+ * Creates an instance of StorageSharedKeyCredentialPolicy.
+ * @param nextPolicy -
+ * @param options -
+ * @param factory -
*/
- any() {
- return Object.keys(this._rawQuery).length > 0;
+ constructor(nextPolicy, options, factory) {
+ super(nextPolicy, options);
+ this.factory = factory;
}
/**
- * Get the keys of the query string.
+ * Signs request.
+ *
+ * @param request -
*/
- keys() {
- return Object.keys(this._rawQuery);
+ signRequest(request) {
+ request.headers.set(HeaderConstants.X_MS_DATE, new Date().toUTCString());
+ if (request.body &&
+ (typeof request.body === "string" || request.body !== undefined) &&
+ request.body.length > 0) {
+ request.headers.set(HeaderConstants.CONTENT_LENGTH, Buffer.byteLength(request.body));
+ }
+ const stringToSign = [
+ request.method.toUpperCase(),
+ this.getHeaderValueToSign(request, HeaderConstants.CONTENT_LANGUAGE),
+ this.getHeaderValueToSign(request, HeaderConstants.CONTENT_ENCODING),
+ this.getHeaderValueToSign(request, HeaderConstants.CONTENT_LENGTH),
+ this.getHeaderValueToSign(request, HeaderConstants.CONTENT_MD5),
+ this.getHeaderValueToSign(request, HeaderConstants.CONTENT_TYPE),
+ this.getHeaderValueToSign(request, HeaderConstants.DATE),
+ this.getHeaderValueToSign(request, HeaderConstants.IF_MODIFIED_SINCE),
+ this.getHeaderValueToSign(request, HeaderConstants.IF_MATCH),
+ this.getHeaderValueToSign(request, HeaderConstants.IF_NONE_MATCH),
+ this.getHeaderValueToSign(request, HeaderConstants.IF_UNMODIFIED_SINCE),
+ this.getHeaderValueToSign(request, HeaderConstants.RANGE),
+ ].join("\n") +
+ "\n" +
+ this.getCanonicalizedHeadersString(request) +
+ this.getCanonicalizedResourceString(request);
+ const signature = this.factory.computeHMACSHA256(stringToSign);
+ request.headers.set(HeaderConstants.AUTHORIZATION, `SharedKey ${this.factory.accountName}:${signature}`);
+ // console.log(`[URL]:${request.url}`);
+ // console.log(`[HEADERS]:${request.headers.toString()}`);
+ // console.log(`[STRING TO SIGN]:${JSON.stringify(stringToSign)}`);
+ // console.log(`[KEY]: ${request.headers.get(HeaderConstants.AUTHORIZATION)}`);
+ return request;
}
/**
- * Set a query parameter with the provided name and value. If the parameterValue is undefined or
- * empty, then this will attempt to remove an existing query parameter with the provided
- * parameterName.
+ * Retrieve header value according to shared key sign rules.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
+ *
+ * @param request -
+ * @param headerName -
*/
- set(parameterName, parameterValue) {
- const caseParameterValue = parameterValue;
- if (parameterName) {
- if (caseParameterValue !== undefined && caseParameterValue !== null) {
- const newValue = Array.isArray(caseParameterValue)
- ? caseParameterValue
- : caseParameterValue.toString();
- this._rawQuery[parameterName] = newValue;
- }
- else {
- delete this._rawQuery[parameterName];
- }
+ getHeaderValueToSign(request, headerName) {
+ const value = request.headers.get(headerName);
+ if (!value) {
+ return "";
+ }
+ // When using version 2015-02-21 or later, if Content-Length is zero, then
+ // set the Content-Length part of the StringToSign to an empty string.
+ // https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
+ if (headerName === HeaderConstants.CONTENT_LENGTH && value === "0") {
+ return "";
}
+ return value;
}
/**
- * Get the value of the query parameter with the provided name. If no parameter exists with the
- * provided parameter name, then undefined will be returned.
+ * To construct the CanonicalizedHeaders portion of the signature string, follow these steps:
+ * 1. Retrieve all headers for the resource that begin with x-ms-, including the x-ms-date header.
+ * 2. Convert each HTTP header name to lowercase.
+ * 3. Sort the headers lexicographically by header name, in ascending order.
+ * Each header may appear only once in the string.
+ * 4. Replace any linear whitespace in the header value with a single space.
+ * 5. Trim any whitespace around the colon in the header.
+ * 6. Finally, append a new-line character to each canonicalized header in the resulting list.
+ * Construct the CanonicalizedHeaders string by concatenating all headers in this list into a single string.
+ *
+ * @param request -
*/
- get(parameterName) {
- return parameterName ? this._rawQuery[parameterName] : undefined;
+ getCanonicalizedHeadersString(request) {
+ let headersArray = request.headers.headersArray().filter((value) => {
+ return value.name.toLowerCase().startsWith(HeaderConstants.PREFIX_FOR_STORAGE);
+ });
+ headersArray.sort((a, b) => {
+ return compareHeader(a.name.toLowerCase(), b.name.toLowerCase());
+ });
+ // Remove duplicate headers
+ headersArray = headersArray.filter((value, index, array) => {
+ if (index > 0 && value.name.toLowerCase() === array[index - 1].name.toLowerCase()) {
+ return false;
+ }
+ return true;
+ });
+ let canonicalizedHeadersStringToSign = "";
+ headersArray.forEach((header) => {
+ canonicalizedHeadersStringToSign += `${header.name
+ .toLowerCase()
+ .trimRight()}:${header.value.trimLeft()}\n`;
+ });
+ return canonicalizedHeadersStringToSign;
}
/**
- * Get the string representation of this query. The return value will not start with a "?".
+ * Retrieves the webResource canonicalized resource string.
+ *
+ * @param request -
*/
- toString() {
- let result = "";
- for (const parameterName in this._rawQuery) {
- if (result) {
- result += "&";
- }
- const parameterValue = this._rawQuery[parameterName];
- if (Array.isArray(parameterValue)) {
- const parameterStrings = [];
- for (const parameterValueElement of parameterValue) {
- parameterStrings.push(`${parameterName}=${parameterValueElement}`);
+ getCanonicalizedResourceString(request) {
+ const path = getURLPath(request.url) || "/";
+ let canonicalizedResourceString = "";
+ canonicalizedResourceString += `/${this.factory.accountName}${path}`;
+ const queries = getURLQueries(request.url);
+ const lowercaseQueries = {};
+ if (queries) {
+ const queryKeys = [];
+ for (const key in queries) {
+ if (Object.prototype.hasOwnProperty.call(queries, key)) {
+ const lowercaseKey = key.toLowerCase();
+ lowercaseQueries[lowercaseKey] = queries[key];
+ queryKeys.push(lowercaseKey);
}
- result += parameterStrings.join("&");
}
- else {
- result += `${parameterName}=${parameterValue}`;
+ queryKeys.sort();
+ for (const key of queryKeys) {
+ canonicalizedResourceString += `\n${key}:${decodeURIComponent(lowercaseQueries[key])}`;
}
}
- return result;
+ return canonicalizedResourceString;
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Credential is an abstract class for Azure Storage HTTP requests signing. This
+ * class will host an credentialPolicyCreator factory which generates CredentialPolicy.
+ */
+class Credential {
/**
- * Parse a URLQuery from the provided text.
- */
- static parse(text) {
- const result = new URLQuery();
- if (text) {
- if (text.startsWith("?")) {
- text = text.substring(1);
- }
- let currentState = "ParameterName";
- let parameterName = "";
- let parameterValue = "";
- for (let i = 0; i < text.length; ++i) {
- const currentCharacter = text[i];
- switch (currentState) {
- case "ParameterName":
- switch (currentCharacter) {
- case "=":
- currentState = "ParameterValue";
- break;
- case "&":
- parameterName = "";
- parameterValue = "";
- break;
- default:
- parameterName += currentCharacter;
- break;
- }
- break;
- case "ParameterValue":
- switch (currentCharacter) {
- case "&":
- result.set(parameterName, parameterValue);
- parameterName = "";
- parameterValue = "";
- currentState = "ParameterName";
- break;
- default:
- parameterValue += currentCharacter;
- break;
- }
- break;
- default:
- throw new Error("Unrecognized URLQuery parse state: " + currentState);
- }
- }
- if (currentState === "ParameterValue") {
- result.set(parameterName, parameterValue);
- }
- }
- return result;
+ * Creates a RequestPolicy object.
+ *
+ * @param _nextPolicy -
+ * @param _options -
+ */
+ create(_nextPolicy, _options) {
+ throw new Error("Method should be implemented in children classes.");
}
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * A class that handles creating, modifying, and parsing URLs.
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * StorageSharedKeyCredential for account key authorization of Azure Storage service.
*/
-class URLBuilder {
+class StorageSharedKeyCredential extends Credential {
/**
- * Set the scheme/protocol for this URL. If the provided scheme contains other parts of a URL
- * (such as a host, port, path, or query), those parts will be added to this URL as well.
+ * Creates an instance of StorageSharedKeyCredential.
+ * @param accountName -
+ * @param accountKey -
*/
- setScheme(scheme) {
- if (!scheme) {
- this._scheme = undefined;
- }
- else {
- this.set(scheme, "SCHEME");
- }
+ constructor(accountName, accountKey) {
+ super();
+ this.accountName = accountName;
+ this.accountKey = Buffer.from(accountKey, "base64");
}
/**
- * Get the scheme that has been set in this URL.
+ * Creates a StorageSharedKeyCredentialPolicy object.
+ *
+ * @param nextPolicy -
+ * @param options -
*/
- getScheme() {
- return this._scheme;
+ create(nextPolicy, options) {
+ return new StorageSharedKeyCredentialPolicy(nextPolicy, options, this);
}
/**
- * Set the host for this URL. If the provided host contains other parts of a URL (such as a
- * port, path, or query), those parts will be added to this URL as well.
+ * Generates a hash signature for an HTTP request or for a SAS.
+ *
+ * @param stringToSign -
*/
- setHost(host) {
- if (!host) {
- this._host = undefined;
- }
- else {
- this.set(host, "SCHEME_OR_HOST");
- }
+ computeHMACSHA256(stringToSign) {
+ return crypto.createHmac("sha256", this.accountKey).update(stringToSign, "utf8").digest("base64");
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources
+ * or for use with Shared Access Signatures (SAS).
+ */
+class AnonymousCredentialPolicy extends CredentialPolicy {
/**
- * Get the host that has been set in this URL.
+ * Creates an instance of AnonymousCredentialPolicy.
+ * @param nextPolicy -
+ * @param options -
*/
- getHost() {
- return this._host;
+ // The base class has a protected constructor. Adding a public one to enable constructing of this class.
+ /* eslint-disable-next-line @typescript-eslint/no-useless-constructor*/
+ constructor(nextPolicy, options) {
+ super(nextPolicy, options);
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * AnonymousCredential provides a credentialPolicyCreator member used to create
+ * AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with
+ * HTTP(S) requests that read public resources or for use with Shared Access
+ * Signatures (SAS).
+ */
+class AnonymousCredential extends Credential {
/**
- * Set the port for this URL. If the provided port contains other parts of a URL (such as a
- * path or query), those parts will be added to this URL as well.
+ * Creates an {@link AnonymousCredentialPolicy} object.
+ *
+ * @param nextPolicy -
+ * @param options -
*/
- setPort(port) {
- if (port === undefined || port === null || port === "") {
- this._port = undefined;
- }
- else {
- this.set(port.toString(), "PORT");
- }
+ create(nextPolicy, options) {
+ return new AnonymousCredentialPolicy(nextPolicy, options);
+ }
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+let _defaultHttpClient;
+function getCachedDefaultHttpClient() {
+ if (!_defaultHttpClient) {
+ _defaultHttpClient = coreRestPipeline.createDefaultHttpClient();
}
+ return _defaultHttpClient;
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * The programmatic identifier of the StorageBrowserPolicy.
+ */
+const storageBrowserPolicyName = "storageBrowserPolicy";
+/**
+ * storageBrowserPolicy is a policy used to prevent browsers from caching requests
+ * and to remove cookies and explicit content-length headers.
+ */
+function storageBrowserPolicy() {
+ return {
+ name: storageBrowserPolicyName,
+ async sendRequest(request, next) {
+ if (coreUtil.isNode) {
+ return next(request);
+ }
+ if (request.method === "GET" || request.method === "HEAD") {
+ request.url = setURLParameter(request.url, URLConstants.Parameters.FORCE_BROWSER_NO_CACHE, new Date().getTime().toString());
+ }
+ request.headers.delete(HeaderConstants.COOKIE);
+ // According to XHR standards, content-length should be fully controlled by browsers
+ request.headers.delete(HeaderConstants.CONTENT_LENGTH);
+ return next(request);
+ },
+ };
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Name of the {@link storageRetryPolicy}
+ */
+const storageRetryPolicyName = "storageRetryPolicy";
+/**
+ * RetryPolicy types.
+ */
+var StorageRetryPolicyType;
+(function (StorageRetryPolicyType) {
/**
- * Get the port that has been set in this URL.
+ * Exponential retry. Retry time delay grows exponentially.
*/
- getPort() {
- return this._port;
- }
+ StorageRetryPolicyType[StorageRetryPolicyType["EXPONENTIAL"] = 0] = "EXPONENTIAL";
/**
- * Set the path for this URL. If the provided path contains a query, then it will be added to
- * this URL as well.
+ * Linear retry. Retry time delay grows linearly.
*/
- setPath(path) {
- if (!path) {
- this._path = undefined;
+ StorageRetryPolicyType[StorageRetryPolicyType["FIXED"] = 1] = "FIXED";
+})(StorageRetryPolicyType || (StorageRetryPolicyType = {}));
+// Default values of StorageRetryOptions
+const DEFAULT_RETRY_OPTIONS = {
+ maxRetryDelayInMs: 120 * 1000,
+ maxTries: 4,
+ retryDelayInMs: 4 * 1000,
+ retryPolicyType: StorageRetryPolicyType.EXPONENTIAL,
+ secondaryHost: "",
+ tryTimeoutInMs: undefined, // Use server side default timeout strategy
+};
+const retriableErrors = [
+ "ETIMEDOUT",
+ "ESOCKETTIMEDOUT",
+ "ECONNREFUSED",
+ "ECONNRESET",
+ "ENOENT",
+ "ENOTFOUND",
+ "TIMEOUT",
+ "EPIPE",
+ "REQUEST_SEND_ERROR",
+];
+const RETRY_ABORT_ERROR = new abortController.AbortError("The operation was aborted.");
+/**
+ * Retry policy with exponential retry and linear retry implemented.
+ */
+function storageRetryPolicy(options = {}) {
+ var _a, _b, _c, _d, _e, _f;
+ const retryPolicyType = (_a = options.retryPolicyType) !== null && _a !== void 0 ? _a : DEFAULT_RETRY_OPTIONS.retryPolicyType;
+ const maxTries = (_b = options.maxTries) !== null && _b !== void 0 ? _b : DEFAULT_RETRY_OPTIONS.maxTries;
+ const retryDelayInMs = (_c = options.retryDelayInMs) !== null && _c !== void 0 ? _c : DEFAULT_RETRY_OPTIONS.retryDelayInMs;
+ const maxRetryDelayInMs = (_d = options.maxRetryDelayInMs) !== null && _d !== void 0 ? _d : DEFAULT_RETRY_OPTIONS.maxRetryDelayInMs;
+ const secondaryHost = (_e = options.secondaryHost) !== null && _e !== void 0 ? _e : DEFAULT_RETRY_OPTIONS.secondaryHost;
+ const tryTimeoutInMs = (_f = options.tryTimeoutInMs) !== null && _f !== void 0 ? _f : DEFAULT_RETRY_OPTIONS.tryTimeoutInMs;
+ function shouldRetry({ isPrimaryRetry, attempt, response, error, }) {
+ var _a, _b;
+ if (attempt >= maxTries) {
+ logger.info(`RetryPolicy: Attempt(s) ${attempt} >= maxTries ${maxTries}, no further try.`);
+ return false;
}
- else {
- const schemeIndex = path.indexOf("://");
- if (schemeIndex !== -1) {
- const schemeStart = path.lastIndexOf("/", schemeIndex);
- // Make sure to only grab the URL part of the path before setting the state back to SCHEME
- // this will handle cases such as "/a/b/c/https://microsoft.com" => "https://microsoft.com"
- this.set(schemeStart === -1 ? path : path.substr(schemeStart + 1), "SCHEME");
+ if (error) {
+ for (const retriableError of retriableErrors) {
+ if (error.name.toUpperCase().includes(retriableError) ||
+ error.message.toUpperCase().includes(retriableError) ||
+ (error.code && error.code.toString().toUpperCase() === retriableError)) {
+ logger.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);
+ return true;
+ }
}
- else {
- this.set(path, "PATH");
+ if ((error === null || error === void 0 ? void 0 : error.code) === "PARSE_ERROR" &&
+ (error === null || error === void 0 ? void 0 : error.message.startsWith(`Error "Error: Unclosed root tag`))) {
+ logger.info("RetryPolicy: Incomplete XML response likely due to service timeout, will retry.");
+ return true;
}
}
- }
- /**
- * Append the provided path to this URL's existing path. If the provided path contains a query,
- * then it will be added to this URL as well.
- */
- appendPath(path) {
- if (path) {
- let currentPath = this.getPath();
- if (currentPath) {
- if (!currentPath.endsWith("/")) {
- currentPath += "/";
- }
- if (path.startsWith("/")) {
- path = path.substring(1);
- }
- path = currentPath + path;
+ // If attempt was against the secondary & it returned a StatusNotFound (404), then
+ // the resource was not found. This may be due to replication delay. So, in this
+ // case, we'll never try the secondary again for this operation.
+ if (response || error) {
+ const statusCode = (_b = (_a = response === null || response === void 0 ? void 0 : response.status) !== null && _a !== void 0 ? _a : error === null || error === void 0 ? void 0 : error.statusCode) !== null && _b !== void 0 ? _b : 0;
+ if (!isPrimaryRetry && statusCode === 404) {
+ logger.info(`RetryPolicy: Secondary access with 404, will retry.`);
+ return true;
+ }
+ // Server internal error or server timeout
+ if (statusCode === 503 || statusCode === 500) {
+ logger.info(`RetryPolicy: Will retry for status code ${statusCode}.`);
+ return true;
}
- this.set(path, "PATH");
}
+ // [Copy source error code] Feature is pending on service side, skip retry on copy source error for now.
+ // if (response) {
+ // // Retry select Copy Source Error Codes.
+ // if (response?.status >= 400) {
+ // const copySourceError = response.headers.get(HeaderConstants.X_MS_CopySourceErrorCode);
+ // if (copySourceError !== undefined) {
+ // switch (copySourceError) {
+ // case "InternalError":
+ // case "OperationTimedOut":
+ // case "ServerBusy":
+ // return true;
+ // }
+ // }
+ // }
+ // }
+ return false;
}
- /**
- * Get the path that has been set in this URL.
- */
- getPath() {
- return this._path;
- }
- /**
- * Set the query in this URL.
- */
- setQuery(query) {
- if (!query) {
- this._query = undefined;
+ function calculateDelay(isPrimaryRetry, attempt) {
+ let delayTimeInMs = 0;
+ if (isPrimaryRetry) {
+ switch (retryPolicyType) {
+ case StorageRetryPolicyType.EXPONENTIAL:
+ delayTimeInMs = Math.min((Math.pow(2, attempt - 1) - 1) * retryDelayInMs, maxRetryDelayInMs);
+ break;
+ case StorageRetryPolicyType.FIXED:
+ delayTimeInMs = retryDelayInMs;
+ break;
+ }
}
else {
- this._query = URLQuery.parse(query);
+ delayTimeInMs = Math.random() * 1000;
}
+ logger.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);
+ return delayTimeInMs;
}
- /**
- * Set a query parameter with the provided name and value in this URL's query. If the provided
- * query parameter value is undefined or empty, then the query parameter will be removed if it
- * existed.
- */
- setQueryParameter(queryParameterName, queryParameterValue) {
- if (queryParameterName) {
- if (!this._query) {
- this._query = new URLQuery();
+ return {
+ name: storageRetryPolicyName,
+ async sendRequest(request, next) {
+ // Set the server-side timeout query parameter "timeout=[seconds]"
+ if (tryTimeoutInMs) {
+ request.url = setURLParameter(request.url, URLConstants.Parameters.TIMEOUT, String(Math.floor(tryTimeoutInMs / 1000)));
+ }
+ const primaryUrl = request.url;
+ const secondaryUrl = secondaryHost ? setURLHost(request.url, secondaryHost) : undefined;
+ let secondaryHas404 = false;
+ let attempt = 1;
+ let retryAgain = true;
+ let response;
+ let error;
+ while (retryAgain) {
+ const isPrimaryRetry = secondaryHas404 ||
+ !secondaryUrl ||
+ !["GET", "HEAD", "OPTIONS"].includes(request.method) ||
+ attempt % 2 === 1;
+ request.url = isPrimaryRetry ? primaryUrl : secondaryUrl;
+ response = undefined;
+ error = undefined;
+ try {
+ logger.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? "Primary" : "Secondary"}`);
+ response = await next(request);
+ secondaryHas404 = secondaryHas404 || (!isPrimaryRetry && response.status === 404);
+ }
+ catch (e) {
+ if (coreRestPipeline.isRestError(e)) {
+ logger.error(`RetryPolicy: Caught error, message: ${e.message}, code: ${e.code}`);
+ error = e;
+ }
+ else {
+ logger.error(`RetryPolicy: Caught error, message: ${coreUtil.getErrorMessage(e)}`);
+ throw e;
+ }
+ }
+ retryAgain = shouldRetry({ isPrimaryRetry, attempt, response, error });
+ if (retryAgain) {
+ await delay(calculateDelay(isPrimaryRetry, attempt), request.abortSignal, RETRY_ABORT_ERROR);
+ }
+ attempt++;
+ }
+ if (response) {
+ return response;
}
- this._query.set(queryParameterName, queryParameterValue);
+ throw error !== null && error !== void 0 ? error : new coreRestPipeline.RestError("RetryPolicy failed without known error.");
+ },
+ };
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * The programmatic identifier of the storageSharedKeyCredentialPolicy.
+ */
+const storageSharedKeyCredentialPolicyName = "storageSharedKeyCredentialPolicy";
+/**
+ * storageSharedKeyCredentialPolicy handles signing requests using storage account keys.
+ */
+function storageSharedKeyCredentialPolicy(options) {
+ function signRequest(request) {
+ request.headers.set(HeaderConstants.X_MS_DATE, new Date().toUTCString());
+ if (request.body &&
+ (typeof request.body === "string" || Buffer.isBuffer(request.body)) &&
+ request.body.length > 0) {
+ request.headers.set(HeaderConstants.CONTENT_LENGTH, Buffer.byteLength(request.body));
}
+ const stringToSign = [
+ request.method.toUpperCase(),
+ getHeaderValueToSign(request, HeaderConstants.CONTENT_LANGUAGE),
+ getHeaderValueToSign(request, HeaderConstants.CONTENT_ENCODING),
+ getHeaderValueToSign(request, HeaderConstants.CONTENT_LENGTH),
+ getHeaderValueToSign(request, HeaderConstants.CONTENT_MD5),
+ getHeaderValueToSign(request, HeaderConstants.CONTENT_TYPE),
+ getHeaderValueToSign(request, HeaderConstants.DATE),
+ getHeaderValueToSign(request, HeaderConstants.IF_MODIFIED_SINCE),
+ getHeaderValueToSign(request, HeaderConstants.IF_MATCH),
+ getHeaderValueToSign(request, HeaderConstants.IF_NONE_MATCH),
+ getHeaderValueToSign(request, HeaderConstants.IF_UNMODIFIED_SINCE),
+ getHeaderValueToSign(request, HeaderConstants.RANGE),
+ ].join("\n") +
+ "\n" +
+ getCanonicalizedHeadersString(request) +
+ getCanonicalizedResourceString(request);
+ const signature = crypto.createHmac("sha256", options.accountKey)
+ .update(stringToSign, "utf8")
+ .digest("base64");
+ request.headers.set(HeaderConstants.AUTHORIZATION, `SharedKey ${options.accountName}:${signature}`);
+ // console.log(`[URL]:${request.url}`);
+ // console.log(`[HEADERS]:${request.headers.toString()}`);
+ // console.log(`[STRING TO SIGN]:${JSON.stringify(stringToSign)}`);
+ // console.log(`[KEY]: ${request.headers.get(HeaderConstants.AUTHORIZATION)}`);
}
/**
- * Get the value of the query parameter with the provided query parameter name. If no query
- * parameter exists with the provided name, then undefined will be returned.
+ * Retrieve header value according to shared key sign rules.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
*/
- getQueryParameterValue(queryParameterName) {
- return this._query ? this._query.get(queryParameterName) : undefined;
+ function getHeaderValueToSign(request, headerName) {
+ const value = request.headers.get(headerName);
+ if (!value) {
+ return "";
+ }
+ // When using version 2015-02-21 or later, if Content-Length is zero, then
+ // set the Content-Length part of the StringToSign to an empty string.
+ // https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
+ if (headerName === HeaderConstants.CONTENT_LENGTH && value === "0") {
+ return "";
+ }
+ return value;
}
/**
- * Get the query in this URL.
+ * To construct the CanonicalizedHeaders portion of the signature string, follow these steps:
+ * 1. Retrieve all headers for the resource that begin with x-ms-, including the x-ms-date header.
+ * 2. Convert each HTTP header name to lowercase.
+ * 3. Sort the headers lexicographically by header name, in ascending order.
+ * Each header may appear only once in the string.
+ * 4. Replace any linear whitespace in the header value with a single space.
+ * 5. Trim any whitespace around the colon in the header.
+ * 6. Finally, append a new-line character to each canonicalized header in the resulting list.
+ * Construct the CanonicalizedHeaders string by concatenating all headers in this list into a single string.
+ *
*/
- getQuery() {
- return this._query ? this._query.toString() : undefined;
+ function getCanonicalizedHeadersString(request) {
+ let headersArray = [];
+ for (const [name, value] of request.headers) {
+ if (name.toLowerCase().startsWith(HeaderConstants.PREFIX_FOR_STORAGE)) {
+ headersArray.push({ name, value });
+ }
+ }
+ headersArray.sort((a, b) => {
+ return compareHeader(a.name.toLowerCase(), b.name.toLowerCase());
+ });
+ // Remove duplicate headers
+ headersArray = headersArray.filter((value, index, array) => {
+ if (index > 0 && value.name.toLowerCase() === array[index - 1].name.toLowerCase()) {
+ return false;
+ }
+ return true;
+ });
+ let canonicalizedHeadersStringToSign = "";
+ headersArray.forEach((header) => {
+ canonicalizedHeadersStringToSign += `${header.name
+ .toLowerCase()
+ .trimRight()}:${header.value.trimLeft()}\n`;
+ });
+ return canonicalizedHeadersStringToSign;
}
- /**
- * Set the parts of this URL by parsing the provided text using the provided startState.
- */
- set(text, startState) {
- const tokenizer = new URLTokenizer(text, startState);
- while (tokenizer.next()) {
- const token = tokenizer.current();
- let tokenPath;
- if (token) {
- switch (token.type) {
- case "SCHEME":
- this._scheme = token.text || undefined;
- break;
- case "HOST":
- this._host = token.text || undefined;
- break;
- case "PORT":
- this._port = token.text || undefined;
- break;
- case "PATH":
- tokenPath = token.text || undefined;
- if (!this._path || this._path === "/" || tokenPath !== "/") {
- this._path = tokenPath;
- }
- break;
- case "QUERY":
- this._query = URLQuery.parse(token.text);
- break;
- default:
- throw new Error(`Unrecognized URLTokenType: ${token.type}`);
+ function getCanonicalizedResourceString(request) {
+ const path = getURLPath(request.url) || "/";
+ let canonicalizedResourceString = "";
+ canonicalizedResourceString += `/${options.accountName}${path}`;
+ const queries = getURLQueries(request.url);
+ const lowercaseQueries = {};
+ if (queries) {
+ const queryKeys = [];
+ for (const key in queries) {
+ if (Object.prototype.hasOwnProperty.call(queries, key)) {
+ const lowercaseKey = key.toLowerCase();
+ lowercaseQueries[lowercaseKey] = queries[key];
+ queryKeys.push(lowercaseKey);
}
}
+ queryKeys.sort();
+ for (const key of queryKeys) {
+ canonicalizedResourceString += `\n${key}:${decodeURIComponent(lowercaseQueries[key])}`;
+ }
}
+ return canonicalizedResourceString;
}
+ return {
+ name: storageSharedKeyCredentialPolicyName,
+ async sendRequest(request, next) {
+ signRequest(request);
+ return next(request);
+ },
+ };
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * StorageBrowserPolicy will handle differences between Node.js and browser runtime, including:
+ *
+ * 1. Browsers cache GET/HEAD requests by adding conditional headers such as 'IF_MODIFIED_SINCE'.
+ * StorageBrowserPolicy is a policy used to add a timestamp query to GET/HEAD request URL
+ * thus avoid the browser cache.
+ *
+ * 2. Remove cookie header for security
+ *
+ * 3. Remove content-length header to avoid browsers warning
+ */
+class StorageBrowserPolicy extends BaseRequestPolicy {
/**
- * Serializes the URL as a string.
- * @returns the URL as a string.
+ * Creates an instance of StorageBrowserPolicy.
+ * @param nextPolicy -
+ * @param options -
*/
- toString() {
- let result = "";
- if (this._scheme) {
- result += `${this._scheme}://`;
- }
- if (this._host) {
- result += this._host;
- }
- if (this._port) {
- result += `:${this._port}`;
- }
- if (this._path) {
- if (!this._path.startsWith("/")) {
- result += "/";
- }
- result += this._path;
- }
- if (this._query && this._query.any()) {
- result += `?${this._query.toString()}`;
- }
- return result;
+ // The base class has a protected constructor. Adding a public one to enable constructing of this class.
+ /* eslint-disable-next-line @typescript-eslint/no-useless-constructor*/
+ constructor(nextPolicy, options) {
+ super(nextPolicy, options);
}
/**
- * If the provided searchValue is found in this URLBuilder, then replace it with the provided
- * replaceValue.
+ * Sends out request.
+ *
+ * @param request -
*/
- replaceAll(searchValue, replaceValue) {
- if (searchValue) {
- this.setScheme(replaceAll(this.getScheme(), searchValue, replaceValue));
- this.setHost(replaceAll(this.getHost(), searchValue, replaceValue));
- this.setPort(replaceAll(this.getPort(), searchValue, replaceValue));
- this.setPath(replaceAll(this.getPath(), searchValue, replaceValue));
- this.setQuery(replaceAll(this.getQuery(), searchValue, replaceValue));
+ async sendRequest(request) {
+ if (coreUtil.isNode) {
+ return this._nextPolicy.sendRequest(request);
+ }
+ if (request.method.toUpperCase() === "GET" || request.method.toUpperCase() === "HEAD") {
+ request.url = setURLParameter(request.url, URLConstants.Parameters.FORCE_BROWSER_NO_CACHE, new Date().getTime().toString());
}
+ request.headers.remove(HeaderConstants.COOKIE);
+ // According to XHR standards, content-length should be fully controlled by browsers
+ request.headers.remove(HeaderConstants.CONTENT_LENGTH);
+ return this._nextPolicy.sendRequest(request);
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
+ */
+class StorageBrowserPolicyFactory {
/**
- * Parses a given string URL into a new {@link URLBuilder}.
+ * Creates a StorageBrowserPolicyFactory object.
+ *
+ * @param nextPolicy -
+ * @param options -
*/
- static parse(text) {
- const result = new URLBuilder();
- result.set(text, "SCHEME_OR_HOST");
- return result;
- }
-}
-class URLToken {
- constructor(text, type) {
- this.text = text;
- this.type = type;
- }
- static scheme(text) {
- return new URLToken(text, "SCHEME");
- }
- static host(text) {
- return new URLToken(text, "HOST");
- }
- static port(text) {
- return new URLToken(text, "PORT");
- }
- static path(text) {
- return new URLToken(text, "PATH");
- }
- static query(text) {
- return new URLToken(text, "QUERY");
+ create(nextPolicy, options) {
+ return new StorageBrowserPolicy(nextPolicy, options);
}
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * Get whether or not the provided character (single character string) is an alphanumeric (letter or
- * digit) character.
+ * The programmatic identifier of the storageCorrectContentLengthPolicy.
*/
-function isAlphaNumericCharacter(character) {
- const characterCode = character.charCodeAt(0);
- return ((48 /* '0' */ <= characterCode && characterCode <= 57) /* '9' */ ||
- (65 /* 'A' */ <= characterCode && characterCode <= 90) /* 'Z' */ ||
- (97 /* 'a' */ <= characterCode && characterCode <= 122) /* 'z' */);
-}
+const storageCorrectContentLengthPolicyName = "StorageCorrectContentLengthPolicy";
/**
- * A class that tokenizes URL strings.
+ * storageCorrectContentLengthPolicy to correctly set Content-Length header with request body length.
*/
-class URLTokenizer {
- constructor(_text, state) {
- this._text = _text;
- this._textLength = _text ? _text.length : 0;
- this._currentState = state !== undefined && state !== null ? state : "SCHEME_OR_HOST";
- this._currentIndex = 0;
- }
- /**
- * Get the current URLToken this URLTokenizer is pointing at, or undefined if the URLTokenizer
- * hasn't started or has finished tokenizing.
- */
- current() {
- return this._currentToken;
- }
- /**
- * Advance to the next URLToken and return whether or not a URLToken was found.
- */
- next() {
- if (!hasCurrentCharacter(this)) {
- this._currentToken = undefined;
- }
- else {
- switch (this._currentState) {
- case "SCHEME":
- nextScheme(this);
- break;
- case "SCHEME_OR_HOST":
- nextSchemeOrHost(this);
- break;
- case "HOST":
- nextHost(this);
- break;
- case "PORT":
- nextPort(this);
- break;
- case "PATH":
- nextPath(this);
- break;
- case "QUERY":
- nextQuery(this);
- break;
- default:
- throw new Error(`Unrecognized URLTokenizerState: ${this._currentState}`);
- }
+function storageCorrectContentLengthPolicy() {
+ function correctContentLength(request) {
+ if (request.body &&
+ (typeof request.body === "string" || Buffer.isBuffer(request.body)) &&
+ request.body.length > 0) {
+ request.headers.set(HeaderConstants.CONTENT_LENGTH, Buffer.byteLength(request.body));
}
- return !!this._currentToken;
}
+ return {
+ name: storageCorrectContentLengthPolicyName,
+ async sendRequest(request, next) {
+ correctContentLength(request);
+ return next(request);
+ },
+ };
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * Read the remaining characters from this Tokenizer's character stream.
+ * A helper to decide if a given argument satisfies the Pipeline contract
+ * @param pipeline - An argument that may be a Pipeline
+ * @returns true when the argument satisfies the Pipeline contract
*/
-function readRemaining(tokenizer) {
- let result = "";
- if (tokenizer._currentIndex < tokenizer._textLength) {
- result = tokenizer._text.substring(tokenizer._currentIndex);
- tokenizer._currentIndex = tokenizer._textLength;
+function isPipelineLike(pipeline) {
+ if (!pipeline || typeof pipeline !== "object") {
+ return false;
}
- return result;
-}
-/**
- * Whether or not this URLTokenizer has a current character.
- */
-function hasCurrentCharacter(tokenizer) {
- return tokenizer._currentIndex < tokenizer._textLength;
-}
-/**
- * Get the character in the text string at the current index.
- */
-function getCurrentCharacter(tokenizer) {
- return tokenizer._text[tokenizer._currentIndex];
+ const castPipeline = pipeline;
+ return (Array.isArray(castPipeline.factories) &&
+ typeof castPipeline.options === "object" &&
+ typeof castPipeline.toServiceClientOptions === "function");
}
/**
- * Advance to the character in text that is "step" characters ahead. If no step value is provided,
- * then step will default to 1.
+ * A Pipeline class containing HTTP request policies.
+ * You can create a default Pipeline by calling {@link newPipeline}.
+ * Or you can create a Pipeline with your own policies by the constructor of Pipeline.
+ *
+ * Refer to {@link newPipeline} and provided policies before implementing your
+ * customized Pipeline.
*/
-function nextCharacter(tokenizer, step) {
- if (hasCurrentCharacter(tokenizer)) {
- if (!step) {
- step = 1;
- }
- tokenizer._currentIndex += step;
+class Pipeline {
+ /**
+ * Creates an instance of Pipeline. Customize HTTPClient by implementing IHttpClient interface.
+ *
+ * @param factories -
+ * @param options -
+ */
+ constructor(factories, options = {}) {
+ this.factories = factories;
+ this.options = options;
}
-}
-/**
- * Starting with the current character, peek "charactersToPeek" number of characters ahead in this
- * Tokenizer's stream of characters.
- */
-function peekCharacters(tokenizer, charactersToPeek) {
- let endIndex = tokenizer._currentIndex + charactersToPeek;
- if (tokenizer._textLength < endIndex) {
- endIndex = tokenizer._textLength;
+ /**
+ * Transfer Pipeline object to ServiceClientOptions object which is required by
+ * ServiceClient constructor.
+ *
+ * @returns The ServiceClientOptions object from this Pipeline.
+ */
+ toServiceClientOptions() {
+ return {
+ httpClient: this.options.httpClient,
+ requestPolicyFactories: this.factories,
+ };
}
- return tokenizer._text.substring(tokenizer._currentIndex, endIndex);
}
/**
- * Read characters from this Tokenizer until the end of the stream or until the provided condition
- * is false when provided the current character.
+ * Creates a new Pipeline object with Credential provided.
+ *
+ * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+ * @param pipelineOptions - Optional. Options.
+ * @returns A new Pipeline object.
*/
-function readWhile(tokenizer, condition) {
- let result = "";
- while (hasCurrentCharacter(tokenizer)) {
- const currentCharacter = getCurrentCharacter(tokenizer);
- if (!condition(currentCharacter)) {
- break;
- }
- else {
- result += currentCharacter;
- nextCharacter(tokenizer);
+function newPipeline(credential, pipelineOptions = {}) {
+ if (!credential) {
+ credential = new AnonymousCredential();
+ }
+ const pipeline = new Pipeline([], pipelineOptions);
+ pipeline._credential = credential;
+ return pipeline;
+}
+function processDownlevelPipeline(pipeline) {
+ const knownFactoryFunctions = [
+ isAnonymousCredential,
+ isStorageSharedKeyCredential,
+ isCoreHttpBearerTokenFactory,
+ isStorageBrowserPolicyFactory,
+ isStorageRetryPolicyFactory,
+ isStorageTelemetryPolicyFactory,
+ isCoreHttpPolicyFactory,
+ ];
+ if (pipeline.factories.length) {
+ const novelFactories = pipeline.factories.filter((factory) => {
+ return !knownFactoryFunctions.some((knownFactory) => knownFactory(factory));
+ });
+ if (novelFactories.length) {
+ const hasInjector = novelFactories.some((factory) => isInjectorPolicyFactory(factory));
+ // if there are any left over, wrap in a requestPolicyFactoryPolicy
+ return {
+ wrappedPolicies: coreHttpCompat.createRequestPolicyFactoryPolicy(novelFactories),
+ afterRetry: hasInjector,
+ };
}
}
- return result;
-}
-/**
- * Read characters from this Tokenizer until a non-alphanumeric character or the end of the
- * character stream is reached.
- */
-function readWhileLetterOrDigit(tokenizer) {
- return readWhile(tokenizer, (character) => isAlphaNumericCharacter(character));
-}
-/**
- * Read characters from this Tokenizer until one of the provided terminating characters is read or
- * the end of the character stream is reached.
- */
-function readUntilCharacter(tokenizer, ...terminatingCharacters) {
- return readWhile(tokenizer, (character) => terminatingCharacters.indexOf(character) === -1);
+ return undefined;
}
-function nextScheme(tokenizer) {
- const scheme = readWhileLetterOrDigit(tokenizer);
- tokenizer._currentToken = URLToken.scheme(scheme);
- if (!hasCurrentCharacter(tokenizer)) {
- tokenizer._currentState = "DONE";
- }
- else {
- tokenizer._currentState = "HOST";
+function getCoreClientOptions(pipeline) {
+ var _a;
+ const _b = pipeline.options, { httpClient: v1Client } = _b, restOptions = tslib.__rest(_b, ["httpClient"]);
+ let httpClient = pipeline._coreHttpClient;
+ if (!httpClient) {
+ httpClient = v1Client ? coreHttpCompat.convertHttpClient(v1Client) : getCachedDefaultHttpClient();
+ pipeline._coreHttpClient = httpClient;
+ }
+ let corePipeline = pipeline._corePipeline;
+ if (!corePipeline) {
+ const packageDetails = `azsdk-js-azure-storage-blob/${SDK_VERSION}`;
+ const userAgentPrefix = restOptions.userAgentOptions && restOptions.userAgentOptions.userAgentPrefix
+ ? `${restOptions.userAgentOptions.userAgentPrefix} ${packageDetails}`
+ : `${packageDetails}`;
+ corePipeline = coreClient.createClientPipeline(Object.assign(Object.assign({}, restOptions), { loggingOptions: {
+ additionalAllowedHeaderNames: StorageBlobLoggingAllowedHeaderNames,
+ additionalAllowedQueryParameters: StorageBlobLoggingAllowedQueryParameters,
+ logger: logger.info,
+ }, userAgentOptions: {
+ userAgentPrefix,
+ }, serializationOptions: {
+ stringifyXML: coreXml.stringifyXML,
+ serializerOptions: {
+ xml: {
+ // Use customized XML char key of "#" so we can deserialize metadata
+ // with "_" key
+ xmlCharKey: "#",
+ },
+ },
+ }, deserializationOptions: {
+ parseXML: coreXml.parseXML,
+ serializerOptions: {
+ xml: {
+ // Use customized XML char key of "#" so we can deserialize metadata
+ // with "_" key
+ xmlCharKey: "#",
+ },
+ },
+ } }));
+ corePipeline.removePolicy({ phase: "Retry" });
+ corePipeline.removePolicy({ name: coreRestPipeline.decompressResponsePolicyName });
+ corePipeline.addPolicy(storageCorrectContentLengthPolicy());
+ corePipeline.addPolicy(storageRetryPolicy(restOptions.retryOptions), { phase: "Retry" });
+ corePipeline.addPolicy(storageBrowserPolicy());
+ const downlevelResults = processDownlevelPipeline(pipeline);
+ if (downlevelResults) {
+ corePipeline.addPolicy(downlevelResults.wrappedPolicies, downlevelResults.afterRetry ? { afterPhase: "Retry" } : undefined);
+ }
+ const credential = getCredentialFromPipeline(pipeline);
+ if (coreAuth.isTokenCredential(credential)) {
+ corePipeline.addPolicy(coreRestPipeline.bearerTokenAuthenticationPolicy({
+ credential,
+ scopes: (_a = restOptions.audience) !== null && _a !== void 0 ? _a : StorageOAuthScopes,
+ challengeCallbacks: { authorizeRequestOnChallenge: coreClient.authorizeRequestOnTenantChallenge },
+ }), { phase: "Sign" });
+ }
+ else if (credential instanceof StorageSharedKeyCredential) {
+ corePipeline.addPolicy(storageSharedKeyCredentialPolicy({
+ accountName: credential.accountName,
+ accountKey: credential.accountKey,
+ }), { phase: "Sign" });
+ }
+ pipeline._corePipeline = corePipeline;
+ }
+ return Object.assign(Object.assign({}, restOptions), { allowInsecureConnection: true, httpClient, pipeline: corePipeline });
+}
+function getCredentialFromPipeline(pipeline) {
+ // see if we squirreled one away on the type itself
+ if (pipeline._credential) {
+ return pipeline._credential;
+ }
+ // if it came from another package, loop over the factories and look for one like before
+ let credential = new AnonymousCredential();
+ for (const factory of pipeline.factories) {
+ if (coreAuth.isTokenCredential(factory.credential)) {
+ // Only works if the factory has been attached a "credential" property.
+ // We do that in newPipeline() when using TokenCredential.
+ credential = factory.credential;
+ }
+ else if (isStorageSharedKeyCredential(factory)) {
+ return factory;
+ }
+ }
+ return credential;
+}
+function isStorageSharedKeyCredential(factory) {
+ if (factory instanceof StorageSharedKeyCredential) {
+ return true;
}
+ return factory.constructor.name === "StorageSharedKeyCredential";
}
-function nextSchemeOrHost(tokenizer) {
- const schemeOrHost = readUntilCharacter(tokenizer, ":", "/", "?");
- if (!hasCurrentCharacter(tokenizer)) {
- tokenizer._currentToken = URLToken.host(schemeOrHost);
- tokenizer._currentState = "DONE";
- }
- else if (getCurrentCharacter(tokenizer) === ":") {
- if (peekCharacters(tokenizer, 3) === "://") {
- tokenizer._currentToken = URLToken.scheme(schemeOrHost);
- tokenizer._currentState = "HOST";
- }
- else {
- tokenizer._currentToken = URLToken.host(schemeOrHost);
- tokenizer._currentState = "PORT";
- }
- }
- else {
- tokenizer._currentToken = URLToken.host(schemeOrHost);
- if (getCurrentCharacter(tokenizer) === "/") {
- tokenizer._currentState = "PATH";
- }
- else {
- tokenizer._currentState = "QUERY";
- }
+function isAnonymousCredential(factory) {
+ if (factory instanceof AnonymousCredential) {
+ return true;
}
+ return factory.constructor.name === "AnonymousCredential";
}
-function nextHost(tokenizer) {
- if (peekCharacters(tokenizer, 3) === "://") {
- nextCharacter(tokenizer, 3);
- }
- const host = readUntilCharacter(tokenizer, ":", "/", "?");
- tokenizer._currentToken = URLToken.host(host);
- if (!hasCurrentCharacter(tokenizer)) {
- tokenizer._currentState = "DONE";
- }
- else if (getCurrentCharacter(tokenizer) === ":") {
- tokenizer._currentState = "PORT";
- }
- else if (getCurrentCharacter(tokenizer) === "/") {
- tokenizer._currentState = "PATH";
- }
- else {
- tokenizer._currentState = "QUERY";
- }
+function isCoreHttpBearerTokenFactory(factory) {
+ return coreAuth.isTokenCredential(factory.credential);
}
-function nextPort(tokenizer) {
- if (getCurrentCharacter(tokenizer) === ":") {
- nextCharacter(tokenizer);
- }
- const port = readUntilCharacter(tokenizer, "/", "?");
- tokenizer._currentToken = URLToken.port(port);
- if (!hasCurrentCharacter(tokenizer)) {
- tokenizer._currentState = "DONE";
- }
- else if (getCurrentCharacter(tokenizer) === "/") {
- tokenizer._currentState = "PATH";
- }
- else {
- tokenizer._currentState = "QUERY";
+function isStorageBrowserPolicyFactory(factory) {
+ if (factory instanceof StorageBrowserPolicyFactory) {
+ return true;
}
+ return factory.constructor.name === "StorageBrowserPolicyFactory";
}
-function nextPath(tokenizer) {
- const path = readUntilCharacter(tokenizer, "?");
- tokenizer._currentToken = URLToken.path(path);
- if (!hasCurrentCharacter(tokenizer)) {
- tokenizer._currentState = "DONE";
- }
- else {
- tokenizer._currentState = "QUERY";
+function isStorageRetryPolicyFactory(factory) {
+ if (factory instanceof StorageRetryPolicyFactory) {
+ return true;
}
+ return factory.constructor.name === "StorageRetryPolicyFactory";
}
-function nextQuery(tokenizer) {
- if (getCurrentCharacter(tokenizer) === "?") {
- nextCharacter(tokenizer);
- }
- const query = readRemaining(tokenizer);
- tokenizer._currentToken = URLToken.query(query);
- tokenizer._currentState = "DONE";
+function isStorageTelemetryPolicyFactory(factory) {
+ return factory.constructor.name === "TelemetryPolicyFactory";
}
-
-// Copyright (c) Microsoft Corporation.
-function createProxyAgent(requestUrl, proxySettings, headers) {
- const host = URLBuilder.parse(proxySettings.host).getHost();
- if (!host) {
- throw new Error("Expecting a non-empty host in proxy settings.");
- }
- if (!isValidPort(proxySettings.port)) {
- throw new Error("Expecting a valid port number in the range of [0, 65535] in proxy settings.");
- }
- const tunnelOptions = {
- proxy: {
- host: host,
- port: proxySettings.port,
- headers: (headers && headers.rawHeaders()) || {},
+function isInjectorPolicyFactory(factory) {
+ return factory.constructor.name === "InjectorPolicyFactory";
+}
+function isCoreHttpPolicyFactory(factory) {
+ const knownPolicies = [
+ "GenerateClientRequestIdPolicy",
+ "TracingPolicy",
+ "LogPolicy",
+ "ProxyPolicy",
+ "DisableResponseDecompressionPolicy",
+ "KeepAlivePolicy",
+ "DeserializationPolicy",
+ ];
+ const mockHttpClient = {
+ sendRequest: async (request) => {
+ return {
+ request,
+ headers: request.headers.clone(),
+ status: 500,
+ };
},
};
- if (proxySettings.username && proxySettings.password) {
- tunnelOptions.proxy.proxyAuth = `${proxySettings.username}:${proxySettings.password}`;
- }
- else if (proxySettings.username) {
- tunnelOptions.proxy.proxyAuth = `${proxySettings.username}`;
- }
- const isRequestHttps = isUrlHttps(requestUrl);
- const isProxyHttps = isUrlHttps(proxySettings.host);
- const proxyAgent = {
- isHttps: isRequestHttps,
- agent: createTunnel(isRequestHttps, isProxyHttps, tunnelOptions),
+ const mockRequestPolicyOptions = {
+ log(_logLevel, _message) {
+ /* do nothing */
+ },
+ shouldLog(_logLevel) {
+ return false;
+ },
};
- return proxyAgent;
-}
-function isUrlHttps(url) {
- const urlScheme = URLBuilder.parse(url).getScheme() || "";
- return urlScheme.toLowerCase() === "https";
-}
-function createTunnel(isRequestHttps, isProxyHttps, tunnelOptions) {
- if (isRequestHttps && isProxyHttps) {
- return tunnel__namespace.httpsOverHttps(tunnelOptions);
- }
- else if (isRequestHttps && !isProxyHttps) {
- return tunnel__namespace.httpsOverHttp(tunnelOptions);
- }
- else if (!isRequestHttps && isProxyHttps) {
- return tunnel__namespace.httpOverHttps(tunnelOptions);
- }
- else {
- return tunnel__namespace.httpOverHttp(tunnelOptions);
- }
-}
-function isValidPort(port) {
- // any port in 0-65535 range is valid (RFC 793) even though almost all implementations
- // will reserve 0 for a specific purpose, and a range of numbers for ephemeral ports
- return 0 <= port && port <= 65535;
-}
-
-// Copyright (c) Microsoft Corporation.
-const RedactedString = "REDACTED";
-const defaultAllowedHeaderNames = [
- "x-ms-client-request-id",
- "x-ms-return-client-request-id",
- "x-ms-useragent",
- "x-ms-correlation-request-id",
- "x-ms-request-id",
- "client-request-id",
- "ms-cv",
- "return-client-request-id",
- "traceparent",
- "Access-Control-Allow-Credentials",
- "Access-Control-Allow-Headers",
- "Access-Control-Allow-Methods",
- "Access-Control-Allow-Origin",
- "Access-Control-Expose-Headers",
- "Access-Control-Max-Age",
- "Access-Control-Request-Headers",
- "Access-Control-Request-Method",
- "Origin",
- "Accept",
- "Accept-Encoding",
- "Cache-Control",
- "Connection",
- "Content-Length",
- "Content-Type",
- "Date",
- "ETag",
- "Expires",
- "If-Match",
- "If-Modified-Since",
- "If-None-Match",
- "If-Unmodified-Since",
- "Last-Modified",
- "Pragma",
- "Request-Id",
- "Retry-After",
- "Server",
- "Transfer-Encoding",
- "User-Agent",
- "WWW-Authenticate",
-];
-const defaultAllowedQueryParameters = ["api-version"];
-class Sanitizer {
- constructor({ allowedHeaderNames = [], allowedQueryParameters = [] } = {}) {
- allowedHeaderNames = Array.isArray(allowedHeaderNames)
- ? defaultAllowedHeaderNames.concat(allowedHeaderNames)
- : defaultAllowedHeaderNames;
- allowedQueryParameters = Array.isArray(allowedQueryParameters)
- ? defaultAllowedQueryParameters.concat(allowedQueryParameters)
- : defaultAllowedQueryParameters;
- this.allowedHeaderNames = new Set(allowedHeaderNames.map((n) => n.toLowerCase()));
- this.allowedQueryParameters = new Set(allowedQueryParameters.map((p) => p.toLowerCase()));
- }
- sanitize(obj) {
- const seen = new Set();
- return JSON.stringify(obj, (key, value) => {
- // Ensure Errors include their interesting non-enumerable members
- if (value instanceof Error) {
- return Object.assign(Object.assign({}, value), { name: value.name, message: value.message });
- }
- if (key === "_headersMap") {
- return this.sanitizeHeaders(value);
- }
- else if (key === "url") {
- return this.sanitizeUrl(value);
- }
- else if (key === "query") {
- return this.sanitizeQuery(value);
- }
- else if (key === "body") {
- // Don't log the request body
- return undefined;
- }
- else if (key === "response") {
- // Don't log response again
- return undefined;
- }
- else if (key === "operationSpec") {
- // When using sendOperationRequest, the request carries a massive
- // field with the autorest spec. No need to log it.
- return undefined;
- }
- else if (Array.isArray(value) || isObject(value)) {
- if (seen.has(value)) {
- return "[Circular]";
- }
- seen.add(value);
- }
- return value;
- }, 2);
- }
- sanitizeHeaders(value) {
- return this.sanitizeObject(value, this.allowedHeaderNames, (v, k) => v[k].value);
- }
- sanitizeQuery(value) {
- return this.sanitizeObject(value, this.allowedQueryParameters, (v, k) => v[k]);
- }
- sanitizeObject(value, allowedKeys, accessor) {
- if (typeof value !== "object" || value === null) {
- return value;
- }
- const sanitized = {};
- for (const k of Object.keys(value)) {
- if (allowedKeys.has(k.toLowerCase())) {
- sanitized[k] = accessor(value, k);
- }
- else {
- sanitized[k] = RedactedString;
- }
- }
- return sanitized;
- }
- sanitizeUrl(value) {
- if (typeof value !== "string" || value === null) {
- return value;
- }
- const urlBuilder = URLBuilder.parse(value);
- const queryString = urlBuilder.getQuery();
- if (!queryString) {
- return value;
- }
- const query = URLQuery.parse(queryString);
- for (const k of query.keys()) {
- if (!this.allowedQueryParameters.has(k.toLowerCase())) {
- query.set(k, RedactedString);
- }
- }
- urlBuilder.setQuery(query.toString());
- return urlBuilder.toString();
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-const custom = util.inspect.custom;
-
-// Copyright (c) Microsoft Corporation.
-const errorSanitizer = new Sanitizer();
-/**
- * An error resulting from an HTTP request to a service endpoint.
- */
-class RestError extends Error {
- constructor(message, code, statusCode, request, response) {
- super(message);
- this.name = "RestError";
- this.code = code;
- this.statusCode = statusCode;
- this.request = request;
- this.response = response;
- Object.setPrototypeOf(this, RestError.prototype);
- }
- /**
- * Logging method for util.inspect in Node
- */
- [custom]() {
- return `RestError: ${this.message} \n ${errorSanitizer.sanitize(this)}`;
- }
-}
-/**
- * A constant string to identify errors that may arise when making an HTTP request that indicates an issue with the transport layer (e.g. the hostname of the URL cannot be resolved via DNS.)
- */
-RestError.REQUEST_SEND_ERROR = "REQUEST_SEND_ERROR";
-/**
- * A constant string to identify errors that may arise from parsing an incoming HTTP response. Usually indicates a malformed HTTP body, such as an encoded JSON payload that is incomplete.
- */
-RestError.PARSE_ERROR = "PARSE_ERROR";
-
-// Copyright (c) Microsoft Corporation.
-const logger = logger$1.createClientLogger("core-http");
-
-// Copyright (c) Microsoft Corporation.
-function getCachedAgent(isHttps, agentCache) {
- return isHttps ? agentCache.httpsAgent : agentCache.httpAgent;
-}
-class ReportTransform extends stream.Transform {
- constructor(progressCallback) {
- super();
- this.progressCallback = progressCallback;
- this.loadedBytes = 0;
- }
- _transform(chunk, _encoding, callback) {
- this.push(chunk);
- this.loadedBytes += chunk.length;
- this.progressCallback({ loadedBytes: this.loadedBytes });
- callback(undefined);
- }
-}
-function isReadableStream(body) {
- return body && typeof body.pipe === "function";
-}
-function isStreamComplete(stream, aborter) {
- return new Promise((resolve) => {
- stream.once("close", () => {
- aborter === null || aborter === void 0 ? void 0 : aborter.abort();
- resolve();
- });
- stream.once("end", resolve);
- stream.once("error", resolve);
- });
-}
-/**
- * Transforms a set of headers into the key/value pair defined by {@link HttpHeadersLike}
- */
-function parseHeaders(headers) {
- const httpHeaders = new HttpHeaders();
- headers.forEach((value, key) => {
- httpHeaders.set(key, value);
+ const policyInstance = factory.create(mockHttpClient, mockRequestPolicyOptions);
+ const policyName = policyInstance.constructor.name;
+ // bundlers sometimes add a custom suffix to the class name to make it unique
+ return knownPolicies.some((knownPolicyName) => {
+ return policyName.startsWith(knownPolicyName);
});
- return httpHeaders;
-}
-/**
- * An HTTP client that uses `node-fetch`.
- */
-class NodeFetchHttpClient {
- constructor() {
- // a mapping of proxy settings string `${host}:${port}:${username}:${password}` to agent
- this.proxyAgentMap = new Map();
- this.keepAliveAgents = {};
- }
- /**
- * Provides minimum viable error handling and the logic that executes the abstract methods.
- * @param httpRequest - Object representing the outgoing HTTP request.
- * @returns An object representing the incoming HTTP response.
- */
- async sendRequest(httpRequest) {
- var _a;
- if (!httpRequest && typeof httpRequest !== "object") {
- throw new Error("'httpRequest' (WebResourceLike) cannot be null or undefined and must be of type object.");
- }
- const abortController$1 = new abortController.AbortController();
- let abortListener;
- if (httpRequest.abortSignal) {
- if (httpRequest.abortSignal.aborted) {
- throw new abortController.AbortError("The operation was aborted.");
- }
- abortListener = (event) => {
- if (event.type === "abort") {
- abortController$1.abort();
- }
- };
- httpRequest.abortSignal.addEventListener("abort", abortListener);
- }
- if (httpRequest.timeout) {
- setTimeout(() => {
- abortController$1.abort();
- }, httpRequest.timeout);
- }
- if (httpRequest.formData) {
- const formData = httpRequest.formData;
- const requestForm = new FormData__default["default"]();
- const appendFormValue = (key, value) => {
- // value function probably returns a stream so we can provide a fresh stream on each retry
- if (typeof value === "function") {
- value = value();
- }
- if (value &&
- Object.prototype.hasOwnProperty.call(value, "value") &&
- Object.prototype.hasOwnProperty.call(value, "options")) {
- requestForm.append(key, value.value, value.options);
- }
- else {
- requestForm.append(key, value);
- }
- };
- for (const formKey of Object.keys(formData)) {
- const formValue = formData[formKey];
- if (Array.isArray(formValue)) {
- for (let j = 0; j < formValue.length; j++) {
- appendFormValue(formKey, formValue[j]);
- }
- }
- else {
- appendFormValue(formKey, formValue);
- }
- }
- httpRequest.body = requestForm;
- httpRequest.formData = undefined;
- const contentType = httpRequest.headers.get("Content-Type");
- if (contentType && contentType.indexOf("multipart/form-data") !== -1) {
- if (typeof requestForm.getBoundary === "function") {
- httpRequest.headers.set("Content-Type", `multipart/form-data; boundary=${requestForm.getBoundary()}`);
- }
- else {
- // browser will automatically apply a suitable content-type header
- httpRequest.headers.remove("Content-Type");
- }
- }
- }
- let body = httpRequest.body
- ? typeof httpRequest.body === "function"
- ? httpRequest.body()
- : httpRequest.body
- : undefined;
- if (httpRequest.onUploadProgress && httpRequest.body) {
- const onUploadProgress = httpRequest.onUploadProgress;
- const uploadReportStream = new ReportTransform(onUploadProgress);
- if (isReadableStream(body)) {
- body.pipe(uploadReportStream);
- }
- else {
- uploadReportStream.end(body);
- }
- body = uploadReportStream;
- }
- const platformSpecificRequestInit = await this.prepareRequest(httpRequest);
- const requestInit = Object.assign({ body: body, headers: httpRequest.headers.rawHeaders(), method: httpRequest.method,
- // the types for RequestInit are from the browser, which expects AbortSignal to
- // have `reason` and `throwIfAborted`, but these don't exist on our polyfill
- // for Node.
- signal: abortController$1.signal, redirect: "manual" }, platformSpecificRequestInit);
- let operationResponse;
- try {
- const response = await this.fetch(httpRequest.url, requestInit);
- const headers = parseHeaders(response.headers);
- const streaming = ((_a = httpRequest.streamResponseStatusCodes) === null || _a === void 0 ? void 0 : _a.has(response.status)) ||
- httpRequest.streamResponseBody;
- operationResponse = {
- headers: headers,
- request: httpRequest,
- status: response.status,
- readableStreamBody: streaming
- ? response.body
- : undefined,
- bodyAsText: !streaming ? await response.text() : undefined,
- };
- const onDownloadProgress = httpRequest.onDownloadProgress;
- if (onDownloadProgress) {
- const responseBody = response.body || undefined;
- if (isReadableStream(responseBody)) {
- const downloadReportStream = new ReportTransform(onDownloadProgress);
- responseBody.pipe(downloadReportStream);
- operationResponse.readableStreamBody = downloadReportStream;
- }
- else {
- const length = parseInt(headers.get("Content-Length")) || undefined;
- if (length) {
- // Calling callback for non-stream response for consistency with browser
- onDownloadProgress({ loadedBytes: length });
- }
- }
- }
- await this.processRequest(operationResponse);
- return operationResponse;
- }
- catch (error) {
- const fetchError = error;
- if (fetchError.code === "ENOTFOUND") {
- throw new RestError(fetchError.message, RestError.REQUEST_SEND_ERROR, undefined, httpRequest);
- }
- else if (fetchError.type === "aborted") {
- throw new abortController.AbortError("The operation was aborted.");
- }
- throw fetchError;
- }
- finally {
- // clean up event listener
- if (httpRequest.abortSignal && abortListener) {
- let uploadStreamDone = Promise.resolve();
- if (isReadableStream(body)) {
- uploadStreamDone = isStreamComplete(body);
- }
- let downloadStreamDone = Promise.resolve();
- if (isReadableStream(operationResponse === null || operationResponse === void 0 ? void 0 : operationResponse.readableStreamBody)) {
- downloadStreamDone = isStreamComplete(operationResponse.readableStreamBody, abortController$1);
- }
- Promise.all([uploadStreamDone, downloadStreamDone])
- .then(() => {
- var _a;
- (_a = httpRequest.abortSignal) === null || _a === void 0 ? void 0 : _a.removeEventListener("abort", abortListener);
- return;
- })
- .catch((e) => {
- logger.warning("Error when cleaning up abortListener on httpRequest", e);
- });
- }
- }
- }
- getOrCreateAgent(httpRequest) {
- var _a;
- const isHttps = isUrlHttps(httpRequest.url);
- // At the moment, proxy settings and keepAlive are mutually
- // exclusive because the 'tunnel' library currently lacks the
- // ability to create a proxy with keepAlive turned on.
- if (httpRequest.proxySettings) {
- const { host, port, username, password } = httpRequest.proxySettings;
- const key = `${host}:${port}:${username}:${password}`;
- const proxyAgents = (_a = this.proxyAgentMap.get(key)) !== null && _a !== void 0 ? _a : {};
- let agent = getCachedAgent(isHttps, proxyAgents);
- if (agent) {
- return agent;
- }
- const tunnel = createProxyAgent(httpRequest.url, httpRequest.proxySettings, httpRequest.headers);
- agent = tunnel.agent;
- if (tunnel.isHttps) {
- proxyAgents.httpsAgent = tunnel.agent;
- }
- else {
- proxyAgents.httpAgent = tunnel.agent;
- }
- this.proxyAgentMap.set(key, proxyAgents);
- return agent;
- }
- else if (httpRequest.keepAlive) {
- let agent = getCachedAgent(isHttps, this.keepAliveAgents);
- if (agent) {
- return agent;
- }
- const agentOptions = {
- keepAlive: httpRequest.keepAlive,
- };
- if (isHttps) {
- agent = this.keepAliveAgents.httpsAgent = new https__namespace.Agent(agentOptions);
- }
- else {
- agent = this.keepAliveAgents.httpAgent = new http__namespace.Agent(agentOptions);
- }
- return agent;
- }
- else {
- return isHttps ? https__namespace.globalAgent : http__namespace.globalAgent;
- }
- }
- /**
- * Uses `node-fetch` to perform the request.
- */
- // eslint-disable-next-line @azure/azure-sdk/ts-apisurface-standardized-verbs
- async fetch(input, init) {
- return node_fetch__default["default"](input, init);
- }
- /**
- * Prepares a request based on the provided web resource.
- */
- async prepareRequest(httpRequest) {
- const requestInit = {};
- // Set the http(s) agent
- requestInit.agent = this.getOrCreateAgent(httpRequest);
- requestInit.compress = httpRequest.decompressResponse;
- return requestInit;
- }
- /**
- * Process an HTTP response.
- */
- async processRequest(_operationResponse) {
- /* no_op */
- }
}
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * The different levels of logs that can be used with the HttpPipelineLogger.
- */
-exports.HttpPipelineLogLevel = void 0;
-(function (HttpPipelineLogLevel) {
- /**
- * A log level that indicates that no logs will be logged.
- */
- HttpPipelineLogLevel[HttpPipelineLogLevel["OFF"] = 0] = "OFF";
- /**
- * An error log.
- */
- HttpPipelineLogLevel[HttpPipelineLogLevel["ERROR"] = 1] = "ERROR";
- /**
- * A warning log.
- */
- HttpPipelineLogLevel[HttpPipelineLogLevel["WARNING"] = 2] = "WARNING";
- /**
- * An information log.
- */
- HttpPipelineLogLevel[HttpPipelineLogLevel["INFO"] = 3] = "INFO";
-})(exports.HttpPipelineLogLevel || (exports.HttpPipelineLogLevel = {}));
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Converts an OperationOptions to a RequestOptionsBase
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
*
- * @param opts - OperationOptions object to convert to RequestOptionsBase
- */
-function operationOptionsToRequestOptionsBase(opts) {
- const { requestOptions, tracingOptions } = opts, additionalOptions = tslib.__rest(opts, ["requestOptions", "tracingOptions"]);
- let result = additionalOptions;
- if (requestOptions) {
- result = Object.assign(Object.assign({}, result), requestOptions);
- }
- if (tracingOptions) {
- result.tracingContext = tracingOptions.tracingContext;
- // By passing spanOptions if they exist at runtime, we're backwards compatible with @azure/core-tracing@preview.13 and earlier.
- result.spanOptions = tracingOptions === null || tracingOptions === void 0 ? void 0 : tracingOptions.spanOptions;
- }
- return result;
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * The base class from which all request policies derive.
- */
-class BaseRequestPolicy {
- /**
- * The main method to implement that manipulates a request/response.
- */
- constructor(
- /**
- * The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
- */
- _nextPolicy,
- /**
- * The options that can be passed to a given request policy.
- */
- _options) {
- this._nextPolicy = _nextPolicy;
- this._options = _options;
- }
- /**
- * Get whether or not a log with the provided log level should be logged.
- * @param logLevel - The log level of the log that will be logged.
- * @returns Whether or not a log with the provided log level should be logged.
- */
- shouldLog(logLevel) {
- return this._options.shouldLog(logLevel);
- }
- /**
- * Attempt to log the provided message to the provided logger. If no logger was provided or if
- * the log level does not meat the logger's threshold, then nothing will be logged.
- * @param logLevel - The log level of this log.
- * @param message - The message of this log.
- */
- log(logLevel, message) {
- this._options.log(logLevel, message);
- }
-}
-/**
- * Optional properties that can be used when creating a RequestPolicy.
- */
-class RequestPolicyOptions {
- constructor(_logger) {
- this._logger = _logger;
- }
- /**
- * Get whether or not a log with the provided log level should be logged.
- * @param logLevel - The log level of the log that will be logged.
- * @returns Whether or not a log with the provided log level should be logged.
- */
- shouldLog(logLevel) {
- return (!!this._logger &&
- logLevel !== exports.HttpPipelineLogLevel.OFF &&
- logLevel <= this._logger.minimumLogLevel);
- }
- /**
- * Attempt to log the provided message to the provided logger. If no logger was provided or if
- * the log level does not meet the logger's threshold, then nothing will be logged.
- * @param logLevel - The log level of this log.
- * @param message - The message of this log.
- */
- log(logLevel, message) {
- if (this._logger && this.shouldLog(logLevel)) {
- this._logger.log(logLevel, message);
- }
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Note: The reason we re-define all of the xml2js default settings (version 2.0) here is because the default settings object exposed
-// by the xm2js library is mutable. See https://github.com/Leonidas-from-XIV/node-xml2js/issues/536
-// By creating a new copy of the settings each time we instantiate the parser,
-// we are safeguarding against the possibility of the default settings being mutated elsewhere unintentionally.
-const xml2jsDefaultOptionsV2 = {
- explicitCharkey: false,
- trim: false,
- normalize: false,
- normalizeTags: false,
- attrkey: XML_ATTRKEY,
- explicitArray: true,
- ignoreAttrs: false,
- mergeAttrs: false,
- explicitRoot: true,
- validator: undefined,
- xmlns: false,
- explicitChildren: false,
- preserveChildrenOrder: false,
- childkey: "$$",
- charsAsChildren: false,
- includeWhiteChars: false,
- async: false,
- strict: true,
- attrNameProcessors: undefined,
- attrValueProcessors: undefined,
- tagNameProcessors: undefined,
- valueProcessors: undefined,
- rootName: "root",
- xmldec: {
- version: "1.0",
- encoding: "UTF-8",
- standalone: true,
- },
- doctype: undefined,
- renderOpts: {
- pretty: true,
- indent: " ",
- newline: "\n",
- },
- headless: false,
- chunkSize: 10000,
- emptyTag: "",
- cdata: false,
-};
-// The xml2js settings for general XML parsing operations.
-const xml2jsParserSettings = Object.assign({}, xml2jsDefaultOptionsV2);
-xml2jsParserSettings.explicitArray = false;
-// The xml2js settings for general XML building operations.
-const xml2jsBuilderSettings = Object.assign({}, xml2jsDefaultOptionsV2);
-xml2jsBuilderSettings.explicitArray = false;
-xml2jsBuilderSettings.renderOpts = {
- pretty: false,
-};
-/**
- * Converts given JSON object to XML string
- * @param obj - JSON object to be converted into XML string
- * @param opts - Options that govern the parsing of given JSON object
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
-function stringifyXML(obj, opts = {}) {
- var _a;
- xml2jsBuilderSettings.rootName = opts.rootName;
- xml2jsBuilderSettings.charkey = (_a = opts.xmlCharKey) !== null && _a !== void 0 ? _a : XML_CHARKEY;
- const builder = new xml2js__namespace.Builder(xml2jsBuilderSettings);
- return builder.buildObject(obj);
-}
-/**
- * Converts given XML string into JSON
- * @param str - String containing the XML content to be parsed into JSON
- * @param opts - Options that govern the parsing of given xml string
- */
-function parseXML(str, opts = {}) {
- var _a;
- xml2jsParserSettings.explicitRoot = !!opts.includeRoot;
- xml2jsParserSettings.charkey = (_a = opts.xmlCharKey) !== null && _a !== void 0 ? _a : XML_CHARKEY;
- const xmlParser = new xml2js__namespace.Parser(xml2jsParserSettings);
- return new Promise((resolve, reject) => {
- if (!str) {
- reject(new Error("Document is empty"));
- }
- else {
- xmlParser.parseString(str, (err, res) => {
- if (err) {
- reject(err);
- }
- else {
- resolve(res);
- }
- });
- }
- });
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Create a new serialization RequestPolicyCreator that will serialized HTTP request bodies as they
- * pass through the HTTP pipeline.
- */
-function deserializationPolicy(deserializationContentTypes, parsingOptions) {
- return {
- create: (nextPolicy, options) => {
- return new DeserializationPolicy(nextPolicy, options, deserializationContentTypes, parsingOptions);
+const BlobServiceProperties = {
+ serializedName: "BlobServiceProperties",
+ xmlName: "StorageServiceProperties",
+ type: {
+ name: "Composite",
+ className: "BlobServiceProperties",
+ modelProperties: {
+ blobAnalyticsLogging: {
+ serializedName: "Logging",
+ xmlName: "Logging",
+ type: {
+ name: "Composite",
+ className: "Logging",
+ },
+ },
+ hourMetrics: {
+ serializedName: "HourMetrics",
+ xmlName: "HourMetrics",
+ type: {
+ name: "Composite",
+ className: "Metrics",
+ },
+ },
+ minuteMetrics: {
+ serializedName: "MinuteMetrics",
+ xmlName: "MinuteMetrics",
+ type: {
+ name: "Composite",
+ className: "Metrics",
+ },
+ },
+ cors: {
+ serializedName: "Cors",
+ xmlName: "Cors",
+ xmlIsWrapped: true,
+ xmlElementName: "CorsRule",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "CorsRule",
+ },
+ },
+ },
+ },
+ defaultServiceVersion: {
+ serializedName: "DefaultServiceVersion",
+ xmlName: "DefaultServiceVersion",
+ type: {
+ name: "String",
+ },
+ },
+ deleteRetentionPolicy: {
+ serializedName: "DeleteRetentionPolicy",
+ xmlName: "DeleteRetentionPolicy",
+ type: {
+ name: "Composite",
+ className: "RetentionPolicy",
+ },
+ },
+ staticWebsite: {
+ serializedName: "StaticWebsite",
+ xmlName: "StaticWebsite",
+ type: {
+ name: "Composite",
+ className: "StaticWebsite",
+ },
+ },
},
- };
-}
-const defaultJsonContentTypes = ["application/json", "text/json"];
-const defaultXmlContentTypes = ["application/xml", "application/atom+xml"];
-const DefaultDeserializationOptions = {
- expectedContentTypes: {
- json: defaultJsonContentTypes,
- xml: defaultXmlContentTypes,
},
};
-/**
- * A RequestPolicy that will deserialize HTTP response bodies and headers as they pass through the
- * HTTP pipeline.
- */
-class DeserializationPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, requestPolicyOptions, deserializationContentTypes, parsingOptions = {}) {
- var _a;
- super(nextPolicy, requestPolicyOptions);
- this.jsonContentTypes =
- (deserializationContentTypes && deserializationContentTypes.json) || defaultJsonContentTypes;
- this.xmlContentTypes =
- (deserializationContentTypes && deserializationContentTypes.xml) || defaultXmlContentTypes;
- this.xmlCharKey = (_a = parsingOptions.xmlCharKey) !== null && _a !== void 0 ? _a : XML_CHARKEY;
- }
- async sendRequest(request) {
- return this._nextPolicy.sendRequest(request).then((response) => deserializeResponseBody(this.jsonContentTypes, this.xmlContentTypes, response, {
- xmlCharKey: this.xmlCharKey,
- }));
- }
-}
-function getOperationResponse(parsedResponse) {
- let result;
- const request = parsedResponse.request;
- const operationSpec = request.operationSpec;
- if (operationSpec) {
- const operationResponseGetter = request.operationResponseGetter;
- if (!operationResponseGetter) {
- result = operationSpec.responses[parsedResponse.status];
- }
- else {
- result = operationResponseGetter(operationSpec, parsedResponse);
- }
- }
- return result;
-}
-function shouldDeserializeResponse(parsedResponse) {
- const shouldDeserialize = parsedResponse.request.shouldDeserialize;
- let result;
- if (shouldDeserialize === undefined) {
- result = true;
- }
- else if (typeof shouldDeserialize === "boolean") {
- result = shouldDeserialize;
- }
- else {
- result = shouldDeserialize(parsedResponse);
- }
- return result;
-}
-/**
- * Given a particular set of content types to parse as either JSON or XML, consumes the HTTP response to produce the result object defined by the request's {@link OperationSpec}.
- * @param jsonContentTypes - Response content types to parse the body as JSON.
- * @param xmlContentTypes - Response content types to parse the body as XML.
- * @param response - HTTP Response from the pipeline.
- * @param options - Options to the serializer, mostly for configuring the XML parser if needed.
- * @returns A parsed {@link HttpOperationResponse} object that can be returned by the {@link ServiceClient}.
- */
-function deserializeResponseBody(jsonContentTypes, xmlContentTypes, response, options = {}) {
- var _a, _b, _c;
- const updatedOptions = {
- rootName: (_a = options.rootName) !== null && _a !== void 0 ? _a : "",
- includeRoot: (_b = options.includeRoot) !== null && _b !== void 0 ? _b : false,
- xmlCharKey: (_c = options.xmlCharKey) !== null && _c !== void 0 ? _c : XML_CHARKEY,
- };
- return parse(jsonContentTypes, xmlContentTypes, response, updatedOptions).then((parsedResponse) => {
- if (!shouldDeserializeResponse(parsedResponse)) {
- return parsedResponse;
- }
- const operationSpec = parsedResponse.request.operationSpec;
- if (!operationSpec || !operationSpec.responses) {
- return parsedResponse;
- }
- const responseSpec = getOperationResponse(parsedResponse);
- const { error, shouldReturnResponse } = handleErrorResponse(parsedResponse, operationSpec, responseSpec);
- if (error) {
- throw error;
- }
- else if (shouldReturnResponse) {
- return parsedResponse;
- }
- // An operation response spec does exist for current status code, so
- // use it to deserialize the response.
- if (responseSpec) {
- if (responseSpec.bodyMapper) {
- let valueToDeserialize = parsedResponse.parsedBody;
- if (operationSpec.isXML && responseSpec.bodyMapper.type.name === MapperType.Sequence) {
- valueToDeserialize =
- typeof valueToDeserialize === "object"
- ? valueToDeserialize[responseSpec.bodyMapper.xmlElementName]
- : [];
- }
- try {
- parsedResponse.parsedBody = operationSpec.serializer.deserialize(responseSpec.bodyMapper, valueToDeserialize, "operationRes.parsedBody", options);
- }
- catch (innerError) {
- const restError = new RestError(`Error ${innerError} occurred in deserializing the responseBody - ${parsedResponse.bodyAsText}`, undefined, parsedResponse.status, parsedResponse.request, parsedResponse);
- throw restError;
- }
- }
- else if (operationSpec.httpMethod === "HEAD") {
- // head methods never have a body, but we return a boolean to indicate presence/absence of the resource
- parsedResponse.parsedBody = response.status >= 200 && response.status < 300;
- }
- if (responseSpec.headersMapper) {
- parsedResponse.parsedHeaders = operationSpec.serializer.deserialize(responseSpec.headersMapper, parsedResponse.headers.toJson(), "operationRes.parsedHeaders", options);
- }
- }
- return parsedResponse;
- });
-}
-function isOperationSpecEmpty(operationSpec) {
- const expectedStatusCodes = Object.keys(operationSpec.responses);
- return (expectedStatusCodes.length === 0 ||
- (expectedStatusCodes.length === 1 && expectedStatusCodes[0] === "default"));
-}
-function handleErrorResponse(parsedResponse, operationSpec, responseSpec) {
- var _a;
- const isSuccessByStatus = 200 <= parsedResponse.status && parsedResponse.status < 300;
- const isExpectedStatusCode = isOperationSpecEmpty(operationSpec)
- ? isSuccessByStatus
- : !!responseSpec;
- if (isExpectedStatusCode) {
- if (responseSpec) {
- if (!responseSpec.isError) {
- return { error: null, shouldReturnResponse: false };
- }
- }
- else {
- return { error: null, shouldReturnResponse: false };
- }
- }
- const errorResponseSpec = responseSpec !== null && responseSpec !== void 0 ? responseSpec : operationSpec.responses.default;
- const streaming = ((_a = parsedResponse.request.streamResponseStatusCodes) === null || _a === void 0 ? void 0 : _a.has(parsedResponse.status)) ||
- parsedResponse.request.streamResponseBody;
- const initialErrorMessage = streaming
- ? `Unexpected status code: ${parsedResponse.status}`
- : parsedResponse.bodyAsText;
- const error = new RestError(initialErrorMessage, undefined, parsedResponse.status, parsedResponse.request, parsedResponse);
- // If the item failed but there's no error spec or default spec to deserialize the error,
- // we should fail so we just throw the parsed response
- if (!errorResponseSpec) {
- throw error;
- }
- const defaultBodyMapper = errorResponseSpec.bodyMapper;
- const defaultHeadersMapper = errorResponseSpec.headersMapper;
- try {
- // If error response has a body, try to deserialize it using default body mapper.
- // Then try to extract error code & message from it
- if (parsedResponse.parsedBody) {
- const parsedBody = parsedResponse.parsedBody;
- let parsedError;
- if (defaultBodyMapper) {
- let valueToDeserialize = parsedBody;
- if (operationSpec.isXML && defaultBodyMapper.type.name === MapperType.Sequence) {
- valueToDeserialize =
- typeof parsedBody === "object" ? parsedBody[defaultBodyMapper.xmlElementName] : [];
- }
- parsedError = operationSpec.serializer.deserialize(defaultBodyMapper, valueToDeserialize, "error.response.parsedBody");
- }
- const internalError = parsedBody.error || parsedError || parsedBody;
- error.code = internalError.code;
- if (internalError.message) {
- error.message = internalError.message;
- }
- if (defaultBodyMapper) {
- error.response.parsedBody = parsedError;
- }
- }
- // If error response has headers, try to deserialize it using default header mapper
- if (parsedResponse.headers && defaultHeadersMapper) {
- error.response.parsedHeaders = operationSpec.serializer.deserialize(defaultHeadersMapper, parsedResponse.headers.toJson(), "operationRes.parsedHeaders");
- }
- }
- catch (defaultError) {
- error.message = `Error "${defaultError.message}" occurred in deserializing the responseBody - "${parsedResponse.bodyAsText}" for the default response.`;
- }
- return { error, shouldReturnResponse: false };
-}
-function parse(jsonContentTypes, xmlContentTypes, operationResponse, opts) {
- var _a;
- const errorHandler = (err) => {
- const msg = `Error "${err}" occurred while parsing the response body - ${operationResponse.bodyAsText}.`;
- const errCode = err.code || RestError.PARSE_ERROR;
- const e = new RestError(msg, errCode, operationResponse.status, operationResponse.request, operationResponse);
- return Promise.reject(e);
- };
- const streaming = ((_a = operationResponse.request.streamResponseStatusCodes) === null || _a === void 0 ? void 0 : _a.has(operationResponse.status)) ||
- operationResponse.request.streamResponseBody;
- if (!streaming && operationResponse.bodyAsText) {
- const text = operationResponse.bodyAsText;
- const contentType = operationResponse.headers.get("Content-Type") || "";
- const contentComponents = !contentType
- ? []
- : contentType.split(";").map((component) => component.toLowerCase());
- if (contentComponents.length === 0 ||
- contentComponents.some((component) => jsonContentTypes.indexOf(component) !== -1)) {
- return new Promise((resolve) => {
- operationResponse.parsedBody = JSON.parse(text);
- resolve(operationResponse);
- }).catch(errorHandler);
- }
- else if (contentComponents.some((component) => xmlContentTypes.indexOf(component) !== -1)) {
- return parseXML(text, opts)
- .then((body) => {
- operationResponse.parsedBody = body;
- return operationResponse;
- })
- .catch(errorHandler);
- }
- }
- return Promise.resolve(operationResponse);
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * By default, HTTP connections are maintained for future requests.
- */
-const DefaultKeepAliveOptions = {
- enable: true,
+const Logging = {
+ serializedName: "Logging",
+ type: {
+ name: "Composite",
+ className: "Logging",
+ modelProperties: {
+ version: {
+ serializedName: "Version",
+ required: true,
+ xmlName: "Version",
+ type: {
+ name: "String",
+ },
+ },
+ deleteProperty: {
+ serializedName: "Delete",
+ required: true,
+ xmlName: "Delete",
+ type: {
+ name: "Boolean",
+ },
+ },
+ read: {
+ serializedName: "Read",
+ required: true,
+ xmlName: "Read",
+ type: {
+ name: "Boolean",
+ },
+ },
+ write: {
+ serializedName: "Write",
+ required: true,
+ xmlName: "Write",
+ type: {
+ name: "Boolean",
+ },
+ },
+ retentionPolicy: {
+ serializedName: "RetentionPolicy",
+ xmlName: "RetentionPolicy",
+ type: {
+ name: "Composite",
+ className: "RetentionPolicy",
+ },
+ },
+ },
+ },
};
-/**
- * Creates a policy that controls whether HTTP connections are maintained on future requests.
- * @param keepAliveOptions - Keep alive options. By default, HTTP connections are maintained for future requests.
- * @returns An instance of the {@link KeepAlivePolicy}
- */
-function keepAlivePolicy(keepAliveOptions) {
- return {
- create: (nextPolicy, options) => {
- return new KeepAlivePolicy(nextPolicy, options, keepAliveOptions || DefaultKeepAliveOptions);
+const RetentionPolicy = {
+ serializedName: "RetentionPolicy",
+ type: {
+ name: "Composite",
+ className: "RetentionPolicy",
+ modelProperties: {
+ enabled: {
+ serializedName: "Enabled",
+ required: true,
+ xmlName: "Enabled",
+ type: {
+ name: "Boolean",
+ },
+ },
+ days: {
+ constraints: {
+ InclusiveMinimum: 1,
+ },
+ serializedName: "Days",
+ xmlName: "Days",
+ type: {
+ name: "Number",
+ },
+ },
},
- };
-}
-/**
- * KeepAlivePolicy is a policy used to control keep alive settings for every request.
- */
-class KeepAlivePolicy extends BaseRequestPolicy {
- /**
- * Creates an instance of KeepAlivePolicy.
- *
- * @param nextPolicy -
- * @param options -
- * @param keepAliveOptions -
- */
- constructor(nextPolicy, options, keepAliveOptions) {
- super(nextPolicy, options);
- this.keepAliveOptions = keepAliveOptions;
- }
- /**
- * Sends out request.
- *
- * @param request -
- * @returns
- */
- async sendRequest(request) {
- request.keepAlive = this.keepAliveOptions.enable;
- return this._nextPolicy.sendRequest(request);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Methods that are allowed to follow redirects 301 and 302
- */
-const allowedRedirect = ["GET", "HEAD"];
-const DefaultRedirectOptions = {
- handleRedirects: true,
- maxRetries: 20,
+ },
};
-/**
- * Creates a redirect policy, which sends a repeats the request to a new destination if a response arrives with a "location" header, and a status code between 300 and 307.
- * @param maximumRetries - Maximum number of redirects to follow.
- * @returns An instance of the {@link RedirectPolicy}
- */
-function redirectPolicy(maximumRetries = 20) {
- return {
- create: (nextPolicy, options) => {
- return new RedirectPolicy(nextPolicy, options, maximumRetries);
+const Metrics = {
+ serializedName: "Metrics",
+ type: {
+ name: "Composite",
+ className: "Metrics",
+ modelProperties: {
+ version: {
+ serializedName: "Version",
+ xmlName: "Version",
+ type: {
+ name: "String",
+ },
+ },
+ enabled: {
+ serializedName: "Enabled",
+ required: true,
+ xmlName: "Enabled",
+ type: {
+ name: "Boolean",
+ },
+ },
+ includeAPIs: {
+ serializedName: "IncludeAPIs",
+ xmlName: "IncludeAPIs",
+ type: {
+ name: "Boolean",
+ },
+ },
+ retentionPolicy: {
+ serializedName: "RetentionPolicy",
+ xmlName: "RetentionPolicy",
+ type: {
+ name: "Composite",
+ className: "RetentionPolicy",
+ },
+ },
},
- };
-}
-/**
- * Resends the request to a new destination if a response arrives with a "location" header, and a status code between 300 and 307.
- */
-class RedirectPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, maxRetries = 20) {
- super(nextPolicy, options);
- this.maxRetries = maxRetries;
- }
- sendRequest(request) {
- return this._nextPolicy
- .sendRequest(request)
- .then((response) => handleRedirect(this, response, 0));
- }
-}
-function handleRedirect(policy, response, currentRetries) {
- const { request, status } = response;
- const locationHeader = response.headers.get("location");
- if (locationHeader &&
- (status === 300 ||
- (status === 301 && allowedRedirect.includes(request.method)) ||
- (status === 302 && allowedRedirect.includes(request.method)) ||
- (status === 303 && request.method === "POST") ||
- status === 307) &&
- (!policy.maxRetries || currentRetries < policy.maxRetries)) {
- const builder = URLBuilder.parse(request.url);
- builder.setPath(locationHeader);
- request.url = builder.toString();
- // POST request with Status code 303 should be converted into a
- // redirected GET request if the redirect url is present in the location header
- if (status === 303) {
- request.method = "GET";
- delete request.body;
- }
- return policy._nextPolicy
- .sendRequest(request)
- .then((res) => handleRedirect(policy, res, currentRetries + 1));
- }
- return Promise.resolve(response);
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-const DEFAULT_CLIENT_RETRY_COUNT = 3;
-// intervals are in ms
-const DEFAULT_CLIENT_RETRY_INTERVAL = 1000 * 30;
-const DEFAULT_CLIENT_MAX_RETRY_INTERVAL = 1000 * 90;
-const DEFAULT_CLIENT_MIN_RETRY_INTERVAL = 1000 * 3;
-function isNumber(n) {
- return typeof n === "number";
-}
-/**
- * @internal
- * Determines if the operation should be retried.
- *
- * @param retryLimit - Specifies the max number of retries.
- * @param predicate - Initial chekck on whether to retry based on given responses or errors
- * @param retryData - The retry data.
- * @returns True if the operation qualifies for a retry; false otherwise.
- */
-function shouldRetry(retryLimit, predicate, retryData, response, error) {
- if (!predicate(response, error)) {
- return false;
- }
- return retryData.retryCount < retryLimit;
-}
-/**
- * @internal
- * Updates the retry data for the next attempt.
- *
- * @param retryOptions - specifies retry interval, and its lower bound and upper bound.
- * @param retryData - The retry data.
- * @param err - The operation"s error, if any.
- */
-function updateRetryData(retryOptions, retryData = { retryCount: 0, retryInterval: 0 }, err) {
- if (err) {
- if (retryData.error) {
- err.innerError = retryData.error;
- }
- retryData.error = err;
- }
- // Adjust retry count
- retryData.retryCount++;
- // Adjust retry interval
- let incrementDelta = Math.pow(2, retryData.retryCount - 1) - 1;
- const boundedRandDelta = retryOptions.retryInterval * 0.8 +
- Math.floor(Math.random() * (retryOptions.retryInterval * 0.4));
- incrementDelta *= boundedRandDelta;
- retryData.retryInterval = Math.min(retryOptions.minRetryInterval + incrementDelta, retryOptions.maxRetryInterval);
- return retryData;
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Policy that retries the request as many times as configured for as long as the max retry time interval specified, each retry waiting longer to begin than the last time.
- * @param retryCount - Maximum number of retries.
- * @param retryInterval - Base time between retries.
- * @param maxRetryInterval - Maximum time to wait between retries.
- */
-function exponentialRetryPolicy(retryCount, retryInterval, maxRetryInterval) {
- return {
- create: (nextPolicy, options) => {
- return new ExponentialRetryPolicy(nextPolicy, options, retryCount, retryInterval, maxRetryInterval);
+ },
+};
+const CorsRule = {
+ serializedName: "CorsRule",
+ type: {
+ name: "Composite",
+ className: "CorsRule",
+ modelProperties: {
+ allowedOrigins: {
+ serializedName: "AllowedOrigins",
+ required: true,
+ xmlName: "AllowedOrigins",
+ type: {
+ name: "String",
+ },
+ },
+ allowedMethods: {
+ serializedName: "AllowedMethods",
+ required: true,
+ xmlName: "AllowedMethods",
+ type: {
+ name: "String",
+ },
+ },
+ allowedHeaders: {
+ serializedName: "AllowedHeaders",
+ required: true,
+ xmlName: "AllowedHeaders",
+ type: {
+ name: "String",
+ },
+ },
+ exposedHeaders: {
+ serializedName: "ExposedHeaders",
+ required: true,
+ xmlName: "ExposedHeaders",
+ type: {
+ name: "String",
+ },
+ },
+ maxAgeInSeconds: {
+ constraints: {
+ InclusiveMinimum: 0,
+ },
+ serializedName: "MaxAgeInSeconds",
+ required: true,
+ xmlName: "MaxAgeInSeconds",
+ type: {
+ name: "Number",
+ },
+ },
},
- };
-}
-/**
- * Describes the Retry Mode type. Currently supporting only Exponential.
- */
-exports.RetryMode = void 0;
-(function (RetryMode) {
- /**
- * Currently supported retry mode.
- * Each time a retry happens, it will take exponentially more time than the last time.
- */
- RetryMode[RetryMode["Exponential"] = 0] = "Exponential";
-})(exports.RetryMode || (exports.RetryMode = {}));
-const DefaultRetryOptions = {
- maxRetries: DEFAULT_CLIENT_RETRY_COUNT,
- retryDelayInMs: DEFAULT_CLIENT_RETRY_INTERVAL,
- maxRetryDelayInMs: DEFAULT_CLIENT_MAX_RETRY_INTERVAL,
+ },
};
-/**
- * Instantiates a new "ExponentialRetryPolicyFilter" instance.
- */
-class ExponentialRetryPolicy extends BaseRequestPolicy {
- /**
- * @param nextPolicy - The next RequestPolicy in the pipeline chain.
- * @param options - The options for this RequestPolicy.
- * @param retryCount - The client retry count.
- * @param retryInterval - The client retry interval, in milliseconds.
- * @param minRetryInterval - The minimum retry interval, in milliseconds.
- * @param maxRetryInterval - The maximum retry interval, in milliseconds.
- */
- constructor(nextPolicy, options, retryCount, retryInterval, maxRetryInterval) {
- super(nextPolicy, options);
- this.retryCount = isNumber(retryCount) ? retryCount : DEFAULT_CLIENT_RETRY_COUNT;
- this.retryInterval = isNumber(retryInterval) ? retryInterval : DEFAULT_CLIENT_RETRY_INTERVAL;
- this.maxRetryInterval = isNumber(maxRetryInterval)
- ? maxRetryInterval
- : DEFAULT_CLIENT_MAX_RETRY_INTERVAL;
- }
- sendRequest(request) {
- return this._nextPolicy
- .sendRequest(request.clone())
- .then((response) => retry$1(this, request, response))
- .catch((error) => retry$1(this, request, error.response, undefined, error));
- }
-}
-async function retry$1(policy, request, response, retryData, requestError) {
- function shouldPolicyRetry(responseParam) {
- const statusCode = responseParam === null || responseParam === void 0 ? void 0 : responseParam.status;
- if (statusCode === 503 && (response === null || response === void 0 ? void 0 : response.headers.get(Constants.HeaderConstants.RETRY_AFTER))) {
- return false;
- }
- if (statusCode === undefined ||
- (statusCode < 500 && statusCode !== 408) ||
- statusCode === 501 ||
- statusCode === 505) {
- return false;
- }
- return true;
- }
- retryData = updateRetryData({
- retryInterval: policy.retryInterval,
- minRetryInterval: 0,
- maxRetryInterval: policy.maxRetryInterval,
- }, retryData, requestError);
- const isAborted = request.abortSignal && request.abortSignal.aborted;
- if (!isAborted && shouldRetry(policy.retryCount, shouldPolicyRetry, retryData, response)) {
- logger.info(`Retrying request in ${retryData.retryInterval}`);
- try {
- await coreUtil.delay(retryData.retryInterval);
- const res = await policy._nextPolicy.sendRequest(request.clone());
- return retry$1(policy, request, res, retryData);
- }
- catch (err) {
- return retry$1(policy, request, response, retryData, err);
- }
- }
- else if (isAborted || requestError || !response) {
- // If the operation failed in the end, return all errors instead of just the last one
- const err = retryData.error ||
- new RestError("Failed to send the request.", RestError.REQUEST_SEND_ERROR, response && response.status, response && response.request, response);
- throw err;
- }
- else {
- return response;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Creates a policy that logs information about the outgoing request and the incoming responses.
- * @param loggingOptions - Logging options.
- * @returns An instance of the {@link LogPolicy}
- */
-function logPolicy(loggingOptions = {}) {
- return {
- create: (nextPolicy, options) => {
- return new LogPolicy(nextPolicy, options, loggingOptions);
+const StaticWebsite = {
+ serializedName: "StaticWebsite",
+ type: {
+ name: "Composite",
+ className: "StaticWebsite",
+ modelProperties: {
+ enabled: {
+ serializedName: "Enabled",
+ required: true,
+ xmlName: "Enabled",
+ type: {
+ name: "Boolean",
+ },
+ },
+ indexDocument: {
+ serializedName: "IndexDocument",
+ xmlName: "IndexDocument",
+ type: {
+ name: "String",
+ },
+ },
+ errorDocument404Path: {
+ serializedName: "ErrorDocument404Path",
+ xmlName: "ErrorDocument404Path",
+ type: {
+ name: "String",
+ },
+ },
+ defaultIndexDocumentPath: {
+ serializedName: "DefaultIndexDocumentPath",
+ xmlName: "DefaultIndexDocumentPath",
+ type: {
+ name: "String",
+ },
+ },
},
- };
-}
-/**
- * A policy that logs information about the outgoing request and the incoming responses.
- */
-class LogPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, { logger: logger$1 = logger.info, allowedHeaderNames = [], allowedQueryParameters = [], } = {}) {
- super(nextPolicy, options);
- this.logger = logger$1;
- this.sanitizer = new Sanitizer({ allowedHeaderNames, allowedQueryParameters });
- }
- /**
- * Header names whose values will be logged when logging is enabled. Defaults to
- * Date, traceparent, x-ms-client-request-id, and x-ms-request id. Any headers
- * specified in this field will be added to that list. Any other values will
- * be written to logs as "REDACTED".
- * @deprecated Pass these into the constructor instead.
- */
- get allowedHeaderNames() {
- return this.sanitizer.allowedHeaderNames;
- }
- /**
- * Header names whose values will be logged when logging is enabled. Defaults to
- * Date, traceparent, x-ms-client-request-id, and x-ms-request id. Any headers
- * specified in this field will be added to that list. Any other values will
- * be written to logs as "REDACTED".
- * @deprecated Pass these into the constructor instead.
- */
- set allowedHeaderNames(allowedHeaderNames) {
- this.sanitizer.allowedHeaderNames = allowedHeaderNames;
- }
- /**
- * Query string names whose values will be logged when logging is enabled. By default no
- * query string values are logged.
- * @deprecated Pass these into the constructor instead.
- */
- get allowedQueryParameters() {
- return this.sanitizer.allowedQueryParameters;
- }
- /**
- * Query string names whose values will be logged when logging is enabled. By default no
- * query string values are logged.
- * @deprecated Pass these into the constructor instead.
- */
- set allowedQueryParameters(allowedQueryParameters) {
- this.sanitizer.allowedQueryParameters = allowedQueryParameters;
- }
- sendRequest(request) {
- if (!this.logger.enabled)
- return this._nextPolicy.sendRequest(request);
- this.logRequest(request);
- return this._nextPolicy.sendRequest(request).then((response) => this.logResponse(response));
- }
- logRequest(request) {
- this.logger(`Request: ${this.sanitizer.sanitize(request)}`);
- }
- logResponse(response) {
- this.logger(`Response status code: ${response.status}`);
- this.logger(`Headers: ${this.sanitizer.sanitize(response.headers)}`);
- return response;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Get the path to this parameter's value as a dotted string (a.b.c).
- * @param parameter - The parameter to get the path string for.
- * @returns The path to this parameter's value as a dotted string.
- */
-function getPathStringFromParameter(parameter) {
- return getPathStringFromParameterPath(parameter.parameterPath, parameter.mapper);
-}
-function getPathStringFromParameterPath(parameterPath, mapper) {
- let result;
- if (typeof parameterPath === "string") {
- result = parameterPath;
- }
- else if (Array.isArray(parameterPath)) {
- result = parameterPath.join(".");
- }
- else {
- result = mapper.serializedName;
- }
- return result;
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Gets the list of status codes for streaming responses.
- * @internal
- */
-function getStreamResponseStatusCodes(operationSpec) {
- const result = new Set();
- for (const statusCode in operationSpec.responses) {
- const operationResponse = operationSpec.responses[statusCode];
- if (operationResponse.bodyMapper &&
- operationResponse.bodyMapper.type.name === MapperType.Stream) {
- result.add(Number(statusCode));
- }
- }
- return result;
-}
-
-// Copyright (c) Microsoft Corporation.
-function getDefaultUserAgentKey() {
- return Constants.HeaderConstants.USER_AGENT;
-}
-function getPlatformSpecificData() {
- const runtimeInfo = {
- key: "Node",
- value: process.version,
- };
- const osInfo = {
- key: "OS",
- value: `(${os__namespace.arch()}-${os__namespace.type()}-${os__namespace.release()})`,
- };
- return [runtimeInfo, osInfo];
-}
-
-// Copyright (c) Microsoft Corporation.
-function getRuntimeInfo() {
- const msRestRuntime = {
- key: "core-http",
- value: Constants.coreHttpVersion,
- };
- return [msRestRuntime];
-}
-function getUserAgentString(telemetryInfo, keySeparator = " ", valueSeparator = "/") {
- return telemetryInfo
- .map((info) => {
- const value = info.value ? `${valueSeparator}${info.value}` : "";
- return `${info.key}${value}`;
- })
- .join(keySeparator);
-}
-const getDefaultUserAgentHeaderName = getDefaultUserAgentKey;
-/**
- * The default approach to generate user agents.
- * Uses static information from this package, plus system information available from the runtime.
- */
-function getDefaultUserAgentValue() {
- const runtimeInfo = getRuntimeInfo();
- const platformSpecificData = getPlatformSpecificData();
- const userAgent = getUserAgentString(runtimeInfo.concat(platformSpecificData));
- return userAgent;
-}
-/**
- * Returns a policy that adds the user agent header to outgoing requests based on the given {@link TelemetryInfo}.
- * @param userAgentData - Telemetry information.
- * @returns A new {@link UserAgentPolicy}.
- */
-function userAgentPolicy(userAgentData) {
- const key = !userAgentData || userAgentData.key === undefined || userAgentData.key === null
- ? getDefaultUserAgentKey()
- : userAgentData.key;
- const value = !userAgentData || userAgentData.value === undefined || userAgentData.value === null
- ? getDefaultUserAgentValue()
- : userAgentData.value;
- return {
- create: (nextPolicy, options) => {
- return new UserAgentPolicy(nextPolicy, options, key, value);
+ },
+};
+const StorageError = {
+ serializedName: "StorageError",
+ type: {
+ name: "Composite",
+ className: "StorageError",
+ modelProperties: {
+ message: {
+ serializedName: "Message",
+ xmlName: "Message",
+ type: {
+ name: "String",
+ },
+ },
+ code: {
+ serializedName: "Code",
+ xmlName: "Code",
+ type: {
+ name: "String",
+ },
+ },
+ authenticationErrorDetail: {
+ serializedName: "AuthenticationErrorDetail",
+ xmlName: "AuthenticationErrorDetail",
+ type: {
+ name: "String",
+ },
+ },
},
- };
-}
-/**
- * A policy that adds the user agent header to outgoing requests based on the given {@link TelemetryInfo}.
- */
-class UserAgentPolicy extends BaseRequestPolicy {
- constructor(_nextPolicy, _options, headerKey, headerValue) {
- super(_nextPolicy, _options);
- this._nextPolicy = _nextPolicy;
- this._options = _options;
- this.headerKey = headerKey;
- this.headerValue = headerValue;
- }
- sendRequest(request) {
- this.addUserAgentHeader(request);
- return this._nextPolicy.sendRequest(request);
- }
- /**
- * Adds the user agent header to the outgoing request.
- */
- addUserAgentHeader(request) {
- if (!request.headers) {
- request.headers = new HttpHeaders();
- }
- if (!request.headers.get(this.headerKey) && this.headerValue) {
- request.headers.set(this.headerKey, this.headerValue);
- }
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * The format that will be used to join an array of values together for a query parameter value.
- */
-exports.QueryCollectionFormat = void 0;
-(function (QueryCollectionFormat) {
- /**
- * CSV: Each pair of segments joined by a single comma.
- */
- QueryCollectionFormat["Csv"] = ",";
- /**
- * SSV: Each pair of segments joined by a single space character.
- */
- QueryCollectionFormat["Ssv"] = " ";
- /**
- * TSV: Each pair of segments joined by a single tab character.
- */
- QueryCollectionFormat["Tsv"] = "\t";
- /**
- * Pipes: Each pair of segments joined by a single pipe character.
- */
- QueryCollectionFormat["Pipes"] = "|";
- /**
- * Denotes this is an array of values that should be passed to the server in multiple key/value pairs, e.g. `?queryParam=value1&queryParam=value2`
- */
- QueryCollectionFormat["Multi"] = "Multi";
-})(exports.QueryCollectionFormat || (exports.QueryCollectionFormat = {}));
-
-// Copyright (c) Microsoft Corporation.
-// Default options for the cycler if none are provided
-const DEFAULT_CYCLER_OPTIONS = {
- forcedRefreshWindowInMs: 1000,
- retryIntervalInMs: 3000,
- refreshWindowInMs: 1000 * 60 * 2, // Start refreshing 2m before expiry
+ },
};
-/**
- * Converts an an unreliable access token getter (which may resolve with null)
- * into an AccessTokenGetter by retrying the unreliable getter in a regular
- * interval.
- *
- * @param getAccessToken - a function that produces a promise of an access
- * token that may fail by returning null
- * @param retryIntervalInMs - the time (in milliseconds) to wait between retry
- * attempts
- * @param timeoutInMs - the timestamp after which the refresh attempt will fail,
- * throwing an exception
- * @returns - a promise that, if it resolves, will resolve with an access token
- */
-async function beginRefresh(getAccessToken, retryIntervalInMs, timeoutInMs) {
- // This wrapper handles exceptions gracefully as long as we haven't exceeded
- // the timeout.
- async function tryGetAccessToken() {
- if (Date.now() < timeoutInMs) {
- try {
- return await getAccessToken();
- }
- catch (_a) {
- return null;
- }
- }
- else {
- const finalToken = await getAccessToken();
- // Timeout is up, so throw if it's still null
- if (finalToken === null) {
- throw new Error("Failed to refresh access token.");
- }
- return finalToken;
- }
- }
- let token = await tryGetAccessToken();
- while (token === null) {
- await coreUtil.delay(retryIntervalInMs);
- token = await tryGetAccessToken();
- }
- return token;
-}
-/**
- * Creates a token cycler from a credential, scopes, and optional settings.
- *
- * A token cycler represents a way to reliably retrieve a valid access token
- * from a TokenCredential. It will handle initializing the token, refreshing it
- * when it nears expiration, and synchronizes refresh attempts to avoid
- * concurrency hazards.
- *
- * @param credential - the underlying TokenCredential that provides the access
- * token
- * @param scopes - the scopes to request authorization for
- * @param tokenCyclerOptions - optionally override default settings for the cycler
- *
- * @returns - a function that reliably produces a valid access token
- */
-function createTokenCycler(credential, scopes, tokenCyclerOptions) {
- let refreshWorker = null;
- let token = null;
- const options = Object.assign(Object.assign({}, DEFAULT_CYCLER_OPTIONS), tokenCyclerOptions);
- /**
- * This little holder defines several predicates that we use to construct
- * the rules of refreshing the token.
- */
- const cycler = {
- /**
- * Produces true if a refresh job is currently in progress.
- */
- get isRefreshing() {
- return refreshWorker !== null;
+const BlobServiceStatistics = {
+ serializedName: "BlobServiceStatistics",
+ xmlName: "StorageServiceStats",
+ type: {
+ name: "Composite",
+ className: "BlobServiceStatistics",
+ modelProperties: {
+ geoReplication: {
+ serializedName: "GeoReplication",
+ xmlName: "GeoReplication",
+ type: {
+ name: "Composite",
+ className: "GeoReplication",
+ },
+ },
},
- /**
- * Produces true if the cycler SHOULD refresh (we are within the refresh
- * window and not already refreshing)
- */
- get shouldRefresh() {
- var _a;
- return (!cycler.isRefreshing &&
- ((_a = token === null || token === void 0 ? void 0 : token.expiresOnTimestamp) !== null && _a !== void 0 ? _a : 0) - options.refreshWindowInMs < Date.now());
+ },
+};
+const GeoReplication = {
+ serializedName: "GeoReplication",
+ type: {
+ name: "Composite",
+ className: "GeoReplication",
+ modelProperties: {
+ status: {
+ serializedName: "Status",
+ required: true,
+ xmlName: "Status",
+ type: {
+ name: "Enum",
+ allowedValues: ["live", "bootstrap", "unavailable"],
+ },
+ },
+ lastSyncOn: {
+ serializedName: "LastSyncTime",
+ required: true,
+ xmlName: "LastSyncTime",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
},
- /**
- * Produces true if the cycler MUST refresh (null or nearly-expired
- * token).
- */
- get mustRefresh() {
- return (token === null || token.expiresOnTimestamp - options.forcedRefreshWindowInMs < Date.now());
+ },
+};
+const ListContainersSegmentResponse = {
+ serializedName: "ListContainersSegmentResponse",
+ xmlName: "EnumerationResults",
+ type: {
+ name: "Composite",
+ className: "ListContainersSegmentResponse",
+ modelProperties: {
+ serviceEndpoint: {
+ serializedName: "ServiceEndpoint",
+ required: true,
+ xmlName: "ServiceEndpoint",
+ xmlIsAttribute: true,
+ type: {
+ name: "String",
+ },
+ },
+ prefix: {
+ serializedName: "Prefix",
+ xmlName: "Prefix",
+ type: {
+ name: "String",
+ },
+ },
+ marker: {
+ serializedName: "Marker",
+ xmlName: "Marker",
+ type: {
+ name: "String",
+ },
+ },
+ maxPageSize: {
+ serializedName: "MaxResults",
+ xmlName: "MaxResults",
+ type: {
+ name: "Number",
+ },
+ },
+ containerItems: {
+ serializedName: "ContainerItems",
+ required: true,
+ xmlName: "Containers",
+ xmlIsWrapped: true,
+ xmlElementName: "Container",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "ContainerItem",
+ },
+ },
+ },
+ },
+ continuationToken: {
+ serializedName: "NextMarker",
+ xmlName: "NextMarker",
+ type: {
+ name: "String",
+ },
+ },
},
- };
- /**
- * Starts a refresh job or returns the existing job if one is already
- * running.
- */
- function refresh(getTokenOptions) {
- var _a;
- if (!cycler.isRefreshing) {
- // We bind `scopes` here to avoid passing it around a lot
- const tryGetAccessToken = () => credential.getToken(scopes, getTokenOptions);
- // Take advantage of promise chaining to insert an assignment to `token`
- // before the refresh can be considered done.
- refreshWorker = beginRefresh(tryGetAccessToken, options.retryIntervalInMs,
- // If we don't have a token, then we should timeout immediately
- (_a = token === null || token === void 0 ? void 0 : token.expiresOnTimestamp) !== null && _a !== void 0 ? _a : Date.now())
- .then((_token) => {
- refreshWorker = null;
- token = _token;
- return token;
- })
- .catch((reason) => {
- // We also should reset the refresher if we enter a failed state. All
- // existing awaiters will throw, but subsequent requests will start a
- // new retry chain.
- refreshWorker = null;
- token = null;
- throw reason;
- });
- }
- return refreshWorker;
- }
- return async (tokenOptions) => {
- //
- // Simple rules:
- // - If we MUST refresh, then return the refresh task, blocking
- // the pipeline until a token is available.
- // - If we SHOULD refresh, then run refresh but don't return it
- // (we can still use the cached token).
- // - Return the token, since it's fine if we didn't return in
- // step 1.
- //
- if (cycler.mustRefresh)
- return refresh(tokenOptions);
- if (cycler.shouldRefresh) {
- refresh(tokenOptions);
- }
- return token;
- };
-}
-// #endregion
-/**
- * Creates a new factory for a RequestPolicy that applies a bearer token to
- * the requests' `Authorization` headers.
- *
- * @param credential - The TokenCredential implementation that can supply the bearer token.
- * @param scopes - The scopes for which the bearer token applies.
- */
-function bearerTokenAuthenticationPolicy(credential, scopes) {
- // This simple function encapsulates the entire process of reliably retrieving the token
- const getToken = createTokenCycler(credential, scopes /* , options */);
- class BearerTokenAuthenticationPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options) {
- super(nextPolicy, options);
- }
- async sendRequest(webResource) {
- if (!webResource.url.toLowerCase().startsWith("https://")) {
- throw new Error("Bearer token authentication is not permitted for non-TLS protected (non-https) URLs.");
- }
- const { token } = await getToken({
- abortSignal: webResource.abortSignal,
- tracingOptions: {
- tracingContext: webResource.tracingContext,
+ },
+};
+const ContainerItem = {
+ serializedName: "ContainerItem",
+ xmlName: "Container",
+ type: {
+ name: "Composite",
+ className: "ContainerItem",
+ modelProperties: {
+ name: {
+ serializedName: "Name",
+ required: true,
+ xmlName: "Name",
+ type: {
+ name: "String",
},
- });
- webResource.headers.set(Constants.HeaderConstants.AUTHORIZATION, `Bearer ${token}`);
- return this._nextPolicy.sendRequest(webResource);
- }
- }
- return {
- create: (nextPolicy, options) => {
- return new BearerTokenAuthenticationPolicy(nextPolicy, options);
+ },
+ deleted: {
+ serializedName: "Deleted",
+ xmlName: "Deleted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ version: {
+ serializedName: "Version",
+ xmlName: "Version",
+ type: {
+ name: "String",
+ },
+ },
+ properties: {
+ serializedName: "Properties",
+ xmlName: "Properties",
+ type: {
+ name: "Composite",
+ className: "ContainerProperties",
+ },
+ },
+ metadata: {
+ serializedName: "Metadata",
+ xmlName: "Metadata",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
},
- };
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Returns a request policy factory that can be used to create an instance of
- * {@link DisableResponseDecompressionPolicy}.
- */
-function disableResponseDecompressionPolicy() {
- return {
- create: (nextPolicy, options) => {
- return new DisableResponseDecompressionPolicy(nextPolicy, options);
+ },
+};
+const ContainerProperties = {
+ serializedName: "ContainerProperties",
+ type: {
+ name: "Composite",
+ className: "ContainerProperties",
+ modelProperties: {
+ lastModified: {
+ serializedName: "Last-Modified",
+ required: true,
+ xmlName: "Last-Modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ etag: {
+ serializedName: "Etag",
+ required: true,
+ xmlName: "Etag",
+ type: {
+ name: "String",
+ },
+ },
+ leaseStatus: {
+ serializedName: "LeaseStatus",
+ xmlName: "LeaseStatus",
+ type: {
+ name: "Enum",
+ allowedValues: ["locked", "unlocked"],
+ },
+ },
+ leaseState: {
+ serializedName: "LeaseState",
+ xmlName: "LeaseState",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken",
+ ],
+ },
+ },
+ leaseDuration: {
+ serializedName: "LeaseDuration",
+ xmlName: "LeaseDuration",
+ type: {
+ name: "Enum",
+ allowedValues: ["infinite", "fixed"],
+ },
+ },
+ publicAccess: {
+ serializedName: "PublicAccess",
+ xmlName: "PublicAccess",
+ type: {
+ name: "Enum",
+ allowedValues: ["container", "blob"],
+ },
+ },
+ hasImmutabilityPolicy: {
+ serializedName: "HasImmutabilityPolicy",
+ xmlName: "HasImmutabilityPolicy",
+ type: {
+ name: "Boolean",
+ },
+ },
+ hasLegalHold: {
+ serializedName: "HasLegalHold",
+ xmlName: "HasLegalHold",
+ type: {
+ name: "Boolean",
+ },
+ },
+ defaultEncryptionScope: {
+ serializedName: "DefaultEncryptionScope",
+ xmlName: "DefaultEncryptionScope",
+ type: {
+ name: "String",
+ },
+ },
+ preventEncryptionScopeOverride: {
+ serializedName: "DenyEncryptionScopeOverride",
+ xmlName: "DenyEncryptionScopeOverride",
+ type: {
+ name: "Boolean",
+ },
+ },
+ deletedOn: {
+ serializedName: "DeletedTime",
+ xmlName: "DeletedTime",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ remainingRetentionDays: {
+ serializedName: "RemainingRetentionDays",
+ xmlName: "RemainingRetentionDays",
+ type: {
+ name: "Number",
+ },
+ },
+ isImmutableStorageWithVersioningEnabled: {
+ serializedName: "ImmutableStorageWithVersioningEnabled",
+ xmlName: "ImmutableStorageWithVersioningEnabled",
+ type: {
+ name: "Boolean",
+ },
+ },
},
- };
-}
-/**
- * A policy to disable response decompression according to Accept-Encoding header
- * https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Encoding
- */
-class DisableResponseDecompressionPolicy extends BaseRequestPolicy {
- /**
- * Creates an instance of DisableResponseDecompressionPolicy.
- *
- * @param nextPolicy -
- * @param options -
- */
- // The parent constructor is protected.
- /* eslint-disable-next-line @typescript-eslint/no-useless-constructor */
- constructor(nextPolicy, options) {
- super(nextPolicy, options);
- }
- /**
- * Sends out request.
- *
- * @param request -
- * @returns
- */
- async sendRequest(request) {
- request.decompressResponse = false;
- return this._nextPolicy.sendRequest(request);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Creates a policy that assigns a unique request id to outgoing requests.
- * @param requestIdHeaderName - The name of the header to use when assigning the unique id to the request.
- */
-function generateClientRequestIdPolicy(requestIdHeaderName = "x-ms-client-request-id") {
- return {
- create: (nextPolicy, options) => {
- return new GenerateClientRequestIdPolicy(nextPolicy, options, requestIdHeaderName);
+ },
+};
+const KeyInfo = {
+ serializedName: "KeyInfo",
+ type: {
+ name: "Composite",
+ className: "KeyInfo",
+ modelProperties: {
+ startsOn: {
+ serializedName: "Start",
+ required: true,
+ xmlName: "Start",
+ type: {
+ name: "String",
+ },
+ },
+ expiresOn: {
+ serializedName: "Expiry",
+ required: true,
+ xmlName: "Expiry",
+ type: {
+ name: "String",
+ },
+ },
},
- };
-}
-class GenerateClientRequestIdPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, _requestIdHeaderName) {
- super(nextPolicy, options);
- this._requestIdHeaderName = _requestIdHeaderName;
- }
- sendRequest(request) {
- if (!request.headers.contains(this._requestIdHeaderName)) {
- request.headers.set(this._requestIdHeaderName, request.requestId);
- }
- return this._nextPolicy.sendRequest(request);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-let cachedHttpClient;
-function getCachedDefaultHttpClient() {
- if (!cachedHttpClient) {
- cachedHttpClient = new NodeFetchHttpClient();
- }
- return cachedHttpClient;
-}
-
-// Copyright (c) Microsoft Corporation.
-function ndJsonPolicy() {
- return {
- create: (nextPolicy, options) => {
- return new NdJsonPolicy(nextPolicy, options);
+ },
+};
+const UserDelegationKey = {
+ serializedName: "UserDelegationKey",
+ type: {
+ name: "Composite",
+ className: "UserDelegationKey",
+ modelProperties: {
+ signedObjectId: {
+ serializedName: "SignedOid",
+ required: true,
+ xmlName: "SignedOid",
+ type: {
+ name: "String",
+ },
+ },
+ signedTenantId: {
+ serializedName: "SignedTid",
+ required: true,
+ xmlName: "SignedTid",
+ type: {
+ name: "String",
+ },
+ },
+ signedStartsOn: {
+ serializedName: "SignedStart",
+ required: true,
+ xmlName: "SignedStart",
+ type: {
+ name: "String",
+ },
+ },
+ signedExpiresOn: {
+ serializedName: "SignedExpiry",
+ required: true,
+ xmlName: "SignedExpiry",
+ type: {
+ name: "String",
+ },
+ },
+ signedService: {
+ serializedName: "SignedService",
+ required: true,
+ xmlName: "SignedService",
+ type: {
+ name: "String",
+ },
+ },
+ signedVersion: {
+ serializedName: "SignedVersion",
+ required: true,
+ xmlName: "SignedVersion",
+ type: {
+ name: "String",
+ },
+ },
+ value: {
+ serializedName: "Value",
+ required: true,
+ xmlName: "Value",
+ type: {
+ name: "String",
+ },
+ },
},
- };
-}
-/**
- * NdJsonPolicy that formats a JSON array as newline-delimited JSON
- */
-class NdJsonPolicy extends BaseRequestPolicy {
- /**
- * Creates an instance of KeepAlivePolicy.
- */
- constructor(nextPolicy, options) {
- super(nextPolicy, options);
- }
- /**
- * Sends a request.
- */
- async sendRequest(request) {
- // There currently isn't a good way to bypass the serializer
- if (typeof request.body === "string" && request.body.startsWith("[")) {
- const body = JSON.parse(request.body);
- if (Array.isArray(body)) {
- request.body = body.map((item) => JSON.stringify(item) + "\n").join("");
- }
- }
- return this._nextPolicy.sendRequest(request);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Stores the patterns specified in NO_PROXY environment variable.
- * @internal
- */
-const globalNoProxyList = [];
-let noProxyListLoaded = false;
-/** A cache of whether a host should bypass the proxy. */
-const globalBypassedMap = new Map();
-function loadEnvironmentProxyValue() {
- if (!process) {
- return undefined;
- }
- const httpsProxy = getEnvironmentValue(Constants.HTTPS_PROXY);
- const allProxy = getEnvironmentValue(Constants.ALL_PROXY);
- const httpProxy = getEnvironmentValue(Constants.HTTP_PROXY);
- return httpsProxy || allProxy || httpProxy;
-}
-/**
- * Check whether the host of a given `uri` matches any pattern in the no proxy list.
- * If there's a match, any request sent to the same host shouldn't have the proxy settings set.
- * This implementation is a port of https://github.com/Azure/azure-sdk-for-net/blob/8cca811371159e527159c7eb65602477898683e2/sdk/core/Azure.Core/src/Pipeline/Internal/HttpEnvironmentProxy.cs#L210
- */
-function isBypassed(uri, noProxyList, bypassedMap) {
- if (noProxyList.length === 0) {
- return false;
- }
- const host = URLBuilder.parse(uri).getHost();
- if (bypassedMap === null || bypassedMap === void 0 ? void 0 : bypassedMap.has(host)) {
- return bypassedMap.get(host);
- }
- let isBypassedFlag = false;
- for (const pattern of noProxyList) {
- if (pattern[0] === ".") {
- // This should match either domain it self or any subdomain or host
- // .foo.com will match foo.com it self or *.foo.com
- if (host.endsWith(pattern)) {
- isBypassedFlag = true;
- }
- else {
- if (host.length === pattern.length - 1 && host === pattern.slice(1)) {
- isBypassedFlag = true;
- }
- }
- }
- else {
- if (host === pattern) {
- isBypassedFlag = true;
- }
- }
- }
- bypassedMap === null || bypassedMap === void 0 ? void 0 : bypassedMap.set(host, isBypassedFlag);
- return isBypassedFlag;
-}
-/**
- * @internal
- */
-function loadNoProxy() {
- const noProxy = getEnvironmentValue(Constants.NO_PROXY);
- noProxyListLoaded = true;
- if (noProxy) {
- return noProxy
- .split(",")
- .map((item) => item.trim())
- .filter((item) => item.length);
- }
- return [];
-}
-/**
- * Converts a given URL of a proxy server into `ProxySettings` or attempts to retrieve `ProxySettings` from the current environment if one is not passed.
- * @param proxyUrl - URL of the proxy
- * @returns The default proxy settings, or undefined.
- */
-function getDefaultProxySettings(proxyUrl) {
- if (!proxyUrl) {
- proxyUrl = loadEnvironmentProxyValue();
- if (!proxyUrl) {
- return undefined;
- }
- }
- const { username, password, urlWithoutAuth } = extractAuthFromUrl(proxyUrl);
- const parsedUrl = URLBuilder.parse(urlWithoutAuth);
- const schema = parsedUrl.getScheme() ? parsedUrl.getScheme() + "://" : "";
- return {
- host: schema + parsedUrl.getHost(),
- port: Number.parseInt(parsedUrl.getPort() || "80"),
- username,
- password,
- };
-}
-/**
- * A policy that allows one to apply proxy settings to all requests.
- * If not passed static settings, they will be retrieved from the HTTPS_PROXY
- * or HTTP_PROXY environment variables.
- * @param proxySettings - ProxySettings to use on each request.
- * @param options - additional settings, for example, custom NO_PROXY patterns
- */
-function proxyPolicy(proxySettings, options) {
- if (!proxySettings) {
- proxySettings = getDefaultProxySettings();
- }
- if (!noProxyListLoaded) {
- globalNoProxyList.push(...loadNoProxy());
- }
- return {
- create: (nextPolicy, requestPolicyOptions) => {
- return new ProxyPolicy(nextPolicy, requestPolicyOptions, proxySettings, options === null || options === void 0 ? void 0 : options.customNoProxyList);
+ },
+};
+const FilterBlobSegment = {
+ serializedName: "FilterBlobSegment",
+ xmlName: "EnumerationResults",
+ type: {
+ name: "Composite",
+ className: "FilterBlobSegment",
+ modelProperties: {
+ serviceEndpoint: {
+ serializedName: "ServiceEndpoint",
+ required: true,
+ xmlName: "ServiceEndpoint",
+ xmlIsAttribute: true,
+ type: {
+ name: "String",
+ },
+ },
+ where: {
+ serializedName: "Where",
+ required: true,
+ xmlName: "Where",
+ type: {
+ name: "String",
+ },
+ },
+ blobs: {
+ serializedName: "Blobs",
+ required: true,
+ xmlName: "Blobs",
+ xmlIsWrapped: true,
+ xmlElementName: "Blob",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "FilterBlobItem",
+ },
+ },
+ },
+ },
+ continuationToken: {
+ serializedName: "NextMarker",
+ xmlName: "NextMarker",
+ type: {
+ name: "String",
+ },
+ },
},
- };
-}
-function extractAuthFromUrl(url) {
- const atIndex = url.indexOf("@");
- if (atIndex === -1) {
- return { urlWithoutAuth: url };
- }
- const schemeIndex = url.indexOf("://");
- const authStart = schemeIndex !== -1 ? schemeIndex + 3 : 0;
- const auth = url.substring(authStart, atIndex);
- const colonIndex = auth.indexOf(":");
- const hasPassword = colonIndex !== -1;
- const username = hasPassword ? auth.substring(0, colonIndex) : auth;
- const password = hasPassword ? auth.substring(colonIndex + 1) : undefined;
- const urlWithoutAuth = url.substring(0, authStart) + url.substring(atIndex + 1);
- return {
- username,
- password,
- urlWithoutAuth,
- };
-}
-class ProxyPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, proxySettings, customNoProxyList) {
- super(nextPolicy, options);
- this.proxySettings = proxySettings;
- this.customNoProxyList = customNoProxyList;
- }
- sendRequest(request) {
- var _a;
- if (!request.proxySettings &&
- !isBypassed(request.url, (_a = this.customNoProxyList) !== null && _a !== void 0 ? _a : globalNoProxyList, this.customNoProxyList ? undefined : globalBypassedMap)) {
- request.proxySettings = this.proxySettings;
- }
- return this._nextPolicy.sendRequest(request);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-function rpRegistrationPolicy(retryTimeout = 30) {
- return {
- create: (nextPolicy, options) => {
- return new RPRegistrationPolicy(nextPolicy, options, retryTimeout);
+ },
+};
+const FilterBlobItem = {
+ serializedName: "FilterBlobItem",
+ xmlName: "Blob",
+ type: {
+ name: "Composite",
+ className: "FilterBlobItem",
+ modelProperties: {
+ name: {
+ serializedName: "Name",
+ required: true,
+ xmlName: "Name",
+ type: {
+ name: "String",
+ },
+ },
+ containerName: {
+ serializedName: "ContainerName",
+ required: true,
+ xmlName: "ContainerName",
+ type: {
+ name: "String",
+ },
+ },
+ tags: {
+ serializedName: "Tags",
+ xmlName: "Tags",
+ type: {
+ name: "Composite",
+ className: "BlobTags",
+ },
+ },
},
- };
-}
-class RPRegistrationPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, _retryTimeout = 30) {
- super(nextPolicy, options);
- this._retryTimeout = _retryTimeout;
- }
- sendRequest(request) {
- return this._nextPolicy
- .sendRequest(request.clone())
- .then((response) => registerIfNeeded(this, request, response));
- }
-}
-function registerIfNeeded(policy, request, response) {
- if (response.status === 409) {
- const rpName = checkRPNotRegisteredError(response.bodyAsText);
- if (rpName) {
- const urlPrefix = extractSubscriptionUrl(request.url);
- return (registerRP(policy, urlPrefix, rpName, request)
- // Autoregistration of ${provider} failed for some reason. We will not return this error
- // instead will return the initial response with 409 status code back to the user.
- // do nothing here as we are returning the original response at the end of this method.
- .catch(() => false)
- .then((registrationStatus) => {
- if (registrationStatus) {
- // Retry the original request. We have to change the x-ms-client-request-id
- // otherwise Azure endpoint will return the initial 409 (cached) response.
- request.headers.set("x-ms-client-request-id", generateUuid());
- return policy._nextPolicy.sendRequest(request.clone());
- }
- return response;
- }));
- }
- }
- return Promise.resolve(response);
-}
-/**
- * Reuses the headers of the original request and url (if specified).
- * @param originalRequest - The original request
- * @param reuseUrlToo - Should the url from the original request be reused as well. Default false.
- * @returns A new request object with desired headers.
- */
-function getRequestEssentials(originalRequest, reuseUrlToo = false) {
- const reqOptions = originalRequest.clone();
- if (reuseUrlToo) {
- reqOptions.url = originalRequest.url;
- }
- // We have to change the x-ms-client-request-id otherwise Azure endpoint
- // will return the initial 409 (cached) response.
- reqOptions.headers.set("x-ms-client-request-id", generateUuid());
- // Set content-type to application/json
- reqOptions.headers.set("Content-Type", "application/json; charset=utf-8");
- return reqOptions;
-}
-/**
- * Validates the error code and message associated with 409 response status code. If it matches to that of
- * RP not registered then it returns the name of the RP else returns undefined.
- * @param body - The response body received after making the original request.
- * @returns The name of the RP if condition is satisfied else undefined.
- */
-function checkRPNotRegisteredError(body) {
- let result, responseBody;
- if (body) {
- try {
- responseBody = JSON.parse(body);
- }
- catch (err) {
- // do nothing;
- }
- if (responseBody &&
- responseBody.error &&
- responseBody.error.message &&
- responseBody.error.code &&
- responseBody.error.code === "MissingSubscriptionRegistration") {
- const matchRes = responseBody.error.message.match(/.*'(.*)'/i);
- if (matchRes) {
- result = matchRes.pop();
- }
- }
- }
- return result;
-}
-/**
- * Extracts the first part of the URL, just after subscription:
- * https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/
- * @param url - The original request url
- * @returns The url prefix as explained above.
- */
-function extractSubscriptionUrl(url) {
- let result;
- const matchRes = url.match(/.*\/subscriptions\/[a-f0-9-]+\//gi);
- if (matchRes && matchRes[0]) {
- result = matchRes[0];
- }
- else {
- throw new Error(`Unable to extract subscriptionId from the given url - ${url}.`);
- }
- return result;
-}
-/**
- * Registers the given provider.
- * @param policy - The RPRegistrationPolicy this function is being called against.
- * @param urlPrefix - https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/
- * @param provider - The provider name to be registered.
- * @param originalRequest - The original request sent by the user that returned a 409 response
- * with a message that the provider is not registered.
- */
-async function registerRP(policy, urlPrefix, provider, originalRequest) {
- const postUrl = `${urlPrefix}providers/${provider}/register?api-version=2016-02-01`;
- const getUrl = `${urlPrefix}providers/${provider}?api-version=2016-02-01`;
- const reqOptions = getRequestEssentials(originalRequest);
- reqOptions.method = "POST";
- reqOptions.url = postUrl;
- const response = await policy._nextPolicy.sendRequest(reqOptions);
- if (response.status !== 200) {
- throw new Error(`Autoregistration of ${provider} failed. Please try registering manually.`);
- }
- return getRegistrationStatus(policy, getUrl, originalRequest);
-}
-/**
- * Polls the registration status of the provider that was registered. Polling happens at an interval of 30 seconds.
- * Polling will happen till the registrationState property of the response body is "Registered".
- * @param policy - The RPRegistrationPolicy this function is being called against.
- * @param url - The request url for polling
- * @param originalRequest - The original request sent by the user that returned a 409 response
- * with a message that the provider is not registered.
- * @returns True if RP Registration is successful.
- */
-async function getRegistrationStatus(policy, url, originalRequest) {
- const reqOptions = getRequestEssentials(originalRequest);
- reqOptions.url = url;
- reqOptions.method = "GET";
- const res = await policy._nextPolicy.sendRequest(reqOptions);
- const obj = res.parsedBody;
- if (res.parsedBody && obj.registrationState && obj.registrationState === "Registered") {
- return true;
- }
- else {
- await coreUtil.delay(policy._retryTimeout * 1000);
- return getRegistrationStatus(policy, url, originalRequest);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Creates a policy that signs outgoing requests by calling to the provided `authenticationProvider`'s `signRequest` method.
- * @param authenticationProvider - The authentication provider.
- * @returns An instance of the {@link SigningPolicy}.
- */
-function signingPolicy(authenticationProvider) {
- return {
- create: (nextPolicy, options) => {
- return new SigningPolicy(nextPolicy, options, authenticationProvider);
+ },
+};
+const BlobTags = {
+ serializedName: "BlobTags",
+ xmlName: "Tags",
+ type: {
+ name: "Composite",
+ className: "BlobTags",
+ modelProperties: {
+ blobTagSet: {
+ serializedName: "BlobTagSet",
+ required: true,
+ xmlName: "TagSet",
+ xmlIsWrapped: true,
+ xmlElementName: "Tag",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "BlobTag",
+ },
+ },
+ },
+ },
},
- };
-}
-/**
- * A policy that signs outgoing requests by calling to the provided `authenticationProvider`'s `signRequest` method.
- */
-class SigningPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, authenticationProvider) {
- super(nextPolicy, options);
- this.authenticationProvider = authenticationProvider;
- }
- signRequest(request) {
- return this.authenticationProvider.signRequest(request);
- }
- sendRequest(request) {
- return this.signRequest(request).then((nextRequest) => this._nextPolicy.sendRequest(nextRequest));
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * A policy that retries when there's a system error, identified by the codes "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" or "ENOENT".
- * @param retryCount - Maximum number of retries.
- * @param retryInterval - The client retry interval, in milliseconds.
- * @param minRetryInterval - The minimum retry interval, in milliseconds.
- * @param maxRetryInterval - The maximum retry interval, in milliseconds.
- * @returns An instance of the {@link SystemErrorRetryPolicy}
- */
-function systemErrorRetryPolicy(retryCount, retryInterval, minRetryInterval, maxRetryInterval) {
- return {
- create: (nextPolicy, options) => {
- return new SystemErrorRetryPolicy(nextPolicy, options, retryCount, retryInterval, minRetryInterval, maxRetryInterval);
+ },
+};
+const BlobTag = {
+ serializedName: "BlobTag",
+ xmlName: "Tag",
+ type: {
+ name: "Composite",
+ className: "BlobTag",
+ modelProperties: {
+ key: {
+ serializedName: "Key",
+ required: true,
+ xmlName: "Key",
+ type: {
+ name: "String",
+ },
+ },
+ value: {
+ serializedName: "Value",
+ required: true,
+ xmlName: "Value",
+ type: {
+ name: "String",
+ },
+ },
},
- };
-}
-/**
- * A policy that retries when there's a system error, identified by the codes "ETIMEDOUT", "ESOCKETTIMEDOUT", "ECONNREFUSED", "ECONNRESET" or "ENOENT".
- * @param retryCount - The client retry count.
- * @param retryInterval - The client retry interval, in milliseconds.
- * @param minRetryInterval - The minimum retry interval, in milliseconds.
- * @param maxRetryInterval - The maximum retry interval, in milliseconds.
- */
-class SystemErrorRetryPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, retryCount, retryInterval, minRetryInterval, maxRetryInterval) {
- super(nextPolicy, options);
- this.retryCount = isNumber(retryCount) ? retryCount : DEFAULT_CLIENT_RETRY_COUNT;
- this.retryInterval = isNumber(retryInterval) ? retryInterval : DEFAULT_CLIENT_RETRY_INTERVAL;
- this.minRetryInterval = isNumber(minRetryInterval)
- ? minRetryInterval
- : DEFAULT_CLIENT_MIN_RETRY_INTERVAL;
- this.maxRetryInterval = isNumber(maxRetryInterval)
- ? maxRetryInterval
- : DEFAULT_CLIENT_MAX_RETRY_INTERVAL;
- }
- sendRequest(request) {
- return this._nextPolicy
- .sendRequest(request.clone())
- .catch((error) => retry(this, request, error.response, error));
- }
-}
-async function retry(policy, request, operationResponse, err, retryData) {
- retryData = updateRetryData(policy, retryData, err);
- function shouldPolicyRetry(_response, error) {
- if (error &&
- error.code &&
- (error.code === "ETIMEDOUT" ||
- error.code === "ESOCKETTIMEDOUT" ||
- error.code === "ECONNREFUSED" ||
- error.code === "ECONNRESET" ||
- error.code === "ENOENT")) {
- return true;
- }
- return false;
- }
- if (shouldRetry(policy.retryCount, shouldPolicyRetry, retryData, operationResponse, err)) {
- // If previous operation ended with an error and the policy allows a retry, do that
- try {
- await coreUtil.delay(retryData.retryInterval);
- return policy._nextPolicy.sendRequest(request.clone());
- }
- catch (nestedErr) {
- return retry(policy, request, operationResponse, nestedErr, retryData);
- }
- }
- else {
- if (err) {
- // If the operation failed in the end, return all errors instead of just the last one
- return Promise.reject(retryData.error);
- }
- return operationResponse;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Maximum number of retries for the throttling retry policy
- */
-const DEFAULT_CLIENT_MAX_RETRY_COUNT = 3;
-
-// Copyright (c) Microsoft Corporation.
-const StatusCodes = Constants.HttpConstants.StatusCodes;
-/**
- * Creates a policy that re-sends the request if the response indicates the request failed because of throttling reasons.
- * For example, if the response contains a `Retry-After` header, it will retry sending the request based on the value of that header.
- *
- * To learn more, please refer to
- * https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits,
- * https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits and
- * https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
- * @returns
- */
-function throttlingRetryPolicy() {
- return {
- create: (nextPolicy, options) => {
- return new ThrottlingRetryPolicy(nextPolicy, options);
+ },
+};
+const SignedIdentifier = {
+ serializedName: "SignedIdentifier",
+ xmlName: "SignedIdentifier",
+ type: {
+ name: "Composite",
+ className: "SignedIdentifier",
+ modelProperties: {
+ id: {
+ serializedName: "Id",
+ required: true,
+ xmlName: "Id",
+ type: {
+ name: "String",
+ },
+ },
+ accessPolicy: {
+ serializedName: "AccessPolicy",
+ xmlName: "AccessPolicy",
+ type: {
+ name: "Composite",
+ className: "AccessPolicy",
+ },
+ },
},
- };
-}
-const StandardAbortMessage = "The operation was aborted.";
-/**
- * Creates a policy that re-sends the request if the response indicates the request failed because of throttling reasons.
- * For example, if the response contains a `Retry-After` header, it will retry sending the request based on the value of that header.
- *
- * To learn more, please refer to
- * https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-request-limits,
- * https://docs.microsoft.com/en-us/azure/azure-subscription-service-limits and
- * https://docs.microsoft.com/en-us/azure/virtual-machines/troubleshooting/troubleshooting-throttling-errors
- */
-class ThrottlingRetryPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, _handleResponse) {
- super(nextPolicy, options);
- this.numberOfRetries = 0;
- this._handleResponse = _handleResponse || this._defaultResponseHandler;
- }
- async sendRequest(httpRequest) {
- const response = await this._nextPolicy.sendRequest(httpRequest.clone());
- if (response.status !== StatusCodes.TooManyRequests &&
- response.status !== StatusCodes.ServiceUnavailable) {
- return response;
- }
- else {
- return this._handleResponse(httpRequest, response);
- }
- }
- async _defaultResponseHandler(httpRequest, httpResponse) {
- var _a;
- const retryAfterHeader = httpResponse.headers.get(Constants.HeaderConstants.RETRY_AFTER);
- if (retryAfterHeader) {
- const delayInMs = ThrottlingRetryPolicy.parseRetryAfterHeader(retryAfterHeader);
- if (delayInMs) {
- this.numberOfRetries += 1;
- await coreUtil.delay(delayInMs, {
- abortSignal: httpRequest.abortSignal,
- abortErrorMsg: StandardAbortMessage,
- });
- if ((_a = httpRequest.abortSignal) === null || _a === void 0 ? void 0 : _a.aborted) {
- throw new abortController.AbortError(StandardAbortMessage);
- }
- if (this.numberOfRetries < DEFAULT_CLIENT_MAX_RETRY_COUNT) {
- return this.sendRequest(httpRequest);
- }
- else {
- return this._nextPolicy.sendRequest(httpRequest);
- }
- }
- }
- return httpResponse;
- }
- static parseRetryAfterHeader(headerValue) {
- const retryAfterInSeconds = Number(headerValue);
- if (Number.isNaN(retryAfterInSeconds)) {
- return ThrottlingRetryPolicy.parseDateRetryAfterHeader(headerValue);
- }
- else {
- return retryAfterInSeconds * 1000;
- }
- }
- static parseDateRetryAfterHeader(headerValue) {
- try {
- const now = Date.now();
- const date = Date.parse(headerValue);
- const diff = date - now;
- return Number.isNaN(diff) ? undefined : diff;
- }
- catch (error) {
- return undefined;
- }
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-const createSpan = coreTracing.createSpanFunction({
- packagePrefix: "",
- namespace: "",
-});
-/**
- * Creates a policy that wraps outgoing requests with a tracing span.
- * @param tracingOptions - Tracing options.
- * @returns An instance of the {@link TracingPolicy} class.
- */
-function tracingPolicy(tracingOptions = {}) {
- return {
- create(nextPolicy, options) {
- return new TracingPolicy(nextPolicy, options, tracingOptions);
+ },
+};
+const AccessPolicy = {
+ serializedName: "AccessPolicy",
+ type: {
+ name: "Composite",
+ className: "AccessPolicy",
+ modelProperties: {
+ startsOn: {
+ serializedName: "Start",
+ xmlName: "Start",
+ type: {
+ name: "String",
+ },
+ },
+ expiresOn: {
+ serializedName: "Expiry",
+ xmlName: "Expiry",
+ type: {
+ name: "String",
+ },
+ },
+ permissions: {
+ serializedName: "Permission",
+ xmlName: "Permission",
+ type: {
+ name: "String",
+ },
+ },
},
- };
-}
-/**
- * A policy that wraps outgoing requests with a tracing span.
- */
-class TracingPolicy extends BaseRequestPolicy {
- constructor(nextPolicy, options, tracingOptions) {
- super(nextPolicy, options);
- this.userAgent = tracingOptions.userAgent;
- }
- async sendRequest(request) {
- if (!request.tracingContext) {
- return this._nextPolicy.sendRequest(request);
- }
- const span = this.tryCreateSpan(request);
- if (!span) {
- return this._nextPolicy.sendRequest(request);
- }
- try {
- const response = await this._nextPolicy.sendRequest(request);
- this.tryProcessResponse(span, response);
- return response;
- }
- catch (err) {
- this.tryProcessError(span, err);
- throw err;
- }
- }
- tryCreateSpan(request) {
- var _a;
- try {
- // Passing spanOptions as part of tracingOptions to maintain compatibility @azure/core-tracing@preview.13 and earlier.
- // We can pass this as a separate parameter once we upgrade to the latest core-tracing.
- const { span } = createSpan(`HTTP ${request.method}`, {
- tracingOptions: {
- spanOptions: Object.assign(Object.assign({}, request.spanOptions), { kind: coreTracing.SpanKind.CLIENT }),
- tracingContext: request.tracingContext,
+ },
+};
+const ListBlobsFlatSegmentResponse = {
+ serializedName: "ListBlobsFlatSegmentResponse",
+ xmlName: "EnumerationResults",
+ type: {
+ name: "Composite",
+ className: "ListBlobsFlatSegmentResponse",
+ modelProperties: {
+ serviceEndpoint: {
+ serializedName: "ServiceEndpoint",
+ required: true,
+ xmlName: "ServiceEndpoint",
+ xmlIsAttribute: true,
+ type: {
+ name: "String",
},
- });
- // If the span is not recording, don't do any more work.
- if (!span.isRecording()) {
- span.end();
- return undefined;
- }
- const namespaceFromContext = (_a = request.tracingContext) === null || _a === void 0 ? void 0 : _a.getValue(Symbol.for("az.namespace"));
- if (typeof namespaceFromContext === "string") {
- span.setAttribute("az.namespace", namespaceFromContext);
- }
- span.setAttributes({
- "http.method": request.method,
- "http.url": request.url,
- requestId: request.requestId,
- });
- if (this.userAgent) {
- span.setAttribute("http.user_agent", this.userAgent);
- }
- // set headers
- const spanContext = span.spanContext();
- const traceParentHeader = coreTracing.getTraceParentHeader(spanContext);
- if (traceParentHeader && coreTracing.isSpanContextValid(spanContext)) {
- request.headers.set("traceparent", traceParentHeader);
- const traceState = spanContext.traceState && spanContext.traceState.serialize();
- // if tracestate is set, traceparent MUST be set, so only set tracestate after traceparent
- if (traceState) {
- request.headers.set("tracestate", traceState);
- }
- }
- return span;
- }
- catch (error) {
- logger.warning(`Skipping creating a tracing span due to an error: ${error.message}`);
- return undefined;
- }
- }
- tryProcessError(span, err) {
- try {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: err.message,
- });
- if (err.statusCode) {
- span.setAttribute("http.status_code", err.statusCode);
- }
- span.end();
- }
- catch (error) {
- logger.warning(`Skipping tracing span processing due to an error: ${error.message}`);
- }
- }
- tryProcessResponse(span, response) {
- try {
- span.setAttribute("http.status_code", response.status);
- const serviceRequestId = response.headers.get("x-ms-request-id");
- if (serviceRequestId) {
- span.setAttribute("serviceRequestId", serviceRequestId);
- }
- span.setStatus({
- code: coreTracing.SpanStatusCode.OK,
- });
- span.end();
- }
- catch (error) {
- logger.warning(`Skipping tracing span processing due to an error: ${error.message}`);
- }
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * ServiceClient sends service requests and receives responses.
- */
-class ServiceClient {
- /**
- * The ServiceClient constructor
- * @param credentials - The credentials used for authentication with the service.
- * @param options - The service client options that govern the behavior of the client.
- */
- constructor(credentials,
- /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */
- options) {
- if (!options) {
- options = {};
- }
- this._withCredentials = options.withCredentials || false;
- this._httpClient = options.httpClient || getCachedDefaultHttpClient();
- this._requestPolicyOptions = new RequestPolicyOptions(options.httpPipelineLogger);
- let requestPolicyFactories;
- if (Array.isArray(options.requestPolicyFactories)) {
- logger.info("ServiceClient: using custom request policies");
- requestPolicyFactories = options.requestPolicyFactories;
- }
- else {
- let authPolicyFactory = undefined;
- if (coreAuth.isTokenCredential(credentials)) {
- logger.info("ServiceClient: creating bearer token authentication policy from provided credentials");
- // Create a wrapped RequestPolicyFactory here so that we can provide the
- // correct scope to the BearerTokenAuthenticationPolicy at the first time
- // one is requested. This is needed because generated ServiceClient
- // implementations do not set baseUri until after ServiceClient's constructor
- // is finished, leaving baseUri empty at the time when it is needed to
- // build the correct scope name.
- const wrappedPolicyFactory = () => {
- let bearerTokenPolicyFactory = undefined;
- // eslint-disable-next-line @typescript-eslint/no-this-alias
- const serviceClient = this;
- const serviceClientOptions = options;
- return {
- create(nextPolicy, createOptions) {
- const credentialScopes = getCredentialScopes(serviceClientOptions, serviceClient.baseUri);
- if (!credentialScopes) {
- throw new Error(`When using credential, the ServiceClient must contain a baseUri or a credentialScopes in ServiceClientOptions. Unable to create a bearerTokenAuthenticationPolicy`);
- }
- if (bearerTokenPolicyFactory === undefined || bearerTokenPolicyFactory === null) {
- bearerTokenPolicyFactory = bearerTokenAuthenticationPolicy(credentials, credentialScopes);
- }
- return bearerTokenPolicyFactory.create(nextPolicy, createOptions);
+ },
+ containerName: {
+ serializedName: "ContainerName",
+ required: true,
+ xmlName: "ContainerName",
+ xmlIsAttribute: true,
+ type: {
+ name: "String",
+ },
+ },
+ prefix: {
+ serializedName: "Prefix",
+ xmlName: "Prefix",
+ type: {
+ name: "String",
+ },
+ },
+ marker: {
+ serializedName: "Marker",
+ xmlName: "Marker",
+ type: {
+ name: "String",
+ },
+ },
+ maxPageSize: {
+ serializedName: "MaxResults",
+ xmlName: "MaxResults",
+ type: {
+ name: "Number",
+ },
+ },
+ segment: {
+ serializedName: "Segment",
+ xmlName: "Blobs",
+ type: {
+ name: "Composite",
+ className: "BlobFlatListSegment",
+ },
+ },
+ continuationToken: {
+ serializedName: "NextMarker",
+ xmlName: "NextMarker",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobFlatListSegment = {
+ serializedName: "BlobFlatListSegment",
+ xmlName: "Blobs",
+ type: {
+ name: "Composite",
+ className: "BlobFlatListSegment",
+ modelProperties: {
+ blobItems: {
+ serializedName: "BlobItems",
+ required: true,
+ xmlName: "BlobItems",
+ xmlElementName: "Blob",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "BlobItemInternal",
},
- };
- };
- authPolicyFactory = wrappedPolicyFactory();
- }
- else if (credentials && typeof credentials.signRequest === "function") {
- logger.info("ServiceClient: creating signing policy from provided credentials");
- authPolicyFactory = signingPolicy(credentials);
- }
- else if (credentials !== undefined && credentials !== null) {
- throw new Error("The credentials argument must implement the TokenCredential interface");
- }
- logger.info("ServiceClient: using default request policies");
- requestPolicyFactories = createDefaultRequestPolicyFactories(authPolicyFactory, options);
- if (options.requestPolicyFactories) {
- // options.requestPolicyFactories can also be a function that manipulates
- // the default requestPolicyFactories array
- const newRequestPolicyFactories = options.requestPolicyFactories(requestPolicyFactories);
- if (newRequestPolicyFactories) {
- requestPolicyFactories = newRequestPolicyFactories;
- }
- }
- }
- this._requestPolicyFactories = requestPolicyFactories;
- }
- /**
- * Send the provided httpRequest.
- */
- sendRequest(options) {
- if (options === null || options === undefined || typeof options !== "object") {
- throw new Error("options cannot be null or undefined and it must be of type object.");
- }
- let httpRequest;
- try {
- if (isWebResourceLike(options)) {
- options.validateRequestProperties();
- httpRequest = options;
- }
- else {
- httpRequest = new WebResource();
- httpRequest = httpRequest.prepare(options);
- }
- }
- catch (error) {
- return Promise.reject(error);
- }
- let httpPipeline = this._httpClient;
- if (this._requestPolicyFactories && this._requestPolicyFactories.length > 0) {
- for (let i = this._requestPolicyFactories.length - 1; i >= 0; --i) {
- httpPipeline = this._requestPolicyFactories[i].create(httpPipeline, this._requestPolicyOptions);
- }
- }
- return httpPipeline.sendRequest(httpRequest);
- }
- /**
- * Send an HTTP request that is populated using the provided OperationSpec.
- * @param operationArguments - The arguments that the HTTP request's templated values will be populated from.
- * @param operationSpec - The OperationSpec to use to populate the httpRequest.
- * @param callback - The callback to call when the response is received.
- */
- async sendOperationRequest(operationArguments, operationSpec, callback) {
- var _a;
- if (typeof operationArguments.options === "function") {
- callback = operationArguments.options;
- operationArguments.options = undefined;
- }
- const serializerOptions = (_a = operationArguments.options) === null || _a === void 0 ? void 0 : _a.serializerOptions;
- const httpRequest = new WebResource();
- let result;
- try {
- const baseUri = operationSpec.baseUrl || this.baseUri;
- if (!baseUri) {
- throw new Error("If operationSpec.baseUrl is not specified, then the ServiceClient must have a baseUri string property that contains the base URL to use.");
- }
- httpRequest.method = operationSpec.httpMethod;
- httpRequest.operationSpec = operationSpec;
- const requestUrl = URLBuilder.parse(baseUri);
- if (operationSpec.path) {
- requestUrl.appendPath(operationSpec.path);
- }
- if (operationSpec.urlParameters && operationSpec.urlParameters.length > 0) {
- for (const urlParameter of operationSpec.urlParameters) {
- let urlParameterValue = getOperationArgumentValueFromParameter(this, operationArguments, urlParameter, operationSpec.serializer);
- urlParameterValue = operationSpec.serializer.serialize(urlParameter.mapper, urlParameterValue, getPathStringFromParameter(urlParameter), serializerOptions);
- if (!urlParameter.skipEncoding) {
- urlParameterValue = encodeURIComponent(urlParameterValue);
- }
- requestUrl.replaceAll(`{${urlParameter.mapper.serializedName || getPathStringFromParameter(urlParameter)}}`, urlParameterValue);
- }
- }
- if (operationSpec.queryParameters && operationSpec.queryParameters.length > 0) {
- for (const queryParameter of operationSpec.queryParameters) {
- let queryParameterValue = getOperationArgumentValueFromParameter(this, operationArguments, queryParameter, operationSpec.serializer);
- if (queryParameterValue !== undefined && queryParameterValue !== null) {
- queryParameterValue = operationSpec.serializer.serialize(queryParameter.mapper, queryParameterValue, getPathStringFromParameter(queryParameter), serializerOptions);
- if (queryParameter.collectionFormat !== undefined &&
- queryParameter.collectionFormat !== null) {
- if (queryParameter.collectionFormat === exports.QueryCollectionFormat.Multi) {
- if (queryParameterValue.length === 0) {
- // The collection is empty, no need to try serializing the current queryParam
- continue;
- }
- else {
- for (const index in queryParameterValue) {
- const item = queryParameterValue[index];
- queryParameterValue[index] =
- item === undefined || item === null ? "" : item.toString();
- }
- }
- }
- else if (queryParameter.collectionFormat === exports.QueryCollectionFormat.Ssv ||
- queryParameter.collectionFormat === exports.QueryCollectionFormat.Tsv) {
- queryParameterValue = queryParameterValue.join(queryParameter.collectionFormat);
- }
- }
- if (!queryParameter.skipEncoding) {
- if (Array.isArray(queryParameterValue)) {
- for (const index in queryParameterValue) {
- if (queryParameterValue[index] !== undefined &&
- queryParameterValue[index] !== null) {
- queryParameterValue[index] = encodeURIComponent(queryParameterValue[index]);
- }
- }
- }
- else {
- queryParameterValue = encodeURIComponent(queryParameterValue);
- }
- }
- if (queryParameter.collectionFormat !== undefined &&
- queryParameter.collectionFormat !== null &&
- queryParameter.collectionFormat !== exports.QueryCollectionFormat.Multi &&
- queryParameter.collectionFormat !== exports.QueryCollectionFormat.Ssv &&
- queryParameter.collectionFormat !== exports.QueryCollectionFormat.Tsv) {
- queryParameterValue = queryParameterValue.join(queryParameter.collectionFormat);
- }
- requestUrl.setQueryParameter(queryParameter.mapper.serializedName || getPathStringFromParameter(queryParameter), queryParameterValue);
- }
- }
- }
- httpRequest.url = requestUrl.toString();
- const contentType = operationSpec.contentType || this.requestContentType;
- if (contentType && operationSpec.requestBody) {
- httpRequest.headers.set("Content-Type", contentType);
- }
- if (operationSpec.headerParameters) {
- for (const headerParameter of operationSpec.headerParameters) {
- let headerValue = getOperationArgumentValueFromParameter(this, operationArguments, headerParameter, operationSpec.serializer);
- if (headerValue !== undefined && headerValue !== null) {
- headerValue = operationSpec.serializer.serialize(headerParameter.mapper, headerValue, getPathStringFromParameter(headerParameter), serializerOptions);
- const headerCollectionPrefix = headerParameter.mapper
- .headerCollectionPrefix;
- if (headerCollectionPrefix) {
- for (const key of Object.keys(headerValue)) {
- httpRequest.headers.set(headerCollectionPrefix + key, headerValue[key]);
- }
- }
- else {
- httpRequest.headers.set(headerParameter.mapper.serializedName ||
- getPathStringFromParameter(headerParameter), headerValue);
- }
- }
- }
- }
- const options = operationArguments.options;
- if (options) {
- if (options.customHeaders) {
- for (const customHeaderName in options.customHeaders) {
- httpRequest.headers.set(customHeaderName, options.customHeaders[customHeaderName]);
- }
- }
- if (options.abortSignal) {
- httpRequest.abortSignal = options.abortSignal;
- }
- if (options.timeout) {
- httpRequest.timeout = options.timeout;
- }
- if (options.onUploadProgress) {
- httpRequest.onUploadProgress = options.onUploadProgress;
- }
- if (options.onDownloadProgress) {
- httpRequest.onDownloadProgress = options.onDownloadProgress;
- }
- if (options.spanOptions) {
- // By passing spanOptions if they exist at runtime, we're backwards compatible with @azure/core-tracing@preview.13 and earlier.
- httpRequest.spanOptions = options.spanOptions;
- }
- if (options.tracingContext) {
- httpRequest.tracingContext = options.tracingContext;
- }
- if (options.shouldDeserialize !== undefined && options.shouldDeserialize !== null) {
- httpRequest.shouldDeserialize = options.shouldDeserialize;
- }
- }
- httpRequest.withCredentials = this._withCredentials;
- serializeRequestBody(this, httpRequest, operationArguments, operationSpec);
- if (httpRequest.streamResponseStatusCodes === undefined) {
- httpRequest.streamResponseStatusCodes = getStreamResponseStatusCodes(operationSpec);
- }
- let rawResponse;
- let sendRequestError;
- try {
- rawResponse = await this.sendRequest(httpRequest);
- }
- catch (error) {
- sendRequestError = error;
- }
- if (sendRequestError) {
- if (sendRequestError.response) {
- sendRequestError.details = flattenResponse(sendRequestError.response, operationSpec.responses[sendRequestError.statusCode] ||
- operationSpec.responses["default"]);
- }
- result = Promise.reject(sendRequestError);
- }
- else {
- result = Promise.resolve(flattenResponse(rawResponse, operationSpec.responses[rawResponse.status]));
- }
- }
- catch (error) {
- result = Promise.reject(error);
- }
- const cb = callback;
- if (cb) {
- result
- .then((res) => cb(null, res._response.parsedBody, res._response.request, res._response))
- .catch((err) => cb(err));
- }
- return result;
- }
-}
-function serializeRequestBody(serviceClient, httpRequest, operationArguments, operationSpec) {
- var _a, _b, _c, _d, _e, _f;
- const serializerOptions = (_b = (_a = operationArguments.options) === null || _a === void 0 ? void 0 : _a.serializerOptions) !== null && _b !== void 0 ? _b : {};
- const updatedOptions = {
- rootName: (_c = serializerOptions.rootName) !== null && _c !== void 0 ? _c : "",
- includeRoot: (_d = serializerOptions.includeRoot) !== null && _d !== void 0 ? _d : false,
- xmlCharKey: (_e = serializerOptions.xmlCharKey) !== null && _e !== void 0 ? _e : XML_CHARKEY,
- };
- const xmlCharKey = serializerOptions.xmlCharKey;
- if (operationSpec.requestBody && operationSpec.requestBody.mapper) {
- httpRequest.body = getOperationArgumentValueFromParameter(serviceClient, operationArguments, operationSpec.requestBody, operationSpec.serializer);
- const bodyMapper = operationSpec.requestBody.mapper;
- const { required, xmlName, xmlElementName, serializedName, xmlNamespace, xmlNamespacePrefix } = bodyMapper;
- const typeName = bodyMapper.type.name;
- try {
- if ((httpRequest.body !== undefined && httpRequest.body !== null) || required) {
- const requestBodyParameterPathString = getPathStringFromParameter(operationSpec.requestBody);
- httpRequest.body = operationSpec.serializer.serialize(bodyMapper, httpRequest.body, requestBodyParameterPathString, updatedOptions);
- const isStream = typeName === MapperType.Stream;
- if (operationSpec.isXML) {
- const xmlnsKey = xmlNamespacePrefix ? `xmlns:${xmlNamespacePrefix}` : "xmlns";
- const value = getXmlValueWithNamespace(xmlNamespace, xmlnsKey, typeName, httpRequest.body, updatedOptions);
- if (typeName === MapperType.Sequence) {
- httpRequest.body = stringifyXML(prepareXMLRootList(value, xmlElementName || xmlName || serializedName, xmlnsKey, xmlNamespace), {
- rootName: xmlName || serializedName,
- xmlCharKey,
- });
- }
- else if (!isStream) {
- httpRequest.body = stringifyXML(value, {
- rootName: xmlName || serializedName,
- xmlCharKey,
- });
- }
- }
- else if (typeName === MapperType.String &&
- (((_f = operationSpec.contentType) === null || _f === void 0 ? void 0 : _f.match("text/plain")) || operationSpec.mediaType === "text")) {
- // the String serializer has validated that request body is a string
- // so just send the string.
- return;
- }
- else if (!isStream) {
- httpRequest.body = JSON.stringify(httpRequest.body);
- }
- }
- }
- catch (error) {
- throw new Error(`Error "${error.message}" occurred in serializing the payload - ${JSON.stringify(serializedName, undefined, " ")}.`);
- }
- }
- else if (operationSpec.formDataParameters && operationSpec.formDataParameters.length > 0) {
- httpRequest.formData = {};
- for (const formDataParameter of operationSpec.formDataParameters) {
- const formDataParameterValue = getOperationArgumentValueFromParameter(serviceClient, operationArguments, formDataParameter, operationSpec.serializer);
- if (formDataParameterValue !== undefined && formDataParameterValue !== null) {
- const formDataParameterPropertyName = formDataParameter.mapper.serializedName || getPathStringFromParameter(formDataParameter);
- httpRequest.formData[formDataParameterPropertyName] = operationSpec.serializer.serialize(formDataParameter.mapper, formDataParameterValue, getPathStringFromParameter(formDataParameter), updatedOptions);
- }
- }
- }
-}
-/**
- * Adds an xml namespace to the xml serialized object if needed, otherwise it just returns the value itself
- */
-function getXmlValueWithNamespace(xmlNamespace, xmlnsKey, typeName, serializedValue, options) {
- // Composite and Sequence schemas already got their root namespace set during serialization
- // We just need to add xmlns to the other schema types
- if (xmlNamespace && !["Composite", "Sequence", "Dictionary"].includes(typeName)) {
- const result = {};
- result[options.xmlCharKey] = serializedValue;
- result[XML_ATTRKEY] = { [xmlnsKey]: xmlNamespace };
- return result;
- }
- return serializedValue;
-}
-function getValueOrFunctionResult(value, defaultValueCreator) {
- let result;
- if (typeof value === "string") {
- result = value;
- }
- else {
- result = defaultValueCreator();
- if (typeof value === "function") {
- result = value(result);
- }
- }
- return result;
-}
-function createDefaultRequestPolicyFactories(authPolicyFactory, options) {
- const factories = [];
- if (options.generateClientRequestIdHeader) {
- factories.push(generateClientRequestIdPolicy(options.clientRequestIdHeaderName));
- }
- if (authPolicyFactory) {
- factories.push(authPolicyFactory);
- }
- const userAgentHeaderName = getValueOrFunctionResult(options.userAgentHeaderName, getDefaultUserAgentHeaderName);
- const userAgentHeaderValue = getValueOrFunctionResult(options.userAgent, getDefaultUserAgentValue);
- if (userAgentHeaderName && userAgentHeaderValue) {
- factories.push(userAgentPolicy({ key: userAgentHeaderName, value: userAgentHeaderValue }));
- }
- factories.push(redirectPolicy());
- factories.push(rpRegistrationPolicy(options.rpRegistrationRetryTimeout));
- if (!options.noRetryPolicy) {
- factories.push(exponentialRetryPolicy());
- factories.push(systemErrorRetryPolicy());
- factories.push(throttlingRetryPolicy());
- }
- factories.push(deserializationPolicy(options.deserializationContentTypes));
- if (coreUtil.isNode) {
- factories.push(proxyPolicy(options.proxySettings));
- }
- factories.push(logPolicy({ logger: logger.info }));
- return factories;
-}
-/**
- * Creates an HTTP pipeline based on the given options.
- * @param pipelineOptions - Defines options that are used to configure policies in the HTTP pipeline for an SDK client.
- * @param authPolicyFactory - An optional authentication policy factory to use for signing requests.
- * @returns A set of options that can be passed to create a new {@link ServiceClient}.
- */
-function createPipelineFromOptions(pipelineOptions, authPolicyFactory) {
- const requestPolicyFactories = [];
- if (pipelineOptions.sendStreamingJson) {
- requestPolicyFactories.push(ndJsonPolicy());
- }
- let userAgentValue = undefined;
- if (pipelineOptions.userAgentOptions && pipelineOptions.userAgentOptions.userAgentPrefix) {
- const userAgentInfo = [];
- userAgentInfo.push(pipelineOptions.userAgentOptions.userAgentPrefix);
- // Add the default user agent value if it isn't already specified
- // by the userAgentPrefix option.
- const defaultUserAgentInfo = getDefaultUserAgentValue();
- if (userAgentInfo.indexOf(defaultUserAgentInfo) === -1) {
- userAgentInfo.push(defaultUserAgentInfo);
- }
- userAgentValue = userAgentInfo.join(" ");
- }
- const keepAliveOptions = Object.assign(Object.assign({}, DefaultKeepAliveOptions), pipelineOptions.keepAliveOptions);
- const retryOptions = Object.assign(Object.assign({}, DefaultRetryOptions), pipelineOptions.retryOptions);
- const redirectOptions = Object.assign(Object.assign({}, DefaultRedirectOptions), pipelineOptions.redirectOptions);
- if (coreUtil.isNode) {
- requestPolicyFactories.push(proxyPolicy(pipelineOptions.proxyOptions));
- }
- const deserializationOptions = Object.assign(Object.assign({}, DefaultDeserializationOptions), pipelineOptions.deserializationOptions);
- const loggingOptions = Object.assign({}, pipelineOptions.loggingOptions);
- requestPolicyFactories.push(tracingPolicy({ userAgent: userAgentValue }), keepAlivePolicy(keepAliveOptions), userAgentPolicy({ value: userAgentValue }), generateClientRequestIdPolicy(), deserializationPolicy(deserializationOptions.expectedContentTypes), throttlingRetryPolicy(), systemErrorRetryPolicy(), exponentialRetryPolicy(retryOptions.maxRetries, retryOptions.retryDelayInMs, retryOptions.maxRetryDelayInMs));
- if (redirectOptions.handleRedirects) {
- requestPolicyFactories.push(redirectPolicy(redirectOptions.maxRetries));
- }
- if (authPolicyFactory) {
- requestPolicyFactories.push(authPolicyFactory);
- }
- requestPolicyFactories.push(logPolicy(loggingOptions));
- if (coreUtil.isNode && pipelineOptions.decompressResponse === false) {
- requestPolicyFactories.push(disableResponseDecompressionPolicy());
- }
- return {
- httpClient: pipelineOptions.httpClient,
- requestPolicyFactories,
- };
-}
-function getOperationArgumentValueFromParameter(serviceClient, operationArguments, parameter, serializer) {
- return getOperationArgumentValueFromParameterPath(serviceClient, operationArguments, parameter.parameterPath, parameter.mapper, serializer);
-}
-function getOperationArgumentValueFromParameterPath(serviceClient, operationArguments, parameterPath, parameterMapper, serializer) {
- var _a;
- let value;
- if (typeof parameterPath === "string") {
- parameterPath = [parameterPath];
- }
- const serializerOptions = (_a = operationArguments.options) === null || _a === void 0 ? void 0 : _a.serializerOptions;
- if (Array.isArray(parameterPath)) {
- if (parameterPath.length > 0) {
- if (parameterMapper.isConstant) {
- value = parameterMapper.defaultValue;
- }
- else {
- let propertySearchResult = getPropertyFromParameterPath(operationArguments, parameterPath);
- if (!propertySearchResult.propertyFound) {
- propertySearchResult = getPropertyFromParameterPath(serviceClient, parameterPath);
- }
- let useDefaultValue = false;
- if (!propertySearchResult.propertyFound) {
- useDefaultValue =
- parameterMapper.required ||
- (parameterPath[0] === "options" && parameterPath.length === 2);
- }
- value = useDefaultValue ? parameterMapper.defaultValue : propertySearchResult.propertyValue;
- }
- // Serialize just for validation purposes.
- const parameterPathString = getPathStringFromParameterPath(parameterPath, parameterMapper);
- serializer.serialize(parameterMapper, value, parameterPathString, serializerOptions);
- }
- }
- else {
- if (parameterMapper.required) {
- value = {};
- }
- for (const propertyName in parameterPath) {
- const propertyMapper = parameterMapper.type.modelProperties[propertyName];
- const propertyPath = parameterPath[propertyName];
- const propertyValue = getOperationArgumentValueFromParameterPath(serviceClient, operationArguments, propertyPath, propertyMapper, serializer);
- // Serialize just for validation purposes.
- const propertyPathString = getPathStringFromParameterPath(propertyPath, propertyMapper);
- serializer.serialize(propertyMapper, propertyValue, propertyPathString, serializerOptions);
- if (propertyValue !== undefined && propertyValue !== null) {
- if (!value) {
- value = {};
- }
- value[propertyName] = propertyValue;
- }
- }
- }
- return value;
-}
-function getPropertyFromParameterPath(parent, parameterPath) {
- const result = { propertyFound: false };
- let i = 0;
- for (; i < parameterPath.length; ++i) {
- const parameterPathPart = parameterPath[i];
- // Make sure to check inherited properties too, so don't use hasOwnProperty().
- if (parent !== undefined && parent !== null && parameterPathPart in parent) {
- parent = parent[parameterPathPart];
- }
- else {
- break;
- }
- }
- if (i === parameterPath.length) {
- result.propertyValue = parent;
- result.propertyFound = true;
- }
- return result;
-}
-/**
- * Parses an {@link HttpOperationResponse} into a normalized HTTP response object ({@link RestResponse}).
- * @param _response - Wrapper object for http response.
- * @param responseSpec - Mappers for how to parse the response properties.
- * @returns - A normalized response object.
- */
-function flattenResponse(_response, responseSpec) {
- const parsedHeaders = _response.parsedHeaders;
- const bodyMapper = responseSpec && responseSpec.bodyMapper;
- const addOperationResponse = (obj) => {
- return Object.defineProperty(obj, "_response", {
- value: _response,
- });
- };
- if (bodyMapper) {
- const typeName = bodyMapper.type.name;
- if (typeName === "Stream") {
- return addOperationResponse(Object.assign(Object.assign({}, parsedHeaders), { blobBody: _response.blobBody, readableStreamBody: _response.readableStreamBody }));
- }
- const modelProperties = (typeName === "Composite" && bodyMapper.type.modelProperties) || {};
- const isPageableResponse = Object.keys(modelProperties).some((k) => modelProperties[k].serializedName === "");
- if (typeName === "Sequence" || isPageableResponse) {
- const arrayResponse = [...(_response.parsedBody || [])];
- for (const key of Object.keys(modelProperties)) {
- if (modelProperties[key].serializedName) {
- arrayResponse[key] = _response.parsedBody[key];
- }
- }
- if (parsedHeaders) {
- for (const key of Object.keys(parsedHeaders)) {
- arrayResponse[key] = parsedHeaders[key];
- }
- }
- addOperationResponse(arrayResponse);
- return arrayResponse;
- }
- if (typeName === "Composite" || typeName === "Dictionary") {
- return addOperationResponse(Object.assign(Object.assign({}, parsedHeaders), _response.parsedBody));
- }
- }
- if (bodyMapper ||
- _response.request.method === "HEAD" ||
- isPrimitiveType(_response.parsedBody)) {
- // primitive body types and HEAD booleans
- return addOperationResponse(Object.assign(Object.assign({}, parsedHeaders), { body: _response.parsedBody }));
- }
- return addOperationResponse(Object.assign(Object.assign({}, parsedHeaders), _response.parsedBody));
-}
-function getCredentialScopes(options, baseUri) {
- if (options === null || options === void 0 ? void 0 : options.credentialScopes) {
- return options.credentialScopes;
- }
- if (baseUri) {
- return `${baseUri}/.default`;
- }
- return undefined;
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * This function is only here for compatibility. Use createSpanFunction in core-tracing.
- *
- * @deprecated This function is only here for compatibility. Use createSpanFunction in core-tracing.
- * @hidden
-
- * @param spanConfig - The name of the operation being performed.
- * @param tracingOptions - The options for the underlying http request.
- */
-function createSpanFunction(args) {
- return coreTracing.createSpanFunction(args);
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Defines the default token refresh buffer duration.
- */
-const TokenRefreshBufferMs = 2 * 60 * 1000; // 2 Minutes
-/**
- * Provides an {@link AccessTokenCache} implementation which clears
- * the cached {@link AccessToken}'s after the expiresOnTimestamp has
- * passed.
- *
- * @deprecated No longer used in the bearer authorization policy.
- */
-class ExpiringAccessTokenCache {
- /**
- * Constructs an instance of {@link ExpiringAccessTokenCache} with
- * an optional expiration buffer time.
- */
- constructor(tokenRefreshBufferMs = TokenRefreshBufferMs) {
- this.cachedToken = undefined;
- this.tokenRefreshBufferMs = tokenRefreshBufferMs;
- }
- /**
- * Saves an access token into the internal in-memory cache.
- * @param accessToken - Access token or undefined to clear the cache.
- */
- setCachedToken(accessToken) {
- this.cachedToken = accessToken;
- }
- /**
- * Returns the cached access token, or `undefined` if one is not cached or the cached one is expiring soon.
- */
- getCachedToken() {
- if (this.cachedToken &&
- Date.now() + this.tokenRefreshBufferMs >= this.cachedToken.expiresOnTimestamp) {
- this.cachedToken = undefined;
- }
- return this.cachedToken;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Helps the core-http token authentication policies with requesting a new token if we're not currently waiting for a new token.
- *
- * @deprecated No longer used in the bearer authorization policy.
- */
-class AccessTokenRefresher {
- constructor(credential, scopes, requiredMillisecondsBeforeNewRefresh = 30000) {
- this.credential = credential;
- this.scopes = scopes;
- this.requiredMillisecondsBeforeNewRefresh = requiredMillisecondsBeforeNewRefresh;
- this.lastCalled = 0;
- }
- /**
- * Returns true if the required milliseconds(defaulted to 30000) have been passed signifying
- * that we are ready for a new refresh.
- */
- isReady() {
- // We're only ready for a new refresh if the required milliseconds have passed.
- return (!this.lastCalled || Date.now() - this.lastCalled > this.requiredMillisecondsBeforeNewRefresh);
- }
- /**
- * Stores the time in which it is called,
- * then requests a new token,
- * then sets this.promise to undefined,
- * then returns the token.
- */
- async getToken(options) {
- this.lastCalled = Date.now();
- const token = await this.credential.getToken(this.scopes, options);
- this.promise = undefined;
- return token || undefined;
- }
- /**
- * Requests a new token if we're not currently waiting for a new token.
- * Returns null if the required time between each call hasn't been reached.
- */
- refresh(options) {
- if (!this.promise) {
- this.promise = this.getToken(options);
- }
- return this.promise;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-const HeaderConstants = Constants.HeaderConstants;
-const DEFAULT_AUTHORIZATION_SCHEME = "Basic";
-/**
- * A simple {@link ServiceClientCredential} that authenticates with a username and a password.
- */
-class BasicAuthenticationCredentials {
- /**
- * Creates a new BasicAuthenticationCredentials object.
- *
- * @param userName - User name.
- * @param password - Password.
- * @param authorizationScheme - The authorization scheme.
- */
- constructor(userName, password, authorizationScheme = DEFAULT_AUTHORIZATION_SCHEME) {
- /**
- * Authorization scheme. Defaults to "Basic".
- * More information about authorization schemes is available here: https://developer.mozilla.org/docs/Web/HTTP/Authentication#authentication_schemes
- */
- this.authorizationScheme = DEFAULT_AUTHORIZATION_SCHEME;
- if (userName === null || userName === undefined || typeof userName.valueOf() !== "string") {
- throw new Error("userName cannot be null or undefined and must be of type string.");
- }
- if (password === null || password === undefined || typeof password.valueOf() !== "string") {
- throw new Error("password cannot be null or undefined and must be of type string.");
- }
- this.userName = userName;
- this.password = password;
- this.authorizationScheme = authorizationScheme;
- }
- /**
- * Signs a request with the Authentication header.
- *
- * @param webResource - The WebResourceLike to be signed.
- * @returns The signed request object.
- */
- signRequest(webResource) {
- const credentials = `${this.userName}:${this.password}`;
- const encodedCredentials = `${this.authorizationScheme} ${encodeString(credentials)}`;
- if (!webResource.headers)
- webResource.headers = new HttpHeaders();
- webResource.headers.set(HeaderConstants.AUTHORIZATION, encodedCredentials);
- return Promise.resolve(webResource);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Authenticates to a service using an API key.
- */
-class ApiKeyCredentials {
- /**
- * @param options - Specifies the options to be provided for auth. Either header or query needs to be provided.
- */
- constructor(options) {
- if (!options || (options && !options.inHeader && !options.inQuery)) {
- throw new Error(`options cannot be null or undefined. Either "inHeader" or "inQuery" property of the options object needs to be provided.`);
- }
- this.inHeader = options.inHeader;
- this.inQuery = options.inQuery;
- }
- /**
- * Signs a request with the values provided in the inHeader and inQuery parameter.
- *
- * @param webResource - The WebResourceLike to be signed.
- * @returns The signed request object.
- */
- signRequest(webResource) {
- if (!webResource) {
- return Promise.reject(new Error(`webResource cannot be null or undefined and must be of type "object".`));
- }
- if (this.inHeader) {
- if (!webResource.headers) {
- webResource.headers = new HttpHeaders();
- }
- for (const headerName in this.inHeader) {
- webResource.headers.set(headerName, this.inHeader[headerName]);
- }
- }
- if (this.inQuery) {
- if (!webResource.url) {
- return Promise.reject(new Error(`url cannot be null in the request object.`));
- }
- if (webResource.url.indexOf("?") < 0) {
- webResource.url += "?";
- }
- for (const key in this.inQuery) {
- if (!webResource.url.endsWith("?")) {
- webResource.url += "&";
- }
- webResource.url += `${key}=${this.inQuery[key]}`;
- }
- }
- return Promise.resolve(webResource);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * A {@link TopicCredentials} object used for Azure Event Grid.
- */
-class TopicCredentials extends ApiKeyCredentials {
- /**
- * Creates a new EventGrid TopicCredentials object.
- *
- * @param topicKey - The EventGrid topic key
- */
- constructor(topicKey) {
- if (!topicKey || (topicKey && typeof topicKey !== "string")) {
- throw new Error("topicKey cannot be null or undefined and must be of type string.");
- }
- const options = {
- inHeader: {
- "aeg-sas-key": topicKey,
+ },
+ },
},
- };
- super(options);
- }
-}
-
-Object.defineProperty(exports, "delay", ({
- enumerable: true,
- get: function () { return coreUtil.delay; }
-}));
-Object.defineProperty(exports, "isNode", ({
- enumerable: true,
- get: function () { return coreUtil.isNode; }
-}));
-Object.defineProperty(exports, "isTokenCredential", ({
- enumerable: true,
- get: function () { return coreAuth.isTokenCredential; }
-}));
-exports.AccessTokenRefresher = AccessTokenRefresher;
-exports.ApiKeyCredentials = ApiKeyCredentials;
-exports.BaseRequestPolicy = BaseRequestPolicy;
-exports.BasicAuthenticationCredentials = BasicAuthenticationCredentials;
-exports.Constants = Constants;
-exports.DefaultHttpClient = NodeFetchHttpClient;
-exports.ExpiringAccessTokenCache = ExpiringAccessTokenCache;
-exports.HttpHeaders = HttpHeaders;
-exports.MapperType = MapperType;
-exports.RequestPolicyOptions = RequestPolicyOptions;
-exports.RestError = RestError;
-exports.Serializer = Serializer;
-exports.ServiceClient = ServiceClient;
-exports.TopicCredentials = TopicCredentials;
-exports.URLBuilder = URLBuilder;
-exports.URLQuery = URLQuery;
-exports.WebResource = WebResource;
-exports.XML_ATTRKEY = XML_ATTRKEY;
-exports.XML_CHARKEY = XML_CHARKEY;
-exports.applyMixins = applyMixins;
-exports.bearerTokenAuthenticationPolicy = bearerTokenAuthenticationPolicy;
-exports.createPipelineFromOptions = createPipelineFromOptions;
-exports.createSpanFunction = createSpanFunction;
-exports.deserializationPolicy = deserializationPolicy;
-exports.deserializeResponseBody = deserializeResponseBody;
-exports.disableResponseDecompressionPolicy = disableResponseDecompressionPolicy;
-exports.encodeUri = encodeUri;
-exports.executePromisesSequentially = executePromisesSequentially;
-exports.exponentialRetryPolicy = exponentialRetryPolicy;
-exports.flattenResponse = flattenResponse;
-exports.generateClientRequestIdPolicy = generateClientRequestIdPolicy;
-exports.generateUuid = generateUuid;
-exports.getDefaultProxySettings = getDefaultProxySettings;
-exports.getDefaultUserAgentValue = getDefaultUserAgentValue;
-exports.isDuration = isDuration;
-exports.isValidUuid = isValidUuid;
-exports.keepAlivePolicy = keepAlivePolicy;
-exports.logPolicy = logPolicy;
-exports.operationOptionsToRequestOptionsBase = operationOptionsToRequestOptionsBase;
-exports.parseXML = parseXML;
-exports.promiseToCallback = promiseToCallback;
-exports.promiseToServiceCallback = promiseToServiceCallback;
-exports.proxyPolicy = proxyPolicy;
-exports.redirectPolicy = redirectPolicy;
-exports.serializeObject = serializeObject;
-exports.signingPolicy = signingPolicy;
-exports.stringifyXML = stringifyXML;
-exports.stripRequest = stripRequest;
-exports.stripResponse = stripResponse;
-exports.systemErrorRetryPolicy = systemErrorRetryPolicy;
-exports.throttlingRetryPolicy = throttlingRetryPolicy;
-exports.tracingPolicy = tracingPolicy;
-exports.userAgentPolicy = userAgentPolicy;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 6279:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-var CombinedStream = __nccwpck_require__(5443);
-var util = __nccwpck_require__(3837);
-var path = __nccwpck_require__(1017);
-var http = __nccwpck_require__(3685);
-var https = __nccwpck_require__(5687);
-var parseUrl = (__nccwpck_require__(7310).parse);
-var fs = __nccwpck_require__(7147);
-var Stream = (__nccwpck_require__(2781).Stream);
-var mime = __nccwpck_require__(3583);
-var asynckit = __nccwpck_require__(4812);
-var populate = __nccwpck_require__(3971);
-
-// Public API
-module.exports = FormData;
-
-// make it a Stream
-util.inherits(FormData, CombinedStream);
-
-/**
- * Create readable "multipart/form-data" streams.
- * Can be used to submit forms
- * and file uploads to other web applications.
- *
- * @constructor
- * @param {Object} options - Properties to be added/overriden for FormData and CombinedStream
- */
-function FormData(options) {
- if (!(this instanceof FormData)) {
- return new FormData(options);
- }
-
- this._overheadLength = 0;
- this._valueLength = 0;
- this._valuesToMeasure = [];
-
- CombinedStream.call(this);
-
- options = options || {};
- for (var option in options) {
- this[option] = options[option];
- }
-}
-
-FormData.LINE_BREAK = '\r\n';
-FormData.DEFAULT_CONTENT_TYPE = 'application/octet-stream';
-
-FormData.prototype.append = function(field, value, options) {
-
- options = options || {};
-
- // allow filename as single option
- if (typeof options == 'string') {
- options = {filename: options};
- }
-
- var append = CombinedStream.prototype.append.bind(this);
-
- // all that streamy business can't handle numbers
- if (typeof value == 'number') {
- value = '' + value;
- }
-
- // https://github.com/felixge/node-form-data/issues/38
- if (util.isArray(value)) {
- // Please convert your array into string
- // the way web server expects it
- this._error(new Error('Arrays are not supported.'));
- return;
- }
-
- var header = this._multiPartHeader(field, value, options);
- var footer = this._multiPartFooter();
-
- append(header);
- append(value);
- append(footer);
-
- // pass along options.knownLength
- this._trackLength(header, value, options);
-};
-
-FormData.prototype._trackLength = function(header, value, options) {
- var valueLength = 0;
-
- // used w/ getLengthSync(), when length is known.
- // e.g. for streaming directly from a remote server,
- // w/ a known file a size, and not wanting to wait for
- // incoming file to finish to get its size.
- if (options.knownLength != null) {
- valueLength += +options.knownLength;
- } else if (Buffer.isBuffer(value)) {
- valueLength = value.length;
- } else if (typeof value === 'string') {
- valueLength = Buffer.byteLength(value);
- }
-
- this._valueLength += valueLength;
-
- // @check why add CRLF? does this account for custom/multiple CRLFs?
- this._overheadLength +=
- Buffer.byteLength(header) +
- FormData.LINE_BREAK.length;
-
- // empty or either doesn't have path or not an http response or not a stream
- if (!value || ( !value.path && !(value.readable && value.hasOwnProperty('httpVersion')) && !(value instanceof Stream))) {
- return;
- }
-
- // no need to bother with the length
- if (!options.knownLength) {
- this._valuesToMeasure.push(value);
- }
-};
-
-FormData.prototype._lengthRetriever = function(value, callback) {
-
- if (value.hasOwnProperty('fd')) {
-
- // take read range into a account
- // `end` = Infinity –> read file till the end
- //
- // TODO: Looks like there is bug in Node fs.createReadStream
- // it doesn't respect `end` options without `start` options
- // Fix it when node fixes it.
- // https://github.com/joyent/node/issues/7819
- if (value.end != undefined && value.end != Infinity && value.start != undefined) {
-
- // when end specified
- // no need to calculate range
- // inclusive, starts with 0
- callback(null, value.end + 1 - (value.start ? value.start : 0));
-
- // not that fast snoopy
- } else {
- // still need to fetch file size from fs
- fs.stat(value.path, function(err, stat) {
-
- var fileSize;
-
- if (err) {
- callback(err);
- return;
- }
-
- // update final size based on the range options
- fileSize = stat.size - (value.start ? value.start : 0);
- callback(null, fileSize);
- });
- }
-
- // or http response
- } else if (value.hasOwnProperty('httpVersion')) {
- callback(null, +value.headers['content-length']);
-
- // or request stream http://github.com/mikeal/request
- } else if (value.hasOwnProperty('httpModule')) {
- // wait till response come back
- value.on('response', function(response) {
- value.pause();
- callback(null, +response.headers['content-length']);
- });
- value.resume();
-
- // something else
- } else {
- callback('Unknown stream');
- }
-};
-
-FormData.prototype._multiPartHeader = function(field, value, options) {
- // custom header specified (as string)?
- // it becomes responsible for boundary
- // (e.g. to handle extra CRLFs on .NET servers)
- if (typeof options.header == 'string') {
- return options.header;
- }
-
- var contentDisposition = this._getContentDisposition(value, options);
- var contentType = this._getContentType(value, options);
-
- var contents = '';
- var headers = {
- // add custom disposition as third element or keep it two elements if not
- 'Content-Disposition': ['form-data', 'name="' + field + '"'].concat(contentDisposition || []),
- // if no content type. allow it to be empty array
- 'Content-Type': [].concat(contentType || [])
- };
-
- // allow custom headers.
- if (typeof options.header == 'object') {
- populate(headers, options.header);
- }
-
- var header;
- for (var prop in headers) {
- if (!headers.hasOwnProperty(prop)) continue;
- header = headers[prop];
-
- // skip nullish headers.
- if (header == null) {
- continue;
- }
-
- // convert all headers to arrays.
- if (!Array.isArray(header)) {
- header = [header];
- }
-
- // add non-empty headers.
- if (header.length) {
- contents += prop + ': ' + header.join('; ') + FormData.LINE_BREAK;
- }
- }
-
- return '--' + this.getBoundary() + FormData.LINE_BREAK + contents + FormData.LINE_BREAK;
-};
-
-FormData.prototype._getContentDisposition = function(value, options) {
-
- var filename
- , contentDisposition
- ;
-
- if (typeof options.filepath === 'string') {
- // custom filepath for relative paths
- filename = path.normalize(options.filepath).replace(/\\/g, '/');
- } else if (options.filename || value.name || value.path) {
- // custom filename take precedence
- // formidable and the browser add a name property
- // fs- and request- streams have path property
- filename = path.basename(options.filename || value.name || value.path);
- } else if (value.readable && value.hasOwnProperty('httpVersion')) {
- // or try http response
- filename = path.basename(value.client._httpMessage.path || '');
- }
-
- if (filename) {
- contentDisposition = 'filename="' + filename + '"';
- }
-
- return contentDisposition;
+ },
+ },
};
-
-FormData.prototype._getContentType = function(value, options) {
-
- // use custom content-type above all
- var contentType = options.contentType;
-
- // or try `name` from formidable, browser
- if (!contentType && value.name) {
- contentType = mime.lookup(value.name);
- }
-
- // or try `path` from fs-, request- streams
- if (!contentType && value.path) {
- contentType = mime.lookup(value.path);
- }
-
- // or if it's http-reponse
- if (!contentType && value.readable && value.hasOwnProperty('httpVersion')) {
- contentType = value.headers['content-type'];
- }
-
- // or guess it from the filepath or filename
- if (!contentType && (options.filepath || options.filename)) {
- contentType = mime.lookup(options.filepath || options.filename);
- }
-
- // fallback to the default content type if `value` is not simple value
- if (!contentType && typeof value == 'object') {
- contentType = FormData.DEFAULT_CONTENT_TYPE;
- }
-
- return contentType;
+const BlobItemInternal = {
+ serializedName: "BlobItemInternal",
+ xmlName: "Blob",
+ type: {
+ name: "Composite",
+ className: "BlobItemInternal",
+ modelProperties: {
+ name: {
+ serializedName: "Name",
+ xmlName: "Name",
+ type: {
+ name: "Composite",
+ className: "BlobName",
+ },
+ },
+ deleted: {
+ serializedName: "Deleted",
+ required: true,
+ xmlName: "Deleted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ snapshot: {
+ serializedName: "Snapshot",
+ required: true,
+ xmlName: "Snapshot",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "VersionId",
+ xmlName: "VersionId",
+ type: {
+ name: "String",
+ },
+ },
+ isCurrentVersion: {
+ serializedName: "IsCurrentVersion",
+ xmlName: "IsCurrentVersion",
+ type: {
+ name: "Boolean",
+ },
+ },
+ properties: {
+ serializedName: "Properties",
+ xmlName: "Properties",
+ type: {
+ name: "Composite",
+ className: "BlobPropertiesInternal",
+ },
+ },
+ metadata: {
+ serializedName: "Metadata",
+ xmlName: "Metadata",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+ blobTags: {
+ serializedName: "BlobTags",
+ xmlName: "Tags",
+ type: {
+ name: "Composite",
+ className: "BlobTags",
+ },
+ },
+ objectReplicationMetadata: {
+ serializedName: "ObjectReplicationMetadata",
+ xmlName: "OrMetadata",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+ hasVersionsOnly: {
+ serializedName: "HasVersionsOnly",
+ xmlName: "HasVersionsOnly",
+ type: {
+ name: "Boolean",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype._multiPartFooter = function() {
- return function(next) {
- var footer = FormData.LINE_BREAK;
-
- var lastPart = (this._streams.length === 0);
- if (lastPart) {
- footer += this._lastBoundary();
- }
-
- next(footer);
- }.bind(this);
+const BlobName = {
+ serializedName: "BlobName",
+ type: {
+ name: "Composite",
+ className: "BlobName",
+ modelProperties: {
+ encoded: {
+ serializedName: "Encoded",
+ xmlName: "Encoded",
+ xmlIsAttribute: true,
+ type: {
+ name: "Boolean",
+ },
+ },
+ content: {
+ serializedName: "content",
+ xmlName: "content",
+ xmlIsMsText: true,
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype._lastBoundary = function() {
- return '--' + this.getBoundary() + '--' + FormData.LINE_BREAK;
+const BlobPropertiesInternal = {
+ serializedName: "BlobPropertiesInternal",
+ xmlName: "Properties",
+ type: {
+ name: "Composite",
+ className: "BlobPropertiesInternal",
+ modelProperties: {
+ createdOn: {
+ serializedName: "Creation-Time",
+ xmlName: "Creation-Time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ lastModified: {
+ serializedName: "Last-Modified",
+ required: true,
+ xmlName: "Last-Modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ etag: {
+ serializedName: "Etag",
+ required: true,
+ xmlName: "Etag",
+ type: {
+ name: "String",
+ },
+ },
+ contentLength: {
+ serializedName: "Content-Length",
+ xmlName: "Content-Length",
+ type: {
+ name: "Number",
+ },
+ },
+ contentType: {
+ serializedName: "Content-Type",
+ xmlName: "Content-Type",
+ type: {
+ name: "String",
+ },
+ },
+ contentEncoding: {
+ serializedName: "Content-Encoding",
+ xmlName: "Content-Encoding",
+ type: {
+ name: "String",
+ },
+ },
+ contentLanguage: {
+ serializedName: "Content-Language",
+ xmlName: "Content-Language",
+ type: {
+ name: "String",
+ },
+ },
+ contentMD5: {
+ serializedName: "Content-MD5",
+ xmlName: "Content-MD5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ contentDisposition: {
+ serializedName: "Content-Disposition",
+ xmlName: "Content-Disposition",
+ type: {
+ name: "String",
+ },
+ },
+ cacheControl: {
+ serializedName: "Cache-Control",
+ xmlName: "Cache-Control",
+ type: {
+ name: "String",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ blobType: {
+ serializedName: "BlobType",
+ xmlName: "BlobType",
+ type: {
+ name: "Enum",
+ allowedValues: ["BlockBlob", "PageBlob", "AppendBlob"],
+ },
+ },
+ leaseStatus: {
+ serializedName: "LeaseStatus",
+ xmlName: "LeaseStatus",
+ type: {
+ name: "Enum",
+ allowedValues: ["locked", "unlocked"],
+ },
+ },
+ leaseState: {
+ serializedName: "LeaseState",
+ xmlName: "LeaseState",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken",
+ ],
+ },
+ },
+ leaseDuration: {
+ serializedName: "LeaseDuration",
+ xmlName: "LeaseDuration",
+ type: {
+ name: "Enum",
+ allowedValues: ["infinite", "fixed"],
+ },
+ },
+ copyId: {
+ serializedName: "CopyId",
+ xmlName: "CopyId",
+ type: {
+ name: "String",
+ },
+ },
+ copyStatus: {
+ serializedName: "CopyStatus",
+ xmlName: "CopyStatus",
+ type: {
+ name: "Enum",
+ allowedValues: ["pending", "success", "aborted", "failed"],
+ },
+ },
+ copySource: {
+ serializedName: "CopySource",
+ xmlName: "CopySource",
+ type: {
+ name: "String",
+ },
+ },
+ copyProgress: {
+ serializedName: "CopyProgress",
+ xmlName: "CopyProgress",
+ type: {
+ name: "String",
+ },
+ },
+ copyCompletedOn: {
+ serializedName: "CopyCompletionTime",
+ xmlName: "CopyCompletionTime",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ copyStatusDescription: {
+ serializedName: "CopyStatusDescription",
+ xmlName: "CopyStatusDescription",
+ type: {
+ name: "String",
+ },
+ },
+ serverEncrypted: {
+ serializedName: "ServerEncrypted",
+ xmlName: "ServerEncrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ incrementalCopy: {
+ serializedName: "IncrementalCopy",
+ xmlName: "IncrementalCopy",
+ type: {
+ name: "Boolean",
+ },
+ },
+ destinationSnapshot: {
+ serializedName: "DestinationSnapshot",
+ xmlName: "DestinationSnapshot",
+ type: {
+ name: "String",
+ },
+ },
+ deletedOn: {
+ serializedName: "DeletedTime",
+ xmlName: "DeletedTime",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ remainingRetentionDays: {
+ serializedName: "RemainingRetentionDays",
+ xmlName: "RemainingRetentionDays",
+ type: {
+ name: "Number",
+ },
+ },
+ accessTier: {
+ serializedName: "AccessTier",
+ xmlName: "AccessTier",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "P4",
+ "P6",
+ "P10",
+ "P15",
+ "P20",
+ "P30",
+ "P40",
+ "P50",
+ "P60",
+ "P70",
+ "P80",
+ "Hot",
+ "Cool",
+ "Archive",
+ "Cold",
+ ],
+ },
+ },
+ accessTierInferred: {
+ serializedName: "AccessTierInferred",
+ xmlName: "AccessTierInferred",
+ type: {
+ name: "Boolean",
+ },
+ },
+ archiveStatus: {
+ serializedName: "ArchiveStatus",
+ xmlName: "ArchiveStatus",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "rehydrate-pending-to-hot",
+ "rehydrate-pending-to-cool",
+ "rehydrate-pending-to-cold",
+ ],
+ },
+ },
+ customerProvidedKeySha256: {
+ serializedName: "CustomerProvidedKeySha256",
+ xmlName: "CustomerProvidedKeySha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "EncryptionScope",
+ xmlName: "EncryptionScope",
+ type: {
+ name: "String",
+ },
+ },
+ accessTierChangedOn: {
+ serializedName: "AccessTierChangeTime",
+ xmlName: "AccessTierChangeTime",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ tagCount: {
+ serializedName: "TagCount",
+ xmlName: "TagCount",
+ type: {
+ name: "Number",
+ },
+ },
+ expiresOn: {
+ serializedName: "Expiry-Time",
+ xmlName: "Expiry-Time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isSealed: {
+ serializedName: "Sealed",
+ xmlName: "Sealed",
+ type: {
+ name: "Boolean",
+ },
+ },
+ rehydratePriority: {
+ serializedName: "RehydratePriority",
+ xmlName: "RehydratePriority",
+ type: {
+ name: "Enum",
+ allowedValues: ["High", "Standard"],
+ },
+ },
+ lastAccessedOn: {
+ serializedName: "LastAccessTime",
+ xmlName: "LastAccessTime",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ immutabilityPolicyExpiresOn: {
+ serializedName: "ImmutabilityPolicyUntilDate",
+ xmlName: "ImmutabilityPolicyUntilDate",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ immutabilityPolicyMode: {
+ serializedName: "ImmutabilityPolicyMode",
+ xmlName: "ImmutabilityPolicyMode",
+ type: {
+ name: "Enum",
+ allowedValues: ["Mutable", "Unlocked", "Locked"],
+ },
+ },
+ legalHold: {
+ serializedName: "LegalHold",
+ xmlName: "LegalHold",
+ type: {
+ name: "Boolean",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype.getHeaders = function(userHeaders) {
- var header;
- var formHeaders = {
- 'content-type': 'multipart/form-data; boundary=' + this.getBoundary()
- };
-
- for (header in userHeaders) {
- if (userHeaders.hasOwnProperty(header)) {
- formHeaders[header.toLowerCase()] = userHeaders[header];
- }
- }
-
- return formHeaders;
+const ListBlobsHierarchySegmentResponse = {
+ serializedName: "ListBlobsHierarchySegmentResponse",
+ xmlName: "EnumerationResults",
+ type: {
+ name: "Composite",
+ className: "ListBlobsHierarchySegmentResponse",
+ modelProperties: {
+ serviceEndpoint: {
+ serializedName: "ServiceEndpoint",
+ required: true,
+ xmlName: "ServiceEndpoint",
+ xmlIsAttribute: true,
+ type: {
+ name: "String",
+ },
+ },
+ containerName: {
+ serializedName: "ContainerName",
+ required: true,
+ xmlName: "ContainerName",
+ xmlIsAttribute: true,
+ type: {
+ name: "String",
+ },
+ },
+ prefix: {
+ serializedName: "Prefix",
+ xmlName: "Prefix",
+ type: {
+ name: "String",
+ },
+ },
+ marker: {
+ serializedName: "Marker",
+ xmlName: "Marker",
+ type: {
+ name: "String",
+ },
+ },
+ maxPageSize: {
+ serializedName: "MaxResults",
+ xmlName: "MaxResults",
+ type: {
+ name: "Number",
+ },
+ },
+ delimiter: {
+ serializedName: "Delimiter",
+ xmlName: "Delimiter",
+ type: {
+ name: "String",
+ },
+ },
+ segment: {
+ serializedName: "Segment",
+ xmlName: "Blobs",
+ type: {
+ name: "Composite",
+ className: "BlobHierarchyListSegment",
+ },
+ },
+ continuationToken: {
+ serializedName: "NextMarker",
+ xmlName: "NextMarker",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype.setBoundary = function(boundary) {
- this._boundary = boundary;
+const BlobHierarchyListSegment = {
+ serializedName: "BlobHierarchyListSegment",
+ xmlName: "Blobs",
+ type: {
+ name: "Composite",
+ className: "BlobHierarchyListSegment",
+ modelProperties: {
+ blobPrefixes: {
+ serializedName: "BlobPrefixes",
+ xmlName: "BlobPrefixes",
+ xmlElementName: "BlobPrefix",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "BlobPrefix",
+ },
+ },
+ },
+ },
+ blobItems: {
+ serializedName: "BlobItems",
+ required: true,
+ xmlName: "BlobItems",
+ xmlElementName: "Blob",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "BlobItemInternal",
+ },
+ },
+ },
+ },
+ },
+ },
};
-
-FormData.prototype.getBoundary = function() {
- if (!this._boundary) {
- this._generateBoundary();
- }
-
- return this._boundary;
+const BlobPrefix = {
+ serializedName: "BlobPrefix",
+ type: {
+ name: "Composite",
+ className: "BlobPrefix",
+ modelProperties: {
+ name: {
+ serializedName: "Name",
+ xmlName: "Name",
+ type: {
+ name: "Composite",
+ className: "BlobName",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype.getBuffer = function() {
- var dataBuffer = new Buffer.alloc( 0 );
- var boundary = this.getBoundary();
-
- // Create the form content. Add Line breaks to the end of data.
- for (var i = 0, len = this._streams.length; i < len; i++) {
- if (typeof this._streams[i] !== 'function') {
-
- // Add content to the buffer.
- if(Buffer.isBuffer(this._streams[i])) {
- dataBuffer = Buffer.concat( [dataBuffer, this._streams[i]]);
- }else {
- dataBuffer = Buffer.concat( [dataBuffer, Buffer.from(this._streams[i])]);
- }
-
- // Add break after content.
- if (typeof this._streams[i] !== 'string' || this._streams[i].substring( 2, boundary.length + 2 ) !== boundary) {
- dataBuffer = Buffer.concat( [dataBuffer, Buffer.from(FormData.LINE_BREAK)] );
- }
- }
- }
-
- // Add the footer and return the Buffer object.
- return Buffer.concat( [dataBuffer, Buffer.from(this._lastBoundary())] );
+const BlockLookupList = {
+ serializedName: "BlockLookupList",
+ xmlName: "BlockList",
+ type: {
+ name: "Composite",
+ className: "BlockLookupList",
+ modelProperties: {
+ committed: {
+ serializedName: "Committed",
+ xmlName: "Committed",
+ xmlElementName: "Committed",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+ uncommitted: {
+ serializedName: "Uncommitted",
+ xmlName: "Uncommitted",
+ xmlElementName: "Uncommitted",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+ latest: {
+ serializedName: "Latest",
+ xmlName: "Latest",
+ xmlElementName: "Latest",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+ },
+ },
};
-
-FormData.prototype._generateBoundary = function() {
- // This generates a 50 character boundary similar to those used by Firefox.
- // They are optimized for boyer-moore parsing.
- var boundary = '--------------------------';
- for (var i = 0; i < 24; i++) {
- boundary += Math.floor(Math.random() * 10).toString(16);
- }
-
- this._boundary = boundary;
+const BlockList = {
+ serializedName: "BlockList",
+ type: {
+ name: "Composite",
+ className: "BlockList",
+ modelProperties: {
+ committedBlocks: {
+ serializedName: "CommittedBlocks",
+ xmlName: "CommittedBlocks",
+ xmlIsWrapped: true,
+ xmlElementName: "Block",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "Block",
+ },
+ },
+ },
+ },
+ uncommittedBlocks: {
+ serializedName: "UncommittedBlocks",
+ xmlName: "UncommittedBlocks",
+ xmlIsWrapped: true,
+ xmlElementName: "Block",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "Block",
+ },
+ },
+ },
+ },
+ },
+ },
};
-
-// Note: getLengthSync DOESN'T calculate streams length
-// As workaround one can calculate file size manually
-// and add it as knownLength option
-FormData.prototype.getLengthSync = function() {
- var knownLength = this._overheadLength + this._valueLength;
-
- // Don't get confused, there are 3 "internal" streams for each keyval pair
- // so it basically checks if there is any value added to the form
- if (this._streams.length) {
- knownLength += this._lastBoundary().length;
- }
-
- // https://github.com/form-data/form-data/issues/40
- if (!this.hasKnownLength()) {
- // Some async length retrievers are present
- // therefore synchronous length calculation is false.
- // Please use getLength(callback) to get proper length
- this._error(new Error('Cannot calculate proper length in synchronous way.'));
- }
-
- return knownLength;
+const Block = {
+ serializedName: "Block",
+ type: {
+ name: "Composite",
+ className: "Block",
+ modelProperties: {
+ name: {
+ serializedName: "Name",
+ required: true,
+ xmlName: "Name",
+ type: {
+ name: "String",
+ },
+ },
+ size: {
+ serializedName: "Size",
+ required: true,
+ xmlName: "Size",
+ type: {
+ name: "Number",
+ },
+ },
+ },
+ },
};
-
-// Public API to check if length of added values is known
-// https://github.com/form-data/form-data/issues/196
-// https://github.com/form-data/form-data/issues/262
-FormData.prototype.hasKnownLength = function() {
- var hasKnownLength = true;
-
- if (this._valuesToMeasure.length) {
- hasKnownLength = false;
- }
-
- return hasKnownLength;
+const PageList = {
+ serializedName: "PageList",
+ type: {
+ name: "Composite",
+ className: "PageList",
+ modelProperties: {
+ pageRange: {
+ serializedName: "PageRange",
+ xmlName: "PageRange",
+ xmlElementName: "PageRange",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "PageRange",
+ },
+ },
+ },
+ },
+ clearRange: {
+ serializedName: "ClearRange",
+ xmlName: "ClearRange",
+ xmlElementName: "ClearRange",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "ClearRange",
+ },
+ },
+ },
+ },
+ continuationToken: {
+ serializedName: "NextMarker",
+ xmlName: "NextMarker",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype.getLength = function(cb) {
- var knownLength = this._overheadLength + this._valueLength;
-
- if (this._streams.length) {
- knownLength += this._lastBoundary().length;
- }
-
- if (!this._valuesToMeasure.length) {
- process.nextTick(cb.bind(this, null, knownLength));
- return;
- }
-
- asynckit.parallel(this._valuesToMeasure, this._lengthRetriever, function(err, values) {
- if (err) {
- cb(err);
- return;
- }
-
- values.forEach(function(length) {
- knownLength += length;
- });
-
- cb(null, knownLength);
- });
+const PageRange = {
+ serializedName: "PageRange",
+ xmlName: "PageRange",
+ type: {
+ name: "Composite",
+ className: "PageRange",
+ modelProperties: {
+ start: {
+ serializedName: "Start",
+ required: true,
+ xmlName: "Start",
+ type: {
+ name: "Number",
+ },
+ },
+ end: {
+ serializedName: "End",
+ required: true,
+ xmlName: "End",
+ type: {
+ name: "Number",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype.submit = function(params, cb) {
- var request
- , options
- , defaults = {method: 'post'}
- ;
-
- // parse provided url if it's string
- // or treat it as options object
- if (typeof params == 'string') {
-
- params = parseUrl(params);
- options = populate({
- port: params.port,
- path: params.pathname,
- host: params.hostname,
- protocol: params.protocol
- }, defaults);
-
- // use custom params
- } else {
-
- options = populate(params, defaults);
- // if no port provided use default one
- if (!options.port) {
- options.port = options.protocol == 'https:' ? 443 : 80;
- }
- }
-
- // put that good code in getHeaders to some use
- options.headers = this.getHeaders(params.headers);
-
- // https if specified, fallback to http in any other case
- if (options.protocol == 'https:') {
- request = https.request(options);
- } else {
- request = http.request(options);
- }
-
- // get content length and fire away
- this.getLength(function(err, length) {
- if (err && err !== 'Unknown stream') {
- this._error(err);
- return;
- }
-
- // add content length
- if (length) {
- request.setHeader('Content-Length', length);
- }
-
- this.pipe(request);
- if (cb) {
- var onResponse;
-
- var callback = function (error, responce) {
- request.removeListener('error', callback);
- request.removeListener('response', onResponse);
-
- return cb.call(this, error, responce);
- };
-
- onResponse = callback.bind(this, null);
-
- request.on('error', callback);
- request.on('response', onResponse);
- }
- }.bind(this));
-
- return request;
+const ClearRange = {
+ serializedName: "ClearRange",
+ xmlName: "ClearRange",
+ type: {
+ name: "Composite",
+ className: "ClearRange",
+ modelProperties: {
+ start: {
+ serializedName: "Start",
+ required: true,
+ xmlName: "Start",
+ type: {
+ name: "Number",
+ },
+ },
+ end: {
+ serializedName: "End",
+ required: true,
+ xmlName: "End",
+ type: {
+ name: "Number",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype._error = function(err) {
- if (!this.error) {
- this.error = err;
- this.pause();
- this.emit('error', err);
- }
+const QueryRequest = {
+ serializedName: "QueryRequest",
+ xmlName: "QueryRequest",
+ type: {
+ name: "Composite",
+ className: "QueryRequest",
+ modelProperties: {
+ queryType: {
+ serializedName: "QueryType",
+ required: true,
+ xmlName: "QueryType",
+ type: {
+ name: "String",
+ },
+ },
+ expression: {
+ serializedName: "Expression",
+ required: true,
+ xmlName: "Expression",
+ type: {
+ name: "String",
+ },
+ },
+ inputSerialization: {
+ serializedName: "InputSerialization",
+ xmlName: "InputSerialization",
+ type: {
+ name: "Composite",
+ className: "QuerySerialization",
+ },
+ },
+ outputSerialization: {
+ serializedName: "OutputSerialization",
+ xmlName: "OutputSerialization",
+ type: {
+ name: "Composite",
+ className: "QuerySerialization",
+ },
+ },
+ },
+ },
};
-
-FormData.prototype.toString = function () {
- return '[object FormData]';
+const QuerySerialization = {
+ serializedName: "QuerySerialization",
+ type: {
+ name: "Composite",
+ className: "QuerySerialization",
+ modelProperties: {
+ format: {
+ serializedName: "Format",
+ xmlName: "Format",
+ type: {
+ name: "Composite",
+ className: "QueryFormat",
+ },
+ },
+ },
+ },
};
-
-
-/***/ }),
-
-/***/ 3971:
-/***/ ((module) => {
-
-// populates missing values
-module.exports = function(dst, src) {
-
- Object.keys(src).forEach(function(prop)
- {
- dst[prop] = dst[prop] || src[prop];
- });
-
- return dst;
+const QueryFormat = {
+ serializedName: "QueryFormat",
+ type: {
+ name: "Composite",
+ className: "QueryFormat",
+ modelProperties: {
+ type: {
+ serializedName: "Type",
+ required: true,
+ xmlName: "Type",
+ type: {
+ name: "Enum",
+ allowedValues: ["delimited", "json", "arrow", "parquet"],
+ },
+ },
+ delimitedTextConfiguration: {
+ serializedName: "DelimitedTextConfiguration",
+ xmlName: "DelimitedTextConfiguration",
+ type: {
+ name: "Composite",
+ className: "DelimitedTextConfiguration",
+ },
+ },
+ jsonTextConfiguration: {
+ serializedName: "JsonTextConfiguration",
+ xmlName: "JsonTextConfiguration",
+ type: {
+ name: "Composite",
+ className: "JsonTextConfiguration",
+ },
+ },
+ arrowConfiguration: {
+ serializedName: "ArrowConfiguration",
+ xmlName: "ArrowConfiguration",
+ type: {
+ name: "Composite",
+ className: "ArrowConfiguration",
+ },
+ },
+ parquetTextConfiguration: {
+ serializedName: "ParquetTextConfiguration",
+ xmlName: "ParquetTextConfiguration",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "any" } },
+ },
+ },
+ },
+ },
};
-
-
-/***/ }),
-
-/***/ 3415:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-Object.defineProperty(exports, "v1", ({
- enumerable: true,
- get: function () {
- return _v.default;
- }
-}));
-Object.defineProperty(exports, "v3", ({
- enumerable: true,
- get: function () {
- return _v2.default;
- }
-}));
-Object.defineProperty(exports, "v4", ({
- enumerable: true,
- get: function () {
- return _v3.default;
- }
-}));
-Object.defineProperty(exports, "v5", ({
- enumerable: true,
- get: function () {
- return _v4.default;
- }
-}));
-Object.defineProperty(exports, "NIL", ({
- enumerable: true,
- get: function () {
- return _nil.default;
- }
-}));
-Object.defineProperty(exports, "version", ({
- enumerable: true,
- get: function () {
- return _version.default;
- }
-}));
-Object.defineProperty(exports, "validate", ({
- enumerable: true,
- get: function () {
- return _validate.default;
- }
-}));
-Object.defineProperty(exports, "stringify", ({
- enumerable: true,
- get: function () {
- return _stringify.default;
- }
-}));
-Object.defineProperty(exports, "parse", ({
- enumerable: true,
- get: function () {
- return _parse.default;
- }
-}));
-
-var _v = _interopRequireDefault(__nccwpck_require__(4757));
-
-var _v2 = _interopRequireDefault(__nccwpck_require__(9982));
-
-var _v3 = _interopRequireDefault(__nccwpck_require__(5393));
-
-var _v4 = _interopRequireDefault(__nccwpck_require__(8788));
-
-var _nil = _interopRequireDefault(__nccwpck_require__(657));
-
-var _version = _interopRequireDefault(__nccwpck_require__(7909));
-
-var _validate = _interopRequireDefault(__nccwpck_require__(4418));
-
-var _stringify = _interopRequireDefault(__nccwpck_require__(4794));
-
-var _parse = _interopRequireDefault(__nccwpck_require__(7079));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/***/ }),
-
-/***/ 4153:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _crypto = _interopRequireDefault(__nccwpck_require__(6113));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function md5(bytes) {
- if (Array.isArray(bytes)) {
- bytes = Buffer.from(bytes);
- } else if (typeof bytes === 'string') {
- bytes = Buffer.from(bytes, 'utf8');
- }
-
- return _crypto.default.createHash('md5').update(bytes).digest();
-}
-
-var _default = md5;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 657:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-var _default = '00000000-0000-0000-0000-000000000000';
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 7079:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _validate = _interopRequireDefault(__nccwpck_require__(4418));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function parse(uuid) {
- if (!(0, _validate.default)(uuid)) {
- throw TypeError('Invalid UUID');
- }
-
- let v;
- const arr = new Uint8Array(16); // Parse ########-....-....-....-............
-
- arr[0] = (v = parseInt(uuid.slice(0, 8), 16)) >>> 24;
- arr[1] = v >>> 16 & 0xff;
- arr[2] = v >>> 8 & 0xff;
- arr[3] = v & 0xff; // Parse ........-####-....-....-............
-
- arr[4] = (v = parseInt(uuid.slice(9, 13), 16)) >>> 8;
- arr[5] = v & 0xff; // Parse ........-....-####-....-............
-
- arr[6] = (v = parseInt(uuid.slice(14, 18), 16)) >>> 8;
- arr[7] = v & 0xff; // Parse ........-....-....-####-............
-
- arr[8] = (v = parseInt(uuid.slice(19, 23), 16)) >>> 8;
- arr[9] = v & 0xff; // Parse ........-....-....-....-############
- // (Use "/" to avoid 32-bit truncation when bit-shifting high-order bytes)
-
- arr[10] = (v = parseInt(uuid.slice(24, 36), 16)) / 0x10000000000 & 0xff;
- arr[11] = v / 0x100000000 & 0xff;
- arr[12] = v >>> 24 & 0xff;
- arr[13] = v >>> 16 & 0xff;
- arr[14] = v >>> 8 & 0xff;
- arr[15] = v & 0xff;
- return arr;
-}
-
-var _default = parse;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 690:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-var _default = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 979:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = rng;
-
-var _crypto = _interopRequireDefault(__nccwpck_require__(6113));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const rnds8Pool = new Uint8Array(256); // # of random values to pre-allocate
-
-let poolPtr = rnds8Pool.length;
-
-function rng() {
- if (poolPtr > rnds8Pool.length - 16) {
- _crypto.default.randomFillSync(rnds8Pool);
-
- poolPtr = 0;
- }
-
- return rnds8Pool.slice(poolPtr, poolPtr += 16);
-}
-
-/***/ }),
-
-/***/ 6631:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _crypto = _interopRequireDefault(__nccwpck_require__(6113));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function sha1(bytes) {
- if (Array.isArray(bytes)) {
- bytes = Buffer.from(bytes);
- } else if (typeof bytes === 'string') {
- bytes = Buffer.from(bytes, 'utf8');
- }
-
- return _crypto.default.createHash('sha1').update(bytes).digest();
-}
-
-var _default = sha1;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 4794:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _validate = _interopRequireDefault(__nccwpck_require__(4418));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * Convert array of 16 byte values to UUID string format of the form:
- * XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
- */
-const byteToHex = [];
-
-for (let i = 0; i < 256; ++i) {
- byteToHex.push((i + 0x100).toString(16).substr(1));
-}
-
-function stringify(arr, offset = 0) {
- // Note: Be careful editing this code! It's been tuned for performance
- // and works in ways you may not expect. See https://github.com/uuidjs/uuid/pull/434
- const uuid = (byteToHex[arr[offset + 0]] + byteToHex[arr[offset + 1]] + byteToHex[arr[offset + 2]] + byteToHex[arr[offset + 3]] + '-' + byteToHex[arr[offset + 4]] + byteToHex[arr[offset + 5]] + '-' + byteToHex[arr[offset + 6]] + byteToHex[arr[offset + 7]] + '-' + byteToHex[arr[offset + 8]] + byteToHex[arr[offset + 9]] + '-' + byteToHex[arr[offset + 10]] + byteToHex[arr[offset + 11]] + byteToHex[arr[offset + 12]] + byteToHex[arr[offset + 13]] + byteToHex[arr[offset + 14]] + byteToHex[arr[offset + 15]]).toLowerCase(); // Consistency check for valid UUID. If this throws, it's likely due to one
- // of the following:
- // - One or more input array values don't map to a hex octet (leading to
- // "undefined" in the uuid)
- // - Invalid input values for the RFC `version` or `variant` fields
-
- if (!(0, _validate.default)(uuid)) {
- throw TypeError('Stringified UUID is invalid');
- }
-
- return uuid;
-}
-
-var _default = stringify;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 4757:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _rng = _interopRequireDefault(__nccwpck_require__(979));
-
-var _stringify = _interopRequireDefault(__nccwpck_require__(4794));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-// **`v1()` - Generate time-based UUID**
-//
-// Inspired by https://github.com/LiosK/UUID.js
-// and http://docs.python.org/library/uuid.html
-let _nodeId;
-
-let _clockseq; // Previous uuid creation time
-
-
-let _lastMSecs = 0;
-let _lastNSecs = 0; // See https://github.com/uuidjs/uuid for API details
-
-function v1(options, buf, offset) {
- let i = buf && offset || 0;
- const b = buf || new Array(16);
- options = options || {};
- let node = options.node || _nodeId;
- let clockseq = options.clockseq !== undefined ? options.clockseq : _clockseq; // node and clockseq need to be initialized to random values if they're not
- // specified. We do this lazily to minimize issues related to insufficient
- // system entropy. See #189
-
- if (node == null || clockseq == null) {
- const seedBytes = options.random || (options.rng || _rng.default)();
-
- if (node == null) {
- // Per 4.5, create and 48-bit node id, (47 random bits + multicast bit = 1)
- node = _nodeId = [seedBytes[0] | 0x01, seedBytes[1], seedBytes[2], seedBytes[3], seedBytes[4], seedBytes[5]];
- }
-
- if (clockseq == null) {
- // Per 4.2.2, randomize (14 bit) clockseq
- clockseq = _clockseq = (seedBytes[6] << 8 | seedBytes[7]) & 0x3fff;
- }
- } // UUID timestamps are 100 nano-second units since the Gregorian epoch,
- // (1582-10-15 00:00). JSNumbers aren't precise enough for this, so
- // time is handled internally as 'msecs' (integer milliseconds) and 'nsecs'
- // (100-nanoseconds offset from msecs) since unix epoch, 1970-01-01 00:00.
-
-
- let msecs = options.msecs !== undefined ? options.msecs : Date.now(); // Per 4.2.1.2, use count of uuid's generated during the current clock
- // cycle to simulate higher resolution clock
-
- let nsecs = options.nsecs !== undefined ? options.nsecs : _lastNSecs + 1; // Time since last uuid creation (in msecs)
-
- const dt = msecs - _lastMSecs + (nsecs - _lastNSecs) / 10000; // Per 4.2.1.2, Bump clockseq on clock regression
-
- if (dt < 0 && options.clockseq === undefined) {
- clockseq = clockseq + 1 & 0x3fff;
- } // Reset nsecs if clock regresses (new clockseq) or we've moved onto a new
- // time interval
-
-
- if ((dt < 0 || msecs > _lastMSecs) && options.nsecs === undefined) {
- nsecs = 0;
- } // Per 4.2.1.2 Throw error if too many uuids are requested
-
-
- if (nsecs >= 10000) {
- throw new Error("uuid.v1(): Can't create more than 10M uuids/sec");
- }
-
- _lastMSecs = msecs;
- _lastNSecs = nsecs;
- _clockseq = clockseq; // Per 4.1.4 - Convert from unix epoch to Gregorian epoch
-
- msecs += 12219292800000; // `time_low`
-
- const tl = ((msecs & 0xfffffff) * 10000 + nsecs) % 0x100000000;
- b[i++] = tl >>> 24 & 0xff;
- b[i++] = tl >>> 16 & 0xff;
- b[i++] = tl >>> 8 & 0xff;
- b[i++] = tl & 0xff; // `time_mid`
-
- const tmh = msecs / 0x100000000 * 10000 & 0xfffffff;
- b[i++] = tmh >>> 8 & 0xff;
- b[i++] = tmh & 0xff; // `time_high_and_version`
-
- b[i++] = tmh >>> 24 & 0xf | 0x10; // include version
-
- b[i++] = tmh >>> 16 & 0xff; // `clock_seq_hi_and_reserved` (Per 4.2.2 - include variant)
-
- b[i++] = clockseq >>> 8 | 0x80; // `clock_seq_low`
-
- b[i++] = clockseq & 0xff; // `node`
-
- for (let n = 0; n < 6; ++n) {
- b[i + n] = node[n];
- }
-
- return buf || (0, _stringify.default)(b);
-}
-
-var _default = v1;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 9982:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _v = _interopRequireDefault(__nccwpck_require__(4085));
-
-var _md = _interopRequireDefault(__nccwpck_require__(4153));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const v3 = (0, _v.default)('v3', 0x30, _md.default);
-var _default = v3;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 4085:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = _default;
-exports.URL = exports.DNS = void 0;
-
-var _stringify = _interopRequireDefault(__nccwpck_require__(4794));
-
-var _parse = _interopRequireDefault(__nccwpck_require__(7079));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function stringToBytes(str) {
- str = unescape(encodeURIComponent(str)); // UTF8 escape
-
- const bytes = [];
-
- for (let i = 0; i < str.length; ++i) {
- bytes.push(str.charCodeAt(i));
- }
-
- return bytes;
-}
-
-const DNS = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
-exports.DNS = DNS;
-const URL = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
-exports.URL = URL;
-
-function _default(name, version, hashfunc) {
- function generateUUID(value, namespace, buf, offset) {
- if (typeof value === 'string') {
- value = stringToBytes(value);
- }
-
- if (typeof namespace === 'string') {
- namespace = (0, _parse.default)(namespace);
- }
-
- if (namespace.length !== 16) {
- throw TypeError('Namespace must be array-like (16 iterable integer values, 0-255)');
- } // Compute hash of namespace and value, Per 4.3
- // Future: Use spread syntax when supported on all platforms, e.g. `bytes =
- // hashfunc([...namespace, ... value])`
-
-
- let bytes = new Uint8Array(16 + value.length);
- bytes.set(namespace);
- bytes.set(value, namespace.length);
- bytes = hashfunc(bytes);
- bytes[6] = bytes[6] & 0x0f | version;
- bytes[8] = bytes[8] & 0x3f | 0x80;
-
- if (buf) {
- offset = offset || 0;
-
- for (let i = 0; i < 16; ++i) {
- buf[offset + i] = bytes[i];
- }
-
- return buf;
- }
-
- return (0, _stringify.default)(bytes);
- } // Function#name is not settable on some platforms (#270)
-
-
- try {
- generateUUID.name = name; // eslint-disable-next-line no-empty
- } catch (err) {} // For CommonJS default export support
-
-
- generateUUID.DNS = DNS;
- generateUUID.URL = URL;
- return generateUUID;
-}
-
-/***/ }),
-
-/***/ 5393:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _rng = _interopRequireDefault(__nccwpck_require__(979));
-
-var _stringify = _interopRequireDefault(__nccwpck_require__(4794));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function v4(options, buf, offset) {
- options = options || {};
-
- const rnds = options.random || (options.rng || _rng.default)(); // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
-
-
- rnds[6] = rnds[6] & 0x0f | 0x40;
- rnds[8] = rnds[8] & 0x3f | 0x80; // Copy bytes to buffer, if provided
-
- if (buf) {
- offset = offset || 0;
-
- for (let i = 0; i < 16; ++i) {
- buf[offset + i] = rnds[i];
- }
-
- return buf;
- }
-
- return (0, _stringify.default)(rnds);
-}
-
-var _default = v4;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 8788:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _v = _interopRequireDefault(__nccwpck_require__(4085));
-
-var _sha = _interopRequireDefault(__nccwpck_require__(6631));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const v5 = (0, _v.default)('v5', 0x50, _sha.default);
-var _default = v5;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 4418:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _regex = _interopRequireDefault(__nccwpck_require__(690));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function validate(uuid) {
- return typeof uuid === 'string' && _regex.default.test(uuid);
-}
-
-var _default = validate;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 7909:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({
- value: true
-}));
-exports["default"] = void 0;
-
-var _validate = _interopRequireDefault(__nccwpck_require__(4418));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function version(uuid) {
- if (!(0, _validate.default)(uuid)) {
- throw TypeError('Invalid UUID');
- }
-
- return parseInt(uuid.substr(14, 1), 16);
-}
-
-var _default = version;
-exports["default"] = _default;
-
-/***/ }),
-
-/***/ 7094:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-
-var logger$1 = __nccwpck_require__(3233);
-var abortController = __nccwpck_require__(2557);
-var coreUtil = __nccwpck_require__(1333);
-
-// Copyright (c) Microsoft Corporation.
-/**
- * The `@azure/logger` configuration for this package.
- * @internal
- */
-const logger = logger$1.createClientLogger("core-lro");
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * The default time interval to wait before sending the next polling request.
- */
-const POLL_INTERVAL_IN_MS = 2000;
-/**
- * The closed set of terminal states.
- */
-const terminalStates = ["succeeded", "canceled", "failed"];
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Deserializes the state
- */
-function deserializeState(serializedState) {
- try {
- return JSON.parse(serializedState).state;
- }
- catch (e) {
- throw new Error(`Unable to deserialize input state: ${serializedState}`);
- }
-}
-function setStateError(inputs) {
- const { state, stateProxy, isOperationError } = inputs;
- return (error) => {
- if (isOperationError(error)) {
- stateProxy.setError(state, error);
- stateProxy.setFailed(state);
- }
- throw error;
- };
-}
-function appendReadableErrorMessage(currentMessage, innerMessage) {
- let message = currentMessage;
- if (message.slice(-1) !== ".") {
- message = message + ".";
- }
- return message + " " + innerMessage;
-}
-function simplifyError(err) {
- let message = err.message;
- let code = err.code;
- let curErr = err;
- while (curErr.innererror) {
- curErr = curErr.innererror;
- code = curErr.code;
- message = appendReadableErrorMessage(message, curErr.message);
- }
- return {
- code,
- message,
- };
-}
-function processOperationStatus(result) {
- const { state, stateProxy, status, isDone, processResult, getError, response, setErrorAsResult } = result;
- switch (status) {
- case "succeeded": {
- stateProxy.setSucceeded(state);
- break;
- }
- case "failed": {
- const err = getError === null || getError === void 0 ? void 0 : getError(response);
- let postfix = "";
- if (err) {
- const { code, message } = simplifyError(err);
- postfix = `. ${code}. ${message}`;
- }
- const errStr = `The long-running operation has failed${postfix}`;
- stateProxy.setError(state, new Error(errStr));
- stateProxy.setFailed(state);
- logger.warning(errStr);
- break;
- }
- case "canceled": {
- stateProxy.setCanceled(state);
- break;
- }
- }
- if ((isDone === null || isDone === void 0 ? void 0 : isDone(response, state)) ||
- (isDone === undefined &&
- ["succeeded", "canceled"].concat(setErrorAsResult ? [] : ["failed"]).includes(status))) {
- stateProxy.setResult(state, buildResult({
- response,
- state,
- processResult,
- }));
- }
-}
-function buildResult(inputs) {
- const { processResult, response, state } = inputs;
- return processResult ? processResult(response, state) : response;
-}
-/**
- * Initiates the long-running operation.
- */
-async function initOperation(inputs) {
- const { init, stateProxy, processResult, getOperationStatus, withOperationLocation, setErrorAsResult, } = inputs;
- const { operationLocation, resourceLocation, metadata, response } = await init();
- if (operationLocation)
- withOperationLocation === null || withOperationLocation === void 0 ? void 0 : withOperationLocation(operationLocation, false);
- const config = {
- metadata,
- operationLocation,
- resourceLocation,
- };
- logger.verbose(`LRO: Operation description:`, config);
- const state = stateProxy.initState(config);
- const status = getOperationStatus({ response, state, operationLocation });
- processOperationStatus({ state, status, stateProxy, response, setErrorAsResult, processResult });
- return state;
-}
-async function pollOperationHelper(inputs) {
- const { poll, state, stateProxy, operationLocation, getOperationStatus, getResourceLocation, isOperationError, options, } = inputs;
- const response = await poll(operationLocation, options).catch(setStateError({
- state,
- stateProxy,
- isOperationError,
- }));
- const status = getOperationStatus(response, state);
- logger.verbose(`LRO: Status:\n\tPolling from: ${state.config.operationLocation}\n\tOperation status: ${status}\n\tPolling status: ${terminalStates.includes(status) ? "Stopped" : "Running"}`);
- if (status === "succeeded") {
- const resourceLocation = getResourceLocation(response, state);
- if (resourceLocation !== undefined) {
- return {
- response: await poll(resourceLocation).catch(setStateError({ state, stateProxy, isOperationError })),
- status,
- };
- }
- }
- return { response, status };
-}
-/** Polls the long-running operation. */
-async function pollOperation(inputs) {
- const { poll, state, stateProxy, options, getOperationStatus, getResourceLocation, getOperationLocation, isOperationError, withOperationLocation, getPollingInterval, processResult, getError, updateState, setDelay, isDone, setErrorAsResult, } = inputs;
- const { operationLocation } = state.config;
- if (operationLocation !== undefined) {
- const { response, status } = await pollOperationHelper({
- poll,
- getOperationStatus,
- state,
- stateProxy,
- operationLocation,
- getResourceLocation,
- isOperationError,
- options,
- });
- processOperationStatus({
- status,
- response,
- state,
- stateProxy,
- isDone,
- processResult,
- getError,
- setErrorAsResult,
- });
- if (!terminalStates.includes(status)) {
- const intervalInMs = getPollingInterval === null || getPollingInterval === void 0 ? void 0 : getPollingInterval(response);
- if (intervalInMs)
- setDelay(intervalInMs);
- const location = getOperationLocation === null || getOperationLocation === void 0 ? void 0 : getOperationLocation(response, state);
- if (location !== undefined) {
- const isUpdated = operationLocation !== location;
- state.config.operationLocation = location;
- withOperationLocation === null || withOperationLocation === void 0 ? void 0 : withOperationLocation(location, isUpdated);
- }
- else
- withOperationLocation === null || withOperationLocation === void 0 ? void 0 : withOperationLocation(operationLocation, false);
- }
- updateState === null || updateState === void 0 ? void 0 : updateState(state, response);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-function getOperationLocationPollingUrl(inputs) {
- const { azureAsyncOperation, operationLocation } = inputs;
- return operationLocation !== null && operationLocation !== void 0 ? operationLocation : azureAsyncOperation;
-}
-function getLocationHeader(rawResponse) {
- return rawResponse.headers["location"];
-}
-function getOperationLocationHeader(rawResponse) {
- return rawResponse.headers["operation-location"];
-}
-function getAzureAsyncOperationHeader(rawResponse) {
- return rawResponse.headers["azure-asyncoperation"];
-}
-function findResourceLocation(inputs) {
- var _a;
- const { location, requestMethod, requestPath, resourceLocationConfig } = inputs;
- switch (requestMethod) {
- case "PUT": {
- return requestPath;
- }
- case "DELETE": {
- return undefined;
- }
- case "PATCH": {
- return (_a = getDefault()) !== null && _a !== void 0 ? _a : requestPath;
- }
- default: {
- return getDefault();
- }
- }
- function getDefault() {
- switch (resourceLocationConfig) {
- case "azure-async-operation": {
- return undefined;
- }
- case "original-uri": {
- return requestPath;
- }
- case "location":
- default: {
- return location;
- }
- }
- }
-}
-function inferLroMode(inputs) {
- const { rawResponse, requestMethod, requestPath, resourceLocationConfig } = inputs;
- const operationLocation = getOperationLocationHeader(rawResponse);
- const azureAsyncOperation = getAzureAsyncOperationHeader(rawResponse);
- const pollingUrl = getOperationLocationPollingUrl({ operationLocation, azureAsyncOperation });
- const location = getLocationHeader(rawResponse);
- const normalizedRequestMethod = requestMethod === null || requestMethod === void 0 ? void 0 : requestMethod.toLocaleUpperCase();
- if (pollingUrl !== undefined) {
- return {
- mode: "OperationLocation",
- operationLocation: pollingUrl,
- resourceLocation: findResourceLocation({
- requestMethod: normalizedRequestMethod,
- location,
- requestPath,
- resourceLocationConfig,
- }),
- };
- }
- else if (location !== undefined) {
- return {
- mode: "ResourceLocation",
- operationLocation: location,
- };
- }
- else if (normalizedRequestMethod === "PUT" && requestPath) {
- return {
- mode: "Body",
- operationLocation: requestPath,
- };
- }
- else {
- return undefined;
- }
-}
-function transformStatus(inputs) {
- const { status, statusCode } = inputs;
- if (typeof status !== "string" && status !== undefined) {
- throw new Error(`Polling was unsuccessful. Expected status to have a string value or no value but it has instead: ${status}. This doesn't necessarily indicate the operation has failed. Check your Azure subscription or resource status for more information.`);
- }
- switch (status === null || status === void 0 ? void 0 : status.toLocaleLowerCase()) {
- case undefined:
- return toOperationStatus(statusCode);
- case "succeeded":
- return "succeeded";
- case "failed":
- return "failed";
- case "running":
- case "accepted":
- case "started":
- case "canceling":
- case "cancelling":
- return "running";
- case "canceled":
- case "cancelled":
- return "canceled";
- default: {
- logger.verbose(`LRO: unrecognized operation status: ${status}`);
- return status;
- }
- }
-}
-function getStatus(rawResponse) {
- var _a;
- const { status } = (_a = rawResponse.body) !== null && _a !== void 0 ? _a : {};
- return transformStatus({ status, statusCode: rawResponse.statusCode });
-}
-function getProvisioningState(rawResponse) {
- var _a, _b;
- const { properties, provisioningState } = (_a = rawResponse.body) !== null && _a !== void 0 ? _a : {};
- const status = (_b = properties === null || properties === void 0 ? void 0 : properties.provisioningState) !== null && _b !== void 0 ? _b : provisioningState;
- return transformStatus({ status, statusCode: rawResponse.statusCode });
-}
-function toOperationStatus(statusCode) {
- if (statusCode === 202) {
- return "running";
- }
- else if (statusCode < 300) {
- return "succeeded";
- }
- else {
- return "failed";
- }
-}
-function parseRetryAfter({ rawResponse }) {
- const retryAfter = rawResponse.headers["retry-after"];
- if (retryAfter !== undefined) {
- // Retry-After header value is either in HTTP date format, or in seconds
- const retryAfterInSeconds = parseInt(retryAfter);
- return isNaN(retryAfterInSeconds)
- ? calculatePollingIntervalFromDate(new Date(retryAfter))
- : retryAfterInSeconds * 1000;
- }
- return undefined;
-}
-function getErrorFromResponse(response) {
- const error = response.flatResponse.error;
- if (!error) {
- logger.warning(`The long-running operation failed but there is no error property in the response's body`);
- return;
- }
- if (!error.code || !error.message) {
- logger.warning(`The long-running operation failed but the error property in the response's body doesn't contain code or message`);
- return;
- }
- return error;
-}
-function calculatePollingIntervalFromDate(retryAfterDate) {
- const timeNow = Math.floor(new Date().getTime());
- const retryAfterTime = retryAfterDate.getTime();
- if (timeNow < retryAfterTime) {
- return retryAfterTime - timeNow;
- }
- return undefined;
-}
-function getStatusFromInitialResponse(inputs) {
- const { response, state, operationLocation } = inputs;
- function helper() {
- var _a;
- const mode = (_a = state.config.metadata) === null || _a === void 0 ? void 0 : _a["mode"];
- switch (mode) {
- case undefined:
- return toOperationStatus(response.rawResponse.statusCode);
- case "Body":
- return getOperationStatus(response, state);
- default:
- return "running";
- }
- }
- const status = helper();
- return status === "running" && operationLocation === undefined ? "succeeded" : status;
-}
-/**
- * Initiates the long-running operation.
- */
-async function initHttpOperation(inputs) {
- const { stateProxy, resourceLocationConfig, processResult, lro, setErrorAsResult } = inputs;
- return initOperation({
- init: async () => {
- const response = await lro.sendInitialRequest();
- const config = inferLroMode({
- rawResponse: response.rawResponse,
- requestPath: lro.requestPath,
- requestMethod: lro.requestMethod,
- resourceLocationConfig,
- });
- return Object.assign({ response, operationLocation: config === null || config === void 0 ? void 0 : config.operationLocation, resourceLocation: config === null || config === void 0 ? void 0 : config.resourceLocation }, ((config === null || config === void 0 ? void 0 : config.mode) ? { metadata: { mode: config.mode } } : {}));
- },
- stateProxy,
- processResult: processResult
- ? ({ flatResponse }, state) => processResult(flatResponse, state)
- : ({ flatResponse }) => flatResponse,
- getOperationStatus: getStatusFromInitialResponse,
- setErrorAsResult,
- });
-}
-function getOperationLocation({ rawResponse }, state) {
- var _a;
- const mode = (_a = state.config.metadata) === null || _a === void 0 ? void 0 : _a["mode"];
- switch (mode) {
- case "OperationLocation": {
- return getOperationLocationPollingUrl({
- operationLocation: getOperationLocationHeader(rawResponse),
- azureAsyncOperation: getAzureAsyncOperationHeader(rawResponse),
- });
- }
- case "ResourceLocation": {
- return getLocationHeader(rawResponse);
- }
- case "Body":
- default: {
- return undefined;
- }
- }
-}
-function getOperationStatus({ rawResponse }, state) {
- var _a;
- const mode = (_a = state.config.metadata) === null || _a === void 0 ? void 0 : _a["mode"];
- switch (mode) {
- case "OperationLocation": {
- return getStatus(rawResponse);
- }
- case "ResourceLocation": {
- return toOperationStatus(rawResponse.statusCode);
- }
- case "Body": {
- return getProvisioningState(rawResponse);
- }
- default:
- throw new Error(`Internal error: Unexpected operation mode: ${mode}`);
- }
-}
-function getResourceLocation({ flatResponse }, state) {
- if (typeof flatResponse === "object") {
- const resourceLocation = flatResponse.resourceLocation;
- if (resourceLocation !== undefined) {
- state.config.resourceLocation = resourceLocation;
- }
- }
- return state.config.resourceLocation;
-}
-function isOperationError(e) {
- return e.name === "RestError";
-}
-/** Polls the long-running operation. */
-async function pollHttpOperation(inputs) {
- const { lro, stateProxy, options, processResult, updateState, setDelay, state, setErrorAsResult, } = inputs;
- return pollOperation({
- state,
- stateProxy,
- setDelay,
- processResult: processResult
- ? ({ flatResponse }, inputState) => processResult(flatResponse, inputState)
- : ({ flatResponse }) => flatResponse,
- getError: getErrorFromResponse,
- updateState,
- getPollingInterval: parseRetryAfter,
- getOperationLocation,
- getOperationStatus,
- isOperationError,
- getResourceLocation,
- options,
- /**
- * The expansion here is intentional because `lro` could be an object that
- * references an inner this, so we need to preserve a reference to it.
- */
- poll: async (location, inputOptions) => lro.sendPollRequest(location, inputOptions),
- setErrorAsResult,
- });
-}
-
-// Copyright (c) Microsoft Corporation.
-const createStateProxy$1 = () => ({
- /**
- * The state at this point is created to be of type OperationState.
- * It will be updated later to be of type TState when the
- * customer-provided callback, `updateState`, is called during polling.
- */
- initState: (config) => ({ status: "running", config }),
- setCanceled: (state) => (state.status = "canceled"),
- setError: (state, error) => (state.error = error),
- setResult: (state, result) => (state.result = result),
- setRunning: (state) => (state.status = "running"),
- setSucceeded: (state) => (state.status = "succeeded"),
- setFailed: (state) => (state.status = "failed"),
- getError: (state) => state.error,
- getResult: (state) => state.result,
- isCanceled: (state) => state.status === "canceled",
- isFailed: (state) => state.status === "failed",
- isRunning: (state) => state.status === "running",
- isSucceeded: (state) => state.status === "succeeded",
-});
-/**
- * Returns a poller factory.
- */
-function buildCreatePoller(inputs) {
- const { getOperationLocation, getStatusFromInitialResponse, getStatusFromPollResponse, isOperationError, getResourceLocation, getPollingInterval, getError, resolveOnUnsuccessful, } = inputs;
- return async ({ init, poll }, options) => {
- const { processResult, updateState, withOperationLocation: withOperationLocationCallback, intervalInMs = POLL_INTERVAL_IN_MS, restoreFrom, } = options || {};
- const stateProxy = createStateProxy$1();
- const withOperationLocation = withOperationLocationCallback
- ? (() => {
- let called = false;
- return (operationLocation, isUpdated) => {
- if (isUpdated)
- withOperationLocationCallback(operationLocation);
- else if (!called)
- withOperationLocationCallback(operationLocation);
- called = true;
- };
- })()
- : undefined;
- const state = restoreFrom
- ? deserializeState(restoreFrom)
- : await initOperation({
- init,
- stateProxy,
- processResult,
- getOperationStatus: getStatusFromInitialResponse,
- withOperationLocation,
- setErrorAsResult: !resolveOnUnsuccessful,
- });
- let resultPromise;
- const abortController$1 = new abortController.AbortController();
- const handlers = new Map();
- const handleProgressEvents = async () => handlers.forEach((h) => h(state));
- const cancelErrMsg = "Operation was canceled";
- let currentPollIntervalInMs = intervalInMs;
- const poller = {
- getOperationState: () => state,
- getResult: () => state.result,
- isDone: () => ["succeeded", "failed", "canceled"].includes(state.status),
- isStopped: () => resultPromise === undefined,
- stopPolling: () => {
- abortController$1.abort();
- },
- toString: () => JSON.stringify({
- state,
- }),
- onProgress: (callback) => {
- const s = Symbol();
- handlers.set(s, callback);
- return () => handlers.delete(s);
- },
- pollUntilDone: (pollOptions) => (resultPromise !== null && resultPromise !== void 0 ? resultPromise : (resultPromise = (async () => {
- const { abortSignal: inputAbortSignal } = pollOptions || {};
- const { signal: abortSignal } = inputAbortSignal
- ? new abortController.AbortController([inputAbortSignal, abortController$1.signal])
- : abortController$1;
- if (!poller.isDone()) {
- await poller.poll({ abortSignal });
- while (!poller.isDone()) {
- await coreUtil.delay(currentPollIntervalInMs, { abortSignal });
- await poller.poll({ abortSignal });
- }
- }
- if (resolveOnUnsuccessful) {
- return poller.getResult();
- }
- else {
- switch (state.status) {
- case "succeeded":
- return poller.getResult();
- case "canceled":
- throw new Error(cancelErrMsg);
- case "failed":
- throw state.error;
- case "notStarted":
- case "running":
- throw new Error(`Polling completed without succeeding or failing`);
- }
- }
- })().finally(() => {
- resultPromise = undefined;
- }))),
- async poll(pollOptions) {
- if (resolveOnUnsuccessful) {
- if (poller.isDone())
- return;
- }
- else {
- switch (state.status) {
- case "succeeded":
- return;
- case "canceled":
- throw new Error(cancelErrMsg);
- case "failed":
- throw state.error;
- }
- }
- await pollOperation({
- poll,
- state,
- stateProxy,
- getOperationLocation,
- isOperationError,
- withOperationLocation,
- getPollingInterval,
- getOperationStatus: getStatusFromPollResponse,
- getResourceLocation,
- processResult,
- getError,
- updateState,
- options: pollOptions,
- setDelay: (pollIntervalInMs) => {
- currentPollIntervalInMs = pollIntervalInMs;
- },
- setErrorAsResult: !resolveOnUnsuccessful,
- });
- await handleProgressEvents();
- if (!resolveOnUnsuccessful) {
- switch (state.status) {
- case "canceled":
- throw new Error(cancelErrMsg);
- case "failed":
- throw state.error;
- }
- }
- },
- };
- return poller;
- };
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Creates a poller that can be used to poll a long-running operation.
- * @param lro - Description of the long-running operation
- * @param options - options to configure the poller
- * @returns an initialized poller
- */
-async function createHttpPoller(lro, options) {
- const { resourceLocationConfig, intervalInMs, processResult, restoreFrom, updateState, withOperationLocation, resolveOnUnsuccessful = false, } = options || {};
- return buildCreatePoller({
- getStatusFromInitialResponse,
- getStatusFromPollResponse: getOperationStatus,
- isOperationError,
- getOperationLocation,
- getResourceLocation,
- getPollingInterval: parseRetryAfter,
- getError: getErrorFromResponse,
- resolveOnUnsuccessful,
- })({
- init: async () => {
- const response = await lro.sendInitialRequest();
- const config = inferLroMode({
- rawResponse: response.rawResponse,
- requestPath: lro.requestPath,
- requestMethod: lro.requestMethod,
- resourceLocationConfig,
- });
- return Object.assign({ response, operationLocation: config === null || config === void 0 ? void 0 : config.operationLocation, resourceLocation: config === null || config === void 0 ? void 0 : config.resourceLocation }, ((config === null || config === void 0 ? void 0 : config.mode) ? { metadata: { mode: config.mode } } : {}));
- },
- poll: lro.sendPollRequest,
- }, {
- intervalInMs,
- withOperationLocation,
- restoreFrom,
- updateState,
- processResult: processResult
- ? ({ flatResponse }, state) => processResult(flatResponse, state)
- : ({ flatResponse }) => flatResponse,
- });
-}
-
-// Copyright (c) Microsoft Corporation.
-const createStateProxy = () => ({
- initState: (config) => ({ config, isStarted: true }),
- setCanceled: (state) => (state.isCancelled = true),
- setError: (state, error) => (state.error = error),
- setResult: (state, result) => (state.result = result),
- setRunning: (state) => (state.isStarted = true),
- setSucceeded: (state) => (state.isCompleted = true),
- setFailed: () => {
- /** empty body */
- },
- getError: (state) => state.error,
- getResult: (state) => state.result,
- isCanceled: (state) => !!state.isCancelled,
- isFailed: (state) => !!state.error,
- isRunning: (state) => !!state.isStarted,
- isSucceeded: (state) => Boolean(state.isCompleted && !state.isCancelled && !state.error),
-});
-class GenericPollOperation {
- constructor(state, lro, setErrorAsResult, lroResourceLocationConfig, processResult, updateState, isDone) {
- this.state = state;
- this.lro = lro;
- this.setErrorAsResult = setErrorAsResult;
- this.lroResourceLocationConfig = lroResourceLocationConfig;
- this.processResult = processResult;
- this.updateState = updateState;
- this.isDone = isDone;
- }
- setPollerConfig(pollerConfig) {
- this.pollerConfig = pollerConfig;
- }
- async update(options) {
- var _a;
- const stateProxy = createStateProxy();
- if (!this.state.isStarted) {
- this.state = Object.assign(Object.assign({}, this.state), (await initHttpOperation({
- lro: this.lro,
- stateProxy,
- resourceLocationConfig: this.lroResourceLocationConfig,
- processResult: this.processResult,
- setErrorAsResult: this.setErrorAsResult,
- })));
- }
- const updateState = this.updateState;
- const isDone = this.isDone;
- if (!this.state.isCompleted && this.state.error === undefined) {
- await pollHttpOperation({
- lro: this.lro,
- state: this.state,
- stateProxy,
- processResult: this.processResult,
- updateState: updateState
- ? (state, { rawResponse }) => updateState(state, rawResponse)
- : undefined,
- isDone: isDone
- ? ({ flatResponse }, state) => isDone(flatResponse, state)
- : undefined,
- options,
- setDelay: (intervalInMs) => {
- this.pollerConfig.intervalInMs = intervalInMs;
- },
- setErrorAsResult: this.setErrorAsResult,
- });
- }
- (_a = options === null || options === void 0 ? void 0 : options.fireProgress) === null || _a === void 0 ? void 0 : _a.call(options, this.state);
- return this;
- }
- async cancel() {
- logger.error("`cancelOperation` is deprecated because it wasn't implemented");
- return this;
- }
- /**
- * Serializes the Poller operation.
- */
- toString() {
- return JSON.stringify({
- state: this.state,
- });
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * When a poller is manually stopped through the `stopPolling` method,
- * the poller will be rejected with an instance of the PollerStoppedError.
- */
-class PollerStoppedError extends Error {
- constructor(message) {
- super(message);
- this.name = "PollerStoppedError";
- Object.setPrototypeOf(this, PollerStoppedError.prototype);
- }
-}
-/**
- * When the operation is cancelled, the poller will be rejected with an instance
- * of the PollerCancelledError.
- */
-class PollerCancelledError extends Error {
- constructor(message) {
- super(message);
- this.name = "PollerCancelledError";
- Object.setPrototypeOf(this, PollerCancelledError.prototype);
- }
-}
-/**
- * A class that represents the definition of a program that polls through consecutive requests
- * until it reaches a state of completion.
- *
- * A poller can be executed manually, by polling request by request by calling to the `poll()` method repeatedly, until its operation is completed.
- * It also provides a way to wait until the operation completes, by calling `pollUntilDone()` and waiting until the operation finishes.
- * Pollers can also request the cancellation of the ongoing process to whom is providing the underlying long running operation.
- *
- * ```ts
- * const poller = new MyPoller();
- *
- * // Polling just once:
- * await poller.poll();
- *
- * // We can try to cancel the request here, by calling:
- * //
- * // await poller.cancelOperation();
- * //
- *
- * // Getting the final result:
- * const result = await poller.pollUntilDone();
- * ```
- *
- * The Poller is defined by two types, a type representing the state of the poller, which
- * must include a basic set of properties from `PollOperationState`,
- * and a return type defined by `TResult`, which can be anything.
- *
- * The Poller class implements the `PollerLike` interface, which allows poller implementations to avoid having
- * to export the Poller's class directly, and instead only export the already instantiated poller with the PollerLike type.
- *
- * ```ts
- * class Client {
- * public async makePoller: PollerLike {
- * const poller = new MyPoller({});
- * // It might be preferred to return the poller after the first request is made,
- * // so that some information can be obtained right away.
- * await poller.poll();
- * return poller;
- * }
- * }
- *
- * const poller: PollerLike = myClient.makePoller();
- * ```
- *
- * A poller can be created through its constructor, then it can be polled until it's completed.
- * At any point in time, the state of the poller can be obtained without delay through the getOperationState method.
- * At any point in time, the intermediate forms of the result type can be requested without delay.
- * Once the underlying operation is marked as completed, the poller will stop and the final value will be returned.
- *
- * ```ts
- * const poller = myClient.makePoller();
- * const state: MyOperationState = poller.getOperationState();
- *
- * // The intermediate result can be obtained at any time.
- * const result: MyResult | undefined = poller.getResult();
- *
- * // The final result can only be obtained after the poller finishes.
- * const result: MyResult = await poller.pollUntilDone();
- * ```
- *
- */
-// eslint-disable-next-line no-use-before-define
-class Poller {
- /**
- * A poller needs to be initialized by passing in at least the basic properties of the `PollOperation`.
- *
- * When writing an implementation of a Poller, this implementation needs to deal with the initialization
- * of any custom state beyond the basic definition of the poller. The basic poller assumes that the poller's
- * operation has already been defined, at least its basic properties. The code below shows how to approach
- * the definition of the constructor of a new custom poller.
- *
- * ```ts
- * export class MyPoller extends Poller {
- * constructor({
- * // Anything you might need outside of the basics
- * }) {
- * let state: MyOperationState = {
- * privateProperty: private,
- * publicProperty: public,
- * };
- *
- * const operation = {
- * state,
- * update,
- * cancel,
- * toString
- * }
- *
- * // Sending the operation to the parent's constructor.
- * super(operation);
- *
- * // You can assign more local properties here.
- * }
- * }
- * ```
- *
- * Inside of this constructor, a new promise is created. This will be used to
- * tell the user when the poller finishes (see `pollUntilDone()`). The promise's
- * resolve and reject methods are also used internally to control when to resolve
- * or reject anyone waiting for the poller to finish.
- *
- * The constructor of a custom implementation of a poller is where any serialized version of
- * a previous poller's operation should be deserialized into the operation sent to the
- * base constructor. For example:
- *
- * ```ts
- * export class MyPoller extends Poller {
- * constructor(
- * baseOperation: string | undefined
- * ) {
- * let state: MyOperationState = {};
- * if (baseOperation) {
- * state = {
- * ...JSON.parse(baseOperation).state,
- * ...state
- * };
- * }
- * const operation = {
- * state,
- * // ...
- * }
- * super(operation);
- * }
- * }
- * ```
- *
- * @param operation - Must contain the basic properties of `PollOperation`.
- */
- constructor(operation) {
- /** controls whether to throw an error if the operation failed or was canceled. */
- this.resolveOnUnsuccessful = false;
- this.stopped = true;
- this.pollProgressCallbacks = [];
- this.operation = operation;
- this.promise = new Promise((resolve, reject) => {
- this.resolve = resolve;
- this.reject = reject;
- });
- // This prevents the UnhandledPromiseRejectionWarning in node.js from being thrown.
- // The above warning would get thrown if `poller.poll` is called, it returns an error,
- // and pullUntilDone did not have a .catch or await try/catch on it's return value.
- this.promise.catch(() => {
- /* intentionally blank */
- });
- }
- /**
- * Starts a loop that will break only if the poller is done
- * or if the poller is stopped.
- */
- async startPolling(pollOptions = {}) {
- if (this.stopped) {
- this.stopped = false;
- }
- while (!this.isStopped() && !this.isDone()) {
- await this.poll(pollOptions);
- await this.delay();
- }
- }
- /**
- * pollOnce does one polling, by calling to the update method of the underlying
- * poll operation to make any relevant change effective.
- *
- * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
- *
- * @param options - Optional properties passed to the operation's update method.
- */
- async pollOnce(options = {}) {
- if (!this.isDone()) {
- this.operation = await this.operation.update({
- abortSignal: options.abortSignal,
- fireProgress: this.fireProgress.bind(this),
- });
- }
- this.processUpdatedState();
- }
- /**
- * fireProgress calls the functions passed in via onProgress the method of the poller.
- *
- * It loops over all of the callbacks received from onProgress, and executes them, sending them
- * the current operation state.
- *
- * @param state - The current operation state.
- */
- fireProgress(state) {
- for (const callback of this.pollProgressCallbacks) {
- callback(state);
- }
- }
- /**
- * Invokes the underlying operation's cancel method.
- */
- async cancelOnce(options = {}) {
- this.operation = await this.operation.cancel(options);
- }
- /**
- * Returns a promise that will resolve once a single polling request finishes.
- * It does this by calling the update method of the Poller's operation.
- *
- * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
- *
- * @param options - Optional properties passed to the operation's update method.
- */
- poll(options = {}) {
- if (!this.pollOncePromise) {
- this.pollOncePromise = this.pollOnce(options);
- const clearPollOncePromise = () => {
- this.pollOncePromise = undefined;
- };
- this.pollOncePromise.then(clearPollOncePromise, clearPollOncePromise).catch(this.reject);
- }
- return this.pollOncePromise;
- }
- processUpdatedState() {
- if (this.operation.state.error) {
- this.stopped = true;
- if (!this.resolveOnUnsuccessful) {
- this.reject(this.operation.state.error);
- throw this.operation.state.error;
- }
- }
- if (this.operation.state.isCancelled) {
- this.stopped = true;
- if (!this.resolveOnUnsuccessful) {
- const error = new PollerCancelledError("Operation was canceled");
- this.reject(error);
- throw error;
- }
- }
- if (this.isDone() && this.resolve) {
- // If the poller has finished polling, this means we now have a result.
- // However, it can be the case that TResult is instantiated to void, so
- // we are not expecting a result anyway. To assert that we might not
- // have a result eventually after finishing polling, we cast the result
- // to TResult.
- this.resolve(this.getResult());
- }
- }
- /**
- * Returns a promise that will resolve once the underlying operation is completed.
- */
- async pollUntilDone(pollOptions = {}) {
- if (this.stopped) {
- this.startPolling(pollOptions).catch(this.reject);
- }
- // This is needed because the state could have been updated by
- // `cancelOperation`, e.g. the operation is canceled or an error occurred.
- this.processUpdatedState();
- return this.promise;
- }
- /**
- * Invokes the provided callback after each polling is completed,
- * sending the current state of the poller's operation.
- *
- * It returns a method that can be used to stop receiving updates on the given callback function.
- */
- onProgress(callback) {
- this.pollProgressCallbacks.push(callback);
- return () => {
- this.pollProgressCallbacks = this.pollProgressCallbacks.filter((c) => c !== callback);
- };
- }
- /**
- * Returns true if the poller has finished polling.
- */
- isDone() {
- const state = this.operation.state;
- return Boolean(state.isCompleted || state.isCancelled || state.error);
- }
- /**
- * Stops the poller from continuing to poll.
- */
- stopPolling() {
- if (!this.stopped) {
- this.stopped = true;
- if (this.reject) {
- this.reject(new PollerStoppedError("This poller is already stopped"));
- }
- }
- }
- /**
- * Returns true if the poller is stopped.
- */
- isStopped() {
- return this.stopped;
- }
- /**
- * Attempts to cancel the underlying operation.
- *
- * It only optionally receives an object with an abortSignal property, from \@azure/abort-controller's AbortSignalLike.
- *
- * If it's called again before it finishes, it will throw an error.
- *
- * @param options - Optional properties passed to the operation's update method.
- */
- cancelOperation(options = {}) {
- if (!this.cancelPromise) {
- this.cancelPromise = this.cancelOnce(options);
- }
- else if (options.abortSignal) {
- throw new Error("A cancel request is currently pending");
- }
- return this.cancelPromise;
- }
- /**
- * Returns the state of the operation.
- *
- * Even though TState will be the same type inside any of the methods of any extension of the Poller class,
- * implementations of the pollers can customize what's shared with the public by writing their own
- * version of the `getOperationState` method, and by defining two types, one representing the internal state of the poller
- * and a public type representing a safe to share subset of the properties of the internal state.
- * Their definition of getOperationState can then return their public type.
- *
- * Example:
- *
- * ```ts
- * // Let's say we have our poller's operation state defined as:
- * interface MyOperationState extends PollOperationState {
- * privateProperty?: string;
- * publicProperty?: string;
- * }
- *
- * // To allow us to have a true separation of public and private state, we have to define another interface:
- * interface PublicState extends PollOperationState {
- * publicProperty?: string;
- * }
- *
- * // Then, we define our Poller as follows:
- * export class MyPoller extends Poller {
- * // ... More content is needed here ...
- *
- * public getOperationState(): PublicState {
- * const state: PublicState = this.operation.state;
- * return {
- * // Properties from PollOperationState
- * isStarted: state.isStarted,
- * isCompleted: state.isCompleted,
- * isCancelled: state.isCancelled,
- * error: state.error,
- * result: state.result,
- *
- * // The only other property needed by PublicState.
- * publicProperty: state.publicProperty
- * }
- * }
- * }
- * ```
- *
- * You can see this in the tests of this repository, go to the file:
- * `../test/utils/testPoller.ts`
- * and look for the getOperationState implementation.
- */
- getOperationState() {
- return this.operation.state;
- }
- /**
- * Returns the result value of the operation,
- * regardless of the state of the poller.
- * It can return undefined or an incomplete form of the final TResult value
- * depending on the implementation.
- */
- getResult() {
- const state = this.operation.state;
- return state.result;
- }
- /**
- * Returns a serialized version of the poller's operation
- * by invoking the operation's toString method.
- */
- toString() {
- return this.operation.toString();
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * The LRO Engine, a class that performs polling.
- */
-class LroEngine extends Poller {
- constructor(lro, options) {
- const { intervalInMs = POLL_INTERVAL_IN_MS, resumeFrom, resolveOnUnsuccessful = false, isDone, lroResourceLocationConfig, processResult, updateState, } = options || {};
- const state = resumeFrom
- ? deserializeState(resumeFrom)
- : {};
- const operation = new GenericPollOperation(state, lro, !resolveOnUnsuccessful, lroResourceLocationConfig, processResult, updateState, isDone);
- super(operation);
- this.resolveOnUnsuccessful = resolveOnUnsuccessful;
- this.config = { intervalInMs: intervalInMs };
- operation.setPollerConfig(this.config);
- }
- /**
- * The method used by the poller to wait before attempting to update its operation.
- */
- delay() {
- return new Promise((resolve) => setTimeout(() => resolve(), this.config.intervalInMs));
- }
-}
-
-exports.LroEngine = LroEngine;
-exports.Poller = Poller;
-exports.PollerCancelledError = PollerCancelledError;
-exports.PollerStoppedError = PollerStoppedError;
-exports.createHttpPoller = createHttpPoller;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 4559:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-
-var tslib = __nccwpck_require__(4351);
-
-// Copyright (c) Microsoft Corporation.
-/**
- * returns an async iterator that iterates over results. It also has a `byPage`
- * method that returns pages of items at once.
- *
- * @param pagedResult - an object that specifies how to get pages.
- * @returns a paged async iterator that iterates over results.
- */
-function getPagedAsyncIterator(pagedResult) {
- var _a;
- const iter = getItemAsyncIterator(pagedResult);
- return {
- next() {
- return iter.next();
- },
- [Symbol.asyncIterator]() {
- return this;
- },
- byPage: (_a = pagedResult === null || pagedResult === void 0 ? void 0 : pagedResult.byPage) !== null && _a !== void 0 ? _a : ((settings) => {
- const { continuationToken, maxPageSize } = settings !== null && settings !== void 0 ? settings : {};
- return getPageAsyncIterator(pagedResult, {
- pageLink: continuationToken,
- maxPageSize,
- });
- }),
- };
-}
-function getItemAsyncIterator(pagedResult) {
- return tslib.__asyncGenerator(this, arguments, function* getItemAsyncIterator_1() {
- var e_1, _a, e_2, _b;
- const pages = getPageAsyncIterator(pagedResult);
- const firstVal = yield tslib.__await(pages.next());
- // if the result does not have an array shape, i.e. TPage = TElement, then we return it as is
- if (!Array.isArray(firstVal.value)) {
- // can extract elements from this page
- const { toElements } = pagedResult;
- if (toElements) {
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(toElements(firstVal.value))));
- try {
- for (var pages_1 = tslib.__asyncValues(pages), pages_1_1; pages_1_1 = yield tslib.__await(pages_1.next()), !pages_1_1.done;) {
- const page = pages_1_1.value;
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(toElements(page))));
- }
- }
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
- finally {
- try {
- if (pages_1_1 && !pages_1_1.done && (_a = pages_1.return)) yield tslib.__await(_a.call(pages_1));
- }
- finally { if (e_1) throw e_1.error; }
- }
- }
- else {
- yield yield tslib.__await(firstVal.value);
- // `pages` is of type `AsyncIterableIterator` but TPage = TElement in this case
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(pages)));
- }
- }
- else {
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(firstVal.value)));
- try {
- for (var pages_2 = tslib.__asyncValues(pages), pages_2_1; pages_2_1 = yield tslib.__await(pages_2.next()), !pages_2_1.done;) {
- const page = pages_2_1.value;
- // pages is of type `AsyncIterableIterator` so `page` is of type `TPage`. In this branch,
- // it must be the case that `TPage = TElement[]`
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(page)));
- }
- }
- catch (e_2_1) { e_2 = { error: e_2_1 }; }
- finally {
- try {
- if (pages_2_1 && !pages_2_1.done && (_b = pages_2.return)) yield tslib.__await(_b.call(pages_2));
- }
- finally { if (e_2) throw e_2.error; }
- }
- }
- });
-}
-function getPageAsyncIterator(pagedResult, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* getPageAsyncIterator_1() {
- const { pageLink, maxPageSize } = options;
- let response = yield tslib.__await(pagedResult.getPage(pageLink !== null && pageLink !== void 0 ? pageLink : pagedResult.firstPageLink, maxPageSize));
- if (!response) {
- return yield tslib.__await(void 0);
- }
- yield yield tslib.__await(response.page);
- while (response.nextPageLink) {
- response = yield tslib.__await(pagedResult.getPage(response.nextPageLink, maxPageSize));
- if (!response) {
- return yield tslib.__await(void 0);
- }
- yield yield tslib.__await(response.page);
- }
- });
-}
-
-exports.getPagedAsyncIterator = getPagedAsyncIterator;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 4175:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-
-var api = __nccwpck_require__(5163);
-
-// Copyright (c) Microsoft Corporation.
-(function (SpanKind) {
- /** Default value. Indicates that the span is used internally. */
- SpanKind[SpanKind["INTERNAL"] = 0] = "INTERNAL";
- /**
- * Indicates that the span covers server-side handling of an RPC or other
- * remote request.
- */
- SpanKind[SpanKind["SERVER"] = 1] = "SERVER";
- /**
- * Indicates that the span covers the client-side wrapper around an RPC or
- * other remote request.
- */
- SpanKind[SpanKind["CLIENT"] = 2] = "CLIENT";
- /**
- * Indicates that the span describes producer sending a message to a
- * broker. Unlike client and server, there is no direct critical path latency
- * relationship between producer and consumer spans.
- */
- SpanKind[SpanKind["PRODUCER"] = 3] = "PRODUCER";
- /**
- * Indicates that the span describes consumer receiving a message from a
- * broker. Unlike client and server, there is no direct critical path latency
- * relationship between producer and consumer spans.
- */
- SpanKind[SpanKind["CONSUMER"] = 4] = "CONSUMER";
-})(exports.SpanKind || (exports.SpanKind = {}));
-/**
- * Return the span if one exists
- *
- * @param context - context to get span from
- */
-function getSpan(context) {
- return api.trace.getSpan(context);
-}
-/**
- * Set the span on a context
- *
- * @param context - context to use as parent
- * @param span - span to set active
- */
-function setSpan(context, span) {
- return api.trace.setSpan(context, span);
-}
-/**
- * Wrap span context in a NoopSpan and set as span in a new
- * context
- *
- * @param context - context to set active span on
- * @param spanContext - span context to be wrapped
- */
-function setSpanContext(context, spanContext) {
- return api.trace.setSpanContext(context, spanContext);
-}
-/**
- * Get the span context of the span if it exists.
- *
- * @param context - context to get values from
- */
-function getSpanContext(context) {
- return api.trace.getSpanContext(context);
-}
-/**
- * Returns true of the given {@link SpanContext} is valid.
- * A valid {@link SpanContext} is one which has a valid trace ID and span ID as per the spec.
- *
- * @param context - the {@link SpanContext} to validate.
- *
- * @returns true if the {@link SpanContext} is valid, false otherwise.
- */
-function isSpanContextValid(context) {
- return api.trace.isSpanContextValid(context);
-}
-function getTracer(name, version) {
- return api.trace.getTracer(name || "azure/core-tracing", version);
-}
-/** Entrypoint for context API */
-const context = api.context;
-(function (SpanStatusCode) {
- /**
- * The default status.
- */
- SpanStatusCode[SpanStatusCode["UNSET"] = 0] = "UNSET";
- /**
- * The operation has been validated by an Application developer or
- * Operator to have completed successfully.
- */
- SpanStatusCode[SpanStatusCode["OK"] = 1] = "OK";
- /**
- * The operation contains an error.
- */
- SpanStatusCode[SpanStatusCode["ERROR"] = 2] = "ERROR";
-})(exports.SpanStatusCode || (exports.SpanStatusCode = {}));
-
-// Copyright (c) Microsoft Corporation.
-function isTracingDisabled() {
- var _a;
- if (typeof process === "undefined") {
- // not supported in browser for now without polyfills
- return false;
- }
- const azureTracingDisabledValue = (_a = process.env.AZURE_TRACING_DISABLED) === null || _a === void 0 ? void 0 : _a.toLowerCase();
- if (azureTracingDisabledValue === "false" || azureTracingDisabledValue === "0") {
- return false;
- }
- return Boolean(azureTracingDisabledValue);
-}
-/**
- * Creates a function that can be used to create spans using the global tracer.
- *
- * Usage:
- *
- * ```typescript
- * // once
- * const createSpan = createSpanFunction({ packagePrefix: "Azure.Data.AppConfiguration", namespace: "Microsoft.AppConfiguration" });
- *
- * // in each operation
- * const span = createSpan("deleteConfigurationSetting", operationOptions);
- * // code...
- * span.end();
- * ```
- *
- * @hidden
- * @param args - allows configuration of the prefix for each span as well as the az.namespace field.
- */
-function createSpanFunction(args) {
- return function (operationName, operationOptions) {
- const tracer = getTracer();
- const tracingOptions = (operationOptions === null || operationOptions === void 0 ? void 0 : operationOptions.tracingOptions) || {};
- const spanOptions = Object.assign({ kind: exports.SpanKind.INTERNAL }, tracingOptions.spanOptions);
- const spanName = args.packagePrefix ? `${args.packagePrefix}.${operationName}` : operationName;
- let span;
- if (isTracingDisabled()) {
- span = api.trace.wrapSpanContext(api.INVALID_SPAN_CONTEXT);
- }
- else {
- span = tracer.startSpan(spanName, spanOptions, tracingOptions.tracingContext);
- }
- if (args.namespace) {
- span.setAttribute("az.namespace", args.namespace);
- }
- let newSpanOptions = tracingOptions.spanOptions || {};
- if (span.isRecording() && args.namespace) {
- newSpanOptions = Object.assign(Object.assign({}, tracingOptions.spanOptions), { attributes: Object.assign(Object.assign({}, spanOptions.attributes), { "az.namespace": args.namespace }) });
- }
- const newTracingOptions = Object.assign(Object.assign({}, tracingOptions), { spanOptions: newSpanOptions, tracingContext: setSpan(tracingOptions.tracingContext || context.active(), span) });
- const newOperationOptions = Object.assign(Object.assign({}, operationOptions), { tracingOptions: newTracingOptions });
- return {
- span,
- updatedOptions: newOperationOptions
- };
- };
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-const VERSION = "00";
-/**
- * Generates a `SpanContext` given a `traceparent` header value.
- * @param traceParent - Serialized span context data as a `traceparent` header value.
- * @returns The `SpanContext` generated from the `traceparent` value.
- */
-function extractSpanContextFromTraceParentHeader(traceParentHeader) {
- const parts = traceParentHeader.split("-");
- if (parts.length !== 4) {
- return;
- }
- const [version, traceId, spanId, traceOptions] = parts;
- if (version !== VERSION) {
- return;
- }
- const traceFlags = parseInt(traceOptions, 16);
- const spanContext = {
- spanId,
- traceId,
- traceFlags
- };
- return spanContext;
-}
-/**
- * Generates a `traceparent` value given a span context.
- * @param spanContext - Contains context for a specific span.
- * @returns The `spanContext` represented as a `traceparent` value.
- */
-function getTraceParentHeader(spanContext) {
- const missingFields = [];
- if (!spanContext.traceId) {
- missingFields.push("traceId");
- }
- if (!spanContext.spanId) {
- missingFields.push("spanId");
- }
- if (missingFields.length) {
- return;
- }
- const flags = spanContext.traceFlags || 0 /* NONE */;
- const hexFlags = flags.toString(16);
- const traceFlags = hexFlags.length === 1 ? `0${hexFlags}` : hexFlags;
- // https://www.w3.org/TR/trace-context/#traceparent-header-field-values
- return `${VERSION}-${spanContext.traceId}-${spanContext.spanId}-${traceFlags}`;
-}
-
-exports.context = context;
-exports.createSpanFunction = createSpanFunction;
-exports.extractSpanContextFromTraceParentHeader = extractSpanContextFromTraceParentHeader;
-exports.getSpan = getSpan;
-exports.getSpanContext = getSpanContext;
-exports.getTraceParentHeader = getTraceParentHeader;
-exports.getTracer = getTracer;
-exports.isSpanContextValid = isSpanContextValid;
-exports.setSpan = setSpan;
-exports.setSpanContext = setSpanContext;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 1333:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-var abortController = __nccwpck_require__(2557);
-var crypto = __nccwpck_require__(6113);
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Creates an abortable promise.
- * @param buildPromise - A function that takes the resolve and reject functions as parameters.
- * @param options - The options for the abortable promise.
- * @returns A promise that can be aborted.
- */
-function createAbortablePromise(buildPromise, options) {
- const { cleanupBeforeAbort, abortSignal, abortErrorMsg } = options !== null && options !== void 0 ? options : {};
- return new Promise((resolve, reject) => {
- function rejectOnAbort() {
- reject(new abortController.AbortError(abortErrorMsg !== null && abortErrorMsg !== void 0 ? abortErrorMsg : "The operation was aborted."));
- }
- function removeListeners() {
- abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.removeEventListener("abort", onAbort);
- }
- function onAbort() {
- cleanupBeforeAbort === null || cleanupBeforeAbort === void 0 ? void 0 : cleanupBeforeAbort();
- removeListeners();
- rejectOnAbort();
- }
- if (abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.aborted) {
- return rejectOnAbort();
- }
- try {
- buildPromise((x) => {
- removeListeners();
- resolve(x);
- }, (x) => {
- removeListeners();
- reject(x);
- });
- }
- catch (err) {
- reject(err);
- }
- abortSignal === null || abortSignal === void 0 ? void 0 : abortSignal.addEventListener("abort", onAbort);
- });
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-const StandardAbortMessage = "The delay was aborted.";
-/**
- * A wrapper for setTimeout that resolves a promise after timeInMs milliseconds.
- * @param timeInMs - The number of milliseconds to be delayed.
- * @param options - The options for delay - currently abort options
- * @returns Promise that is resolved after timeInMs
- */
-function delay(timeInMs, options) {
- let token;
- const { abortSignal, abortErrorMsg } = options !== null && options !== void 0 ? options : {};
- return createAbortablePromise((resolve) => {
- token = setTimeout(resolve, timeInMs);
- }, {
- cleanupBeforeAbort: () => clearTimeout(token),
- abortSignal,
- abortErrorMsg: abortErrorMsg !== null && abortErrorMsg !== void 0 ? abortErrorMsg : StandardAbortMessage,
- });
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * promise.race() wrapper that aborts rest of promises as soon as the first promise settles.
- */
-async function cancelablePromiseRace(abortablePromiseBuilders, options) {
- var _a, _b;
- const aborter = new abortController.AbortController();
- function abortHandler() {
- aborter.abort();
- }
- (_a = options === null || options === void 0 ? void 0 : options.abortSignal) === null || _a === void 0 ? void 0 : _a.addEventListener("abort", abortHandler);
- try {
- return await Promise.race(abortablePromiseBuilders.map((p) => p({ abortSignal: aborter.signal })));
- }
- finally {
- aborter.abort();
- (_b = options === null || options === void 0 ? void 0 : options.abortSignal) === null || _b === void 0 ? void 0 : _b.removeEventListener("abort", abortHandler);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Returns a random integer value between a lower and upper bound,
- * inclusive of both bounds.
- * Note that this uses Math.random and isn't secure. If you need to use
- * this for any kind of security purpose, find a better source of random.
- * @param min - The smallest integer value allowed.
- * @param max - The largest integer value allowed.
- */
-function getRandomIntegerInclusive(min, max) {
- // Make sure inputs are integers.
- min = Math.ceil(min);
- max = Math.floor(max);
- // Pick a random offset from zero to the size of the range.
- // Since Math.random() can never return 1, we have to make the range one larger
- // in order to be inclusive of the maximum value after we take the floor.
- const offset = Math.floor(Math.random() * (max - min + 1));
- return offset + min;
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Helper to determine when an input is a generic JS object.
- * @returns true when input is an object type that is not null, Array, RegExp, or Date.
- */
-function isObject(input) {
- return (typeof input === "object" &&
- input !== null &&
- !Array.isArray(input) &&
- !(input instanceof RegExp) &&
- !(input instanceof Date));
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Typeguard for an error object shape (has name and message)
- * @param e - Something caught by a catch clause.
- */
-function isError(e) {
- if (isObject(e)) {
- const hasName = typeof e.name === "string";
- const hasMessage = typeof e.message === "string";
- return hasName && hasMessage;
- }
- return false;
-}
-/**
- * Given what is thought to be an error object, return the message if possible.
- * If the message is missing, returns a stringified version of the input.
- * @param e - Something thrown from a try block
- * @returns The error message or a string of the input
- */
-function getErrorMessage(e) {
- if (isError(e)) {
- return e.message;
- }
- else {
- let stringified;
- try {
- if (typeof e === "object" && e) {
- stringified = JSON.stringify(e);
- }
- else {
- stringified = String(e);
- }
- }
- catch (err) {
- stringified = "[unable to stringify input]";
- }
- return `Unknown error ${stringified}`;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Generates a SHA-256 HMAC signature.
- * @param key - The HMAC key represented as a base64 string, used to generate the cryptographic HMAC hash.
- * @param stringToSign - The data to be signed.
- * @param encoding - The textual encoding to use for the returned HMAC digest.
- */
-async function computeSha256Hmac(key, stringToSign, encoding) {
- const decodedKey = Buffer.from(key, "base64");
- return crypto.createHmac("sha256", decodedKey).update(stringToSign).digest(encoding);
-}
-/**
- * Generates a SHA-256 hash.
- * @param content - The data to be included in the hash.
- * @param encoding - The textual encoding to use for the returned hash.
- */
-async function computeSha256Hash(content, encoding) {
- return crypto.createHash("sha256").update(content).digest(encoding);
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Helper TypeGuard that checks if something is defined or not.
- * @param thing - Anything
- */
-function isDefined(thing) {
- return typeof thing !== "undefined" && thing !== null;
-}
-/**
- * Helper TypeGuard that checks if the input is an object with the specified properties.
- * @param thing - Anything.
- * @param properties - The name of the properties that should appear in the object.
- */
-function isObjectWithProperties(thing, properties) {
- if (!isDefined(thing) || typeof thing !== "object") {
- return false;
- }
- for (const property of properties) {
- if (!objectHasProperty(thing, property)) {
- return false;
- }
- }
- return true;
-}
-/**
- * Helper TypeGuard that checks if the input is an object with the specified property.
- * @param thing - Any object.
- * @param property - The name of the property that should appear in the object.
- */
-function objectHasProperty(thing, property) {
- return (isDefined(thing) && typeof thing === "object" && property in thing);
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/*
- * NOTE: When moving this file, please update "react-native" section in package.json.
- */
-/**
- * Generated Universally Unique Identifier
- *
- * @returns RFC4122 v4 UUID.
- */
-function generateUUID() {
- let uuid = "";
- for (let i = 0; i < 32; i++) {
- // Generate a random number between 0 and 15
- const randomNumber = Math.floor(Math.random() * 16);
- // Set the UUID version to 4 in the 13th position
- if (i === 12) {
- uuid += "4";
- }
- else if (i === 16) {
- // Set the UUID variant to "10" in the 17th position
- uuid += (randomNumber & 0x3) | 0x8;
- }
- else {
- // Add a random hexadecimal digit to the UUID string
- uuid += randomNumber.toString(16);
- }
- // Add hyphens to the UUID string at the appropriate positions
- if (i === 7 || i === 11 || i === 15 || i === 19) {
- uuid += "-";
- }
- }
- return uuid;
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-var _a$1;
-// NOTE: This is a workaround until we can use `globalThis.crypto.randomUUID` in Node.js 19+.
-let uuidFunction = typeof ((_a$1 = globalThis === null || globalThis === void 0 ? void 0 : globalThis.crypto) === null || _a$1 === void 0 ? void 0 : _a$1.randomUUID) === "function"
- ? globalThis.crypto.randomUUID.bind(globalThis.crypto)
- : crypto.randomUUID;
-// Not defined in earlier versions of Node.js 14
-if (!uuidFunction) {
- uuidFunction = generateUUID;
-}
-/**
- * Generated Universally Unique Identifier
- *
- * @returns RFC4122 v4 UUID.
- */
-function randomUUID() {
- return uuidFunction();
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-var _a, _b, _c, _d;
-/**
- * A constant that indicates whether the environment the code is running is a Web Browser.
- */
-// eslint-disable-next-line @azure/azure-sdk/ts-no-window
-const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
-/**
- * A constant that indicates whether the environment the code is running is a Web Worker.
- */
-const isWebWorker = typeof self === "object" &&
- typeof (self === null || self === void 0 ? void 0 : self.importScripts) === "function" &&
- (((_a = self.constructor) === null || _a === void 0 ? void 0 : _a.name) === "DedicatedWorkerGlobalScope" ||
- ((_b = self.constructor) === null || _b === void 0 ? void 0 : _b.name) === "ServiceWorkerGlobalScope" ||
- ((_c = self.constructor) === null || _c === void 0 ? void 0 : _c.name) === "SharedWorkerGlobalScope");
-/**
- * A constant that indicates whether the environment the code is running is Deno.
- */
-const isDeno = typeof Deno !== "undefined" &&
- typeof Deno.version !== "undefined" &&
- typeof Deno.version.deno !== "undefined";
-/**
- * A constant that indicates whether the environment the code is running is Node.JS.
- */
-const isNode = typeof process !== "undefined" &&
- Boolean(process.version) &&
- Boolean((_d = process.versions) === null || _d === void 0 ? void 0 : _d.node) &&
- // Deno thought it was a good idea to spoof process.versions.node, see https://deno.land/std@0.177.0/node/process.ts?s=versions
- !isDeno;
-/**
- * A constant that indicates whether the environment the code is running is Bun.sh.
- */
-const isBun = typeof Bun !== "undefined" && typeof Bun.version !== "undefined";
-/**
- * A constant that indicates whether the environment the code is running is in React-Native.
- */
-// https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
-const isReactNative = typeof navigator !== "undefined" && (navigator === null || navigator === void 0 ? void 0 : navigator.product) === "ReactNative";
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * The helper that transforms bytes with specific character encoding into string
- * @param bytes - the uint8array bytes
- * @param format - the format we use to encode the byte
- * @returns a string of the encoded string
- */
-function uint8ArrayToString(bytes, format) {
- return Buffer.from(bytes).toString(format);
-}
-/**
- * The helper that transforms string to specific character encoded bytes array.
- * @param value - the string to be converted
- * @param format - the format we use to decode the value
- * @returns a uint8array
- */
-function stringToUint8Array(value, format) {
- return Buffer.from(value, format);
-}
-
-exports.cancelablePromiseRace = cancelablePromiseRace;
-exports.computeSha256Hash = computeSha256Hash;
-exports.computeSha256Hmac = computeSha256Hmac;
-exports.createAbortablePromise = createAbortablePromise;
-exports.delay = delay;
-exports.getErrorMessage = getErrorMessage;
-exports.getRandomIntegerInclusive = getRandomIntegerInclusive;
-exports.isBrowser = isBrowser;
-exports.isBun = isBun;
-exports.isDefined = isDefined;
-exports.isDeno = isDeno;
-exports.isError = isError;
-exports.isNode = isNode;
-exports.isObject = isObject;
-exports.isObjectWithProperties = isObjectWithProperties;
-exports.isReactNative = isReactNative;
-exports.isWebWorker = isWebWorker;
-exports.objectHasProperty = objectHasProperty;
-exports.randomUUID = randomUUID;
-exports.stringToUint8Array = stringToUint8Array;
-exports.uint8ArrayToString = uint8ArrayToString;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 3233:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-
-var os = __nccwpck_require__(2037);
-var util = __nccwpck_require__(3837);
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var util__default = /*#__PURE__*/_interopDefaultLegacy(util);
-
-// Copyright (c) Microsoft Corporation.
-function log(message, ...args) {
- process.stderr.write(`${util__default["default"].format(message, ...args)}${os.EOL}`);
-}
-
-// Copyright (c) Microsoft Corporation.
-const debugEnvVariable = (typeof process !== "undefined" && process.env && process.env.DEBUG) || undefined;
-let enabledString;
-let enabledNamespaces = [];
-let skippedNamespaces = [];
-const debuggers = [];
-if (debugEnvVariable) {
- enable(debugEnvVariable);
-}
-const debugObj = Object.assign((namespace) => {
- return createDebugger(namespace);
-}, {
- enable,
- enabled,
- disable,
- log,
-});
-function enable(namespaces) {
- enabledString = namespaces;
- enabledNamespaces = [];
- skippedNamespaces = [];
- const wildcard = /\*/g;
- const namespaceList = namespaces.split(",").map((ns) => ns.trim().replace(wildcard, ".*?"));
- for (const ns of namespaceList) {
- if (ns.startsWith("-")) {
- skippedNamespaces.push(new RegExp(`^${ns.substr(1)}$`));
- }
- else {
- enabledNamespaces.push(new RegExp(`^${ns}$`));
- }
- }
- for (const instance of debuggers) {
- instance.enabled = enabled(instance.namespace);
- }
-}
-function enabled(namespace) {
- if (namespace.endsWith("*")) {
- return true;
- }
- for (const skipped of skippedNamespaces) {
- if (skipped.test(namespace)) {
- return false;
- }
- }
- for (const enabledNamespace of enabledNamespaces) {
- if (enabledNamespace.test(namespace)) {
- return true;
- }
- }
- return false;
-}
-function disable() {
- const result = enabledString || "";
- enable("");
- return result;
-}
-function createDebugger(namespace) {
- const newDebugger = Object.assign(debug, {
- enabled: enabled(namespace),
- destroy,
- log: debugObj.log,
- namespace,
- extend,
- });
- function debug(...args) {
- if (!newDebugger.enabled) {
- return;
- }
- if (args.length > 0) {
- args[0] = `${namespace} ${args[0]}`;
- }
- newDebugger.log(...args);
- }
- debuggers.push(newDebugger);
- return newDebugger;
-}
-function destroy() {
- const index = debuggers.indexOf(this);
- if (index >= 0) {
- debuggers.splice(index, 1);
- return true;
- }
- return false;
-}
-function extend(namespace) {
- const newDebugger = createDebugger(`${this.namespace}:${namespace}`);
- newDebugger.log = this.log;
- return newDebugger;
-}
-var debug = debugObj;
-
-// Copyright (c) Microsoft Corporation.
-const registeredLoggers = new Set();
-const logLevelFromEnv = (typeof process !== "undefined" && process.env && process.env.AZURE_LOG_LEVEL) || undefined;
-let azureLogLevel;
-/**
- * The AzureLogger provides a mechanism for overriding where logs are output to.
- * By default, logs are sent to stderr.
- * Override the `log` method to redirect logs to another location.
- */
-const AzureLogger = debug("azure");
-AzureLogger.log = (...args) => {
- debug.log(...args);
-};
-const AZURE_LOG_LEVELS = ["verbose", "info", "warning", "error"];
-if (logLevelFromEnv) {
- // avoid calling setLogLevel because we don't want a mis-set environment variable to crash
- if (isAzureLogLevel(logLevelFromEnv)) {
- setLogLevel(logLevelFromEnv);
- }
- else {
- console.error(`AZURE_LOG_LEVEL set to unknown log level '${logLevelFromEnv}'; logging is not enabled. Acceptable values: ${AZURE_LOG_LEVELS.join(", ")}.`);
- }
-}
-/**
- * Immediately enables logging at the specified log level. If no level is specified, logging is disabled.
- * @param level - The log level to enable for logging.
- * Options from most verbose to least verbose are:
- * - verbose
- * - info
- * - warning
- * - error
- */
-function setLogLevel(level) {
- if (level && !isAzureLogLevel(level)) {
- throw new Error(`Unknown log level '${level}'. Acceptable values: ${AZURE_LOG_LEVELS.join(",")}`);
- }
- azureLogLevel = level;
- const enabledNamespaces = [];
- for (const logger of registeredLoggers) {
- if (shouldEnable(logger)) {
- enabledNamespaces.push(logger.namespace);
- }
- }
- debug.enable(enabledNamespaces.join(","));
-}
-/**
- * Retrieves the currently specified log level.
- */
-function getLogLevel() {
- return azureLogLevel;
-}
-const levelMap = {
- verbose: 400,
- info: 300,
- warning: 200,
- error: 100,
-};
-/**
- * Creates a logger for use by the Azure SDKs that inherits from `AzureLogger`.
- * @param namespace - The name of the SDK package.
- * @hidden
- */
-function createClientLogger(namespace) {
- const clientRootLogger = AzureLogger.extend(namespace);
- patchLogMethod(AzureLogger, clientRootLogger);
- return {
- error: createLogger(clientRootLogger, "error"),
- warning: createLogger(clientRootLogger, "warning"),
- info: createLogger(clientRootLogger, "info"),
- verbose: createLogger(clientRootLogger, "verbose"),
- };
-}
-function patchLogMethod(parent, child) {
- child.log = (...args) => {
- parent.log(...args);
- };
-}
-function createLogger(parent, level) {
- const logger = Object.assign(parent.extend(level), {
- level,
- });
- patchLogMethod(parent, logger);
- if (shouldEnable(logger)) {
- const enabledNamespaces = debug.disable();
- debug.enable(enabledNamespaces + "," + logger.namespace);
- }
- registeredLoggers.add(logger);
- return logger;
-}
-function shouldEnable(logger) {
- return Boolean(azureLogLevel && levelMap[logger.level] <= levelMap[azureLogLevel]);
-}
-function isAzureLogLevel(logLevel) {
- return AZURE_LOG_LEVELS.includes(logLevel);
-}
-
-exports.AzureLogger = AzureLogger;
-exports.createClientLogger = createClientLogger;
-exports.getLogLevel = getLogLevel;
-exports.setLogLevel = setLogLevel;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 4100:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-
-var coreHttp = __nccwpck_require__(4607);
-var tslib = __nccwpck_require__(4351);
-var coreTracing = __nccwpck_require__(4175);
-var logger$1 = __nccwpck_require__(3233);
-var abortController = __nccwpck_require__(2557);
-var os = __nccwpck_require__(2037);
-var crypto = __nccwpck_require__(6113);
-var stream = __nccwpck_require__(2781);
-__nccwpck_require__(4559);
-var coreLro = __nccwpck_require__(7094);
-var events = __nccwpck_require__(2361);
-var fs = __nccwpck_require__(7147);
-var util = __nccwpck_require__(3837);
-
-function _interopNamespace(e) {
- if (e && e.__esModule) return e;
- var n = Object.create(null);
- if (e) {
- Object.keys(e).forEach(function (k) {
- if (k !== 'default') {
- var d = Object.getOwnPropertyDescriptor(e, k);
- Object.defineProperty(n, k, d.get ? d : {
- enumerable: true,
- get: function () { return e[k]; }
- });
- }
- });
- }
- n["default"] = e;
- return Object.freeze(n);
-}
-
-var coreHttp__namespace = /*#__PURE__*/_interopNamespace(coreHttp);
-var os__namespace = /*#__PURE__*/_interopNamespace(os);
-var fs__namespace = /*#__PURE__*/_interopNamespace(fs);
-var util__namespace = /*#__PURE__*/_interopNamespace(util);
-
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-const BlobServiceProperties = {
- serializedName: "BlobServiceProperties",
- xmlName: "StorageServiceProperties",
- type: {
- name: "Composite",
- className: "BlobServiceProperties",
- modelProperties: {
- blobAnalyticsLogging: {
- serializedName: "Logging",
- xmlName: "Logging",
- type: {
- name: "Composite",
- className: "Logging"
- }
- },
- hourMetrics: {
- serializedName: "HourMetrics",
- xmlName: "HourMetrics",
- type: {
- name: "Composite",
- className: "Metrics"
- }
- },
- minuteMetrics: {
- serializedName: "MinuteMetrics",
- xmlName: "MinuteMetrics",
- type: {
- name: "Composite",
- className: "Metrics"
- }
- },
- cors: {
- serializedName: "Cors",
- xmlName: "Cors",
- xmlIsWrapped: true,
- xmlElementName: "CorsRule",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "CorsRule"
- }
- }
- }
- },
- defaultServiceVersion: {
- serializedName: "DefaultServiceVersion",
- xmlName: "DefaultServiceVersion",
- type: {
- name: "String"
- }
- },
- deleteRetentionPolicy: {
- serializedName: "DeleteRetentionPolicy",
- xmlName: "DeleteRetentionPolicy",
- type: {
- name: "Composite",
- className: "RetentionPolicy"
- }
- },
- staticWebsite: {
- serializedName: "StaticWebsite",
- xmlName: "StaticWebsite",
- type: {
- name: "Composite",
- className: "StaticWebsite"
- }
- }
- }
- }
-};
-const Logging = {
- serializedName: "Logging",
- type: {
- name: "Composite",
- className: "Logging",
- modelProperties: {
- version: {
- serializedName: "Version",
- required: true,
- xmlName: "Version",
- type: {
- name: "String"
- }
- },
- deleteProperty: {
- serializedName: "Delete",
- required: true,
- xmlName: "Delete",
- type: {
- name: "Boolean"
- }
- },
- read: {
- serializedName: "Read",
- required: true,
- xmlName: "Read",
- type: {
- name: "Boolean"
- }
- },
- write: {
- serializedName: "Write",
- required: true,
- xmlName: "Write",
- type: {
- name: "Boolean"
- }
- },
- retentionPolicy: {
- serializedName: "RetentionPolicy",
- xmlName: "RetentionPolicy",
- type: {
- name: "Composite",
- className: "RetentionPolicy"
- }
- }
- }
- }
-};
-const RetentionPolicy = {
- serializedName: "RetentionPolicy",
- type: {
- name: "Composite",
- className: "RetentionPolicy",
- modelProperties: {
- enabled: {
- serializedName: "Enabled",
- required: true,
- xmlName: "Enabled",
- type: {
- name: "Boolean"
- }
- },
- days: {
- constraints: {
- InclusiveMinimum: 1
- },
- serializedName: "Days",
- xmlName: "Days",
- type: {
- name: "Number"
- }
- }
- }
- }
-};
-const Metrics = {
- serializedName: "Metrics",
- type: {
- name: "Composite",
- className: "Metrics",
- modelProperties: {
- version: {
- serializedName: "Version",
- xmlName: "Version",
- type: {
- name: "String"
- }
- },
- enabled: {
- serializedName: "Enabled",
- required: true,
- xmlName: "Enabled",
- type: {
- name: "Boolean"
- }
- },
- includeAPIs: {
- serializedName: "IncludeAPIs",
- xmlName: "IncludeAPIs",
- type: {
- name: "Boolean"
- }
- },
- retentionPolicy: {
- serializedName: "RetentionPolicy",
- xmlName: "RetentionPolicy",
- type: {
- name: "Composite",
- className: "RetentionPolicy"
- }
- }
- }
- }
-};
-const CorsRule = {
- serializedName: "CorsRule",
- type: {
- name: "Composite",
- className: "CorsRule",
- modelProperties: {
- allowedOrigins: {
- serializedName: "AllowedOrigins",
- required: true,
- xmlName: "AllowedOrigins",
- type: {
- name: "String"
- }
- },
- allowedMethods: {
- serializedName: "AllowedMethods",
- required: true,
- xmlName: "AllowedMethods",
- type: {
- name: "String"
- }
- },
- allowedHeaders: {
- serializedName: "AllowedHeaders",
- required: true,
- xmlName: "AllowedHeaders",
- type: {
- name: "String"
- }
- },
- exposedHeaders: {
- serializedName: "ExposedHeaders",
- required: true,
- xmlName: "ExposedHeaders",
- type: {
- name: "String"
- }
- },
- maxAgeInSeconds: {
- constraints: {
- InclusiveMinimum: 0
- },
- serializedName: "MaxAgeInSeconds",
- required: true,
- xmlName: "MaxAgeInSeconds",
- type: {
- name: "Number"
- }
- }
- }
- }
-};
-const StaticWebsite = {
- serializedName: "StaticWebsite",
- type: {
- name: "Composite",
- className: "StaticWebsite",
- modelProperties: {
- enabled: {
- serializedName: "Enabled",
- required: true,
- xmlName: "Enabled",
- type: {
- name: "Boolean"
- }
- },
- indexDocument: {
- serializedName: "IndexDocument",
- xmlName: "IndexDocument",
- type: {
- name: "String"
- }
- },
- errorDocument404Path: {
- serializedName: "ErrorDocument404Path",
- xmlName: "ErrorDocument404Path",
- type: {
- name: "String"
- }
- },
- defaultIndexDocumentPath: {
- serializedName: "DefaultIndexDocumentPath",
- xmlName: "DefaultIndexDocumentPath",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const StorageError = {
- serializedName: "StorageError",
- type: {
- name: "Composite",
- className: "StorageError",
- modelProperties: {
- message: {
- serializedName: "Message",
- xmlName: "Message",
- type: {
- name: "String"
- }
- },
- code: {
- serializedName: "Code",
- xmlName: "Code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobServiceStatistics = {
- serializedName: "BlobServiceStatistics",
- xmlName: "StorageServiceStats",
- type: {
- name: "Composite",
- className: "BlobServiceStatistics",
- modelProperties: {
- geoReplication: {
- serializedName: "GeoReplication",
- xmlName: "GeoReplication",
- type: {
- name: "Composite",
- className: "GeoReplication"
- }
- }
- }
- }
-};
-const GeoReplication = {
- serializedName: "GeoReplication",
- type: {
- name: "Composite",
- className: "GeoReplication",
- modelProperties: {
- status: {
- serializedName: "Status",
- required: true,
- xmlName: "Status",
- type: {
- name: "Enum",
- allowedValues: ["live", "bootstrap", "unavailable"]
- }
- },
- lastSyncOn: {
- serializedName: "LastSyncTime",
- required: true,
- xmlName: "LastSyncTime",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const ListContainersSegmentResponse = {
- serializedName: "ListContainersSegmentResponse",
- xmlName: "EnumerationResults",
- type: {
- name: "Composite",
- className: "ListContainersSegmentResponse",
- modelProperties: {
- serviceEndpoint: {
- serializedName: "ServiceEndpoint",
- required: true,
- xmlName: "ServiceEndpoint",
- xmlIsAttribute: true,
- type: {
- name: "String"
- }
- },
- prefix: {
- serializedName: "Prefix",
- xmlName: "Prefix",
- type: {
- name: "String"
- }
- },
- marker: {
- serializedName: "Marker",
- xmlName: "Marker",
- type: {
- name: "String"
- }
- },
- maxPageSize: {
- serializedName: "MaxResults",
- xmlName: "MaxResults",
- type: {
- name: "Number"
- }
- },
- containerItems: {
- serializedName: "ContainerItems",
- required: true,
- xmlName: "Containers",
- xmlIsWrapped: true,
- xmlElementName: "Container",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "ContainerItem"
- }
- }
- }
- },
- continuationToken: {
- serializedName: "NextMarker",
- xmlName: "NextMarker",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerItem = {
- serializedName: "ContainerItem",
- xmlName: "Container",
- type: {
- name: "Composite",
- className: "ContainerItem",
- modelProperties: {
- name: {
- serializedName: "Name",
- required: true,
- xmlName: "Name",
- type: {
- name: "String"
- }
- },
- deleted: {
- serializedName: "Deleted",
- xmlName: "Deleted",
- type: {
- name: "Boolean"
- }
- },
- version: {
- serializedName: "Version",
- xmlName: "Version",
- type: {
- name: "String"
- }
- },
- properties: {
- serializedName: "Properties",
- xmlName: "Properties",
- type: {
- name: "Composite",
- className: "ContainerProperties"
- }
- },
- metadata: {
- serializedName: "Metadata",
- xmlName: "Metadata",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- }
- }
- }
- }
-};
-const ContainerProperties = {
- serializedName: "ContainerProperties",
- type: {
- name: "Composite",
- className: "ContainerProperties",
- modelProperties: {
- lastModified: {
- serializedName: "Last-Modified",
- required: true,
- xmlName: "Last-Modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- etag: {
- serializedName: "Etag",
- required: true,
- xmlName: "Etag",
- type: {
- name: "String"
- }
- },
- leaseStatus: {
- serializedName: "LeaseStatus",
- xmlName: "LeaseStatus",
- type: {
- name: "Enum",
- allowedValues: ["locked", "unlocked"]
- }
- },
- leaseState: {
- serializedName: "LeaseState",
- xmlName: "LeaseState",
- type: {
- name: "Enum",
- allowedValues: [
- "available",
- "leased",
- "expired",
- "breaking",
- "broken"
- ]
- }
- },
- leaseDuration: {
- serializedName: "LeaseDuration",
- xmlName: "LeaseDuration",
- type: {
- name: "Enum",
- allowedValues: ["infinite", "fixed"]
- }
- },
- publicAccess: {
- serializedName: "PublicAccess",
- xmlName: "PublicAccess",
- type: {
- name: "Enum",
- allowedValues: ["container", "blob"]
- }
- },
- hasImmutabilityPolicy: {
- serializedName: "HasImmutabilityPolicy",
- xmlName: "HasImmutabilityPolicy",
- type: {
- name: "Boolean"
- }
- },
- hasLegalHold: {
- serializedName: "HasLegalHold",
- xmlName: "HasLegalHold",
- type: {
- name: "Boolean"
- }
- },
- defaultEncryptionScope: {
- serializedName: "DefaultEncryptionScope",
- xmlName: "DefaultEncryptionScope",
- type: {
- name: "String"
- }
- },
- preventEncryptionScopeOverride: {
- serializedName: "DenyEncryptionScopeOverride",
- xmlName: "DenyEncryptionScopeOverride",
- type: {
- name: "Boolean"
- }
- },
- deletedOn: {
- serializedName: "DeletedTime",
- xmlName: "DeletedTime",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- remainingRetentionDays: {
- serializedName: "RemainingRetentionDays",
- xmlName: "RemainingRetentionDays",
- type: {
- name: "Number"
- }
- },
- isImmutableStorageWithVersioningEnabled: {
- serializedName: "ImmutableStorageWithVersioningEnabled",
- xmlName: "ImmutableStorageWithVersioningEnabled",
- type: {
- name: "Boolean"
- }
- }
- }
- }
-};
-const KeyInfo = {
- serializedName: "KeyInfo",
- type: {
- name: "Composite",
- className: "KeyInfo",
- modelProperties: {
- startsOn: {
- serializedName: "Start",
- required: true,
- xmlName: "Start",
- type: {
- name: "String"
- }
- },
- expiresOn: {
- serializedName: "Expiry",
- required: true,
- xmlName: "Expiry",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const UserDelegationKey = {
- serializedName: "UserDelegationKey",
- type: {
- name: "Composite",
- className: "UserDelegationKey",
- modelProperties: {
- signedObjectId: {
- serializedName: "SignedOid",
- required: true,
- xmlName: "SignedOid",
- type: {
- name: "String"
- }
- },
- signedTenantId: {
- serializedName: "SignedTid",
- required: true,
- xmlName: "SignedTid",
- type: {
- name: "String"
- }
- },
- signedStartsOn: {
- serializedName: "SignedStart",
- required: true,
- xmlName: "SignedStart",
- type: {
- name: "String"
- }
- },
- signedExpiresOn: {
- serializedName: "SignedExpiry",
- required: true,
- xmlName: "SignedExpiry",
- type: {
- name: "String"
- }
- },
- signedService: {
- serializedName: "SignedService",
- required: true,
- xmlName: "SignedService",
- type: {
- name: "String"
- }
- },
- signedVersion: {
- serializedName: "SignedVersion",
- required: true,
- xmlName: "SignedVersion",
- type: {
- name: "String"
- }
- },
- value: {
- serializedName: "Value",
- required: true,
- xmlName: "Value",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const FilterBlobSegment = {
- serializedName: "FilterBlobSegment",
- xmlName: "EnumerationResults",
- type: {
- name: "Composite",
- className: "FilterBlobSegment",
- modelProperties: {
- serviceEndpoint: {
- serializedName: "ServiceEndpoint",
- required: true,
- xmlName: "ServiceEndpoint",
- xmlIsAttribute: true,
- type: {
- name: "String"
- }
- },
- where: {
- serializedName: "Where",
- required: true,
- xmlName: "Where",
- type: {
- name: "String"
- }
- },
- blobs: {
- serializedName: "Blobs",
- required: true,
- xmlName: "Blobs",
- xmlIsWrapped: true,
- xmlElementName: "Blob",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "FilterBlobItem"
- }
- }
- }
- },
- continuationToken: {
- serializedName: "NextMarker",
- xmlName: "NextMarker",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const FilterBlobItem = {
- serializedName: "FilterBlobItem",
- xmlName: "Blob",
- type: {
- name: "Composite",
- className: "FilterBlobItem",
- modelProperties: {
- name: {
- serializedName: "Name",
- required: true,
- xmlName: "Name",
- type: {
- name: "String"
- }
- },
- containerName: {
- serializedName: "ContainerName",
- required: true,
- xmlName: "ContainerName",
- type: {
- name: "String"
- }
- },
- tags: {
- serializedName: "Tags",
- xmlName: "Tags",
- type: {
- name: "Composite",
- className: "BlobTags"
- }
- }
- }
- }
-};
-const BlobTags = {
- serializedName: "BlobTags",
- xmlName: "Tags",
- type: {
- name: "Composite",
- className: "BlobTags",
- modelProperties: {
- blobTagSet: {
- serializedName: "BlobTagSet",
- required: true,
- xmlName: "TagSet",
- xmlIsWrapped: true,
- xmlElementName: "Tag",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "BlobTag"
- }
- }
- }
- }
- }
- }
-};
-const BlobTag = {
- serializedName: "BlobTag",
- xmlName: "Tag",
- type: {
- name: "Composite",
- className: "BlobTag",
- modelProperties: {
- key: {
- serializedName: "Key",
- required: true,
- xmlName: "Key",
- type: {
- name: "String"
- }
- },
- value: {
- serializedName: "Value",
- required: true,
- xmlName: "Value",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const SignedIdentifier = {
- serializedName: "SignedIdentifier",
- xmlName: "SignedIdentifier",
- type: {
- name: "Composite",
- className: "SignedIdentifier",
- modelProperties: {
- id: {
- serializedName: "Id",
- required: true,
- xmlName: "Id",
- type: {
- name: "String"
- }
- },
- accessPolicy: {
- serializedName: "AccessPolicy",
- xmlName: "AccessPolicy",
- type: {
- name: "Composite",
- className: "AccessPolicy"
- }
- }
- }
- }
-};
-const AccessPolicy = {
- serializedName: "AccessPolicy",
- type: {
- name: "Composite",
- className: "AccessPolicy",
- modelProperties: {
- startsOn: {
- serializedName: "Start",
- xmlName: "Start",
- type: {
- name: "String"
- }
- },
- expiresOn: {
- serializedName: "Expiry",
- xmlName: "Expiry",
- type: {
- name: "String"
- }
- },
- permissions: {
- serializedName: "Permission",
- xmlName: "Permission",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ListBlobsFlatSegmentResponse = {
- serializedName: "ListBlobsFlatSegmentResponse",
- xmlName: "EnumerationResults",
- type: {
- name: "Composite",
- className: "ListBlobsFlatSegmentResponse",
- modelProperties: {
- serviceEndpoint: {
- serializedName: "ServiceEndpoint",
- required: true,
- xmlName: "ServiceEndpoint",
- xmlIsAttribute: true,
- type: {
- name: "String"
- }
- },
- containerName: {
- serializedName: "ContainerName",
- required: true,
- xmlName: "ContainerName",
- xmlIsAttribute: true,
- type: {
- name: "String"
- }
- },
- prefix: {
- serializedName: "Prefix",
- xmlName: "Prefix",
- type: {
- name: "String"
- }
- },
- marker: {
- serializedName: "Marker",
- xmlName: "Marker",
- type: {
- name: "String"
- }
- },
- maxPageSize: {
- serializedName: "MaxResults",
- xmlName: "MaxResults",
- type: {
- name: "Number"
- }
- },
- segment: {
- serializedName: "Segment",
- xmlName: "Blobs",
- type: {
- name: "Composite",
- className: "BlobFlatListSegment"
- }
- },
- continuationToken: {
- serializedName: "NextMarker",
- xmlName: "NextMarker",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobFlatListSegment = {
- serializedName: "BlobFlatListSegment",
- xmlName: "Blobs",
- type: {
- name: "Composite",
- className: "BlobFlatListSegment",
- modelProperties: {
- blobItems: {
- serializedName: "BlobItems",
- required: true,
- xmlName: "BlobItems",
- xmlElementName: "Blob",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "BlobItemInternal"
- }
- }
- }
- }
- }
- }
-};
-const BlobItemInternal = {
- serializedName: "BlobItemInternal",
- xmlName: "Blob",
- type: {
- name: "Composite",
- className: "BlobItemInternal",
- modelProperties: {
- name: {
- serializedName: "Name",
- xmlName: "Name",
- type: {
- name: "Composite",
- className: "BlobName"
- }
- },
- deleted: {
- serializedName: "Deleted",
- required: true,
- xmlName: "Deleted",
- type: {
- name: "Boolean"
- }
- },
- snapshot: {
- serializedName: "Snapshot",
- required: true,
- xmlName: "Snapshot",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "VersionId",
- xmlName: "VersionId",
- type: {
- name: "String"
- }
- },
- isCurrentVersion: {
- serializedName: "IsCurrentVersion",
- xmlName: "IsCurrentVersion",
- type: {
- name: "Boolean"
- }
- },
- properties: {
- serializedName: "Properties",
- xmlName: "Properties",
- type: {
- name: "Composite",
- className: "BlobPropertiesInternal"
- }
- },
- metadata: {
- serializedName: "Metadata",
- xmlName: "Metadata",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- }
- },
- blobTags: {
- serializedName: "BlobTags",
- xmlName: "Tags",
- type: {
- name: "Composite",
- className: "BlobTags"
- }
- },
- objectReplicationMetadata: {
- serializedName: "ObjectReplicationMetadata",
- xmlName: "OrMetadata",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- }
- },
- hasVersionsOnly: {
- serializedName: "HasVersionsOnly",
- xmlName: "HasVersionsOnly",
- type: {
- name: "Boolean"
- }
- }
- }
- }
-};
-const BlobName = {
- serializedName: "BlobName",
- type: {
- name: "Composite",
- className: "BlobName",
- modelProperties: {
- encoded: {
- serializedName: "Encoded",
- xmlName: "Encoded",
- xmlIsAttribute: true,
- type: {
- name: "Boolean"
- }
- },
- content: {
- serializedName: "content",
- xmlName: "content",
- xmlIsMsText: true,
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobPropertiesInternal = {
- serializedName: "BlobPropertiesInternal",
- xmlName: "Properties",
- type: {
- name: "Composite",
- className: "BlobPropertiesInternal",
- modelProperties: {
- createdOn: {
- serializedName: "Creation-Time",
- xmlName: "Creation-Time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- lastModified: {
- serializedName: "Last-Modified",
- required: true,
- xmlName: "Last-Modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- etag: {
- serializedName: "Etag",
- required: true,
- xmlName: "Etag",
- type: {
- name: "String"
- }
- },
- contentLength: {
- serializedName: "Content-Length",
- xmlName: "Content-Length",
- type: {
- name: "Number"
- }
- },
- contentType: {
- serializedName: "Content-Type",
- xmlName: "Content-Type",
- type: {
- name: "String"
- }
- },
- contentEncoding: {
- serializedName: "Content-Encoding",
- xmlName: "Content-Encoding",
- type: {
- name: "String"
- }
- },
- contentLanguage: {
- serializedName: "Content-Language",
- xmlName: "Content-Language",
- type: {
- name: "String"
- }
- },
- contentMD5: {
- serializedName: "Content-MD5",
- xmlName: "Content-MD5",
- type: {
- name: "ByteArray"
- }
- },
- contentDisposition: {
- serializedName: "Content-Disposition",
- xmlName: "Content-Disposition",
- type: {
- name: "String"
- }
- },
- cacheControl: {
- serializedName: "Cache-Control",
- xmlName: "Cache-Control",
- type: {
- name: "String"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- blobType: {
- serializedName: "BlobType",
- xmlName: "BlobType",
- type: {
- name: "Enum",
- allowedValues: ["BlockBlob", "PageBlob", "AppendBlob"]
- }
- },
- leaseStatus: {
- serializedName: "LeaseStatus",
- xmlName: "LeaseStatus",
- type: {
- name: "Enum",
- allowedValues: ["locked", "unlocked"]
- }
- },
- leaseState: {
- serializedName: "LeaseState",
- xmlName: "LeaseState",
- type: {
- name: "Enum",
- allowedValues: [
- "available",
- "leased",
- "expired",
- "breaking",
- "broken"
- ]
- }
- },
- leaseDuration: {
- serializedName: "LeaseDuration",
- xmlName: "LeaseDuration",
- type: {
- name: "Enum",
- allowedValues: ["infinite", "fixed"]
- }
- },
- copyId: {
- serializedName: "CopyId",
- xmlName: "CopyId",
- type: {
- name: "String"
- }
- },
- copyStatus: {
- serializedName: "CopyStatus",
- xmlName: "CopyStatus",
- type: {
- name: "Enum",
- allowedValues: ["pending", "success", "aborted", "failed"]
- }
- },
- copySource: {
- serializedName: "CopySource",
- xmlName: "CopySource",
- type: {
- name: "String"
- }
- },
- copyProgress: {
- serializedName: "CopyProgress",
- xmlName: "CopyProgress",
- type: {
- name: "String"
- }
- },
- copyCompletedOn: {
- serializedName: "CopyCompletionTime",
- xmlName: "CopyCompletionTime",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- copyStatusDescription: {
- serializedName: "CopyStatusDescription",
- xmlName: "CopyStatusDescription",
- type: {
- name: "String"
- }
- },
- serverEncrypted: {
- serializedName: "ServerEncrypted",
- xmlName: "ServerEncrypted",
- type: {
- name: "Boolean"
- }
- },
- incrementalCopy: {
- serializedName: "IncrementalCopy",
- xmlName: "IncrementalCopy",
- type: {
- name: "Boolean"
- }
- },
- destinationSnapshot: {
- serializedName: "DestinationSnapshot",
- xmlName: "DestinationSnapshot",
- type: {
- name: "String"
- }
- },
- deletedOn: {
- serializedName: "DeletedTime",
- xmlName: "DeletedTime",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- remainingRetentionDays: {
- serializedName: "RemainingRetentionDays",
- xmlName: "RemainingRetentionDays",
- type: {
- name: "Number"
- }
- },
- accessTier: {
- serializedName: "AccessTier",
- xmlName: "AccessTier",
- type: {
- name: "Enum",
- allowedValues: [
- "P4",
- "P6",
- "P10",
- "P15",
- "P20",
- "P30",
- "P40",
- "P50",
- "P60",
- "P70",
- "P80",
- "Hot",
- "Cool",
- "Archive",
- "Cold"
- ]
- }
- },
- accessTierInferred: {
- serializedName: "AccessTierInferred",
- xmlName: "AccessTierInferred",
- type: {
- name: "Boolean"
- }
- },
- archiveStatus: {
- serializedName: "ArchiveStatus",
- xmlName: "ArchiveStatus",
- type: {
- name: "Enum",
- allowedValues: [
- "rehydrate-pending-to-hot",
- "rehydrate-pending-to-cool",
- "rehydrate-pending-to-cold"
- ]
- }
- },
- customerProvidedKeySha256: {
- serializedName: "CustomerProvidedKeySha256",
- xmlName: "CustomerProvidedKeySha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "EncryptionScope",
- xmlName: "EncryptionScope",
- type: {
- name: "String"
- }
- },
- accessTierChangedOn: {
- serializedName: "AccessTierChangeTime",
- xmlName: "AccessTierChangeTime",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- tagCount: {
- serializedName: "TagCount",
- xmlName: "TagCount",
- type: {
- name: "Number"
- }
- },
- expiresOn: {
- serializedName: "Expiry-Time",
- xmlName: "Expiry-Time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isSealed: {
- serializedName: "Sealed",
- xmlName: "Sealed",
- type: {
- name: "Boolean"
- }
- },
- rehydratePriority: {
- serializedName: "RehydratePriority",
- xmlName: "RehydratePriority",
- type: {
- name: "Enum",
- allowedValues: ["High", "Standard"]
- }
- },
- lastAccessedOn: {
- serializedName: "LastAccessTime",
- xmlName: "LastAccessTime",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- immutabilityPolicyExpiresOn: {
- serializedName: "ImmutabilityPolicyUntilDate",
- xmlName: "ImmutabilityPolicyUntilDate",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- immutabilityPolicyMode: {
- serializedName: "ImmutabilityPolicyMode",
- xmlName: "ImmutabilityPolicyMode",
- type: {
- name: "Enum",
- allowedValues: ["Mutable", "Unlocked", "Locked"]
- }
- },
- legalHold: {
- serializedName: "LegalHold",
- xmlName: "LegalHold",
- type: {
- name: "Boolean"
- }
- }
- }
- }
-};
-const ListBlobsHierarchySegmentResponse = {
- serializedName: "ListBlobsHierarchySegmentResponse",
- xmlName: "EnumerationResults",
- type: {
- name: "Composite",
- className: "ListBlobsHierarchySegmentResponse",
- modelProperties: {
- serviceEndpoint: {
- serializedName: "ServiceEndpoint",
- required: true,
- xmlName: "ServiceEndpoint",
- xmlIsAttribute: true,
- type: {
- name: "String"
- }
- },
- containerName: {
- serializedName: "ContainerName",
- required: true,
- xmlName: "ContainerName",
- xmlIsAttribute: true,
- type: {
- name: "String"
- }
- },
- prefix: {
- serializedName: "Prefix",
- xmlName: "Prefix",
- type: {
- name: "String"
- }
- },
- marker: {
- serializedName: "Marker",
- xmlName: "Marker",
- type: {
- name: "String"
- }
- },
- maxPageSize: {
- serializedName: "MaxResults",
- xmlName: "MaxResults",
- type: {
- name: "Number"
- }
- },
- delimiter: {
- serializedName: "Delimiter",
- xmlName: "Delimiter",
- type: {
- name: "String"
- }
- },
- segment: {
- serializedName: "Segment",
- xmlName: "Blobs",
- type: {
- name: "Composite",
- className: "BlobHierarchyListSegment"
- }
- },
- continuationToken: {
- serializedName: "NextMarker",
- xmlName: "NextMarker",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobHierarchyListSegment = {
- serializedName: "BlobHierarchyListSegment",
- xmlName: "Blobs",
- type: {
- name: "Composite",
- className: "BlobHierarchyListSegment",
- modelProperties: {
- blobPrefixes: {
- serializedName: "BlobPrefixes",
- xmlName: "BlobPrefixes",
- xmlElementName: "BlobPrefix",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "BlobPrefix"
- }
- }
- }
- },
- blobItems: {
- serializedName: "BlobItems",
- required: true,
- xmlName: "BlobItems",
- xmlElementName: "Blob",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "BlobItemInternal"
- }
- }
- }
- }
- }
- }
-};
-const BlobPrefix = {
- serializedName: "BlobPrefix",
- type: {
- name: "Composite",
- className: "BlobPrefix",
- modelProperties: {
- name: {
- serializedName: "Name",
- xmlName: "Name",
- type: {
- name: "Composite",
- className: "BlobName"
- }
- }
- }
- }
-};
-const BlockLookupList = {
- serializedName: "BlockLookupList",
- xmlName: "BlockList",
- type: {
- name: "Composite",
- className: "BlockLookupList",
- modelProperties: {
- committed: {
- serializedName: "Committed",
- xmlName: "Committed",
- xmlElementName: "Committed",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "String"
- }
- }
- }
- },
- uncommitted: {
- serializedName: "Uncommitted",
- xmlName: "Uncommitted",
- xmlElementName: "Uncommitted",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "String"
- }
- }
- }
- },
- latest: {
- serializedName: "Latest",
- xmlName: "Latest",
- xmlElementName: "Latest",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "String"
- }
- }
- }
- }
- }
- }
-};
-const BlockList = {
- serializedName: "BlockList",
- type: {
- name: "Composite",
- className: "BlockList",
- modelProperties: {
- committedBlocks: {
- serializedName: "CommittedBlocks",
- xmlName: "CommittedBlocks",
- xmlIsWrapped: true,
- xmlElementName: "Block",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "Block"
- }
- }
- }
- },
- uncommittedBlocks: {
- serializedName: "UncommittedBlocks",
- xmlName: "UncommittedBlocks",
- xmlIsWrapped: true,
- xmlElementName: "Block",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "Block"
- }
- }
- }
- }
- }
- }
-};
-const Block = {
- serializedName: "Block",
- type: {
- name: "Composite",
- className: "Block",
- modelProperties: {
- name: {
- serializedName: "Name",
- required: true,
- xmlName: "Name",
- type: {
- name: "String"
- }
- },
- size: {
- serializedName: "Size",
- required: true,
- xmlName: "Size",
- type: {
- name: "Number"
- }
- }
- }
- }
-};
-const PageList = {
- serializedName: "PageList",
- type: {
- name: "Composite",
- className: "PageList",
- modelProperties: {
- pageRange: {
- serializedName: "PageRange",
- xmlName: "PageRange",
- xmlElementName: "PageRange",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "PageRange"
- }
- }
- }
- },
- clearRange: {
- serializedName: "ClearRange",
- xmlName: "ClearRange",
- xmlElementName: "ClearRange",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "ClearRange"
- }
- }
- }
- },
- continuationToken: {
- serializedName: "NextMarker",
- xmlName: "NextMarker",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageRange = {
- serializedName: "PageRange",
- xmlName: "PageRange",
- type: {
- name: "Composite",
- className: "PageRange",
- modelProperties: {
- start: {
- serializedName: "Start",
- required: true,
- xmlName: "Start",
- type: {
- name: "Number"
- }
- },
- end: {
- serializedName: "End",
- required: true,
- xmlName: "End",
- type: {
- name: "Number"
- }
- }
- }
- }
-};
-const ClearRange = {
- serializedName: "ClearRange",
- xmlName: "ClearRange",
- type: {
- name: "Composite",
- className: "ClearRange",
- modelProperties: {
- start: {
- serializedName: "Start",
- required: true,
- xmlName: "Start",
- type: {
- name: "Number"
- }
- },
- end: {
- serializedName: "End",
- required: true,
- xmlName: "End",
- type: {
- name: "Number"
- }
- }
- }
- }
-};
-const QueryRequest = {
- serializedName: "QueryRequest",
- xmlName: "QueryRequest",
- type: {
- name: "Composite",
- className: "QueryRequest",
- modelProperties: {
- queryType: {
- serializedName: "QueryType",
- required: true,
- xmlName: "QueryType",
- type: {
- name: "String"
- }
- },
- expression: {
- serializedName: "Expression",
- required: true,
- xmlName: "Expression",
- type: {
- name: "String"
- }
- },
- inputSerialization: {
- serializedName: "InputSerialization",
- xmlName: "InputSerialization",
- type: {
- name: "Composite",
- className: "QuerySerialization"
- }
- },
- outputSerialization: {
- serializedName: "OutputSerialization",
- xmlName: "OutputSerialization",
- type: {
- name: "Composite",
- className: "QuerySerialization"
- }
- }
- }
- }
-};
-const QuerySerialization = {
- serializedName: "QuerySerialization",
- type: {
- name: "Composite",
- className: "QuerySerialization",
- modelProperties: {
- format: {
- serializedName: "Format",
- xmlName: "Format",
- type: {
- name: "Composite",
- className: "QueryFormat"
- }
- }
- }
- }
-};
-const QueryFormat = {
- serializedName: "QueryFormat",
- type: {
- name: "Composite",
- className: "QueryFormat",
- modelProperties: {
- type: {
- serializedName: "Type",
- required: true,
- xmlName: "Type",
- type: {
- name: "Enum",
- allowedValues: ["delimited", "json", "arrow", "parquet"]
- }
- },
- delimitedTextConfiguration: {
- serializedName: "DelimitedTextConfiguration",
- xmlName: "DelimitedTextConfiguration",
- type: {
- name: "Composite",
- className: "DelimitedTextConfiguration"
- }
- },
- jsonTextConfiguration: {
- serializedName: "JsonTextConfiguration",
- xmlName: "JsonTextConfiguration",
- type: {
- name: "Composite",
- className: "JsonTextConfiguration"
- }
- },
- arrowConfiguration: {
- serializedName: "ArrowConfiguration",
- xmlName: "ArrowConfiguration",
- type: {
- name: "Composite",
- className: "ArrowConfiguration"
- }
- },
- parquetTextConfiguration: {
- serializedName: "ParquetTextConfiguration",
- xmlName: "ParquetTextConfiguration",
- type: {
- name: "any"
- }
- }
- }
- }
-};
-const DelimitedTextConfiguration = {
- serializedName: "DelimitedTextConfiguration",
- xmlName: "DelimitedTextConfiguration",
- type: {
- name: "Composite",
- className: "DelimitedTextConfiguration",
- modelProperties: {
- columnSeparator: {
- serializedName: "ColumnSeparator",
- xmlName: "ColumnSeparator",
- type: {
- name: "String"
- }
- },
- fieldQuote: {
- serializedName: "FieldQuote",
- xmlName: "FieldQuote",
- type: {
- name: "String"
- }
- },
- recordSeparator: {
- serializedName: "RecordSeparator",
- xmlName: "RecordSeparator",
- type: {
- name: "String"
- }
- },
- escapeChar: {
- serializedName: "EscapeChar",
- xmlName: "EscapeChar",
- type: {
- name: "String"
- }
- },
- headersPresent: {
- serializedName: "HeadersPresent",
- xmlName: "HasHeaders",
- type: {
- name: "Boolean"
- }
- }
- }
- }
-};
-const JsonTextConfiguration = {
- serializedName: "JsonTextConfiguration",
- xmlName: "JsonTextConfiguration",
- type: {
- name: "Composite",
- className: "JsonTextConfiguration",
- modelProperties: {
- recordSeparator: {
- serializedName: "RecordSeparator",
- xmlName: "RecordSeparator",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ArrowConfiguration = {
- serializedName: "ArrowConfiguration",
- xmlName: "ArrowConfiguration",
- type: {
- name: "Composite",
- className: "ArrowConfiguration",
- modelProperties: {
- schema: {
- serializedName: "Schema",
- required: true,
- xmlName: "Schema",
- xmlIsWrapped: true,
- xmlElementName: "Field",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "ArrowField"
- }
- }
- }
- }
- }
- }
-};
-const ArrowField = {
- serializedName: "ArrowField",
- xmlName: "Field",
- type: {
- name: "Composite",
- className: "ArrowField",
- modelProperties: {
- type: {
- serializedName: "Type",
- required: true,
- xmlName: "Type",
- type: {
- name: "String"
- }
- },
- name: {
- serializedName: "Name",
- xmlName: "Name",
- type: {
- name: "String"
- }
- },
- precision: {
- serializedName: "Precision",
- xmlName: "Precision",
- type: {
- name: "Number"
- }
- },
- scale: {
- serializedName: "Scale",
- xmlName: "Scale",
- type: {
- name: "Number"
- }
- }
- }
- }
-};
-const ServiceSetPropertiesHeaders = {
- serializedName: "Service_setPropertiesHeaders",
- type: {
- name: "Composite",
- className: "ServiceSetPropertiesHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceSetPropertiesExceptionHeaders = {
- serializedName: "Service_setPropertiesExceptionHeaders",
- type: {
- name: "Composite",
- className: "ServiceSetPropertiesExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceGetPropertiesHeaders = {
- serializedName: "Service_getPropertiesHeaders",
- type: {
- name: "Composite",
- className: "ServiceGetPropertiesHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceGetPropertiesExceptionHeaders = {
- serializedName: "Service_getPropertiesExceptionHeaders",
- type: {
- name: "Composite",
- className: "ServiceGetPropertiesExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceGetStatisticsHeaders = {
- serializedName: "Service_getStatisticsHeaders",
- type: {
- name: "Composite",
- className: "ServiceGetStatisticsHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceGetStatisticsExceptionHeaders = {
- serializedName: "Service_getStatisticsExceptionHeaders",
- type: {
- name: "Composite",
- className: "ServiceGetStatisticsExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceListContainersSegmentHeaders = {
- serializedName: "Service_listContainersSegmentHeaders",
- type: {
- name: "Composite",
- className: "ServiceListContainersSegmentHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceListContainersSegmentExceptionHeaders = {
- serializedName: "Service_listContainersSegmentExceptionHeaders",
- type: {
- name: "Composite",
- className: "ServiceListContainersSegmentExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceGetUserDelegationKeyHeaders = {
- serializedName: "Service_getUserDelegationKeyHeaders",
- type: {
- name: "Composite",
- className: "ServiceGetUserDelegationKeyHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceGetUserDelegationKeyExceptionHeaders = {
- serializedName: "Service_getUserDelegationKeyExceptionHeaders",
- type: {
- name: "Composite",
- className: "ServiceGetUserDelegationKeyExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceGetAccountInfoHeaders = {
- serializedName: "Service_getAccountInfoHeaders",
- type: {
- name: "Composite",
- className: "ServiceGetAccountInfoHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- skuName: {
- serializedName: "x-ms-sku-name",
- xmlName: "x-ms-sku-name",
- type: {
- name: "Enum",
- allowedValues: [
- "Standard_LRS",
- "Standard_GRS",
- "Standard_RAGRS",
- "Standard_ZRS",
- "Premium_LRS"
- ]
- }
- },
- accountKind: {
- serializedName: "x-ms-account-kind",
- xmlName: "x-ms-account-kind",
- type: {
- name: "Enum",
- allowedValues: [
- "Storage",
- "BlobStorage",
- "StorageV2",
- "FileStorage",
- "BlockBlobStorage"
- ]
- }
- },
- isHierarchicalNamespaceEnabled: {
- serializedName: "x-ms-is-hns-enabled",
- xmlName: "x-ms-is-hns-enabled",
- type: {
- name: "Boolean"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceGetAccountInfoExceptionHeaders = {
- serializedName: "Service_getAccountInfoExceptionHeaders",
- type: {
- name: "Composite",
- className: "ServiceGetAccountInfoExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceSubmitBatchHeaders = {
- serializedName: "Service_submitBatchHeaders",
- type: {
- name: "Composite",
- className: "ServiceSubmitBatchHeaders",
- modelProperties: {
- contentType: {
- serializedName: "content-type",
- xmlName: "content-type",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceSubmitBatchExceptionHeaders = {
- serializedName: "Service_submitBatchExceptionHeaders",
- type: {
- name: "Composite",
- className: "ServiceSubmitBatchExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceFilterBlobsHeaders = {
- serializedName: "Service_filterBlobsHeaders",
- type: {
- name: "Composite",
- className: "ServiceFilterBlobsHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ServiceFilterBlobsExceptionHeaders = {
- serializedName: "Service_filterBlobsExceptionHeaders",
- type: {
- name: "Composite",
- className: "ServiceFilterBlobsExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerCreateHeaders = {
- serializedName: "Container_createHeaders",
- type: {
- name: "Composite",
- className: "ContainerCreateHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerCreateExceptionHeaders = {
- serializedName: "Container_createExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerCreateExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerGetPropertiesHeaders = {
- serializedName: "Container_getPropertiesHeaders",
- type: {
- name: "Composite",
- className: "ContainerGetPropertiesHeaders",
- modelProperties: {
- metadata: {
- serializedName: "x-ms-meta",
- xmlName: "x-ms-meta",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- },
- headerCollectionPrefix: "x-ms-meta-"
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- leaseDuration: {
- serializedName: "x-ms-lease-duration",
- xmlName: "x-ms-lease-duration",
- type: {
- name: "Enum",
- allowedValues: ["infinite", "fixed"]
- }
- },
- leaseState: {
- serializedName: "x-ms-lease-state",
- xmlName: "x-ms-lease-state",
- type: {
- name: "Enum",
- allowedValues: [
- "available",
- "leased",
- "expired",
- "breaking",
- "broken"
- ]
- }
- },
- leaseStatus: {
- serializedName: "x-ms-lease-status",
- xmlName: "x-ms-lease-status",
- type: {
- name: "Enum",
- allowedValues: ["locked", "unlocked"]
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- blobPublicAccess: {
- serializedName: "x-ms-blob-public-access",
- xmlName: "x-ms-blob-public-access",
- type: {
- name: "Enum",
- allowedValues: ["container", "blob"]
- }
- },
- hasImmutabilityPolicy: {
- serializedName: "x-ms-has-immutability-policy",
- xmlName: "x-ms-has-immutability-policy",
- type: {
- name: "Boolean"
- }
- },
- hasLegalHold: {
- serializedName: "x-ms-has-legal-hold",
- xmlName: "x-ms-has-legal-hold",
- type: {
- name: "Boolean"
- }
- },
- defaultEncryptionScope: {
- serializedName: "x-ms-default-encryption-scope",
- xmlName: "x-ms-default-encryption-scope",
- type: {
- name: "String"
- }
- },
- denyEncryptionScopeOverride: {
- serializedName: "x-ms-deny-encryption-scope-override",
- xmlName: "x-ms-deny-encryption-scope-override",
- type: {
- name: "Boolean"
- }
- },
- isImmutableStorageWithVersioningEnabled: {
- serializedName: "x-ms-immutable-storage-with-versioning-enabled",
- xmlName: "x-ms-immutable-storage-with-versioning-enabled",
- type: {
- name: "Boolean"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerGetPropertiesExceptionHeaders = {
- serializedName: "Container_getPropertiesExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerGetPropertiesExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerDeleteHeaders = {
- serializedName: "Container_deleteHeaders",
- type: {
- name: "Composite",
- className: "ContainerDeleteHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerDeleteExceptionHeaders = {
- serializedName: "Container_deleteExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerDeleteExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerSetMetadataHeaders = {
- serializedName: "Container_setMetadataHeaders",
- type: {
- name: "Composite",
- className: "ContainerSetMetadataHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerSetMetadataExceptionHeaders = {
- serializedName: "Container_setMetadataExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerSetMetadataExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerGetAccessPolicyHeaders = {
- serializedName: "Container_getAccessPolicyHeaders",
- type: {
- name: "Composite",
- className: "ContainerGetAccessPolicyHeaders",
- modelProperties: {
- blobPublicAccess: {
- serializedName: "x-ms-blob-public-access",
- xmlName: "x-ms-blob-public-access",
- type: {
- name: "Enum",
- allowedValues: ["container", "blob"]
- }
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerGetAccessPolicyExceptionHeaders = {
- serializedName: "Container_getAccessPolicyExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerGetAccessPolicyExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerSetAccessPolicyHeaders = {
- serializedName: "Container_setAccessPolicyHeaders",
- type: {
- name: "Composite",
- className: "ContainerSetAccessPolicyHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerSetAccessPolicyExceptionHeaders = {
- serializedName: "Container_setAccessPolicyExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerSetAccessPolicyExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerRestoreHeaders = {
- serializedName: "Container_restoreHeaders",
- type: {
- name: "Composite",
- className: "ContainerRestoreHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerRestoreExceptionHeaders = {
- serializedName: "Container_restoreExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerRestoreExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerRenameHeaders = {
- serializedName: "Container_renameHeaders",
- type: {
- name: "Composite",
- className: "ContainerRenameHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerRenameExceptionHeaders = {
- serializedName: "Container_renameExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerRenameExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerSubmitBatchHeaders = {
- serializedName: "Container_submitBatchHeaders",
- type: {
- name: "Composite",
- className: "ContainerSubmitBatchHeaders",
- modelProperties: {
- contentType: {
- serializedName: "content-type",
- xmlName: "content-type",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerSubmitBatchExceptionHeaders = {
- serializedName: "Container_submitBatchExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerSubmitBatchExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerFilterBlobsHeaders = {
- serializedName: "Container_filterBlobsHeaders",
- type: {
- name: "Composite",
- className: "ContainerFilterBlobsHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const ContainerFilterBlobsExceptionHeaders = {
- serializedName: "Container_filterBlobsExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerFilterBlobsExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerAcquireLeaseHeaders = {
- serializedName: "Container_acquireLeaseHeaders",
- type: {
- name: "Composite",
- className: "ContainerAcquireLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- leaseId: {
- serializedName: "x-ms-lease-id",
- xmlName: "x-ms-lease-id",
- type: {
- name: "String"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const ContainerAcquireLeaseExceptionHeaders = {
- serializedName: "Container_acquireLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerAcquireLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerReleaseLeaseHeaders = {
- serializedName: "Container_releaseLeaseHeaders",
- type: {
- name: "Composite",
- className: "ContainerReleaseLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const ContainerReleaseLeaseExceptionHeaders = {
- serializedName: "Container_releaseLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerReleaseLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerRenewLeaseHeaders = {
- serializedName: "Container_renewLeaseHeaders",
- type: {
- name: "Composite",
- className: "ContainerRenewLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- leaseId: {
- serializedName: "x-ms-lease-id",
- xmlName: "x-ms-lease-id",
- type: {
- name: "String"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const ContainerRenewLeaseExceptionHeaders = {
- serializedName: "Container_renewLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerRenewLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerBreakLeaseHeaders = {
- serializedName: "Container_breakLeaseHeaders",
- type: {
- name: "Composite",
- className: "ContainerBreakLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- leaseTime: {
- serializedName: "x-ms-lease-time",
- xmlName: "x-ms-lease-time",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const ContainerBreakLeaseExceptionHeaders = {
- serializedName: "Container_breakLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerBreakLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerChangeLeaseHeaders = {
- serializedName: "Container_changeLeaseHeaders",
- type: {
- name: "Composite",
- className: "ContainerChangeLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- leaseId: {
- serializedName: "x-ms-lease-id",
- xmlName: "x-ms-lease-id",
- type: {
- name: "String"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const ContainerChangeLeaseExceptionHeaders = {
- serializedName: "Container_changeLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerChangeLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerListBlobFlatSegmentHeaders = {
- serializedName: "Container_listBlobFlatSegmentHeaders",
- type: {
- name: "Composite",
- className: "ContainerListBlobFlatSegmentHeaders",
- modelProperties: {
- contentType: {
- serializedName: "content-type",
- xmlName: "content-type",
- type: {
- name: "String"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerListBlobFlatSegmentExceptionHeaders = {
- serializedName: "Container_listBlobFlatSegmentExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerListBlobFlatSegmentExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerListBlobHierarchySegmentHeaders = {
- serializedName: "Container_listBlobHierarchySegmentHeaders",
- type: {
- name: "Composite",
- className: "ContainerListBlobHierarchySegmentHeaders",
- modelProperties: {
- contentType: {
- serializedName: "content-type",
- xmlName: "content-type",
- type: {
- name: "String"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerListBlobHierarchySegmentExceptionHeaders = {
- serializedName: "Container_listBlobHierarchySegmentExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerListBlobHierarchySegmentExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const ContainerGetAccountInfoHeaders = {
- serializedName: "Container_getAccountInfoHeaders",
- type: {
- name: "Composite",
- className: "ContainerGetAccountInfoHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- skuName: {
- serializedName: "x-ms-sku-name",
- xmlName: "x-ms-sku-name",
- type: {
- name: "Enum",
- allowedValues: [
- "Standard_LRS",
- "Standard_GRS",
- "Standard_RAGRS",
- "Standard_ZRS",
- "Premium_LRS"
- ]
- }
- },
- accountKind: {
- serializedName: "x-ms-account-kind",
- xmlName: "x-ms-account-kind",
- type: {
- name: "Enum",
- allowedValues: [
- "Storage",
- "BlobStorage",
- "StorageV2",
- "FileStorage",
- "BlockBlobStorage"
- ]
- }
- }
- }
- }
-};
-const ContainerGetAccountInfoExceptionHeaders = {
- serializedName: "Container_getAccountInfoExceptionHeaders",
- type: {
- name: "Composite",
- className: "ContainerGetAccountInfoExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobDownloadHeaders = {
- serializedName: "Blob_downloadHeaders",
- type: {
- name: "Composite",
- className: "BlobDownloadHeaders",
- modelProperties: {
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- createdOn: {
- serializedName: "x-ms-creation-time",
- xmlName: "x-ms-creation-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- metadata: {
- serializedName: "x-ms-meta",
- xmlName: "x-ms-meta",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- },
- headerCollectionPrefix: "x-ms-meta-"
- },
- objectReplicationPolicyId: {
- serializedName: "x-ms-or-policy-id",
- xmlName: "x-ms-or-policy-id",
- type: {
- name: "String"
- }
- },
- objectReplicationRules: {
- serializedName: "x-ms-or",
- xmlName: "x-ms-or",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- },
- headerCollectionPrefix: "x-ms-or-"
- },
- contentLength: {
- serializedName: "content-length",
- xmlName: "content-length",
- type: {
- name: "Number"
- }
- },
- contentType: {
- serializedName: "content-type",
- xmlName: "content-type",
- type: {
- name: "String"
- }
- },
- contentRange: {
- serializedName: "content-range",
- xmlName: "content-range",
- type: {
- name: "String"
- }
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- contentEncoding: {
- serializedName: "content-encoding",
- xmlName: "content-encoding",
- type: {
- name: "String"
- }
- },
- cacheControl: {
- serializedName: "cache-control",
- xmlName: "cache-control",
- type: {
- name: "String"
- }
- },
- contentDisposition: {
- serializedName: "content-disposition",
- xmlName: "content-disposition",
- type: {
- name: "String"
- }
- },
- contentLanguage: {
- serializedName: "content-language",
- xmlName: "content-language",
- type: {
- name: "String"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- blobType: {
- serializedName: "x-ms-blob-type",
- xmlName: "x-ms-blob-type",
- type: {
- name: "Enum",
- allowedValues: ["BlockBlob", "PageBlob", "AppendBlob"]
- }
- },
- copyCompletedOn: {
- serializedName: "x-ms-copy-completion-time",
- xmlName: "x-ms-copy-completion-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- copyStatusDescription: {
- serializedName: "x-ms-copy-status-description",
- xmlName: "x-ms-copy-status-description",
- type: {
- name: "String"
- }
- },
- copyId: {
- serializedName: "x-ms-copy-id",
- xmlName: "x-ms-copy-id",
- type: {
- name: "String"
- }
- },
- copyProgress: {
- serializedName: "x-ms-copy-progress",
- xmlName: "x-ms-copy-progress",
- type: {
- name: "String"
- }
- },
- copySource: {
- serializedName: "x-ms-copy-source",
- xmlName: "x-ms-copy-source",
- type: {
- name: "String"
- }
- },
- copyStatus: {
- serializedName: "x-ms-copy-status",
- xmlName: "x-ms-copy-status",
- type: {
- name: "Enum",
- allowedValues: ["pending", "success", "aborted", "failed"]
- }
- },
- leaseDuration: {
- serializedName: "x-ms-lease-duration",
- xmlName: "x-ms-lease-duration",
- type: {
- name: "Enum",
- allowedValues: ["infinite", "fixed"]
- }
- },
- leaseState: {
- serializedName: "x-ms-lease-state",
- xmlName: "x-ms-lease-state",
- type: {
- name: "Enum",
- allowedValues: [
- "available",
- "leased",
- "expired",
- "breaking",
- "broken"
- ]
- }
- },
- leaseStatus: {
- serializedName: "x-ms-lease-status",
- xmlName: "x-ms-lease-status",
- type: {
- name: "Enum",
- allowedValues: ["locked", "unlocked"]
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- isCurrentVersion: {
- serializedName: "x-ms-is-current-version",
- xmlName: "x-ms-is-current-version",
- type: {
- name: "Boolean"
- }
- },
- acceptRanges: {
- serializedName: "accept-ranges",
- xmlName: "accept-ranges",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- blobCommittedBlockCount: {
- serializedName: "x-ms-blob-committed-block-count",
- xmlName: "x-ms-blob-committed-block-count",
- type: {
- name: "Number"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-server-encrypted",
- xmlName: "x-ms-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- blobContentMD5: {
- serializedName: "x-ms-blob-content-md5",
- xmlName: "x-ms-blob-content-md5",
- type: {
- name: "ByteArray"
- }
- },
- tagCount: {
- serializedName: "x-ms-tag-count",
- xmlName: "x-ms-tag-count",
- type: {
- name: "Number"
- }
- },
- isSealed: {
- serializedName: "x-ms-blob-sealed",
- xmlName: "x-ms-blob-sealed",
- type: {
- name: "Boolean"
- }
- },
- lastAccessed: {
- serializedName: "x-ms-last-access-time",
- xmlName: "x-ms-last-access-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- immutabilityPolicyExpiresOn: {
- serializedName: "x-ms-immutability-policy-until-date",
- xmlName: "x-ms-immutability-policy-until-date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- immutabilityPolicyMode: {
- serializedName: "x-ms-immutability-policy-mode",
- xmlName: "x-ms-immutability-policy-mode",
- type: {
- name: "Enum",
- allowedValues: ["Mutable", "Unlocked", "Locked"]
- }
- },
- legalHold: {
- serializedName: "x-ms-legal-hold",
- xmlName: "x-ms-legal-hold",
- type: {
- name: "Boolean"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- },
- contentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- }
- }
- }
-};
-const BlobDownloadExceptionHeaders = {
- serializedName: "Blob_downloadExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobDownloadExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobGetPropertiesHeaders = {
- serializedName: "Blob_getPropertiesHeaders",
- type: {
- name: "Composite",
- className: "BlobGetPropertiesHeaders",
- modelProperties: {
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- createdOn: {
- serializedName: "x-ms-creation-time",
- xmlName: "x-ms-creation-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- metadata: {
- serializedName: "x-ms-meta",
- xmlName: "x-ms-meta",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- },
- headerCollectionPrefix: "x-ms-meta-"
- },
- objectReplicationPolicyId: {
- serializedName: "x-ms-or-policy-id",
- xmlName: "x-ms-or-policy-id",
- type: {
- name: "String"
- }
- },
- objectReplicationRules: {
- serializedName: "x-ms-or",
- xmlName: "x-ms-or",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- },
- headerCollectionPrefix: "x-ms-or-"
- },
- blobType: {
- serializedName: "x-ms-blob-type",
- xmlName: "x-ms-blob-type",
- type: {
- name: "Enum",
- allowedValues: ["BlockBlob", "PageBlob", "AppendBlob"]
- }
- },
- copyCompletedOn: {
- serializedName: "x-ms-copy-completion-time",
- xmlName: "x-ms-copy-completion-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- copyStatusDescription: {
- serializedName: "x-ms-copy-status-description",
- xmlName: "x-ms-copy-status-description",
- type: {
- name: "String"
- }
- },
- copyId: {
- serializedName: "x-ms-copy-id",
- xmlName: "x-ms-copy-id",
- type: {
- name: "String"
- }
- },
- copyProgress: {
- serializedName: "x-ms-copy-progress",
- xmlName: "x-ms-copy-progress",
- type: {
- name: "String"
- }
- },
- copySource: {
- serializedName: "x-ms-copy-source",
- xmlName: "x-ms-copy-source",
- type: {
- name: "String"
- }
- },
- copyStatus: {
- serializedName: "x-ms-copy-status",
- xmlName: "x-ms-copy-status",
- type: {
- name: "Enum",
- allowedValues: ["pending", "success", "aborted", "failed"]
- }
- },
- isIncrementalCopy: {
- serializedName: "x-ms-incremental-copy",
- xmlName: "x-ms-incremental-copy",
- type: {
- name: "Boolean"
- }
- },
- destinationSnapshot: {
- serializedName: "x-ms-copy-destination-snapshot",
- xmlName: "x-ms-copy-destination-snapshot",
- type: {
- name: "String"
- }
- },
- leaseDuration: {
- serializedName: "x-ms-lease-duration",
- xmlName: "x-ms-lease-duration",
- type: {
- name: "Enum",
- allowedValues: ["infinite", "fixed"]
- }
- },
- leaseState: {
- serializedName: "x-ms-lease-state",
- xmlName: "x-ms-lease-state",
- type: {
- name: "Enum",
- allowedValues: [
- "available",
- "leased",
- "expired",
- "breaking",
- "broken"
- ]
- }
- },
- leaseStatus: {
- serializedName: "x-ms-lease-status",
- xmlName: "x-ms-lease-status",
- type: {
- name: "Enum",
- allowedValues: ["locked", "unlocked"]
- }
- },
- contentLength: {
- serializedName: "content-length",
- xmlName: "content-length",
- type: {
- name: "Number"
- }
- },
- contentType: {
- serializedName: "content-type",
- xmlName: "content-type",
- type: {
- name: "String"
- }
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- contentEncoding: {
- serializedName: "content-encoding",
- xmlName: "content-encoding",
- type: {
- name: "String"
- }
- },
- contentDisposition: {
- serializedName: "content-disposition",
- xmlName: "content-disposition",
- type: {
- name: "String"
- }
- },
- contentLanguage: {
- serializedName: "content-language",
- xmlName: "content-language",
- type: {
- name: "String"
- }
- },
- cacheControl: {
- serializedName: "cache-control",
- xmlName: "cache-control",
- type: {
- name: "String"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- acceptRanges: {
- serializedName: "accept-ranges",
- xmlName: "accept-ranges",
- type: {
- name: "String"
- }
- },
- blobCommittedBlockCount: {
- serializedName: "x-ms-blob-committed-block-count",
- xmlName: "x-ms-blob-committed-block-count",
- type: {
- name: "Number"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-server-encrypted",
- xmlName: "x-ms-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- accessTier: {
- serializedName: "x-ms-access-tier",
- xmlName: "x-ms-access-tier",
- type: {
- name: "String"
- }
- },
- accessTierInferred: {
- serializedName: "x-ms-access-tier-inferred",
- xmlName: "x-ms-access-tier-inferred",
- type: {
- name: "Boolean"
- }
- },
- archiveStatus: {
- serializedName: "x-ms-archive-status",
- xmlName: "x-ms-archive-status",
- type: {
- name: "String"
- }
- },
- accessTierChangedOn: {
- serializedName: "x-ms-access-tier-change-time",
- xmlName: "x-ms-access-tier-change-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- isCurrentVersion: {
- serializedName: "x-ms-is-current-version",
- xmlName: "x-ms-is-current-version",
- type: {
- name: "Boolean"
- }
- },
- tagCount: {
- serializedName: "x-ms-tag-count",
- xmlName: "x-ms-tag-count",
- type: {
- name: "Number"
- }
- },
- expiresOn: {
- serializedName: "x-ms-expiry-time",
- xmlName: "x-ms-expiry-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isSealed: {
- serializedName: "x-ms-blob-sealed",
- xmlName: "x-ms-blob-sealed",
- type: {
- name: "Boolean"
- }
- },
- rehydratePriority: {
- serializedName: "x-ms-rehydrate-priority",
- xmlName: "x-ms-rehydrate-priority",
- type: {
- name: "Enum",
- allowedValues: ["High", "Standard"]
- }
- },
- lastAccessed: {
- serializedName: "x-ms-last-access-time",
- xmlName: "x-ms-last-access-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- immutabilityPolicyExpiresOn: {
- serializedName: "x-ms-immutability-policy-until-date",
- xmlName: "x-ms-immutability-policy-until-date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- immutabilityPolicyMode: {
- serializedName: "x-ms-immutability-policy-mode",
- xmlName: "x-ms-immutability-policy-mode",
- type: {
- name: "Enum",
- allowedValues: ["Mutable", "Unlocked", "Locked"]
- }
- },
- legalHold: {
- serializedName: "x-ms-legal-hold",
- xmlName: "x-ms-legal-hold",
- type: {
- name: "Boolean"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobGetPropertiesExceptionHeaders = {
- serializedName: "Blob_getPropertiesExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobGetPropertiesExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobDeleteHeaders = {
- serializedName: "Blob_deleteHeaders",
- type: {
- name: "Composite",
- className: "BlobDeleteHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobDeleteExceptionHeaders = {
- serializedName: "Blob_deleteExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobDeleteExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobUndeleteHeaders = {
- serializedName: "Blob_undeleteHeaders",
- type: {
- name: "Composite",
- className: "BlobUndeleteHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobUndeleteExceptionHeaders = {
- serializedName: "Blob_undeleteExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobUndeleteExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetExpiryHeaders = {
- serializedName: "Blob_setExpiryHeaders",
- type: {
- name: "Composite",
- className: "BlobSetExpiryHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const BlobSetExpiryExceptionHeaders = {
- serializedName: "Blob_setExpiryExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobSetExpiryExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetHttpHeadersHeaders = {
- serializedName: "Blob_setHttpHeadersHeaders",
- type: {
- name: "Composite",
- className: "BlobSetHttpHeadersHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetHttpHeadersExceptionHeaders = {
- serializedName: "Blob_setHttpHeadersExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobSetHttpHeadersExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetImmutabilityPolicyHeaders = {
- serializedName: "Blob_setImmutabilityPolicyHeaders",
- type: {
- name: "Composite",
- className: "BlobSetImmutabilityPolicyHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- immutabilityPolicyExpiry: {
- serializedName: "x-ms-immutability-policy-until-date",
- xmlName: "x-ms-immutability-policy-until-date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- immutabilityPolicyMode: {
- serializedName: "x-ms-immutability-policy-mode",
- xmlName: "x-ms-immutability-policy-mode",
- type: {
- name: "Enum",
- allowedValues: ["Mutable", "Unlocked", "Locked"]
- }
- }
- }
- }
-};
-const BlobSetImmutabilityPolicyExceptionHeaders = {
- serializedName: "Blob_setImmutabilityPolicyExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobSetImmutabilityPolicyExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobDeleteImmutabilityPolicyHeaders = {
- serializedName: "Blob_deleteImmutabilityPolicyHeaders",
- type: {
- name: "Composite",
- className: "BlobDeleteImmutabilityPolicyHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const BlobDeleteImmutabilityPolicyExceptionHeaders = {
- serializedName: "Blob_deleteImmutabilityPolicyExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobDeleteImmutabilityPolicyExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetLegalHoldHeaders = {
- serializedName: "Blob_setLegalHoldHeaders",
- type: {
- name: "Composite",
- className: "BlobSetLegalHoldHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- legalHold: {
- serializedName: "x-ms-legal-hold",
- xmlName: "x-ms-legal-hold",
- type: {
- name: "Boolean"
- }
- }
- }
- }
-};
-const BlobSetLegalHoldExceptionHeaders = {
- serializedName: "Blob_setLegalHoldExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobSetLegalHoldExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetMetadataHeaders = {
- serializedName: "Blob_setMetadataHeaders",
- type: {
- name: "Composite",
- className: "BlobSetMetadataHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetMetadataExceptionHeaders = {
- serializedName: "Blob_setMetadataExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobSetMetadataExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobAcquireLeaseHeaders = {
- serializedName: "Blob_acquireLeaseHeaders",
- type: {
- name: "Composite",
- className: "BlobAcquireLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- leaseId: {
- serializedName: "x-ms-lease-id",
- xmlName: "x-ms-lease-id",
- type: {
- name: "String"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const BlobAcquireLeaseExceptionHeaders = {
- serializedName: "Blob_acquireLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobAcquireLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobReleaseLeaseHeaders = {
- serializedName: "Blob_releaseLeaseHeaders",
- type: {
- name: "Composite",
- className: "BlobReleaseLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const BlobReleaseLeaseExceptionHeaders = {
- serializedName: "Blob_releaseLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobReleaseLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobRenewLeaseHeaders = {
- serializedName: "Blob_renewLeaseHeaders",
- type: {
- name: "Composite",
- className: "BlobRenewLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- leaseId: {
- serializedName: "x-ms-lease-id",
- xmlName: "x-ms-lease-id",
- type: {
- name: "String"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const BlobRenewLeaseExceptionHeaders = {
- serializedName: "Blob_renewLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobRenewLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobChangeLeaseHeaders = {
- serializedName: "Blob_changeLeaseHeaders",
- type: {
- name: "Composite",
- className: "BlobChangeLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- leaseId: {
- serializedName: "x-ms-lease-id",
- xmlName: "x-ms-lease-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const BlobChangeLeaseExceptionHeaders = {
- serializedName: "Blob_changeLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobChangeLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobBreakLeaseHeaders = {
- serializedName: "Blob_breakLeaseHeaders",
- type: {
- name: "Composite",
- className: "BlobBreakLeaseHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- leaseTime: {
- serializedName: "x-ms-lease-time",
- xmlName: "x-ms-lease-time",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
- }
- }
-};
-const BlobBreakLeaseExceptionHeaders = {
- serializedName: "Blob_breakLeaseExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobBreakLeaseExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobCreateSnapshotHeaders = {
- serializedName: "Blob_createSnapshotHeaders",
- type: {
- name: "Composite",
- className: "BlobCreateSnapshotHeaders",
- modelProperties: {
- snapshot: {
- serializedName: "x-ms-snapshot",
- xmlName: "x-ms-snapshot",
- type: {
- name: "String"
- }
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobCreateSnapshotExceptionHeaders = {
- serializedName: "Blob_createSnapshotExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobCreateSnapshotExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobStartCopyFromURLHeaders = {
- serializedName: "Blob_startCopyFromURLHeaders",
- type: {
- name: "Composite",
- className: "BlobStartCopyFromURLHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- copyId: {
- serializedName: "x-ms-copy-id",
- xmlName: "x-ms-copy-id",
- type: {
- name: "String"
- }
- },
- copyStatus: {
- serializedName: "x-ms-copy-status",
- xmlName: "x-ms-copy-status",
- type: {
- name: "Enum",
- allowedValues: ["pending", "success", "aborted", "failed"]
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobStartCopyFromURLExceptionHeaders = {
- serializedName: "Blob_startCopyFromURLExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobStartCopyFromURLExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobCopyFromURLHeaders = {
- serializedName: "Blob_copyFromURLHeaders",
- type: {
- name: "Composite",
- className: "BlobCopyFromURLHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- copyId: {
- serializedName: "x-ms-copy-id",
- xmlName: "x-ms-copy-id",
- type: {
- name: "String"
- }
- },
- copyStatus: {
- defaultValue: "success",
- isConstant: true,
- serializedName: "x-ms-copy-status",
- type: {
- name: "String"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobCopyFromURLExceptionHeaders = {
- serializedName: "Blob_copyFromURLExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobCopyFromURLExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobAbortCopyFromURLHeaders = {
- serializedName: "Blob_abortCopyFromURLHeaders",
- type: {
- name: "Composite",
- className: "BlobAbortCopyFromURLHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobAbortCopyFromURLExceptionHeaders = {
- serializedName: "Blob_abortCopyFromURLExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobAbortCopyFromURLExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetTierHeaders = {
- serializedName: "Blob_setTierHeaders",
- type: {
- name: "Composite",
- className: "BlobSetTierHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetTierExceptionHeaders = {
- serializedName: "Blob_setTierExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobSetTierExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobGetAccountInfoHeaders = {
- serializedName: "Blob_getAccountInfoHeaders",
- type: {
- name: "Composite",
- className: "BlobGetAccountInfoHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- skuName: {
- serializedName: "x-ms-sku-name",
- xmlName: "x-ms-sku-name",
- type: {
- name: "Enum",
- allowedValues: [
- "Standard_LRS",
- "Standard_GRS",
- "Standard_RAGRS",
- "Standard_ZRS",
- "Premium_LRS"
- ]
- }
- },
- accountKind: {
- serializedName: "x-ms-account-kind",
- xmlName: "x-ms-account-kind",
- type: {
- name: "Enum",
- allowedValues: [
- "Storage",
- "BlobStorage",
- "StorageV2",
- "FileStorage",
- "BlockBlobStorage"
- ]
- }
- }
- }
- }
-};
-const BlobGetAccountInfoExceptionHeaders = {
- serializedName: "Blob_getAccountInfoExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobGetAccountInfoExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobQueryHeaders = {
- serializedName: "Blob_queryHeaders",
- type: {
- name: "Composite",
- className: "BlobQueryHeaders",
- modelProperties: {
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- metadata: {
- serializedName: "x-ms-meta",
- xmlName: "x-ms-meta",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- }
- },
- contentLength: {
- serializedName: "content-length",
- xmlName: "content-length",
- type: {
- name: "Number"
- }
- },
- contentType: {
- serializedName: "content-type",
- xmlName: "content-type",
- type: {
- name: "String"
- }
- },
- contentRange: {
- serializedName: "content-range",
- xmlName: "content-range",
- type: {
- name: "String"
- }
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- contentEncoding: {
- serializedName: "content-encoding",
- xmlName: "content-encoding",
- type: {
- name: "String"
- }
- },
- cacheControl: {
- serializedName: "cache-control",
- xmlName: "cache-control",
- type: {
- name: "String"
- }
- },
- contentDisposition: {
- serializedName: "content-disposition",
- xmlName: "content-disposition",
- type: {
- name: "String"
- }
- },
- contentLanguage: {
- serializedName: "content-language",
- xmlName: "content-language",
- type: {
- name: "String"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- blobType: {
- serializedName: "x-ms-blob-type",
- xmlName: "x-ms-blob-type",
- type: {
- name: "Enum",
- allowedValues: ["BlockBlob", "PageBlob", "AppendBlob"]
- }
- },
- copyCompletionTime: {
- serializedName: "x-ms-copy-completion-time",
- xmlName: "x-ms-copy-completion-time",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- copyStatusDescription: {
- serializedName: "x-ms-copy-status-description",
- xmlName: "x-ms-copy-status-description",
- type: {
- name: "String"
- }
- },
- copyId: {
- serializedName: "x-ms-copy-id",
- xmlName: "x-ms-copy-id",
- type: {
- name: "String"
- }
- },
- copyProgress: {
- serializedName: "x-ms-copy-progress",
- xmlName: "x-ms-copy-progress",
- type: {
- name: "String"
- }
- },
- copySource: {
- serializedName: "x-ms-copy-source",
- xmlName: "x-ms-copy-source",
- type: {
- name: "String"
- }
- },
- copyStatus: {
- serializedName: "x-ms-copy-status",
- xmlName: "x-ms-copy-status",
- type: {
- name: "Enum",
- allowedValues: ["pending", "success", "aborted", "failed"]
- }
- },
- leaseDuration: {
- serializedName: "x-ms-lease-duration",
- xmlName: "x-ms-lease-duration",
- type: {
- name: "Enum",
- allowedValues: ["infinite", "fixed"]
- }
- },
- leaseState: {
- serializedName: "x-ms-lease-state",
- xmlName: "x-ms-lease-state",
- type: {
- name: "Enum",
- allowedValues: [
- "available",
- "leased",
- "expired",
- "breaking",
- "broken"
- ]
- }
- },
- leaseStatus: {
- serializedName: "x-ms-lease-status",
- xmlName: "x-ms-lease-status",
- type: {
- name: "Enum",
- allowedValues: ["locked", "unlocked"]
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- acceptRanges: {
- serializedName: "accept-ranges",
- xmlName: "accept-ranges",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- blobCommittedBlockCount: {
- serializedName: "x-ms-blob-committed-block-count",
- xmlName: "x-ms-blob-committed-block-count",
- type: {
- name: "Number"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-server-encrypted",
- xmlName: "x-ms-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- blobContentMD5: {
- serializedName: "x-ms-blob-content-md5",
- xmlName: "x-ms-blob-content-md5",
- type: {
- name: "ByteArray"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- },
- contentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- }
- }
- }
-};
-const BlobQueryExceptionHeaders = {
- serializedName: "Blob_queryExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobQueryExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobGetTagsHeaders = {
- serializedName: "Blob_getTagsHeaders",
- type: {
- name: "Composite",
- className: "BlobGetTagsHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobGetTagsExceptionHeaders = {
- serializedName: "Blob_getTagsExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobGetTagsExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetTagsHeaders = {
- serializedName: "Blob_setTagsHeaders",
- type: {
- name: "Composite",
- className: "BlobSetTagsHeaders",
- modelProperties: {
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlobSetTagsExceptionHeaders = {
- serializedName: "Blob_setTagsExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlobSetTagsExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobCreateHeaders = {
- serializedName: "PageBlob_createHeaders",
- type: {
- name: "Composite",
- className: "PageBlobCreateHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobCreateExceptionHeaders = {
- serializedName: "PageBlob_createExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobCreateExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobUploadPagesHeaders = {
- serializedName: "PageBlob_uploadPagesHeaders",
- type: {
- name: "Composite",
- className: "PageBlobUploadPagesHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobUploadPagesExceptionHeaders = {
- serializedName: "PageBlob_uploadPagesExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobUploadPagesExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobClearPagesHeaders = {
- serializedName: "PageBlob_clearPagesHeaders",
- type: {
- name: "Composite",
- className: "PageBlobClearPagesHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobClearPagesExceptionHeaders = {
- serializedName: "PageBlob_clearPagesExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobClearPagesExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobUploadPagesFromURLHeaders = {
- serializedName: "PageBlob_uploadPagesFromURLHeaders",
- type: {
- name: "Composite",
- className: "PageBlobUploadPagesFromURLHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobUploadPagesFromURLExceptionHeaders = {
- serializedName: "PageBlob_uploadPagesFromURLExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobUploadPagesFromURLExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobGetPageRangesHeaders = {
- serializedName: "PageBlob_getPageRangesHeaders",
- type: {
- name: "Composite",
- className: "PageBlobGetPageRangesHeaders",
- modelProperties: {
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- blobContentLength: {
- serializedName: "x-ms-blob-content-length",
- xmlName: "x-ms-blob-content-length",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobGetPageRangesExceptionHeaders = {
- serializedName: "PageBlob_getPageRangesExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobGetPageRangesExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobGetPageRangesDiffHeaders = {
- serializedName: "PageBlob_getPageRangesDiffHeaders",
- type: {
- name: "Composite",
- className: "PageBlobGetPageRangesDiffHeaders",
- modelProperties: {
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- blobContentLength: {
- serializedName: "x-ms-blob-content-length",
- xmlName: "x-ms-blob-content-length",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobGetPageRangesDiffExceptionHeaders = {
- serializedName: "PageBlob_getPageRangesDiffExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobGetPageRangesDiffExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobResizeHeaders = {
- serializedName: "PageBlob_resizeHeaders",
- type: {
- name: "Composite",
- className: "PageBlobResizeHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobResizeExceptionHeaders = {
- serializedName: "PageBlob_resizeExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobResizeExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobUpdateSequenceNumberHeaders = {
- serializedName: "PageBlob_updateSequenceNumberHeaders",
- type: {
- name: "Composite",
- className: "PageBlobUpdateSequenceNumberHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- blobSequenceNumber: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobUpdateSequenceNumberExceptionHeaders = {
- serializedName: "PageBlob_updateSequenceNumberExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobUpdateSequenceNumberExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobCopyIncrementalHeaders = {
- serializedName: "PageBlob_copyIncrementalHeaders",
- type: {
- name: "Composite",
- className: "PageBlobCopyIncrementalHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- copyId: {
- serializedName: "x-ms-copy-id",
- xmlName: "x-ms-copy-id",
- type: {
- name: "String"
- }
- },
- copyStatus: {
- serializedName: "x-ms-copy-status",
- xmlName: "x-ms-copy-status",
- type: {
- name: "Enum",
- allowedValues: ["pending", "success", "aborted", "failed"]
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const PageBlobCopyIncrementalExceptionHeaders = {
- serializedName: "PageBlob_copyIncrementalExceptionHeaders",
- type: {
- name: "Composite",
- className: "PageBlobCopyIncrementalExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const AppendBlobCreateHeaders = {
- serializedName: "AppendBlob_createHeaders",
- type: {
- name: "Composite",
- className: "AppendBlobCreateHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const AppendBlobCreateExceptionHeaders = {
- serializedName: "AppendBlob_createExceptionHeaders",
- type: {
- name: "Composite",
- className: "AppendBlobCreateExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const AppendBlobAppendBlockHeaders = {
- serializedName: "AppendBlob_appendBlockHeaders",
- type: {
- name: "Composite",
- className: "AppendBlobAppendBlockHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- blobAppendOffset: {
- serializedName: "x-ms-blob-append-offset",
- xmlName: "x-ms-blob-append-offset",
- type: {
- name: "String"
- }
- },
- blobCommittedBlockCount: {
- serializedName: "x-ms-blob-committed-block-count",
- xmlName: "x-ms-blob-committed-block-count",
- type: {
- name: "Number"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const AppendBlobAppendBlockExceptionHeaders = {
- serializedName: "AppendBlob_appendBlockExceptionHeaders",
- type: {
- name: "Composite",
- className: "AppendBlobAppendBlockExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const AppendBlobAppendBlockFromUrlHeaders = {
- serializedName: "AppendBlob_appendBlockFromUrlHeaders",
- type: {
- name: "Composite",
- className: "AppendBlobAppendBlockFromUrlHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- blobAppendOffset: {
- serializedName: "x-ms-blob-append-offset",
- xmlName: "x-ms-blob-append-offset",
- type: {
- name: "String"
- }
- },
- blobCommittedBlockCount: {
- serializedName: "x-ms-blob-committed-block-count",
- xmlName: "x-ms-blob-committed-block-count",
- type: {
- name: "Number"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const AppendBlobAppendBlockFromUrlExceptionHeaders = {
- serializedName: "AppendBlob_appendBlockFromUrlExceptionHeaders",
- type: {
- name: "Composite",
- className: "AppendBlobAppendBlockFromUrlExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const AppendBlobSealHeaders = {
- serializedName: "AppendBlob_sealHeaders",
- type: {
- name: "Composite",
- className: "AppendBlobSealHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isSealed: {
- serializedName: "x-ms-blob-sealed",
- xmlName: "x-ms-blob-sealed",
- type: {
- name: "Boolean"
- }
- }
- }
- }
-};
-const AppendBlobSealExceptionHeaders = {
- serializedName: "AppendBlob_sealExceptionHeaders",
- type: {
- name: "Composite",
- className: "AppendBlobSealExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobUploadHeaders = {
- serializedName: "BlockBlob_uploadHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobUploadHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobUploadExceptionHeaders = {
- serializedName: "BlockBlob_uploadExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobUploadExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobPutBlobFromUrlHeaders = {
- serializedName: "BlockBlob_putBlobFromUrlHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobPutBlobFromUrlHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobPutBlobFromUrlExceptionHeaders = {
- serializedName: "BlockBlob_putBlobFromUrlExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobPutBlobFromUrlExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobStageBlockHeaders = {
- serializedName: "BlockBlob_stageBlockHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobStageBlockHeaders",
- modelProperties: {
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobStageBlockExceptionHeaders = {
- serializedName: "BlockBlob_stageBlockExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobStageBlockExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobStageBlockFromURLHeaders = {
- serializedName: "BlockBlob_stageBlockFromURLHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobStageBlockFromURLHeaders",
- modelProperties: {
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobStageBlockFromURLExceptionHeaders = {
- serializedName: "BlockBlob_stageBlockFromURLExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobStageBlockFromURLExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobCommitBlockListHeaders = {
- serializedName: "BlockBlob_commitBlockListHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobCommitBlockListHeaders",
- modelProperties: {
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- contentMD5: {
- serializedName: "content-md5",
- xmlName: "content-md5",
- type: {
- name: "ByteArray"
- }
- },
- xMsContentCrc64: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- versionId: {
- serializedName: "x-ms-version-id",
- xmlName: "x-ms-version-id",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- isServerEncrypted: {
- serializedName: "x-ms-request-server-encrypted",
- xmlName: "x-ms-request-server-encrypted",
- type: {
- name: "Boolean"
- }
- },
- encryptionKeySha256: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- },
- encryptionScope: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobCommitBlockListExceptionHeaders = {
- serializedName: "BlockBlob_commitBlockListExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobCommitBlockListExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobGetBlockListHeaders = {
- serializedName: "BlockBlob_getBlockListHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobGetBlockListHeaders",
- modelProperties: {
- lastModified: {
- serializedName: "last-modified",
- xmlName: "last-modified",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- etag: {
- serializedName: "etag",
- xmlName: "etag",
- type: {
- name: "String"
- }
- },
- contentType: {
- serializedName: "content-type",
- xmlName: "content-type",
- type: {
- name: "String"
- }
- },
- blobContentLength: {
- serializedName: "x-ms-blob-content-length",
- xmlName: "x-ms-blob-content-length",
- type: {
- name: "Number"
- }
- },
- clientRequestId: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- },
- requestId: {
- serializedName: "x-ms-request-id",
- xmlName: "x-ms-request-id",
- type: {
- name: "String"
- }
- },
- version: {
- serializedName: "x-ms-version",
- xmlName: "x-ms-version",
- type: {
- name: "String"
- }
- },
- date: {
- serializedName: "date",
- xmlName: "date",
- type: {
- name: "DateTimeRfc1123"
- }
- },
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-const BlockBlobGetBlockListExceptionHeaders = {
- serializedName: "BlockBlob_getBlockListExceptionHeaders",
- type: {
- name: "Composite",
- className: "BlockBlobGetBlockListExceptionHeaders",
- modelProperties: {
- errorCode: {
- serializedName: "x-ms-error-code",
- xmlName: "x-ms-error-code",
- type: {
- name: "String"
- }
- }
- }
- }
-};
-
-var Mappers = /*#__PURE__*/Object.freeze({
- __proto__: null,
- BlobServiceProperties: BlobServiceProperties,
- Logging: Logging,
- RetentionPolicy: RetentionPolicy,
- Metrics: Metrics,
- CorsRule: CorsRule,
- StaticWebsite: StaticWebsite,
- StorageError: StorageError,
- BlobServiceStatistics: BlobServiceStatistics,
- GeoReplication: GeoReplication,
- ListContainersSegmentResponse: ListContainersSegmentResponse,
- ContainerItem: ContainerItem,
- ContainerProperties: ContainerProperties,
- KeyInfo: KeyInfo,
- UserDelegationKey: UserDelegationKey,
- FilterBlobSegment: FilterBlobSegment,
- FilterBlobItem: FilterBlobItem,
- BlobTags: BlobTags,
- BlobTag: BlobTag,
- SignedIdentifier: SignedIdentifier,
- AccessPolicy: AccessPolicy,
- ListBlobsFlatSegmentResponse: ListBlobsFlatSegmentResponse,
- BlobFlatListSegment: BlobFlatListSegment,
- BlobItemInternal: BlobItemInternal,
- BlobName: BlobName,
- BlobPropertiesInternal: BlobPropertiesInternal,
- ListBlobsHierarchySegmentResponse: ListBlobsHierarchySegmentResponse,
- BlobHierarchyListSegment: BlobHierarchyListSegment,
- BlobPrefix: BlobPrefix,
- BlockLookupList: BlockLookupList,
- BlockList: BlockList,
- Block: Block,
- PageList: PageList,
- PageRange: PageRange,
- ClearRange: ClearRange,
- QueryRequest: QueryRequest,
- QuerySerialization: QuerySerialization,
- QueryFormat: QueryFormat,
- DelimitedTextConfiguration: DelimitedTextConfiguration,
- JsonTextConfiguration: JsonTextConfiguration,
- ArrowConfiguration: ArrowConfiguration,
- ArrowField: ArrowField,
- ServiceSetPropertiesHeaders: ServiceSetPropertiesHeaders,
- ServiceSetPropertiesExceptionHeaders: ServiceSetPropertiesExceptionHeaders,
- ServiceGetPropertiesHeaders: ServiceGetPropertiesHeaders,
- ServiceGetPropertiesExceptionHeaders: ServiceGetPropertiesExceptionHeaders,
- ServiceGetStatisticsHeaders: ServiceGetStatisticsHeaders,
- ServiceGetStatisticsExceptionHeaders: ServiceGetStatisticsExceptionHeaders,
- ServiceListContainersSegmentHeaders: ServiceListContainersSegmentHeaders,
- ServiceListContainersSegmentExceptionHeaders: ServiceListContainersSegmentExceptionHeaders,
- ServiceGetUserDelegationKeyHeaders: ServiceGetUserDelegationKeyHeaders,
- ServiceGetUserDelegationKeyExceptionHeaders: ServiceGetUserDelegationKeyExceptionHeaders,
- ServiceGetAccountInfoHeaders: ServiceGetAccountInfoHeaders,
- ServiceGetAccountInfoExceptionHeaders: ServiceGetAccountInfoExceptionHeaders,
- ServiceSubmitBatchHeaders: ServiceSubmitBatchHeaders,
- ServiceSubmitBatchExceptionHeaders: ServiceSubmitBatchExceptionHeaders,
- ServiceFilterBlobsHeaders: ServiceFilterBlobsHeaders,
- ServiceFilterBlobsExceptionHeaders: ServiceFilterBlobsExceptionHeaders,
- ContainerCreateHeaders: ContainerCreateHeaders,
- ContainerCreateExceptionHeaders: ContainerCreateExceptionHeaders,
- ContainerGetPropertiesHeaders: ContainerGetPropertiesHeaders,
- ContainerGetPropertiesExceptionHeaders: ContainerGetPropertiesExceptionHeaders,
- ContainerDeleteHeaders: ContainerDeleteHeaders,
- ContainerDeleteExceptionHeaders: ContainerDeleteExceptionHeaders,
- ContainerSetMetadataHeaders: ContainerSetMetadataHeaders,
- ContainerSetMetadataExceptionHeaders: ContainerSetMetadataExceptionHeaders,
- ContainerGetAccessPolicyHeaders: ContainerGetAccessPolicyHeaders,
- ContainerGetAccessPolicyExceptionHeaders: ContainerGetAccessPolicyExceptionHeaders,
- ContainerSetAccessPolicyHeaders: ContainerSetAccessPolicyHeaders,
- ContainerSetAccessPolicyExceptionHeaders: ContainerSetAccessPolicyExceptionHeaders,
- ContainerRestoreHeaders: ContainerRestoreHeaders,
- ContainerRestoreExceptionHeaders: ContainerRestoreExceptionHeaders,
- ContainerRenameHeaders: ContainerRenameHeaders,
- ContainerRenameExceptionHeaders: ContainerRenameExceptionHeaders,
- ContainerSubmitBatchHeaders: ContainerSubmitBatchHeaders,
- ContainerSubmitBatchExceptionHeaders: ContainerSubmitBatchExceptionHeaders,
- ContainerFilterBlobsHeaders: ContainerFilterBlobsHeaders,
- ContainerFilterBlobsExceptionHeaders: ContainerFilterBlobsExceptionHeaders,
- ContainerAcquireLeaseHeaders: ContainerAcquireLeaseHeaders,
- ContainerAcquireLeaseExceptionHeaders: ContainerAcquireLeaseExceptionHeaders,
- ContainerReleaseLeaseHeaders: ContainerReleaseLeaseHeaders,
- ContainerReleaseLeaseExceptionHeaders: ContainerReleaseLeaseExceptionHeaders,
- ContainerRenewLeaseHeaders: ContainerRenewLeaseHeaders,
- ContainerRenewLeaseExceptionHeaders: ContainerRenewLeaseExceptionHeaders,
- ContainerBreakLeaseHeaders: ContainerBreakLeaseHeaders,
- ContainerBreakLeaseExceptionHeaders: ContainerBreakLeaseExceptionHeaders,
- ContainerChangeLeaseHeaders: ContainerChangeLeaseHeaders,
- ContainerChangeLeaseExceptionHeaders: ContainerChangeLeaseExceptionHeaders,
- ContainerListBlobFlatSegmentHeaders: ContainerListBlobFlatSegmentHeaders,
- ContainerListBlobFlatSegmentExceptionHeaders: ContainerListBlobFlatSegmentExceptionHeaders,
- ContainerListBlobHierarchySegmentHeaders: ContainerListBlobHierarchySegmentHeaders,
- ContainerListBlobHierarchySegmentExceptionHeaders: ContainerListBlobHierarchySegmentExceptionHeaders,
- ContainerGetAccountInfoHeaders: ContainerGetAccountInfoHeaders,
- ContainerGetAccountInfoExceptionHeaders: ContainerGetAccountInfoExceptionHeaders,
- BlobDownloadHeaders: BlobDownloadHeaders,
- BlobDownloadExceptionHeaders: BlobDownloadExceptionHeaders,
- BlobGetPropertiesHeaders: BlobGetPropertiesHeaders,
- BlobGetPropertiesExceptionHeaders: BlobGetPropertiesExceptionHeaders,
- BlobDeleteHeaders: BlobDeleteHeaders,
- BlobDeleteExceptionHeaders: BlobDeleteExceptionHeaders,
- BlobUndeleteHeaders: BlobUndeleteHeaders,
- BlobUndeleteExceptionHeaders: BlobUndeleteExceptionHeaders,
- BlobSetExpiryHeaders: BlobSetExpiryHeaders,
- BlobSetExpiryExceptionHeaders: BlobSetExpiryExceptionHeaders,
- BlobSetHttpHeadersHeaders: BlobSetHttpHeadersHeaders,
- BlobSetHttpHeadersExceptionHeaders: BlobSetHttpHeadersExceptionHeaders,
- BlobSetImmutabilityPolicyHeaders: BlobSetImmutabilityPolicyHeaders,
- BlobSetImmutabilityPolicyExceptionHeaders: BlobSetImmutabilityPolicyExceptionHeaders,
- BlobDeleteImmutabilityPolicyHeaders: BlobDeleteImmutabilityPolicyHeaders,
- BlobDeleteImmutabilityPolicyExceptionHeaders: BlobDeleteImmutabilityPolicyExceptionHeaders,
- BlobSetLegalHoldHeaders: BlobSetLegalHoldHeaders,
- BlobSetLegalHoldExceptionHeaders: BlobSetLegalHoldExceptionHeaders,
- BlobSetMetadataHeaders: BlobSetMetadataHeaders,
- BlobSetMetadataExceptionHeaders: BlobSetMetadataExceptionHeaders,
- BlobAcquireLeaseHeaders: BlobAcquireLeaseHeaders,
- BlobAcquireLeaseExceptionHeaders: BlobAcquireLeaseExceptionHeaders,
- BlobReleaseLeaseHeaders: BlobReleaseLeaseHeaders,
- BlobReleaseLeaseExceptionHeaders: BlobReleaseLeaseExceptionHeaders,
- BlobRenewLeaseHeaders: BlobRenewLeaseHeaders,
- BlobRenewLeaseExceptionHeaders: BlobRenewLeaseExceptionHeaders,
- BlobChangeLeaseHeaders: BlobChangeLeaseHeaders,
- BlobChangeLeaseExceptionHeaders: BlobChangeLeaseExceptionHeaders,
- BlobBreakLeaseHeaders: BlobBreakLeaseHeaders,
- BlobBreakLeaseExceptionHeaders: BlobBreakLeaseExceptionHeaders,
- BlobCreateSnapshotHeaders: BlobCreateSnapshotHeaders,
- BlobCreateSnapshotExceptionHeaders: BlobCreateSnapshotExceptionHeaders,
- BlobStartCopyFromURLHeaders: BlobStartCopyFromURLHeaders,
- BlobStartCopyFromURLExceptionHeaders: BlobStartCopyFromURLExceptionHeaders,
- BlobCopyFromURLHeaders: BlobCopyFromURLHeaders,
- BlobCopyFromURLExceptionHeaders: BlobCopyFromURLExceptionHeaders,
- BlobAbortCopyFromURLHeaders: BlobAbortCopyFromURLHeaders,
- BlobAbortCopyFromURLExceptionHeaders: BlobAbortCopyFromURLExceptionHeaders,
- BlobSetTierHeaders: BlobSetTierHeaders,
- BlobSetTierExceptionHeaders: BlobSetTierExceptionHeaders,
- BlobGetAccountInfoHeaders: BlobGetAccountInfoHeaders,
- BlobGetAccountInfoExceptionHeaders: BlobGetAccountInfoExceptionHeaders,
- BlobQueryHeaders: BlobQueryHeaders,
- BlobQueryExceptionHeaders: BlobQueryExceptionHeaders,
- BlobGetTagsHeaders: BlobGetTagsHeaders,
- BlobGetTagsExceptionHeaders: BlobGetTagsExceptionHeaders,
- BlobSetTagsHeaders: BlobSetTagsHeaders,
- BlobSetTagsExceptionHeaders: BlobSetTagsExceptionHeaders,
- PageBlobCreateHeaders: PageBlobCreateHeaders,
- PageBlobCreateExceptionHeaders: PageBlobCreateExceptionHeaders,
- PageBlobUploadPagesHeaders: PageBlobUploadPagesHeaders,
- PageBlobUploadPagesExceptionHeaders: PageBlobUploadPagesExceptionHeaders,
- PageBlobClearPagesHeaders: PageBlobClearPagesHeaders,
- PageBlobClearPagesExceptionHeaders: PageBlobClearPagesExceptionHeaders,
- PageBlobUploadPagesFromURLHeaders: PageBlobUploadPagesFromURLHeaders,
- PageBlobUploadPagesFromURLExceptionHeaders: PageBlobUploadPagesFromURLExceptionHeaders,
- PageBlobGetPageRangesHeaders: PageBlobGetPageRangesHeaders,
- PageBlobGetPageRangesExceptionHeaders: PageBlobGetPageRangesExceptionHeaders,
- PageBlobGetPageRangesDiffHeaders: PageBlobGetPageRangesDiffHeaders,
- PageBlobGetPageRangesDiffExceptionHeaders: PageBlobGetPageRangesDiffExceptionHeaders,
- PageBlobResizeHeaders: PageBlobResizeHeaders,
- PageBlobResizeExceptionHeaders: PageBlobResizeExceptionHeaders,
- PageBlobUpdateSequenceNumberHeaders: PageBlobUpdateSequenceNumberHeaders,
- PageBlobUpdateSequenceNumberExceptionHeaders: PageBlobUpdateSequenceNumberExceptionHeaders,
- PageBlobCopyIncrementalHeaders: PageBlobCopyIncrementalHeaders,
- PageBlobCopyIncrementalExceptionHeaders: PageBlobCopyIncrementalExceptionHeaders,
- AppendBlobCreateHeaders: AppendBlobCreateHeaders,
- AppendBlobCreateExceptionHeaders: AppendBlobCreateExceptionHeaders,
- AppendBlobAppendBlockHeaders: AppendBlobAppendBlockHeaders,
- AppendBlobAppendBlockExceptionHeaders: AppendBlobAppendBlockExceptionHeaders,
- AppendBlobAppendBlockFromUrlHeaders: AppendBlobAppendBlockFromUrlHeaders,
- AppendBlobAppendBlockFromUrlExceptionHeaders: AppendBlobAppendBlockFromUrlExceptionHeaders,
- AppendBlobSealHeaders: AppendBlobSealHeaders,
- AppendBlobSealExceptionHeaders: AppendBlobSealExceptionHeaders,
- BlockBlobUploadHeaders: BlockBlobUploadHeaders,
- BlockBlobUploadExceptionHeaders: BlockBlobUploadExceptionHeaders,
- BlockBlobPutBlobFromUrlHeaders: BlockBlobPutBlobFromUrlHeaders,
- BlockBlobPutBlobFromUrlExceptionHeaders: BlockBlobPutBlobFromUrlExceptionHeaders,
- BlockBlobStageBlockHeaders: BlockBlobStageBlockHeaders,
- BlockBlobStageBlockExceptionHeaders: BlockBlobStageBlockExceptionHeaders,
- BlockBlobStageBlockFromURLHeaders: BlockBlobStageBlockFromURLHeaders,
- BlockBlobStageBlockFromURLExceptionHeaders: BlockBlobStageBlockFromURLExceptionHeaders,
- BlockBlobCommitBlockListHeaders: BlockBlobCommitBlockListHeaders,
- BlockBlobCommitBlockListExceptionHeaders: BlockBlobCommitBlockListExceptionHeaders,
- BlockBlobGetBlockListHeaders: BlockBlobGetBlockListHeaders,
- BlockBlobGetBlockListExceptionHeaders: BlockBlobGetBlockListExceptionHeaders
-});
-
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-const contentType = {
- parameterPath: ["options", "contentType"],
- mapper: {
- defaultValue: "application/xml",
- isConstant: true,
- serializedName: "Content-Type",
- type: {
- name: "String"
- }
- }
-};
-const blobServiceProperties = {
- parameterPath: "blobServiceProperties",
- mapper: BlobServiceProperties
-};
-const accept = {
- parameterPath: "accept",
- mapper: {
- defaultValue: "application/xml",
- isConstant: true,
- serializedName: "Accept",
- type: {
- name: "String"
- }
- }
-};
-const url = {
- parameterPath: "url",
- mapper: {
- serializedName: "url",
- required: true,
- xmlName: "url",
- type: {
- name: "String"
- }
- },
- skipEncoding: true
-};
-const restype = {
- parameterPath: "restype",
- mapper: {
- defaultValue: "service",
- isConstant: true,
- serializedName: "restype",
- type: {
- name: "String"
- }
- }
-};
-const comp = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "properties",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const timeoutInSeconds = {
- parameterPath: ["options", "timeoutInSeconds"],
- mapper: {
- constraints: {
- InclusiveMinimum: 0
- },
- serializedName: "timeout",
- xmlName: "timeout",
- type: {
- name: "Number"
- }
- }
-};
-const version = {
- parameterPath: "version",
- mapper: {
- defaultValue: "2023-11-03",
- isConstant: true,
- serializedName: "x-ms-version",
- type: {
- name: "String"
- }
- }
-};
-const requestId = {
- parameterPath: ["options", "requestId"],
- mapper: {
- serializedName: "x-ms-client-request-id",
- xmlName: "x-ms-client-request-id",
- type: {
- name: "String"
- }
- }
-};
-const accept1 = {
- parameterPath: "accept",
- mapper: {
- defaultValue: "application/xml",
- isConstant: true,
- serializedName: "Accept",
- type: {
- name: "String"
- }
- }
-};
-const comp1 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "stats",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const comp2 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "list",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const prefix = {
- parameterPath: ["options", "prefix"],
- mapper: {
- serializedName: "prefix",
- xmlName: "prefix",
- type: {
- name: "String"
- }
- }
-};
-const marker = {
- parameterPath: ["options", "marker"],
- mapper: {
- serializedName: "marker",
- xmlName: "marker",
- type: {
- name: "String"
- }
- }
-};
-const maxPageSize = {
- parameterPath: ["options", "maxPageSize"],
- mapper: {
- constraints: {
- InclusiveMinimum: 1
- },
- serializedName: "maxresults",
- xmlName: "maxresults",
- type: {
- name: "Number"
- }
- }
-};
-const include = {
- parameterPath: ["options", "include"],
- mapper: {
- serializedName: "include",
- xmlName: "include",
- xmlElementName: "ListContainersIncludeType",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Enum",
- allowedValues: ["metadata", "deleted", "system"]
- }
- }
- }
- },
- collectionFormat: coreHttp.QueryCollectionFormat.Csv
-};
-const keyInfo = {
- parameterPath: "keyInfo",
- mapper: KeyInfo
-};
-const comp3 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "userdelegationkey",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const restype1 = {
- parameterPath: "restype",
- mapper: {
- defaultValue: "account",
- isConstant: true,
- serializedName: "restype",
- type: {
- name: "String"
- }
- }
-};
-const body = {
- parameterPath: "body",
- mapper: {
- serializedName: "body",
- required: true,
- xmlName: "body",
- type: {
- name: "Stream"
- }
- }
-};
-const comp4 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "batch",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const contentLength = {
- parameterPath: "contentLength",
- mapper: {
- serializedName: "Content-Length",
- required: true,
- xmlName: "Content-Length",
- type: {
- name: "Number"
- }
- }
-};
-const multipartContentType = {
- parameterPath: "multipartContentType",
- mapper: {
- serializedName: "Content-Type",
- required: true,
- xmlName: "Content-Type",
- type: {
- name: "String"
- }
- }
-};
-const comp5 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "blobs",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const where = {
- parameterPath: ["options", "where"],
- mapper: {
- serializedName: "where",
- xmlName: "where",
- type: {
- name: "String"
- }
- }
-};
-const restype2 = {
- parameterPath: "restype",
- mapper: {
- defaultValue: "container",
- isConstant: true,
- serializedName: "restype",
- type: {
- name: "String"
- }
- }
-};
-const metadata = {
- parameterPath: ["options", "metadata"],
- mapper: {
- serializedName: "x-ms-meta",
- xmlName: "x-ms-meta",
- type: {
- name: "Dictionary",
- value: { type: { name: "String" } }
- },
- headerCollectionPrefix: "x-ms-meta-"
- }
-};
-const access = {
- parameterPath: ["options", "access"],
- mapper: {
- serializedName: "x-ms-blob-public-access",
- xmlName: "x-ms-blob-public-access",
- type: {
- name: "Enum",
- allowedValues: ["container", "blob"]
- }
- }
-};
-const defaultEncryptionScope = {
- parameterPath: [
- "options",
- "containerEncryptionScope",
- "defaultEncryptionScope"
- ],
- mapper: {
- serializedName: "x-ms-default-encryption-scope",
- xmlName: "x-ms-default-encryption-scope",
- type: {
- name: "String"
- }
- }
-};
-const preventEncryptionScopeOverride = {
- parameterPath: [
- "options",
- "containerEncryptionScope",
- "preventEncryptionScopeOverride"
- ],
- mapper: {
- serializedName: "x-ms-deny-encryption-scope-override",
- xmlName: "x-ms-deny-encryption-scope-override",
- type: {
- name: "Boolean"
- }
- }
-};
-const leaseId = {
- parameterPath: ["options", "leaseAccessConditions", "leaseId"],
- mapper: {
- serializedName: "x-ms-lease-id",
- xmlName: "x-ms-lease-id",
- type: {
- name: "String"
- }
- }
-};
-const ifModifiedSince = {
- parameterPath: ["options", "modifiedAccessConditions", "ifModifiedSince"],
- mapper: {
- serializedName: "If-Modified-Since",
- xmlName: "If-Modified-Since",
- type: {
- name: "DateTimeRfc1123"
- }
- }
-};
-const ifUnmodifiedSince = {
- parameterPath: ["options", "modifiedAccessConditions", "ifUnmodifiedSince"],
- mapper: {
- serializedName: "If-Unmodified-Since",
- xmlName: "If-Unmodified-Since",
- type: {
- name: "DateTimeRfc1123"
- }
- }
-};
-const comp6 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "metadata",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const comp7 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "acl",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const containerAcl = {
- parameterPath: ["options", "containerAcl"],
- mapper: {
- serializedName: "containerAcl",
- xmlName: "SignedIdentifiers",
- xmlIsWrapped: true,
- xmlElementName: "SignedIdentifier",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Composite",
- className: "SignedIdentifier"
- }
- }
- }
- }
-};
-const comp8 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "undelete",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const deletedContainerName = {
- parameterPath: ["options", "deletedContainerName"],
- mapper: {
- serializedName: "x-ms-deleted-container-name",
- xmlName: "x-ms-deleted-container-name",
- type: {
- name: "String"
- }
- }
-};
-const deletedContainerVersion = {
- parameterPath: ["options", "deletedContainerVersion"],
- mapper: {
- serializedName: "x-ms-deleted-container-version",
- xmlName: "x-ms-deleted-container-version",
- type: {
- name: "String"
- }
- }
-};
-const comp9 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "rename",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const sourceContainerName = {
- parameterPath: "sourceContainerName",
- mapper: {
- serializedName: "x-ms-source-container-name",
- required: true,
- xmlName: "x-ms-source-container-name",
- type: {
- name: "String"
- }
- }
-};
-const sourceLeaseId = {
- parameterPath: ["options", "sourceLeaseId"],
- mapper: {
- serializedName: "x-ms-source-lease-id",
- xmlName: "x-ms-source-lease-id",
- type: {
- name: "String"
- }
- }
-};
-const comp10 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "lease",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const action = {
- parameterPath: "action",
- mapper: {
- defaultValue: "acquire",
- isConstant: true,
- serializedName: "x-ms-lease-action",
- type: {
- name: "String"
- }
- }
-};
-const duration = {
- parameterPath: ["options", "duration"],
- mapper: {
- serializedName: "x-ms-lease-duration",
- xmlName: "x-ms-lease-duration",
- type: {
- name: "Number"
- }
- }
-};
-const proposedLeaseId = {
- parameterPath: ["options", "proposedLeaseId"],
- mapper: {
- serializedName: "x-ms-proposed-lease-id",
- xmlName: "x-ms-proposed-lease-id",
- type: {
- name: "String"
- }
- }
-};
-const action1 = {
- parameterPath: "action",
- mapper: {
- defaultValue: "release",
- isConstant: true,
- serializedName: "x-ms-lease-action",
- type: {
- name: "String"
- }
- }
-};
-const leaseId1 = {
- parameterPath: "leaseId",
- mapper: {
- serializedName: "x-ms-lease-id",
- required: true,
- xmlName: "x-ms-lease-id",
- type: {
- name: "String"
- }
- }
-};
-const action2 = {
- parameterPath: "action",
- mapper: {
- defaultValue: "renew",
- isConstant: true,
- serializedName: "x-ms-lease-action",
- type: {
- name: "String"
- }
- }
-};
-const action3 = {
- parameterPath: "action",
- mapper: {
- defaultValue: "break",
- isConstant: true,
- serializedName: "x-ms-lease-action",
- type: {
- name: "String"
- }
- }
-};
-const breakPeriod = {
- parameterPath: ["options", "breakPeriod"],
- mapper: {
- serializedName: "x-ms-lease-break-period",
- xmlName: "x-ms-lease-break-period",
- type: {
- name: "Number"
- }
- }
-};
-const action4 = {
- parameterPath: "action",
- mapper: {
- defaultValue: "change",
- isConstant: true,
- serializedName: "x-ms-lease-action",
- type: {
- name: "String"
- }
- }
-};
-const proposedLeaseId1 = {
- parameterPath: "proposedLeaseId",
- mapper: {
- serializedName: "x-ms-proposed-lease-id",
- required: true,
- xmlName: "x-ms-proposed-lease-id",
- type: {
- name: "String"
- }
- }
-};
-const include1 = {
- parameterPath: ["options", "include"],
- mapper: {
- serializedName: "include",
- xmlName: "include",
- xmlElementName: "ListBlobsIncludeItem",
- type: {
- name: "Sequence",
- element: {
- type: {
- name: "Enum",
- allowedValues: [
- "copy",
- "deleted",
- "metadata",
- "snapshots",
- "uncommittedblobs",
- "versions",
- "tags",
- "immutabilitypolicy",
- "legalhold",
- "deletedwithversions"
- ]
- }
- }
- }
- },
- collectionFormat: coreHttp.QueryCollectionFormat.Csv
-};
-const delimiter = {
- parameterPath: "delimiter",
- mapper: {
- serializedName: "delimiter",
- required: true,
- xmlName: "delimiter",
- type: {
- name: "String"
- }
- }
-};
-const snapshot = {
- parameterPath: ["options", "snapshot"],
- mapper: {
- serializedName: "snapshot",
- xmlName: "snapshot",
- type: {
- name: "String"
- }
- }
-};
-const versionId = {
- parameterPath: ["options", "versionId"],
- mapper: {
- serializedName: "versionid",
- xmlName: "versionid",
- type: {
- name: "String"
- }
- }
-};
-const range = {
- parameterPath: ["options", "range"],
- mapper: {
- serializedName: "x-ms-range",
- xmlName: "x-ms-range",
- type: {
- name: "String"
- }
- }
-};
-const rangeGetContentMD5 = {
- parameterPath: ["options", "rangeGetContentMD5"],
- mapper: {
- serializedName: "x-ms-range-get-content-md5",
- xmlName: "x-ms-range-get-content-md5",
- type: {
- name: "Boolean"
- }
- }
-};
-const rangeGetContentCRC64 = {
- parameterPath: ["options", "rangeGetContentCRC64"],
- mapper: {
- serializedName: "x-ms-range-get-content-crc64",
- xmlName: "x-ms-range-get-content-crc64",
- type: {
- name: "Boolean"
- }
- }
-};
-const encryptionKey = {
- parameterPath: ["options", "cpkInfo", "encryptionKey"],
- mapper: {
- serializedName: "x-ms-encryption-key",
- xmlName: "x-ms-encryption-key",
- type: {
- name: "String"
- }
- }
-};
-const encryptionKeySha256 = {
- parameterPath: ["options", "cpkInfo", "encryptionKeySha256"],
- mapper: {
- serializedName: "x-ms-encryption-key-sha256",
- xmlName: "x-ms-encryption-key-sha256",
- type: {
- name: "String"
- }
- }
-};
-const encryptionAlgorithm = {
- parameterPath: ["options", "cpkInfo", "encryptionAlgorithm"],
- mapper: {
- serializedName: "x-ms-encryption-algorithm",
- xmlName: "x-ms-encryption-algorithm",
- type: {
- name: "String"
- }
- }
-};
-const ifMatch = {
- parameterPath: ["options", "modifiedAccessConditions", "ifMatch"],
- mapper: {
- serializedName: "If-Match",
- xmlName: "If-Match",
- type: {
- name: "String"
- }
- }
-};
-const ifNoneMatch = {
- parameterPath: ["options", "modifiedAccessConditions", "ifNoneMatch"],
- mapper: {
- serializedName: "If-None-Match",
- xmlName: "If-None-Match",
- type: {
- name: "String"
- }
- }
-};
-const ifTags = {
- parameterPath: ["options", "modifiedAccessConditions", "ifTags"],
- mapper: {
- serializedName: "x-ms-if-tags",
- xmlName: "x-ms-if-tags",
- type: {
- name: "String"
- }
- }
-};
-const deleteSnapshots = {
- parameterPath: ["options", "deleteSnapshots"],
- mapper: {
- serializedName: "x-ms-delete-snapshots",
- xmlName: "x-ms-delete-snapshots",
- type: {
- name: "Enum",
- allowedValues: ["include", "only"]
- }
- }
-};
-const blobDeleteType = {
- parameterPath: ["options", "blobDeleteType"],
- mapper: {
- serializedName: "deletetype",
- xmlName: "deletetype",
- type: {
- name: "String"
- }
- }
-};
-const comp11 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "expiry",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const expiryOptions = {
- parameterPath: "expiryOptions",
- mapper: {
- serializedName: "x-ms-expiry-option",
- required: true,
- xmlName: "x-ms-expiry-option",
- type: {
- name: "String"
- }
- }
-};
-const expiresOn = {
- parameterPath: ["options", "expiresOn"],
- mapper: {
- serializedName: "x-ms-expiry-time",
- xmlName: "x-ms-expiry-time",
- type: {
- name: "String"
- }
- }
-};
-const blobCacheControl = {
- parameterPath: ["options", "blobHttpHeaders", "blobCacheControl"],
- mapper: {
- serializedName: "x-ms-blob-cache-control",
- xmlName: "x-ms-blob-cache-control",
- type: {
- name: "String"
- }
- }
-};
-const blobContentType = {
- parameterPath: ["options", "blobHttpHeaders", "blobContentType"],
- mapper: {
- serializedName: "x-ms-blob-content-type",
- xmlName: "x-ms-blob-content-type",
- type: {
- name: "String"
- }
- }
-};
-const blobContentMD5 = {
- parameterPath: ["options", "blobHttpHeaders", "blobContentMD5"],
- mapper: {
- serializedName: "x-ms-blob-content-md5",
- xmlName: "x-ms-blob-content-md5",
- type: {
- name: "ByteArray"
- }
- }
-};
-const blobContentEncoding = {
- parameterPath: ["options", "blobHttpHeaders", "blobContentEncoding"],
- mapper: {
- serializedName: "x-ms-blob-content-encoding",
- xmlName: "x-ms-blob-content-encoding",
- type: {
- name: "String"
- }
- }
-};
-const blobContentLanguage = {
- parameterPath: ["options", "blobHttpHeaders", "blobContentLanguage"],
- mapper: {
- serializedName: "x-ms-blob-content-language",
- xmlName: "x-ms-blob-content-language",
- type: {
- name: "String"
- }
- }
-};
-const blobContentDisposition = {
- parameterPath: ["options", "blobHttpHeaders", "blobContentDisposition"],
- mapper: {
- serializedName: "x-ms-blob-content-disposition",
- xmlName: "x-ms-blob-content-disposition",
- type: {
- name: "String"
- }
- }
-};
-const comp12 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "immutabilityPolicies",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const immutabilityPolicyExpiry = {
- parameterPath: ["options", "immutabilityPolicyExpiry"],
- mapper: {
- serializedName: "x-ms-immutability-policy-until-date",
- xmlName: "x-ms-immutability-policy-until-date",
- type: {
- name: "DateTimeRfc1123"
- }
- }
-};
-const immutabilityPolicyMode = {
- parameterPath: ["options", "immutabilityPolicyMode"],
- mapper: {
- serializedName: "x-ms-immutability-policy-mode",
- xmlName: "x-ms-immutability-policy-mode",
- type: {
- name: "Enum",
- allowedValues: ["Mutable", "Unlocked", "Locked"]
- }
- }
-};
-const comp13 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "legalhold",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const legalHold = {
- parameterPath: "legalHold",
- mapper: {
- serializedName: "x-ms-legal-hold",
- required: true,
- xmlName: "x-ms-legal-hold",
- type: {
- name: "Boolean"
- }
- }
-};
-const encryptionScope = {
- parameterPath: ["options", "encryptionScope"],
- mapper: {
- serializedName: "x-ms-encryption-scope",
- xmlName: "x-ms-encryption-scope",
- type: {
- name: "String"
- }
- }
-};
-const comp14 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "snapshot",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const tier = {
- parameterPath: ["options", "tier"],
- mapper: {
- serializedName: "x-ms-access-tier",
- xmlName: "x-ms-access-tier",
- type: {
- name: "Enum",
- allowedValues: [
- "P4",
- "P6",
- "P10",
- "P15",
- "P20",
- "P30",
- "P40",
- "P50",
- "P60",
- "P70",
- "P80",
- "Hot",
- "Cool",
- "Archive",
- "Cold"
- ]
- }
- }
-};
-const rehydratePriority = {
- parameterPath: ["options", "rehydratePriority"],
- mapper: {
- serializedName: "x-ms-rehydrate-priority",
- xmlName: "x-ms-rehydrate-priority",
- type: {
- name: "Enum",
- allowedValues: ["High", "Standard"]
- }
- }
-};
-const sourceIfModifiedSince = {
- parameterPath: [
- "options",
- "sourceModifiedAccessConditions",
- "sourceIfModifiedSince"
- ],
- mapper: {
- serializedName: "x-ms-source-if-modified-since",
- xmlName: "x-ms-source-if-modified-since",
- type: {
- name: "DateTimeRfc1123"
- }
- }
-};
-const sourceIfUnmodifiedSince = {
- parameterPath: [
- "options",
- "sourceModifiedAccessConditions",
- "sourceIfUnmodifiedSince"
- ],
- mapper: {
- serializedName: "x-ms-source-if-unmodified-since",
- xmlName: "x-ms-source-if-unmodified-since",
- type: {
- name: "DateTimeRfc1123"
- }
- }
-};
-const sourceIfMatch = {
- parameterPath: ["options", "sourceModifiedAccessConditions", "sourceIfMatch"],
- mapper: {
- serializedName: "x-ms-source-if-match",
- xmlName: "x-ms-source-if-match",
- type: {
- name: "String"
- }
- }
-};
-const sourceIfNoneMatch = {
- parameterPath: [
- "options",
- "sourceModifiedAccessConditions",
- "sourceIfNoneMatch"
- ],
- mapper: {
- serializedName: "x-ms-source-if-none-match",
- xmlName: "x-ms-source-if-none-match",
- type: {
- name: "String"
- }
- }
-};
-const sourceIfTags = {
- parameterPath: ["options", "sourceModifiedAccessConditions", "sourceIfTags"],
- mapper: {
- serializedName: "x-ms-source-if-tags",
- xmlName: "x-ms-source-if-tags",
- type: {
- name: "String"
- }
- }
-};
-const copySource = {
- parameterPath: "copySource",
- mapper: {
- serializedName: "x-ms-copy-source",
- required: true,
- xmlName: "x-ms-copy-source",
- type: {
- name: "String"
- }
- }
-};
-const blobTagsString = {
- parameterPath: ["options", "blobTagsString"],
- mapper: {
- serializedName: "x-ms-tags",
- xmlName: "x-ms-tags",
- type: {
- name: "String"
- }
- }
-};
-const sealBlob = {
- parameterPath: ["options", "sealBlob"],
- mapper: {
- serializedName: "x-ms-seal-blob",
- xmlName: "x-ms-seal-blob",
- type: {
- name: "Boolean"
- }
- }
-};
-const legalHold1 = {
- parameterPath: ["options", "legalHold"],
- mapper: {
- serializedName: "x-ms-legal-hold",
- xmlName: "x-ms-legal-hold",
- type: {
- name: "Boolean"
- }
- }
-};
-const xMsRequiresSync = {
- parameterPath: "xMsRequiresSync",
- mapper: {
- defaultValue: "true",
- isConstant: true,
- serializedName: "x-ms-requires-sync",
- type: {
- name: "String"
- }
- }
-};
-const sourceContentMD5 = {
- parameterPath: ["options", "sourceContentMD5"],
- mapper: {
- serializedName: "x-ms-source-content-md5",
- xmlName: "x-ms-source-content-md5",
- type: {
- name: "ByteArray"
- }
- }
-};
-const copySourceAuthorization = {
- parameterPath: ["options", "copySourceAuthorization"],
- mapper: {
- serializedName: "x-ms-copy-source-authorization",
- xmlName: "x-ms-copy-source-authorization",
- type: {
- name: "String"
- }
- }
-};
-const copySourceTags = {
- parameterPath: ["options", "copySourceTags"],
- mapper: {
- serializedName: "x-ms-copy-source-tag-option",
- xmlName: "x-ms-copy-source-tag-option",
- type: {
- name: "Enum",
- allowedValues: ["REPLACE", "COPY"]
- }
- }
-};
-const comp15 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "copy",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const copyActionAbortConstant = {
- parameterPath: "copyActionAbortConstant",
- mapper: {
- defaultValue: "abort",
- isConstant: true,
- serializedName: "x-ms-copy-action",
- type: {
- name: "String"
- }
- }
-};
-const copyId = {
- parameterPath: "copyId",
- mapper: {
- serializedName: "copyid",
- required: true,
- xmlName: "copyid",
- type: {
- name: "String"
- }
- }
-};
-const comp16 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "tier",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const tier1 = {
- parameterPath: "tier",
- mapper: {
- serializedName: "x-ms-access-tier",
- required: true,
- xmlName: "x-ms-access-tier",
- type: {
- name: "Enum",
- allowedValues: [
- "P4",
- "P6",
- "P10",
- "P15",
- "P20",
- "P30",
- "P40",
- "P50",
- "P60",
- "P70",
- "P80",
- "Hot",
- "Cool",
- "Archive",
- "Cold"
- ]
- }
- }
-};
-const queryRequest = {
- parameterPath: ["options", "queryRequest"],
- mapper: QueryRequest
-};
-const comp17 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "query",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const comp18 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "tags",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const tags = {
- parameterPath: ["options", "tags"],
- mapper: BlobTags
-};
-const transactionalContentMD5 = {
- parameterPath: ["options", "transactionalContentMD5"],
- mapper: {
- serializedName: "Content-MD5",
- xmlName: "Content-MD5",
- type: {
- name: "ByteArray"
- }
- }
-};
-const transactionalContentCrc64 = {
- parameterPath: ["options", "transactionalContentCrc64"],
- mapper: {
- serializedName: "x-ms-content-crc64",
- xmlName: "x-ms-content-crc64",
- type: {
- name: "ByteArray"
- }
- }
-};
-const blobType = {
- parameterPath: "blobType",
- mapper: {
- defaultValue: "PageBlob",
- isConstant: true,
- serializedName: "x-ms-blob-type",
- type: {
- name: "String"
- }
- }
-};
-const blobContentLength = {
- parameterPath: "blobContentLength",
- mapper: {
- serializedName: "x-ms-blob-content-length",
- required: true,
- xmlName: "x-ms-blob-content-length",
- type: {
- name: "Number"
- }
- }
-};
-const blobSequenceNumber = {
- parameterPath: ["options", "blobSequenceNumber"],
- mapper: {
- serializedName: "x-ms-blob-sequence-number",
- xmlName: "x-ms-blob-sequence-number",
- type: {
- name: "Number"
- }
- }
-};
-const contentType1 = {
- parameterPath: ["options", "contentType"],
- mapper: {
- defaultValue: "application/octet-stream",
- isConstant: true,
- serializedName: "Content-Type",
- type: {
- name: "String"
- }
- }
-};
-const body1 = {
- parameterPath: "body",
- mapper: {
- serializedName: "body",
- required: true,
- xmlName: "body",
- type: {
- name: "Stream"
- }
- }
-};
-const accept2 = {
- parameterPath: "accept",
- mapper: {
- defaultValue: "application/xml",
- isConstant: true,
- serializedName: "Accept",
- type: {
- name: "String"
- }
- }
-};
-const comp19 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "page",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const pageWrite = {
- parameterPath: "pageWrite",
- mapper: {
- defaultValue: "update",
- isConstant: true,
- serializedName: "x-ms-page-write",
- type: {
- name: "String"
- }
- }
-};
-const ifSequenceNumberLessThanOrEqualTo = {
- parameterPath: [
- "options",
- "sequenceNumberAccessConditions",
- "ifSequenceNumberLessThanOrEqualTo"
- ],
- mapper: {
- serializedName: "x-ms-if-sequence-number-le",
- xmlName: "x-ms-if-sequence-number-le",
- type: {
- name: "Number"
- }
- }
-};
-const ifSequenceNumberLessThan = {
- parameterPath: [
- "options",
- "sequenceNumberAccessConditions",
- "ifSequenceNumberLessThan"
- ],
- mapper: {
- serializedName: "x-ms-if-sequence-number-lt",
- xmlName: "x-ms-if-sequence-number-lt",
- type: {
- name: "Number"
- }
- }
-};
-const ifSequenceNumberEqualTo = {
- parameterPath: [
- "options",
- "sequenceNumberAccessConditions",
- "ifSequenceNumberEqualTo"
- ],
- mapper: {
- serializedName: "x-ms-if-sequence-number-eq",
- xmlName: "x-ms-if-sequence-number-eq",
- type: {
- name: "Number"
- }
- }
-};
-const pageWrite1 = {
- parameterPath: "pageWrite",
- mapper: {
- defaultValue: "clear",
- isConstant: true,
- serializedName: "x-ms-page-write",
- type: {
- name: "String"
- }
- }
-};
-const sourceUrl = {
- parameterPath: "sourceUrl",
- mapper: {
- serializedName: "x-ms-copy-source",
- required: true,
- xmlName: "x-ms-copy-source",
- type: {
- name: "String"
- }
- }
-};
-const sourceRange = {
- parameterPath: "sourceRange",
- mapper: {
- serializedName: "x-ms-source-range",
- required: true,
- xmlName: "x-ms-source-range",
- type: {
- name: "String"
- }
- }
-};
-const sourceContentCrc64 = {
- parameterPath: ["options", "sourceContentCrc64"],
- mapper: {
- serializedName: "x-ms-source-content-crc64",
- xmlName: "x-ms-source-content-crc64",
- type: {
- name: "ByteArray"
- }
- }
-};
-const range1 = {
- parameterPath: "range",
- mapper: {
- serializedName: "x-ms-range",
- required: true,
- xmlName: "x-ms-range",
- type: {
- name: "String"
- }
- }
-};
-const comp20 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "pagelist",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const prevsnapshot = {
- parameterPath: ["options", "prevsnapshot"],
- mapper: {
- serializedName: "prevsnapshot",
- xmlName: "prevsnapshot",
- type: {
- name: "String"
- }
- }
-};
-const prevSnapshotUrl = {
- parameterPath: ["options", "prevSnapshotUrl"],
- mapper: {
- serializedName: "x-ms-previous-snapshot-url",
- xmlName: "x-ms-previous-snapshot-url",
- type: {
- name: "String"
- }
- }
-};
-const sequenceNumberAction = {
- parameterPath: "sequenceNumberAction",
- mapper: {
- serializedName: "x-ms-sequence-number-action",
- required: true,
- xmlName: "x-ms-sequence-number-action",
- type: {
- name: "Enum",
- allowedValues: ["max", "update", "increment"]
- }
- }
-};
-const comp21 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "incrementalcopy",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const blobType1 = {
- parameterPath: "blobType",
- mapper: {
- defaultValue: "AppendBlob",
- isConstant: true,
- serializedName: "x-ms-blob-type",
- type: {
- name: "String"
- }
- }
-};
-const comp22 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "appendblock",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const maxSize = {
- parameterPath: ["options", "appendPositionAccessConditions", "maxSize"],
- mapper: {
- serializedName: "x-ms-blob-condition-maxsize",
- xmlName: "x-ms-blob-condition-maxsize",
- type: {
- name: "Number"
- }
- }
-};
-const appendPosition = {
- parameterPath: [
- "options",
- "appendPositionAccessConditions",
- "appendPosition"
- ],
- mapper: {
- serializedName: "x-ms-blob-condition-appendpos",
- xmlName: "x-ms-blob-condition-appendpos",
- type: {
- name: "Number"
- }
- }
-};
-const sourceRange1 = {
- parameterPath: ["options", "sourceRange"],
- mapper: {
- serializedName: "x-ms-source-range",
- xmlName: "x-ms-source-range",
- type: {
- name: "String"
- }
- }
-};
-const comp23 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "seal",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const blobType2 = {
- parameterPath: "blobType",
- mapper: {
- defaultValue: "BlockBlob",
- isConstant: true,
- serializedName: "x-ms-blob-type",
- type: {
- name: "String"
- }
- }
-};
-const copySourceBlobProperties = {
- parameterPath: ["options", "copySourceBlobProperties"],
- mapper: {
- serializedName: "x-ms-copy-source-blob-properties",
- xmlName: "x-ms-copy-source-blob-properties",
- type: {
- name: "Boolean"
- }
- }
-};
-const comp24 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "block",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const blockId = {
- parameterPath: "blockId",
- mapper: {
- serializedName: "blockid",
- required: true,
- xmlName: "blockid",
- type: {
- name: "String"
- }
- }
-};
-const blocks = {
- parameterPath: "blocks",
- mapper: BlockLookupList
-};
-const comp25 = {
- parameterPath: "comp",
- mapper: {
- defaultValue: "blocklist",
- isConstant: true,
- serializedName: "comp",
- type: {
- name: "String"
- }
- }
-};
-const listType = {
- parameterPath: "listType",
- mapper: {
- defaultValue: "committed",
- serializedName: "blocklisttype",
- required: true,
- xmlName: "blocklisttype",
- type: {
- name: "Enum",
- allowedValues: ["committed", "uncommitted", "all"]
- }
- }
-};
-
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-/** Class representing a Service. */
-class Service {
- /**
- * Initialize a new instance of the class Service class.
- * @param client Reference to the service client
- */
- constructor(client) {
- this.client = client;
- }
- /**
- * Sets properties for a storage account's Blob service endpoint, including properties for Storage
- * Analytics and CORS (Cross-Origin Resource Sharing) rules
- * @param blobServiceProperties The StorageService properties.
- * @param options The options parameters.
- */
- setProperties(blobServiceProperties, options) {
- const operationArguments = {
- blobServiceProperties,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setPropertiesOperationSpec);
- }
- /**
- * gets the properties of a storage account's Blob service, including properties for Storage Analytics
- * and CORS (Cross-Origin Resource Sharing) rules.
- * @param options The options parameters.
- */
- getProperties(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getPropertiesOperationSpec$2);
- }
- /**
- * Retrieves statistics related to replication for the Blob service. It is only available on the
- * secondary location endpoint when read-access geo-redundant replication is enabled for the storage
- * account.
- * @param options The options parameters.
- */
- getStatistics(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getStatisticsOperationSpec);
- }
- /**
- * The List Containers Segment operation returns a list of the containers under the specified account
- * @param options The options parameters.
- */
- listContainersSegment(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, listContainersSegmentOperationSpec);
- }
- /**
- * Retrieves a user delegation key for the Blob service. This is only a valid operation when using
- * bearer token authentication.
- * @param keyInfo Key information
- * @param options The options parameters.
- */
- getUserDelegationKey(keyInfo, options) {
- const operationArguments = {
- keyInfo,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getUserDelegationKeyOperationSpec);
- }
- /**
- * Returns the sku name and account kind
- * @param options The options parameters.
- */
- getAccountInfo(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getAccountInfoOperationSpec$2);
- }
- /**
- * The Batch operation allows multiple API calls to be embedded into a single HTTP request.
- * @param contentLength The length of the request.
- * @param multipartContentType Required. The value of this header must be multipart/mixed with a batch
- * boundary. Example header value: multipart/mixed; boundary=batch_
- * @param body Initial data
- * @param options The options parameters.
- */
- submitBatch(contentLength, multipartContentType, body, options) {
- const operationArguments = {
- contentLength,
- multipartContentType,
- body,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, submitBatchOperationSpec$1);
- }
- /**
- * The Filter Blobs operation enables callers to list blobs across all containers whose tags match a
- * given search expression. Filter blobs searches across all containers within a storage account but
- * can be scoped within the expression to a single container.
- * @param options The options parameters.
- */
- filterBlobs(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, filterBlobsOperationSpec$1);
- }
-}
-// Operation Specifications
-const xmlSerializer$5 = new coreHttp__namespace.Serializer(Mappers, /* isXml */ true);
-const setPropertiesOperationSpec = {
- path: "/",
- httpMethod: "PUT",
- responses: {
- 202: {
- headersMapper: ServiceSetPropertiesHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ServiceSetPropertiesExceptionHeaders
- }
- },
- requestBody: blobServiceProperties,
- queryParameters: [
- restype,
- comp,
- timeoutInSeconds
- ],
- urlParameters: [url],
- headerParameters: [
- contentType,
- accept,
- version,
- requestId
- ],
- isXML: true,
- contentType: "application/xml; charset=utf-8",
- mediaType: "xml",
- serializer: xmlSerializer$5
-};
-const getPropertiesOperationSpec$2 = {
- path: "/",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: BlobServiceProperties,
- headersMapper: ServiceGetPropertiesHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ServiceGetPropertiesExceptionHeaders
- }
- },
- queryParameters: [
- restype,
- comp,
- timeoutInSeconds
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$5
-};
-const getStatisticsOperationSpec = {
- path: "/",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: BlobServiceStatistics,
- headersMapper: ServiceGetStatisticsHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ServiceGetStatisticsExceptionHeaders
- }
- },
- queryParameters: [
- restype,
- timeoutInSeconds,
- comp1
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$5
-};
-const listContainersSegmentOperationSpec = {
- path: "/",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: ListContainersSegmentResponse,
- headersMapper: ServiceListContainersSegmentHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ServiceListContainersSegmentExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- comp2,
- prefix,
- marker,
- maxPageSize,
- include
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$5
-};
-const getUserDelegationKeyOperationSpec = {
- path: "/",
- httpMethod: "POST",
- responses: {
- 200: {
- bodyMapper: UserDelegationKey,
- headersMapper: ServiceGetUserDelegationKeyHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ServiceGetUserDelegationKeyExceptionHeaders
- }
- },
- requestBody: keyInfo,
- queryParameters: [
- restype,
- timeoutInSeconds,
- comp3
- ],
- urlParameters: [url],
- headerParameters: [
- contentType,
- accept,
- version,
- requestId
- ],
- isXML: true,
- contentType: "application/xml; charset=utf-8",
- mediaType: "xml",
- serializer: xmlSerializer$5
-};
-const getAccountInfoOperationSpec$2 = {
- path: "/",
- httpMethod: "GET",
- responses: {
- 200: {
- headersMapper: ServiceGetAccountInfoHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ServiceGetAccountInfoExceptionHeaders
- }
- },
- queryParameters: [comp, restype1],
- urlParameters: [url],
- headerParameters: [version, accept1],
- isXML: true,
- serializer: xmlSerializer$5
-};
-const submitBatchOperationSpec$1 = {
- path: "/",
- httpMethod: "POST",
- responses: {
- 202: {
- bodyMapper: {
- type: { name: "Stream" },
- serializedName: "parsedResponse"
- },
- headersMapper: ServiceSubmitBatchHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ServiceSubmitBatchExceptionHeaders
- }
- },
- requestBody: body,
- queryParameters: [timeoutInSeconds, comp4],
- urlParameters: [url],
- headerParameters: [
- contentType,
- accept,
- version,
- requestId,
- contentLength,
- multipartContentType
- ],
- isXML: true,
- contentType: "application/xml; charset=utf-8",
- mediaType: "xml",
- serializer: xmlSerializer$5
-};
-const filterBlobsOperationSpec$1 = {
- path: "/",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: FilterBlobSegment,
- headersMapper: ServiceFilterBlobsHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ServiceFilterBlobsExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- marker,
- maxPageSize,
- comp5,
- where
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$5
-};
-
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-/** Class representing a Container. */
-class Container {
- /**
- * Initialize a new instance of the class Container class.
- * @param client Reference to the service client
- */
- constructor(client) {
- this.client = client;
- }
- /**
- * creates a new container under the specified account. If the container with the same name already
- * exists, the operation fails
- * @param options The options parameters.
- */
- create(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, createOperationSpec$2);
- }
- /**
- * returns all user-defined metadata and system properties for the specified container. The data
- * returned does not include the container's list of blobs
- * @param options The options parameters.
- */
- getProperties(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getPropertiesOperationSpec$1);
- }
- /**
- * operation marks the specified container for deletion. The container and any blobs contained within
- * it are later deleted during garbage collection
- * @param options The options parameters.
- */
- delete(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, deleteOperationSpec$1);
- }
- /**
- * operation sets one or more user-defined name-value pairs for the specified container.
- * @param options The options parameters.
- */
- setMetadata(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setMetadataOperationSpec$1);
- }
- /**
- * gets the permissions for the specified container. The permissions indicate whether container data
- * may be accessed publicly.
- * @param options The options parameters.
- */
- getAccessPolicy(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getAccessPolicyOperationSpec);
- }
- /**
- * sets the permissions for the specified container. The permissions indicate whether blobs in a
- * container may be accessed publicly.
- * @param options The options parameters.
- */
- setAccessPolicy(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setAccessPolicyOperationSpec);
- }
- /**
- * Restores a previously-deleted container.
- * @param options The options parameters.
- */
- restore(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, restoreOperationSpec);
- }
- /**
- * Renames an existing container.
- * @param sourceContainerName Required. Specifies the name of the container to rename.
- * @param options The options parameters.
- */
- rename(sourceContainerName, options) {
- const operationArguments = {
- sourceContainerName,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, renameOperationSpec);
- }
- /**
- * The Batch operation allows multiple API calls to be embedded into a single HTTP request.
- * @param contentLength The length of the request.
- * @param multipartContentType Required. The value of this header must be multipart/mixed with a batch
- * boundary. Example header value: multipart/mixed; boundary=batch_
- * @param body Initial data
- * @param options The options parameters.
- */
- submitBatch(contentLength, multipartContentType, body, options) {
- const operationArguments = {
- contentLength,
- multipartContentType,
- body,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, submitBatchOperationSpec);
- }
- /**
- * The Filter Blobs operation enables callers to list blobs in a container whose tags match a given
- * search expression. Filter blobs searches within the given container.
- * @param options The options parameters.
- */
- filterBlobs(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, filterBlobsOperationSpec);
- }
- /**
- * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
- * be 15 to 60 seconds, or can be infinite
- * @param options The options parameters.
- */
- acquireLease(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, acquireLeaseOperationSpec$1);
- }
- /**
- * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
- * be 15 to 60 seconds, or can be infinite
- * @param leaseId Specifies the current lease ID on the resource.
- * @param options The options parameters.
- */
- releaseLease(leaseId, options) {
- const operationArguments = {
- leaseId,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, releaseLeaseOperationSpec$1);
- }
- /**
- * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
- * be 15 to 60 seconds, or can be infinite
- * @param leaseId Specifies the current lease ID on the resource.
- * @param options The options parameters.
- */
- renewLease(leaseId, options) {
- const operationArguments = {
- leaseId,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, renewLeaseOperationSpec$1);
- }
- /**
- * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
- * be 15 to 60 seconds, or can be infinite
- * @param options The options parameters.
- */
- breakLease(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, breakLeaseOperationSpec$1);
- }
- /**
- * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
- * be 15 to 60 seconds, or can be infinite
- * @param leaseId Specifies the current lease ID on the resource.
- * @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
- * (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
- * (String) for a list of valid GUID string formats.
- * @param options The options parameters.
- */
- changeLease(leaseId, proposedLeaseId, options) {
- const operationArguments = {
- leaseId,
- proposedLeaseId,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, changeLeaseOperationSpec$1);
- }
- /**
- * [Update] The List Blobs operation returns a list of the blobs under the specified container
- * @param options The options parameters.
- */
- listBlobFlatSegment(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, listBlobFlatSegmentOperationSpec);
- }
- /**
- * [Update] The List Blobs operation returns a list of the blobs under the specified container
- * @param delimiter When the request includes this parameter, the operation returns a BlobPrefix
- * element in the response body that acts as a placeholder for all blobs whose names begin with the
- * same substring up to the appearance of the delimiter character. The delimiter may be a single
- * character or a string.
- * @param options The options parameters.
- */
- listBlobHierarchySegment(delimiter, options) {
- const operationArguments = {
- delimiter,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, listBlobHierarchySegmentOperationSpec);
- }
- /**
- * Returns the sku name and account kind
- * @param options The options parameters.
- */
- getAccountInfo(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getAccountInfoOperationSpec$1);
- }
-}
-// Operation Specifications
-const xmlSerializer$4 = new coreHttp__namespace.Serializer(Mappers, /* isXml */ true);
-const createOperationSpec$2 = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: ContainerCreateHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerCreateExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, restype2],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- metadata,
- access,
- defaultEncryptionScope,
- preventEncryptionScopeOverride
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const getPropertiesOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "GET",
- responses: {
- 200: {
- headersMapper: ContainerGetPropertiesHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerGetPropertiesExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, restype2],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const deleteOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "DELETE",
- responses: {
- 202: {
- headersMapper: ContainerDeleteHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerDeleteExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, restype2],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const setMetadataOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: ContainerSetMetadataHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerSetMetadataExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp6
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- metadata,
- leaseId,
- ifModifiedSince
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const getAccessPolicyOperationSpec = {
- path: "/{containerName}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: {
- type: {
- name: "Sequence",
- element: {
- type: { name: "Composite", className: "SignedIdentifier" }
- }
- },
- serializedName: "SignedIdentifiers",
- xmlName: "SignedIdentifiers",
- xmlIsWrapped: true,
- xmlElementName: "SignedIdentifier"
- },
- headersMapper: ContainerGetAccessPolicyHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerGetAccessPolicyExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp7
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const setAccessPolicyOperationSpec = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: ContainerSetAccessPolicyHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerSetAccessPolicyExceptionHeaders
- }
- },
- requestBody: containerAcl,
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp7
- ],
- urlParameters: [url],
- headerParameters: [
- contentType,
- accept,
- version,
- requestId,
- access,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince
- ],
- isXML: true,
- contentType: "application/xml; charset=utf-8",
- mediaType: "xml",
- serializer: xmlSerializer$4
-};
-const restoreOperationSpec = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: ContainerRestoreHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerRestoreExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp8
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- deletedContainerName,
- deletedContainerVersion
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const renameOperationSpec = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: ContainerRenameHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerRenameExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp9
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- sourceContainerName,
- sourceLeaseId
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const submitBatchOperationSpec = {
- path: "/{containerName}",
- httpMethod: "POST",
- responses: {
- 202: {
- bodyMapper: {
- type: { name: "Stream" },
- serializedName: "parsedResponse"
- },
- headersMapper: ContainerSubmitBatchHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerSubmitBatchExceptionHeaders
- }
- },
- requestBody: body,
- queryParameters: [
- timeoutInSeconds,
- comp4,
- restype2
- ],
- urlParameters: [url],
- headerParameters: [
- contentType,
- accept,
- version,
- requestId,
- contentLength,
- multipartContentType
- ],
- isXML: true,
- contentType: "application/xml; charset=utf-8",
- mediaType: "xml",
- serializer: xmlSerializer$4
-};
-const filterBlobsOperationSpec = {
- path: "/{containerName}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: FilterBlobSegment,
- headersMapper: ContainerFilterBlobsHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerFilterBlobsExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- marker,
- maxPageSize,
- comp5,
- where,
- restype2
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const acquireLeaseOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: ContainerAcquireLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerAcquireLeaseExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp10
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- action,
- duration,
- proposedLeaseId
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const releaseLeaseOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: ContainerReleaseLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerReleaseLeaseExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp10
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- action1,
- leaseId1
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const renewLeaseOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: ContainerRenewLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerRenewLeaseExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp10
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- leaseId1,
- action2
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const breakLeaseOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 202: {
- headersMapper: ContainerBreakLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerBreakLeaseExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp10
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- action3,
- breakPeriod
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const changeLeaseOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: ContainerChangeLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerChangeLeaseExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- restype2,
- comp10
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- leaseId1,
- action4,
- proposedLeaseId1
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const listBlobFlatSegmentOperationSpec = {
- path: "/{containerName}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: ListBlobsFlatSegmentResponse,
- headersMapper: ContainerListBlobFlatSegmentHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerListBlobFlatSegmentExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- comp2,
- prefix,
- marker,
- maxPageSize,
- restype2,
- include1
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const listBlobHierarchySegmentOperationSpec = {
- path: "/{containerName}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: ListBlobsHierarchySegmentResponse,
- headersMapper: ContainerListBlobHierarchySegmentHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerListBlobHierarchySegmentExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- comp2,
- prefix,
- marker,
- maxPageSize,
- restype2,
- include1,
- delimiter
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$4
-};
-const getAccountInfoOperationSpec$1 = {
- path: "/{containerName}",
- httpMethod: "GET",
- responses: {
- 200: {
- headersMapper: ContainerGetAccountInfoHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: ContainerGetAccountInfoExceptionHeaders
- }
- },
- queryParameters: [comp, restype1],
- urlParameters: [url],
- headerParameters: [version, accept1],
- isXML: true,
- serializer: xmlSerializer$4
-};
-
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-/** Class representing a Blob. */
-class Blob$1 {
- /**
- * Initialize a new instance of the class Blob class.
- * @param client Reference to the service client
- */
- constructor(client) {
- this.client = client;
- }
- /**
- * The Download operation reads or downloads a blob from the system, including its metadata and
- * properties. You can also call Download to read a snapshot.
- * @param options The options parameters.
- */
- download(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, downloadOperationSpec);
- }
- /**
- * The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system
- * properties for the blob. It does not return the content of the blob.
- * @param options The options parameters.
- */
- getProperties(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getPropertiesOperationSpec);
- }
- /**
- * If the storage account's soft delete feature is disabled then, when a blob is deleted, it is
- * permanently removed from the storage account. If the storage account's soft delete feature is
- * enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible
- * immediately. However, the blob service retains the blob or snapshot for the number of days specified
- * by the DeleteRetentionPolicy section of [Storage service properties]
- * (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is
- * permanently removed from the storage account. Note that you continue to be charged for the
- * soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the
- * "include=deleted" query parameter to discover which blobs and snapshots have been soft deleted. You
- * can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a
- * soft-deleted blob or snapshot causes the service to return an HTTP status code of 404
- * (ResourceNotFound).
- * @param options The options parameters.
- */
- delete(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, deleteOperationSpec);
- }
- /**
- * Undelete a blob that was previously soft deleted
- * @param options The options parameters.
- */
- undelete(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, undeleteOperationSpec);
- }
- /**
- * Sets the time a blob will expire and be deleted.
- * @param expiryOptions Required. Indicates mode of the expiry time
- * @param options The options parameters.
- */
- setExpiry(expiryOptions, options) {
- const operationArguments = {
- expiryOptions,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setExpiryOperationSpec);
- }
- /**
- * The Set HTTP Headers operation sets system properties on the blob
- * @param options The options parameters.
- */
- setHttpHeaders(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setHttpHeadersOperationSpec);
- }
- /**
- * The Set Immutability Policy operation sets the immutability policy on the blob
- * @param options The options parameters.
- */
- setImmutabilityPolicy(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setImmutabilityPolicyOperationSpec);
- }
- /**
- * The Delete Immutability Policy operation deletes the immutability policy on the blob
- * @param options The options parameters.
- */
- deleteImmutabilityPolicy(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, deleteImmutabilityPolicyOperationSpec);
- }
- /**
- * The Set Legal Hold operation sets a legal hold on the blob.
- * @param legalHold Specified if a legal hold should be set on the blob.
- * @param options The options parameters.
- */
- setLegalHold(legalHold, options) {
- const operationArguments = {
- legalHold,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setLegalHoldOperationSpec);
- }
- /**
- * The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more
- * name-value pairs
- * @param options The options parameters.
- */
- setMetadata(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setMetadataOperationSpec);
- }
- /**
- * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
- * operations
- * @param options The options parameters.
- */
- acquireLease(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, acquireLeaseOperationSpec);
- }
- /**
- * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
- * operations
- * @param leaseId Specifies the current lease ID on the resource.
- * @param options The options parameters.
- */
- releaseLease(leaseId, options) {
- const operationArguments = {
- leaseId,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, releaseLeaseOperationSpec);
- }
- /**
- * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
- * operations
- * @param leaseId Specifies the current lease ID on the resource.
- * @param options The options parameters.
- */
- renewLease(leaseId, options) {
- const operationArguments = {
- leaseId,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, renewLeaseOperationSpec);
- }
- /**
- * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
- * operations
- * @param leaseId Specifies the current lease ID on the resource.
- * @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
- * (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
- * (String) for a list of valid GUID string formats.
- * @param options The options parameters.
- */
- changeLease(leaseId, proposedLeaseId, options) {
- const operationArguments = {
- leaseId,
- proposedLeaseId,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, changeLeaseOperationSpec);
- }
- /**
- * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
- * operations
- * @param options The options parameters.
- */
- breakLease(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, breakLeaseOperationSpec);
- }
- /**
- * The Create Snapshot operation creates a read-only snapshot of a blob
- * @param options The options parameters.
- */
- createSnapshot(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, createSnapshotOperationSpec);
- }
- /**
- * The Start Copy From URL operation copies a blob or an internet resource to a new blob.
- * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
- * 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
- * appear in a request URI. The source blob must either be public or must be authenticated via a shared
- * access signature.
- * @param options The options parameters.
- */
- startCopyFromURL(copySource, options) {
- const operationArguments = {
- copySource,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, startCopyFromURLOperationSpec);
- }
- /**
- * The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return
- * a response until the copy is complete.
- * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
- * 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
- * appear in a request URI. The source blob must either be public or must be authenticated via a shared
- * access signature.
- * @param options The options parameters.
- */
- copyFromURL(copySource, options) {
- const operationArguments = {
- copySource,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, copyFromURLOperationSpec);
- }
- /**
- * The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination
- * blob with zero length and full metadata.
- * @param copyId The copy identifier provided in the x-ms-copy-id header of the original Copy Blob
- * operation.
- * @param options The options parameters.
- */
- abortCopyFromURL(copyId, options) {
- const operationArguments = {
- copyId,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, abortCopyFromURLOperationSpec);
- }
- /**
- * The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium
- * storage account and on a block blob in a blob storage account (locally redundant storage only). A
- * premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block
- * blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's
- * ETag.
- * @param tier Indicates the tier to be set on the blob.
- * @param options The options parameters.
- */
- setTier(tier, options) {
- const operationArguments = {
- tier,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setTierOperationSpec);
- }
- /**
- * Returns the sku name and account kind
- * @param options The options parameters.
- */
- getAccountInfo(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getAccountInfoOperationSpec);
- }
- /**
- * The Query operation enables users to select/project on blob data by providing simple query
- * expressions.
- * @param options The options parameters.
- */
- query(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, queryOperationSpec);
- }
- /**
- * The Get Tags operation enables users to get the tags associated with a blob.
- * @param options The options parameters.
- */
- getTags(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getTagsOperationSpec);
- }
- /**
- * The Set Tags operation enables users to set tags on a blob.
- * @param options The options parameters.
- */
- setTags(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, setTagsOperationSpec);
- }
-}
-// Operation Specifications
-const xmlSerializer$3 = new coreHttp__namespace.Serializer(Mappers, /* isXml */ true);
-const downloadOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: {
- type: { name: "Stream" },
- serializedName: "parsedResponse"
- },
- headersMapper: BlobDownloadHeaders
- },
- 206: {
- bodyMapper: {
- type: { name: "Stream" },
- serializedName: "parsedResponse"
- },
- headersMapper: BlobDownloadHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobDownloadExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- snapshot,
- versionId
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- range,
- rangeGetContentMD5,
- rangeGetContentCRC64,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const getPropertiesOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "HEAD",
- responses: {
- 200: {
- headersMapper: BlobGetPropertiesHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobGetPropertiesExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- snapshot,
- versionId
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const deleteOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "DELETE",
- responses: {
- 202: {
- headersMapper: BlobDeleteHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobDeleteExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- snapshot,
- versionId,
- blobDeleteType
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- ifMatch,
- ifNoneMatch,
- ifTags,
- deleteSnapshots
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const undeleteOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobUndeleteHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobUndeleteExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp8],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const setExpiryOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobSetExpiryHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobSetExpiryExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp11],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- expiryOptions,
- expiresOn
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const setHttpHeadersOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobSetHttpHeadersHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobSetHttpHeadersExceptionHeaders
- }
- },
- queryParameters: [comp, timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- ifMatch,
- ifNoneMatch,
- ifTags,
- blobCacheControl,
- blobContentType,
- blobContentMD5,
- blobContentEncoding,
- blobContentLanguage,
- blobContentDisposition
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const setImmutabilityPolicyOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobSetImmutabilityPolicyHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobSetImmutabilityPolicyExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp12],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifUnmodifiedSince,
- immutabilityPolicyExpiry,
- immutabilityPolicyMode
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const deleteImmutabilityPolicyOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "DELETE",
- responses: {
- 200: {
- headersMapper: BlobDeleteImmutabilityPolicyHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobDeleteImmutabilityPolicyExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp12],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const setLegalHoldOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobSetLegalHoldHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobSetLegalHoldExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp13],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- legalHold
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const setMetadataOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobSetMetadataHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobSetMetadataExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp6],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- encryptionScope
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const acquireLeaseOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: BlobAcquireLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobAcquireLeaseExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp10],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- action,
- duration,
- proposedLeaseId,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const releaseLeaseOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobReleaseLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobReleaseLeaseExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp10],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- action1,
- leaseId1,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const renewLeaseOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobRenewLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobRenewLeaseExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp10],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- leaseId1,
- action2,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const changeLeaseOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobChangeLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobChangeLeaseExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp10],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- leaseId1,
- action4,
- proposedLeaseId1,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const breakLeaseOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 202: {
- headersMapper: BlobBreakLeaseHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobBreakLeaseExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp10],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- action3,
- breakPeriod,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const createSnapshotOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: BlobCreateSnapshotHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobCreateSnapshotExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp14],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- encryptionScope
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const startCopyFromURLOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 202: {
- headersMapper: BlobStartCopyFromURLHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobStartCopyFromURLExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- ifMatch,
- ifNoneMatch,
- ifTags,
- immutabilityPolicyExpiry,
- immutabilityPolicyMode,
- tier,
- rehydratePriority,
- sourceIfModifiedSince,
- sourceIfUnmodifiedSince,
- sourceIfMatch,
- sourceIfNoneMatch,
- sourceIfTags,
- copySource,
- blobTagsString,
- sealBlob,
- legalHold1
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const copyFromURLOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 202: {
- headersMapper: BlobCopyFromURLHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobCopyFromURLExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- ifMatch,
- ifNoneMatch,
- ifTags,
- immutabilityPolicyExpiry,
- immutabilityPolicyMode,
- encryptionScope,
- tier,
- sourceIfModifiedSince,
- sourceIfUnmodifiedSince,
- sourceIfMatch,
- sourceIfNoneMatch,
- copySource,
- blobTagsString,
- legalHold1,
- xMsRequiresSync,
- sourceContentMD5,
- copySourceAuthorization,
- copySourceTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const abortCopyFromURLOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 204: {
- headersMapper: BlobAbortCopyFromURLHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobAbortCopyFromURLExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- comp15,
- copyId
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- copyActionAbortConstant
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const setTierOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: BlobSetTierHeaders
- },
- 202: {
- headersMapper: BlobSetTierHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobSetTierExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- snapshot,
- versionId,
- comp16
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifTags,
- rehydratePriority,
- tier1
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const getAccountInfoOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "GET",
- responses: {
- 200: {
- headersMapper: BlobGetAccountInfoHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobGetAccountInfoExceptionHeaders
- }
- },
- queryParameters: [comp, restype1],
- urlParameters: [url],
- headerParameters: [version, accept1],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const queryOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "POST",
- responses: {
- 200: {
- bodyMapper: {
- type: { name: "Stream" },
- serializedName: "parsedResponse"
- },
- headersMapper: BlobQueryHeaders
- },
- 206: {
- bodyMapper: {
- type: { name: "Stream" },
- serializedName: "parsedResponse"
- },
- headersMapper: BlobQueryHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobQueryExceptionHeaders
- }
- },
- requestBody: queryRequest,
- queryParameters: [
- timeoutInSeconds,
- snapshot,
- comp17
- ],
- urlParameters: [url],
- headerParameters: [
- contentType,
- accept,
- version,
- requestId,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- contentType: "application/xml; charset=utf-8",
- mediaType: "xml",
- serializer: xmlSerializer$3
-};
-const getTagsOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: BlobTags,
- headersMapper: BlobGetTagsHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobGetTagsExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- snapshot,
- versionId,
- comp18
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$3
-};
-const setTagsOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 204: {
- headersMapper: BlobSetTagsHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlobSetTagsExceptionHeaders
- }
- },
- requestBody: tags,
- queryParameters: [
- timeoutInSeconds,
- versionId,
- comp18
- ],
- urlParameters: [url],
- headerParameters: [
- contentType,
- accept,
- version,
- requestId,
- leaseId,
- ifTags,
- transactionalContentMD5,
- transactionalContentCrc64
- ],
- isXML: true,
- contentType: "application/xml; charset=utf-8",
- mediaType: "xml",
- serializer: xmlSerializer$3
-};
-
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-/** Class representing a PageBlob. */
-class PageBlob {
- /**
- * Initialize a new instance of the class PageBlob class.
- * @param client Reference to the service client
- */
- constructor(client) {
- this.client = client;
- }
- /**
- * The Create operation creates a new page blob.
- * @param contentLength The length of the request.
- * @param blobContentLength This header specifies the maximum size for the page blob, up to 1 TB. The
- * page blob size must be aligned to a 512-byte boundary.
- * @param options The options parameters.
- */
- create(contentLength, blobContentLength, options) {
- const operationArguments = {
- contentLength,
- blobContentLength,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, createOperationSpec$1);
- }
- /**
- * The Upload Pages operation writes a range of pages to a page blob
- * @param contentLength The length of the request.
- * @param body Initial data
- * @param options The options parameters.
- */
- uploadPages(contentLength, body, options) {
- const operationArguments = {
- contentLength,
- body,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, uploadPagesOperationSpec);
- }
- /**
- * The Clear Pages operation clears a set of pages from a page blob
- * @param contentLength The length of the request.
- * @param options The options parameters.
- */
- clearPages(contentLength, options) {
- const operationArguments = {
- contentLength,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, clearPagesOperationSpec);
- }
- /**
- * The Upload Pages operation writes a range of pages to a page blob where the contents are read from a
- * URL
- * @param sourceUrl Specify a URL to the copy source.
- * @param sourceRange Bytes of source data in the specified range. The length of this range should
- * match the ContentLength header and x-ms-range/Range destination range header.
- * @param contentLength The length of the request.
- * @param range The range of bytes to which the source range would be written. The range should be 512
- * aligned and range-end is required.
- * @param options The options parameters.
- */
- uploadPagesFromURL(sourceUrl, sourceRange, contentLength, range, options) {
- const operationArguments = {
- sourceUrl,
- sourceRange,
- contentLength,
- range,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, uploadPagesFromURLOperationSpec);
- }
- /**
- * The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a
- * page blob
- * @param options The options parameters.
- */
- getPageRanges(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getPageRangesOperationSpec);
- }
- /**
- * The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were
- * changed between target blob and previous snapshot.
- * @param options The options parameters.
- */
- getPageRangesDiff(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getPageRangesDiffOperationSpec);
- }
- /**
- * Resize the Blob
- * @param blobContentLength This header specifies the maximum size for the page blob, up to 1 TB. The
- * page blob size must be aligned to a 512-byte boundary.
- * @param options The options parameters.
- */
- resize(blobContentLength, options) {
- const operationArguments = {
- blobContentLength,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, resizeOperationSpec);
- }
- /**
- * Update the sequence number of the blob
- * @param sequenceNumberAction Required if the x-ms-blob-sequence-number header is set for the request.
- * This property applies to page blobs only. This property indicates how the service should modify the
- * blob's sequence number
- * @param options The options parameters.
- */
- updateSequenceNumber(sequenceNumberAction, options) {
- const operationArguments = {
- sequenceNumberAction,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, updateSequenceNumberOperationSpec);
- }
- /**
- * The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob.
- * The snapshot is copied such that only the differential changes between the previously copied
- * snapshot are transferred to the destination. The copied snapshots are complete copies of the
- * original snapshot and can be read or copied from as usual. This API is supported since REST version
- * 2016-05-31.
- * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
- * 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
- * appear in a request URI. The source blob must either be public or must be authenticated via a shared
- * access signature.
- * @param options The options parameters.
- */
- copyIncremental(copySource, options) {
- const operationArguments = {
- copySource,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, copyIncrementalOperationSpec);
- }
-}
-// Operation Specifications
-const xmlSerializer$2 = new coreHttp__namespace.Serializer(Mappers, /* isXml */ true);
-const serializer$2 = new coreHttp__namespace.Serializer(Mappers, /* isXml */ false);
-const createOperationSpec$1 = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: PageBlobCreateHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobCreateExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- contentLength,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- blobCacheControl,
- blobContentType,
- blobContentMD5,
- blobContentEncoding,
- blobContentLanguage,
- blobContentDisposition,
- immutabilityPolicyExpiry,
- immutabilityPolicyMode,
- encryptionScope,
- tier,
- blobTagsString,
- legalHold1,
- blobType,
- blobContentLength,
- blobSequenceNumber
- ],
- isXML: true,
- serializer: xmlSerializer$2
-};
-const uploadPagesOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: PageBlobUploadPagesHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobUploadPagesExceptionHeaders
- }
- },
- requestBody: body1,
- queryParameters: [timeoutInSeconds, comp19],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- contentLength,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- range,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- encryptionScope,
- transactionalContentMD5,
- transactionalContentCrc64,
- contentType1,
- accept2,
- pageWrite,
- ifSequenceNumberLessThanOrEqualTo,
- ifSequenceNumberLessThan,
- ifSequenceNumberEqualTo
- ],
- mediaType: "binary",
- serializer: serializer$2
-};
-const clearPagesOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: PageBlobClearPagesHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobClearPagesExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp19],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- contentLength,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- range,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- encryptionScope,
- ifSequenceNumberLessThanOrEqualTo,
- ifSequenceNumberLessThan,
- ifSequenceNumberEqualTo,
- pageWrite1
- ],
- isXML: true,
- serializer: xmlSerializer$2
-};
-const uploadPagesFromURLOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: PageBlobUploadPagesFromURLHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobUploadPagesFromURLExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp19],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- contentLength,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- encryptionScope,
- sourceIfModifiedSince,
- sourceIfUnmodifiedSince,
- sourceIfMatch,
- sourceIfNoneMatch,
- sourceContentMD5,
- copySourceAuthorization,
- pageWrite,
- ifSequenceNumberLessThanOrEqualTo,
- ifSequenceNumberLessThan,
- ifSequenceNumberEqualTo,
- sourceUrl,
- sourceRange,
- sourceContentCrc64,
- range1
- ],
- isXML: true,
- serializer: xmlSerializer$2
-};
-const getPageRangesOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: PageList,
- headersMapper: PageBlobGetPageRangesHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobGetPageRangesExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- marker,
- maxPageSize,
- snapshot,
- comp20
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- range,
- ifMatch,
- ifNoneMatch,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer$2
-};
-const getPageRangesDiffOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: PageList,
- headersMapper: PageBlobGetPageRangesDiffHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobGetPageRangesDiffExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- marker,
- maxPageSize,
- snapshot,
- comp20,
- prevsnapshot
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- range,
- ifMatch,
- ifNoneMatch,
- ifTags,
- prevSnapshotUrl
- ],
- isXML: true,
- serializer: xmlSerializer$2
-};
-const resizeOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: PageBlobResizeHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobResizeExceptionHeaders
- }
- },
- queryParameters: [comp, timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- encryptionScope,
- blobContentLength
- ],
- isXML: true,
- serializer: xmlSerializer$2
-};
-const updateSequenceNumberOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: PageBlobUpdateSequenceNumberHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobUpdateSequenceNumberExceptionHeaders
- }
- },
- queryParameters: [comp, timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- ifMatch,
- ifNoneMatch,
- ifTags,
- blobSequenceNumber,
- sequenceNumberAction
- ],
- isXML: true,
- serializer: xmlSerializer$2
-};
-const copyIncrementalOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 202: {
- headersMapper: PageBlobCopyIncrementalHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: PageBlobCopyIncrementalExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp21],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- ifModifiedSince,
- ifUnmodifiedSince,
- ifMatch,
- ifNoneMatch,
- ifTags,
- copySource
- ],
- isXML: true,
- serializer: xmlSerializer$2
-};
-
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-/** Class representing a AppendBlob. */
-class AppendBlob {
- /**
- * Initialize a new instance of the class AppendBlob class.
- * @param client Reference to the service client
- */
- constructor(client) {
- this.client = client;
- }
- /**
- * The Create Append Blob operation creates a new append blob.
- * @param contentLength The length of the request.
- * @param options The options parameters.
- */
- create(contentLength, options) {
- const operationArguments = {
- contentLength,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, createOperationSpec);
- }
- /**
- * The Append Block operation commits a new block of data to the end of an existing append blob. The
- * Append Block operation is permitted only if the blob was created with x-ms-blob-type set to
- * AppendBlob. Append Block is supported only on version 2015-02-21 version or later.
- * @param contentLength The length of the request.
- * @param body Initial data
- * @param options The options parameters.
- */
- appendBlock(contentLength, body, options) {
- const operationArguments = {
- contentLength,
- body,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, appendBlockOperationSpec);
- }
- /**
- * The Append Block operation commits a new block of data to the end of an existing append blob where
- * the contents are read from a source url. The Append Block operation is permitted only if the blob
- * was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version
- * 2015-02-21 version or later.
- * @param sourceUrl Specify a URL to the copy source.
- * @param contentLength The length of the request.
- * @param options The options parameters.
- */
- appendBlockFromUrl(sourceUrl, contentLength, options) {
- const operationArguments = {
- sourceUrl,
- contentLength,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, appendBlockFromUrlOperationSpec);
- }
- /**
- * The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version
- * 2019-12-12 version or later.
- * @param options The options parameters.
- */
- seal(options) {
- const operationArguments = {
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, sealOperationSpec);
- }
-}
-// Operation Specifications
-const xmlSerializer$1 = new coreHttp__namespace.Serializer(Mappers, /* isXml */ true);
-const serializer$1 = new coreHttp__namespace.Serializer(Mappers, /* isXml */ false);
-const createOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: AppendBlobCreateHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: AppendBlobCreateExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- contentLength,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- blobCacheControl,
- blobContentType,
- blobContentMD5,
- blobContentEncoding,
- blobContentLanguage,
- blobContentDisposition,
- immutabilityPolicyExpiry,
- immutabilityPolicyMode,
- encryptionScope,
- blobTagsString,
- legalHold1,
- blobType1
- ],
- isXML: true,
- serializer: xmlSerializer$1
-};
-const appendBlockOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: AppendBlobAppendBlockHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: AppendBlobAppendBlockExceptionHeaders
- }
- },
- requestBody: body1,
- queryParameters: [timeoutInSeconds, comp22],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- contentLength,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- encryptionScope,
- transactionalContentMD5,
- transactionalContentCrc64,
- contentType1,
- accept2,
- maxSize,
- appendPosition
- ],
- mediaType: "binary",
- serializer: serializer$1
-};
-const appendBlockFromUrlOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: AppendBlobAppendBlockFromUrlHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: AppendBlobAppendBlockFromUrlExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp22],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- contentLength,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- encryptionScope,
- sourceIfModifiedSince,
- sourceIfUnmodifiedSince,
- sourceIfMatch,
- sourceIfNoneMatch,
- sourceContentMD5,
- copySourceAuthorization,
- transactionalContentMD5,
- sourceUrl,
- sourceContentCrc64,
- maxSize,
- appendPosition,
- sourceRange1
- ],
- isXML: true,
- serializer: xmlSerializer$1
-};
-const sealOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 200: {
- headersMapper: AppendBlobSealHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: AppendBlobSealExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds, comp23],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- ifMatch,
- ifNoneMatch,
- appendPosition
- ],
- isXML: true,
- serializer: xmlSerializer$1
-};
-
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-/** Class representing a BlockBlob. */
-class BlockBlob {
- /**
- * Initialize a new instance of the class BlockBlob class.
- * @param client Reference to the service client
- */
- constructor(client) {
- this.client = client;
- }
- /**
- * The Upload Block Blob operation updates the content of an existing block blob. Updating an existing
- * block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put
- * Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a
- * partial update of the content of a block blob, use the Put Block List operation.
- * @param contentLength The length of the request.
- * @param body Initial data
- * @param options The options parameters.
- */
- upload(contentLength, body, options) {
- const operationArguments = {
- contentLength,
- body,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, uploadOperationSpec);
- }
- /**
- * The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read
- * from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are
- * not supported with Put Blob from URL; the content of an existing blob is overwritten with the
- * content of the new blob. To perform partial updates to a block blob’s contents using a source URL,
- * use the Put Block from URL API in conjunction with Put Block List.
- * @param contentLength The length of the request.
- * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
- * 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
- * appear in a request URI. The source blob must either be public or must be authenticated via a shared
- * access signature.
- * @param options The options parameters.
- */
- putBlobFromUrl(contentLength, copySource, options) {
- const operationArguments = {
- contentLength,
- copySource,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, putBlobFromUrlOperationSpec);
- }
- /**
- * The Stage Block operation creates a new block to be committed as part of a blob
- * @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
- * must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
- * for the blockid parameter must be the same size for each block.
- * @param contentLength The length of the request.
- * @param body Initial data
- * @param options The options parameters.
- */
- stageBlock(blockId, contentLength, body, options) {
- const operationArguments = {
- blockId,
- contentLength,
- body,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, stageBlockOperationSpec);
- }
- /**
- * The Stage Block operation creates a new block to be committed as part of a blob where the contents
- * are read from a URL.
- * @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
- * must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
- * for the blockid parameter must be the same size for each block.
- * @param contentLength The length of the request.
- * @param sourceUrl Specify a URL to the copy source.
- * @param options The options parameters.
- */
- stageBlockFromURL(blockId, contentLength, sourceUrl, options) {
- const operationArguments = {
- blockId,
- contentLength,
- sourceUrl,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, stageBlockFromURLOperationSpec);
- }
- /**
- * The Commit Block List operation writes a blob by specifying the list of block IDs that make up the
- * blob. In order to be written as part of a blob, a block must have been successfully written to the
- * server in a prior Put Block operation. You can call Put Block List to update a blob by uploading
- * only those blocks that have changed, then committing the new and existing blocks together. You can
- * do this by specifying whether to commit a block from the committed block list or from the
- * uncommitted block list, or to commit the most recently uploaded version of the block, whichever list
- * it may belong to.
- * @param blocks Blob Blocks.
- * @param options The options parameters.
- */
- commitBlockList(blocks, options) {
- const operationArguments = {
- blocks,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, commitBlockListOperationSpec);
- }
- /**
- * The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block
- * blob
- * @param listType Specifies whether to return the list of committed blocks, the list of uncommitted
- * blocks, or both lists together.
- * @param options The options parameters.
- */
- getBlockList(listType, options) {
- const operationArguments = {
- listType,
- options: coreHttp__namespace.operationOptionsToRequestOptionsBase(options || {})
- };
- return this.client.sendOperationRequest(operationArguments, getBlockListOperationSpec);
- }
-}
-// Operation Specifications
-const xmlSerializer = new coreHttp__namespace.Serializer(Mappers, /* isXml */ true);
-const serializer = new coreHttp__namespace.Serializer(Mappers, /* isXml */ false);
-const uploadOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: BlockBlobUploadHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlockBlobUploadExceptionHeaders
- }
- },
- requestBody: body1,
- queryParameters: [timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- contentLength,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- blobCacheControl,
- blobContentType,
- blobContentMD5,
- blobContentEncoding,
- blobContentLanguage,
- blobContentDisposition,
- immutabilityPolicyExpiry,
- immutabilityPolicyMode,
- encryptionScope,
- tier,
- blobTagsString,
- legalHold1,
- transactionalContentMD5,
- transactionalContentCrc64,
- contentType1,
- accept2,
- blobType2
- ],
- mediaType: "binary",
- serializer
-};
-const putBlobFromUrlOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: BlockBlobPutBlobFromUrlHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlockBlobPutBlobFromUrlExceptionHeaders
- }
- },
- queryParameters: [timeoutInSeconds],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- contentLength,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- blobCacheControl,
- blobContentType,
- blobContentMD5,
- blobContentEncoding,
- blobContentLanguage,
- blobContentDisposition,
- encryptionScope,
- tier,
- sourceIfModifiedSince,
- sourceIfUnmodifiedSince,
- sourceIfMatch,
- sourceIfNoneMatch,
- sourceIfTags,
- copySource,
- blobTagsString,
- sourceContentMD5,
- copySourceAuthorization,
- copySourceTags,
- transactionalContentMD5,
- blobType2,
- copySourceBlobProperties
- ],
- isXML: true,
- serializer: xmlSerializer
-};
-const stageBlockOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: BlockBlobStageBlockHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlockBlobStageBlockExceptionHeaders
- }
- },
- requestBody: body1,
- queryParameters: [
- timeoutInSeconds,
- comp24,
- blockId
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- contentLength,
- leaseId,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- encryptionScope,
- transactionalContentMD5,
- transactionalContentCrc64,
- contentType1,
- accept2
- ],
- mediaType: "binary",
- serializer
-};
-const stageBlockFromURLOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: BlockBlobStageBlockFromURLHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlockBlobStageBlockFromURLExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- comp24,
- blockId
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- contentLength,
- leaseId,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- encryptionScope,
- sourceIfModifiedSince,
- sourceIfUnmodifiedSince,
- sourceIfMatch,
- sourceIfNoneMatch,
- sourceContentMD5,
- copySourceAuthorization,
- sourceUrl,
- sourceContentCrc64,
- sourceRange1
- ],
- isXML: true,
- serializer: xmlSerializer
-};
-const commitBlockListOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "PUT",
- responses: {
- 201: {
- headersMapper: BlockBlobCommitBlockListHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlockBlobCommitBlockListExceptionHeaders
- }
- },
- requestBody: blocks,
- queryParameters: [timeoutInSeconds, comp25],
- urlParameters: [url],
- headerParameters: [
- contentType,
- accept,
- version,
- requestId,
- metadata,
- leaseId,
- ifModifiedSince,
- ifUnmodifiedSince,
- encryptionKey,
- encryptionKeySha256,
- encryptionAlgorithm,
- ifMatch,
- ifNoneMatch,
- ifTags,
- blobCacheControl,
- blobContentType,
- blobContentMD5,
- blobContentEncoding,
- blobContentLanguage,
- blobContentDisposition,
- immutabilityPolicyExpiry,
- immutabilityPolicyMode,
- encryptionScope,
- tier,
- blobTagsString,
- legalHold1,
- transactionalContentMD5,
- transactionalContentCrc64
- ],
- isXML: true,
- contentType: "application/xml; charset=utf-8",
- mediaType: "xml",
- serializer: xmlSerializer
-};
-const getBlockListOperationSpec = {
- path: "/{containerName}/{blob}",
- httpMethod: "GET",
- responses: {
- 200: {
- bodyMapper: BlockList,
- headersMapper: BlockBlobGetBlockListHeaders
- },
- default: {
- bodyMapper: StorageError,
- headersMapper: BlockBlobGetBlockListExceptionHeaders
- }
- },
- queryParameters: [
- timeoutInSeconds,
- snapshot,
- comp25,
- listType
- ],
- urlParameters: [url],
- headerParameters: [
- version,
- requestId,
- accept1,
- leaseId,
- ifTags
- ],
- isXML: true,
- serializer: xmlSerializer
-};
-
-// Copyright (c) Microsoft Corporation.
-/**
- * The `@azure/logger` configuration for this package.
- */
-const logger = logger$1.createClientLogger("storage-blob");
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-const SDK_VERSION = "12.17.0";
-const SERVICE_VERSION = "2023-11-03";
-const BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES = 256 * 1024 * 1024; // 256MB
-const BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES = 4000 * 1024 * 1024; // 4000MB
-const BLOCK_BLOB_MAX_BLOCKS = 50000;
-const DEFAULT_BLOCK_BUFFER_SIZE_BYTES = 8 * 1024 * 1024; // 8MB
-const DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES = 4 * 1024 * 1024; // 4MB
-const DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS = 5;
-const REQUEST_TIMEOUT = 100 * 1000; // In ms
-/**
- * The OAuth scope to use with Azure Storage.
- */
-const StorageOAuthScopes = "https://storage.azure.com/.default";
-const URLConstants = {
- Parameters: {
- FORCE_BROWSER_NO_CACHE: "_",
- SIGNATURE: "sig",
- SNAPSHOT: "snapshot",
- VERSIONID: "versionid",
- TIMEOUT: "timeout",
- },
-};
-const HTTPURLConnection = {
- HTTP_ACCEPTED: 202,
- HTTP_CONFLICT: 409,
- HTTP_NOT_FOUND: 404,
- HTTP_PRECON_FAILED: 412,
- HTTP_RANGE_NOT_SATISFIABLE: 416,
-};
-const HeaderConstants = {
- AUTHORIZATION: "Authorization",
- AUTHORIZATION_SCHEME: "Bearer",
- CONTENT_ENCODING: "Content-Encoding",
- CONTENT_ID: "Content-ID",
- CONTENT_LANGUAGE: "Content-Language",
- CONTENT_LENGTH: "Content-Length",
- CONTENT_MD5: "Content-Md5",
- CONTENT_TRANSFER_ENCODING: "Content-Transfer-Encoding",
- CONTENT_TYPE: "Content-Type",
- COOKIE: "Cookie",
- DATE: "date",
- IF_MATCH: "if-match",
- IF_MODIFIED_SINCE: "if-modified-since",
- IF_NONE_MATCH: "if-none-match",
- IF_UNMODIFIED_SINCE: "if-unmodified-since",
- PREFIX_FOR_STORAGE: "x-ms-",
- RANGE: "Range",
- USER_AGENT: "User-Agent",
- X_MS_CLIENT_REQUEST_ID: "x-ms-client-request-id",
- X_MS_COPY_SOURCE: "x-ms-copy-source",
- X_MS_DATE: "x-ms-date",
- X_MS_ERROR_CODE: "x-ms-error-code",
- X_MS_VERSION: "x-ms-version",
-};
-const ETagNone = "";
-const ETagAny = "*";
-const SIZE_1_MB = 1 * 1024 * 1024;
-const BATCH_MAX_REQUEST = 256;
-const BATCH_MAX_PAYLOAD_IN_BYTES = 4 * SIZE_1_MB;
-const HTTP_LINE_ENDING = "\r\n";
-const HTTP_VERSION_1_1 = "HTTP/1.1";
-const EncryptionAlgorithmAES25 = "AES256";
-const DevelopmentConnectionString = `DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;`;
-const StorageBlobLoggingAllowedHeaderNames = [
- "Access-Control-Allow-Origin",
- "Cache-Control",
- "Content-Length",
- "Content-Type",
- "Date",
- "Request-Id",
- "traceparent",
- "Transfer-Encoding",
- "User-Agent",
- "x-ms-client-request-id",
- "x-ms-date",
- "x-ms-error-code",
- "x-ms-request-id",
- "x-ms-return-client-request-id",
- "x-ms-version",
- "Accept-Ranges",
- "Content-Disposition",
- "Content-Encoding",
- "Content-Language",
- "Content-MD5",
- "Content-Range",
- "ETag",
- "Last-Modified",
- "Server",
- "Vary",
- "x-ms-content-crc64",
- "x-ms-copy-action",
- "x-ms-copy-completion-time",
- "x-ms-copy-id",
- "x-ms-copy-progress",
- "x-ms-copy-status",
- "x-ms-has-immutability-policy",
- "x-ms-has-legal-hold",
- "x-ms-lease-state",
- "x-ms-lease-status",
- "x-ms-range",
- "x-ms-request-server-encrypted",
- "x-ms-server-encrypted",
- "x-ms-snapshot",
- "x-ms-source-range",
- "If-Match",
- "If-Modified-Since",
- "If-None-Match",
- "If-Unmodified-Since",
- "x-ms-access-tier",
- "x-ms-access-tier-change-time",
- "x-ms-access-tier-inferred",
- "x-ms-account-kind",
- "x-ms-archive-status",
- "x-ms-blob-append-offset",
- "x-ms-blob-cache-control",
- "x-ms-blob-committed-block-count",
- "x-ms-blob-condition-appendpos",
- "x-ms-blob-condition-maxsize",
- "x-ms-blob-content-disposition",
- "x-ms-blob-content-encoding",
- "x-ms-blob-content-language",
- "x-ms-blob-content-length",
- "x-ms-blob-content-md5",
- "x-ms-blob-content-type",
- "x-ms-blob-public-access",
- "x-ms-blob-sequence-number",
- "x-ms-blob-type",
- "x-ms-copy-destination-snapshot",
- "x-ms-creation-time",
- "x-ms-default-encryption-scope",
- "x-ms-delete-snapshots",
- "x-ms-delete-type-permanent",
- "x-ms-deny-encryption-scope-override",
- "x-ms-encryption-algorithm",
- "x-ms-if-sequence-number-eq",
- "x-ms-if-sequence-number-le",
- "x-ms-if-sequence-number-lt",
- "x-ms-incremental-copy",
- "x-ms-lease-action",
- "x-ms-lease-break-period",
- "x-ms-lease-duration",
- "x-ms-lease-id",
- "x-ms-lease-time",
- "x-ms-page-write",
- "x-ms-proposed-lease-id",
- "x-ms-range-get-content-md5",
- "x-ms-rehydrate-priority",
- "x-ms-sequence-number-action",
- "x-ms-sku-name",
- "x-ms-source-content-md5",
- "x-ms-source-if-match",
- "x-ms-source-if-modified-since",
- "x-ms-source-if-none-match",
- "x-ms-source-if-unmodified-since",
- "x-ms-tag-count",
- "x-ms-encryption-key-sha256",
- "x-ms-if-tags",
- "x-ms-source-if-tags",
-];
-const StorageBlobLoggingAllowedQueryParameters = [
- "comp",
- "maxresults",
- "rscc",
- "rscd",
- "rsce",
- "rscl",
- "rsct",
- "se",
- "si",
- "sip",
- "sp",
- "spr",
- "sr",
- "srt",
- "ss",
- "st",
- "sv",
- "include",
- "marker",
- "prefix",
- "copyid",
- "restype",
- "blockid",
- "blocklisttype",
- "delimiter",
- "prevsnapshot",
- "ske",
- "skoid",
- "sks",
- "skt",
- "sktid",
- "skv",
- "snapshot",
-];
-const BlobUsesCustomerSpecifiedEncryptionMsg = "BlobUsesCustomerSpecifiedEncryption";
-const BlobDoesNotUseCustomerSpecifiedEncryption = "BlobDoesNotUseCustomerSpecifiedEncryption";
-/// List of ports used for path style addressing.
-/// Path style addressing means that storage account is put in URI's Path segment in instead of in host.
-const PathStylePorts = [
- "10000",
- "10001",
- "10002",
- "10003",
- "10004",
- "10100",
- "10101",
- "10102",
- "10103",
- "10104",
- "11000",
- "11001",
- "11002",
- "11003",
- "11004",
- "11100",
- "11101",
- "11102",
- "11103",
- "11104",
-];
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Reserved URL characters must be properly escaped for Storage services like Blob or File.
- *
- * ## URL encode and escape strategy for JS SDKs
- *
- * When customers pass a URL string into XxxClient classes constructor, the URL string may already be URL encoded or not.
- * But before sending to Azure Storage server, the URL must be encoded. However, it's hard for a SDK to guess whether the URL
- * string has been encoded or not. We have 2 potential strategies, and chose strategy two for the XxxClient constructors.
- *
- * ### Strategy One: Assume the customer URL string is not encoded, and always encode URL string in SDK.
- *
- * This is what legacy V2 SDK does, simple and works for most of the cases.
- * - When customer URL string is "http://account.blob.core.windows.net/con/b:",
- * SDK will encode it to "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
- * - When customer URL string is "http://account.blob.core.windows.net/con/b%3A",
- * SDK will encode it to "http://account.blob.core.windows.net/con/b%253A" and send to server. A blob named "b%3A" will be created.
- *
- * But this strategy will make it not possible to create a blob with "?" in it's name. Because when customer URL string is
- * "http://account.blob.core.windows.net/con/blob?name", the "?name" will be treated as URL paramter instead of blob name.
- * If customer URL string is "http://account.blob.core.windows.net/con/blob%3Fname", a blob named "blob%3Fname" will be created.
- * V2 SDK doesn't have this issue because it doesn't allow customer pass in a full URL, it accepts a separate blob name and encodeURIComponent for it.
- * We cannot accept a SDK cannot create a blob name with "?". So we implement strategy two:
- *
- * ### Strategy Two: SDK doesn't assume the URL has been encoded or not. It will just escape the special characters.
- *
- * This is what V10 Blob Go SDK does. It accepts a URL type in Go, and call url.EscapedPath() to escape the special chars unescaped.
- * - When customer URL string is "http://account.blob.core.windows.net/con/b:",
- * SDK will escape ":" like "http://account.blob.core.windows.net/con/b%3A" and send to server. A blob named "b:" will be created.
- * - When customer URL string is "http://account.blob.core.windows.net/con/b%3A",
- * There is no special characters, so send "http://account.blob.core.windows.net/con/b%3A" to server. A blob named "b:" will be created.
- * - When customer URL string is "http://account.blob.core.windows.net/con/b%253A",
- * There is no special characters, so send "http://account.blob.core.windows.net/con/b%253A" to server. A blob named "b%3A" will be created.
- *
- * This strategy gives us flexibility to create with any special characters. But "%" will be treated as a special characters, if the URL string
- * is not encoded, there shouldn't a "%" in the URL string, otherwise the URL is not a valid URL.
- * If customer needs to create a blob with "%" in it's blob name, use "%25" instead of "%". Just like above 3rd sample.
- * And following URL strings are invalid:
- * - "http://account.blob.core.windows.net/con/b%"
- * - "http://account.blob.core.windows.net/con/b%2"
- * - "http://account.blob.core.windows.net/con/b%G"
- *
- * Another special character is "?", use "%2F" to represent a blob name with "?" in a URL string.
- *
- * ### Strategy for containerName, blobName or other specific XXXName parameters in methods such as `containerClient.getBlobClient(blobName)`
- *
- * We will apply strategy one, and call encodeURIComponent for these parameters like blobName. Because what customers passes in is a plain name instead of a URL.
- *
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/naming-and-referencing-shares--directories--files--and-metadata
- *
- * @param url -
- */
-function escapeURLPath(url) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- let path = urlParsed.getPath();
- path = path || "/";
- path = escape(path);
- urlParsed.setPath(path);
- return urlParsed.toString();
-}
-function getProxyUriFromDevConnString(connectionString) {
- // Development Connection String
- // https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string#connect-to-the-emulator-account-using-the-well-known-account-name-and-key
- let proxyUri = "";
- if (connectionString.search("DevelopmentStorageProxyUri=") !== -1) {
- // CONNECTION_STRING=UseDevelopmentStorage=true;DevelopmentStorageProxyUri=http://myProxyUri
- const matchCredentials = connectionString.split(";");
- for (const element of matchCredentials) {
- if (element.trim().startsWith("DevelopmentStorageProxyUri=")) {
- proxyUri = element.trim().match("DevelopmentStorageProxyUri=(.*)")[1];
- }
- }
- }
- return proxyUri;
-}
-function getValueInConnString(connectionString, argument) {
- const elements = connectionString.split(";");
- for (const element of elements) {
- if (element.trim().startsWith(argument)) {
- return element.trim().match(argument + "=(.*)")[1];
- }
- }
- return "";
-}
-/**
- * Extracts the parts of an Azure Storage account connection string.
- *
- * @param connectionString - Connection string.
- * @returns String key value pairs of the storage account's url and credentials.
- */
-function extractConnectionStringParts(connectionString) {
- let proxyUri = "";
- if (connectionString.startsWith("UseDevelopmentStorage=true")) {
- // Development connection string
- proxyUri = getProxyUriFromDevConnString(connectionString);
- connectionString = DevelopmentConnectionString;
- }
- // Matching BlobEndpoint in the Account connection string
- let blobEndpoint = getValueInConnString(connectionString, "BlobEndpoint");
- // Slicing off '/' at the end if exists
- // (The methods that use `extractConnectionStringParts` expect the url to not have `/` at the end)
- blobEndpoint = blobEndpoint.endsWith("/") ? blobEndpoint.slice(0, -1) : blobEndpoint;
- if (connectionString.search("DefaultEndpointsProtocol=") !== -1 &&
- connectionString.search("AccountKey=") !== -1) {
- // Account connection string
- let defaultEndpointsProtocol = "";
- let accountName = "";
- let accountKey = Buffer.from("accountKey", "base64");
- let endpointSuffix = "";
- // Get account name and key
- accountName = getValueInConnString(connectionString, "AccountName");
- accountKey = Buffer.from(getValueInConnString(connectionString, "AccountKey"), "base64");
- if (!blobEndpoint) {
- // BlobEndpoint is not present in the Account connection string
- // Can be obtained from `${defaultEndpointsProtocol}://${accountName}.blob.${endpointSuffix}`
- defaultEndpointsProtocol = getValueInConnString(connectionString, "DefaultEndpointsProtocol");
- const protocol = defaultEndpointsProtocol.toLowerCase();
- if (protocol !== "https" && protocol !== "http") {
- throw new Error("Invalid DefaultEndpointsProtocol in the provided Connection String. Expecting 'https' or 'http'");
- }
- endpointSuffix = getValueInConnString(connectionString, "EndpointSuffix");
- if (!endpointSuffix) {
- throw new Error("Invalid EndpointSuffix in the provided Connection String");
- }
- blobEndpoint = `${defaultEndpointsProtocol}://${accountName}.blob.${endpointSuffix}`;
- }
- if (!accountName) {
- throw new Error("Invalid AccountName in the provided Connection String");
- }
- else if (accountKey.length === 0) {
- throw new Error("Invalid AccountKey in the provided Connection String");
- }
- return {
- kind: "AccountConnString",
- url: blobEndpoint,
- accountName,
- accountKey,
- proxyUri,
- };
- }
- else {
- // SAS connection string
- const accountSas = getValueInConnString(connectionString, "SharedAccessSignature");
- let accountName = getValueInConnString(connectionString, "AccountName");
- // if accountName is empty, try to read it from BlobEndpoint
- if (!accountName) {
- accountName = getAccountNameFromUrl(blobEndpoint);
- }
- if (!blobEndpoint) {
- throw new Error("Invalid BlobEndpoint in the provided SAS Connection String");
- }
- else if (!accountSas) {
- throw new Error("Invalid SharedAccessSignature in the provided SAS Connection String");
- }
- return { kind: "SASConnString", url: blobEndpoint, accountName, accountSas };
- }
-}
-/**
- * Internal escape method implemented Strategy Two mentioned in escapeURL() description.
- *
- * @param text -
- */
-function escape(text) {
- return encodeURIComponent(text)
- .replace(/%2F/g, "/") // Don't escape for "/"
- .replace(/'/g, "%27") // Escape for "'"
- .replace(/\+/g, "%20")
- .replace(/%25/g, "%"); // Revert encoded "%"
-}
-/**
- * Append a string to URL path. Will remove duplicated "/" in front of the string
- * when URL path ends with a "/".
- *
- * @param url - Source URL string
- * @param name - String to be appended to URL
- * @returns An updated URL string
- */
-function appendToURLPath(url, name) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- let path = urlParsed.getPath();
- path = path ? (path.endsWith("/") ? `${path}${name}` : `${path}/${name}`) : name;
- urlParsed.setPath(path);
- const normalizedUrl = new URL(urlParsed.toString());
- return normalizedUrl.toString();
-}
-/**
- * Set URL parameter name and value. If name exists in URL parameters, old value
- * will be replaced by name key. If not provide value, the parameter will be deleted.
- *
- * @param url - Source URL string
- * @param name - Parameter name
- * @param value - Parameter value
- * @returns An updated URL string
- */
-function setURLParameter(url, name, value) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- urlParsed.setQueryParameter(name, value);
- return urlParsed.toString();
-}
-/**
- * Get URL parameter by name.
- *
- * @param url -
- * @param name -
- */
-function getURLParameter(url, name) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- return urlParsed.getQueryParameterValue(name);
-}
-/**
- * Set URL host.
- *
- * @param url - Source URL string
- * @param host - New host string
- * @returns An updated URL string
- */
-function setURLHost(url, host) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- urlParsed.setHost(host);
- return urlParsed.toString();
-}
-/**
- * Get URL path from an URL string.
- *
- * @param url - Source URL string
- */
-function getURLPath(url) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- return urlParsed.getPath();
-}
-/**
- * Get URL scheme from an URL string.
- *
- * @param url - Source URL string
- */
-function getURLScheme(url) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- return urlParsed.getScheme();
-}
-/**
- * Get URL path and query from an URL string.
- *
- * @param url - Source URL string
- */
-function getURLPathAndQuery(url) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- const pathString = urlParsed.getPath();
- if (!pathString) {
- throw new RangeError("Invalid url without valid path.");
- }
- let queryString = urlParsed.getQuery() || "";
- queryString = queryString.trim();
- if (queryString !== "") {
- queryString = queryString.startsWith("?") ? queryString : `?${queryString}`; // Ensure query string start with '?'
- }
- return `${pathString}${queryString}`;
-}
-/**
- * Get URL query key value pairs from an URL string.
- *
- * @param url -
- */
-function getURLQueries(url) {
- let queryString = coreHttp.URLBuilder.parse(url).getQuery();
- if (!queryString) {
- return {};
- }
- queryString = queryString.trim();
- queryString = queryString.startsWith("?") ? queryString.substr(1) : queryString;
- let querySubStrings = queryString.split("&");
- querySubStrings = querySubStrings.filter((value) => {
- const indexOfEqual = value.indexOf("=");
- const lastIndexOfEqual = value.lastIndexOf("=");
- return (indexOfEqual > 0 && indexOfEqual === lastIndexOfEqual && lastIndexOfEqual < value.length - 1);
- });
- const queries = {};
- for (const querySubString of querySubStrings) {
- const splitResults = querySubString.split("=");
- const key = splitResults[0];
- const value = splitResults[1];
- queries[key] = value;
- }
- return queries;
-}
-/**
- * Append a string to URL query.
- *
- * @param url - Source URL string.
- * @param queryParts - String to be appended to the URL query.
- * @returns An updated URL string.
- */
-function appendToURLQuery(url, queryParts) {
- const urlParsed = coreHttp.URLBuilder.parse(url);
- let query = urlParsed.getQuery();
- if (query) {
- query += "&" + queryParts;
- }
- else {
- query = queryParts;
- }
- urlParsed.setQuery(query);
- return urlParsed.toString();
-}
-/**
- * Rounds a date off to seconds.
- *
- * @param date -
- * @param withMilliseconds - If true, YYYY-MM-DDThh:mm:ss.fffffffZ will be returned;
- * If false, YYYY-MM-DDThh:mm:ssZ will be returned.
- * @returns Date string in ISO8061 format, with or without 7 milliseconds component
- */
-function truncatedISO8061Date(date, withMilliseconds = true) {
- // Date.toISOString() will return like "2018-10-29T06:34:36.139Z"
- const dateString = date.toISOString();
- return withMilliseconds
- ? dateString.substring(0, dateString.length - 1) + "0000" + "Z"
- : dateString.substring(0, dateString.length - 5) + "Z";
-}
-/**
- * Base64 encode.
- *
- * @param content -
- */
-function base64encode(content) {
- return !coreHttp.isNode ? btoa(content) : Buffer.from(content).toString("base64");
-}
-/**
- * Generate a 64 bytes base64 block ID string.
- *
- * @param blockIndex -
- */
-function generateBlockID(blockIDPrefix, blockIndex) {
- // To generate a 64 bytes base64 string, source string should be 48
- const maxSourceStringLength = 48;
- // A blob can have a maximum of 100,000 uncommitted blocks at any given time
- const maxBlockIndexLength = 6;
- const maxAllowedBlockIDPrefixLength = maxSourceStringLength - maxBlockIndexLength;
- if (blockIDPrefix.length > maxAllowedBlockIDPrefixLength) {
- blockIDPrefix = blockIDPrefix.slice(0, maxAllowedBlockIDPrefixLength);
- }
- const res = blockIDPrefix +
- padStart(blockIndex.toString(), maxSourceStringLength - blockIDPrefix.length, "0");
- return base64encode(res);
-}
-/**
- * Delay specified time interval.
- *
- * @param timeInMs -
- * @param aborter -
- * @param abortError -
- */
-async function delay(timeInMs, aborter, abortError) {
- return new Promise((resolve, reject) => {
- /* eslint-disable-next-line prefer-const */
- let timeout;
- const abortHandler = () => {
- if (timeout !== undefined) {
- clearTimeout(timeout);
- }
- reject(abortError);
- };
- const resolveHandler = () => {
- if (aborter !== undefined) {
- aborter.removeEventListener("abort", abortHandler);
- }
- resolve();
- };
- timeout = setTimeout(resolveHandler, timeInMs);
- if (aborter !== undefined) {
- aborter.addEventListener("abort", abortHandler);
- }
- });
-}
-/**
- * String.prototype.padStart()
- *
- * @param currentString -
- * @param targetLength -
- * @param padString -
- */
-function padStart(currentString, targetLength, padString = " ") {
- // @ts-expect-error: TS doesn't know this code needs to run downlevel sometimes
- if (String.prototype.padStart) {
- return currentString.padStart(targetLength, padString);
- }
- padString = padString || " ";
- if (currentString.length > targetLength) {
- return currentString;
- }
- else {
- targetLength = targetLength - currentString.length;
- if (targetLength > padString.length) {
- padString += padString.repeat(targetLength / padString.length);
- }
- return padString.slice(0, targetLength) + currentString;
- }
-}
-/**
- * If two strings are equal when compared case insensitive.
- *
- * @param str1 -
- * @param str2 -
- */
-function iEqual(str1, str2) {
- return str1.toLocaleLowerCase() === str2.toLocaleLowerCase();
-}
-/**
- * Extracts account name from the url
- * @param url - url to extract the account name from
- * @returns with the account name
- */
-function getAccountNameFromUrl(url) {
- const parsedUrl = coreHttp.URLBuilder.parse(url);
- let accountName;
- try {
- if (parsedUrl.getHost().split(".")[1] === "blob") {
- // `${defaultEndpointsProtocol}://${accountName}.blob.${endpointSuffix}`;
- accountName = parsedUrl.getHost().split(".")[0];
- }
- else if (isIpEndpointStyle(parsedUrl)) {
- // IPv4/IPv6 address hosts... Example - http://192.0.0.10:10001/devstoreaccount1/
- // Single word domain without a [dot] in the endpoint... Example - http://localhost:10001/devstoreaccount1/
- // .getPath() -> /devstoreaccount1/
- accountName = parsedUrl.getPath().split("/")[1];
- }
- else {
- // Custom domain case: "https://customdomain.com/containername/blob".
- accountName = "";
- }
- return accountName;
- }
- catch (error) {
- throw new Error("Unable to extract accountName with provided information.");
- }
-}
-function isIpEndpointStyle(parsedUrl) {
- if (parsedUrl.getHost() === undefined) {
- return false;
- }
- const host = parsedUrl.getHost() + (parsedUrl.getPort() === undefined ? "" : ":" + parsedUrl.getPort());
- // Case 1: Ipv6, use a broad regex to find out candidates whose host contains two ':'.
- // Case 2: localhost(:port) or host.docker.internal, use broad regex to match port part.
- // Case 3: Ipv4, use broad regex which just check if host contains Ipv4.
- // For valid host please refer to https://man7.org/linux/man-pages/man7/hostname.7.html.
- return (/^.*:.*:.*$|^(localhost|host.docker.internal)(:[0-9]+)?$|^(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.(\d|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])){3}(:[0-9]+)?$/.test(host) ||
- (parsedUrl.getPort() !== undefined && PathStylePorts.includes(parsedUrl.getPort())));
-}
-/**
- * Convert Tags to encoded string.
- *
- * @param tags -
- */
-function toBlobTagsString(tags) {
- if (tags === undefined) {
- return undefined;
- }
- const tagPairs = [];
- for (const key in tags) {
- if (Object.prototype.hasOwnProperty.call(tags, key)) {
- const value = tags[key];
- tagPairs.push(`${encodeURIComponent(key)}=${encodeURIComponent(value)}`);
- }
- }
- return tagPairs.join("&");
-}
-/**
- * Convert Tags type to BlobTags.
- *
- * @param tags -
- */
-function toBlobTags(tags) {
- if (tags === undefined) {
- return undefined;
- }
- const res = {
- blobTagSet: [],
- };
- for (const key in tags) {
- if (Object.prototype.hasOwnProperty.call(tags, key)) {
- const value = tags[key];
- res.blobTagSet.push({
- key,
- value,
- });
- }
- }
- return res;
-}
-/**
- * Covert BlobTags to Tags type.
- *
- * @param tags -
- */
-function toTags(tags) {
- if (tags === undefined) {
- return undefined;
- }
- const res = {};
- for (const blobTag of tags.blobTagSet) {
- res[blobTag.key] = blobTag.value;
- }
- return res;
-}
-/**
- * Convert BlobQueryTextConfiguration to QuerySerialization type.
- *
- * @param textConfiguration -
- */
-function toQuerySerialization(textConfiguration) {
- if (textConfiguration === undefined) {
- return undefined;
- }
- switch (textConfiguration.kind) {
- case "csv":
- return {
- format: {
- type: "delimited",
- delimitedTextConfiguration: {
- columnSeparator: textConfiguration.columnSeparator || ",",
- fieldQuote: textConfiguration.fieldQuote || "",
- recordSeparator: textConfiguration.recordSeparator,
- escapeChar: textConfiguration.escapeCharacter || "",
- headersPresent: textConfiguration.hasHeaders || false,
+const DelimitedTextConfiguration = {
+ serializedName: "DelimitedTextConfiguration",
+ xmlName: "DelimitedTextConfiguration",
+ type: {
+ name: "Composite",
+ className: "DelimitedTextConfiguration",
+ modelProperties: {
+ columnSeparator: {
+ serializedName: "ColumnSeparator",
+ xmlName: "ColumnSeparator",
+ type: {
+ name: "String",
+ },
+ },
+ fieldQuote: {
+ serializedName: "FieldQuote",
+ xmlName: "FieldQuote",
+ type: {
+ name: "String",
+ },
+ },
+ recordSeparator: {
+ serializedName: "RecordSeparator",
+ xmlName: "RecordSeparator",
+ type: {
+ name: "String",
+ },
+ },
+ escapeChar: {
+ serializedName: "EscapeChar",
+ xmlName: "EscapeChar",
+ type: {
+ name: "String",
+ },
+ },
+ headersPresent: {
+ serializedName: "HeadersPresent",
+ xmlName: "HasHeaders",
+ type: {
+ name: "Boolean",
+ },
+ },
+ },
+ },
+};
+const JsonTextConfiguration = {
+ serializedName: "JsonTextConfiguration",
+ xmlName: "JsonTextConfiguration",
+ type: {
+ name: "Composite",
+ className: "JsonTextConfiguration",
+ modelProperties: {
+ recordSeparator: {
+ serializedName: "RecordSeparator",
+ xmlName: "RecordSeparator",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ArrowConfiguration = {
+ serializedName: "ArrowConfiguration",
+ xmlName: "ArrowConfiguration",
+ type: {
+ name: "Composite",
+ className: "ArrowConfiguration",
+ modelProperties: {
+ schema: {
+ serializedName: "Schema",
+ required: true,
+ xmlName: "Schema",
+ xmlIsWrapped: true,
+ xmlElementName: "Field",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "ArrowField",
+ },
},
},
- };
- case "json":
- return {
- format: {
- type: "json",
- jsonTextConfiguration: {
- recordSeparator: textConfiguration.recordSeparator,
- },
+ },
+ },
+ },
+};
+const ArrowField = {
+ serializedName: "ArrowField",
+ xmlName: "Field",
+ type: {
+ name: "Composite",
+ className: "ArrowField",
+ modelProperties: {
+ type: {
+ serializedName: "Type",
+ required: true,
+ xmlName: "Type",
+ type: {
+ name: "String",
+ },
+ },
+ name: {
+ serializedName: "Name",
+ xmlName: "Name",
+ type: {
+ name: "String",
+ },
+ },
+ precision: {
+ serializedName: "Precision",
+ xmlName: "Precision",
+ type: {
+ name: "Number",
+ },
+ },
+ scale: {
+ serializedName: "Scale",
+ xmlName: "Scale",
+ type: {
+ name: "Number",
+ },
+ },
+ },
+ },
+};
+const ServiceSetPropertiesHeaders = {
+ serializedName: "Service_setPropertiesHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceSetPropertiesHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceSetPropertiesExceptionHeaders = {
+ serializedName: "Service_setPropertiesExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceSetPropertiesExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceGetPropertiesHeaders = {
+ serializedName: "Service_getPropertiesHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceGetPropertiesHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceGetPropertiesExceptionHeaders = {
+ serializedName: "Service_getPropertiesExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceGetPropertiesExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceGetStatisticsHeaders = {
+ serializedName: "Service_getStatisticsHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceGetStatisticsHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceGetStatisticsExceptionHeaders = {
+ serializedName: "Service_getStatisticsExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceGetStatisticsExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceListContainersSegmentHeaders = {
+ serializedName: "Service_listContainersSegmentHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceListContainersSegmentHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceListContainersSegmentExceptionHeaders = {
+ serializedName: "Service_listContainersSegmentExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceListContainersSegmentExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceGetUserDelegationKeyHeaders = {
+ serializedName: "Service_getUserDelegationKeyHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceGetUserDelegationKeyHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceGetUserDelegationKeyExceptionHeaders = {
+ serializedName: "Service_getUserDelegationKeyExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceGetUserDelegationKeyExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceGetAccountInfoHeaders = {
+ serializedName: "Service_getAccountInfoHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceGetAccountInfoHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ skuName: {
+ serializedName: "x-ms-sku-name",
+ xmlName: "x-ms-sku-name",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "Standard_LRS",
+ "Standard_GRS",
+ "Standard_RAGRS",
+ "Standard_ZRS",
+ "Premium_LRS",
+ ],
+ },
+ },
+ accountKind: {
+ serializedName: "x-ms-account-kind",
+ xmlName: "x-ms-account-kind",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "Storage",
+ "BlobStorage",
+ "StorageV2",
+ "FileStorage",
+ "BlockBlobStorage",
+ ],
+ },
+ },
+ isHierarchicalNamespaceEnabled: {
+ serializedName: "x-ms-is-hns-enabled",
+ xmlName: "x-ms-is-hns-enabled",
+ type: {
+ name: "Boolean",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceGetAccountInfoExceptionHeaders = {
+ serializedName: "Service_getAccountInfoExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceGetAccountInfoExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceSubmitBatchHeaders = {
+ serializedName: "Service_submitBatchHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceSubmitBatchHeaders",
+ modelProperties: {
+ contentType: {
+ serializedName: "content-type",
+ xmlName: "content-type",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceSubmitBatchExceptionHeaders = {
+ serializedName: "Service_submitBatchExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceSubmitBatchExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceFilterBlobsHeaders = {
+ serializedName: "Service_filterBlobsHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceFilterBlobsHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ServiceFilterBlobsExceptionHeaders = {
+ serializedName: "Service_filterBlobsExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ServiceFilterBlobsExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerCreateHeaders = {
+ serializedName: "Container_createHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerCreateHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerCreateExceptionHeaders = {
+ serializedName: "Container_createExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerCreateExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerGetPropertiesHeaders = {
+ serializedName: "Container_getPropertiesHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerGetPropertiesHeaders",
+ modelProperties: {
+ metadata: {
+ serializedName: "x-ms-meta",
+ headerCollectionPrefix: "x-ms-meta-",
+ xmlName: "x-ms-meta",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ leaseDuration: {
+ serializedName: "x-ms-lease-duration",
+ xmlName: "x-ms-lease-duration",
+ type: {
+ name: "Enum",
+ allowedValues: ["infinite", "fixed"],
+ },
+ },
+ leaseState: {
+ serializedName: "x-ms-lease-state",
+ xmlName: "x-ms-lease-state",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken",
+ ],
+ },
+ },
+ leaseStatus: {
+ serializedName: "x-ms-lease-status",
+ xmlName: "x-ms-lease-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["locked", "unlocked"],
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ blobPublicAccess: {
+ serializedName: "x-ms-blob-public-access",
+ xmlName: "x-ms-blob-public-access",
+ type: {
+ name: "Enum",
+ allowedValues: ["container", "blob"],
+ },
+ },
+ hasImmutabilityPolicy: {
+ serializedName: "x-ms-has-immutability-policy",
+ xmlName: "x-ms-has-immutability-policy",
+ type: {
+ name: "Boolean",
+ },
+ },
+ hasLegalHold: {
+ serializedName: "x-ms-has-legal-hold",
+ xmlName: "x-ms-has-legal-hold",
+ type: {
+ name: "Boolean",
+ },
+ },
+ defaultEncryptionScope: {
+ serializedName: "x-ms-default-encryption-scope",
+ xmlName: "x-ms-default-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ denyEncryptionScopeOverride: {
+ serializedName: "x-ms-deny-encryption-scope-override",
+ xmlName: "x-ms-deny-encryption-scope-override",
+ type: {
+ name: "Boolean",
+ },
+ },
+ isImmutableStorageWithVersioningEnabled: {
+ serializedName: "x-ms-immutable-storage-with-versioning-enabled",
+ xmlName: "x-ms-immutable-storage-with-versioning-enabled",
+ type: {
+ name: "Boolean",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerGetPropertiesExceptionHeaders = {
+ serializedName: "Container_getPropertiesExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerGetPropertiesExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerDeleteHeaders = {
+ serializedName: "Container_deleteHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerDeleteHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerDeleteExceptionHeaders = {
+ serializedName: "Container_deleteExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerDeleteExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerSetMetadataHeaders = {
+ serializedName: "Container_setMetadataHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerSetMetadataHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerSetMetadataExceptionHeaders = {
+ serializedName: "Container_setMetadataExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerSetMetadataExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerGetAccessPolicyHeaders = {
+ serializedName: "Container_getAccessPolicyHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerGetAccessPolicyHeaders",
+ modelProperties: {
+ blobPublicAccess: {
+ serializedName: "x-ms-blob-public-access",
+ xmlName: "x-ms-blob-public-access",
+ type: {
+ name: "Enum",
+ allowedValues: ["container", "blob"],
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerGetAccessPolicyExceptionHeaders = {
+ serializedName: "Container_getAccessPolicyExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerGetAccessPolicyExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerSetAccessPolicyHeaders = {
+ serializedName: "Container_setAccessPolicyHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerSetAccessPolicyHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerSetAccessPolicyExceptionHeaders = {
+ serializedName: "Container_setAccessPolicyExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerSetAccessPolicyExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerRestoreHeaders = {
+ serializedName: "Container_restoreHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerRestoreHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerRestoreExceptionHeaders = {
+ serializedName: "Container_restoreExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerRestoreExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerRenameHeaders = {
+ serializedName: "Container_renameHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerRenameHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerRenameExceptionHeaders = {
+ serializedName: "Container_renameExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerRenameExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerSubmitBatchHeaders = {
+ serializedName: "Container_submitBatchHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerSubmitBatchHeaders",
+ modelProperties: {
+ contentType: {
+ serializedName: "content-type",
+ xmlName: "content-type",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerSubmitBatchExceptionHeaders = {
+ serializedName: "Container_submitBatchExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerSubmitBatchExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerFilterBlobsHeaders = {
+ serializedName: "Container_filterBlobsHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerFilterBlobsHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const ContainerFilterBlobsExceptionHeaders = {
+ serializedName: "Container_filterBlobsExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerFilterBlobsExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerAcquireLeaseHeaders = {
+ serializedName: "Container_acquireLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerAcquireLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ leaseId: {
+ serializedName: "x-ms-lease-id",
+ xmlName: "x-ms-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const ContainerAcquireLeaseExceptionHeaders = {
+ serializedName: "Container_acquireLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerAcquireLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerReleaseLeaseHeaders = {
+ serializedName: "Container_releaseLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerReleaseLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const ContainerReleaseLeaseExceptionHeaders = {
+ serializedName: "Container_releaseLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerReleaseLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerRenewLeaseHeaders = {
+ serializedName: "Container_renewLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerRenewLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ leaseId: {
+ serializedName: "x-ms-lease-id",
+ xmlName: "x-ms-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const ContainerRenewLeaseExceptionHeaders = {
+ serializedName: "Container_renewLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerRenewLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerBreakLeaseHeaders = {
+ serializedName: "Container_breakLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerBreakLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ leaseTime: {
+ serializedName: "x-ms-lease-time",
+ xmlName: "x-ms-lease-time",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const ContainerBreakLeaseExceptionHeaders = {
+ serializedName: "Container_breakLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerBreakLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerChangeLeaseHeaders = {
+ serializedName: "Container_changeLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerChangeLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ leaseId: {
+ serializedName: "x-ms-lease-id",
+ xmlName: "x-ms-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const ContainerChangeLeaseExceptionHeaders = {
+ serializedName: "Container_changeLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerChangeLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerListBlobFlatSegmentHeaders = {
+ serializedName: "Container_listBlobFlatSegmentHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerListBlobFlatSegmentHeaders",
+ modelProperties: {
+ contentType: {
+ serializedName: "content-type",
+ xmlName: "content-type",
+ type: {
+ name: "String",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerListBlobFlatSegmentExceptionHeaders = {
+ serializedName: "Container_listBlobFlatSegmentExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerListBlobFlatSegmentExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerListBlobHierarchySegmentHeaders = {
+ serializedName: "Container_listBlobHierarchySegmentHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerListBlobHierarchySegmentHeaders",
+ modelProperties: {
+ contentType: {
+ serializedName: "content-type",
+ xmlName: "content-type",
+ type: {
+ name: "String",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerListBlobHierarchySegmentExceptionHeaders = {
+ serializedName: "Container_listBlobHierarchySegmentExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerListBlobHierarchySegmentExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const ContainerGetAccountInfoHeaders = {
+ serializedName: "Container_getAccountInfoHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerGetAccountInfoHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ skuName: {
+ serializedName: "x-ms-sku-name",
+ xmlName: "x-ms-sku-name",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "Standard_LRS",
+ "Standard_GRS",
+ "Standard_RAGRS",
+ "Standard_ZRS",
+ "Premium_LRS",
+ ],
+ },
+ },
+ accountKind: {
+ serializedName: "x-ms-account-kind",
+ xmlName: "x-ms-account-kind",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "Storage",
+ "BlobStorage",
+ "StorageV2",
+ "FileStorage",
+ "BlockBlobStorage",
+ ],
+ },
+ },
+ isHierarchicalNamespaceEnabled: {
+ serializedName: "x-ms-is-hns-enabled",
+ xmlName: "x-ms-is-hns-enabled",
+ type: {
+ name: "Boolean",
+ },
+ },
+ },
+ },
+};
+const ContainerGetAccountInfoExceptionHeaders = {
+ serializedName: "Container_getAccountInfoExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "ContainerGetAccountInfoExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobDownloadHeaders = {
+ serializedName: "Blob_downloadHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobDownloadHeaders",
+ modelProperties: {
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ createdOn: {
+ serializedName: "x-ms-creation-time",
+ xmlName: "x-ms-creation-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ metadata: {
+ serializedName: "x-ms-meta",
+ headerCollectionPrefix: "x-ms-meta-",
+ xmlName: "x-ms-meta",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+ objectReplicationPolicyId: {
+ serializedName: "x-ms-or-policy-id",
+ xmlName: "x-ms-or-policy-id",
+ type: {
+ name: "String",
+ },
+ },
+ objectReplicationRules: {
+ serializedName: "x-ms-or",
+ headerCollectionPrefix: "x-ms-or-",
+ xmlName: "x-ms-or",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+ contentLength: {
+ serializedName: "content-length",
+ xmlName: "content-length",
+ type: {
+ name: "Number",
+ },
+ },
+ contentType: {
+ serializedName: "content-type",
+ xmlName: "content-type",
+ type: {
+ name: "String",
+ },
+ },
+ contentRange: {
+ serializedName: "content-range",
+ xmlName: "content-range",
+ type: {
+ name: "String",
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ contentEncoding: {
+ serializedName: "content-encoding",
+ xmlName: "content-encoding",
+ type: {
+ name: "String",
+ },
+ },
+ cacheControl: {
+ serializedName: "cache-control",
+ xmlName: "cache-control",
+ type: {
+ name: "String",
+ },
+ },
+ contentDisposition: {
+ serializedName: "content-disposition",
+ xmlName: "content-disposition",
+ type: {
+ name: "String",
+ },
+ },
+ contentLanguage: {
+ serializedName: "content-language",
+ xmlName: "content-language",
+ type: {
+ name: "String",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ blobType: {
+ serializedName: "x-ms-blob-type",
+ xmlName: "x-ms-blob-type",
+ type: {
+ name: "Enum",
+ allowedValues: ["BlockBlob", "PageBlob", "AppendBlob"],
+ },
+ },
+ copyCompletedOn: {
+ serializedName: "x-ms-copy-completion-time",
+ xmlName: "x-ms-copy-completion-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ copyStatusDescription: {
+ serializedName: "x-ms-copy-status-description",
+ xmlName: "x-ms-copy-status-description",
+ type: {
+ name: "String",
+ },
+ },
+ copyId: {
+ serializedName: "x-ms-copy-id",
+ xmlName: "x-ms-copy-id",
+ type: {
+ name: "String",
+ },
+ },
+ copyProgress: {
+ serializedName: "x-ms-copy-progress",
+ xmlName: "x-ms-copy-progress",
+ type: {
+ name: "String",
+ },
+ },
+ copySource: {
+ serializedName: "x-ms-copy-source",
+ xmlName: "x-ms-copy-source",
+ type: {
+ name: "String",
+ },
+ },
+ copyStatus: {
+ serializedName: "x-ms-copy-status",
+ xmlName: "x-ms-copy-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["pending", "success", "aborted", "failed"],
+ },
+ },
+ leaseDuration: {
+ serializedName: "x-ms-lease-duration",
+ xmlName: "x-ms-lease-duration",
+ type: {
+ name: "Enum",
+ allowedValues: ["infinite", "fixed"],
+ },
+ },
+ leaseState: {
+ serializedName: "x-ms-lease-state",
+ xmlName: "x-ms-lease-state",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken",
+ ],
+ },
+ },
+ leaseStatus: {
+ serializedName: "x-ms-lease-status",
+ xmlName: "x-ms-lease-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["locked", "unlocked"],
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ isCurrentVersion: {
+ serializedName: "x-ms-is-current-version",
+ xmlName: "x-ms-is-current-version",
+ type: {
+ name: "Boolean",
+ },
+ },
+ acceptRanges: {
+ serializedName: "accept-ranges",
+ xmlName: "accept-ranges",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ blobCommittedBlockCount: {
+ serializedName: "x-ms-blob-committed-block-count",
+ xmlName: "x-ms-blob-committed-block-count",
+ type: {
+ name: "Number",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-server-encrypted",
+ xmlName: "x-ms-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ blobContentMD5: {
+ serializedName: "x-ms-blob-content-md5",
+ xmlName: "x-ms-blob-content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ tagCount: {
+ serializedName: "x-ms-tag-count",
+ xmlName: "x-ms-tag-count",
+ type: {
+ name: "Number",
+ },
+ },
+ isSealed: {
+ serializedName: "x-ms-blob-sealed",
+ xmlName: "x-ms-blob-sealed",
+ type: {
+ name: "Boolean",
+ },
+ },
+ lastAccessed: {
+ serializedName: "x-ms-last-access-time",
+ xmlName: "x-ms-last-access-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ immutabilityPolicyExpiresOn: {
+ serializedName: "x-ms-immutability-policy-until-date",
+ xmlName: "x-ms-immutability-policy-until-date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ immutabilityPolicyMode: {
+ serializedName: "x-ms-immutability-policy-mode",
+ xmlName: "x-ms-immutability-policy-mode",
+ type: {
+ name: "Enum",
+ allowedValues: ["Mutable", "Unlocked", "Locked"],
+ },
+ },
+ legalHold: {
+ serializedName: "x-ms-legal-hold",
+ xmlName: "x-ms-legal-hold",
+ type: {
+ name: "Boolean",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ contentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ },
+ },
+};
+const BlobDownloadExceptionHeaders = {
+ serializedName: "Blob_downloadExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobDownloadExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobGetPropertiesHeaders = {
+ serializedName: "Blob_getPropertiesHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobGetPropertiesHeaders",
+ modelProperties: {
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ createdOn: {
+ serializedName: "x-ms-creation-time",
+ xmlName: "x-ms-creation-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ metadata: {
+ serializedName: "x-ms-meta",
+ headerCollectionPrefix: "x-ms-meta-",
+ xmlName: "x-ms-meta",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+ objectReplicationPolicyId: {
+ serializedName: "x-ms-or-policy-id",
+ xmlName: "x-ms-or-policy-id",
+ type: {
+ name: "String",
+ },
+ },
+ objectReplicationRules: {
+ serializedName: "x-ms-or",
+ headerCollectionPrefix: "x-ms-or-",
+ xmlName: "x-ms-or",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+ blobType: {
+ serializedName: "x-ms-blob-type",
+ xmlName: "x-ms-blob-type",
+ type: {
+ name: "Enum",
+ allowedValues: ["BlockBlob", "PageBlob", "AppendBlob"],
+ },
+ },
+ copyCompletedOn: {
+ serializedName: "x-ms-copy-completion-time",
+ xmlName: "x-ms-copy-completion-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ copyStatusDescription: {
+ serializedName: "x-ms-copy-status-description",
+ xmlName: "x-ms-copy-status-description",
+ type: {
+ name: "String",
+ },
+ },
+ copyId: {
+ serializedName: "x-ms-copy-id",
+ xmlName: "x-ms-copy-id",
+ type: {
+ name: "String",
+ },
+ },
+ copyProgress: {
+ serializedName: "x-ms-copy-progress",
+ xmlName: "x-ms-copy-progress",
+ type: {
+ name: "String",
+ },
+ },
+ copySource: {
+ serializedName: "x-ms-copy-source",
+ xmlName: "x-ms-copy-source",
+ type: {
+ name: "String",
+ },
+ },
+ copyStatus: {
+ serializedName: "x-ms-copy-status",
+ xmlName: "x-ms-copy-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["pending", "success", "aborted", "failed"],
+ },
+ },
+ isIncrementalCopy: {
+ serializedName: "x-ms-incremental-copy",
+ xmlName: "x-ms-incremental-copy",
+ type: {
+ name: "Boolean",
+ },
+ },
+ destinationSnapshot: {
+ serializedName: "x-ms-copy-destination-snapshot",
+ xmlName: "x-ms-copy-destination-snapshot",
+ type: {
+ name: "String",
+ },
+ },
+ leaseDuration: {
+ serializedName: "x-ms-lease-duration",
+ xmlName: "x-ms-lease-duration",
+ type: {
+ name: "Enum",
+ allowedValues: ["infinite", "fixed"],
+ },
+ },
+ leaseState: {
+ serializedName: "x-ms-lease-state",
+ xmlName: "x-ms-lease-state",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken",
+ ],
+ },
+ },
+ leaseStatus: {
+ serializedName: "x-ms-lease-status",
+ xmlName: "x-ms-lease-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["locked", "unlocked"],
+ },
+ },
+ contentLength: {
+ serializedName: "content-length",
+ xmlName: "content-length",
+ type: {
+ name: "Number",
+ },
+ },
+ contentType: {
+ serializedName: "content-type",
+ xmlName: "content-type",
+ type: {
+ name: "String",
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ contentEncoding: {
+ serializedName: "content-encoding",
+ xmlName: "content-encoding",
+ type: {
+ name: "String",
+ },
+ },
+ contentDisposition: {
+ serializedName: "content-disposition",
+ xmlName: "content-disposition",
+ type: {
+ name: "String",
+ },
+ },
+ contentLanguage: {
+ serializedName: "content-language",
+ xmlName: "content-language",
+ type: {
+ name: "String",
+ },
+ },
+ cacheControl: {
+ serializedName: "cache-control",
+ xmlName: "cache-control",
+ type: {
+ name: "String",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ acceptRanges: {
+ serializedName: "accept-ranges",
+ xmlName: "accept-ranges",
+ type: {
+ name: "String",
+ },
+ },
+ blobCommittedBlockCount: {
+ serializedName: "x-ms-blob-committed-block-count",
+ xmlName: "x-ms-blob-committed-block-count",
+ type: {
+ name: "Number",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-server-encrypted",
+ xmlName: "x-ms-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ accessTier: {
+ serializedName: "x-ms-access-tier",
+ xmlName: "x-ms-access-tier",
+ type: {
+ name: "String",
+ },
+ },
+ accessTierInferred: {
+ serializedName: "x-ms-access-tier-inferred",
+ xmlName: "x-ms-access-tier-inferred",
+ type: {
+ name: "Boolean",
+ },
+ },
+ archiveStatus: {
+ serializedName: "x-ms-archive-status",
+ xmlName: "x-ms-archive-status",
+ type: {
+ name: "String",
+ },
+ },
+ accessTierChangedOn: {
+ serializedName: "x-ms-access-tier-change-time",
+ xmlName: "x-ms-access-tier-change-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ isCurrentVersion: {
+ serializedName: "x-ms-is-current-version",
+ xmlName: "x-ms-is-current-version",
+ type: {
+ name: "Boolean",
+ },
+ },
+ tagCount: {
+ serializedName: "x-ms-tag-count",
+ xmlName: "x-ms-tag-count",
+ type: {
+ name: "Number",
+ },
+ },
+ expiresOn: {
+ serializedName: "x-ms-expiry-time",
+ xmlName: "x-ms-expiry-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isSealed: {
+ serializedName: "x-ms-blob-sealed",
+ xmlName: "x-ms-blob-sealed",
+ type: {
+ name: "Boolean",
+ },
+ },
+ rehydratePriority: {
+ serializedName: "x-ms-rehydrate-priority",
+ xmlName: "x-ms-rehydrate-priority",
+ type: {
+ name: "Enum",
+ allowedValues: ["High", "Standard"],
+ },
+ },
+ lastAccessed: {
+ serializedName: "x-ms-last-access-time",
+ xmlName: "x-ms-last-access-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ immutabilityPolicyExpiresOn: {
+ serializedName: "x-ms-immutability-policy-until-date",
+ xmlName: "x-ms-immutability-policy-until-date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ immutabilityPolicyMode: {
+ serializedName: "x-ms-immutability-policy-mode",
+ xmlName: "x-ms-immutability-policy-mode",
+ type: {
+ name: "Enum",
+ allowedValues: ["Mutable", "Unlocked", "Locked"],
+ },
+ },
+ legalHold: {
+ serializedName: "x-ms-legal-hold",
+ xmlName: "x-ms-legal-hold",
+ type: {
+ name: "Boolean",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobGetPropertiesExceptionHeaders = {
+ serializedName: "Blob_getPropertiesExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobGetPropertiesExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobDeleteHeaders = {
+ serializedName: "Blob_deleteHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobDeleteHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobDeleteExceptionHeaders = {
+ serializedName: "Blob_deleteExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobDeleteExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobUndeleteHeaders = {
+ serializedName: "Blob_undeleteHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobUndeleteHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobUndeleteExceptionHeaders = {
+ serializedName: "Blob_undeleteExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobUndeleteExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetExpiryHeaders = {
+ serializedName: "Blob_setExpiryHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetExpiryHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const BlobSetExpiryExceptionHeaders = {
+ serializedName: "Blob_setExpiryExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetExpiryExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetHttpHeadersHeaders = {
+ serializedName: "Blob_setHttpHeadersHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetHttpHeadersHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetHttpHeadersExceptionHeaders = {
+ serializedName: "Blob_setHttpHeadersExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetHttpHeadersExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetImmutabilityPolicyHeaders = {
+ serializedName: "Blob_setImmutabilityPolicyHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetImmutabilityPolicyHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ immutabilityPolicyExpiry: {
+ serializedName: "x-ms-immutability-policy-until-date",
+ xmlName: "x-ms-immutability-policy-until-date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ immutabilityPolicyMode: {
+ serializedName: "x-ms-immutability-policy-mode",
+ xmlName: "x-ms-immutability-policy-mode",
+ type: {
+ name: "Enum",
+ allowedValues: ["Mutable", "Unlocked", "Locked"],
+ },
+ },
+ },
+ },
+};
+const BlobSetImmutabilityPolicyExceptionHeaders = {
+ serializedName: "Blob_setImmutabilityPolicyExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetImmutabilityPolicyExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobDeleteImmutabilityPolicyHeaders = {
+ serializedName: "Blob_deleteImmutabilityPolicyHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobDeleteImmutabilityPolicyHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const BlobDeleteImmutabilityPolicyExceptionHeaders = {
+ serializedName: "Blob_deleteImmutabilityPolicyExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobDeleteImmutabilityPolicyExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetLegalHoldHeaders = {
+ serializedName: "Blob_setLegalHoldHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetLegalHoldHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ legalHold: {
+ serializedName: "x-ms-legal-hold",
+ xmlName: "x-ms-legal-hold",
+ type: {
+ name: "Boolean",
+ },
+ },
+ },
+ },
+};
+const BlobSetLegalHoldExceptionHeaders = {
+ serializedName: "Blob_setLegalHoldExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetLegalHoldExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetMetadataHeaders = {
+ serializedName: "Blob_setMetadataHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetMetadataHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetMetadataExceptionHeaders = {
+ serializedName: "Blob_setMetadataExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetMetadataExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobAcquireLeaseHeaders = {
+ serializedName: "Blob_acquireLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobAcquireLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ leaseId: {
+ serializedName: "x-ms-lease-id",
+ xmlName: "x-ms-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const BlobAcquireLeaseExceptionHeaders = {
+ serializedName: "Blob_acquireLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobAcquireLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobReleaseLeaseHeaders = {
+ serializedName: "Blob_releaseLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobReleaseLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const BlobReleaseLeaseExceptionHeaders = {
+ serializedName: "Blob_releaseLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobReleaseLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobRenewLeaseHeaders = {
+ serializedName: "Blob_renewLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobRenewLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ leaseId: {
+ serializedName: "x-ms-lease-id",
+ xmlName: "x-ms-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const BlobRenewLeaseExceptionHeaders = {
+ serializedName: "Blob_renewLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobRenewLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobChangeLeaseHeaders = {
+ serializedName: "Blob_changeLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobChangeLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ leaseId: {
+ serializedName: "x-ms-lease-id",
+ xmlName: "x-ms-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const BlobChangeLeaseExceptionHeaders = {
+ serializedName: "Blob_changeLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobChangeLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobBreakLeaseHeaders = {
+ serializedName: "Blob_breakLeaseHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobBreakLeaseHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ leaseTime: {
+ serializedName: "x-ms-lease-time",
+ xmlName: "x-ms-lease-time",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ },
+ },
+};
+const BlobBreakLeaseExceptionHeaders = {
+ serializedName: "Blob_breakLeaseExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobBreakLeaseExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobCreateSnapshotHeaders = {
+ serializedName: "Blob_createSnapshotHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobCreateSnapshotHeaders",
+ modelProperties: {
+ snapshot: {
+ serializedName: "x-ms-snapshot",
+ xmlName: "x-ms-snapshot",
+ type: {
+ name: "String",
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobCreateSnapshotExceptionHeaders = {
+ serializedName: "Blob_createSnapshotExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobCreateSnapshotExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobStartCopyFromURLHeaders = {
+ serializedName: "Blob_startCopyFromURLHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobStartCopyFromURLHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ copyId: {
+ serializedName: "x-ms-copy-id",
+ xmlName: "x-ms-copy-id",
+ type: {
+ name: "String",
+ },
+ },
+ copyStatus: {
+ serializedName: "x-ms-copy-status",
+ xmlName: "x-ms-copy-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["pending", "success", "aborted", "failed"],
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobStartCopyFromURLExceptionHeaders = {
+ serializedName: "Blob_startCopyFromURLExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobStartCopyFromURLExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobCopyFromURLHeaders = {
+ serializedName: "Blob_copyFromURLHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobCopyFromURLHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ copyId: {
+ serializedName: "x-ms-copy-id",
+ xmlName: "x-ms-copy-id",
+ type: {
+ name: "String",
+ },
+ },
+ copyStatus: {
+ defaultValue: "success",
+ isConstant: true,
+ serializedName: "x-ms-copy-status",
+ type: {
+ name: "String",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobCopyFromURLExceptionHeaders = {
+ serializedName: "Blob_copyFromURLExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobCopyFromURLExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobAbortCopyFromURLHeaders = {
+ serializedName: "Blob_abortCopyFromURLHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobAbortCopyFromURLHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobAbortCopyFromURLExceptionHeaders = {
+ serializedName: "Blob_abortCopyFromURLExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobAbortCopyFromURLExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetTierHeaders = {
+ serializedName: "Blob_setTierHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetTierHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetTierExceptionHeaders = {
+ serializedName: "Blob_setTierExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetTierExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobGetAccountInfoHeaders = {
+ serializedName: "Blob_getAccountInfoHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobGetAccountInfoHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ skuName: {
+ serializedName: "x-ms-sku-name",
+ xmlName: "x-ms-sku-name",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "Standard_LRS",
+ "Standard_GRS",
+ "Standard_RAGRS",
+ "Standard_ZRS",
+ "Premium_LRS",
+ ],
+ },
+ },
+ accountKind: {
+ serializedName: "x-ms-account-kind",
+ xmlName: "x-ms-account-kind",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "Storage",
+ "BlobStorage",
+ "StorageV2",
+ "FileStorage",
+ "BlockBlobStorage",
+ ],
+ },
+ },
+ isHierarchicalNamespaceEnabled: {
+ serializedName: "x-ms-is-hns-enabled",
+ xmlName: "x-ms-is-hns-enabled",
+ type: {
+ name: "Boolean",
+ },
+ },
+ },
+ },
+};
+const BlobGetAccountInfoExceptionHeaders = {
+ serializedName: "Blob_getAccountInfoExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobGetAccountInfoExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobQueryHeaders = {
+ serializedName: "Blob_queryHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobQueryHeaders",
+ modelProperties: {
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ metadata: {
+ serializedName: "x-ms-meta",
+ headerCollectionPrefix: "x-ms-meta-",
+ xmlName: "x-ms-meta",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+ contentLength: {
+ serializedName: "content-length",
+ xmlName: "content-length",
+ type: {
+ name: "Number",
+ },
+ },
+ contentType: {
+ serializedName: "content-type",
+ xmlName: "content-type",
+ type: {
+ name: "String",
+ },
+ },
+ contentRange: {
+ serializedName: "content-range",
+ xmlName: "content-range",
+ type: {
+ name: "String",
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ contentEncoding: {
+ serializedName: "content-encoding",
+ xmlName: "content-encoding",
+ type: {
+ name: "String",
+ },
+ },
+ cacheControl: {
+ serializedName: "cache-control",
+ xmlName: "cache-control",
+ type: {
+ name: "String",
+ },
+ },
+ contentDisposition: {
+ serializedName: "content-disposition",
+ xmlName: "content-disposition",
+ type: {
+ name: "String",
+ },
+ },
+ contentLanguage: {
+ serializedName: "content-language",
+ xmlName: "content-language",
+ type: {
+ name: "String",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ blobType: {
+ serializedName: "x-ms-blob-type",
+ xmlName: "x-ms-blob-type",
+ type: {
+ name: "Enum",
+ allowedValues: ["BlockBlob", "PageBlob", "AppendBlob"],
+ },
+ },
+ copyCompletionTime: {
+ serializedName: "x-ms-copy-completion-time",
+ xmlName: "x-ms-copy-completion-time",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ copyStatusDescription: {
+ serializedName: "x-ms-copy-status-description",
+ xmlName: "x-ms-copy-status-description",
+ type: {
+ name: "String",
+ },
+ },
+ copyId: {
+ serializedName: "x-ms-copy-id",
+ xmlName: "x-ms-copy-id",
+ type: {
+ name: "String",
+ },
+ },
+ copyProgress: {
+ serializedName: "x-ms-copy-progress",
+ xmlName: "x-ms-copy-progress",
+ type: {
+ name: "String",
+ },
+ },
+ copySource: {
+ serializedName: "x-ms-copy-source",
+ xmlName: "x-ms-copy-source",
+ type: {
+ name: "String",
+ },
+ },
+ copyStatus: {
+ serializedName: "x-ms-copy-status",
+ xmlName: "x-ms-copy-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["pending", "success", "aborted", "failed"],
+ },
+ },
+ leaseDuration: {
+ serializedName: "x-ms-lease-duration",
+ xmlName: "x-ms-lease-duration",
+ type: {
+ name: "Enum",
+ allowedValues: ["infinite", "fixed"],
+ },
+ },
+ leaseState: {
+ serializedName: "x-ms-lease-state",
+ xmlName: "x-ms-lease-state",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "available",
+ "leased",
+ "expired",
+ "breaking",
+ "broken",
+ ],
+ },
+ },
+ leaseStatus: {
+ serializedName: "x-ms-lease-status",
+ xmlName: "x-ms-lease-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["locked", "unlocked"],
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ acceptRanges: {
+ serializedName: "accept-ranges",
+ xmlName: "accept-ranges",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ blobCommittedBlockCount: {
+ serializedName: "x-ms-blob-committed-block-count",
+ xmlName: "x-ms-blob-committed-block-count",
+ type: {
+ name: "Number",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-server-encrypted",
+ xmlName: "x-ms-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ blobContentMD5: {
+ serializedName: "x-ms-blob-content-md5",
+ xmlName: "x-ms-blob-content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ contentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ },
+ },
+};
+const BlobQueryExceptionHeaders = {
+ serializedName: "Blob_queryExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobQueryExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobGetTagsHeaders = {
+ serializedName: "Blob_getTagsHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobGetTagsHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobGetTagsExceptionHeaders = {
+ serializedName: "Blob_getTagsExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobGetTagsExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetTagsHeaders = {
+ serializedName: "Blob_setTagsHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetTagsHeaders",
+ modelProperties: {
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlobSetTagsExceptionHeaders = {
+ serializedName: "Blob_setTagsExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlobSetTagsExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobCreateHeaders = {
+ serializedName: "PageBlob_createHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobCreateHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobCreateExceptionHeaders = {
+ serializedName: "PageBlob_createExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobCreateExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobUploadPagesHeaders = {
+ serializedName: "PageBlob_uploadPagesHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobUploadPagesHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobUploadPagesExceptionHeaders = {
+ serializedName: "PageBlob_uploadPagesExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobUploadPagesExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobClearPagesHeaders = {
+ serializedName: "PageBlob_clearPagesHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobClearPagesHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobClearPagesExceptionHeaders = {
+ serializedName: "PageBlob_clearPagesExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobClearPagesExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobUploadPagesFromURLHeaders = {
+ serializedName: "PageBlob_uploadPagesFromURLHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobUploadPagesFromURLHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobUploadPagesFromURLExceptionHeaders = {
+ serializedName: "PageBlob_uploadPagesFromURLExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobUploadPagesFromURLExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobGetPageRangesHeaders = {
+ serializedName: "PageBlob_getPageRangesHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobGetPageRangesHeaders",
+ modelProperties: {
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ blobContentLength: {
+ serializedName: "x-ms-blob-content-length",
+ xmlName: "x-ms-blob-content-length",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobGetPageRangesExceptionHeaders = {
+ serializedName: "PageBlob_getPageRangesExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobGetPageRangesExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobGetPageRangesDiffHeaders = {
+ serializedName: "PageBlob_getPageRangesDiffHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobGetPageRangesDiffHeaders",
+ modelProperties: {
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ blobContentLength: {
+ serializedName: "x-ms-blob-content-length",
+ xmlName: "x-ms-blob-content-length",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobGetPageRangesDiffExceptionHeaders = {
+ serializedName: "PageBlob_getPageRangesDiffExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobGetPageRangesDiffExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobResizeHeaders = {
+ serializedName: "PageBlob_resizeHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobResizeHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobResizeExceptionHeaders = {
+ serializedName: "PageBlob_resizeExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobResizeExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobUpdateSequenceNumberHeaders = {
+ serializedName: "PageBlob_updateSequenceNumberHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobUpdateSequenceNumberHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ blobSequenceNumber: {
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobUpdateSequenceNumberExceptionHeaders = {
+ serializedName: "PageBlob_updateSequenceNumberExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobUpdateSequenceNumberExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobCopyIncrementalHeaders = {
+ serializedName: "PageBlob_copyIncrementalHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobCopyIncrementalHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ copyId: {
+ serializedName: "x-ms-copy-id",
+ xmlName: "x-ms-copy-id",
+ type: {
+ name: "String",
+ },
+ },
+ copyStatus: {
+ serializedName: "x-ms-copy-status",
+ xmlName: "x-ms-copy-status",
+ type: {
+ name: "Enum",
+ allowedValues: ["pending", "success", "aborted", "failed"],
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const PageBlobCopyIncrementalExceptionHeaders = {
+ serializedName: "PageBlob_copyIncrementalExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "PageBlobCopyIncrementalExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const AppendBlobCreateHeaders = {
+ serializedName: "AppendBlob_createHeaders",
+ type: {
+ name: "Composite",
+ className: "AppendBlobCreateHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const AppendBlobCreateExceptionHeaders = {
+ serializedName: "AppendBlob_createExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "AppendBlobCreateExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const AppendBlobAppendBlockHeaders = {
+ serializedName: "AppendBlob_appendBlockHeaders",
+ type: {
+ name: "Composite",
+ className: "AppendBlobAppendBlockHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ blobAppendOffset: {
+ serializedName: "x-ms-blob-append-offset",
+ xmlName: "x-ms-blob-append-offset",
+ type: {
+ name: "String",
+ },
+ },
+ blobCommittedBlockCount: {
+ serializedName: "x-ms-blob-committed-block-count",
+ xmlName: "x-ms-blob-committed-block-count",
+ type: {
+ name: "Number",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const AppendBlobAppendBlockExceptionHeaders = {
+ serializedName: "AppendBlob_appendBlockExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "AppendBlobAppendBlockExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const AppendBlobAppendBlockFromUrlHeaders = {
+ serializedName: "AppendBlob_appendBlockFromUrlHeaders",
+ type: {
+ name: "Composite",
+ className: "AppendBlobAppendBlockFromUrlHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ blobAppendOffset: {
+ serializedName: "x-ms-blob-append-offset",
+ xmlName: "x-ms-blob-append-offset",
+ type: {
+ name: "String",
+ },
+ },
+ blobCommittedBlockCount: {
+ serializedName: "x-ms-blob-committed-block-count",
+ xmlName: "x-ms-blob-committed-block-count",
+ type: {
+ name: "Number",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const AppendBlobAppendBlockFromUrlExceptionHeaders = {
+ serializedName: "AppendBlob_appendBlockFromUrlExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "AppendBlobAppendBlockFromUrlExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const AppendBlobSealHeaders = {
+ serializedName: "AppendBlob_sealHeaders",
+ type: {
+ name: "Composite",
+ className: "AppendBlobSealHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isSealed: {
+ serializedName: "x-ms-blob-sealed",
+ xmlName: "x-ms-blob-sealed",
+ type: {
+ name: "Boolean",
+ },
+ },
+ },
+ },
+};
+const AppendBlobSealExceptionHeaders = {
+ serializedName: "AppendBlob_sealExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "AppendBlobSealExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobUploadHeaders = {
+ serializedName: "BlockBlob_uploadHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobUploadHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobUploadExceptionHeaders = {
+ serializedName: "BlockBlob_uploadExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobUploadExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobPutBlobFromUrlHeaders = {
+ serializedName: "BlockBlob_putBlobFromUrlHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobPutBlobFromUrlHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobPutBlobFromUrlExceptionHeaders = {
+ serializedName: "BlockBlob_putBlobFromUrlExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobPutBlobFromUrlExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobStageBlockHeaders = {
+ serializedName: "BlockBlob_stageBlockHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobStageBlockHeaders",
+ modelProperties: {
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobStageBlockExceptionHeaders = {
+ serializedName: "BlockBlob_stageBlockExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobStageBlockExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobStageBlockFromURLHeaders = {
+ serializedName: "BlockBlob_stageBlockFromURLHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobStageBlockFromURLHeaders",
+ modelProperties: {
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobStageBlockFromURLExceptionHeaders = {
+ serializedName: "BlockBlob_stageBlockFromURLExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobStageBlockFromURLExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobCommitBlockListHeaders = {
+ serializedName: "BlockBlob_commitBlockListHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobCommitBlockListHeaders",
+ modelProperties: {
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
},
- };
- case "arrow":
- return {
- format: {
- type: "arrow",
- arrowConfiguration: {
- schema: textConfiguration.schema,
- },
+ },
+ contentMD5: {
+ serializedName: "content-md5",
+ xmlName: "content-md5",
+ type: {
+ name: "ByteArray",
},
- };
- case "parquet":
- return {
- format: {
- type: "parquet",
+ },
+ xMsContentCrc64: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
},
- };
- default:
- throw Error("Invalid BlobQueryTextConfiguration.");
- }
-}
-function parseObjectReplicationRecord(objectReplicationRecord) {
- if (!objectReplicationRecord) {
- return undefined;
- }
- if ("policy-id" in objectReplicationRecord) {
- // If the dictionary contains a key with policy id, we are not required to do any parsing since
- // the policy id should already be stored in the ObjectReplicationDestinationPolicyId.
- return undefined;
- }
- const orProperties = [];
- for (const key in objectReplicationRecord) {
- const ids = key.split("_");
- const policyPrefix = "or-";
- if (ids[0].startsWith(policyPrefix)) {
- ids[0] = ids[0].substring(policyPrefix.length);
- }
- const rule = {
- ruleId: ids[1],
- replicationStatus: objectReplicationRecord[key],
- };
- const policyIndex = orProperties.findIndex((policy) => policy.policyId === ids[0]);
- if (policyIndex > -1) {
- orProperties[policyIndex].rules.push(rule);
- }
- else {
- orProperties.push({
- policyId: ids[0],
- rules: [rule],
- });
- }
- }
- return orProperties;
-}
-/**
- * Attach a TokenCredential to an object.
- *
- * @param thing -
- * @param credential -
- */
-function attachCredential(thing, credential) {
- thing.credential = credential;
- return thing;
-}
-function httpAuthorizationToString(httpAuthorization) {
- return httpAuthorization ? httpAuthorization.scheme + " " + httpAuthorization.value : undefined;
-}
-function BlobNameToString(name) {
- if (name.encoded) {
- return decodeURIComponent(name.content);
- }
- else {
- return name.content;
- }
-}
-function ConvertInternalResponseOfListBlobFlat(internalResponse) {
- return Object.assign(Object.assign({}, internalResponse), { segment: {
- blobItems: internalResponse.segment.blobItems.map((blobItemInteral) => {
- const blobItem = Object.assign(Object.assign({}, blobItemInteral), { name: BlobNameToString(blobItemInteral.name) });
- return blobItem;
- }),
- } });
-}
-function ConvertInternalResponseOfListBlobHierarchy(internalResponse) {
- var _a;
- return Object.assign(Object.assign({}, internalResponse), { segment: {
- blobPrefixes: (_a = internalResponse.segment.blobPrefixes) === null || _a === void 0 ? void 0 : _a.map((blobPrefixInternal) => {
- const blobPrefix = Object.assign(Object.assign({}, blobPrefixInternal), { name: BlobNameToString(blobPrefixInternal.name) });
- return blobPrefix;
- }),
- blobItems: internalResponse.segment.blobItems.map((blobItemInteral) => {
- const blobItem = Object.assign(Object.assign({}, blobItemInteral), { name: BlobNameToString(blobItemInteral.name) });
- return blobItem;
- }),
- } });
-}
-function* ExtractPageRangeInfoItems(getPageRangesSegment) {
- let pageRange = [];
- let clearRange = [];
- if (getPageRangesSegment.pageRange)
- pageRange = getPageRangesSegment.pageRange;
- if (getPageRangesSegment.clearRange)
- clearRange = getPageRangesSegment.clearRange;
- let pageRangeIndex = 0;
- let clearRangeIndex = 0;
- while (pageRangeIndex < pageRange.length && clearRangeIndex < clearRange.length) {
- if (pageRange[pageRangeIndex].start < clearRange[clearRangeIndex].start) {
- yield {
- start: pageRange[pageRangeIndex].start,
- end: pageRange[pageRangeIndex].end,
- isClear: false,
- };
- ++pageRangeIndex;
- }
- else {
- yield {
- start: clearRange[clearRangeIndex].start,
- end: clearRange[clearRangeIndex].end,
- isClear: true,
- };
- ++clearRangeIndex;
- }
- }
- for (; pageRangeIndex < pageRange.length; ++pageRangeIndex) {
- yield {
- start: pageRange[pageRangeIndex].start,
- end: pageRange[pageRangeIndex].end,
- isClear: false,
- };
- }
- for (; clearRangeIndex < clearRange.length; ++clearRangeIndex) {
- yield {
- start: clearRange[clearRangeIndex].start,
- end: clearRange[clearRangeIndex].end,
- isClear: true,
- };
- }
-}
-/**
- * Escape the blobName but keep path separator ('/').
- */
-function EscapePath(blobName) {
- const split = blobName.split("/");
- for (let i = 0; i < split.length; i++) {
- split[i] = encodeURIComponent(split[i]);
- }
- return split.join("/");
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * StorageBrowserPolicy will handle differences between Node.js and browser runtime, including:
- *
- * 1. Browsers cache GET/HEAD requests by adding conditional headers such as 'IF_MODIFIED_SINCE'.
- * StorageBrowserPolicy is a policy used to add a timestamp query to GET/HEAD request URL
- * thus avoid the browser cache.
- *
- * 2. Remove cookie header for security
- *
- * 3. Remove content-length header to avoid browsers warning
- */
-class StorageBrowserPolicy extends coreHttp.BaseRequestPolicy {
- /**
- * Creates an instance of StorageBrowserPolicy.
- * @param nextPolicy -
- * @param options -
- */
- // The base class has a protected constructor. Adding a public one to enable constructing of this class.
- /* eslint-disable-next-line @typescript-eslint/no-useless-constructor*/
- constructor(nextPolicy, options) {
- super(nextPolicy, options);
- }
- /**
- * Sends out request.
- *
- * @param request -
- */
- async sendRequest(request) {
- if (coreHttp.isNode) {
- return this._nextPolicy.sendRequest(request);
- }
- if (request.method.toUpperCase() === "GET" || request.method.toUpperCase() === "HEAD") {
- request.url = setURLParameter(request.url, URLConstants.Parameters.FORCE_BROWSER_NO_CACHE, new Date().getTime().toString());
- }
- request.headers.remove(HeaderConstants.COOKIE);
- // According to XHR standards, content-length should be fully controlled by browsers
- request.headers.remove(HeaderConstants.CONTENT_LENGTH);
- return this._nextPolicy.sendRequest(request);
- }
-}
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ versionId: {
+ serializedName: "x-ms-version-id",
+ xmlName: "x-ms-version-id",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ isServerEncrypted: {
+ serializedName: "x-ms-request-server-encrypted",
+ xmlName: "x-ms-request-server-encrypted",
+ type: {
+ name: "Boolean",
+ },
+ },
+ encryptionKeySha256: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+ encryptionScope: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobCommitBlockListExceptionHeaders = {
+ serializedName: "BlockBlob_commitBlockListExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobCommitBlockListExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobGetBlockListHeaders = {
+ serializedName: "BlockBlob_getBlockListHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobGetBlockListHeaders",
+ modelProperties: {
+ lastModified: {
+ serializedName: "last-modified",
+ xmlName: "last-modified",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ etag: {
+ serializedName: "etag",
+ xmlName: "etag",
+ type: {
+ name: "String",
+ },
+ },
+ contentType: {
+ serializedName: "content-type",
+ xmlName: "content-type",
+ type: {
+ name: "String",
+ },
+ },
+ blobContentLength: {
+ serializedName: "x-ms-blob-content-length",
+ xmlName: "x-ms-blob-content-length",
+ type: {
+ name: "Number",
+ },
+ },
+ clientRequestId: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ requestId: {
+ serializedName: "x-ms-request-id",
+ xmlName: "x-ms-request-id",
+ type: {
+ name: "String",
+ },
+ },
+ version: {
+ serializedName: "x-ms-version",
+ xmlName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+ date: {
+ serializedName: "date",
+ xmlName: "date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
+const BlockBlobGetBlockListExceptionHeaders = {
+ serializedName: "BlockBlob_getBlockListExceptionHeaders",
+ type: {
+ name: "Composite",
+ className: "BlockBlobGetBlockListExceptionHeaders",
+ modelProperties: {
+ errorCode: {
+ serializedName: "x-ms-error-code",
+ xmlName: "x-ms-error-code",
+ type: {
+ name: "String",
+ },
+ },
+ },
+ },
+};
-// Copyright (c) Microsoft Corporation.
-/**
- * StorageBrowserPolicyFactory is a factory class helping generating StorageBrowserPolicy objects.
- */
-class StorageBrowserPolicyFactory {
- /**
- * Creates a StorageBrowserPolicyFactory object.
- *
- * @param nextPolicy -
- * @param options -
- */
- create(nextPolicy, options) {
- return new StorageBrowserPolicy(nextPolicy, options);
- }
-}
+var Mappers = /*#__PURE__*/Object.freeze({
+ __proto__: null,
+ AccessPolicy: AccessPolicy,
+ AppendBlobAppendBlockExceptionHeaders: AppendBlobAppendBlockExceptionHeaders,
+ AppendBlobAppendBlockFromUrlExceptionHeaders: AppendBlobAppendBlockFromUrlExceptionHeaders,
+ AppendBlobAppendBlockFromUrlHeaders: AppendBlobAppendBlockFromUrlHeaders,
+ AppendBlobAppendBlockHeaders: AppendBlobAppendBlockHeaders,
+ AppendBlobCreateExceptionHeaders: AppendBlobCreateExceptionHeaders,
+ AppendBlobCreateHeaders: AppendBlobCreateHeaders,
+ AppendBlobSealExceptionHeaders: AppendBlobSealExceptionHeaders,
+ AppendBlobSealHeaders: AppendBlobSealHeaders,
+ ArrowConfiguration: ArrowConfiguration,
+ ArrowField: ArrowField,
+ BlobAbortCopyFromURLExceptionHeaders: BlobAbortCopyFromURLExceptionHeaders,
+ BlobAbortCopyFromURLHeaders: BlobAbortCopyFromURLHeaders,
+ BlobAcquireLeaseExceptionHeaders: BlobAcquireLeaseExceptionHeaders,
+ BlobAcquireLeaseHeaders: BlobAcquireLeaseHeaders,
+ BlobBreakLeaseExceptionHeaders: BlobBreakLeaseExceptionHeaders,
+ BlobBreakLeaseHeaders: BlobBreakLeaseHeaders,
+ BlobChangeLeaseExceptionHeaders: BlobChangeLeaseExceptionHeaders,
+ BlobChangeLeaseHeaders: BlobChangeLeaseHeaders,
+ BlobCopyFromURLExceptionHeaders: BlobCopyFromURLExceptionHeaders,
+ BlobCopyFromURLHeaders: BlobCopyFromURLHeaders,
+ BlobCreateSnapshotExceptionHeaders: BlobCreateSnapshotExceptionHeaders,
+ BlobCreateSnapshotHeaders: BlobCreateSnapshotHeaders,
+ BlobDeleteExceptionHeaders: BlobDeleteExceptionHeaders,
+ BlobDeleteHeaders: BlobDeleteHeaders,
+ BlobDeleteImmutabilityPolicyExceptionHeaders: BlobDeleteImmutabilityPolicyExceptionHeaders,
+ BlobDeleteImmutabilityPolicyHeaders: BlobDeleteImmutabilityPolicyHeaders,
+ BlobDownloadExceptionHeaders: BlobDownloadExceptionHeaders,
+ BlobDownloadHeaders: BlobDownloadHeaders,
+ BlobFlatListSegment: BlobFlatListSegment,
+ BlobGetAccountInfoExceptionHeaders: BlobGetAccountInfoExceptionHeaders,
+ BlobGetAccountInfoHeaders: BlobGetAccountInfoHeaders,
+ BlobGetPropertiesExceptionHeaders: BlobGetPropertiesExceptionHeaders,
+ BlobGetPropertiesHeaders: BlobGetPropertiesHeaders,
+ BlobGetTagsExceptionHeaders: BlobGetTagsExceptionHeaders,
+ BlobGetTagsHeaders: BlobGetTagsHeaders,
+ BlobHierarchyListSegment: BlobHierarchyListSegment,
+ BlobItemInternal: BlobItemInternal,
+ BlobName: BlobName,
+ BlobPrefix: BlobPrefix,
+ BlobPropertiesInternal: BlobPropertiesInternal,
+ BlobQueryExceptionHeaders: BlobQueryExceptionHeaders,
+ BlobQueryHeaders: BlobQueryHeaders,
+ BlobReleaseLeaseExceptionHeaders: BlobReleaseLeaseExceptionHeaders,
+ BlobReleaseLeaseHeaders: BlobReleaseLeaseHeaders,
+ BlobRenewLeaseExceptionHeaders: BlobRenewLeaseExceptionHeaders,
+ BlobRenewLeaseHeaders: BlobRenewLeaseHeaders,
+ BlobServiceProperties: BlobServiceProperties,
+ BlobServiceStatistics: BlobServiceStatistics,
+ BlobSetExpiryExceptionHeaders: BlobSetExpiryExceptionHeaders,
+ BlobSetExpiryHeaders: BlobSetExpiryHeaders,
+ BlobSetHttpHeadersExceptionHeaders: BlobSetHttpHeadersExceptionHeaders,
+ BlobSetHttpHeadersHeaders: BlobSetHttpHeadersHeaders,
+ BlobSetImmutabilityPolicyExceptionHeaders: BlobSetImmutabilityPolicyExceptionHeaders,
+ BlobSetImmutabilityPolicyHeaders: BlobSetImmutabilityPolicyHeaders,
+ BlobSetLegalHoldExceptionHeaders: BlobSetLegalHoldExceptionHeaders,
+ BlobSetLegalHoldHeaders: BlobSetLegalHoldHeaders,
+ BlobSetMetadataExceptionHeaders: BlobSetMetadataExceptionHeaders,
+ BlobSetMetadataHeaders: BlobSetMetadataHeaders,
+ BlobSetTagsExceptionHeaders: BlobSetTagsExceptionHeaders,
+ BlobSetTagsHeaders: BlobSetTagsHeaders,
+ BlobSetTierExceptionHeaders: BlobSetTierExceptionHeaders,
+ BlobSetTierHeaders: BlobSetTierHeaders,
+ BlobStartCopyFromURLExceptionHeaders: BlobStartCopyFromURLExceptionHeaders,
+ BlobStartCopyFromURLHeaders: BlobStartCopyFromURLHeaders,
+ BlobTag: BlobTag,
+ BlobTags: BlobTags,
+ BlobUndeleteExceptionHeaders: BlobUndeleteExceptionHeaders,
+ BlobUndeleteHeaders: BlobUndeleteHeaders,
+ Block: Block,
+ BlockBlobCommitBlockListExceptionHeaders: BlockBlobCommitBlockListExceptionHeaders,
+ BlockBlobCommitBlockListHeaders: BlockBlobCommitBlockListHeaders,
+ BlockBlobGetBlockListExceptionHeaders: BlockBlobGetBlockListExceptionHeaders,
+ BlockBlobGetBlockListHeaders: BlockBlobGetBlockListHeaders,
+ BlockBlobPutBlobFromUrlExceptionHeaders: BlockBlobPutBlobFromUrlExceptionHeaders,
+ BlockBlobPutBlobFromUrlHeaders: BlockBlobPutBlobFromUrlHeaders,
+ BlockBlobStageBlockExceptionHeaders: BlockBlobStageBlockExceptionHeaders,
+ BlockBlobStageBlockFromURLExceptionHeaders: BlockBlobStageBlockFromURLExceptionHeaders,
+ BlockBlobStageBlockFromURLHeaders: BlockBlobStageBlockFromURLHeaders,
+ BlockBlobStageBlockHeaders: BlockBlobStageBlockHeaders,
+ BlockBlobUploadExceptionHeaders: BlockBlobUploadExceptionHeaders,
+ BlockBlobUploadHeaders: BlockBlobUploadHeaders,
+ BlockList: BlockList,
+ BlockLookupList: BlockLookupList,
+ ClearRange: ClearRange,
+ ContainerAcquireLeaseExceptionHeaders: ContainerAcquireLeaseExceptionHeaders,
+ ContainerAcquireLeaseHeaders: ContainerAcquireLeaseHeaders,
+ ContainerBreakLeaseExceptionHeaders: ContainerBreakLeaseExceptionHeaders,
+ ContainerBreakLeaseHeaders: ContainerBreakLeaseHeaders,
+ ContainerChangeLeaseExceptionHeaders: ContainerChangeLeaseExceptionHeaders,
+ ContainerChangeLeaseHeaders: ContainerChangeLeaseHeaders,
+ ContainerCreateExceptionHeaders: ContainerCreateExceptionHeaders,
+ ContainerCreateHeaders: ContainerCreateHeaders,
+ ContainerDeleteExceptionHeaders: ContainerDeleteExceptionHeaders,
+ ContainerDeleteHeaders: ContainerDeleteHeaders,
+ ContainerFilterBlobsExceptionHeaders: ContainerFilterBlobsExceptionHeaders,
+ ContainerFilterBlobsHeaders: ContainerFilterBlobsHeaders,
+ ContainerGetAccessPolicyExceptionHeaders: ContainerGetAccessPolicyExceptionHeaders,
+ ContainerGetAccessPolicyHeaders: ContainerGetAccessPolicyHeaders,
+ ContainerGetAccountInfoExceptionHeaders: ContainerGetAccountInfoExceptionHeaders,
+ ContainerGetAccountInfoHeaders: ContainerGetAccountInfoHeaders,
+ ContainerGetPropertiesExceptionHeaders: ContainerGetPropertiesExceptionHeaders,
+ ContainerGetPropertiesHeaders: ContainerGetPropertiesHeaders,
+ ContainerItem: ContainerItem,
+ ContainerListBlobFlatSegmentExceptionHeaders: ContainerListBlobFlatSegmentExceptionHeaders,
+ ContainerListBlobFlatSegmentHeaders: ContainerListBlobFlatSegmentHeaders,
+ ContainerListBlobHierarchySegmentExceptionHeaders: ContainerListBlobHierarchySegmentExceptionHeaders,
+ ContainerListBlobHierarchySegmentHeaders: ContainerListBlobHierarchySegmentHeaders,
+ ContainerProperties: ContainerProperties,
+ ContainerReleaseLeaseExceptionHeaders: ContainerReleaseLeaseExceptionHeaders,
+ ContainerReleaseLeaseHeaders: ContainerReleaseLeaseHeaders,
+ ContainerRenameExceptionHeaders: ContainerRenameExceptionHeaders,
+ ContainerRenameHeaders: ContainerRenameHeaders,
+ ContainerRenewLeaseExceptionHeaders: ContainerRenewLeaseExceptionHeaders,
+ ContainerRenewLeaseHeaders: ContainerRenewLeaseHeaders,
+ ContainerRestoreExceptionHeaders: ContainerRestoreExceptionHeaders,
+ ContainerRestoreHeaders: ContainerRestoreHeaders,
+ ContainerSetAccessPolicyExceptionHeaders: ContainerSetAccessPolicyExceptionHeaders,
+ ContainerSetAccessPolicyHeaders: ContainerSetAccessPolicyHeaders,
+ ContainerSetMetadataExceptionHeaders: ContainerSetMetadataExceptionHeaders,
+ ContainerSetMetadataHeaders: ContainerSetMetadataHeaders,
+ ContainerSubmitBatchExceptionHeaders: ContainerSubmitBatchExceptionHeaders,
+ ContainerSubmitBatchHeaders: ContainerSubmitBatchHeaders,
+ CorsRule: CorsRule,
+ DelimitedTextConfiguration: DelimitedTextConfiguration,
+ FilterBlobItem: FilterBlobItem,
+ FilterBlobSegment: FilterBlobSegment,
+ GeoReplication: GeoReplication,
+ JsonTextConfiguration: JsonTextConfiguration,
+ KeyInfo: KeyInfo,
+ ListBlobsFlatSegmentResponse: ListBlobsFlatSegmentResponse,
+ ListBlobsHierarchySegmentResponse: ListBlobsHierarchySegmentResponse,
+ ListContainersSegmentResponse: ListContainersSegmentResponse,
+ Logging: Logging,
+ Metrics: Metrics,
+ PageBlobClearPagesExceptionHeaders: PageBlobClearPagesExceptionHeaders,
+ PageBlobClearPagesHeaders: PageBlobClearPagesHeaders,
+ PageBlobCopyIncrementalExceptionHeaders: PageBlobCopyIncrementalExceptionHeaders,
+ PageBlobCopyIncrementalHeaders: PageBlobCopyIncrementalHeaders,
+ PageBlobCreateExceptionHeaders: PageBlobCreateExceptionHeaders,
+ PageBlobCreateHeaders: PageBlobCreateHeaders,
+ PageBlobGetPageRangesDiffExceptionHeaders: PageBlobGetPageRangesDiffExceptionHeaders,
+ PageBlobGetPageRangesDiffHeaders: PageBlobGetPageRangesDiffHeaders,
+ PageBlobGetPageRangesExceptionHeaders: PageBlobGetPageRangesExceptionHeaders,
+ PageBlobGetPageRangesHeaders: PageBlobGetPageRangesHeaders,
+ PageBlobResizeExceptionHeaders: PageBlobResizeExceptionHeaders,
+ PageBlobResizeHeaders: PageBlobResizeHeaders,
+ PageBlobUpdateSequenceNumberExceptionHeaders: PageBlobUpdateSequenceNumberExceptionHeaders,
+ PageBlobUpdateSequenceNumberHeaders: PageBlobUpdateSequenceNumberHeaders,
+ PageBlobUploadPagesExceptionHeaders: PageBlobUploadPagesExceptionHeaders,
+ PageBlobUploadPagesFromURLExceptionHeaders: PageBlobUploadPagesFromURLExceptionHeaders,
+ PageBlobUploadPagesFromURLHeaders: PageBlobUploadPagesFromURLHeaders,
+ PageBlobUploadPagesHeaders: PageBlobUploadPagesHeaders,
+ PageList: PageList,
+ PageRange: PageRange,
+ QueryFormat: QueryFormat,
+ QueryRequest: QueryRequest,
+ QuerySerialization: QuerySerialization,
+ RetentionPolicy: RetentionPolicy,
+ ServiceFilterBlobsExceptionHeaders: ServiceFilterBlobsExceptionHeaders,
+ ServiceFilterBlobsHeaders: ServiceFilterBlobsHeaders,
+ ServiceGetAccountInfoExceptionHeaders: ServiceGetAccountInfoExceptionHeaders,
+ ServiceGetAccountInfoHeaders: ServiceGetAccountInfoHeaders,
+ ServiceGetPropertiesExceptionHeaders: ServiceGetPropertiesExceptionHeaders,
+ ServiceGetPropertiesHeaders: ServiceGetPropertiesHeaders,
+ ServiceGetStatisticsExceptionHeaders: ServiceGetStatisticsExceptionHeaders,
+ ServiceGetStatisticsHeaders: ServiceGetStatisticsHeaders,
+ ServiceGetUserDelegationKeyExceptionHeaders: ServiceGetUserDelegationKeyExceptionHeaders,
+ ServiceGetUserDelegationKeyHeaders: ServiceGetUserDelegationKeyHeaders,
+ ServiceListContainersSegmentExceptionHeaders: ServiceListContainersSegmentExceptionHeaders,
+ ServiceListContainersSegmentHeaders: ServiceListContainersSegmentHeaders,
+ ServiceSetPropertiesExceptionHeaders: ServiceSetPropertiesExceptionHeaders,
+ ServiceSetPropertiesHeaders: ServiceSetPropertiesHeaders,
+ ServiceSubmitBatchExceptionHeaders: ServiceSubmitBatchExceptionHeaders,
+ ServiceSubmitBatchHeaders: ServiceSubmitBatchHeaders,
+ SignedIdentifier: SignedIdentifier,
+ StaticWebsite: StaticWebsite,
+ StorageError: StorageError,
+ UserDelegationKey: UserDelegationKey
+});
-// Copyright (c) Microsoft Corporation.
-/**
- * RetryPolicy types.
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
-exports.StorageRetryPolicyType = void 0;
-(function (StorageRetryPolicyType) {
- /**
- * Exponential retry. Retry time delay grows exponentially.
- */
- StorageRetryPolicyType[StorageRetryPolicyType["EXPONENTIAL"] = 0] = "EXPONENTIAL";
- /**
- * Linear retry. Retry time delay grows linearly.
- */
- StorageRetryPolicyType[StorageRetryPolicyType["FIXED"] = 1] = "FIXED";
-})(exports.StorageRetryPolicyType || (exports.StorageRetryPolicyType = {}));
-// Default values of StorageRetryOptions
-const DEFAULT_RETRY_OPTIONS = {
- maxRetryDelayInMs: 120 * 1000,
- maxTries: 4,
- retryDelayInMs: 4 * 1000,
- retryPolicyType: exports.StorageRetryPolicyType.EXPONENTIAL,
- secondaryHost: "",
- tryTimeoutInMs: undefined, // Use server side default timeout strategy
+const contentType = {
+ parameterPath: ["options", "contentType"],
+ mapper: {
+ defaultValue: "application/xml",
+ isConstant: true,
+ serializedName: "Content-Type",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobServiceProperties = {
+ parameterPath: "blobServiceProperties",
+ mapper: BlobServiceProperties,
+};
+const accept = {
+ parameterPath: "accept",
+ mapper: {
+ defaultValue: "application/xml",
+ isConstant: true,
+ serializedName: "Accept",
+ type: {
+ name: "String",
+ },
+ },
+};
+const url = {
+ parameterPath: "url",
+ mapper: {
+ serializedName: "url",
+ required: true,
+ xmlName: "url",
+ type: {
+ name: "String",
+ },
+ },
+ skipEncoding: true,
+};
+const restype = {
+ parameterPath: "restype",
+ mapper: {
+ defaultValue: "service",
+ isConstant: true,
+ serializedName: "restype",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "properties",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const timeoutInSeconds = {
+ parameterPath: ["options", "timeoutInSeconds"],
+ mapper: {
+ constraints: {
+ InclusiveMinimum: 0,
+ },
+ serializedName: "timeout",
+ xmlName: "timeout",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const version = {
+ parameterPath: "version",
+ mapper: {
+ defaultValue: "2024-08-04",
+ isConstant: true,
+ serializedName: "x-ms-version",
+ type: {
+ name: "String",
+ },
+ },
+};
+const requestId = {
+ parameterPath: ["options", "requestId"],
+ mapper: {
+ serializedName: "x-ms-client-request-id",
+ xmlName: "x-ms-client-request-id",
+ type: {
+ name: "String",
+ },
+ },
+};
+const accept1 = {
+ parameterPath: "accept",
+ mapper: {
+ defaultValue: "application/xml",
+ isConstant: true,
+ serializedName: "Accept",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp1 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "stats",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp2 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "list",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const prefix = {
+ parameterPath: ["options", "prefix"],
+ mapper: {
+ serializedName: "prefix",
+ xmlName: "prefix",
+ type: {
+ name: "String",
+ },
+ },
+};
+const marker = {
+ parameterPath: ["options", "marker"],
+ mapper: {
+ serializedName: "marker",
+ xmlName: "marker",
+ type: {
+ name: "String",
+ },
+ },
+};
+const maxPageSize = {
+ parameterPath: ["options", "maxPageSize"],
+ mapper: {
+ constraints: {
+ InclusiveMinimum: 1,
+ },
+ serializedName: "maxresults",
+ xmlName: "maxresults",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const include = {
+ parameterPath: ["options", "include"],
+ mapper: {
+ serializedName: "include",
+ xmlName: "include",
+ xmlElementName: "ListContainersIncludeType",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Enum",
+ allowedValues: ["metadata", "deleted", "system"],
+ },
+ },
+ },
+ },
+ collectionFormat: "CSV",
+};
+const keyInfo = {
+ parameterPath: "keyInfo",
+ mapper: KeyInfo,
+};
+const comp3 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "userdelegationkey",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const restype1 = {
+ parameterPath: "restype",
+ mapper: {
+ defaultValue: "account",
+ isConstant: true,
+ serializedName: "restype",
+ type: {
+ name: "String",
+ },
+ },
+};
+const body = {
+ parameterPath: "body",
+ mapper: {
+ serializedName: "body",
+ required: true,
+ xmlName: "body",
+ type: {
+ name: "Stream",
+ },
+ },
+};
+const comp4 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "batch",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const contentLength = {
+ parameterPath: "contentLength",
+ mapper: {
+ serializedName: "Content-Length",
+ required: true,
+ xmlName: "Content-Length",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const multipartContentType = {
+ parameterPath: "multipartContentType",
+ mapper: {
+ serializedName: "Content-Type",
+ required: true,
+ xmlName: "Content-Type",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp5 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "blobs",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const where = {
+ parameterPath: ["options", "where"],
+ mapper: {
+ serializedName: "where",
+ xmlName: "where",
+ type: {
+ name: "String",
+ },
+ },
+};
+const restype2 = {
+ parameterPath: "restype",
+ mapper: {
+ defaultValue: "container",
+ isConstant: true,
+ serializedName: "restype",
+ type: {
+ name: "String",
+ },
+ },
+};
+const metadata = {
+ parameterPath: ["options", "metadata"],
+ mapper: {
+ serializedName: "x-ms-meta",
+ xmlName: "x-ms-meta",
+ headerCollectionPrefix: "x-ms-meta-",
+ type: {
+ name: "Dictionary",
+ value: { type: { name: "String" } },
+ },
+ },
+};
+const access = {
+ parameterPath: ["options", "access"],
+ mapper: {
+ serializedName: "x-ms-blob-public-access",
+ xmlName: "x-ms-blob-public-access",
+ type: {
+ name: "Enum",
+ allowedValues: ["container", "blob"],
+ },
+ },
+};
+const defaultEncryptionScope = {
+ parameterPath: [
+ "options",
+ "containerEncryptionScope",
+ "defaultEncryptionScope",
+ ],
+ mapper: {
+ serializedName: "x-ms-default-encryption-scope",
+ xmlName: "x-ms-default-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+};
+const preventEncryptionScopeOverride = {
+ parameterPath: [
+ "options",
+ "containerEncryptionScope",
+ "preventEncryptionScopeOverride",
+ ],
+ mapper: {
+ serializedName: "x-ms-deny-encryption-scope-override",
+ xmlName: "x-ms-deny-encryption-scope-override",
+ type: {
+ name: "Boolean",
+ },
+ },
+};
+const leaseId = {
+ parameterPath: ["options", "leaseAccessConditions", "leaseId"],
+ mapper: {
+ serializedName: "x-ms-lease-id",
+ xmlName: "x-ms-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+};
+const ifModifiedSince = {
+ parameterPath: ["options", "modifiedAccessConditions", "ifModifiedSince"],
+ mapper: {
+ serializedName: "If-Modified-Since",
+ xmlName: "If-Modified-Since",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+};
+const ifUnmodifiedSince = {
+ parameterPath: ["options", "modifiedAccessConditions", "ifUnmodifiedSince"],
+ mapper: {
+ serializedName: "If-Unmodified-Since",
+ xmlName: "If-Unmodified-Since",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+};
+const comp6 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "metadata",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp7 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "acl",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const containerAcl = {
+ parameterPath: ["options", "containerAcl"],
+ mapper: {
+ serializedName: "containerAcl",
+ xmlName: "SignedIdentifiers",
+ xmlIsWrapped: true,
+ xmlElementName: "SignedIdentifier",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Composite",
+ className: "SignedIdentifier",
+ },
+ },
+ },
+ },
+};
+const comp8 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "undelete",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const deletedContainerName = {
+ parameterPath: ["options", "deletedContainerName"],
+ mapper: {
+ serializedName: "x-ms-deleted-container-name",
+ xmlName: "x-ms-deleted-container-name",
+ type: {
+ name: "String",
+ },
+ },
+};
+const deletedContainerVersion = {
+ parameterPath: ["options", "deletedContainerVersion"],
+ mapper: {
+ serializedName: "x-ms-deleted-container-version",
+ xmlName: "x-ms-deleted-container-version",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp9 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "rename",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sourceContainerName = {
+ parameterPath: "sourceContainerName",
+ mapper: {
+ serializedName: "x-ms-source-container-name",
+ required: true,
+ xmlName: "x-ms-source-container-name",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sourceLeaseId = {
+ parameterPath: ["options", "sourceLeaseId"],
+ mapper: {
+ serializedName: "x-ms-source-lease-id",
+ xmlName: "x-ms-source-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp10 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "lease",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const action = {
+ parameterPath: "action",
+ mapper: {
+ defaultValue: "acquire",
+ isConstant: true,
+ serializedName: "x-ms-lease-action",
+ type: {
+ name: "String",
+ },
+ },
+};
+const duration = {
+ parameterPath: ["options", "duration"],
+ mapper: {
+ serializedName: "x-ms-lease-duration",
+ xmlName: "x-ms-lease-duration",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const proposedLeaseId = {
+ parameterPath: ["options", "proposedLeaseId"],
+ mapper: {
+ serializedName: "x-ms-proposed-lease-id",
+ xmlName: "x-ms-proposed-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+};
+const action1 = {
+ parameterPath: "action",
+ mapper: {
+ defaultValue: "release",
+ isConstant: true,
+ serializedName: "x-ms-lease-action",
+ type: {
+ name: "String",
+ },
+ },
+};
+const leaseId1 = {
+ parameterPath: "leaseId",
+ mapper: {
+ serializedName: "x-ms-lease-id",
+ required: true,
+ xmlName: "x-ms-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+};
+const action2 = {
+ parameterPath: "action",
+ mapper: {
+ defaultValue: "renew",
+ isConstant: true,
+ serializedName: "x-ms-lease-action",
+ type: {
+ name: "String",
+ },
+ },
+};
+const action3 = {
+ parameterPath: "action",
+ mapper: {
+ defaultValue: "break",
+ isConstant: true,
+ serializedName: "x-ms-lease-action",
+ type: {
+ name: "String",
+ },
+ },
+};
+const breakPeriod = {
+ parameterPath: ["options", "breakPeriod"],
+ mapper: {
+ serializedName: "x-ms-lease-break-period",
+ xmlName: "x-ms-lease-break-period",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const action4 = {
+ parameterPath: "action",
+ mapper: {
+ defaultValue: "change",
+ isConstant: true,
+ serializedName: "x-ms-lease-action",
+ type: {
+ name: "String",
+ },
+ },
+};
+const proposedLeaseId1 = {
+ parameterPath: "proposedLeaseId",
+ mapper: {
+ serializedName: "x-ms-proposed-lease-id",
+ required: true,
+ xmlName: "x-ms-proposed-lease-id",
+ type: {
+ name: "String",
+ },
+ },
+};
+const include1 = {
+ parameterPath: ["options", "include"],
+ mapper: {
+ serializedName: "include",
+ xmlName: "include",
+ xmlElementName: "ListBlobsIncludeItem",
+ type: {
+ name: "Sequence",
+ element: {
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "copy",
+ "deleted",
+ "metadata",
+ "snapshots",
+ "uncommittedblobs",
+ "versions",
+ "tags",
+ "immutabilitypolicy",
+ "legalhold",
+ "deletedwithversions",
+ ],
+ },
+ },
+ },
+ },
+ collectionFormat: "CSV",
+};
+const delimiter = {
+ parameterPath: "delimiter",
+ mapper: {
+ serializedName: "delimiter",
+ required: true,
+ xmlName: "delimiter",
+ type: {
+ name: "String",
+ },
+ },
+};
+const snapshot = {
+ parameterPath: ["options", "snapshot"],
+ mapper: {
+ serializedName: "snapshot",
+ xmlName: "snapshot",
+ type: {
+ name: "String",
+ },
+ },
+};
+const versionId = {
+ parameterPath: ["options", "versionId"],
+ mapper: {
+ serializedName: "versionid",
+ xmlName: "versionid",
+ type: {
+ name: "String",
+ },
+ },
+};
+const range = {
+ parameterPath: ["options", "range"],
+ mapper: {
+ serializedName: "x-ms-range",
+ xmlName: "x-ms-range",
+ type: {
+ name: "String",
+ },
+ },
+};
+const rangeGetContentMD5 = {
+ parameterPath: ["options", "rangeGetContentMD5"],
+ mapper: {
+ serializedName: "x-ms-range-get-content-md5",
+ xmlName: "x-ms-range-get-content-md5",
+ type: {
+ name: "Boolean",
+ },
+ },
+};
+const rangeGetContentCRC64 = {
+ parameterPath: ["options", "rangeGetContentCRC64"],
+ mapper: {
+ serializedName: "x-ms-range-get-content-crc64",
+ xmlName: "x-ms-range-get-content-crc64",
+ type: {
+ name: "Boolean",
+ },
+ },
+};
+const encryptionKey = {
+ parameterPath: ["options", "cpkInfo", "encryptionKey"],
+ mapper: {
+ serializedName: "x-ms-encryption-key",
+ xmlName: "x-ms-encryption-key",
+ type: {
+ name: "String",
+ },
+ },
+};
+const encryptionKeySha256 = {
+ parameterPath: ["options", "cpkInfo", "encryptionKeySha256"],
+ mapper: {
+ serializedName: "x-ms-encryption-key-sha256",
+ xmlName: "x-ms-encryption-key-sha256",
+ type: {
+ name: "String",
+ },
+ },
+};
+const encryptionAlgorithm = {
+ parameterPath: ["options", "cpkInfo", "encryptionAlgorithm"],
+ mapper: {
+ serializedName: "x-ms-encryption-algorithm",
+ xmlName: "x-ms-encryption-algorithm",
+ type: {
+ name: "String",
+ },
+ },
+};
+const ifMatch = {
+ parameterPath: ["options", "modifiedAccessConditions", "ifMatch"],
+ mapper: {
+ serializedName: "If-Match",
+ xmlName: "If-Match",
+ type: {
+ name: "String",
+ },
+ },
+};
+const ifNoneMatch = {
+ parameterPath: ["options", "modifiedAccessConditions", "ifNoneMatch"],
+ mapper: {
+ serializedName: "If-None-Match",
+ xmlName: "If-None-Match",
+ type: {
+ name: "String",
+ },
+ },
+};
+const ifTags = {
+ parameterPath: ["options", "modifiedAccessConditions", "ifTags"],
+ mapper: {
+ serializedName: "x-ms-if-tags",
+ xmlName: "x-ms-if-tags",
+ type: {
+ name: "String",
+ },
+ },
+};
+const deleteSnapshots = {
+ parameterPath: ["options", "deleteSnapshots"],
+ mapper: {
+ serializedName: "x-ms-delete-snapshots",
+ xmlName: "x-ms-delete-snapshots",
+ type: {
+ name: "Enum",
+ allowedValues: ["include", "only"],
+ },
+ },
+};
+const blobDeleteType = {
+ parameterPath: ["options", "blobDeleteType"],
+ mapper: {
+ serializedName: "deletetype",
+ xmlName: "deletetype",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp11 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "expiry",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const expiryOptions = {
+ parameterPath: "expiryOptions",
+ mapper: {
+ serializedName: "x-ms-expiry-option",
+ required: true,
+ xmlName: "x-ms-expiry-option",
+ type: {
+ name: "String",
+ },
+ },
+};
+const expiresOn = {
+ parameterPath: ["options", "expiresOn"],
+ mapper: {
+ serializedName: "x-ms-expiry-time",
+ xmlName: "x-ms-expiry-time",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobCacheControl = {
+ parameterPath: ["options", "blobHttpHeaders", "blobCacheControl"],
+ mapper: {
+ serializedName: "x-ms-blob-cache-control",
+ xmlName: "x-ms-blob-cache-control",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobContentType = {
+ parameterPath: ["options", "blobHttpHeaders", "blobContentType"],
+ mapper: {
+ serializedName: "x-ms-blob-content-type",
+ xmlName: "x-ms-blob-content-type",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobContentMD5 = {
+ parameterPath: ["options", "blobHttpHeaders", "blobContentMD5"],
+ mapper: {
+ serializedName: "x-ms-blob-content-md5",
+ xmlName: "x-ms-blob-content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+};
+const blobContentEncoding = {
+ parameterPath: ["options", "blobHttpHeaders", "blobContentEncoding"],
+ mapper: {
+ serializedName: "x-ms-blob-content-encoding",
+ xmlName: "x-ms-blob-content-encoding",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobContentLanguage = {
+ parameterPath: ["options", "blobHttpHeaders", "blobContentLanguage"],
+ mapper: {
+ serializedName: "x-ms-blob-content-language",
+ xmlName: "x-ms-blob-content-language",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobContentDisposition = {
+ parameterPath: ["options", "blobHttpHeaders", "blobContentDisposition"],
+ mapper: {
+ serializedName: "x-ms-blob-content-disposition",
+ xmlName: "x-ms-blob-content-disposition",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp12 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "immutabilityPolicies",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const immutabilityPolicyExpiry = {
+ parameterPath: ["options", "immutabilityPolicyExpiry"],
+ mapper: {
+ serializedName: "x-ms-immutability-policy-until-date",
+ xmlName: "x-ms-immutability-policy-until-date",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+};
+const immutabilityPolicyMode = {
+ parameterPath: ["options", "immutabilityPolicyMode"],
+ mapper: {
+ serializedName: "x-ms-immutability-policy-mode",
+ xmlName: "x-ms-immutability-policy-mode",
+ type: {
+ name: "Enum",
+ allowedValues: ["Mutable", "Unlocked", "Locked"],
+ },
+ },
+};
+const comp13 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "legalhold",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const legalHold = {
+ parameterPath: "legalHold",
+ mapper: {
+ serializedName: "x-ms-legal-hold",
+ required: true,
+ xmlName: "x-ms-legal-hold",
+ type: {
+ name: "Boolean",
+ },
+ },
+};
+const encryptionScope = {
+ parameterPath: ["options", "encryptionScope"],
+ mapper: {
+ serializedName: "x-ms-encryption-scope",
+ xmlName: "x-ms-encryption-scope",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp14 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "snapshot",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const tier = {
+ parameterPath: ["options", "tier"],
+ mapper: {
+ serializedName: "x-ms-access-tier",
+ xmlName: "x-ms-access-tier",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "P4",
+ "P6",
+ "P10",
+ "P15",
+ "P20",
+ "P30",
+ "P40",
+ "P50",
+ "P60",
+ "P70",
+ "P80",
+ "Hot",
+ "Cool",
+ "Archive",
+ "Cold",
+ ],
+ },
+ },
+};
+const rehydratePriority = {
+ parameterPath: ["options", "rehydratePriority"],
+ mapper: {
+ serializedName: "x-ms-rehydrate-priority",
+ xmlName: "x-ms-rehydrate-priority",
+ type: {
+ name: "Enum",
+ allowedValues: ["High", "Standard"],
+ },
+ },
+};
+const sourceIfModifiedSince = {
+ parameterPath: [
+ "options",
+ "sourceModifiedAccessConditions",
+ "sourceIfModifiedSince",
+ ],
+ mapper: {
+ serializedName: "x-ms-source-if-modified-since",
+ xmlName: "x-ms-source-if-modified-since",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+};
+const sourceIfUnmodifiedSince = {
+ parameterPath: [
+ "options",
+ "sourceModifiedAccessConditions",
+ "sourceIfUnmodifiedSince",
+ ],
+ mapper: {
+ serializedName: "x-ms-source-if-unmodified-since",
+ xmlName: "x-ms-source-if-unmodified-since",
+ type: {
+ name: "DateTimeRfc1123",
+ },
+ },
+};
+const sourceIfMatch = {
+ parameterPath: ["options", "sourceModifiedAccessConditions", "sourceIfMatch"],
+ mapper: {
+ serializedName: "x-ms-source-if-match",
+ xmlName: "x-ms-source-if-match",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sourceIfNoneMatch = {
+ parameterPath: [
+ "options",
+ "sourceModifiedAccessConditions",
+ "sourceIfNoneMatch",
+ ],
+ mapper: {
+ serializedName: "x-ms-source-if-none-match",
+ xmlName: "x-ms-source-if-none-match",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sourceIfTags = {
+ parameterPath: ["options", "sourceModifiedAccessConditions", "sourceIfTags"],
+ mapper: {
+ serializedName: "x-ms-source-if-tags",
+ xmlName: "x-ms-source-if-tags",
+ type: {
+ name: "String",
+ },
+ },
+};
+const copySource = {
+ parameterPath: "copySource",
+ mapper: {
+ serializedName: "x-ms-copy-source",
+ required: true,
+ xmlName: "x-ms-copy-source",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobTagsString = {
+ parameterPath: ["options", "blobTagsString"],
+ mapper: {
+ serializedName: "x-ms-tags",
+ xmlName: "x-ms-tags",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sealBlob = {
+ parameterPath: ["options", "sealBlob"],
+ mapper: {
+ serializedName: "x-ms-seal-blob",
+ xmlName: "x-ms-seal-blob",
+ type: {
+ name: "Boolean",
+ },
+ },
+};
+const legalHold1 = {
+ parameterPath: ["options", "legalHold"],
+ mapper: {
+ serializedName: "x-ms-legal-hold",
+ xmlName: "x-ms-legal-hold",
+ type: {
+ name: "Boolean",
+ },
+ },
};
-const RETRY_ABORT_ERROR = new abortController.AbortError("The operation was aborted.");
-/**
- * Retry policy with exponential retry and linear retry implemented.
- */
-class StorageRetryPolicy extends coreHttp.BaseRequestPolicy {
- /**
- * Creates an instance of RetryPolicy.
- *
- * @param nextPolicy -
- * @param options -
- * @param retryOptions -
- */
- constructor(nextPolicy, options, retryOptions = DEFAULT_RETRY_OPTIONS) {
- super(nextPolicy, options);
- // Initialize retry options
- this.retryOptions = {
- retryPolicyType: retryOptions.retryPolicyType
- ? retryOptions.retryPolicyType
- : DEFAULT_RETRY_OPTIONS.retryPolicyType,
- maxTries: retryOptions.maxTries && retryOptions.maxTries >= 1
- ? Math.floor(retryOptions.maxTries)
- : DEFAULT_RETRY_OPTIONS.maxTries,
- tryTimeoutInMs: retryOptions.tryTimeoutInMs && retryOptions.tryTimeoutInMs >= 0
- ? retryOptions.tryTimeoutInMs
- : DEFAULT_RETRY_OPTIONS.tryTimeoutInMs,
- retryDelayInMs: retryOptions.retryDelayInMs && retryOptions.retryDelayInMs >= 0
- ? Math.min(retryOptions.retryDelayInMs, retryOptions.maxRetryDelayInMs
- ? retryOptions.maxRetryDelayInMs
- : DEFAULT_RETRY_OPTIONS.maxRetryDelayInMs)
- : DEFAULT_RETRY_OPTIONS.retryDelayInMs,
- maxRetryDelayInMs: retryOptions.maxRetryDelayInMs && retryOptions.maxRetryDelayInMs >= 0
- ? retryOptions.maxRetryDelayInMs
- : DEFAULT_RETRY_OPTIONS.maxRetryDelayInMs,
- secondaryHost: retryOptions.secondaryHost
- ? retryOptions.secondaryHost
- : DEFAULT_RETRY_OPTIONS.secondaryHost,
- };
- }
- /**
- * Sends request.
- *
- * @param request -
- */
- async sendRequest(request) {
- return this.attemptSendRequest(request, false, 1);
- }
- /**
- * Decide and perform next retry. Won't mutate request parameter.
- *
- * @param request -
- * @param secondaryHas404 - If attempt was against the secondary & it returned a StatusNotFound (404), then
- * the resource was not found. This may be due to replication delay. So, in this
- * case, we'll never try the secondary again for this operation.
- * @param attempt - How many retries has been attempted to performed, starting from 1, which includes
- * the attempt will be performed by this method call.
- */
- async attemptSendRequest(request, secondaryHas404, attempt) {
- const newRequest = request.clone();
- const isPrimaryRetry = secondaryHas404 ||
- !this.retryOptions.secondaryHost ||
- !(request.method === "GET" || request.method === "HEAD" || request.method === "OPTIONS") ||
- attempt % 2 === 1;
- if (!isPrimaryRetry) {
- newRequest.url = setURLHost(newRequest.url, this.retryOptions.secondaryHost);
- }
- // Set the server-side timeout query parameter "timeout=[seconds]"
- if (this.retryOptions.tryTimeoutInMs) {
- newRequest.url = setURLParameter(newRequest.url, URLConstants.Parameters.TIMEOUT, Math.floor(this.retryOptions.tryTimeoutInMs / 1000).toString());
- }
- let response;
- try {
- logger.info(`RetryPolicy: =====> Try=${attempt} ${isPrimaryRetry ? "Primary" : "Secondary"}`);
- response = await this._nextPolicy.sendRequest(newRequest);
- if (!this.shouldRetry(isPrimaryRetry, attempt, response)) {
- return response;
- }
- secondaryHas404 = secondaryHas404 || (!isPrimaryRetry && response.status === 404);
- }
- catch (err) {
- logger.error(`RetryPolicy: Caught error, message: ${err.message}, code: ${err.code}`);
- if (!this.shouldRetry(isPrimaryRetry, attempt, response, err)) {
- throw err;
- }
- }
- await this.delay(isPrimaryRetry, attempt, request.abortSignal);
- return this.attemptSendRequest(request, secondaryHas404, ++attempt);
- }
- /**
- * Decide whether to retry according to last HTTP response and retry counters.
- *
- * @param isPrimaryRetry -
- * @param attempt -
- * @param response -
- * @param err -
- */
- shouldRetry(isPrimaryRetry, attempt, response, err) {
- if (attempt >= this.retryOptions.maxTries) {
- logger.info(`RetryPolicy: Attempt(s) ${attempt} >= maxTries ${this.retryOptions
- .maxTries}, no further try.`);
- return false;
- }
- // Handle network failures, you may need to customize the list when you implement
- // your own http client
- const retriableErrors = [
- "ETIMEDOUT",
- "ESOCKETTIMEDOUT",
- "ECONNREFUSED",
- "ECONNRESET",
- "ENOENT",
- "ENOTFOUND",
- "TIMEOUT",
- "EPIPE",
- "REQUEST_SEND_ERROR", // For default xhr based http client provided in ms-rest-js
- ];
- if (err) {
- for (const retriableError of retriableErrors) {
- if (err.name.toUpperCase().includes(retriableError) ||
- err.message.toUpperCase().includes(retriableError) ||
- (err.code && err.code.toString().toUpperCase() === retriableError)) {
- logger.info(`RetryPolicy: Network error ${retriableError} found, will retry.`);
- return true;
- }
- }
- }
- // If attempt was against the secondary & it returned a StatusNotFound (404), then
- // the resource was not found. This may be due to replication delay. So, in this
- // case, we'll never try the secondary again for this operation.
- if (response || err) {
- const statusCode = response ? response.status : err ? err.statusCode : 0;
- if (!isPrimaryRetry && statusCode === 404) {
- logger.info(`RetryPolicy: Secondary access with 404, will retry.`);
- return true;
- }
- // Server internal error or server timeout
- if (statusCode === 503 || statusCode === 500) {
- logger.info(`RetryPolicy: Will retry for status code ${statusCode}.`);
- return true;
- }
- }
- if ((err === null || err === void 0 ? void 0 : err.code) === "PARSE_ERROR" && (err === null || err === void 0 ? void 0 : err.message.startsWith(`Error "Error: Unclosed root tag`))) {
- logger.info("RetryPolicy: Incomplete XML response likely due to service timeout, will retry.");
- return true;
- }
- return false;
- }
- /**
- * Delay a calculated time between retries.
- *
- * @param isPrimaryRetry -
- * @param attempt -
- * @param abortSignal -
- */
- async delay(isPrimaryRetry, attempt, abortSignal) {
- let delayTimeInMs = 0;
- if (isPrimaryRetry) {
- switch (this.retryOptions.retryPolicyType) {
- case exports.StorageRetryPolicyType.EXPONENTIAL:
- delayTimeInMs = Math.min((Math.pow(2, attempt - 1) - 1) * this.retryOptions.retryDelayInMs, this.retryOptions.maxRetryDelayInMs);
- break;
- case exports.StorageRetryPolicyType.FIXED:
- delayTimeInMs = this.retryOptions.retryDelayInMs;
- break;
- }
- }
- else {
- delayTimeInMs = Math.random() * 1000;
- }
- logger.info(`RetryPolicy: Delay for ${delayTimeInMs}ms`);
- return delay(delayTimeInMs, abortSignal, RETRY_ABORT_ERROR);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * StorageRetryPolicyFactory is a factory class helping generating {@link StorageRetryPolicy} objects.
- */
-class StorageRetryPolicyFactory {
- /**
- * Creates an instance of StorageRetryPolicyFactory.
- * @param retryOptions -
- */
- constructor(retryOptions) {
- this.retryOptions = retryOptions;
- }
- /**
- * Creates a StorageRetryPolicy object.
- *
- * @param nextPolicy -
- * @param options -
- */
- create(nextPolicy, options) {
- return new StorageRetryPolicy(nextPolicy, options, this.retryOptions);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Credential policy used to sign HTTP(S) requests before sending. This is an
- * abstract class.
- */
-class CredentialPolicy extends coreHttp.BaseRequestPolicy {
- /**
- * Sends out request.
- *
- * @param request -
- */
- sendRequest(request) {
- return this._nextPolicy.sendRequest(this.signRequest(request));
- }
- /**
- * Child classes must implement this method with request signing. This method
- * will be executed in {@link sendRequest}.
- *
- * @param request -
- */
- signRequest(request) {
- // Child classes must override this method with request signing. This method
- // will be executed in sendRequest().
- return request;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * AnonymousCredentialPolicy is used with HTTP(S) requests that read public resources
- * or for use with Shared Access Signatures (SAS).
- */
-class AnonymousCredentialPolicy extends CredentialPolicy {
- /**
- * Creates an instance of AnonymousCredentialPolicy.
- * @param nextPolicy -
- * @param options -
- */
- // The base class has a protected constructor. Adding a public one to enable constructing of this class.
- /* eslint-disable-next-line @typescript-eslint/no-useless-constructor*/
- constructor(nextPolicy, options) {
- super(nextPolicy, options);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Credential is an abstract class for Azure Storage HTTP requests signing. This
- * class will host an credentialPolicyCreator factory which generates CredentialPolicy.
- */
-class Credential {
- /**
- * Creates a RequestPolicy object.
- *
- * @param _nextPolicy -
- * @param _options -
- */
- create(_nextPolicy, _options) {
- throw new Error("Method should be implemented in children classes.");
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * AnonymousCredential provides a credentialPolicyCreator member used to create
- * AnonymousCredentialPolicy objects. AnonymousCredentialPolicy is used with
- * HTTP(S) requests that read public resources or for use with Shared Access
- * Signatures (SAS).
- */
-class AnonymousCredential extends Credential {
- /**
- * Creates an {@link AnonymousCredentialPolicy} object.
- *
- * @param nextPolicy -
- * @param options -
- */
- create(nextPolicy, options) {
- return new AnonymousCredentialPolicy(nextPolicy, options);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * TelemetryPolicy is a policy used to tag user-agent header for every requests.
- */
-class TelemetryPolicy extends coreHttp.BaseRequestPolicy {
- /**
- * Creates an instance of TelemetryPolicy.
- * @param nextPolicy -
- * @param options -
- * @param telemetry -
- */
- constructor(nextPolicy, options, telemetry) {
- super(nextPolicy, options);
- this.telemetry = telemetry;
- }
- /**
- * Sends out request.
- *
- * @param request -
- */
- async sendRequest(request) {
- if (coreHttp.isNode) {
- if (!request.headers) {
- request.headers = new coreHttp.HttpHeaders();
- }
- if (!request.headers.get(HeaderConstants.USER_AGENT)) {
- request.headers.set(HeaderConstants.USER_AGENT, this.telemetry);
- }
- }
- return this._nextPolicy.sendRequest(request);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * TelemetryPolicyFactory is a factory class helping generating {@link TelemetryPolicy} objects.
- */
-class TelemetryPolicyFactory {
- /**
- * Creates an instance of TelemetryPolicyFactory.
- * @param telemetry -
- */
- constructor(telemetry) {
- const userAgentInfo = [];
- if (coreHttp.isNode) {
- if (telemetry) {
- const telemetryString = telemetry.userAgentPrefix || "";
- if (telemetryString.length > 0 && userAgentInfo.indexOf(telemetryString) === -1) {
- userAgentInfo.push(telemetryString);
- }
- }
- // e.g. azsdk-js-storageblob/10.0.0
- const libInfo = `azsdk-js-storageblob/${SDK_VERSION}`;
- if (userAgentInfo.indexOf(libInfo) === -1) {
- userAgentInfo.push(libInfo);
- }
- // e.g. (NODE-VERSION 4.9.1; Windows_NT 10.0.16299)
- let runtimeInfo = `(NODE-VERSION ${process.version})`;
- if (os__namespace) {
- runtimeInfo = `(NODE-VERSION ${process.version}; ${os__namespace.type()} ${os__namespace.release()})`;
- }
- if (userAgentInfo.indexOf(runtimeInfo) === -1) {
- userAgentInfo.push(runtimeInfo);
- }
- }
- this.telemetryString = userAgentInfo.join(" ");
- }
- /**
- * Creates a TelemetryPolicy object.
- *
- * @param nextPolicy -
- * @param options -
- */
- create(nextPolicy, options) {
- return new TelemetryPolicy(nextPolicy, options, this.telemetryString);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-const _defaultHttpClient = new coreHttp.DefaultHttpClient();
-function getCachedDefaultHttpClient() {
- return _defaultHttpClient;
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * A set of constants used internally when processing requests.
- */
-const Constants = {
- DefaultScope: "/.default",
- /**
- * Defines constants for use with HTTP headers.
- */
- HeaderConstants: {
- /**
- * The Authorization header.
- */
- AUTHORIZATION: "authorization",
+const xMsRequiresSync = {
+ parameterPath: "xMsRequiresSync",
+ mapper: {
+ defaultValue: "true",
+ isConstant: true,
+ serializedName: "x-ms-requires-sync",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sourceContentMD5 = {
+ parameterPath: ["options", "sourceContentMD5"],
+ mapper: {
+ serializedName: "x-ms-source-content-md5",
+ xmlName: "x-ms-source-content-md5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+};
+const copySourceAuthorization = {
+ parameterPath: ["options", "copySourceAuthorization"],
+ mapper: {
+ serializedName: "x-ms-copy-source-authorization",
+ xmlName: "x-ms-copy-source-authorization",
+ type: {
+ name: "String",
+ },
+ },
+};
+const copySourceTags = {
+ parameterPath: ["options", "copySourceTags"],
+ mapper: {
+ serializedName: "x-ms-copy-source-tag-option",
+ xmlName: "x-ms-copy-source-tag-option",
+ type: {
+ name: "Enum",
+ allowedValues: ["REPLACE", "COPY"],
+ },
+ },
+};
+const comp15 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "copy",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const copyActionAbortConstant = {
+ parameterPath: "copyActionAbortConstant",
+ mapper: {
+ defaultValue: "abort",
+ isConstant: true,
+ serializedName: "x-ms-copy-action",
+ type: {
+ name: "String",
+ },
+ },
+};
+const copyId = {
+ parameterPath: "copyId",
+ mapper: {
+ serializedName: "copyid",
+ required: true,
+ xmlName: "copyid",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp16 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "tier",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const tier1 = {
+ parameterPath: "tier",
+ mapper: {
+ serializedName: "x-ms-access-tier",
+ required: true,
+ xmlName: "x-ms-access-tier",
+ type: {
+ name: "Enum",
+ allowedValues: [
+ "P4",
+ "P6",
+ "P10",
+ "P15",
+ "P20",
+ "P30",
+ "P40",
+ "P50",
+ "P60",
+ "P70",
+ "P80",
+ "Hot",
+ "Cool",
+ "Archive",
+ "Cold",
+ ],
+ },
+ },
+};
+const queryRequest = {
+ parameterPath: ["options", "queryRequest"],
+ mapper: QueryRequest,
+};
+const comp17 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "query",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp18 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "tags",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const tags = {
+ parameterPath: ["options", "tags"],
+ mapper: BlobTags,
+};
+const transactionalContentMD5 = {
+ parameterPath: ["options", "transactionalContentMD5"],
+ mapper: {
+ serializedName: "Content-MD5",
+ xmlName: "Content-MD5",
+ type: {
+ name: "ByteArray",
+ },
+ },
+};
+const transactionalContentCrc64 = {
+ parameterPath: ["options", "transactionalContentCrc64"],
+ mapper: {
+ serializedName: "x-ms-content-crc64",
+ xmlName: "x-ms-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+};
+const blobType = {
+ parameterPath: "blobType",
+ mapper: {
+ defaultValue: "PageBlob",
+ isConstant: true,
+ serializedName: "x-ms-blob-type",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobContentLength = {
+ parameterPath: "blobContentLength",
+ mapper: {
+ serializedName: "x-ms-blob-content-length",
+ required: true,
+ xmlName: "x-ms-blob-content-length",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const blobSequenceNumber = {
+ parameterPath: ["options", "blobSequenceNumber"],
+ mapper: {
+ defaultValue: 0,
+ serializedName: "x-ms-blob-sequence-number",
+ xmlName: "x-ms-blob-sequence-number",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const contentType1 = {
+ parameterPath: ["options", "contentType"],
+ mapper: {
+ defaultValue: "application/octet-stream",
+ isConstant: true,
+ serializedName: "Content-Type",
+ type: {
+ name: "String",
+ },
},
};
-// Default options for the cycler if none are provided
-const DEFAULT_CYCLER_OPTIONS = {
- forcedRefreshWindowInMs: 1000,
- retryIntervalInMs: 3000,
- refreshWindowInMs: 1000 * 60 * 2, // Start refreshing 2m before expiry
+const body1 = {
+ parameterPath: "body",
+ mapper: {
+ serializedName: "body",
+ required: true,
+ xmlName: "body",
+ type: {
+ name: "Stream",
+ },
+ },
};
-/**
- * Converts an an unreliable access token getter (which may resolve with null)
- * into an AccessTokenGetter by retrying the unreliable getter in a regular
- * interval.
- *
- * @param getAccessToken - a function that produces a promise of an access
- * token that may fail by returning null
- * @param retryIntervalInMs - the time (in milliseconds) to wait between retry
- * attempts
- * @param timeoutInMs - the timestamp after which the refresh attempt will fail,
- * throwing an exception
- * @returns - a promise that, if it resolves, will resolve with an access token
- */
-async function beginRefresh(getAccessToken, retryIntervalInMs, timeoutInMs) {
- // This wrapper handles exceptions gracefully as long as we haven't exceeded
- // the timeout.
- async function tryGetAccessToken() {
- if (Date.now() < timeoutInMs) {
- try {
- return await getAccessToken();
- }
- catch (_a) {
- return null;
- }
- }
- else {
- const finalToken = await getAccessToken();
- // Timeout is up, so throw if it's still null
- if (finalToken === null) {
- throw new Error("Failed to refresh access token.");
- }
- return finalToken;
- }
- }
- let token = await tryGetAccessToken();
- while (token === null) {
- await coreHttp.delay(retryIntervalInMs);
- token = await tryGetAccessToken();
- }
- return token;
-}
-/**
- * Creates a token cycler from a credential, scopes, and optional settings.
- *
- * A token cycler represents a way to reliably retrieve a valid access token
- * from a TokenCredential. It will handle initializing the token, refreshing it
- * when it nears expiration, and synchronizes refresh attempts to avoid
- * concurrency hazards.
- *
- * @param credential - the underlying TokenCredential that provides the access
- * token
- * @param scopes - the scopes to request authorization for
- * @param tokenCyclerOptions - optionally override default settings for the cycler
- *
- * @returns - a function that reliably produces a valid access token
- */
-function createTokenCycler(credential, scopes, tokenCyclerOptions) {
- let refreshWorker = null;
- let token = null;
- const options = Object.assign(Object.assign({}, DEFAULT_CYCLER_OPTIONS), tokenCyclerOptions);
- /**
- * This little holder defines several predicates that we use to construct
- * the rules of refreshing the token.
- */
- const cycler = {
- /**
- * Produces true if a refresh job is currently in progress.
- */
- get isRefreshing() {
- return refreshWorker !== null;
+const accept2 = {
+ parameterPath: "accept",
+ mapper: {
+ defaultValue: "application/xml",
+ isConstant: true,
+ serializedName: "Accept",
+ type: {
+ name: "String",
},
- /**
- * Produces true if the cycler SHOULD refresh (we are within the refresh
- * window and not already refreshing)
- */
- get shouldRefresh() {
- var _a;
- return (!cycler.isRefreshing &&
- ((_a = token === null || token === void 0 ? void 0 : token.expiresOnTimestamp) !== null && _a !== void 0 ? _a : 0) - options.refreshWindowInMs < Date.now());
+ },
+};
+const comp19 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "page",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
},
- /**
- * Produces true if the cycler MUST refresh (null or nearly-expired
- * token).
- */
- get mustRefresh() {
- return (token === null || token.expiresOnTimestamp - options.forcedRefreshWindowInMs < Date.now());
+ },
+};
+const pageWrite = {
+ parameterPath: "pageWrite",
+ mapper: {
+ defaultValue: "update",
+ isConstant: true,
+ serializedName: "x-ms-page-write",
+ type: {
+ name: "String",
},
- };
- /**
- * Starts a refresh job or returns the existing job if one is already
- * running.
- */
- function refresh(getTokenOptions) {
- var _a;
- if (!cycler.isRefreshing) {
- // We bind `scopes` here to avoid passing it around a lot
- const tryGetAccessToken = () => credential.getToken(scopes, getTokenOptions);
- // Take advantage of promise chaining to insert an assignment to `token`
- // before the refresh can be considered done.
- refreshWorker = beginRefresh(tryGetAccessToken, options.retryIntervalInMs,
- // If we don't have a token, then we should timeout immediately
- (_a = token === null || token === void 0 ? void 0 : token.expiresOnTimestamp) !== null && _a !== void 0 ? _a : Date.now())
- .then((_token) => {
- refreshWorker = null;
- token = _token;
- return token;
- })
- .catch((reason) => {
- // We also should reset the refresher if we enter a failed state. All
- // existing awaiters will throw, but subsequent requests will start a
- // new retry chain.
- refreshWorker = null;
- token = null;
- throw reason;
- });
- }
- return refreshWorker;
- }
- return async (tokenOptions) => {
- //
- // Simple rules:
- // - If we MUST refresh, then return the refresh task, blocking
- // the pipeline until a token is available.
- // - If we SHOULD refresh, then run refresh but don't return it
- // (we can still use the cached token).
- // - Return the token, since it's fine if we didn't return in
- // step 1.
- //
- if (cycler.mustRefresh)
- return refresh(tokenOptions);
- if (cycler.shouldRefresh) {
- refresh(tokenOptions);
- }
- return token;
- };
-}
-/**
- * We will retrieve the challenge only if the response status code was 401,
- * and if the response contained the header "WWW-Authenticate" with a non-empty value.
- */
-function getChallenge(response) {
- const challenge = response.headers.get("WWW-Authenticate");
- if (response.status === 401 && challenge) {
- return challenge;
- }
- return;
-}
-/**
- * Converts: `Bearer a="b" c="d"`.
- * Into: `[ { a: 'b', c: 'd' }]`.
- *
- * @internal
- */
-function parseChallenge(challenge) {
- const bearerChallenge = challenge.slice("Bearer ".length);
- const challengeParts = `${bearerChallenge.trim()} `.split(" ").filter((x) => x);
- const keyValuePairs = challengeParts.map((keyValue) => (([key, value]) => ({ [key]: value }))(keyValue.trim().split("=")));
- // Key-value pairs to plain object:
- return keyValuePairs.reduce((a, b) => (Object.assign(Object.assign({}, a), b)), {});
-}
-// #endregion
-/**
- * Creates a new factory for a RequestPolicy that applies a bearer token to
- * the requests' `Authorization` headers.
- *
- * @param credential - The TokenCredential implementation that can supply the bearer token.
- * @param scopes - The scopes for which the bearer token applies.
- */
-function storageBearerTokenChallengeAuthenticationPolicy(credential, scopes) {
- // This simple function encapsulates the entire process of reliably retrieving the token
- let getToken = createTokenCycler(credential, scopes);
- class StorageBearerTokenChallengeAuthenticationPolicy extends coreHttp.BaseRequestPolicy {
- constructor(nextPolicy, options) {
- super(nextPolicy, options);
- }
- async sendRequest(webResource) {
- if (!webResource.url.toLowerCase().startsWith("https://")) {
- throw new Error("Bearer token authentication is not permitted for non-TLS protected (non-https) URLs.");
- }
- const getTokenInternal = getToken;
- const token = (await getTokenInternal({
- abortSignal: webResource.abortSignal,
- tracingOptions: {
- tracingContext: webResource.tracingContext,
- },
- })).token;
- webResource.headers.set(Constants.HeaderConstants.AUTHORIZATION, `Bearer ${token}`);
- const response = await this._nextPolicy.sendRequest(webResource);
- if ((response === null || response === void 0 ? void 0 : response.status) === 401) {
- const challenge = getChallenge(response);
- if (challenge) {
- const challengeInfo = parseChallenge(challenge);
- const challengeScopes = challengeInfo.resource_id + Constants.DefaultScope;
- const parsedAuthUri = coreHttp.URLBuilder.parse(challengeInfo.authorization_uri);
- const pathSegments = parsedAuthUri.getPath().split("/");
- const tenantId = pathSegments[1];
- const getTokenForChallenge = createTokenCycler(credential, challengeScopes);
- const tokenForChallenge = (await getTokenForChallenge({
- abortSignal: webResource.abortSignal,
- tracingOptions: {
- tracingContext: webResource.tracingContext,
- },
- tenantId: tenantId,
- })).token;
- getToken = getTokenForChallenge;
- webResource.headers.set(Constants.HeaderConstants.AUTHORIZATION, `Bearer ${tokenForChallenge}`);
- return this._nextPolicy.sendRequest(webResource);
- }
- }
- return response;
- }
- }
- return {
- create: (nextPolicy, options) => {
- return new StorageBearerTokenChallengeAuthenticationPolicy(nextPolicy, options);
+ },
+};
+const ifSequenceNumberLessThanOrEqualTo = {
+ parameterPath: [
+ "options",
+ "sequenceNumberAccessConditions",
+ "ifSequenceNumberLessThanOrEqualTo",
+ ],
+ mapper: {
+ serializedName: "x-ms-if-sequence-number-le",
+ xmlName: "x-ms-if-sequence-number-le",
+ type: {
+ name: "Number",
},
- };
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * A helper to decide if a given argument satisfies the Pipeline contract
- * @param pipeline - An argument that may be a Pipeline
- * @returns true when the argument satisfies the Pipeline contract
- */
-function isPipelineLike(pipeline) {
- if (!pipeline || typeof pipeline !== "object") {
- return false;
- }
- const castPipeline = pipeline;
- return (Array.isArray(castPipeline.factories) &&
- typeof castPipeline.options === "object" &&
- typeof castPipeline.toServiceClientOptions === "function");
-}
-/**
- * A Pipeline class containing HTTP request policies.
- * You can create a default Pipeline by calling {@link newPipeline}.
- * Or you can create a Pipeline with your own policies by the constructor of Pipeline.
- *
- * Refer to {@link newPipeline} and provided policies before implementing your
- * customized Pipeline.
- */
-class Pipeline {
- /**
- * Creates an instance of Pipeline. Customize HTTPClient by implementing IHttpClient interface.
- *
- * @param factories -
- * @param options -
- */
- constructor(factories, options = {}) {
- this.factories = factories;
- // when options.httpClient is not specified, passing in a DefaultHttpClient instance to
- // avoid each client creating its own http client.
- this.options = Object.assign(Object.assign({}, options), { httpClient: options.httpClient || getCachedDefaultHttpClient() });
- }
- /**
- * Transfer Pipeline object to ServiceClientOptions object which is required by
- * ServiceClient constructor.
- *
- * @returns The ServiceClientOptions object from this Pipeline.
- */
- toServiceClientOptions() {
- return {
- httpClient: this.options.httpClient,
- requestPolicyFactories: this.factories,
- };
- }
-}
-/**
- * Creates a new Pipeline object with Credential provided.
- *
- * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
- * @param pipelineOptions - Optional. Options.
- * @returns A new Pipeline object.
- */
-function newPipeline(credential, pipelineOptions = {}) {
- var _a;
- if (credential === undefined) {
- credential = new AnonymousCredential();
- }
- // Order is important. Closer to the API at the top & closer to the network at the bottom.
- // The credential's policy factory must appear close to the wire so it can sign any
- // changes made by other factories (like UniqueRequestIDPolicyFactory)
- const telemetryPolicy = new TelemetryPolicyFactory(pipelineOptions.userAgentOptions);
- const factories = [
- coreHttp.tracingPolicy({ userAgent: telemetryPolicy.telemetryString }),
- coreHttp.keepAlivePolicy(pipelineOptions.keepAliveOptions),
- telemetryPolicy,
- coreHttp.generateClientRequestIdPolicy(),
- new StorageBrowserPolicyFactory(),
- new StorageRetryPolicyFactory(pipelineOptions.retryOptions),
- // Default deserializationPolicy is provided by protocol layer
- // Use customized XML char key of "#" so we could deserialize metadata
- // with "_" key
- coreHttp.deserializationPolicy(undefined, { xmlCharKey: "#" }),
- coreHttp.logPolicy({
- logger: logger.info,
- allowedHeaderNames: StorageBlobLoggingAllowedHeaderNames,
- allowedQueryParameters: StorageBlobLoggingAllowedQueryParameters,
- }),
- ];
- if (coreHttp.isNode) {
- // policies only available in Node.js runtime, not in browsers
- factories.push(coreHttp.proxyPolicy(pipelineOptions.proxyOptions));
- factories.push(coreHttp.disableResponseDecompressionPolicy());
- }
- factories.push(coreHttp.isTokenCredential(credential)
- ? attachCredential(storageBearerTokenChallengeAuthenticationPolicy(credential, (_a = pipelineOptions.audience) !== null && _a !== void 0 ? _a : StorageOAuthScopes), credential)
- : credential);
- return new Pipeline(factories, pipelineOptions);
-}
+ },
+};
+const ifSequenceNumberLessThan = {
+ parameterPath: [
+ "options",
+ "sequenceNumberAccessConditions",
+ "ifSequenceNumberLessThan",
+ ],
+ mapper: {
+ serializedName: "x-ms-if-sequence-number-lt",
+ xmlName: "x-ms-if-sequence-number-lt",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const ifSequenceNumberEqualTo = {
+ parameterPath: [
+ "options",
+ "sequenceNumberAccessConditions",
+ "ifSequenceNumberEqualTo",
+ ],
+ mapper: {
+ serializedName: "x-ms-if-sequence-number-eq",
+ xmlName: "x-ms-if-sequence-number-eq",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const pageWrite1 = {
+ parameterPath: "pageWrite",
+ mapper: {
+ defaultValue: "clear",
+ isConstant: true,
+ serializedName: "x-ms-page-write",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sourceUrl = {
+ parameterPath: "sourceUrl",
+ mapper: {
+ serializedName: "x-ms-copy-source",
+ required: true,
+ xmlName: "x-ms-copy-source",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sourceRange = {
+ parameterPath: "sourceRange",
+ mapper: {
+ serializedName: "x-ms-source-range",
+ required: true,
+ xmlName: "x-ms-source-range",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sourceContentCrc64 = {
+ parameterPath: ["options", "sourceContentCrc64"],
+ mapper: {
+ serializedName: "x-ms-source-content-crc64",
+ xmlName: "x-ms-source-content-crc64",
+ type: {
+ name: "ByteArray",
+ },
+ },
+};
+const range1 = {
+ parameterPath: "range",
+ mapper: {
+ serializedName: "x-ms-range",
+ required: true,
+ xmlName: "x-ms-range",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp20 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "pagelist",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const prevsnapshot = {
+ parameterPath: ["options", "prevsnapshot"],
+ mapper: {
+ serializedName: "prevsnapshot",
+ xmlName: "prevsnapshot",
+ type: {
+ name: "String",
+ },
+ },
+};
+const prevSnapshotUrl = {
+ parameterPath: ["options", "prevSnapshotUrl"],
+ mapper: {
+ serializedName: "x-ms-previous-snapshot-url",
+ xmlName: "x-ms-previous-snapshot-url",
+ type: {
+ name: "String",
+ },
+ },
+};
+const sequenceNumberAction = {
+ parameterPath: "sequenceNumberAction",
+ mapper: {
+ serializedName: "x-ms-sequence-number-action",
+ required: true,
+ xmlName: "x-ms-sequence-number-action",
+ type: {
+ name: "Enum",
+ allowedValues: ["max", "update", "increment"],
+ },
+ },
+};
+const comp21 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "incrementalcopy",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobType1 = {
+ parameterPath: "blobType",
+ mapper: {
+ defaultValue: "AppendBlob",
+ isConstant: true,
+ serializedName: "x-ms-blob-type",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp22 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "appendblock",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const maxSize = {
+ parameterPath: ["options", "appendPositionAccessConditions", "maxSize"],
+ mapper: {
+ serializedName: "x-ms-blob-condition-maxsize",
+ xmlName: "x-ms-blob-condition-maxsize",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const appendPosition = {
+ parameterPath: [
+ "options",
+ "appendPositionAccessConditions",
+ "appendPosition",
+ ],
+ mapper: {
+ serializedName: "x-ms-blob-condition-appendpos",
+ xmlName: "x-ms-blob-condition-appendpos",
+ type: {
+ name: "Number",
+ },
+ },
+};
+const sourceRange1 = {
+ parameterPath: ["options", "sourceRange"],
+ mapper: {
+ serializedName: "x-ms-source-range",
+ xmlName: "x-ms-source-range",
+ type: {
+ name: "String",
+ },
+ },
+};
+const comp23 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "seal",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blobType2 = {
+ parameterPath: "blobType",
+ mapper: {
+ defaultValue: "BlockBlob",
+ isConstant: true,
+ serializedName: "x-ms-blob-type",
+ type: {
+ name: "String",
+ },
+ },
+};
+const copySourceBlobProperties = {
+ parameterPath: ["options", "copySourceBlobProperties"],
+ mapper: {
+ serializedName: "x-ms-copy-source-blob-properties",
+ xmlName: "x-ms-copy-source-blob-properties",
+ type: {
+ name: "Boolean",
+ },
+ },
+};
+const comp24 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "block",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blockId = {
+ parameterPath: "blockId",
+ mapper: {
+ serializedName: "blockid",
+ required: true,
+ xmlName: "blockid",
+ type: {
+ name: "String",
+ },
+ },
+};
+const blocks = {
+ parameterPath: "blocks",
+ mapper: BlockLookupList,
+};
+const comp25 = {
+ parameterPath: "comp",
+ mapper: {
+ defaultValue: "blocklist",
+ isConstant: true,
+ serializedName: "comp",
+ type: {
+ name: "String",
+ },
+ },
+};
+const listType = {
+ parameterPath: "listType",
+ mapper: {
+ defaultValue: "committed",
+ serializedName: "blocklisttype",
+ required: true,
+ xmlName: "blocklisttype",
+ type: {
+ name: "Enum",
+ allowedValues: ["committed", "uncommitted", "all"],
+ },
+ },
+};
-// Copyright (c) Microsoft Corporation.
-/**
- * StorageSharedKeyCredentialPolicy is a policy used to sign HTTP request with a shared key.
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
-class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
+/** Class containing Service operations. */
+class ServiceImpl {
/**
- * Creates an instance of StorageSharedKeyCredentialPolicy.
- * @param nextPolicy -
- * @param options -
- * @param factory -
+ * Initialize a new instance of the class Service class.
+ * @param client Reference to the service client
*/
- constructor(nextPolicy, options, factory) {
- super(nextPolicy, options);
- this.factory = factory;
+ constructor(client) {
+ this.client = client;
}
/**
- * Signs request.
- *
- * @param request -
+ * Sets properties for a storage account's Blob service endpoint, including properties for Storage
+ * Analytics and CORS (Cross-Origin Resource Sharing) rules
+ * @param blobServiceProperties The StorageService properties.
+ * @param options The options parameters.
*/
- signRequest(request) {
- request.headers.set(HeaderConstants.X_MS_DATE, new Date().toUTCString());
- if (request.body &&
- (typeof request.body === "string" || request.body !== undefined) &&
- request.body.length > 0) {
- request.headers.set(HeaderConstants.CONTENT_LENGTH, Buffer.byteLength(request.body));
- }
- const stringToSign = [
- request.method.toUpperCase(),
- this.getHeaderValueToSign(request, HeaderConstants.CONTENT_LANGUAGE),
- this.getHeaderValueToSign(request, HeaderConstants.CONTENT_ENCODING),
- this.getHeaderValueToSign(request, HeaderConstants.CONTENT_LENGTH),
- this.getHeaderValueToSign(request, HeaderConstants.CONTENT_MD5),
- this.getHeaderValueToSign(request, HeaderConstants.CONTENT_TYPE),
- this.getHeaderValueToSign(request, HeaderConstants.DATE),
- this.getHeaderValueToSign(request, HeaderConstants.IF_MODIFIED_SINCE),
- this.getHeaderValueToSign(request, HeaderConstants.IF_MATCH),
- this.getHeaderValueToSign(request, HeaderConstants.IF_NONE_MATCH),
- this.getHeaderValueToSign(request, HeaderConstants.IF_UNMODIFIED_SINCE),
- this.getHeaderValueToSign(request, HeaderConstants.RANGE),
- ].join("\n") +
- "\n" +
- this.getCanonicalizedHeadersString(request) +
- this.getCanonicalizedResourceString(request);
- const signature = this.factory.computeHMACSHA256(stringToSign);
- request.headers.set(HeaderConstants.AUTHORIZATION, `SharedKey ${this.factory.accountName}:${signature}`);
- // console.log(`[URL]:${request.url}`);
- // console.log(`[HEADERS]:${request.headers.toString()}`);
- // console.log(`[STRING TO SIGN]:${JSON.stringify(stringToSign)}`);
- // console.log(`[KEY]: ${request.headers.get(HeaderConstants.AUTHORIZATION)}`);
- return request;
+ setProperties(blobServiceProperties, options) {
+ return this.client.sendOperationRequest({ blobServiceProperties, options }, setPropertiesOperationSpec);
}
/**
- * Retrieve header value according to shared key sign rules.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
- *
- * @param request -
- * @param headerName -
+ * gets the properties of a storage account's Blob service, including properties for Storage Analytics
+ * and CORS (Cross-Origin Resource Sharing) rules.
+ * @param options The options parameters.
*/
- getHeaderValueToSign(request, headerName) {
- const value = request.headers.get(headerName);
- if (!value) {
- return "";
- }
- // When using version 2015-02-21 or later, if Content-Length is zero, then
- // set the Content-Length part of the StringToSign to an empty string.
- // https://docs.microsoft.com/en-us/rest/api/storageservices/authenticate-with-shared-key
- if (headerName === HeaderConstants.CONTENT_LENGTH && value === "0") {
- return "";
- }
- return value;
+ getProperties(options) {
+ return this.client.sendOperationRequest({ options }, getPropertiesOperationSpec$2);
}
/**
- * To construct the CanonicalizedHeaders portion of the signature string, follow these steps:
- * 1. Retrieve all headers for the resource that begin with x-ms-, including the x-ms-date header.
- * 2. Convert each HTTP header name to lowercase.
- * 3. Sort the headers lexicographically by header name, in ascending order.
- * Each header may appear only once in the string.
- * 4. Replace any linear whitespace in the header value with a single space.
- * 5. Trim any whitespace around the colon in the header.
- * 6. Finally, append a new-line character to each canonicalized header in the resulting list.
- * Construct the CanonicalizedHeaders string by concatenating all headers in this list into a single string.
- *
- * @param request -
+ * Retrieves statistics related to replication for the Blob service. It is only available on the
+ * secondary location endpoint when read-access geo-redundant replication is enabled for the storage
+ * account.
+ * @param options The options parameters.
*/
- getCanonicalizedHeadersString(request) {
- let headersArray = request.headers.headersArray().filter((value) => {
- return value.name.toLowerCase().startsWith(HeaderConstants.PREFIX_FOR_STORAGE);
- });
- headersArray.sort((a, b) => {
- return a.name.toLowerCase().localeCompare(b.name.toLowerCase());
- });
- // Remove duplicate headers
- headersArray = headersArray.filter((value, index, array) => {
- if (index > 0 && value.name.toLowerCase() === array[index - 1].name.toLowerCase()) {
- return false;
- }
- return true;
- });
- let canonicalizedHeadersStringToSign = "";
- headersArray.forEach((header) => {
- canonicalizedHeadersStringToSign += `${header.name
- .toLowerCase()
- .trimRight()}:${header.value.trimLeft()}\n`;
- });
- return canonicalizedHeadersStringToSign;
+ getStatistics(options) {
+ return this.client.sendOperationRequest({ options }, getStatisticsOperationSpec);
}
/**
- * Retrieves the webResource canonicalized resource string.
- *
- * @param request -
+ * The List Containers Segment operation returns a list of the containers under the specified account
+ * @param options The options parameters.
*/
- getCanonicalizedResourceString(request) {
- const path = getURLPath(request.url) || "/";
- let canonicalizedResourceString = "";
- canonicalizedResourceString += `/${this.factory.accountName}${path}`;
- const queries = getURLQueries(request.url);
- const lowercaseQueries = {};
- if (queries) {
- const queryKeys = [];
- for (const key in queries) {
- if (Object.prototype.hasOwnProperty.call(queries, key)) {
- const lowercaseKey = key.toLowerCase();
- lowercaseQueries[lowercaseKey] = queries[key];
- queryKeys.push(lowercaseKey);
- }
- }
- queryKeys.sort();
- for (const key of queryKeys) {
- canonicalizedResourceString += `\n${key}:${decodeURIComponent(lowercaseQueries[key])}`;
- }
- }
- return canonicalizedResourceString;
+ listContainersSegment(options) {
+ return this.client.sendOperationRequest({ options }, listContainersSegmentOperationSpec);
}
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * StorageSharedKeyCredential for account key authorization of Azure Storage service.
- */
-class StorageSharedKeyCredential extends Credential {
/**
- * Creates an instance of StorageSharedKeyCredential.
- * @param accountName -
- * @param accountKey -
+ * Retrieves a user delegation key for the Blob service. This is only a valid operation when using
+ * bearer token authentication.
+ * @param keyInfo Key information
+ * @param options The options parameters.
*/
- constructor(accountName, accountKey) {
- super();
- this.accountName = accountName;
- this.accountKey = Buffer.from(accountKey, "base64");
+ getUserDelegationKey(keyInfo, options) {
+ return this.client.sendOperationRequest({ keyInfo, options }, getUserDelegationKeyOperationSpec);
}
/**
- * Creates a StorageSharedKeyCredentialPolicy object.
- *
- * @param nextPolicy -
- * @param options -
+ * Returns the sku name and account kind
+ * @param options The options parameters.
*/
- create(nextPolicy, options) {
- return new StorageSharedKeyCredentialPolicy(nextPolicy, options, this);
+ getAccountInfo(options) {
+ return this.client.sendOperationRequest({ options }, getAccountInfoOperationSpec$2);
}
/**
- * Generates a hash signature for an HTTP request or for a SAS.
- *
- * @param stringToSign -
+ * The Batch operation allows multiple API calls to be embedded into a single HTTP request.
+ * @param contentLength The length of the request.
+ * @param multipartContentType Required. The value of this header must be multipart/mixed with a batch
+ * boundary. Example header value: multipart/mixed; boundary=batch_
+ * @param body Initial data
+ * @param options The options parameters.
*/
- computeHMACSHA256(stringToSign) {
- return crypto.createHmac("sha256", this.accountKey).update(stringToSign, "utf8").digest("base64");
+ submitBatch(contentLength, multipartContentType, body, options) {
+ return this.client.sendOperationRequest({ contentLength, multipartContentType, body, options }, submitBatchOperationSpec$1);
+ }
+ /**
+ * The Filter Blobs operation enables callers to list blobs across all containers whose tags match a
+ * given search expression. Filter blobs searches across all containers within a storage account but
+ * can be scoped within the expression to a single container.
+ * @param options The options parameters.
+ */
+ filterBlobs(options) {
+ return this.client.sendOperationRequest({ options }, filterBlobsOperationSpec$1);
}
}
+// Operation Specifications
+const xmlSerializer$5 = coreClient__namespace.createSerializer(Mappers, /* isXml */ true);
+const setPropertiesOperationSpec = {
+ path: "/",
+ httpMethod: "PUT",
+ responses: {
+ 202: {
+ headersMapper: ServiceSetPropertiesHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ServiceSetPropertiesExceptionHeaders,
+ },
+ },
+ requestBody: blobServiceProperties,
+ queryParameters: [
+ restype,
+ comp,
+ timeoutInSeconds,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ contentType,
+ accept,
+ version,
+ requestId,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "xml",
+ serializer: xmlSerializer$5,
+};
+const getPropertiesOperationSpec$2 = {
+ path: "/",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: BlobServiceProperties,
+ headersMapper: ServiceGetPropertiesHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ServiceGetPropertiesExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ restype,
+ comp,
+ timeoutInSeconds,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$5,
+};
+const getStatisticsOperationSpec = {
+ path: "/",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: BlobServiceStatistics,
+ headersMapper: ServiceGetStatisticsHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ServiceGetStatisticsExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ restype,
+ timeoutInSeconds,
+ comp1,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$5,
+};
+const listContainersSegmentOperationSpec = {
+ path: "/",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: ListContainersSegmentResponse,
+ headersMapper: ServiceListContainersSegmentHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ServiceListContainersSegmentExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ comp2,
+ prefix,
+ marker,
+ maxPageSize,
+ include,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$5,
+};
+const getUserDelegationKeyOperationSpec = {
+ path: "/",
+ httpMethod: "POST",
+ responses: {
+ 200: {
+ bodyMapper: UserDelegationKey,
+ headersMapper: ServiceGetUserDelegationKeyHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ServiceGetUserDelegationKeyExceptionHeaders,
+ },
+ },
+ requestBody: keyInfo,
+ queryParameters: [
+ restype,
+ timeoutInSeconds,
+ comp3,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ contentType,
+ accept,
+ version,
+ requestId,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "xml",
+ serializer: xmlSerializer$5,
+};
+const getAccountInfoOperationSpec$2 = {
+ path: "/",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ headersMapper: ServiceGetAccountInfoHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ServiceGetAccountInfoExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ comp,
+ timeoutInSeconds,
+ restype1,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$5,
+};
+const submitBatchOperationSpec$1 = {
+ path: "/",
+ httpMethod: "POST",
+ responses: {
+ 202: {
+ bodyMapper: {
+ type: { name: "Stream" },
+ serializedName: "parsedResponse",
+ },
+ headersMapper: ServiceSubmitBatchHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ServiceSubmitBatchExceptionHeaders,
+ },
+ },
+ requestBody: body,
+ queryParameters: [timeoutInSeconds, comp4],
+ urlParameters: [url],
+ headerParameters: [
+ accept,
+ version,
+ requestId,
+ contentLength,
+ multipartContentType,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "xml",
+ serializer: xmlSerializer$5,
+};
+const filterBlobsOperationSpec$1 = {
+ path: "/",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: FilterBlobSegment,
+ headersMapper: ServiceFilterBlobsHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ServiceFilterBlobsExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ marker,
+ maxPageSize,
+ comp5,
+ where,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$5,
+};
/*
* Copyright (c) Microsoft Corporation.
@@ -32471,2763 +20967,4401 @@ class StorageSharedKeyCredential extends Credential {
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
-const packageName = "azure-storage-blob";
-const packageVersion = "12.17.0";
-class StorageClientContext extends coreHttp__namespace.ServiceClient {
- /**
- * Initializes a new instance of the StorageClientContext class.
- * @param url The URL of the service account, container, or blob that is the target of the desired
- * operation.
- * @param options The parameter options
- */
- constructor(url, options) {
- if (url === undefined) {
- throw new Error("'url' cannot be null");
- }
- // Initializing default values for options
- if (!options) {
- options = {};
- }
- if (!options.userAgent) {
- const defaultUserAgent = coreHttp__namespace.getDefaultUserAgentValue();
- options.userAgent = `${packageName}/${packageVersion} ${defaultUserAgent}`;
- }
- super(undefined, options);
- this.requestContentType = "application/json; charset=utf-8";
- this.baseUri = options.endpoint || "{url}";
- // Parameter assignments
- this.url = url;
- // Assigning values to Constant parameters
- this.version = options.version || "2023-11-03";
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * A StorageClient represents a based URL class for {@link BlobServiceClient}, {@link ContainerClient}
- * and etc.
- */
-class StorageClient {
+/** Class containing Container operations. */
+class ContainerImpl {
/**
- * Creates an instance of StorageClient.
- * @param url - url to resource
- * @param pipeline - request policy pipeline.
+ * Initialize a new instance of the class Container class.
+ * @param client Reference to the service client
*/
- constructor(url, pipeline) {
- // URL should be encoded and only once, protocol layer shouldn't encode URL again
- this.url = escapeURLPath(url);
- this.accountName = getAccountNameFromUrl(url);
- this.pipeline = pipeline;
- this.storageClientContext = new StorageClientContext(this.url, pipeline.toServiceClientOptions());
- this.isHttps = iEqual(getURLScheme(this.url) || "", "https");
- this.credential = new AnonymousCredential();
- for (const factory of this.pipeline.factories) {
- if ((coreHttp.isNode && factory instanceof StorageSharedKeyCredential) ||
- factory instanceof AnonymousCredential) {
- this.credential = factory;
- }
- else if (coreHttp.isTokenCredential(factory.credential)) {
- // Only works if the factory has been attached a "credential" property.
- // We do that in newPipeline() when using TokenCredential.
- this.credential = factory.credential;
- }
- }
- // Override protocol layer's default content-type
- const storageClientContext = this.storageClientContext;
- storageClientContext.requestContentType = undefined;
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Creates a span using the global tracer.
- * @internal
- */
-const createSpan = coreTracing.createSpanFunction({
- packagePrefix: "Azure.Storage.Blob",
- namespace: "Microsoft.Storage",
-});
-/**
- * @internal
- *
- * Adapt the tracing options from OperationOptions to what they need to be for
- * RequestOptionsBase (when we update to later OpenTelemetry versions this is now
- * two separate fields, not just one).
- */
-function convertTracingToRequestOptionsBase(options) {
- var _a, _b;
- return {
- // By passing spanOptions if they exist at runtime, we're backwards compatible with @azure/core-tracing@preview.13 and earlier.
- spanOptions: (_a = options === null || options === void 0 ? void 0 : options.tracingOptions) === null || _a === void 0 ? void 0 : _a.spanOptions,
- tracingContext: (_b = options === null || options === void 0 ? void 0 : options.tracingOptions) === null || _b === void 0 ? void 0 : _b.tracingContext,
- };
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. Setting
- * a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all
- * the values are set, this should be serialized with toString and set as the permissions field on a
- * {@link BlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but
- * the order of the permissions is particular and this class guarantees correctness.
- */
-class BlobSASPermissions {
- constructor() {
- /**
- * Specifies Read access granted.
- */
- this.read = false;
- /**
- * Specifies Add access granted.
- */
- this.add = false;
- /**
- * Specifies Create access granted.
- */
- this.create = false;
- /**
- * Specifies Write access granted.
- */
- this.write = false;
- /**
- * Specifies Delete access granted.
- */
- this.delete = false;
- /**
- * Specifies Delete version access granted.
- */
- this.deleteVersion = false;
- /**
- * Specfies Tag access granted.
- */
- this.tag = false;
- /**
- * Specifies Move access granted.
- */
- this.move = false;
- /**
- * Specifies Execute access granted.
- */
- this.execute = false;
- /**
- * Specifies SetImmutabilityPolicy access granted.
- */
- this.setImmutabilityPolicy = false;
- /**
- * Specifies that Permanent Delete is permitted.
- */
- this.permanentDelete = false;
+ constructor(client) {
+ this.client = client;
}
/**
- * Creates a {@link BlobSASPermissions} from the specified permissions string. This method will throw an
- * Error if it encounters a character that does not correspond to a valid permission.
- *
- * @param permissions -
+ * creates a new container under the specified account. If the container with the same name already
+ * exists, the operation fails
+ * @param options The options parameters.
*/
- static parse(permissions) {
- const blobSASPermissions = new BlobSASPermissions();
- for (const char of permissions) {
- switch (char) {
- case "r":
- blobSASPermissions.read = true;
- break;
- case "a":
- blobSASPermissions.add = true;
- break;
- case "c":
- blobSASPermissions.create = true;
- break;
- case "w":
- blobSASPermissions.write = true;
- break;
- case "d":
- blobSASPermissions.delete = true;
- break;
- case "x":
- blobSASPermissions.deleteVersion = true;
- break;
- case "t":
- blobSASPermissions.tag = true;
- break;
- case "m":
- blobSASPermissions.move = true;
- break;
- case "e":
- blobSASPermissions.execute = true;
- break;
- case "i":
- blobSASPermissions.setImmutabilityPolicy = true;
- break;
- case "y":
- blobSASPermissions.permanentDelete = true;
- break;
- default:
- throw new RangeError(`Invalid permission: ${char}`);
- }
- }
- return blobSASPermissions;
+ create(options) {
+ return this.client.sendOperationRequest({ options }, createOperationSpec$2);
}
/**
- * Creates a {@link BlobSASPermissions} from a raw object which contains same keys as it
- * and boolean values for them.
- *
- * @param permissionLike -
+ * returns all user-defined metadata and system properties for the specified container. The data
+ * returned does not include the container's list of blobs
+ * @param options The options parameters.
*/
- static from(permissionLike) {
- const blobSASPermissions = new BlobSASPermissions();
- if (permissionLike.read) {
- blobSASPermissions.read = true;
- }
- if (permissionLike.add) {
- blobSASPermissions.add = true;
- }
- if (permissionLike.create) {
- blobSASPermissions.create = true;
- }
- if (permissionLike.write) {
- blobSASPermissions.write = true;
- }
- if (permissionLike.delete) {
- blobSASPermissions.delete = true;
- }
- if (permissionLike.deleteVersion) {
- blobSASPermissions.deleteVersion = true;
- }
- if (permissionLike.tag) {
- blobSASPermissions.tag = true;
- }
- if (permissionLike.move) {
- blobSASPermissions.move = true;
- }
- if (permissionLike.execute) {
- blobSASPermissions.execute = true;
- }
- if (permissionLike.setImmutabilityPolicy) {
- blobSASPermissions.setImmutabilityPolicy = true;
- }
- if (permissionLike.permanentDelete) {
- blobSASPermissions.permanentDelete = true;
- }
- return blobSASPermissions;
+ getProperties(options) {
+ return this.client.sendOperationRequest({ options }, getPropertiesOperationSpec$1);
}
/**
- * Converts the given permissions to a string. Using this method will guarantee the permissions are in an
- * order accepted by the service.
- *
- * @returns A string which represents the BlobSASPermissions
+ * operation marks the specified container for deletion. The container and any blobs contained within
+ * it are later deleted during garbage collection
+ * @param options The options parameters.
*/
- toString() {
- const permissions = [];
- if (this.read) {
- permissions.push("r");
- }
- if (this.add) {
- permissions.push("a");
- }
- if (this.create) {
- permissions.push("c");
- }
- if (this.write) {
- permissions.push("w");
- }
- if (this.delete) {
- permissions.push("d");
- }
- if (this.deleteVersion) {
- permissions.push("x");
- }
- if (this.tag) {
- permissions.push("t");
- }
- if (this.move) {
- permissions.push("m");
- }
- if (this.execute) {
- permissions.push("e");
- }
- if (this.setImmutabilityPolicy) {
- permissions.push("i");
- }
- if (this.permanentDelete) {
- permissions.push("y");
- }
- return permissions.join("");
+ delete(options) {
+ return this.client.sendOperationRequest({ options }, deleteOperationSpec$1);
}
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container.
- * Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation.
- * Once all the values are set, this should be serialized with toString and set as the permissions field on a
- * {@link BlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but
- * the order of the permissions is particular and this class guarantees correctness.
- */
-class ContainerSASPermissions {
- constructor() {
- /**
- * Specifies Read access granted.
- */
- this.read = false;
- /**
- * Specifies Add access granted.
- */
- this.add = false;
- /**
- * Specifies Create access granted.
- */
- this.create = false;
- /**
- * Specifies Write access granted.
- */
- this.write = false;
- /**
- * Specifies Delete access granted.
- */
- this.delete = false;
- /**
- * Specifies Delete version access granted.
- */
- this.deleteVersion = false;
- /**
- * Specifies List access granted.
- */
- this.list = false;
- /**
- * Specfies Tag access granted.
- */
- this.tag = false;
- /**
- * Specifies Move access granted.
- */
- this.move = false;
- /**
- * Specifies Execute access granted.
- */
- this.execute = false;
- /**
- * Specifies SetImmutabilityPolicy access granted.
- */
- this.setImmutabilityPolicy = false;
- /**
- * Specifies that Permanent Delete is permitted.
- */
- this.permanentDelete = false;
- /**
- * Specifies that Filter Blobs by Tags is permitted.
- */
- this.filterByTags = false;
+ /**
+ * operation sets one or more user-defined name-value pairs for the specified container.
+ * @param options The options parameters.
+ */
+ setMetadata(options) {
+ return this.client.sendOperationRequest({ options }, setMetadataOperationSpec$1);
}
/**
- * Creates an {@link ContainerSASPermissions} from the specified permissions string. This method will throw an
- * Error if it encounters a character that does not correspond to a valid permission.
- *
- * @param permissions -
+ * gets the permissions for the specified container. The permissions indicate whether container data
+ * may be accessed publicly.
+ * @param options The options parameters.
*/
- static parse(permissions) {
- const containerSASPermissions = new ContainerSASPermissions();
- for (const char of permissions) {
- switch (char) {
- case "r":
- containerSASPermissions.read = true;
- break;
- case "a":
- containerSASPermissions.add = true;
- break;
- case "c":
- containerSASPermissions.create = true;
- break;
- case "w":
- containerSASPermissions.write = true;
- break;
- case "d":
- containerSASPermissions.delete = true;
- break;
- case "l":
- containerSASPermissions.list = true;
- break;
- case "t":
- containerSASPermissions.tag = true;
- break;
- case "x":
- containerSASPermissions.deleteVersion = true;
- break;
- case "m":
- containerSASPermissions.move = true;
- break;
- case "e":
- containerSASPermissions.execute = true;
- break;
- case "i":
- containerSASPermissions.setImmutabilityPolicy = true;
- break;
- case "y":
- containerSASPermissions.permanentDelete = true;
- break;
- case "f":
- containerSASPermissions.filterByTags = true;
- break;
- default:
- throw new RangeError(`Invalid permission ${char}`);
- }
- }
- return containerSASPermissions;
+ getAccessPolicy(options) {
+ return this.client.sendOperationRequest({ options }, getAccessPolicyOperationSpec);
}
/**
- * Creates a {@link ContainerSASPermissions} from a raw object which contains same keys as it
- * and boolean values for them.
- *
- * @param permissionLike -
+ * sets the permissions for the specified container. The permissions indicate whether blobs in a
+ * container may be accessed publicly.
+ * @param options The options parameters.
*/
- static from(permissionLike) {
- const containerSASPermissions = new ContainerSASPermissions();
- if (permissionLike.read) {
- containerSASPermissions.read = true;
- }
- if (permissionLike.add) {
- containerSASPermissions.add = true;
- }
- if (permissionLike.create) {
- containerSASPermissions.create = true;
- }
- if (permissionLike.write) {
- containerSASPermissions.write = true;
- }
- if (permissionLike.delete) {
- containerSASPermissions.delete = true;
- }
- if (permissionLike.list) {
- containerSASPermissions.list = true;
- }
- if (permissionLike.deleteVersion) {
- containerSASPermissions.deleteVersion = true;
- }
- if (permissionLike.tag) {
- containerSASPermissions.tag = true;
- }
- if (permissionLike.move) {
- containerSASPermissions.move = true;
- }
- if (permissionLike.execute) {
- containerSASPermissions.execute = true;
- }
- if (permissionLike.setImmutabilityPolicy) {
- containerSASPermissions.setImmutabilityPolicy = true;
- }
- if (permissionLike.permanentDelete) {
- containerSASPermissions.permanentDelete = true;
- }
- if (permissionLike.filterByTags) {
- containerSASPermissions.filterByTags = true;
- }
- return containerSASPermissions;
+ setAccessPolicy(options) {
+ return this.client.sendOperationRequest({ options }, setAccessPolicyOperationSpec);
}
/**
- * Converts the given permissions to a string. Using this method will guarantee the permissions are in an
- * order accepted by the service.
- *
- * The order of the characters should be as specified here to ensure correctness.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
- *
+ * Restores a previously-deleted container.
+ * @param options The options parameters.
*/
- toString() {
- const permissions = [];
- if (this.read) {
- permissions.push("r");
- }
- if (this.add) {
- permissions.push("a");
- }
- if (this.create) {
- permissions.push("c");
- }
- if (this.write) {
- permissions.push("w");
- }
- if (this.delete) {
- permissions.push("d");
- }
- if (this.deleteVersion) {
- permissions.push("x");
- }
- if (this.list) {
- permissions.push("l");
- }
- if (this.tag) {
- permissions.push("t");
- }
- if (this.move) {
- permissions.push("m");
- }
- if (this.execute) {
- permissions.push("e");
- }
- if (this.setImmutabilityPolicy) {
- permissions.push("i");
- }
- if (this.permanentDelete) {
- permissions.push("y");
- }
- if (this.filterByTags) {
- permissions.push("f");
- }
- return permissions.join("");
+ restore(options) {
+ return this.client.sendOperationRequest({ options }, restoreOperationSpec);
}
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * UserDelegationKeyCredential is only used for generation of user delegation SAS.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas
- */
-class UserDelegationKeyCredential {
/**
- * Creates an instance of UserDelegationKeyCredential.
- * @param accountName -
- * @param userDelegationKey -
+ * Renames an existing container.
+ * @param sourceContainerName Required. Specifies the name of the container to rename.
+ * @param options The options parameters.
*/
- constructor(accountName, userDelegationKey) {
- this.accountName = accountName;
- this.userDelegationKey = userDelegationKey;
- this.key = Buffer.from(userDelegationKey.value, "base64");
+ rename(sourceContainerName, options) {
+ return this.client.sendOperationRequest({ sourceContainerName, options }, renameOperationSpec);
}
/**
- * Generates a hash signature for an HTTP request or for a SAS.
- *
- * @param stringToSign -
+ * The Batch operation allows multiple API calls to be embedded into a single HTTP request.
+ * @param contentLength The length of the request.
+ * @param multipartContentType Required. The value of this header must be multipart/mixed with a batch
+ * boundary. Example header value: multipart/mixed; boundary=batch_
+ * @param body Initial data
+ * @param options The options parameters.
*/
- computeHMACSHA256(stringToSign) {
- // console.log(`stringToSign: ${JSON.stringify(stringToSign)}`);
- return crypto.createHmac("sha256", this.key).update(stringToSign, "utf8").digest("base64");
+ submitBatch(contentLength, multipartContentType, body, options) {
+ return this.client.sendOperationRequest({ contentLength, multipartContentType, body, options }, submitBatchOperationSpec);
}
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Generate SasIPRange format string. For example:
- *
- * "8.8.8.8" or "1.1.1.1-255.255.255.255"
- *
- * @param ipRange -
- */
-function ipRangeToString(ipRange) {
- return ipRange.end ? `${ipRange.start}-${ipRange.end}` : ipRange.start;
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Protocols for generated SAS.
- */
-exports.SASProtocol = void 0;
-(function (SASProtocol) {
/**
- * Protocol that allows HTTPS only
+ * The Filter Blobs operation enables callers to list blobs in a container whose tags match a given
+ * search expression. Filter blobs searches within the given container.
+ * @param options The options parameters.
*/
- SASProtocol["Https"] = "https";
+ filterBlobs(options) {
+ return this.client.sendOperationRequest({ options }, filterBlobsOperationSpec);
+ }
/**
- * Protocol that allows both HTTPS and HTTP
+ * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
+ * be 15 to 60 seconds, or can be infinite
+ * @param options The options parameters.
*/
- SASProtocol["HttpsAndHttp"] = "https,http";
-})(exports.SASProtocol || (exports.SASProtocol = {}));
-/**
- * Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
- * by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link BlobSASSignatureValues}
- * types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
- * be taken here in case there are existing query parameters, which might affect the appropriate means of appending
- * these query parameters).
- *
- * NOTE: Instances of this class are immutable.
- */
-class SASQueryParameters {
- constructor(version, signature, permissionsOrOptions, services, resourceTypes, protocol, startsOn, expiresOn, ipRange, identifier, resource, cacheControl, contentDisposition, contentEncoding, contentLanguage, contentType, userDelegationKey, preauthorizedAgentObjectId, correlationId, encryptionScope) {
- this.version = version;
- this.signature = signature;
- if (permissionsOrOptions !== undefined && typeof permissionsOrOptions !== "string") {
- // SASQueryParametersOptions
- this.permissions = permissionsOrOptions.permissions;
- this.services = permissionsOrOptions.services;
- this.resourceTypes = permissionsOrOptions.resourceTypes;
- this.protocol = permissionsOrOptions.protocol;
- this.startsOn = permissionsOrOptions.startsOn;
- this.expiresOn = permissionsOrOptions.expiresOn;
- this.ipRangeInner = permissionsOrOptions.ipRange;
- this.identifier = permissionsOrOptions.identifier;
- this.encryptionScope = permissionsOrOptions.encryptionScope;
- this.resource = permissionsOrOptions.resource;
- this.cacheControl = permissionsOrOptions.cacheControl;
- this.contentDisposition = permissionsOrOptions.contentDisposition;
- this.contentEncoding = permissionsOrOptions.contentEncoding;
- this.contentLanguage = permissionsOrOptions.contentLanguage;
- this.contentType = permissionsOrOptions.contentType;
- if (permissionsOrOptions.userDelegationKey) {
- this.signedOid = permissionsOrOptions.userDelegationKey.signedObjectId;
- this.signedTenantId = permissionsOrOptions.userDelegationKey.signedTenantId;
- this.signedStartsOn = permissionsOrOptions.userDelegationKey.signedStartsOn;
- this.signedExpiresOn = permissionsOrOptions.userDelegationKey.signedExpiresOn;
- this.signedService = permissionsOrOptions.userDelegationKey.signedService;
- this.signedVersion = permissionsOrOptions.userDelegationKey.signedVersion;
- this.preauthorizedAgentObjectId = permissionsOrOptions.preauthorizedAgentObjectId;
- this.correlationId = permissionsOrOptions.correlationId;
- }
- }
- else {
- this.services = services;
- this.resourceTypes = resourceTypes;
- this.expiresOn = expiresOn;
- this.permissions = permissionsOrOptions;
- this.protocol = protocol;
- this.startsOn = startsOn;
- this.ipRangeInner = ipRange;
- this.encryptionScope = encryptionScope;
- this.identifier = identifier;
- this.resource = resource;
- this.cacheControl = cacheControl;
- this.contentDisposition = contentDisposition;
- this.contentEncoding = contentEncoding;
- this.contentLanguage = contentLanguage;
- this.contentType = contentType;
- if (userDelegationKey) {
- this.signedOid = userDelegationKey.signedObjectId;
- this.signedTenantId = userDelegationKey.signedTenantId;
- this.signedStartsOn = userDelegationKey.signedStartsOn;
- this.signedExpiresOn = userDelegationKey.signedExpiresOn;
- this.signedService = userDelegationKey.signedService;
- this.signedVersion = userDelegationKey.signedVersion;
- this.preauthorizedAgentObjectId = preauthorizedAgentObjectId;
- this.correlationId = correlationId;
- }
- }
+ acquireLease(options) {
+ return this.client.sendOperationRequest({ options }, acquireLeaseOperationSpec$1);
+ }
+ /**
+ * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
+ * be 15 to 60 seconds, or can be infinite
+ * @param leaseId Specifies the current lease ID on the resource.
+ * @param options The options parameters.
+ */
+ releaseLease(leaseId, options) {
+ return this.client.sendOperationRequest({ leaseId, options }, releaseLeaseOperationSpec$1);
+ }
+ /**
+ * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
+ * be 15 to 60 seconds, or can be infinite
+ * @param leaseId Specifies the current lease ID on the resource.
+ * @param options The options parameters.
+ */
+ renewLease(leaseId, options) {
+ return this.client.sendOperationRequest({ leaseId, options }, renewLeaseOperationSpec$1);
+ }
+ /**
+ * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
+ * be 15 to 60 seconds, or can be infinite
+ * @param options The options parameters.
+ */
+ breakLease(options) {
+ return this.client.sendOperationRequest({ options }, breakLeaseOperationSpec$1);
+ }
+ /**
+ * [Update] establishes and manages a lock on a container for delete operations. The lock duration can
+ * be 15 to 60 seconds, or can be infinite
+ * @param leaseId Specifies the current lease ID on the resource.
+ * @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
+ * (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
+ * (String) for a list of valid GUID string formats.
+ * @param options The options parameters.
+ */
+ changeLease(leaseId, proposedLeaseId, options) {
+ return this.client.sendOperationRequest({ leaseId, proposedLeaseId, options }, changeLeaseOperationSpec$1);
+ }
+ /**
+ * [Update] The List Blobs operation returns a list of the blobs under the specified container
+ * @param options The options parameters.
+ */
+ listBlobFlatSegment(options) {
+ return this.client.sendOperationRequest({ options }, listBlobFlatSegmentOperationSpec);
+ }
+ /**
+ * [Update] The List Blobs operation returns a list of the blobs under the specified container
+ * @param delimiter When the request includes this parameter, the operation returns a BlobPrefix
+ * element in the response body that acts as a placeholder for all blobs whose names begin with the
+ * same substring up to the appearance of the delimiter character. The delimiter may be a single
+ * character or a string.
+ * @param options The options parameters.
+ */
+ listBlobHierarchySegment(delimiter, options) {
+ return this.client.sendOperationRequest({ delimiter, options }, listBlobHierarchySegmentOperationSpec);
+ }
+ /**
+ * Returns the sku name and account kind
+ * @param options The options parameters.
+ */
+ getAccountInfo(options) {
+ return this.client.sendOperationRequest({ options }, getAccountInfoOperationSpec$1);
+ }
+}
+// Operation Specifications
+const xmlSerializer$4 = coreClient__namespace.createSerializer(Mappers, /* isXml */ true);
+const createOperationSpec$2 = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: ContainerCreateHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerCreateExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, restype2],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ metadata,
+ access,
+ defaultEncryptionScope,
+ preventEncryptionScopeOverride,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const getPropertiesOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ headersMapper: ContainerGetPropertiesHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerGetPropertiesExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, restype2],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const deleteOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "DELETE",
+ responses: {
+ 202: {
+ headersMapper: ContainerDeleteHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerDeleteExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, restype2],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const setMetadataOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: ContainerSetMetadataHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerSetMetadataExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp6,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const getAccessPolicyOperationSpec = {
+ path: "/{containerName}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: {
+ type: {
+ name: "Sequence",
+ element: {
+ type: { name: "Composite", className: "SignedIdentifier" },
+ },
+ },
+ serializedName: "SignedIdentifiers",
+ xmlName: "SignedIdentifiers",
+ xmlIsWrapped: true,
+ xmlElementName: "SignedIdentifier",
+ },
+ headersMapper: ContainerGetAccessPolicyHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerGetAccessPolicyExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp7,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const setAccessPolicyOperationSpec = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: ContainerSetAccessPolicyHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerSetAccessPolicyExceptionHeaders,
+ },
+ },
+ requestBody: containerAcl,
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp7,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ contentType,
+ accept,
+ version,
+ requestId,
+ access,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "xml",
+ serializer: xmlSerializer$4,
+};
+const restoreOperationSpec = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: ContainerRestoreHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerRestoreExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp8,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ deletedContainerName,
+ deletedContainerVersion,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const renameOperationSpec = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: ContainerRenameHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerRenameExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp9,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ sourceContainerName,
+ sourceLeaseId,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const submitBatchOperationSpec = {
+ path: "/{containerName}",
+ httpMethod: "POST",
+ responses: {
+ 202: {
+ bodyMapper: {
+ type: { name: "Stream" },
+ serializedName: "parsedResponse",
+ },
+ headersMapper: ContainerSubmitBatchHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerSubmitBatchExceptionHeaders,
+ },
+ },
+ requestBody: body,
+ queryParameters: [
+ timeoutInSeconds,
+ comp4,
+ restype2,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ accept,
+ version,
+ requestId,
+ contentLength,
+ multipartContentType,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "xml",
+ serializer: xmlSerializer$4,
+};
+const filterBlobsOperationSpec = {
+ path: "/{containerName}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: FilterBlobSegment,
+ headersMapper: ContainerFilterBlobsHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerFilterBlobsExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ marker,
+ maxPageSize,
+ comp5,
+ where,
+ restype2,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const acquireLeaseOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: ContainerAcquireLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerAcquireLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp10,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ action,
+ duration,
+ proposedLeaseId,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const releaseLeaseOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: ContainerReleaseLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerReleaseLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp10,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ action1,
+ leaseId1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const renewLeaseOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: ContainerRenewLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerRenewLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp10,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ leaseId1,
+ action2,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const breakLeaseOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 202: {
+ headersMapper: ContainerBreakLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerBreakLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp10,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ action3,
+ breakPeriod,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const changeLeaseOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: ContainerChangeLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerChangeLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ restype2,
+ comp10,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ leaseId1,
+ action4,
+ proposedLeaseId1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const listBlobFlatSegmentOperationSpec = {
+ path: "/{containerName}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: ListBlobsFlatSegmentResponse,
+ headersMapper: ContainerListBlobFlatSegmentHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerListBlobFlatSegmentExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ comp2,
+ prefix,
+ marker,
+ maxPageSize,
+ restype2,
+ include1,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const listBlobHierarchySegmentOperationSpec = {
+ path: "/{containerName}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: ListBlobsHierarchySegmentResponse,
+ headersMapper: ContainerListBlobHierarchySegmentHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerListBlobHierarchySegmentExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ comp2,
+ prefix,
+ marker,
+ maxPageSize,
+ restype2,
+ include1,
+ delimiter,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+const getAccountInfoOperationSpec$1 = {
+ path: "/{containerName}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ headersMapper: ContainerGetAccountInfoHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: ContainerGetAccountInfoExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ comp,
+ timeoutInSeconds,
+ restype1,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$4,
+};
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+/** Class containing Blob operations. */
+class BlobImpl {
+ /**
+ * Initialize a new instance of the class Blob class.
+ * @param client Reference to the service client
+ */
+ constructor(client) {
+ this.client = client;
}
/**
- * Optional. IP range allowed for this SAS.
- *
- * @readonly
+ * The Download operation reads or downloads a blob from the system, including its metadata and
+ * properties. You can also call Download to read a snapshot.
+ * @param options The options parameters.
*/
- get ipRange() {
- if (this.ipRangeInner) {
- return {
- end: this.ipRangeInner.end,
- start: this.ipRangeInner.start,
- };
- }
- return undefined;
+ download(options) {
+ return this.client.sendOperationRequest({ options }, downloadOperationSpec);
}
/**
- * Encodes all SAS query parameters into a string that can be appended to a URL.
- *
+ * The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system
+ * properties for the blob. It does not return the content of the blob.
+ * @param options The options parameters.
*/
- toString() {
- const params = [
- "sv",
- "ss",
- "srt",
- "spr",
- "st",
- "se",
- "sip",
- "si",
- "ses",
- "skoid",
- "sktid",
- "skt",
- "ske",
- "sks",
- "skv",
- "sr",
- "sp",
- "sig",
- "rscc",
- "rscd",
- "rsce",
- "rscl",
- "rsct",
- "saoid",
- "scid",
- ];
- const queries = [];
- for (const param of params) {
- switch (param) {
- case "sv":
- this.tryAppendQueryParameter(queries, param, this.version);
- break;
- case "ss":
- this.tryAppendQueryParameter(queries, param, this.services);
- break;
- case "srt":
- this.tryAppendQueryParameter(queries, param, this.resourceTypes);
- break;
- case "spr":
- this.tryAppendQueryParameter(queries, param, this.protocol);
- break;
- case "st":
- this.tryAppendQueryParameter(queries, param, this.startsOn ? truncatedISO8061Date(this.startsOn, false) : undefined);
- break;
- case "se":
- this.tryAppendQueryParameter(queries, param, this.expiresOn ? truncatedISO8061Date(this.expiresOn, false) : undefined);
- break;
- case "sip":
- this.tryAppendQueryParameter(queries, param, this.ipRange ? ipRangeToString(this.ipRange) : undefined);
- break;
- case "si":
- this.tryAppendQueryParameter(queries, param, this.identifier);
- break;
- case "ses":
- this.tryAppendQueryParameter(queries, param, this.encryptionScope);
- break;
- case "skoid": // Signed object ID
- this.tryAppendQueryParameter(queries, param, this.signedOid);
- break;
- case "sktid": // Signed tenant ID
- this.tryAppendQueryParameter(queries, param, this.signedTenantId);
- break;
- case "skt": // Signed key start time
- this.tryAppendQueryParameter(queries, param, this.signedStartsOn ? truncatedISO8061Date(this.signedStartsOn, false) : undefined);
- break;
- case "ske": // Signed key expiry time
- this.tryAppendQueryParameter(queries, param, this.signedExpiresOn ? truncatedISO8061Date(this.signedExpiresOn, false) : undefined);
- break;
- case "sks": // Signed key service
- this.tryAppendQueryParameter(queries, param, this.signedService);
- break;
- case "skv": // Signed key version
- this.tryAppendQueryParameter(queries, param, this.signedVersion);
- break;
- case "sr":
- this.tryAppendQueryParameter(queries, param, this.resource);
- break;
- case "sp":
- this.tryAppendQueryParameter(queries, param, this.permissions);
- break;
- case "sig":
- this.tryAppendQueryParameter(queries, param, this.signature);
- break;
- case "rscc":
- this.tryAppendQueryParameter(queries, param, this.cacheControl);
- break;
- case "rscd":
- this.tryAppendQueryParameter(queries, param, this.contentDisposition);
- break;
- case "rsce":
- this.tryAppendQueryParameter(queries, param, this.contentEncoding);
- break;
- case "rscl":
- this.tryAppendQueryParameter(queries, param, this.contentLanguage);
- break;
- case "rsct":
- this.tryAppendQueryParameter(queries, param, this.contentType);
- break;
- case "saoid":
- this.tryAppendQueryParameter(queries, param, this.preauthorizedAgentObjectId);
- break;
- case "scid":
- this.tryAppendQueryParameter(queries, param, this.correlationId);
- break;
- }
- }
- return queries.join("&");
+ getProperties(options) {
+ return this.client.sendOperationRequest({ options }, getPropertiesOperationSpec);
}
/**
- * A private helper method used to filter and append query key/value pairs into an array.
- *
- * @param queries -
- * @param key -
- * @param value -
+ * If the storage account's soft delete feature is disabled then, when a blob is deleted, it is
+ * permanently removed from the storage account. If the storage account's soft delete feature is
+ * enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible
+ * immediately. However, the blob service retains the blob or snapshot for the number of days specified
+ * by the DeleteRetentionPolicy section of [Storage service properties]
+ * (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is
+ * permanently removed from the storage account. Note that you continue to be charged for the
+ * soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the
+ * "include=deleted" query parameter to discover which blobs and snapshots have been soft deleted. You
+ * can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a
+ * soft-deleted blob or snapshot causes the service to return an HTTP status code of 404
+ * (ResourceNotFound).
+ * @param options The options parameters.
*/
- tryAppendQueryParameter(queries, key, value) {
- if (!value) {
- return;
- }
- key = encodeURIComponent(key);
- value = encodeURIComponent(value);
- if (key.length > 0 && value.length > 0) {
- queries.push(`${key}=${value}`);
- }
+ delete(options) {
+ return this.client.sendOperationRequest({ options }, deleteOperationSpec);
}
-}
-
-// Copyright (c) Microsoft Corporation.
-function generateBlobSASQueryParameters(blobSASSignatureValues, sharedKeyCredentialOrUserDelegationKey, accountName) {
- const version = blobSASSignatureValues.version ? blobSASSignatureValues.version : SERVICE_VERSION;
- const sharedKeyCredential = sharedKeyCredentialOrUserDelegationKey instanceof StorageSharedKeyCredential
- ? sharedKeyCredentialOrUserDelegationKey
- : undefined;
- let userDelegationKeyCredential;
- if (sharedKeyCredential === undefined && accountName !== undefined) {
- userDelegationKeyCredential = new UserDelegationKeyCredential(accountName, sharedKeyCredentialOrUserDelegationKey);
+ /**
+ * Undelete a blob that was previously soft deleted
+ * @param options The options parameters.
+ */
+ undelete(options) {
+ return this.client.sendOperationRequest({ options }, undeleteOperationSpec);
}
- if (sharedKeyCredential === undefined && userDelegationKeyCredential === undefined) {
- throw TypeError("Invalid sharedKeyCredential, userDelegationKey or accountName.");
+ /**
+ * Sets the time a blob will expire and be deleted.
+ * @param expiryOptions Required. Indicates mode of the expiry time
+ * @param options The options parameters.
+ */
+ setExpiry(expiryOptions, options) {
+ return this.client.sendOperationRequest({ expiryOptions, options }, setExpiryOperationSpec);
}
- // Version 2020-12-06 adds support for encryptionscope in SAS.
- if (version >= "2020-12-06") {
- if (sharedKeyCredential !== undefined) {
- return generateBlobSASQueryParameters20201206(blobSASSignatureValues, sharedKeyCredential);
- }
- else {
- return generateBlobSASQueryParametersUDK20201206(blobSASSignatureValues, userDelegationKeyCredential);
- }
+ /**
+ * The Set HTTP Headers operation sets system properties on the blob
+ * @param options The options parameters.
+ */
+ setHttpHeaders(options) {
+ return this.client.sendOperationRequest({ options }, setHttpHeadersOperationSpec);
}
- // Version 2019-12-12 adds support for the blob tags permission.
- // Version 2018-11-09 adds support for the signed resource and signed blob snapshot time fields.
- // https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas#constructing-the-signature-string
- if (version >= "2018-11-09") {
- if (sharedKeyCredential !== undefined) {
- return generateBlobSASQueryParameters20181109(blobSASSignatureValues, sharedKeyCredential);
- }
- else {
- // Version 2020-02-10 delegation SAS signature construction includes preauthorizedAgentObjectId, agentObjectId, correlationId.
- if (version >= "2020-02-10") {
- return generateBlobSASQueryParametersUDK20200210(blobSASSignatureValues, userDelegationKeyCredential);
- }
- else {
- return generateBlobSASQueryParametersUDK20181109(blobSASSignatureValues, userDelegationKeyCredential);
- }
- }
+ /**
+ * The Set Immutability Policy operation sets the immutability policy on the blob
+ * @param options The options parameters.
+ */
+ setImmutabilityPolicy(options) {
+ return this.client.sendOperationRequest({ options }, setImmutabilityPolicyOperationSpec);
}
- if (version >= "2015-04-05") {
- if (sharedKeyCredential !== undefined) {
- return generateBlobSASQueryParameters20150405(blobSASSignatureValues, sharedKeyCredential);
- }
- else {
- throw new RangeError("'version' must be >= '2018-11-09' when generating user delegation SAS using user delegation key.");
- }
+ /**
+ * The Delete Immutability Policy operation deletes the immutability policy on the blob
+ * @param options The options parameters.
+ */
+ deleteImmutabilityPolicy(options) {
+ return this.client.sendOperationRequest({ options }, deleteImmutabilityPolicyOperationSpec);
}
- throw new RangeError("'version' must be >= '2015-04-05'.");
-}
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- * IMPLEMENTATION FOR API VERSION FROM 2015-04-05 AND BEFORE 2018-11-09.
- *
- * Creates an instance of SASQueryParameters.
- *
- * Only accepts required settings needed to create a SAS. For optional settings please
- * set corresponding properties directly, such as permissions, startsOn and identifier.
- *
- * WARNING: When identifier is not provided, permissions and expiresOn are required.
- * You MUST assign value to identifier or expiresOn & permissions manually if you initial with
- * this constructor.
- *
- * @param blobSASSignatureValues -
- * @param sharedKeyCredential -
- */
-function generateBlobSASQueryParameters20150405(blobSASSignatureValues, sharedKeyCredential) {
- blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
- if (!blobSASSignatureValues.identifier &&
- !(blobSASSignatureValues.permissions && blobSASSignatureValues.expiresOn)) {
- throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when 'identifier' is not provided.");
+ /**
+ * The Set Legal Hold operation sets a legal hold on the blob.
+ * @param legalHold Specified if a legal hold should be set on the blob.
+ * @param options The options parameters.
+ */
+ setLegalHold(legalHold, options) {
+ return this.client.sendOperationRequest({ legalHold, options }, setLegalHoldOperationSpec);
}
- let resource = "c";
- if (blobSASSignatureValues.blobName) {
- resource = "b";
+ /**
+ * The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more
+ * name-value pairs
+ * @param options The options parameters.
+ */
+ setMetadata(options) {
+ return this.client.sendOperationRequest({ options }, setMetadataOperationSpec);
}
- // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
- let verifiedPermissions;
- if (blobSASSignatureValues.permissions) {
- if (blobSASSignatureValues.blobName) {
- verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
- else {
- verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
+ /**
+ * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+ * operations
+ * @param options The options parameters.
+ */
+ acquireLease(options) {
+ return this.client.sendOperationRequest({ options }, acquireLeaseOperationSpec);
}
- // Signature is generated on the un-url-encoded values.
- const stringToSign = [
- verifiedPermissions ? verifiedPermissions : "",
- blobSASSignatureValues.startsOn
- ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
- : "",
- blobSASSignatureValues.expiresOn
- ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
- : "",
- getCanonicalName(sharedKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
- blobSASSignatureValues.identifier,
- blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
- blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
- blobSASSignatureValues.version,
- blobSASSignatureValues.cacheControl ? blobSASSignatureValues.cacheControl : "",
- blobSASSignatureValues.contentDisposition ? blobSASSignatureValues.contentDisposition : "",
- blobSASSignatureValues.contentEncoding ? blobSASSignatureValues.contentEncoding : "",
- blobSASSignatureValues.contentLanguage ? blobSASSignatureValues.contentLanguage : "",
- blobSASSignatureValues.contentType ? blobSASSignatureValues.contentType : "",
- ].join("\n");
- const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
- return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType);
-}
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- * IMPLEMENTATION FOR API VERSION FROM 2018-11-09.
- *
- * Creates an instance of SASQueryParameters.
- *
- * Only accepts required settings needed to create a SAS. For optional settings please
- * set corresponding properties directly, such as permissions, startsOn and identifier.
- *
- * WARNING: When identifier is not provided, permissions and expiresOn are required.
- * You MUST assign value to identifier or expiresOn & permissions manually if you initial with
- * this constructor.
- *
- * @param blobSASSignatureValues -
- * @param sharedKeyCredential -
- */
-function generateBlobSASQueryParameters20181109(blobSASSignatureValues, sharedKeyCredential) {
- blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
- if (!blobSASSignatureValues.identifier &&
- !(blobSASSignatureValues.permissions && blobSASSignatureValues.expiresOn)) {
- throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when 'identifier' is not provided.");
+ /**
+ * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+ * operations
+ * @param leaseId Specifies the current lease ID on the resource.
+ * @param options The options parameters.
+ */
+ releaseLease(leaseId, options) {
+ return this.client.sendOperationRequest({ leaseId, options }, releaseLeaseOperationSpec);
}
- let resource = "c";
- let timestamp = blobSASSignatureValues.snapshotTime;
- if (blobSASSignatureValues.blobName) {
- resource = "b";
- if (blobSASSignatureValues.snapshotTime) {
- resource = "bs";
- }
- else if (blobSASSignatureValues.versionId) {
- resource = "bv";
- timestamp = blobSASSignatureValues.versionId;
- }
+ /**
+ * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+ * operations
+ * @param leaseId Specifies the current lease ID on the resource.
+ * @param options The options parameters.
+ */
+ renewLease(leaseId, options) {
+ return this.client.sendOperationRequest({ leaseId, options }, renewLeaseOperationSpec);
}
- // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
- let verifiedPermissions;
- if (blobSASSignatureValues.permissions) {
- if (blobSASSignatureValues.blobName) {
- verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
- else {
- verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
+ /**
+ * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+ * operations
+ * @param leaseId Specifies the current lease ID on the resource.
+ * @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
+ * (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
+ * (String) for a list of valid GUID string formats.
+ * @param options The options parameters.
+ */
+ changeLease(leaseId, proposedLeaseId, options) {
+ return this.client.sendOperationRequest({ leaseId, proposedLeaseId, options }, changeLeaseOperationSpec);
}
- // Signature is generated on the un-url-encoded values.
- const stringToSign = [
- verifiedPermissions ? verifiedPermissions : "",
- blobSASSignatureValues.startsOn
- ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
- : "",
- blobSASSignatureValues.expiresOn
- ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
- : "",
- getCanonicalName(sharedKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
- blobSASSignatureValues.identifier,
- blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
- blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
- blobSASSignatureValues.version,
- resource,
- timestamp,
- blobSASSignatureValues.cacheControl ? blobSASSignatureValues.cacheControl : "",
- blobSASSignatureValues.contentDisposition ? blobSASSignatureValues.contentDisposition : "",
- blobSASSignatureValues.contentEncoding ? blobSASSignatureValues.contentEncoding : "",
- blobSASSignatureValues.contentLanguage ? blobSASSignatureValues.contentLanguage : "",
- blobSASSignatureValues.contentType ? blobSASSignatureValues.contentType : "",
- ].join("\n");
- const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
- return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType);
-}
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- * IMPLEMENTATION FOR API VERSION FROM 2020-12-06.
- *
- * Creates an instance of SASQueryParameters.
- *
- * Only accepts required settings needed to create a SAS. For optional settings please
- * set corresponding properties directly, such as permissions, startsOn and identifier.
- *
- * WARNING: When identifier is not provided, permissions and expiresOn are required.
- * You MUST assign value to identifier or expiresOn & permissions manually if you initial with
- * this constructor.
- *
- * @param blobSASSignatureValues -
- * @param sharedKeyCredential -
- */
-function generateBlobSASQueryParameters20201206(blobSASSignatureValues, sharedKeyCredential) {
- blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
- if (!blobSASSignatureValues.identifier &&
- !(blobSASSignatureValues.permissions && blobSASSignatureValues.expiresOn)) {
- throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when 'identifier' is not provided.");
+ /**
+ * [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
+ * operations
+ * @param options The options parameters.
+ */
+ breakLease(options) {
+ return this.client.sendOperationRequest({ options }, breakLeaseOperationSpec);
}
- let resource = "c";
- let timestamp = blobSASSignatureValues.snapshotTime;
- if (blobSASSignatureValues.blobName) {
- resource = "b";
- if (blobSASSignatureValues.snapshotTime) {
- resource = "bs";
- }
- else if (blobSASSignatureValues.versionId) {
- resource = "bv";
- timestamp = blobSASSignatureValues.versionId;
- }
+ /**
+ * The Create Snapshot operation creates a read-only snapshot of a blob
+ * @param options The options parameters.
+ */
+ createSnapshot(options) {
+ return this.client.sendOperationRequest({ options }, createSnapshotOperationSpec);
}
- // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
- let verifiedPermissions;
- if (blobSASSignatureValues.permissions) {
- if (blobSASSignatureValues.blobName) {
- verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
- else {
- verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
+ /**
+ * The Start Copy From URL operation copies a blob or an internet resource to a new blob.
+ * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
+ * 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
+ * appear in a request URI. The source blob must either be public or must be authenticated via a shared
+ * access signature.
+ * @param options The options parameters.
+ */
+ startCopyFromURL(copySource, options) {
+ return this.client.sendOperationRequest({ copySource, options }, startCopyFromURLOperationSpec);
}
- // Signature is generated on the un-url-encoded values.
- const stringToSign = [
- verifiedPermissions ? verifiedPermissions : "",
- blobSASSignatureValues.startsOn
- ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
- : "",
- blobSASSignatureValues.expiresOn
- ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
- : "",
- getCanonicalName(sharedKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
- blobSASSignatureValues.identifier,
- blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
- blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
- blobSASSignatureValues.version,
- resource,
- timestamp,
- blobSASSignatureValues.encryptionScope,
- blobSASSignatureValues.cacheControl ? blobSASSignatureValues.cacheControl : "",
- blobSASSignatureValues.contentDisposition ? blobSASSignatureValues.contentDisposition : "",
- blobSASSignatureValues.contentEncoding ? blobSASSignatureValues.contentEncoding : "",
- blobSASSignatureValues.contentLanguage ? blobSASSignatureValues.contentLanguage : "",
- blobSASSignatureValues.contentType ? blobSASSignatureValues.contentType : "",
- ].join("\n");
- const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
- return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType, undefined, undefined, undefined, blobSASSignatureValues.encryptionScope);
-}
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- * IMPLEMENTATION FOR API VERSION FROM 2018-11-09.
- *
- * Creates an instance of SASQueryParameters.
- *
- * Only accepts required settings needed to create a SAS. For optional settings please
- * set corresponding properties directly, such as permissions, startsOn.
- *
- * WARNING: identifier will be ignored, permissions and expiresOn are required.
- *
- * @param blobSASSignatureValues -
- * @param userDelegationKeyCredential -
- */
-function generateBlobSASQueryParametersUDK20181109(blobSASSignatureValues, userDelegationKeyCredential) {
- blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
- // Stored access policies are not supported for a user delegation SAS.
- if (!blobSASSignatureValues.permissions || !blobSASSignatureValues.expiresOn) {
- throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when generating user delegation SAS.");
+ /**
+ * The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return
+ * a response until the copy is complete.
+ * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
+ * 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
+ * appear in a request URI. The source blob must either be public or must be authenticated via a shared
+ * access signature.
+ * @param options The options parameters.
+ */
+ copyFromURL(copySource, options) {
+ return this.client.sendOperationRequest({ copySource, options }, copyFromURLOperationSpec);
}
- let resource = "c";
- let timestamp = blobSASSignatureValues.snapshotTime;
- if (blobSASSignatureValues.blobName) {
- resource = "b";
- if (blobSASSignatureValues.snapshotTime) {
- resource = "bs";
- }
- else if (blobSASSignatureValues.versionId) {
- resource = "bv";
- timestamp = blobSASSignatureValues.versionId;
- }
+ /**
+ * The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination
+ * blob with zero length and full metadata.
+ * @param copyId The copy identifier provided in the x-ms-copy-id header of the original Copy Blob
+ * operation.
+ * @param options The options parameters.
+ */
+ abortCopyFromURL(copyId, options) {
+ return this.client.sendOperationRequest({ copyId, options }, abortCopyFromURLOperationSpec);
}
- // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
- let verifiedPermissions;
- if (blobSASSignatureValues.permissions) {
- if (blobSASSignatureValues.blobName) {
- verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
- else {
- verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
+ /**
+ * The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium
+ * storage account and on a block blob in a blob storage account (locally redundant storage only). A
+ * premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block
+ * blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's
+ * ETag.
+ * @param tier Indicates the tier to be set on the blob.
+ * @param options The options parameters.
+ */
+ setTier(tier, options) {
+ return this.client.sendOperationRequest({ tier, options }, setTierOperationSpec);
}
- // Signature is generated on the un-url-encoded values.
- const stringToSign = [
- verifiedPermissions ? verifiedPermissions : "",
- blobSASSignatureValues.startsOn
- ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
- : "",
- blobSASSignatureValues.expiresOn
- ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
- : "",
- getCanonicalName(userDelegationKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
- userDelegationKeyCredential.userDelegationKey.signedObjectId,
- userDelegationKeyCredential.userDelegationKey.signedTenantId,
- userDelegationKeyCredential.userDelegationKey.signedStartsOn
- ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedStartsOn, false)
- : "",
- userDelegationKeyCredential.userDelegationKey.signedExpiresOn
- ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedExpiresOn, false)
- : "",
- userDelegationKeyCredential.userDelegationKey.signedService,
- userDelegationKeyCredential.userDelegationKey.signedVersion,
- blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
- blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
- blobSASSignatureValues.version,
- resource,
- timestamp,
- blobSASSignatureValues.cacheControl,
- blobSASSignatureValues.contentDisposition,
- blobSASSignatureValues.contentEncoding,
- blobSASSignatureValues.contentLanguage,
- blobSASSignatureValues.contentType,
- ].join("\n");
- const signature = userDelegationKeyCredential.computeHMACSHA256(stringToSign);
- return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType, userDelegationKeyCredential.userDelegationKey);
-}
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- * IMPLEMENTATION FOR API VERSION FROM 2020-02-10.
- *
- * Creates an instance of SASQueryParameters.
- *
- * Only accepts required settings needed to create a SAS. For optional settings please
- * set corresponding properties directly, such as permissions, startsOn.
- *
- * WARNING: identifier will be ignored, permissions and expiresOn are required.
- *
- * @param blobSASSignatureValues -
- * @param userDelegationKeyCredential -
- */
-function generateBlobSASQueryParametersUDK20200210(blobSASSignatureValues, userDelegationKeyCredential) {
- blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
- // Stored access policies are not supported for a user delegation SAS.
- if (!blobSASSignatureValues.permissions || !blobSASSignatureValues.expiresOn) {
- throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when generating user delegation SAS.");
+ /**
+ * Returns the sku name and account kind
+ * @param options The options parameters.
+ */
+ getAccountInfo(options) {
+ return this.client.sendOperationRequest({ options }, getAccountInfoOperationSpec);
}
- let resource = "c";
- let timestamp = blobSASSignatureValues.snapshotTime;
- if (blobSASSignatureValues.blobName) {
- resource = "b";
- if (blobSASSignatureValues.snapshotTime) {
- resource = "bs";
- }
- else if (blobSASSignatureValues.versionId) {
- resource = "bv";
- timestamp = blobSASSignatureValues.versionId;
- }
+ /**
+ * The Query operation enables users to select/project on blob data by providing simple query
+ * expressions.
+ * @param options The options parameters.
+ */
+ query(options) {
+ return this.client.sendOperationRequest({ options }, queryOperationSpec);
}
- // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
- let verifiedPermissions;
- if (blobSASSignatureValues.permissions) {
- if (blobSASSignatureValues.blobName) {
- verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
- else {
- verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
+ /**
+ * The Get Tags operation enables users to get the tags associated with a blob.
+ * @param options The options parameters.
+ */
+ getTags(options) {
+ return this.client.sendOperationRequest({ options }, getTagsOperationSpec);
+ }
+ /**
+ * The Set Tags operation enables users to set tags on a blob.
+ * @param options The options parameters.
+ */
+ setTags(options) {
+ return this.client.sendOperationRequest({ options }, setTagsOperationSpec);
}
- // Signature is generated on the un-url-encoded values.
- const stringToSign = [
- verifiedPermissions ? verifiedPermissions : "",
- blobSASSignatureValues.startsOn
- ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
- : "",
- blobSASSignatureValues.expiresOn
- ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
- : "",
- getCanonicalName(userDelegationKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
- userDelegationKeyCredential.userDelegationKey.signedObjectId,
- userDelegationKeyCredential.userDelegationKey.signedTenantId,
- userDelegationKeyCredential.userDelegationKey.signedStartsOn
- ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedStartsOn, false)
- : "",
- userDelegationKeyCredential.userDelegationKey.signedExpiresOn
- ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedExpiresOn, false)
- : "",
- userDelegationKeyCredential.userDelegationKey.signedService,
- userDelegationKeyCredential.userDelegationKey.signedVersion,
- blobSASSignatureValues.preauthorizedAgentObjectId,
- undefined,
- blobSASSignatureValues.correlationId,
- blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
- blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
- blobSASSignatureValues.version,
- resource,
- timestamp,
- blobSASSignatureValues.cacheControl,
- blobSASSignatureValues.contentDisposition,
- blobSASSignatureValues.contentEncoding,
- blobSASSignatureValues.contentLanguage,
- blobSASSignatureValues.contentType,
- ].join("\n");
- const signature = userDelegationKeyCredential.computeHMACSHA256(stringToSign);
- return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType, userDelegationKeyCredential.userDelegationKey, blobSASSignatureValues.preauthorizedAgentObjectId, blobSASSignatureValues.correlationId);
}
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- * IMPLEMENTATION FOR API VERSION FROM 2020-12-06.
- *
- * Creates an instance of SASQueryParameters.
- *
- * Only accepts required settings needed to create a SAS. For optional settings please
- * set corresponding properties directly, such as permissions, startsOn.
- *
- * WARNING: identifier will be ignored, permissions and expiresOn are required.
+// Operation Specifications
+const xmlSerializer$3 = coreClient__namespace.createSerializer(Mappers, /* isXml */ true);
+const downloadOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: {
+ type: { name: "Stream" },
+ serializedName: "parsedResponse",
+ },
+ headersMapper: BlobDownloadHeaders,
+ },
+ 206: {
+ bodyMapper: {
+ type: { name: "Stream" },
+ serializedName: "parsedResponse",
+ },
+ headersMapper: BlobDownloadHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobDownloadExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ snapshot,
+ versionId,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ range,
+ rangeGetContentMD5,
+ rangeGetContentCRC64,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const getPropertiesOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "HEAD",
+ responses: {
+ 200: {
+ headersMapper: BlobGetPropertiesHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobGetPropertiesExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ snapshot,
+ versionId,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const deleteOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "DELETE",
+ responses: {
+ 202: {
+ headersMapper: BlobDeleteHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobDeleteExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ snapshot,
+ versionId,
+ blobDeleteType,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ deleteSnapshots,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const undeleteOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobUndeleteHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobUndeleteExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp8],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const setExpiryOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobSetExpiryHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobSetExpiryExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp11],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ expiryOptions,
+ expiresOn,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const setHttpHeadersOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobSetHttpHeadersHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobSetHttpHeadersExceptionHeaders,
+ },
+ },
+ queryParameters: [comp, timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ blobCacheControl,
+ blobContentType,
+ blobContentMD5,
+ blobContentEncoding,
+ blobContentLanguage,
+ blobContentDisposition,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const setImmutabilityPolicyOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobSetImmutabilityPolicyHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobSetImmutabilityPolicyExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp12],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifUnmodifiedSince,
+ immutabilityPolicyExpiry,
+ immutabilityPolicyMode,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const deleteImmutabilityPolicyOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "DELETE",
+ responses: {
+ 200: {
+ headersMapper: BlobDeleteImmutabilityPolicyHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobDeleteImmutabilityPolicyExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp12],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const setLegalHoldOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobSetLegalHoldHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobSetLegalHoldExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp13],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ legalHold,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const setMetadataOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobSetMetadataHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobSetMetadataExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp6],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ encryptionScope,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const acquireLeaseOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: BlobAcquireLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobAcquireLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp10],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ action,
+ duration,
+ proposedLeaseId,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const releaseLeaseOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobReleaseLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobReleaseLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp10],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ action1,
+ leaseId1,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const renewLeaseOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobRenewLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobRenewLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp10],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ leaseId1,
+ action2,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const changeLeaseOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobChangeLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobChangeLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp10],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ leaseId1,
+ action4,
+ proposedLeaseId1,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const breakLeaseOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 202: {
+ headersMapper: BlobBreakLeaseHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobBreakLeaseExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp10],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ action3,
+ breakPeriod,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const createSnapshotOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: BlobCreateSnapshotHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobCreateSnapshotExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp14],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ encryptionScope,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const startCopyFromURLOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 202: {
+ headersMapper: BlobStartCopyFromURLHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobStartCopyFromURLExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ immutabilityPolicyExpiry,
+ immutabilityPolicyMode,
+ tier,
+ rehydratePriority,
+ sourceIfModifiedSince,
+ sourceIfUnmodifiedSince,
+ sourceIfMatch,
+ sourceIfNoneMatch,
+ sourceIfTags,
+ copySource,
+ blobTagsString,
+ sealBlob,
+ legalHold1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const copyFromURLOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 202: {
+ headersMapper: BlobCopyFromURLHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobCopyFromURLExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ immutabilityPolicyExpiry,
+ immutabilityPolicyMode,
+ encryptionScope,
+ tier,
+ sourceIfModifiedSince,
+ sourceIfUnmodifiedSince,
+ sourceIfMatch,
+ sourceIfNoneMatch,
+ copySource,
+ blobTagsString,
+ legalHold1,
+ xMsRequiresSync,
+ sourceContentMD5,
+ copySourceAuthorization,
+ copySourceTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const abortCopyFromURLOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 204: {
+ headersMapper: BlobAbortCopyFromURLHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobAbortCopyFromURLExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ comp15,
+ copyId,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ copyActionAbortConstant,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const setTierOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: BlobSetTierHeaders,
+ },
+ 202: {
+ headersMapper: BlobSetTierHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobSetTierExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ snapshot,
+ versionId,
+ comp16,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifTags,
+ rehydratePriority,
+ tier1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const getAccountInfoOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ headersMapper: BlobGetAccountInfoHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobGetAccountInfoExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ comp,
+ timeoutInSeconds,
+ restype1,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const queryOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "POST",
+ responses: {
+ 200: {
+ bodyMapper: {
+ type: { name: "Stream" },
+ serializedName: "parsedResponse",
+ },
+ headersMapper: BlobQueryHeaders,
+ },
+ 206: {
+ bodyMapper: {
+ type: { name: "Stream" },
+ serializedName: "parsedResponse",
+ },
+ headersMapper: BlobQueryHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobQueryExceptionHeaders,
+ },
+ },
+ requestBody: queryRequest,
+ queryParameters: [
+ timeoutInSeconds,
+ snapshot,
+ comp17,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ contentType,
+ accept,
+ version,
+ requestId,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "xml",
+ serializer: xmlSerializer$3,
+};
+const getTagsOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: BlobTags,
+ headersMapper: BlobGetTagsHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobGetTagsExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ snapshot,
+ versionId,
+ comp18,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$3,
+};
+const setTagsOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 204: {
+ headersMapper: BlobSetTagsHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlobSetTagsExceptionHeaders,
+ },
+ },
+ requestBody: tags,
+ queryParameters: [
+ timeoutInSeconds,
+ versionId,
+ comp18,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ contentType,
+ accept,
+ version,
+ requestId,
+ leaseId,
+ ifTags,
+ transactionalContentMD5,
+ transactionalContentCrc64,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "xml",
+ serializer: xmlSerializer$3,
+};
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
*
- * @param blobSASSignatureValues -
- * @param userDelegationKeyCredential -
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
-function generateBlobSASQueryParametersUDK20201206(blobSASSignatureValues, userDelegationKeyCredential) {
- blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
- // Stored access policies are not supported for a user delegation SAS.
- if (!blobSASSignatureValues.permissions || !blobSASSignatureValues.expiresOn) {
- throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when generating user delegation SAS.");
- }
- let resource = "c";
- let timestamp = blobSASSignatureValues.snapshotTime;
- if (blobSASSignatureValues.blobName) {
- resource = "b";
- if (blobSASSignatureValues.snapshotTime) {
- resource = "bs";
- }
- else if (blobSASSignatureValues.versionId) {
- resource = "bv";
- timestamp = blobSASSignatureValues.versionId;
- }
+/** Class containing PageBlob operations. */
+class PageBlobImpl {
+ /**
+ * Initialize a new instance of the class PageBlob class.
+ * @param client Reference to the service client
+ */
+ constructor(client) {
+ this.client = client;
}
- // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
- let verifiedPermissions;
- if (blobSASSignatureValues.permissions) {
- if (blobSASSignatureValues.blobName) {
- verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
- else {
- verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
- }
+ /**
+ * The Create operation creates a new page blob.
+ * @param contentLength The length of the request.
+ * @param blobContentLength This header specifies the maximum size for the page blob, up to 1 TB. The
+ * page blob size must be aligned to a 512-byte boundary.
+ * @param options The options parameters.
+ */
+ create(contentLength, blobContentLength, options) {
+ return this.client.sendOperationRequest({ contentLength, blobContentLength, options }, createOperationSpec$1);
}
- // Signature is generated on the un-url-encoded values.
- const stringToSign = [
- verifiedPermissions ? verifiedPermissions : "",
- blobSASSignatureValues.startsOn
- ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
- : "",
- blobSASSignatureValues.expiresOn
- ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
- : "",
- getCanonicalName(userDelegationKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
- userDelegationKeyCredential.userDelegationKey.signedObjectId,
- userDelegationKeyCredential.userDelegationKey.signedTenantId,
- userDelegationKeyCredential.userDelegationKey.signedStartsOn
- ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedStartsOn, false)
- : "",
- userDelegationKeyCredential.userDelegationKey.signedExpiresOn
- ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedExpiresOn, false)
- : "",
- userDelegationKeyCredential.userDelegationKey.signedService,
- userDelegationKeyCredential.userDelegationKey.signedVersion,
- blobSASSignatureValues.preauthorizedAgentObjectId,
- undefined,
- blobSASSignatureValues.correlationId,
- blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
- blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
- blobSASSignatureValues.version,
- resource,
- timestamp,
- blobSASSignatureValues.encryptionScope,
- blobSASSignatureValues.cacheControl,
- blobSASSignatureValues.contentDisposition,
- blobSASSignatureValues.contentEncoding,
- blobSASSignatureValues.contentLanguage,
- blobSASSignatureValues.contentType,
- ].join("\n");
- const signature = userDelegationKeyCredential.computeHMACSHA256(stringToSign);
- return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType, userDelegationKeyCredential.userDelegationKey, blobSASSignatureValues.preauthorizedAgentObjectId, blobSASSignatureValues.correlationId, blobSASSignatureValues.encryptionScope);
-}
-function getCanonicalName(accountName, containerName, blobName) {
- // Container: "/blob/account/containerName"
- // Blob: "/blob/account/containerName/blobName"
- const elements = [`/blob/${accountName}/${containerName}`];
- if (blobName) {
- elements.push(`/${blobName}`);
+ /**
+ * The Upload Pages operation writes a range of pages to a page blob
+ * @param contentLength The length of the request.
+ * @param body Initial data
+ * @param options The options parameters.
+ */
+ uploadPages(contentLength, body, options) {
+ return this.client.sendOperationRequest({ contentLength, body, options }, uploadPagesOperationSpec);
}
- return elements.join("");
-}
-function SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues) {
- const version = blobSASSignatureValues.version ? blobSASSignatureValues.version : SERVICE_VERSION;
- if (blobSASSignatureValues.snapshotTime && version < "2018-11-09") {
- throw RangeError("'version' must be >= '2018-11-09' when providing 'snapshotTime'.");
+ /**
+ * The Clear Pages operation clears a set of pages from a page blob
+ * @param contentLength The length of the request.
+ * @param options The options parameters.
+ */
+ clearPages(contentLength, options) {
+ return this.client.sendOperationRequest({ contentLength, options }, clearPagesOperationSpec);
}
- if (blobSASSignatureValues.blobName === undefined && blobSASSignatureValues.snapshotTime) {
- throw RangeError("Must provide 'blobName' when providing 'snapshotTime'.");
+ /**
+ * The Upload Pages operation writes a range of pages to a page blob where the contents are read from a
+ * URL
+ * @param sourceUrl Specify a URL to the copy source.
+ * @param sourceRange Bytes of source data in the specified range. The length of this range should
+ * match the ContentLength header and x-ms-range/Range destination range header.
+ * @param contentLength The length of the request.
+ * @param range The range of bytes to which the source range would be written. The range should be 512
+ * aligned and range-end is required.
+ * @param options The options parameters.
+ */
+ uploadPagesFromURL(sourceUrl, sourceRange, contentLength, range, options) {
+ return this.client.sendOperationRequest({ sourceUrl, sourceRange, contentLength, range, options }, uploadPagesFromURLOperationSpec);
}
- if (blobSASSignatureValues.versionId && version < "2019-10-10") {
- throw RangeError("'version' must be >= '2019-10-10' when providing 'versionId'.");
+ /**
+ * The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a
+ * page blob
+ * @param options The options parameters.
+ */
+ getPageRanges(options) {
+ return this.client.sendOperationRequest({ options }, getPageRangesOperationSpec);
}
- if (blobSASSignatureValues.blobName === undefined && blobSASSignatureValues.versionId) {
- throw RangeError("Must provide 'blobName' when providing 'versionId'.");
+ /**
+ * The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were
+ * changed between target blob and previous snapshot.
+ * @param options The options parameters.
+ */
+ getPageRangesDiff(options) {
+ return this.client.sendOperationRequest({ options }, getPageRangesDiffOperationSpec);
}
- if (blobSASSignatureValues.permissions &&
- blobSASSignatureValues.permissions.setImmutabilityPolicy &&
- version < "2020-08-04") {
- throw RangeError("'version' must be >= '2020-08-04' when provided 'i' permission.");
+ /**
+ * Resize the Blob
+ * @param blobContentLength This header specifies the maximum size for the page blob, up to 1 TB. The
+ * page blob size must be aligned to a 512-byte boundary.
+ * @param options The options parameters.
+ */
+ resize(blobContentLength, options) {
+ return this.client.sendOperationRequest({ blobContentLength, options }, resizeOperationSpec);
}
- if (blobSASSignatureValues.permissions &&
- blobSASSignatureValues.permissions.deleteVersion &&
- version < "2019-10-10") {
- throw RangeError("'version' must be >= '2019-10-10' when providing 'x' permission.");
+ /**
+ * Update the sequence number of the blob
+ * @param sequenceNumberAction Required if the x-ms-blob-sequence-number header is set for the request.
+ * This property applies to page blobs only. This property indicates how the service should modify the
+ * blob's sequence number
+ * @param options The options parameters.
+ */
+ updateSequenceNumber(sequenceNumberAction, options) {
+ return this.client.sendOperationRequest({ sequenceNumberAction, options }, updateSequenceNumberOperationSpec);
}
- if (blobSASSignatureValues.permissions &&
- blobSASSignatureValues.permissions.permanentDelete &&
- version < "2019-10-10") {
- throw RangeError("'version' must be >= '2019-10-10' when providing 'y' permission.");
+ /**
+ * The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob.
+ * The snapshot is copied such that only the differential changes between the previously copied
+ * snapshot are transferred to the destination. The copied snapshots are complete copies of the
+ * original snapshot and can be read or copied from as usual. This API is supported since REST version
+ * 2016-05-31.
+ * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
+ * 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
+ * appear in a request URI. The source blob must either be public or must be authenticated via a shared
+ * access signature.
+ * @param options The options parameters.
+ */
+ copyIncremental(copySource, options) {
+ return this.client.sendOperationRequest({ copySource, options }, copyIncrementalOperationSpec);
}
- if (blobSASSignatureValues.permissions &&
- blobSASSignatureValues.permissions.tag &&
- version < "2019-12-12") {
- throw RangeError("'version' must be >= '2019-12-12' when providing 't' permission.");
+}
+// Operation Specifications
+const xmlSerializer$2 = coreClient__namespace.createSerializer(Mappers, /* isXml */ true);
+const createOperationSpec$1 = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: PageBlobCreateHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobCreateExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ contentLength,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ blobCacheControl,
+ blobContentType,
+ blobContentMD5,
+ blobContentEncoding,
+ blobContentLanguage,
+ blobContentDisposition,
+ immutabilityPolicyExpiry,
+ immutabilityPolicyMode,
+ encryptionScope,
+ tier,
+ blobTagsString,
+ legalHold1,
+ blobType,
+ blobContentLength,
+ blobSequenceNumber,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$2,
+};
+const uploadPagesOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: PageBlobUploadPagesHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobUploadPagesExceptionHeaders,
+ },
+ },
+ requestBody: body1,
+ queryParameters: [timeoutInSeconds, comp19],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ contentLength,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ range,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ encryptionScope,
+ transactionalContentMD5,
+ transactionalContentCrc64,
+ contentType1,
+ accept2,
+ pageWrite,
+ ifSequenceNumberLessThanOrEqualTo,
+ ifSequenceNumberLessThan,
+ ifSequenceNumberEqualTo,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "binary",
+ serializer: xmlSerializer$2,
+};
+const clearPagesOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: PageBlobClearPagesHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobClearPagesExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp19],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ contentLength,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ range,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ encryptionScope,
+ ifSequenceNumberLessThanOrEqualTo,
+ ifSequenceNumberLessThan,
+ ifSequenceNumberEqualTo,
+ pageWrite1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$2,
+};
+const uploadPagesFromURLOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: PageBlobUploadPagesFromURLHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobUploadPagesFromURLExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp19],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ contentLength,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ encryptionScope,
+ sourceIfModifiedSince,
+ sourceIfUnmodifiedSince,
+ sourceIfMatch,
+ sourceIfNoneMatch,
+ sourceContentMD5,
+ copySourceAuthorization,
+ pageWrite,
+ ifSequenceNumberLessThanOrEqualTo,
+ ifSequenceNumberLessThan,
+ ifSequenceNumberEqualTo,
+ sourceUrl,
+ sourceRange,
+ sourceContentCrc64,
+ range1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$2,
+};
+const getPageRangesOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: PageList,
+ headersMapper: PageBlobGetPageRangesHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobGetPageRangesExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ marker,
+ maxPageSize,
+ snapshot,
+ comp20,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ range,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$2,
+};
+const getPageRangesDiffOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: PageList,
+ headersMapper: PageBlobGetPageRangesDiffHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobGetPageRangesDiffExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ marker,
+ maxPageSize,
+ snapshot,
+ comp20,
+ prevsnapshot,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ range,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ prevSnapshotUrl,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$2,
+};
+const resizeOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: PageBlobResizeHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobResizeExceptionHeaders,
+ },
+ },
+ queryParameters: [comp, timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ encryptionScope,
+ blobContentLength,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$2,
+};
+const updateSequenceNumberOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: PageBlobUpdateSequenceNumberHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobUpdateSequenceNumberExceptionHeaders,
+ },
+ },
+ queryParameters: [comp, timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ blobSequenceNumber,
+ sequenceNumberAction,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$2,
+};
+const copyIncrementalOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 202: {
+ headersMapper: PageBlobCopyIncrementalHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: PageBlobCopyIncrementalExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp21],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ copySource,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$2,
+};
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+/** Class containing AppendBlob operations. */
+class AppendBlobImpl {
+ /**
+ * Initialize a new instance of the class AppendBlob class.
+ * @param client Reference to the service client
+ */
+ constructor(client) {
+ this.client = client;
}
- if (version < "2020-02-10" &&
- blobSASSignatureValues.permissions &&
- (blobSASSignatureValues.permissions.move || blobSASSignatureValues.permissions.execute)) {
- throw RangeError("'version' must be >= '2020-02-10' when providing the 'm' or 'e' permission.");
+ /**
+ * The Create Append Blob operation creates a new append blob.
+ * @param contentLength The length of the request.
+ * @param options The options parameters.
+ */
+ create(contentLength, options) {
+ return this.client.sendOperationRequest({ contentLength, options }, createOperationSpec);
}
- if (version < "2021-04-10" &&
- blobSASSignatureValues.permissions &&
- blobSASSignatureValues.permissions.filterByTags) {
- throw RangeError("'version' must be >= '2021-04-10' when providing the 'f' permission.");
+ /**
+ * The Append Block operation commits a new block of data to the end of an existing append blob. The
+ * Append Block operation is permitted only if the blob was created with x-ms-blob-type set to
+ * AppendBlob. Append Block is supported only on version 2015-02-21 version or later.
+ * @param contentLength The length of the request.
+ * @param body Initial data
+ * @param options The options parameters.
+ */
+ appendBlock(contentLength, body, options) {
+ return this.client.sendOperationRequest({ contentLength, body, options }, appendBlockOperationSpec);
}
- if (version < "2020-02-10" &&
- (blobSASSignatureValues.preauthorizedAgentObjectId || blobSASSignatureValues.correlationId)) {
- throw RangeError("'version' must be >= '2020-02-10' when providing 'preauthorizedAgentObjectId' or 'correlationId'.");
+ /**
+ * The Append Block operation commits a new block of data to the end of an existing append blob where
+ * the contents are read from a source url. The Append Block operation is permitted only if the blob
+ * was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version
+ * 2015-02-21 version or later.
+ * @param sourceUrl Specify a URL to the copy source.
+ * @param contentLength The length of the request.
+ * @param options The options parameters.
+ */
+ appendBlockFromUrl(sourceUrl, contentLength, options) {
+ return this.client.sendOperationRequest({ sourceUrl, contentLength, options }, appendBlockFromUrlOperationSpec);
}
- if (blobSASSignatureValues.encryptionScope && version < "2020-12-06") {
- throw RangeError("'version' must be >= '2020-12-06' when provided 'encryptionScope' in SAS.");
+ /**
+ * The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version
+ * 2019-12-12 version or later.
+ * @param options The options parameters.
+ */
+ seal(options) {
+ return this.client.sendOperationRequest({ options }, sealOperationSpec);
}
- blobSASSignatureValues.version = version;
- return blobSASSignatureValues;
}
+// Operation Specifications
+const xmlSerializer$1 = coreClient__namespace.createSerializer(Mappers, /* isXml */ true);
+const createOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: AppendBlobCreateHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: AppendBlobCreateExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ contentLength,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ blobCacheControl,
+ blobContentType,
+ blobContentMD5,
+ blobContentEncoding,
+ blobContentLanguage,
+ blobContentDisposition,
+ immutabilityPolicyExpiry,
+ immutabilityPolicyMode,
+ encryptionScope,
+ blobTagsString,
+ legalHold1,
+ blobType1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$1,
+};
+const appendBlockOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: AppendBlobAppendBlockHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: AppendBlobAppendBlockExceptionHeaders,
+ },
+ },
+ requestBody: body1,
+ queryParameters: [timeoutInSeconds, comp22],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ contentLength,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ encryptionScope,
+ transactionalContentMD5,
+ transactionalContentCrc64,
+ contentType1,
+ accept2,
+ maxSize,
+ appendPosition,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "binary",
+ serializer: xmlSerializer$1,
+};
+const appendBlockFromUrlOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: AppendBlobAppendBlockFromUrlHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: AppendBlobAppendBlockFromUrlExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp22],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ contentLength,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ encryptionScope,
+ sourceIfModifiedSince,
+ sourceIfUnmodifiedSince,
+ sourceIfMatch,
+ sourceIfNoneMatch,
+ sourceContentMD5,
+ copySourceAuthorization,
+ transactionalContentMD5,
+ sourceUrl,
+ sourceContentCrc64,
+ maxSize,
+ appendPosition,
+ sourceRange1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$1,
+};
+const sealOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 200: {
+ headersMapper: AppendBlobSealHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: AppendBlobSealExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds, comp23],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ ifMatch,
+ ifNoneMatch,
+ appendPosition,
+ ],
+ isXML: true,
+ serializer: xmlSerializer$1,
+};
-// Copyright (c) Microsoft Corporation.
-/**
- * A client that manages leases for a {@link ContainerClient} or a {@link BlobClient}.
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
*/
-class BlobLeaseClient {
+/** Class containing BlockBlob operations. */
+class BlockBlobImpl {
/**
- * Creates an instance of BlobLeaseClient.
- * @param client - The client to make the lease operation requests.
- * @param leaseId - Initial proposed lease id.
+ * Initialize a new instance of the class BlockBlob class.
+ * @param client Reference to the service client
*/
- constructor(client, leaseId) {
- const clientContext = new StorageClientContext(client.url, client.pipeline.toServiceClientOptions());
- this._url = client.url;
- if (client.name === undefined) {
- this._isContainer = true;
- this._containerOrBlobOperation = new Container(clientContext);
- }
- else {
- this._isContainer = false;
- this._containerOrBlobOperation = new Blob$1(clientContext);
- }
- if (!leaseId) {
- leaseId = coreHttp.generateUuid();
- }
- this._leaseId = leaseId;
+ constructor(client) {
+ this.client = client;
}
/**
- * Gets the lease Id.
- *
- * @readonly
+ * The Upload Block Blob operation updates the content of an existing block blob. Updating an existing
+ * block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put
+ * Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a
+ * partial update of the content of a block blob, use the Put Block List operation.
+ * @param contentLength The length of the request.
+ * @param body Initial data
+ * @param options The options parameters.
*/
- get leaseId() {
- return this._leaseId;
+ upload(contentLength, body, options) {
+ return this.client.sendOperationRequest({ contentLength, body, options }, uploadOperationSpec);
}
/**
- * Gets the url.
- *
- * @readonly
+ * The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read
+ * from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are
+ * not supported with Put Blob from URL; the content of an existing blob is overwritten with the
+ * content of the new blob. To perform partial updates to a block blob’s contents using a source URL,
+ * use the Put Block from URL API in conjunction with Put Block List.
+ * @param contentLength The length of the request.
+ * @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
+ * 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
+ * appear in a request URI. The source blob must either be public or must be authenticated via a shared
+ * access signature.
+ * @param options The options parameters.
*/
- get url() {
- return this._url;
+ putBlobFromUrl(contentLength, copySource, options) {
+ return this.client.sendOperationRequest({ contentLength, copySource, options }, putBlobFromUrlOperationSpec);
}
/**
- * Establishes and manages a lock on a container for delete operations, or on a blob
- * for write and delete operations.
- * The lock duration can be 15 to 60 seconds, or can be infinite.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
- * and
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
- *
- * @param duration - Must be between 15 to 60 seconds, or infinite (-1)
- * @param options - option to configure lease management operations.
- * @returns Response data for acquire lease operation.
+ * The Stage Block operation creates a new block to be committed as part of a blob
+ * @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
+ * must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
+ * for the blockid parameter must be the same size for each block.
+ * @param contentLength The length of the request.
+ * @param body Initial data
+ * @param options The options parameters.
*/
- async acquireLease(duration, options = {}) {
- var _a, _b, _c, _d, _e, _f;
- const { span, updatedOptions } = createSpan("BlobLeaseClient-acquireLease", options);
- if (this._isContainer &&
- ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
- (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
- ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
- throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
- }
- try {
- return await this._containerOrBlobOperation.acquireLease(Object.assign({ abortSignal: options.abortSignal, duration, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_f = options.conditions) === null || _f === void 0 ? void 0 : _f.tagConditions }), proposedLeaseId: this._leaseId }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ stageBlock(blockId, contentLength, body, options) {
+ return this.client.sendOperationRequest({ blockId, contentLength, body, options }, stageBlockOperationSpec);
}
/**
- * To change the ID of the lease.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
- * and
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
- *
- * @param proposedLeaseId - the proposed new lease Id.
- * @param options - option to configure lease management operations.
- * @returns Response data for change lease operation.
+ * The Stage Block operation creates a new block to be committed as part of a blob where the contents
+ * are read from a URL.
+ * @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
+ * must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
+ * for the blockid parameter must be the same size for each block.
+ * @param contentLength The length of the request.
+ * @param sourceUrl Specify a URL to the copy source.
+ * @param options The options parameters.
*/
- async changeLease(proposedLeaseId, options = {}) {
- var _a, _b, _c, _d, _e, _f;
- const { span, updatedOptions } = createSpan("BlobLeaseClient-changeLease", options);
- if (this._isContainer &&
- ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
- (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
- ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
- throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
- }
- try {
- const response = await this._containerOrBlobOperation.changeLease(this._leaseId, proposedLeaseId, Object.assign({ abortSignal: options.abortSignal, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_f = options.conditions) === null || _f === void 0 ? void 0 : _f.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- this._leaseId = proposedLeaseId;
- return response;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ stageBlockFromURL(blockId, contentLength, sourceUrl, options) {
+ return this.client.sendOperationRequest({ blockId, contentLength, sourceUrl, options }, stageBlockFromURLOperationSpec);
}
/**
- * To free the lease if it is no longer needed so that another client may
- * immediately acquire a lease against the container or the blob.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
- * and
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
- *
- * @param options - option to configure lease management operations.
- * @returns Response data for release lease operation.
+ * The Commit Block List operation writes a blob by specifying the list of block IDs that make up the
+ * blob. In order to be written as part of a blob, a block must have been successfully written to the
+ * server in a prior Put Block operation. You can call Put Block List to update a blob by uploading
+ * only those blocks that have changed, then committing the new and existing blocks together. You can
+ * do this by specifying whether to commit a block from the committed block list or from the
+ * uncommitted block list, or to commit the most recently uploaded version of the block, whichever list
+ * it may belong to.
+ * @param blocks Blob Blocks.
+ * @param options The options parameters.
*/
- async releaseLease(options = {}) {
- var _a, _b, _c, _d, _e, _f;
- const { span, updatedOptions } = createSpan("BlobLeaseClient-releaseLease", options);
- if (this._isContainer &&
- ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
- (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
- ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
- throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
- }
- try {
- return await this._containerOrBlobOperation.releaseLease(this._leaseId, Object.assign({ abortSignal: options.abortSignal, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_f = options.conditions) === null || _f === void 0 ? void 0 : _f.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ commitBlockList(blocks, options) {
+ return this.client.sendOperationRequest({ blocks, options }, commitBlockListOperationSpec);
}
/**
- * To renew the lease.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
- * and
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
- *
- * @param options - Optional option to configure lease management operations.
- * @returns Response data for renew lease operation.
+ * The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block
+ * blob
+ * @param listType Specifies whether to return the list of committed blocks, the list of uncommitted
+ * blocks, or both lists together.
+ * @param options The options parameters.
*/
- async renewLease(options = {}) {
- var _a, _b, _c, _d, _e, _f;
- const { span, updatedOptions } = createSpan("BlobLeaseClient-renewLease", options);
- if (this._isContainer &&
- ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
- (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
- ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
- throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
- }
- try {
- return await this._containerOrBlobOperation.renewLease(this._leaseId, Object.assign({ abortSignal: options.abortSignal, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_f = options.conditions) === null || _f === void 0 ? void 0 : _f.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ getBlockList(listType, options) {
+ return this.client.sendOperationRequest({ listType, options }, getBlockListOperationSpec);
}
+}
+// Operation Specifications
+const xmlSerializer = coreClient__namespace.createSerializer(Mappers, /* isXml */ true);
+const uploadOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: BlockBlobUploadHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlockBlobUploadExceptionHeaders,
+ },
+ },
+ requestBody: body1,
+ queryParameters: [timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ contentLength,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ blobCacheControl,
+ blobContentType,
+ blobContentMD5,
+ blobContentEncoding,
+ blobContentLanguage,
+ blobContentDisposition,
+ immutabilityPolicyExpiry,
+ immutabilityPolicyMode,
+ encryptionScope,
+ tier,
+ blobTagsString,
+ legalHold1,
+ transactionalContentMD5,
+ transactionalContentCrc64,
+ contentType1,
+ accept2,
+ blobType2,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "binary",
+ serializer: xmlSerializer,
+};
+const putBlobFromUrlOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: BlockBlobPutBlobFromUrlHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlockBlobPutBlobFromUrlExceptionHeaders,
+ },
+ },
+ queryParameters: [timeoutInSeconds],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ contentLength,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ blobCacheControl,
+ blobContentType,
+ blobContentMD5,
+ blobContentEncoding,
+ blobContentLanguage,
+ blobContentDisposition,
+ encryptionScope,
+ tier,
+ sourceIfModifiedSince,
+ sourceIfUnmodifiedSince,
+ sourceIfMatch,
+ sourceIfNoneMatch,
+ sourceIfTags,
+ copySource,
+ blobTagsString,
+ sourceContentMD5,
+ copySourceAuthorization,
+ copySourceTags,
+ transactionalContentMD5,
+ blobType2,
+ copySourceBlobProperties,
+ ],
+ isXML: true,
+ serializer: xmlSerializer,
+};
+const stageBlockOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: BlockBlobStageBlockHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlockBlobStageBlockExceptionHeaders,
+ },
+ },
+ requestBody: body1,
+ queryParameters: [
+ timeoutInSeconds,
+ comp24,
+ blockId,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ contentLength,
+ leaseId,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ encryptionScope,
+ transactionalContentMD5,
+ transactionalContentCrc64,
+ contentType1,
+ accept2,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "binary",
+ serializer: xmlSerializer,
+};
+const stageBlockFromURLOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: BlockBlobStageBlockFromURLHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlockBlobStageBlockFromURLExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ comp24,
+ blockId,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ contentLength,
+ leaseId,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ encryptionScope,
+ sourceIfModifiedSince,
+ sourceIfUnmodifiedSince,
+ sourceIfMatch,
+ sourceIfNoneMatch,
+ sourceContentMD5,
+ copySourceAuthorization,
+ sourceUrl,
+ sourceContentCrc64,
+ sourceRange1,
+ ],
+ isXML: true,
+ serializer: xmlSerializer,
+};
+const commitBlockListOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "PUT",
+ responses: {
+ 201: {
+ headersMapper: BlockBlobCommitBlockListHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlockBlobCommitBlockListExceptionHeaders,
+ },
+ },
+ requestBody: blocks,
+ queryParameters: [timeoutInSeconds, comp25],
+ urlParameters: [url],
+ headerParameters: [
+ contentType,
+ accept,
+ version,
+ requestId,
+ metadata,
+ leaseId,
+ ifModifiedSince,
+ ifUnmodifiedSince,
+ encryptionKey,
+ encryptionKeySha256,
+ encryptionAlgorithm,
+ ifMatch,
+ ifNoneMatch,
+ ifTags,
+ blobCacheControl,
+ blobContentType,
+ blobContentMD5,
+ blobContentEncoding,
+ blobContentLanguage,
+ blobContentDisposition,
+ immutabilityPolicyExpiry,
+ immutabilityPolicyMode,
+ encryptionScope,
+ tier,
+ blobTagsString,
+ legalHold1,
+ transactionalContentMD5,
+ transactionalContentCrc64,
+ ],
+ isXML: true,
+ contentType: "application/xml; charset=utf-8",
+ mediaType: "xml",
+ serializer: xmlSerializer,
+};
+const getBlockListOperationSpec = {
+ path: "/{containerName}/{blob}",
+ httpMethod: "GET",
+ responses: {
+ 200: {
+ bodyMapper: BlockList,
+ headersMapper: BlockBlobGetBlockListHeaders,
+ },
+ default: {
+ bodyMapper: StorageError,
+ headersMapper: BlockBlobGetBlockListExceptionHeaders,
+ },
+ },
+ queryParameters: [
+ timeoutInSeconds,
+ snapshot,
+ comp25,
+ listType,
+ ],
+ urlParameters: [url],
+ headerParameters: [
+ version,
+ requestId,
+ accept1,
+ leaseId,
+ ifTags,
+ ],
+ isXML: true,
+ serializer: xmlSerializer,
+};
+
+/*
+ * Copyright (c) Microsoft Corporation.
+ * Licensed under the MIT License.
+ *
+ * Code generated by Microsoft (R) AutoRest Code Generator.
+ * Changes may cause incorrect behavior and will be lost if the code is regenerated.
+ */
+let StorageClient$1 = class StorageClient extends coreHttpCompat__namespace.ExtendedServiceClient {
/**
- * To end the lease but ensure that another client cannot acquire a new lease
- * until the current lease period has expired.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
- * and
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
- *
- * @param breakPeriod - Break period
- * @param options - Optional options to configure lease management operations.
- * @returns Response data for break lease operation.
+ * Initializes a new instance of the StorageClient class.
+ * @param url The URL of the service account, container, or blob that is the target of the desired
+ * operation.
+ * @param options The parameter options
*/
- async breakLease(breakPeriod, options = {}) {
- var _a, _b, _c, _d, _e, _f;
- const { span, updatedOptions } = createSpan("BlobLeaseClient-breakLease", options);
- if (this._isContainer &&
- ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
- (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
- ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
- throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
- }
- try {
- const operationOptions = Object.assign({ abortSignal: options.abortSignal, breakPeriod, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_f = options.conditions) === null || _f === void 0 ? void 0 : _f.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions));
- return await this._containerOrBlobOperation.breakLease(operationOptions);
+ constructor(url, options) {
+ var _a, _b;
+ if (url === undefined) {
+ throw new Error("'url' cannot be null");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ // Initializing default values for options
+ if (!options) {
+ options = {};
}
- finally {
- span.end();
+ const defaults = {
+ requestContentType: "application/json; charset=utf-8",
+ };
+ const packageDetails = `azsdk-js-azure-storage-blob/12.24.0`;
+ const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
+ ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
+ : `${packageDetails}`;
+ const optionsWithDefaults = Object.assign(Object.assign(Object.assign({}, defaults), options), { userAgentOptions: {
+ userAgentPrefix,
+ }, endpoint: (_b = (_a = options.endpoint) !== null && _a !== void 0 ? _a : options.baseUri) !== null && _b !== void 0 ? _b : "{url}" });
+ super(optionsWithDefaults);
+ // Parameter assignments
+ this.url = url;
+ // Assigning values to Constant parameters
+ this.version = options.version || "2024-08-04";
+ this.service = new ServiceImpl(this);
+ this.container = new ContainerImpl(this);
+ this.blob = new BlobImpl(this);
+ this.pageBlob = new PageBlobImpl(this);
+ this.appendBlob = new AppendBlobImpl(this);
+ this.blockBlob = new BlockBlobImpl(this);
+ }
+};
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * @internal
+ */
+class StorageContextClient extends StorageClient$1 {
+ async sendOperationRequest(operationArguments, operationSpec) {
+ const operationSpecToSend = Object.assign({}, operationSpec);
+ if (operationSpecToSend.path === "/{containerName}" ||
+ operationSpecToSend.path === "/{containerName}/{blob}") {
+ operationSpecToSend.path = "";
}
+ return super.sendOperationRequest(operationArguments, operationSpecToSend);
}
}
// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * A Node.js ReadableStream will internally retry when internal ReadableStream unexpected ends.
+ * A StorageClient represents a based URL class for {@link BlobServiceClient}, {@link ContainerClient}
+ * and etc.
*/
-class RetriableReadableStream extends stream.Readable {
+class StorageClient {
/**
- * Creates an instance of RetriableReadableStream.
- *
- * @param source - The current ReadableStream returned from getter
- * @param getter - A method calling downloading request returning
- * a new ReadableStream from specified offset
- * @param offset - Offset position in original data source to read
- * @param count - How much data in original data source to read
- * @param options -
+ * Creates an instance of StorageClient.
+ * @param url - url to resource
+ * @param pipeline - request policy pipeline.
*/
- constructor(source, getter, offset, count, options = {}) {
- super({ highWaterMark: options.highWaterMark });
- this.retries = 0;
- this.sourceDataHandler = (data) => {
- if (this.options.doInjectErrorOnce) {
- this.options.doInjectErrorOnce = undefined;
- this.source.pause();
- this.source.removeAllListeners("data");
- this.source.emit("end");
- return;
- }
- // console.log(
- // `Offset: ${this.offset}, Received ${data.length} from internal stream`
- // );
- this.offset += data.length;
- if (this.onProgress) {
- this.onProgress({ loadedBytes: this.offset - this.start });
- }
- if (!this.push(data)) {
- this.source.pause();
- }
- };
- this.sourceErrorOrEndHandler = (err) => {
- if (err && err.name === "AbortError") {
- this.destroy(err);
- return;
- }
- // console.log(
- // `Source stream emits end or error, offset: ${
- // this.offset
- // }, dest end : ${this.end}`
- // );
- this.removeSourceEventHandlers();
- if (this.offset - 1 === this.end) {
- this.push(null);
- }
- else if (this.offset <= this.end) {
- // console.log(
- // `retries: ${this.retries}, max retries: ${this.maxRetries}`
- // );
- if (this.retries < this.maxRetryRequests) {
- this.retries += 1;
- this.getter(this.offset)
- .then((newSource) => {
- this.source = newSource;
- this.setSourceEventHandlers();
- return;
- })
- .catch((error) => {
- this.destroy(error);
- });
- }
- else {
- this.destroy(new Error(`Data corruption failure: received less data than required and reached maxRetires limitation. Received data offset: ${this.offset - 1}, data needed offset: ${this.end}, retries: ${this.retries}, max retries: ${this.maxRetryRequests}`));
- }
- }
- else {
- this.destroy(new Error(`Data corruption failure: Received more data than original request, data needed offset is ${this.end}, received offset: ${this.offset - 1}`));
- }
- };
- this.getter = getter;
- this.source = source;
- this.start = offset;
- this.offset = offset;
- this.end = offset + count - 1;
- this.maxRetryRequests =
- options.maxRetryRequests && options.maxRetryRequests >= 0 ? options.maxRetryRequests : 0;
- this.onProgress = options.onProgress;
- this.options = options;
- this.setSourceEventHandlers();
- }
- _read() {
- this.source.resume();
- }
- setSourceEventHandlers() {
- this.source.on("data", this.sourceDataHandler);
- this.source.on("end", this.sourceErrorOrEndHandler);
- this.source.on("error", this.sourceErrorOrEndHandler);
- }
- removeSourceEventHandlers() {
- this.source.removeListener("data", this.sourceDataHandler);
- this.source.removeListener("end", this.sourceErrorOrEndHandler);
- this.source.removeListener("error", this.sourceErrorOrEndHandler);
- }
- _destroy(error, callback) {
- // remove listener from source and release source
- this.removeSourceEventHandlers();
- this.source.destroy();
- callback(error === null ? undefined : error);
+ constructor(url, pipeline) {
+ // URL should be encoded and only once, protocol layer shouldn't encode URL again
+ this.url = escapeURLPath(url);
+ this.accountName = getAccountNameFromUrl(url);
+ this.pipeline = pipeline;
+ this.storageClientContext = new StorageContextClient(this.url, getCoreClientOptions(pipeline));
+ this.isHttps = iEqual(getURLScheme(this.url) || "", "https");
+ this.credential = getCredentialFromPipeline(pipeline);
+ // Override protocol layer's default content-type
+ const storageClientContext = this.storageClientContext;
+ storageClientContext.requestContentType = undefined;
}
}
// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Creates a span using the global tracer.
+ * @internal
+ */
+const tracingClient = coreTracing.createTracingClient({
+ packageName: "@azure/storage-blob",
+ packageVersion: SDK_VERSION,
+ namespace: "Microsoft.Storage",
+});
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
- * BlobDownloadResponse implements BlobDownloadResponseParsed interface, and in Node.js runtime it will
- * automatically retry when internal read stream unexpected ends. (This kind of unexpected ends cannot
- * trigger retries defined in pipeline retry policy.)
- *
- * The {@link readableStreamBody} stream will retry underlayer, you can just use it as a normal Node.js
- * Readable stream.
+ * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a blob. Setting
+ * a value to true means that any SAS which uses these permissions will grant permissions for that operation. Once all
+ * the values are set, this should be serialized with toString and set as the permissions field on a
+ * {@link BlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but
+ * the order of the permissions is particular and this class guarantees correctness.
*/
-class BlobDownloadResponse {
- /**
- * Creates an instance of BlobDownloadResponse.
- *
- * @param originalResponse -
- * @param getter -
- * @param offset -
- * @param count -
- * @param options -
- */
- constructor(originalResponse, getter, offset, count, options = {}) {
- this.originalResponse = originalResponse;
- this.blobDownloadStream = new RetriableReadableStream(this.originalResponse.readableStreamBody, getter, offset, count, options);
- }
- /**
- * Indicates that the service supports
- * requests for partial file content.
- *
- * @readonly
- */
- get acceptRanges() {
- return this.originalResponse.acceptRanges;
- }
- /**
- * Returns if it was previously specified
- * for the file.
- *
- * @readonly
- */
- get cacheControl() {
- return this.originalResponse.cacheControl;
- }
- /**
- * Returns the value that was specified
- * for the 'x-ms-content-disposition' header and specifies how to process the
- * response.
- *
- * @readonly
- */
- get contentDisposition() {
- return this.originalResponse.contentDisposition;
- }
- /**
- * Returns the value that was specified
- * for the Content-Encoding request header.
- *
- * @readonly
- */
- get contentEncoding() {
- return this.originalResponse.contentEncoding;
- }
- /**
- * Returns the value that was specified
- * for the Content-Language request header.
- *
- * @readonly
- */
- get contentLanguage() {
- return this.originalResponse.contentLanguage;
- }
- /**
- * The current sequence number for a
- * page blob. This header is not returned for block blobs or append blobs.
- *
- * @readonly
- */
- get blobSequenceNumber() {
- return this.originalResponse.blobSequenceNumber;
- }
- /**
- * The blob's type. Possible values include:
- * 'BlockBlob', 'PageBlob', 'AppendBlob'.
- *
- * @readonly
- */
- get blobType() {
- return this.originalResponse.blobType;
- }
- /**
- * The number of bytes present in the
- * response body.
- *
- * @readonly
- */
- get contentLength() {
- return this.originalResponse.contentLength;
- }
- /**
- * If the file has an MD5 hash and the
- * request is to read the full file, this response header is returned so that
- * the client can check for message content integrity. If the request is to
- * read a specified range and the 'x-ms-range-get-content-md5' is set to
- * true, then the request returns an MD5 hash for the range, as long as the
- * range size is less than or equal to 4 MB. If neither of these sets of
- * conditions is true, then no value is returned for the 'Content-MD5'
- * header.
- *
- * @readonly
- */
- get contentMD5() {
- return this.originalResponse.contentMD5;
- }
- /**
- * Indicates the range of bytes returned if
- * the client requested a subset of the file by setting the Range request
- * header.
- *
- * @readonly
- */
- get contentRange() {
- return this.originalResponse.contentRange;
- }
- /**
- * The content type specified for the file.
- * The default content type is 'application/octet-stream'
- *
- * @readonly
- */
- get contentType() {
- return this.originalResponse.contentType;
- }
- /**
- * Conclusion time of the last attempted
- * Copy File operation where this file was the destination file. This value
- * can specify the time of a completed, aborted, or failed copy attempt.
- *
- * @readonly
- */
- get copyCompletedOn() {
- return this.originalResponse.copyCompletedOn;
- }
- /**
- * String identifier for the last attempted Copy
- * File operation where this file was the destination file.
- *
- * @readonly
- */
- get copyId() {
- return this.originalResponse.copyId;
- }
- /**
- * Contains the number of bytes copied and
- * the total bytes in the source in the last attempted Copy File operation
- * where this file was the destination file. Can show between 0 and
- * Content-Length bytes copied.
- *
- * @readonly
- */
- get copyProgress() {
- return this.originalResponse.copyProgress;
- }
- /**
- * URL up to 2KB in length that specifies the
- * source file used in the last attempted Copy File operation where this file
- * was the destination file.
- *
- * @readonly
- */
- get copySource() {
- return this.originalResponse.copySource;
- }
- /**
- * State of the copy operation
- * identified by 'x-ms-copy-id'. Possible values include: 'pending',
- * 'success', 'aborted', 'failed'
- *
- * @readonly
- */
- get copyStatus() {
- return this.originalResponse.copyStatus;
- }
- /**
- * Only appears when
- * x-ms-copy-status is failed or pending. Describes cause of fatal or
- * non-fatal copy operation failure.
- *
- * @readonly
- */
- get copyStatusDescription() {
- return this.originalResponse.copyStatusDescription;
- }
- /**
- * When a blob is leased,
- * specifies whether the lease is of infinite or fixed duration. Possible
- * values include: 'infinite', 'fixed'.
- *
- * @readonly
- */
- get leaseDuration() {
- return this.originalResponse.leaseDuration;
+class BlobSASPermissions {
+ constructor() {
+ /**
+ * Specifies Read access granted.
+ */
+ this.read = false;
+ /**
+ * Specifies Add access granted.
+ */
+ this.add = false;
+ /**
+ * Specifies Create access granted.
+ */
+ this.create = false;
+ /**
+ * Specifies Write access granted.
+ */
+ this.write = false;
+ /**
+ * Specifies Delete access granted.
+ */
+ this.delete = false;
+ /**
+ * Specifies Delete version access granted.
+ */
+ this.deleteVersion = false;
+ /**
+ * Specfies Tag access granted.
+ */
+ this.tag = false;
+ /**
+ * Specifies Move access granted.
+ */
+ this.move = false;
+ /**
+ * Specifies Execute access granted.
+ */
+ this.execute = false;
+ /**
+ * Specifies SetImmutabilityPolicy access granted.
+ */
+ this.setImmutabilityPolicy = false;
+ /**
+ * Specifies that Permanent Delete is permitted.
+ */
+ this.permanentDelete = false;
}
/**
- * Lease state of the blob. Possible
- * values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
+ * Creates a {@link BlobSASPermissions} from the specified permissions string. This method will throw an
+ * Error if it encounters a character that does not correspond to a valid permission.
*
- * @readonly
+ * @param permissions -
*/
- get leaseState() {
- return this.originalResponse.leaseState;
+ static parse(permissions) {
+ const blobSASPermissions = new BlobSASPermissions();
+ for (const char of permissions) {
+ switch (char) {
+ case "r":
+ blobSASPermissions.read = true;
+ break;
+ case "a":
+ blobSASPermissions.add = true;
+ break;
+ case "c":
+ blobSASPermissions.create = true;
+ break;
+ case "w":
+ blobSASPermissions.write = true;
+ break;
+ case "d":
+ blobSASPermissions.delete = true;
+ break;
+ case "x":
+ blobSASPermissions.deleteVersion = true;
+ break;
+ case "t":
+ blobSASPermissions.tag = true;
+ break;
+ case "m":
+ blobSASPermissions.move = true;
+ break;
+ case "e":
+ blobSASPermissions.execute = true;
+ break;
+ case "i":
+ blobSASPermissions.setImmutabilityPolicy = true;
+ break;
+ case "y":
+ blobSASPermissions.permanentDelete = true;
+ break;
+ default:
+ throw new RangeError(`Invalid permission: ${char}`);
+ }
+ }
+ return blobSASPermissions;
}
/**
- * The current lease status of the
- * blob. Possible values include: 'locked', 'unlocked'.
+ * Creates a {@link BlobSASPermissions} from a raw object which contains same keys as it
+ * and boolean values for them.
*
- * @readonly
+ * @param permissionLike -
*/
- get leaseStatus() {
- return this.originalResponse.leaseStatus;
+ static from(permissionLike) {
+ const blobSASPermissions = new BlobSASPermissions();
+ if (permissionLike.read) {
+ blobSASPermissions.read = true;
+ }
+ if (permissionLike.add) {
+ blobSASPermissions.add = true;
+ }
+ if (permissionLike.create) {
+ blobSASPermissions.create = true;
+ }
+ if (permissionLike.write) {
+ blobSASPermissions.write = true;
+ }
+ if (permissionLike.delete) {
+ blobSASPermissions.delete = true;
+ }
+ if (permissionLike.deleteVersion) {
+ blobSASPermissions.deleteVersion = true;
+ }
+ if (permissionLike.tag) {
+ blobSASPermissions.tag = true;
+ }
+ if (permissionLike.move) {
+ blobSASPermissions.move = true;
+ }
+ if (permissionLike.execute) {
+ blobSASPermissions.execute = true;
+ }
+ if (permissionLike.setImmutabilityPolicy) {
+ blobSASPermissions.setImmutabilityPolicy = true;
+ }
+ if (permissionLike.permanentDelete) {
+ blobSASPermissions.permanentDelete = true;
+ }
+ return blobSASPermissions;
}
/**
- * A UTC date/time value generated by the service that
- * indicates the time at which the response was initiated.
+ * Converts the given permissions to a string. Using this method will guarantee the permissions are in an
+ * order accepted by the service.
*
- * @readonly
+ * @returns A string which represents the BlobSASPermissions
*/
- get date() {
- return this.originalResponse.date;
+ toString() {
+ const permissions = [];
+ if (this.read) {
+ permissions.push("r");
+ }
+ if (this.add) {
+ permissions.push("a");
+ }
+ if (this.create) {
+ permissions.push("c");
+ }
+ if (this.write) {
+ permissions.push("w");
+ }
+ if (this.delete) {
+ permissions.push("d");
+ }
+ if (this.deleteVersion) {
+ permissions.push("x");
+ }
+ if (this.tag) {
+ permissions.push("t");
+ }
+ if (this.move) {
+ permissions.push("m");
+ }
+ if (this.execute) {
+ permissions.push("e");
+ }
+ if (this.setImmutabilityPolicy) {
+ permissions.push("i");
+ }
+ if (this.permanentDelete) {
+ permissions.push("y");
+ }
+ return permissions.join("");
}
- /**
- * The number of committed blocks
- * present in the blob. This header is returned only for append blobs.
- *
- * @readonly
- */
- get blobCommittedBlockCount() {
- return this.originalResponse.blobCommittedBlockCount;
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container.
+ * Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation.
+ * Once all the values are set, this should be serialized with toString and set as the permissions field on a
+ * {@link BlobSASSignatureValues} object. It is possible to construct the permissions string without this class, but
+ * the order of the permissions is particular and this class guarantees correctness.
+ */
+class ContainerSASPermissions {
+ constructor() {
+ /**
+ * Specifies Read access granted.
+ */
+ this.read = false;
+ /**
+ * Specifies Add access granted.
+ */
+ this.add = false;
+ /**
+ * Specifies Create access granted.
+ */
+ this.create = false;
+ /**
+ * Specifies Write access granted.
+ */
+ this.write = false;
+ /**
+ * Specifies Delete access granted.
+ */
+ this.delete = false;
+ /**
+ * Specifies Delete version access granted.
+ */
+ this.deleteVersion = false;
+ /**
+ * Specifies List access granted.
+ */
+ this.list = false;
+ /**
+ * Specfies Tag access granted.
+ */
+ this.tag = false;
+ /**
+ * Specifies Move access granted.
+ */
+ this.move = false;
+ /**
+ * Specifies Execute access granted.
+ */
+ this.execute = false;
+ /**
+ * Specifies SetImmutabilityPolicy access granted.
+ */
+ this.setImmutabilityPolicy = false;
+ /**
+ * Specifies that Permanent Delete is permitted.
+ */
+ this.permanentDelete = false;
+ /**
+ * Specifies that Filter Blobs by Tags is permitted.
+ */
+ this.filterByTags = false;
}
/**
- * The ETag contains a value that you can use to
- * perform operations conditionally, in quotes.
+ * Creates an {@link ContainerSASPermissions} from the specified permissions string. This method will throw an
+ * Error if it encounters a character that does not correspond to a valid permission.
*
- * @readonly
+ * @param permissions -
*/
- get etag() {
- return this.originalResponse.etag;
+ static parse(permissions) {
+ const containerSASPermissions = new ContainerSASPermissions();
+ for (const char of permissions) {
+ switch (char) {
+ case "r":
+ containerSASPermissions.read = true;
+ break;
+ case "a":
+ containerSASPermissions.add = true;
+ break;
+ case "c":
+ containerSASPermissions.create = true;
+ break;
+ case "w":
+ containerSASPermissions.write = true;
+ break;
+ case "d":
+ containerSASPermissions.delete = true;
+ break;
+ case "l":
+ containerSASPermissions.list = true;
+ break;
+ case "t":
+ containerSASPermissions.tag = true;
+ break;
+ case "x":
+ containerSASPermissions.deleteVersion = true;
+ break;
+ case "m":
+ containerSASPermissions.move = true;
+ break;
+ case "e":
+ containerSASPermissions.execute = true;
+ break;
+ case "i":
+ containerSASPermissions.setImmutabilityPolicy = true;
+ break;
+ case "y":
+ containerSASPermissions.permanentDelete = true;
+ break;
+ case "f":
+ containerSASPermissions.filterByTags = true;
+ break;
+ default:
+ throw new RangeError(`Invalid permission ${char}`);
+ }
+ }
+ return containerSASPermissions;
}
/**
- * The number of tags associated with the blob
+ * Creates a {@link ContainerSASPermissions} from a raw object which contains same keys as it
+ * and boolean values for them.
*
- * @readonly
+ * @param permissionLike -
*/
- get tagCount() {
- return this.originalResponse.tagCount;
+ static from(permissionLike) {
+ const containerSASPermissions = new ContainerSASPermissions();
+ if (permissionLike.read) {
+ containerSASPermissions.read = true;
+ }
+ if (permissionLike.add) {
+ containerSASPermissions.add = true;
+ }
+ if (permissionLike.create) {
+ containerSASPermissions.create = true;
+ }
+ if (permissionLike.write) {
+ containerSASPermissions.write = true;
+ }
+ if (permissionLike.delete) {
+ containerSASPermissions.delete = true;
+ }
+ if (permissionLike.list) {
+ containerSASPermissions.list = true;
+ }
+ if (permissionLike.deleteVersion) {
+ containerSASPermissions.deleteVersion = true;
+ }
+ if (permissionLike.tag) {
+ containerSASPermissions.tag = true;
+ }
+ if (permissionLike.move) {
+ containerSASPermissions.move = true;
+ }
+ if (permissionLike.execute) {
+ containerSASPermissions.execute = true;
+ }
+ if (permissionLike.setImmutabilityPolicy) {
+ containerSASPermissions.setImmutabilityPolicy = true;
+ }
+ if (permissionLike.permanentDelete) {
+ containerSASPermissions.permanentDelete = true;
+ }
+ if (permissionLike.filterByTags) {
+ containerSASPermissions.filterByTags = true;
+ }
+ return containerSASPermissions;
}
/**
- * The error code.
+ * Converts the given permissions to a string. Using this method will guarantee the permissions are in an
+ * order accepted by the service.
*
- * @readonly
- */
- get errorCode() {
- return this.originalResponse.errorCode;
- }
- /**
- * The value of this header is set to
- * true if the file data and application metadata are completely encrypted
- * using the specified algorithm. Otherwise, the value is set to false (when
- * the file is unencrypted, or if only parts of the file/application metadata
- * are encrypted).
+ * The order of the characters should be as specified here to ensure correctness.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
*
- * @readonly
*/
- get isServerEncrypted() {
- return this.originalResponse.isServerEncrypted;
+ toString() {
+ const permissions = [];
+ if (this.read) {
+ permissions.push("r");
+ }
+ if (this.add) {
+ permissions.push("a");
+ }
+ if (this.create) {
+ permissions.push("c");
+ }
+ if (this.write) {
+ permissions.push("w");
+ }
+ if (this.delete) {
+ permissions.push("d");
+ }
+ if (this.deleteVersion) {
+ permissions.push("x");
+ }
+ if (this.list) {
+ permissions.push("l");
+ }
+ if (this.tag) {
+ permissions.push("t");
+ }
+ if (this.move) {
+ permissions.push("m");
+ }
+ if (this.execute) {
+ permissions.push("e");
+ }
+ if (this.setImmutabilityPolicy) {
+ permissions.push("i");
+ }
+ if (this.permanentDelete) {
+ permissions.push("y");
+ }
+ if (this.filterByTags) {
+ permissions.push("f");
+ }
+ return permissions.join("");
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * UserDelegationKeyCredential is only used for generation of user delegation SAS.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-user-delegation-sas
+ */
+class UserDelegationKeyCredential {
/**
- * If the blob has a MD5 hash, and if
- * request contains range header (Range or x-ms-range), this response header
- * is returned with the value of the whole blob's MD5 value. This value may
- * or may not be equal to the value returned in Content-MD5 header, with the
- * latter calculated from the requested range.
- *
- * @readonly
+ * Creates an instance of UserDelegationKeyCredential.
+ * @param accountName -
+ * @param userDelegationKey -
*/
- get blobContentMD5() {
- return this.originalResponse.blobContentMD5;
+ constructor(accountName, userDelegationKey) {
+ this.accountName = accountName;
+ this.userDelegationKey = userDelegationKey;
+ this.key = Buffer.from(userDelegationKey.value, "base64");
}
/**
- * Returns the date and time the file was last
- * modified. Any operation that modifies the file or its properties updates
- * the last modified time.
+ * Generates a hash signature for an HTTP request or for a SAS.
*
- * @readonly
+ * @param stringToSign -
*/
- get lastModified() {
- return this.originalResponse.lastModified;
+ computeHMACSHA256(stringToSign) {
+ // console.log(`stringToSign: ${JSON.stringify(stringToSign)}`);
+ return crypto.createHmac("sha256", this.key).update(stringToSign, "utf8").digest("base64");
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Generate SasIPRange format string. For example:
+ *
+ * "8.8.8.8" or "1.1.1.1-255.255.255.255"
+ *
+ * @param ipRange -
+ */
+function ipRangeToString(ipRange) {
+ return ipRange.end ? `${ipRange.start}-${ipRange.end}` : ipRange.start;
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Protocols for generated SAS.
+ */
+exports.SASProtocol = void 0;
+(function (SASProtocol) {
/**
- * Returns the UTC date and time generated by the service that indicates the time at which the blob was
- * last read or written to.
- *
- * @readonly
+ * Protocol that allows HTTPS only
*/
- get lastAccessed() {
- return this.originalResponse.lastAccessed;
- }
+ SASProtocol["Https"] = "https";
/**
- * Returns the date and time the blob was created.
- *
- * @readonly
+ * Protocol that allows both HTTPS and HTTP
*/
- get createdOn() {
- return this.originalResponse.createdOn;
- }
+ SASProtocol["HttpsAndHttp"] = "https,http";
+})(exports.SASProtocol || (exports.SASProtocol = {}));
+/**
+ * Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
+ * by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link BlobSASSignatureValues}
+ * types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
+ * be taken here in case there are existing query parameters, which might affect the appropriate means of appending
+ * these query parameters).
+ *
+ * NOTE: Instances of this class are immutable.
+ */
+class SASQueryParameters {
/**
- * A name-value pair
- * to associate with a file storage object.
+ * Optional. IP range allowed for this SAS.
*
* @readonly
*/
- get metadata() {
- return this.originalResponse.metadata;
+ get ipRange() {
+ if (this.ipRangeInner) {
+ return {
+ end: this.ipRangeInner.end,
+ start: this.ipRangeInner.start,
+ };
+ }
+ return undefined;
}
- /**
- * This header uniquely identifies the request
- * that was made and can be used for troubleshooting the request.
- *
- * @readonly
- */
- get requestId() {
- return this.originalResponse.requestId;
+ constructor(version, signature, permissionsOrOptions, services, resourceTypes, protocol, startsOn, expiresOn, ipRange, identifier, resource, cacheControl, contentDisposition, contentEncoding, contentLanguage, contentType, userDelegationKey, preauthorizedAgentObjectId, correlationId, encryptionScope) {
+ this.version = version;
+ this.signature = signature;
+ if (permissionsOrOptions !== undefined && typeof permissionsOrOptions !== "string") {
+ // SASQueryParametersOptions
+ this.permissions = permissionsOrOptions.permissions;
+ this.services = permissionsOrOptions.services;
+ this.resourceTypes = permissionsOrOptions.resourceTypes;
+ this.protocol = permissionsOrOptions.protocol;
+ this.startsOn = permissionsOrOptions.startsOn;
+ this.expiresOn = permissionsOrOptions.expiresOn;
+ this.ipRangeInner = permissionsOrOptions.ipRange;
+ this.identifier = permissionsOrOptions.identifier;
+ this.encryptionScope = permissionsOrOptions.encryptionScope;
+ this.resource = permissionsOrOptions.resource;
+ this.cacheControl = permissionsOrOptions.cacheControl;
+ this.contentDisposition = permissionsOrOptions.contentDisposition;
+ this.contentEncoding = permissionsOrOptions.contentEncoding;
+ this.contentLanguage = permissionsOrOptions.contentLanguage;
+ this.contentType = permissionsOrOptions.contentType;
+ if (permissionsOrOptions.userDelegationKey) {
+ this.signedOid = permissionsOrOptions.userDelegationKey.signedObjectId;
+ this.signedTenantId = permissionsOrOptions.userDelegationKey.signedTenantId;
+ this.signedStartsOn = permissionsOrOptions.userDelegationKey.signedStartsOn;
+ this.signedExpiresOn = permissionsOrOptions.userDelegationKey.signedExpiresOn;
+ this.signedService = permissionsOrOptions.userDelegationKey.signedService;
+ this.signedVersion = permissionsOrOptions.userDelegationKey.signedVersion;
+ this.preauthorizedAgentObjectId = permissionsOrOptions.preauthorizedAgentObjectId;
+ this.correlationId = permissionsOrOptions.correlationId;
+ }
+ }
+ else {
+ this.services = services;
+ this.resourceTypes = resourceTypes;
+ this.expiresOn = expiresOn;
+ this.permissions = permissionsOrOptions;
+ this.protocol = protocol;
+ this.startsOn = startsOn;
+ this.ipRangeInner = ipRange;
+ this.encryptionScope = encryptionScope;
+ this.identifier = identifier;
+ this.resource = resource;
+ this.cacheControl = cacheControl;
+ this.contentDisposition = contentDisposition;
+ this.contentEncoding = contentEncoding;
+ this.contentLanguage = contentLanguage;
+ this.contentType = contentType;
+ if (userDelegationKey) {
+ this.signedOid = userDelegationKey.signedObjectId;
+ this.signedTenantId = userDelegationKey.signedTenantId;
+ this.signedStartsOn = userDelegationKey.signedStartsOn;
+ this.signedExpiresOn = userDelegationKey.signedExpiresOn;
+ this.signedService = userDelegationKey.signedService;
+ this.signedVersion = userDelegationKey.signedVersion;
+ this.preauthorizedAgentObjectId = preauthorizedAgentObjectId;
+ this.correlationId = correlationId;
+ }
+ }
}
/**
- * If a client request id header is sent in the request, this header will be present in the
- * response with the same value.
+ * Encodes all SAS query parameters into a string that can be appended to a URL.
*
- * @readonly
*/
- get clientRequestId() {
- return this.originalResponse.clientRequestId;
+ toString() {
+ const params = [
+ "sv",
+ "ss",
+ "srt",
+ "spr",
+ "st",
+ "se",
+ "sip",
+ "si",
+ "ses",
+ "skoid", // Signed object ID
+ "sktid", // Signed tenant ID
+ "skt", // Signed key start time
+ "ske", // Signed key expiry time
+ "sks", // Signed key service
+ "skv", // Signed key version
+ "sr",
+ "sp",
+ "sig",
+ "rscc",
+ "rscd",
+ "rsce",
+ "rscl",
+ "rsct",
+ "saoid",
+ "scid",
+ ];
+ const queries = [];
+ for (const param of params) {
+ switch (param) {
+ case "sv":
+ this.tryAppendQueryParameter(queries, param, this.version);
+ break;
+ case "ss":
+ this.tryAppendQueryParameter(queries, param, this.services);
+ break;
+ case "srt":
+ this.tryAppendQueryParameter(queries, param, this.resourceTypes);
+ break;
+ case "spr":
+ this.tryAppendQueryParameter(queries, param, this.protocol);
+ break;
+ case "st":
+ this.tryAppendQueryParameter(queries, param, this.startsOn ? truncatedISO8061Date(this.startsOn, false) : undefined);
+ break;
+ case "se":
+ this.tryAppendQueryParameter(queries, param, this.expiresOn ? truncatedISO8061Date(this.expiresOn, false) : undefined);
+ break;
+ case "sip":
+ this.tryAppendQueryParameter(queries, param, this.ipRange ? ipRangeToString(this.ipRange) : undefined);
+ break;
+ case "si":
+ this.tryAppendQueryParameter(queries, param, this.identifier);
+ break;
+ case "ses":
+ this.tryAppendQueryParameter(queries, param, this.encryptionScope);
+ break;
+ case "skoid": // Signed object ID
+ this.tryAppendQueryParameter(queries, param, this.signedOid);
+ break;
+ case "sktid": // Signed tenant ID
+ this.tryAppendQueryParameter(queries, param, this.signedTenantId);
+ break;
+ case "skt": // Signed key start time
+ this.tryAppendQueryParameter(queries, param, this.signedStartsOn ? truncatedISO8061Date(this.signedStartsOn, false) : undefined);
+ break;
+ case "ske": // Signed key expiry time
+ this.tryAppendQueryParameter(queries, param, this.signedExpiresOn ? truncatedISO8061Date(this.signedExpiresOn, false) : undefined);
+ break;
+ case "sks": // Signed key service
+ this.tryAppendQueryParameter(queries, param, this.signedService);
+ break;
+ case "skv": // Signed key version
+ this.tryAppendQueryParameter(queries, param, this.signedVersion);
+ break;
+ case "sr":
+ this.tryAppendQueryParameter(queries, param, this.resource);
+ break;
+ case "sp":
+ this.tryAppendQueryParameter(queries, param, this.permissions);
+ break;
+ case "sig":
+ this.tryAppendQueryParameter(queries, param, this.signature);
+ break;
+ case "rscc":
+ this.tryAppendQueryParameter(queries, param, this.cacheControl);
+ break;
+ case "rscd":
+ this.tryAppendQueryParameter(queries, param, this.contentDisposition);
+ break;
+ case "rsce":
+ this.tryAppendQueryParameter(queries, param, this.contentEncoding);
+ break;
+ case "rscl":
+ this.tryAppendQueryParameter(queries, param, this.contentLanguage);
+ break;
+ case "rsct":
+ this.tryAppendQueryParameter(queries, param, this.contentType);
+ break;
+ case "saoid":
+ this.tryAppendQueryParameter(queries, param, this.preauthorizedAgentObjectId);
+ break;
+ case "scid":
+ this.tryAppendQueryParameter(queries, param, this.correlationId);
+ break;
+ }
+ }
+ return queries.join("&");
}
/**
- * Indicates the version of the Blob service used
- * to execute the request.
+ * A private helper method used to filter and append query key/value pairs into an array.
*
- * @readonly
+ * @param queries -
+ * @param key -
+ * @param value -
*/
- get version() {
- return this.originalResponse.version;
+ tryAppendQueryParameter(queries, key, value) {
+ if (!value) {
+ return;
+ }
+ key = encodeURIComponent(key);
+ value = encodeURIComponent(value);
+ if (key.length > 0 && value.length > 0) {
+ queries.push(`${key}=${value}`);
+ }
}
- /**
- * Indicates the versionId of the downloaded blob version.
- *
- * @readonly
- */
- get versionId() {
- return this.originalResponse.versionId;
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+function generateBlobSASQueryParameters(blobSASSignatureValues, sharedKeyCredentialOrUserDelegationKey, accountName) {
+ const version = blobSASSignatureValues.version ? blobSASSignatureValues.version : SERVICE_VERSION;
+ const sharedKeyCredential = sharedKeyCredentialOrUserDelegationKey instanceof StorageSharedKeyCredential
+ ? sharedKeyCredentialOrUserDelegationKey
+ : undefined;
+ let userDelegationKeyCredential;
+ if (sharedKeyCredential === undefined && accountName !== undefined) {
+ userDelegationKeyCredential = new UserDelegationKeyCredential(accountName, sharedKeyCredentialOrUserDelegationKey);
}
- /**
- * Indicates whether version of this blob is a current version.
- *
- * @readonly
- */
- get isCurrentVersion() {
- return this.originalResponse.isCurrentVersion;
+ if (sharedKeyCredential === undefined && userDelegationKeyCredential === undefined) {
+ throw TypeError("Invalid sharedKeyCredential, userDelegationKey or accountName.");
}
- /**
- * The SHA-256 hash of the encryption key used to encrypt the blob. This value is only returned
- * when the blob was encrypted with a customer-provided key.
- *
- * @readonly
- */
- get encryptionKeySha256() {
- return this.originalResponse.encryptionKeySha256;
+ // Version 2020-12-06 adds support for encryptionscope in SAS.
+ if (version >= "2020-12-06") {
+ if (sharedKeyCredential !== undefined) {
+ return generateBlobSASQueryParameters20201206(blobSASSignatureValues, sharedKeyCredential);
+ }
+ else {
+ return generateBlobSASQueryParametersUDK20201206(blobSASSignatureValues, userDelegationKeyCredential);
+ }
}
- /**
- * If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to
- * true, then the request returns a crc64 for the range, as long as the range size is less than
- * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is
- * specified in the same request, it will fail with 400(Bad Request)
- */
- get contentCrc64() {
- return this.originalResponse.contentCrc64;
+ // Version 2019-12-12 adds support for the blob tags permission.
+ // Version 2018-11-09 adds support for the signed resource and signed blob snapshot time fields.
+ // https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas#constructing-the-signature-string
+ if (version >= "2018-11-09") {
+ if (sharedKeyCredential !== undefined) {
+ return generateBlobSASQueryParameters20181109(blobSASSignatureValues, sharedKeyCredential);
+ }
+ else {
+ // Version 2020-02-10 delegation SAS signature construction includes preauthorizedAgentObjectId, agentObjectId, correlationId.
+ if (version >= "2020-02-10") {
+ return generateBlobSASQueryParametersUDK20200210(blobSASSignatureValues, userDelegationKeyCredential);
+ }
+ else {
+ return generateBlobSASQueryParametersUDK20181109(blobSASSignatureValues, userDelegationKeyCredential);
+ }
+ }
}
- /**
- * Object Replication Policy Id of the destination blob.
- *
- * @readonly
- */
- get objectReplicationDestinationPolicyId() {
- return this.originalResponse.objectReplicationDestinationPolicyId;
+ if (version >= "2015-04-05") {
+ if (sharedKeyCredential !== undefined) {
+ return generateBlobSASQueryParameters20150405(blobSASSignatureValues, sharedKeyCredential);
+ }
+ else {
+ throw new RangeError("'version' must be >= '2018-11-09' when generating user delegation SAS using user delegation key.");
+ }
}
- /**
- * Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob.
- *
- * @readonly
- */
- get objectReplicationSourceProperties() {
- return this.originalResponse.objectReplicationSourceProperties;
+ throw new RangeError("'version' must be >= '2015-04-05'.");
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ * IMPLEMENTATION FOR API VERSION FROM 2015-04-05 AND BEFORE 2018-11-09.
+ *
+ * Creates an instance of SASQueryParameters.
+ *
+ * Only accepts required settings needed to create a SAS. For optional settings please
+ * set corresponding properties directly, such as permissions, startsOn and identifier.
+ *
+ * WARNING: When identifier is not provided, permissions and expiresOn are required.
+ * You MUST assign value to identifier or expiresOn & permissions manually if you initial with
+ * this constructor.
+ *
+ * @param blobSASSignatureValues -
+ * @param sharedKeyCredential -
+ */
+function generateBlobSASQueryParameters20150405(blobSASSignatureValues, sharedKeyCredential) {
+ blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
+ if (!blobSASSignatureValues.identifier &&
+ !(blobSASSignatureValues.permissions && blobSASSignatureValues.expiresOn)) {
+ throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when 'identifier' is not provided.");
}
- /**
- * If this blob has been sealed.
- *
- * @readonly
- */
- get isSealed() {
- return this.originalResponse.isSealed;
+ let resource = "c";
+ if (blobSASSignatureValues.blobName) {
+ resource = "b";
}
- /**
- * UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.
- *
- * @readonly
- */
- get immutabilityPolicyExpiresOn() {
- return this.originalResponse.immutabilityPolicyExpiresOn;
+ // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
+ let verifiedPermissions;
+ if (blobSASSignatureValues.permissions) {
+ if (blobSASSignatureValues.blobName) {
+ verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
+ }
+ else {
+ verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
+ }
}
- /**
- * Indicates immutability policy mode.
- *
- * @readonly
- */
- get immutabilityPolicyMode() {
- return this.originalResponse.immutabilityPolicyMode;
+ // Signature is generated on the un-url-encoded values.
+ const stringToSign = [
+ verifiedPermissions ? verifiedPermissions : "",
+ blobSASSignatureValues.startsOn
+ ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
+ : "",
+ blobSASSignatureValues.expiresOn
+ ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
+ : "",
+ getCanonicalName(sharedKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
+ blobSASSignatureValues.identifier,
+ blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
+ blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
+ blobSASSignatureValues.version,
+ blobSASSignatureValues.cacheControl ? blobSASSignatureValues.cacheControl : "",
+ blobSASSignatureValues.contentDisposition ? blobSASSignatureValues.contentDisposition : "",
+ blobSASSignatureValues.contentEncoding ? blobSASSignatureValues.contentEncoding : "",
+ blobSASSignatureValues.contentLanguage ? blobSASSignatureValues.contentLanguage : "",
+ blobSASSignatureValues.contentType ? blobSASSignatureValues.contentType : "",
+ ].join("\n");
+ const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
+ return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType);
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ * IMPLEMENTATION FOR API VERSION FROM 2018-11-09.
+ *
+ * Creates an instance of SASQueryParameters.
+ *
+ * Only accepts required settings needed to create a SAS. For optional settings please
+ * set corresponding properties directly, such as permissions, startsOn and identifier.
+ *
+ * WARNING: When identifier is not provided, permissions and expiresOn are required.
+ * You MUST assign value to identifier or expiresOn & permissions manually if you initial with
+ * this constructor.
+ *
+ * @param blobSASSignatureValues -
+ * @param sharedKeyCredential -
+ */
+function generateBlobSASQueryParameters20181109(blobSASSignatureValues, sharedKeyCredential) {
+ blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
+ if (!blobSASSignatureValues.identifier &&
+ !(blobSASSignatureValues.permissions && blobSASSignatureValues.expiresOn)) {
+ throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when 'identifier' is not provided.");
}
- /**
- * Indicates if a legal hold is present on the blob.
- *
- * @readonly
- */
- get legalHold() {
- return this.originalResponse.legalHold;
+ let resource = "c";
+ let timestamp = blobSASSignatureValues.snapshotTime;
+ if (blobSASSignatureValues.blobName) {
+ resource = "b";
+ if (blobSASSignatureValues.snapshotTime) {
+ resource = "bs";
+ }
+ else if (blobSASSignatureValues.versionId) {
+ resource = "bv";
+ timestamp = blobSASSignatureValues.versionId;
+ }
}
- /**
- * The response body as a browser Blob.
- * Always undefined in node.js.
- *
- * @readonly
- */
- get contentAsBlob() {
- return this.originalResponse.blobBody;
+ // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
+ let verifiedPermissions;
+ if (blobSASSignatureValues.permissions) {
+ if (blobSASSignatureValues.blobName) {
+ verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
+ }
+ else {
+ verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
+ }
}
- /**
- * The response body as a node.js Readable stream.
- * Always undefined in the browser.
- *
- * It will automatically retry when internal read stream unexpected ends.
- *
- * @readonly
- */
- get readableStreamBody() {
- return coreHttp.isNode ? this.blobDownloadStream : undefined;
+ // Signature is generated on the un-url-encoded values.
+ const stringToSign = [
+ verifiedPermissions ? verifiedPermissions : "",
+ blobSASSignatureValues.startsOn
+ ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
+ : "",
+ blobSASSignatureValues.expiresOn
+ ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
+ : "",
+ getCanonicalName(sharedKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
+ blobSASSignatureValues.identifier,
+ blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
+ blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
+ blobSASSignatureValues.version,
+ resource,
+ timestamp,
+ blobSASSignatureValues.cacheControl ? blobSASSignatureValues.cacheControl : "",
+ blobSASSignatureValues.contentDisposition ? blobSASSignatureValues.contentDisposition : "",
+ blobSASSignatureValues.contentEncoding ? blobSASSignatureValues.contentEncoding : "",
+ blobSASSignatureValues.contentLanguage ? blobSASSignatureValues.contentLanguage : "",
+ blobSASSignatureValues.contentType ? blobSASSignatureValues.contentType : "",
+ ].join("\n");
+ const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
+ return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType);
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ * IMPLEMENTATION FOR API VERSION FROM 2020-12-06.
+ *
+ * Creates an instance of SASQueryParameters.
+ *
+ * Only accepts required settings needed to create a SAS. For optional settings please
+ * set corresponding properties directly, such as permissions, startsOn and identifier.
+ *
+ * WARNING: When identifier is not provided, permissions and expiresOn are required.
+ * You MUST assign value to identifier or expiresOn & permissions manually if you initial with
+ * this constructor.
+ *
+ * @param blobSASSignatureValues -
+ * @param sharedKeyCredential -
+ */
+function generateBlobSASQueryParameters20201206(blobSASSignatureValues, sharedKeyCredential) {
+ blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
+ if (!blobSASSignatureValues.identifier &&
+ !(blobSASSignatureValues.permissions && blobSASSignatureValues.expiresOn)) {
+ throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when 'identifier' is not provided.");
}
- /**
- * The HTTP response.
- */
- get _response() {
- return this.originalResponse._response;
+ let resource = "c";
+ let timestamp = blobSASSignatureValues.snapshotTime;
+ if (blobSASSignatureValues.blobName) {
+ resource = "b";
+ if (blobSASSignatureValues.snapshotTime) {
+ resource = "bs";
+ }
+ else if (blobSASSignatureValues.versionId) {
+ resource = "bv";
+ timestamp = blobSASSignatureValues.versionId;
+ }
}
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-const AVRO_SYNC_MARKER_SIZE = 16;
-const AVRO_INIT_BYTES = new Uint8Array([79, 98, 106, 1]);
-const AVRO_CODEC_KEY = "avro.codec";
-const AVRO_SCHEMA_KEY = "avro.schema";
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-class AvroParser {
- /**
- * Reads a fixed number of bytes from the stream.
- *
- * @param stream -
- * @param length -
- * @param options -
- */
- static async readFixedBytes(stream, length, options = {}) {
- const bytes = await stream.read(length, { abortSignal: options.abortSignal });
- if (bytes.length !== length) {
- throw new Error("Hit stream end.");
+ // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
+ let verifiedPermissions;
+ if (blobSASSignatureValues.permissions) {
+ if (blobSASSignatureValues.blobName) {
+ verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
+ }
+ else {
+ verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
}
- return bytes;
}
- /**
- * Reads a single byte from the stream.
- *
- * @param stream -
- * @param options -
- */
- static async readByte(stream, options = {}) {
- const buf = await AvroParser.readFixedBytes(stream, 1, options);
- return buf[0];
+ // Signature is generated on the un-url-encoded values.
+ const stringToSign = [
+ verifiedPermissions ? verifiedPermissions : "",
+ blobSASSignatureValues.startsOn
+ ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
+ : "",
+ blobSASSignatureValues.expiresOn
+ ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
+ : "",
+ getCanonicalName(sharedKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
+ blobSASSignatureValues.identifier,
+ blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
+ blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
+ blobSASSignatureValues.version,
+ resource,
+ timestamp,
+ blobSASSignatureValues.encryptionScope,
+ blobSASSignatureValues.cacheControl ? blobSASSignatureValues.cacheControl : "",
+ blobSASSignatureValues.contentDisposition ? blobSASSignatureValues.contentDisposition : "",
+ blobSASSignatureValues.contentEncoding ? blobSASSignatureValues.contentEncoding : "",
+ blobSASSignatureValues.contentLanguage ? blobSASSignatureValues.contentLanguage : "",
+ blobSASSignatureValues.contentType ? blobSASSignatureValues.contentType : "",
+ ].join("\n");
+ const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
+ return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType, undefined, undefined, undefined, blobSASSignatureValues.encryptionScope);
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ * IMPLEMENTATION FOR API VERSION FROM 2018-11-09.
+ *
+ * Creates an instance of SASQueryParameters.
+ *
+ * Only accepts required settings needed to create a SAS. For optional settings please
+ * set corresponding properties directly, such as permissions, startsOn.
+ *
+ * WARNING: identifier will be ignored, permissions and expiresOn are required.
+ *
+ * @param blobSASSignatureValues -
+ * @param userDelegationKeyCredential -
+ */
+function generateBlobSASQueryParametersUDK20181109(blobSASSignatureValues, userDelegationKeyCredential) {
+ blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
+ // Stored access policies are not supported for a user delegation SAS.
+ if (!blobSASSignatureValues.permissions || !blobSASSignatureValues.expiresOn) {
+ throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when generating user delegation SAS.");
}
- // int and long are stored in variable-length zig-zag coding.
- // variable-length: https://lucene.apache.org/core/3_5_0/fileformats.html#VInt
- // zig-zag: https://developers.google.com/protocol-buffers/docs/encoding?csw=1#types
- static async readZigZagLong(stream, options = {}) {
- let zigZagEncoded = 0;
- let significanceInBit = 0;
- let byte, haveMoreByte, significanceInFloat;
- do {
- byte = await AvroParser.readByte(stream, options);
- haveMoreByte = byte & 0x80;
- zigZagEncoded |= (byte & 0x7f) << significanceInBit;
- significanceInBit += 7;
- } while (haveMoreByte && significanceInBit < 28); // bitwise operation only works for 32-bit integers
- if (haveMoreByte) {
- // Switch to float arithmetic
- // eslint-disable-next-line no-self-assign
- zigZagEncoded = zigZagEncoded;
- significanceInFloat = 268435456; // 2 ** 28.
- do {
- byte = await AvroParser.readByte(stream, options);
- zigZagEncoded += (byte & 0x7f) * significanceInFloat;
- significanceInFloat *= 128; // 2 ** 7
- } while (byte & 0x80);
- const res = (zigZagEncoded % 2 ? -(zigZagEncoded + 1) : zigZagEncoded) / 2;
- if (res < Number.MIN_SAFE_INTEGER || res > Number.MAX_SAFE_INTEGER) {
- throw new Error("Integer overflow.");
- }
- return res;
+ let resource = "c";
+ let timestamp = blobSASSignatureValues.snapshotTime;
+ if (blobSASSignatureValues.blobName) {
+ resource = "b";
+ if (blobSASSignatureValues.snapshotTime) {
+ resource = "bs";
+ }
+ else if (blobSASSignatureValues.versionId) {
+ resource = "bv";
+ timestamp = blobSASSignatureValues.versionId;
}
- return (zigZagEncoded >> 1) ^ -(zigZagEncoded & 1);
- }
- static async readLong(stream, options = {}) {
- return AvroParser.readZigZagLong(stream, options);
}
- static async readInt(stream, options = {}) {
- return AvroParser.readZigZagLong(stream, options);
+ // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
+ let verifiedPermissions;
+ if (blobSASSignatureValues.permissions) {
+ if (blobSASSignatureValues.blobName) {
+ verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
+ }
+ else {
+ verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
+ }
}
- static async readNull() {
- return null;
+ // Signature is generated on the un-url-encoded values.
+ const stringToSign = [
+ verifiedPermissions ? verifiedPermissions : "",
+ blobSASSignatureValues.startsOn
+ ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
+ : "",
+ blobSASSignatureValues.expiresOn
+ ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
+ : "",
+ getCanonicalName(userDelegationKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
+ userDelegationKeyCredential.userDelegationKey.signedObjectId,
+ userDelegationKeyCredential.userDelegationKey.signedTenantId,
+ userDelegationKeyCredential.userDelegationKey.signedStartsOn
+ ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedStartsOn, false)
+ : "",
+ userDelegationKeyCredential.userDelegationKey.signedExpiresOn
+ ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedExpiresOn, false)
+ : "",
+ userDelegationKeyCredential.userDelegationKey.signedService,
+ userDelegationKeyCredential.userDelegationKey.signedVersion,
+ blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
+ blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
+ blobSASSignatureValues.version,
+ resource,
+ timestamp,
+ blobSASSignatureValues.cacheControl,
+ blobSASSignatureValues.contentDisposition,
+ blobSASSignatureValues.contentEncoding,
+ blobSASSignatureValues.contentLanguage,
+ blobSASSignatureValues.contentType,
+ ].join("\n");
+ const signature = userDelegationKeyCredential.computeHMACSHA256(stringToSign);
+ return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType, userDelegationKeyCredential.userDelegationKey);
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ * IMPLEMENTATION FOR API VERSION FROM 2020-02-10.
+ *
+ * Creates an instance of SASQueryParameters.
+ *
+ * Only accepts required settings needed to create a SAS. For optional settings please
+ * set corresponding properties directly, such as permissions, startsOn.
+ *
+ * WARNING: identifier will be ignored, permissions and expiresOn are required.
+ *
+ * @param blobSASSignatureValues -
+ * @param userDelegationKeyCredential -
+ */
+function generateBlobSASQueryParametersUDK20200210(blobSASSignatureValues, userDelegationKeyCredential) {
+ blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
+ // Stored access policies are not supported for a user delegation SAS.
+ if (!blobSASSignatureValues.permissions || !blobSASSignatureValues.expiresOn) {
+ throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when generating user delegation SAS.");
}
- static async readBoolean(stream, options = {}) {
- const b = await AvroParser.readByte(stream, options);
- if (b === 1) {
- return true;
- }
- else if (b === 0) {
- return false;
+ let resource = "c";
+ let timestamp = blobSASSignatureValues.snapshotTime;
+ if (blobSASSignatureValues.blobName) {
+ resource = "b";
+ if (blobSASSignatureValues.snapshotTime) {
+ resource = "bs";
}
- else {
- throw new Error("Byte was not a boolean.");
+ else if (blobSASSignatureValues.versionId) {
+ resource = "bv";
+ timestamp = blobSASSignatureValues.versionId;
}
}
- static async readFloat(stream, options = {}) {
- const u8arr = await AvroParser.readFixedBytes(stream, 4, options);
- const view = new DataView(u8arr.buffer, u8arr.byteOffset, u8arr.byteLength);
- return view.getFloat32(0, true); // littleEndian = true
- }
- static async readDouble(stream, options = {}) {
- const u8arr = await AvroParser.readFixedBytes(stream, 8, options);
- const view = new DataView(u8arr.buffer, u8arr.byteOffset, u8arr.byteLength);
- return view.getFloat64(0, true); // littleEndian = true
- }
- static async readBytes(stream, options = {}) {
- const size = await AvroParser.readLong(stream, options);
- if (size < 0) {
- throw new Error("Bytes size was negative.");
+ // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
+ let verifiedPermissions;
+ if (blobSASSignatureValues.permissions) {
+ if (blobSASSignatureValues.blobName) {
+ verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
+ }
+ else {
+ verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
}
- return stream.read(size, { abortSignal: options.abortSignal });
- }
- static async readString(stream, options = {}) {
- const u8arr = await AvroParser.readBytes(stream, options);
- const utf8decoder = new TextDecoder();
- return utf8decoder.decode(u8arr);
}
- static async readMapPair(stream, readItemMethod, options = {}) {
- const key = await AvroParser.readString(stream, options);
- // FUTURE: this won't work with readFixed (currently not supported) which needs a length as the parameter.
- const value = await readItemMethod(stream, options);
- return { key, value };
+ // Signature is generated on the un-url-encoded values.
+ const stringToSign = [
+ verifiedPermissions ? verifiedPermissions : "",
+ blobSASSignatureValues.startsOn
+ ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
+ : "",
+ blobSASSignatureValues.expiresOn
+ ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
+ : "",
+ getCanonicalName(userDelegationKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
+ userDelegationKeyCredential.userDelegationKey.signedObjectId,
+ userDelegationKeyCredential.userDelegationKey.signedTenantId,
+ userDelegationKeyCredential.userDelegationKey.signedStartsOn
+ ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedStartsOn, false)
+ : "",
+ userDelegationKeyCredential.userDelegationKey.signedExpiresOn
+ ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedExpiresOn, false)
+ : "",
+ userDelegationKeyCredential.userDelegationKey.signedService,
+ userDelegationKeyCredential.userDelegationKey.signedVersion,
+ blobSASSignatureValues.preauthorizedAgentObjectId,
+ undefined, // agentObjectId
+ blobSASSignatureValues.correlationId,
+ blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
+ blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
+ blobSASSignatureValues.version,
+ resource,
+ timestamp,
+ blobSASSignatureValues.cacheControl,
+ blobSASSignatureValues.contentDisposition,
+ blobSASSignatureValues.contentEncoding,
+ blobSASSignatureValues.contentLanguage,
+ blobSASSignatureValues.contentType,
+ ].join("\n");
+ const signature = userDelegationKeyCredential.computeHMACSHA256(stringToSign);
+ return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType, userDelegationKeyCredential.userDelegationKey, blobSASSignatureValues.preauthorizedAgentObjectId, blobSASSignatureValues.correlationId);
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ * IMPLEMENTATION FOR API VERSION FROM 2020-12-06.
+ *
+ * Creates an instance of SASQueryParameters.
+ *
+ * Only accepts required settings needed to create a SAS. For optional settings please
+ * set corresponding properties directly, such as permissions, startsOn.
+ *
+ * WARNING: identifier will be ignored, permissions and expiresOn are required.
+ *
+ * @param blobSASSignatureValues -
+ * @param userDelegationKeyCredential -
+ */
+function generateBlobSASQueryParametersUDK20201206(blobSASSignatureValues, userDelegationKeyCredential) {
+ blobSASSignatureValues = SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues);
+ // Stored access policies are not supported for a user delegation SAS.
+ if (!blobSASSignatureValues.permissions || !blobSASSignatureValues.expiresOn) {
+ throw new RangeError("Must provide 'permissions' and 'expiresOn' for Blob SAS generation when generating user delegation SAS.");
}
- static async readMap(stream, readItemMethod, options = {}) {
- const readPairMethod = (s, opts = {}) => {
- return AvroParser.readMapPair(s, readItemMethod, opts);
- };
- const pairs = await AvroParser.readArray(stream, readPairMethod, options);
- const dict = {};
- for (const pair of pairs) {
- dict[pair.key] = pair.value;
+ let resource = "c";
+ let timestamp = blobSASSignatureValues.snapshotTime;
+ if (blobSASSignatureValues.blobName) {
+ resource = "b";
+ if (blobSASSignatureValues.snapshotTime) {
+ resource = "bs";
}
- return dict;
- }
- static async readArray(stream, readItemMethod, options = {}) {
- const items = [];
- for (let count = await AvroParser.readLong(stream, options); count !== 0; count = await AvroParser.readLong(stream, options)) {
- if (count < 0) {
- // Ignore block sizes
- await AvroParser.readLong(stream, options);
- count = -count;
- }
- while (count--) {
- const item = await readItemMethod(stream, options);
- items.push(item);
- }
+ else if (blobSASSignatureValues.versionId) {
+ resource = "bv";
+ timestamp = blobSASSignatureValues.versionId;
}
- return items;
}
-}
-var AvroComplex;
-(function (AvroComplex) {
- AvroComplex["RECORD"] = "record";
- AvroComplex["ENUM"] = "enum";
- AvroComplex["ARRAY"] = "array";
- AvroComplex["MAP"] = "map";
- AvroComplex["UNION"] = "union";
- AvroComplex["FIXED"] = "fixed";
-})(AvroComplex || (AvroComplex = {}));
-var AvroPrimitive;
-(function (AvroPrimitive) {
- AvroPrimitive["NULL"] = "null";
- AvroPrimitive["BOOLEAN"] = "boolean";
- AvroPrimitive["INT"] = "int";
- AvroPrimitive["LONG"] = "long";
- AvroPrimitive["FLOAT"] = "float";
- AvroPrimitive["DOUBLE"] = "double";
- AvroPrimitive["BYTES"] = "bytes";
- AvroPrimitive["STRING"] = "string";
-})(AvroPrimitive || (AvroPrimitive = {}));
-class AvroType {
- /**
- * Determines the AvroType from the Avro Schema.
- */
- static fromSchema(schema) {
- if (typeof schema === "string") {
- return AvroType.fromStringSchema(schema);
- }
- else if (Array.isArray(schema)) {
- return AvroType.fromArraySchema(schema);
+ // Calling parse and toString guarantees the proper ordering and throws on invalid characters.
+ let verifiedPermissions;
+ if (blobSASSignatureValues.permissions) {
+ if (blobSASSignatureValues.blobName) {
+ verifiedPermissions = BlobSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
}
else {
- return AvroType.fromObjectSchema(schema);
+ verifiedPermissions = ContainerSASPermissions.parse(blobSASSignatureValues.permissions.toString()).toString();
}
}
- static fromStringSchema(schema) {
- switch (schema) {
- case AvroPrimitive.NULL:
- case AvroPrimitive.BOOLEAN:
- case AvroPrimitive.INT:
- case AvroPrimitive.LONG:
- case AvroPrimitive.FLOAT:
- case AvroPrimitive.DOUBLE:
- case AvroPrimitive.BYTES:
- case AvroPrimitive.STRING:
- return new AvroPrimitiveType(schema);
- default:
- throw new Error(`Unexpected Avro type ${schema}`);
- }
+ // Signature is generated on the un-url-encoded values.
+ const stringToSign = [
+ verifiedPermissions ? verifiedPermissions : "",
+ blobSASSignatureValues.startsOn
+ ? truncatedISO8061Date(blobSASSignatureValues.startsOn, false)
+ : "",
+ blobSASSignatureValues.expiresOn
+ ? truncatedISO8061Date(blobSASSignatureValues.expiresOn, false)
+ : "",
+ getCanonicalName(userDelegationKeyCredential.accountName, blobSASSignatureValues.containerName, blobSASSignatureValues.blobName),
+ userDelegationKeyCredential.userDelegationKey.signedObjectId,
+ userDelegationKeyCredential.userDelegationKey.signedTenantId,
+ userDelegationKeyCredential.userDelegationKey.signedStartsOn
+ ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedStartsOn, false)
+ : "",
+ userDelegationKeyCredential.userDelegationKey.signedExpiresOn
+ ? truncatedISO8061Date(userDelegationKeyCredential.userDelegationKey.signedExpiresOn, false)
+ : "",
+ userDelegationKeyCredential.userDelegationKey.signedService,
+ userDelegationKeyCredential.userDelegationKey.signedVersion,
+ blobSASSignatureValues.preauthorizedAgentObjectId,
+ undefined, // agentObjectId
+ blobSASSignatureValues.correlationId,
+ blobSASSignatureValues.ipRange ? ipRangeToString(blobSASSignatureValues.ipRange) : "",
+ blobSASSignatureValues.protocol ? blobSASSignatureValues.protocol : "",
+ blobSASSignatureValues.version,
+ resource,
+ timestamp,
+ blobSASSignatureValues.encryptionScope,
+ blobSASSignatureValues.cacheControl,
+ blobSASSignatureValues.contentDisposition,
+ blobSASSignatureValues.contentEncoding,
+ blobSASSignatureValues.contentLanguage,
+ blobSASSignatureValues.contentType,
+ ].join("\n");
+ const signature = userDelegationKeyCredential.computeHMACSHA256(stringToSign);
+ return new SASQueryParameters(blobSASSignatureValues.version, signature, verifiedPermissions, undefined, undefined, blobSASSignatureValues.protocol, blobSASSignatureValues.startsOn, blobSASSignatureValues.expiresOn, blobSASSignatureValues.ipRange, blobSASSignatureValues.identifier, resource, blobSASSignatureValues.cacheControl, blobSASSignatureValues.contentDisposition, blobSASSignatureValues.contentEncoding, blobSASSignatureValues.contentLanguage, blobSASSignatureValues.contentType, userDelegationKeyCredential.userDelegationKey, blobSASSignatureValues.preauthorizedAgentObjectId, blobSASSignatureValues.correlationId, blobSASSignatureValues.encryptionScope);
+}
+function getCanonicalName(accountName, containerName, blobName) {
+ // Container: "/blob/account/containerName"
+ // Blob: "/blob/account/containerName/blobName"
+ const elements = [`/blob/${accountName}/${containerName}`];
+ if (blobName) {
+ elements.push(`/${blobName}`);
}
- static fromArraySchema(schema) {
- return new AvroUnionType(schema.map(AvroType.fromSchema));
+ return elements.join("");
+}
+function SASSignatureValuesSanityCheckAndAutofill(blobSASSignatureValues) {
+ const version = blobSASSignatureValues.version ? blobSASSignatureValues.version : SERVICE_VERSION;
+ if (blobSASSignatureValues.snapshotTime && version < "2018-11-09") {
+ throw RangeError("'version' must be >= '2018-11-09' when providing 'snapshotTime'.");
}
- static fromObjectSchema(schema) {
- const type = schema.type;
- // Primitives can be defined as strings or objects
- try {
- return AvroType.fromStringSchema(type);
- }
- catch (err) {
- // eslint-disable-line no-empty
- }
- switch (type) {
- case AvroComplex.RECORD:
- if (schema.aliases) {
- throw new Error(`aliases currently is not supported, schema: ${schema}`);
- }
- if (!schema.name) {
- throw new Error(`Required attribute 'name' doesn't exist on schema: ${schema}`);
- }
- // eslint-disable-next-line no-case-declarations
- const fields = {};
- if (!schema.fields) {
- throw new Error(`Required attribute 'fields' doesn't exist on schema: ${schema}`);
- }
- for (const field of schema.fields) {
- fields[field.name] = AvroType.fromSchema(field.type);
- }
- return new AvroRecordType(fields, schema.name);
- case AvroComplex.ENUM:
- if (schema.aliases) {
- throw new Error(`aliases currently is not supported, schema: ${schema}`);
- }
- if (!schema.symbols) {
- throw new Error(`Required attribute 'symbols' doesn't exist on schema: ${schema}`);
- }
- return new AvroEnumType(schema.symbols);
- case AvroComplex.MAP:
- if (!schema.values) {
- throw new Error(`Required attribute 'values' doesn't exist on schema: ${schema}`);
- }
- return new AvroMapType(AvroType.fromSchema(schema.values));
- case AvroComplex.ARRAY: // Unused today
- case AvroComplex.FIXED: // Unused today
- default:
- throw new Error(`Unexpected Avro type ${type} in ${schema}`);
- }
+ if (blobSASSignatureValues.blobName === undefined && blobSASSignatureValues.snapshotTime) {
+ throw RangeError("Must provide 'blobName' when providing 'snapshotTime'.");
}
-}
-class AvroPrimitiveType extends AvroType {
- constructor(primitive) {
- super();
- this._primitive = primitive;
+ if (blobSASSignatureValues.versionId && version < "2019-10-10") {
+ throw RangeError("'version' must be >= '2019-10-10' when providing 'versionId'.");
}
- read(stream, options = {}) {
- switch (this._primitive) {
- case AvroPrimitive.NULL:
- return AvroParser.readNull();
- case AvroPrimitive.BOOLEAN:
- return AvroParser.readBoolean(stream, options);
- case AvroPrimitive.INT:
- return AvroParser.readInt(stream, options);
- case AvroPrimitive.LONG:
- return AvroParser.readLong(stream, options);
- case AvroPrimitive.FLOAT:
- return AvroParser.readFloat(stream, options);
- case AvroPrimitive.DOUBLE:
- return AvroParser.readDouble(stream, options);
- case AvroPrimitive.BYTES:
- return AvroParser.readBytes(stream, options);
- case AvroPrimitive.STRING:
- return AvroParser.readString(stream, options);
- default:
- throw new Error("Unknown Avro Primitive");
- }
+ if (blobSASSignatureValues.blobName === undefined && blobSASSignatureValues.versionId) {
+ throw RangeError("Must provide 'blobName' when providing 'versionId'.");
}
-}
-class AvroEnumType extends AvroType {
- constructor(symbols) {
- super();
- this._symbols = symbols;
+ if (blobSASSignatureValues.permissions &&
+ blobSASSignatureValues.permissions.setImmutabilityPolicy &&
+ version < "2020-08-04") {
+ throw RangeError("'version' must be >= '2020-08-04' when provided 'i' permission.");
}
- async read(stream, options = {}) {
- const value = await AvroParser.readInt(stream, options);
- return this._symbols[value];
+ if (blobSASSignatureValues.permissions &&
+ blobSASSignatureValues.permissions.deleteVersion &&
+ version < "2019-10-10") {
+ throw RangeError("'version' must be >= '2019-10-10' when providing 'x' permission.");
}
-}
-class AvroUnionType extends AvroType {
- constructor(types) {
- super();
- this._types = types;
+ if (blobSASSignatureValues.permissions &&
+ blobSASSignatureValues.permissions.permanentDelete &&
+ version < "2019-10-10") {
+ throw RangeError("'version' must be >= '2019-10-10' when providing 'y' permission.");
}
- async read(stream, options = {}) {
- // eslint-disable-line @typescript-eslint/ban-types
- const typeIndex = await AvroParser.readInt(stream, options);
- return this._types[typeIndex].read(stream, options);
+ if (blobSASSignatureValues.permissions &&
+ blobSASSignatureValues.permissions.tag &&
+ version < "2019-12-12") {
+ throw RangeError("'version' must be >= '2019-12-12' when providing 't' permission.");
}
-}
-class AvroMapType extends AvroType {
- constructor(itemType) {
- super();
- this._itemType = itemType;
+ if (version < "2020-02-10" &&
+ blobSASSignatureValues.permissions &&
+ (blobSASSignatureValues.permissions.move || blobSASSignatureValues.permissions.execute)) {
+ throw RangeError("'version' must be >= '2020-02-10' when providing the 'm' or 'e' permission.");
}
- read(stream, options = {}) {
- const readItemMethod = (s, opts) => {
- return this._itemType.read(s, opts);
- };
- return AvroParser.readMap(stream, readItemMethod, options);
+ if (version < "2021-04-10" &&
+ blobSASSignatureValues.permissions &&
+ blobSASSignatureValues.permissions.filterByTags) {
+ throw RangeError("'version' must be >= '2021-04-10' when providing the 'f' permission.");
}
-}
-class AvroRecordType extends AvroType {
- constructor(fields, name) {
- super();
- this._fields = fields;
- this._name = name;
+ if (version < "2020-02-10" &&
+ (blobSASSignatureValues.preauthorizedAgentObjectId || blobSASSignatureValues.correlationId)) {
+ throw RangeError("'version' must be >= '2020-02-10' when providing 'preauthorizedAgentObjectId' or 'correlationId'.");
}
- async read(stream, options = {}) {
- const record = {};
- record["$schema"] = this._name;
- for (const key in this._fields) {
- if (Object.prototype.hasOwnProperty.call(this._fields, key)) {
- record[key] = await this._fields[key].read(stream, options);
- }
- }
- return record;
+ if (blobSASSignatureValues.encryptionScope && version < "2020-12-06") {
+ throw RangeError("'version' must be >= '2020-12-06' when provided 'encryptionScope' in SAS.");
}
+ blobSASSignatureValues.version = version;
+ return blobSASSignatureValues;
}
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
-function arraysEqual(a, b) {
- if (a === b)
- return true;
- // eslint-disable-next-line eqeqeq
- if (a == null || b == null)
- return false;
- if (a.length !== b.length)
- return false;
- for (let i = 0; i < a.length; ++i) {
- if (a[i] !== b[i])
- return false;
- }
- return true;
-}
-
-// Copyright (c) Microsoft Corporation.
-class AvroReader {
- constructor(dataStream, headerStream, currentBlockOffset, indexWithinCurrentBlock) {
- this._dataStream = dataStream;
- this._headerStream = headerStream || dataStream;
- this._initialized = false;
- this._blockOffset = currentBlockOffset || 0;
- this._objectIndex = indexWithinCurrentBlock || 0;
- this._initialBlockOffset = currentBlockOffset || 0;
- }
- get blockOffset() {
- return this._blockOffset;
- }
- get objectIndex() {
- return this._objectIndex;
- }
- async initialize(options = {}) {
- const header = await AvroParser.readFixedBytes(this._headerStream, AVRO_INIT_BYTES.length, {
- abortSignal: options.abortSignal,
- });
- if (!arraysEqual(header, AVRO_INIT_BYTES)) {
- throw new Error("Stream is not an Avro file.");
- }
- // File metadata is written as if defined by the following map schema:
- // { "type": "map", "values": "bytes"}
- this._metadata = await AvroParser.readMap(this._headerStream, AvroParser.readString, {
- abortSignal: options.abortSignal,
- });
- // Validate codec
- const codec = this._metadata[AVRO_CODEC_KEY];
- if (!(codec === undefined || codec === null || codec === "null")) {
- throw new Error("Codecs are not supported");
- }
- // The 16-byte, randomly-generated sync marker for this file.
- this._syncMarker = await AvroParser.readFixedBytes(this._headerStream, AVRO_SYNC_MARKER_SIZE, {
- abortSignal: options.abortSignal,
- });
- // Parse the schema
- const schema = JSON.parse(this._metadata[AVRO_SCHEMA_KEY]);
- this._itemType = AvroType.fromSchema(schema);
- if (this._blockOffset === 0) {
- this._blockOffset = this._initialBlockOffset + this._dataStream.position;
- }
- this._itemsRemainingInBlock = await AvroParser.readLong(this._dataStream, {
- abortSignal: options.abortSignal,
- });
- // skip block length
- await AvroParser.readLong(this._dataStream, { abortSignal: options.abortSignal });
- this._initialized = true;
- if (this._objectIndex && this._objectIndex > 0) {
- for (let i = 0; i < this._objectIndex; i++) {
- await this._itemType.read(this._dataStream, { abortSignal: options.abortSignal });
- this._itemsRemainingInBlock--;
- }
- }
- }
- hasNext() {
- return !this._initialized || this._itemsRemainingInBlock > 0;
- }
- parseObjects(options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* parseObjects_1() {
- if (!this._initialized) {
- yield tslib.__await(this.initialize(options));
- }
- while (this.hasNext()) {
- const result = yield tslib.__await(this._itemType.read(this._dataStream, {
- abortSignal: options.abortSignal,
- }));
- this._itemsRemainingInBlock--;
- this._objectIndex++;
- if (this._itemsRemainingInBlock === 0) {
- const marker = yield tslib.__await(AvroParser.readFixedBytes(this._dataStream, AVRO_SYNC_MARKER_SIZE, {
- abortSignal: options.abortSignal,
- }));
- this._blockOffset = this._initialBlockOffset + this._dataStream.position;
- this._objectIndex = 0;
- if (!arraysEqual(this._syncMarker, marker)) {
- throw new Error("Stream is not a valid Avro file.");
- }
- try {
- this._itemsRemainingInBlock = yield tslib.__await(AvroParser.readLong(this._dataStream, {
- abortSignal: options.abortSignal,
- }));
- }
- catch (err) {
- // We hit the end of the stream.
- this._itemsRemainingInBlock = 0;
- }
- if (this._itemsRemainingInBlock > 0) {
- // Ignore block size
- yield tslib.__await(AvroParser.readLong(this._dataStream, { abortSignal: options.abortSignal }));
- }
- }
- yield yield tslib.__await(result);
- }
- });
+/**
+ * A client that manages leases for a {@link ContainerClient} or a {@link BlobClient}.
+ */
+class BlobLeaseClient {
+ /**
+ * Gets the lease Id.
+ *
+ * @readonly
+ */
+ get leaseId() {
+ return this._leaseId;
}
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-class AvroReadable {
-}
-
-// Copyright (c) Microsoft Corporation.
-const ABORT_ERROR = new abortController.AbortError("Reading from the avro stream was aborted.");
-class AvroReadableFromStream extends AvroReadable {
- constructor(readable) {
- super();
- this._readable = readable;
- this._position = 0;
+ /**
+ * Gets the url.
+ *
+ * @readonly
+ */
+ get url() {
+ return this._url;
}
- toUint8Array(data) {
- if (typeof data === "string") {
- return Buffer.from(data);
+ /**
+ * Creates an instance of BlobLeaseClient.
+ * @param client - The client to make the lease operation requests.
+ * @param leaseId - Initial proposed lease id.
+ */
+ constructor(client, leaseId) {
+ const clientContext = client.storageClientContext;
+ this._url = client.url;
+ if (client.name === undefined) {
+ this._isContainer = true;
+ this._containerOrBlobOperation = clientContext.container;
}
- return data;
- }
- get position() {
- return this._position;
- }
- async read(size, options = {}) {
- var _a;
- if ((_a = options.abortSignal) === null || _a === void 0 ? void 0 : _a.aborted) {
- throw ABORT_ERROR;
+ else {
+ this._isContainer = false;
+ this._containerOrBlobOperation = clientContext.blob;
}
- if (size < 0) {
- throw new Error(`size parameter should be positive: ${size}`);
+ if (!leaseId) {
+ leaseId = coreUtil.randomUUID();
}
- if (size === 0) {
- return new Uint8Array();
+ this._leaseId = leaseId;
+ }
+ /**
+ * Establishes and manages a lock on a container for delete operations, or on a blob
+ * for write and delete operations.
+ * The lock duration can be 15 to 60 seconds, or can be infinite.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
+ * and
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
+ *
+ * @param duration - Must be between 15 to 60 seconds, or infinite (-1)
+ * @param options - option to configure lease management operations.
+ * @returns Response data for acquire lease operation.
+ */
+ async acquireLease(duration, options = {}) {
+ var _a, _b, _c, _d, _e;
+ if (this._isContainer &&
+ ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
+ (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
+ ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
+ throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
}
- if (!this._readable.readable) {
- throw new Error("Stream no longer readable.");
+ return tracingClient.withSpan("BlobLeaseClient-acquireLease", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this._containerOrBlobOperation.acquireLease({
+ abortSignal: options.abortSignal,
+ duration,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ proposedLeaseId: this._leaseId,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * To change the ID of the lease.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
+ * and
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
+ *
+ * @param proposedLeaseId - the proposed new lease Id.
+ * @param options - option to configure lease management operations.
+ * @returns Response data for change lease operation.
+ */
+ async changeLease(proposedLeaseId, options = {}) {
+ var _a, _b, _c, _d, _e;
+ if (this._isContainer &&
+ ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
+ (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
+ ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
+ throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
}
- // See if there is already enough data.
- const chunk = this._readable.read(size);
- if (chunk) {
- this._position += chunk.length;
- // chunk.length maybe less than desired size if the stream ends.
- return this.toUint8Array(chunk);
+ return tracingClient.withSpan("BlobLeaseClient-changeLease", options, async (updatedOptions) => {
+ var _a;
+ const response = assertResponse(await this._containerOrBlobOperation.changeLease(this._leaseId, proposedLeaseId, {
+ abortSignal: options.abortSignal,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ this._leaseId = proposedLeaseId;
+ return response;
+ });
+ }
+ /**
+ * To free the lease if it is no longer needed so that another client may
+ * immediately acquire a lease against the container or the blob.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
+ * and
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
+ *
+ * @param options - option to configure lease management operations.
+ * @returns Response data for release lease operation.
+ */
+ async releaseLease(options = {}) {
+ var _a, _b, _c, _d, _e;
+ if (this._isContainer &&
+ ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
+ (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
+ ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
+ throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
}
- else {
- // register callback to wait for enough data to read
- return new Promise((resolve, reject) => {
- /* eslint-disable @typescript-eslint/no-use-before-define */
- const cleanUp = () => {
- this._readable.removeListener("readable", readableCallback);
- this._readable.removeListener("error", rejectCallback);
- this._readable.removeListener("end", rejectCallback);
- this._readable.removeListener("close", rejectCallback);
- if (options.abortSignal) {
- options.abortSignal.removeEventListener("abort", abortHandler);
- }
- };
- const readableCallback = () => {
- const callbackChunk = this._readable.read(size);
- if (callbackChunk) {
- this._position += callbackChunk.length;
- cleanUp();
- // callbackChunk.length maybe less than desired size if the stream ends.
- resolve(this.toUint8Array(callbackChunk));
- }
- };
- const rejectCallback = () => {
- cleanUp();
- reject();
- };
- const abortHandler = () => {
- cleanUp();
- reject(ABORT_ERROR);
- };
- this._readable.on("readable", readableCallback);
- this._readable.once("error", rejectCallback);
- this._readable.once("end", rejectCallback);
- this._readable.once("close", rejectCallback);
- if (options.abortSignal) {
- options.abortSignal.addEventListener("abort", abortHandler);
- }
- /* eslint-enable @typescript-eslint/no-use-before-define */
+ return tracingClient.withSpan("BlobLeaseClient-releaseLease", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this._containerOrBlobOperation.releaseLease(this._leaseId, {
+ abortSignal: options.abortSignal,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * To renew the lease.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
+ * and
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
+ *
+ * @param options - Optional option to configure lease management operations.
+ * @returns Response data for renew lease operation.
+ */
+ async renewLease(options = {}) {
+ var _a, _b, _c, _d, _e;
+ if (this._isContainer &&
+ ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
+ (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
+ ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
+ throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
+ }
+ return tracingClient.withSpan("BlobLeaseClient-renewLease", options, async (updatedOptions) => {
+ var _a;
+ return this._containerOrBlobOperation.renewLease(this._leaseId, {
+ abortSignal: options.abortSignal,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
});
+ });
+ }
+ /**
+ * To end the lease but ensure that another client cannot acquire a new lease
+ * until the current lease period has expired.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-container
+ * and
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/lease-blob
+ *
+ * @param breakPeriod - Break period
+ * @param options - Optional options to configure lease management operations.
+ * @returns Response data for break lease operation.
+ */
+ async breakLease(breakPeriod, options = {}) {
+ var _a, _b, _c, _d, _e;
+ if (this._isContainer &&
+ ((((_a = options.conditions) === null || _a === void 0 ? void 0 : _a.ifMatch) && ((_b = options.conditions) === null || _b === void 0 ? void 0 : _b.ifMatch) !== ETagNone) ||
+ (((_c = options.conditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch) && ((_d = options.conditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch) !== ETagNone) ||
+ ((_e = options.conditions) === null || _e === void 0 ? void 0 : _e.tagConditions))) {
+ throw new RangeError("The IfMatch, IfNoneMatch and tags access conditions are ignored by the service. Values other than undefined or their default values are not acceptable.");
}
+ return tracingClient.withSpan("BlobLeaseClient-breakLease", options, async (updatedOptions) => {
+ var _a;
+ const operationOptions = {
+ abortSignal: options.abortSignal,
+ breakPeriod,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ };
+ return assertResponse(await this._containerOrBlobOperation.breakLease(operationOptions));
+ });
}
}
// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
- * A Node.js BlobQuickQueryStream will internally parse avro data stream for blob query.
+ * A Node.js ReadableStream will internally retry when internal ReadableStream unexpected ends.
*/
-class BlobQuickQueryStream extends stream.Readable {
+class RetriableReadableStream extends stream.Readable {
/**
- * Creates an instance of BlobQuickQueryStream.
+ * Creates an instance of RetriableReadableStream.
*
* @param source - The current ReadableStream returned from getter
+ * @param getter - A method calling downloading request returning
+ * a new ReadableStream from specified offset
+ * @param offset - Offset position in original data source to read
+ * @param count - How much data in original data source to read
* @param options -
*/
- constructor(source, options = {}) {
- super();
- this.avroPaused = true;
+ constructor(source, getter, offset, count, options = {}) {
+ super({ highWaterMark: options.highWaterMark });
+ this.retries = 0;
+ this.sourceDataHandler = (data) => {
+ if (this.options.doInjectErrorOnce) {
+ this.options.doInjectErrorOnce = undefined;
+ this.source.pause();
+ this.sourceErrorOrEndHandler();
+ this.source.destroy();
+ return;
+ }
+ // console.log(
+ // `Offset: ${this.offset}, Received ${data.length} from internal stream`
+ // );
+ this.offset += data.length;
+ if (this.onProgress) {
+ this.onProgress({ loadedBytes: this.offset - this.start });
+ }
+ if (!this.push(data)) {
+ this.source.pause();
+ }
+ };
+ this.sourceAbortedHandler = () => {
+ const abortError = new abortController.AbortError("The operation was aborted.");
+ this.destroy(abortError);
+ };
+ this.sourceErrorOrEndHandler = (err) => {
+ if (err && err.name === "AbortError") {
+ this.destroy(err);
+ return;
+ }
+ // console.log(
+ // `Source stream emits end or error, offset: ${
+ // this.offset
+ // }, dest end : ${this.end}`
+ // );
+ this.removeSourceEventHandlers();
+ if (this.offset - 1 === this.end) {
+ this.push(null);
+ }
+ else if (this.offset <= this.end) {
+ // console.log(
+ // `retries: ${this.retries}, max retries: ${this.maxRetries}`
+ // );
+ if (this.retries < this.maxRetryRequests) {
+ this.retries += 1;
+ this.getter(this.offset)
+ .then((newSource) => {
+ this.source = newSource;
+ this.setSourceEventHandlers();
+ return;
+ })
+ .catch((error) => {
+ this.destroy(error);
+ });
+ }
+ else {
+ this.destroy(new Error(`Data corruption failure: received less data than required and reached maxRetires limitation. Received data offset: ${this.offset - 1}, data needed offset: ${this.end}, retries: ${this.retries}, max retries: ${this.maxRetryRequests}`));
+ }
+ }
+ else {
+ this.destroy(new Error(`Data corruption failure: Received more data than original request, data needed offset is ${this.end}, received offset: ${this.offset - 1}`));
+ }
+ };
+ this.getter = getter;
this.source = source;
+ this.start = offset;
+ this.offset = offset;
+ this.end = offset + count - 1;
+ this.maxRetryRequests =
+ options.maxRetryRequests && options.maxRetryRequests >= 0 ? options.maxRetryRequests : 0;
this.onProgress = options.onProgress;
- this.onError = options.onError;
- this.avroReader = new AvroReader(new AvroReadableFromStream(this.source));
- this.avroIter = this.avroReader.parseObjects({ abortSignal: options.abortSignal });
+ this.options = options;
+ this.setSourceEventHandlers();
}
_read() {
- if (this.avroPaused) {
- this.readInternal().catch((err) => {
- this.emit("error", err);
- });
- }
+ this.source.resume();
}
- async readInternal() {
- this.avroPaused = false;
- let avroNext;
- do {
- avroNext = await this.avroIter.next();
- if (avroNext.done) {
- break;
- }
- const obj = avroNext.value;
- const schema = obj.$schema;
- if (typeof schema !== "string") {
- throw Error("Missing schema in avro record.");
- }
- switch (schema) {
- case "com.microsoft.azure.storage.queryBlobContents.resultData":
- {
- const data = obj.data;
- if (data instanceof Uint8Array === false) {
- throw Error("Invalid data in avro result record.");
- }
- if (!this.push(Buffer.from(data))) {
- this.avroPaused = true;
- }
- }
- break;
- case "com.microsoft.azure.storage.queryBlobContents.progress":
- {
- const bytesScanned = obj.bytesScanned;
- if (typeof bytesScanned !== "number") {
- throw Error("Invalid bytesScanned in avro progress record.");
- }
- if (this.onProgress) {
- this.onProgress({ loadedBytes: bytesScanned });
- }
- }
- break;
- case "com.microsoft.azure.storage.queryBlobContents.end":
- if (this.onProgress) {
- const totalBytes = obj.totalBytes;
- if (typeof totalBytes !== "number") {
- throw Error("Invalid totalBytes in avro end record.");
- }
- this.onProgress({ loadedBytes: totalBytes });
- }
- this.push(null);
- break;
- case "com.microsoft.azure.storage.queryBlobContents.error":
- if (this.onError) {
- const fatal = obj.fatal;
- if (typeof fatal !== "boolean") {
- throw Error("Invalid fatal in avro error record.");
- }
- const name = obj.name;
- if (typeof name !== "string") {
- throw Error("Invalid name in avro error record.");
- }
- const description = obj.description;
- if (typeof description !== "string") {
- throw Error("Invalid description in avro error record.");
- }
- const position = obj.position;
- if (typeof position !== "number") {
- throw Error("Invalid position in avro error record.");
- }
- this.onError({
- position,
- name,
- isFatal: fatal,
- description,
- });
- }
- break;
- default:
- throw Error(`Unknown schema ${schema} in avro progress record.`);
- }
- } while (!avroNext.done && !this.avroPaused);
+ setSourceEventHandlers() {
+ this.source.on("data", this.sourceDataHandler);
+ this.source.on("end", this.sourceErrorOrEndHandler);
+ this.source.on("error", this.sourceErrorOrEndHandler);
+ // needed for Node14
+ this.source.on("aborted", this.sourceAbortedHandler);
+ }
+ removeSourceEventHandlers() {
+ this.source.removeListener("data", this.sourceDataHandler);
+ this.source.removeListener("end", this.sourceErrorOrEndHandler);
+ this.source.removeListener("error", this.sourceErrorOrEndHandler);
+ this.source.removeListener("aborted", this.sourceAbortedHandler);
+ }
+ _destroy(error, callback) {
+ // remove listener from source and release source
+ this.removeSourceEventHandlers();
+ this.source.destroy();
+ callback(error === null ? undefined : error);
}
}
// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
- * BlobQueryResponse implements BlobDownloadResponseModel interface, and in Node.js runtime it will
- * parse avor data returned by blob query.
+ * BlobDownloadResponse implements BlobDownloadResponseParsed interface, and in Node.js runtime it will
+ * automatically retry when internal read stream unexpected ends. (This kind of unexpected ends cannot
+ * trigger retries defined in pipeline retry policy.)
+ *
+ * The {@link readableStreamBody} stream will retry underlayer, you can just use it as a normal Node.js
+ * Readable stream.
*/
-class BlobQueryResponse {
- /**
- * Creates an instance of BlobQueryResponse.
- *
- * @param originalResponse -
- * @param options -
- */
- constructor(originalResponse, options = {}) {
- this.originalResponse = originalResponse;
- this.blobDownloadStream = new BlobQuickQueryStream(this.originalResponse.readableStreamBody, options);
- }
+class BlobDownloadResponse {
/**
* Indicates that the service supports
* requests for partial file content.
@@ -35343,7 +25477,7 @@ class BlobQueryResponse {
* @readonly
*/
get copyCompletedOn() {
- return undefined;
+ return this.originalResponse.copyCompletedOn;
}
/**
* String identifier for the last attempted Copy
@@ -35450,6 +25584,14 @@ class BlobQueryResponse {
get etag() {
return this.originalResponse.etag;
}
+ /**
+ * The number of tags associated with the blob
+ *
+ * @readonly
+ */
+ get tagCount() {
+ return this.originalResponse.tagCount;
+ }
/**
* The error code.
*
@@ -35492,6 +25634,23 @@ class BlobQueryResponse {
get lastModified() {
return this.originalResponse.lastModified;
}
+ /**
+ * Returns the UTC date and time generated by the service that indicates the time at which the blob was
+ * last read or written to.
+ *
+ * @readonly
+ */
+ get lastAccessed() {
+ return this.originalResponse.lastAccessed;
+ }
+ /**
+ * Returns the date and time the blob was created.
+ *
+ * @readonly
+ */
+ get createdOn() {
+ return this.originalResponse.createdOn;
+ }
/**
* A name-value pair
* to associate with a file storage object.
@@ -35507,44 +25666,108 @@ class BlobQueryResponse {
*
* @readonly
*/
- get requestId() {
- return this.originalResponse.requestId;
+ get requestId() {
+ return this.originalResponse.requestId;
+ }
+ /**
+ * If a client request id header is sent in the request, this header will be present in the
+ * response with the same value.
+ *
+ * @readonly
+ */
+ get clientRequestId() {
+ return this.originalResponse.clientRequestId;
+ }
+ /**
+ * Indicates the version of the Blob service used
+ * to execute the request.
+ *
+ * @readonly
+ */
+ get version() {
+ return this.originalResponse.version;
+ }
+ /**
+ * Indicates the versionId of the downloaded blob version.
+ *
+ * @readonly
+ */
+ get versionId() {
+ return this.originalResponse.versionId;
+ }
+ /**
+ * Indicates whether version of this blob is a current version.
+ *
+ * @readonly
+ */
+ get isCurrentVersion() {
+ return this.originalResponse.isCurrentVersion;
+ }
+ /**
+ * The SHA-256 hash of the encryption key used to encrypt the blob. This value is only returned
+ * when the blob was encrypted with a customer-provided key.
+ *
+ * @readonly
+ */
+ get encryptionKeySha256() {
+ return this.originalResponse.encryptionKeySha256;
+ }
+ /**
+ * If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to
+ * true, then the request returns a crc64 for the range, as long as the range size is less than
+ * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is
+ * specified in the same request, it will fail with 400(Bad Request)
+ */
+ get contentCrc64() {
+ return this.originalResponse.contentCrc64;
+ }
+ /**
+ * Object Replication Policy Id of the destination blob.
+ *
+ * @readonly
+ */
+ get objectReplicationDestinationPolicyId() {
+ return this.originalResponse.objectReplicationDestinationPolicyId;
+ }
+ /**
+ * Parsed Object Replication Policy Id, Rule Id(s) and status of the source blob.
+ *
+ * @readonly
+ */
+ get objectReplicationSourceProperties() {
+ return this.originalResponse.objectReplicationSourceProperties;
}
/**
- * If a client request id header is sent in the request, this header will be present in the
- * response with the same value.
+ * If this blob has been sealed.
*
* @readonly
*/
- get clientRequestId() {
- return this.originalResponse.clientRequestId;
+ get isSealed() {
+ return this.originalResponse.isSealed;
}
/**
- * Indicates the version of the File service used
- * to execute the request.
+ * UTC date/time value generated by the service that indicates the time at which the blob immutability policy will expire.
*
* @readonly
*/
- get version() {
- return this.originalResponse.version;
+ get immutabilityPolicyExpiresOn() {
+ return this.originalResponse.immutabilityPolicyExpiresOn;
}
/**
- * The SHA-256 hash of the encryption key used to encrypt the blob. This value is only returned
- * when the blob was encrypted with a customer-provided key.
+ * Indicates immutability policy mode.
*
* @readonly
*/
- get encryptionKeySha256() {
- return this.originalResponse.encryptionKeySha256;
+ get immutabilityPolicyMode() {
+ return this.originalResponse.immutabilityPolicyMode;
}
/**
- * If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to
- * true, then the request returns a crc64 for the range, as long as the range size is less than
- * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is
- * specified in the same request, it will fail with 400(Bad Request)
+ * Indicates if a legal hold is present on the blob.
+ *
+ * @readonly
*/
- get contentCrc64() {
- return this.originalResponse.contentCrc64;
+ get legalHold() {
+ return this.originalResponse.legalHold;
}
/**
* The response body as a browser Blob.
@@ -35552,19 +25775,19 @@ class BlobQueryResponse {
*
* @readonly
*/
- get blobBody() {
- return undefined;
+ get contentAsBlob() {
+ return this.originalResponse.blobBody;
}
/**
* The response body as a node.js Readable stream.
* Always undefined in the browser.
*
- * It will parse avor data returned by blob query.
+ * It will automatically retry when internal read stream unexpected ends.
*
* @readonly
*/
get readableStreamBody() {
- return coreHttp.isNode ? this.blobDownloadStream : undefined;
+ return coreUtil.isNode ? this.blobDownloadStream : undefined;
}
/**
* The HTTP response.
@@ -35572,2911 +25795,1984 @@ class BlobQueryResponse {
get _response() {
return this.originalResponse._response;
}
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * Represents the access tier on a blob.
- * For detailed information about block blob level tiering see {@link https://docs.microsoft.com/azure/storage/blobs/storage-blob-storage-tiers|Hot, cool and archive storage tiers.}
- */
-exports.BlockBlobTier = void 0;
-(function (BlockBlobTier) {
- /**
- * Optimized for storing data that is accessed frequently.
- */
- BlockBlobTier["Hot"] = "Hot";
- /**
- * Optimized for storing data that is infrequently accessed and stored for at least 30 days.
- */
- BlockBlobTier["Cool"] = "Cool";
- /**
- * Optimized for storing data that is rarely accessed.
- */
- BlockBlobTier["Cold"] = "Cold";
/**
- * Optimized for storing data that is rarely accessed and stored for at least 180 days
- * with flexible latency requirements (on the order of hours).
- */
- BlockBlobTier["Archive"] = "Archive";
-})(exports.BlockBlobTier || (exports.BlockBlobTier = {}));
-/**
- * Specifies the page blob tier to set the blob to. This is only applicable to page blobs on premium storage accounts.
- * Please see {@link https://docs.microsoft.com/azure/storage/storage-premium-storage#scalability-and-performance-targets|here}
- * for detailed information on the corresponding IOPS and throughput per PageBlobTier.
- */
-exports.PremiumPageBlobTier = void 0;
-(function (PremiumPageBlobTier) {
- /**
- * P4 Tier.
- */
- PremiumPageBlobTier["P4"] = "P4";
- /**
- * P6 Tier.
- */
- PremiumPageBlobTier["P6"] = "P6";
- /**
- * P10 Tier.
- */
- PremiumPageBlobTier["P10"] = "P10";
- /**
- * P15 Tier.
- */
- PremiumPageBlobTier["P15"] = "P15";
- /**
- * P20 Tier.
- */
- PremiumPageBlobTier["P20"] = "P20";
- /**
- * P30 Tier.
- */
- PremiumPageBlobTier["P30"] = "P30";
- /**
- * P40 Tier.
- */
- PremiumPageBlobTier["P40"] = "P40";
- /**
- * P50 Tier.
- */
- PremiumPageBlobTier["P50"] = "P50";
- /**
- * P60 Tier.
- */
- PremiumPageBlobTier["P60"] = "P60";
- /**
- * P70 Tier.
- */
- PremiumPageBlobTier["P70"] = "P70";
- /**
- * P80 Tier.
+ * Creates an instance of BlobDownloadResponse.
+ *
+ * @param originalResponse -
+ * @param getter -
+ * @param offset -
+ * @param count -
+ * @param options -
*/
- PremiumPageBlobTier["P80"] = "P80";
-})(exports.PremiumPageBlobTier || (exports.PremiumPageBlobTier = {}));
-function toAccessTier(tier) {
- if (tier === undefined) {
- return undefined;
- }
- return tier; // No more check if string is a valid AccessTier, and left this to underlay logic to decide(service).
-}
-function ensureCpkIfSpecified(cpk, isHttps) {
- if (cpk && !isHttps) {
- throw new RangeError("Customer-provided encryption key must be used over HTTPS.");
- }
- if (cpk && !cpk.encryptionAlgorithm) {
- cpk.encryptionAlgorithm = EncryptionAlgorithmAES25;
+ constructor(originalResponse, getter, offset, count, options = {}) {
+ this.originalResponse = originalResponse;
+ this.blobDownloadStream = new RetriableReadableStream(this.originalResponse.readableStreamBody, getter, offset, count, options);
}
}
-/**
- * Defines the known cloud audiences for Storage.
- */
-exports.StorageBlobAudience = void 0;
-(function (StorageBlobAudience) {
- /**
- * The OAuth scope to use to retrieve an AAD token for Azure Storage.
- */
- StorageBlobAudience["StorageOAuthScopes"] = "https://storage.azure.com/.default";
- /**
- * The OAuth scope to use to retrieve an AAD token for Azure Disk.
- */
- StorageBlobAudience["DiskComputeOAuthScopes"] = "https://disk.compute.azure.com/.default";
-})(exports.StorageBlobAudience || (exports.StorageBlobAudience = {}));
-function getBlobServiceAccountAudience(storageAccountName) {
- return `https://${storageAccountName}.blob.core.windows.net/.default`;
-}
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
-/**
- * Function that converts PageRange and ClearRange to a common Range object.
- * PageRange and ClearRange have start and end while Range offset and count
- * this function normalizes to Range.
- * @param response - Model PageBlob Range response
- */
-function rangeResponseFromModel(response) {
- const pageRange = (response._response.parsedBody.pageRange || []).map((x) => ({
- offset: x.start,
- count: x.end - x.start,
- }));
- const clearRange = (response._response.parsedBody.clearRange || []).map((x) => ({
- offset: x.start,
- count: x.end - x.start,
- }));
- return Object.assign(Object.assign({}, response), { pageRange,
- clearRange, _response: Object.assign(Object.assign({}, response._response), { parsedBody: {
- pageRange,
- clearRange,
- } }) });
-}
+const AVRO_SYNC_MARKER_SIZE = 16;
+const AVRO_INIT_BYTES = new Uint8Array([79, 98, 106, 1]);
+const AVRO_CODEC_KEY = "avro.codec";
+const AVRO_SCHEMA_KEY = "avro.schema";
// Copyright (c) Microsoft Corporation.
-/**
- * This is the poller returned by {@link BlobClient.beginCopyFromURL}.
- * This can not be instantiated directly outside of this package.
- *
- * @hidden
- */
-class BlobBeginCopyFromUrlPoller extends coreLro.Poller {
- constructor(options) {
- const { blobClient, copySource, intervalInMs = 15000, onProgress, resumeFrom, startCopyFromURLOptions, } = options;
- let state;
- if (resumeFrom) {
- state = JSON.parse(resumeFrom).state;
+// Licensed under the MIT license.
+class AvroParser {
+ /**
+ * Reads a fixed number of bytes from the stream.
+ *
+ * @param stream -
+ * @param length -
+ * @param options -
+ */
+ static async readFixedBytes(stream, length, options = {}) {
+ const bytes = await stream.read(length, { abortSignal: options.abortSignal });
+ if (bytes.length !== length) {
+ throw new Error("Hit stream end.");
}
- const operation = makeBlobBeginCopyFromURLPollOperation(Object.assign(Object.assign({}, state), { blobClient,
- copySource,
- startCopyFromURLOptions }));
- super(operation);
- if (typeof onProgress === "function") {
- this.onProgress(onProgress);
+ return bytes;
+ }
+ /**
+ * Reads a single byte from the stream.
+ *
+ * @param stream -
+ * @param options -
+ */
+ static async readByte(stream, options = {}) {
+ const buf = await AvroParser.readFixedBytes(stream, 1, options);
+ return buf[0];
+ }
+ // int and long are stored in variable-length zig-zag coding.
+ // variable-length: https://lucene.apache.org/core/3_5_0/fileformats.html#VInt
+ // zig-zag: https://developers.google.com/protocol-buffers/docs/encoding?csw=1#types
+ static async readZigZagLong(stream, options = {}) {
+ let zigZagEncoded = 0;
+ let significanceInBit = 0;
+ let byte, haveMoreByte, significanceInFloat;
+ do {
+ byte = await AvroParser.readByte(stream, options);
+ haveMoreByte = byte & 0x80;
+ zigZagEncoded |= (byte & 0x7f) << significanceInBit;
+ significanceInBit += 7;
+ } while (haveMoreByte && significanceInBit < 28); // bitwise operation only works for 32-bit integers
+ if (haveMoreByte) {
+ // Switch to float arithmetic
+ // eslint-disable-next-line no-self-assign
+ zigZagEncoded = zigZagEncoded;
+ significanceInFloat = 268435456; // 2 ** 28.
+ do {
+ byte = await AvroParser.readByte(stream, options);
+ zigZagEncoded += (byte & 0x7f) * significanceInFloat;
+ significanceInFloat *= 128; // 2 ** 7
+ } while (byte & 0x80);
+ const res = (zigZagEncoded % 2 ? -(zigZagEncoded + 1) : zigZagEncoded) / 2;
+ if (res < Number.MIN_SAFE_INTEGER || res > Number.MAX_SAFE_INTEGER) {
+ throw new Error("Integer overflow.");
+ }
+ return res;
}
- this.intervalInMs = intervalInMs;
+ return (zigZagEncoded >> 1) ^ -(zigZagEncoded & 1);
}
- delay() {
- return coreHttp.delay(this.intervalInMs);
+ static async readLong(stream, options = {}) {
+ return AvroParser.readZigZagLong(stream, options);
}
-}
-/**
- * Note: Intentionally using function expression over arrow function expression
- * so that the function can be invoked with a different context.
- * This affects what `this` refers to.
- * @hidden
- */
-const cancel = async function cancel(options = {}) {
- const state = this.state;
- const { copyId } = state;
- if (state.isCompleted) {
- return makeBlobBeginCopyFromURLPollOperation(state);
+ static async readInt(stream, options = {}) {
+ return AvroParser.readZigZagLong(stream, options);
}
- if (!copyId) {
- state.isCancelled = true;
- return makeBlobBeginCopyFromURLPollOperation(state);
+ static async readNull() {
+ return null;
}
- // if abortCopyFromURL throws, it will bubble up to user's poller.cancelOperation call
- await state.blobClient.abortCopyFromURL(copyId, {
- abortSignal: options.abortSignal,
- });
- state.isCancelled = true;
- return makeBlobBeginCopyFromURLPollOperation(state);
-};
-/**
- * Note: Intentionally using function expression over arrow function expression
- * so that the function can be invoked with a different context.
- * This affects what `this` refers to.
- * @hidden
- */
-const update = async function update(options = {}) {
- const state = this.state;
- const { blobClient, copySource, startCopyFromURLOptions } = state;
- if (!state.isStarted) {
- state.isStarted = true;
- const result = await blobClient.startCopyFromURL(copySource, startCopyFromURLOptions);
- // copyId is needed to abort
- state.copyId = result.copyId;
- if (result.copyStatus === "success") {
- state.result = result;
- state.isCompleted = true;
+ static async readBoolean(stream, options = {}) {
+ const b = await AvroParser.readByte(stream, options);
+ if (b === 1) {
+ return true;
}
- }
- else if (!state.isCompleted) {
- try {
- const result = await state.blobClient.getProperties({ abortSignal: options.abortSignal });
- const { copyStatus, copyProgress } = result;
- const prevCopyProgress = state.copyProgress;
- if (copyProgress) {
- state.copyProgress = copyProgress;
- }
- if (copyStatus === "pending" &&
- copyProgress !== prevCopyProgress &&
- typeof options.fireProgress === "function") {
- // trigger in setTimeout, or swallow error?
- options.fireProgress(state);
- }
- else if (copyStatus === "success") {
- state.result = result;
- state.isCompleted = true;
- }
- else if (copyStatus === "failed") {
- state.error = new Error(`Blob copy failed with reason: "${result.copyStatusDescription || "unknown"}"`);
- state.isCompleted = true;
- }
+ else if (b === 0) {
+ return false;
}
- catch (err) {
- state.error = err;
- state.isCompleted = true;
+ else {
+ throw new Error("Byte was not a boolean.");
}
}
- return makeBlobBeginCopyFromURLPollOperation(state);
-};
-/**
- * Note: Intentionally using function expression over arrow function expression
- * so that the function can be invoked with a different context.
- * This affects what `this` refers to.
- * @hidden
- */
-const toString = function toString() {
- return JSON.stringify({ state: this.state }, (key, value) => {
- // remove blobClient from serialized state since a client can't be hydrated from this info.
- if (key === "blobClient") {
- return undefined;
- }
- return value;
- });
-};
-/**
- * Creates a poll operation given the provided state.
- * @hidden
- */
-function makeBlobBeginCopyFromURLPollOperation(state) {
- return {
- state: Object.assign({}, state),
- cancel,
- toString,
- update,
- };
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * Generate a range string. For example:
- *
- * "bytes=255-" or "bytes=0-511"
- *
- * @param iRange -
- */
-function rangeToString(iRange) {
- if (iRange.offset < 0) {
- throw new RangeError(`Range.offset cannot be smaller than 0.`);
+ static async readFloat(stream, options = {}) {
+ const u8arr = await AvroParser.readFixedBytes(stream, 4, options);
+ const view = new DataView(u8arr.buffer, u8arr.byteOffset, u8arr.byteLength);
+ return view.getFloat32(0, true); // littleEndian = true
}
- if (iRange.count && iRange.count <= 0) {
- throw new RangeError(`Range.count must be larger than 0. Leave it undefined if you want a range from offset to the end.`);
+ static async readDouble(stream, options = {}) {
+ const u8arr = await AvroParser.readFixedBytes(stream, 8, options);
+ const view = new DataView(u8arr.buffer, u8arr.byteOffset, u8arr.byteLength);
+ return view.getFloat64(0, true); // littleEndian = true
}
- return iRange.count
- ? `bytes=${iRange.offset}-${iRange.offset + iRange.count - 1}`
- : `bytes=${iRange.offset}-`;
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * States for Batch.
- */
-var BatchStates;
-(function (BatchStates) {
- BatchStates[BatchStates["Good"] = 0] = "Good";
- BatchStates[BatchStates["Error"] = 1] = "Error";
-})(BatchStates || (BatchStates = {}));
-/**
- * Batch provides basic parallel execution with concurrency limits.
- * Will stop execute left operations when one of the executed operation throws an error.
- * But Batch cannot cancel ongoing operations, you need to cancel them by yourself.
- */
-class Batch {
- /**
- * Creates an instance of Batch.
- * @param concurrency -
- */
- constructor(concurrency = 5) {
- /**
- * Number of active operations under execution.
- */
- this.actives = 0;
- /**
- * Number of completed operations under execution.
- */
- this.completed = 0;
- /**
- * Offset of next operation to be executed.
- */
- this.offset = 0;
- /**
- * Operation array to be executed.
- */
- this.operations = [];
- /**
- * States of Batch. When an error happens, state will turn into error.
- * Batch will stop execute left operations.
- */
- this.state = BatchStates.Good;
- if (concurrency < 1) {
- throw new RangeError("concurrency must be larger than 0");
+ static async readBytes(stream, options = {}) {
+ const size = await AvroParser.readLong(stream, options);
+ if (size < 0) {
+ throw new Error("Bytes size was negative.");
}
- this.concurrency = concurrency;
- this.emitter = new events.EventEmitter();
- }
- /**
- * Add a operation into queue.
- *
- * @param operation -
- */
- addOperation(operation) {
- this.operations.push(async () => {
- try {
- this.actives++;
- await operation();
- this.actives--;
- this.completed++;
- this.parallelExecute();
- }
- catch (error) {
- this.emitter.emit("error", error);
- }
- });
+ return stream.read(size, { abortSignal: options.abortSignal });
}
- /**
- * Start execute operations in the queue.
- *
- */
- async do() {
- if (this.operations.length === 0) {
- return Promise.resolve();
- }
- this.parallelExecute();
- return new Promise((resolve, reject) => {
- this.emitter.on("finish", resolve);
- this.emitter.on("error", (error) => {
- this.state = BatchStates.Error;
- reject(error);
- });
- });
+ static async readString(stream, options = {}) {
+ const u8arr = await AvroParser.readBytes(stream, options);
+ const utf8decoder = new TextDecoder();
+ return utf8decoder.decode(u8arr);
}
- /**
- * Get next operation to be executed. Return null when reaching ends.
- *
- */
- nextOperation() {
- if (this.offset < this.operations.length) {
- return this.operations[this.offset++];
- }
- return null;
+ static async readMapPair(stream, readItemMethod, options = {}) {
+ const key = await AvroParser.readString(stream, options);
+ // FUTURE: this won't work with readFixed (currently not supported) which needs a length as the parameter.
+ const value = await readItemMethod(stream, options);
+ return { key, value };
}
- /**
- * Start execute operations. One one the most important difference between
- * this method with do() is that do() wraps as an sync method.
- *
- */
- parallelExecute() {
- if (this.state === BatchStates.Error) {
- return;
- }
- if (this.completed >= this.operations.length) {
- this.emitter.emit("finish");
- return;
+ static async readMap(stream, readItemMethod, options = {}) {
+ const readPairMethod = (s, opts = {}) => {
+ return AvroParser.readMapPair(s, readItemMethod, opts);
+ };
+ const pairs = await AvroParser.readArray(stream, readPairMethod, options);
+ const dict = {};
+ for (const pair of pairs) {
+ dict[pair.key] = pair.value;
}
- while (this.actives < this.concurrency) {
- const operation = this.nextOperation();
- if (operation) {
- operation();
+ return dict;
+ }
+ static async readArray(stream, readItemMethod, options = {}) {
+ const items = [];
+ for (let count = await AvroParser.readLong(stream, options); count !== 0; count = await AvroParser.readLong(stream, options)) {
+ if (count < 0) {
+ // Ignore block sizes
+ await AvroParser.readLong(stream, options);
+ count = -count;
}
- else {
- return;
+ while (count--) {
+ const item = await readItemMethod(stream, options);
+ items.push(item);
}
}
+ return items;
}
}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * This class generates a readable stream from the data in an array of buffers.
- */
-class BuffersStream extends stream.Readable {
+var AvroComplex;
+(function (AvroComplex) {
+ AvroComplex["RECORD"] = "record";
+ AvroComplex["ENUM"] = "enum";
+ AvroComplex["ARRAY"] = "array";
+ AvroComplex["MAP"] = "map";
+ AvroComplex["UNION"] = "union";
+ AvroComplex["FIXED"] = "fixed";
+})(AvroComplex || (AvroComplex = {}));
+var AvroPrimitive;
+(function (AvroPrimitive) {
+ AvroPrimitive["NULL"] = "null";
+ AvroPrimitive["BOOLEAN"] = "boolean";
+ AvroPrimitive["INT"] = "int";
+ AvroPrimitive["LONG"] = "long";
+ AvroPrimitive["FLOAT"] = "float";
+ AvroPrimitive["DOUBLE"] = "double";
+ AvroPrimitive["BYTES"] = "bytes";
+ AvroPrimitive["STRING"] = "string";
+})(AvroPrimitive || (AvroPrimitive = {}));
+class AvroType {
/**
- * Creates an instance of BuffersStream that will emit the data
- * contained in the array of buffers.
- *
- * @param buffers - Array of buffers containing the data
- * @param byteLength - The total length of data contained in the buffers
+ * Determines the AvroType from the Avro Schema.
*/
- constructor(buffers, byteLength, options) {
- super(options);
- this.buffers = buffers;
- this.byteLength = byteLength;
- this.byteOffsetInCurrentBuffer = 0;
- this.bufferIndex = 0;
- this.pushedBytesLength = 0;
- // check byteLength is no larger than buffers[] total length
- let buffersLength = 0;
- for (const buf of this.buffers) {
- buffersLength += buf.byteLength;
+ static fromSchema(schema) {
+ if (typeof schema === "string") {
+ return AvroType.fromStringSchema(schema);
}
- if (buffersLength < this.byteLength) {
- throw new Error("Data size shouldn't be larger than the total length of buffers.");
+ else if (Array.isArray(schema)) {
+ return AvroType.fromArraySchema(schema);
+ }
+ else {
+ return AvroType.fromObjectSchema(schema);
}
}
- /**
- * Internal _read() that will be called when the stream wants to pull more data in.
- *
- * @param size - Optional. The size of data to be read
- */
- _read(size) {
- if (this.pushedBytesLength >= this.byteLength) {
- this.push(null);
+ static fromStringSchema(schema) {
+ switch (schema) {
+ case AvroPrimitive.NULL:
+ case AvroPrimitive.BOOLEAN:
+ case AvroPrimitive.INT:
+ case AvroPrimitive.LONG:
+ case AvroPrimitive.FLOAT:
+ case AvroPrimitive.DOUBLE:
+ case AvroPrimitive.BYTES:
+ case AvroPrimitive.STRING:
+ return new AvroPrimitiveType(schema);
+ default:
+ throw new Error(`Unexpected Avro type ${schema}`);
}
- if (!size) {
- size = this.readableHighWaterMark;
+ }
+ static fromArraySchema(schema) {
+ return new AvroUnionType(schema.map(AvroType.fromSchema));
+ }
+ static fromObjectSchema(schema) {
+ const type = schema.type;
+ // Primitives can be defined as strings or objects
+ try {
+ return AvroType.fromStringSchema(type);
}
- const outBuffers = [];
- let i = 0;
- while (i < size && this.pushedBytesLength < this.byteLength) {
- // The last buffer may be longer than the data it contains.
- const remainingDataInAllBuffers = this.byteLength - this.pushedBytesLength;
- const remainingCapacityInThisBuffer = this.buffers[this.bufferIndex].byteLength - this.byteOffsetInCurrentBuffer;
- const remaining = Math.min(remainingCapacityInThisBuffer, remainingDataInAllBuffers);
- if (remaining > size - i) {
- // chunkSize = size - i
- const end = this.byteOffsetInCurrentBuffer + size - i;
- outBuffers.push(this.buffers[this.bufferIndex].slice(this.byteOffsetInCurrentBuffer, end));
- this.pushedBytesLength += size - i;
- this.byteOffsetInCurrentBuffer = end;
- i = size;
- break;
- }
- else {
- // chunkSize = remaining
- const end = this.byteOffsetInCurrentBuffer + remaining;
- outBuffers.push(this.buffers[this.bufferIndex].slice(this.byteOffsetInCurrentBuffer, end));
- if (remaining === remainingCapacityInThisBuffer) {
- // this.buffers[this.bufferIndex] used up, shift to next one
- this.byteOffsetInCurrentBuffer = 0;
- this.bufferIndex++;
+ catch (err) {
+ // eslint-disable-line no-empty
+ }
+ switch (type) {
+ case AvroComplex.RECORD:
+ if (schema.aliases) {
+ throw new Error(`aliases currently is not supported, schema: ${schema}`);
}
- else {
- this.byteOffsetInCurrentBuffer = end;
+ if (!schema.name) {
+ throw new Error(`Required attribute 'name' doesn't exist on schema: ${schema}`);
}
- this.pushedBytesLength += remaining;
- i += remaining;
- }
- }
- if (outBuffers.length > 1) {
- this.push(Buffer.concat(outBuffers));
- }
- else if (outBuffers.length === 1) {
- this.push(outBuffers[0]);
+ // eslint-disable-next-line no-case-declarations
+ const fields = {};
+ if (!schema.fields) {
+ throw new Error(`Required attribute 'fields' doesn't exist on schema: ${schema}`);
+ }
+ for (const field of schema.fields) {
+ fields[field.name] = AvroType.fromSchema(field.type);
+ }
+ return new AvroRecordType(fields, schema.name);
+ case AvroComplex.ENUM:
+ if (schema.aliases) {
+ throw new Error(`aliases currently is not supported, schema: ${schema}`);
+ }
+ if (!schema.symbols) {
+ throw new Error(`Required attribute 'symbols' doesn't exist on schema: ${schema}`);
+ }
+ return new AvroEnumType(schema.symbols);
+ case AvroComplex.MAP:
+ if (!schema.values) {
+ throw new Error(`Required attribute 'values' doesn't exist on schema: ${schema}`);
+ }
+ return new AvroMapType(AvroType.fromSchema(schema.values));
+ case AvroComplex.ARRAY: // Unused today
+ case AvroComplex.FIXED: // Unused today
+ default:
+ throw new Error(`Unexpected Avro type ${type} in ${schema}`);
}
}
}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * maxBufferLength is max size of each buffer in the pooled buffers.
- */
-// Can't use import as Typescript doesn't recognize "buffer".
-const maxBufferLength = (__nccwpck_require__(4300).constants.MAX_LENGTH);
-/**
- * This class provides a buffer container which conceptually has no hard size limit.
- * It accepts a capacity, an array of input buffers and the total length of input data.
- * It will allocate an internal "buffer" of the capacity and fill the data in the input buffers
- * into the internal "buffer" serially with respect to the total length.
- * Then by calling PooledBuffer.getReadableStream(), you can get a readable stream
- * assembled from all the data in the internal "buffer".
- */
-class PooledBuffer {
- constructor(capacity, buffers, totalLength) {
- /**
- * Internal buffers used to keep the data.
- * Each buffer has a length of the maxBufferLength except last one.
- */
- this.buffers = [];
- this.capacity = capacity;
- this._size = 0;
- // allocate
- const bufferNum = Math.ceil(capacity / maxBufferLength);
- for (let i = 0; i < bufferNum; i++) {
- let len = i === bufferNum - 1 ? capacity % maxBufferLength : maxBufferLength;
- if (len === 0) {
- len = maxBufferLength;
- }
- this.buffers.push(Buffer.allocUnsafe(len));
- }
- if (buffers) {
- this.fill(buffers, totalLength);
+class AvroPrimitiveType extends AvroType {
+ constructor(primitive) {
+ super();
+ this._primitive = primitive;
+ }
+ read(stream, options = {}) {
+ switch (this._primitive) {
+ case AvroPrimitive.NULL:
+ return AvroParser.readNull();
+ case AvroPrimitive.BOOLEAN:
+ return AvroParser.readBoolean(stream, options);
+ case AvroPrimitive.INT:
+ return AvroParser.readInt(stream, options);
+ case AvroPrimitive.LONG:
+ return AvroParser.readLong(stream, options);
+ case AvroPrimitive.FLOAT:
+ return AvroParser.readFloat(stream, options);
+ case AvroPrimitive.DOUBLE:
+ return AvroParser.readDouble(stream, options);
+ case AvroPrimitive.BYTES:
+ return AvroParser.readBytes(stream, options);
+ case AvroPrimitive.STRING:
+ return AvroParser.readString(stream, options);
+ default:
+ throw new Error("Unknown Avro Primitive");
}
}
- /**
- * The size of the data contained in the pooled buffers.
- */
- get size() {
- return this._size;
+}
+class AvroEnumType extends AvroType {
+ constructor(symbols) {
+ super();
+ this._symbols = symbols;
}
- /**
- * Fill the internal buffers with data in the input buffers serially
- * with respect to the total length and the total capacity of the internal buffers.
- * Data copied will be shift out of the input buffers.
- *
- * @param buffers - Input buffers containing the data to be filled in the pooled buffer
- * @param totalLength - Total length of the data to be filled in.
- *
- */
- fill(buffers, totalLength) {
- this._size = Math.min(this.capacity, totalLength);
- let i = 0, j = 0, targetOffset = 0, sourceOffset = 0, totalCopiedNum = 0;
- while (totalCopiedNum < this._size) {
- const source = buffers[i];
- const target = this.buffers[j];
- const copiedNum = source.copy(target, targetOffset, sourceOffset);
- totalCopiedNum += copiedNum;
- sourceOffset += copiedNum;
- targetOffset += copiedNum;
- if (sourceOffset === source.length) {
- i++;
- sourceOffset = 0;
- }
- if (targetOffset === target.length) {
- j++;
- targetOffset = 0;
+ async read(stream, options = {}) {
+ const value = await AvroParser.readInt(stream, options);
+ return this._symbols[value];
+ }
+}
+class AvroUnionType extends AvroType {
+ constructor(types) {
+ super();
+ this._types = types;
+ }
+ async read(stream, options = {}) {
+ // eslint-disable-line @typescript-eslint/ban-types
+ const typeIndex = await AvroParser.readInt(stream, options);
+ return this._types[typeIndex].read(stream, options);
+ }
+}
+class AvroMapType extends AvroType {
+ constructor(itemType) {
+ super();
+ this._itemType = itemType;
+ }
+ read(stream, options = {}) {
+ const readItemMethod = (s, opts) => {
+ return this._itemType.read(s, opts);
+ };
+ return AvroParser.readMap(stream, readItemMethod, options);
+ }
+}
+class AvroRecordType extends AvroType {
+ constructor(fields, name) {
+ super();
+ this._fields = fields;
+ this._name = name;
+ }
+ async read(stream, options = {}) {
+ const record = {};
+ record["$schema"] = this._name;
+ for (const key in this._fields) {
+ if (Object.prototype.hasOwnProperty.call(this._fields, key)) {
+ record[key] = await this._fields[key].read(stream, options);
}
}
- // clear copied from source buffers
- buffers.splice(0, i);
- if (buffers.length > 0) {
- buffers[0] = buffers[0].slice(sourceOffset);
- }
+ return record;
}
- /**
- * Get the readable stream assembled from all the data in the internal buffers.
- *
- */
- getReadableStream() {
- return new BuffersStream(this.buffers, this.size);
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+function arraysEqual(a, b) {
+ if (a === b)
+ return true;
+ // eslint-disable-next-line eqeqeq
+ if (a == null || b == null)
+ return false;
+ if (a.length !== b.length)
+ return false;
+ for (let i = 0; i < a.length; ++i) {
+ if (a[i] !== b[i])
+ return false;
}
+ return true;
}
// Copyright (c) Microsoft Corporation.
-/**
- * This class accepts a Node.js Readable stream as input, and keeps reading data
- * from the stream into the internal buffer structure, until it reaches maxBuffers.
- * Every available buffer will try to trigger outgoingHandler.
- *
- * The internal buffer structure includes an incoming buffer array, and a outgoing
- * buffer array. The incoming buffer array includes the "empty" buffers can be filled
- * with new incoming data. The outgoing array includes the filled buffers to be
- * handled by outgoingHandler. Every above buffer size is defined by parameter bufferSize.
- *
- * NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING
- *
- * NUM_OF_ALL_BUFFERS lesser than or equal to maxBuffers
- *
- * PERFORMANCE IMPROVEMENT TIPS:
- * 1. Input stream highWaterMark is better to set a same value with bufferSize
- * parameter, which will avoid Buffer.concat() operations.
- * 2. concurrency should set a smaller value than maxBuffers, which is helpful to
- * reduce the possibility when a outgoing handler waits for the stream data.
- * in this situation, outgoing handlers are blocked.
- * Outgoing queue shouldn't be empty.
- */
-class BufferScheduler {
- /**
- * Creates an instance of BufferScheduler.
- *
- * @param readable - A Node.js Readable stream
- * @param bufferSize - Buffer size of every maintained buffer
- * @param maxBuffers - How many buffers can be allocated
- * @param outgoingHandler - An async function scheduled to be
- * triggered when a buffer fully filled
- * with stream data
- * @param concurrency - Concurrency of executing outgoingHandlers (>0)
- * @param encoding - [Optional] Encoding of Readable stream when it's a string stream
- */
- constructor(readable, bufferSize, maxBuffers, outgoingHandler, concurrency, encoding) {
- /**
- * An internal event emitter.
- */
- this.emitter = new events.EventEmitter();
- /**
- * An internal offset marker to track data offset in bytes of next outgoingHandler.
- */
- this.offset = 0;
- /**
- * An internal marker to track whether stream is end.
- */
- this.isStreamEnd = false;
- /**
- * An internal marker to track whether stream or outgoingHandler returns error.
- */
- this.isError = false;
- /**
- * How many handlers are executing.
- */
- this.executingOutgoingHandlers = 0;
- /**
- * How many buffers have been allocated.
- */
- this.numBuffers = 0;
- /**
- * Because this class doesn't know how much data every time stream pops, which
- * is defined by highWaterMarker of the stream. So BufferScheduler will cache
- * data received from the stream, when data in unresolvedDataArray exceeds the
- * blockSize defined, it will try to concat a blockSize of buffer, fill into available
- * buffers from incoming and push to outgoing array.
- */
- this.unresolvedDataArray = [];
- /**
- * How much data consisted in unresolvedDataArray.
- */
- this.unresolvedLength = 0;
- /**
- * The array includes all the available buffers can be used to fill data from stream.
- */
- this.incoming = [];
- /**
- * The array (queue) includes all the buffers filled from stream data.
- */
- this.outgoing = [];
- if (bufferSize <= 0) {
- throw new RangeError(`bufferSize must be larger than 0, current is ${bufferSize}`);
- }
- if (maxBuffers <= 0) {
- throw new RangeError(`maxBuffers must be larger than 0, current is ${maxBuffers}`);
- }
- if (concurrency <= 0) {
- throw new RangeError(`concurrency must be larger than 0, current is ${concurrency}`);
- }
- this.bufferSize = bufferSize;
- this.maxBuffers = maxBuffers;
- this.readable = readable;
- this.outgoingHandler = outgoingHandler;
- this.concurrency = concurrency;
- this.encoding = encoding;
+// Licensed under the MIT license.
+class AvroReader {
+ get blockOffset() {
+ return this._blockOffset;
}
- /**
- * Start the scheduler, will return error when stream of any of the outgoingHandlers
- * returns error.
- *
- */
- async do() {
- return new Promise((resolve, reject) => {
- this.readable.on("data", (data) => {
- data = typeof data === "string" ? Buffer.from(data, this.encoding) : data;
- this.appendUnresolvedData(data);
- if (!this.resolveData()) {
- this.readable.pause();
- }
- });
- this.readable.on("error", (err) => {
- this.emitter.emit("error", err);
- });
- this.readable.on("end", () => {
- this.isStreamEnd = true;
- this.emitter.emit("checkEnd");
- });
- this.emitter.on("error", (err) => {
- this.isError = true;
- this.readable.pause();
- reject(err);
- });
- this.emitter.on("checkEnd", () => {
- if (this.outgoing.length > 0) {
- this.triggerOutgoingHandlers();
- return;
- }
- if (this.isStreamEnd && this.executingOutgoingHandlers === 0) {
- if (this.unresolvedLength > 0 && this.unresolvedLength < this.bufferSize) {
- const buffer = this.shiftBufferFromUnresolvedDataArray();
- this.outgoingHandler(() => buffer.getReadableStream(), buffer.size, this.offset)
- .then(resolve)
- .catch(reject);
- }
- else if (this.unresolvedLength >= this.bufferSize) {
- return;
- }
- else {
- resolve();
- }
- }
- });
+ get objectIndex() {
+ return this._objectIndex;
+ }
+ constructor(dataStream, headerStream, currentBlockOffset, indexWithinCurrentBlock) {
+ this._dataStream = dataStream;
+ this._headerStream = headerStream || dataStream;
+ this._initialized = false;
+ this._blockOffset = currentBlockOffset || 0;
+ this._objectIndex = indexWithinCurrentBlock || 0;
+ this._initialBlockOffset = currentBlockOffset || 0;
+ }
+ async initialize(options = {}) {
+ const header = await AvroParser.readFixedBytes(this._headerStream, AVRO_INIT_BYTES.length, {
+ abortSignal: options.abortSignal,
+ });
+ if (!arraysEqual(header, AVRO_INIT_BYTES)) {
+ throw new Error("Stream is not an Avro file.");
+ }
+ // File metadata is written as if defined by the following map schema:
+ // { "type": "map", "values": "bytes"}
+ this._metadata = await AvroParser.readMap(this._headerStream, AvroParser.readString, {
+ abortSignal: options.abortSignal,
+ });
+ // Validate codec
+ const codec = this._metadata[AVRO_CODEC_KEY];
+ if (!(codec === undefined || codec === null || codec === "null")) {
+ throw new Error("Codecs are not supported");
+ }
+ // The 16-byte, randomly-generated sync marker for this file.
+ this._syncMarker = await AvroParser.readFixedBytes(this._headerStream, AVRO_SYNC_MARKER_SIZE, {
+ abortSignal: options.abortSignal,
});
- }
- /**
- * Insert a new data into unresolved array.
- *
- * @param data -
- */
- appendUnresolvedData(data) {
- this.unresolvedDataArray.push(data);
- this.unresolvedLength += data.length;
- }
- /**
- * Try to shift a buffer with size in blockSize. The buffer returned may be less
- * than blockSize when data in unresolvedDataArray is less than bufferSize.
- *
- */
- shiftBufferFromUnresolvedDataArray(buffer) {
- if (!buffer) {
- buffer = new PooledBuffer(this.bufferSize, this.unresolvedDataArray, this.unresolvedLength);
+ // Parse the schema
+ const schema = JSON.parse(this._metadata[AVRO_SCHEMA_KEY]);
+ this._itemType = AvroType.fromSchema(schema);
+ if (this._blockOffset === 0) {
+ this._blockOffset = this._initialBlockOffset + this._dataStream.position;
}
- else {
- buffer.fill(this.unresolvedDataArray, this.unresolvedLength);
+ this._itemsRemainingInBlock = await AvroParser.readLong(this._dataStream, {
+ abortSignal: options.abortSignal,
+ });
+ // skip block length
+ await AvroParser.readLong(this._dataStream, { abortSignal: options.abortSignal });
+ this._initialized = true;
+ if (this._objectIndex && this._objectIndex > 0) {
+ for (let i = 0; i < this._objectIndex; i++) {
+ await this._itemType.read(this._dataStream, { abortSignal: options.abortSignal });
+ this._itemsRemainingInBlock--;
+ }
}
- this.unresolvedLength -= buffer.size;
- return buffer;
}
- /**
- * Resolve data in unresolvedDataArray. For every buffer with size in blockSize
- * shifted, it will try to get (or allocate a buffer) from incoming, and fill it,
- * then push it into outgoing to be handled by outgoing handler.
- *
- * Return false when available buffers in incoming are not enough, else true.
- *
- * @returns Return false when buffers in incoming are not enough, else true.
- */
- resolveData() {
- while (this.unresolvedLength >= this.bufferSize) {
- let buffer;
- if (this.incoming.length > 0) {
- buffer = this.incoming.shift();
- this.shiftBufferFromUnresolvedDataArray(buffer);
+ hasNext() {
+ return !this._initialized || this._itemsRemainingInBlock > 0;
+ }
+ parseObjects() {
+ return tslib.__asyncGenerator(this, arguments, function* parseObjects_1(options = {}) {
+ if (!this._initialized) {
+ yield tslib.__await(this.initialize(options));
}
- else {
- if (this.numBuffers < this.maxBuffers) {
- buffer = this.shiftBufferFromUnresolvedDataArray();
- this.numBuffers++;
- }
- else {
- // No available buffer, wait for buffer returned
- return false;
+ while (this.hasNext()) {
+ const result = yield tslib.__await(this._itemType.read(this._dataStream, {
+ abortSignal: options.abortSignal,
+ }));
+ this._itemsRemainingInBlock--;
+ this._objectIndex++;
+ if (this._itemsRemainingInBlock === 0) {
+ const marker = yield tslib.__await(AvroParser.readFixedBytes(this._dataStream, AVRO_SYNC_MARKER_SIZE, {
+ abortSignal: options.abortSignal,
+ }));
+ this._blockOffset = this._initialBlockOffset + this._dataStream.position;
+ this._objectIndex = 0;
+ if (!arraysEqual(this._syncMarker, marker)) {
+ throw new Error("Stream is not a valid Avro file.");
+ }
+ try {
+ this._itemsRemainingInBlock = yield tslib.__await(AvroParser.readLong(this._dataStream, {
+ abortSignal: options.abortSignal,
+ }));
+ }
+ catch (err) {
+ // We hit the end of the stream.
+ this._itemsRemainingInBlock = 0;
+ }
+ if (this._itemsRemainingInBlock > 0) {
+ // Ignore block size
+ yield tslib.__await(AvroParser.readLong(this._dataStream, { abortSignal: options.abortSignal }));
+ }
}
+ yield yield tslib.__await(result);
}
- this.outgoing.push(buffer);
- this.triggerOutgoingHandlers();
+ });
+ }
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+class AvroReadable {
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const ABORT_ERROR = new abortController.AbortError("Reading from the avro stream was aborted.");
+class AvroReadableFromStream extends AvroReadable {
+ toUint8Array(data) {
+ if (typeof data === "string") {
+ return Buffer.from(data);
}
- return true;
+ return data;
}
- /**
- * Try to trigger a outgoing handler for every buffer in outgoing. Stop when
- * concurrency reaches.
- */
- async triggerOutgoingHandlers() {
- let buffer;
- do {
- if (this.executingOutgoingHandlers >= this.concurrency) {
- return;
- }
- buffer = this.outgoing.shift();
- if (buffer) {
- this.triggerOutgoingHandler(buffer);
- }
- } while (buffer);
+ constructor(readable) {
+ super();
+ this._readable = readable;
+ this._position = 0;
}
- /**
- * Trigger a outgoing handler for a buffer shifted from outgoing.
- *
- * @param buffer -
- */
- async triggerOutgoingHandler(buffer) {
- const bufferLength = buffer.size;
- this.executingOutgoingHandlers++;
- this.offset += bufferLength;
- try {
- await this.outgoingHandler(() => buffer.getReadableStream(), bufferLength, this.offset - bufferLength);
+ get position() {
+ return this._position;
+ }
+ async read(size, options = {}) {
+ var _a;
+ if ((_a = options.abortSignal) === null || _a === void 0 ? void 0 : _a.aborted) {
+ throw ABORT_ERROR;
}
- catch (err) {
- this.emitter.emit("error", err);
- return;
+ if (size < 0) {
+ throw new Error(`size parameter should be positive: ${size}`);
}
- this.executingOutgoingHandlers--;
- this.reuseBuffer(buffer);
- this.emitter.emit("checkEnd");
- }
- /**
- * Return buffer used by outgoing handler into incoming.
- *
- * @param buffer -
- */
- reuseBuffer(buffer) {
- this.incoming.push(buffer);
- if (!this.isError && this.resolveData() && !this.isStreamEnd) {
- this.readable.resume();
+ if (size === 0) {
+ return new Uint8Array();
+ }
+ if (!this._readable.readable) {
+ throw new Error("Stream no longer readable.");
+ }
+ // See if there is already enough data.
+ const chunk = this._readable.read(size);
+ if (chunk) {
+ this._position += chunk.length;
+ // chunk.length maybe less than desired size if the stream ends.
+ return this.toUint8Array(chunk);
+ }
+ else {
+ // register callback to wait for enough data to read
+ return new Promise((resolve, reject) => {
+ /* eslint-disable @typescript-eslint/no-use-before-define */
+ const cleanUp = () => {
+ this._readable.removeListener("readable", readableCallback);
+ this._readable.removeListener("error", rejectCallback);
+ this._readable.removeListener("end", rejectCallback);
+ this._readable.removeListener("close", rejectCallback);
+ if (options.abortSignal) {
+ options.abortSignal.removeEventListener("abort", abortHandler);
+ }
+ };
+ const readableCallback = () => {
+ const callbackChunk = this._readable.read(size);
+ if (callbackChunk) {
+ this._position += callbackChunk.length;
+ cleanUp();
+ // callbackChunk.length maybe less than desired size if the stream ends.
+ resolve(this.toUint8Array(callbackChunk));
+ }
+ };
+ const rejectCallback = () => {
+ cleanUp();
+ reject();
+ };
+ const abortHandler = () => {
+ cleanUp();
+ reject(ABORT_ERROR);
+ };
+ this._readable.on("readable", readableCallback);
+ this._readable.once("error", rejectCallback);
+ this._readable.once("end", rejectCallback);
+ this._readable.once("close", rejectCallback);
+ if (options.abortSignal) {
+ options.abortSignal.addEventListener("abort", abortHandler);
+ }
+ /* eslint-enable @typescript-eslint/no-use-before-define */
+ });
}
}
}
// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * Reads a readable stream into buffer. Fill the buffer from offset to end.
- *
- * @param stream - A Node.js Readable stream
- * @param buffer - Buffer to be filled, length must greater than or equal to offset
- * @param offset - From which position in the buffer to be filled, inclusive
- * @param end - To which position in the buffer to be filled, exclusive
- * @param encoding - Encoding of the Readable stream
- */
-async function streamToBuffer(stream, buffer, offset, end, encoding) {
- let pos = 0; // Position in stream
- const count = end - offset; // Total amount of data needed in stream
- return new Promise((resolve, reject) => {
- const timeout = setTimeout(() => reject(new Error(`The operation cannot be completed in timeout.`)), REQUEST_TIMEOUT);
- stream.on("readable", () => {
- if (pos >= count) {
- clearTimeout(timeout);
- resolve();
- return;
- }
- let chunk = stream.read();
- if (!chunk) {
- return;
- }
- if (typeof chunk === "string") {
- chunk = Buffer.from(chunk, encoding);
- }
- // How much data needed in this chunk
- const chunkLength = pos + chunk.length > count ? count - pos : chunk.length;
- buffer.fill(chunk.slice(0, chunkLength), offset + pos, offset + pos + chunkLength);
- pos += chunkLength;
- });
- stream.on("end", () => {
- clearTimeout(timeout);
- if (pos < count) {
- reject(new Error(`Stream drains before getting enough data needed. Data read: ${pos}, data need: ${count}`));
- }
- resolve();
- });
- stream.on("error", (msg) => {
- clearTimeout(timeout);
- reject(msg);
- });
- });
-}
-/**
- * Reads a readable stream into buffer entirely.
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
*
- * @param stream - A Node.js Readable stream
- * @param buffer - Buffer to be filled, length must greater than or equal to offset
- * @param encoding - Encoding of the Readable stream
- * @returns with the count of bytes read.
- * @throws `RangeError` If buffer size is not big enough.
+ * A Node.js BlobQuickQueryStream will internally parse avro data stream for blob query.
*/
-async function streamToBuffer2(stream, buffer, encoding) {
- let pos = 0; // Position in stream
- const bufferSize = buffer.length;
- return new Promise((resolve, reject) => {
- stream.on("readable", () => {
- let chunk = stream.read();
- if (!chunk) {
- return;
+class BlobQuickQueryStream extends stream.Readable {
+ /**
+ * Creates an instance of BlobQuickQueryStream.
+ *
+ * @param source - The current ReadableStream returned from getter
+ * @param options -
+ */
+ constructor(source, options = {}) {
+ super();
+ this.avroPaused = true;
+ this.source = source;
+ this.onProgress = options.onProgress;
+ this.onError = options.onError;
+ this.avroReader = new AvroReader(new AvroReadableFromStream(this.source));
+ this.avroIter = this.avroReader.parseObjects({ abortSignal: options.abortSignal });
+ }
+ _read() {
+ if (this.avroPaused) {
+ this.readInternal().catch((err) => {
+ this.emit("error", err);
+ });
+ }
+ }
+ async readInternal() {
+ this.avroPaused = false;
+ let avroNext;
+ do {
+ avroNext = await this.avroIter.next();
+ if (avroNext.done) {
+ break;
}
- if (typeof chunk === "string") {
- chunk = Buffer.from(chunk, encoding);
+ const obj = avroNext.value;
+ const schema = obj.$schema;
+ if (typeof schema !== "string") {
+ throw Error("Missing schema in avro record.");
}
- if (pos + chunk.length > bufferSize) {
- reject(new Error(`Stream exceeds buffer size. Buffer size: ${bufferSize}`));
- return;
+ switch (schema) {
+ case "com.microsoft.azure.storage.queryBlobContents.resultData":
+ {
+ const data = obj.data;
+ if (data instanceof Uint8Array === false) {
+ throw Error("Invalid data in avro result record.");
+ }
+ if (!this.push(Buffer.from(data))) {
+ this.avroPaused = true;
+ }
+ }
+ break;
+ case "com.microsoft.azure.storage.queryBlobContents.progress":
+ {
+ const bytesScanned = obj.bytesScanned;
+ if (typeof bytesScanned !== "number") {
+ throw Error("Invalid bytesScanned in avro progress record.");
+ }
+ if (this.onProgress) {
+ this.onProgress({ loadedBytes: bytesScanned });
+ }
+ }
+ break;
+ case "com.microsoft.azure.storage.queryBlobContents.end":
+ if (this.onProgress) {
+ const totalBytes = obj.totalBytes;
+ if (typeof totalBytes !== "number") {
+ throw Error("Invalid totalBytes in avro end record.");
+ }
+ this.onProgress({ loadedBytes: totalBytes });
+ }
+ this.push(null);
+ break;
+ case "com.microsoft.azure.storage.queryBlobContents.error":
+ if (this.onError) {
+ const fatal = obj.fatal;
+ if (typeof fatal !== "boolean") {
+ throw Error("Invalid fatal in avro error record.");
+ }
+ const name = obj.name;
+ if (typeof name !== "string") {
+ throw Error("Invalid name in avro error record.");
+ }
+ const description = obj.description;
+ if (typeof description !== "string") {
+ throw Error("Invalid description in avro error record.");
+ }
+ const position = obj.position;
+ if (typeof position !== "number") {
+ throw Error("Invalid position in avro error record.");
+ }
+ this.onError({
+ position,
+ name,
+ isFatal: fatal,
+ description,
+ });
+ }
+ break;
+ default:
+ throw Error(`Unknown schema ${schema} in avro progress record.`);
}
- buffer.fill(chunk, pos, pos + chunk.length);
- pos += chunk.length;
- });
- stream.on("end", () => {
- resolve(pos);
- });
- stream.on("error", reject);
- });
-}
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * Writes the content of a readstream to a local file. Returns a Promise which is completed after the file handle is closed.
- *
- * @param rs - The read stream.
- * @param file - Destination file path.
- */
-async function readStreamToLocalFile(rs, file) {
- return new Promise((resolve, reject) => {
- const ws = fs__namespace.createWriteStream(file);
- rs.on("error", (err) => {
- reject(err);
- });
- ws.on("error", (err) => {
- reject(err);
- });
- ws.on("close", resolve);
- rs.pipe(ws);
- });
+ } while (!avroNext.done && !this.avroPaused);
+ }
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
- * Promisified version of fs.stat().
- */
-const fsStat = util__namespace.promisify(fs__namespace.stat);
-const fsCreateReadStream = fs__namespace.createReadStream;
-
-/**
- * A BlobClient represents a URL to an Azure Storage blob; the blob may be a block blob,
- * append blob, or page blob.
+ * BlobQueryResponse implements BlobDownloadResponseModel interface, and in Node.js runtime it will
+ * parse avor data returned by blob query.
*/
-class BlobClient extends StorageClient {
- constructor(urlOrConnectionString, credentialOrPipelineOrContainerName, blobNameOrOptions,
- // Legacy, no fix for eslint error without breaking. Disable it for this interface.
- /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
- options) {
- options = options || {};
- let pipeline;
- let url;
- if (isPipelineLike(credentialOrPipelineOrContainerName)) {
- // (url: string, pipeline: Pipeline)
- url = urlOrConnectionString;
- pipeline = credentialOrPipelineOrContainerName;
- }
- else if ((coreHttp.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
- credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
- coreHttp.isTokenCredential(credentialOrPipelineOrContainerName)) {
- // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
- url = urlOrConnectionString;
- options = blobNameOrOptions;
- pipeline = newPipeline(credentialOrPipelineOrContainerName, options);
- }
- else if (!credentialOrPipelineOrContainerName &&
- typeof credentialOrPipelineOrContainerName !== "string") {
- // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
- // The second parameter is undefined. Use anonymous credential.
- url = urlOrConnectionString;
- if (blobNameOrOptions && typeof blobNameOrOptions !== "string") {
- options = blobNameOrOptions;
- }
- pipeline = newPipeline(new AnonymousCredential(), options);
- }
- else if (credentialOrPipelineOrContainerName &&
- typeof credentialOrPipelineOrContainerName === "string" &&
- blobNameOrOptions &&
- typeof blobNameOrOptions === "string") {
- // (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
- const containerName = credentialOrPipelineOrContainerName;
- const blobName = blobNameOrOptions;
- const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
- if (extractedCreds.kind === "AccountConnString") {
- if (coreHttp.isNode) {
- const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
- url = appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName));
- if (!options.proxyOptions) {
- options.proxyOptions = coreHttp.getDefaultProxySettings(extractedCreds.proxyUri);
- }
- pipeline = newPipeline(sharedKeyCredential, options);
- }
- else {
- throw new Error("Account connection string is only supported in Node.js environment");
- }
- }
- else if (extractedCreds.kind === "SASConnString") {
- url =
- appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName)) +
- "?" +
- extractedCreds.accountSas;
- pipeline = newPipeline(new AnonymousCredential(), options);
- }
- else {
- throw new Error("Connection string must be either an Account connection string or a SAS connection string");
- }
- }
- else {
- throw new Error("Expecting non-empty strings for containerName and blobName parameters");
- }
- super(url, pipeline);
- ({ blobName: this._name, containerName: this._containerName } =
- this.getBlobAndContainerNamesFromUrl());
- this.blobContext = new Blob$1(this.storageClientContext);
- this._snapshot = getURLParameter(this.url, URLConstants.Parameters.SNAPSHOT);
- this._versionId = getURLParameter(this.url, URLConstants.Parameters.VERSIONID);
- }
- /**
- * The name of the blob.
- */
- get name() {
- return this._name;
- }
+class BlobQueryResponse {
/**
- * The name of the storage container the blob is associated with.
+ * Indicates that the service supports
+ * requests for partial file content.
+ *
+ * @readonly
*/
- get containerName() {
- return this._containerName;
+ get acceptRanges() {
+ return this.originalResponse.acceptRanges;
}
/**
- * Creates a new BlobClient object identical to the source but with the specified snapshot timestamp.
- * Provide "" will remove the snapshot and return a Client to the base blob.
+ * Returns if it was previously specified
+ * for the file.
*
- * @param snapshot - The snapshot timestamp.
- * @returns A new BlobClient object identical to the source but with the specified snapshot timestamp
+ * @readonly
*/
- withSnapshot(snapshot) {
- return new BlobClient(setURLParameter(this.url, URLConstants.Parameters.SNAPSHOT, snapshot.length === 0 ? undefined : snapshot), this.pipeline);
+ get cacheControl() {
+ return this.originalResponse.cacheControl;
}
/**
- * Creates a new BlobClient object pointing to a version of this blob.
- * Provide "" will remove the versionId and return a Client to the base blob.
+ * Returns the value that was specified
+ * for the 'x-ms-content-disposition' header and specifies how to process the
+ * response.
*
- * @param versionId - The versionId.
- * @returns A new BlobClient object pointing to the version of this blob.
+ * @readonly
*/
- withVersion(versionId) {
- return new BlobClient(setURLParameter(this.url, URLConstants.Parameters.VERSIONID, versionId.length === 0 ? undefined : versionId), this.pipeline);
+ get contentDisposition() {
+ return this.originalResponse.contentDisposition;
}
/**
- * Creates a AppendBlobClient object.
+ * Returns the value that was specified
+ * for the Content-Encoding request header.
*
+ * @readonly
*/
- getAppendBlobClient() {
- return new AppendBlobClient(this.url, this.pipeline);
+ get contentEncoding() {
+ return this.originalResponse.contentEncoding;
}
/**
- * Creates a BlockBlobClient object.
+ * Returns the value that was specified
+ * for the Content-Language request header.
*
+ * @readonly
*/
- getBlockBlobClient() {
- return new BlockBlobClient(this.url, this.pipeline);
+ get contentLanguage() {
+ return this.originalResponse.contentLanguage;
}
/**
- * Creates a PageBlobClient object.
+ * The current sequence number for a
+ * page blob. This header is not returned for block blobs or append blobs.
*
+ * @readonly
*/
- getPageBlobClient() {
- return new PageBlobClient(this.url, this.pipeline);
+ get blobSequenceNumber() {
+ return this.originalResponse.blobSequenceNumber;
}
/**
- * Reads or downloads a blob from the system, including its metadata and properties.
- * You can also call Get Blob to read a snapshot.
- *
- * * In Node.js, data returns in a Readable stream readableStreamBody
- * * In browsers, data returns in a promise blobBody
- *
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
- *
- * @param offset - From which position of the blob to download, greater than or equal to 0
- * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
- * @param options - Optional options to Blob Download operation.
- *
- *
- * Example usage (Node.js):
- *
- * ```js
- * // Download and convert a blob to a string
- * const downloadBlockBlobResponse = await blobClient.download();
- * const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
- * console.log("Downloaded blob content:", downloaded.toString());
- *
- * async function streamToBuffer(readableStream) {
- * return new Promise((resolve, reject) => {
- * const chunks = [];
- * readableStream.on("data", (data) => {
- * chunks.push(data instanceof Buffer ? data : Buffer.from(data));
- * });
- * readableStream.on("end", () => {
- * resolve(Buffer.concat(chunks));
- * });
- * readableStream.on("error", reject);
- * });
- * }
- * ```
- *
- * Example usage (browser):
- *
- * ```js
- * // Download and convert a blob to a string
- * const downloadBlockBlobResponse = await blobClient.download();
- * const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
- * console.log(
- * "Downloaded blob content",
- * downloaded
- * );
+ * The blob's type. Possible values include:
+ * 'BlockBlob', 'PageBlob', 'AppendBlob'.
*
- * async function blobToString(blob: Blob): Promise {
- * const fileReader = new FileReader();
- * return new Promise((resolve, reject) => {
- * fileReader.onloadend = (ev: any) => {
- * resolve(ev.target!.result);
- * };
- * fileReader.onerror = reject;
- * fileReader.readAsText(blob);
- * });
- * }
- * ```
+ * @readonly
*/
- async download(offset = 0, count, options = {}) {
- var _a;
- options.conditions = options.conditions || {};
- options.conditions = options.conditions || {};
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- const { span, updatedOptions } = createSpan("BlobClient-download", options);
- try {
- const res = await this.blobContext.download(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), requestOptions: {
- onDownloadProgress: coreHttp.isNode ? undefined : options.onProgress, // for Node.js, progress is reported by RetriableReadableStream
- }, range: offset === 0 && !count ? undefined : rangeToString({ offset, count }), rangeGetContentMD5: options.rangeGetContentMD5, rangeGetContentCRC64: options.rangeGetContentCrc64, snapshot: options.snapshot, cpkInfo: options.customerProvidedKey }, convertTracingToRequestOptionsBase(updatedOptions)));
- const wrappedRes = Object.assign(Object.assign({}, res), { _response: res._response, objectReplicationDestinationPolicyId: res.objectReplicationPolicyId, objectReplicationSourceProperties: parseObjectReplicationRecord(res.objectReplicationRules) });
- // Return browser response immediately
- if (!coreHttp.isNode) {
- return wrappedRes;
- }
- // We support retrying when download stream unexpected ends in Node.js runtime
- // Following code shouldn't be bundled into browser build, however some
- // bundlers may try to bundle following code and "FileReadResponse.ts".
- // In this case, "FileDownloadResponse.browser.ts" will be used as a shim of "FileDownloadResponse.ts"
- // The config is in package.json "browser" field
- if (options.maxRetryRequests === undefined || options.maxRetryRequests < 0) {
- // TODO: Default value or make it a required parameter?
- options.maxRetryRequests = DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS;
- }
- if (res.contentLength === undefined) {
- throw new RangeError(`File download response doesn't contain valid content length header`);
- }
- if (!res.etag) {
- throw new RangeError(`File download response doesn't contain valid etag header`);
- }
- return new BlobDownloadResponse(wrappedRes, async (start) => {
- var _a;
- const updatedDownloadOptions = {
- leaseAccessConditions: options.conditions,
- modifiedAccessConditions: {
- ifMatch: options.conditions.ifMatch || res.etag,
- ifModifiedSince: options.conditions.ifModifiedSince,
- ifNoneMatch: options.conditions.ifNoneMatch,
- ifUnmodifiedSince: options.conditions.ifUnmodifiedSince,
- ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions,
- },
- range: rangeToString({
- count: offset + res.contentLength - start,
- offset: start,
- }),
- rangeGetContentMD5: options.rangeGetContentMD5,
- rangeGetContentCRC64: options.rangeGetContentCrc64,
- snapshot: options.snapshot,
- cpkInfo: options.customerProvidedKey,
- };
- // Debug purpose only
- // console.log(
- // `Read from internal stream, range: ${
- // updatedOptions.range
- // }, options: ${JSON.stringify(updatedOptions)}`
- // );
- return (await this.blobContext.download(Object.assign({ abortSignal: options.abortSignal }, updatedDownloadOptions))).readableStreamBody;
- }, offset, res.contentLength, {
- maxRetryRequests: options.maxRetryRequests,
- onProgress: options.onProgress,
- });
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get blobType() {
+ return this.originalResponse.blobType;
}
/**
- * Returns true if the Azure blob resource represented by this client exists; false otherwise.
- *
- * NOTE: use this function with care since an existing blob might be deleted by other clients or
- * applications. Vice versa new blobs might be added by other clients or applications after this
- * function completes.
+ * The number of bytes present in the
+ * response body.
*
- * @param options - options to Exists operation.
+ * @readonly
*/
- async exists(options = {}) {
- const { span, updatedOptions } = createSpan("BlobClient-exists", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- await this.getProperties({
- abortSignal: options.abortSignal,
- customerProvidedKey: options.customerProvidedKey,
- conditions: options.conditions,
- tracingOptions: updatedOptions.tracingOptions,
- });
- return true;
- }
- catch (e) {
- if (e.statusCode === 404) {
- // Expected exception when checking blob existence
- return false;
- }
- else if (e.statusCode === 409 &&
- (e.details.errorCode === BlobUsesCustomerSpecifiedEncryptionMsg ||
- e.details.errorCode === BlobDoesNotUseCustomerSpecifiedEncryption)) {
- // Expected exception when checking blob existence
- return true;
- }
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get contentLength() {
+ return this.originalResponse.contentLength;
}
/**
- * Returns all user-defined metadata, standard HTTP properties, and system properties
- * for the blob. It does not return the content of the blob.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-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 methods of {@link ContainerClient} that list blobs using the `includeMetadata` option, which
- * will retain their original casing.
+ * If the file has an MD5 hash and the
+ * request is to read the full file, this response header is returned so that
+ * the client can check for message content integrity. If the request is to
+ * read a specified range and the 'x-ms-range-get-content-md5' is set to
+ * true, then the request returns an MD5 hash for the range, as long as the
+ * range size is less than or equal to 4 MB. If neither of these sets of
+ * conditions is true, then no value is returned for the 'Content-MD5'
+ * header.
*
- * @param options - Optional options to Get Properties operation.
+ * @readonly
*/
- async getProperties(options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobClient-getProperties", options);
- try {
- options.conditions = options.conditions || {};
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- const res = await this.blobContext.getProperties(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), cpkInfo: options.customerProvidedKey }, convertTracingToRequestOptionsBase(updatedOptions)));
- return Object.assign(Object.assign({}, res), { _response: res._response, objectReplicationDestinationPolicyId: res.objectReplicationPolicyId, objectReplicationSourceProperties: parseObjectReplicationRecord(res.objectReplicationRules) });
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get contentMD5() {
+ return this.originalResponse.contentMD5;
}
/**
- * Marks the specified blob or snapshot for deletion. The blob is later deleted
- * during garbage collection. Note that in order to delete a blob, you must delete
- * all of its snapshots. You can delete both at the same time with the Delete
- * Blob operation.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
+ * Indicates the range of bytes returned if
+ * the client requested a subset of the file by setting the Range request
+ * header.
*
- * @param options - Optional options to Blob Delete operation.
+ * @readonly
*/
- async delete(options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobClient-delete", options);
- options.conditions = options.conditions || {};
- try {
- return await this.blobContext.delete(Object.assign({ abortSignal: options.abortSignal, deleteSnapshots: options.deleteSnapshots, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get contentRange() {
+ return this.originalResponse.contentRange;
}
/**
- * Marks the specified blob or snapshot for deletion if it exists. The blob is later deleted
- * during garbage collection. Note that in order to delete a blob, you must delete
- * all of its snapshots. You can delete both at the same time with the Delete
- * Blob operation.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
+ * The content type specified for the file.
+ * The default content type is 'application/octet-stream'
*
- * @param options - Optional options to Blob Delete operation.
+ * @readonly
*/
- async deleteIfExists(options = {}) {
- var _a, _b;
- const { span, updatedOptions } = createSpan("BlobClient-deleteIfExists", options);
- try {
- const res = await this.delete(updatedOptions);
- return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
- }
- catch (e) {
- if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "BlobNotFound") {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: "Expected exception when deleting a blob or snapshot only if it exists.",
- });
- return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
- }
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get contentType() {
+ return this.originalResponse.contentType;
}
/**
- * Restores the contents and metadata of soft deleted blob and any associated
- * soft deleted snapshots. Undelete Blob is supported only on version 2017-07-29
- * or later.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
+ * Conclusion time of the last attempted
+ * Copy File operation where this file was the destination file. This value
+ * can specify the time of a completed, aborted, or failed copy attempt.
*
- * @param options - Optional options to Blob Undelete operation.
+ * @readonly
*/
- async undelete(options = {}) {
- const { span, updatedOptions } = createSpan("BlobClient-undelete", options);
- try {
- return await this.blobContext.undelete(Object.assign({ abortSignal: options.abortSignal }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get copyCompletedOn() {
+ return undefined;
}
/**
- * Sets system properties on the blob.
- *
- * If no value provided, or no value provided for the specified blob HTTP headers,
- * these blob HTTP headers without a value will be cleared.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
+ * String identifier for the last attempted Copy
+ * File operation where this file was the destination file.
*
- * @param blobHTTPHeaders - If no value provided, or no value provided for
- * the specified blob HTTP headers, these blob HTTP
- * headers without a value will be cleared.
- * A common header to set is `blobContentType`
- * enabling the browser to provide functionality
- * based on file type.
- * @param options - Optional options to Blob Set HTTP Headers operation.
+ * @readonly
*/
- async setHTTPHeaders(blobHTTPHeaders, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobClient-setHTTPHeaders", options);
- options.conditions = options.conditions || {};
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.blobContext.setHttpHeaders(Object.assign({ abortSignal: options.abortSignal, blobHttpHeaders: blobHTTPHeaders, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get copyId() {
+ return this.originalResponse.copyId;
}
/**
- * Sets user-defined metadata for the specified blob as one or more name-value pairs.
- *
- * If no option provided, or no metadata defined in the parameter, the blob
- * metadata will be removed.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
+ * Contains the number of bytes copied and
+ * the total bytes in the source in the last attempted Copy File operation
+ * where this file was the destination file. Can show between 0 and
+ * Content-Length bytes copied.
*
- * @param metadata - Replace existing metadata with this value.
- * If no value provided the existing metadata will be removed.
- * @param options - Optional options to Set Metadata operation.
+ * @readonly
*/
- async setMetadata(metadata, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobClient-setMetadata", options);
- options.conditions = options.conditions || {};
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.blobContext.setMetadata(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, metadata, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get copyProgress() {
+ return this.originalResponse.copyProgress;
}
/**
- * Sets tags on the underlying blob.
- * A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters.
- * Valid tag key and value characters include lower and upper case letters, digits (0-9),
- * space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'), colon (':'), equals ('='), and underscore ('_').
+ * URL up to 2KB in length that specifies the
+ * source file used in the last attempted Copy File operation where this file
+ * was the destination file.
*
- * @param tags -
- * @param options -
+ * @readonly
*/
- async setTags(tags, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobClient-setTags", options);
- try {
- return await this.blobContext.setTags(Object.assign(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)), { tags: toBlobTags(tags) }));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get copySource() {
+ return this.originalResponse.copySource;
}
/**
- * Gets the tags associated with the underlying blob.
+ * State of the copy operation
+ * identified by 'x-ms-copy-id'. Possible values include: 'pending',
+ * 'success', 'aborted', 'failed'
*
- * @param options -
+ * @readonly
*/
- async getTags(options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobClient-getTags", options);
- try {
- const response = await this.blobContext.getTags(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- const wrappedResponse = Object.assign(Object.assign({}, response), { _response: response._response, tags: toTags({ blobTagSet: response.blobTagSet }) || {} });
- return wrappedResponse;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get copyStatus() {
+ return this.originalResponse.copyStatus;
}
/**
- * Get a {@link BlobLeaseClient} that manages leases on the blob.
+ * Only appears when
+ * x-ms-copy-status is failed or pending. Describes cause of fatal or
+ * non-fatal copy operation failure.
*
- * @param proposeLeaseId - Initial proposed lease Id.
- * @returns A new BlobLeaseClient object for managing leases on the blob.
+ * @readonly
*/
- getBlobLeaseClient(proposeLeaseId) {
- return new BlobLeaseClient(this, proposeLeaseId);
+ get copyStatusDescription() {
+ return this.originalResponse.copyStatusDescription;
}
/**
- * Creates a read-only snapshot of a blob.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
+ * When a blob is leased,
+ * specifies whether the lease is of infinite or fixed duration. Possible
+ * values include: 'infinite', 'fixed'.
*
- * @param options - Optional options to the Blob Create Snapshot operation.
+ * @readonly
*/
- async createSnapshot(options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobClient-createSnapshot", options);
- options.conditions = options.conditions || {};
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.blobContext.createSnapshot(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, metadata: options.metadata, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get leaseDuration() {
+ return this.originalResponse.leaseDuration;
}
/**
- * Asynchronously copies a blob to a destination within the storage account.
- * This method returns a long running operation poller that allows you to wait
- * indefinitely until the copy is completed.
- * You can also cancel a copy before it is completed by calling `cancelOperation` on the poller.
- * Note that the onProgress callback will not be invoked if the operation completes in the first
- * request, and attempting to cancel a completed copy will result in an error being thrown.
- *
- * In version 2012-02-12 and later, the source for a Copy Blob operation can be
- * a committed blob in any Azure storage account.
- * Beginning with version 2015-02-21, the source for a Copy Blob operation can be
- * an Azure file in any Azure storage account.
- * Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
- * operation to copy from another storage account.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
- *
- * Example using automatic polling:
- *
- * ```js
- * const copyPoller = await blobClient.beginCopyFromURL('url');
- * const result = await copyPoller.pollUntilDone();
- * ```
- *
- * Example using manual polling:
- *
- * ```js
- * const copyPoller = await blobClient.beginCopyFromURL('url');
- * while (!poller.isDone()) {
- * await poller.poll();
- * }
- * const result = copyPoller.getResult();
- * ```
- *
- * Example using progress updates:
- *
- * ```js
- * const copyPoller = await blobClient.beginCopyFromURL('url', {
- * onProgress(state) {
- * console.log(`Progress: ${state.copyProgress}`);
- * }
- * });
- * const result = await copyPoller.pollUntilDone();
- * ```
- *
- * Example using a changing polling interval (default 15 seconds):
- *
- * ```js
- * const copyPoller = await blobClient.beginCopyFromURL('url', {
- * intervalInMs: 1000 // poll blob every 1 second for copy progress
- * });
- * const result = await copyPoller.pollUntilDone();
- * ```
- *
- * Example using copy cancellation:
+ * Lease state of the blob. Possible
+ * values include: 'available', 'leased', 'expired', 'breaking', 'broken'.
*
- * ```js
- * const copyPoller = await blobClient.beginCopyFromURL('url');
- * // cancel operation after starting it.
- * try {
- * await copyPoller.cancelOperation();
- * // calls to get the result now throw PollerCancelledError
- * await copyPoller.getResult();
- * } catch (err) {
- * if (err.name === 'PollerCancelledError') {
- * console.log('The copy was cancelled.');
- * }
- * }
- * ```
+ * @readonly
+ */
+ get leaseState() {
+ return this.originalResponse.leaseState;
+ }
+ /**
+ * The current lease status of the
+ * blob. Possible values include: 'locked', 'unlocked'.
*
- * @param copySource - url to the source Azure Blob/File.
- * @param options - Optional options to the Blob Start Copy From URL operation.
+ * @readonly
*/
- async beginCopyFromURL(copySource, options = {}) {
- const client = {
- abortCopyFromURL: (...args) => this.abortCopyFromURL(...args),
- getProperties: (...args) => this.getProperties(...args),
- startCopyFromURL: (...args) => this.startCopyFromURL(...args),
- };
- const poller = new BlobBeginCopyFromUrlPoller({
- blobClient: client,
- copySource,
- intervalInMs: options.intervalInMs,
- onProgress: options.onProgress,
- resumeFrom: options.resumeFrom,
- startCopyFromURLOptions: options,
- });
- // Trigger the startCopyFromURL call by calling poll.
- // Any errors from this method should be surfaced to the user.
- await poller.poll();
- return poller;
+ get leaseStatus() {
+ return this.originalResponse.leaseStatus;
}
/**
- * Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero
- * length and full metadata. Version 2012-02-12 and newer.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
+ * A UTC date/time value generated by the service that
+ * indicates the time at which the response was initiated.
*
- * @param copyId - Id of the Copy From URL operation.
- * @param options - Optional options to the Blob Abort Copy From URL operation.
+ * @readonly
*/
- async abortCopyFromURL(copyId, options = {}) {
- const { span, updatedOptions } = createSpan("BlobClient-abortCopyFromURL", options);
- try {
- return await this.blobContext.abortCopyFromURL(copyId, Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get date() {
+ return this.originalResponse.date;
}
/**
- * The synchronous Copy From URL operation copies a blob or an internet resource to a new blob. It will not
- * return a response until the copy is complete.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
+ * The number of committed blocks
+ * present in the blob. This header is returned only for append blobs.
*
- * @param copySource - The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
- * @param options -
+ * @readonly
*/
- async syncCopyFromURL(copySource, options = {}) {
- var _a, _b, _c;
- const { span, updatedOptions } = createSpan("BlobClient-syncCopyFromURL", options);
- options.conditions = options.conditions || {};
- options.sourceConditions = options.sourceConditions || {};
- try {
- return await this.blobContext.copyFromURL(copySource, Object.assign({ abortSignal: options.abortSignal, metadata: options.metadata, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), sourceModifiedAccessConditions: {
- sourceIfMatch: options.sourceConditions.ifMatch,
- sourceIfModifiedSince: options.sourceConditions.ifModifiedSince,
- sourceIfNoneMatch: options.sourceConditions.ifNoneMatch,
- sourceIfUnmodifiedSince: options.sourceConditions.ifUnmodifiedSince,
- }, sourceContentMD5: options.sourceContentMD5, copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization), tier: toAccessTier(options.tier), blobTagsString: toBlobTagsString(options.tags), immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn, immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode, legalHold: options.legalHold, encryptionScope: options.encryptionScope, copySourceTags: options.copySourceTags }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get blobCommittedBlockCount() {
+ return this.originalResponse.blobCommittedBlockCount;
}
/**
- * Sets the tier on a blob. The operation is allowed on a page blob in a premium
- * storage account and on a block blob in a blob storage account (locally redundant
- * storage only). A premium page blob's tier determines the allowed size, IOPS,
- * and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive
- * storage type. This operation does not update the blob's ETag.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
+ * The ETag contains a value that you can use to
+ * perform operations conditionally, in quotes.
*
- * @param tier - The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
- * @param options - Optional options to the Blob Set Tier operation.
+ * @readonly
*/
- async setAccessTier(tier, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobClient-setAccessTier", options);
- try {
- return await this.blobContext.setTier(toAccessTier(tier), Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), rehydratePriority: options.rehydratePriority }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get etag() {
+ return this.originalResponse.etag;
}
- async downloadToBuffer(param1, param2, param3, param4 = {}) {
- let buffer;
- let offset = 0;
- let count = 0;
- let options = param4;
- if (param1 instanceof Buffer) {
- buffer = param1;
- offset = param2 || 0;
- count = typeof param3 === "number" ? param3 : 0;
- }
- else {
- offset = typeof param1 === "number" ? param1 : 0;
- count = typeof param2 === "number" ? param2 : 0;
- options = param3 || {};
- }
- const { span, updatedOptions } = createSpan("BlobClient-downloadToBuffer", options);
- try {
- if (!options.blockSize) {
- options.blockSize = 0;
- }
- if (options.blockSize < 0) {
- throw new RangeError("blockSize option must be >= 0");
- }
- if (options.blockSize === 0) {
- options.blockSize = DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES;
- }
- if (offset < 0) {
- throw new RangeError("offset option must be >= 0");
- }
- if (count && count <= 0) {
- throw new RangeError("count option must be greater than 0");
- }
- if (!options.conditions) {
- options.conditions = {};
- }
- // Customer doesn't specify length, get it
- if (!count) {
- const response = await this.getProperties(Object.assign(Object.assign({}, options), { tracingOptions: Object.assign(Object.assign({}, options.tracingOptions), convertTracingToRequestOptionsBase(updatedOptions)) }));
- count = response.contentLength - offset;
- if (count < 0) {
- throw new RangeError(`offset ${offset} shouldn't be larger than blob size ${response.contentLength}`);
- }
- }
- // Allocate the buffer of size = count if the buffer is not provided
- if (!buffer) {
- try {
- buffer = Buffer.alloc(count);
- }
- catch (error) {
- throw new Error(`Unable to allocate the buffer of size: ${count}(in bytes). Please try passing your own buffer to the "downloadToBuffer" method or try using other methods like "download" or "downloadToFile".\t ${error.message}`);
- }
- }
- if (buffer.length < count) {
- throw new RangeError(`The buffer's size should be equal to or larger than the request count of bytes: ${count}`);
- }
- let transferProgress = 0;
- const batch = new Batch(options.concurrency);
- for (let off = offset; off < offset + count; off = off + options.blockSize) {
- batch.addOperation(async () => {
- // Exclusive chunk end position
- let chunkEnd = offset + count;
- if (off + options.blockSize < chunkEnd) {
- chunkEnd = off + options.blockSize;
- }
- const response = await this.download(off, chunkEnd - off, {
- abortSignal: options.abortSignal,
- conditions: options.conditions,
- maxRetryRequests: options.maxRetryRequestsPerBlock,
- customerProvidedKey: options.customerProvidedKey,
- tracingOptions: Object.assign(Object.assign({}, options.tracingOptions), convertTracingToRequestOptionsBase(updatedOptions)),
- });
- const stream = response.readableStreamBody;
- await streamToBuffer(stream, buffer, off - offset, chunkEnd - offset);
- // Update progress after block is downloaded, in case of block trying
- // Could provide finer grained progress updating inside HTTP requests,
- // only if convenience layer download try is enabled
- transferProgress += chunkEnd - off;
- if (options.onProgress) {
- options.onProgress({ loadedBytes: transferProgress });
- }
- });
- }
- await batch.do();
- return buffer;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ /**
+ * The error code.
+ *
+ * @readonly
+ */
+ get errorCode() {
+ return this.originalResponse.errorCode;
}
/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ * The value of this header is set to
+ * true if the file data and application metadata are completely encrypted
+ * using the specified algorithm. Otherwise, the value is set to false (when
+ * the file is unencrypted, or if only parts of the file/application metadata
+ * are encrypted).
*
- * Downloads an Azure Blob to a local file.
- * Fails if the the given file path already exits.
- * Offset and count are optional, pass 0 and undefined respectively to download the entire blob.
+ * @readonly
+ */
+ get isServerEncrypted() {
+ return this.originalResponse.isServerEncrypted;
+ }
+ /**
+ * If the blob has a MD5 hash, and if
+ * request contains range header (Range or x-ms-range), this response header
+ * is returned with the value of the whole blob's MD5 value. This value may
+ * or may not be equal to the value returned in Content-MD5 header, with the
+ * latter calculated from the requested range.
*
- * @param filePath -
- * @param offset - From which position of the block blob to download.
- * @param count - How much data to be downloaded. Will download to the end when passing undefined.
- * @param options - Options to Blob download options.
- * @returns The response data for blob download operation,
- * but with readableStreamBody set to undefined since its
- * content is already read and written into a local file
- * at the specified path.
+ * @readonly
*/
- async downloadToFile(filePath, offset = 0, count, options = {}) {
- const { span, updatedOptions } = createSpan("BlobClient-downloadToFile", options);
- try {
- const response = await this.download(offset, count, Object.assign(Object.assign({}, options), { tracingOptions: Object.assign(Object.assign({}, options.tracingOptions), convertTracingToRequestOptionsBase(updatedOptions)) }));
- if (response.readableStreamBody) {
- await readStreamToLocalFile(response.readableStreamBody, filePath);
- }
- // The stream is no longer accessible so setting it to undefined.
- response.blobDownloadStream = undefined;
- return response;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get blobContentMD5() {
+ return this.originalResponse.blobContentMD5;
}
- getBlobAndContainerNamesFromUrl() {
- let containerName;
- let blobName;
- try {
- // URL may look like the following
- // "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString";
- // "https://myaccount.blob.core.windows.net/mycontainer/blob";
- // "https://myaccount.blob.core.windows.net/mycontainer/blob/a.txt?sasString";
- // "https://myaccount.blob.core.windows.net/mycontainer/blob/a.txt";
- // IPv4/IPv6 address hosts, Endpoints - `http://127.0.0.1:10000/devstoreaccount1/containername/blob`
- // http://localhost:10001/devstoreaccount1/containername/blob
- const parsedUrl = coreHttp.URLBuilder.parse(this.url);
- if (parsedUrl.getHost().split(".")[1] === "blob") {
- // "https://myaccount.blob.core.windows.net/containername/blob".
- // .getPath() -> /containername/blob
- const pathComponents = parsedUrl.getPath().match("/([^/]*)(/(.*))?");
- containerName = pathComponents[1];
- blobName = pathComponents[3];
- }
- else if (isIpEndpointStyle(parsedUrl)) {
- // IPv4/IPv6 address hosts... Example - http://192.0.0.10:10001/devstoreaccount1/containername/blob
- // Single word domain without a [dot] in the endpoint... Example - http://localhost:10001/devstoreaccount1/containername/blob
- // .getPath() -> /devstoreaccount1/containername/blob
- const pathComponents = parsedUrl.getPath().match("/([^/]*)/([^/]*)(/(.*))?");
- containerName = pathComponents[2];
- blobName = pathComponents[4];
- }
- else {
- // "https://customdomain.com/containername/blob".
- // .getPath() -> /containername/blob
- const pathComponents = parsedUrl.getPath().match("/([^/]*)(/(.*))?");
- containerName = pathComponents[1];
- blobName = pathComponents[3];
- }
- // decode the encoded blobName, containerName - to get all the special characters that might be present in them
- containerName = decodeURIComponent(containerName);
- blobName = decodeURIComponent(blobName);
- // Azure Storage Server will replace "\" with "/" in the blob names
- // doing the same in the SDK side so that the user doesn't have to replace "\" instances in the blobName
- blobName = blobName.replace(/\\/g, "/");
- if (!containerName) {
- throw new Error("Provided containerName is invalid.");
- }
- return { blobName, containerName };
- }
- catch (error) {
- throw new Error("Unable to extract blobName and containerName with provided information.");
- }
+ /**
+ * Returns the date and time the file was last
+ * modified. Any operation that modifies the file or its properties updates
+ * the last modified time.
+ *
+ * @readonly
+ */
+ get lastModified() {
+ return this.originalResponse.lastModified;
}
/**
- * Asynchronously copies a blob to a destination within the storage account.
- * In version 2012-02-12 and later, the source for a Copy Blob operation can be
- * a committed blob in any Azure storage account.
- * Beginning with version 2015-02-21, the source for a Copy Blob operation can be
- * an Azure file in any Azure storage account.
- * Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
- * operation to copy from another storage account.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
+ * A name-value pair
+ * to associate with a file storage object.
*
- * @param copySource - url to the source Azure Blob/File.
- * @param options - Optional options to the Blob Start Copy From URL operation.
+ * @readonly
*/
- async startCopyFromURL(copySource, options = {}) {
- var _a, _b, _c;
- const { span, updatedOptions } = createSpan("BlobClient-startCopyFromURL", options);
- options.conditions = options.conditions || {};
- options.sourceConditions = options.sourceConditions || {};
- try {
- return await this.blobContext.startCopyFromURL(copySource, Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, metadata: options.metadata, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), sourceModifiedAccessConditions: {
- sourceIfMatch: options.sourceConditions.ifMatch,
- sourceIfModifiedSince: options.sourceConditions.ifModifiedSince,
- sourceIfNoneMatch: options.sourceConditions.ifNoneMatch,
- sourceIfUnmodifiedSince: options.sourceConditions.ifUnmodifiedSince,
- sourceIfTags: options.sourceConditions.tagConditions,
- }, immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn, immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode, legalHold: options.legalHold, rehydratePriority: options.rehydratePriority, tier: toAccessTier(options.tier), blobTagsString: toBlobTagsString(options.tags), sealBlob: options.sealBlob }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get metadata() {
+ return this.originalResponse.metadata;
}
/**
- * Only available for BlobClient constructed with a shared key credential.
+ * This header uniquely identifies the request
+ * that was made and can be used for troubleshooting the request.
*
- * Generates a Blob 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.
+ * @readonly
+ */
+ get requestId() {
+ return this.originalResponse.requestId;
+ }
+ /**
+ * If a client request id header is sent in the request, this header will be present in the
+ * response with the same value.
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
+ * @readonly
+ */
+ get clientRequestId() {
+ return this.originalResponse.clientRequestId;
+ }
+ /**
+ * Indicates the version of the File service used
+ * to execute the request.
*
- * @param options - Optional parameters.
- * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+ * @readonly
*/
- generateSasUrl(options) {
- return new Promise((resolve) => {
- if (!(this.credential instanceof StorageSharedKeyCredential)) {
- throw new RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
- }
- const sas = generateBlobSASQueryParameters(Object.assign({ containerName: this._containerName, blobName: this._name, snapshotTime: this._snapshot, versionId: this._versionId }, options), this.credential).toString();
- resolve(appendToURLQuery(this.url, sas));
- });
+ get version() {
+ return this.originalResponse.version;
}
/**
- * Delete the immutablility policy on the blob.
+ * The SHA-256 hash of the encryption key used to encrypt the blob. This value is only returned
+ * when the blob was encrypted with a customer-provided key.
*
- * @param options - Optional options to delete immutability policy on the blob.
+ * @readonly
*/
- async deleteImmutabilityPolicy(options) {
- const { span, updatedOptions } = createSpan("BlobClient-deleteImmutabilityPolicy", options);
- try {
- return await this.blobContext.deleteImmutabilityPolicy(Object.assign({ abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get encryptionKeySha256() {
+ return this.originalResponse.encryptionKeySha256;
+ }
+ /**
+ * If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to
+ * true, then the request returns a crc64 for the range, as long as the range size is less than
+ * or equal to 4 MB. If both x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 is
+ * specified in the same request, it will fail with 400(Bad Request)
+ */
+ get contentCrc64() {
+ return this.originalResponse.contentCrc64;
}
/**
- * Set immutablility policy on the blob.
+ * The response body as a browser Blob.
+ * Always undefined in node.js.
*
- * @param options - Optional options to set immutability policy on the blob.
+ * @readonly
*/
- async setImmutabilityPolicy(immutabilityPolicy, options) {
- const { span, updatedOptions } = createSpan("BlobClient-setImmutabilityPolicy", options);
- try {
- return await this.blobContext.setImmutabilityPolicy(Object.assign({ abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal, immutabilityPolicyExpiry: immutabilityPolicy.expiriesOn, immutabilityPolicyMode: immutabilityPolicy.policyMode, modifiedAccessConditions: options === null || options === void 0 ? void 0 : options.modifiedAccessCondition }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get blobBody() {
+ return undefined;
}
/**
- * Set legal hold on the blob.
+ * The response body as a node.js Readable stream.
+ * Always undefined in the browser.
*
- * @param options - Optional options to set legal hold on the blob.
+ * It will parse avor data returned by blob query.
+ *
+ * @readonly
*/
- async setLegalHold(legalHoldEnabled, options) {
- const { span, updatedOptions } = createSpan("BlobClient-setLegalHold", options);
- try {
- return await this.blobContext.setLegalHold(legalHoldEnabled, Object.assign({ abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ get readableStreamBody() {
+ return coreUtil.isNode ? this.blobDownloadStream : undefined;
+ }
+ /**
+ * The HTTP response.
+ */
+ get _response() {
+ return this.originalResponse._response;
+ }
+ /**
+ * Creates an instance of BlobQueryResponse.
+ *
+ * @param originalResponse -
+ * @param options -
+ */
+ constructor(originalResponse, options = {}) {
+ this.originalResponse = originalResponse;
+ this.blobDownloadStream = new BlobQuickQueryStream(this.originalResponse.readableStreamBody, options);
}
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * AppendBlobClient defines a set of operations applicable to append blobs.
+ * Represents the access tier on a blob.
+ * For detailed information about block blob level tiering see {@link https://docs.microsoft.com/azure/storage/blobs/storage-blob-storage-tiers|Hot, cool and archive storage tiers.}
*/
-class AppendBlobClient extends BlobClient {
- constructor(urlOrConnectionString, credentialOrPipelineOrContainerName, blobNameOrOptions,
- // Legacy, no fix for eslint error without breaking. Disable it for this interface.
- /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
- options) {
- // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead.
- // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options);
- let pipeline;
- let url;
- options = options || {};
- if (isPipelineLike(credentialOrPipelineOrContainerName)) {
- // (url: string, pipeline: Pipeline)
- url = urlOrConnectionString;
- pipeline = credentialOrPipelineOrContainerName;
- }
- else if ((coreHttp.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
- credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
- coreHttp.isTokenCredential(credentialOrPipelineOrContainerName)) {
- // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions) url = urlOrConnectionString;
- url = urlOrConnectionString;
- options = blobNameOrOptions;
- pipeline = newPipeline(credentialOrPipelineOrContainerName, options);
- }
- else if (!credentialOrPipelineOrContainerName &&
- typeof credentialOrPipelineOrContainerName !== "string") {
- // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
- url = urlOrConnectionString;
- // The second parameter is undefined. Use anonymous credential.
- pipeline = newPipeline(new AnonymousCredential(), options);
- }
- else if (credentialOrPipelineOrContainerName &&
- typeof credentialOrPipelineOrContainerName === "string" &&
- blobNameOrOptions &&
- typeof blobNameOrOptions === "string") {
- // (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
- const containerName = credentialOrPipelineOrContainerName;
- const blobName = blobNameOrOptions;
- const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
- if (extractedCreds.kind === "AccountConnString") {
- if (coreHttp.isNode) {
- const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
- url = appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName));
- if (!options.proxyOptions) {
- options.proxyOptions = coreHttp.getDefaultProxySettings(extractedCreds.proxyUri);
- }
- pipeline = newPipeline(sharedKeyCredential, options);
- }
- else {
- throw new Error("Account connection string is only supported in Node.js environment");
- }
- }
- else if (extractedCreds.kind === "SASConnString") {
- url =
- appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName)) +
- "?" +
- extractedCreds.accountSas;
- pipeline = newPipeline(new AnonymousCredential(), options);
- }
- else {
- throw new Error("Connection string must be either an Account connection string or a SAS connection string");
- }
- }
- else {
- throw new Error("Expecting non-empty strings for containerName and blobName parameters");
- }
- super(url, pipeline);
- this.appendBlobContext = new AppendBlob(this.storageClientContext);
- }
+exports.BlockBlobTier = void 0;
+(function (BlockBlobTier) {
+ /**
+ * Optimized for storing data that is accessed frequently.
+ */
+ BlockBlobTier["Hot"] = "Hot";
+ /**
+ * Optimized for storing data that is infrequently accessed and stored for at least 30 days.
+ */
+ BlockBlobTier["Cool"] = "Cool";
+ /**
+ * Optimized for storing data that is rarely accessed.
+ */
+ BlockBlobTier["Cold"] = "Cold";
+ /**
+ * Optimized for storing data that is rarely accessed and stored for at least 180 days
+ * with flexible latency requirements (on the order of hours).
+ */
+ BlockBlobTier["Archive"] = "Archive";
+})(exports.BlockBlobTier || (exports.BlockBlobTier = {}));
+/**
+ * Specifies the page blob tier to set the blob to. This is only applicable to page blobs on premium storage accounts.
+ * Please see {@link https://docs.microsoft.com/azure/storage/storage-premium-storage#scalability-and-performance-targets|here}
+ * for detailed information on the corresponding IOPS and throughput per PageBlobTier.
+ */
+exports.PremiumPageBlobTier = void 0;
+(function (PremiumPageBlobTier) {
/**
- * Creates a new AppendBlobClient object identical to the source but with the
- * specified snapshot timestamp.
- * Provide "" will remove the snapshot and return a Client to the base blob.
- *
- * @param snapshot - The snapshot timestamp.
- * @returns A new AppendBlobClient object identical to the source but with the specified snapshot timestamp.
+ * P4 Tier.
*/
- withSnapshot(snapshot) {
- return new AppendBlobClient(setURLParameter(this.url, URLConstants.Parameters.SNAPSHOT, snapshot.length === 0 ? undefined : snapshot), this.pipeline);
- }
+ PremiumPageBlobTier["P4"] = "P4";
/**
- * Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
- * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
- *
- * @param options - Options to the Append Block Create operation.
- *
- *
- * Example usage:
- *
- * ```js
- * const appendBlobClient = containerClient.getAppendBlobClient("");
- * await appendBlobClient.create();
- * ```
+ * P6 Tier.
*/
- async create(options = {}) {
- var _a, _b, _c;
- const { span, updatedOptions } = createSpan("AppendBlobClient-create", options);
- options.conditions = options.conditions || {};
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.appendBlobContext.create(0, Object.assign({ abortSignal: options.abortSignal, blobHttpHeaders: options.blobHTTPHeaders, leaseAccessConditions: options.conditions, metadata: options.metadata, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope, immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn, immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode, legalHold: options.legalHold, blobTagsString: toBlobTagsString(options.tags) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
+ PremiumPageBlobTier["P6"] = "P6";
/**
- * Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
- * If the blob with the same name already exists, the content of the existing blob will remain unchanged.
- * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
- *
- * @param options -
+ * P10 Tier.
*/
- async createIfNotExists(options = {}) {
- var _a, _b;
- const { span, updatedOptions } = createSpan("AppendBlobClient-createIfNotExists", options);
- const conditions = { ifNoneMatch: ETagAny };
- try {
- const res = await this.create(Object.assign(Object.assign({}, updatedOptions), { conditions }));
- return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
- }
- catch (e) {
- if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "BlobAlreadyExists") {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: "Expected exception when creating a blob only if it does not already exist.",
- });
- return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
- }
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
+ PremiumPageBlobTier["P10"] = "P10";
/**
- * Seals the append blob, making it read only.
- *
- * @param options -
+ * P15 Tier.
*/
- async seal(options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("AppendBlobClient-seal", options);
- options.conditions = options.conditions || {};
- try {
- return await this.appendBlobContext.seal(Object.assign({ abortSignal: options.abortSignal, appendPositionAccessConditions: options.conditions, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
+ PremiumPageBlobTier["P15"] = "P15";
/**
- * Commits a new block of data to the end of the existing append blob.
- * @see https://docs.microsoft.com/rest/api/storageservices/append-block
- *
- * @param body - Data to be appended.
- * @param contentLength - Length of the body in bytes.
- * @param options - Options to the Append Block operation.
- *
- *
- * Example usage:
- *
- * ```js
- * const content = "Hello World!";
- *
- * // Create a new append blob and append data to the blob.
- * const newAppendBlobClient = containerClient.getAppendBlobClient("");
- * await newAppendBlobClient.create();
- * await newAppendBlobClient.appendBlock(content, content.length);
- *
- * // Append data to an existing append blob.
- * const existingAppendBlobClient = containerClient.getAppendBlobClient("");
- * await existingAppendBlobClient.appendBlock(content, content.length);
- * ```
+ * P20 Tier.
*/
- async appendBlock(body, contentLength, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("AppendBlobClient-appendBlock", options);
- options.conditions = options.conditions || {};
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.appendBlobContext.appendBlock(contentLength, body, Object.assign({ abortSignal: options.abortSignal, appendPositionAccessConditions: options.conditions, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), requestOptions: {
- onUploadProgress: options.onProgress,
- }, transactionalContentMD5: options.transactionalContentMD5, transactionalContentCrc64: options.transactionalContentCrc64, cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ PremiumPageBlobTier["P20"] = "P20";
+ /**
+ * P30 Tier.
+ */
+ PremiumPageBlobTier["P30"] = "P30";
+ /**
+ * P40 Tier.
+ */
+ PremiumPageBlobTier["P40"] = "P40";
+ /**
+ * P50 Tier.
+ */
+ PremiumPageBlobTier["P50"] = "P50";
+ /**
+ * P60 Tier.
+ */
+ PremiumPageBlobTier["P60"] = "P60";
+ /**
+ * P70 Tier.
+ */
+ PremiumPageBlobTier["P70"] = "P70";
+ /**
+ * P80 Tier.
+ */
+ PremiumPageBlobTier["P80"] = "P80";
+})(exports.PremiumPageBlobTier || (exports.PremiumPageBlobTier = {}));
+function toAccessTier(tier) {
+ if (tier === undefined) {
+ return undefined;
+ }
+ return tier; // No more check if string is a valid AccessTier, and left this to underlay logic to decide(service).
+}
+function ensureCpkIfSpecified(cpk, isHttps) {
+ if (cpk && !isHttps) {
+ throw new RangeError("Customer-provided encryption key must be used over HTTPS.");
}
+ if (cpk && !cpk.encryptionAlgorithm) {
+ cpk.encryptionAlgorithm = EncryptionAlgorithmAES25;
+ }
+}
+/**
+ * Defines the known cloud audiences for Storage.
+ */
+exports.StorageBlobAudience = void 0;
+(function (StorageBlobAudience) {
/**
- * The Append Block operation commits a new block of data to the end of an existing append blob
- * where the contents are read from a source url.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
- *
- * @param sourceURL -
- * The url to the blob that will be the source of the copy. A source blob in the same storage account can
- * be authenticated via Shared Key. However, if the source is a blob in another account, the source blob
- * must either be public or must be authenticated via a shared access signature. If the source blob is
- * public, no authentication is required to perform the operation.
- * @param sourceOffset - Offset in source to be appended
- * @param count - Number of bytes to be appended as a block
- * @param options -
+ * The OAuth scope to use to retrieve an AAD token for Azure Storage.
*/
- async appendBlockFromURL(sourceURL, sourceOffset, count, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("AppendBlobClient-appendBlockFromURL", options);
- options.conditions = options.conditions || {};
- options.sourceConditions = options.sourceConditions || {};
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.appendBlobContext.appendBlockFromUrl(sourceURL, 0, Object.assign({ abortSignal: options.abortSignal, sourceRange: rangeToString({ offset: sourceOffset, count }), sourceContentMD5: options.sourceContentMD5, sourceContentCrc64: options.sourceContentCrc64, leaseAccessConditions: options.conditions, appendPositionAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), sourceModifiedAccessConditions: {
- sourceIfMatch: options.sourceConditions.ifMatch,
- sourceIfModifiedSince: options.sourceConditions.ifModifiedSince,
- sourceIfNoneMatch: options.sourceConditions.ifNoneMatch,
- sourceIfUnmodifiedSince: options.sourceConditions.ifUnmodifiedSince,
- }, copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization), cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ StorageBlobAudience["StorageOAuthScopes"] = "https://storage.azure.com/.default";
+ /**
+ * The OAuth scope to use to retrieve an AAD token for Azure Disk.
+ */
+ StorageBlobAudience["DiskComputeOAuthScopes"] = "https://disk.compute.azure.com/.default";
+})(exports.StorageBlobAudience || (exports.StorageBlobAudience = {}));
+/**
+ *
+ * To get OAuth audience for a storage account for blob service.
+ */
+function getBlobServiceAccountAudience(storageAccountName) {
+ return `https://${storageAccountName}.blob.core.windows.net/.default`;
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Function that converts PageRange and ClearRange to a common Range object.
+ * PageRange and ClearRange have start and end while Range offset and count
+ * this function normalizes to Range.
+ * @param response - Model PageBlob Range response
+ */
+function rangeResponseFromModel(response) {
+ const pageRange = (response._response.parsedBody.pageRange || []).map((x) => ({
+ offset: x.start,
+ count: x.end - x.start,
+ }));
+ const clearRange = (response._response.parsedBody.clearRange || []).map((x) => ({
+ offset: x.start,
+ count: x.end - x.start,
+ }));
+ return Object.assign(Object.assign({}, response), { pageRange,
+ clearRange, _response: Object.assign(Object.assign({}, response._response), { parsedBody: {
+ pageRange,
+ clearRange,
+ } }) });
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * This is the poller returned by {@link BlobClient.beginCopyFromURL}.
+ * This can not be instantiated directly outside of this package.
+ *
+ * @hidden
+ */
+class BlobBeginCopyFromUrlPoller extends coreLro.Poller {
+ constructor(options) {
+ const { blobClient, copySource, intervalInMs = 15000, onProgress, resumeFrom, startCopyFromURLOptions, } = options;
+ let state;
+ if (resumeFrom) {
+ state = JSON.parse(resumeFrom).state;
}
- finally {
- span.end();
+ const operation = makeBlobBeginCopyFromURLPollOperation(Object.assign(Object.assign({}, state), { blobClient,
+ copySource,
+ startCopyFromURLOptions }));
+ super(operation);
+ if (typeof onProgress === "function") {
+ this.onProgress(onProgress);
}
+ this.intervalInMs = intervalInMs;
+ }
+ delay() {
+ return coreUtil.delay(this.intervalInMs);
}
}
/**
- * BlockBlobClient defines a set of operations applicable to block blobs.
+ * Note: Intentionally using function expression over arrow function expression
+ * so that the function can be invoked with a different context.
+ * This affects what `this` refers to.
+ * @hidden
*/
-class BlockBlobClient extends BlobClient {
- constructor(urlOrConnectionString, credentialOrPipelineOrContainerName, blobNameOrOptions,
- // Legacy, no fix for eslint error without breaking. Disable it for this interface.
- /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
- options) {
- // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead.
- // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options);
- let pipeline;
- let url;
- options = options || {};
- if (isPipelineLike(credentialOrPipelineOrContainerName)) {
- // (url: string, pipeline: Pipeline)
- url = urlOrConnectionString;
- pipeline = credentialOrPipelineOrContainerName;
- }
- else if ((coreHttp.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
- credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
- coreHttp.isTokenCredential(credentialOrPipelineOrContainerName)) {
- // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
- url = urlOrConnectionString;
- options = blobNameOrOptions;
- pipeline = newPipeline(credentialOrPipelineOrContainerName, options);
+const cancel = async function cancel(options = {}) {
+ const state = this.state;
+ const { copyId } = state;
+ if (state.isCompleted) {
+ return makeBlobBeginCopyFromURLPollOperation(state);
+ }
+ if (!copyId) {
+ state.isCancelled = true;
+ return makeBlobBeginCopyFromURLPollOperation(state);
+ }
+ // if abortCopyFromURL throws, it will bubble up to user's poller.cancelOperation call
+ await state.blobClient.abortCopyFromURL(copyId, {
+ abortSignal: options.abortSignal,
+ });
+ state.isCancelled = true;
+ return makeBlobBeginCopyFromURLPollOperation(state);
+};
+/**
+ * Note: Intentionally using function expression over arrow function expression
+ * so that the function can be invoked with a different context.
+ * This affects what `this` refers to.
+ * @hidden
+ */
+const update = async function update(options = {}) {
+ const state = this.state;
+ const { blobClient, copySource, startCopyFromURLOptions } = state;
+ if (!state.isStarted) {
+ state.isStarted = true;
+ const result = await blobClient.startCopyFromURL(copySource, startCopyFromURLOptions);
+ // copyId is needed to abort
+ state.copyId = result.copyId;
+ if (result.copyStatus === "success") {
+ state.result = result;
+ state.isCompleted = true;
}
- else if (!credentialOrPipelineOrContainerName &&
- typeof credentialOrPipelineOrContainerName !== "string") {
- // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
- // The second parameter is undefined. Use anonymous credential.
- url = urlOrConnectionString;
- if (blobNameOrOptions && typeof blobNameOrOptions !== "string") {
- options = blobNameOrOptions;
+ }
+ else if (!state.isCompleted) {
+ try {
+ const result = await state.blobClient.getProperties({ abortSignal: options.abortSignal });
+ const { copyStatus, copyProgress } = result;
+ const prevCopyProgress = state.copyProgress;
+ if (copyProgress) {
+ state.copyProgress = copyProgress;
}
- pipeline = newPipeline(new AnonymousCredential(), options);
- }
- else if (credentialOrPipelineOrContainerName &&
- typeof credentialOrPipelineOrContainerName === "string" &&
- blobNameOrOptions &&
- typeof blobNameOrOptions === "string") {
- // (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
- const containerName = credentialOrPipelineOrContainerName;
- const blobName = blobNameOrOptions;
- const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
- if (extractedCreds.kind === "AccountConnString") {
- if (coreHttp.isNode) {
- const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
- url = appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName));
- if (!options.proxyOptions) {
- options.proxyOptions = coreHttp.getDefaultProxySettings(extractedCreds.proxyUri);
- }
- pipeline = newPipeline(sharedKeyCredential, options);
- }
- else {
- throw new Error("Account connection string is only supported in Node.js environment");
- }
+ if (copyStatus === "pending" &&
+ copyProgress !== prevCopyProgress &&
+ typeof options.fireProgress === "function") {
+ // trigger in setTimeout, or swallow error?
+ options.fireProgress(state);
}
- else if (extractedCreds.kind === "SASConnString") {
- url =
- appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName)) +
- "?" +
- extractedCreds.accountSas;
- pipeline = newPipeline(new AnonymousCredential(), options);
+ else if (copyStatus === "success") {
+ state.result = result;
+ state.isCompleted = true;
}
- else {
- throw new Error("Connection string must be either an Account connection string or a SAS connection string");
+ else if (copyStatus === "failed") {
+ state.error = new Error(`Blob copy failed with reason: "${result.copyStatusDescription || "unknown"}"`);
+ state.isCompleted = true;
}
}
- else {
- throw new Error("Expecting non-empty strings for containerName and blobName parameters");
+ catch (err) {
+ state.error = err;
+ state.isCompleted = true;
}
- super(url, pipeline);
- this.blockBlobContext = new BlockBlob(this.storageClientContext);
- this._blobContext = new Blob$1(this.storageClientContext);
}
- /**
- * Creates a new BlockBlobClient object identical to the source but with the
- * specified snapshot timestamp.
- * Provide "" will remove the snapshot and return a URL to the base blob.
- *
- * @param snapshot - The snapshot timestamp.
- * @returns A new BlockBlobClient object identical to the source but with the specified snapshot timestamp.
- */
- withSnapshot(snapshot) {
- return new BlockBlobClient(setURLParameter(this.url, URLConstants.Parameters.SNAPSHOT, snapshot.length === 0 ? undefined : snapshot), this.pipeline);
+ return makeBlobBeginCopyFromURLPollOperation(state);
+};
+/**
+ * Note: Intentionally using function expression over arrow function expression
+ * so that the function can be invoked with a different context.
+ * This affects what `this` refers to.
+ * @hidden
+ */
+const toString = function toString() {
+ return JSON.stringify({ state: this.state }, (key, value) => {
+ // remove blobClient from serialized state since a client can't be hydrated from this info.
+ if (key === "blobClient") {
+ return undefined;
+ }
+ return value;
+ });
+};
+/**
+ * Creates a poll operation given the provided state.
+ * @hidden
+ */
+function makeBlobBeginCopyFromURLPollOperation(state) {
+ return {
+ state: Object.assign({}, state),
+ cancel,
+ toString,
+ update,
+ };
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * Generate a range string. For example:
+ *
+ * "bytes=255-" or "bytes=0-511"
+ *
+ * @param iRange -
+ */
+function rangeToString(iRange) {
+ if (iRange.offset < 0) {
+ throw new RangeError(`Range.offset cannot be smaller than 0.`);
}
+ if (iRange.count && iRange.count <= 0) {
+ throw new RangeError(`Range.count must be larger than 0. Leave it undefined if you want a range from offset to the end.`);
+ }
+ return iRange.count
+ ? `bytes=${iRange.offset}-${iRange.offset + iRange.count - 1}`
+ : `bytes=${iRange.offset}-`;
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+// In browser, during webpack or browserify bundling, this module will be replaced by 'events'
+// https://github.com/Gozala/events
+/**
+ * States for Batch.
+ */
+var BatchStates;
+(function (BatchStates) {
+ BatchStates[BatchStates["Good"] = 0] = "Good";
+ BatchStates[BatchStates["Error"] = 1] = "Error";
+})(BatchStates || (BatchStates = {}));
+/**
+ * Batch provides basic parallel execution with concurrency limits.
+ * Will stop execute left operations when one of the executed operation throws an error.
+ * But Batch cannot cancel ongoing operations, you need to cancel them by yourself.
+ */
+class Batch {
/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * Quick query for a JSON or CSV formatted blob.
- *
- * Example usage (Node.js):
- *
- * ```js
- * // Query and convert a blob to a string
- * const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
- * const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
- * console.log("Query blob content:", downloaded);
- *
- * async function streamToBuffer(readableStream) {
- * return new Promise((resolve, reject) => {
- * const chunks = [];
- * readableStream.on("data", (data) => {
- * chunks.push(data instanceof Buffer ? data : Buffer.from(data));
- * });
- * readableStream.on("end", () => {
- * resolve(Buffer.concat(chunks));
- * });
- * readableStream.on("error", reject);
- * });
- * }
- * ```
- *
- * @param query -
- * @param options -
+ * Creates an instance of Batch.
+ * @param concurrency -
*/
- async query(query, options = {}) {
- var _a;
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- const { span, updatedOptions } = createSpan("BlockBlobClient-query", options);
- try {
- if (!coreHttp.isNode) {
- throw new Error("This operation currently is only supported in Node.js.");
- }
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- const response = await this._blobContext.query(Object.assign({ abortSignal: options.abortSignal, queryRequest: {
- queryType: "SQL",
- expression: query,
- inputSerialization: toQuerySerialization(options.inputTextConfiguration),
- outputSerialization: toQuerySerialization(options.outputTextConfiguration),
- }, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), cpkInfo: options.customerProvidedKey }, convertTracingToRequestOptionsBase(updatedOptions)));
- return new BlobQueryResponse(response, {
- abortSignal: options.abortSignal,
- onProgress: options.onProgress,
- onError: options.onError,
- });
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
+ constructor(concurrency = 5) {
+ /**
+ * Number of active operations under execution.
+ */
+ this.actives = 0;
+ /**
+ * Number of completed operations under execution.
+ */
+ this.completed = 0;
+ /**
+ * Offset of next operation to be executed.
+ */
+ this.offset = 0;
+ /**
+ * Operation array to be executed.
+ */
+ this.operations = [];
+ /**
+ * States of Batch. When an error happens, state will turn into error.
+ * Batch will stop execute left operations.
+ */
+ this.state = BatchStates.Good;
+ if (concurrency < 1) {
+ throw new RangeError("concurrency must be larger than 0");
}
+ this.concurrency = concurrency;
+ this.emitter = new events.EventEmitter();
}
/**
- * Creates a new block blob, or updates the content of an existing block blob.
- * Updating an existing block blob overwrites any existing metadata on the blob.
- * Partial updates are not supported; the content of the existing blob is
- * overwritten with the new content. To perform a partial update of a block blob's,
- * use {@link stageBlock} and {@link commitBlockList}.
- *
- * This is a non-parallel uploading method, please use {@link uploadFile},
- * {@link uploadStream} or {@link uploadBrowserData} for better performance
- * with concurrency uploading.
- *
- * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
- *
- * @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
- * which returns a new Readable stream whose offset is from data source beginning.
- * @param contentLength - Length of body in bytes. Use Buffer.byteLength() to calculate body length for a
- * string including non non-Base64/Hex-encoded characters.
- * @param options - Options to the Block Blob Upload operation.
- * @returns Response data for the Block Blob Upload operation.
+ * Add a operation into queue.
*
- * Example usage:
+ * @param operation -
+ */
+ addOperation(operation) {
+ this.operations.push(async () => {
+ try {
+ this.actives++;
+ await operation();
+ this.actives--;
+ this.completed++;
+ this.parallelExecute();
+ }
+ catch (error) {
+ this.emitter.emit("error", error);
+ }
+ });
+ }
+ /**
+ * Start execute operations in the queue.
*
- * ```js
- * const content = "Hello world!";
- * const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
- * ```
*/
- async upload(body, contentLength, options = {}) {
- var _a, _b, _c;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("BlockBlobClient-upload", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.blockBlobContext.upload(contentLength, body, Object.assign({ abortSignal: options.abortSignal, blobHttpHeaders: options.blobHTTPHeaders, leaseAccessConditions: options.conditions, metadata: options.metadata, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), requestOptions: {
- onUploadProgress: options.onProgress,
- }, cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope, immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn, immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode, legalHold: options.legalHold, tier: toAccessTier(options.tier), blobTagsString: toBlobTagsString(options.tags) }, convertTracingToRequestOptionsBase(updatedOptions)));
+ async do() {
+ if (this.operations.length === 0) {
+ return Promise.resolve();
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
+ this.parallelExecute();
+ return new Promise((resolve, reject) => {
+ this.emitter.on("finish", resolve);
+ this.emitter.on("error", (error) => {
+ this.state = BatchStates.Error;
+ reject(error);
});
- throw e;
- }
- finally {
- span.end();
+ });
+ }
+ /**
+ * Get next operation to be executed. Return null when reaching ends.
+ *
+ */
+ nextOperation() {
+ if (this.offset < this.operations.length) {
+ return this.operations[this.offset++];
}
+ return null;
}
/**
- * Creates a new Block Blob where the contents of the blob are read from a given URL.
- * This API is supported beginning with the 2020-04-08 version. Partial updates
- * are not supported with Put Blob from URL; the content of an existing blob is overwritten with
- * the content of the new blob. To perform partial updates to a block blob’s contents using a
- * source URL, use {@link stageBlockFromURL} and {@link commitBlockList}.
+ * Start execute operations. One one the most important difference between
+ * this method with do() is that do() wraps as an sync method.
*
- * @param sourceURL - Specifies the URL of the blob. The value
- * may be a URL of up to 2 KB in length that specifies a blob.
- * The value should be URL-encoded as it would appear
- * in a request URI. The source blob must either be public
- * or must be authenticated via a shared access signature.
- * If the source blob is public, no authentication is required
- * to perform the operation. Here are some examples of source object URLs:
- * - https://myaccount.blob.core.windows.net/mycontainer/myblob
- * - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
- * @param options - Optional parameters.
*/
- async syncUploadFromURL(sourceURL, options = {}) {
- var _a, _b, _c, _d, _e;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("BlockBlobClient-syncUploadFromURL", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.blockBlobContext.putBlobFromUrl(0, sourceURL, Object.assign(Object.assign(Object.assign({}, options), { blobHttpHeaders: options.blobHTTPHeaders, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: options.conditions.tagConditions }), sourceModifiedAccessConditions: {
- sourceIfMatch: (_a = options.sourceConditions) === null || _a === void 0 ? void 0 : _a.ifMatch,
- sourceIfModifiedSince: (_b = options.sourceConditions) === null || _b === void 0 ? void 0 : _b.ifModifiedSince,
- sourceIfNoneMatch: (_c = options.sourceConditions) === null || _c === void 0 ? void 0 : _c.ifNoneMatch,
- sourceIfUnmodifiedSince: (_d = options.sourceConditions) === null || _d === void 0 ? void 0 : _d.ifUnmodifiedSince,
- sourceIfTags: (_e = options.sourceConditions) === null || _e === void 0 ? void 0 : _e.tagConditions,
- }, cpkInfo: options.customerProvidedKey, copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization), tier: toAccessTier(options.tier), blobTagsString: toBlobTagsString(options.tags), copySourceTags: options.copySourceTags }), convertTracingToRequestOptionsBase(updatedOptions)));
+ parallelExecute() {
+ if (this.state === BatchStates.Error) {
+ return;
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (this.completed >= this.operations.length) {
+ this.emitter.emit("finish");
+ return;
}
- finally {
- span.end();
+ while (this.actives < this.concurrency) {
+ const operation = this.nextOperation();
+ if (operation) {
+ operation();
+ }
+ else {
+ return;
+ }
}
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * This class generates a readable stream from the data in an array of buffers.
+ */
+class BuffersStream extends stream.Readable {
/**
- * Uploads the specified block to the block blob's "staging area" to be later
- * committed by a call to commitBlockList.
- * @see https://docs.microsoft.com/rest/api/storageservices/put-block
+ * Creates an instance of BuffersStream that will emit the data
+ * contained in the array of buffers.
*
- * @param blockId - A 64-byte value that is base64-encoded
- * @param body - Data to upload to the staging area.
- * @param contentLength - Number of bytes to upload.
- * @param options - Options to the Block Blob Stage Block operation.
- * @returns Response data for the Block Blob Stage Block operation.
+ * @param buffers - Array of buffers containing the data
+ * @param byteLength - The total length of data contained in the buffers
*/
- async stageBlock(blockId, body, contentLength, options = {}) {
- const { span, updatedOptions } = createSpan("BlockBlobClient-stageBlock", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.blockBlobContext.stageBlock(blockId, contentLength, body, Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, requestOptions: {
- onUploadProgress: options.onProgress,
- }, transactionalContentMD5: options.transactionalContentMD5, transactionalContentCrc64: options.transactionalContentCrc64, cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ constructor(buffers, byteLength, options) {
+ super(options);
+ this.buffers = buffers;
+ this.byteLength = byteLength;
+ this.byteOffsetInCurrentBuffer = 0;
+ this.bufferIndex = 0;
+ this.pushedBytesLength = 0;
+ // check byteLength is no larger than buffers[] total length
+ let buffersLength = 0;
+ for (const buf of this.buffers) {
+ buffersLength += buf.byteLength;
}
- finally {
- span.end();
+ if (buffersLength < this.byteLength) {
+ throw new Error("Data size shouldn't be larger than the total length of buffers.");
}
}
/**
- * The Stage Block From URL operation creates a new block to be committed as part
- * of a blob where the contents are read from a URL.
- * This API is available starting in version 2018-03-28.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
+ * Internal _read() that will be called when the stream wants to pull more data in.
*
- * @param blockId - A 64-byte value that is base64-encoded
- * @param sourceURL - Specifies the URL of the blob. The value
- * may be a URL of up to 2 KB in length that specifies a blob.
- * The value should be URL-encoded as it would appear
- * in a request URI. The source blob must either be public
- * or must be authenticated via a shared access signature.
- * If the source blob is public, no authentication is required
- * to perform the operation. Here are some examples of source object URLs:
- * - https://myaccount.blob.core.windows.net/mycontainer/myblob
- * - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
- * @param offset - From which position of the blob to download, greater than or equal to 0
- * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
- * @param options - Options to the Block Blob Stage Block From URL operation.
- * @returns Response data for the Block Blob Stage Block From URL operation.
+ * @param size - Optional. The size of data to be read
*/
- async stageBlockFromURL(blockId, sourceURL, offset = 0, count, options = {}) {
- const { span, updatedOptions } = createSpan("BlockBlobClient-stageBlockFromURL", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.blockBlobContext.stageBlockFromURL(blockId, 0, sourceURL, Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, sourceContentMD5: options.sourceContentMD5, sourceContentCrc64: options.sourceContentCrc64, sourceRange: offset === 0 && !count ? undefined : rangeToString({ offset, count }), cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope, copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization) }, convertTracingToRequestOptionsBase(updatedOptions)));
+ _read(size) {
+ if (this.pushedBytesLength >= this.byteLength) {
+ this.push(null);
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (!size) {
+ size = this.readableHighWaterMark;
}
- finally {
- span.end();
+ const outBuffers = [];
+ let i = 0;
+ while (i < size && this.pushedBytesLength < this.byteLength) {
+ // The last buffer may be longer than the data it contains.
+ const remainingDataInAllBuffers = this.byteLength - this.pushedBytesLength;
+ const remainingCapacityInThisBuffer = this.buffers[this.bufferIndex].byteLength - this.byteOffsetInCurrentBuffer;
+ const remaining = Math.min(remainingCapacityInThisBuffer, remainingDataInAllBuffers);
+ if (remaining > size - i) {
+ // chunkSize = size - i
+ const end = this.byteOffsetInCurrentBuffer + size - i;
+ outBuffers.push(this.buffers[this.bufferIndex].slice(this.byteOffsetInCurrentBuffer, end));
+ this.pushedBytesLength += size - i;
+ this.byteOffsetInCurrentBuffer = end;
+ i = size;
+ break;
+ }
+ else {
+ // chunkSize = remaining
+ const end = this.byteOffsetInCurrentBuffer + remaining;
+ outBuffers.push(this.buffers[this.bufferIndex].slice(this.byteOffsetInCurrentBuffer, end));
+ if (remaining === remainingCapacityInThisBuffer) {
+ // this.buffers[this.bufferIndex] used up, shift to next one
+ this.byteOffsetInCurrentBuffer = 0;
+ this.bufferIndex++;
+ }
+ else {
+ this.byteOffsetInCurrentBuffer = end;
+ }
+ this.pushedBytesLength += remaining;
+ i += remaining;
+ }
+ }
+ if (outBuffers.length > 1) {
+ this.push(Buffer.concat(outBuffers));
+ }
+ else if (outBuffers.length === 1) {
+ this.push(outBuffers[0]);
}
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const maxBufferLength = buffer.constants.MAX_LENGTH;
+/**
+ * This class provides a buffer container which conceptually has no hard size limit.
+ * It accepts a capacity, an array of input buffers and the total length of input data.
+ * It will allocate an internal "buffer" of the capacity and fill the data in the input buffers
+ * into the internal "buffer" serially with respect to the total length.
+ * Then by calling PooledBuffer.getReadableStream(), you can get a readable stream
+ * assembled from all the data in the internal "buffer".
+ */
+class PooledBuffer {
/**
- * Writes a blob by specifying the list of block IDs that make up the blob.
- * In order to be written as part of a blob, a block must have been successfully written
- * to the server in a prior {@link stageBlock} operation. You can call {@link commitBlockList} to
- * update a blob by uploading only those blocks that have changed, then committing the new and existing
- * blocks together. Any blocks not specified in the block list and permanently deleted.
- * @see https://docs.microsoft.com/rest/api/storageservices/put-block-list
- *
- * @param blocks - Array of 64-byte value that is base64-encoded
- * @param options - Options to the Block Blob Commit Block List operation.
- * @returns Response data for the Block Blob Commit Block List operation.
+ * The size of the data contained in the pooled buffers.
*/
- async commitBlockList(blocks, options = {}) {
- var _a, _b, _c;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("BlockBlobClient-commitBlockList", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.blockBlobContext.commitBlockList({ latest: blocks }, Object.assign({ abortSignal: options.abortSignal, blobHttpHeaders: options.blobHTTPHeaders, leaseAccessConditions: options.conditions, metadata: options.metadata, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope, immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn, immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode, legalHold: options.legalHold, tier: toAccessTier(options.tier), blobTagsString: toBlobTagsString(options.tags) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ get size() {
+ return this._size;
+ }
+ constructor(capacity, buffers, totalLength) {
+ /**
+ * Internal buffers used to keep the data.
+ * Each buffer has a length of the maxBufferLength except last one.
+ */
+ this.buffers = [];
+ this.capacity = capacity;
+ this._size = 0;
+ // allocate
+ const bufferNum = Math.ceil(capacity / maxBufferLength);
+ for (let i = 0; i < bufferNum; i++) {
+ let len = i === bufferNum - 1 ? capacity % maxBufferLength : maxBufferLength;
+ if (len === 0) {
+ len = maxBufferLength;
+ }
+ this.buffers.push(Buffer.allocUnsafe(len));
}
- finally {
- span.end();
+ if (buffers) {
+ this.fill(buffers, totalLength);
}
}
/**
- * Returns the list of blocks that have been uploaded as part of a block blob
- * using the specified block list filter.
- * @see https://docs.microsoft.com/rest/api/storageservices/get-block-list
+ * Fill the internal buffers with data in the input buffers serially
+ * with respect to the total length and the total capacity of the internal buffers.
+ * Data copied will be shift out of the input buffers.
+ *
+ * @param buffers - Input buffers containing the data to be filled in the pooled buffer
+ * @param totalLength - Total length of the data to be filled in.
*
- * @param listType - Specifies whether to return the list of committed blocks,
- * the list of uncommitted blocks, or both lists together.
- * @param options - Options to the Block Blob Get Block List operation.
- * @returns Response data for the Block Blob Get Block List operation.
*/
- async getBlockList(listType, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlockBlobClient-getBlockList", options);
- try {
- const res = await this.blockBlobContext.getBlockList(listType, Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- if (!res.committedBlocks) {
- res.committedBlocks = [];
+ fill(buffers, totalLength) {
+ this._size = Math.min(this.capacity, totalLength);
+ let i = 0, j = 0, targetOffset = 0, sourceOffset = 0, totalCopiedNum = 0;
+ while (totalCopiedNum < this._size) {
+ const source = buffers[i];
+ const target = this.buffers[j];
+ const copiedNum = source.copy(target, targetOffset, sourceOffset);
+ totalCopiedNum += copiedNum;
+ sourceOffset += copiedNum;
+ targetOffset += copiedNum;
+ if (sourceOffset === source.length) {
+ i++;
+ sourceOffset = 0;
}
- if (!res.uncommittedBlocks) {
- res.uncommittedBlocks = [];
+ if (targetOffset === target.length) {
+ j++;
+ targetOffset = 0;
}
- return res;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
}
- finally {
- span.end();
+ // clear copied from source buffers
+ buffers.splice(0, i);
+ if (buffers.length > 0) {
+ buffers[0] = buffers[0].slice(sourceOffset);
}
}
- // High level functions
/**
- * Uploads a Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView object to a BlockBlob.
- *
- * When data length is no more than the specifiled {@link BlockBlobParallelUploadOptions.maxSingleShotSize} (default is
- * {@link BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES}), this method will use 1 {@link upload} call to finish the upload.
- * Otherwise, this method will call {@link stageBlock} to upload blocks, and finally call {@link commitBlockList}
- * to commit the block list.
+ * Get the readable stream assembled from all the data in the internal buffers.
*
- * A common {@link BlockBlobParallelUploadOptions.blobHTTPHeaders} option to set is
- * `blobContentType`, enabling the browser to provide
- * functionality based on file type.
+ */
+ getReadableStream() {
+ return new BuffersStream(this.buffers, this.size);
+ }
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * This class accepts a Node.js Readable stream as input, and keeps reading data
+ * from the stream into the internal buffer structure, until it reaches maxBuffers.
+ * Every available buffer will try to trigger outgoingHandler.
+ *
+ * The internal buffer structure includes an incoming buffer array, and a outgoing
+ * buffer array. The incoming buffer array includes the "empty" buffers can be filled
+ * with new incoming data. The outgoing array includes the filled buffers to be
+ * handled by outgoingHandler. Every above buffer size is defined by parameter bufferSize.
+ *
+ * NUM_OF_ALL_BUFFERS = BUFFERS_IN_INCOMING + BUFFERS_IN_OUTGOING + BUFFERS_UNDER_HANDLING
+ *
+ * NUM_OF_ALL_BUFFERS lesser than or equal to maxBuffers
+ *
+ * PERFORMANCE IMPROVEMENT TIPS:
+ * 1. Input stream highWaterMark is better to set a same value with bufferSize
+ * parameter, which will avoid Buffer.concat() operations.
+ * 2. concurrency should set a smaller value than maxBuffers, which is helpful to
+ * reduce the possibility when a outgoing handler waits for the stream data.
+ * in this situation, outgoing handlers are blocked.
+ * Outgoing queue shouldn't be empty.
+ */
+class BufferScheduler {
+ /**
+ * Creates an instance of BufferScheduler.
*
- * @param data - Buffer(Node.js), Blob, ArrayBuffer or ArrayBufferView
- * @param options -
+ * @param readable - A Node.js Readable stream
+ * @param bufferSize - Buffer size of every maintained buffer
+ * @param maxBuffers - How many buffers can be allocated
+ * @param outgoingHandler - An async function scheduled to be
+ * triggered when a buffer fully filled
+ * with stream data
+ * @param concurrency - Concurrency of executing outgoingHandlers (>0)
+ * @param encoding - [Optional] Encoding of Readable stream when it's a string stream
*/
- async uploadData(data, options = {}) {
- const { span, updatedOptions } = createSpan("BlockBlobClient-uploadData", options);
- try {
- if (coreHttp.isNode) {
- let buffer;
- if (data instanceof Buffer) {
- buffer = data;
- }
- else if (data instanceof ArrayBuffer) {
- buffer = Buffer.from(data);
- }
- else {
- data = data;
- buffer = Buffer.from(data.buffer, data.byteOffset, data.byteLength);
- }
- return this.uploadSeekableInternal((offset, size) => buffer.slice(offset, offset + size), buffer.byteLength, updatedOptions);
- }
- else {
- const browserBlob = new Blob([data]);
- return this.uploadSeekableInternal((offset, size) => browserBlob.slice(offset, offset + size), browserBlob.size, updatedOptions);
- }
+ constructor(readable, bufferSize, maxBuffers, outgoingHandler, concurrency, encoding) {
+ /**
+ * An internal event emitter.
+ */
+ this.emitter = new events.EventEmitter();
+ /**
+ * An internal offset marker to track data offset in bytes of next outgoingHandler.
+ */
+ this.offset = 0;
+ /**
+ * An internal marker to track whether stream is end.
+ */
+ this.isStreamEnd = false;
+ /**
+ * An internal marker to track whether stream or outgoingHandler returns error.
+ */
+ this.isError = false;
+ /**
+ * How many handlers are executing.
+ */
+ this.executingOutgoingHandlers = 0;
+ /**
+ * How many buffers have been allocated.
+ */
+ this.numBuffers = 0;
+ /**
+ * Because this class doesn't know how much data every time stream pops, which
+ * is defined by highWaterMarker of the stream. So BufferScheduler will cache
+ * data received from the stream, when data in unresolvedDataArray exceeds the
+ * blockSize defined, it will try to concat a blockSize of buffer, fill into available
+ * buffers from incoming and push to outgoing array.
+ */
+ this.unresolvedDataArray = [];
+ /**
+ * How much data consisted in unresolvedDataArray.
+ */
+ this.unresolvedLength = 0;
+ /**
+ * The array includes all the available buffers can be used to fill data from stream.
+ */
+ this.incoming = [];
+ /**
+ * The array (queue) includes all the buffers filled from stream data.
+ */
+ this.outgoing = [];
+ if (bufferSize <= 0) {
+ throw new RangeError(`bufferSize must be larger than 0, current is ${bufferSize}`);
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (maxBuffers <= 0) {
+ throw new RangeError(`maxBuffers must be larger than 0, current is ${maxBuffers}`);
}
- finally {
- span.end();
+ if (concurrency <= 0) {
+ throw new RangeError(`concurrency must be larger than 0, current is ${concurrency}`);
}
+ this.bufferSize = bufferSize;
+ this.maxBuffers = maxBuffers;
+ this.readable = readable;
+ this.outgoingHandler = outgoingHandler;
+ this.concurrency = concurrency;
+ this.encoding = encoding;
+ }
+ /**
+ * Start the scheduler, will return error when stream of any of the outgoingHandlers
+ * returns error.
+ *
+ */
+ async do() {
+ return new Promise((resolve, reject) => {
+ this.readable.on("data", (data) => {
+ data = typeof data === "string" ? Buffer.from(data, this.encoding) : data;
+ this.appendUnresolvedData(data);
+ if (!this.resolveData()) {
+ this.readable.pause();
+ }
+ });
+ this.readable.on("error", (err) => {
+ this.emitter.emit("error", err);
+ });
+ this.readable.on("end", () => {
+ this.isStreamEnd = true;
+ this.emitter.emit("checkEnd");
+ });
+ this.emitter.on("error", (err) => {
+ this.isError = true;
+ this.readable.pause();
+ reject(err);
+ });
+ this.emitter.on("checkEnd", () => {
+ if (this.outgoing.length > 0) {
+ this.triggerOutgoingHandlers();
+ return;
+ }
+ if (this.isStreamEnd && this.executingOutgoingHandlers === 0) {
+ if (this.unresolvedLength > 0 && this.unresolvedLength < this.bufferSize) {
+ const buffer = this.shiftBufferFromUnresolvedDataArray();
+ this.outgoingHandler(() => buffer.getReadableStream(), buffer.size, this.offset)
+ .then(resolve)
+ .catch(reject);
+ }
+ else if (this.unresolvedLength >= this.bufferSize) {
+ return;
+ }
+ else {
+ resolve();
+ }
+ }
+ });
+ });
}
/**
- * ONLY AVAILABLE IN BROWSERS.
- *
- * Uploads a browser Blob/File/ArrayBuffer/ArrayBufferView object to block blob.
- *
- * When buffer length lesser than or equal to 256MB, this method will use 1 upload call to finish the upload.
- * Otherwise, this method will call {@link stageBlock} to upload blocks, and finally call
- * {@link commitBlockList} to commit the block list.
- *
- * A common {@link BlockBlobParallelUploadOptions.blobHTTPHeaders} option to set is
- * `blobContentType`, enabling the browser to provide
- * functionality based on file type.
+ * Insert a new data into unresolved array.
*
- * @deprecated Use {@link uploadData} instead.
+ * @param data -
+ */
+ appendUnresolvedData(data) {
+ this.unresolvedDataArray.push(data);
+ this.unresolvedLength += data.length;
+ }
+ /**
+ * Try to shift a buffer with size in blockSize. The buffer returned may be less
+ * than blockSize when data in unresolvedDataArray is less than bufferSize.
*
- * @param browserData - Blob, File, ArrayBuffer or ArrayBufferView
- * @param options - Options to upload browser data.
- * @returns Response data for the Blob Upload operation.
*/
- async uploadBrowserData(browserData, options = {}) {
- const { span, updatedOptions } = createSpan("BlockBlobClient-uploadBrowserData", options);
- try {
- const browserBlob = new Blob([browserData]);
- return await this.uploadSeekableInternal((offset, size) => browserBlob.slice(offset, offset + size), browserBlob.size, updatedOptions);
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ shiftBufferFromUnresolvedDataArray(buffer) {
+ if (!buffer) {
+ buffer = new PooledBuffer(this.bufferSize, this.unresolvedDataArray, this.unresolvedLength);
}
- finally {
- span.end();
+ else {
+ buffer.fill(this.unresolvedDataArray, this.unresolvedLength);
}
+ this.unresolvedLength -= buffer.size;
+ return buffer;
}
/**
+ * Resolve data in unresolvedDataArray. For every buffer with size in blockSize
+ * shifted, it will try to get (or allocate a buffer) from incoming, and fill it,
+ * then push it into outgoing to be handled by outgoing handler.
*
- * Uploads data to block blob. Requires a bodyFactory as the data source,
- * which need to return a {@link HttpRequestBody} object with the offset and size provided.
- *
- * When data length is no more than the specified {@link BlockBlobParallelUploadOptions.maxSingleShotSize} (default is
- * {@link BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES}), this method will use 1 {@link upload} call to finish the upload.
- * Otherwise, this method will call {@link stageBlock} to upload blocks, and finally call {@link commitBlockList}
- * to commit the block list.
+ * Return false when available buffers in incoming are not enough, else true.
*
- * @param bodyFactory -
- * @param size - size of the data to upload.
- * @param options - Options to Upload to Block Blob operation.
- * @returns Response data for the Blob Upload operation.
+ * @returns Return false when buffers in incoming are not enough, else true.
*/
- async uploadSeekableInternal(bodyFactory, size, options = {}) {
- if (!options.blockSize) {
- options.blockSize = 0;
- }
- if (options.blockSize < 0 || options.blockSize > BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES) {
- throw new RangeError(`blockSize option must be >= 0 and <= ${BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES}`);
- }
- if (options.maxSingleShotSize !== 0 && !options.maxSingleShotSize) {
- options.maxSingleShotSize = BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES;
- }
- if (options.maxSingleShotSize < 0 ||
- options.maxSingleShotSize > BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES) {
- throw new RangeError(`maxSingleShotSize option must be >= 0 and <= ${BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES}`);
- }
- if (options.blockSize === 0) {
- if (size > BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES * BLOCK_BLOB_MAX_BLOCKS) {
- throw new RangeError(`${size} is too larger to upload to a block blob.`);
+ resolveData() {
+ while (this.unresolvedLength >= this.bufferSize) {
+ let buffer;
+ if (this.incoming.length > 0) {
+ buffer = this.incoming.shift();
+ this.shiftBufferFromUnresolvedDataArray(buffer);
}
- if (size > options.maxSingleShotSize) {
- options.blockSize = Math.ceil(size / BLOCK_BLOB_MAX_BLOCKS);
- if (options.blockSize < DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES) {
- options.blockSize = DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES;
+ else {
+ if (this.numBuffers < this.maxBuffers) {
+ buffer = this.shiftBufferFromUnresolvedDataArray();
+ this.numBuffers++;
+ }
+ else {
+ // No available buffer, wait for buffer returned
+ return false;
}
}
+ this.outgoing.push(buffer);
+ this.triggerOutgoingHandlers();
}
- if (!options.blobHTTPHeaders) {
- options.blobHTTPHeaders = {};
- }
- if (!options.conditions) {
- options.conditions = {};
- }
- const { span, updatedOptions } = createSpan("BlockBlobClient-uploadSeekableInternal", options);
- try {
- if (size <= options.maxSingleShotSize) {
- return await this.upload(bodyFactory(0, size), size, updatedOptions);
- }
- const numBlocks = Math.floor((size - 1) / options.blockSize) + 1;
- if (numBlocks > BLOCK_BLOB_MAX_BLOCKS) {
- throw new RangeError(`The buffer's size is too big or the BlockSize is too small;` +
- `the number of blocks must be <= ${BLOCK_BLOB_MAX_BLOCKS}`);
+ return true;
+ }
+ /**
+ * Try to trigger a outgoing handler for every buffer in outgoing. Stop when
+ * concurrency reaches.
+ */
+ async triggerOutgoingHandlers() {
+ let buffer;
+ do {
+ if (this.executingOutgoingHandlers >= this.concurrency) {
+ return;
}
- const blockList = [];
- const blockIDPrefix = coreHttp.generateUuid();
- let transferProgress = 0;
- const batch = new Batch(options.concurrency);
- for (let i = 0; i < numBlocks; i++) {
- batch.addOperation(async () => {
- const blockID = generateBlockID(blockIDPrefix, i);
- const start = options.blockSize * i;
- const end = i === numBlocks - 1 ? size : start + options.blockSize;
- const contentLength = end - start;
- blockList.push(blockID);
- await this.stageBlock(blockID, bodyFactory(start, contentLength), contentLength, {
- abortSignal: options.abortSignal,
- conditions: options.conditions,
- encryptionScope: options.encryptionScope,
- tracingOptions: updatedOptions.tracingOptions,
- });
- // Update progress after block is successfully uploaded to server, in case of block trying
- // TODO: Hook with convenience layer progress event in finer level
- transferProgress += contentLength;
- if (options.onProgress) {
- options.onProgress({
- loadedBytes: transferProgress,
- });
- }
- });
+ buffer = this.outgoing.shift();
+ if (buffer) {
+ this.triggerOutgoingHandler(buffer);
}
- await batch.do();
- return this.commitBlockList(blockList, updatedOptions);
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ } while (buffer);
}
/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * Uploads a local file in blocks to a block blob.
- *
- * When file size lesser than or equal to 256MB, this method will use 1 upload call to finish the upload.
- * Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList
- * to commit the block list.
+ * Trigger a outgoing handler for a buffer shifted from outgoing.
*
- * @param filePath - Full path of local file
- * @param options - Options to Upload to Block Blob operation.
- * @returns Response data for the Blob Upload operation.
+ * @param buffer -
*/
- async uploadFile(filePath, options = {}) {
- const { span, updatedOptions } = createSpan("BlockBlobClient-uploadFile", options);
+ async triggerOutgoingHandler(buffer) {
+ const bufferLength = buffer.size;
+ this.executingOutgoingHandlers++;
+ this.offset += bufferLength;
try {
- const size = (await fsStat(filePath)).size;
- return await this.uploadSeekableInternal((offset, count) => {
- return () => fsCreateReadStream(filePath, {
- autoClose: true,
- end: count ? offset + count - 1 : Infinity,
- start: offset,
- });
- }, size, Object.assign(Object.assign({}, options), { tracingOptions: Object.assign(Object.assign({}, options.tracingOptions), convertTracingToRequestOptionsBase(updatedOptions)) }));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ await this.outgoingHandler(() => buffer.getReadableStream(), bufferLength, this.offset - bufferLength);
}
- finally {
- span.end();
+ catch (err) {
+ this.emitter.emit("error", err);
+ return;
}
+ this.executingOutgoingHandlers--;
+ this.reuseBuffer(buffer);
+ this.emitter.emit("checkEnd");
}
/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * Uploads a Node.js Readable stream into block blob.
- *
- * PERFORMANCE IMPROVEMENT TIPS:
- * * Input stream highWaterMark is better to set a same value with bufferSize
- * parameter, which will avoid Buffer.concat() operations.
+ * Return buffer used by outgoing handler into incoming.
*
- * @param stream - Node.js Readable stream
- * @param bufferSize - Size of every buffer allocated, also the block size in the uploaded block blob. Default value is 8MB
- * @param maxConcurrency - Max concurrency indicates the max number of buffers that can be allocated,
- * positive correlation with max uploading concurrency. Default value is 5
- * @param options - Options to Upload Stream to Block Blob operation.
- * @returns Response data for the Blob Upload operation.
+ * @param buffer -
*/
- async uploadStream(stream, bufferSize = DEFAULT_BLOCK_BUFFER_SIZE_BYTES, maxConcurrency = 5, options = {}) {
- if (!options.blobHTTPHeaders) {
- options.blobHTTPHeaders = {};
- }
- if (!options.conditions) {
- options.conditions = {};
- }
- const { span, updatedOptions } = createSpan("BlockBlobClient-uploadStream", options);
- try {
- let blockNum = 0;
- const blockIDPrefix = coreHttp.generateUuid();
- let transferProgress = 0;
- const blockList = [];
- const scheduler = new BufferScheduler(stream, bufferSize, maxConcurrency, async (body, length) => {
- const blockID = generateBlockID(blockIDPrefix, blockNum);
- blockList.push(blockID);
- blockNum++;
- await this.stageBlock(blockID, body, length, {
- conditions: options.conditions,
- encryptionScope: options.encryptionScope,
- tracingOptions: updatedOptions.tracingOptions,
- });
- // Update progress after block is successfully uploaded to server, in case of block trying
- transferProgress += length;
- if (options.onProgress) {
- options.onProgress({ loadedBytes: transferProgress });
- }
- },
- // concurrency should set a smaller value than maxConcurrency, which is helpful to
- // reduce the possibility when a outgoing handler waits for stream data, in
- // this situation, outgoing handlers are blocked.
- // Outgoing queue shouldn't be empty.
- Math.ceil((maxConcurrency / 4) * 3));
- await scheduler.do();
- return await this.commitBlockList(blockList, Object.assign(Object.assign({}, options), { tracingOptions: Object.assign(Object.assign({}, options.tracingOptions), convertTracingToRequestOptionsBase(updatedOptions)) }));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
+ reuseBuffer(buffer) {
+ this.incoming.push(buffer);
+ if (!this.isError && this.resolveData() && !this.isStreamEnd) {
+ this.readable.resume();
}
}
}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * PageBlobClient defines a set of operations applicable to page blobs.
+ * Reads a readable stream into buffer. Fill the buffer from offset to end.
+ *
+ * @param stream - A Node.js Readable stream
+ * @param buffer - Buffer to be filled, length must greater than or equal to offset
+ * @param offset - From which position in the buffer to be filled, inclusive
+ * @param end - To which position in the buffer to be filled, exclusive
+ * @param encoding - Encoding of the Readable stream
*/
-class PageBlobClient extends BlobClient {
+async function streamToBuffer(stream, buffer, offset, end, encoding) {
+ let pos = 0; // Position in stream
+ const count = end - offset; // Total amount of data needed in stream
+ return new Promise((resolve, reject) => {
+ const timeout = setTimeout(() => reject(new Error(`The operation cannot be completed in timeout.`)), REQUEST_TIMEOUT);
+ stream.on("readable", () => {
+ if (pos >= count) {
+ clearTimeout(timeout);
+ resolve();
+ return;
+ }
+ let chunk = stream.read();
+ if (!chunk) {
+ return;
+ }
+ if (typeof chunk === "string") {
+ chunk = Buffer.from(chunk, encoding);
+ }
+ // How much data needed in this chunk
+ const chunkLength = pos + chunk.length > count ? count - pos : chunk.length;
+ buffer.fill(chunk.slice(0, chunkLength), offset + pos, offset + pos + chunkLength);
+ pos += chunkLength;
+ });
+ stream.on("end", () => {
+ clearTimeout(timeout);
+ if (pos < count) {
+ reject(new Error(`Stream drains before getting enough data needed. Data read: ${pos}, data need: ${count}`));
+ }
+ resolve();
+ });
+ stream.on("error", (msg) => {
+ clearTimeout(timeout);
+ reject(msg);
+ });
+ });
+}
+/**
+ * Reads a readable stream into buffer entirely.
+ *
+ * @param stream - A Node.js Readable stream
+ * @param buffer - Buffer to be filled, length must greater than or equal to offset
+ * @param encoding - Encoding of the Readable stream
+ * @returns with the count of bytes read.
+ * @throws `RangeError` If buffer size is not big enough.
+ */
+async function streamToBuffer2(stream, buffer, encoding) {
+ let pos = 0; // Position in stream
+ const bufferSize = buffer.length;
+ return new Promise((resolve, reject) => {
+ stream.on("readable", () => {
+ let chunk = stream.read();
+ if (!chunk) {
+ return;
+ }
+ if (typeof chunk === "string") {
+ chunk = Buffer.from(chunk, encoding);
+ }
+ if (pos + chunk.length > bufferSize) {
+ reject(new Error(`Stream exceeds buffer size. Buffer size: ${bufferSize}`));
+ return;
+ }
+ buffer.fill(chunk, pos, pos + chunk.length);
+ pos += chunk.length;
+ });
+ stream.on("end", () => {
+ resolve(pos);
+ });
+ stream.on("error", reject);
+ });
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Writes the content of a readstream to a local file. Returns a Promise which is completed after the file handle is closed.
+ *
+ * @param rs - The read stream.
+ * @param file - Destination file path.
+ */
+async function readStreamToLocalFile(rs, file) {
+ return new Promise((resolve, reject) => {
+ const ws = fs__namespace.createWriteStream(file);
+ rs.on("error", (err) => {
+ reject(err);
+ });
+ ws.on("error", (err) => {
+ reject(err);
+ });
+ ws.on("close", resolve);
+ rs.pipe(ws);
+ });
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Promisified version of fs.stat().
+ */
+const fsStat = util__namespace.promisify(fs__namespace.stat);
+const fsCreateReadStream = fs__namespace.createReadStream;
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * A BlobClient represents a URL to an Azure Storage blob; the blob may be a block blob,
+ * append blob, or page blob.
+ */
+class BlobClient extends StorageClient {
+ /**
+ * The name of the blob.
+ */
+ get name() {
+ return this._name;
+ }
+ /**
+ * The name of the storage container the blob is associated with.
+ */
+ get containerName() {
+ return this._containerName;
+ }
constructor(urlOrConnectionString, credentialOrPipelineOrContainerName, blobNameOrOptions,
// Legacy, no fix for eslint error without breaking. Disable it for this interface.
/* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
options) {
- // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead.
- // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options);
+ options = options || {};
let pipeline;
let url;
- options = options || {};
if (isPipelineLike(credentialOrPipelineOrContainerName)) {
// (url: string, pipeline: Pipeline)
url = urlOrConnectionString;
pipeline = credentialOrPipelineOrContainerName;
}
- else if ((coreHttp.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
+ else if ((coreUtil.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
- coreHttp.isTokenCredential(credentialOrPipelineOrContainerName)) {
+ coreAuth.isTokenCredential(credentialOrPipelineOrContainerName)) {
// (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
url = urlOrConnectionString;
options = blobNameOrOptions;
@@ -38485,1382 +27781,1758 @@ class PageBlobClient extends BlobClient {
else if (!credentialOrPipelineOrContainerName &&
typeof credentialOrPipelineOrContainerName !== "string") {
// (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
- // The second parameter is undefined. Use anonymous credential.
- url = urlOrConnectionString;
- pipeline = newPipeline(new AnonymousCredential(), options);
- }
- else if (credentialOrPipelineOrContainerName &&
- typeof credentialOrPipelineOrContainerName === "string" &&
- blobNameOrOptions &&
- typeof blobNameOrOptions === "string") {
- // (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
- const containerName = credentialOrPipelineOrContainerName;
- const blobName = blobNameOrOptions;
- const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
- if (extractedCreds.kind === "AccountConnString") {
- if (coreHttp.isNode) {
- const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
- url = appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName));
- if (!options.proxyOptions) {
- options.proxyOptions = coreHttp.getDefaultProxySettings(extractedCreds.proxyUri);
- }
- pipeline = newPipeline(sharedKeyCredential, options);
- }
- else {
- throw new Error("Account connection string is only supported in Node.js environment");
- }
- }
- else if (extractedCreds.kind === "SASConnString") {
- url =
- appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName)) +
- "?" +
- extractedCreds.accountSas;
- pipeline = newPipeline(new AnonymousCredential(), options);
- }
- else {
- throw new Error("Connection string must be either an Account connection string or a SAS connection string");
- }
- }
- else {
- throw new Error("Expecting non-empty strings for containerName and blobName parameters");
- }
- super(url, pipeline);
- this.pageBlobContext = new PageBlob(this.storageClientContext);
- }
- /**
- * Creates a new PageBlobClient object identical to the source but with the
- * specified snapshot timestamp.
- * Provide "" will remove the snapshot and return a Client to the base blob.
- *
- * @param snapshot - The snapshot timestamp.
- * @returns A new PageBlobClient object identical to the source but with the specified snapshot timestamp.
- */
- withSnapshot(snapshot) {
- return new PageBlobClient(setURLParameter(this.url, URLConstants.Parameters.SNAPSHOT, snapshot.length === 0 ? undefined : snapshot), this.pipeline);
- }
- /**
- * Creates a page blob of the specified length. Call uploadPages to upload data
- * data to a page blob.
- * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
- *
- * @param size - size of the page blob.
- * @param options - Options to the Page Blob Create operation.
- * @returns Response data for the Page Blob Create operation.
- */
- async create(size, options = {}) {
- var _a, _b, _c;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-create", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.pageBlobContext.create(0, size, Object.assign({ abortSignal: options.abortSignal, blobHttpHeaders: options.blobHTTPHeaders, blobSequenceNumber: options.blobSequenceNumber, leaseAccessConditions: options.conditions, metadata: options.metadata, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope, immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn, immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode, legalHold: options.legalHold, tier: toAccessTier(options.tier), blobTagsString: toBlobTagsString(options.tags) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
- /**
- * Creates a page blob of the specified length. Call uploadPages to upload data
- * data to a page blob. If the blob with the same name already exists, the content
- * of the existing blob will remain unchanged.
- * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
- *
- * @param size - size of the page blob.
- * @param options -
- */
- async createIfNotExists(size, options = {}) {
- var _a, _b;
- const { span, updatedOptions } = createSpan("PageBlobClient-createIfNotExists", options);
- try {
- const conditions = { ifNoneMatch: ETagAny };
- const res = await this.create(size, Object.assign(Object.assign({}, options), { conditions, tracingOptions: updatedOptions.tracingOptions }));
- return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
- }
- catch (e) {
- if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "BlobAlreadyExists") {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: "Expected exception when creating a blob only if it does not already exist.",
- });
- return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
- }
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
- /**
- * Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512.
- * @see https://docs.microsoft.com/rest/api/storageservices/put-page
- *
- * @param body - Data to upload
- * @param offset - Offset of destination page blob
- * @param count - Content length of the body, also number of bytes to be uploaded
- * @param options - Options to the Page Blob Upload Pages operation.
- * @returns Response data for the Page Blob Upload Pages operation.
- */
- async uploadPages(body, offset, count, options = {}) {
- var _a;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-uploadPages", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.pageBlobContext.uploadPages(count, body, Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), requestOptions: {
- onUploadProgress: options.onProgress,
- }, range: rangeToString({ offset, count }), sequenceNumberAccessConditions: options.conditions, transactionalContentMD5: options.transactionalContentMD5, transactionalContentCrc64: options.transactionalContentCrc64, cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
- /**
- * The Upload Pages operation writes a range of pages to a page blob where the
- * contents are read from a URL.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
- *
- * @param sourceURL - Specify a URL to the copy source, Shared Access Signature(SAS) maybe needed for authentication
- * @param sourceOffset - The source offset to copy from. Pass 0 to copy from the beginning of source page blob
- * @param destOffset - Offset of destination page blob
- * @param count - Number of bytes to be uploaded from source page blob
- * @param options -
- */
- async uploadPagesFromURL(sourceURL, sourceOffset, destOffset, count, options = {}) {
- var _a;
- options.conditions = options.conditions || {};
- options.sourceConditions = options.sourceConditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-uploadPagesFromURL", options);
- try {
- ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
- return await this.pageBlobContext.uploadPagesFromURL(sourceURL, rangeToString({ offset: sourceOffset, count }), 0, rangeToString({ offset: destOffset, count }), Object.assign({ abortSignal: options.abortSignal, sourceContentMD5: options.sourceContentMD5, sourceContentCrc64: options.sourceContentCrc64, leaseAccessConditions: options.conditions, sequenceNumberAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), sourceModifiedAccessConditions: {
- sourceIfMatch: options.sourceConditions.ifMatch,
- sourceIfModifiedSince: options.sourceConditions.ifModifiedSince,
- sourceIfNoneMatch: options.sourceConditions.ifNoneMatch,
- sourceIfUnmodifiedSince: options.sourceConditions.ifUnmodifiedSince,
- }, cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope, copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization) }, convertTracingToRequestOptionsBase(updatedOptions)));
+ // The second parameter is undefined. Use anonymous credential.
+ url = urlOrConnectionString;
+ if (blobNameOrOptions && typeof blobNameOrOptions !== "string") {
+ options = blobNameOrOptions;
+ }
+ pipeline = newPipeline(new AnonymousCredential(), options);
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ else if (credentialOrPipelineOrContainerName &&
+ typeof credentialOrPipelineOrContainerName === "string" &&
+ blobNameOrOptions &&
+ typeof blobNameOrOptions === "string") {
+ // (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
+ const containerName = credentialOrPipelineOrContainerName;
+ const blobName = blobNameOrOptions;
+ const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
+ if (extractedCreds.kind === "AccountConnString") {
+ if (coreUtil.isNode) {
+ const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
+ url = appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName));
+ if (!options.proxyOptions) {
+ options.proxyOptions = coreRestPipeline.getDefaultProxySettings(extractedCreds.proxyUri);
+ }
+ pipeline = newPipeline(sharedKeyCredential, options);
+ }
+ else {
+ throw new Error("Account connection string is only supported in Node.js environment");
+ }
+ }
+ else if (extractedCreds.kind === "SASConnString") {
+ url =
+ appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName)) +
+ "?" +
+ extractedCreds.accountSas;
+ pipeline = newPipeline(new AnonymousCredential(), options);
+ }
+ else {
+ throw new Error("Connection string must be either an Account connection string or a SAS connection string");
+ }
}
- finally {
- span.end();
+ else {
+ throw new Error("Expecting non-empty strings for containerName and blobName parameters");
}
+ super(url, pipeline);
+ ({ blobName: this._name, containerName: this._containerName } =
+ this.getBlobAndContainerNamesFromUrl());
+ this.blobContext = this.storageClientContext.blob;
+ this._snapshot = getURLParameter(this.url, URLConstants.Parameters.SNAPSHOT);
+ this._versionId = getURLParameter(this.url, URLConstants.Parameters.VERSIONID);
}
/**
- * Frees the specified pages from the page blob.
- * @see https://docs.microsoft.com/rest/api/storageservices/put-page
+ * Creates a new BlobClient object identical to the source but with the specified snapshot timestamp.
+ * Provide "" will remove the snapshot and return a Client to the base blob.
*
- * @param offset - Starting byte position of the pages to clear.
- * @param count - Number of bytes to clear.
- * @param options - Options to the Page Blob Clear Pages operation.
- * @returns Response data for the Page Blob Clear Pages operation.
+ * @param snapshot - The snapshot timestamp.
+ * @returns A new BlobClient object identical to the source but with the specified snapshot timestamp
*/
- async clearPages(offset = 0, count, options = {}) {
- var _a;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-clearPages", options);
- try {
- return await this.pageBlobContext.clearPages(0, Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), range: rangeToString({ offset, count }), sequenceNumberAccessConditions: options.conditions, cpkInfo: options.customerProvidedKey, encryptionScope: options.encryptionScope }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ withSnapshot(snapshot) {
+ return new BlobClient(setURLParameter(this.url, URLConstants.Parameters.SNAPSHOT, snapshot.length === 0 ? undefined : snapshot), this.pipeline);
}
/**
- * Returns the list of valid page ranges for a page blob or snapshot of a page blob.
- * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+ * Creates a new BlobClient object pointing to a version of this blob.
+ * Provide "" will remove the versionId and return a Client to the base blob.
*
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param options - Options to the Page Blob Get Ranges operation.
- * @returns Response data for the Page Blob Get Ranges operation.
+ * @param versionId - The versionId.
+ * @returns A new BlobClient object pointing to the version of this blob.
*/
- async getPageRanges(offset = 0, count, options = {}) {
- var _a;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-getPageRanges", options);
- try {
- return await this.pageBlobContext
- .getPageRanges(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), range: rangeToString({ offset, count }) }, convertTracingToRequestOptionsBase(updatedOptions)))
- .then(rangeResponseFromModel);
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ withVersion(versionId) {
+ return new BlobClient(setURLParameter(this.url, URLConstants.Parameters.VERSIONID, versionId.length === 0 ? undefined : versionId), this.pipeline);
}
/**
- * getPageRangesSegment returns a single segment of page ranges starting from the
- * specified Marker. Use an empty Marker to start enumeration from the beginning.
- * After getting a segment, process it, and then call getPageRangesSegment again
- * (passing the the previously-returned Marker) to get the next segment.
- * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+ * Creates a AppendBlobClient object.
*
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
- * @param options - Options to PageBlob Get Page Ranges Segment operation.
*/
- async listPageRangesSegment(offset = 0, count, marker, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("PageBlobClient-getPageRangesSegment", options);
- try {
- return await this.pageBlobContext.getPageRanges(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), range: rangeToString({ offset, count }), marker: marker, maxPageSize: options.maxPageSize }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ getAppendBlobClient() {
+ return new AppendBlobClient(this.url, this.pipeline);
}
/**
- * Returns an AsyncIterableIterator for {@link PageBlobGetPageRangesResponseModel}
+ * Creates a BlockBlobClient object.
*
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param marker - A string value that identifies the portion of
- * the get of page ranges to be returned with the next getting operation. The
- * operation returns the ContinuationToken value within the response body if the
- * getting operation did not return all page ranges remaining within the current page.
- * The ContinuationToken value can be used as the value for
- * the marker parameter in a subsequent call to request the next page of get
- * items. The marker value is opaque to the client.
- * @param options - Options to List Page Ranges operation.
*/
- listPageRangeItemSegments(offset = 0, count, marker, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* listPageRangeItemSegments_1() {
- let getPageRangeItemSegmentsResponse;
- if (!!marker || marker === undefined) {
- do {
- getPageRangeItemSegmentsResponse = yield tslib.__await(this.listPageRangesSegment(offset, count, marker, options));
- marker = getPageRangeItemSegmentsResponse.continuationToken;
- yield yield tslib.__await(yield tslib.__await(getPageRangeItemSegmentsResponse));
- } while (marker);
- }
- });
+ getBlockBlobClient() {
+ return new BlockBlobClient(this.url, this.pipeline);
}
/**
- * Returns an AsyncIterableIterator of {@link PageRangeInfo} objects
+ * Creates a PageBlobClient object.
*
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param options - Options to List Page Ranges operation.
*/
- listPageRangeItems(offset = 0, count, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* listPageRangeItems_1() {
- var e_1, _a;
- let marker;
- try {
- for (var _b = tslib.__asyncValues(this.listPageRangeItemSegments(offset, count, marker, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
- const getPageRangesSegment = _c.value;
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(ExtractPageRangeInfoItems(getPageRangesSegment))));
- }
- }
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
- finally {
- try {
- if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
- }
- finally { if (e_1) throw e_1.error; }
- }
- });
+ getPageBlobClient() {
+ return new PageBlobClient(this.url, this.pipeline);
}
/**
- * Returns an async iterable iterator to list of page ranges for a page blob.
- * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+ * Reads or downloads a blob from the system, including its metadata and properties.
+ * You can also call Get Blob to read a snapshot.
*
- * .byPage() returns an async iterable iterator to list of page ranges for a page blob.
+ * * In Node.js, data returns in a Readable stream readableStreamBody
+ * * In browsers, data returns in a promise blobBody
*
- * Example using `for await` syntax:
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob
*
- * ```js
- * // Get the pageBlobClient before you run these snippets,
- * // Can be obtained from `blobServiceClient.getContainerClient("").getPageBlobClient("");`
- * let i = 1;
- * for await (const pageRange of pageBlobClient.listPageRanges()) {
- * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
- * }
- * ```
+ * @param offset - From which position of the blob to download, greater than or equal to 0
+ * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
+ * @param options - Optional options to Blob Download operation.
*
- * Example using `iter.next()`:
+ *
+ * Example usage (Node.js):
*
* ```js
- * let i = 1;
- * let iter = pageBlobClient.listPageRanges();
- * let pageRangeItem = await iter.next();
- * while (!pageRangeItem.done) {
- * console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
- * pageRangeItem = await iter.next();
+ * // Download and convert a blob to a string
+ * const downloadBlockBlobResponse = await blobClient.download();
+ * const downloaded = await streamToBuffer(downloadBlockBlobResponse.readableStreamBody);
+ * console.log("Downloaded blob content:", downloaded.toString());
+ *
+ * async function streamToBuffer(readableStream) {
+ * return new Promise((resolve, reject) => {
+ * const chunks = [];
+ * readableStream.on("data", (data) => {
+ * chunks.push(data instanceof Buffer ? data : Buffer.from(data));
+ * });
+ * readableStream.on("end", () => {
+ * resolve(Buffer.concat(chunks));
+ * });
+ * readableStream.on("error", reject);
+ * });
* }
* ```
*
- * Example using `byPage()`:
+ * Example usage (browser):
*
* ```js
- * // passing optional maxPageSize in the page settings
- * let i = 1;
- * for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
- * for (const pageRange of response) {
- * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
- * }
+ * // Download and convert a blob to a string
+ * const downloadBlockBlobResponse = await blobClient.download();
+ * const downloaded = await blobToString(await downloadBlockBlobResponse.blobBody);
+ * console.log(
+ * "Downloaded blob content",
+ * downloaded
+ * );
+ *
+ * async function blobToString(blob: Blob): Promise {
+ * const fileReader = new FileReader();
+ * return new Promise((resolve, reject) => {
+ * fileReader.onloadend = (ev: any) => {
+ * resolve(ev.target!.result);
+ * };
+ * fileReader.onerror = reject;
+ * fileReader.readAsText(blob);
+ * });
* }
* ```
+ */
+ async download(offset = 0, count, options = {}) {
+ options.conditions = options.conditions || {};
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlobClient-download", options, async (updatedOptions) => {
+ var _a;
+ const res = assertResponse(await this.blobContext.download({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ requestOptions: {
+ onDownloadProgress: coreUtil.isNode ? undefined : options.onProgress, // for Node.js, progress is reported by RetriableReadableStream
+ },
+ range: offset === 0 && !count ? undefined : rangeToString({ offset, count }),
+ rangeGetContentMD5: options.rangeGetContentMD5,
+ rangeGetContentCRC64: options.rangeGetContentCrc64,
+ snapshot: options.snapshot,
+ cpkInfo: options.customerProvidedKey,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ const wrappedRes = Object.assign(Object.assign({}, res), { _response: res._response, objectReplicationDestinationPolicyId: res.objectReplicationPolicyId, objectReplicationSourceProperties: parseObjectReplicationRecord(res.objectReplicationRules) });
+ // Return browser response immediately
+ if (!coreUtil.isNode) {
+ return wrappedRes;
+ }
+ // We support retrying when download stream unexpected ends in Node.js runtime
+ // Following code shouldn't be bundled into browser build, however some
+ // bundlers may try to bundle following code and "FileReadResponse.ts".
+ // In this case, "FileDownloadResponse.browser.ts" will be used as a shim of "FileDownloadResponse.ts"
+ // The config is in package.json "browser" field
+ if (options.maxRetryRequests === undefined || options.maxRetryRequests < 0) {
+ // TODO: Default value or make it a required parameter?
+ options.maxRetryRequests = DEFAULT_MAX_DOWNLOAD_RETRY_REQUESTS;
+ }
+ if (res.contentLength === undefined) {
+ throw new RangeError(`File download response doesn't contain valid content length header`);
+ }
+ if (!res.etag) {
+ throw new RangeError(`File download response doesn't contain valid etag header`);
+ }
+ return new BlobDownloadResponse(wrappedRes, async (start) => {
+ var _a;
+ const updatedDownloadOptions = {
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: {
+ ifMatch: options.conditions.ifMatch || res.etag,
+ ifModifiedSince: options.conditions.ifModifiedSince,
+ ifNoneMatch: options.conditions.ifNoneMatch,
+ ifUnmodifiedSince: options.conditions.ifUnmodifiedSince,
+ ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions,
+ },
+ range: rangeToString({
+ count: offset + res.contentLength - start,
+ offset: start,
+ }),
+ rangeGetContentMD5: options.rangeGetContentMD5,
+ rangeGetContentCRC64: options.rangeGetContentCrc64,
+ snapshot: options.snapshot,
+ cpkInfo: options.customerProvidedKey,
+ };
+ // Debug purpose only
+ // console.log(
+ // `Read from internal stream, range: ${
+ // updatedOptions.range
+ // }, options: ${JSON.stringify(updatedOptions)}`
+ // );
+ return (await this.blobContext.download(Object.assign({ abortSignal: options.abortSignal }, updatedDownloadOptions))).readableStreamBody;
+ }, offset, res.contentLength, {
+ maxRetryRequests: options.maxRetryRequests,
+ onProgress: options.onProgress,
+ });
+ });
+ }
+ /**
+ * Returns true if the Azure blob resource represented by this client exists; false otherwise.
*
- * Example using paging with a marker:
+ * NOTE: use this function with care since an existing blob might be deleted by other clients or
+ * applications. Vice versa new blobs might be added by other clients or applications after this
+ * function completes.
*
- * ```js
- * let i = 1;
- * let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
- * let response = (await iterator.next()).value;
+ * @param options - options to Exists operation.
+ */
+ async exists(options = {}) {
+ return tracingClient.withSpan("BlobClient-exists", options, async (updatedOptions) => {
+ try {
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ await this.getProperties({
+ abortSignal: options.abortSignal,
+ customerProvidedKey: options.customerProvidedKey,
+ conditions: options.conditions,
+ tracingOptions: updatedOptions.tracingOptions,
+ });
+ return true;
+ }
+ catch (e) {
+ if (e.statusCode === 404) {
+ // Expected exception when checking blob existence
+ return false;
+ }
+ else if (e.statusCode === 409 &&
+ (e.details.errorCode === BlobUsesCustomerSpecifiedEncryptionMsg ||
+ e.details.errorCode === BlobDoesNotUseCustomerSpecifiedEncryption)) {
+ // Expected exception when checking blob existence
+ return true;
+ }
+ throw e;
+ }
+ });
+ }
+ /**
+ * Returns all user-defined metadata, standard HTTP properties, and system properties
+ * for the blob. It does not return the content of the blob.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties
*
- * // Prints 2 page ranges
- * for (const pageRange of response) {
- * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
- * }
+ * 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 methods of {@link ContainerClient} that list blobs using the `includeMetadata` option, which
+ * will retain their original casing.
*
- * // Gets next marker
- * let marker = response.continuationToken;
+ * @param options - Optional options to Get Properties operation.
+ */
+ async getProperties(options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlobClient-getProperties", options, async (updatedOptions) => {
+ var _a;
+ const res = assertResponse(await this.blobContext.getProperties({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ cpkInfo: options.customerProvidedKey,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ return Object.assign(Object.assign({}, res), { _response: res._response, objectReplicationDestinationPolicyId: res.objectReplicationPolicyId, objectReplicationSourceProperties: parseObjectReplicationRecord(res.objectReplicationRules) });
+ });
+ }
+ /**
+ * Marks the specified blob or snapshot for deletion. The blob is later deleted
+ * during garbage collection. Note that in order to delete a blob, you must delete
+ * all of its snapshots. You can delete both at the same time with the Delete
+ * Blob operation.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
*
- * // Passing next marker as continuationToken
+ * @param options - Optional options to Blob Delete operation.
+ */
+ async delete(options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("BlobClient-delete", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.blobContext.delete({
+ abortSignal: options.abortSignal,
+ deleteSnapshots: options.deleteSnapshots,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Marks the specified blob or snapshot for deletion if it exists. The blob is later deleted
+ * during garbage collection. Note that in order to delete a blob, you must delete
+ * all of its snapshots. You can delete both at the same time with the Delete
+ * Blob operation.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
*
- * iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
- * response = (await iterator.next()).value;
+ * @param options - Optional options to Blob Delete operation.
+ */
+ async deleteIfExists(options = {}) {
+ return tracingClient.withSpan("BlobClient-deleteIfExists", options, async (updatedOptions) => {
+ var _a, _b;
+ try {
+ const res = assertResponse(await this.delete(updatedOptions));
+ return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
+ }
+ catch (e) {
+ if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "BlobNotFound") {
+ return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+ }
+ throw e;
+ }
+ });
+ }
+ /**
+ * Restores the contents and metadata of soft deleted blob and any associated
+ * soft deleted snapshots. Undelete Blob is supported only on version 2017-07-29
+ * or later.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/undelete-blob
*
- * // Prints 10 page ranges
- * for (const blob of response) {
- * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
- * }
- * ```
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param options - Options to the Page Blob Get Ranges operation.
- * @returns An asyncIterableIterator that supports paging.
+ * @param options - Optional options to Blob Undelete operation.
*/
- listPageRanges(offset = 0, count, options = {}) {
+ async undelete(options = {}) {
+ return tracingClient.withSpan("BlobClient-undelete", options, async (updatedOptions) => {
+ return assertResponse(await this.blobContext.undelete({
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Sets system properties on the blob.
+ *
+ * If no value provided, or no value provided for the specified blob HTTP headers,
+ * these blob HTTP headers without a value will be cleared.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
+ *
+ * @param blobHTTPHeaders - If no value provided, or no value provided for
+ * the specified blob HTTP headers, these blob HTTP
+ * headers without a value will be cleared.
+ * A common header to set is `blobContentType`
+ * enabling the browser to provide functionality
+ * based on file type.
+ * @param options - Optional options to Blob Set HTTP Headers operation.
+ */
+ async setHTTPHeaders(blobHTTPHeaders, options = {}) {
options.conditions = options.conditions || {};
- // AsyncIterableIterator to iterate over blobs
- const iter = this.listPageRangeItems(offset, count, options);
- return {
- /**
- * The next method, part of the iteration protocol
- */
- next() {
- return iter.next();
- },
- /**
- * The connection to the async iterator, part of the iteration protocol
- */
- [Symbol.asyncIterator]() {
- return this;
- },
- /**
- * Return an AsyncIterableIterator that works a page at a time
- */
- byPage: (settings = {}) => {
- return this.listPageRangeItemSegments(offset, count, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, options));
- },
- };
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlobClient-setHTTPHeaders", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.blobContext.setHttpHeaders({
+ abortSignal: options.abortSignal,
+ blobHttpHeaders: blobHTTPHeaders,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ // cpkInfo: options.customerProvidedKey, // CPK is not included in Swagger, should change this back when this issue is fixed in Swagger.
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Gets the collection of page ranges that differ between a specified snapshot and this page blob.
- * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+ * Sets user-defined metadata for the specified blob as one or more name-value pairs.
*
- * @param offset - Starting byte position of the page blob
- * @param count - Number of bytes to get ranges diff.
- * @param prevSnapshot - Timestamp of snapshot to retrieve the difference.
- * @param options - Options to the Page Blob Get Page Ranges Diff operation.
- * @returns Response data for the Page Blob Get Page Range Diff operation.
+ * If no option provided, or no metadata defined in the parameter, the blob
+ * metadata will be removed.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata
+ *
+ * @param metadata - Replace existing metadata with this value.
+ * If no value provided the existing metadata will be removed.
+ * @param options - Optional options to Set Metadata operation.
*/
- async getPageRangesDiff(offset, count, prevSnapshot, options = {}) {
- var _a;
+ async setMetadata(metadata, options = {}) {
options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-getPageRangesDiff", options);
- try {
- return await this.pageBlobContext
- .getPageRangesDiff(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), prevsnapshot: prevSnapshot, range: rangeToString({ offset, count }) }, convertTracingToRequestOptionsBase(updatedOptions)))
- .then(rangeResponseFromModel);
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlobClient-setMetadata", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.blobContext.setMetadata({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ metadata,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * getPageRangesDiffSegment returns a single segment of page ranges starting from the
- * specified Marker for difference between previous snapshot and the target page blob.
- * Use an empty Marker to start enumeration from the beginning.
- * After getting a segment, process it, and then call getPageRangesDiffSegment again
- * (passing the the previously-returned Marker) to get the next segment.
- * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+ * Sets tags on the underlying blob.
+ * A blob can have up to 10 tags. Tag keys must be between 1 and 128 characters. Tag values must be between 0 and 256 characters.
+ * Valid tag key and value characters include lower and upper case letters, digits (0-9),
+ * space (' '), plus ('+'), minus ('-'), period ('.'), foward slash ('/'), colon (':'), equals ('='), and underscore ('_').
*
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param prevSnapshotOrUrl - Timestamp of snapshot to retrieve the difference or URL of snapshot to retrieve the difference.
- * @param marker - A string value that identifies the portion of the get to be returned with the next get operation.
- * @param options - Options to the Page Blob Get Page Ranges Diff operation.
+ * @param tags -
+ * @param options -
*/
- async listPageRangesDiffSegment(offset, count, prevSnapshotOrUrl, marker, options) {
- var _a;
- const { span, updatedOptions } = createSpan("PageBlobClient-getPageRangesDiffSegment", options);
- try {
- return await this.pageBlobContext.getPageRangesDiff(Object.assign({ abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal, leaseAccessConditions: options === null || options === void 0 ? void 0 : options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.conditions), { ifTags: (_a = options === null || options === void 0 ? void 0 : options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), prevsnapshot: prevSnapshotOrUrl, range: rangeToString({
- offset: offset,
- count: count,
- }), marker: marker, maxPageSize: options === null || options === void 0 ? void 0 : options.maxPageSize }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ async setTags(tags, options = {}) {
+ return tracingClient.withSpan("BlobClient-setTags", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.blobContext.setTags({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ tags: toBlobTags(tags),
+ }));
+ });
}
/**
- * Returns an AsyncIterableIterator for {@link PageBlobGetPageRangesDiffResponseModel}
- *
+ * Gets the tags associated with the underlying blob.
*
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param prevSnapshotOrUrl - Timestamp of snapshot to retrieve the difference or URL of snapshot to retrieve the difference.
- * @param marker - A string value that identifies the portion of
- * the get of page ranges to be returned with the next getting operation. The
- * operation returns the ContinuationToken value within the response body if the
- * getting operation did not return all page ranges remaining within the current page.
- * The ContinuationToken value can be used as the value for
- * the marker parameter in a subsequent call to request the next page of get
- * items. The marker value is opaque to the client.
- * @param options - Options to the Page Blob Get Page Ranges Diff operation.
+ * @param options -
*/
- listPageRangeDiffItemSegments(offset, count, prevSnapshotOrUrl, marker, options) {
- return tslib.__asyncGenerator(this, arguments, function* listPageRangeDiffItemSegments_1() {
- let getPageRangeItemSegmentsResponse;
- if (!!marker || marker === undefined) {
- do {
- getPageRangeItemSegmentsResponse = yield tslib.__await(this.listPageRangesDiffSegment(offset, count, prevSnapshotOrUrl, marker, options));
- marker = getPageRangeItemSegmentsResponse.continuationToken;
- yield yield tslib.__await(yield tslib.__await(getPageRangeItemSegmentsResponse));
- } while (marker);
- }
+ async getTags(options = {}) {
+ return tracingClient.withSpan("BlobClient-getTags", options, async (updatedOptions) => {
+ var _a;
+ const response = assertResponse(await this.blobContext.getTags({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ const wrappedResponse = Object.assign(Object.assign({}, response), { _response: response._response, tags: toTags({ blobTagSet: response.blobTagSet }) || {} });
+ return wrappedResponse;
});
}
/**
- * Returns an AsyncIterableIterator of {@link PageRangeInfo} objects
+ * Get a {@link BlobLeaseClient} that manages leases on the blob.
*
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param prevSnapshotOrUrl - Timestamp of snapshot to retrieve the difference or URL of snapshot to retrieve the difference.
- * @param options - Options to the Page Blob Get Page Ranges Diff operation.
+ * @param proposeLeaseId - Initial proposed lease Id.
+ * @returns A new BlobLeaseClient object for managing leases on the blob.
*/
- listPageRangeDiffItems(offset, count, prevSnapshotOrUrl, options) {
- return tslib.__asyncGenerator(this, arguments, function* listPageRangeDiffItems_1() {
- var e_2, _a;
- let marker;
- try {
- for (var _b = tslib.__asyncValues(this.listPageRangeDiffItemSegments(offset, count, prevSnapshotOrUrl, marker, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
- const getPageRangesSegment = _c.value;
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(ExtractPageRangeInfoItems(getPageRangesSegment))));
- }
- }
- catch (e_2_1) { e_2 = { error: e_2_1 }; }
- finally {
- try {
- if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
- }
- finally { if (e_2) throw e_2.error; }
- }
+ getBlobLeaseClient(proposeLeaseId) {
+ return new BlobLeaseClient(this, proposeLeaseId);
+ }
+ /**
+ * Creates a read-only snapshot of a blob.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/snapshot-blob
+ *
+ * @param options - Optional options to the Blob Create Snapshot operation.
+ */
+ async createSnapshot(options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlobClient-createSnapshot", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.blobContext.createSnapshot({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ metadata: options.metadata,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
});
}
/**
- * Returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
- * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+ * Asynchronously copies a blob to a destination within the storage account.
+ * This method returns a long running operation poller that allows you to wait
+ * indefinitely until the copy is completed.
+ * You can also cancel a copy before it is completed by calling `cancelOperation` on the poller.
+ * Note that the onProgress callback will not be invoked if the operation completes in the first
+ * request, and attempting to cancel a completed copy will result in an error being thrown.
*
- * .byPage() returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
+ * In version 2012-02-12 and later, the source for a Copy Blob operation can be
+ * a committed blob in any Azure storage account.
+ * Beginning with version 2015-02-21, the source for a Copy Blob operation can be
+ * an Azure file in any Azure storage account.
+ * Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
+ * operation to copy from another storage account.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
*
- * Example using `for await` syntax:
+ * Example using automatic polling:
*
* ```js
- * // Get the pageBlobClient before you run these snippets,
- * // Can be obtained from `blobServiceClient.getContainerClient("").getPageBlobClient("");`
- * let i = 1;
- * for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
- * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
- * }
+ * const copyPoller = await blobClient.beginCopyFromURL('url');
+ * const result = await copyPoller.pollUntilDone();
* ```
*
- * Example using `iter.next()`:
+ * Example using manual polling:
*
* ```js
- * let i = 1;
- * let iter = pageBlobClient.listPageRangesDiff();
- * let pageRangeItem = await iter.next();
- * while (!pageRangeItem.done) {
- * console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
- * pageRangeItem = await iter.next();
+ * const copyPoller = await blobClient.beginCopyFromURL('url');
+ * while (!poller.isDone()) {
+ * await poller.poll();
* }
+ * const result = copyPoller.getResult();
* ```
*
- * Example using `byPage()`:
+ * Example using progress updates:
*
* ```js
- * // passing optional maxPageSize in the page settings
- * let i = 1;
- * for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
- * for (const pageRange of response) {
- * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * const copyPoller = await blobClient.beginCopyFromURL('url', {
+ * onProgress(state) {
+ * console.log(`Progress: ${state.copyProgress}`);
* }
- * }
+ * });
+ * const result = await copyPoller.pollUntilDone();
* ```
*
- * Example using paging with a marker:
+ * Example using a changing polling interval (default 15 seconds):
*
* ```js
- * let i = 1;
- * let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
- * let response = (await iterator.next()).value;
- *
- * // Prints 2 page ranges
- * for (const pageRange of response) {
- * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
- * }
- *
- * // Gets next marker
- * let marker = response.continuationToken;
- *
- * // Passing next marker as continuationToken
+ * const copyPoller = await blobClient.beginCopyFromURL('url', {
+ * intervalInMs: 1000 // poll blob every 1 second for copy progress
+ * });
+ * const result = await copyPoller.pollUntilDone();
+ * ```
*
- * iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
- * response = (await iterator.next()).value;
+ * Example using copy cancellation:
*
- * // Prints 10 page ranges
- * for (const blob of response) {
- * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * ```js
+ * const copyPoller = await blobClient.beginCopyFromURL('url');
+ * // cancel operation after starting it.
+ * try {
+ * await copyPoller.cancelOperation();
+ * // calls to get the result now throw PollerCancelledError
+ * await copyPoller.getResult();
+ * } catch (err) {
+ * if (err.name === 'PollerCancelledError') {
+ * console.log('The copy was cancelled.');
+ * }
* }
* ```
- * @param offset - Starting byte position of the page ranges.
- * @param count - Number of bytes to get.
- * @param prevSnapshot - Timestamp of snapshot to retrieve the difference.
- * @param options - Options to the Page Blob Get Ranges operation.
- * @returns An asyncIterableIterator that supports paging.
+ *
+ * @param copySource - url to the source Azure Blob/File.
+ * @param options - Optional options to the Blob Start Copy From URL operation.
*/
- listPageRangesDiff(offset, count, prevSnapshot, options = {}) {
- options.conditions = options.conditions || {};
- // AsyncIterableIterator to iterate over blobs
- const iter = this.listPageRangeDiffItems(offset, count, prevSnapshot, Object.assign({}, options));
- return {
- /**
- * The next method, part of the iteration protocol
- */
- next() {
- return iter.next();
- },
- /**
- * The connection to the async iterator, part of the iteration protocol
- */
- [Symbol.asyncIterator]() {
- return this;
- },
- /**
- * Return an AsyncIterableIterator that works a page at a time
- */
- byPage: (settings = {}) => {
- return this.listPageRangeDiffItemSegments(offset, count, prevSnapshot, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, options));
- },
+ async beginCopyFromURL(copySource, options = {}) {
+ const client = {
+ abortCopyFromURL: (...args) => this.abortCopyFromURL(...args),
+ getProperties: (...args) => this.getProperties(...args),
+ startCopyFromURL: (...args) => this.startCopyFromURL(...args),
};
+ const poller = new BlobBeginCopyFromUrlPoller({
+ blobClient: client,
+ copySource,
+ intervalInMs: options.intervalInMs,
+ onProgress: options.onProgress,
+ resumeFrom: options.resumeFrom,
+ startCopyFromURLOptions: options,
+ });
+ // Trigger the startCopyFromURL call by calling poll.
+ // Any errors from this method should be surfaced to the user.
+ await poller.poll();
+ return poller;
}
/**
- * Gets the collection of page ranges that differ between a specified snapshot and this page blob for managed disks.
- * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+ * Aborts a pending asynchronous Copy Blob operation, and leaves a destination blob with zero
+ * length and full metadata. Version 2012-02-12 and newer.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-blob
*
- * @param offset - Starting byte position of the page blob
- * @param count - Number of bytes to get ranges diff.
- * @param prevSnapshotUrl - URL of snapshot to retrieve the difference.
- * @param options - Options to the Page Blob Get Page Ranges Diff operation.
- * @returns Response data for the Page Blob Get Page Range Diff operation.
+ * @param copyId - Id of the Copy From URL operation.
+ * @param options - Optional options to the Blob Abort Copy From URL operation.
*/
- async getPageRangesDiffForManagedDisks(offset, count, prevSnapshotUrl, options = {}) {
- var _a;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-GetPageRangesDiffForManagedDisks", options);
- try {
- return await this.pageBlobContext
- .getPageRangesDiff(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), prevSnapshotUrl, range: rangeToString({ offset, count }) }, convertTracingToRequestOptionsBase(updatedOptions)))
- .then(rangeResponseFromModel);
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ async abortCopyFromURL(copyId, options = {}) {
+ return tracingClient.withSpan("BlobClient-abortCopyFromURL", options, async (updatedOptions) => {
+ return assertResponse(await this.blobContext.abortCopyFromURL(copyId, {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Resizes the page blob to the specified size (which must be a multiple of 512).
- * @see https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
+ * The synchronous Copy From URL operation copies a blob or an internet resource to a new blob. It will not
+ * return a response until the copy is complete.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob-from-url
*
- * @param size - Target size
- * @param options - Options to the Page Blob Resize operation.
- * @returns Response data for the Page Blob Resize operation.
+ * @param copySource - The source URL to copy from, Shared Access Signature(SAS) maybe needed for authentication
+ * @param options -
*/
- async resize(size, options = {}) {
- var _a;
+ async syncCopyFromURL(copySource, options = {}) {
options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-resize", options);
- try {
- return await this.pageBlobContext.resize(size, Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), encryptionScope: options.encryptionScope }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ options.sourceConditions = options.sourceConditions || {};
+ return tracingClient.withSpan("BlobClient-syncCopyFromURL", options, async (updatedOptions) => {
+ var _a, _b, _c, _d, _e, _f, _g;
+ return assertResponse(await this.blobContext.copyFromURL(copySource, {
+ abortSignal: options.abortSignal,
+ metadata: options.metadata,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ sourceModifiedAccessConditions: {
+ sourceIfMatch: (_b = options.sourceConditions) === null || _b === void 0 ? void 0 : _b.ifMatch,
+ sourceIfModifiedSince: (_c = options.sourceConditions) === null || _c === void 0 ? void 0 : _c.ifModifiedSince,
+ sourceIfNoneMatch: (_d = options.sourceConditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch,
+ sourceIfUnmodifiedSince: (_e = options.sourceConditions) === null || _e === void 0 ? void 0 : _e.ifUnmodifiedSince,
+ },
+ sourceContentMD5: options.sourceContentMD5,
+ copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization),
+ tier: toAccessTier(options.tier),
+ blobTagsString: toBlobTagsString(options.tags),
+ immutabilityPolicyExpiry: (_f = options.immutabilityPolicy) === null || _f === void 0 ? void 0 : _f.expiriesOn,
+ immutabilityPolicyMode: (_g = options.immutabilityPolicy) === null || _g === void 0 ? void 0 : _g.policyMode,
+ legalHold: options.legalHold,
+ encryptionScope: options.encryptionScope,
+ copySourceTags: options.copySourceTags,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Sets a page blob's sequence number.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
+ * Sets the tier on a blob. The operation is allowed on a page blob in a premium
+ * storage account and on a block blob in a blob storage account (locally redundant
+ * storage only). A premium page blob's tier determines the allowed size, IOPS,
+ * and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive
+ * storage type. This operation does not update the blob's ETag.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-tier
*
- * @param sequenceNumberAction - Indicates how the service should modify the blob's sequence number.
- * @param sequenceNumber - Required if sequenceNumberAction is max or update
- * @param options - Options to the Page Blob Update Sequence Number operation.
- * @returns Response data for the Page Blob Update Sequence Number operation.
+ * @param tier - The tier to be set on the blob. Valid values are Hot, Cool, or Archive.
+ * @param options - Optional options to the Blob Set Tier operation.
*/
- async updateSequenceNumber(sequenceNumberAction, sequenceNumber, options = {}) {
- var _a;
- options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("PageBlobClient-updateSequenceNumber", options);
- try {
- return await this.pageBlobContext.updateSequenceNumber(sequenceNumberAction, Object.assign({ abortSignal: options.abortSignal, blobSequenceNumber: sequenceNumber, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ async setAccessTier(tier, options = {}) {
+ return tracingClient.withSpan("BlobClient-setAccessTier", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.blobContext.setTier(toAccessTier(tier), {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ rehydratePriority: options.rehydratePriority,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
- /**
- * Begins an operation to start an incremental copy from one page blob's snapshot to this page blob.
- * The snapshot is copied such that only the differential changes between the previously
- * copied snapshot are transferred to the destination.
- * The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual.
- * @see https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob
- * @see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
- *
- * @param copySource - Specifies the name of the source page blob snapshot. For example,
- * https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
- * @param options - Options to the Page Blob Copy Incremental operation.
- * @returns Response data for the Page Blob Copy Incremental operation.
- */
- async startCopyIncremental(copySource, options = {}) {
+ async downloadToBuffer(param1, param2, param3, param4 = {}) {
var _a;
- const { span, updatedOptions } = createSpan("PageBlobClient-startCopyIncremental", options);
- try {
- return await this.pageBlobContext.copyIncremental(copySource, Object.assign({ abortSignal: options.abortSignal, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }) }, convertTracingToRequestOptionsBase(updatedOptions)));
+ let buffer;
+ let offset = 0;
+ let count = 0;
+ let options = param4;
+ if (param1 instanceof Buffer) {
+ buffer = param1;
+ offset = param2 || 0;
+ count = typeof param3 === "number" ? param3 : 0;
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ else {
+ offset = typeof param1 === "number" ? param1 : 0;
+ count = typeof param2 === "number" ? param2 : 0;
+ options = param3 || {};
}
- finally {
- span.end();
+ let blockSize = (_a = options.blockSize) !== null && _a !== void 0 ? _a : 0;
+ if (blockSize < 0) {
+ throw new RangeError("blockSize option must be >= 0");
}
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-async function getBodyAsText(batchResponse) {
- let buffer = Buffer.alloc(BATCH_MAX_PAYLOAD_IN_BYTES);
- const responseLength = await streamToBuffer2(batchResponse.readableStreamBody, buffer);
- // Slice the buffer to trim the empty ending.
- buffer = buffer.slice(0, responseLength);
- return buffer.toString();
-}
-function utf8ByteLength(str) {
- return Buffer.byteLength(str);
-}
-
-// Copyright (c) Microsoft Corporation.
-const HTTP_HEADER_DELIMITER = ": ";
-const SPACE_DELIMITER = " ";
-const NOT_FOUND = -1;
-/**
- * Util class for parsing batch response.
- */
-class BatchResponseParser {
- constructor(batchResponse, subRequests) {
- if (!batchResponse || !batchResponse.contentType) {
- // In special case(reported), server may return invalid content-type which could not be parsed.
- throw new RangeError("batchResponse is malformed or doesn't contain valid content-type.");
+ if (blockSize === 0) {
+ blockSize = DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES;
}
- if (!subRequests || subRequests.size === 0) {
- // This should be prevent during coding.
- throw new RangeError("Invalid state: subRequests is not provided or size is 0.");
+ if (offset < 0) {
+ throw new RangeError("offset option must be >= 0");
}
- this.batchResponse = batchResponse;
- this.subRequests = subRequests;
- this.responseBatchBoundary = this.batchResponse.contentType.split("=")[1];
- this.perResponsePrefix = `--${this.responseBatchBoundary}${HTTP_LINE_ENDING}`;
- this.batchResponseEnding = `--${this.responseBatchBoundary}--`;
- }
- // For example of response, please refer to https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#response
- async parseBatchResponse() {
- // When logic reach here, suppose batch request has already succeeded with 202, so we can further parse
- // sub request's response.
- if (this.batchResponse._response.status !== HTTPURLConnection.HTTP_ACCEPTED) {
- throw new Error(`Invalid state: batch request failed with status: '${this.batchResponse._response.status}'.`);
+ if (count && count <= 0) {
+ throw new RangeError("count option must be greater than 0");
}
- const responseBodyAsText = await getBodyAsText(this.batchResponse);
- const subResponses = responseBodyAsText
- .split(this.batchResponseEnding)[0] // string after ending is useless
- .split(this.perResponsePrefix)
- .slice(1); // string before first response boundary is useless
- const subResponseCount = subResponses.length;
- // Defensive coding in case of potential error parsing.
- // Note: subResponseCount == 1 is special case where sub request is invalid.
- // We try to prevent such cases through early validation, e.g. validate sub request count >= 1.
- // While in unexpected sub request invalid case, we allow sub response to be parsed and return to user.
- if (subResponseCount !== this.subRequests.size && subResponseCount !== 1) {
- throw new Error("Invalid state: sub responses' count is not equal to sub requests' count.");
+ if (!options.conditions) {
+ options.conditions = {};
}
- const deserializedSubResponses = new Array(subResponseCount);
- let subResponsesSucceededCount = 0;
- let subResponsesFailedCount = 0;
- // Parse sub subResponses.
- for (let index = 0; index < subResponseCount; index++) {
- const subResponse = subResponses[index];
- const deserializedSubResponse = {};
- deserializedSubResponse.headers = new coreHttp.HttpHeaders();
- const responseLines = subResponse.split(`${HTTP_LINE_ENDING}`);
- let subRespHeaderStartFound = false;
- let subRespHeaderEndFound = false;
- let subRespFailed = false;
- let contentId = NOT_FOUND;
- for (const responseLine of responseLines) {
- if (!subRespHeaderStartFound) {
- // Convention line to indicate content ID
- if (responseLine.startsWith(HeaderConstants.CONTENT_ID)) {
- contentId = parseInt(responseLine.split(HTTP_HEADER_DELIMITER)[1]);
- }
- // Http version line with status code indicates the start of sub request's response.
- // Example: HTTP/1.1 202 Accepted
- if (responseLine.startsWith(HTTP_VERSION_1_1)) {
- subRespHeaderStartFound = true;
- const tokens = responseLine.split(SPACE_DELIMITER);
- deserializedSubResponse.status = parseInt(tokens[1]);
- deserializedSubResponse.statusMessage = tokens.slice(2).join(SPACE_DELIMITER);
- }
- continue; // Skip convention headers not specifically for sub request i.e. Content-Type: application/http and Content-ID: *
+ return tracingClient.withSpan("BlobClient-downloadToBuffer", options, async (updatedOptions) => {
+ // Customer doesn't specify length, get it
+ if (!count) {
+ const response = await this.getProperties(Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+ count = response.contentLength - offset;
+ if (count < 0) {
+ throw new RangeError(`offset ${offset} shouldn't be larger than blob size ${response.contentLength}`);
}
- if (responseLine.trim() === "") {
- // Sub response's header start line already found, and the first empty line indicates header end line found.
- if (!subRespHeaderEndFound) {
- subRespHeaderEndFound = true;
- }
- continue; // Skip empty line
+ }
+ // Allocate the buffer of size = count if the buffer is not provided
+ if (!buffer) {
+ try {
+ buffer = Buffer.alloc(count);
}
- // Note: when code reach here, it indicates subRespHeaderStartFound == true
- if (!subRespHeaderEndFound) {
- if (responseLine.indexOf(HTTP_HEADER_DELIMITER) === -1) {
- // Defensive coding to prevent from missing valuable lines.
- throw new Error(`Invalid state: find non-empty line '${responseLine}' without HTTP header delimiter '${HTTP_HEADER_DELIMITER}'.`);
- }
- // Parse headers of sub response.
- const tokens = responseLine.split(HTTP_HEADER_DELIMITER);
- deserializedSubResponse.headers.set(tokens[0], tokens[1]);
- if (tokens[0] === HeaderConstants.X_MS_ERROR_CODE) {
- deserializedSubResponse.errorCode = tokens[1];
- subRespFailed = true;
- }
+ catch (error) {
+ throw new Error(`Unable to allocate the buffer of size: ${count}(in bytes). Please try passing your own buffer to the "downloadToBuffer" method or try using other methods like "download" or "downloadToFile".\t ${error.message}`);
}
- else {
- // Assemble body of sub response.
- if (!deserializedSubResponse.bodyAsText) {
- deserializedSubResponse.bodyAsText = "";
+ }
+ if (buffer.length < count) {
+ throw new RangeError(`The buffer's size should be equal to or larger than the request count of bytes: ${count}`);
+ }
+ let transferProgress = 0;
+ const batch = new Batch(options.concurrency);
+ for (let off = offset; off < offset + count; off = off + blockSize) {
+ batch.addOperation(async () => {
+ // Exclusive chunk end position
+ let chunkEnd = offset + count;
+ if (off + blockSize < chunkEnd) {
+ chunkEnd = off + blockSize;
}
- deserializedSubResponse.bodyAsText += responseLine;
- }
- } // Inner for end
- // The response will contain the Content-ID header for each corresponding subrequest response to use for tracking.
- // The Content-IDs are set to a valid index in the subrequests we sent. In the status code 202 path, we could expect it
- // to be 1-1 mapping from the [0, subRequests.size) to the Content-IDs returned. If not, we simply don't return that
- // unexpected subResponse in the parsed reponse and we can always look it up in the raw response for debugging purpose.
- if (contentId !== NOT_FOUND &&
- Number.isInteger(contentId) &&
- contentId >= 0 &&
- contentId < this.subRequests.size &&
- deserializedSubResponses[contentId] === undefined) {
- deserializedSubResponse._request = this.subRequests.get(contentId);
- deserializedSubResponses[contentId] = deserializedSubResponse;
+ const response = await this.download(off, chunkEnd - off, {
+ abortSignal: options.abortSignal,
+ conditions: options.conditions,
+ maxRetryRequests: options.maxRetryRequestsPerBlock,
+ customerProvidedKey: options.customerProvidedKey,
+ tracingOptions: updatedOptions.tracingOptions,
+ });
+ const stream = response.readableStreamBody;
+ await streamToBuffer(stream, buffer, off - offset, chunkEnd - offset);
+ // Update progress after block is downloaded, in case of block trying
+ // Could provide finer grained progress updating inside HTTP requests,
+ // only if convenience layer download try is enabled
+ transferProgress += chunkEnd - off;
+ if (options.onProgress) {
+ options.onProgress({ loadedBytes: transferProgress });
+ }
+ });
+ }
+ await batch.do();
+ return buffer;
+ });
+ }
+ /**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Downloads an Azure Blob to a local file.
+ * Fails if the the given file path already exits.
+ * Offset and count are optional, pass 0 and undefined respectively to download the entire blob.
+ *
+ * @param filePath -
+ * @param offset - From which position of the block blob to download.
+ * @param count - How much data to be downloaded. Will download to the end when passing undefined.
+ * @param options - Options to Blob download options.
+ * @returns The response data for blob download operation,
+ * but with readableStreamBody set to undefined since its
+ * content is already read and written into a local file
+ * at the specified path.
+ */
+ async downloadToFile(filePath, offset = 0, count, options = {}) {
+ return tracingClient.withSpan("BlobClient-downloadToFile", options, async (updatedOptions) => {
+ const response = await this.download(offset, count, Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+ if (response.readableStreamBody) {
+ await readStreamToLocalFile(response.readableStreamBody, filePath);
}
- else {
- logger.error(`subResponses[${index}] is dropped as the Content-ID is not found or invalid, Content-ID: ${contentId}`);
+ // The stream is no longer accessible so setting it to undefined.
+ response.blobDownloadStream = undefined;
+ return response;
+ });
+ }
+ getBlobAndContainerNamesFromUrl() {
+ let containerName;
+ let blobName;
+ try {
+ // URL may look like the following
+ // "https://myaccount.blob.core.windows.net/mycontainer/blob?sasString";
+ // "https://myaccount.blob.core.windows.net/mycontainer/blob";
+ // "https://myaccount.blob.core.windows.net/mycontainer/blob/a.txt?sasString";
+ // "https://myaccount.blob.core.windows.net/mycontainer/blob/a.txt";
+ // IPv4/IPv6 address hosts, Endpoints - `http://127.0.0.1:10000/devstoreaccount1/containername/blob`
+ // http://localhost:10001/devstoreaccount1/containername/blob
+ const parsedUrl = new URL(this.url);
+ if (parsedUrl.host.split(".")[1] === "blob") {
+ // "https://myaccount.blob.core.windows.net/containername/blob".
+ // .getPath() -> /containername/blob
+ const pathComponents = parsedUrl.pathname.match("/([^/]*)(/(.*))?");
+ containerName = pathComponents[1];
+ blobName = pathComponents[3];
}
- if (subRespFailed) {
- subResponsesFailedCount++;
+ else if (isIpEndpointStyle(parsedUrl)) {
+ // IPv4/IPv6 address hosts... Example - http://192.0.0.10:10001/devstoreaccount1/containername/blob
+ // Single word domain without a [dot] in the endpoint... Example - http://localhost:10001/devstoreaccount1/containername/blob
+ // .getPath() -> /devstoreaccount1/containername/blob
+ const pathComponents = parsedUrl.pathname.match("/([^/]*)/([^/]*)(/(.*))?");
+ containerName = pathComponents[2];
+ blobName = pathComponents[4];
}
else {
- subResponsesSucceededCount++;
+ // "https://customdomain.com/containername/blob".
+ // .getPath() -> /containername/blob
+ const pathComponents = parsedUrl.pathname.match("/([^/]*)(/(.*))?");
+ containerName = pathComponents[1];
+ blobName = pathComponents[3];
+ }
+ // decode the encoded blobName, containerName - to get all the special characters that might be present in them
+ containerName = decodeURIComponent(containerName);
+ blobName = decodeURIComponent(blobName);
+ // Azure Storage Server will replace "\" with "/" in the blob names
+ // doing the same in the SDK side so that the user doesn't have to replace "\" instances in the blobName
+ blobName = blobName.replace(/\\/g, "/");
+ if (!containerName) {
+ throw new Error("Provided containerName is invalid.");
}
+ return { blobName, containerName };
+ }
+ catch (error) {
+ throw new Error("Unable to extract blobName and containerName with provided information.");
}
- return {
- subResponses: deserializedSubResponses,
- subResponsesSucceededCount: subResponsesSucceededCount,
- subResponsesFailedCount: subResponsesFailedCount,
- };
}
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-var MutexLockStatus;
-(function (MutexLockStatus) {
- MutexLockStatus[MutexLockStatus["LOCKED"] = 0] = "LOCKED";
- MutexLockStatus[MutexLockStatus["UNLOCKED"] = 1] = "UNLOCKED";
-})(MutexLockStatus || (MutexLockStatus = {}));
-/**
- * An async mutex lock.
- */
-class Mutex {
/**
- * Lock for a specific key. If the lock has been acquired by another customer, then
- * will wait until getting the lock.
+ * Asynchronously copies a blob to a destination within the storage account.
+ * In version 2012-02-12 and later, the source for a Copy Blob operation can be
+ * a committed blob in any Azure storage account.
+ * Beginning with version 2015-02-21, the source for a Copy Blob operation can be
+ * an Azure file in any Azure storage account.
+ * Only storage accounts created on or after June 7th, 2012 allow the Copy Blob
+ * operation to copy from another storage account.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/copy-blob
*
- * @param key - lock key
+ * @param copySource - url to the source Azure Blob/File.
+ * @param options - Optional options to the Blob Start Copy From URL operation.
*/
- static async lock(key) {
- return new Promise((resolve) => {
- if (this.keys[key] === undefined || this.keys[key] === MutexLockStatus.UNLOCKED) {
- this.keys[key] = MutexLockStatus.LOCKED;
- resolve();
- }
- else {
- this.onUnlockEvent(key, () => {
- this.keys[key] = MutexLockStatus.LOCKED;
- resolve();
- });
- }
+ async startCopyFromURL(copySource, options = {}) {
+ return tracingClient.withSpan("BlobClient-startCopyFromURL", options, async (updatedOptions) => {
+ var _a, _b, _c;
+ options.conditions = options.conditions || {};
+ options.sourceConditions = options.sourceConditions || {};
+ return assertResponse(await this.blobContext.startCopyFromURL(copySource, {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ metadata: options.metadata,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ sourceModifiedAccessConditions: {
+ sourceIfMatch: options.sourceConditions.ifMatch,
+ sourceIfModifiedSince: options.sourceConditions.ifModifiedSince,
+ sourceIfNoneMatch: options.sourceConditions.ifNoneMatch,
+ sourceIfUnmodifiedSince: options.sourceConditions.ifUnmodifiedSince,
+ sourceIfTags: options.sourceConditions.tagConditions,
+ },
+ immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn,
+ immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode,
+ legalHold: options.legalHold,
+ rehydratePriority: options.rehydratePriority,
+ tier: toAccessTier(options.tier),
+ blobTagsString: toBlobTagsString(options.tags),
+ sealBlob: options.sealBlob,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
});
}
/**
- * Unlock a key.
+ * Only available for BlobClient constructed with a shared key credential.
*
- * @param key -
+ * Generates a Blob 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
+ *
+ * @param options - Optional parameters.
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
*/
- static async unlock(key) {
+ generateSasUrl(options) {
return new Promise((resolve) => {
- if (this.keys[key] === MutexLockStatus.LOCKED) {
- this.emitUnlockEvent(key);
+ if (!(this.credential instanceof StorageSharedKeyCredential)) {
+ throw new RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
}
- delete this.keys[key];
- resolve();
+ const sas = generateBlobSASQueryParameters(Object.assign({ containerName: this._containerName, blobName: this._name, snapshotTime: this._snapshot, versionId: this._versionId }, options), this.credential).toString();
+ resolve(appendToURLQuery(this.url, sas));
});
}
- static onUnlockEvent(key, handler) {
- if (this.listeners[key] === undefined) {
- this.listeners[key] = [handler];
- }
- else {
- this.listeners[key].push(handler);
- }
- }
- static emitUnlockEvent(key) {
- if (this.listeners[key] !== undefined && this.listeners[key].length > 0) {
- const handler = this.listeners[key].shift();
- setImmediate(() => {
- handler.call(this);
- });
- }
- }
-}
-Mutex.keys = {};
-Mutex.listeners = {};
-
-// Copyright (c) Microsoft Corporation.
-/**
- * A BlobBatch represents an aggregated set of operations on blobs.
- * Currently, only `delete` and `setAccessTier` are supported.
- */
-class BlobBatch {
- constructor() {
- this.batch = "batch";
- this.batchRequest = new InnerBatchRequest();
- }
/**
- * Get the value of Content-Type for a batch request.
- * The value must be multipart/mixed with a batch boundary.
- * Example: multipart/mixed; boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252
+ * Delete the immutablility policy on the blob.
+ *
+ * @param options - Optional options to delete immutability policy on the blob.
*/
- getMultiPartContentType() {
- return this.batchRequest.getMultipartContentType();
+ async deleteImmutabilityPolicy(options = {}) {
+ return tracingClient.withSpan("BlobClient-deleteImmutabilityPolicy", options, async (updatedOptions) => {
+ return assertResponse(await this.blobContext.deleteImmutabilityPolicy({
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Get assembled HTTP request body for sub requests.
+ * Set immutability policy on the blob.
+ *
+ * @param options - Optional options to set immutability policy on the blob.
*/
- getHttpRequestBody() {
- return this.batchRequest.getHttpRequestBody();
+ async setImmutabilityPolicy(immutabilityPolicy, options = {}) {
+ return tracingClient.withSpan("BlobClient-setImmutabilityPolicy", options, async (updatedOptions) => {
+ return assertResponse(await this.blobContext.setImmutabilityPolicy({
+ immutabilityPolicyExpiry: immutabilityPolicy.expiriesOn,
+ immutabilityPolicyMode: immutabilityPolicy.policyMode,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Get sub requests that are added into the batch request.
+ * Set legal hold on the blob.
+ *
+ * @param options - Optional options to set legal hold on the blob.
*/
- getSubRequests() {
- return this.batchRequest.getSubRequests();
- }
- async addSubRequestInternal(subRequest, assembleSubRequestFunc) {
- await Mutex.lock(this.batch);
- try {
- this.batchRequest.preAddSubRequest(subRequest);
- await assembleSubRequestFunc();
- this.batchRequest.postAddSubRequest(subRequest);
- }
- finally {
- await Mutex.unlock(this.batch);
- }
+ async setLegalHold(legalHoldEnabled, options = {}) {
+ return tracingClient.withSpan("BlobClient-setLegalHold", options, async (updatedOptions) => {
+ return assertResponse(await this.blobContext.setLegalHold(legalHoldEnabled, {
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
- setBatchType(batchType) {
- if (!this.batchType) {
- this.batchType = batchType;
- }
- if (this.batchType !== batchType) {
- throw new RangeError(`BlobBatch only supports one operation type per batch and it already is being used for ${this.batchType} operations.`);
- }
+ /**
+ * The Get Account Information operation returns the sku name and account kind
+ * for the specified account.
+ * The Get Account Information operation is available on service versions beginning
+ * with version 2018-03-28.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
+ *
+ * @param options - Options to the Service Get Account Info operation.
+ * @returns Response data for the Service Get Account Info operation.
+ */
+ async getAccountInfo(options = {}) {
+ return tracingClient.withSpan("BlobClient-getAccountInfo", options, async (updatedOptions) => {
+ return assertResponse(await this.blobContext.getAccountInfo({
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
- async deleteBlob(urlOrBlobClient, credentialOrOptions, options) {
+}
+/**
+ * AppendBlobClient defines a set of operations applicable to append blobs.
+ */
+class AppendBlobClient extends BlobClient {
+ constructor(urlOrConnectionString, credentialOrPipelineOrContainerName, blobNameOrOptions,
+ // Legacy, no fix for eslint error without breaking. Disable it for this interface.
+ /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+ options) {
+ // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead.
+ // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options);
+ let pipeline;
let url;
- let credential;
- if (typeof urlOrBlobClient === "string" &&
- ((coreHttp.isNode && credentialOrOptions instanceof StorageSharedKeyCredential) ||
- credentialOrOptions instanceof AnonymousCredential ||
- coreHttp.isTokenCredential(credentialOrOptions))) {
- // First overload
- url = urlOrBlobClient;
- credential = credentialOrOptions;
- }
- else if (urlOrBlobClient instanceof BlobClient) {
- // Second overload
- url = urlOrBlobClient.url;
- credential = urlOrBlobClient.credential;
- options = credentialOrOptions;
- }
- else {
- throw new RangeError("Invalid arguments. Either url and credential, or BlobClient need be provided.");
- }
- if (!options) {
- options = {};
- }
- const { span, updatedOptions } = createSpan("BatchDeleteRequest-addSubRequest", options);
- try {
- this.setBatchType("delete");
- await this.addSubRequestInternal({
- url: url,
- credential: credential,
- }, async () => {
- await new BlobClient(url, this.batchRequest.createPipeline(credential)).delete(updatedOptions);
- });
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ options = options || {};
+ if (isPipelineLike(credentialOrPipelineOrContainerName)) {
+ // (url: string, pipeline: Pipeline)
+ url = urlOrConnectionString;
+ pipeline = credentialOrPipelineOrContainerName;
}
- finally {
- span.end();
+ else if ((coreUtil.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
+ credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
+ coreAuth.isTokenCredential(credentialOrPipelineOrContainerName)) {
+ // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions) url = urlOrConnectionString;
+ url = urlOrConnectionString;
+ options = blobNameOrOptions;
+ pipeline = newPipeline(credentialOrPipelineOrContainerName, options);
}
- }
- async setBlobAccessTier(urlOrBlobClient, credentialOrTier, tierOrOptions, options) {
- let url;
- let credential;
- let tier;
- if (typeof urlOrBlobClient === "string" &&
- ((coreHttp.isNode && credentialOrTier instanceof StorageSharedKeyCredential) ||
- credentialOrTier instanceof AnonymousCredential ||
- coreHttp.isTokenCredential(credentialOrTier))) {
- // First overload
- url = urlOrBlobClient;
- credential = credentialOrTier;
- tier = tierOrOptions;
+ else if (!credentialOrPipelineOrContainerName &&
+ typeof credentialOrPipelineOrContainerName !== "string") {
+ // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
+ url = urlOrConnectionString;
+ // The second parameter is undefined. Use anonymous credential.
+ pipeline = newPipeline(new AnonymousCredential(), options);
}
- else if (urlOrBlobClient instanceof BlobClient) {
- // Second overload
- url = urlOrBlobClient.url;
- credential = urlOrBlobClient.credential;
- tier = credentialOrTier;
- options = tierOrOptions;
+ else if (credentialOrPipelineOrContainerName &&
+ typeof credentialOrPipelineOrContainerName === "string" &&
+ blobNameOrOptions &&
+ typeof blobNameOrOptions === "string") {
+ // (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
+ const containerName = credentialOrPipelineOrContainerName;
+ const blobName = blobNameOrOptions;
+ const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
+ if (extractedCreds.kind === "AccountConnString") {
+ if (coreUtil.isNode) {
+ const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
+ url = appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName));
+ if (!options.proxyOptions) {
+ options.proxyOptions = coreRestPipeline.getDefaultProxySettings(extractedCreds.proxyUri);
+ }
+ pipeline = newPipeline(sharedKeyCredential, options);
+ }
+ else {
+ throw new Error("Account connection string is only supported in Node.js environment");
+ }
+ }
+ else if (extractedCreds.kind === "SASConnString") {
+ url =
+ appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName)) +
+ "?" +
+ extractedCreds.accountSas;
+ pipeline = newPipeline(new AnonymousCredential(), options);
+ }
+ else {
+ throw new Error("Connection string must be either an Account connection string or a SAS connection string");
+ }
}
else {
- throw new RangeError("Invalid arguments. Either url and credential, or BlobClient need be provided.");
- }
- if (!options) {
- options = {};
- }
- const { span, updatedOptions } = createSpan("BatchSetTierRequest-addSubRequest", options);
- try {
- this.setBatchType("setAccessTier");
- await this.addSubRequestInternal({
- url: url,
- credential: credential,
- }, async () => {
- await new BlobClient(url, this.batchRequest.createPipeline(credential)).setAccessTier(tier, updatedOptions);
- });
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
+ throw new Error("Expecting non-empty strings for containerName and blobName parameters");
}
- }
-}
-/**
- * Inner batch request class which is responsible for assembling and serializing sub requests.
- * See https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#request-body for how requests are assembled.
- */
-class InnerBatchRequest {
- constructor() {
- this.operationCount = 0;
- this.body = "";
- const tempGuid = coreHttp.generateUuid();
- // batch_{batchid}
- this.boundary = `batch_${tempGuid}`;
- // --batch_{batchid}
- // Content-Type: application/http
- // Content-Transfer-Encoding: binary
- this.subRequestPrefix = `--${this.boundary}${HTTP_LINE_ENDING}${HeaderConstants.CONTENT_TYPE}: application/http${HTTP_LINE_ENDING}${HeaderConstants.CONTENT_TRANSFER_ENCODING}: binary`;
- // multipart/mixed; boundary=batch_{batchid}
- this.multipartContentType = `multipart/mixed; boundary=${this.boundary}`;
- // --batch_{batchid}--
- this.batchRequestEnding = `--${this.boundary}--`;
- this.subRequests = new Map();
+ super(url, pipeline);
+ this.appendBlobContext = this.storageClientContext.appendBlob;
}
/**
- * Create pipeline to assemble sub requests. The idea here is to use existing
- * credential and serialization/deserialization components, with additional policies to
- * filter unnecessary headers, assemble sub requests into request's body
- * and intercept request from going to wire.
- * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
+ * Creates a new AppendBlobClient object identical to the source but with the
+ * specified snapshot timestamp.
+ * Provide "" will remove the snapshot and return a Client to the base blob.
+ *
+ * @param snapshot - The snapshot timestamp.
+ * @returns A new AppendBlobClient object identical to the source but with the specified snapshot timestamp.
*/
- createPipeline(credential) {
- const isAnonymousCreds = credential instanceof AnonymousCredential;
- const policyFactoryLength = 3 + (isAnonymousCreds ? 0 : 1); // [deserializationPolicy, BatchHeaderFilterPolicyFactory, (Optional)Credential, BatchRequestAssemblePolicyFactory]
- const factories = new Array(policyFactoryLength);
- factories[0] = coreHttp.deserializationPolicy(); // Default deserializationPolicy is provided by protocol layer
- factories[1] = new BatchHeaderFilterPolicyFactory(); // Use batch header filter policy to exclude unnecessary headers
- if (!isAnonymousCreds) {
- factories[2] = coreHttp.isTokenCredential(credential)
- ? attachCredential(coreHttp.bearerTokenAuthenticationPolicy(credential, StorageOAuthScopes), credential)
- : credential;
- }
- factories[policyFactoryLength - 1] = new BatchRequestAssemblePolicyFactory(this); // Use batch assemble policy to assemble request and intercept request from going to wire
- return new Pipeline(factories, {});
- }
- appendSubRequestToBody(request) {
- // Start to assemble sub request
- this.body += [
- this.subRequestPrefix,
- `${HeaderConstants.CONTENT_ID}: ${this.operationCount}`,
- "",
- `${request.method.toString()} ${getURLPathAndQuery(request.url)} ${HTTP_VERSION_1_1}${HTTP_LINE_ENDING}`, // sub request start line with method
- ].join(HTTP_LINE_ENDING);
- for (const header of request.headers.headersArray()) {
- this.body += `${header.name}: ${header.value}${HTTP_LINE_ENDING}`;
- }
- this.body += HTTP_LINE_ENDING; // sub request's headers need be ending with an empty line
- // No body to assemble for current batch request support
- // End to assemble sub request
- }
- preAddSubRequest(subRequest) {
- if (this.operationCount >= BATCH_MAX_REQUEST) {
- throw new RangeError(`Cannot exceed ${BATCH_MAX_REQUEST} sub requests in a single batch`);
- }
- // Fast fail if url for sub request is invalid
- const path = getURLPath(subRequest.url);
- if (!path || path === "") {
- throw new RangeError(`Invalid url for sub request: '${subRequest.url}'`);
- }
- }
- postAddSubRequest(subRequest) {
- this.subRequests.set(this.operationCount, subRequest);
- this.operationCount++;
- }
- // Return the http request body with assembling the ending line to the sub request body.
- getHttpRequestBody() {
- return `${this.body}${this.batchRequestEnding}${HTTP_LINE_ENDING}`;
- }
- getMultipartContentType() {
- return this.multipartContentType;
- }
- getSubRequests() {
- return this.subRequests;
- }
-}
-class BatchRequestAssemblePolicy extends coreHttp.BaseRequestPolicy {
- constructor(batchRequest, nextPolicy, options) {
- super(nextPolicy, options);
- this.dummyResponse = {
- request: new coreHttp.WebResource(),
- status: 200,
- headers: new coreHttp.HttpHeaders(),
- };
- this.batchRequest = batchRequest;
- }
- async sendRequest(request) {
- await this.batchRequest.appendSubRequestToBody(request);
- return this.dummyResponse; // Intercept request from going to wire
+ withSnapshot(snapshot) {
+ return new AppendBlobClient(setURLParameter(this.url, URLConstants.Parameters.SNAPSHOT, snapshot.length === 0 ? undefined : snapshot), this.pipeline);
}
-}
-class BatchRequestAssemblePolicyFactory {
- constructor(batchRequest) {
- this.batchRequest = batchRequest;
+ /**
+ * Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+ *
+ * @param options - Options to the Append Block Create operation.
+ *
+ *
+ * Example usage:
+ *
+ * ```js
+ * const appendBlobClient = containerClient.getAppendBlobClient("");
+ * await appendBlobClient.create();
+ * ```
+ */
+ async create(options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("AppendBlobClient-create", options, async (updatedOptions) => {
+ var _a, _b, _c;
+ return assertResponse(await this.appendBlobContext.create(0, {
+ abortSignal: options.abortSignal,
+ blobHttpHeaders: options.blobHTTPHeaders,
+ leaseAccessConditions: options.conditions,
+ metadata: options.metadata,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn,
+ immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode,
+ legalHold: options.legalHold,
+ blobTagsString: toBlobTagsString(options.tags),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
- create(nextPolicy, options) {
- return new BatchRequestAssemblePolicy(this.batchRequest, nextPolicy, options);
+ /**
+ * Creates a 0-length append blob. Call AppendBlock to append data to an append blob.
+ * If the blob with the same name already exists, the content of the existing blob will remain unchanged.
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+ *
+ * @param options -
+ */
+ async createIfNotExists(options = {}) {
+ const conditions = { ifNoneMatch: ETagAny };
+ return tracingClient.withSpan("AppendBlobClient-createIfNotExists", options, async (updatedOptions) => {
+ var _a, _b;
+ try {
+ const res = assertResponse(await this.create(Object.assign(Object.assign({}, updatedOptions), { conditions })));
+ return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
+ }
+ catch (e) {
+ if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "BlobAlreadyExists") {
+ return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+ }
+ throw e;
+ }
+ });
}
-}
-class BatchHeaderFilterPolicy extends coreHttp.BaseRequestPolicy {
- // The base class has a protected constructor. Adding a public one to enable constructing of this class.
- /* eslint-disable-next-line @typescript-eslint/no-useless-constructor*/
- constructor(nextPolicy, options) {
- super(nextPolicy, options);
+ /**
+ * Seals the append blob, making it read only.
+ *
+ * @param options -
+ */
+ async seal(options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("AppendBlobClient-seal", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.appendBlobContext.seal({
+ abortSignal: options.abortSignal,
+ appendPositionAccessConditions: options.conditions,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
- async sendRequest(request) {
- let xMsHeaderName = "";
- for (const header of request.headers.headersArray()) {
- if (iEqual(header.name, HeaderConstants.X_MS_VERSION)) {
- xMsHeaderName = header.name;
- }
- }
- if (xMsHeaderName !== "") {
- request.headers.remove(xMsHeaderName); // The subrequests should not have the x-ms-version header.
- }
- return this._nextPolicy.sendRequest(request);
+ /**
+ * Commits a new block of data to the end of the existing append blob.
+ * @see https://docs.microsoft.com/rest/api/storageservices/append-block
+ *
+ * @param body - Data to be appended.
+ * @param contentLength - Length of the body in bytes.
+ * @param options - Options to the Append Block operation.
+ *
+ *
+ * Example usage:
+ *
+ * ```js
+ * const content = "Hello World!";
+ *
+ * // Create a new append blob and append data to the blob.
+ * const newAppendBlobClient = containerClient.getAppendBlobClient("");
+ * await newAppendBlobClient.create();
+ * await newAppendBlobClient.appendBlock(content, content.length);
+ *
+ * // Append data to an existing append blob.
+ * const existingAppendBlobClient = containerClient.getAppendBlobClient("");
+ * await existingAppendBlobClient.appendBlock(content, content.length);
+ * ```
+ */
+ async appendBlock(body, contentLength, options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("AppendBlobClient-appendBlock", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.appendBlobContext.appendBlock(contentLength, body, {
+ abortSignal: options.abortSignal,
+ appendPositionAccessConditions: options.conditions,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ requestOptions: {
+ onUploadProgress: options.onProgress,
+ },
+ transactionalContentMD5: options.transactionalContentMD5,
+ transactionalContentCrc64: options.transactionalContentCrc64,
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
-}
-class BatchHeaderFilterPolicyFactory {
- create(nextPolicy, options) {
- return new BatchHeaderFilterPolicy(nextPolicy, options);
+ /**
+ * The Append Block operation commits a new block of data to the end of an existing append blob
+ * where the contents are read from a source url.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/append-block-from-url
+ *
+ * @param sourceURL -
+ * The url to the blob that will be the source of the copy. A source blob in the same storage account can
+ * be authenticated via Shared Key. However, if the source is a blob in another account, the source blob
+ * must either be public or must be authenticated via a shared access signature. If the source blob is
+ * public, no authentication is required to perform the operation.
+ * @param sourceOffset - Offset in source to be appended
+ * @param count - Number of bytes to be appended as a block
+ * @param options -
+ */
+ async appendBlockFromURL(sourceURL, sourceOffset, count, options = {}) {
+ options.conditions = options.conditions || {};
+ options.sourceConditions = options.sourceConditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("AppendBlobClient-appendBlockFromURL", options, async (updatedOptions) => {
+ var _a, _b, _c, _d, _e;
+ return assertResponse(await this.appendBlobContext.appendBlockFromUrl(sourceURL, 0, {
+ abortSignal: options.abortSignal,
+ sourceRange: rangeToString({ offset: sourceOffset, count }),
+ sourceContentMD5: options.sourceContentMD5,
+ sourceContentCrc64: options.sourceContentCrc64,
+ leaseAccessConditions: options.conditions,
+ appendPositionAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ sourceModifiedAccessConditions: {
+ sourceIfMatch: (_b = options.sourceConditions) === null || _b === void 0 ? void 0 : _b.ifMatch,
+ sourceIfModifiedSince: (_c = options.sourceConditions) === null || _c === void 0 ? void 0 : _c.ifModifiedSince,
+ sourceIfNoneMatch: (_d = options.sourceConditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch,
+ sourceIfUnmodifiedSince: (_e = options.sourceConditions) === null || _e === void 0 ? void 0 : _e.ifUnmodifiedSince,
+ },
+ copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization),
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
}
-
-// Copyright (c) Microsoft Corporation.
/**
- * A BlobBatchClient allows you to make batched requests to the Azure Storage Blob service.
- *
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
+ * BlockBlobClient defines a set of operations applicable to block blobs.
*/
-class BlobBatchClient {
- constructor(url, credentialOrPipeline,
+class BlockBlobClient extends BlobClient {
+ constructor(urlOrConnectionString, credentialOrPipelineOrContainerName, blobNameOrOptions,
// Legacy, no fix for eslint error without breaking. Disable it for this interface.
/* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
options) {
+ // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead.
+ // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options);
let pipeline;
- if (isPipelineLike(credentialOrPipeline)) {
- pipeline = credentialOrPipeline;
+ let url;
+ options = options || {};
+ if (isPipelineLike(credentialOrPipelineOrContainerName)) {
+ // (url: string, pipeline: Pipeline)
+ url = urlOrConnectionString;
+ pipeline = credentialOrPipelineOrContainerName;
}
- else if (!credentialOrPipeline) {
- // no credential provided
- pipeline = newPipeline(new AnonymousCredential(), options);
+ else if ((coreUtil.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
+ credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
+ coreAuth.isTokenCredential(credentialOrPipelineOrContainerName)) {
+ // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
+ url = urlOrConnectionString;
+ options = blobNameOrOptions;
+ pipeline = newPipeline(credentialOrPipelineOrContainerName, options);
}
- else {
- pipeline = newPipeline(credentialOrPipeline, options);
+ else if (!credentialOrPipelineOrContainerName &&
+ typeof credentialOrPipelineOrContainerName !== "string") {
+ // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
+ // The second parameter is undefined. Use anonymous credential.
+ url = urlOrConnectionString;
+ if (blobNameOrOptions && typeof blobNameOrOptions !== "string") {
+ options = blobNameOrOptions;
+ }
+ pipeline = newPipeline(new AnonymousCredential(), options);
}
- const storageClientContext = new StorageClientContext(url, pipeline.toServiceClientOptions());
- const path = getURLPath(url);
- if (path && path !== "/") {
- // Container scoped.
- this.serviceOrContainerContext = new Container(storageClientContext);
+ else if (credentialOrPipelineOrContainerName &&
+ typeof credentialOrPipelineOrContainerName === "string" &&
+ blobNameOrOptions &&
+ typeof blobNameOrOptions === "string") {
+ // (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
+ const containerName = credentialOrPipelineOrContainerName;
+ const blobName = blobNameOrOptions;
+ const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
+ if (extractedCreds.kind === "AccountConnString") {
+ if (coreUtil.isNode) {
+ const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
+ url = appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName));
+ if (!options.proxyOptions) {
+ options.proxyOptions = coreRestPipeline.getDefaultProxySettings(extractedCreds.proxyUri);
+ }
+ pipeline = newPipeline(sharedKeyCredential, options);
+ }
+ else {
+ throw new Error("Account connection string is only supported in Node.js environment");
+ }
+ }
+ else if (extractedCreds.kind === "SASConnString") {
+ url =
+ appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName)) +
+ "?" +
+ extractedCreds.accountSas;
+ pipeline = newPipeline(new AnonymousCredential(), options);
+ }
+ else {
+ throw new Error("Connection string must be either an Account connection string or a SAS connection string");
+ }
}
else {
- this.serviceOrContainerContext = new Service(storageClientContext);
+ throw new Error("Expecting non-empty strings for containerName and blobName parameters");
}
+ super(url, pipeline);
+ this.blockBlobContext = this.storageClientContext.blockBlob;
+ this._blobContext = this.storageClientContext.blob;
}
/**
- * Creates a {@link BlobBatch}.
- * A BlobBatch represents an aggregated set of operations on blobs.
+ * Creates a new BlockBlobClient object identical to the source but with the
+ * specified snapshot timestamp.
+ * Provide "" will remove the snapshot and return a URL to the base blob.
+ *
+ * @param snapshot - The snapshot timestamp.
+ * @returns A new BlockBlobClient object identical to the source but with the specified snapshot timestamp.
*/
- createBatch() {
- return new BlobBatch();
+ withSnapshot(snapshot) {
+ return new BlockBlobClient(setURLParameter(this.url, URLConstants.Parameters.SNAPSHOT, snapshot.length === 0 ? undefined : snapshot), this.pipeline);
}
- async deleteBlobs(urlsOrBlobClients, credentialOrOptions,
- // Legacy, no fix for eslint error without breaking. Disable it for this interface.
- /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
- options) {
- const batch = new BlobBatch();
- for (const urlOrBlobClient of urlsOrBlobClients) {
- if (typeof urlOrBlobClient === "string") {
- await batch.deleteBlob(urlOrBlobClient, credentialOrOptions, options);
+ /**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Quick query for a JSON or CSV formatted blob.
+ *
+ * Example usage (Node.js):
+ *
+ * ```js
+ * // Query and convert a blob to a string
+ * const queryBlockBlobResponse = await blockBlobClient.query("select * from BlobStorage");
+ * const downloaded = (await streamToBuffer(queryBlockBlobResponse.readableStreamBody)).toString();
+ * console.log("Query blob content:", downloaded);
+ *
+ * async function streamToBuffer(readableStream) {
+ * return new Promise((resolve, reject) => {
+ * const chunks = [];
+ * readableStream.on("data", (data) => {
+ * chunks.push(data instanceof Buffer ? data : Buffer.from(data));
+ * });
+ * readableStream.on("end", () => {
+ * resolve(Buffer.concat(chunks));
+ * });
+ * readableStream.on("error", reject);
+ * });
+ * }
+ * ```
+ *
+ * @param query -
+ * @param options -
+ */
+ async query(query, options = {}) {
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ if (!coreUtil.isNode) {
+ throw new Error("This operation currently is only supported in Node.js.");
+ }
+ return tracingClient.withSpan("BlockBlobClient-query", options, async (updatedOptions) => {
+ var _a;
+ const response = assertResponse(await this._blobContext.query({
+ abortSignal: options.abortSignal,
+ queryRequest: {
+ queryType: "SQL",
+ expression: query,
+ inputSerialization: toQuerySerialization(options.inputTextConfiguration),
+ outputSerialization: toQuerySerialization(options.outputTextConfiguration),
+ },
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ cpkInfo: options.customerProvidedKey,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ return new BlobQueryResponse(response, {
+ abortSignal: options.abortSignal,
+ onProgress: options.onProgress,
+ onError: options.onError,
+ });
+ });
+ }
+ /**
+ * Creates a new block blob, or updates the content of an existing block blob.
+ * Updating an existing block blob overwrites any existing metadata on the blob.
+ * Partial updates are not supported; the content of the existing blob is
+ * overwritten with the new content. To perform a partial update of a block blob's,
+ * use {@link stageBlock} and {@link commitBlockList}.
+ *
+ * This is a non-parallel uploading method, please use {@link uploadFile},
+ * {@link uploadStream} or {@link uploadBrowserData} for better performance
+ * with concurrency uploading.
+ *
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+ *
+ * @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
+ * which returns a new Readable stream whose offset is from data source beginning.
+ * @param contentLength - Length of body in bytes. Use Buffer.byteLength() to calculate body length for a
+ * string including non non-Base64/Hex-encoded characters.
+ * @param options - Options to the Block Blob Upload operation.
+ * @returns Response data for the Block Blob Upload operation.
+ *
+ * Example usage:
+ *
+ * ```js
+ * const content = "Hello world!";
+ * const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
+ * ```
+ */
+ async upload(body, contentLength, options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlockBlobClient-upload", options, async (updatedOptions) => {
+ var _a, _b, _c;
+ return assertResponse(await this.blockBlobContext.upload(contentLength, body, {
+ abortSignal: options.abortSignal,
+ blobHttpHeaders: options.blobHTTPHeaders,
+ leaseAccessConditions: options.conditions,
+ metadata: options.metadata,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ requestOptions: {
+ onUploadProgress: options.onProgress,
+ },
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn,
+ immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode,
+ legalHold: options.legalHold,
+ tier: toAccessTier(options.tier),
+ blobTagsString: toBlobTagsString(options.tags),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Creates a new Block Blob where the contents of the blob are read from a given URL.
+ * This API is supported beginning with the 2020-04-08 version. Partial updates
+ * are not supported with Put Blob from URL; the content of an existing blob is overwritten with
+ * the content of the new blob. To perform partial updates to a block blob’s contents using a
+ * source URL, use {@link stageBlockFromURL} and {@link commitBlockList}.
+ *
+ * @param sourceURL - Specifies the URL of the blob. The value
+ * may be a URL of up to 2 KB in length that specifies a blob.
+ * The value should be URL-encoded as it would appear
+ * in a request URI. The source blob must either be public
+ * or must be authenticated via a shared access signature.
+ * If the source blob is public, no authentication is required
+ * to perform the operation. Here are some examples of source object URLs:
+ * - https://myaccount.blob.core.windows.net/mycontainer/myblob
+ * - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
+ * @param options - Optional parameters.
+ */
+ async syncUploadFromURL(sourceURL, options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlockBlobClient-syncUploadFromURL", options, async (updatedOptions) => {
+ var _a, _b, _c, _d, _e, _f;
+ return assertResponse(await this.blockBlobContext.putBlobFromUrl(0, sourceURL, Object.assign(Object.assign({}, options), { blobHttpHeaders: options.blobHTTPHeaders, leaseAccessConditions: options.conditions, modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }), sourceModifiedAccessConditions: {
+ sourceIfMatch: (_b = options.sourceConditions) === null || _b === void 0 ? void 0 : _b.ifMatch,
+ sourceIfModifiedSince: (_c = options.sourceConditions) === null || _c === void 0 ? void 0 : _c.ifModifiedSince,
+ sourceIfNoneMatch: (_d = options.sourceConditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch,
+ sourceIfUnmodifiedSince: (_e = options.sourceConditions) === null || _e === void 0 ? void 0 : _e.ifUnmodifiedSince,
+ sourceIfTags: (_f = options.sourceConditions) === null || _f === void 0 ? void 0 : _f.tagConditions,
+ }, cpkInfo: options.customerProvidedKey, copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization), tier: toAccessTier(options.tier), blobTagsString: toBlobTagsString(options.tags), copySourceTags: options.copySourceTags, tracingOptions: updatedOptions.tracingOptions })));
+ });
+ }
+ /**
+ * Uploads the specified block to the block blob's "staging area" to be later
+ * committed by a call to commitBlockList.
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-block
+ *
+ * @param blockId - A 64-byte value that is base64-encoded
+ * @param body - Data to upload to the staging area.
+ * @param contentLength - Number of bytes to upload.
+ * @param options - Options to the Block Blob Stage Block operation.
+ * @returns Response data for the Block Blob Stage Block operation.
+ */
+ async stageBlock(blockId, body, contentLength, options = {}) {
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlockBlobClient-stageBlock", options, async (updatedOptions) => {
+ return assertResponse(await this.blockBlobContext.stageBlock(blockId, contentLength, body, {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ requestOptions: {
+ onUploadProgress: options.onProgress,
+ },
+ transactionalContentMD5: options.transactionalContentMD5,
+ transactionalContentCrc64: options.transactionalContentCrc64,
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * The Stage Block From URL operation creates a new block to be committed as part
+ * of a blob where the contents are read from a URL.
+ * This API is available starting in version 2018-03-28.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/put-block-from-url
+ *
+ * @param blockId - A 64-byte value that is base64-encoded
+ * @param sourceURL - Specifies the URL of the blob. The value
+ * may be a URL of up to 2 KB in length that specifies a blob.
+ * The value should be URL-encoded as it would appear
+ * in a request URI. The source blob must either be public
+ * or must be authenticated via a shared access signature.
+ * If the source blob is public, no authentication is required
+ * to perform the operation. Here are some examples of source object URLs:
+ * - https://myaccount.blob.core.windows.net/mycontainer/myblob
+ * - https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
+ * @param offset - From which position of the blob to download, greater than or equal to 0
+ * @param count - How much data to be downloaded, greater than 0. Will download to the end when undefined
+ * @param options - Options to the Block Blob Stage Block From URL operation.
+ * @returns Response data for the Block Blob Stage Block From URL operation.
+ */
+ async stageBlockFromURL(blockId, sourceURL, offset = 0, count, options = {}) {
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlockBlobClient-stageBlockFromURL", options, async (updatedOptions) => {
+ return assertResponse(await this.blockBlobContext.stageBlockFromURL(blockId, 0, sourceURL, {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ sourceContentMD5: options.sourceContentMD5,
+ sourceContentCrc64: options.sourceContentCrc64,
+ sourceRange: offset === 0 && !count ? undefined : rangeToString({ offset, count }),
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Writes a blob by specifying the list of block IDs that make up the blob.
+ * In order to be written as part of a blob, a block must have been successfully written
+ * to the server in a prior {@link stageBlock} operation. You can call {@link commitBlockList} to
+ * update a blob by uploading only those blocks that have changed, then committing the new and existing
+ * blocks together. Any blocks not specified in the block list and permanently deleted.
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-block-list
+ *
+ * @param blocks - Array of 64-byte value that is base64-encoded
+ * @param options - Options to the Block Blob Commit Block List operation.
+ * @returns Response data for the Block Blob Commit Block List operation.
+ */
+ async commitBlockList(blocks, options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("BlockBlobClient-commitBlockList", options, async (updatedOptions) => {
+ var _a, _b, _c;
+ return assertResponse(await this.blockBlobContext.commitBlockList({ latest: blocks }, {
+ abortSignal: options.abortSignal,
+ blobHttpHeaders: options.blobHTTPHeaders,
+ leaseAccessConditions: options.conditions,
+ metadata: options.metadata,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn,
+ immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode,
+ legalHold: options.legalHold,
+ tier: toAccessTier(options.tier),
+ blobTagsString: toBlobTagsString(options.tags),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Returns the list of blocks that have been uploaded as part of a block blob
+ * using the specified block list filter.
+ * @see https://docs.microsoft.com/rest/api/storageservices/get-block-list
+ *
+ * @param listType - Specifies whether to return the list of committed blocks,
+ * the list of uncommitted blocks, or both lists together.
+ * @param options - Options to the Block Blob Get Block List operation.
+ * @returns Response data for the Block Blob Get Block List operation.
+ */
+ async getBlockList(listType, options = {}) {
+ return tracingClient.withSpan("BlockBlobClient-getBlockList", options, async (updatedOptions) => {
+ var _a;
+ const res = assertResponse(await this.blockBlobContext.getBlockList(listType, {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ if (!res.committedBlocks) {
+ res.committedBlocks = [];
}
- else {
- await batch.deleteBlob(urlOrBlobClient, credentialOrOptions);
+ if (!res.uncommittedBlocks) {
+ res.uncommittedBlocks = [];
}
- }
- return this.submitBatch(batch);
+ return res;
+ });
}
- async setBlobsAccessTier(urlsOrBlobClients, credentialOrTier, tierOrOptions,
- // Legacy, no fix for eslint error without breaking. Disable it for this interface.
- /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
- options) {
- const batch = new BlobBatch();
- for (const urlOrBlobClient of urlsOrBlobClients) {
- if (typeof urlOrBlobClient === "string") {
- await batch.setBlobAccessTier(urlOrBlobClient, credentialOrTier, tierOrOptions, options);
+ // High level functions
+ /**
+ * Uploads a Buffer(Node.js)/Blob(browsers)/ArrayBuffer/ArrayBufferView object to a BlockBlob.
+ *
+ * When data length is no more than the specifiled {@link BlockBlobParallelUploadOptions.maxSingleShotSize} (default is
+ * {@link BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES}), this method will use 1 {@link upload} call to finish the upload.
+ * Otherwise, this method will call {@link stageBlock} to upload blocks, and finally call {@link commitBlockList}
+ * to commit the block list.
+ *
+ * A common {@link BlockBlobParallelUploadOptions.blobHTTPHeaders} option to set is
+ * `blobContentType`, enabling the browser to provide
+ * functionality based on file type.
+ *
+ * @param data - Buffer(Node.js), Blob, ArrayBuffer or ArrayBufferView
+ * @param options -
+ */
+ async uploadData(data, options = {}) {
+ return tracingClient.withSpan("BlockBlobClient-uploadData", options, async (updatedOptions) => {
+ if (coreUtil.isNode) {
+ let buffer;
+ if (data instanceof Buffer) {
+ buffer = data;
+ }
+ else if (data instanceof ArrayBuffer) {
+ buffer = Buffer.from(data);
+ }
+ else {
+ data = data;
+ buffer = Buffer.from(data.buffer, data.byteOffset, data.byteLength);
+ }
+ return this.uploadSeekableInternal((offset, size) => buffer.slice(offset, offset + size), buffer.byteLength, updatedOptions);
}
else {
- await batch.setBlobAccessTier(urlOrBlobClient, credentialOrTier, tierOrOptions);
+ const browserBlob = new Blob([data]);
+ return this.uploadSeekableInternal((offset, size) => browserBlob.slice(offset, offset + size), browserBlob.size, updatedOptions);
}
- }
- return this.submitBatch(batch);
+ });
}
/**
- * Submit batch request which consists of multiple subrequests.
+ * ONLY AVAILABLE IN BROWSERS.
*
- * Get `blobBatchClient` and other details before running the snippets.
- * `blobServiceClient.getBlobBatchClient()` gives the `blobBatchClient`
+ * Uploads a browser Blob/File/ArrayBuffer/ArrayBufferView object to block blob.
*
- * Example usage:
+ * When buffer length lesser than or equal to 256MB, this method will use 1 upload call to finish the upload.
+ * Otherwise, this method will call {@link stageBlock} to upload blocks, and finally call
+ * {@link commitBlockList} to commit the block list.
*
- * ```js
- * let batchRequest = new BlobBatch();
- * await batchRequest.deleteBlob(urlInString0, credential0);
- * await batchRequest.deleteBlob(urlInString1, credential1, {
- * deleteSnapshots: "include"
- * });
- * const batchResp = await blobBatchClient.submitBatch(batchRequest);
- * console.log(batchResp.subResponsesSucceededCount);
- * ```
+ * A common {@link BlockBlobParallelUploadOptions.blobHTTPHeaders} option to set is
+ * `blobContentType`, enabling the browser to provide
+ * functionality based on file type.
*
- * Example using a lease:
+ * @deprecated Use {@link uploadData} instead.
*
- * ```js
- * let batchRequest = new BlobBatch();
- * await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
- * await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
- * conditions: { leaseId: leaseId }
- * });
- * const batchResp = await blobBatchClient.submitBatch(batchRequest);
- * console.log(batchResp.subResponsesSucceededCount);
- * ```
+ * @param browserData - Blob, File, ArrayBuffer or ArrayBufferView
+ * @param options - Options to upload browser data.
+ * @returns Response data for the Blob Upload operation.
+ */
+ async uploadBrowserData(browserData, options = {}) {
+ return tracingClient.withSpan("BlockBlobClient-uploadBrowserData", options, async (updatedOptions) => {
+ const browserBlob = new Blob([browserData]);
+ return this.uploadSeekableInternal((offset, size) => browserBlob.slice(offset, offset + size), browserBlob.size, updatedOptions);
+ });
+ }
+ /**
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
+ * Uploads data to block blob. Requires a bodyFactory as the data source,
+ * which need to return a {@link HttpRequestBody} object with the offset and size provided.
*
- * @param batchRequest - A set of Delete or SetTier operations.
- * @param options -
+ * When data length is no more than the specified {@link BlockBlobParallelUploadOptions.maxSingleShotSize} (default is
+ * {@link BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES}), this method will use 1 {@link upload} call to finish the upload.
+ * Otherwise, this method will call {@link stageBlock} to upload blocks, and finally call {@link commitBlockList}
+ * to commit the block list.
+ *
+ * @param bodyFactory -
+ * @param size - size of the data to upload.
+ * @param options - Options to Upload to Block Blob operation.
+ * @returns Response data for the Blob Upload operation.
*/
- async submitBatch(batchRequest, options = {}) {
- if (!batchRequest || batchRequest.getSubRequests().size === 0) {
- throw new RangeError("Batch request should contain one or more sub requests.");
+ async uploadSeekableInternal(bodyFactory, size, options = {}) {
+ var _a, _b;
+ let blockSize = (_a = options.blockSize) !== null && _a !== void 0 ? _a : 0;
+ if (blockSize < 0 || blockSize > BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES) {
+ throw new RangeError(`blockSize option must be >= 0 and <= ${BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES}`);
}
- const { span, updatedOptions } = createSpan("BlobBatchClient-submitBatch", options);
- try {
- const batchRequestBody = batchRequest.getHttpRequestBody();
- // ServiceSubmitBatchResponseModel and ContainerSubmitBatchResponse are compatible for now.
- const rawBatchResponse = await this.serviceOrContainerContext.submitBatch(utf8ByteLength(batchRequestBody), batchRequest.getMultiPartContentType(), batchRequestBody, Object.assign(Object.assign({}, options), convertTracingToRequestOptionsBase(updatedOptions)));
- // Parse the sub responses result, if logic reaches here(i.e. the batch request succeeded with status code 202).
- const batchResponseParser = new BatchResponseParser(rawBatchResponse, batchRequest.getSubRequests());
- const responseSummary = await batchResponseParser.parseBatchResponse();
- const res = {
- _response: rawBatchResponse._response,
- contentType: rawBatchResponse.contentType,
- errorCode: rawBatchResponse.errorCode,
- requestId: rawBatchResponse.requestId,
- clientRequestId: rawBatchResponse.clientRequestId,
- version: rawBatchResponse.version,
- subResponses: responseSummary.subResponses,
- subResponsesSucceededCount: responseSummary.subResponsesSucceededCount,
- subResponsesFailedCount: responseSummary.subResponsesFailedCount,
- };
- return res;
+ const maxSingleShotSize = (_b = options.maxSingleShotSize) !== null && _b !== void 0 ? _b : BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES;
+ if (maxSingleShotSize < 0 || maxSingleShotSize > BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES) {
+ throw new RangeError(`maxSingleShotSize option must be >= 0 and <= ${BLOCK_BLOB_MAX_UPLOAD_BLOB_BYTES}`);
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (blockSize === 0) {
+ if (size > BLOCK_BLOB_MAX_STAGE_BLOCK_BYTES * BLOCK_BLOB_MAX_BLOCKS) {
+ throw new RangeError(`${size} is too larger to upload to a block blob.`);
+ }
+ if (size > maxSingleShotSize) {
+ blockSize = Math.ceil(size / BLOCK_BLOB_MAX_BLOCKS);
+ if (blockSize < DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES) {
+ blockSize = DEFAULT_BLOB_DOWNLOAD_BLOCK_BYTES;
+ }
+ }
+ }
+ if (!options.blobHTTPHeaders) {
+ options.blobHTTPHeaders = {};
+ }
+ if (!options.conditions) {
+ options.conditions = {};
+ }
+ return tracingClient.withSpan("BlockBlobClient-uploadSeekableInternal", options, async (updatedOptions) => {
+ if (size <= maxSingleShotSize) {
+ return assertResponse(await this.upload(bodyFactory(0, size), size, updatedOptions));
+ }
+ const numBlocks = Math.floor((size - 1) / blockSize) + 1;
+ if (numBlocks > BLOCK_BLOB_MAX_BLOCKS) {
+ throw new RangeError(`The buffer's size is too big or the BlockSize is too small;` +
+ `the number of blocks must be <= ${BLOCK_BLOB_MAX_BLOCKS}`);
+ }
+ const blockList = [];
+ const blockIDPrefix = coreUtil.randomUUID();
+ let transferProgress = 0;
+ const batch = new Batch(options.concurrency);
+ for (let i = 0; i < numBlocks; i++) {
+ batch.addOperation(async () => {
+ const blockID = generateBlockID(blockIDPrefix, i);
+ const start = blockSize * i;
+ const end = i === numBlocks - 1 ? size : start + blockSize;
+ const contentLength = end - start;
+ blockList.push(blockID);
+ await this.stageBlock(blockID, bodyFactory(start, contentLength), contentLength, {
+ abortSignal: options.abortSignal,
+ conditions: options.conditions,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ });
+ // Update progress after block is successfully uploaded to server, in case of block trying
+ // TODO: Hook with convenience layer progress event in finer level
+ transferProgress += contentLength;
+ if (options.onProgress) {
+ options.onProgress({
+ loadedBytes: transferProgress,
+ });
+ }
+ });
+ }
+ await batch.do();
+ return this.commitBlockList(blockList, updatedOptions);
+ });
+ }
+ /**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Uploads a local file in blocks to a block blob.
+ *
+ * When file size lesser than or equal to 256MB, this method will use 1 upload call to finish the upload.
+ * Otherwise, this method will call stageBlock to upload blocks, and finally call commitBlockList
+ * to commit the block list.
+ *
+ * @param filePath - Full path of local file
+ * @param options - Options to Upload to Block Blob operation.
+ * @returns Response data for the Blob Upload operation.
+ */
+ async uploadFile(filePath, options = {}) {
+ return tracingClient.withSpan("BlockBlobClient-uploadFile", options, async (updatedOptions) => {
+ const size = (await fsStat(filePath)).size;
+ return this.uploadSeekableInternal((offset, count) => {
+ return () => fsCreateReadStream(filePath, {
+ autoClose: true,
+ end: count ? offset + count - 1 : Infinity,
+ start: offset,
+ });
+ }, size, Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions }));
+ });
+ }
+ /**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Uploads a Node.js Readable stream into block blob.
+ *
+ * PERFORMANCE IMPROVEMENT TIPS:
+ * * Input stream highWaterMark is better to set a same value with bufferSize
+ * parameter, which will avoid Buffer.concat() operations.
+ *
+ * @param stream - Node.js Readable stream
+ * @param bufferSize - Size of every buffer allocated, also the block size in the uploaded block blob. Default value is 8MB
+ * @param maxConcurrency - Max concurrency indicates the max number of buffers that can be allocated,
+ * positive correlation with max uploading concurrency. Default value is 5
+ * @param options - Options to Upload Stream to Block Blob operation.
+ * @returns Response data for the Blob Upload operation.
+ */
+ async uploadStream(stream, bufferSize = DEFAULT_BLOCK_BUFFER_SIZE_BYTES, maxConcurrency = 5, options = {}) {
+ if (!options.blobHTTPHeaders) {
+ options.blobHTTPHeaders = {};
}
- finally {
- span.end();
+ if (!options.conditions) {
+ options.conditions = {};
}
+ return tracingClient.withSpan("BlockBlobClient-uploadStream", options, async (updatedOptions) => {
+ let blockNum = 0;
+ const blockIDPrefix = coreUtil.randomUUID();
+ let transferProgress = 0;
+ const blockList = [];
+ const scheduler = new BufferScheduler(stream, bufferSize, maxConcurrency, async (body, length) => {
+ const blockID = generateBlockID(blockIDPrefix, blockNum);
+ blockList.push(blockID);
+ blockNum++;
+ await this.stageBlock(blockID, body, length, {
+ conditions: options.conditions,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ });
+ // Update progress after block is successfully uploaded to server, in case of block trying
+ transferProgress += length;
+ if (options.onProgress) {
+ options.onProgress({ loadedBytes: transferProgress });
+ }
+ },
+ // concurrency should set a smaller value than maxConcurrency, which is helpful to
+ // reduce the possibility when a outgoing handler waits for stream data, in
+ // this situation, outgoing handlers are blocked.
+ // Outgoing queue shouldn't be empty.
+ Math.ceil((maxConcurrency / 4) * 3));
+ await scheduler.do();
+ return assertResponse(await this.commitBlockList(blockList, Object.assign(Object.assign({}, options), { tracingOptions: updatedOptions.tracingOptions })));
+ });
}
}
-
/**
- * A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs.
+ * PageBlobClient defines a set of operations applicable to page blobs.
*/
-class ContainerClient extends StorageClient {
- constructor(urlOrConnectionString, credentialOrPipelineOrContainerName,
+class PageBlobClient extends BlobClient {
+ constructor(urlOrConnectionString, credentialOrPipelineOrContainerName, blobNameOrOptions,
// Legacy, no fix for eslint error without breaking. Disable it for this interface.
/* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
options) {
+ // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead.
+ // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options);
let pipeline;
let url;
options = options || {};
@@ -39869,11 +29541,12 @@ class ContainerClient extends StorageClient {
url = urlOrConnectionString;
pipeline = credentialOrPipelineOrContainerName;
}
- else if ((coreHttp.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
+ else if ((coreUtil.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
- coreHttp.isTokenCredential(credentialOrPipelineOrContainerName)) {
+ coreAuth.isTokenCredential(credentialOrPipelineOrContainerName)) {
// (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
url = urlOrConnectionString;
+ options = blobNameOrOptions;
pipeline = newPipeline(credentialOrPipelineOrContainerName, options);
}
else if (!credentialOrPipelineOrContainerName &&
@@ -39884,16 +29557,19 @@ class ContainerClient extends StorageClient {
pipeline = newPipeline(new AnonymousCredential(), options);
}
else if (credentialOrPipelineOrContainerName &&
- typeof credentialOrPipelineOrContainerName === "string") {
+ typeof credentialOrPipelineOrContainerName === "string" &&
+ blobNameOrOptions &&
+ typeof blobNameOrOptions === "string") {
// (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
const containerName = credentialOrPipelineOrContainerName;
+ const blobName = blobNameOrOptions;
const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
if (extractedCreds.kind === "AccountConnString") {
- if (coreHttp.isNode) {
+ if (coreUtil.isNode) {
const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
- url = appendToURLPath(extractedCreds.url, encodeURIComponent(containerName));
+ url = appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName));
if (!options.proxyOptions) {
- options.proxyOptions = coreHttp.getDefaultProxySettings(extractedCreds.proxyUri);
+ options.proxyOptions = coreRestPipeline.getDefaultProxySettings(extractedCreds.proxyUri);
}
pipeline = newPipeline(sharedKeyCredential, options);
}
@@ -39903,7 +29579,7 @@ class ContainerClient extends StorageClient {
}
else if (extractedCreds.kind === "SASConnString") {
url =
- appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)) +
+ appendToURLPath(appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)), encodeURIComponent(blobName)) +
"?" +
extractedCreds.accountSas;
pipeline = newPipeline(new AnonymousCredential(), options);
@@ -39913,1982 +29589,2136 @@ class ContainerClient extends StorageClient {
}
}
else {
- throw new Error("Expecting non-empty strings for containerName parameter");
+ throw new Error("Expecting non-empty strings for containerName and blobName parameters");
}
super(url, pipeline);
- this._containerName = this.getContainerNameFromUrl();
- this.containerContext = new Container(this.storageClientContext);
+ this.pageBlobContext = this.storageClientContext.pageBlob;
}
/**
- * The name of the container.
+ * Creates a new PageBlobClient object identical to the source but with the
+ * specified snapshot timestamp.
+ * Provide "" will remove the snapshot and return a Client to the base blob.
+ *
+ * @param snapshot - The snapshot timestamp.
+ * @returns A new PageBlobClient object identical to the source but with the specified snapshot timestamp.
*/
- get containerName() {
- return this._containerName;
+ withSnapshot(snapshot) {
+ return new PageBlobClient(setURLParameter(this.url, URLConstants.Parameters.SNAPSHOT, snapshot.length === 0 ? undefined : snapshot), this.pipeline);
}
/**
- * Creates a new container under the specified account. If the container with
- * the same name already exists, the operation fails.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
- * Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
- *
- * @param options - Options to Container Create operation.
- *
- *
- * Example usage:
+ * Creates a page blob of the specified length. Call uploadPages to upload data
+ * data to a page blob.
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
*
- * ```js
- * const containerClient = blobServiceClient.getContainerClient("");
- * const createContainerResponse = await containerClient.create();
- * console.log("Container was created successfully", createContainerResponse.requestId);
- * ```
+ * @param size - size of the page blob.
+ * @param options - Options to the Page Blob Create operation.
+ * @returns Response data for the Page Blob Create operation.
*/
- async create(options = {}) {
- const { span, updatedOptions } = createSpan("ContainerClient-create", options);
- try {
- // Spread operator in destructuring assignments,
- // this will filter out unwanted properties from the response object into result object
- return await this.containerContext.create(Object.assign(Object.assign({}, options), convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ async create(size, options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("PageBlobClient-create", options, async (updatedOptions) => {
+ var _a, _b, _c;
+ return assertResponse(await this.pageBlobContext.create(0, size, {
+ abortSignal: options.abortSignal,
+ blobHttpHeaders: options.blobHTTPHeaders,
+ blobSequenceNumber: options.blobSequenceNumber,
+ leaseAccessConditions: options.conditions,
+ metadata: options.metadata,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ immutabilityPolicyExpiry: (_b = options.immutabilityPolicy) === null || _b === void 0 ? void 0 : _b.expiriesOn,
+ immutabilityPolicyMode: (_c = options.immutabilityPolicy) === null || _c === void 0 ? void 0 : _c.policyMode,
+ legalHold: options.legalHold,
+ tier: toAccessTier(options.tier),
+ blobTagsString: toBlobTagsString(options.tags),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Creates a new container under the specified account. If the container with
- * the same name already exists, it is not changed.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
- * Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
+ * Creates a page blob of the specified length. Call uploadPages to upload data
+ * data to a page blob. If the blob with the same name already exists, the content
+ * of the existing blob will remain unchanged.
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
*
+ * @param size - size of the page blob.
* @param options -
*/
- async createIfNotExists(options = {}) {
- var _a, _b;
- const { span, updatedOptions } = createSpan("ContainerClient-createIfNotExists", options);
- try {
- const res = await this.create(updatedOptions);
- return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
- }
- catch (e) {
- if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "ContainerAlreadyExists") {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: "Expected exception when creating a container only if it does not already exist.",
- });
- return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+ async createIfNotExists(size, options = {}) {
+ return tracingClient.withSpan("PageBlobClient-createIfNotExists", options, async (updatedOptions) => {
+ var _a, _b;
+ try {
+ const conditions = { ifNoneMatch: ETagAny };
+ const res = assertResponse(await this.create(size, Object.assign(Object.assign({}, options), { conditions, tracingOptions: updatedOptions.tracingOptions })));
+ return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
}
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ catch (e) {
+ if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "BlobAlreadyExists") {
+ return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+ }
+ throw e;
+ }
+ });
}
/**
- * Returns true if the Azure container resource represented by this client exists; false otherwise.
+ * Writes 1 or more pages to the page blob. The start and end offsets must be a multiple of 512.
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-page
*
- * NOTE: use this function with care since an existing container might be deleted by other clients or
- * applications. Vice versa new containers with the same name might be added by other clients or
- * applications after this function completes.
+ * @param body - Data to upload
+ * @param offset - Offset of destination page blob
+ * @param count - Content length of the body, also number of bytes to be uploaded
+ * @param options - Options to the Page Blob Upload Pages operation.
+ * @returns Response data for the Page Blob Upload Pages operation.
+ */
+ async uploadPages(body, offset, count, options = {}) {
+ options.conditions = options.conditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("PageBlobClient-uploadPages", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.pageBlobContext.uploadPages(count, body, {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ requestOptions: {
+ onUploadProgress: options.onProgress,
+ },
+ range: rangeToString({ offset, count }),
+ sequenceNumberAccessConditions: options.conditions,
+ transactionalContentMD5: options.transactionalContentMD5,
+ transactionalContentCrc64: options.transactionalContentCrc64,
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * The Upload Pages operation writes a range of pages to a page blob where the
+ * contents are read from a URL.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/put-page-from-url
*
+ * @param sourceURL - Specify a URL to the copy source, Shared Access Signature(SAS) maybe needed for authentication
+ * @param sourceOffset - The source offset to copy from. Pass 0 to copy from the beginning of source page blob
+ * @param destOffset - Offset of destination page blob
+ * @param count - Number of bytes to be uploaded from source page blob
* @param options -
*/
- async exists(options = {}) {
- const { span, updatedOptions } = createSpan("ContainerClient-exists", options);
- try {
- await this.getProperties({
+ async uploadPagesFromURL(sourceURL, sourceOffset, destOffset, count, options = {}) {
+ options.conditions = options.conditions || {};
+ options.sourceConditions = options.sourceConditions || {};
+ ensureCpkIfSpecified(options.customerProvidedKey, this.isHttps);
+ return tracingClient.withSpan("PageBlobClient-uploadPagesFromURL", options, async (updatedOptions) => {
+ var _a, _b, _c, _d, _e;
+ return assertResponse(await this.pageBlobContext.uploadPagesFromURL(sourceURL, rangeToString({ offset: sourceOffset, count }), 0, rangeToString({ offset: destOffset, count }), {
abortSignal: options.abortSignal,
+ sourceContentMD5: options.sourceContentMD5,
+ sourceContentCrc64: options.sourceContentCrc64,
+ leaseAccessConditions: options.conditions,
+ sequenceNumberAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ sourceModifiedAccessConditions: {
+ sourceIfMatch: (_b = options.sourceConditions) === null || _b === void 0 ? void 0 : _b.ifMatch,
+ sourceIfModifiedSince: (_c = options.sourceConditions) === null || _c === void 0 ? void 0 : _c.ifModifiedSince,
+ sourceIfNoneMatch: (_d = options.sourceConditions) === null || _d === void 0 ? void 0 : _d.ifNoneMatch,
+ sourceIfUnmodifiedSince: (_e = options.sourceConditions) === null || _e === void 0 ? void 0 : _e.ifUnmodifiedSince,
+ },
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ copySourceAuthorization: httpAuthorizationToString(options.sourceAuthorization),
tracingOptions: updatedOptions.tracingOptions,
- });
- return true;
- }
- catch (e) {
- if (e.statusCode === 404) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: "Expected exception when checking container existence",
- });
- return false;
- }
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ }));
+ });
}
/**
- * Creates a {@link BlobClient}
+ * Frees the specified pages from the page blob.
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-page
*
- * @param blobName - A blob name
- * @returns A new BlobClient object for the given blob name.
+ * @param offset - Starting byte position of the pages to clear.
+ * @param count - Number of bytes to clear.
+ * @param options - Options to the Page Blob Clear Pages operation.
+ * @returns Response data for the Page Blob Clear Pages operation.
*/
- getBlobClient(blobName) {
- return new BlobClient(appendToURLPath(this.url, EscapePath(blobName)), this.pipeline);
+ async clearPages(offset = 0, count, options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("PageBlobClient-clearPages", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.pageBlobContext.clearPages(0, {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ range: rangeToString({ offset, count }),
+ sequenceNumberAccessConditions: options.conditions,
+ cpkInfo: options.customerProvidedKey,
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Creates an {@link AppendBlobClient}
+ * Returns the list of valid page ranges for a page blob or snapshot of a page blob.
+ * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
*
- * @param blobName - An append blob name
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param options - Options to the Page Blob Get Ranges operation.
+ * @returns Response data for the Page Blob Get Ranges operation.
*/
- getAppendBlobClient(blobName) {
- return new AppendBlobClient(appendToURLPath(this.url, EscapePath(blobName)), this.pipeline);
+ async getPageRanges(offset = 0, count, options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("PageBlobClient-getPageRanges", options, async (updatedOptions) => {
+ var _a;
+ const response = assertResponse(await this.pageBlobContext.getPageRanges({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ range: rangeToString({ offset, count }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ return rangeResponseFromModel(response);
+ });
}
/**
- * Creates a {@link BlockBlobClient}
+ * getPageRangesSegment returns a single segment of page ranges starting from the
+ * specified Marker. Use an empty Marker to start enumeration from the beginning.
+ * After getting a segment, process it, and then call getPageRangesSegment again
+ * (passing the the previously-returned Marker) to get the next segment.
+ * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
*
- * @param blobName - A block blob name
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
+ * @param options - Options to PageBlob Get Page Ranges Segment operation.
+ */
+ async listPageRangesSegment(offset = 0, count, marker, options = {}) {
+ return tracingClient.withSpan("PageBlobClient-getPageRangesSegment", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.pageBlobContext.getPageRanges({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ range: rangeToString({ offset, count }),
+ marker: marker,
+ maxPageSize: options.maxPageSize,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Returns an AsyncIterableIterator for {@link PageBlobGetPageRangesResponseModel}
*
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param marker - A string value that identifies the portion of
+ * the get of page ranges to be returned with the next getting operation. The
+ * operation returns the ContinuationToken value within the response body if the
+ * getting operation did not return all page ranges remaining within the current page.
+ * The ContinuationToken value can be used as the value for
+ * the marker parameter in a subsequent call to request the next page of get
+ * items. The marker value is opaque to the client.
+ * @param options - Options to List Page Ranges operation.
+ */
+ listPageRangeItemSegments() {
+ return tslib.__asyncGenerator(this, arguments, function* listPageRangeItemSegments_1(offset = 0, count, marker, options = {}) {
+ let getPageRangeItemSegmentsResponse;
+ if (!!marker || marker === undefined) {
+ do {
+ getPageRangeItemSegmentsResponse = yield tslib.__await(this.listPageRangesSegment(offset, count, marker, options));
+ marker = getPageRangeItemSegmentsResponse.continuationToken;
+ yield yield tslib.__await(yield tslib.__await(getPageRangeItemSegmentsResponse));
+ } while (marker);
+ }
+ });
+ }
+ /**
+ * Returns an AsyncIterableIterator of {@link PageRangeInfo} objects
*
- * Example usage:
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param options - Options to List Page Ranges operation.
+ */
+ listPageRangeItems() {
+ return tslib.__asyncGenerator(this, arguments, function* listPageRangeItems_1(offset = 0, count, options = {}) {
+ var _a, e_1, _b, _c;
+ let marker;
+ try {
+ for (var _d = true, _e = tslib.__asyncValues(this.listPageRangeItemSegments(offset, count, marker, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+ _c = _f.value;
+ _d = false;
+ const getPageRangesSegment = _c;
+ yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(ExtractPageRangeInfoItems(getPageRangesSegment))));
+ }
+ }
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
+ finally {
+ try {
+ if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
+ }
+ finally { if (e_1) throw e_1.error; }
+ }
+ });
+ }
+ /**
+ * Returns an async iterable iterator to list of page ranges for a page blob.
+ * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
+ *
+ * .byPage() returns an async iterable iterator to list of page ranges for a page blob.
+ *
+ * Example using `for await` syntax:
*
* ```js
- * const content = "Hello world!";
+ * // Get the pageBlobClient before you run these snippets,
+ * // Can be obtained from `blobServiceClient.getContainerClient("").getPageBlobClient("");`
+ * let i = 1;
+ * for await (const pageRange of pageBlobClient.listPageRanges()) {
+ * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * }
+ * ```
*
- * const blockBlobClient = containerClient.getBlockBlobClient("");
- * const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
+ * Example using `iter.next()`:
+ *
+ * ```js
+ * let i = 1;
+ * let iter = pageBlobClient.listPageRanges();
+ * let pageRangeItem = await iter.next();
+ * while (!pageRangeItem.done) {
+ * console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
+ * pageRangeItem = await iter.next();
+ * }
+ * ```
+ *
+ * Example using `byPage()`:
+ *
+ * ```js
+ * // passing optional maxPageSize in the page settings
+ * let i = 1;
+ * for await (const response of pageBlobClient.listPageRanges().byPage({ maxPageSize: 20 })) {
+ * for (const pageRange of response) {
+ * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * }
+ * }
+ * ```
+ *
+ * Example using paging with a marker:
+ *
+ * ```js
+ * let i = 1;
+ * let iterator = pageBlobClient.listPageRanges().byPage({ maxPageSize: 2 });
+ * let response = (await iterator.next()).value;
+ *
+ * // Prints 2 page ranges
+ * for (const pageRange of response) {
+ * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * }
+ *
+ * // Gets next marker
+ * let marker = response.continuationToken;
+ *
+ * // Passing next marker as continuationToken
+ *
+ * iterator = pageBlobClient.listPageRanges().byPage({ continuationToken: marker, maxPageSize: 10 });
+ * response = (await iterator.next()).value;
+ *
+ * // Prints 10 page ranges
+ * for (const blob of response) {
+ * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * }
* ```
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param options - Options to the Page Blob Get Ranges operation.
+ * @returns An asyncIterableIterator that supports paging.
*/
- getBlockBlobClient(blobName) {
- return new BlockBlobClient(appendToURLPath(this.url, EscapePath(blobName)), this.pipeline);
+ listPageRanges(offset = 0, count, options = {}) {
+ options.conditions = options.conditions || {};
+ // AsyncIterableIterator to iterate over blobs
+ const iter = this.listPageRangeItems(offset, count, options);
+ return {
+ /**
+ * The next method, part of the iteration protocol
+ */
+ next() {
+ return iter.next();
+ },
+ /**
+ * The connection to the async iterator, part of the iteration protocol
+ */
+ [Symbol.asyncIterator]() {
+ return this;
+ },
+ /**
+ * Return an AsyncIterableIterator that works a page at a time
+ */
+ byPage: (settings = {}) => {
+ return this.listPageRangeItemSegments(offset, count, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, options));
+ },
+ };
}
/**
- * Creates a {@link PageBlobClient}
+ * Gets the collection of page ranges that differ between a specified snapshot and this page blob.
+ * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
*
- * @param blobName - A page blob name
+ * @param offset - Starting byte position of the page blob
+ * @param count - Number of bytes to get ranges diff.
+ * @param prevSnapshot - Timestamp of snapshot to retrieve the difference.
+ * @param options - Options to the Page Blob Get Page Ranges Diff operation.
+ * @returns Response data for the Page Blob Get Page Range Diff operation.
*/
- getPageBlobClient(blobName) {
- return new PageBlobClient(appendToURLPath(this.url, EscapePath(blobName)), this.pipeline);
+ async getPageRangesDiff(offset, count, prevSnapshot, options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("PageBlobClient-getPageRangesDiff", options, async (updatedOptions) => {
+ var _a;
+ const result = assertResponse(await this.pageBlobContext.getPageRangesDiff({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ prevsnapshot: prevSnapshot,
+ range: rangeToString({ offset, count }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ return rangeResponseFromModel(result);
+ });
}
/**
- * Returns all user-defined metadata and system properties for the specified
- * container. The data returned does not include the container's list of blobs.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-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 `listContainers` method of {@link BlobServiceClient} using the `includeMetadata` option, which
- * will retain their original casing.
+ * getPageRangesDiffSegment returns a single segment of page ranges starting from the
+ * specified Marker for difference between previous snapshot and the target page blob.
+ * Use an empty Marker to start enumeration from the beginning.
+ * After getting a segment, process it, and then call getPageRangesDiffSegment again
+ * (passing the the previously-returned Marker) to get the next segment.
+ * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
*
- * @param options - Options to Container Get Properties operation.
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param prevSnapshotOrUrl - Timestamp of snapshot to retrieve the difference or URL of snapshot to retrieve the difference.
+ * @param marker - A string value that identifies the portion of the get to be returned with the next get operation.
+ * @param options - Options to the Page Blob Get Page Ranges Diff operation.
*/
- async getProperties(options = {}) {
- if (!options.conditions) {
- options.conditions = {};
- }
- const { span, updatedOptions } = createSpan("ContainerClient-getProperties", options);
- try {
- return await this.containerContext.getProperties(Object.assign(Object.assign({ abortSignal: options.abortSignal }, options.conditions), convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ async listPageRangesDiffSegment(offset, count, prevSnapshotOrUrl, marker, options = {}) {
+ return tracingClient.withSpan("PageBlobClient-getPageRangesDiffSegment", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.pageBlobContext.getPageRangesDiff({
+ abortSignal: options === null || options === void 0 ? void 0 : options.abortSignal,
+ leaseAccessConditions: options === null || options === void 0 ? void 0 : options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options === null || options === void 0 ? void 0 : options.conditions), { ifTags: (_a = options === null || options === void 0 ? void 0 : options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ prevsnapshot: prevSnapshotOrUrl,
+ range: rangeToString({
+ offset: offset,
+ count: count,
+ }),
+ marker: marker,
+ maxPageSize: options === null || options === void 0 ? void 0 : options.maxPageSize,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Marks the specified container for deletion. The container and any blobs
- * contained within it are later deleted during garbage collection.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
+ * Returns an AsyncIterableIterator for {@link PageBlobGetPageRangesDiffResponseModel}
*
- * @param options - Options to Container Delete operation.
+ *
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param prevSnapshotOrUrl - Timestamp of snapshot to retrieve the difference or URL of snapshot to retrieve the difference.
+ * @param marker - A string value that identifies the portion of
+ * the get of page ranges to be returned with the next getting operation. The
+ * operation returns the ContinuationToken value within the response body if the
+ * getting operation did not return all page ranges remaining within the current page.
+ * The ContinuationToken value can be used as the value for
+ * the marker parameter in a subsequent call to request the next page of get
+ * items. The marker value is opaque to the client.
+ * @param options - Options to the Page Blob Get Page Ranges Diff operation.
*/
- async delete(options = {}) {
- if (!options.conditions) {
- options.conditions = {};
- }
- const { span, updatedOptions } = createSpan("ContainerClient-delete", options);
- try {
- return await this.containerContext.delete(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, modifiedAccessConditions: options.conditions }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ listPageRangeDiffItemSegments(offset, count, prevSnapshotOrUrl, marker, options) {
+ return tslib.__asyncGenerator(this, arguments, function* listPageRangeDiffItemSegments_1() {
+ let getPageRangeItemSegmentsResponse;
+ if (!!marker || marker === undefined) {
+ do {
+ getPageRangeItemSegmentsResponse = yield tslib.__await(this.listPageRangesDiffSegment(offset, count, prevSnapshotOrUrl, marker, options));
+ marker = getPageRangeItemSegmentsResponse.continuationToken;
+ yield yield tslib.__await(yield tslib.__await(getPageRangeItemSegmentsResponse));
+ } while (marker);
+ }
+ });
}
/**
- * Marks the specified container for deletion if it exists. The container and any blobs
- * contained within it are later deleted during garbage collection.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
+ * Returns an AsyncIterableIterator of {@link PageRangeInfo} objects
*
- * @param options - Options to Container Delete operation.
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param prevSnapshotOrUrl - Timestamp of snapshot to retrieve the difference or URL of snapshot to retrieve the difference.
+ * @param options - Options to the Page Blob Get Page Ranges Diff operation.
*/
- async deleteIfExists(options = {}) {
- var _a, _b;
- const { span, updatedOptions } = createSpan("ContainerClient-deleteIfExists", options);
- try {
- const res = await this.delete(updatedOptions);
- return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
- }
- catch (e) {
- if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "ContainerNotFound") {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: "Expected exception when deleting a container only if it exists.",
- });
- return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+ listPageRangeDiffItems(offset, count, prevSnapshotOrUrl, options) {
+ return tslib.__asyncGenerator(this, arguments, function* listPageRangeDiffItems_1() {
+ var _a, e_2, _b, _c;
+ let marker;
+ try {
+ for (var _d = true, _e = tslib.__asyncValues(this.listPageRangeDiffItemSegments(offset, count, prevSnapshotOrUrl, marker, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+ _c = _f.value;
+ _d = false;
+ const getPageRangesSegment = _c;
+ yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(ExtractPageRangeInfoItems(getPageRangesSegment))));
+ }
}
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ catch (e_2_1) { e_2 = { error: e_2_1 }; }
+ finally {
+ try {
+ if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
+ }
+ finally { if (e_2) throw e_2.error; }
+ }
+ });
}
/**
- * Sets one or more user-defined name-value pairs for the specified container.
+ * Returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
+ * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
*
- * If no option provided, or no metadata defined in the parameter, the container
- * metadata will be removed.
+ * .byPage() returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
+ * Example using `for await` syntax:
*
- * @param metadata - Replace existing metadata with this value.
- * If no value provided the existing metadata will be removed.
- * @param options - Options to Container Set Metadata operation.
- */
- async setMetadata(metadata, options = {}) {
- if (!options.conditions) {
- options.conditions = {};
- }
- if (options.conditions.ifUnmodifiedSince) {
- throw new RangeError("the IfUnmodifiedSince must have their default values because they are ignored by the blob service");
- }
- const { span, updatedOptions } = createSpan("ContainerClient-setMetadata", options);
- try {
- return await this.containerContext.setMetadata(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions, metadata, modifiedAccessConditions: options.conditions }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
- /**
- * Gets the permissions for the specified container. The permissions indicate
- * whether container data may be accessed publicly.
+ * ```js
+ * // Get the pageBlobClient before you run these snippets,
+ * // Can be obtained from `blobServiceClient.getContainerClient("").getPageBlobClient("");`
+ * let i = 1;
+ * for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
+ * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * }
+ * ```
*
- * WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings.
- * For example, new Date("2018-12-31T03:44:23.8827891Z").toISOString() will get "2018-12-31T03:44:23.882Z".
+ * Example using `iter.next()`:
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-acl
+ * ```js
+ * let i = 1;
+ * let iter = pageBlobClient.listPageRangesDiff();
+ * let pageRangeItem = await iter.next();
+ * while (!pageRangeItem.done) {
+ * console.log(`Page range ${i++}: ${pageRangeItem.value.start} - ${pageRangeItem.value.end}, IsClear: ${pageRangeItem.value.isClear}`);
+ * pageRangeItem = await iter.next();
+ * }
+ * ```
*
- * @param options - Options to Container Get Access Policy operation.
- */
- async getAccessPolicy(options = {}) {
- if (!options.conditions) {
- options.conditions = {};
- }
- const { span, updatedOptions } = createSpan("ContainerClient-getAccessPolicy", options);
- try {
- const response = await this.containerContext.getAccessPolicy(Object.assign({ abortSignal: options.abortSignal, leaseAccessConditions: options.conditions }, convertTracingToRequestOptionsBase(updatedOptions)));
- const res = {
- _response: response._response,
- blobPublicAccess: response.blobPublicAccess,
- date: response.date,
- etag: response.etag,
- errorCode: response.errorCode,
- lastModified: response.lastModified,
- requestId: response.requestId,
- clientRequestId: response.clientRequestId,
- signedIdentifiers: [],
- version: response.version,
- };
- for (const identifier of response) {
- let accessPolicy = undefined;
- if (identifier.accessPolicy) {
- accessPolicy = {
- permissions: identifier.accessPolicy.permissions,
- };
- if (identifier.accessPolicy.expiresOn) {
- accessPolicy.expiresOn = new Date(identifier.accessPolicy.expiresOn);
- }
- if (identifier.accessPolicy.startsOn) {
- accessPolicy.startsOn = new Date(identifier.accessPolicy.startsOn);
- }
- }
- res.signedIdentifiers.push({
- accessPolicy,
- id: identifier.id,
- });
- }
- return res;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
- /**
- * Sets the permissions for the specified container. The permissions indicate
- * whether blobs in a container may be accessed publicly.
+ * Example using `byPage()`:
*
- * When you set permissions for a container, the existing permissions are replaced.
- * If no access or containerAcl provided, the existing container ACL will be
- * removed.
+ * ```js
+ * // passing optional maxPageSize in the page settings
+ * let i = 1;
+ * for await (const response of pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 20 })) {
+ * for (const pageRange of response) {
+ * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * }
+ * }
+ * ```
*
- * When you establish a stored access policy on a container, 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-container-acl
+ * Example using paging with a marker:
*
- * @param access - The level of public access to data in the container.
- * @param containerAcl - Array of elements each having a unique Id and details of the access policy.
- * @param options - Options to Container Set Access Policy operation.
+ * ```js
+ * let i = 1;
+ * let iterator = pageBlobClient.listPageRangesDiff().byPage({ maxPageSize: 2 });
+ * let response = (await iterator.next()).value;
+ *
+ * // Prints 2 page ranges
+ * for (const pageRange of response) {
+ * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * }
+ *
+ * // Gets next marker
+ * let marker = response.continuationToken;
+ *
+ * // Passing next marker as continuationToken
+ *
+ * iterator = pageBlobClient.listPageRangesDiff().byPage({ continuationToken: marker, maxPageSize: 10 });
+ * response = (await iterator.next()).value;
+ *
+ * // Prints 10 page ranges
+ * for (const blob of response) {
+ * console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+ * }
+ * ```
+ * @param offset - Starting byte position of the page ranges.
+ * @param count - Number of bytes to get.
+ * @param prevSnapshot - Timestamp of snapshot to retrieve the difference.
+ * @param options - Options to the Page Blob Get Ranges operation.
+ * @returns An asyncIterableIterator that supports paging.
*/
- async setAccessPolicy(access, containerAcl, options = {}) {
+ listPageRangesDiff(offset, count, prevSnapshot, options = {}) {
options.conditions = options.conditions || {};
- const { span, updatedOptions } = createSpan("ContainerClient-setAccessPolicy", options);
- try {
- const acl = [];
- for (const identifier of containerAcl || []) {
- acl.push({
- accessPolicy: {
- expiresOn: identifier.accessPolicy.expiresOn
- ? truncatedISO8061Date(identifier.accessPolicy.expiresOn)
- : "",
- permissions: identifier.accessPolicy.permissions,
- startsOn: identifier.accessPolicy.startsOn
- ? truncatedISO8061Date(identifier.accessPolicy.startsOn)
- : "",
- },
- id: identifier.id,
- });
- }
- return await this.containerContext.setAccessPolicy(Object.assign({ abortSignal: options.abortSignal, access, containerAcl: acl, leaseAccessConditions: options.conditions, modifiedAccessConditions: options.conditions }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ // AsyncIterableIterator to iterate over blobs
+ const iter = this.listPageRangeDiffItems(offset, count, prevSnapshot, Object.assign({}, options));
+ return {
+ /**
+ * The next method, part of the iteration protocol
+ */
+ next() {
+ return iter.next();
+ },
+ /**
+ * The connection to the async iterator, part of the iteration protocol
+ */
+ [Symbol.asyncIterator]() {
+ return this;
+ },
+ /**
+ * Return an AsyncIterableIterator that works a page at a time
+ */
+ byPage: (settings = {}) => {
+ return this.listPageRangeDiffItemSegments(offset, count, prevSnapshot, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, options));
+ },
+ };
}
/**
- * Get a {@link BlobLeaseClient} that manages leases on the container.
+ * Gets the collection of page ranges that differ between a specified snapshot and this page blob for managed disks.
+ * @see https://docs.microsoft.com/rest/api/storageservices/get-page-ranges
*
- * @param proposeLeaseId - Initial proposed lease Id.
- * @returns A new BlobLeaseClient object for managing leases on the container.
+ * @param offset - Starting byte position of the page blob
+ * @param count - Number of bytes to get ranges diff.
+ * @param prevSnapshotUrl - URL of snapshot to retrieve the difference.
+ * @param options - Options to the Page Blob Get Page Ranges Diff operation.
+ * @returns Response data for the Page Blob Get Page Range Diff operation.
*/
- getBlobLeaseClient(proposeLeaseId) {
- return new BlobLeaseClient(this, proposeLeaseId);
+ async getPageRangesDiffForManagedDisks(offset, count, prevSnapshotUrl, options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("PageBlobClient-GetPageRangesDiffForManagedDisks", options, async (updatedOptions) => {
+ var _a;
+ const response = assertResponse(await this.pageBlobContext.getPageRangesDiff({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ prevSnapshotUrl,
+ range: rangeToString({ offset, count }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ return rangeResponseFromModel(response);
+ });
}
/**
- * Creates a new block blob, or updates the content of an existing block blob.
- *
- * Updating an existing block blob overwrites any existing metadata on the blob.
- * Partial updates are not supported; the content of the existing blob is
- * overwritten with the new content. To perform a partial update of a block blob's,
- * use {@link BlockBlobClient.stageBlock} and {@link BlockBlobClient.commitBlockList}.
- *
- * This is a non-parallel uploading method, please use {@link BlockBlobClient.uploadFile},
- * {@link BlockBlobClient.uploadStream} or {@link BlockBlobClient.uploadBrowserData} for better
- * performance with concurrency uploading.
+ * Resizes the page blob to the specified size (which must be a multiple of 512).
+ * @see https://docs.microsoft.com/rest/api/storageservices/set-blob-properties
*
- * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+ * @param size - Target size
+ * @param options - Options to the Page Blob Resize operation.
+ * @returns Response data for the Page Blob Resize operation.
+ */
+ async resize(size, options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("PageBlobClient-resize", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.pageBlobContext.resize(size, {
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ encryptionScope: options.encryptionScope,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Sets a page blob's sequence number.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties
*
- * @param blobName - Name of the block blob to create or update.
- * @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
- * which returns a new Readable stream whose offset is from data source beginning.
- * @param contentLength - Length of body in bytes. Use Buffer.byteLength() to calculate body length for a
- * string including non non-Base64/Hex-encoded characters.
- * @param options - Options to configure the Block Blob Upload operation.
- * @returns Block Blob upload response data and the corresponding BlockBlobClient instance.
+ * @param sequenceNumberAction - Indicates how the service should modify the blob's sequence number.
+ * @param sequenceNumber - Required if sequenceNumberAction is max or update
+ * @param options - Options to the Page Blob Update Sequence Number operation.
+ * @returns Response data for the Page Blob Update Sequence Number operation.
*/
- async uploadBlockBlob(blobName, body, contentLength, options = {}) {
- const { span, updatedOptions } = createSpan("ContainerClient-uploadBlockBlob", options);
- try {
- const blockBlobClient = this.getBlockBlobClient(blobName);
- const response = await blockBlobClient.upload(body, contentLength, updatedOptions);
- return {
- blockBlobClient,
- response,
- };
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ async updateSequenceNumber(sequenceNumberAction, sequenceNumber, options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("PageBlobClient-updateSequenceNumber", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.pageBlobContext.updateSequenceNumber(sequenceNumberAction, {
+ abortSignal: options.abortSignal,
+ blobSequenceNumber: sequenceNumber,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Marks the specified blob or snapshot for deletion. The blob is later deleted
- * during garbage collection. Note that in order to delete a blob, you must delete
- * all of its snapshots. You can delete both at the same time with the Delete
- * Blob operation.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
+ * Begins an operation to start an incremental copy from one page blob's snapshot to this page blob.
+ * The snapshot is copied such that only the differential changes between the previously
+ * copied snapshot are transferred to the destination.
+ * The copied snapshots are complete copies of the original snapshot and can be read or copied from as usual.
+ * @see https://docs.microsoft.com/rest/api/storageservices/incremental-copy-blob
+ * @see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/incremental-snapshots
*
- * @param blobName -
- * @param options - Options to Blob Delete operation.
- * @returns Block blob deletion response data.
+ * @param copySource - Specifies the name of the source page blob snapshot. For example,
+ * https://myaccount.blob.core.windows.net/mycontainer/myblob?snapshot=
+ * @param options - Options to the Page Blob Copy Incremental operation.
+ * @returns Response data for the Page Blob Copy Incremental operation.
*/
- async deleteBlob(blobName, options = {}) {
- const { span, updatedOptions } = createSpan("ContainerClient-deleteBlob", options);
- try {
- let blobClient = this.getBlobClient(blobName);
- if (options.versionId) {
- blobClient = blobClient.withVersion(options.versionId);
- }
- return await blobClient.delete(updatedOptions);
+ async startCopyIncremental(copySource, options = {}) {
+ return tracingClient.withSpan("PageBlobClient-startCopyIncremental", options, async (updatedOptions) => {
+ var _a;
+ return assertResponse(await this.pageBlobContext.copyIncremental(copySource, {
+ abortSignal: options.abortSignal,
+ modifiedAccessConditions: Object.assign(Object.assign({}, options.conditions), { ifTags: (_a = options.conditions) === null || _a === void 0 ? void 0 : _a.tagConditions }),
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+async function getBodyAsText(batchResponse) {
+ let buffer = Buffer.alloc(BATCH_MAX_PAYLOAD_IN_BYTES);
+ const responseLength = await streamToBuffer2(batchResponse.readableStreamBody, buffer);
+ // Slice the buffer to trim the empty ending.
+ buffer = buffer.slice(0, responseLength);
+ return buffer.toString();
+}
+function utf8ByteLength(str) {
+ return Buffer.byteLength(str);
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+const HTTP_HEADER_DELIMITER = ": ";
+const SPACE_DELIMITER = " ";
+const NOT_FOUND = -1;
+/**
+ * Util class for parsing batch response.
+ */
+class BatchResponseParser {
+ constructor(batchResponse, subRequests) {
+ if (!batchResponse || !batchResponse.contentType) {
+ // In special case(reported), server may return invalid content-type which could not be parsed.
+ throw new RangeError("batchResponse is malformed or doesn't contain valid content-type.");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (!subRequests || subRequests.size === 0) {
+ // This should be prevent during coding.
+ throw new RangeError("Invalid state: subRequests is not provided or size is 0.");
}
- finally {
- span.end();
+ this.batchResponse = batchResponse;
+ this.subRequests = subRequests;
+ this.responseBatchBoundary = this.batchResponse.contentType.split("=")[1];
+ this.perResponsePrefix = `--${this.responseBatchBoundary}${HTTP_LINE_ENDING}`;
+ this.batchResponseEnding = `--${this.responseBatchBoundary}--`;
+ }
+ // For example of response, please refer to https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#response
+ async parseBatchResponse() {
+ // When logic reach here, suppose batch request has already succeeded with 202, so we can further parse
+ // sub request's response.
+ if (this.batchResponse._response.status !== HTTPURLConnection.HTTP_ACCEPTED) {
+ throw new Error(`Invalid state: batch request failed with status: '${this.batchResponse._response.status}'.`);
+ }
+ const responseBodyAsText = await getBodyAsText(this.batchResponse);
+ const subResponses = responseBodyAsText
+ .split(this.batchResponseEnding)[0] // string after ending is useless
+ .split(this.perResponsePrefix)
+ .slice(1); // string before first response boundary is useless
+ const subResponseCount = subResponses.length;
+ // Defensive coding in case of potential error parsing.
+ // Note: subResponseCount == 1 is special case where sub request is invalid.
+ // We try to prevent such cases through early validation, e.g. validate sub request count >= 1.
+ // While in unexpected sub request invalid case, we allow sub response to be parsed and return to user.
+ if (subResponseCount !== this.subRequests.size && subResponseCount !== 1) {
+ throw new Error("Invalid state: sub responses' count is not equal to sub requests' count.");
+ }
+ const deserializedSubResponses = new Array(subResponseCount);
+ let subResponsesSucceededCount = 0;
+ let subResponsesFailedCount = 0;
+ // Parse sub subResponses.
+ for (let index = 0; index < subResponseCount; index++) {
+ const subResponse = subResponses[index];
+ const deserializedSubResponse = {};
+ deserializedSubResponse.headers = coreHttpCompat.toHttpHeadersLike(coreRestPipeline.createHttpHeaders());
+ const responseLines = subResponse.split(`${HTTP_LINE_ENDING}`);
+ let subRespHeaderStartFound = false;
+ let subRespHeaderEndFound = false;
+ let subRespFailed = false;
+ let contentId = NOT_FOUND;
+ for (const responseLine of responseLines) {
+ if (!subRespHeaderStartFound) {
+ // Convention line to indicate content ID
+ if (responseLine.startsWith(HeaderConstants.CONTENT_ID)) {
+ contentId = parseInt(responseLine.split(HTTP_HEADER_DELIMITER)[1]);
+ }
+ // Http version line with status code indicates the start of sub request's response.
+ // Example: HTTP/1.1 202 Accepted
+ if (responseLine.startsWith(HTTP_VERSION_1_1)) {
+ subRespHeaderStartFound = true;
+ const tokens = responseLine.split(SPACE_DELIMITER);
+ deserializedSubResponse.status = parseInt(tokens[1]);
+ deserializedSubResponse.statusMessage = tokens.slice(2).join(SPACE_DELIMITER);
+ }
+ continue; // Skip convention headers not specifically for sub request i.e. Content-Type: application/http and Content-ID: *
+ }
+ if (responseLine.trim() === "") {
+ // Sub response's header start line already found, and the first empty line indicates header end line found.
+ if (!subRespHeaderEndFound) {
+ subRespHeaderEndFound = true;
+ }
+ continue; // Skip empty line
+ }
+ // Note: when code reach here, it indicates subRespHeaderStartFound == true
+ if (!subRespHeaderEndFound) {
+ if (responseLine.indexOf(HTTP_HEADER_DELIMITER) === -1) {
+ // Defensive coding to prevent from missing valuable lines.
+ throw new Error(`Invalid state: find non-empty line '${responseLine}' without HTTP header delimiter '${HTTP_HEADER_DELIMITER}'.`);
+ }
+ // Parse headers of sub response.
+ const tokens = responseLine.split(HTTP_HEADER_DELIMITER);
+ deserializedSubResponse.headers.set(tokens[0], tokens[1]);
+ if (tokens[0] === HeaderConstants.X_MS_ERROR_CODE) {
+ deserializedSubResponse.errorCode = tokens[1];
+ subRespFailed = true;
+ }
+ }
+ else {
+ // Assemble body of sub response.
+ if (!deserializedSubResponse.bodyAsText) {
+ deserializedSubResponse.bodyAsText = "";
+ }
+ deserializedSubResponse.bodyAsText += responseLine;
+ }
+ } // Inner for end
+ // The response will contain the Content-ID header for each corresponding subrequest response to use for tracking.
+ // The Content-IDs are set to a valid index in the subrequests we sent. In the status code 202 path, we could expect it
+ // to be 1-1 mapping from the [0, subRequests.size) to the Content-IDs returned. If not, we simply don't return that
+ // unexpected subResponse in the parsed reponse and we can always look it up in the raw response for debugging purpose.
+ if (contentId !== NOT_FOUND &&
+ Number.isInteger(contentId) &&
+ contentId >= 0 &&
+ contentId < this.subRequests.size &&
+ deserializedSubResponses[contentId] === undefined) {
+ deserializedSubResponse._request = this.subRequests.get(contentId);
+ deserializedSubResponses[contentId] = deserializedSubResponse;
+ }
+ else {
+ logger.error(`subResponses[${index}] is dropped as the Content-ID is not found or invalid, Content-ID: ${contentId}`);
+ }
+ if (subRespFailed) {
+ subResponsesFailedCount++;
+ }
+ else {
+ subResponsesSucceededCount++;
+ }
}
+ return {
+ subResponses: deserializedSubResponses,
+ subResponsesSucceededCount: subResponsesSucceededCount,
+ subResponsesFailedCount: subResponsesFailedCount,
+ };
}
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+var MutexLockStatus;
+(function (MutexLockStatus) {
+ MutexLockStatus[MutexLockStatus["LOCKED"] = 0] = "LOCKED";
+ MutexLockStatus[MutexLockStatus["UNLOCKED"] = 1] = "UNLOCKED";
+})(MutexLockStatus || (MutexLockStatus = {}));
+/**
+ * An async mutex lock.
+ */
+class Mutex {
/**
- * listBlobFlatSegment returns a single segment of blobs starting from the
- * specified Marker. Use an empty Marker to start enumeration from the beginning.
- * After getting a segment, process it, and then call listBlobsFlatSegment again
- * (passing the the previously-returned Marker) to get the next segment.
- * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs
+ * Lock for a specific key. If the lock has been acquired by another customer, then
+ * will wait until getting the lock.
*
- * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
- * @param options - Options to Container List Blob Flat Segment operation.
+ * @param key - lock key
*/
- async listBlobFlatSegment(marker, options = {}) {
- const { span, updatedOptions } = createSpan("ContainerClient-listBlobFlatSegment", options);
- try {
- const response = await this.containerContext.listBlobFlatSegment(Object.assign(Object.assign({ marker }, options), convertTracingToRequestOptionsBase(updatedOptions)));
- const wrappedResponse = Object.assign(Object.assign({}, response), { _response: Object.assign(Object.assign({}, response._response), { parsedBody: ConvertInternalResponseOfListBlobFlat(response._response.parsedBody) }), segment: Object.assign(Object.assign({}, response.segment), { blobItems: response.segment.blobItems.map((blobItemInteral) => {
- const blobItem = Object.assign(Object.assign({}, blobItemInteral), { name: BlobNameToString(blobItemInteral.name), tags: toTags(blobItemInteral.blobTags), objectReplicationSourceProperties: parseObjectReplicationRecord(blobItemInteral.objectReplicationMetadata) });
- return blobItem;
- }) }) });
- return wrappedResponse;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ static async lock(key) {
+ return new Promise((resolve) => {
+ if (this.keys[key] === undefined || this.keys[key] === MutexLockStatus.UNLOCKED) {
+ this.keys[key] = MutexLockStatus.LOCKED;
+ resolve();
+ }
+ else {
+ this.onUnlockEvent(key, () => {
+ this.keys[key] = MutexLockStatus.LOCKED;
+ resolve();
+ });
+ }
+ });
}
/**
- * listBlobHierarchySegment returns a single segment of blobs starting from
- * the specified Marker. Use an empty Marker to start enumeration from the
- * beginning. After getting a segment, process it, and then call listBlobsHierarchicalSegment
- * again (passing the the previously-returned Marker) to get the next segment.
- * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs
+ * Unlock a key.
*
- * @param delimiter - The character or string used to define the virtual hierarchy
- * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
- * @param options - Options to Container List Blob Hierarchy Segment operation.
+ * @param key -
*/
- async listBlobHierarchySegment(delimiter, marker, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("ContainerClient-listBlobHierarchySegment", options);
- try {
- const response = await this.containerContext.listBlobHierarchySegment(delimiter, Object.assign(Object.assign({ marker }, options), convertTracingToRequestOptionsBase(updatedOptions)));
- const wrappedResponse = Object.assign(Object.assign({}, response), { _response: Object.assign(Object.assign({}, response._response), { parsedBody: ConvertInternalResponseOfListBlobHierarchy(response._response.parsedBody) }), segment: Object.assign(Object.assign({}, response.segment), { blobItems: response.segment.blobItems.map((blobItemInteral) => {
- const blobItem = Object.assign(Object.assign({}, blobItemInteral), { name: BlobNameToString(blobItemInteral.name), tags: toTags(blobItemInteral.blobTags), objectReplicationSourceProperties: parseObjectReplicationRecord(blobItemInteral.objectReplicationMetadata) });
- return blobItem;
- }), blobPrefixes: (_a = response.segment.blobPrefixes) === null || _a === void 0 ? void 0 : _a.map((blobPrefixInternal) => {
- const blobPrefix = Object.assign(Object.assign({}, blobPrefixInternal), { name: BlobNameToString(blobPrefixInternal.name) });
- return blobPrefix;
- }) }) });
- return wrappedResponse;
+ static async unlock(key) {
+ return new Promise((resolve) => {
+ if (this.keys[key] === MutexLockStatus.LOCKED) {
+ this.emitUnlockEvent(key);
+ }
+ delete this.keys[key];
+ resolve();
+ });
+ }
+ static onUnlockEvent(key, handler) {
+ if (this.listeners[key] === undefined) {
+ this.listeners[key] = [handler];
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ else {
+ this.listeners[key].push(handler);
}
- finally {
- span.end();
+ }
+ static emitUnlockEvent(key) {
+ if (this.listeners[key] !== undefined && this.listeners[key].length > 0) {
+ const handler = this.listeners[key].shift();
+ setImmediate(() => {
+ handler.call(this);
+ });
}
}
+}
+Mutex.keys = {};
+Mutex.listeners = {};
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * A BlobBatch represents an aggregated set of operations on blobs.
+ * Currently, only `delete` and `setAccessTier` are supported.
+ */
+class BlobBatch {
+ constructor() {
+ this.batch = "batch";
+ this.batchRequest = new InnerBatchRequest();
+ }
/**
- * Returns an AsyncIterableIterator for ContainerListBlobFlatSegmentResponse
- *
- * @param marker - A string value that identifies the portion of
- * the list of blobs to be returned with the next listing operation. The
- * operation returns the ContinuationToken value within the response body if the
- * listing operation did not return all blobs remaining to be listed
- * with the current page. The ContinuationToken value can be used as the value for
- * the marker parameter in a subsequent call to request the next page of list
- * items. The marker value is opaque to the client.
- * @param options - Options to list blobs operation.
+ * Get the value of Content-Type for a batch request.
+ * The value must be multipart/mixed with a batch boundary.
+ * Example: multipart/mixed; boundary=batch_a81786c8-e301-4e42-a729-a32ca24ae252
*/
- listSegments(marker, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* listSegments_1() {
- let listBlobsFlatSegmentResponse;
- if (!!marker || marker === undefined) {
- do {
- listBlobsFlatSegmentResponse = yield tslib.__await(this.listBlobFlatSegment(marker, options));
- marker = listBlobsFlatSegmentResponse.continuationToken;
- yield yield tslib.__await(yield tslib.__await(listBlobsFlatSegmentResponse));
- } while (marker);
- }
- });
+ getMultiPartContentType() {
+ return this.batchRequest.getMultipartContentType();
}
/**
- * Returns an AsyncIterableIterator of {@link BlobItem} objects
- *
- * @param options - Options to list blobs operation.
+ * Get assembled HTTP request body for sub requests.
*/
- listItems(options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* listItems_1() {
- var e_1, _a;
- let marker;
- try {
- for (var _b = tslib.__asyncValues(this.listSegments(marker, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
- const listBlobsFlatSegmentResponse = _c.value;
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(listBlobsFlatSegmentResponse.segment.blobItems)));
- }
- }
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
- finally {
- try {
- if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
- }
- finally { if (e_1) throw e_1.error; }
- }
- });
+ getHttpRequestBody() {
+ return this.batchRequest.getHttpRequestBody();
}
/**
- * Returns an async iterable iterator to list all the blobs
- * under the specified account.
- *
- * .byPage() returns an async iterable iterator to list the blobs in pages.
- *
- * Example using `for await` syntax:
- *
- * ```js
- * // Get the containerClient before you run these snippets,
- * // Can be obtained from `blobServiceClient.getContainerClient("");`
- * let i = 1;
- * for await (const blob of containerClient.listBlobsFlat()) {
- * console.log(`Blob ${i++}: ${blob.name}`);
- * }
- * ```
- *
- * Example using `iter.next()`:
- *
- * ```js
- * let i = 1;
- * let iter = containerClient.listBlobsFlat();
- * let blobItem = await iter.next();
- * while (!blobItem.done) {
- * console.log(`Blob ${i++}: ${blobItem.value.name}`);
- * blobItem = await iter.next();
- * }
- * ```
- *
- * Example using `byPage()`:
- *
- * ```js
- * // passing optional maxPageSize in the page settings
- * let i = 1;
- * for await (const response of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
- * for (const blob of response.segment.blobItems) {
- * console.log(`Blob ${i++}: ${blob.name}`);
- * }
- * }
- * ```
- *
- * Example using paging with a marker:
- *
- * ```js
- * let i = 1;
- * let iterator = containerClient.listBlobsFlat().byPage({ maxPageSize: 2 });
- * let response = (await iterator.next()).value;
- *
- * // Prints 2 blob names
- * for (const blob of response.segment.blobItems) {
- * console.log(`Blob ${i++}: ${blob.name}`);
- * }
- *
- * // Gets next marker
- * let marker = response.continuationToken;
- *
- * // Passing next marker as continuationToken
- *
- * iterator = containerClient.listBlobsFlat().byPage({ continuationToken: marker, maxPageSize: 10 });
- * response = (await iterator.next()).value;
- *
- * // Prints 10 blob names
- * for (const blob of response.segment.blobItems) {
- * console.log(`Blob ${i++}: ${blob.name}`);
- * }
- * ```
- *
- * @param options - Options to list blobs.
- * @returns An asyncIterableIterator that supports paging.
+ * Get sub requests that are added into the batch request.
*/
- listBlobsFlat(options = {}) {
- const include = [];
- if (options.includeCopy) {
- include.push("copy");
+ getSubRequests() {
+ return this.batchRequest.getSubRequests();
+ }
+ async addSubRequestInternal(subRequest, assembleSubRequestFunc) {
+ await Mutex.lock(this.batch);
+ try {
+ this.batchRequest.preAddSubRequest(subRequest);
+ await assembleSubRequestFunc();
+ this.batchRequest.postAddSubRequest(subRequest);
}
- if (options.includeDeleted) {
- include.push("deleted");
+ finally {
+ await Mutex.unlock(this.batch);
}
- if (options.includeMetadata) {
- include.push("metadata");
+ }
+ setBatchType(batchType) {
+ if (!this.batchType) {
+ this.batchType = batchType;
}
- if (options.includeSnapshots) {
- include.push("snapshots");
+ if (this.batchType !== batchType) {
+ throw new RangeError(`BlobBatch only supports one operation type per batch and it already is being used for ${this.batchType} operations.`);
}
- if (options.includeVersions) {
- include.push("versions");
+ }
+ async deleteBlob(urlOrBlobClient, credentialOrOptions, options) {
+ let url;
+ let credential;
+ if (typeof urlOrBlobClient === "string" &&
+ ((coreUtil.isNode && credentialOrOptions instanceof StorageSharedKeyCredential) ||
+ credentialOrOptions instanceof AnonymousCredential ||
+ coreAuth.isTokenCredential(credentialOrOptions))) {
+ // First overload
+ url = urlOrBlobClient;
+ credential = credentialOrOptions;
}
- if (options.includeUncommitedBlobs) {
- include.push("uncommittedblobs");
+ else if (urlOrBlobClient instanceof BlobClient) {
+ // Second overload
+ url = urlOrBlobClient.url;
+ credential = urlOrBlobClient.credential;
+ options = credentialOrOptions;
}
- if (options.includeTags) {
- include.push("tags");
+ else {
+ throw new RangeError("Invalid arguments. Either url and credential, or BlobClient need be provided.");
}
- if (options.includeDeletedWithVersions) {
- include.push("deletedwithversions");
+ if (!options) {
+ options = {};
}
- if (options.includeImmutabilityPolicy) {
- include.push("immutabilitypolicy");
+ return tracingClient.withSpan("BatchDeleteRequest-addSubRequest", options, async (updatedOptions) => {
+ this.setBatchType("delete");
+ await this.addSubRequestInternal({
+ url: url,
+ credential: credential,
+ }, async () => {
+ await new BlobClient(url, this.batchRequest.createPipeline(credential)).delete(updatedOptions);
+ });
+ });
+ }
+ async setBlobAccessTier(urlOrBlobClient, credentialOrTier, tierOrOptions, options) {
+ let url;
+ let credential;
+ let tier;
+ if (typeof urlOrBlobClient === "string" &&
+ ((coreUtil.isNode && credentialOrTier instanceof StorageSharedKeyCredential) ||
+ credentialOrTier instanceof AnonymousCredential ||
+ coreAuth.isTokenCredential(credentialOrTier))) {
+ // First overload
+ url = urlOrBlobClient;
+ credential = credentialOrTier;
+ tier = tierOrOptions;
}
- if (options.includeLegalHold) {
- include.push("legalhold");
+ else if (urlOrBlobClient instanceof BlobClient) {
+ // Second overload
+ url = urlOrBlobClient.url;
+ credential = urlOrBlobClient.credential;
+ tier = credentialOrTier;
+ options = tierOrOptions;
}
- if (options.prefix === "") {
- options.prefix = undefined;
+ else {
+ throw new RangeError("Invalid arguments. Either url and credential, or BlobClient need be provided.");
}
- const updatedOptions = Object.assign(Object.assign({}, options), (include.length > 0 ? { include: include } : {}));
- // AsyncIterableIterator to iterate over blobs
- const iter = this.listItems(updatedOptions);
- return {
- /**
- * The next method, part of the iteration protocol
- */
- next() {
- return iter.next();
- },
- /**
- * The connection to the async iterator, part of the iteration protocol
- */
- [Symbol.asyncIterator]() {
- return this;
- },
- /**
- * Return an AsyncIterableIterator that works a page at a time
- */
- byPage: (settings = {}) => {
- return this.listSegments(settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, updatedOptions));
- },
- };
- }
- /**
- * Returns an AsyncIterableIterator for ContainerListBlobHierarchySegmentResponse
- *
- * @param delimiter - The character or string used to define the virtual hierarchy
- * @param marker - A string value that identifies the portion of
- * the list of blobs to be returned with the next listing operation. The
- * operation returns the ContinuationToken value within the response body if the
- * listing operation did not return all blobs remaining to be listed
- * with the current page. The ContinuationToken value can be used as the value for
- * the marker parameter in a subsequent call to request the next page of list
- * items. The marker value is opaque to the client.
- * @param options - Options to list blobs operation.
- */
- listHierarchySegments(delimiter, marker, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* listHierarchySegments_1() {
- let listBlobsHierarchySegmentResponse;
- if (!!marker || marker === undefined) {
- do {
- listBlobsHierarchySegmentResponse = yield tslib.__await(this.listBlobHierarchySegment(delimiter, marker, options));
- marker = listBlobsHierarchySegmentResponse.continuationToken;
- yield yield tslib.__await(yield tslib.__await(listBlobsHierarchySegmentResponse));
- } while (marker);
- }
+ if (!options) {
+ options = {};
+ }
+ return tracingClient.withSpan("BatchSetTierRequest-addSubRequest", options, async (updatedOptions) => {
+ this.setBatchType("setAccessTier");
+ await this.addSubRequestInternal({
+ url: url,
+ credential: credential,
+ }, async () => {
+ await new BlobClient(url, this.batchRequest.createPipeline(credential)).setAccessTier(tier, updatedOptions);
+ });
});
}
- /**
- * Returns an AsyncIterableIterator for {@link BlobPrefix} and {@link BlobItem} objects.
- *
- * @param delimiter - The character or string used to define the virtual hierarchy
- * @param options - Options to list blobs operation.
- */
- listItemsByHierarchy(delimiter, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* listItemsByHierarchy_1() {
- var e_2, _a;
- let marker;
- try {
- for (var _b = tslib.__asyncValues(this.listHierarchySegments(delimiter, marker, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
- const listBlobsHierarchySegmentResponse = _c.value;
- const segment = listBlobsHierarchySegmentResponse.segment;
- if (segment.blobPrefixes) {
- for (const prefix of segment.blobPrefixes) {
- yield yield tslib.__await(Object.assign({ kind: "prefix" }, prefix));
- }
- }
- for (const blob of segment.blobItems) {
- yield yield tslib.__await(Object.assign({ kind: "blob" }, blob));
- }
- }
- }
- catch (e_2_1) { e_2 = { error: e_2_1 }; }
- finally {
- try {
- if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
- }
- finally { if (e_2) throw e_2.error; }
- }
- });
+}
+/**
+ * Inner batch request class which is responsible for assembling and serializing sub requests.
+ * See https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch#request-body for how requests are assembled.
+ */
+class InnerBatchRequest {
+ constructor() {
+ this.operationCount = 0;
+ this.body = "";
+ const tempGuid = coreUtil.randomUUID();
+ // batch_{batchid}
+ this.boundary = `batch_${tempGuid}`;
+ // --batch_{batchid}
+ // Content-Type: application/http
+ // Content-Transfer-Encoding: binary
+ this.subRequestPrefix = `--${this.boundary}${HTTP_LINE_ENDING}${HeaderConstants.CONTENT_TYPE}: application/http${HTTP_LINE_ENDING}${HeaderConstants.CONTENT_TRANSFER_ENCODING}: binary`;
+ // multipart/mixed; boundary=batch_{batchid}
+ this.multipartContentType = `multipart/mixed; boundary=${this.boundary}`;
+ // --batch_{batchid}--
+ this.batchRequestEnding = `--${this.boundary}--`;
+ this.subRequests = new Map();
}
/**
- * Returns an async iterable iterator to list all the blobs by hierarchy.
- * under the specified account.
- *
- * .byPage() returns an async iterable iterator to list the blobs by hierarchy in pages.
- *
- * Example using `for await` syntax:
- *
- * ```js
- * for await (const item of containerClient.listBlobsByHierarchy("/")) {
- * if (item.kind === "prefix") {
- * console.log(`\tBlobPrefix: ${item.name}`);
- * } else {
- * console.log(`\tBlobItem: name - ${item.name}`);
- * }
- * }
- * ```
- *
- * Example using `iter.next()`:
- *
- * ```js
- * let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
- * let entity = await iter.next();
- * while (!entity.done) {
- * let item = entity.value;
- * if (item.kind === "prefix") {
- * console.log(`\tBlobPrefix: ${item.name}`);
- * } else {
- * console.log(`\tBlobItem: name - ${item.name}`);
- * }
- * entity = await iter.next();
- * }
- * ```
- *
- * Example using `byPage()`:
- *
- * ```js
- * console.log("Listing blobs by hierarchy by page");
- * for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
- * const segment = response.segment;
- * if (segment.blobPrefixes) {
- * for (const prefix of segment.blobPrefixes) {
- * console.log(`\tBlobPrefix: ${prefix.name}`);
- * }
- * }
- * for (const blob of response.segment.blobItems) {
- * console.log(`\tBlobItem: name - ${blob.name}`);
- * }
- * }
- * ```
- *
- * Example using paging with a max page size:
- *
- * ```js
- * console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");
- *
- * let i = 1;
- * for await (const response of containerClient
- * .listBlobsByHierarchy("/", { prefix: "prefix2/sub1/" })
- * .byPage({ maxPageSize: 2 })) {
- * console.log(`Page ${i++}`);
- * const segment = response.segment;
- *
- * if (segment.blobPrefixes) {
- * for (const prefix of segment.blobPrefixes) {
- * console.log(`\tBlobPrefix: ${prefix.name}`);
- * }
- * }
- *
- * for (const blob of response.segment.blobItems) {
- * console.log(`\tBlobItem: name - ${blob.name}`);
- * }
- * }
- * ```
- *
- * @param delimiter - The character or string used to define the virtual hierarchy
- * @param options - Options to list blobs operation.
+ * Create pipeline to assemble sub requests. The idea here is to use existing
+ * credential and serialization/deserialization components, with additional policies to
+ * filter unnecessary headers, assemble sub requests into request's body
+ * and intercept request from going to wire.
+ * @param credential - Such as AnonymousCredential, StorageSharedKeyCredential or any credential from the `@azure/identity` package to authenticate requests to the service. You can also provide an object that implements the TokenCredential interface. If not specified, AnonymousCredential is used.
*/
- listBlobsByHierarchy(delimiter, options = {}) {
- if (delimiter === "") {
- throw new RangeError("delimiter should contain one or more characters");
- }
- const include = [];
- if (options.includeCopy) {
- include.push("copy");
- }
- if (options.includeDeleted) {
- include.push("deleted");
- }
- if (options.includeMetadata) {
- include.push("metadata");
- }
- if (options.includeSnapshots) {
- include.push("snapshots");
+ createPipeline(credential) {
+ const corePipeline = coreRestPipeline.createEmptyPipeline();
+ corePipeline.addPolicy(coreClient.serializationPolicy({
+ stringifyXML: coreXml.stringifyXML,
+ serializerOptions: {
+ xml: {
+ xmlCharKey: "#",
+ },
+ },
+ }), { phase: "Serialize" });
+ // Use batch header filter policy to exclude unnecessary headers
+ corePipeline.addPolicy(batchHeaderFilterPolicy());
+ // Use batch assemble policy to assemble request and intercept request from going to wire
+ corePipeline.addPolicy(batchRequestAssemblePolicy(this), { afterPhase: "Sign" });
+ if (coreAuth.isTokenCredential(credential)) {
+ corePipeline.addPolicy(coreRestPipeline.bearerTokenAuthenticationPolicy({
+ credential,
+ scopes: StorageOAuthScopes,
+ challengeCallbacks: { authorizeRequestOnChallenge: coreClient.authorizeRequestOnTenantChallenge },
+ }), { phase: "Sign" });
+ }
+ else if (credential instanceof StorageSharedKeyCredential) {
+ corePipeline.addPolicy(storageSharedKeyCredentialPolicy({
+ accountName: credential.accountName,
+ accountKey: credential.accountKey,
+ }), { phase: "Sign" });
+ }
+ const pipeline = new Pipeline([]);
+ // attach the v2 pipeline to this one
+ pipeline._credential = credential;
+ pipeline._corePipeline = corePipeline;
+ return pipeline;
+ }
+ appendSubRequestToBody(request) {
+ // Start to assemble sub request
+ this.body += [
+ this.subRequestPrefix, // sub request constant prefix
+ `${HeaderConstants.CONTENT_ID}: ${this.operationCount}`, // sub request's content ID
+ "", // empty line after sub request's content ID
+ `${request.method.toString()} ${getURLPathAndQuery(request.url)} ${HTTP_VERSION_1_1}${HTTP_LINE_ENDING}`, // sub request start line with method
+ ].join(HTTP_LINE_ENDING);
+ for (const [name, value] of request.headers) {
+ this.body += `${name}: ${value}${HTTP_LINE_ENDING}`;
}
- if (options.includeVersions) {
- include.push("versions");
+ this.body += HTTP_LINE_ENDING; // sub request's headers need be ending with an empty line
+ // No body to assemble for current batch request support
+ // End to assemble sub request
+ }
+ preAddSubRequest(subRequest) {
+ if (this.operationCount >= BATCH_MAX_REQUEST) {
+ throw new RangeError(`Cannot exceed ${BATCH_MAX_REQUEST} sub requests in a single batch`);
}
- if (options.includeUncommitedBlobs) {
- include.push("uncommittedblobs");
+ // Fast fail if url for sub request is invalid
+ const path = getURLPath(subRequest.url);
+ if (!path || path === "") {
+ throw new RangeError(`Invalid url for sub request: '${subRequest.url}'`);
}
- if (options.includeTags) {
- include.push("tags");
+ }
+ postAddSubRequest(subRequest) {
+ this.subRequests.set(this.operationCount, subRequest);
+ this.operationCount++;
+ }
+ // Return the http request body with assembling the ending line to the sub request body.
+ getHttpRequestBody() {
+ return `${this.body}${this.batchRequestEnding}${HTTP_LINE_ENDING}`;
+ }
+ getMultipartContentType() {
+ return this.multipartContentType;
+ }
+ getSubRequests() {
+ return this.subRequests;
+ }
+}
+function batchRequestAssemblePolicy(batchRequest) {
+ return {
+ name: "batchRequestAssemblePolicy",
+ async sendRequest(request) {
+ batchRequest.appendSubRequestToBody(request);
+ return {
+ request,
+ status: 200,
+ headers: coreRestPipeline.createHttpHeaders(),
+ };
+ },
+ };
+}
+function batchHeaderFilterPolicy() {
+ return {
+ name: "batchHeaderFilterPolicy",
+ async sendRequest(request, next) {
+ let xMsHeaderName = "";
+ for (const [name] of request.headers) {
+ if (iEqual(name, HeaderConstants.X_MS_VERSION)) {
+ xMsHeaderName = name;
+ }
+ }
+ if (xMsHeaderName !== "") {
+ request.headers.delete(xMsHeaderName); // The subrequests should not have the x-ms-version header.
+ }
+ return next(request);
+ },
+ };
+}
+
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * A BlobBatchClient allows you to make batched requests to the Azure Storage Blob service.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
+ */
+class BlobBatchClient {
+ constructor(url, credentialOrPipeline,
+ // Legacy, no fix for eslint error without breaking. Disable it for this interface.
+ /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+ options) {
+ let pipeline;
+ if (isPipelineLike(credentialOrPipeline)) {
+ pipeline = credentialOrPipeline;
}
- if (options.includeDeletedWithVersions) {
- include.push("deletedwithversions");
+ else if (!credentialOrPipeline) {
+ // no credential provided
+ pipeline = newPipeline(new AnonymousCredential(), options);
}
- if (options.includeImmutabilityPolicy) {
- include.push("immutabilitypolicy");
+ else {
+ pipeline = newPipeline(credentialOrPipeline, options);
}
- if (options.includeLegalHold) {
- include.push("legalhold");
+ const storageClientContext = new StorageContextClient(url, getCoreClientOptions(pipeline));
+ const path = getURLPath(url);
+ if (path && path !== "/") {
+ // Container scoped.
+ this.serviceOrContainerContext = storageClientContext.container;
}
- if (options.prefix === "") {
- options.prefix = undefined;
+ else {
+ this.serviceOrContainerContext = storageClientContext.service;
}
- const updatedOptions = Object.assign(Object.assign({}, options), (include.length > 0 ? { include: include } : {}));
- // AsyncIterableIterator to iterate over blob prefixes and blobs
- const iter = this.listItemsByHierarchy(delimiter, updatedOptions);
- return {
- /**
- * The next method, part of the iteration protocol
- */
- async next() {
- return iter.next();
- },
- /**
- * The connection to the async iterator, part of the iteration protocol
- */
- [Symbol.asyncIterator]() {
- return this;
- },
- /**
- * Return an AsyncIterableIterator that works a page at a time
- */
- byPage: (settings = {}) => {
- return this.listHierarchySegments(delimiter, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, updatedOptions));
- },
- };
}
/**
- * The Filter Blobs operation enables callers to list blobs in the container whose tags
- * match a given search expression.
- *
- * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
- * The given expression must evaluate to true for a blob to be returned in the results.
- * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter;
- * however, only a subset of the OData filter syntax is supported in the Blob service.
- * @param marker - A string value that identifies the portion of
- * the list of blobs to be returned with the next listing operation. The
- * operation returns the continuationToken value within the response body if the
- * listing operation did not return all blobs remaining to be listed
- * with the current page. The continuationToken value can be used as the value for
- * the marker parameter in a subsequent call to request the next page of list
- * items. The marker value is opaque to the client.
- * @param options - Options to find blobs by tags.
+ * Creates a {@link BlobBatch}.
+ * A BlobBatch represents an aggregated set of operations on blobs.
*/
- async findBlobsByTagsSegment(tagFilterSqlExpression, marker, options = {}) {
- const { span, updatedOptions } = createSpan("ContainerClient-findBlobsByTagsSegment", options);
- try {
- const response = await this.containerContext.filterBlobs(Object.assign({ abortSignal: options.abortSignal, where: tagFilterSqlExpression, marker, maxPageSize: options.maxPageSize }, convertTracingToRequestOptionsBase(updatedOptions)));
- const wrappedResponse = Object.assign(Object.assign({}, response), { _response: response._response, blobs: response.blobs.map((blob) => {
- var _a;
- let tagValue = "";
- if (((_a = blob.tags) === null || _a === void 0 ? void 0 : _a.blobTagSet.length) === 1) {
- tagValue = blob.tags.blobTagSet[0].value;
- }
- return Object.assign(Object.assign({}, blob), { tags: toTags(blob.tags), tagValue });
- }) });
- return wrappedResponse;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ createBatch() {
+ return new BlobBatch();
}
- /**
- * Returns an AsyncIterableIterator for ContainerFindBlobsByTagsSegmentResponse.
- *
- * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
- * The given expression must evaluate to true for a blob to be returned in the results.
- * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter;
- * however, only a subset of the OData filter syntax is supported in the Blob service.
- * @param marker - A string value that identifies the portion of
- * the list of blobs to be returned with the next listing operation. The
- * operation returns the continuationToken value within the response body if the
- * listing operation did not return all blobs remaining to be listed
- * with the current page. The continuationToken value can be used as the value for
- * the marker parameter in a subsequent call to request the next page of list
- * items. The marker value is opaque to the client.
- * @param options - Options to find blobs by tags.
- */
- findBlobsByTagsSegments(tagFilterSqlExpression, marker, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* findBlobsByTagsSegments_1() {
- let response;
- if (!!marker || marker === undefined) {
- do {
- response = yield tslib.__await(this.findBlobsByTagsSegment(tagFilterSqlExpression, marker, options));
- response.blobs = response.blobs || [];
- marker = response.continuationToken;
- yield yield tslib.__await(response);
- } while (marker);
+ async deleteBlobs(urlsOrBlobClients, credentialOrOptions,
+ // Legacy, no fix for eslint error without breaking. Disable it for this interface.
+ /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+ options) {
+ const batch = new BlobBatch();
+ for (const urlOrBlobClient of urlsOrBlobClients) {
+ if (typeof urlOrBlobClient === "string") {
+ await batch.deleteBlob(urlOrBlobClient, credentialOrOptions, options);
}
- });
+ else {
+ await batch.deleteBlob(urlOrBlobClient, credentialOrOptions);
+ }
+ }
+ return this.submitBatch(batch);
}
- /**
- * Returns an AsyncIterableIterator for blobs.
- *
- * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
- * The given expression must evaluate to true for a blob to be returned in the results.
- * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter;
- * however, only a subset of the OData filter syntax is supported in the Blob service.
- * @param options - Options to findBlobsByTagsItems.
- */
- findBlobsByTagsItems(tagFilterSqlExpression, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* findBlobsByTagsItems_1() {
- var e_3, _a;
- let marker;
- try {
- for (var _b = tslib.__asyncValues(this.findBlobsByTagsSegments(tagFilterSqlExpression, marker, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
- const segment = _c.value;
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(segment.blobs)));
- }
+ async setBlobsAccessTier(urlsOrBlobClients, credentialOrTier, tierOrOptions,
+ // Legacy, no fix for eslint error without breaking. Disable it for this interface.
+ /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+ options) {
+ const batch = new BlobBatch();
+ for (const urlOrBlobClient of urlsOrBlobClients) {
+ if (typeof urlOrBlobClient === "string") {
+ await batch.setBlobAccessTier(urlOrBlobClient, credentialOrTier, tierOrOptions, options);
}
- catch (e_3_1) { e_3 = { error: e_3_1 }; }
- finally {
- try {
- if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
- }
- finally { if (e_3) throw e_3.error; }
+ else {
+ await batch.setBlobAccessTier(urlOrBlobClient, credentialOrTier, tierOrOptions);
}
- });
+ }
+ return this.submitBatch(batch);
}
/**
- * Returns an async iterable iterator to find all blobs with specified tag
- * under the specified container.
- *
- * .byPage() returns an async iterable iterator to list the blobs in pages.
- *
- * Example using `for await` syntax:
+ * Submit batch request which consists of multiple subrequests.
*
- * ```js
- * let i = 1;
- * for await (const blob of containerClient.findBlobsByTags("tagkey='tagvalue'")) {
- * console.log(`Blob ${i++}: ${blob.name}`);
- * }
- * ```
+ * Get `blobBatchClient` and other details before running the snippets.
+ * `blobServiceClient.getBlobBatchClient()` gives the `blobBatchClient`
*
- * Example using `iter.next()`:
+ * Example usage:
*
* ```js
- * let i = 1;
- * const iter = containerClient.findBlobsByTags("tagkey='tagvalue'");
- * let blobItem = await iter.next();
- * while (!blobItem.done) {
- * console.log(`Blob ${i++}: ${blobItem.value.name}`);
- * blobItem = await iter.next();
- * }
+ * let batchRequest = new BlobBatch();
+ * await batchRequest.deleteBlob(urlInString0, credential0);
+ * await batchRequest.deleteBlob(urlInString1, credential1, {
+ * deleteSnapshots: "include"
+ * });
+ * const batchResp = await blobBatchClient.submitBatch(batchRequest);
+ * console.log(batchResp.subResponsesSucceededCount);
* ```
*
- * Example using `byPage()`:
+ * Example using a lease:
*
* ```js
- * // passing optional maxPageSize in the page settings
- * let i = 1;
- * for await (const response of containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
- * if (response.blobs) {
- * for (const blob of response.blobs) {
- * console.log(`Blob ${i++}: ${blob.name}`);
- * }
- * }
- * }
+ * let batchRequest = new BlobBatch();
+ * await batchRequest.setBlobAccessTier(blockBlobClient0, "Cool");
+ * await batchRequest.setBlobAccessTier(blockBlobClient1, "Cool", {
+ * conditions: { leaseId: leaseId }
+ * });
+ * const batchResp = await blobBatchClient.submitBatch(batchRequest);
+ * console.log(batchResp.subResponsesSucceededCount);
* ```
*
- * Example using paging with a marker:
- *
- * ```js
- * let i = 1;
- * let iterator = containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
- * let response = (await iterator.next()).value;
- *
- * // Prints 2 blob names
- * if (response.blobs) {
- * for (const blob of response.blobs) {
- * console.log(`Blob ${i++}: ${blob.name}`);
- * }
- * }
- *
- * // Gets next marker
- * let marker = response.continuationToken;
- * // Passing next marker as continuationToken
- * iterator = containerClient
- * .findBlobsByTags("tagkey='tagvalue'")
- * .byPage({ continuationToken: marker, maxPageSize: 10 });
- * response = (await iterator.next()).value;
- *
- * // Prints blob names
- * if (response.blobs) {
- * for (const blob of response.blobs) {
- * console.log(`Blob ${i++}: ${blob.name}`);
- * }
- * }
- * ```
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
*
- * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
- * The given expression must evaluate to true for a blob to be returned in the results.
- * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter;
- * however, only a subset of the OData filter syntax is supported in the Blob service.
- * @param options - Options to find blobs by tags.
+ * @param batchRequest - A set of Delete or SetTier operations.
+ * @param options -
*/
- findBlobsByTags(tagFilterSqlExpression, options = {}) {
- // AsyncIterableIterator to iterate over blobs
- const listSegmentOptions = Object.assign({}, options);
- const iter = this.findBlobsByTagsItems(tagFilterSqlExpression, listSegmentOptions);
- return {
- /**
- * The next method, part of the iteration protocol
- */
- next() {
- return iter.next();
- },
- /**
- * The connection to the async iterator, part of the iteration protocol
- */
- [Symbol.asyncIterator]() {
- return this;
- },
- /**
- * Return an AsyncIterableIterator that works a page at a time
- */
- byPage: (settings = {}) => {
- return this.findBlobsByTagsSegments(tagFilterSqlExpression, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, listSegmentOptions));
- },
- };
+ async submitBatch(batchRequest, options = {}) {
+ if (!batchRequest || batchRequest.getSubRequests().size === 0) {
+ throw new RangeError("Batch request should contain one or more sub requests.");
+ }
+ return tracingClient.withSpan("BlobBatchClient-submitBatch", options, async (updatedOptions) => {
+ const batchRequestBody = batchRequest.getHttpRequestBody();
+ // ServiceSubmitBatchResponseModel and ContainerSubmitBatchResponse are compatible for now.
+ const rawBatchResponse = assertResponse(await this.serviceOrContainerContext.submitBatch(utf8ByteLength(batchRequestBody), batchRequest.getMultiPartContentType(), batchRequestBody, Object.assign({}, updatedOptions)));
+ // Parse the sub responses result, if logic reaches here(i.e. the batch request succeeded with status code 202).
+ const batchResponseParser = new BatchResponseParser(rawBatchResponse, batchRequest.getSubRequests());
+ const responseSummary = await batchResponseParser.parseBatchResponse();
+ const res = {
+ _response: rawBatchResponse._response,
+ contentType: rawBatchResponse.contentType,
+ errorCode: rawBatchResponse.errorCode,
+ requestId: rawBatchResponse.requestId,
+ clientRequestId: rawBatchResponse.clientRequestId,
+ version: rawBatchResponse.version,
+ subResponses: responseSummary.subResponses,
+ subResponsesSucceededCount: responseSummary.subResponsesSucceededCount,
+ subResponsesFailedCount: responseSummary.subResponsesFailedCount,
+ };
+ return res;
+ });
}
- getContainerNameFromUrl() {
- let containerName;
- try {
- // URL may look like the following
- // "https://myaccount.blob.core.windows.net/mycontainer?sasString";
- // "https://myaccount.blob.core.windows.net/mycontainer";
- // IPv4/IPv6 address hosts, Endpoints - `http://127.0.0.1:10000/devstoreaccount1/containername`
- // http://localhost:10001/devstoreaccount1/containername
- const parsedUrl = coreHttp.URLBuilder.parse(this.url);
- if (parsedUrl.getHost().split(".")[1] === "blob") {
- // "https://myaccount.blob.core.windows.net/containername".
- // "https://customdomain.com/containername".
- // .getPath() -> /containername
- containerName = parsedUrl.getPath().split("/")[1];
+}
+
+/**
+ * A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs.
+ */
+class ContainerClient extends StorageClient {
+ /**
+ * The name of the container.
+ */
+ get containerName() {
+ return this._containerName;
+ }
+ constructor(urlOrConnectionString, credentialOrPipelineOrContainerName,
+ // Legacy, no fix for eslint error without breaking. Disable it for this interface.
+ /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+ options) {
+ let pipeline;
+ let url;
+ options = options || {};
+ if (isPipelineLike(credentialOrPipelineOrContainerName)) {
+ // (url: string, pipeline: Pipeline)
+ url = urlOrConnectionString;
+ pipeline = credentialOrPipelineOrContainerName;
+ }
+ else if ((coreUtil.isNode && credentialOrPipelineOrContainerName instanceof StorageSharedKeyCredential) ||
+ credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
+ coreAuth.isTokenCredential(credentialOrPipelineOrContainerName)) {
+ // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
+ url = urlOrConnectionString;
+ pipeline = newPipeline(credentialOrPipelineOrContainerName, options);
+ }
+ else if (!credentialOrPipelineOrContainerName &&
+ typeof credentialOrPipelineOrContainerName !== "string") {
+ // (url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)
+ // The second parameter is undefined. Use anonymous credential.
+ url = urlOrConnectionString;
+ pipeline = newPipeline(new AnonymousCredential(), options);
+ }
+ else if (credentialOrPipelineOrContainerName &&
+ typeof credentialOrPipelineOrContainerName === "string") {
+ // (connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions)
+ const containerName = credentialOrPipelineOrContainerName;
+ const extractedCreds = extractConnectionStringParts(urlOrConnectionString);
+ if (extractedCreds.kind === "AccountConnString") {
+ if (coreUtil.isNode) {
+ const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
+ url = appendToURLPath(extractedCreds.url, encodeURIComponent(containerName));
+ if (!options.proxyOptions) {
+ options.proxyOptions = coreRestPipeline.getDefaultProxySettings(extractedCreds.proxyUri);
+ }
+ pipeline = newPipeline(sharedKeyCredential, options);
+ }
+ else {
+ throw new Error("Account connection string is only supported in Node.js environment");
+ }
}
- else if (isIpEndpointStyle(parsedUrl)) {
- // IPv4/IPv6 address hosts... Example - http://192.0.0.10:10001/devstoreaccount1/containername
- // Single word domain without a [dot] in the endpoint... Example - http://localhost:10001/devstoreaccount1/containername
- // .getPath() -> /devstoreaccount1/containername
- containerName = parsedUrl.getPath().split("/")[2];
+ else if (extractedCreds.kind === "SASConnString") {
+ url =
+ appendToURLPath(extractedCreds.url, encodeURIComponent(containerName)) +
+ "?" +
+ extractedCreds.accountSas;
+ pipeline = newPipeline(new AnonymousCredential(), options);
}
else {
- // "https://customdomain.com/containername".
- // .getPath() -> /containername
- containerName = parsedUrl.getPath().split("/")[1];
- }
- // decode the encoded containerName - to get all the special characters that might be present in it
- containerName = decodeURIComponent(containerName);
- if (!containerName) {
- throw new Error("Provided containerName is invalid.");
+ throw new Error("Connection string must be either an Account connection string or a SAS connection string");
}
- return containerName;
}
- catch (error) {
- throw new Error("Unable to extract containerName with provided information.");
+ else {
+ throw new Error("Expecting non-empty strings for containerName parameter");
}
+ super(url, pipeline);
+ this._containerName = this.getContainerNameFromUrl();
+ this.containerContext = this.storageClientContext.container;
}
/**
- * Only available for ContainerClient constructed with a shared key credential.
+ * Creates a new container under the specified account. If the container with
+ * the same name already exists, the operation fails.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
+ * Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
*
- * Generates a Blob Container 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.
+ * @param options - Options to Container Create operation.
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
*
- * @param options - Optional parameters.
- * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
+ * Example usage:
+ *
+ * ```js
+ * const containerClient = blobServiceClient.getContainerClient("");
+ * const createContainerResponse = await containerClient.create();
+ * console.log("Container was created successfully", createContainerResponse.requestId);
+ * ```
*/
- generateSasUrl(options) {
- return new Promise((resolve) => {
- if (!(this.credential instanceof StorageSharedKeyCredential)) {
- throw new RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
+ async create(options = {}) {
+ return tracingClient.withSpan("ContainerClient-create", options, async (updatedOptions) => {
+ return assertResponse(await this.containerContext.create(updatedOptions));
+ });
+ }
+ /**
+ * Creates a new container under the specified account. If the container with
+ * the same name already exists, it is not changed.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
+ * Naming rules: @see https://learn.microsoft.com/rest/api/storageservices/naming-and-referencing-containers--blobs--and-metadata
+ *
+ * @param options -
+ */
+ async createIfNotExists(options = {}) {
+ return tracingClient.withSpan("ContainerClient-createIfNotExists", options, async (updatedOptions) => {
+ var _a, _b;
+ try {
+ const res = await this.create(updatedOptions);
+ return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
+ }
+ catch (e) {
+ if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "ContainerAlreadyExists") {
+ return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+ }
+ else {
+ throw e;
+ }
}
- const sas = generateBlobSASQueryParameters(Object.assign({ containerName: this._containerName }, options), this.credential).toString();
- resolve(appendToURLQuery(this.url, sas));
});
}
/**
- * Creates a BlobBatchClient object to conduct batch operations.
+ * Returns true if the Azure container resource represented by this client exists; false otherwise.
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
+ * NOTE: use this function with care since an existing container might be deleted by other clients or
+ * applications. Vice versa new containers with the same name might be added by other clients or
+ * applications after this function completes.
*
- * @returns A new BlobBatchClient object for this container.
+ * @param options -
*/
- getBlobBatchClient() {
- return new BlobBatchClient(this.url, this.pipeline);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value
- * to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the
- * values are set, this should be serialized with toString and set as the permissions field on an
- * {@link AccountSASSignatureValues} object. It is possible to construct the permissions string without this class, but
- * the order of the permissions is particular and this class guarantees correctness.
- */
-class AccountSASPermissions {
- constructor() {
- /**
- * Permission to read resources and list queues and tables granted.
- */
- this.read = false;
- /**
- * Permission to write resources granted.
- */
- this.write = false;
- /**
- * Permission to create blobs and files granted.
- */
- this.delete = false;
- /**
- * Permission to delete versions granted.
- */
- this.deleteVersion = false;
- /**
- * Permission to list blob containers, blobs, shares, directories, and files granted.
- */
- this.list = false;
- /**
- * Permission to add messages, table entities, and append to blobs granted.
- */
- this.add = false;
- /**
- * Permission to create blobs and files granted.
- */
- this.create = false;
- /**
- * Permissions to update messages and table entities granted.
- */
- this.update = false;
- /**
- * Permission to get and delete messages granted.
- */
- this.process = false;
- /**
- * Specfies Tag access granted.
- */
- this.tag = false;
- /**
- * Permission to filter blobs.
- */
- this.filter = false;
- /**
- * Permission to set immutability policy.
- */
- this.setImmutabilityPolicy = false;
- /**
- * Specifies that Permanent Delete is permitted.
- */
- this.permanentDelete = false;
+ async exists(options = {}) {
+ return tracingClient.withSpan("ContainerClient-exists", options, async (updatedOptions) => {
+ try {
+ await this.getProperties({
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ });
+ return true;
+ }
+ catch (e) {
+ if (e.statusCode === 404) {
+ return false;
+ }
+ throw e;
+ }
+ });
}
/**
- * Parse initializes the AccountSASPermissions fields from a string.
+ * Creates a {@link BlobClient}
*
- * @param permissions -
+ * @param blobName - A blob name
+ * @returns A new BlobClient object for the given blob name.
*/
- static parse(permissions) {
- const accountSASPermissions = new AccountSASPermissions();
- for (const c of permissions) {
- switch (c) {
- case "r":
- accountSASPermissions.read = true;
- break;
- case "w":
- accountSASPermissions.write = true;
- break;
- case "d":
- accountSASPermissions.delete = true;
- break;
- case "x":
- accountSASPermissions.deleteVersion = true;
- break;
- case "l":
- accountSASPermissions.list = true;
- break;
- case "a":
- accountSASPermissions.add = true;
- break;
- case "c":
- accountSASPermissions.create = true;
- break;
- case "u":
- accountSASPermissions.update = true;
- break;
- case "p":
- accountSASPermissions.process = true;
- break;
- case "t":
- accountSASPermissions.tag = true;
- break;
- case "f":
- accountSASPermissions.filter = true;
- break;
- case "i":
- accountSASPermissions.setImmutabilityPolicy = true;
- break;
- case "y":
- accountSASPermissions.permanentDelete = true;
- break;
- default:
- throw new RangeError(`Invalid permission character: ${c}`);
- }
- }
- return accountSASPermissions;
+ getBlobClient(blobName) {
+ return new BlobClient(appendToURLPath(this.url, EscapePath(blobName)), this.pipeline);
}
/**
- * Creates a {@link AccountSASPermissions} from a raw object which contains same keys as it
- * and boolean values for them.
+ * Creates an {@link AppendBlobClient}
*
- * @param permissionLike -
+ * @param blobName - An append blob name
*/
- static from(permissionLike) {
- const accountSASPermissions = new AccountSASPermissions();
- if (permissionLike.read) {
- accountSASPermissions.read = true;
- }
- if (permissionLike.write) {
- accountSASPermissions.write = true;
- }
- if (permissionLike.delete) {
- accountSASPermissions.delete = true;
- }
- if (permissionLike.deleteVersion) {
- accountSASPermissions.deleteVersion = true;
- }
- if (permissionLike.filter) {
- accountSASPermissions.filter = true;
- }
- if (permissionLike.tag) {
- accountSASPermissions.tag = true;
- }
- if (permissionLike.list) {
- accountSASPermissions.list = true;
- }
- if (permissionLike.add) {
- accountSASPermissions.add = true;
- }
- if (permissionLike.create) {
- accountSASPermissions.create = true;
- }
- if (permissionLike.update) {
- accountSASPermissions.update = true;
- }
- if (permissionLike.process) {
- accountSASPermissions.process = true;
- }
- if (permissionLike.setImmutabilityPolicy) {
- accountSASPermissions.setImmutabilityPolicy = true;
- }
- if (permissionLike.permanentDelete) {
- accountSASPermissions.permanentDelete = true;
- }
- return accountSASPermissions;
+ getAppendBlobClient(blobName) {
+ return new AppendBlobClient(appendToURLPath(this.url, EscapePath(blobName)), this.pipeline);
}
/**
- * Produces the SAS permissions string for an Azure Storage account.
- * Call this method to set AccountSASSignatureValues Permissions field.
+ * Creates a {@link BlockBlobClient}
*
- * Using this method will guarantee the resource types are in
- * an order accepted by the service.
+ * @param blobName - A block blob name
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
*
+ * Example usage:
+ *
+ * ```js
+ * const content = "Hello world!";
+ *
+ * const blockBlobClient = containerClient.getBlockBlobClient("");
+ * const uploadBlobResponse = await blockBlobClient.upload(content, content.length);
+ * ```
*/
- toString() {
- // The order of the characters should be as specified here to ensure correctness:
- // https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
- // Use a string array instead of string concatenating += operator for performance
- const permissions = [];
- if (this.read) {
- permissions.push("r");
- }
- if (this.write) {
- permissions.push("w");
- }
- if (this.delete) {
- permissions.push("d");
- }
- if (this.deleteVersion) {
- permissions.push("x");
- }
- if (this.filter) {
- permissions.push("f");
- }
- if (this.tag) {
- permissions.push("t");
- }
- if (this.list) {
- permissions.push("l");
- }
- if (this.add) {
- permissions.push("a");
- }
- if (this.create) {
- permissions.push("c");
- }
- if (this.update) {
- permissions.push("u");
- }
- if (this.process) {
- permissions.push("p");
- }
- if (this.setImmutabilityPolicy) {
- permissions.push("i");
- }
- if (this.permanentDelete) {
- permissions.push("y");
- }
- return permissions.join("");
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value
- * to true means that any SAS which uses these permissions will grant access to that resource type. Once all the
- * values are set, this should be serialized with toString and set as the resources field on an
- * {@link AccountSASSignatureValues} object. It is possible to construct the resources string without this class, but
- * the order of the resources is particular and this class guarantees correctness.
- */
-class AccountSASResourceTypes {
- constructor() {
- /**
- * Permission to access service level APIs granted.
- */
- this.service = false;
- /**
- * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.
- */
- this.container = false;
- /**
- * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.
- */
- this.object = false;
+ getBlockBlobClient(blobName) {
+ return new BlockBlobClient(appendToURLPath(this.url, EscapePath(blobName)), this.pipeline);
}
/**
- * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an
- * Error if it encounters a character that does not correspond to a valid resource type.
+ * Creates a {@link PageBlobClient}
*
- * @param resourceTypes -
+ * @param blobName - A page blob name
*/
- static parse(resourceTypes) {
- const accountSASResourceTypes = new AccountSASResourceTypes();
- for (const c of resourceTypes) {
- switch (c) {
- case "s":
- accountSASResourceTypes.service = true;
- break;
- case "c":
- accountSASResourceTypes.container = true;
- break;
- case "o":
- accountSASResourceTypes.object = true;
- break;
- default:
- throw new RangeError(`Invalid resource type: ${c}`);
- }
- }
- return accountSASResourceTypes;
+ getPageBlobClient(blobName) {
+ return new PageBlobClient(appendToURLPath(this.url, EscapePath(blobName)), this.pipeline);
}
/**
- * Converts the given resource types to a string.
+ * Returns all user-defined metadata and system properties for the specified
+ * container. The data returned does not include the container's list of blobs.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-container-properties
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+ * 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 `listContainers` method of {@link BlobServiceClient} using the `includeMetadata` option, which
+ * will retain their original casing.
*
+ * @param options - Options to Container Get Properties operation.
*/
- toString() {
- const resourceTypes = [];
- if (this.service) {
- resourceTypes.push("s");
- }
- if (this.container) {
- resourceTypes.push("c");
- }
- if (this.object) {
- resourceTypes.push("o");
+ async getProperties(options = {}) {
+ if (!options.conditions) {
+ options.conditions = {};
}
- return resourceTypes.join("");
+ return tracingClient.withSpan("ContainerClient-getProperties", options, async (updatedOptions) => {
+ return assertResponse(await this.containerContext.getProperties(Object.assign(Object.assign({ abortSignal: options.abortSignal }, options.conditions), { tracingOptions: updatedOptions.tracingOptions })));
+ });
}
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value
- * to true means that any SAS which uses these permissions will grant access to that service. Once all the
- * values are set, this should be serialized with toString and set as the services field on an
- * {@link AccountSASSignatureValues} object. It is possible to construct the services string without this class, but
- * the order of the services is particular and this class guarantees correctness.
- */
-class AccountSASServices {
- constructor() {
- /**
- * Permission to access blob resources granted.
- */
- this.blob = false;
- /**
- * Permission to access file resources granted.
- */
- this.file = false;
- /**
- * Permission to access queue resources granted.
- */
- this.queue = false;
- /**
- * Permission to access table resources granted.
- */
- this.table = false;
+ /**
+ * Marks the specified container for deletion. The container and any blobs
+ * contained within it are later deleted during garbage collection.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
+ *
+ * @param options - Options to Container Delete operation.
+ */
+ async delete(options = {}) {
+ if (!options.conditions) {
+ options.conditions = {};
+ }
+ return tracingClient.withSpan("ContainerClient-delete", options, async (updatedOptions) => {
+ return assertResponse(await this.containerContext.delete({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: options.conditions,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
/**
- * Creates an {@link AccountSASServices} from the specified services string. This method will throw an
- * Error if it encounters a character that does not correspond to a valid service.
+ * Marks the specified container for deletion if it exists. The container and any blobs
+ * contained within it are later deleted during garbage collection.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-container
*
- * @param services -
+ * @param options - Options to Container Delete operation.
*/
- static parse(services) {
- const accountSASServices = new AccountSASServices();
- for (const c of services) {
- switch (c) {
- case "b":
- accountSASServices.blob = true;
- break;
- case "f":
- accountSASServices.file = true;
- break;
- case "q":
- accountSASServices.queue = true;
- break;
- case "t":
- accountSASServices.table = true;
- break;
- default:
- throw new RangeError(`Invalid service character: ${c}`);
+ async deleteIfExists(options = {}) {
+ return tracingClient.withSpan("ContainerClient-deleteIfExists", options, async (updatedOptions) => {
+ var _a, _b;
+ try {
+ const res = await this.delete(updatedOptions);
+ return Object.assign(Object.assign({ succeeded: true }, res), { _response: res._response });
}
- }
- return accountSASServices;
+ catch (e) {
+ if (((_a = e.details) === null || _a === void 0 ? void 0 : _a.errorCode) === "ContainerNotFound") {
+ return Object.assign(Object.assign({ succeeded: false }, (_b = e.response) === null || _b === void 0 ? void 0 : _b.parsedHeaders), { _response: e.response });
+ }
+ throw e;
+ }
+ });
}
/**
- * Converts the given services to a string.
+ * Sets one or more user-defined name-value pairs for the specified container.
+ *
+ * If no option provided, or no metadata defined in the parameter, the container
+ * metadata will be removed.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-container-metadata
*
+ * @param metadata - Replace existing metadata with this value.
+ * If no value provided the existing metadata will be removed.
+ * @param options - Options to Container Set Metadata operation.
*/
- toString() {
- const services = [];
- if (this.blob) {
- services.push("b");
- }
- if (this.table) {
- services.push("t");
- }
- if (this.queue) {
- services.push("q");
+ async setMetadata(metadata, options = {}) {
+ if (!options.conditions) {
+ options.conditions = {};
}
- if (this.file) {
- services.push("f");
+ if (options.conditions.ifUnmodifiedSince) {
+ throw new RangeError("the IfUnmodifiedSince must have their default values because they are ignored by the blob service");
}
- return services.join("");
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-/**
- * ONLY AVAILABLE IN NODE.JS RUNTIME.
- *
- * Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
- * REST request.
- *
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
- *
- * @param accountSASSignatureValues -
- * @param sharedKeyCredential -
- */
-function generateAccountSASQueryParameters(accountSASSignatureValues, sharedKeyCredential) {
- const version = accountSASSignatureValues.version
- ? accountSASSignatureValues.version
- : SERVICE_VERSION;
- if (accountSASSignatureValues.permissions &&
- accountSASSignatureValues.permissions.setImmutabilityPolicy &&
- version < "2020-08-04") {
- throw RangeError("'version' must be >= '2020-08-04' when provided 'i' permission.");
- }
- if (accountSASSignatureValues.permissions &&
- accountSASSignatureValues.permissions.deleteVersion &&
- version < "2019-10-10") {
- throw RangeError("'version' must be >= '2019-10-10' when provided 'x' permission.");
+ return tracingClient.withSpan("ContainerClient-setMetadata", options, async (updatedOptions) => {
+ return assertResponse(await this.containerContext.setMetadata({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ metadata,
+ modifiedAccessConditions: options.conditions,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
- if (accountSASSignatureValues.permissions &&
- accountSASSignatureValues.permissions.permanentDelete &&
- version < "2019-10-10") {
- throw RangeError("'version' must be >= '2019-10-10' when provided 'y' permission.");
+ /**
+ * Gets the permissions for the specified container. The permissions indicate
+ * whether container data may be accessed publicly.
+ *
+ * WARNING: JavaScript Date will potentially lose precision when parsing startsOn and expiresOn strings.
+ * 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-container-acl
+ *
+ * @param options - Options to Container Get Access Policy operation.
+ */
+ async getAccessPolicy(options = {}) {
+ if (!options.conditions) {
+ options.conditions = {};
+ }
+ return tracingClient.withSpan("ContainerClient-getAccessPolicy", options, async (updatedOptions) => {
+ const response = assertResponse(await this.containerContext.getAccessPolicy({
+ abortSignal: options.abortSignal,
+ leaseAccessConditions: options.conditions,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ const res = {
+ _response: response._response,
+ blobPublicAccess: response.blobPublicAccess,
+ date: response.date,
+ etag: response.etag,
+ errorCode: response.errorCode,
+ lastModified: response.lastModified,
+ requestId: response.requestId,
+ clientRequestId: response.clientRequestId,
+ signedIdentifiers: [],
+ version: response.version,
+ };
+ for (const identifier of response) {
+ let accessPolicy = undefined;
+ if (identifier.accessPolicy) {
+ accessPolicy = {
+ permissions: identifier.accessPolicy.permissions,
+ };
+ if (identifier.accessPolicy.expiresOn) {
+ accessPolicy.expiresOn = new Date(identifier.accessPolicy.expiresOn);
+ }
+ if (identifier.accessPolicy.startsOn) {
+ accessPolicy.startsOn = new Date(identifier.accessPolicy.startsOn);
+ }
+ }
+ res.signedIdentifiers.push({
+ accessPolicy,
+ id: identifier.id,
+ });
+ }
+ return res;
+ });
}
- if (accountSASSignatureValues.permissions &&
- accountSASSignatureValues.permissions.tag &&
- version < "2019-12-12") {
- throw RangeError("'version' must be >= '2019-12-12' when provided 't' permission.");
+ /**
+ * Sets the permissions for the specified container. The permissions indicate
+ * whether blobs in a container may be accessed publicly.
+ *
+ * When you set permissions for a container, the existing permissions are replaced.
+ * If no access or containerAcl provided, the existing container ACL will be
+ * removed.
+ *
+ * When you establish a stored access policy on a container, 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-container-acl
+ *
+ * @param access - The level of public access to data in the container.
+ * @param containerAcl - Array of elements each having a unique Id and details of the access policy.
+ * @param options - Options to Container Set Access Policy operation.
+ */
+ async setAccessPolicy(access, containerAcl, options = {}) {
+ options.conditions = options.conditions || {};
+ return tracingClient.withSpan("ContainerClient-setAccessPolicy", options, async (updatedOptions) => {
+ const acl = [];
+ for (const identifier of containerAcl || []) {
+ acl.push({
+ accessPolicy: {
+ expiresOn: identifier.accessPolicy.expiresOn
+ ? truncatedISO8061Date(identifier.accessPolicy.expiresOn)
+ : "",
+ permissions: identifier.accessPolicy.permissions,
+ startsOn: identifier.accessPolicy.startsOn
+ ? truncatedISO8061Date(identifier.accessPolicy.startsOn)
+ : "",
+ },
+ id: identifier.id,
+ });
+ }
+ return assertResponse(await this.containerContext.setAccessPolicy({
+ abortSignal: options.abortSignal,
+ access,
+ containerAcl: acl,
+ leaseAccessConditions: options.conditions,
+ modifiedAccessConditions: options.conditions,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
- if (accountSASSignatureValues.permissions &&
- accountSASSignatureValues.permissions.filter &&
- version < "2019-12-12") {
- throw RangeError("'version' must be >= '2019-12-12' when provided 'f' permission.");
+ /**
+ * Get a {@link BlobLeaseClient} that manages leases on the container.
+ *
+ * @param proposeLeaseId - Initial proposed lease Id.
+ * @returns A new BlobLeaseClient object for managing leases on the container.
+ */
+ getBlobLeaseClient(proposeLeaseId) {
+ return new BlobLeaseClient(this, proposeLeaseId);
}
- if (accountSASSignatureValues.encryptionScope && version < "2020-12-06") {
- throw RangeError("'version' must be >= '2020-12-06' when provided 'encryptionScope' in SAS.");
+ /**
+ * Creates a new block blob, or updates the content of an existing block blob.
+ *
+ * Updating an existing block blob overwrites any existing metadata on the blob.
+ * Partial updates are not supported; the content of the existing blob is
+ * overwritten with the new content. To perform a partial update of a block blob's,
+ * use {@link BlockBlobClient.stageBlock} and {@link BlockBlobClient.commitBlockList}.
+ *
+ * This is a non-parallel uploading method, please use {@link BlockBlobClient.uploadFile},
+ * {@link BlockBlobClient.uploadStream} or {@link BlockBlobClient.uploadBrowserData} for better
+ * performance with concurrency uploading.
+ *
+ * @see https://docs.microsoft.com/rest/api/storageservices/put-blob
+ *
+ * @param blobName - Name of the block blob to create or update.
+ * @param body - Blob, string, ArrayBuffer, ArrayBufferView or a function
+ * which returns a new Readable stream whose offset is from data source beginning.
+ * @param contentLength - Length of body in bytes. Use Buffer.byteLength() to calculate body length for a
+ * string including non non-Base64/Hex-encoded characters.
+ * @param options - Options to configure the Block Blob Upload operation.
+ * @returns Block Blob upload response data and the corresponding BlockBlobClient instance.
+ */
+ async uploadBlockBlob(blobName, body, contentLength, options = {}) {
+ return tracingClient.withSpan("ContainerClient-uploadBlockBlob", options, async (updatedOptions) => {
+ const blockBlobClient = this.getBlockBlobClient(blobName);
+ const response = await blockBlobClient.upload(body, contentLength, updatedOptions);
+ return {
+ blockBlobClient,
+ response,
+ };
+ });
}
- const parsedPermissions = AccountSASPermissions.parse(accountSASSignatureValues.permissions.toString());
- const parsedServices = AccountSASServices.parse(accountSASSignatureValues.services).toString();
- const parsedResourceTypes = AccountSASResourceTypes.parse(accountSASSignatureValues.resourceTypes).toString();
- let stringToSign;
- if (version >= "2020-12-06") {
- stringToSign = [
- sharedKeyCredential.accountName,
- parsedPermissions,
- parsedServices,
- parsedResourceTypes,
- accountSASSignatureValues.startsOn
- ? truncatedISO8061Date(accountSASSignatureValues.startsOn, false)
- : "",
- truncatedISO8061Date(accountSASSignatureValues.expiresOn, false),
- accountSASSignatureValues.ipRange ? ipRangeToString(accountSASSignatureValues.ipRange) : "",
- accountSASSignatureValues.protocol ? accountSASSignatureValues.protocol : "",
- version,
- accountSASSignatureValues.encryptionScope ? accountSASSignatureValues.encryptionScope : "",
- "", // Account SAS requires an additional newline character
- ].join("\n");
+ /**
+ * Marks the specified blob or snapshot for deletion. The blob is later deleted
+ * during garbage collection. Note that in order to delete a blob, you must delete
+ * all of its snapshots. You can delete both at the same time with the Delete
+ * Blob operation.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/delete-blob
+ *
+ * @param blobName -
+ * @param options - Options to Blob Delete operation.
+ * @returns Block blob deletion response data.
+ */
+ async deleteBlob(blobName, options = {}) {
+ return tracingClient.withSpan("ContainerClient-deleteBlob", options, async (updatedOptions) => {
+ let blobClient = this.getBlobClient(blobName);
+ if (options.versionId) {
+ blobClient = blobClient.withVersion(options.versionId);
+ }
+ return blobClient.delete(updatedOptions);
+ });
}
- else {
- stringToSign = [
- sharedKeyCredential.accountName,
- parsedPermissions,
- parsedServices,
- parsedResourceTypes,
- accountSASSignatureValues.startsOn
- ? truncatedISO8061Date(accountSASSignatureValues.startsOn, false)
- : "",
- truncatedISO8061Date(accountSASSignatureValues.expiresOn, false),
- accountSASSignatureValues.ipRange ? ipRangeToString(accountSASSignatureValues.ipRange) : "",
- accountSASSignatureValues.protocol ? accountSASSignatureValues.protocol : "",
- version,
- "", // Account SAS requires an additional newline character
- ].join("\n");
+ /**
+ * listBlobFlatSegment returns a single segment of blobs starting from the
+ * specified Marker. Use an empty Marker to start enumeration from the beginning.
+ * After getting a segment, process it, and then call listBlobsFlatSegment again
+ * (passing the the previously-returned Marker) to get the next segment.
+ * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs
+ *
+ * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
+ * @param options - Options to Container List Blob Flat Segment operation.
+ */
+ async listBlobFlatSegment(marker, options = {}) {
+ return tracingClient.withSpan("ContainerClient-listBlobFlatSegment", options, async (updatedOptions) => {
+ const response = assertResponse(await this.containerContext.listBlobFlatSegment(Object.assign(Object.assign({ marker }, options), { tracingOptions: updatedOptions.tracingOptions })));
+ const wrappedResponse = Object.assign(Object.assign({}, response), { _response: Object.assign(Object.assign({}, response._response), { parsedBody: ConvertInternalResponseOfListBlobFlat(response._response.parsedBody) }), segment: Object.assign(Object.assign({}, response.segment), { blobItems: response.segment.blobItems.map((blobItemInternal) => {
+ const blobItem = Object.assign(Object.assign({}, blobItemInternal), { name: BlobNameToString(blobItemInternal.name), tags: toTags(blobItemInternal.blobTags), objectReplicationSourceProperties: parseObjectReplicationRecord(blobItemInternal.objectReplicationMetadata) });
+ return blobItem;
+ }) }) });
+ return wrappedResponse;
+ });
}
- const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
- return new SASQueryParameters(version, signature, parsedPermissions.toString(), parsedServices, parsedResourceTypes, accountSASSignatureValues.protocol, accountSASSignatureValues.startsOn, accountSASSignatureValues.expiresOn, accountSASSignatureValues.ipRange, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, accountSASSignatureValues.encryptionScope);
-}
-
-/**
- * A BlobServiceClient represents a Client to the Azure Storage Blob service allowing you
- * to manipulate blob containers.
- */
-class BlobServiceClient extends StorageClient {
- constructor(url, credentialOrPipeline,
- // Legacy, no fix for eslint error without breaking. Disable it for this interface.
- /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
- options) {
- let pipeline;
- if (isPipelineLike(credentialOrPipeline)) {
- pipeline = credentialOrPipeline;
- }
- else if ((coreHttp.isNode && credentialOrPipeline instanceof StorageSharedKeyCredential) ||
- credentialOrPipeline instanceof AnonymousCredential ||
- coreHttp.isTokenCredential(credentialOrPipeline)) {
- pipeline = newPipeline(credentialOrPipeline, options);
- }
- else {
- // The second parameter is undefined. Use anonymous credential
- pipeline = newPipeline(new AnonymousCredential(), options);
- }
- super(url, pipeline);
- this.serviceContext = new Service(this.storageClientContext);
+ /**
+ * listBlobHierarchySegment returns a single segment of blobs starting from
+ * the specified Marker. Use an empty Marker to start enumeration from the
+ * beginning. After getting a segment, process it, and then call listBlobsHierarchicalSegment
+ * again (passing the the previously-returned Marker) to get the next segment.
+ * @see https://docs.microsoft.com/rest/api/storageservices/list-blobs
+ *
+ * @param delimiter - The character or string used to define the virtual hierarchy
+ * @param marker - A string value that identifies the portion of the list to be returned with the next list operation.
+ * @param options - Options to Container List Blob Hierarchy Segment operation.
+ */
+ async listBlobHierarchySegment(delimiter, marker, options = {}) {
+ return tracingClient.withSpan("ContainerClient-listBlobHierarchySegment", options, async (updatedOptions) => {
+ var _a;
+ const response = assertResponse(await this.containerContext.listBlobHierarchySegment(delimiter, Object.assign(Object.assign({ marker }, options), { tracingOptions: updatedOptions.tracingOptions })));
+ const wrappedResponse = Object.assign(Object.assign({}, response), { _response: Object.assign(Object.assign({}, response._response), { parsedBody: ConvertInternalResponseOfListBlobHierarchy(response._response.parsedBody) }), segment: Object.assign(Object.assign({}, response.segment), { blobItems: response.segment.blobItems.map((blobItemInternal) => {
+ const blobItem = Object.assign(Object.assign({}, blobItemInternal), { name: BlobNameToString(blobItemInternal.name), tags: toTags(blobItemInternal.blobTags), objectReplicationSourceProperties: parseObjectReplicationRecord(blobItemInternal.objectReplicationMetadata) });
+ return blobItem;
+ }), blobPrefixes: (_a = response.segment.blobPrefixes) === null || _a === void 0 ? void 0 : _a.map((blobPrefixInternal) => {
+ const blobPrefix = Object.assign(Object.assign({}, blobPrefixInternal), { name: BlobNameToString(blobPrefixInternal.name) });
+ return blobPrefix;
+ }) }) });
+ return wrappedResponse;
+ });
}
/**
+ * Returns an AsyncIterableIterator for ContainerListBlobFlatSegmentResponse
*
- * Creates an instance of BlobServiceClient from connection string.
+ * @param marker - A string value that identifies the portion of
+ * the list of blobs to be returned with the next listing operation. The
+ * operation returns the ContinuationToken value within the response body if the
+ * listing operation did not return all blobs remaining to be listed
+ * with the current page. The ContinuationToken value can be used as the value for
+ * the marker parameter in a subsequent call to request the next page of list
+ * items. The marker value is opaque to the client.
+ * @param options - Options to list blobs operation.
+ */
+ listSegments(marker_1) {
+ return tslib.__asyncGenerator(this, arguments, function* listSegments_1(marker, options = {}) {
+ let listBlobsFlatSegmentResponse;
+ if (!!marker || marker === undefined) {
+ do {
+ listBlobsFlatSegmentResponse = yield tslib.__await(this.listBlobFlatSegment(marker, options));
+ marker = listBlobsFlatSegmentResponse.continuationToken;
+ yield yield tslib.__await(yield tslib.__await(listBlobsFlatSegmentResponse));
+ } while (marker);
+ }
+ });
+ }
+ /**
+ * Returns an AsyncIterableIterator of {@link BlobItem} objects
*
- * @param connectionString - 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`
- * @param options - Optional. Options to configure the HTTP pipeline.
+ * @param options - Options to list blobs operation.
*/
- static fromConnectionString(connectionString,
- // Legacy, no fix for eslint error without breaking. Disable it for this interface.
- /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
- options) {
- options = options || {};
- const extractedCreds = extractConnectionStringParts(connectionString);
- if (extractedCreds.kind === "AccountConnString") {
- if (coreHttp.isNode) {
- const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
- if (!options.proxyOptions) {
- options.proxyOptions = coreHttp.getDefaultProxySettings(extractedCreds.proxyUri);
+ listItems() {
+ return tslib.__asyncGenerator(this, arguments, function* listItems_1(options = {}) {
+ var _a, e_1, _b, _c;
+ let marker;
+ try {
+ for (var _d = true, _e = tslib.__asyncValues(this.listSegments(marker, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+ _c = _f.value;
+ _d = false;
+ const listBlobsFlatSegmentResponse = _c;
+ yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(listBlobsFlatSegmentResponse.segment.blobItems)));
}
- const pipeline = newPipeline(sharedKeyCredential, options);
- return new BlobServiceClient(extractedCreds.url, pipeline);
}
- else {
- throw new Error("Account connection string is only supported in Node.js environment");
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
+ finally {
+ try {
+ if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
+ }
+ finally { if (e_1) throw e_1.error; }
}
- }
- else if (extractedCreds.kind === "SASConnString") {
- const pipeline = newPipeline(new AnonymousCredential(), options);
- return new BlobServiceClient(extractedCreds.url + "?" + extractedCreds.accountSas, pipeline);
- }
- else {
- throw new Error("Connection string must be either an Account connection string or a SAS connection string");
- }
+ });
}
/**
- * Creates a {@link ContainerClient} object
+ * Returns an async iterable iterator to list all the blobs
+ * under the specified account.
*
- * @param containerName - A container name
- * @returns A new ContainerClient object for the given container name.
+ * .byPage() returns an async iterable iterator to list the blobs in pages.
*
- * Example usage:
+ * Example using `for await` syntax:
*
* ```js
- * const containerClient = blobServiceClient.getContainerClient("");
+ * // Get the containerClient before you run these snippets,
+ * // Can be obtained from `blobServiceClient.getContainerClient("");`
+ * let i = 1;
+ * for await (const blob of containerClient.listBlobsFlat()) {
+ * console.log(`Blob ${i++}: ${blob.name}`);
+ * }
* ```
- */
- getContainerClient(containerName) {
- return new ContainerClient(appendToURLPath(this.url, encodeURIComponent(containerName)), this.pipeline);
- }
- /**
- * Create a Blob container. @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
*
- * @param containerName - Name of the container to create.
- * @param options - Options to configure Container Create operation.
- * @returns Container creation response and the corresponding container client.
+ * Example using `iter.next()`:
+ *
+ * ```js
+ * let i = 1;
+ * let iter = containerClient.listBlobsFlat();
+ * let blobItem = await iter.next();
+ * while (!blobItem.done) {
+ * console.log(`Blob ${i++}: ${blobItem.value.name}`);
+ * blobItem = await iter.next();
+ * }
+ * ```
+ *
+ * Example using `byPage()`:
+ *
+ * ```js
+ * // passing optional maxPageSize in the page settings
+ * let i = 1;
+ * for await (const response of containerClient.listBlobsFlat().byPage({ maxPageSize: 20 })) {
+ * for (const blob of response.segment.blobItems) {
+ * console.log(`Blob ${i++}: ${blob.name}`);
+ * }
+ * }
+ * ```
+ *
+ * Example using paging with a marker:
+ *
+ * ```js
+ * let i = 1;
+ * let iterator = containerClient.listBlobsFlat().byPage({ maxPageSize: 2 });
+ * let response = (await iterator.next()).value;
+ *
+ * // Prints 2 blob names
+ * for (const blob of response.segment.blobItems) {
+ * console.log(`Blob ${i++}: ${blob.name}`);
+ * }
+ *
+ * // Gets next marker
+ * let marker = response.continuationToken;
+ *
+ * // Passing next marker as continuationToken
+ *
+ * iterator = containerClient.listBlobsFlat().byPage({ continuationToken: marker, maxPageSize: 10 });
+ * response = (await iterator.next()).value;
+ *
+ * // Prints 10 blob names
+ * for (const blob of response.segment.blobItems) {
+ * console.log(`Blob ${i++}: ${blob.name}`);
+ * }
+ * ```
+ *
+ * @param options - Options to list blobs.
+ * @returns An asyncIterableIterator that supports paging.
*/
- async createContainer(containerName, options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-createContainer", options);
- try {
- const containerClient = this.getContainerClient(containerName);
- const containerCreateResponse = await containerClient.create(updatedOptions);
- return {
- containerClient,
- containerCreateResponse,
- };
+ listBlobsFlat(options = {}) {
+ const include = [];
+ if (options.includeCopy) {
+ include.push("copy");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (options.includeDeleted) {
+ include.push("deleted");
}
- finally {
- span.end();
+ if (options.includeMetadata) {
+ include.push("metadata");
}
- }
- /**
- * Deletes a Blob container.
- *
- * @param containerName - Name of the container to delete.
- * @param options - Options to configure Container Delete operation.
- * @returns Container deletion response.
- */
- async deleteContainer(containerName, options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-deleteContainer", options);
- try {
- const containerClient = this.getContainerClient(containerName);
- return await containerClient.delete(updatedOptions);
+ if (options.includeSnapshots) {
+ include.push("snapshots");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (options.includeVersions) {
+ include.push("versions");
}
- finally {
- span.end();
+ if (options.includeUncommitedBlobs) {
+ include.push("uncommittedblobs");
}
- }
- /**
- * Restore a previously deleted Blob container.
- * This API is only functional if Container Soft Delete is enabled for the storage account associated with the container.
- *
- * @param deletedContainerName - Name of the previously deleted container.
- * @param deletedContainerVersion - Version of the previously deleted container, used to uniquely identify the deleted container.
- * @param options - Options to configure Container Restore operation.
- * @returns Container deletion response.
- */
- async undeleteContainer(deletedContainerName, deletedContainerVersion, options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-undeleteContainer", options);
- try {
- const containerClient = this.getContainerClient(options.destinationContainerName || deletedContainerName);
- // Hack to access a protected member.
- const containerContext = new Container(containerClient["storageClientContext"]);
- const containerUndeleteResponse = await containerContext.restore(Object.assign({ deletedContainerName,
- deletedContainerVersion }, updatedOptions));
- return { containerClient, containerUndeleteResponse };
+ if (options.includeTags) {
+ include.push("tags");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (options.includeDeletedWithVersions) {
+ include.push("deletedwithversions");
}
- finally {
- span.end();
+ if (options.includeImmutabilityPolicy) {
+ include.push("immutabilitypolicy");
+ }
+ if (options.includeLegalHold) {
+ include.push("legalhold");
+ }
+ if (options.prefix === "") {
+ options.prefix = undefined;
}
+ const updatedOptions = Object.assign(Object.assign({}, options), (include.length > 0 ? { include: include } : {}));
+ // AsyncIterableIterator to iterate over blobs
+ const iter = this.listItems(updatedOptions);
+ return {
+ /**
+ * The next method, part of the iteration protocol
+ */
+ next() {
+ return iter.next();
+ },
+ /**
+ * The connection to the async iterator, part of the iteration protocol
+ */
+ [Symbol.asyncIterator]() {
+ return this;
+ },
+ /**
+ * Return an AsyncIterableIterator that works a page at a time
+ */
+ byPage: (settings = {}) => {
+ return this.listSegments(settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, updatedOptions));
+ },
+ };
}
/**
- * Rename an existing Blob Container.
+ * Returns an AsyncIterableIterator for ContainerListBlobHierarchySegmentResponse
*
- * @param sourceContainerName - The name of the source container.
- * @param destinationContainerName - The new name of the container.
- * @param options - Options to configure Container Rename operation.
+ * @param delimiter - The character or string used to define the virtual hierarchy
+ * @param marker - A string value that identifies the portion of
+ * the list of blobs to be returned with the next listing operation. The
+ * operation returns the ContinuationToken value within the response body if the
+ * listing operation did not return all blobs remaining to be listed
+ * with the current page. The ContinuationToken value can be used as the value for
+ * the marker parameter in a subsequent call to request the next page of list
+ * items. The marker value is opaque to the client.
+ * @param options - Options to list blobs operation.
*/
- /* eslint-disable-next-line @typescript-eslint/ban-ts-comment */
- // @ts-ignore Need to hide this interface for now. Make it public and turn on the live tests for it when the service is ready.
- async renameContainer(sourceContainerName, destinationContainerName, options = {}) {
- var _a;
- const { span, updatedOptions } = createSpan("BlobServiceClient-renameContainer", options);
- try {
- const containerClient = this.getContainerClient(destinationContainerName);
- // Hack to access a protected member.
- const containerContext = new Container(containerClient["storageClientContext"]);
- const containerRenameResponse = await containerContext.rename(sourceContainerName, Object.assign(Object.assign({}, updatedOptions), { sourceLeaseId: (_a = options.sourceCondition) === null || _a === void 0 ? void 0 : _a.leaseId }));
- return { containerClient, containerRenameResponse };
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ listHierarchySegments(delimiter_1, marker_1) {
+ return tslib.__asyncGenerator(this, arguments, function* listHierarchySegments_1(delimiter, marker, options = {}) {
+ let listBlobsHierarchySegmentResponse;
+ if (!!marker || marker === undefined) {
+ do {
+ listBlobsHierarchySegmentResponse = yield tslib.__await(this.listBlobHierarchySegment(delimiter, marker, options));
+ marker = listBlobsHierarchySegmentResponse.continuationToken;
+ yield yield tslib.__await(yield tslib.__await(listBlobsHierarchySegmentResponse));
+ } while (marker);
+ }
+ });
}
/**
- * Gets the properties of a storage account’s Blob service, including properties
- * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
+ * Returns an AsyncIterableIterator for {@link BlobPrefix} and {@link BlobItem} objects.
*
- * @param options - Options to the Service Get Properties operation.
- * @returns Response data for the Service Get Properties operation.
+ * @param delimiter - The character or string used to define the virtual hierarchy
+ * @param options - Options to list blobs operation.
*/
- async getProperties(options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-getProperties", options);
- try {
- return await this.serviceContext.getProperties(Object.assign({ abortSignal: options.abortSignal }, convertTracingToRequestOptionsBase(updatedOptions)));
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ listItemsByHierarchy(delimiter_1) {
+ return tslib.__asyncGenerator(this, arguments, function* listItemsByHierarchy_1(delimiter, options = {}) {
+ var _a, e_2, _b, _c;
+ let marker;
+ try {
+ for (var _d = true, _e = tslib.__asyncValues(this.listHierarchySegments(delimiter, marker, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+ _c = _f.value;
+ _d = false;
+ const listBlobsHierarchySegmentResponse = _c;
+ const segment = listBlobsHierarchySegmentResponse.segment;
+ if (segment.blobPrefixes) {
+ for (const prefix of segment.blobPrefixes) {
+ yield yield tslib.__await(Object.assign({ kind: "prefix" }, prefix));
+ }
+ }
+ for (const blob of segment.blobItems) {
+ yield yield tslib.__await(Object.assign({ kind: "blob" }, blob));
+ }
+ }
+ }
+ catch (e_2_1) { e_2 = { error: e_2_1 }; }
+ finally {
+ try {
+ if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
+ }
+ finally { if (e_2) throw e_2.error; }
+ }
+ });
}
/**
- * Sets properties for a storage account’s Blob service endpoint, including properties
- * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
+ * Returns an async iterable iterator to list all the blobs by hierarchy.
+ * under the specified account.
+ *
+ * .byPage() returns an async iterable iterator to list the blobs by hierarchy in pages.
+ *
+ * Example using `for await` syntax:
+ *
+ * ```js
+ * for await (const item of containerClient.listBlobsByHierarchy("/")) {
+ * if (item.kind === "prefix") {
+ * console.log(`\tBlobPrefix: ${item.name}`);
+ * } else {
+ * console.log(`\tBlobItem: name - ${item.name}`);
+ * }
+ * }
+ * ```
+ *
+ * Example using `iter.next()`:
+ *
+ * ```js
+ * let iter = containerClient.listBlobsByHierarchy("/", { prefix: "prefix1/" });
+ * let entity = await iter.next();
+ * while (!entity.done) {
+ * let item = entity.value;
+ * if (item.kind === "prefix") {
+ * console.log(`\tBlobPrefix: ${item.name}`);
+ * } else {
+ * console.log(`\tBlobItem: name - ${item.name}`);
+ * }
+ * entity = await iter.next();
+ * }
+ * ```
+ *
+ * Example using `byPage()`:
+ *
+ * ```js
+ * console.log("Listing blobs by hierarchy by page");
+ * for await (const response of containerClient.listBlobsByHierarchy("/").byPage()) {
+ * const segment = response.segment;
+ * if (segment.blobPrefixes) {
+ * for (const prefix of segment.blobPrefixes) {
+ * console.log(`\tBlobPrefix: ${prefix.name}`);
+ * }
+ * }
+ * for (const blob of response.segment.blobItems) {
+ * console.log(`\tBlobItem: name - ${blob.name}`);
+ * }
+ * }
+ * ```
+ *
+ * Example using paging with a max page size:
+ *
+ * ```js
+ * console.log("Listing blobs by hierarchy by page, specifying a prefix and a max page size");
+ *
+ * let i = 1;
+ * for await (const response of containerClient
+ * .listBlobsByHierarchy("/", { prefix: "prefix2/sub1/" })
+ * .byPage({ maxPageSize: 2 })) {
+ * console.log(`Page ${i++}`);
+ * const segment = response.segment;
+ *
+ * if (segment.blobPrefixes) {
+ * for (const prefix of segment.blobPrefixes) {
+ * console.log(`\tBlobPrefix: ${prefix.name}`);
+ * }
+ * }
*
- * @param properties -
- * @param options - Options to the Service Set Properties operation.
- * @returns Response data for the Service Set Properties operation.
+ * for (const blob of response.segment.blobItems) {
+ * console.log(`\tBlobItem: name - ${blob.name}`);
+ * }
+ * }
+ * ```
+ *
+ * @param delimiter - The character or string used to define the virtual hierarchy
+ * @param options - Options to list blobs operation.
*/
- async setProperties(properties, options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-setProperties", options);
- try {
- return await this.serviceContext.setProperties(properties, Object.assign({ abortSignal: options.abortSignal }, convertTracingToRequestOptionsBase(updatedOptions)));
+ listBlobsByHierarchy(delimiter, options = {}) {
+ if (delimiter === "") {
+ throw new RangeError("delimiter should contain one or more characters");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ const include = [];
+ if (options.includeCopy) {
+ include.push("copy");
}
- finally {
- span.end();
+ if (options.includeDeleted) {
+ include.push("deleted");
}
- }
- /**
- * Retrieves statistics related to replication for the Blob service. It is only
- * available on the secondary location endpoint when read-access geo-redundant
- * replication is enabled for the storage account.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
- *
- * @param options - Options to the Service Get Statistics operation.
- * @returns Response data for the Service Get Statistics operation.
- */
- async getStatistics(options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-getStatistics", options);
- try {
- return await this.serviceContext.getStatistics(Object.assign({ abortSignal: options.abortSignal }, convertTracingToRequestOptionsBase(updatedOptions)));
+ if (options.includeMetadata) {
+ include.push("metadata");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (options.includeSnapshots) {
+ include.push("snapshots");
}
- finally {
- span.end();
+ if (options.includeVersions) {
+ include.push("versions");
}
- }
- /**
- * The Get Account Information operation returns the sku name and account kind
- * for the specified account.
- * The Get Account Information operation is available on service versions beginning
- * with version 2018-03-28.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
- *
- * @param options - Options to the Service Get Account Info operation.
- * @returns Response data for the Service Get Account Info operation.
- */
- async getAccountInfo(options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-getAccountInfo", options);
- try {
- return await this.serviceContext.getAccountInfo(Object.assign({ abortSignal: options.abortSignal }, convertTracingToRequestOptionsBase(updatedOptions)));
+ if (options.includeUncommitedBlobs) {
+ include.push("uncommittedblobs");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (options.includeTags) {
+ include.push("tags");
}
- finally {
- span.end();
+ if (options.includeDeletedWithVersions) {
+ include.push("deletedwithversions");
}
- }
- /**
- * Returns a list of the containers under the specified account.
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2
- *
- * @param marker - A string value that identifies the portion of
- * the list of containers to be returned with the next listing operation. The
- * operation returns the continuationToken value within the response body if the
- * listing operation did not return all containers remaining to be listed
- * with the current page. The continuationToken value can be used as the value for
- * the marker parameter in a subsequent call to request the next page of list
- * items. The marker value is opaque to the client.
- * @param options - Options to the Service List Container Segment operation.
- * @returns Response data for the Service List Container Segment operation.
- */
- async listContainersSegment(marker, options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-listContainersSegment", options);
- try {
- return await this.serviceContext.listContainersSegment(Object.assign(Object.assign(Object.assign({ abortSignal: options.abortSignal, marker }, options), { include: typeof options.include === "string" ? [options.include] : options.include }), convertTracingToRequestOptionsBase(updatedOptions)));
+ if (options.includeImmutabilityPolicy) {
+ include.push("immutabilitypolicy");
}
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
+ if (options.includeLegalHold) {
+ include.push("legalhold");
}
- finally {
- span.end();
+ if (options.prefix === "") {
+ options.prefix = undefined;
}
+ const updatedOptions = Object.assign(Object.assign({}, options), (include.length > 0 ? { include: include } : {}));
+ // AsyncIterableIterator to iterate over blob prefixes and blobs
+ const iter = this.listItemsByHierarchy(delimiter, updatedOptions);
+ return {
+ /**
+ * The next method, part of the iteration protocol
+ */
+ async next() {
+ return iter.next();
+ },
+ /**
+ * The connection to the async iterator, part of the iteration protocol
+ */
+ [Symbol.asyncIterator]() {
+ return this;
+ },
+ /**
+ * Return an AsyncIterableIterator that works a page at a time
+ */
+ byPage: (settings = {}) => {
+ return this.listHierarchySegments(delimiter, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, updatedOptions));
+ },
+ };
}
/**
- * The Filter Blobs operation enables callers to list blobs across all containers whose tags
- * match a given search expression. Filter blobs searches across all containers within a
- * storage account but can be scoped within the expression to a single container.
+ * The Filter Blobs operation enables callers to list blobs in the container whose tags
+ * match a given search expression.
*
* @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
* The given expression must evaluate to true for a blob to be returned in the results.
@@ -41904,9 +31734,14 @@ class BlobServiceClient extends StorageClient {
* @param options - Options to find blobs by tags.
*/
async findBlobsByTagsSegment(tagFilterSqlExpression, marker, options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-findBlobsByTagsSegment", options);
- try {
- const response = await this.serviceContext.filterBlobs(Object.assign({ abortSignal: options.abortSignal, where: tagFilterSqlExpression, marker, maxPageSize: options.maxPageSize }, convertTracingToRequestOptionsBase(updatedOptions)));
+ return tracingClient.withSpan("ContainerClient-findBlobsByTagsSegment", options, async (updatedOptions) => {
+ const response = assertResponse(await this.containerContext.filterBlobs({
+ abortSignal: options.abortSignal,
+ where: tagFilterSqlExpression,
+ marker,
+ maxPageSize: options.maxPageSize,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
const wrappedResponse = Object.assign(Object.assign({}, response), { _response: response._response, blobs: response.blobs.map((blob) => {
var _a;
let tagValue = "";
@@ -41916,20 +31751,10 @@ class BlobServiceClient extends StorageClient {
return Object.assign(Object.assign({}, blob), { tags: toTags(blob.tags), tagValue });
}) });
return wrappedResponse;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
+ });
}
/**
- * Returns an AsyncIterableIterator for ServiceFindBlobsByTagsSegmentResponse.
+ * Returns an AsyncIterableIterator for ContainerFindBlobsByTagsSegmentResponse.
*
* @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
* The given expression must evaluate to true for a blob to be returned in the results.
@@ -41944,8 +31769,8 @@ class BlobServiceClient extends StorageClient {
* items. The marker value is opaque to the client.
* @param options - Options to find blobs by tags.
*/
- findBlobsByTagsSegments(tagFilterSqlExpression, marker, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* findBlobsByTagsSegments_1() {
+ findBlobsByTagsSegments(tagFilterSqlExpression_1, marker_1) {
+ return tslib.__asyncGenerator(this, arguments, function* findBlobsByTagsSegments_1(tagFilterSqlExpression, marker, options = {}) {
let response;
if (!!marker || marker === undefined) {
do {
@@ -41966,39 +31791,39 @@ class BlobServiceClient extends StorageClient {
* however, only a subset of the OData filter syntax is supported in the Blob service.
* @param options - Options to findBlobsByTagsItems.
*/
- findBlobsByTagsItems(tagFilterSqlExpression, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* findBlobsByTagsItems_1() {
- var e_1, _a;
+ findBlobsByTagsItems(tagFilterSqlExpression_1) {
+ return tslib.__asyncGenerator(this, arguments, function* findBlobsByTagsItems_1(tagFilterSqlExpression, options = {}) {
+ var _a, e_3, _b, _c;
let marker;
try {
- for (var _b = tslib.__asyncValues(this.findBlobsByTagsSegments(tagFilterSqlExpression, marker, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
- const segment = _c.value;
+ for (var _d = true, _e = tslib.__asyncValues(this.findBlobsByTagsSegments(tagFilterSqlExpression, marker, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+ _c = _f.value;
+ _d = false;
+ const segment = _c;
yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(segment.blobs)));
}
}
- catch (e_1_1) { e_1 = { error: e_1_1 }; }
+ catch (e_3_1) { e_3 = { error: e_3_1 }; }
finally {
try {
- if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
+ if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
}
- finally { if (e_1) throw e_1.error; }
+ finally { if (e_3) throw e_3.error; }
}
});
}
/**
* Returns an async iterable iterator to find all blobs with specified tag
- * under the specified account.
+ * under the specified container.
*
* .byPage() returns an async iterable iterator to list the blobs in pages.
*
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
- *
* Example using `for await` syntax:
*
* ```js
* let i = 1;
- * for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
- * console.log(`Blob ${i++}: ${container.name}`);
+ * for await (const blob of containerClient.findBlobsByTags("tagkey='tagvalue'")) {
+ * console.log(`Blob ${i++}: ${blob.name}`);
* }
* ```
*
@@ -42006,7 +31831,7 @@ class BlobServiceClient extends StorageClient {
*
* ```js
* let i = 1;
- * const iter = blobServiceClient.findBlobsByTags("tagkey='tagvalue'");
+ * const iter = containerClient.findBlobsByTags("tagkey='tagvalue'");
* let blobItem = await iter.next();
* while (!blobItem.done) {
* console.log(`Blob ${i++}: ${blobItem.value.name}`);
@@ -42019,7 +31844,7 @@ class BlobServiceClient extends StorageClient {
* ```js
* // passing optional maxPageSize in the page settings
* let i = 1;
- * for await (const response of blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
+ * for await (const response of containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
* if (response.blobs) {
* for (const blob of response.blobs) {
* console.log(`Blob ${i++}: ${blob.name}`);
@@ -42032,7 +31857,7 @@ class BlobServiceClient extends StorageClient {
*
* ```js
* let i = 1;
- * let iterator = blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
+ * let iterator = containerClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
* let response = (await iterator.next()).value;
*
* // Prints 2 blob names
@@ -42045,7 +31870,7 @@ class BlobServiceClient extends StorageClient {
* // Gets next marker
* let marker = response.continuationToken;
* // Passing next marker as continuationToken
- * iterator = blobServiceClient
+ * iterator = containerClient
* .findBlobsByTags("tagkey='tagvalue'")
* .byPage({ continuationToken: marker, maxPageSize: 10 });
* response = (await iterator.next()).value;
@@ -42078,3476 +31903,1793 @@ class BlobServiceClient extends StorageClient {
/**
* The connection to the async iterator, part of the iteration protocol
*/
- [Symbol.asyncIterator]() {
- return this;
- },
- /**
- * Return an AsyncIterableIterator that works a page at a time
- */
- byPage: (settings = {}) => {
- return this.findBlobsByTagsSegments(tagFilterSqlExpression, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, listSegmentOptions));
- },
- };
- }
- /**
- * Returns an AsyncIterableIterator for ServiceListContainersSegmentResponses
- *
- * @param marker - A string value that identifies the portion of
- * the list of containers to be returned with the next listing operation. The
- * operation returns the continuationToken value within the response body if the
- * listing operation did not return all containers remaining to be listed
- * with the current page. The continuationToken value can be used as the value for
- * the marker parameter in a subsequent call to request the next page of list
- * items. The marker value is opaque to the client.
- * @param options - Options to list containers operation.
- */
- listSegments(marker, options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* listSegments_1() {
- let listContainersSegmentResponse;
- if (!!marker || marker === undefined) {
- do {
- listContainersSegmentResponse = yield tslib.__await(this.listContainersSegment(marker, options));
- listContainersSegmentResponse.containerItems =
- listContainersSegmentResponse.containerItems || [];
- marker = listContainersSegmentResponse.continuationToken;
- yield yield tslib.__await(yield tslib.__await(listContainersSegmentResponse));
- } while (marker);
- }
- });
- }
- /**
- * Returns an AsyncIterableIterator for Container Items
- *
- * @param options - Options to list containers operation.
- */
- listItems(options = {}) {
- return tslib.__asyncGenerator(this, arguments, function* listItems_1() {
- var e_2, _a;
- let marker;
- try {
- for (var _b = tslib.__asyncValues(this.listSegments(marker, options)), _c; _c = yield tslib.__await(_b.next()), !_c.done;) {
- const segment = _c.value;
- yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(segment.containerItems)));
- }
- }
- catch (e_2_1) { e_2 = { error: e_2_1 }; }
- finally {
- try {
- if (_c && !_c.done && (_a = _b.return)) yield tslib.__await(_a.call(_b));
- }
- finally { if (e_2) throw e_2.error; }
- }
- });
- }
- /**
- * Returns an async iterable iterator to list all the containers
- * under the specified account.
- *
- * .byPage() returns an async iterable iterator to list the containers in pages.
- *
- * Example using `for await` syntax:
- *
- * ```js
- * let i = 1;
- * for await (const container of blobServiceClient.listContainers()) {
- * console.log(`Container ${i++}: ${container.name}`);
- * }
- * ```
- *
- * Example using `iter.next()`:
- *
- * ```js
- * let i = 1;
- * const iter = blobServiceClient.listContainers();
- * let containerItem = await iter.next();
- * while (!containerItem.done) {
- * console.log(`Container ${i++}: ${containerItem.value.name}`);
- * containerItem = await iter.next();
- * }
- * ```
- *
- * Example using `byPage()`:
- *
- * ```js
- * // passing optional maxPageSize in the page settings
- * let i = 1;
- * for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
- * if (response.containerItems) {
- * for (const container of response.containerItems) {
- * console.log(`Container ${i++}: ${container.name}`);
- * }
- * }
- * }
- * ```
- *
- * Example using paging with a marker:
- *
- * ```js
- * let i = 1;
- * let iterator = blobServiceClient.listContainers().byPage({ maxPageSize: 2 });
- * let response = (await iterator.next()).value;
- *
- * // Prints 2 container names
- * if (response.containerItems) {
- * for (const container of response.containerItems) {
- * console.log(`Container ${i++}: ${container.name}`);
- * }
- * }
- *
- * // Gets next marker
- * let marker = response.continuationToken;
- * // Passing next marker as continuationToken
- * iterator = blobServiceClient
- * .listContainers()
- * .byPage({ continuationToken: marker, maxPageSize: 10 });
- * response = (await iterator.next()).value;
- *
- * // Prints 10 container names
- * if (response.containerItems) {
- * for (const container of response.containerItems) {
- * console.log(`Container ${i++}: ${container.name}`);
- * }
- * }
- * ```
- *
- * @param options - Options to list containers.
- * @returns An asyncIterableIterator that supports paging.
- */
- listContainers(options = {}) {
- if (options.prefix === "") {
- options.prefix = undefined;
- }
- const include = [];
- if (options.includeDeleted) {
- include.push("deleted");
- }
- if (options.includeMetadata) {
- include.push("metadata");
- }
- if (options.includeSystem) {
- include.push("system");
- }
- // AsyncIterableIterator to iterate over containers
- const listSegmentOptions = Object.assign(Object.assign({}, options), (include.length > 0 ? { include } : {}));
- const iter = this.listItems(listSegmentOptions);
- return {
- /**
- * The next method, part of the iteration protocol
- */
- next() {
- return iter.next();
- },
- /**
- * The connection to the async iterator, part of the iteration protocol
- */
- [Symbol.asyncIterator]() {
- return this;
- },
- /**
- * Return an AsyncIterableIterator that works a page at a time
- */
- byPage: (settings = {}) => {
- return this.listSegments(settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, listSegmentOptions));
- },
- };
- }
- /**
- * ONLY AVAILABLE WHEN USING BEARER TOKEN AUTHENTICATION (TokenCredential).
- *
- * Retrieves a user delegation key for the Blob service. This is only a valid operation when using
- * bearer token authentication.
- *
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
- *
- * @param startsOn - The start time for the user delegation SAS. Must be within 7 days of the current time
- * @param expiresOn - The end time for the user delegation SAS. Must be within 7 days of the current time
- */
- async getUserDelegationKey(startsOn, expiresOn, options = {}) {
- const { span, updatedOptions } = createSpan("BlobServiceClient-getUserDelegationKey", options);
- try {
- const response = await this.serviceContext.getUserDelegationKey({
- startsOn: truncatedISO8061Date(startsOn, false),
- expiresOn: truncatedISO8061Date(expiresOn, false),
- }, Object.assign({ abortSignal: options.abortSignal }, convertTracingToRequestOptionsBase(updatedOptions)));
- const userDelegationKey = {
- signedObjectId: response.signedObjectId,
- signedTenantId: response.signedTenantId,
- signedStartsOn: new Date(response.signedStartsOn),
- signedExpiresOn: new Date(response.signedExpiresOn),
- signedService: response.signedService,
- signedVersion: response.signedVersion,
- value: response.value,
- };
- const res = Object.assign({ _response: response._response, requestId: response.requestId, clientRequestId: response.clientRequestId, version: response.version, date: response.date, errorCode: response.errorCode }, userDelegationKey);
- return res;
- }
- catch (e) {
- span.setStatus({
- code: coreTracing.SpanStatusCode.ERROR,
- message: e.message,
- });
- throw e;
- }
- finally {
- span.end();
- }
- }
- /**
- * Creates a BlobBatchClient object to conduct batch operations.
- *
- * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
- *
- * @returns A new BlobBatchClient object for this service.
- */
- getBlobBatchClient() {
- return new BlobBatchClient(this.url, this.pipeline);
- }
- /**
- * Only available for BlobServiceClient constructed with a shared key credential.
- *
- * Generates a Blob account 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/create-account-sas
- *
- * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
- * @param permissions - Specifies the list of permissions to be associated with the SAS.
- * @param resourceTypes - Specifies the resource types associated with the shared access signature.
- * @param options - Optional parameters.
- * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
- */
- generateAccountSasUrl(expiresOn, permissions = AccountSASPermissions.parse("r"), resourceTypes = "sco", options = {}) {
- if (!(this.credential instanceof StorageSharedKeyCredential)) {
- throw RangeError("Can only generate the account SAS when the client is initialized with a shared key credential");
- }
- if (expiresOn === undefined) {
- const now = new Date();
- expiresOn = new Date(now.getTime() + 3600 * 1000);
- }
- const sas = generateAccountSASQueryParameters(Object.assign({ permissions,
- expiresOn,
- resourceTypes, services: AccountSASServices.parse("b").toString() }, options), this.credential).toString();
- return appendToURLQuery(this.url, sas);
- }
-}
-
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-/** Known values of {@link EncryptionAlgorithmType} that the service accepts. */
-exports.KnownEncryptionAlgorithmType = void 0;
-(function (KnownEncryptionAlgorithmType) {
- KnownEncryptionAlgorithmType["AES256"] = "AES256";
-})(exports.KnownEncryptionAlgorithmType || (exports.KnownEncryptionAlgorithmType = {}));
-
-Object.defineProperty(exports, "BaseRequestPolicy", ({
- enumerable: true,
- get: function () { return coreHttp.BaseRequestPolicy; }
-}));
-Object.defineProperty(exports, "HttpHeaders", ({
- enumerable: true,
- get: function () { return coreHttp.HttpHeaders; }
-}));
-Object.defineProperty(exports, "RequestPolicyOptions", ({
- enumerable: true,
- get: function () { return coreHttp.RequestPolicyOptions; }
-}));
-Object.defineProperty(exports, "RestError", ({
- enumerable: true,
- get: function () { return coreHttp.RestError; }
-}));
-Object.defineProperty(exports, "WebResource", ({
- enumerable: true,
- get: function () { return coreHttp.WebResource; }
-}));
-Object.defineProperty(exports, "deserializationPolicy", ({
- enumerable: true,
- get: function () { return coreHttp.deserializationPolicy; }
-}));
-exports.AccountSASPermissions = AccountSASPermissions;
-exports.AccountSASResourceTypes = AccountSASResourceTypes;
-exports.AccountSASServices = AccountSASServices;
-exports.AnonymousCredential = AnonymousCredential;
-exports.AnonymousCredentialPolicy = AnonymousCredentialPolicy;
-exports.AppendBlobClient = AppendBlobClient;
-exports.BlobBatch = BlobBatch;
-exports.BlobBatchClient = BlobBatchClient;
-exports.BlobClient = BlobClient;
-exports.BlobLeaseClient = BlobLeaseClient;
-exports.BlobSASPermissions = BlobSASPermissions;
-exports.BlobServiceClient = BlobServiceClient;
-exports.BlockBlobClient = BlockBlobClient;
-exports.ContainerClient = ContainerClient;
-exports.ContainerSASPermissions = ContainerSASPermissions;
-exports.Credential = Credential;
-exports.CredentialPolicy = CredentialPolicy;
-exports.PageBlobClient = PageBlobClient;
-exports.Pipeline = Pipeline;
-exports.SASQueryParameters = SASQueryParameters;
-exports.StorageBrowserPolicy = StorageBrowserPolicy;
-exports.StorageBrowserPolicyFactory = StorageBrowserPolicyFactory;
-exports.StorageOAuthScopes = StorageOAuthScopes;
-exports.StorageRetryPolicy = StorageRetryPolicy;
-exports.StorageRetryPolicyFactory = StorageRetryPolicyFactory;
-exports.StorageSharedKeyCredential = StorageSharedKeyCredential;
-exports.StorageSharedKeyCredentialPolicy = StorageSharedKeyCredentialPolicy;
-exports.generateAccountSASQueryParameters = generateAccountSASQueryParameters;
-exports.generateBlobSASQueryParameters = generateBlobSASQueryParameters;
-exports.getBlobServiceAccountAudience = getBlobServiceAccountAudience;
-exports.isPipelineLike = isPipelineLike;
-exports.logger = logger;
-exports.newPipeline = newPipeline;
-//# sourceMappingURL=index.js.map
-
-
-/***/ }),
-
-/***/ 7171:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.ContextAPI = void 0;
-const NoopContextManager_1 = __nccwpck_require__(4118);
-const global_utils_1 = __nccwpck_require__(5135);
-const diag_1 = __nccwpck_require__(1877);
-const API_NAME = 'context';
-const NOOP_CONTEXT_MANAGER = new NoopContextManager_1.NoopContextManager();
-/**
- * Singleton object which represents the entry point to the OpenTelemetry Context API
- */
-class ContextAPI {
- /** Empty private constructor prevents end users from constructing a new instance of the API */
- constructor() { }
- /** Get the singleton instance of the Context API */
- static getInstance() {
- if (!this._instance) {
- this._instance = new ContextAPI();
- }
- return this._instance;
- }
- /**
- * Set the current context manager.
- *
- * @returns true if the context manager was successfully registered, else false
- */
- setGlobalContextManager(contextManager) {
- return (0, global_utils_1.registerGlobal)(API_NAME, contextManager, diag_1.DiagAPI.instance());
- }
- /**
- * Get the currently active context
- */
- active() {
- return this._getContextManager().active();
- }
- /**
- * Execute a function with an active context
- *
- * @param context context to be active during function execution
- * @param fn function to execute in a context
- * @param thisArg optional receiver to be used for calling fn
- * @param args optional arguments forwarded to fn
- */
- with(context, fn, thisArg, ...args) {
- return this._getContextManager().with(context, fn, thisArg, ...args);
- }
- /**
- * Bind a context to a target function or event emitter
- *
- * @param context context to bind to the event emitter or function. Defaults to the currently active context
- * @param target function or event emitter to bind
- */
- bind(context, target) {
- return this._getContextManager().bind(context, target);
- }
- _getContextManager() {
- return (0, global_utils_1.getGlobal)(API_NAME) || NOOP_CONTEXT_MANAGER;
- }
- /** Disable and remove the global context manager */
- disable() {
- this._getContextManager().disable();
- (0, global_utils_1.unregisterGlobal)(API_NAME, diag_1.DiagAPI.instance());
- }
-}
-exports.ContextAPI = ContextAPI;
-//# sourceMappingURL=context.js.map
-
-/***/ }),
-
-/***/ 1877:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.DiagAPI = void 0;
-const ComponentLogger_1 = __nccwpck_require__(7978);
-const logLevelLogger_1 = __nccwpck_require__(9639);
-const types_1 = __nccwpck_require__(8077);
-const global_utils_1 = __nccwpck_require__(5135);
-const API_NAME = 'diag';
-/**
- * Singleton object which represents the entry point to the OpenTelemetry internal
- * diagnostic API
- */
-class DiagAPI {
+ [Symbol.asyncIterator]() {
+ return this;
+ },
+ /**
+ * Return an AsyncIterableIterator that works a page at a time
+ */
+ byPage: (settings = {}) => {
+ return this.findBlobsByTagsSegments(tagFilterSqlExpression, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, listSegmentOptions));
+ },
+ };
+ }
/**
- * Private internal constructor
- * @private
+ * The Get Account Information operation returns the sku name and account kind
+ * for the specified account.
+ * The Get Account Information operation is available on service versions beginning
+ * with version 2018-03-28.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
+ *
+ * @param options - Options to the Service Get Account Info operation.
+ * @returns Response data for the Service Get Account Info operation.
*/
- constructor() {
- function _logProxy(funcName) {
- return function (...args) {
- const logger = (0, global_utils_1.getGlobal)('diag');
- // shortcut if logger not set
- if (!logger)
- return;
- return logger[funcName](...args);
- };
- }
- // Using self local variable for minification purposes as 'this' cannot be minified
- const self = this;
- // DiagAPI specific functions
- const setLogger = (logger, optionsOrLogLevel = { logLevel: types_1.DiagLogLevel.INFO }) => {
- var _a, _b, _c;
- if (logger === self) {
- // There isn't much we can do here.
- // Logging to the console might break the user application.
- // Try to log to self. If a logger was previously registered it will receive the log.
- const err = new Error('Cannot use diag as the logger for itself. Please use a DiagLogger implementation like ConsoleDiagLogger or a custom implementation');
- self.error((_a = err.stack) !== null && _a !== void 0 ? _a : err.message);
- return false;
+ async getAccountInfo(options = {}) {
+ return tracingClient.withSpan("ContainerClient-getAccountInfo", options, async (updatedOptions) => {
+ return assertResponse(await this.containerContext.getAccountInfo({
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ getContainerNameFromUrl() {
+ let containerName;
+ try {
+ // URL may look like the following
+ // "https://myaccount.blob.core.windows.net/mycontainer?sasString";
+ // "https://myaccount.blob.core.windows.net/mycontainer";
+ // IPv4/IPv6 address hosts, Endpoints - `http://127.0.0.1:10000/devstoreaccount1/containername`
+ // http://localhost:10001/devstoreaccount1/containername
+ const parsedUrl = new URL(this.url);
+ if (parsedUrl.hostname.split(".")[1] === "blob") {
+ // "https://myaccount.blob.core.windows.net/containername".
+ // "https://customdomain.com/containername".
+ // .getPath() -> /containername
+ containerName = parsedUrl.pathname.split("/")[1];
}
- if (typeof optionsOrLogLevel === 'number') {
- optionsOrLogLevel = {
- logLevel: optionsOrLogLevel,
- };
+ else if (isIpEndpointStyle(parsedUrl)) {
+ // IPv4/IPv6 address hosts... Example - http://192.0.0.10:10001/devstoreaccount1/containername
+ // Single word domain without a [dot] in the endpoint... Example - http://localhost:10001/devstoreaccount1/containername
+ // .getPath() -> /devstoreaccount1/containername
+ containerName = parsedUrl.pathname.split("/")[2];
}
- const oldLogger = (0, global_utils_1.getGlobal)('diag');
- const newLogger = (0, logLevelLogger_1.createLogLevelDiagLogger)((_b = optionsOrLogLevel.logLevel) !== null && _b !== void 0 ? _b : types_1.DiagLogLevel.INFO, logger);
- // There already is an logger registered. We'll let it know before overwriting it.
- if (oldLogger && !optionsOrLogLevel.suppressOverrideMessage) {
- const stack = (_c = new Error().stack) !== null && _c !== void 0 ? _c : '';
- oldLogger.warn(`Current logger will be overwritten from ${stack}`);
- newLogger.warn(`Current logger will overwrite one already registered from ${stack}`);
+ else {
+ // "https://customdomain.com/containername".
+ // .getPath() -> /containername
+ containerName = parsedUrl.pathname.split("/")[1];
}
- return (0, global_utils_1.registerGlobal)('diag', newLogger, self, true);
- };
- self.setLogger = setLogger;
- self.disable = () => {
- (0, global_utils_1.unregisterGlobal)(API_NAME, self);
- };
- self.createComponentLogger = (options) => {
- return new ComponentLogger_1.DiagComponentLogger(options);
- };
- self.verbose = _logProxy('verbose');
- self.debug = _logProxy('debug');
- self.info = _logProxy('info');
- self.warn = _logProxy('warn');
- self.error = _logProxy('error');
- }
- /** Get the singleton instance of the DiagAPI API */
- static instance() {
- if (!this._instance) {
- this._instance = new DiagAPI();
- }
- return this._instance;
- }
-}
-exports.DiagAPI = DiagAPI;
-//# sourceMappingURL=diag.js.map
-
-/***/ }),
-
-/***/ 7696:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.MetricsAPI = void 0;
-const NoopMeterProvider_1 = __nccwpck_require__(2647);
-const global_utils_1 = __nccwpck_require__(5135);
-const diag_1 = __nccwpck_require__(1877);
-const API_NAME = 'metrics';
-/**
- * Singleton object which represents the entry point to the OpenTelemetry Metrics API
- */
-class MetricsAPI {
- /** Empty private constructor prevents end users from constructing a new instance of the API */
- constructor() { }
- /** Get the singleton instance of the Metrics API */
- static getInstance() {
- if (!this._instance) {
- this._instance = new MetricsAPI();
+ // decode the encoded containerName - to get all the special characters that might be present in it
+ containerName = decodeURIComponent(containerName);
+ if (!containerName) {
+ throw new Error("Provided containerName is invalid.");
+ }
+ return containerName;
}
- return this._instance;
- }
- /**
- * Set the current global meter provider.
- * Returns true if the meter provider was successfully registered, else false.
- */
- setGlobalMeterProvider(provider) {
- return (0, global_utils_1.registerGlobal)(API_NAME, provider, diag_1.DiagAPI.instance());
- }
- /**
- * Returns the global meter provider.
- */
- getMeterProvider() {
- return (0, global_utils_1.getGlobal)(API_NAME) || NoopMeterProvider_1.NOOP_METER_PROVIDER;
- }
- /**
- * Returns a meter from the global meter provider.
- */
- getMeter(name, version, options) {
- return this.getMeterProvider().getMeter(name, version, options);
- }
- /** Remove the global meter provider */
- disable() {
- (0, global_utils_1.unregisterGlobal)(API_NAME, diag_1.DiagAPI.instance());
- }
-}
-exports.MetricsAPI = MetricsAPI;
-//# sourceMappingURL=metrics.js.map
-
-/***/ }),
-
-/***/ 9909:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.PropagationAPI = void 0;
-const global_utils_1 = __nccwpck_require__(5135);
-const NoopTextMapPropagator_1 = __nccwpck_require__(2368);
-const TextMapPropagator_1 = __nccwpck_require__(865);
-const context_helpers_1 = __nccwpck_require__(7682);
-const utils_1 = __nccwpck_require__(8136);
-const diag_1 = __nccwpck_require__(1877);
-const API_NAME = 'propagation';
-const NOOP_TEXT_MAP_PROPAGATOR = new NoopTextMapPropagator_1.NoopTextMapPropagator();
-/**
- * Singleton object which represents the entry point to the OpenTelemetry Propagation API
- */
-class PropagationAPI {
- /** Empty private constructor prevents end users from constructing a new instance of the API */
- constructor() {
- this.createBaggage = utils_1.createBaggage;
- this.getBaggage = context_helpers_1.getBaggage;
- this.getActiveBaggage = context_helpers_1.getActiveBaggage;
- this.setBaggage = context_helpers_1.setBaggage;
- this.deleteBaggage = context_helpers_1.deleteBaggage;
- }
- /** Get the singleton instance of the Propagator API */
- static getInstance() {
- if (!this._instance) {
- this._instance = new PropagationAPI();
+ catch (error) {
+ throw new Error("Unable to extract containerName with provided information.");
}
- return this._instance;
}
/**
- * Set the current propagator.
+ * Only available for ContainerClient constructed with a shared key credential.
*
- * @returns true if the propagator was successfully registered, else false
- */
- setGlobalPropagator(propagator) {
- return (0, global_utils_1.registerGlobal)(API_NAME, propagator, diag_1.DiagAPI.instance());
- }
- /**
- * Inject context into a carrier to be propagated inter-process
+ * Generates a Blob Container 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.
*
- * @param context Context carrying tracing data to inject
- * @param carrier carrier to inject context into
- * @param setter Function used to set values on the carrier
- */
- inject(context, carrier, setter = TextMapPropagator_1.defaultTextMapSetter) {
- return this._getGlobalPropagator().inject(context, carrier, setter);
- }
- /**
- * Extract context from a carrier
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas
*
- * @param context Context which the newly created context will inherit from
- * @param carrier Carrier to extract context from
- * @param getter Function used to extract keys from a carrier
+ * @param options - Optional parameters.
+ * @returns The SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
*/
- extract(context, carrier, getter = TextMapPropagator_1.defaultTextMapGetter) {
- return this._getGlobalPropagator().extract(context, carrier, getter);
+ generateSasUrl(options) {
+ return new Promise((resolve) => {
+ if (!(this.credential instanceof StorageSharedKeyCredential)) {
+ throw new RangeError("Can only generate the SAS when the client is initialized with a shared key credential");
+ }
+ const sas = generateBlobSASQueryParameters(Object.assign({ containerName: this._containerName }, options), this.credential).toString();
+ resolve(appendToURLQuery(this.url, sas));
+ });
}
/**
- * Return a list of all fields which may be used by the propagator.
+ * Creates a BlobBatchClient object to conduct batch operations.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
+ *
+ * @returns A new BlobBatchClient object for this container.
*/
- fields() {
- return this._getGlobalPropagator().fields();
- }
- /** Remove the global propagator */
- disable() {
- (0, global_utils_1.unregisterGlobal)(API_NAME, diag_1.DiagAPI.instance());
- }
- _getGlobalPropagator() {
- return (0, global_utils_1.getGlobal)(API_NAME) || NOOP_TEXT_MAP_PROPAGATOR;
+ getBlobBatchClient() {
+ return new BlobBatchClient(this.url, this.pipeline);
}
}
-exports.PropagationAPI = PropagationAPI;
-//# sourceMappingURL=propagation.js.map
-
-/***/ }),
-
-/***/ 1539:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.TraceAPI = void 0;
-const global_utils_1 = __nccwpck_require__(5135);
-const ProxyTracerProvider_1 = __nccwpck_require__(2285);
-const spancontext_utils_1 = __nccwpck_require__(9745);
-const context_utils_1 = __nccwpck_require__(3326);
-const diag_1 = __nccwpck_require__(1877);
-const API_NAME = 'trace';
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * Singleton object which represents the entry point to the OpenTelemetry Tracing API
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * This is a helper class to construct a string representing the permissions granted by an AccountSAS. Setting a value
+ * to true means that any SAS which uses these permissions will grant permissions for that operation. Once all the
+ * values are set, this should be serialized with toString and set as the permissions field on an
+ * {@link AccountSASSignatureValues} object. It is possible to construct the permissions string without this class, but
+ * the order of the permissions is particular and this class guarantees correctness.
*/
-class TraceAPI {
- /** Empty private constructor prevents end users from constructing a new instance of the API */
+class AccountSASPermissions {
constructor() {
- this._proxyTracerProvider = new ProxyTracerProvider_1.ProxyTracerProvider();
- this.wrapSpanContext = spancontext_utils_1.wrapSpanContext;
- this.isSpanContextValid = spancontext_utils_1.isSpanContextValid;
- this.deleteSpan = context_utils_1.deleteSpan;
- this.getSpan = context_utils_1.getSpan;
- this.getActiveSpan = context_utils_1.getActiveSpan;
- this.getSpanContext = context_utils_1.getSpanContext;
- this.setSpan = context_utils_1.setSpan;
- this.setSpanContext = context_utils_1.setSpanContext;
- }
- /** Get the singleton instance of the Trace API */
- static getInstance() {
- if (!this._instance) {
- this._instance = new TraceAPI();
- }
- return this._instance;
+ /**
+ * Permission to read resources and list queues and tables granted.
+ */
+ this.read = false;
+ /**
+ * Permission to write resources granted.
+ */
+ this.write = false;
+ /**
+ * Permission to delete blobs and files granted.
+ */
+ this.delete = false;
+ /**
+ * Permission to delete versions granted.
+ */
+ this.deleteVersion = false;
+ /**
+ * Permission to list blob containers, blobs, shares, directories, and files granted.
+ */
+ this.list = false;
+ /**
+ * Permission to add messages, table entities, and append to blobs granted.
+ */
+ this.add = false;
+ /**
+ * Permission to create blobs and files granted.
+ */
+ this.create = false;
+ /**
+ * Permissions to update messages and table entities granted.
+ */
+ this.update = false;
+ /**
+ * Permission to get and delete messages granted.
+ */
+ this.process = false;
+ /**
+ * Specfies Tag access granted.
+ */
+ this.tag = false;
+ /**
+ * Permission to filter blobs.
+ */
+ this.filter = false;
+ /**
+ * Permission to set immutability policy.
+ */
+ this.setImmutabilityPolicy = false;
+ /**
+ * Specifies that Permanent Delete is permitted.
+ */
+ this.permanentDelete = false;
}
/**
- * Set the current global tracer.
+ * Parse initializes the AccountSASPermissions fields from a string.
*
- * @returns true if the tracer provider was successfully registered, else false
+ * @param permissions -
*/
- setGlobalTracerProvider(provider) {
- const success = (0, global_utils_1.registerGlobal)(API_NAME, this._proxyTracerProvider, diag_1.DiagAPI.instance());
- if (success) {
- this._proxyTracerProvider.setDelegate(provider);
+ static parse(permissions) {
+ const accountSASPermissions = new AccountSASPermissions();
+ for (const c of permissions) {
+ switch (c) {
+ case "r":
+ accountSASPermissions.read = true;
+ break;
+ case "w":
+ accountSASPermissions.write = true;
+ break;
+ case "d":
+ accountSASPermissions.delete = true;
+ break;
+ case "x":
+ accountSASPermissions.deleteVersion = true;
+ break;
+ case "l":
+ accountSASPermissions.list = true;
+ break;
+ case "a":
+ accountSASPermissions.add = true;
+ break;
+ case "c":
+ accountSASPermissions.create = true;
+ break;
+ case "u":
+ accountSASPermissions.update = true;
+ break;
+ case "p":
+ accountSASPermissions.process = true;
+ break;
+ case "t":
+ accountSASPermissions.tag = true;
+ break;
+ case "f":
+ accountSASPermissions.filter = true;
+ break;
+ case "i":
+ accountSASPermissions.setImmutabilityPolicy = true;
+ break;
+ case "y":
+ accountSASPermissions.permanentDelete = true;
+ break;
+ default:
+ throw new RangeError(`Invalid permission character: ${c}`);
+ }
}
- return success;
- }
- /**
- * Returns the global tracer provider.
- */
- getTracerProvider() {
- return (0, global_utils_1.getGlobal)(API_NAME) || this._proxyTracerProvider;
+ return accountSASPermissions;
}
/**
- * Returns a tracer from the global tracer provider.
+ * Creates a {@link AccountSASPermissions} from a raw object which contains same keys as it
+ * and boolean values for them.
+ *
+ * @param permissionLike -
*/
- getTracer(name, version) {
- return this.getTracerProvider().getTracer(name, version);
- }
- /** Remove the global tracer provider */
- disable() {
- (0, global_utils_1.unregisterGlobal)(API_NAME, diag_1.DiagAPI.instance());
- this._proxyTracerProvider = new ProxyTracerProvider_1.ProxyTracerProvider();
- }
-}
-exports.TraceAPI = TraceAPI;
-//# sourceMappingURL=trace.js.map
-
-/***/ }),
-
-/***/ 7682:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.deleteBaggage = exports.setBaggage = exports.getActiveBaggage = exports.getBaggage = void 0;
-const context_1 = __nccwpck_require__(7171);
-const context_2 = __nccwpck_require__(8242);
-/**
- * Baggage key
- */
-const BAGGAGE_KEY = (0, context_2.createContextKey)('OpenTelemetry Baggage Key');
-/**
- * Retrieve the current baggage from the given context
- *
- * @param {Context} Context that manage all context values
- * @returns {Baggage} Extracted baggage from the context
- */
-function getBaggage(context) {
- return context.getValue(BAGGAGE_KEY) || undefined;
-}
-exports.getBaggage = getBaggage;
-/**
- * Retrieve the current baggage from the active/current context
- *
- * @returns {Baggage} Extracted baggage from the context
- */
-function getActiveBaggage() {
- return getBaggage(context_1.ContextAPI.getInstance().active());
-}
-exports.getActiveBaggage = getActiveBaggage;
-/**
- * Store a baggage in the given context
- *
- * @param {Context} Context that manage all context values
- * @param {Baggage} baggage that will be set in the actual context
- */
-function setBaggage(context, baggage) {
- return context.setValue(BAGGAGE_KEY, baggage);
-}
-exports.setBaggage = setBaggage;
-/**
- * Delete the baggage stored in the given context
- *
- * @param {Context} Context that manage all context values
- */
-function deleteBaggage(context) {
- return context.deleteValue(BAGGAGE_KEY);
-}
-exports.deleteBaggage = deleteBaggage;
-//# sourceMappingURL=context-helpers.js.map
-
-/***/ }),
-
-/***/ 4811:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.BaggageImpl = void 0;
-class BaggageImpl {
- constructor(entries) {
- this._entries = entries ? new Map(entries) : new Map();
- }
- getEntry(key) {
- const entry = this._entries.get(key);
- if (!entry) {
- return undefined;
+ static from(permissionLike) {
+ const accountSASPermissions = new AccountSASPermissions();
+ if (permissionLike.read) {
+ accountSASPermissions.read = true;
}
- return Object.assign({}, entry);
- }
- getAllEntries() {
- return Array.from(this._entries.entries()).map(([k, v]) => [k, v]);
- }
- setEntry(key, entry) {
- const newBaggage = new BaggageImpl(this._entries);
- newBaggage._entries.set(key, entry);
- return newBaggage;
- }
- removeEntry(key) {
- const newBaggage = new BaggageImpl(this._entries);
- newBaggage._entries.delete(key);
- return newBaggage;
- }
- removeEntries(...keys) {
- const newBaggage = new BaggageImpl(this._entries);
- for (const key of keys) {
- newBaggage._entries.delete(key);
+ if (permissionLike.write) {
+ accountSASPermissions.write = true;
}
- return newBaggage;
- }
- clear() {
- return new BaggageImpl();
- }
-}
-exports.BaggageImpl = BaggageImpl;
-//# sourceMappingURL=baggage-impl.js.map
-
-/***/ }),
-
-/***/ 3542:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.baggageEntryMetadataSymbol = void 0;
-/**
- * Symbol used to make BaggageEntryMetadata an opaque type
- */
-exports.baggageEntryMetadataSymbol = Symbol('BaggageEntryMetadata');
-//# sourceMappingURL=symbol.js.map
-
-/***/ }),
-
-/***/ 8136:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.baggageEntryMetadataFromString = exports.createBaggage = void 0;
-const diag_1 = __nccwpck_require__(1877);
-const baggage_impl_1 = __nccwpck_require__(4811);
-const symbol_1 = __nccwpck_require__(3542);
-const diag = diag_1.DiagAPI.instance();
-/**
- * Create a new Baggage with optional entries
- *
- * @param entries An array of baggage entries the new baggage should contain
- */
-function createBaggage(entries = {}) {
- return new baggage_impl_1.BaggageImpl(new Map(Object.entries(entries)));
-}
-exports.createBaggage = createBaggage;
-/**
- * Create a serializable BaggageEntryMetadata object from a string.
- *
- * @param str string metadata. Format is currently not defined by the spec and has no special meaning.
- *
- */
-function baggageEntryMetadataFromString(str) {
- if (typeof str !== 'string') {
- diag.error(`Cannot create baggage metadata from unknown type: ${typeof str}`);
- str = '';
- }
- return {
- __TYPE__: symbol_1.baggageEntryMetadataSymbol,
- toString() {
- return str;
- },
- };
-}
-exports.baggageEntryMetadataFromString = baggageEntryMetadataFromString;
-//# sourceMappingURL=utils.js.map
-
-/***/ }),
-
-/***/ 7393:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.context = void 0;
-// Split module-level variable definition into separate files to allow
-// tree-shaking on each api instance.
-const context_1 = __nccwpck_require__(7171);
-/** Entrypoint for context API */
-exports.context = context_1.ContextAPI.getInstance();
-//# sourceMappingURL=context-api.js.map
-
-/***/ }),
-
-/***/ 4118:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.NoopContextManager = void 0;
-const context_1 = __nccwpck_require__(8242);
-class NoopContextManager {
- active() {
- return context_1.ROOT_CONTEXT;
- }
- with(_context, fn, thisArg, ...args) {
- return fn.call(thisArg, ...args);
- }
- bind(_context, target) {
- return target;
- }
- enable() {
- return this;
- }
- disable() {
- return this;
- }
-}
-exports.NoopContextManager = NoopContextManager;
-//# sourceMappingURL=NoopContextManager.js.map
-
-/***/ }),
-
-/***/ 8242:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.ROOT_CONTEXT = exports.createContextKey = void 0;
-/** Get a key to uniquely identify a context value */
-function createContextKey(description) {
- // The specification states that for the same input, multiple calls should
- // return different keys. Due to the nature of the JS dependency management
- // system, this creates problems where multiple versions of some package
- // could hold different keys for the same property.
- //
- // Therefore, we use Symbol.for which returns the same key for the same input.
- return Symbol.for(description);
-}
-exports.createContextKey = createContextKey;
-class BaseContext {
- /**
- * Construct a new context which inherits values from an optional parent context.
- *
- * @param parentContext a context from which to inherit values
- */
- constructor(parentContext) {
- // for minification
- const self = this;
- self._currentContext = parentContext ? new Map(parentContext) : new Map();
- self.getValue = (key) => self._currentContext.get(key);
- self.setValue = (key, value) => {
- const context = new BaseContext(self._currentContext);
- context._currentContext.set(key, value);
- return context;
- };
- self.deleteValue = (key) => {
- const context = new BaseContext(self._currentContext);
- context._currentContext.delete(key);
- return context;
- };
- }
-}
-/** The root context is used as the default parent context when there is no active context */
-exports.ROOT_CONTEXT = new BaseContext();
-//# sourceMappingURL=context.js.map
-
-/***/ }),
-
-/***/ 9721:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.diag = void 0;
-// Split module-level variable definition into separate files to allow
-// tree-shaking on each api instance.
-const diag_1 = __nccwpck_require__(1877);
-/**
- * Entrypoint for Diag API.
- * Defines Diagnostic handler used for internal diagnostic logging operations.
- * The default provides a Noop DiagLogger implementation which may be changed via the
- * diag.setLogger(logger: DiagLogger) function.
- */
-exports.diag = diag_1.DiagAPI.instance();
-//# sourceMappingURL=diag-api.js.map
-
-/***/ }),
-
-/***/ 7978:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.DiagComponentLogger = void 0;
-const global_utils_1 = __nccwpck_require__(5135);
-/**
- * Component Logger which is meant to be used as part of any component which
- * will add automatically additional namespace in front of the log message.
- * It will then forward all message to global diag logger
- * @example
- * const cLogger = diag.createComponentLogger({ namespace: '@opentelemetry/instrumentation-http' });
- * cLogger.debug('test');
- * // @opentelemetry/instrumentation-http test
- */
-class DiagComponentLogger {
- constructor(props) {
- this._namespace = props.namespace || 'DiagComponentLogger';
- }
- debug(...args) {
- return logProxy('debug', this._namespace, args);
- }
- error(...args) {
- return logProxy('error', this._namespace, args);
- }
- info(...args) {
- return logProxy('info', this._namespace, args);
- }
- warn(...args) {
- return logProxy('warn', this._namespace, args);
- }
- verbose(...args) {
- return logProxy('verbose', this._namespace, args);
- }
-}
-exports.DiagComponentLogger = DiagComponentLogger;
-function logProxy(funcName, namespace, args) {
- const logger = (0, global_utils_1.getGlobal)('diag');
- // shortcut if logger not set
- if (!logger) {
- return;
- }
- args.unshift(namespace);
- return logger[funcName](...args);
-}
-//# sourceMappingURL=ComponentLogger.js.map
-
-/***/ }),
-
-/***/ 3041:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.DiagConsoleLogger = void 0;
-const consoleMap = [
- { n: 'error', c: 'error' },
- { n: 'warn', c: 'warn' },
- { n: 'info', c: 'info' },
- { n: 'debug', c: 'debug' },
- { n: 'verbose', c: 'trace' },
-];
-/**
- * A simple Immutable Console based diagnostic logger which will output any messages to the Console.
- * If you want to limit the amount of logging to a specific level or lower use the
- * {@link createLogLevelDiagLogger}
- */
-class DiagConsoleLogger {
- constructor() {
- function _consoleFunc(funcName) {
- return function (...args) {
- if (console) {
- // Some environments only expose the console when the F12 developer console is open
- // eslint-disable-next-line no-console
- let theFunc = console[funcName];
- if (typeof theFunc !== 'function') {
- // Not all environments support all functions
- // eslint-disable-next-line no-console
- theFunc = console.log;
- }
- // One last final check
- if (typeof theFunc === 'function') {
- return theFunc.apply(console, args);
- }
- }
- };
+ if (permissionLike.delete) {
+ accountSASPermissions.delete = true;
+ }
+ if (permissionLike.deleteVersion) {
+ accountSASPermissions.deleteVersion = true;
+ }
+ if (permissionLike.filter) {
+ accountSASPermissions.filter = true;
+ }
+ if (permissionLike.tag) {
+ accountSASPermissions.tag = true;
+ }
+ if (permissionLike.list) {
+ accountSASPermissions.list = true;
+ }
+ if (permissionLike.add) {
+ accountSASPermissions.add = true;
}
- for (let i = 0; i < consoleMap.length; i++) {
- this[consoleMap[i].n] = _consoleFunc(consoleMap[i].c);
+ if (permissionLike.create) {
+ accountSASPermissions.create = true;
}
- }
-}
-exports.DiagConsoleLogger = DiagConsoleLogger;
-//# sourceMappingURL=consoleLogger.js.map
-
-/***/ }),
-
-/***/ 9639:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.createLogLevelDiagLogger = void 0;
-const types_1 = __nccwpck_require__(8077);
-function createLogLevelDiagLogger(maxLevel, logger) {
- if (maxLevel < types_1.DiagLogLevel.NONE) {
- maxLevel = types_1.DiagLogLevel.NONE;
- }
- else if (maxLevel > types_1.DiagLogLevel.ALL) {
- maxLevel = types_1.DiagLogLevel.ALL;
- }
- // In case the logger is null or undefined
- logger = logger || {};
- function _filterFunc(funcName, theLevel) {
- const theFunc = logger[funcName];
- if (typeof theFunc === 'function' && maxLevel >= theLevel) {
- return theFunc.bind(logger);
+ if (permissionLike.update) {
+ accountSASPermissions.update = true;
}
- return function () { };
- }
- return {
- error: _filterFunc('error', types_1.DiagLogLevel.ERROR),
- warn: _filterFunc('warn', types_1.DiagLogLevel.WARN),
- info: _filterFunc('info', types_1.DiagLogLevel.INFO),
- debug: _filterFunc('debug', types_1.DiagLogLevel.DEBUG),
- verbose: _filterFunc('verbose', types_1.DiagLogLevel.VERBOSE),
- };
-}
-exports.createLogLevelDiagLogger = createLogLevelDiagLogger;
-//# sourceMappingURL=logLevelLogger.js.map
-
-/***/ }),
-
-/***/ 8077:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.DiagLogLevel = void 0;
-/**
- * Defines the available internal logging levels for the diagnostic logger, the numeric values
- * of the levels are defined to match the original values from the initial LogLevel to avoid
- * compatibility/migration issues for any implementation that assume the numeric ordering.
- */
-var DiagLogLevel;
-(function (DiagLogLevel) {
- /** Diagnostic Logging level setting to disable all logging (except and forced logs) */
- DiagLogLevel[DiagLogLevel["NONE"] = 0] = "NONE";
- /** Identifies an error scenario */
- DiagLogLevel[DiagLogLevel["ERROR"] = 30] = "ERROR";
- /** Identifies a warning scenario */
- DiagLogLevel[DiagLogLevel["WARN"] = 50] = "WARN";
- /** General informational log message */
- DiagLogLevel[DiagLogLevel["INFO"] = 60] = "INFO";
- /** General debug log message */
- DiagLogLevel[DiagLogLevel["DEBUG"] = 70] = "DEBUG";
- /**
- * Detailed trace level logging should only be used for development, should only be set
- * in a development environment.
- */
- DiagLogLevel[DiagLogLevel["VERBOSE"] = 80] = "VERBOSE";
- /** Used to set the logging level to include all logging */
- DiagLogLevel[DiagLogLevel["ALL"] = 9999] = "ALL";
-})(DiagLogLevel = exports.DiagLogLevel || (exports.DiagLogLevel = {}));
-//# sourceMappingURL=types.js.map
-
-/***/ }),
-
-/***/ 5163:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.trace = exports.propagation = exports.metrics = exports.diag = exports.context = exports.INVALID_SPAN_CONTEXT = exports.INVALID_TRACEID = exports.INVALID_SPANID = exports.isValidSpanId = exports.isValidTraceId = exports.isSpanContextValid = exports.createTraceState = exports.TraceFlags = exports.SpanStatusCode = exports.SpanKind = exports.SamplingDecision = exports.ProxyTracerProvider = exports.ProxyTracer = exports.defaultTextMapSetter = exports.defaultTextMapGetter = exports.ValueType = exports.createNoopMeter = exports.DiagLogLevel = exports.DiagConsoleLogger = exports.ROOT_CONTEXT = exports.createContextKey = exports.baggageEntryMetadataFromString = void 0;
-var utils_1 = __nccwpck_require__(8136);
-Object.defineProperty(exports, "baggageEntryMetadataFromString", ({ enumerable: true, get: function () { return utils_1.baggageEntryMetadataFromString; } }));
-// Context APIs
-var context_1 = __nccwpck_require__(8242);
-Object.defineProperty(exports, "createContextKey", ({ enumerable: true, get: function () { return context_1.createContextKey; } }));
-Object.defineProperty(exports, "ROOT_CONTEXT", ({ enumerable: true, get: function () { return context_1.ROOT_CONTEXT; } }));
-// Diag APIs
-var consoleLogger_1 = __nccwpck_require__(3041);
-Object.defineProperty(exports, "DiagConsoleLogger", ({ enumerable: true, get: function () { return consoleLogger_1.DiagConsoleLogger; } }));
-var types_1 = __nccwpck_require__(8077);
-Object.defineProperty(exports, "DiagLogLevel", ({ enumerable: true, get: function () { return types_1.DiagLogLevel; } }));
-// Metrics APIs
-var NoopMeter_1 = __nccwpck_require__(4837);
-Object.defineProperty(exports, "createNoopMeter", ({ enumerable: true, get: function () { return NoopMeter_1.createNoopMeter; } }));
-var Metric_1 = __nccwpck_require__(9999);
-Object.defineProperty(exports, "ValueType", ({ enumerable: true, get: function () { return Metric_1.ValueType; } }));
-// Propagation APIs
-var TextMapPropagator_1 = __nccwpck_require__(865);
-Object.defineProperty(exports, "defaultTextMapGetter", ({ enumerable: true, get: function () { return TextMapPropagator_1.defaultTextMapGetter; } }));
-Object.defineProperty(exports, "defaultTextMapSetter", ({ enumerable: true, get: function () { return TextMapPropagator_1.defaultTextMapSetter; } }));
-var ProxyTracer_1 = __nccwpck_require__(3503);
-Object.defineProperty(exports, "ProxyTracer", ({ enumerable: true, get: function () { return ProxyTracer_1.ProxyTracer; } }));
-var ProxyTracerProvider_1 = __nccwpck_require__(2285);
-Object.defineProperty(exports, "ProxyTracerProvider", ({ enumerable: true, get: function () { return ProxyTracerProvider_1.ProxyTracerProvider; } }));
-var SamplingResult_1 = __nccwpck_require__(3209);
-Object.defineProperty(exports, "SamplingDecision", ({ enumerable: true, get: function () { return SamplingResult_1.SamplingDecision; } }));
-var span_kind_1 = __nccwpck_require__(1424);
-Object.defineProperty(exports, "SpanKind", ({ enumerable: true, get: function () { return span_kind_1.SpanKind; } }));
-var status_1 = __nccwpck_require__(8845);
-Object.defineProperty(exports, "SpanStatusCode", ({ enumerable: true, get: function () { return status_1.SpanStatusCode; } }));
-var trace_flags_1 = __nccwpck_require__(6905);
-Object.defineProperty(exports, "TraceFlags", ({ enumerable: true, get: function () { return trace_flags_1.TraceFlags; } }));
-var utils_2 = __nccwpck_require__(2615);
-Object.defineProperty(exports, "createTraceState", ({ enumerable: true, get: function () { return utils_2.createTraceState; } }));
-var spancontext_utils_1 = __nccwpck_require__(9745);
-Object.defineProperty(exports, "isSpanContextValid", ({ enumerable: true, get: function () { return spancontext_utils_1.isSpanContextValid; } }));
-Object.defineProperty(exports, "isValidTraceId", ({ enumerable: true, get: function () { return spancontext_utils_1.isValidTraceId; } }));
-Object.defineProperty(exports, "isValidSpanId", ({ enumerable: true, get: function () { return spancontext_utils_1.isValidSpanId; } }));
-var invalid_span_constants_1 = __nccwpck_require__(1760);
-Object.defineProperty(exports, "INVALID_SPANID", ({ enumerable: true, get: function () { return invalid_span_constants_1.INVALID_SPANID; } }));
-Object.defineProperty(exports, "INVALID_TRACEID", ({ enumerable: true, get: function () { return invalid_span_constants_1.INVALID_TRACEID; } }));
-Object.defineProperty(exports, "INVALID_SPAN_CONTEXT", ({ enumerable: true, get: function () { return invalid_span_constants_1.INVALID_SPAN_CONTEXT; } }));
-// Split module-level variable definition into separate files to allow
-// tree-shaking on each api instance.
-const context_api_1 = __nccwpck_require__(7393);
-Object.defineProperty(exports, "context", ({ enumerable: true, get: function () { return context_api_1.context; } }));
-const diag_api_1 = __nccwpck_require__(9721);
-Object.defineProperty(exports, "diag", ({ enumerable: true, get: function () { return diag_api_1.diag; } }));
-const metrics_api_1 = __nccwpck_require__(2601);
-Object.defineProperty(exports, "metrics", ({ enumerable: true, get: function () { return metrics_api_1.metrics; } }));
-const propagation_api_1 = __nccwpck_require__(7591);
-Object.defineProperty(exports, "propagation", ({ enumerable: true, get: function () { return propagation_api_1.propagation; } }));
-const trace_api_1 = __nccwpck_require__(8989);
-Object.defineProperty(exports, "trace", ({ enumerable: true, get: function () { return trace_api_1.trace; } }));
-// Default export.
-exports["default"] = {
- context: context_api_1.context,
- diag: diag_api_1.diag,
- metrics: metrics_api_1.metrics,
- propagation: propagation_api_1.propagation,
- trace: trace_api_1.trace,
-};
-//# sourceMappingURL=index.js.map
-
-/***/ }),
-
-/***/ 5135:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.unregisterGlobal = exports.getGlobal = exports.registerGlobal = void 0;
-const platform_1 = __nccwpck_require__(9957);
-const version_1 = __nccwpck_require__(8996);
-const semver_1 = __nccwpck_require__(1522);
-const major = version_1.VERSION.split('.')[0];
-const GLOBAL_OPENTELEMETRY_API_KEY = Symbol.for(`opentelemetry.js.api.${major}`);
-const _global = platform_1._globalThis;
-function registerGlobal(type, instance, diag, allowOverride = false) {
- var _a;
- const api = (_global[GLOBAL_OPENTELEMETRY_API_KEY] = (_a = _global[GLOBAL_OPENTELEMETRY_API_KEY]) !== null && _a !== void 0 ? _a : {
- version: version_1.VERSION,
- });
- if (!allowOverride && api[type]) {
- // already registered an API of this type
- const err = new Error(`@opentelemetry/api: Attempted duplicate registration of API: ${type}`);
- diag.error(err.stack || err.message);
- return false;
- }
- if (api.version !== version_1.VERSION) {
- // All registered APIs must be of the same version exactly
- const err = new Error(`@opentelemetry/api: Registration of version v${api.version} for ${type} does not match previously registered API v${version_1.VERSION}`);
- diag.error(err.stack || err.message);
- return false;
- }
- api[type] = instance;
- diag.debug(`@opentelemetry/api: Registered a global for ${type} v${version_1.VERSION}.`);
- return true;
-}
-exports.registerGlobal = registerGlobal;
-function getGlobal(type) {
- var _a, _b;
- const globalVersion = (_a = _global[GLOBAL_OPENTELEMETRY_API_KEY]) === null || _a === void 0 ? void 0 : _a.version;
- if (!globalVersion || !(0, semver_1.isCompatible)(globalVersion)) {
- return;
- }
- return (_b = _global[GLOBAL_OPENTELEMETRY_API_KEY]) === null || _b === void 0 ? void 0 : _b[type];
-}
-exports.getGlobal = getGlobal;
-function unregisterGlobal(type, diag) {
- diag.debug(`@opentelemetry/api: Unregistering a global for ${type} v${version_1.VERSION}.`);
- const api = _global[GLOBAL_OPENTELEMETRY_API_KEY];
- if (api) {
- delete api[type];
- }
-}
-exports.unregisterGlobal = unregisterGlobal;
-//# sourceMappingURL=global-utils.js.map
-
-/***/ }),
-
-/***/ 1522:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.isCompatible = exports._makeCompatibilityCheck = void 0;
-const version_1 = __nccwpck_require__(8996);
-const re = /^(\d+)\.(\d+)\.(\d+)(-(.+))?$/;
-/**
- * Create a function to test an API version to see if it is compatible with the provided ownVersion.
- *
- * The returned function has the following semantics:
- * - Exact match is always compatible
- * - Major versions must match exactly
- * - 1.x package cannot use global 2.x package
- * - 2.x package cannot use global 1.x package
- * - The minor version of the API module requesting access to the global API must be less than or equal to the minor version of this API
- * - 1.3 package may use 1.4 global because the later global contains all functions 1.3 expects
- * - 1.4 package may NOT use 1.3 global because it may try to call functions which don't exist on 1.3
- * - If the major version is 0, the minor version is treated as the major and the patch is treated as the minor
- * - Patch and build tag differences are not considered at this time
- *
- * @param ownVersion version which should be checked against
- */
-function _makeCompatibilityCheck(ownVersion) {
- const acceptedVersions = new Set([ownVersion]);
- const rejectedVersions = new Set();
- const myVersionMatch = ownVersion.match(re);
- if (!myVersionMatch) {
- // we cannot guarantee compatibility so we always return noop
- return () => false;
- }
- const ownVersionParsed = {
- major: +myVersionMatch[1],
- minor: +myVersionMatch[2],
- patch: +myVersionMatch[3],
- prerelease: myVersionMatch[4],
- };
- // if ownVersion has a prerelease tag, versions must match exactly
- if (ownVersionParsed.prerelease != null) {
- return function isExactmatch(globalVersion) {
- return globalVersion === ownVersion;
- };
- }
- function _reject(v) {
- rejectedVersions.add(v);
- return false;
- }
- function _accept(v) {
- acceptedVersions.add(v);
- return true;
+ if (permissionLike.process) {
+ accountSASPermissions.process = true;
+ }
+ if (permissionLike.setImmutabilityPolicy) {
+ accountSASPermissions.setImmutabilityPolicy = true;
+ }
+ if (permissionLike.permanentDelete) {
+ accountSASPermissions.permanentDelete = true;
+ }
+ return accountSASPermissions;
}
- return function isCompatible(globalVersion) {
- if (acceptedVersions.has(globalVersion)) {
- return true;
+ /**
+ * Produces the SAS permissions string for an Azure Storage account.
+ * Call this method to set AccountSASSignatureValues Permissions field.
+ *
+ * Using this method will guarantee the resource types are in
+ * an order accepted by the service.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+ *
+ */
+ toString() {
+ // The order of the characters should be as specified here to ensure correctness:
+ // https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+ // Use a string array instead of string concatenating += operator for performance
+ const permissions = [];
+ if (this.read) {
+ permissions.push("r");
}
- if (rejectedVersions.has(globalVersion)) {
- return false;
+ if (this.write) {
+ permissions.push("w");
}
- const globalVersionMatch = globalVersion.match(re);
- if (!globalVersionMatch) {
- // cannot parse other version
- // we cannot guarantee compatibility so we always noop
- return _reject(globalVersion);
- }
- const globalVersionParsed = {
- major: +globalVersionMatch[1],
- minor: +globalVersionMatch[2],
- patch: +globalVersionMatch[3],
- prerelease: globalVersionMatch[4],
- };
- // if globalVersion has a prerelease tag, versions must match exactly
- if (globalVersionParsed.prerelease != null) {
- return _reject(globalVersion);
+ if (this.delete) {
+ permissions.push("d");
}
- // major versions must match
- if (ownVersionParsed.major !== globalVersionParsed.major) {
- return _reject(globalVersion);
+ if (this.deleteVersion) {
+ permissions.push("x");
}
- if (ownVersionParsed.major === 0) {
- if (ownVersionParsed.minor === globalVersionParsed.minor &&
- ownVersionParsed.patch <= globalVersionParsed.patch) {
- return _accept(globalVersion);
- }
- return _reject(globalVersion);
+ if (this.filter) {
+ permissions.push("f");
+ }
+ if (this.tag) {
+ permissions.push("t");
}
- if (ownVersionParsed.minor <= globalVersionParsed.minor) {
- return _accept(globalVersion);
+ if (this.list) {
+ permissions.push("l");
}
- return _reject(globalVersion);
- };
+ if (this.add) {
+ permissions.push("a");
+ }
+ if (this.create) {
+ permissions.push("c");
+ }
+ if (this.update) {
+ permissions.push("u");
+ }
+ if (this.process) {
+ permissions.push("p");
+ }
+ if (this.setImmutabilityPolicy) {
+ permissions.push("i");
+ }
+ if (this.permanentDelete) {
+ permissions.push("y");
+ }
+ return permissions.join("");
+ }
}
-exports._makeCompatibilityCheck = _makeCompatibilityCheck;
-/**
- * Test an API version to see if it is compatible with this API.
- *
- * - Exact match is always compatible
- * - Major versions must match exactly
- * - 1.x package cannot use global 2.x package
- * - 2.x package cannot use global 1.x package
- * - The minor version of the API module requesting access to the global API must be less than or equal to the minor version of this API
- * - 1.3 package may use 1.4 global because the later global contains all functions 1.3 expects
- * - 1.4 package may NOT use 1.3 global because it may try to call functions which don't exist on 1.3
- * - If the major version is 0, the minor version is treated as the major and the patch is treated as the minor
- * - Patch and build tag differences are not considered at this time
- *
- * @param version version of the API requesting an instance of the global API
- */
-exports.isCompatible = _makeCompatibilityCheck(version_1.VERSION);
-//# sourceMappingURL=semver.js.map
-
-/***/ }),
-
-/***/ 2601:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.metrics = void 0;
-// Split module-level variable definition into separate files to allow
-// tree-shaking on each api instance.
-const metrics_1 = __nccwpck_require__(7696);
-/** Entrypoint for metrics API */
-exports.metrics = metrics_1.MetricsAPI.getInstance();
-//# sourceMappingURL=metrics-api.js.map
-
-/***/ }),
-
-/***/ 9999:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.ValueType = void 0;
-/** The Type of value. It describes how the data is reported. */
-var ValueType;
-(function (ValueType) {
- ValueType[ValueType["INT"] = 0] = "INT";
- ValueType[ValueType["DOUBLE"] = 1] = "DOUBLE";
-})(ValueType = exports.ValueType || (exports.ValueType = {}));
-//# sourceMappingURL=Metric.js.map
-
-/***/ }),
-/***/ 4837:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.createNoopMeter = exports.NOOP_OBSERVABLE_UP_DOWN_COUNTER_METRIC = exports.NOOP_OBSERVABLE_GAUGE_METRIC = exports.NOOP_OBSERVABLE_COUNTER_METRIC = exports.NOOP_UP_DOWN_COUNTER_METRIC = exports.NOOP_HISTOGRAM_METRIC = exports.NOOP_COUNTER_METRIC = exports.NOOP_METER = exports.NoopObservableUpDownCounterMetric = exports.NoopObservableGaugeMetric = exports.NoopObservableCounterMetric = exports.NoopObservableMetric = exports.NoopHistogramMetric = exports.NoopUpDownCounterMetric = exports.NoopCounterMetric = exports.NoopMetric = exports.NoopMeter = void 0;
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * NoopMeter is a noop implementation of the {@link Meter} interface. It reuses
- * constant NoopMetrics for all of its methods.
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * This is a helper class to construct a string representing the resources accessible by an AccountSAS. Setting a value
+ * to true means that any SAS which uses these permissions will grant access to that resource type. Once all the
+ * values are set, this should be serialized with toString and set as the resources field on an
+ * {@link AccountSASSignatureValues} object. It is possible to construct the resources string without this class, but
+ * the order of the resources is particular and this class guarantees correctness.
*/
-class NoopMeter {
- constructor() { }
- /**
- * @see {@link Meter.createHistogram}
- */
- createHistogram(_name, _options) {
- return exports.NOOP_HISTOGRAM_METRIC;
- }
- /**
- * @see {@link Meter.createCounter}
- */
- createCounter(_name, _options) {
- return exports.NOOP_COUNTER_METRIC;
- }
- /**
- * @see {@link Meter.createUpDownCounter}
- */
- createUpDownCounter(_name, _options) {
- return exports.NOOP_UP_DOWN_COUNTER_METRIC;
- }
- /**
- * @see {@link Meter.createObservableGauge}
- */
- createObservableGauge(_name, _options) {
- return exports.NOOP_OBSERVABLE_GAUGE_METRIC;
+class AccountSASResourceTypes {
+ constructor() {
+ /**
+ * Permission to access service level APIs granted.
+ */
+ this.service = false;
+ /**
+ * Permission to access container level APIs (Blob Containers, Tables, Queues, File Shares) granted.
+ */
+ this.container = false;
+ /**
+ * Permission to access object level APIs (Blobs, Table Entities, Queue Messages, Files) granted.
+ */
+ this.object = false;
}
/**
- * @see {@link Meter.createObservableCounter}
+ * Creates an {@link AccountSASResourceTypes} from the specified resource types string. This method will throw an
+ * Error if it encounters a character that does not correspond to a valid resource type.
+ *
+ * @param resourceTypes -
*/
- createObservableCounter(_name, _options) {
- return exports.NOOP_OBSERVABLE_COUNTER_METRIC;
+ static parse(resourceTypes) {
+ const accountSASResourceTypes = new AccountSASResourceTypes();
+ for (const c of resourceTypes) {
+ switch (c) {
+ case "s":
+ accountSASResourceTypes.service = true;
+ break;
+ case "c":
+ accountSASResourceTypes.container = true;
+ break;
+ case "o":
+ accountSASResourceTypes.object = true;
+ break;
+ default:
+ throw new RangeError(`Invalid resource type: ${c}`);
+ }
+ }
+ return accountSASResourceTypes;
}
/**
- * @see {@link Meter.createObservableUpDownCounter}
+ * Converts the given resource types to a string.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
+ *
*/
- createObservableUpDownCounter(_name, _options) {
- return exports.NOOP_OBSERVABLE_UP_DOWN_COUNTER_METRIC;
+ toString() {
+ const resourceTypes = [];
+ if (this.service) {
+ resourceTypes.push("s");
+ }
+ if (this.container) {
+ resourceTypes.push("c");
+ }
+ if (this.object) {
+ resourceTypes.push("o");
+ }
+ return resourceTypes.join("");
}
- /**
- * @see {@link Meter.addBatchObservableCallback}
- */
- addBatchObservableCallback(_callback, _observables) { }
- /**
- * @see {@link Meter.removeBatchObservableCallback}
- */
- removeBatchObservableCallback(_callback) { }
-}
-exports.NoopMeter = NoopMeter;
-class NoopMetric {
-}
-exports.NoopMetric = NoopMetric;
-class NoopCounterMetric extends NoopMetric {
- add(_value, _attributes) { }
}
-exports.NoopCounterMetric = NoopCounterMetric;
-class NoopUpDownCounterMetric extends NoopMetric {
- add(_value, _attributes) { }
-}
-exports.NoopUpDownCounterMetric = NoopUpDownCounterMetric;
-class NoopHistogramMetric extends NoopMetric {
- record(_value, _attributes) { }
-}
-exports.NoopHistogramMetric = NoopHistogramMetric;
-class NoopObservableMetric {
- addCallback(_callback) { }
- removeCallback(_callback) { }
-}
-exports.NoopObservableMetric = NoopObservableMetric;
-class NoopObservableCounterMetric extends NoopObservableMetric {
-}
-exports.NoopObservableCounterMetric = NoopObservableCounterMetric;
-class NoopObservableGaugeMetric extends NoopObservableMetric {
-}
-exports.NoopObservableGaugeMetric = NoopObservableGaugeMetric;
-class NoopObservableUpDownCounterMetric extends NoopObservableMetric {
-}
-exports.NoopObservableUpDownCounterMetric = NoopObservableUpDownCounterMetric;
-exports.NOOP_METER = new NoopMeter();
-// Synchronous instruments
-exports.NOOP_COUNTER_METRIC = new NoopCounterMetric();
-exports.NOOP_HISTOGRAM_METRIC = new NoopHistogramMetric();
-exports.NOOP_UP_DOWN_COUNTER_METRIC = new NoopUpDownCounterMetric();
-// Asynchronous instruments
-exports.NOOP_OBSERVABLE_COUNTER_METRIC = new NoopObservableCounterMetric();
-exports.NOOP_OBSERVABLE_GAUGE_METRIC = new NoopObservableGaugeMetric();
-exports.NOOP_OBSERVABLE_UP_DOWN_COUNTER_METRIC = new NoopObservableUpDownCounterMetric();
-/**
- * Create a no-op Meter
- */
-function createNoopMeter() {
- return exports.NOOP_METER;
-}
-exports.createNoopMeter = createNoopMeter;
-//# sourceMappingURL=NoopMeter.js.map
-
-/***/ }),
-
-/***/ 2647:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.NOOP_METER_PROVIDER = exports.NoopMeterProvider = void 0;
-const NoopMeter_1 = __nccwpck_require__(4837);
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
/**
- * An implementation of the {@link MeterProvider} which returns an impotent Meter
- * for all calls to `getMeter`
- */
-class NoopMeterProvider {
- getMeter(_name, _version, _options) {
- return NoopMeter_1.NOOP_METER;
- }
-}
-exports.NoopMeterProvider = NoopMeterProvider;
-exports.NOOP_METER_PROVIDER = new NoopMeterProvider();
-//# sourceMappingURL=NoopMeterProvider.js.map
-
-/***/ }),
-
-/***/ 9957:
-/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-__exportStar(__nccwpck_require__(7200), exports);
-//# sourceMappingURL=index.js.map
-
-/***/ }),
-
-/***/ 9406:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports._globalThis = void 0;
-/** only globals that common to node and browsers are allowed */
-// eslint-disable-next-line node/no-unsupported-features/es-builtins
-exports._globalThis = typeof globalThis === 'object' ? globalThis : global;
-//# sourceMappingURL=globalThis.js.map
-
-/***/ }),
-
-/***/ 7200:
-/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
- if (k2 === undefined) k2 = k;
- o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-__exportStar(__nccwpck_require__(9406), exports);
-//# sourceMappingURL=index.js.map
-
-/***/ }),
-
-/***/ 7591:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.propagation = void 0;
-// Split module-level variable definition into separate files to allow
-// tree-shaking on each api instance.
-const propagation_1 = __nccwpck_require__(9909);
-/** Entrypoint for propagation API */
-exports.propagation = propagation_1.PropagationAPI.getInstance();
-//# sourceMappingURL=propagation-api.js.map
-
-/***/ }),
-
-/***/ 2368:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.NoopTextMapPropagator = void 0;
-/**
- * No-op implementations of {@link TextMapPropagator}.
+ * This is a helper class to construct a string representing the services accessible by an AccountSAS. Setting a value
+ * to true means that any SAS which uses these permissions will grant access to that service. Once all the
+ * values are set, this should be serialized with toString and set as the services field on an
+ * {@link AccountSASSignatureValues} object. It is possible to construct the services string without this class, but
+ * the order of the services is particular and this class guarantees correctness.
*/
-class NoopTextMapPropagator {
- /** Noop inject function does nothing */
- inject(_context, _carrier) { }
- /** Noop extract function does nothing and returns the input context */
- extract(context, _carrier) {
- return context;
+class AccountSASServices {
+ constructor() {
+ /**
+ * Permission to access blob resources granted.
+ */
+ this.blob = false;
+ /**
+ * Permission to access file resources granted.
+ */
+ this.file = false;
+ /**
+ * Permission to access queue resources granted.
+ */
+ this.queue = false;
+ /**
+ * Permission to access table resources granted.
+ */
+ this.table = false;
}
- fields() {
- return [];
+ /**
+ * Creates an {@link AccountSASServices} from the specified services string. This method will throw an
+ * Error if it encounters a character that does not correspond to a valid service.
+ *
+ * @param services -
+ */
+ static parse(services) {
+ const accountSASServices = new AccountSASServices();
+ for (const c of services) {
+ switch (c) {
+ case "b":
+ accountSASServices.blob = true;
+ break;
+ case "f":
+ accountSASServices.file = true;
+ break;
+ case "q":
+ accountSASServices.queue = true;
+ break;
+ case "t":
+ accountSASServices.table = true;
+ break;
+ default:
+ throw new RangeError(`Invalid service character: ${c}`);
+ }
+ }
+ return accountSASServices;
}
-}
-exports.NoopTextMapPropagator = NoopTextMapPropagator;
-//# sourceMappingURL=NoopTextMapPropagator.js.map
-
-/***/ }),
-
-/***/ 865:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.defaultTextMapSetter = exports.defaultTextMapGetter = void 0;
-exports.defaultTextMapGetter = {
- get(carrier, key) {
- if (carrier == null) {
- return undefined;
+ /**
+ * Converts the given services to a string.
+ *
+ */
+ toString() {
+ const services = [];
+ if (this.blob) {
+ services.push("b");
}
- return carrier[key];
- },
- keys(carrier) {
- if (carrier == null) {
- return [];
+ if (this.table) {
+ services.push("t");
}
- return Object.keys(carrier);
- },
-};
-exports.defaultTextMapSetter = {
- set(carrier, key, value) {
- if (carrier == null) {
- return;
+ if (this.queue) {
+ services.push("q");
}
- carrier[key] = value;
- },
-};
-//# sourceMappingURL=TextMapPropagator.js.map
-
-/***/ }),
-
-/***/ 8989:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.trace = void 0;
-// Split module-level variable definition into separate files to allow
-// tree-shaking on each api instance.
-const trace_1 = __nccwpck_require__(1539);
-/** Entrypoint for trace API */
-exports.trace = trace_1.TraceAPI.getInstance();
-//# sourceMappingURL=trace-api.js.map
-
-/***/ }),
-
-/***/ 1462:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
+ if (this.file) {
+ services.push("f");
+ }
+ return services.join("");
+ }
+}
-/*
- * Copyright The OpenTelemetry Authors
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
*
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
+ * Generates a {@link SASQueryParameters} object which contains all SAS query parameters needed to make an actual
+ * REST request.
*
- * https://www.apache.org/licenses/LICENSE-2.0
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-an-account-sas
*
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.NonRecordingSpan = void 0;
-const invalid_span_constants_1 = __nccwpck_require__(1760);
-/**
- * The NonRecordingSpan is the default {@link Span} that is used when no Span
- * implementation is available. All operations are no-op including context
- * propagation.
+ * @param accountSASSignatureValues -
+ * @param sharedKeyCredential -
*/
-class NonRecordingSpan {
- constructor(_spanContext = invalid_span_constants_1.INVALID_SPAN_CONTEXT) {
- this._spanContext = _spanContext;
+function generateAccountSASQueryParameters(accountSASSignatureValues, sharedKeyCredential) {
+ const version = accountSASSignatureValues.version
+ ? accountSASSignatureValues.version
+ : SERVICE_VERSION;
+ if (accountSASSignatureValues.permissions &&
+ accountSASSignatureValues.permissions.setImmutabilityPolicy &&
+ version < "2020-08-04") {
+ throw RangeError("'version' must be >= '2020-08-04' when provided 'i' permission.");
}
- // Returns a SpanContext.
- spanContext() {
- return this._spanContext;
+ if (accountSASSignatureValues.permissions &&
+ accountSASSignatureValues.permissions.deleteVersion &&
+ version < "2019-10-10") {
+ throw RangeError("'version' must be >= '2019-10-10' when provided 'x' permission.");
}
- // By default does nothing
- setAttribute(_key, _value) {
- return this;
+ if (accountSASSignatureValues.permissions &&
+ accountSASSignatureValues.permissions.permanentDelete &&
+ version < "2019-10-10") {
+ throw RangeError("'version' must be >= '2019-10-10' when provided 'y' permission.");
}
- // By default does nothing
- setAttributes(_attributes) {
- return this;
+ if (accountSASSignatureValues.permissions &&
+ accountSASSignatureValues.permissions.tag &&
+ version < "2019-12-12") {
+ throw RangeError("'version' must be >= '2019-12-12' when provided 't' permission.");
}
- // By default does nothing
- addEvent(_name, _attributes) {
- return this;
+ if (accountSASSignatureValues.permissions &&
+ accountSASSignatureValues.permissions.filter &&
+ version < "2019-12-12") {
+ throw RangeError("'version' must be >= '2019-12-12' when provided 'f' permission.");
}
- // By default does nothing
- setStatus(_status) {
- return this;
+ if (accountSASSignatureValues.encryptionScope && version < "2020-12-06") {
+ throw RangeError("'version' must be >= '2020-12-06' when provided 'encryptionScope' in SAS.");
}
- // By default does nothing
- updateName(_name) {
- return this;
+ const parsedPermissions = AccountSASPermissions.parse(accountSASSignatureValues.permissions.toString());
+ const parsedServices = AccountSASServices.parse(accountSASSignatureValues.services).toString();
+ const parsedResourceTypes = AccountSASResourceTypes.parse(accountSASSignatureValues.resourceTypes).toString();
+ let stringToSign;
+ if (version >= "2020-12-06") {
+ stringToSign = [
+ sharedKeyCredential.accountName,
+ parsedPermissions,
+ parsedServices,
+ parsedResourceTypes,
+ accountSASSignatureValues.startsOn
+ ? truncatedISO8061Date(accountSASSignatureValues.startsOn, false)
+ : "",
+ truncatedISO8061Date(accountSASSignatureValues.expiresOn, false),
+ accountSASSignatureValues.ipRange ? ipRangeToString(accountSASSignatureValues.ipRange) : "",
+ accountSASSignatureValues.protocol ? accountSASSignatureValues.protocol : "",
+ version,
+ accountSASSignatureValues.encryptionScope ? accountSASSignatureValues.encryptionScope : "",
+ "", // Account SAS requires an additional newline character
+ ].join("\n");
}
- // By default does nothing
- end(_endTime) { }
- // isRecording always returns false for NonRecordingSpan.
- isRecording() {
- return false;
+ else {
+ stringToSign = [
+ sharedKeyCredential.accountName,
+ parsedPermissions,
+ parsedServices,
+ parsedResourceTypes,
+ accountSASSignatureValues.startsOn
+ ? truncatedISO8061Date(accountSASSignatureValues.startsOn, false)
+ : "",
+ truncatedISO8061Date(accountSASSignatureValues.expiresOn, false),
+ accountSASSignatureValues.ipRange ? ipRangeToString(accountSASSignatureValues.ipRange) : "",
+ accountSASSignatureValues.protocol ? accountSASSignatureValues.protocol : "",
+ version,
+ "", // Account SAS requires an additional newline character
+ ].join("\n");
}
- // By default does nothing
- recordException(_exception, _time) { }
+ const signature = sharedKeyCredential.computeHMACSHA256(stringToSign);
+ return new SASQueryParameters(version, signature, parsedPermissions.toString(), parsedServices, parsedResourceTypes, accountSASSignatureValues.protocol, accountSASSignatureValues.startsOn, accountSASSignatureValues.expiresOn, accountSASSignatureValues.ipRange, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, undefined, accountSASSignatureValues.encryptionScope);
}
-exports.NonRecordingSpan = NonRecordingSpan;
-//# sourceMappingURL=NonRecordingSpan.js.map
-
-/***/ }),
-
-/***/ 7606:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.NoopTracer = void 0;
-const context_1 = __nccwpck_require__(7171);
-const context_utils_1 = __nccwpck_require__(3326);
-const NonRecordingSpan_1 = __nccwpck_require__(1462);
-const spancontext_utils_1 = __nccwpck_require__(9745);
-const contextApi = context_1.ContextAPI.getInstance();
/**
- * No-op implementations of {@link Tracer}.
+ * A BlobServiceClient represents a Client to the Azure Storage Blob service allowing you
+ * to manipulate blob containers.
*/
-class NoopTracer {
- // startSpan starts a noop span.
- startSpan(name, options, context = contextApi.active()) {
- const root = Boolean(options === null || options === void 0 ? void 0 : options.root);
- if (root) {
- return new NonRecordingSpan_1.NonRecordingSpan();
+class BlobServiceClient extends StorageClient {
+ /**
+ *
+ * Creates an instance of BlobServiceClient from connection string.
+ *
+ * @param connectionString - 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`
+ * @param options - Optional. Options to configure the HTTP pipeline.
+ */
+ static fromConnectionString(connectionString,
+ // Legacy, no fix for eslint error without breaking. Disable it for this interface.
+ /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+ options) {
+ options = options || {};
+ const extractedCreds = extractConnectionStringParts(connectionString);
+ if (extractedCreds.kind === "AccountConnString") {
+ if (coreUtil.isNode) {
+ const sharedKeyCredential = new StorageSharedKeyCredential(extractedCreds.accountName, extractedCreds.accountKey);
+ if (!options.proxyOptions) {
+ options.proxyOptions = coreRestPipeline.getDefaultProxySettings(extractedCreds.proxyUri);
+ }
+ const pipeline = newPipeline(sharedKeyCredential, options);
+ return new BlobServiceClient(extractedCreds.url, pipeline);
+ }
+ else {
+ throw new Error("Account connection string is only supported in Node.js environment");
+ }
}
- const parentFromContext = context && (0, context_utils_1.getSpanContext)(context);
- if (isSpanContext(parentFromContext) &&
- (0, spancontext_utils_1.isSpanContextValid)(parentFromContext)) {
- return new NonRecordingSpan_1.NonRecordingSpan(parentFromContext);
+ else if (extractedCreds.kind === "SASConnString") {
+ const pipeline = newPipeline(new AnonymousCredential(), options);
+ return new BlobServiceClient(extractedCreds.url + "?" + extractedCreds.accountSas, pipeline);
}
else {
- return new NonRecordingSpan_1.NonRecordingSpan();
+ throw new Error("Connection string must be either an Account connection string or a SAS connection string");
}
}
- startActiveSpan(name, arg2, arg3, arg4) {
- let opts;
- let ctx;
- let fn;
- if (arguments.length < 2) {
- return;
- }
- else if (arguments.length === 2) {
- fn = arg2;
+ constructor(url, credentialOrPipeline,
+ // Legacy, no fix for eslint error without breaking. Disable it for this interface.
+ /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/
+ options) {
+ let pipeline;
+ if (isPipelineLike(credentialOrPipeline)) {
+ pipeline = credentialOrPipeline;
}
- else if (arguments.length === 3) {
- opts = arg2;
- fn = arg3;
+ else if ((coreUtil.isNode && credentialOrPipeline instanceof StorageSharedKeyCredential) ||
+ credentialOrPipeline instanceof AnonymousCredential ||
+ coreAuth.isTokenCredential(credentialOrPipeline)) {
+ pipeline = newPipeline(credentialOrPipeline, options);
}
else {
- opts = arg2;
- ctx = arg3;
- fn = arg4;
+ // The second parameter is undefined. Use anonymous credential
+ pipeline = newPipeline(new AnonymousCredential(), options);
}
- const parentContext = ctx !== null && ctx !== void 0 ? ctx : contextApi.active();
- const span = this.startSpan(name, opts, parentContext);
- const contextWithSpanSet = (0, context_utils_1.setSpan)(parentContext, span);
- return contextApi.with(contextWithSpanSet, fn, undefined, span);
+ super(url, pipeline);
+ this.serviceContext = this.storageClientContext.service;
}
-}
-exports.NoopTracer = NoopTracer;
-function isSpanContext(spanContext) {
- return (typeof spanContext === 'object' &&
- typeof spanContext['spanId'] === 'string' &&
- typeof spanContext['traceId'] === 'string' &&
- typeof spanContext['traceFlags'] === 'number');
-}
-//# sourceMappingURL=NoopTracer.js.map
-
-/***/ }),
-
-/***/ 3259:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.NoopTracerProvider = void 0;
-const NoopTracer_1 = __nccwpck_require__(7606);
-/**
- * An implementation of the {@link TracerProvider} which returns an impotent
- * Tracer for all calls to `getTracer`.
- *
- * All operations are no-op.
- */
-class NoopTracerProvider {
- getTracer(_name, _version, _options) {
- return new NoopTracer_1.NoopTracer();
+ /**
+ * Creates a {@link ContainerClient} object
+ *
+ * @param containerName - A container name
+ * @returns A new ContainerClient object for the given container name.
+ *
+ * Example usage:
+ *
+ * ```js
+ * const containerClient = blobServiceClient.getContainerClient("");
+ * ```
+ */
+ getContainerClient(containerName) {
+ return new ContainerClient(appendToURLPath(this.url, encodeURIComponent(containerName)), this.pipeline);
}
-}
-exports.NoopTracerProvider = NoopTracerProvider;
-//# sourceMappingURL=NoopTracerProvider.js.map
-
-/***/ }),
-
-/***/ 3503:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.ProxyTracer = void 0;
-const NoopTracer_1 = __nccwpck_require__(7606);
-const NOOP_TRACER = new NoopTracer_1.NoopTracer();
-/**
- * Proxy tracer provided by the proxy tracer provider
- */
-class ProxyTracer {
- constructor(_provider, name, version, options) {
- this._provider = _provider;
- this.name = name;
- this.version = version;
- this.options = options;
+ /**
+ * Create a Blob container. @see https://docs.microsoft.com/en-us/rest/api/storageservices/create-container
+ *
+ * @param containerName - Name of the container to create.
+ * @param options - Options to configure Container Create operation.
+ * @returns Container creation response and the corresponding container client.
+ */
+ async createContainer(containerName, options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-createContainer", options, async (updatedOptions) => {
+ const containerClient = this.getContainerClient(containerName);
+ const containerCreateResponse = await containerClient.create(updatedOptions);
+ return {
+ containerClient,
+ containerCreateResponse,
+ };
+ });
}
- startSpan(name, options, context) {
- return this._getTracer().startSpan(name, options, context);
+ /**
+ * Deletes a Blob container.
+ *
+ * @param containerName - Name of the container to delete.
+ * @param options - Options to configure Container Delete operation.
+ * @returns Container deletion response.
+ */
+ async deleteContainer(containerName, options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-deleteContainer", options, async (updatedOptions) => {
+ const containerClient = this.getContainerClient(containerName);
+ return containerClient.delete(updatedOptions);
+ });
}
- startActiveSpan(_name, _options, _context, _fn) {
- const tracer = this._getTracer();
- return Reflect.apply(tracer.startActiveSpan, tracer, arguments);
+ /**
+ * Restore a previously deleted Blob container.
+ * This API is only functional if Container Soft Delete is enabled for the storage account associated with the container.
+ *
+ * @param deletedContainerName - Name of the previously deleted container.
+ * @param deletedContainerVersion - Version of the previously deleted container, used to uniquely identify the deleted container.
+ * @param options - Options to configure Container Restore operation.
+ * @returns Container deletion response.
+ */
+ async undeleteContainer(deletedContainerName, deletedContainerVersion, options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-undeleteContainer", options, async (updatedOptions) => {
+ const containerClient = this.getContainerClient(options.destinationContainerName || deletedContainerName);
+ // Hack to access a protected member.
+ const containerContext = containerClient["storageClientContext"].container;
+ const containerUndeleteResponse = assertResponse(await containerContext.restore({
+ deletedContainerName,
+ deletedContainerVersion,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ return { containerClient, containerUndeleteResponse };
+ });
}
/**
- * Try to get a tracer from the proxy tracer provider.
- * If the proxy tracer provider has no delegate, return a noop tracer.
+ * Rename an existing Blob Container.
+ *
+ * @param sourceContainerName - The name of the source container.
+ * @param destinationContainerName - The new name of the container.
+ * @param options - Options to configure Container Rename operation.
*/
- _getTracer() {
- if (this._delegate) {
- return this._delegate;
- }
- const tracer = this._provider.getDelegateTracer(this.name, this.version, this.options);
- if (!tracer) {
- return NOOP_TRACER;
- }
- this._delegate = tracer;
- return this._delegate;
+ /* eslint-disable-next-line @typescript-eslint/ban-ts-comment */
+ // @ts-ignore Need to hide this interface for now. Make it public and turn on the live tests for it when the service is ready.
+ async renameContainer(sourceContainerName, destinationContainerName, options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-renameContainer", options, async (updatedOptions) => {
+ var _a;
+ const containerClient = this.getContainerClient(destinationContainerName);
+ // Hack to access a protected member.
+ const containerContext = containerClient["storageClientContext"].container;
+ const containerRenameResponse = assertResponse(await containerContext.rename(sourceContainerName, Object.assign(Object.assign({}, updatedOptions), { sourceLeaseId: (_a = options.sourceCondition) === null || _a === void 0 ? void 0 : _a.leaseId })));
+ return { containerClient, containerRenameResponse };
+ });
}
-}
-exports.ProxyTracer = ProxyTracer;
-//# sourceMappingURL=ProxyTracer.js.map
-
-/***/ }),
-
-/***/ 2285:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.ProxyTracerProvider = void 0;
-const ProxyTracer_1 = __nccwpck_require__(3503);
-const NoopTracerProvider_1 = __nccwpck_require__(3259);
-const NOOP_TRACER_PROVIDER = new NoopTracerProvider_1.NoopTracerProvider();
-/**
- * Tracer provider which provides {@link ProxyTracer}s.
- *
- * Before a delegate is set, tracers provided are NoOp.
- * When a delegate is set, traces are provided from the delegate.
- * When a delegate is set after tracers have already been provided,
- * all tracers already provided will use the provided delegate implementation.
- */
-class ProxyTracerProvider {
/**
- * Get a {@link ProxyTracer}
+ * Gets the properties of a storage account’s Blob service, including properties
+ * for Storage Analytics and CORS (Cross-Origin Resource Sharing) rules.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
+ *
+ * @param options - Options to the Service Get Properties operation.
+ * @returns Response data for the Service Get Properties operation.
*/
- getTracer(name, version, options) {
- var _a;
- return ((_a = this.getDelegateTracer(name, version, options)) !== null && _a !== void 0 ? _a : new ProxyTracer_1.ProxyTracer(this, name, version, options));
+ async getProperties(options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-getProperties", options, async (updatedOptions) => {
+ return assertResponse(await this.serviceContext.getProperties({
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
}
- getDelegate() {
- var _a;
- return (_a = this._delegate) !== null && _a !== void 0 ? _a : NOOP_TRACER_PROVIDER;
+ /**
+ * Sets properties for a storage account’s Blob service endpoint, including properties
+ * for Storage Analytics, CORS (Cross-Origin Resource Sharing) rules and soft delete settings.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-service-properties
+ *
+ * @param properties -
+ * @param options - Options to the Service Set Properties operation.
+ * @returns Response data for the Service Set Properties operation.
+ */
+ async setProperties(properties, options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-setProperties", options, async (updatedOptions) => {
+ return assertResponse(await this.serviceContext.setProperties(properties, {
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Retrieves statistics related to replication for the Blob service. It is only
+ * available on the secondary location endpoint when read-access geo-redundant
+ * replication is enabled for the storage account.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-stats
+ *
+ * @param options - Options to the Service Get Statistics operation.
+ * @returns Response data for the Service Get Statistics operation.
+ */
+ async getStatistics(options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-getStatistics", options, async (updatedOptions) => {
+ return assertResponse(await this.serviceContext.getStatistics({
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * The Get Account Information operation returns the sku name and account kind
+ * for the specified account.
+ * The Get Account Information operation is available on service versions beginning
+ * with version 2018-03-28.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-account-information
+ *
+ * @param options - Options to the Service Get Account Info operation.
+ * @returns Response data for the Service Get Account Info operation.
+ */
+ async getAccountInfo(options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-getAccountInfo", options, async (updatedOptions) => {
+ return assertResponse(await this.serviceContext.getAccountInfo({
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ });
+ }
+ /**
+ * Returns a list of the containers under the specified account.
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/list-containers2
+ *
+ * @param marker - A string value that identifies the portion of
+ * the list of containers to be returned with the next listing operation. The
+ * operation returns the continuationToken value within the response body if the
+ * listing operation did not return all containers remaining to be listed
+ * with the current page. The continuationToken value can be used as the value for
+ * the marker parameter in a subsequent call to request the next page of list
+ * items. The marker value is opaque to the client.
+ * @param options - Options to the Service List Container Segment operation.
+ * @returns Response data for the Service List Container Segment operation.
+ */
+ async listContainersSegment(marker, options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-listContainersSegment", options, async (updatedOptions) => {
+ return assertResponse(await this.serviceContext.listContainersSegment(Object.assign(Object.assign({ abortSignal: options.abortSignal, marker }, options), { include: typeof options.include === "string" ? [options.include] : options.include, tracingOptions: updatedOptions.tracingOptions })));
+ });
+ }
+ /**
+ * The Filter Blobs operation enables callers to list blobs across all containers whose tags
+ * match a given search expression. Filter blobs searches across all containers within a
+ * storage account but can be scoped within the expression to a single container.
+ *
+ * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
+ * The given expression must evaluate to true for a blob to be returned in the results.
+ * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter;
+ * however, only a subset of the OData filter syntax is supported in the Blob service.
+ * @param marker - A string value that identifies the portion of
+ * the list of blobs to be returned with the next listing operation. The
+ * operation returns the continuationToken value within the response body if the
+ * listing operation did not return all blobs remaining to be listed
+ * with the current page. The continuationToken value can be used as the value for
+ * the marker parameter in a subsequent call to request the next page of list
+ * items. The marker value is opaque to the client.
+ * @param options - Options to find blobs by tags.
+ */
+ async findBlobsByTagsSegment(tagFilterSqlExpression, marker, options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-findBlobsByTagsSegment", options, async (updatedOptions) => {
+ const response = assertResponse(await this.serviceContext.filterBlobs({
+ abortSignal: options.abortSignal,
+ where: tagFilterSqlExpression,
+ marker,
+ maxPageSize: options.maxPageSize,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ const wrappedResponse = Object.assign(Object.assign({}, response), { _response: response._response, blobs: response.blobs.map((blob) => {
+ var _a;
+ let tagValue = "";
+ if (((_a = blob.tags) === null || _a === void 0 ? void 0 : _a.blobTagSet.length) === 1) {
+ tagValue = blob.tags.blobTagSet[0].value;
+ }
+ return Object.assign(Object.assign({}, blob), { tags: toTags(blob.tags), tagValue });
+ }) });
+ return wrappedResponse;
+ });
+ }
+ /**
+ * Returns an AsyncIterableIterator for ServiceFindBlobsByTagsSegmentResponse.
+ *
+ * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
+ * The given expression must evaluate to true for a blob to be returned in the results.
+ * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter;
+ * however, only a subset of the OData filter syntax is supported in the Blob service.
+ * @param marker - A string value that identifies the portion of
+ * the list of blobs to be returned with the next listing operation. The
+ * operation returns the continuationToken value within the response body if the
+ * listing operation did not return all blobs remaining to be listed
+ * with the current page. The continuationToken value can be used as the value for
+ * the marker parameter in a subsequent call to request the next page of list
+ * items. The marker value is opaque to the client.
+ * @param options - Options to find blobs by tags.
+ */
+ findBlobsByTagsSegments(tagFilterSqlExpression_1, marker_1) {
+ return tslib.__asyncGenerator(this, arguments, function* findBlobsByTagsSegments_1(tagFilterSqlExpression, marker, options = {}) {
+ let response;
+ if (!!marker || marker === undefined) {
+ do {
+ response = yield tslib.__await(this.findBlobsByTagsSegment(tagFilterSqlExpression, marker, options));
+ response.blobs = response.blobs || [];
+ marker = response.continuationToken;
+ yield yield tslib.__await(response);
+ } while (marker);
+ }
+ });
+ }
+ /**
+ * Returns an AsyncIterableIterator for blobs.
+ *
+ * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
+ * The given expression must evaluate to true for a blob to be returned in the results.
+ * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter;
+ * however, only a subset of the OData filter syntax is supported in the Blob service.
+ * @param options - Options to findBlobsByTagsItems.
+ */
+ findBlobsByTagsItems(tagFilterSqlExpression_1) {
+ return tslib.__asyncGenerator(this, arguments, function* findBlobsByTagsItems_1(tagFilterSqlExpression, options = {}) {
+ var _a, e_1, _b, _c;
+ let marker;
+ try {
+ for (var _d = true, _e = tslib.__asyncValues(this.findBlobsByTagsSegments(tagFilterSqlExpression, marker, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+ _c = _f.value;
+ _d = false;
+ const segment = _c;
+ yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(segment.blobs)));
+ }
+ }
+ catch (e_1_1) { e_1 = { error: e_1_1 }; }
+ finally {
+ try {
+ if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
+ }
+ finally { if (e_1) throw e_1.error; }
+ }
+ });
+ }
+ /**
+ * Returns an async iterable iterator to find all blobs with specified tag
+ * under the specified account.
+ *
+ * .byPage() returns an async iterable iterator to list the blobs in pages.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-service-properties
+ *
+ * Example using `for await` syntax:
+ *
+ * ```js
+ * let i = 1;
+ * for await (const blob of blobServiceClient.findBlobsByTags("tagkey='tagvalue'")) {
+ * console.log(`Blob ${i++}: ${container.name}`);
+ * }
+ * ```
+ *
+ * Example using `iter.next()`:
+ *
+ * ```js
+ * let i = 1;
+ * const iter = blobServiceClient.findBlobsByTags("tagkey='tagvalue'");
+ * let blobItem = await iter.next();
+ * while (!blobItem.done) {
+ * console.log(`Blob ${i++}: ${blobItem.value.name}`);
+ * blobItem = await iter.next();
+ * }
+ * ```
+ *
+ * Example using `byPage()`:
+ *
+ * ```js
+ * // passing optional maxPageSize in the page settings
+ * let i = 1;
+ * for await (const response of blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 20 })) {
+ * if (response.blobs) {
+ * for (const blob of response.blobs) {
+ * console.log(`Blob ${i++}: ${blob.name}`);
+ * }
+ * }
+ * }
+ * ```
+ *
+ * Example using paging with a marker:
+ *
+ * ```js
+ * let i = 1;
+ * let iterator = blobServiceClient.findBlobsByTags("tagkey='tagvalue'").byPage({ maxPageSize: 2 });
+ * let response = (await iterator.next()).value;
+ *
+ * // Prints 2 blob names
+ * if (response.blobs) {
+ * for (const blob of response.blobs) {
+ * console.log(`Blob ${i++}: ${blob.name}`);
+ * }
+ * }
+ *
+ * // Gets next marker
+ * let marker = response.continuationToken;
+ * // Passing next marker as continuationToken
+ * iterator = blobServiceClient
+ * .findBlobsByTags("tagkey='tagvalue'")
+ * .byPage({ continuationToken: marker, maxPageSize: 10 });
+ * response = (await iterator.next()).value;
+ *
+ * // Prints blob names
+ * if (response.blobs) {
+ * for (const blob of response.blobs) {
+ * console.log(`Blob ${i++}: ${blob.name}`);
+ * }
+ * }
+ * ```
+ *
+ * @param tagFilterSqlExpression - The where parameter enables the caller to query blobs whose tags match a given expression.
+ * The given expression must evaluate to true for a blob to be returned in the results.
+ * The[OData - ABNF] filter syntax rule defines the formal grammar for the value of the where query parameter;
+ * however, only a subset of the OData filter syntax is supported in the Blob service.
+ * @param options - Options to find blobs by tags.
+ */
+ findBlobsByTags(tagFilterSqlExpression, options = {}) {
+ // AsyncIterableIterator to iterate over blobs
+ const listSegmentOptions = Object.assign({}, options);
+ const iter = this.findBlobsByTagsItems(tagFilterSqlExpression, listSegmentOptions);
+ return {
+ /**
+ * The next method, part of the iteration protocol
+ */
+ next() {
+ return iter.next();
+ },
+ /**
+ * The connection to the async iterator, part of the iteration protocol
+ */
+ [Symbol.asyncIterator]() {
+ return this;
+ },
+ /**
+ * Return an AsyncIterableIterator that works a page at a time
+ */
+ byPage: (settings = {}) => {
+ return this.findBlobsByTagsSegments(tagFilterSqlExpression, settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, listSegmentOptions));
+ },
+ };
}
/**
- * Set the delegate tracer provider
+ * Returns an AsyncIterableIterator for ServiceListContainersSegmentResponses
+ *
+ * @param marker - A string value that identifies the portion of
+ * the list of containers to be returned with the next listing operation. The
+ * operation returns the continuationToken value within the response body if the
+ * listing operation did not return all containers remaining to be listed
+ * with the current page. The continuationToken value can be used as the value for
+ * the marker parameter in a subsequent call to request the next page of list
+ * items. The marker value is opaque to the client.
+ * @param options - Options to list containers operation.
*/
- setDelegate(delegate) {
- this._delegate = delegate;
- }
- getDelegateTracer(name, version, options) {
- var _a;
- return (_a = this._delegate) === null || _a === void 0 ? void 0 : _a.getTracer(name, version, options);
+ listSegments(marker_1) {
+ return tslib.__asyncGenerator(this, arguments, function* listSegments_1(marker, options = {}) {
+ let listContainersSegmentResponse;
+ if (!!marker || marker === undefined) {
+ do {
+ listContainersSegmentResponse = yield tslib.__await(this.listContainersSegment(marker, options));
+ listContainersSegmentResponse.containerItems =
+ listContainersSegmentResponse.containerItems || [];
+ marker = listContainersSegmentResponse.continuationToken;
+ yield yield tslib.__await(yield tslib.__await(listContainersSegmentResponse));
+ } while (marker);
+ }
+ });
}
-}
-exports.ProxyTracerProvider = ProxyTracerProvider;
-//# sourceMappingURL=ProxyTracerProvider.js.map
-
-/***/ }),
-
-/***/ 3209:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.SamplingDecision = void 0;
-/**
- * @deprecated use the one declared in @opentelemetry/sdk-trace-base instead.
- * A sampling decision that determines how a {@link Span} will be recorded
- * and collected.
- */
-var SamplingDecision;
-(function (SamplingDecision) {
- /**
- * `Span.isRecording() === false`, span will not be recorded and all events
- * and attributes will be dropped.
- */
- SamplingDecision[SamplingDecision["NOT_RECORD"] = 0] = "NOT_RECORD";
- /**
- * `Span.isRecording() === true`, but `Sampled` flag in {@link TraceFlags}
- * MUST NOT be set.
- */
- SamplingDecision[SamplingDecision["RECORD"] = 1] = "RECORD";
/**
- * `Span.isRecording() === true` AND `Sampled` flag in {@link TraceFlags}
- * MUST be set.
+ * Returns an AsyncIterableIterator for Container Items
+ *
+ * @param options - Options to list containers operation.
*/
- SamplingDecision[SamplingDecision["RECORD_AND_SAMPLED"] = 2] = "RECORD_AND_SAMPLED";
-})(SamplingDecision = exports.SamplingDecision || (exports.SamplingDecision = {}));
-//# sourceMappingURL=SamplingResult.js.map
-
-/***/ }),
-
-/***/ 3326:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.getSpanContext = exports.setSpanContext = exports.deleteSpan = exports.setSpan = exports.getActiveSpan = exports.getSpan = void 0;
-const context_1 = __nccwpck_require__(8242);
-const NonRecordingSpan_1 = __nccwpck_require__(1462);
-const context_2 = __nccwpck_require__(7171);
-/**
- * span key
- */
-const SPAN_KEY = (0, context_1.createContextKey)('OpenTelemetry Context Key SPAN');
-/**
- * Return the span if one exists
- *
- * @param context context to get span from
- */
-function getSpan(context) {
- return context.getValue(SPAN_KEY) || undefined;
-}
-exports.getSpan = getSpan;
-/**
- * Gets the span from the current context, if one exists.
- */
-function getActiveSpan() {
- return getSpan(context_2.ContextAPI.getInstance().active());
-}
-exports.getActiveSpan = getActiveSpan;
-/**
- * Set the span on a context
- *
- * @param context context to use as parent
- * @param span span to set active
- */
-function setSpan(context, span) {
- return context.setValue(SPAN_KEY, span);
-}
-exports.setSpan = setSpan;
-/**
- * Remove current span stored in the context
- *
- * @param context context to delete span from
- */
-function deleteSpan(context) {
- return context.deleteValue(SPAN_KEY);
-}
-exports.deleteSpan = deleteSpan;
-/**
- * Wrap span context in a NoopSpan and set as span in a new
- * context
- *
- * @param context context to set active span on
- * @param spanContext span context to be wrapped
- */
-function setSpanContext(context, spanContext) {
- return setSpan(context, new NonRecordingSpan_1.NonRecordingSpan(spanContext));
-}
-exports.setSpanContext = setSpanContext;
-/**
- * Get the span context of the span if it exists.
- *
- * @param context context to get values from
- */
-function getSpanContext(context) {
- var _a;
- return (_a = getSpan(context)) === null || _a === void 0 ? void 0 : _a.spanContext();
-}
-exports.getSpanContext = getSpanContext;
-//# sourceMappingURL=context-utils.js.map
-
-/***/ }),
-
-/***/ 2110:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.TraceStateImpl = void 0;
-const tracestate_validators_1 = __nccwpck_require__(4864);
-const MAX_TRACE_STATE_ITEMS = 32;
-const MAX_TRACE_STATE_LEN = 512;
-const LIST_MEMBERS_SEPARATOR = ',';
-const LIST_MEMBER_KEY_VALUE_SPLITTER = '=';
-/**
- * TraceState must be a class and not a simple object type because of the spec
- * requirement (https://www.w3.org/TR/trace-context/#tracestate-field).
- *
- * Here is the list of allowed mutations:
- * - New key-value pair should be added into the beginning of the list
- * - The value of any key can be updated. Modified keys MUST be moved to the
- * beginning of the list.
- */
-class TraceStateImpl {
- constructor(rawTraceState) {
- this._internalState = new Map();
- if (rawTraceState)
- this._parse(rawTraceState);
- }
- set(key, value) {
- // TODO: Benchmark the different approaches(map vs list) and
- // use the faster one.
- const traceState = this._clone();
- if (traceState._internalState.has(key)) {
- traceState._internalState.delete(key);
- }
- traceState._internalState.set(key, value);
- return traceState;
- }
- unset(key) {
- const traceState = this._clone();
- traceState._internalState.delete(key);
- return traceState;
- }
- get(key) {
- return this._internalState.get(key);
- }
- serialize() {
- return this._keys()
- .reduce((agg, key) => {
- agg.push(key + LIST_MEMBER_KEY_VALUE_SPLITTER + this.get(key));
- return agg;
- }, [])
- .join(LIST_MEMBERS_SEPARATOR);
- }
- _parse(rawTraceState) {
- if (rawTraceState.length > MAX_TRACE_STATE_LEN)
- return;
- this._internalState = rawTraceState
- .split(LIST_MEMBERS_SEPARATOR)
- .reverse() // Store in reverse so new keys (.set(...)) will be placed at the beginning
- .reduce((agg, part) => {
- const listMember = part.trim(); // Optional Whitespace (OWS) handling
- const i = listMember.indexOf(LIST_MEMBER_KEY_VALUE_SPLITTER);
- if (i !== -1) {
- const key = listMember.slice(0, i);
- const value = listMember.slice(i + 1, part.length);
- if ((0, tracestate_validators_1.validateKey)(key) && (0, tracestate_validators_1.validateValue)(value)) {
- agg.set(key, value);
+ listItems() {
+ return tslib.__asyncGenerator(this, arguments, function* listItems_1(options = {}) {
+ var _a, e_2, _b, _c;
+ let marker;
+ try {
+ for (var _d = true, _e = tslib.__asyncValues(this.listSegments(marker, options)), _f; _f = yield tslib.__await(_e.next()), _a = _f.done, !_a; _d = true) {
+ _c = _f.value;
+ _d = false;
+ const segment = _c;
+ yield tslib.__await(yield* tslib.__asyncDelegator(tslib.__asyncValues(segment.containerItems)));
}
- else {
- // TODO: Consider to add warning log
+ }
+ catch (e_2_1) { e_2 = { error: e_2_1 }; }
+ finally {
+ try {
+ if (!_d && !_a && (_b = _e.return)) yield tslib.__await(_b.call(_e));
}
+ finally { if (e_2) throw e_2.error; }
}
- return agg;
- }, new Map());
- // Because of the reverse() requirement, trunc must be done after map is created
- if (this._internalState.size > MAX_TRACE_STATE_ITEMS) {
- this._internalState = new Map(Array.from(this._internalState.entries())
- .reverse() // Use reverse same as original tracestate parse chain
- .slice(0, MAX_TRACE_STATE_ITEMS));
- }
- }
- _keys() {
- return Array.from(this._internalState.keys()).reverse();
- }
- _clone() {
- const traceState = new TraceStateImpl();
- traceState._internalState = new Map(this._internalState);
- return traceState;
+ });
}
-}
-exports.TraceStateImpl = TraceStateImpl;
-//# sourceMappingURL=tracestate-impl.js.map
-
-/***/ }),
-
-/***/ 4864:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.validateValue = exports.validateKey = void 0;
-const VALID_KEY_CHAR_RANGE = '[_0-9a-z-*/]';
-const VALID_KEY = `[a-z]${VALID_KEY_CHAR_RANGE}{0,255}`;
-const VALID_VENDOR_KEY = `[a-z0-9]${VALID_KEY_CHAR_RANGE}{0,240}@[a-z]${VALID_KEY_CHAR_RANGE}{0,13}`;
-const VALID_KEY_REGEX = new RegExp(`^(?:${VALID_KEY}|${VALID_VENDOR_KEY})$`);
-const VALID_VALUE_BASE_REGEX = /^[ -~]{0,255}[!-~]$/;
-const INVALID_VALUE_COMMA_EQUAL_REGEX = /,|=/;
-/**
- * Key is opaque string up to 256 characters printable. It MUST begin with a
- * lowercase letter, and can only contain lowercase letters a-z, digits 0-9,
- * underscores _, dashes -, asterisks *, and forward slashes /.
- * For multi-tenant vendor scenarios, an at sign (@) can be used to prefix the
- * vendor name. Vendors SHOULD set the tenant ID at the beginning of the key.
- * see https://www.w3.org/TR/trace-context/#key
- */
-function validateKey(key) {
- return VALID_KEY_REGEX.test(key);
-}
-exports.validateKey = validateKey;
-/**
- * Value is opaque string up to 256 characters printable ASCII RFC0020
- * characters (i.e., the range 0x20 to 0x7E) except comma , and =.
- */
-function validateValue(value) {
- return (VALID_VALUE_BASE_REGEX.test(value) &&
- !INVALID_VALUE_COMMA_EQUAL_REGEX.test(value));
-}
-exports.validateValue = validateValue;
-//# sourceMappingURL=tracestate-validators.js.map
-
-/***/ }),
-
-/***/ 2615:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.createTraceState = void 0;
-const tracestate_impl_1 = __nccwpck_require__(2110);
-function createTraceState(rawTraceState) {
- return new tracestate_impl_1.TraceStateImpl(rawTraceState);
-}
-exports.createTraceState = createTraceState;
-//# sourceMappingURL=utils.js.map
-
-/***/ }),
-
-/***/ 1760:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.INVALID_SPAN_CONTEXT = exports.INVALID_TRACEID = exports.INVALID_SPANID = void 0;
-const trace_flags_1 = __nccwpck_require__(6905);
-exports.INVALID_SPANID = '0000000000000000';
-exports.INVALID_TRACEID = '00000000000000000000000000000000';
-exports.INVALID_SPAN_CONTEXT = {
- traceId: exports.INVALID_TRACEID,
- spanId: exports.INVALID_SPANID,
- traceFlags: trace_flags_1.TraceFlags.NONE,
-};
-//# sourceMappingURL=invalid-span-constants.js.map
-
-/***/ }),
-
-/***/ 1424:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.SpanKind = void 0;
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var SpanKind;
-(function (SpanKind) {
- /** Default value. Indicates that the span is used internally. */
- SpanKind[SpanKind["INTERNAL"] = 0] = "INTERNAL";
- /**
- * Indicates that the span covers server-side handling of an RPC or other
- * remote request.
- */
- SpanKind[SpanKind["SERVER"] = 1] = "SERVER";
/**
- * Indicates that the span covers the client-side wrapper around an RPC or
- * other remote request.
- */
- SpanKind[SpanKind["CLIENT"] = 2] = "CLIENT";
- /**
- * Indicates that the span describes producer sending a message to a
- * broker. Unlike client and server, there is no direct critical path latency
- * relationship between producer and consumer spans.
- */
- SpanKind[SpanKind["PRODUCER"] = 3] = "PRODUCER";
- /**
- * Indicates that the span describes consumer receiving a message from a
- * broker. Unlike client and server, there is no direct critical path latency
- * relationship between producer and consumer spans.
+ * Returns an async iterable iterator to list all the containers
+ * under the specified account.
+ *
+ * .byPage() returns an async iterable iterator to list the containers in pages.
+ *
+ * Example using `for await` syntax:
+ *
+ * ```js
+ * let i = 1;
+ * for await (const container of blobServiceClient.listContainers()) {
+ * console.log(`Container ${i++}: ${container.name}`);
+ * }
+ * ```
+ *
+ * Example using `iter.next()`:
+ *
+ * ```js
+ * let i = 1;
+ * const iter = blobServiceClient.listContainers();
+ * let containerItem = await iter.next();
+ * while (!containerItem.done) {
+ * console.log(`Container ${i++}: ${containerItem.value.name}`);
+ * containerItem = await iter.next();
+ * }
+ * ```
+ *
+ * Example using `byPage()`:
+ *
+ * ```js
+ * // passing optional maxPageSize in the page settings
+ * let i = 1;
+ * for await (const response of blobServiceClient.listContainers().byPage({ maxPageSize: 20 })) {
+ * if (response.containerItems) {
+ * for (const container of response.containerItems) {
+ * console.log(`Container ${i++}: ${container.name}`);
+ * }
+ * }
+ * }
+ * ```
+ *
+ * Example using paging with a marker:
+ *
+ * ```js
+ * let i = 1;
+ * let iterator = blobServiceClient.listContainers().byPage({ maxPageSize: 2 });
+ * let response = (await iterator.next()).value;
+ *
+ * // Prints 2 container names
+ * if (response.containerItems) {
+ * for (const container of response.containerItems) {
+ * console.log(`Container ${i++}: ${container.name}`);
+ * }
+ * }
+ *
+ * // Gets next marker
+ * let marker = response.continuationToken;
+ * // Passing next marker as continuationToken
+ * iterator = blobServiceClient
+ * .listContainers()
+ * .byPage({ continuationToken: marker, maxPageSize: 10 });
+ * response = (await iterator.next()).value;
+ *
+ * // Prints 10 container names
+ * if (response.containerItems) {
+ * for (const container of response.containerItems) {
+ * console.log(`Container ${i++}: ${container.name}`);
+ * }
+ * }
+ * ```
+ *
+ * @param options - Options to list containers.
+ * @returns An asyncIterableIterator that supports paging.
*/
- SpanKind[SpanKind["CONSUMER"] = 4] = "CONSUMER";
-})(SpanKind = exports.SpanKind || (exports.SpanKind = {}));
-//# sourceMappingURL=span_kind.js.map
-
-/***/ }),
-
-/***/ 9745:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.wrapSpanContext = exports.isSpanContextValid = exports.isValidSpanId = exports.isValidTraceId = void 0;
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-const invalid_span_constants_1 = __nccwpck_require__(1760);
-const NonRecordingSpan_1 = __nccwpck_require__(1462);
-const VALID_TRACEID_REGEX = /^([0-9a-f]{32})$/i;
-const VALID_SPANID_REGEX = /^[0-9a-f]{16}$/i;
-function isValidTraceId(traceId) {
- return VALID_TRACEID_REGEX.test(traceId) && traceId !== invalid_span_constants_1.INVALID_TRACEID;
-}
-exports.isValidTraceId = isValidTraceId;
-function isValidSpanId(spanId) {
- return VALID_SPANID_REGEX.test(spanId) && spanId !== invalid_span_constants_1.INVALID_SPANID;
-}
-exports.isValidSpanId = isValidSpanId;
-/**
- * Returns true if this {@link SpanContext} is valid.
- * @return true if this {@link SpanContext} is valid.
- */
-function isSpanContextValid(spanContext) {
- return (isValidTraceId(spanContext.traceId) && isValidSpanId(spanContext.spanId));
-}
-exports.isSpanContextValid = isSpanContextValid;
-/**
- * Wrap the given {@link SpanContext} in a new non-recording {@link Span}
- *
- * @param spanContext span context to be wrapped
- * @returns a new non-recording {@link Span} with the provided context
- */
-function wrapSpanContext(spanContext) {
- return new NonRecordingSpan_1.NonRecordingSpan(spanContext);
-}
-exports.wrapSpanContext = wrapSpanContext;
-//# sourceMappingURL=spancontext-utils.js.map
-
-/***/ }),
-
-/***/ 8845:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.SpanStatusCode = void 0;
-/**
- * An enumeration of status codes.
- */
-var SpanStatusCode;
-(function (SpanStatusCode) {
+ listContainers(options = {}) {
+ if (options.prefix === "") {
+ options.prefix = undefined;
+ }
+ const include = [];
+ if (options.includeDeleted) {
+ include.push("deleted");
+ }
+ if (options.includeMetadata) {
+ include.push("metadata");
+ }
+ if (options.includeSystem) {
+ include.push("system");
+ }
+ // AsyncIterableIterator to iterate over containers
+ const listSegmentOptions = Object.assign(Object.assign({}, options), (include.length > 0 ? { include } : {}));
+ const iter = this.listItems(listSegmentOptions);
+ return {
+ /**
+ * The next method, part of the iteration protocol
+ */
+ next() {
+ return iter.next();
+ },
+ /**
+ * The connection to the async iterator, part of the iteration protocol
+ */
+ [Symbol.asyncIterator]() {
+ return this;
+ },
+ /**
+ * Return an AsyncIterableIterator that works a page at a time
+ */
+ byPage: (settings = {}) => {
+ return this.listSegments(settings.continuationToken, Object.assign({ maxPageSize: settings.maxPageSize }, listSegmentOptions));
+ },
+ };
+ }
/**
- * The default status.
+ * ONLY AVAILABLE WHEN USING BEARER TOKEN AUTHENTICATION (TokenCredential).
+ *
+ * Retrieves a user delegation key for the Blob service. This is only a valid operation when using
+ * bearer token authentication.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/get-user-delegation-key
+ *
+ * @param startsOn - The start time for the user delegation SAS. Must be within 7 days of the current time
+ * @param expiresOn - The end time for the user delegation SAS. Must be within 7 days of the current time
*/
- SpanStatusCode[SpanStatusCode["UNSET"] = 0] = "UNSET";
+ async getUserDelegationKey(startsOn, expiresOn, options = {}) {
+ return tracingClient.withSpan("BlobServiceClient-getUserDelegationKey", options, async (updatedOptions) => {
+ const response = assertResponse(await this.serviceContext.getUserDelegationKey({
+ startsOn: truncatedISO8061Date(startsOn, false),
+ expiresOn: truncatedISO8061Date(expiresOn, false),
+ }, {
+ abortSignal: options.abortSignal,
+ tracingOptions: updatedOptions.tracingOptions,
+ }));
+ const userDelegationKey = {
+ signedObjectId: response.signedObjectId,
+ signedTenantId: response.signedTenantId,
+ signedStartsOn: new Date(response.signedStartsOn),
+ signedExpiresOn: new Date(response.signedExpiresOn),
+ signedService: response.signedService,
+ signedVersion: response.signedVersion,
+ value: response.value,
+ };
+ const res = Object.assign({ _response: response._response, requestId: response.requestId, clientRequestId: response.clientRequestId, version: response.version, date: response.date, errorCode: response.errorCode }, userDelegationKey);
+ return res;
+ });
+ }
/**
- * The operation has been validated by an Application developer or
- * Operator to have completed successfully.
+ * Creates a BlobBatchClient object to conduct batch operations.
+ *
+ * @see https://docs.microsoft.com/en-us/rest/api/storageservices/blob-batch
+ *
+ * @returns A new BlobBatchClient object for this service.
*/
- SpanStatusCode[SpanStatusCode["OK"] = 1] = "OK";
+ getBlobBatchClient() {
+ return new BlobBatchClient(this.url, this.pipeline);
+ }
/**
- * The operation contains an error.
+ * Only available for BlobServiceClient constructed with a shared key credential.
+ *
+ * Generates a Blob account 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/create-account-sas
+ *
+ * @param expiresOn - Optional. The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
+ * @param permissions - Specifies the list of permissions to be associated with the SAS.
+ * @param resourceTypes - Specifies the resource types associated with the shared access signature.
+ * @param options - Optional parameters.
+ * @returns An account SAS URI consisting of the URI to the resource represented by this client, followed by the generated SAS token.
*/
- SpanStatusCode[SpanStatusCode["ERROR"] = 2] = "ERROR";
-})(SpanStatusCode = exports.SpanStatusCode || (exports.SpanStatusCode = {}));
-//# sourceMappingURL=status.js.map
-
-/***/ }),
-
-/***/ 6905:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.TraceFlags = void 0;
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var TraceFlags;
-(function (TraceFlags) {
- /** Represents no flag set. */
- TraceFlags[TraceFlags["NONE"] = 0] = "NONE";
- /** Bit to represent whether trace is sampled in trace flags. */
- TraceFlags[TraceFlags["SAMPLED"] = 1] = "SAMPLED";
-})(TraceFlags = exports.TraceFlags || (exports.TraceFlags = {}));
-//# sourceMappingURL=trace_flags.js.map
-
-/***/ }),
-
-/***/ 8996:
-/***/ ((__unused_webpack_module, exports) => {
-
-"use strict";
-
-/*
- * Copyright The OpenTelemetry Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.VERSION = void 0;
-// this is autogenerated file, see scripts/version-update.js
-exports.VERSION = '1.7.0';
-//# sourceMappingURL=version.js.map
-
-/***/ }),
-
-/***/ 4812:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-module.exports =
-{
- parallel : __nccwpck_require__(8210),
- serial : __nccwpck_require__(445),
- serialOrdered : __nccwpck_require__(3578)
-};
-
-
-/***/ }),
-
-/***/ 1700:
-/***/ ((module) => {
-
-// API
-module.exports = abort;
-
-/**
- * Aborts leftover active jobs
- *
- * @param {object} state - current state object
- */
-function abort(state)
-{
- Object.keys(state.jobs).forEach(clean.bind(state));
-
- // reset leftover jobs
- state.jobs = {};
-}
-
-/**
- * Cleans up leftover job by invoking abort function for the provided job id
- *
- * @this state
- * @param {string|number} key - job id to abort
- */
-function clean(key)
-{
- if (typeof this.jobs[key] == 'function')
- {
- this.jobs[key]();
- }
-}
-
-
-/***/ }),
-
-/***/ 2794:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-var defer = __nccwpck_require__(5295);
-
-// API
-module.exports = async;
-
-/**
- * Runs provided callback asynchronously
- * even if callback itself is not
- *
- * @param {function} callback - callback to invoke
- * @returns {function} - augmented callback
- */
-function async(callback)
-{
- var isAsync = false;
-
- // check if async happened
- defer(function() { isAsync = true; });
-
- return function async_callback(err, result)
- {
- if (isAsync)
- {
- callback(err, result);
- }
- else
- {
- defer(function nextTick_callback()
- {
- callback(err, result);
- });
+ generateAccountSasUrl(expiresOn, permissions = AccountSASPermissions.parse("r"), resourceTypes = "sco", options = {}) {
+ if (!(this.credential instanceof StorageSharedKeyCredential)) {
+ throw RangeError("Can only generate the account SAS when the client is initialized with a shared key credential");
+ }
+ if (expiresOn === undefined) {
+ const now = new Date();
+ expiresOn = new Date(now.getTime() + 3600 * 1000);
+ }
+ const sas = generateAccountSASQueryParameters(Object.assign({ permissions,
+ expiresOn,
+ resourceTypes, services: AccountSASServices.parse("b").toString() }, options), this.credential).toString();
+ return appendToURLQuery(this.url, sas);
}
- };
}
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+/** Known values of {@link EncryptionAlgorithmType} that the service accepts. */
+exports.KnownEncryptionAlgorithmType = void 0;
+(function (KnownEncryptionAlgorithmType) {
+ KnownEncryptionAlgorithmType["AES256"] = "AES256";
+})(exports.KnownEncryptionAlgorithmType || (exports.KnownEncryptionAlgorithmType = {}));
-/***/ }),
-
-/***/ 5295:
-/***/ ((module) => {
-
-module.exports = defer;
-
-/**
- * Runs provided function on next iteration of the event loop
- *
- * @param {function} fn - function to run
- */
-function defer(fn)
-{
- var nextTick = typeof setImmediate == 'function'
- ? setImmediate
- : (
- typeof process == 'object' && typeof process.nextTick == 'function'
- ? process.nextTick
- : null
- );
-
- if (nextTick)
- {
- nextTick(fn);
- }
- else
- {
- setTimeout(fn, 0);
- }
-}
+Object.defineProperty(exports, "RestError", ({
+ enumerable: true,
+ get: function () { return coreRestPipeline.RestError; }
+}));
+exports.AccountSASPermissions = AccountSASPermissions;
+exports.AccountSASResourceTypes = AccountSASResourceTypes;
+exports.AccountSASServices = AccountSASServices;
+exports.AnonymousCredential = AnonymousCredential;
+exports.AnonymousCredentialPolicy = AnonymousCredentialPolicy;
+exports.AppendBlobClient = AppendBlobClient;
+exports.BaseRequestPolicy = BaseRequestPolicy;
+exports.BlobBatch = BlobBatch;
+exports.BlobBatchClient = BlobBatchClient;
+exports.BlobClient = BlobClient;
+exports.BlobLeaseClient = BlobLeaseClient;
+exports.BlobSASPermissions = BlobSASPermissions;
+exports.BlobServiceClient = BlobServiceClient;
+exports.BlockBlobClient = BlockBlobClient;
+exports.ContainerClient = ContainerClient;
+exports.ContainerSASPermissions = ContainerSASPermissions;
+exports.Credential = Credential;
+exports.CredentialPolicy = CredentialPolicy;
+exports.PageBlobClient = PageBlobClient;
+exports.Pipeline = Pipeline;
+exports.SASQueryParameters = SASQueryParameters;
+exports.StorageBrowserPolicy = StorageBrowserPolicy;
+exports.StorageBrowserPolicyFactory = StorageBrowserPolicyFactory;
+exports.StorageOAuthScopes = StorageOAuthScopes;
+exports.StorageRetryPolicy = StorageRetryPolicy;
+exports.StorageRetryPolicyFactory = StorageRetryPolicyFactory;
+exports.StorageSharedKeyCredential = StorageSharedKeyCredential;
+exports.StorageSharedKeyCredentialPolicy = StorageSharedKeyCredentialPolicy;
+exports.generateAccountSASQueryParameters = generateAccountSASQueryParameters;
+exports.generateBlobSASQueryParameters = generateBlobSASQueryParameters;
+exports.getBlobServiceAccountAudience = getBlobServiceAccountAudience;
+exports.isPipelineLike = isPipelineLike;
+exports.logger = logger;
+exports.newPipeline = newPipeline;
+//# sourceMappingURL=index.js.map
/***/ }),
-/***/ 9023:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+/***/ 7559:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
-var async = __nccwpck_require__(2794)
- , abort = __nccwpck_require__(1700)
- ;
-// API
-module.exports = iterate;
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+///
+const listenersMap = new WeakMap();
+const abortedMap = new WeakMap();
/**
- * Iterates over each job object
+ * An aborter instance implements AbortSignal interface, can abort HTTP requests.
+ *
+ * - Call AbortSignal.none to create a new AbortSignal instance that cannot be cancelled.
+ * Use `AbortSignal.none` when you are required to pass a cancellation token but the operation
+ * cannot or will not ever be cancelled.
*
- * @param {array|object} list - array or object (named list) to iterate over
- * @param {function} iterator - iterator to run
- * @param {object} state - current job status
- * @param {function} callback - invoked when all elements processed
+ * @example
+ * Abort without timeout
+ * ```ts
+ * await doAsyncWork(AbortSignal.none);
+ * ```
*/
-function iterate(list, iterator, state, callback)
-{
- // store current index
- var key = state['keyedList'] ? state['keyedList'][state.index] : state.index;
-
- state.jobs[key] = runJob(iterator, key, list[key], function(error, output)
- {
- // don't repeat yourself
- // skip secondary callbacks
- if (!(key in state.jobs))
- {
- return;
+class AbortSignal {
+ constructor() {
+ /**
+ * onabort event listener.
+ */
+ this.onabort = null;
+ listenersMap.set(this, []);
+ abortedMap.set(this, false);
}
-
- // clean up jobs
- delete state.jobs[key];
-
- if (error)
- {
- // don't process rest of the results
- // stop still active jobs
- // and reset the list
- abort(state);
+ /**
+ * Status of whether aborted or not.
+ *
+ * @readonly
+ */
+ get aborted() {
+ if (!abortedMap.has(this)) {
+ throw new TypeError("Expected `this` to be an instance of AbortSignal.");
+ }
+ return abortedMap.get(this);
}
- else
- {
- state.results[key] = output;
+ /**
+ * Creates a new AbortSignal instance that will never be aborted.
+ *
+ * @readonly
+ */
+ static get none() {
+ return new AbortSignal();
+ }
+ /**
+ * Added new "abort" event listener, only support "abort" event.
+ *
+ * @param _type - Only support "abort" event
+ * @param listener - The listener to be added
+ */
+ addEventListener(
+ // tslint:disable-next-line:variable-name
+ _type, listener) {
+ if (!listenersMap.has(this)) {
+ throw new TypeError("Expected `this` to be an instance of AbortSignal.");
+ }
+ const listeners = listenersMap.get(this);
+ listeners.push(listener);
+ }
+ /**
+ * Remove "abort" event listener, only support "abort" event.
+ *
+ * @param _type - Only support "abort" event
+ * @param listener - The listener to be removed
+ */
+ removeEventListener(
+ // tslint:disable-next-line:variable-name
+ _type, listener) {
+ if (!listenersMap.has(this)) {
+ throw new TypeError("Expected `this` to be an instance of AbortSignal.");
+ }
+ const listeners = listenersMap.get(this);
+ const index = listeners.indexOf(listener);
+ if (index > -1) {
+ listeners.splice(index, 1);
+ }
+ }
+ /**
+ * Dispatches a synthetic event to the AbortSignal.
+ */
+ dispatchEvent(_event) {
+ throw new Error("This is a stub dispatchEvent implementation that should not be used. It only exists for type-checking purposes.");
}
-
- // return salvaged results
- callback(error, state.results);
- });
}
-
/**
- * Runs iterator over provided job element
+ * Helper to trigger an abort event immediately, the onabort and all abort event listeners will be triggered.
+ * Will try to trigger abort event for all linked AbortSignal nodes.
*
- * @param {function} iterator - iterator to invoke
- * @param {string|number} key - key/index of the element in the list of jobs
- * @param {mixed} item - job description
- * @param {function} callback - invoked after iterator is done with the job
- * @returns {function|mixed} - job abort function or something else
- */
-function runJob(iterator, key, item, callback)
-{
- var aborter;
-
- // allow shortcut if iterator expects only two arguments
- if (iterator.length == 2)
- {
- aborter = iterator(item, async(callback));
- }
- // otherwise go with full three arguments
- else
- {
- aborter = iterator(item, key, async(callback));
- }
-
- return aborter;
-}
-
-
-/***/ }),
-
-/***/ 2474:
-/***/ ((module) => {
-
-// API
-module.exports = state;
-
-/**
- * Creates initial state object
- * for iteration over list
+ * - If there is a timeout, the timer will be cancelled.
+ * - If aborted is true, nothing will happen.
*
- * @param {array|object} list - list to iterate over
- * @param {function|null} sortMethod - function to use for keys sort,
- * or `null` to keep them as is
- * @returns {object} - initial state object
- */
-function state(list, sortMethod)
-{
- var isNamedList = !Array.isArray(list)
- , initState =
- {
- index : 0,
- keyedList: isNamedList || sortMethod ? Object.keys(list) : null,
- jobs : {},
- results : isNamedList ? {} : [],
- size : isNamedList ? Object.keys(list).length : list.length
+ * @internal
+ */
+// eslint-disable-next-line @azure/azure-sdk/ts-use-interface-parameters
+function abortSignal(signal) {
+ if (signal.aborted) {
+ return;
}
- ;
-
- if (sortMethod)
- {
- // sort array keys based on it's values
- // sort object's keys just on own merit
- initState.keyedList.sort(isNamedList ? sortMethod : function(a, b)
- {
- return sortMethod(list[a], list[b]);
- });
- }
-
- return initState;
+ if (signal.onabort) {
+ signal.onabort.call(signal);
+ }
+ const listeners = listenersMap.get(signal);
+ if (listeners) {
+ // Create a copy of listeners so mutations to the array
+ // (e.g. via removeListener calls) don't affect the listeners
+ // we invoke.
+ listeners.slice().forEach((listener) => {
+ listener.call(signal, { type: "abort" });
+ });
+ }
+ abortedMap.set(signal, true);
}
-
-/***/ }),
-
-/***/ 7942:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-var abort = __nccwpck_require__(1700)
- , async = __nccwpck_require__(2794)
- ;
-
-// API
-module.exports = terminator;
-
+// Copyright (c) Microsoft Corporation.
/**
- * Terminates jobs in the attached state context
+ * This error is thrown when an asynchronous operation has been aborted.
+ * Check for this error by testing the `name` that the name property of the
+ * error matches `"AbortError"`.
*
- * @this AsyncKitState#
- * @param {function} callback - final callback to invoke after termination
+ * @example
+ * ```ts
+ * const controller = new AbortController();
+ * controller.abort();
+ * try {
+ * doAsyncWork(controller.signal)
+ * } catch (e) {
+ * if (e.name === 'AbortError') {
+ * // handle abort error here.
+ * }
+ * }
+ * ```
*/
-function terminator(callback)
-{
- if (!Object.keys(this.jobs).length)
- {
- return;
- }
-
- // fast forward iteration index
- this.index = this.size;
-
- // abort jobs
- abort(this);
-
- // send back results we have so far
- async(callback)(null, this.results);
+class AbortError extends Error {
+ constructor(message) {
+ super(message);
+ this.name = "AbortError";
+ }
}
-
-
-/***/ }),
-
-/***/ 8210:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-var iterate = __nccwpck_require__(9023)
- , initState = __nccwpck_require__(2474)
- , terminator = __nccwpck_require__(7942)
- ;
-
-// Public API
-module.exports = parallel;
-
/**
- * Runs iterator over provided array elements in parallel
+ * An AbortController provides an AbortSignal and the associated controls to signal
+ * that an asynchronous operation should be aborted.
+ *
+ * @example
+ * Abort an operation when another event fires
+ * ```ts
+ * const controller = new AbortController();
+ * const signal = controller.signal;
+ * doAsyncWork(signal);
+ * button.addEventListener('click', () => controller.abort());
+ * ```
+ *
+ * @example
+ * Share aborter cross multiple operations in 30s
+ * ```ts
+ * // Upload the same data to 2 different data centers at the same time,
+ * // abort another when any of them is finished
+ * const controller = AbortController.withTimeout(30 * 1000);
+ * doAsyncWork(controller.signal).then(controller.abort);
+ * doAsyncWork(controller.signal).then(controller.abort);
+ *```
+ *
+ * @example
+ * Cascaded aborting
+ * ```ts
+ * // All operations can't take more than 30 seconds
+ * const aborter = Aborter.timeout(30 * 1000);
*
- * @param {array|object} list - array or object (named list) to iterate over
- * @param {function} iterator - iterator to run
- * @param {function} callback - invoked when all elements processed
- * @returns {function} - jobs terminator
+ * // Following 2 operations can't take more than 25 seconds
+ * await doAsyncWork(aborter.withTimeout(25 * 1000));
+ * await doAsyncWork(aborter.withTimeout(25 * 1000));
+ * ```
*/
-function parallel(list, iterator, callback)
-{
- var state = initState(list);
-
- while (state.index < (state['keyedList'] || list).length)
- {
- iterate(list, iterator, state, function(error, result)
- {
- if (error)
- {
- callback(error, result);
- return;
- }
-
- // looks like it's the last one
- if (Object.keys(state.jobs).length === 0)
- {
- callback(null, state.results);
- return;
- }
- });
-
- state.index++;
- }
-
- return terminator.bind(state, callback);
+class AbortController {
+ // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
+ constructor(parentSignals) {
+ this._signal = new AbortSignal();
+ if (!parentSignals) {
+ return;
+ }
+ // coerce parentSignals into an array
+ if (!Array.isArray(parentSignals)) {
+ // eslint-disable-next-line prefer-rest-params
+ parentSignals = arguments;
+ }
+ for (const parentSignal of parentSignals) {
+ // if the parent signal has already had abort() called,
+ // then call abort on this signal as well.
+ if (parentSignal.aborted) {
+ this.abort();
+ }
+ else {
+ // when the parent signal aborts, this signal should as well.
+ parentSignal.addEventListener("abort", () => {
+ this.abort();
+ });
+ }
+ }
+ }
+ /**
+ * The AbortSignal associated with this controller that will signal aborted
+ * when the abort method is called on this controller.
+ *
+ * @readonly
+ */
+ get signal() {
+ return this._signal;
+ }
+ /**
+ * Signal that any operations passed this controller's associated abort signal
+ * to cancel any remaining work and throw an `AbortError`.
+ */
+ abort() {
+ abortSignal(this._signal);
+ }
+ /**
+ * Creates a new AbortSignal instance that will abort after the provided ms.
+ * @param ms - Elapsed time in milliseconds to trigger an abort.
+ */
+ static timeout(ms) {
+ const signal = new AbortSignal();
+ const timer = setTimeout(abortSignal, ms, signal);
+ // Prevent the active Timer from keeping the Node.js event loop active.
+ if (typeof timer.unref === "function") {
+ timer.unref();
+ }
+ return signal;
+ }
}
+exports.AbortController = AbortController;
+exports.AbortError = AbortError;
+exports.AbortSignal = AbortSignal;
+//# sourceMappingURL=index.js.map
+
/***/ }),
-/***/ 445:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-var serialOrdered = __nccwpck_require__(3578);
+/***/ 8348:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
-// Public API
-module.exports = serial;
+"use strict";
-/**
- * Runs iterator over provided array elements in series
- *
- * @param {array|object} list - array or object (named list) to iterate over
- * @param {function} iterator - iterator to run
- * @param {function} callback - invoked when all elements processed
- * @returns {function} - jobs terminator
- */
-function serial(list, iterator, callback)
-{
- return serialOrdered(list, iterator, null, callback);
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ var desc = Object.getOwnPropertyDescriptor(m, k);
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+ desc = { enumerable: true, get: function() { return m[k]; } };
+ }
+ Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+ o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+ if (mod && mod.__esModule) return mod;
+ var result = {};
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+ __setModuleDefault(result, mod);
+ return result;
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.req = exports.json = exports.toBuffer = void 0;
+const http = __importStar(__nccwpck_require__(3685));
+const https = __importStar(__nccwpck_require__(5687));
+async function toBuffer(stream) {
+ let length = 0;
+ const chunks = [];
+ for await (const chunk of stream) {
+ length += chunk.length;
+ chunks.push(chunk);
+ }
+ return Buffer.concat(chunks, length);
}
-
+exports.toBuffer = toBuffer;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+async function json(stream) {
+ const buf = await toBuffer(stream);
+ const str = buf.toString('utf8');
+ try {
+ return JSON.parse(str);
+ }
+ catch (_err) {
+ const err = _err;
+ err.message += ` (input: ${str})`;
+ throw err;
+ }
+}
+exports.json = json;
+function req(url, opts = {}) {
+ const href = typeof url === 'string' ? url : url.href;
+ const req = (href.startsWith('https:') ? https : http).request(url, opts);
+ const promise = new Promise((resolve, reject) => {
+ req
+ .once('response', resolve)
+ .once('error', reject)
+ .end();
+ });
+ req.then = promise.then.bind(promise);
+ return req;
+}
+exports.req = req;
+//# sourceMappingURL=helpers.js.map
/***/ }),
-/***/ 3578:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-var iterate = __nccwpck_require__(9023)
- , initState = __nccwpck_require__(2474)
- , terminator = __nccwpck_require__(7942)
- ;
-
-// Public API
-module.exports = serialOrdered;
-// sorting helpers
-module.exports.ascending = ascending;
-module.exports.descending = descending;
+/***/ 694:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
-/**
- * Runs iterator over provided sorted array elements in series
- *
- * @param {array|object} list - array or object (named list) to iterate over
- * @param {function} iterator - iterator to run
- * @param {function} sortMethod - custom sort function
- * @param {function} callback - invoked when all elements processed
- * @returns {function} - jobs terminator
- */
-function serialOrdered(list, iterator, sortMethod, callback)
-{
- var state = initState(list, sortMethod);
+"use strict";
- iterate(list, iterator, state, function iteratorHandler(error, result)
- {
- if (error)
- {
- callback(error, result);
- return;
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ var desc = Object.getOwnPropertyDescriptor(m, k);
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+ desc = { enumerable: true, get: function() { return m[k]; } };
}
-
- state.index++;
-
- // are we there yet?
- if (state.index < (state['keyedList'] || list).length)
- {
- iterate(list, iterator, state, iteratorHandler);
- return;
+ Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+ o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+ if (mod && mod.__esModule) return mod;
+ var result = {};
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+ __setModuleDefault(result, mod);
+ return result;
+};
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.Agent = void 0;
+const net = __importStar(__nccwpck_require__(1808));
+const http = __importStar(__nccwpck_require__(3685));
+const https_1 = __nccwpck_require__(5687);
+__exportStar(__nccwpck_require__(8348), exports);
+const INTERNAL = Symbol('AgentBaseInternalState');
+class Agent extends http.Agent {
+ constructor(opts) {
+ super(opts);
+ this[INTERNAL] = {};
+ }
+ /**
+ * Determine whether this is an `http` or `https` request.
+ */
+ isSecureEndpoint(options) {
+ if (options) {
+ // First check the `secureEndpoint` property explicitly, since this
+ // means that a parent `Agent` is "passing through" to this instance.
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
+ if (typeof options.secureEndpoint === 'boolean') {
+ return options.secureEndpoint;
+ }
+ // If no explicit `secure` endpoint, check if `protocol` property is
+ // set. This will usually be the case since using a full string URL
+ // or `URL` instance should be the most common usage.
+ if (typeof options.protocol === 'string') {
+ return options.protocol === 'https:';
+ }
+ }
+ // Finally, if no `protocol` property was set, then fall back to
+ // checking the stack trace of the current call stack, and try to
+ // detect the "https" module.
+ const { stack } = new Error();
+ if (typeof stack !== 'string')
+ return false;
+ return stack
+ .split('\n')
+ .some((l) => l.indexOf('(https.js:') !== -1 ||
+ l.indexOf('node:https:') !== -1);
+ }
+ // In order to support async signatures in `connect()` and Node's native
+ // connection pooling in `http.Agent`, the array of sockets for each origin
+ // has to be updated synchronously. This is so the length of the array is
+ // accurate when `addRequest()` is next called. We achieve this by creating a
+ // fake socket and adding it to `sockets[origin]` and incrementing
+ // `totalSocketCount`.
+ incrementSockets(name) {
+ // If `maxSockets` and `maxTotalSockets` are both Infinity then there is no
+ // need to create a fake socket because Node.js native connection pooling
+ // will never be invoked.
+ if (this.maxSockets === Infinity && this.maxTotalSockets === Infinity) {
+ return null;
+ }
+ // All instances of `sockets` are expected TypeScript errors. The
+ // alternative is to add it as a private property of this class but that
+ // will break TypeScript subclassing.
+ if (!this.sockets[name]) {
+ // @ts-expect-error `sockets` is readonly in `@types/node`
+ this.sockets[name] = [];
+ }
+ const fakeSocket = new net.Socket({ writable: false });
+ this.sockets[name].push(fakeSocket);
+ // @ts-expect-error `totalSocketCount` isn't defined in `@types/node`
+ this.totalSocketCount++;
+ return fakeSocket;
+ }
+ decrementSockets(name, socket) {
+ if (!this.sockets[name] || socket === null) {
+ return;
+ }
+ const sockets = this.sockets[name];
+ const index = sockets.indexOf(socket);
+ if (index !== -1) {
+ sockets.splice(index, 1);
+ // @ts-expect-error `totalSocketCount` isn't defined in `@types/node`
+ this.totalSocketCount--;
+ if (sockets.length === 0) {
+ // @ts-expect-error `sockets` is readonly in `@types/node`
+ delete this.sockets[name];
+ }
+ }
+ }
+ // In order to properly update the socket pool, we need to call `getName()` on
+ // the core `https.Agent` if it is a secureEndpoint.
+ getName(options) {
+ const secureEndpoint = typeof options.secureEndpoint === 'boolean'
+ ? options.secureEndpoint
+ : this.isSecureEndpoint(options);
+ if (secureEndpoint) {
+ // @ts-expect-error `getName()` isn't defined in `@types/node`
+ return https_1.Agent.prototype.getName.call(this, options);
+ }
+ // @ts-expect-error `getName()` isn't defined in `@types/node`
+ return super.getName(options);
+ }
+ createSocket(req, options, cb) {
+ const connectOpts = {
+ ...options,
+ secureEndpoint: this.isSecureEndpoint(options),
+ };
+ const name = this.getName(connectOpts);
+ const fakeSocket = this.incrementSockets(name);
+ Promise.resolve()
+ .then(() => this.connect(req, connectOpts))
+ .then((socket) => {
+ this.decrementSockets(name, fakeSocket);
+ if (socket instanceof http.Agent) {
+ // @ts-expect-error `addRequest()` isn't defined in `@types/node`
+ return socket.addRequest(req, connectOpts);
+ }
+ this[INTERNAL].currentSocket = socket;
+ // @ts-expect-error `createSocket()` isn't defined in `@types/node`
+ super.createSocket(req, options, cb);
+ }, (err) => {
+ this.decrementSockets(name, fakeSocket);
+ cb(err);
+ });
+ }
+ createConnection() {
+ const socket = this[INTERNAL].currentSocket;
+ this[INTERNAL].currentSocket = undefined;
+ if (!socket) {
+ throw new Error('No socket was returned in the `connect()` function');
+ }
+ return socket;
+ }
+ get defaultPort() {
+ return (this[INTERNAL].defaultPort ??
+ (this.protocol === 'https:' ? 443 : 80));
+ }
+ set defaultPort(v) {
+ if (this[INTERNAL]) {
+ this[INTERNAL].defaultPort = v;
+ }
+ }
+ get protocol() {
+ return (this[INTERNAL].protocol ??
+ (this.isSecureEndpoint() ? 'https:' : 'http:'));
+ }
+ set protocol(v) {
+ if (this[INTERNAL]) {
+ this[INTERNAL].protocol = v;
+ }
}
-
- // done here
- callback(null, state.results);
- });
-
- return terminator.bind(state, callback);
-}
-
-/*
- * -- Sort methods
- */
-
-/**
- * sort helper to sort array elements in ascending order
- *
- * @param {mixed} a - an item to compare
- * @param {mixed} b - an item to compare
- * @returns {number} - comparison result
- */
-function ascending(a, b)
-{
- return a < b ? -1 : a > b ? 1 : 0;
-}
-
-/**
- * sort helper to sort array elements in descending order
- *
- * @param {mixed} a - an item to compare
- * @param {mixed} b - an item to compare
- * @returns {number} - comparison result
- */
-function descending(a, b)
-{
- return -1 * ascending(a, b);
}
-
+exports.Agent = Agent;
+//# sourceMappingURL=index.js.map
/***/ }),
@@ -45827,221 +33969,6 @@ function expand(str, isTop) {
-/***/ }),
-
-/***/ 5443:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-var util = __nccwpck_require__(3837);
-var Stream = (__nccwpck_require__(2781).Stream);
-var DelayedStream = __nccwpck_require__(8611);
-
-module.exports = CombinedStream;
-function CombinedStream() {
- this.writable = false;
- this.readable = true;
- this.dataSize = 0;
- this.maxDataSize = 2 * 1024 * 1024;
- this.pauseStreams = true;
-
- this._released = false;
- this._streams = [];
- this._currentStream = null;
- this._insideLoop = false;
- this._pendingNext = false;
-}
-util.inherits(CombinedStream, Stream);
-
-CombinedStream.create = function(options) {
- var combinedStream = new this();
-
- options = options || {};
- for (var option in options) {
- combinedStream[option] = options[option];
- }
-
- return combinedStream;
-};
-
-CombinedStream.isStreamLike = function(stream) {
- return (typeof stream !== 'function')
- && (typeof stream !== 'string')
- && (typeof stream !== 'boolean')
- && (typeof stream !== 'number')
- && (!Buffer.isBuffer(stream));
-};
-
-CombinedStream.prototype.append = function(stream) {
- var isStreamLike = CombinedStream.isStreamLike(stream);
-
- if (isStreamLike) {
- if (!(stream instanceof DelayedStream)) {
- var newStream = DelayedStream.create(stream, {
- maxDataSize: Infinity,
- pauseStream: this.pauseStreams,
- });
- stream.on('data', this._checkDataSize.bind(this));
- stream = newStream;
- }
-
- this._handleErrors(stream);
-
- if (this.pauseStreams) {
- stream.pause();
- }
- }
-
- this._streams.push(stream);
- return this;
-};
-
-CombinedStream.prototype.pipe = function(dest, options) {
- Stream.prototype.pipe.call(this, dest, options);
- this.resume();
- return dest;
-};
-
-CombinedStream.prototype._getNext = function() {
- this._currentStream = null;
-
- if (this._insideLoop) {
- this._pendingNext = true;
- return; // defer call
- }
-
- this._insideLoop = true;
- try {
- do {
- this._pendingNext = false;
- this._realGetNext();
- } while (this._pendingNext);
- } finally {
- this._insideLoop = false;
- }
-};
-
-CombinedStream.prototype._realGetNext = function() {
- var stream = this._streams.shift();
-
-
- if (typeof stream == 'undefined') {
- this.end();
- return;
- }
-
- if (typeof stream !== 'function') {
- this._pipeNext(stream);
- return;
- }
-
- var getStream = stream;
- getStream(function(stream) {
- var isStreamLike = CombinedStream.isStreamLike(stream);
- if (isStreamLike) {
- stream.on('data', this._checkDataSize.bind(this));
- this._handleErrors(stream);
- }
-
- this._pipeNext(stream);
- }.bind(this));
-};
-
-CombinedStream.prototype._pipeNext = function(stream) {
- this._currentStream = stream;
-
- var isStreamLike = CombinedStream.isStreamLike(stream);
- if (isStreamLike) {
- stream.on('end', this._getNext.bind(this));
- stream.pipe(this, {end: false});
- return;
- }
-
- var value = stream;
- this.write(value);
- this._getNext();
-};
-
-CombinedStream.prototype._handleErrors = function(stream) {
- var self = this;
- stream.on('error', function(err) {
- self._emitError(err);
- });
-};
-
-CombinedStream.prototype.write = function(data) {
- this.emit('data', data);
-};
-
-CombinedStream.prototype.pause = function() {
- if (!this.pauseStreams) {
- return;
- }
-
- if(this.pauseStreams && this._currentStream && typeof(this._currentStream.pause) == 'function') this._currentStream.pause();
- this.emit('pause');
-};
-
-CombinedStream.prototype.resume = function() {
- if (!this._released) {
- this._released = true;
- this.writable = true;
- this._getNext();
- }
-
- if(this.pauseStreams && this._currentStream && typeof(this._currentStream.resume) == 'function') this._currentStream.resume();
- this.emit('resume');
-};
-
-CombinedStream.prototype.end = function() {
- this._reset();
- this.emit('end');
-};
-
-CombinedStream.prototype.destroy = function() {
- this._reset();
- this.emit('close');
-};
-
-CombinedStream.prototype._reset = function() {
- this.writable = false;
- this._streams = [];
- this._currentStream = null;
-};
-
-CombinedStream.prototype._checkDataSize = function() {
- this._updateDataSize();
- if (this.dataSize <= this.maxDataSize) {
- return;
- }
-
- var message =
- 'DelayedStream#maxDataSize of ' + this.maxDataSize + ' bytes exceeded.';
- this._emitError(new Error(message));
-};
-
-CombinedStream.prototype._updateDataSize = function() {
- this.dataSize = 0;
-
- var self = this;
- this._streams.forEach(function(stream) {
- if (!stream.dataSize) {
- return;
- }
-
- self.dataSize += stream.dataSize;
- });
-
- if (this._currentStream && this._currentStream.dataSize) {
- this.dataSize += this._currentStream.dataSize;
- }
-};
-
-CombinedStream.prototype._emitError = function(err) {
- this._reset();
- this.emit('error', err);
-};
-
-
/***/ }),
/***/ 6891:
@@ -46064,4863 +33991,4708 @@ var isArray = Array.isArray || function (xs) {
/***/ }),
-/***/ 8611:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-
-var Stream = (__nccwpck_require__(2781).Stream);
-var util = __nccwpck_require__(3837);
-
-module.exports = DelayedStream;
-function DelayedStream() {
- this.source = null;
- this.dataSize = 0;
- this.maxDataSize = 1024 * 1024;
- this.pauseStream = true;
-
- this._maxDataSizeExceeded = false;
- this._released = false;
- this._bufferedEvents = [];
-}
-util.inherits(DelayedStream, Stream);
-
-DelayedStream.create = function(source, options) {
- var delayedStream = new this();
-
- options = options || {};
- for (var option in options) {
- delayedStream[option] = options[option];
- }
-
- delayedStream.source = source;
-
- var realEmit = source.emit;
- source.emit = function() {
- delayedStream._handleEmit(arguments);
- return realEmit.apply(source, arguments);
- };
-
- source.on('error', function() {});
- if (delayedStream.pauseStream) {
- source.pause();
- }
-
- return delayedStream;
-};
-
-Object.defineProperty(DelayedStream.prototype, 'readable', {
- configurable: true,
- enumerable: true,
- get: function() {
- return this.source.readable;
- }
-});
-
-DelayedStream.prototype.setEncoding = function() {
- return this.source.setEncoding.apply(this.source, arguments);
-};
-
-DelayedStream.prototype.resume = function() {
- if (!this._released) {
- this.release();
- }
-
- this.source.resume();
-};
-
-DelayedStream.prototype.pause = function() {
- this.source.pause();
-};
-
-DelayedStream.prototype.release = function() {
- this._released = true;
-
- this._bufferedEvents.forEach(function(args) {
- this.emit.apply(this, args);
- }.bind(this));
- this._bufferedEvents = [];
-};
-
-DelayedStream.prototype.pipe = function() {
- var r = Stream.prototype.pipe.apply(this, arguments);
- this.resume();
- return r;
-};
-
-DelayedStream.prototype._handleEmit = function(args) {
- if (this._released) {
- this.emit.apply(this, args);
- return;
- }
-
- if (args[0] === 'data') {
- this.dataSize += args[1].length;
- this._checkIfMaxDataSizeExceeded();
- }
-
- this._bufferedEvents.push(args);
-};
-
-DelayedStream.prototype._checkIfMaxDataSizeExceeded = function() {
- if (this._maxDataSizeExceeded) {
- return;
- }
-
- if (this.dataSize <= this.maxDataSize) {
- return;
- }
-
- this._maxDataSizeExceeded = true;
- var message =
- 'DelayedStream#maxDataSize of ' + this.maxDataSize + ' bytes exceeded.'
- this.emit('error', new Error(message));
-};
-
-
-/***/ }),
-
-/***/ 7426:
-/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+/***/ 8222:
+/***/ ((module, exports, __nccwpck_require__) => {
-/*!
- * mime-db
- * Copyright(c) 2014 Jonathan Ong
- * Copyright(c) 2015-2022 Douglas Christopher Wilson
- * MIT Licensed
- */
+/* eslint-env browser */
/**
- * Module exports.
- */
-
-module.exports = __nccwpck_require__(3765)
-
-
-/***/ }),
-
-/***/ 3583:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
-
-"use strict";
-/*!
- * mime-types
- * Copyright(c) 2014 Jonathan Ong
- * Copyright(c) 2015 Douglas Christopher Wilson
- * MIT Licensed
+ * This is the web browser implementation of `debug()`.
*/
+exports.formatArgs = formatArgs;
+exports.save = save;
+exports.load = load;
+exports.useColors = useColors;
+exports.storage = localstorage();
+exports.destroy = (() => {
+ let warned = false;
+ return () => {
+ if (!warned) {
+ warned = true;
+ console.warn('Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.');
+ }
+ };
+})();
+
+/**
+ * Colors.
+ */
+
+exports.colors = [
+ '#0000CC',
+ '#0000FF',
+ '#0033CC',
+ '#0033FF',
+ '#0066CC',
+ '#0066FF',
+ '#0099CC',
+ '#0099FF',
+ '#00CC00',
+ '#00CC33',
+ '#00CC66',
+ '#00CC99',
+ '#00CCCC',
+ '#00CCFF',
+ '#3300CC',
+ '#3300FF',
+ '#3333CC',
+ '#3333FF',
+ '#3366CC',
+ '#3366FF',
+ '#3399CC',
+ '#3399FF',
+ '#33CC00',
+ '#33CC33',
+ '#33CC66',
+ '#33CC99',
+ '#33CCCC',
+ '#33CCFF',
+ '#6600CC',
+ '#6600FF',
+ '#6633CC',
+ '#6633FF',
+ '#66CC00',
+ '#66CC33',
+ '#9900CC',
+ '#9900FF',
+ '#9933CC',
+ '#9933FF',
+ '#99CC00',
+ '#99CC33',
+ '#CC0000',
+ '#CC0033',
+ '#CC0066',
+ '#CC0099',
+ '#CC00CC',
+ '#CC00FF',
+ '#CC3300',
+ '#CC3333',
+ '#CC3366',
+ '#CC3399',
+ '#CC33CC',
+ '#CC33FF',
+ '#CC6600',
+ '#CC6633',
+ '#CC9900',
+ '#CC9933',
+ '#CCCC00',
+ '#CCCC33',
+ '#FF0000',
+ '#FF0033',
+ '#FF0066',
+ '#FF0099',
+ '#FF00CC',
+ '#FF00FF',
+ '#FF3300',
+ '#FF3333',
+ '#FF3366',
+ '#FF3399',
+ '#FF33CC',
+ '#FF33FF',
+ '#FF6600',
+ '#FF6633',
+ '#FF9900',
+ '#FF9933',
+ '#FFCC00',
+ '#FFCC33'
+];
/**
- * Module dependencies.
- * @private
- */
-
-var db = __nccwpck_require__(7426)
-var extname = (__nccwpck_require__(1017).extname)
-
-/**
- * Module variables.
- * @private
+ * Currently only WebKit-based Web Inspectors, Firefox >= v31,
+ * and the Firebug extension (any Firefox version) are known
+ * to support "%c" CSS customizations.
+ *
+ * TODO: add a `localStorage` variable to explicitly enable/disable colors
*/
-var EXTRACT_TYPE_REGEXP = /^\s*([^;\s]*)(?:;|\s|$)/
-var TEXT_TYPE_REGEXP = /^text\//i
+// eslint-disable-next-line complexity
+function useColors() {
+ // NB: In an Electron preload script, document will be defined but not fully
+ // initialized. Since we know we're in Chrome, we'll just detect this case
+ // explicitly
+ if (typeof window !== 'undefined' && window.process && (window.process.type === 'renderer' || window.process.__nwjs)) {
+ return true;
+ }
-/**
- * Module exports.
- * @public
- */
+ // Internet Explorer and Edge do not support colors.
+ if (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/(edge|trident)\/(\d+)/)) {
+ return false;
+ }
-exports.charset = charset
-exports.charsets = { lookup: charset }
-exports.contentType = contentType
-exports.extension = extension
-exports.extensions = Object.create(null)
-exports.lookup = lookup
-exports.types = Object.create(null)
+ let m;
-// Populate the extensions/types maps
-populateMaps(exports.extensions, exports.types)
+ // Is webkit? http://stackoverflow.com/a/16459606/376773
+ // document is undefined in react-native: https://github.com/facebook/react-native/pull/1632
+ return (typeof document !== 'undefined' && document.documentElement && document.documentElement.style && document.documentElement.style.WebkitAppearance) ||
+ // Is firebug? http://stackoverflow.com/a/398120/376773
+ (typeof window !== 'undefined' && window.console && (window.console.firebug || (window.console.exception && window.console.table))) ||
+ // Is firefox >= v31?
+ // https://developer.mozilla.org/en-US/docs/Tools/Web_Console#Styling_messages
+ (typeof navigator !== 'undefined' && navigator.userAgent && (m = navigator.userAgent.toLowerCase().match(/firefox\/(\d+)/)) && parseInt(m[1], 10) >= 31) ||
+ // Double check webkit in userAgent just in case we are in a worker
+ (typeof navigator !== 'undefined' && navigator.userAgent && navigator.userAgent.toLowerCase().match(/applewebkit\/(\d+)/));
+}
/**
- * Get the default charset for a MIME type.
+ * Colorize log arguments if enabled.
*
- * @param {string} type
- * @return {boolean|string}
+ * @api public
*/
-function charset (type) {
- if (!type || typeof type !== 'string') {
- return false
- }
+function formatArgs(args) {
+ args[0] = (this.useColors ? '%c' : '') +
+ this.namespace +
+ (this.useColors ? ' %c' : ' ') +
+ args[0] +
+ (this.useColors ? '%c ' : ' ') +
+ '+' + module.exports.humanize(this.diff);
- // TODO: use media-typer
- var match = EXTRACT_TYPE_REGEXP.exec(type)
- var mime = match && db[match[1].toLowerCase()]
+ if (!this.useColors) {
+ return;
+ }
- if (mime && mime.charset) {
- return mime.charset
- }
+ const c = 'color: ' + this.color;
+ args.splice(1, 0, c, 'color: inherit');
- // default text/* to utf-8
- if (match && TEXT_TYPE_REGEXP.test(match[1])) {
- return 'UTF-8'
- }
+ // The final "%c" is somewhat tricky, because there could be other
+ // arguments passed either before or after the %c, so we need to
+ // figure out the correct index to insert the CSS into
+ let index = 0;
+ let lastC = 0;
+ args[0].replace(/%[a-zA-Z%]/g, match => {
+ if (match === '%%') {
+ return;
+ }
+ index++;
+ if (match === '%c') {
+ // We only are interested in the *last* %c
+ // (the user may have provided their own)
+ lastC = index;
+ }
+ });
- return false
+ args.splice(lastC, 0, c);
}
/**
- * Create a full Content-Type header given a MIME type or extension.
+ * Invokes `console.debug()` when available.
+ * No-op when `console.debug` is not a "function".
+ * If `console.debug` is not available, falls back
+ * to `console.log`.
*
- * @param {string} str
- * @return {boolean|string}
+ * @api public
*/
-
-function contentType (str) {
- // TODO: should this even be in this module?
- if (!str || typeof str !== 'string') {
- return false
- }
-
- var mime = str.indexOf('/') === -1
- ? exports.lookup(str)
- : str
-
- if (!mime) {
- return false
- }
-
- // TODO: use content-type or other module
- if (mime.indexOf('charset') === -1) {
- var charset = exports.charset(mime)
- if (charset) mime += '; charset=' + charset.toLowerCase()
- }
-
- return mime
-}
+exports.log = console.debug || console.log || (() => {});
/**
- * Get the default extension for a MIME type.
+ * Save `namespaces`.
*
- * @param {string} type
- * @return {boolean|string}
+ * @param {String} namespaces
+ * @api private
*/
-
-function extension (type) {
- if (!type || typeof type !== 'string') {
- return false
- }
-
- // TODO: use media-typer
- var match = EXTRACT_TYPE_REGEXP.exec(type)
-
- // get extensions
- var exts = match && exports.extensions[match[1].toLowerCase()]
-
- if (!exts || !exts.length) {
- return false
- }
-
- return exts[0]
+function save(namespaces) {
+ try {
+ if (namespaces) {
+ exports.storage.setItem('debug', namespaces);
+ } else {
+ exports.storage.removeItem('debug');
+ }
+ } catch (error) {
+ // Swallow
+ // XXX (@Qix-) should we be logging these?
+ }
}
/**
- * Lookup the MIME type for a file path/extension.
+ * Load `namespaces`.
*
- * @param {string} path
- * @return {boolean|string}
- */
-
-function lookup (path) {
- if (!path || typeof path !== 'string') {
- return false
- }
-
- // get the extension ("ext" or ".ext" or full path)
- var extension = extname('x.' + path)
- .toLowerCase()
- .substr(1)
+ * @return {String} returns the previously persisted debug modes
+ * @api private
+ */
+function load() {
+ let r;
+ try {
+ r = exports.storage.getItem('debug');
+ } catch (error) {
+ // Swallow
+ // XXX (@Qix-) should we be logging these?
+ }
- if (!extension) {
- return false
- }
+ // If debug isn't set in LS, and we're in Electron, try to load $DEBUG
+ if (!r && typeof process !== 'undefined' && 'env' in process) {
+ r = process.env.DEBUG;
+ }
- return exports.types[extension] || false
+ return r;
}
/**
- * Populate the extensions and types maps.
- * @private
- */
-
-function populateMaps (extensions, types) {
- // source preference (least -> most)
- var preference = ['nginx', 'apache', undefined, 'iana']
-
- Object.keys(db).forEach(function forEachMimeType (type) {
- var mime = db[type]
- var exts = mime.extensions
-
- if (!exts || !exts.length) {
- return
- }
-
- // mime -> extensions
- extensions[type] = exts
+ * Localstorage attempts to return the localstorage.
+ *
+ * This is necessary because safari throws
+ * when a user disables cookies/localstorage
+ * and you attempt to access it.
+ *
+ * @return {LocalStorage}
+ * @api private
+ */
+
+function localstorage() {
+ try {
+ // TVMLKit (Apple TV JS Runtime) does not have a window object, just localStorage in the global context
+ // The Browser also has localStorage in the global context.
+ return localStorage;
+ } catch (error) {
+ // Swallow
+ // XXX (@Qix-) should we be logging these?
+ }
+}
- // extension -> mime
- for (var i = 0; i < exts.length; i++) {
- var extension = exts[i]
+module.exports = __nccwpck_require__(6243)(exports);
- if (types[extension]) {
- var from = preference.indexOf(db[types[extension]].source)
- var to = preference.indexOf(mime.source)
+const {formatters} = module.exports;
- if (types[extension] !== 'application/octet-stream' &&
- (from > to || (from === to && types[extension].substr(0, 12) === 'application/'))) {
- // skip the remapping
- continue
- }
- }
+/**
+ * Map %j to `JSON.stringify()`, since no Web Inspectors do that by default.
+ */
- // set the extension -> mime
- types[extension] = type
- }
- })
-}
+formatters.j = function (v) {
+ try {
+ return JSON.stringify(v);
+ } catch (error) {
+ return '[UnexpectedJSONParseError]: ' + error.message;
+ }
+};
/***/ }),
-/***/ 3973:
+/***/ 6243:
/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-module.exports = minimatch
-minimatch.Minimatch = Minimatch
-
-var path = (function () { try { return __nccwpck_require__(1017) } catch (e) {}}()) || {
- sep: '/'
-}
-minimatch.sep = path.sep
-
-var GLOBSTAR = minimatch.GLOBSTAR = Minimatch.GLOBSTAR = {}
-var expand = __nccwpck_require__(3717)
-
-var plTypes = {
- '!': { open: '(?:(?!(?:', close: '))[^/]*?)'},
- '?': { open: '(?:', close: ')?' },
- '+': { open: '(?:', close: ')+' },
- '*': { open: '(?:', close: ')*' },
- '@': { open: '(?:', close: ')' }
-}
-
-// any single thing other than /
-// don't need to escape / when using new RegExp()
-var qmark = '[^/]'
-
-// * => any number of characters
-var star = qmark + '*?'
-
-// ** when dots are allowed. Anything goes, except .. and .
-// not (^ or / followed by one or two dots followed by $ or /),
-// followed by anything, any number of times.
-var twoStarDot = '(?:(?!(?:\\\/|^)(?:\\.{1,2})($|\\\/)).)*?'
-
-// not a ^ or / followed by a dot,
-// followed by anything, any number of times.
-var twoStarNoDot = '(?:(?!(?:\\\/|^)\\.).)*?'
-// characters that need to be escaped in RegExp.
-var reSpecials = charSet('().*{}+?[]^$\\!')
+/**
+ * This is the common logic for both the Node.js and web browser
+ * implementations of `debug()`.
+ */
-// "abc" -> { a:true, b:true, c:true }
-function charSet (s) {
- return s.split('').reduce(function (set, c) {
- set[c] = true
- return set
- }, {})
-}
+function setup(env) {
+ createDebug.debug = createDebug;
+ createDebug.default = createDebug;
+ createDebug.coerce = coerce;
+ createDebug.disable = disable;
+ createDebug.enable = enable;
+ createDebug.enabled = enabled;
+ createDebug.humanize = __nccwpck_require__(900);
+ createDebug.destroy = destroy;
-// normalizes slashes.
-var slashSplit = /\/+/
+ Object.keys(env).forEach(key => {
+ createDebug[key] = env[key];
+ });
-minimatch.filter = filter
-function filter (pattern, options) {
- options = options || {}
- return function (p, i, list) {
- return minimatch(p, pattern, options)
- }
-}
+ /**
+ * The currently active debug mode names, and names to skip.
+ */
-function ext (a, b) {
- b = b || {}
- var t = {}
- Object.keys(a).forEach(function (k) {
- t[k] = a[k]
- })
- Object.keys(b).forEach(function (k) {
- t[k] = b[k]
- })
- return t
-}
+ createDebug.names = [];
+ createDebug.skips = [];
-minimatch.defaults = function (def) {
- if (!def || typeof def !== 'object' || !Object.keys(def).length) {
- return minimatch
- }
+ /**
+ * Map of special "%n" handling functions, for the debug "format" argument.
+ *
+ * Valid key names are a single, lower or upper-case letter, i.e. "n" and "N".
+ */
+ createDebug.formatters = {};
- var orig = minimatch
+ /**
+ * Selects a color for a debug namespace
+ * @param {String} namespace The namespace string for the debug instance to be colored
+ * @return {Number|String} An ANSI color code for the given namespace
+ * @api private
+ */
+ function selectColor(namespace) {
+ let hash = 0;
+
+ for (let i = 0; i < namespace.length; i++) {
+ hash = ((hash << 5) - hash) + namespace.charCodeAt(i);
+ hash |= 0; // Convert to 32bit integer
+ }
- var m = function minimatch (p, pattern, options) {
- return orig(p, pattern, ext(def, options))
- }
+ return createDebug.colors[Math.abs(hash) % createDebug.colors.length];
+ }
+ createDebug.selectColor = selectColor;
- m.Minimatch = function Minimatch (pattern, options) {
- return new orig.Minimatch(pattern, ext(def, options))
- }
- m.Minimatch.defaults = function defaults (options) {
- return orig.defaults(ext(def, options)).Minimatch
- }
+ /**
+ * Create a debugger with the given `namespace`.
+ *
+ * @param {String} namespace
+ * @return {Function}
+ * @api public
+ */
+ function createDebug(namespace) {
+ let prevTime;
+ let enableOverride = null;
+ let namespacesCache;
+ let enabledCache;
+
+ function debug(...args) {
+ // Disabled?
+ if (!debug.enabled) {
+ return;
+ }
- m.filter = function filter (pattern, options) {
- return orig.filter(pattern, ext(def, options))
- }
+ const self = debug;
- m.defaults = function defaults (options) {
- return orig.defaults(ext(def, options))
- }
+ // Set `diff` timestamp
+ const curr = Number(new Date());
+ const ms = curr - (prevTime || curr);
+ self.diff = ms;
+ self.prev = prevTime;
+ self.curr = curr;
+ prevTime = curr;
- m.makeRe = function makeRe (pattern, options) {
- return orig.makeRe(pattern, ext(def, options))
- }
+ args[0] = createDebug.coerce(args[0]);
- m.braceExpand = function braceExpand (pattern, options) {
- return orig.braceExpand(pattern, ext(def, options))
- }
+ if (typeof args[0] !== 'string') {
+ // Anything else let's inspect with %O
+ args.unshift('%O');
+ }
- m.match = function (list, pattern, options) {
- return orig.match(list, pattern, ext(def, options))
- }
+ // Apply any `formatters` transformations
+ let index = 0;
+ args[0] = args[0].replace(/%([a-zA-Z%])/g, (match, format) => {
+ // If we encounter an escaped % then don't increase the array index
+ if (match === '%%') {
+ return '%';
+ }
+ index++;
+ const formatter = createDebug.formatters[format];
+ if (typeof formatter === 'function') {
+ const val = args[index];
+ match = formatter.call(self, val);
+
+ // Now we need to remove `args[index]` since it's inlined in the `format`
+ args.splice(index, 1);
+ index--;
+ }
+ return match;
+ });
- return m
-}
+ // Apply env-specific formatting (colors, etc.)
+ createDebug.formatArgs.call(self, args);
-Minimatch.defaults = function (def) {
- return minimatch.defaults(def).Minimatch
-}
+ const logFn = self.log || createDebug.log;
+ logFn.apply(self, args);
+ }
-function minimatch (p, pattern, options) {
- assertValidPattern(pattern)
+ debug.namespace = namespace;
+ debug.useColors = createDebug.useColors();
+ debug.color = createDebug.selectColor(namespace);
+ debug.extend = extend;
+ debug.destroy = createDebug.destroy; // XXX Temporary. Will be removed in the next major release.
+
+ Object.defineProperty(debug, 'enabled', {
+ enumerable: true,
+ configurable: false,
+ get: () => {
+ if (enableOverride !== null) {
+ return enableOverride;
+ }
+ if (namespacesCache !== createDebug.namespaces) {
+ namespacesCache = createDebug.namespaces;
+ enabledCache = createDebug.enabled(namespace);
+ }
- if (!options) options = {}
+ return enabledCache;
+ },
+ set: v => {
+ enableOverride = v;
+ }
+ });
- // shortcut: comments match nothing.
- if (!options.nocomment && pattern.charAt(0) === '#') {
- return false
- }
+ // Env-specific initialization logic for debug instances
+ if (typeof createDebug.init === 'function') {
+ createDebug.init(debug);
+ }
- return new Minimatch(pattern, options).match(p)
-}
+ return debug;
+ }
-function Minimatch (pattern, options) {
- if (!(this instanceof Minimatch)) {
- return new Minimatch(pattern, options)
- }
+ function extend(namespace, delimiter) {
+ const newDebug = createDebug(this.namespace + (typeof delimiter === 'undefined' ? ':' : delimiter) + namespace);
+ newDebug.log = this.log;
+ return newDebug;
+ }
- assertValidPattern(pattern)
+ /**
+ * Enables a debug mode by namespaces. This can include modes
+ * separated by a colon and wildcards.
+ *
+ * @param {String} namespaces
+ * @api public
+ */
+ function enable(namespaces) {
+ createDebug.save(namespaces);
+ createDebug.namespaces = namespaces;
+
+ createDebug.names = [];
+ createDebug.skips = [];
+
+ let i;
+ const split = (typeof namespaces === 'string' ? namespaces : '').split(/[\s,]+/);
+ const len = split.length;
+
+ for (i = 0; i < len; i++) {
+ if (!split[i]) {
+ // ignore empty strings
+ continue;
+ }
- if (!options) options = {}
+ namespaces = split[i].replace(/\*/g, '.*?');
- pattern = pattern.trim()
+ if (namespaces[0] === '-') {
+ createDebug.skips.push(new RegExp('^' + namespaces.slice(1) + '$'));
+ } else {
+ createDebug.names.push(new RegExp('^' + namespaces + '$'));
+ }
+ }
+ }
- // windows support: need to use /, not \
- if (!options.allowWindowsEscape && path.sep !== '/') {
- pattern = pattern.split(path.sep).join('/')
- }
+ /**
+ * Disable debug output.
+ *
+ * @return {String} namespaces
+ * @api public
+ */
+ function disable() {
+ const namespaces = [
+ ...createDebug.names.map(toNamespace),
+ ...createDebug.skips.map(toNamespace).map(namespace => '-' + namespace)
+ ].join(',');
+ createDebug.enable('');
+ return namespaces;
+ }
- this.options = options
- this.set = []
- this.pattern = pattern
- this.regexp = null
- this.negate = false
- this.comment = false
- this.empty = false
- this.partial = !!options.partial
+ /**
+ * Returns true if the given mode name is enabled, false otherwise.
+ *
+ * @param {String} name
+ * @return {Boolean}
+ * @api public
+ */
+ function enabled(name) {
+ if (name[name.length - 1] === '*') {
+ return true;
+ }
- // make the set of regexps etc.
- this.make()
-}
+ let i;
+ let len;
-Minimatch.prototype.debug = function () {}
+ for (i = 0, len = createDebug.skips.length; i < len; i++) {
+ if (createDebug.skips[i].test(name)) {
+ return false;
+ }
+ }
-Minimatch.prototype.make = make
-function make () {
- var pattern = this.pattern
- var options = this.options
+ for (i = 0, len = createDebug.names.length; i < len; i++) {
+ if (createDebug.names[i].test(name)) {
+ return true;
+ }
+ }
- // empty patterns and comments match nothing.
- if (!options.nocomment && pattern.charAt(0) === '#') {
- this.comment = true
- return
- }
- if (!pattern) {
- this.empty = true
- return
- }
+ return false;
+ }
- // step 1: figure out negation, etc.
- this.parseNegate()
+ /**
+ * Convert regexp to namespace
+ *
+ * @param {RegExp} regxep
+ * @return {String} namespace
+ * @api private
+ */
+ function toNamespace(regexp) {
+ return regexp.toString()
+ .substring(2, regexp.toString().length - 2)
+ .replace(/\.\*\?$/, '*');
+ }
- // step 2: expand braces
- var set = this.globSet = this.braceExpand()
+ /**
+ * Coerce `val`.
+ *
+ * @param {Mixed} val
+ * @return {Mixed}
+ * @api private
+ */
+ function coerce(val) {
+ if (val instanceof Error) {
+ return val.stack || val.message;
+ }
+ return val;
+ }
- if (options.debug) this.debug = function debug() { console.error.apply(console, arguments) }
+ /**
+ * XXX DO NOT USE. This is a temporary stub function.
+ * XXX It WILL be removed in the next major release.
+ */
+ function destroy() {
+ console.warn('Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.');
+ }
- this.debug(this.pattern, set)
+ createDebug.enable(createDebug.load());
- // step 3: now we have a set, so turn each one into a series of path-portion
- // matching patterns.
- // These will be regexps, except in the case of "**", which is
- // set to the GLOBSTAR object for globstar behavior,
- // and will not contain any / characters
- set = this.globParts = set.map(function (s) {
- return s.split(slashSplit)
- })
+ return createDebug;
+}
- this.debug(this.pattern, set)
+module.exports = setup;
- // glob --> regexps
- set = set.map(function (s, si, set) {
- return s.map(this.parse, this)
- }, this)
- this.debug(this.pattern, set)
+/***/ }),
- // filter out everything that didn't compile properly.
- set = set.filter(function (s) {
- return s.indexOf(false) === -1
- })
+/***/ 8237:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
- this.debug(this.pattern, set)
+/**
+ * Detect Electron renderer / nwjs process, which is node, but we should
+ * treat as a browser.
+ */
- this.set = set
+if (typeof process === 'undefined' || process.type === 'renderer' || process.browser === true || process.__nwjs) {
+ module.exports = __nccwpck_require__(8222);
+} else {
+ module.exports = __nccwpck_require__(5332);
}
-Minimatch.prototype.parseNegate = parseNegate
-function parseNegate () {
- var pattern = this.pattern
- var negate = false
- var options = this.options
- var negateOffset = 0
-
- if (options.nonegate) return
- for (var i = 0, l = pattern.length
- ; i < l && pattern.charAt(i) === '!'
- ; i++) {
- negate = !negate
- negateOffset++
- }
+/***/ }),
- if (negateOffset) this.pattern = pattern.substr(negateOffset)
- this.negate = negate
-}
+/***/ 5332:
+/***/ ((module, exports, __nccwpck_require__) => {
-// Brace expansion:
-// a{b,c}d -> abd acd
-// a{b,}c -> abc ac
-// a{0..3}d -> a0d a1d a2d a3d
-// a{b,c{d,e}f}g -> abg acdfg acefg
-// a{b,c}d{e,f}g -> abdeg acdeg abdeg abdfg
-//
-// Invalid sets are not expanded.
-// a{2..}b -> a{2..}b
-// a{b}c -> a{b}c
-minimatch.braceExpand = function (pattern, options) {
- return braceExpand(pattern, options)
-}
+/**
+ * Module dependencies.
+ */
-Minimatch.prototype.braceExpand = braceExpand
+const tty = __nccwpck_require__(6224);
+const util = __nccwpck_require__(3837);
-function braceExpand (pattern, options) {
- if (!options) {
- if (this instanceof Minimatch) {
- options = this.options
- } else {
- options = {}
- }
- }
+/**
+ * This is the Node.js implementation of `debug()`.
+ */
- pattern = typeof pattern === 'undefined'
- ? this.pattern : pattern
+exports.init = init;
+exports.log = log;
+exports.formatArgs = formatArgs;
+exports.save = save;
+exports.load = load;
+exports.useColors = useColors;
+exports.destroy = util.deprecate(
+ () => {},
+ 'Instance method `debug.destroy()` is deprecated and no longer does anything. It will be removed in the next major version of `debug`.'
+);
- assertValidPattern(pattern)
+/**
+ * Colors.
+ */
- // Thanks to Yeting Li for
- // improving this regexp to avoid a ReDOS vulnerability.
- if (options.nobrace || !/\{(?:(?!\{).)*\}/.test(pattern)) {
- // shortcut. no need to expand.
- return [pattern]
- }
+exports.colors = [6, 2, 3, 4, 5, 1];
- return expand(pattern)
+try {
+ // Optional dependency (as in, doesn't need to be installed, NOT like optionalDependencies in package.json)
+ // eslint-disable-next-line import/no-extraneous-dependencies
+ const supportsColor = __nccwpck_require__(9318);
+
+ if (supportsColor && (supportsColor.stderr || supportsColor).level >= 2) {
+ exports.colors = [
+ 20,
+ 21,
+ 26,
+ 27,
+ 32,
+ 33,
+ 38,
+ 39,
+ 40,
+ 41,
+ 42,
+ 43,
+ 44,
+ 45,
+ 56,
+ 57,
+ 62,
+ 63,
+ 68,
+ 69,
+ 74,
+ 75,
+ 76,
+ 77,
+ 78,
+ 79,
+ 80,
+ 81,
+ 92,
+ 93,
+ 98,
+ 99,
+ 112,
+ 113,
+ 128,
+ 129,
+ 134,
+ 135,
+ 148,
+ 149,
+ 160,
+ 161,
+ 162,
+ 163,
+ 164,
+ 165,
+ 166,
+ 167,
+ 168,
+ 169,
+ 170,
+ 171,
+ 172,
+ 173,
+ 178,
+ 179,
+ 184,
+ 185,
+ 196,
+ 197,
+ 198,
+ 199,
+ 200,
+ 201,
+ 202,
+ 203,
+ 204,
+ 205,
+ 206,
+ 207,
+ 208,
+ 209,
+ 214,
+ 215,
+ 220,
+ 221
+ ];
+ }
+} catch (error) {
+ // Swallow - we only care if `supports-color` is available; it doesn't have to be.
}
-var MAX_PATTERN_LENGTH = 1024 * 64
-var assertValidPattern = function (pattern) {
- if (typeof pattern !== 'string') {
- throw new TypeError('invalid pattern')
- }
-
- if (pattern.length > MAX_PATTERN_LENGTH) {
- throw new TypeError('pattern is too long')
- }
-}
+/**
+ * Build up the default `inspectOpts` object from the environment variables.
+ *
+ * $ DEBUG_COLORS=no DEBUG_DEPTH=10 DEBUG_SHOW_HIDDEN=enabled node script.js
+ */
+
+exports.inspectOpts = Object.keys(process.env).filter(key => {
+ return /^debug_/i.test(key);
+}).reduce((obj, key) => {
+ // Camel-case
+ const prop = key
+ .substring(6)
+ .toLowerCase()
+ .replace(/_([a-z])/g, (_, k) => {
+ return k.toUpperCase();
+ });
-// parse a component of the expanded set.
-// At this point, no pattern may contain "/" in it
-// so we're going to return a 2d array, where each entry is the full
-// pattern, split on '/', and then turned into a regular expression.
-// A regexp is made at the end which joins each array with an
-// escaped /, and another full one which joins each regexp with |.
-//
-// Following the lead of Bash 4.1, note that "**" only has special meaning
-// when it is the *only* thing in a path portion. Otherwise, any series
-// of * is equivalent to a single *. Globstar behavior is enabled by
-// default, and can be disabled by setting options.noglobstar.
-Minimatch.prototype.parse = parse
-var SUBPARSE = {}
-function parse (pattern, isSub) {
- assertValidPattern(pattern)
+ // Coerce string value into JS value
+ let val = process.env[key];
+ if (/^(yes|on|true|enabled)$/i.test(val)) {
+ val = true;
+ } else if (/^(no|off|false|disabled)$/i.test(val)) {
+ val = false;
+ } else if (val === 'null') {
+ val = null;
+ } else {
+ val = Number(val);
+ }
- var options = this.options
+ obj[prop] = val;
+ return obj;
+}, {});
- // shortcuts
- if (pattern === '**') {
- if (!options.noglobstar)
- return GLOBSTAR
- else
- pattern = '*'
- }
- if (pattern === '') return ''
+/**
+ * Is stdout a TTY? Colored output is enabled when `true`.
+ */
- var re = ''
- var hasMagic = !!options.nocase
- var escaping = false
- // ? => one single character
- var patternListStack = []
- var negativeLists = []
- var stateChar
- var inClass = false
- var reClassStart = -1
- var classStart = -1
- // . and .. never match anything that doesn't start with .,
- // even when options.dot is set.
- var patternStart = pattern.charAt(0) === '.' ? '' // anything
- // not (start or / followed by . or .. followed by / or end)
- : options.dot ? '(?!(?:^|\\\/)\\.{1,2}(?:$|\\\/))'
- : '(?!\\.)'
- var self = this
+function useColors() {
+ return 'colors' in exports.inspectOpts ?
+ Boolean(exports.inspectOpts.colors) :
+ tty.isatty(process.stderr.fd);
+}
- function clearStateChar () {
- if (stateChar) {
- // we had some state-tracking character
- // that wasn't consumed by this pass.
- switch (stateChar) {
- case '*':
- re += star
- hasMagic = true
- break
- case '?':
- re += qmark
- hasMagic = true
- break
- default:
- re += '\\' + stateChar
- break
- }
- self.debug('clearStateChar %j %j', stateChar, re)
- stateChar = false
- }
- }
+/**
+ * Adds ANSI color escape codes if enabled.
+ *
+ * @api public
+ */
- for (var i = 0, len = pattern.length, c
- ; (i < len) && (c = pattern.charAt(i))
- ; i++) {
- this.debug('%s\t%s %s %j', pattern, i, re, c)
+function formatArgs(args) {
+ const {namespace: name, useColors} = this;
- // skip over any that are escaped.
- if (escaping && reSpecials[c]) {
- re += '\\' + c
- escaping = false
- continue
- }
+ if (useColors) {
+ const c = this.color;
+ const colorCode = '\u001B[3' + (c < 8 ? c : '8;5;' + c);
+ const prefix = ` ${colorCode};1m${name} \u001B[0m`;
- switch (c) {
- /* istanbul ignore next */
- case '/': {
- // completely not allowed, even escaped.
- // Should already be path-split by now.
- return false
- }
+ args[0] = prefix + args[0].split('\n').join('\n' + prefix);
+ args.push(colorCode + 'm+' + module.exports.humanize(this.diff) + '\u001B[0m');
+ } else {
+ args[0] = getDate() + name + ' ' + args[0];
+ }
+}
- case '\\':
- clearStateChar()
- escaping = true
- continue
+function getDate() {
+ if (exports.inspectOpts.hideDate) {
+ return '';
+ }
+ return new Date().toISOString() + ' ';
+}
- // the various stateChar values
- // for the "extglob" stuff.
- case '?':
- case '*':
- case '+':
- case '@':
- case '!':
- this.debug('%s\t%s %s %j <-- stateChar', pattern, i, re, c)
+/**
+ * Invokes `util.formatWithOptions()` with the specified arguments and writes to stderr.
+ */
- // all of those are literals inside a class, except that
- // the glob [!a] means [^a] in regexp
- if (inClass) {
- this.debug(' in class')
- if (c === '!' && i === classStart + 1) c = '^'
- re += c
- continue
- }
+function log(...args) {
+ return process.stderr.write(util.formatWithOptions(exports.inspectOpts, ...args) + '\n');
+}
- // if we already have a stateChar, then it means
- // that there was something like ** or +? in there.
- // Handle the stateChar, then proceed with this one.
- self.debug('call clearStateChar %j', stateChar)
- clearStateChar()
- stateChar = c
- // if extglob is disabled, then +(asdf|foo) isn't a thing.
- // just clear the statechar *now*, rather than even diving into
- // the patternList stuff.
- if (options.noext) clearStateChar()
- continue
+/**
+ * Save `namespaces`.
+ *
+ * @param {String} namespaces
+ * @api private
+ */
+function save(namespaces) {
+ if (namespaces) {
+ process.env.DEBUG = namespaces;
+ } else {
+ // If you set a process.env field to null or undefined, it gets cast to the
+ // string 'null' or 'undefined'. Just delete instead.
+ delete process.env.DEBUG;
+ }
+}
- case '(':
- if (inClass) {
- re += '('
- continue
- }
+/**
+ * Load `namespaces`.
+ *
+ * @return {String} returns the previously persisted debug modes
+ * @api private
+ */
- if (!stateChar) {
- re += '\\('
- continue
- }
+function load() {
+ return process.env.DEBUG;
+}
- patternListStack.push({
- type: stateChar,
- start: i - 1,
- reStart: re.length,
- open: plTypes[stateChar].open,
- close: plTypes[stateChar].close
- })
- // negation is (?:(?!js)[^/]*)
- re += stateChar === '!' ? '(?:(?!(?:' : '(?:'
- this.debug('plType %j %j', stateChar, re)
- stateChar = false
- continue
+/**
+ * Init logic for `debug` instances.
+ *
+ * Create a new `inspectOpts` object in case `useColors` is set
+ * differently for a particular `debug` instance.
+ */
- case ')':
- if (inClass || !patternListStack.length) {
- re += '\\)'
- continue
- }
+function init(debug) {
+ debug.inspectOpts = {};
- clearStateChar()
- hasMagic = true
- var pl = patternListStack.pop()
- // negation is (?:(?!js)[^/]*)
- // The others are (?:)
- re += pl.close
- if (pl.type === '!') {
- negativeLists.push(pl)
- }
- pl.reEnd = re.length
- continue
+ const keys = Object.keys(exports.inspectOpts);
+ for (let i = 0; i < keys.length; i++) {
+ debug.inspectOpts[keys[i]] = exports.inspectOpts[keys[i]];
+ }
+}
- case '|':
- if (inClass || !patternListStack.length || escaping) {
- re += '\\|'
- escaping = false
- continue
- }
+module.exports = __nccwpck_require__(6243)(exports);
- clearStateChar()
- re += '|'
- continue
+const {formatters} = module.exports;
- // these are mostly the same in regexp and glob
- case '[':
- // swallow any state-tracking char before the [
- clearStateChar()
+/**
+ * Map %o to `util.inspect()`, all on a single line.
+ */
- if (inClass) {
- re += '\\' + c
- continue
- }
+formatters.o = function (v) {
+ this.inspectOpts.colors = this.useColors;
+ return util.inspect(v, this.inspectOpts)
+ .split('\n')
+ .map(str => str.trim())
+ .join(' ');
+};
- inClass = true
- classStart = i
- reClassStart = re.length
- re += c
- continue
+/**
+ * Map %O to `util.inspect()`, allowing multiple lines if needed.
+ */
- case ']':
- // a right bracket shall lose its special
- // meaning and represent itself in
- // a bracket expression if it occurs
- // first in the list. -- POSIX.2 2.8.3.2
- if (i === classStart + 1 || !inClass) {
- re += '\\' + c
- escaping = false
- continue
- }
+formatters.O = function (v) {
+ this.inspectOpts.colors = this.useColors;
+ return util.inspect(v, this.inspectOpts);
+};
- // handle the case where we left a class open.
- // "[z-a]" is valid, equivalent to "\[z-a\]"
- // split where the last [ was, make sure we don't have
- // an invalid re. if so, re-walk the contents of the
- // would-be class to re-translate any characters that
- // were passed through as-is
- // TODO: It would probably be faster to determine this
- // without a try/catch and a new RegExp, but it's tricky
- // to do safely. For now, this is safe and works.
- var cs = pattern.substring(classStart + 1, i)
- try {
- RegExp('[' + cs + ']')
- } catch (er) {
- // not a valid class!
- var sp = this.parse(cs, SUBPARSE)
- re = re.substr(0, reClassStart) + '\\[' + sp[0] + '\\]'
- hasMagic = hasMagic || sp[1]
- inClass = false
- continue
- }
- // finish up the class.
- hasMagic = true
- inClass = false
- re += c
- continue
+/***/ }),
- default:
- // swallow any state char that wasn't consumed
- clearStateChar()
+/***/ 2603:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
- if (escaping) {
- // no need
- escaping = false
- } else if (reSpecials[c]
- && !(c === '^' && inClass)) {
- re += '\\'
- }
+"use strict";
- re += c
- } // switch
- } // for
+const validator = __nccwpck_require__(1739);
+const XMLParser = __nccwpck_require__(2380);
+const XMLBuilder = __nccwpck_require__(660);
- // handle the case where we left a class open.
- // "[abc" is valid, equivalent to "\[abc"
- if (inClass) {
- // split where the last [ was, and escape it
- // this is a huge pita. We now have to re-walk
- // the contents of the would-be class to re-translate
- // any characters that were passed through as-is
- cs = pattern.substr(classStart + 1)
- sp = this.parse(cs, SUBPARSE)
- re = re.substr(0, reClassStart) + '\\[' + sp[0]
- hasMagic = hasMagic || sp[1]
- }
+module.exports = {
+ XMLParser: XMLParser,
+ XMLValidator: validator,
+ XMLBuilder: XMLBuilder
+}
- // handle the case where we had a +( thing at the *end*
- // of the pattern.
- // each pattern list stack adds 3 chars, and we need to go through
- // and escape any | chars that were passed through as-is for the regexp.
- // Go through and escape them, taking care not to double-escape any
- // | chars that were already escaped.
- for (pl = patternListStack.pop(); pl; pl = patternListStack.pop()) {
- var tail = re.slice(pl.reStart + pl.open.length)
- this.debug('setting tail', re, pl)
- // maybe some even number of \, then maybe 1 \, followed by a |
- tail = tail.replace(/((?:\\{2}){0,64})(\\?)\|/g, function (_, $1, $2) {
- if (!$2) {
- // the | isn't already escaped, so escape it.
- $2 = '\\'
- }
+/***/ }),
- // need to escape all those slashes *again*, without escaping the
- // one that we need for escaping the | character. As it works out,
- // escaping an even number of slashes can be done by simply repeating
- // it exactly after itself. That's why this trick works.
- //
- // I am sorry that you have to see this.
- return $1 + $1 + $2 + '|'
- })
+/***/ 8280:
+/***/ ((__unused_webpack_module, exports) => {
- this.debug('tail=%j\n %s', tail, tail, pl, re)
- var t = pl.type === '*' ? star
- : pl.type === '?' ? qmark
- : '\\' + pl.type
+"use strict";
- hasMagic = true
- re = re.slice(0, pl.reStart) + t + '\\(' + tail
- }
- // handle trailing things that only matter at the very end.
- clearStateChar()
- if (escaping) {
- // trailing \\
- re += '\\\\'
- }
+const nameStartChar = ':A-Za-z_\\u00C0-\\u00D6\\u00D8-\\u00F6\\u00F8-\\u02FF\\u0370-\\u037D\\u037F-\\u1FFF\\u200C-\\u200D\\u2070-\\u218F\\u2C00-\\u2FEF\\u3001-\\uD7FF\\uF900-\\uFDCF\\uFDF0-\\uFFFD';
+const nameChar = nameStartChar + '\\-.\\d\\u00B7\\u0300-\\u036F\\u203F-\\u2040';
+const nameRegexp = '[' + nameStartChar + '][' + nameChar + ']*'
+const regexName = new RegExp('^' + nameRegexp + '$');
- // only need to apply the nodot start if the re starts with
- // something that could conceivably capture a dot
- var addPatternStart = false
- switch (re.charAt(0)) {
- case '[': case '.': case '(': addPatternStart = true
+const getAllMatches = function(string, regex) {
+ const matches = [];
+ let match = regex.exec(string);
+ while (match) {
+ const allmatches = [];
+ allmatches.startIndex = regex.lastIndex - match[0].length;
+ const len = match.length;
+ for (let index = 0; index < len; index++) {
+ allmatches.push(match[index]);
+ }
+ matches.push(allmatches);
+ match = regex.exec(string);
}
+ return matches;
+};
- // Hack to work around lack of negative lookbehind in JS
- // A pattern like: *.!(x).!(y|z) needs to ensure that a name
- // like 'a.xyz.yz' doesn't match. So, the first negative
- // lookahead, has to look ALL the way ahead, to the end of
- // the pattern.
- for (var n = negativeLists.length - 1; n > -1; n--) {
- var nl = negativeLists[n]
-
- var nlBefore = re.slice(0, nl.reStart)
- var nlFirst = re.slice(nl.reStart, nl.reEnd - 8)
- var nlLast = re.slice(nl.reEnd - 8, nl.reEnd)
- var nlAfter = re.slice(nl.reEnd)
+const isName = function(string) {
+ const match = regexName.exec(string);
+ return !(match === null || typeof match === 'undefined');
+};
- nlLast += nlAfter
+exports.isExist = function(v) {
+ return typeof v !== 'undefined';
+};
- // Handle nested stuff like *(*.js|!(*.json)), where open parens
- // mean that we should *not* include the ) in the bit that is considered
- // "after" the negated section.
- var openParensBefore = nlBefore.split('(').length - 1
- var cleanAfter = nlAfter
- for (i = 0; i < openParensBefore; i++) {
- cleanAfter = cleanAfter.replace(/\)[+*?]?/, '')
- }
- nlAfter = cleanAfter
+exports.isEmptyObject = function(obj) {
+ return Object.keys(obj).length === 0;
+};
- var dollar = ''
- if (nlAfter === '' && isSub !== SUBPARSE) {
- dollar = '$'
+/**
+ * Copy all the properties of a into b.
+ * @param {*} target
+ * @param {*} a
+ */
+exports.merge = function(target, a, arrayMode) {
+ if (a) {
+ const keys = Object.keys(a); // will return an array of own properties
+ const len = keys.length; //don't make it inline
+ for (let i = 0; i < len; i++) {
+ if (arrayMode === 'strict') {
+ target[keys[i]] = [ a[keys[i]] ];
+ } else {
+ target[keys[i]] = a[keys[i]];
+ }
}
- var newRe = nlBefore + nlFirst + nlAfter + dollar + nlLast
- re = newRe
}
+};
+/* exports.merge =function (b,a){
+ return Object.assign(b,a);
+} */
- // if the re is not "" at this point, then we need to make sure
- // it doesn't match against an empty path part.
- // Otherwise a/* will match a/, which it should not.
- if (re !== '' && hasMagic) {
- re = '(?=.)' + re
+exports.getValue = function(v) {
+ if (exports.isExist(v)) {
+ return v;
+ } else {
+ return '';
}
+};
- if (addPatternStart) {
- re = patternStart + re
- }
+// const fakeCall = function(a) {return a;};
+// const fakeCallNoReturn = function() {};
- // parsing just a piece of a larger pattern.
- if (isSub === SUBPARSE) {
- return [re, hasMagic]
- }
+exports.isName = isName;
+exports.getAllMatches = getAllMatches;
+exports.nameRegexp = nameRegexp;
- // skip the regexp for non-magical patterns
- // unescape anything in it, though, so that it'll be
- // an exact match against a file etc.
- if (!hasMagic) {
- return globUnescape(pattern)
- }
- var flags = options.nocase ? 'i' : ''
- try {
- var regExp = new RegExp('^' + re + '$', flags)
- } catch (er) /* istanbul ignore next - should be impossible */ {
- // If it was an invalid regular expression, then it can't match
- // anything. This trick looks for a character after the end of
- // the string, which is of course impossible, except in multi-line
- // mode, but it's not a /m regex.
- return new RegExp('$.')
- }
+/***/ }),
- regExp._glob = pattern
- regExp._src = re
+/***/ 1739:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
- return regExp
-}
+"use strict";
-minimatch.makeRe = function (pattern, options) {
- return new Minimatch(pattern, options || {}).makeRe()
-}
-Minimatch.prototype.makeRe = makeRe
-function makeRe () {
- if (this.regexp || this.regexp === false) return this.regexp
+const util = __nccwpck_require__(8280);
- // at this point, this.set is a 2d array of partial
- // pattern strings, or "**".
- //
- // It's better to use .match(). This function shouldn't
- // be used, really, but it's pretty convenient sometimes,
- // when you just want to work with a regex.
- var set = this.set
+const defaultOptions = {
+ allowBooleanAttributes: false, //A tag can have attributes without any value
+ unpairedTags: []
+};
- if (!set.length) {
- this.regexp = false
- return this.regexp
+//const tagsPattern = new RegExp("<\\/?([\\w:\\-_\.]+)\\s*\/?>","g");
+exports.validate = function (xmlData, options) {
+ options = Object.assign({}, defaultOptions, options);
+
+ //xmlData = xmlData.replace(/(\r\n|\n|\r)/gm,"");//make it single line
+ //xmlData = xmlData.replace(/(^\s*<\?xml.*?\?>)/g,"");//Remove XML starting tag
+ //xmlData = xmlData.replace(/()/g,"");//Remove DOCTYPE
+ const tags = [];
+ let tagFound = false;
+
+ //indicates that the root tag has been closed (aka. depth 0 has been reached)
+ let reachedRoot = false;
+
+ if (xmlData[0] === '\ufeff') {
+ // check for byte order mark (BOM)
+ xmlData = xmlData.substr(1);
}
- var options = this.options
+
+ for (let i = 0; i < xmlData.length; i++) {
- var twoStar = options.noglobstar ? star
- : options.dot ? twoStarDot
- : twoStarNoDot
- var flags = options.nocase ? 'i' : ''
+ if (xmlData[i] === '<' && xmlData[i+1] === '?') {
+ i+=2;
+ i = readPI(xmlData,i);
+ if (i.err) return i;
+ }else if (xmlData[i] === '<') {
+ //starting of tag
+ //read until you reach to '>' avoiding any '>' in attribute value
+ let tagStartPos = i;
+ i++;
+
+ if (xmlData[i] === '!') {
+ i = readCommentAndCDATA(xmlData, i);
+ continue;
+ } else {
+ let closingTag = false;
+ if (xmlData[i] === '/') {
+ //closing tag
+ closingTag = true;
+ i++;
+ }
+ //read tagname
+ let tagName = '';
+ for (; i < xmlData.length &&
+ xmlData[i] !== '>' &&
+ xmlData[i] !== ' ' &&
+ xmlData[i] !== '\t' &&
+ xmlData[i] !== '\n' &&
+ xmlData[i] !== '\r'; i++
+ ) {
+ tagName += xmlData[i];
+ }
+ tagName = tagName.trim();
+ //console.log(tagName);
- var re = set.map(function (pattern) {
- return pattern.map(function (p) {
- return (p === GLOBSTAR) ? twoStar
- : (typeof p === 'string') ? regExpEscape(p)
- : p._src
- }).join('\\\/')
- }).join('|')
+ if (tagName[tagName.length - 1] === '/') {
+ //self closing tag without attributes
+ tagName = tagName.substring(0, tagName.length - 1);
+ //continue;
+ i--;
+ }
+ if (!validateTagName(tagName)) {
+ let msg;
+ if (tagName.trim().length === 0) {
+ msg = "Invalid space after '<'.";
+ } else {
+ msg = "Tag '"+tagName+"' is an invalid name.";
+ }
+ return getErrorObject('InvalidTag', msg, getLineNumberForPosition(xmlData, i));
+ }
- // must match entire pattern
- // ending in a * or ** will make it less strict.
- re = '^(?:' + re + ')$'
+ const result = readAttributeStr(xmlData, i);
+ if (result === false) {
+ return getErrorObject('InvalidAttr', "Attributes for '"+tagName+"' have open quote.", getLineNumberForPosition(xmlData, i));
+ }
+ let attrStr = result.value;
+ i = result.index;
- // can match anything, as long as it's not this.
- if (this.negate) re = '^(?!' + re + ').*$'
+ if (attrStr[attrStr.length - 1] === '/') {
+ //self closing tag
+ const attrStrStart = i - attrStr.length;
+ attrStr = attrStr.substring(0, attrStr.length - 1);
+ const isValid = validateAttributeString(attrStr, options);
+ if (isValid === true) {
+ tagFound = true;
+ //continue; //text may presents after self closing tag
+ } else {
+ //the result from the nested function returns the position of the error within the attribute
+ //in order to get the 'true' error line, we need to calculate the position where the attribute begins (i - attrStr.length) and then add the position within the attribute
+ //this gives us the absolute index in the entire xml, which we can use to find the line at last
+ return getErrorObject(isValid.err.code, isValid.err.msg, getLineNumberForPosition(xmlData, attrStrStart + isValid.err.line));
+ }
+ } else if (closingTag) {
+ if (!result.tagClosed) {
+ return getErrorObject('InvalidTag', "Closing tag '"+tagName+"' doesn't have proper closing.", getLineNumberForPosition(xmlData, i));
+ } else if (attrStr.trim().length > 0) {
+ return getErrorObject('InvalidTag', "Closing tag '"+tagName+"' can't have attributes or invalid starting.", getLineNumberForPosition(xmlData, tagStartPos));
+ } else if (tags.length === 0) {
+ return getErrorObject('InvalidTag', "Closing tag '"+tagName+"' has not been opened.", getLineNumberForPosition(xmlData, tagStartPos));
+ } else {
+ const otg = tags.pop();
+ if (tagName !== otg.tagName) {
+ let openPos = getLineNumberForPosition(xmlData, otg.tagStartPos);
+ return getErrorObject('InvalidTag',
+ "Expected closing tag '"+otg.tagName+"' (opened in line "+openPos.line+", col "+openPos.col+") instead of closing tag '"+tagName+"'.",
+ getLineNumberForPosition(xmlData, tagStartPos));
+ }
- try {
- this.regexp = new RegExp(re, flags)
- } catch (ex) /* istanbul ignore next - should be impossible */ {
- this.regexp = false
+ //when there are no more tags, we reached the root level.
+ if (tags.length == 0) {
+ reachedRoot = true;
+ }
+ }
+ } else {
+ const isValid = validateAttributeString(attrStr, options);
+ if (isValid !== true) {
+ //the result from the nested function returns the position of the error within the attribute
+ //in order to get the 'true' error line, we need to calculate the position where the attribute begins (i - attrStr.length) and then add the position within the attribute
+ //this gives us the absolute index in the entire xml, which we can use to find the line at last
+ return getErrorObject(isValid.err.code, isValid.err.msg, getLineNumberForPosition(xmlData, i - attrStr.length + isValid.err.line));
+ }
+
+ //if the root level has been reached before ...
+ if (reachedRoot === true) {
+ return getErrorObject('InvalidXml', 'Multiple possible root nodes found.', getLineNumberForPosition(xmlData, i));
+ } else if(options.unpairedTags.indexOf(tagName) !== -1){
+ //don't push into stack
+ } else {
+ tags.push({tagName, tagStartPos});
+ }
+ tagFound = true;
+ }
+
+ //skip tag text value
+ //It may include comments and CDATA value
+ for (i++; i < xmlData.length; i++) {
+ if (xmlData[i] === '<') {
+ if (xmlData[i + 1] === '!') {
+ //comment or CADATA
+ i++;
+ i = readCommentAndCDATA(xmlData, i);
+ continue;
+ } else if (xmlData[i+1] === '?') {
+ i = readPI(xmlData, ++i);
+ if (i.err) return i;
+ } else{
+ break;
+ }
+ } else if (xmlData[i] === '&') {
+ const afterAmp = validateAmpersand(xmlData, i);
+ if (afterAmp == -1)
+ return getErrorObject('InvalidChar', "char '&' is not expected.", getLineNumberForPosition(xmlData, i));
+ i = afterAmp;
+ }else{
+ if (reachedRoot === true && !isWhiteSpace(xmlData[i])) {
+ return getErrorObject('InvalidXml', "Extra text at the end", getLineNumberForPosition(xmlData, i));
+ }
+ }
+ } //end of reading tag text value
+ if (xmlData[i] === '<') {
+ i--;
+ }
+ }
+ } else {
+ if ( isWhiteSpace(xmlData[i])) {
+ continue;
+ }
+ return getErrorObject('InvalidChar', "char '"+xmlData[i]+"' is not expected.", getLineNumberForPosition(xmlData, i));
+ }
}
- return this.regexp
-}
-minimatch.match = function (list, pattern, options) {
- options = options || {}
- var mm = new Minimatch(pattern, options)
- list = list.filter(function (f) {
- return mm.match(f)
- })
- if (mm.options.nonull && !list.length) {
- list.push(pattern)
+ if (!tagFound) {
+ return getErrorObject('InvalidXml', 'Start tag expected.', 1);
+ }else if (tags.length == 1) {
+ return getErrorObject('InvalidTag', "Unclosed tag '"+tags[0].tagName+"'.", getLineNumberForPosition(xmlData, tags[0].tagStartPos));
+ }else if (tags.length > 0) {
+ return getErrorObject('InvalidXml', "Invalid '"+
+ JSON.stringify(tags.map(t => t.tagName), null, 4).replace(/\r?\n/g, '')+
+ "' found.", {line: 1, col: 1});
}
- return list
+
+ return true;
+};
+
+function isWhiteSpace(char){
+ return char === ' ' || char === '\t' || char === '\n' || char === '\r';
+}
+/**
+ * Read Processing insstructions and skip
+ * @param {*} xmlData
+ * @param {*} i
+ */
+function readPI(xmlData, i) {
+ const start = i;
+ for (; i < xmlData.length; i++) {
+ if (xmlData[i] == '?' || xmlData[i] == ' ') {
+ //tagname
+ const tagname = xmlData.substr(start, i - start);
+ if (i > 5 && tagname === 'xml') {
+ return getErrorObject('InvalidXml', 'XML declaration allowed only at the start of the document.', getLineNumberForPosition(xmlData, i));
+ } else if (xmlData[i] == '?' && xmlData[i + 1] == '>') {
+ //check if valid attribut string
+ i++;
+ break;
+ } else {
+ continue;
+ }
+ }
+ }
+ return i;
}
-Minimatch.prototype.match = function match (f, partial) {
- if (typeof partial === 'undefined') partial = this.partial
- this.debug('match', f, this.pattern)
- // short-circuit in the case of busted things.
- // comments, etc.
- if (this.comment) return false
- if (this.empty) return f === ''
+function readCommentAndCDATA(xmlData, i) {
+ if (xmlData.length > i + 5 && xmlData[i + 1] === '-' && xmlData[i + 2] === '-') {
+ //comment
+ for (i += 3; i < xmlData.length; i++) {
+ if (xmlData[i] === '-' && xmlData[i + 1] === '-' && xmlData[i + 2] === '>') {
+ i += 2;
+ break;
+ }
+ }
+ } else if (
+ xmlData.length > i + 8 &&
+ xmlData[i + 1] === 'D' &&
+ xmlData[i + 2] === 'O' &&
+ xmlData[i + 3] === 'C' &&
+ xmlData[i + 4] === 'T' &&
+ xmlData[i + 5] === 'Y' &&
+ xmlData[i + 6] === 'P' &&
+ xmlData[i + 7] === 'E'
+ ) {
+ let angleBracketsCount = 1;
+ for (i += 8; i < xmlData.length; i++) {
+ if (xmlData[i] === '<') {
+ angleBracketsCount++;
+ } else if (xmlData[i] === '>') {
+ angleBracketsCount--;
+ if (angleBracketsCount === 0) {
+ break;
+ }
+ }
+ }
+ } else if (
+ xmlData.length > i + 9 &&
+ xmlData[i + 1] === '[' &&
+ xmlData[i + 2] === 'C' &&
+ xmlData[i + 3] === 'D' &&
+ xmlData[i + 4] === 'A' &&
+ xmlData[i + 5] === 'T' &&
+ xmlData[i + 6] === 'A' &&
+ xmlData[i + 7] === '['
+ ) {
+ for (i += 8; i < xmlData.length; i++) {
+ if (xmlData[i] === ']' && xmlData[i + 1] === ']' && xmlData[i + 2] === '>') {
+ i += 2;
+ break;
+ }
+ }
+ }
- if (f === '/' && partial) return true
+ return i;
+}
- var options = this.options
+const doubleQuote = '"';
+const singleQuote = "'";
- // windows: need to use /, not \
- if (path.sep !== '/') {
- f = f.split(path.sep).join('/')
+/**
+ * Keep reading xmlData until '<' is found outside the attribute value.
+ * @param {string} xmlData
+ * @param {number} i
+ */
+function readAttributeStr(xmlData, i) {
+ let attrStr = '';
+ let startChar = '';
+ let tagClosed = false;
+ for (; i < xmlData.length; i++) {
+ if (xmlData[i] === doubleQuote || xmlData[i] === singleQuote) {
+ if (startChar === '') {
+ startChar = xmlData[i];
+ } else if (startChar !== xmlData[i]) {
+ //if vaue is enclosed with double quote then single quotes are allowed inside the value and vice versa
+ } else {
+ startChar = '';
+ }
+ } else if (xmlData[i] === '>') {
+ if (startChar === '') {
+ tagClosed = true;
+ break;
+ }
+ }
+ attrStr += xmlData[i];
+ }
+ if (startChar !== '') {
+ return false;
}
- // treat the test path as a set of pathparts.
- f = f.split(slashSplit)
- this.debug(this.pattern, 'split', f)
+ return {
+ value: attrStr,
+ index: i,
+ tagClosed: tagClosed
+ };
+}
- // just ONE of the pattern sets in this.set needs to match
- // in order for it to be valid. If negating, then just one
- // match means that we have failed.
- // Either way, return on the first hit.
+/**
+ * Select all the attributes whether valid or invalid.
+ */
+const validAttrStrRegxp = new RegExp('(\\s*)([^\\s=]+)(\\s*=)?(\\s*([\'"])(([\\s\\S])*?)\\5)?', 'g');
- var set = this.set
- this.debug(this.pattern, 'set', set)
+//attr, ="sd", a="amit's", a="sd"b="saf", ab cd=""
- // Find the basename of the path by looking for the last non-empty segment
- var filename
- var i
- for (i = f.length - 1; i >= 0; i--) {
- filename = f[i]
- if (filename) break
- }
+function validateAttributeString(attrStr, options) {
+ //console.log("start:"+attrStr+":end");
- for (i = 0; i < set.length; i++) {
- var pattern = set[i]
- var file = f
- if (options.matchBase && pattern.length === 1) {
- file = [filename]
+ //if(attrStr.trim().length === 0) return true; //empty string
+
+ const matches = util.getAllMatches(attrStr, validAttrStrRegxp);
+ const attrNames = {};
+
+ for (let i = 0; i < matches.length; i++) {
+ if (matches[i][1].length === 0) {
+ //nospace before attribute name: a="sd"b="saf"
+ return getErrorObject('InvalidAttr', "Attribute '"+matches[i][2]+"' has no space in starting.", getPositionFromMatch(matches[i]))
+ } else if (matches[i][3] !== undefined && matches[i][4] === undefined) {
+ return getErrorObject('InvalidAttr', "Attribute '"+matches[i][2]+"' is without value.", getPositionFromMatch(matches[i]));
+ } else if (matches[i][3] === undefined && !options.allowBooleanAttributes) {
+ //independent attribute: ab
+ return getErrorObject('InvalidAttr', "boolean attribute '"+matches[i][2]+"' is not allowed.", getPositionFromMatch(matches[i]));
}
- var hit = this.matchOne(file, pattern, partial)
- if (hit) {
- if (options.flipNegate) return true
- return !this.negate
+ /* else if(matches[i][6] === undefined){//attribute without value: ab=
+ return { err: { code:"InvalidAttr",msg:"attribute " + matches[i][2] + " has no value assigned."}};
+ } */
+ const attrName = matches[i][2];
+ if (!validateAttrName(attrName)) {
+ return getErrorObject('InvalidAttr', "Attribute '"+attrName+"' is an invalid name.", getPositionFromMatch(matches[i]));
+ }
+ if (!attrNames.hasOwnProperty(attrName)) {
+ //check for duplicate attribute.
+ attrNames[attrName] = 1;
+ } else {
+ return getErrorObject('InvalidAttr', "Attribute '"+attrName+"' is repeated.", getPositionFromMatch(matches[i]));
}
}
- // didn't get any hits. this is success if it's a negative
- // pattern, failure otherwise.
- if (options.flipNegate) return false
- return this.negate
+ return true;
+}
+
+function validateNumberAmpersand(xmlData, i) {
+ let re = /\d/;
+ if (xmlData[i] === 'x') {
+ i++;
+ re = /[\da-fA-F]/;
+ }
+ for (; i < xmlData.length; i++) {
+ if (xmlData[i] === ';')
+ return i;
+ if (!xmlData[i].match(re))
+ break;
+ }
+ return -1;
+}
+
+function validateAmpersand(xmlData, i) {
+ // https://www.w3.org/TR/xml/#dt-charref
+ i++;
+ if (xmlData[i] === ';')
+ return -1;
+ if (xmlData[i] === '#') {
+ i++;
+ return validateNumberAmpersand(xmlData, i);
+ }
+ let count = 0;
+ for (; i < xmlData.length; i++, count++) {
+ if (xmlData[i].match(/\w/) && count < 20)
+ continue;
+ if (xmlData[i] === ';')
+ break;
+ return -1;
+ }
+ return i;
+}
+
+function getErrorObject(code, message, lineNumber) {
+ return {
+ err: {
+ code: code,
+ msg: message,
+ line: lineNumber.line || lineNumber,
+ col: lineNumber.col,
+ },
+ };
+}
+
+function validateAttrName(attrName) {
+ return util.isName(attrName);
+}
+
+// const startsWithXML = /^xml/i;
+
+function validateTagName(tagname) {
+ return util.isName(tagname) /* && !tagname.match(startsWithXML) */;
}
-// set partial to true to test if, for example,
-// "/a/b" matches the start of "/*/b/*/d"
-// Partial means, if you run out of file before you run
-// out of pattern, then that's fine, as long as all
-// the parts match.
-Minimatch.prototype.matchOne = function (file, pattern, partial) {
- var options = this.options
+//this function returns the line number for the character at the given index
+function getLineNumberForPosition(xmlData, index) {
+ const lines = xmlData.substring(0, index).split(/\r?\n/);
+ return {
+ line: lines.length,
- this.debug('matchOne',
- { 'this': this, file: file, pattern: pattern })
+ // column number is last line's length + 1, because column numbering starts at 1:
+ col: lines[lines.length - 1].length + 1
+ };
+}
- this.debug('matchOne', file.length, pattern.length)
+//this function returns the position of the first character of match within attrStr
+function getPositionFromMatch(match) {
+ return match.startIndex + match[1].length;
+}
- for (var fi = 0,
- pi = 0,
- fl = file.length,
- pl = pattern.length
- ; (fi < fl) && (pi < pl)
- ; fi++, pi++) {
- this.debug('matchOne loop')
- var p = pattern[pi]
- var f = file[fi]
- this.debug(pattern, p, f)
+/***/ }),
- // should be impossible.
- // some invalid regexp stuff in the set.
- /* istanbul ignore if */
- if (p === false) return false
+/***/ 660:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
- if (p === GLOBSTAR) {
- this.debug('GLOBSTAR', [pattern, p, f])
+"use strict";
- // "**"
- // a/**/b/**/c would match the following:
- // a/b/x/y/z/c
- // a/x/y/z/b/c
- // a/b/x/b/x/c
- // a/b/c
- // To do this, take the rest of the pattern after
- // the **, and see if it would match the file remainder.
- // If so, return success.
- // If not, the ** "swallows" a segment, and try again.
- // This is recursively awful.
- //
- // a/**/b/**/c matching a/b/x/y/z/c
- // - a matches a
- // - doublestar
- // - matchOne(b/x/y/z/c, b/**/c)
- // - b matches b
- // - doublestar
- // - matchOne(x/y/z/c, c) -> no
- // - matchOne(y/z/c, c) -> no
- // - matchOne(z/c, c) -> no
- // - matchOne(c, c) yes, hit
- var fr = fi
- var pr = pi + 1
- if (pr === pl) {
- this.debug('** at the end')
- // a ** at the end will just swallow the rest.
- // We have found a match.
- // however, it will not swallow /.x, unless
- // options.dot is set.
- // . and .. are *never* matched by **, for explosively
- // exponential reasons.
- for (; fi < fl; fi++) {
- if (file[fi] === '.' || file[fi] === '..' ||
- (!options.dot && file[fi].charAt(0) === '.')) return false
- }
- return true
- }
+//parse Empty Node as self closing node
+const buildFromOrderedJs = __nccwpck_require__(2462);
+
+const defaultOptions = {
+ attributeNamePrefix: '@_',
+ attributesGroupName: false,
+ textNodeName: '#text',
+ ignoreAttributes: true,
+ cdataPropName: false,
+ format: false,
+ indentBy: ' ',
+ suppressEmptyNode: false,
+ suppressUnpairedNode: true,
+ suppressBooleanAttributes: true,
+ tagValueProcessor: function(key, a) {
+ return a;
+ },
+ attributeValueProcessor: function(attrName, a) {
+ return a;
+ },
+ preserveOrder: false,
+ commentPropName: false,
+ unpairedTags: [],
+ entities: [
+ { regex: new RegExp("&", "g"), val: "&" },//it must be on top
+ { regex: new RegExp(">", "g"), val: ">" },
+ { regex: new RegExp("<", "g"), val: "<" },
+ { regex: new RegExp("\'", "g"), val: "'" },
+ { regex: new RegExp("\"", "g"), val: """ }
+ ],
+ processEntities: true,
+ stopNodes: [],
+ // transformTagName: false,
+ // transformAttributeName: false,
+ oneListGroup: false
+};
+
+function Builder(options) {
+ this.options = Object.assign({}, defaultOptions, options);
+ if (this.options.ignoreAttributes || this.options.attributesGroupName) {
+ this.isAttribute = function(/*a*/) {
+ return false;
+ };
+ } else {
+ this.attrPrefixLen = this.options.attributeNamePrefix.length;
+ this.isAttribute = isAttribute;
+ }
- // ok, let's see if we can swallow whatever we can.
- while (fr < fl) {
- var swallowee = file[fr]
+ this.processTextOrObjNode = processTextOrObjNode
- this.debug('\nglobstar while', file, fr, pattern, pr, swallowee)
+ if (this.options.format) {
+ this.indentate = indentate;
+ this.tagEndChar = '>\n';
+ this.newLine = '\n';
+ } else {
+ this.indentate = function() {
+ return '';
+ };
+ this.tagEndChar = '>';
+ this.newLine = '';
+ }
+}
- // XXX remove this slice. Just pass the start index.
- if (this.matchOne(file.slice(fr), pattern.slice(pr), partial)) {
- this.debug('globstar found match!', fr, fl, swallowee)
- // found a match.
- return true
+Builder.prototype.build = function(jObj) {
+ if(this.options.preserveOrder){
+ return buildFromOrderedJs(jObj, this.options);
+ }else {
+ if(Array.isArray(jObj) && this.options.arrayNodeName && this.options.arrayNodeName.length > 1){
+ jObj = {
+ [this.options.arrayNodeName] : jObj
+ }
+ }
+ return this.j2x(jObj, 0).val;
+ }
+};
+
+Builder.prototype.j2x = function(jObj, level) {
+ let attrStr = '';
+ let val = '';
+ for (let key in jObj) {
+ if(!Object.prototype.hasOwnProperty.call(jObj, key)) continue;
+ if (typeof jObj[key] === 'undefined') {
+ // supress undefined node only if it is not an attribute
+ if (this.isAttribute(key)) {
+ val += '';
+ }
+ } else if (jObj[key] === null) {
+ // null attribute should be ignored by the attribute list, but should not cause the tag closing
+ if (this.isAttribute(key)) {
+ val += '';
+ } else if (key[0] === '?') {
+ val += this.indentate(level) + '<' + key + '?' + this.tagEndChar;
+ } else {
+ val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+ }
+ // val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+ } else if (jObj[key] instanceof Date) {
+ val += this.buildTextValNode(jObj[key], key, '', level);
+ } else if (typeof jObj[key] !== 'object') {
+ //premitive type
+ const attr = this.isAttribute(key);
+ if (attr) {
+ attrStr += this.buildAttrPairStr(attr, '' + jObj[key]);
+ }else {
+ //tag value
+ if (key === this.options.textNodeName) {
+ let newval = this.options.tagValueProcessor(key, '' + jObj[key]);
+ val += this.replaceEntitiesValue(newval);
} else {
- // can't swallow "." or ".." ever.
- // can only swallow ".foo" when explicitly asked.
- if (swallowee === '.' || swallowee === '..' ||
- (!options.dot && swallowee.charAt(0) === '.')) {
- this.debug('dot detected!', file, fr, pattern, pr)
- break
+ val += this.buildTextValNode(jObj[key], key, '', level);
+ }
+ }
+ } else if (Array.isArray(jObj[key])) {
+ //repeated nodes
+ const arrLen = jObj[key].length;
+ let listTagVal = "";
+ let listTagAttr = "";
+ for (let j = 0; j < arrLen; j++) {
+ const item = jObj[key][j];
+ if (typeof item === 'undefined') {
+ // supress undefined node
+ } else if (item === null) {
+ if(key[0] === "?") val += this.indentate(level) + '<' + key + '?' + this.tagEndChar;
+ else val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+ // val += this.indentate(level) + '<' + key + '/' + this.tagEndChar;
+ } else if (typeof item === 'object') {
+ if(this.options.oneListGroup){
+ const result = this.j2x(item, level + 1);
+ listTagVal += result.val;
+ if (this.options.attributesGroupName && item.hasOwnProperty(this.options.attributesGroupName)) {
+ listTagAttr += result.attrStr
+ }
+ }else{
+ listTagVal += this.processTextOrObjNode(item, key, level)
+ }
+ } else {
+ if (this.options.oneListGroup) {
+ let textValue = this.options.tagValueProcessor(key, item);
+ textValue = this.replaceEntitiesValue(textValue);
+ listTagVal += textValue;
+ } else {
+ listTagVal += this.buildTextValNode(item, key, '', level);
}
-
- // ** swallows a segment, and continue.
- this.debug('globstar swallow a segment, and continue')
- fr++
}
}
-
- // no match was found.
- // However, in partial mode, we can't say this is necessarily over.
- // If there's more *pattern* left, then
- /* istanbul ignore if */
- if (partial) {
- // ran out of file
- this.debug('\n>>> no match, partial?', file, fr, pattern, pr)
- if (fr === fl) return true
+ if(this.options.oneListGroup){
+ listTagVal = this.buildObjectNode(listTagVal, key, listTagAttr, level);
}
- return false
+ val += listTagVal;
+ } else {
+ //nested node
+ if (this.options.attributesGroupName && key === this.options.attributesGroupName) {
+ const Ks = Object.keys(jObj[key]);
+ const L = Ks.length;
+ for (let j = 0; j < L; j++) {
+ attrStr += this.buildAttrPairStr(Ks[j], '' + jObj[key][Ks[j]]);
+ }
+ } else {
+ val += this.processTextOrObjNode(jObj[key], key, level)
+ }
+ }
+ }
+ return {attrStr: attrStr, val: val};
+};
+
+Builder.prototype.buildAttrPairStr = function(attrName, val){
+ val = this.options.attributeValueProcessor(attrName, '' + val);
+ val = this.replaceEntitiesValue(val);
+ if (this.options.suppressBooleanAttributes && val === "true") {
+ return ' ' + attrName;
+ } else return ' ' + attrName + '="' + val + '"';
+}
+
+function processTextOrObjNode (object, key, level) {
+ const result = this.j2x(object, level + 1);
+ if (object[this.options.textNodeName] !== undefined && Object.keys(object).length === 1) {
+ return this.buildTextValNode(object[this.options.textNodeName], key, result.attrStr, level);
+ } else {
+ return this.buildObjectNode(result.val, key, result.attrStr, level);
+ }
+}
+
+Builder.prototype.buildObjectNode = function(val, key, attrStr, level) {
+ if(val === ""){
+ if(key[0] === "?") return this.indentate(level) + '<' + key + attrStr+ '?' + this.tagEndChar;
+ else {
+ return this.indentate(level) + '<' + key + attrStr + this.closeTag(key) + this.tagEndChar;
}
+ }else{
- // something other than **
- // non-magic patterns just have to match exactly
- // patterns with magic have been turned into regexps.
- var hit
- if (typeof p === 'string') {
- hit = f === p
- this.debug('string match', p, f, hit)
- } else {
- hit = f.match(p)
- this.debug('pattern match', p, f, hit)
+ let tagEndExp = '' + val + tagEndExp );
+ } else if (this.options.commentPropName !== false && key === this.options.commentPropName && piClosingChar.length === 0) {
+ return this.indentate(level) + `` + this.newLine;
+ }else {
+ return (
+ this.indentate(level) + '<' + key + attrStr + piClosingChar + this.tagEndChar +
+ val +
+ this.indentate(level) + tagEndExp );
}
+ }
+}
- if (!hit) return false
+Builder.prototype.closeTag = function(key){
+ let closeTag = "";
+ if(this.options.unpairedTags.indexOf(key) !== -1){ //unpaired
+ if(!this.options.suppressUnpairedNode) closeTag = "/"
+ }else if(this.options.suppressEmptyNode){ //empty
+ closeTag = "/";
+ }else{
+ closeTag = `>` + this.newLine;
+ }else if (this.options.commentPropName !== false && key === this.options.commentPropName) {
+ return this.indentate(level) + `` + this.newLine;
+ }else if(key[0] === "?") {//PI tag
+ return this.indentate(level) + '<' + key + attrStr+ '?' + this.tagEndChar;
+ }else{
+ let textValue = this.options.tagValueProcessor(key, val);
+ textValue = this.replaceEntitiesValue(textValue);
+
+ if( textValue === ''){
+ return this.indentate(level) + '<' + key + attrStr + this.closeTag(key) + this.tagEndChar;
+ }else{
+ return this.indentate(level) + '<' + key + attrStr + '>' +
+ textValue +
+ ' 0 && this.options.processEntities){
+ for (let i=0; i {
+/***/ 2462:
+/***/ ((module) => {
-"use strict";
+const EOL = "\n";
+/**
+ *
+ * @param {array} jArray
+ * @param {any} options
+ * @returns
+ */
+function toXml(jArray, options) {
+ let indentation = "";
+ if (options.format && options.indentBy.length > 0) {
+ indentation = EOL;
+ }
+ return arrToStr(jArray, options, "", indentation);
+}
-Object.defineProperty(exports, "__esModule", ({ value: true }));
+function arrToStr(arr, options, jPath, indentation) {
+ let xmlStr = "";
+ let isPreviousElementTag = false;
-function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
-
-var Stream = _interopDefault(__nccwpck_require__(2781));
-var http = _interopDefault(__nccwpck_require__(3685));
-var Url = _interopDefault(__nccwpck_require__(7310));
-var whatwgUrl = _interopDefault(__nccwpck_require__(8665));
-var https = _interopDefault(__nccwpck_require__(5687));
-var zlib = _interopDefault(__nccwpck_require__(9796));
-
-// Based on https://github.com/tmpvar/jsdom/blob/aa85b2abf07766ff7bf5c1f6daafb3726f2f2db5/lib/jsdom/living/blob.js
-
-// fix for "Readable" isn't a named export issue
-const Readable = Stream.Readable;
-
-const BUFFER = Symbol('buffer');
-const TYPE = Symbol('type');
-
-class Blob {
- constructor() {
- this[TYPE] = '';
-
- const blobParts = arguments[0];
- const options = arguments[1];
-
- const buffers = [];
- let size = 0;
-
- if (blobParts) {
- const a = blobParts;
- const length = Number(a.length);
- for (let i = 0; i < length; i++) {
- const element = a[i];
- let buffer;
- if (element instanceof Buffer) {
- buffer = element;
- } else if (ArrayBuffer.isView(element)) {
- buffer = Buffer.from(element.buffer, element.byteOffset, element.byteLength);
- } else if (element instanceof ArrayBuffer) {
- buffer = Buffer.from(element);
- } else if (element instanceof Blob) {
- buffer = element[BUFFER];
- } else {
- buffer = Buffer.from(typeof element === 'string' ? element : String(element));
- }
- size += buffer.length;
- buffers.push(buffer);
- }
- }
+ for (let i = 0; i < arr.length; i++) {
+ const tagObj = arr[i];
+ const tagName = propName(tagObj);
+ if(tagName === undefined) continue;
- this[BUFFER] = Buffer.concat(buffers);
+ let newJPath = "";
+ if (jPath.length === 0) newJPath = tagName
+ else newJPath = `${jPath}.${tagName}`;
- let type = options && options.type !== undefined && String(options.type).toLowerCase();
- if (type && !/[^\u0020-\u007E]/.test(type)) {
- this[TYPE] = type;
- }
- }
- get size() {
- return this[BUFFER].length;
- }
- get type() {
- return this[TYPE];
- }
- text() {
- return Promise.resolve(this[BUFFER].toString());
- }
- arrayBuffer() {
- const buf = this[BUFFER];
- const ab = buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength);
- return Promise.resolve(ab);
- }
- stream() {
- const readable = new Readable();
- readable._read = function () {};
- readable.push(this[BUFFER]);
- readable.push(null);
- return readable;
- }
- toString() {
- return '[object Blob]';
- }
- slice() {
- const size = this.size;
-
- const start = arguments[0];
- const end = arguments[1];
- let relativeStart, relativeEnd;
- if (start === undefined) {
- relativeStart = 0;
- } else if (start < 0) {
- relativeStart = Math.max(size + start, 0);
- } else {
- relativeStart = Math.min(start, size);
- }
- if (end === undefined) {
- relativeEnd = size;
- } else if (end < 0) {
- relativeEnd = Math.max(size + end, 0);
- } else {
- relativeEnd = Math.min(end, size);
- }
- const span = Math.max(relativeEnd - relativeStart, 0);
+ if (tagName === options.textNodeName) {
+ let tagText = tagObj[tagName];
+ if (!isStopNode(newJPath, options)) {
+ tagText = options.tagValueProcessor(tagName, tagText);
+ tagText = replaceEntitiesValue(tagText, options);
+ }
+ if (isPreviousElementTag) {
+ xmlStr += indentation;
+ }
+ xmlStr += tagText;
+ isPreviousElementTag = false;
+ continue;
+ } else if (tagName === options.cdataPropName) {
+ if (isPreviousElementTag) {
+ xmlStr += indentation;
+ }
+ xmlStr += ``;
+ isPreviousElementTag = false;
+ continue;
+ } else if (tagName === options.commentPropName) {
+ xmlStr += indentation + ``;
+ isPreviousElementTag = true;
+ continue;
+ } else if (tagName[0] === "?") {
+ const attStr = attr_to_str(tagObj[":@"], options);
+ const tempInd = tagName === "?xml" ? "" : indentation;
+ let piTextNodeName = tagObj[tagName][0][options.textNodeName];
+ piTextNodeName = piTextNodeName.length !== 0 ? " " + piTextNodeName : ""; //remove extra spacing
+ xmlStr += tempInd + `<${tagName}${piTextNodeName}${attStr}?>`;
+ isPreviousElementTag = true;
+ continue;
+ }
+ let newIdentation = indentation;
+ if (newIdentation !== "") {
+ newIdentation += options.indentBy;
+ }
+ const attStr = attr_to_str(tagObj[":@"], options);
+ const tagStart = indentation + `<${tagName}${attStr}`;
+ const tagValue = arrToStr(tagObj[tagName], options, newJPath, newIdentation);
+ if (options.unpairedTags.indexOf(tagName) !== -1) {
+ if (options.suppressUnpairedNode) xmlStr += tagStart + ">";
+ else xmlStr += tagStart + "/>";
+ } else if ((!tagValue || tagValue.length === 0) && options.suppressEmptyNode) {
+ xmlStr += tagStart + "/>";
+ } else if (tagValue && tagValue.endsWith(">")) {
+ xmlStr += tagStart + `>${tagValue}${indentation}`;
+ } else {
+ xmlStr += tagStart + ">";
+ if (tagValue && indentation !== "" && (tagValue.includes("/>") || tagValue.includes("`;
+ }
+ isPreviousElementTag = true;
+ }
- const buffer = this[BUFFER];
- const slicedBuffer = buffer.slice(relativeStart, relativeStart + span);
- const blob = new Blob([], { type: arguments[2] });
- blob[BUFFER] = slicedBuffer;
- return blob;
- }
+ return xmlStr;
}
-Object.defineProperties(Blob.prototype, {
- size: { enumerable: true },
- type: { enumerable: true },
- slice: { enumerable: true }
-});
+function propName(obj) {
+ const keys = Object.keys(obj);
+ for (let i = 0; i < keys.length; i++) {
+ const key = keys[i];
+ if(!obj.hasOwnProperty(key)) continue;
+ if (key !== ":@") return key;
+ }
+}
-Object.defineProperty(Blob.prototype, Symbol.toStringTag, {
- value: 'Blob',
- writable: false,
- enumerable: false,
- configurable: true
-});
+function attr_to_str(attrMap, options) {
+ let attrStr = "";
+ if (attrMap && !options.ignoreAttributes) {
+ for (let attr in attrMap) {
+ if(!attrMap.hasOwnProperty(attr)) continue;
+ let attrVal = options.attributeValueProcessor(attr, attrMap[attr]);
+ attrVal = replaceEntitiesValue(attrVal, options);
+ if (attrVal === true && options.suppressBooleanAttributes) {
+ attrStr += ` ${attr.substr(options.attributeNamePrefix.length)}`;
+ } else {
+ attrStr += ` ${attr.substr(options.attributeNamePrefix.length)}="${attrVal}"`;
+ }
+ }
+ }
+ return attrStr;
+}
-/**
- * fetch-error.js
- *
- * FetchError interface for operational errors
- */
+function isStopNode(jPath, options) {
+ jPath = jPath.substr(0, jPath.length - options.textNodeName.length - 1);
+ let tagName = jPath.substr(jPath.lastIndexOf(".") + 1);
+ for (let index in options.stopNodes) {
+ if (options.stopNodes[index] === jPath || options.stopNodes[index] === "*." + tagName) return true;
+ }
+ return false;
+}
-/**
- * Create FetchError instance
- *
- * @param String message Error message for human
- * @param String type Error type for machine
- * @param String systemError For Node.js system error
- * @return FetchError
- */
-function FetchError(message, type, systemError) {
- Error.call(this, message);
+function replaceEntitiesValue(textValue, options) {
+ if (textValue && textValue.length > 0 && options.processEntities) {
+ for (let i = 0; i < options.entities.length; i++) {
+ const entity = options.entities[i];
+ textValue = textValue.replace(entity.regex, entity.val);
+ }
+ }
+ return textValue;
+}
+module.exports = toXml;
- this.message = message;
- this.type = type;
- // when err.type is `system`, err.code contains system error code
- if (systemError) {
- this.code = this.errno = systemError.code;
- }
+/***/ }),
- // hide custom error implementation details from end-users
- Error.captureStackTrace(this, this.constructor);
-}
+/***/ 6072:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
-FetchError.prototype = Object.create(Error.prototype);
-FetchError.prototype.constructor = FetchError;
-FetchError.prototype.name = 'FetchError';
+const util = __nccwpck_require__(8280);
+
+//TODO: handle comments
+function readDocType(xmlData, i){
+
+ const entities = {};
+ if( xmlData[i + 3] === 'O' &&
+ xmlData[i + 4] === 'C' &&
+ xmlData[i + 5] === 'T' &&
+ xmlData[i + 6] === 'Y' &&
+ xmlData[i + 7] === 'P' &&
+ xmlData[i + 8] === 'E')
+ {
+ i = i+9;
+ let angleBracketsCount = 1;
+ let hasBody = false, comment = false;
+ let exp = "";
+ for(;i') { //Read tag content
+ if(comment){
+ if( xmlData[i - 1] === "-" && xmlData[i - 2] === "-"){
+ comment = false;
+ angleBracketsCount--;
+ }
+ }else{
+ angleBracketsCount--;
+ }
+ if (angleBracketsCount === 0) {
+ break;
+ }
+ }else if( xmlData[i] === '['){
+ hasBody = true;
+ }else{
+ exp += xmlData[i];
+ }
+ }
+ if(angleBracketsCount !== 0){
+ throw new Error(`Unclosed DOCTYPE`);
+ }
+ }else{
+ throw new Error(`Invalid Tag instead of DOCTYPE`);
+ }
+ return {entities, i};
+}
-let convert;
-try {
- convert = (__nccwpck_require__(2877).convert);
-} catch (e) {}
+function readEntityExp(xmlData,i){
+ //External entities are not supported
+ //
-const INTERNALS = Symbol('Body internals');
+ //Parameter entities are not supported
+ //
-// fix an issue where "PassThrough" isn't a named export for node <10
-const PassThrough = Stream.PassThrough;
+ //Internal entities are supported
+ //
+
+ //read EntityName
+ let entityName = "";
+ for (; i < xmlData.length && (xmlData[i] !== "'" && xmlData[i] !== '"' ); i++) {
+ // if(xmlData[i] === " ") continue;
+ // else
+ entityName += xmlData[i];
+ }
+ entityName = entityName.trim();
+ if(entityName.indexOf(" ") !== -1) throw new Error("External entites are not supported");
-/**
- * Body mixin
- *
- * Ref: https://fetch.spec.whatwg.org/#body
- *
- * @param Stream body Readable stream
- * @param Object opts Response options
- * @return Void
- */
-function Body(body) {
- var _this = this;
-
- var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
- _ref$size = _ref.size;
-
- let size = _ref$size === undefined ? 0 : _ref$size;
- var _ref$timeout = _ref.timeout;
- let timeout = _ref$timeout === undefined ? 0 : _ref$timeout;
-
- if (body == null) {
- // body is undefined or null
- body = null;
- } else if (isURLSearchParams(body)) {
- // body is a URLSearchParams
- body = Buffer.from(body.toString());
- } else if (isBlob(body)) ; else if (Buffer.isBuffer(body)) ; else if (Object.prototype.toString.call(body) === '[object ArrayBuffer]') {
- // body is ArrayBuffer
- body = Buffer.from(body);
- } else if (ArrayBuffer.isView(body)) {
- // body is ArrayBufferView
- body = Buffer.from(body.buffer, body.byteOffset, body.byteLength);
- } else if (body instanceof Stream) ; else {
- // none of the above
- // coerce to string then buffer
- body = Buffer.from(String(body));
- }
- this[INTERNALS] = {
- body,
- disturbed: false,
- error: null
- };
- this.size = size;
- this.timeout = timeout;
+ //read Entity Value
+ const startChar = xmlData[i++];
+ let val = ""
+ for (; i < xmlData.length && xmlData[i] !== startChar ; i++) {
+ val += xmlData[i];
+ }
+ return [entityName, val, i];
+}
- if (body instanceof Stream) {
- body.on('error', function (err) {
- const error = err.name === 'AbortError' ? err : new FetchError(`Invalid response body while trying to fetch ${_this.url}: ${err.message}`, 'system', err);
- _this[INTERNALS].error = error;
- });
- }
+function isComment(xmlData, i){
+ if(xmlData[i+1] === '!' &&
+ xmlData[i+2] === '-' &&
+ xmlData[i+3] === '-') return true
+ return false
+}
+function isEntity(xmlData, i){
+ if(xmlData[i+1] === '!' &&
+ xmlData[i+2] === 'E' &&
+ xmlData[i+3] === 'N' &&
+ xmlData[i+4] === 'T' &&
+ xmlData[i+5] === 'I' &&
+ xmlData[i+6] === 'T' &&
+ xmlData[i+7] === 'Y') return true
+ return false
+}
+function isElement(xmlData, i){
+ if(xmlData[i+1] === '!' &&
+ xmlData[i+2] === 'E' &&
+ xmlData[i+3] === 'L' &&
+ xmlData[i+4] === 'E' &&
+ xmlData[i+5] === 'M' &&
+ xmlData[i+6] === 'E' &&
+ xmlData[i+7] === 'N' &&
+ xmlData[i+8] === 'T') return true
+ return false
}
-Body.prototype = {
- get body() {
- return this[INTERNALS].body;
- },
+function isAttlist(xmlData, i){
+ if(xmlData[i+1] === '!' &&
+ xmlData[i+2] === 'A' &&
+ xmlData[i+3] === 'T' &&
+ xmlData[i+4] === 'T' &&
+ xmlData[i+5] === 'L' &&
+ xmlData[i+6] === 'I' &&
+ xmlData[i+7] === 'S' &&
+ xmlData[i+8] === 'T') return true
+ return false
+}
+function isNotation(xmlData, i){
+ if(xmlData[i+1] === '!' &&
+ xmlData[i+2] === 'N' &&
+ xmlData[i+3] === 'O' &&
+ xmlData[i+4] === 'T' &&
+ xmlData[i+5] === 'A' &&
+ xmlData[i+6] === 'T' &&
+ xmlData[i+7] === 'I' &&
+ xmlData[i+8] === 'O' &&
+ xmlData[i+9] === 'N') return true
+ return false
+}
- get bodyUsed() {
- return this[INTERNALS].disturbed;
- },
+function validateEntityName(name){
+ if (util.isName(name))
+ return name;
+ else
+ throw new Error(`Invalid entity name ${name}`);
+}
- /**
- * Decode response as ArrayBuffer
- *
- * @return Promise
- */
- arrayBuffer() {
- return consumeBody.call(this).then(function (buf) {
- return buf.buffer.slice(buf.byteOffset, buf.byteOffset + buf.byteLength);
- });
- },
+module.exports = readDocType;
- /**
- * Return raw response as Blob
- *
- * @return Promise
- */
- blob() {
- let ct = this.headers && this.headers.get('content-type') || '';
- return consumeBody.call(this).then(function (buf) {
- return Object.assign(
- // Prevent copying
- new Blob([], {
- type: ct.toLowerCase()
- }), {
- [BUFFER]: buf
- });
- });
- },
- /**
- * Decode response as json
- *
- * @return Promise
- */
- json() {
- var _this2 = this;
-
- return consumeBody.call(this).then(function (buffer) {
- try {
- return JSON.parse(buffer.toString());
- } catch (err) {
- return Body.Promise.reject(new FetchError(`invalid json response body at ${_this2.url} reason: ${err.message}`, 'invalid-json'));
- }
- });
- },
+/***/ }),
- /**
- * Decode response as text
- *
- * @return Promise
- */
- text() {
- return consumeBody.call(this).then(function (buffer) {
- return buffer.toString();
- });
- },
+/***/ 2821:
+/***/ ((__unused_webpack_module, exports) => {
- /**
- * Decode response as buffer (non-spec api)
- *
- * @return Promise
- */
- buffer() {
- return consumeBody.call(this);
- },
- /**
- * Decode response as text, while automatically detecting the encoding and
- * trying to decode to UTF-8 (non-spec api)
- *
- * @return Promise
- */
- textConverted() {
- var _this3 = this;
-
- return consumeBody.call(this).then(function (buffer) {
- return convertBody(buffer, _this3.headers);
- });
- }
+const defaultOptions = {
+ preserveOrder: false,
+ attributeNamePrefix: '@_',
+ attributesGroupName: false,
+ textNodeName: '#text',
+ ignoreAttributes: true,
+ removeNSPrefix: false, // remove NS from tag name or attribute name if true
+ allowBooleanAttributes: false, //a tag can have attributes without any value
+ //ignoreRootElement : false,
+ parseTagValue: true,
+ parseAttributeValue: false,
+ trimValues: true, //Trim string values of tag and attributes
+ cdataPropName: false,
+ numberParseOptions: {
+ hex: true,
+ leadingZeros: true,
+ eNotation: true
+ },
+ tagValueProcessor: function(tagName, val) {
+ return val;
+ },
+ attributeValueProcessor: function(attrName, val) {
+ return val;
+ },
+ stopNodes: [], //nested tags will not be parsed even for errors
+ alwaysCreateTextNode: false,
+ isArray: () => false,
+ commentPropName: false,
+ unpairedTags: [],
+ processEntities: true,
+ htmlEntities: false,
+ ignoreDeclaration: false,
+ ignorePiTags: false,
+ transformTagName: false,
+ transformAttributeName: false,
+ updateTag: function(tagName, jPath, attrs){
+ return tagName
+ },
+ // skipEmptyListItem: false
+};
+
+const buildOptions = function(options) {
+ return Object.assign({}, defaultOptions, options);
};
-// In browsers, all properties are enumerable.
-Object.defineProperties(Body.prototype, {
- body: { enumerable: true },
- bodyUsed: { enumerable: true },
- arrayBuffer: { enumerable: true },
- blob: { enumerable: true },
- json: { enumerable: true },
- text: { enumerable: true }
-});
+exports.buildOptions = buildOptions;
+exports.defaultOptions = defaultOptions;
-Body.mixIn = function (proto) {
- for (const name of Object.getOwnPropertyNames(Body.prototype)) {
- // istanbul ignore else: future proof
- if (!(name in proto)) {
- const desc = Object.getOwnPropertyDescriptor(Body.prototype, name);
- Object.defineProperty(proto, name, desc);
- }
- }
-};
+/***/ }),
-/**
- * Consume and convert an entire Body to a Buffer.
- *
- * Ref: https://fetch.spec.whatwg.org/#concept-body-consume-body
- *
- * @return Promise
- */
-function consumeBody() {
- var _this4 = this;
+/***/ 5832:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
- if (this[INTERNALS].disturbed) {
- return Body.Promise.reject(new TypeError(`body used already for: ${this.url}`));
- }
+"use strict";
- this[INTERNALS].disturbed = true;
+///@ts-check
+
+const util = __nccwpck_require__(8280);
+const xmlNode = __nccwpck_require__(7462);
+const readDocType = __nccwpck_require__(6072);
+const toNumber = __nccwpck_require__(4526);
+
+// const regx =
+// '<((!\\[CDATA\\[([\\s\\S]*?)(]]>))|((NAME:)?(NAME))([^>]*)>|((\\/)(NAME)\\s*>))([^<]*)'
+// .replace(/NAME/g, util.nameRegexp);
+
+//const tagsRegx = new RegExp("<(\\/?[\\w:\\-\._]+)([^>]*)>(\\s*"+cdataRegx+")*([^<]+)?","g");
+//const tagsRegx = new RegExp("<(\\/?)((\\w*:)?([\\w:\\-\._]+))([^>]*)>([^<]*)("+cdataRegx+"([^<]*))*([^<]+)?","g");
+
+class OrderedObjParser{
+ constructor(options){
+ this.options = options;
+ this.currentNode = null;
+ this.tagsNodeStack = [];
+ this.docTypeEntities = {};
+ this.lastEntities = {
+ "apos" : { regex: /&(apos|#39|#x27);/g, val : "'"},
+ "gt" : { regex: /&(gt|#62|#x3E);/g, val : ">"},
+ "lt" : { regex: /&(lt|#60|#x3C);/g, val : "<"},
+ "quot" : { regex: /&(quot|#34|#x22);/g, val : "\""},
+ };
+ this.ampEntity = { regex: /&(amp|#38|#x26);/g, val : "&"};
+ this.htmlEntities = {
+ "space": { regex: /&(nbsp|#160);/g, val: " " },
+ // "lt" : { regex: /&(lt|#60);/g, val: "<" },
+ // "gt" : { regex: /&(gt|#62);/g, val: ">" },
+ // "amp" : { regex: /&(amp|#38);/g, val: "&" },
+ // "quot" : { regex: /&(quot|#34);/g, val: "\"" },
+ // "apos" : { regex: /&(apos|#39);/g, val: "'" },
+ "cent" : { regex: /&(cent|#162);/g, val: "¢" },
+ "pound" : { regex: /&(pound|#163);/g, val: "£" },
+ "yen" : { regex: /&(yen|#165);/g, val: "¥" },
+ "euro" : { regex: /&(euro|#8364);/g, val: "€" },
+ "copyright" : { regex: /&(copy|#169);/g, val: "©" },
+ "reg" : { regex: /&(reg|#174);/g, val: "®" },
+ "inr" : { regex: /&(inr|#8377);/g, val: "₹" },
+ "num_dec": { regex: /&#([0-9]{1,7});/g, val : (_, str) => String.fromCharCode(Number.parseInt(str, 10)) },
+ "num_hex": { regex: /&#x([0-9a-fA-F]{1,6});/g, val : (_, str) => String.fromCharCode(Number.parseInt(str, 16)) },
+ };
+ this.addExternalEntities = addExternalEntities;
+ this.parseXml = parseXml;
+ this.parseTextData = parseTextData;
+ this.resolveNameSpace = resolveNameSpace;
+ this.buildAttributesMap = buildAttributesMap;
+ this.isItStopNode = isItStopNode;
+ this.replaceEntitiesValue = replaceEntitiesValue;
+ this.readStopNodeData = readStopNodeData;
+ this.saveTextToParentTag = saveTextToParentTag;
+ this.addChild = addChild;
+ }
- if (this[INTERNALS].error) {
- return Body.Promise.reject(this[INTERNALS].error);
- }
+}
- let body = this.body;
+function addExternalEntities(externalEntities){
+ const entKeys = Object.keys(externalEntities);
+ for (let i = 0; i < entKeys.length; i++) {
+ const ent = entKeys[i];
+ this.lastEntities[ent] = {
+ regex: new RegExp("&"+ent+";","g"),
+ val : externalEntities[ent]
+ }
+ }
+}
- // body is null
- if (body === null) {
- return Body.Promise.resolve(Buffer.alloc(0));
- }
+/**
+ * @param {string} val
+ * @param {string} tagName
+ * @param {string} jPath
+ * @param {boolean} dontTrim
+ * @param {boolean} hasAttributes
+ * @param {boolean} isLeafNode
+ * @param {boolean} escapeEntities
+ */
+function parseTextData(val, tagName, jPath, dontTrim, hasAttributes, isLeafNode, escapeEntities) {
+ if (val !== undefined) {
+ if (this.options.trimValues && !dontTrim) {
+ val = val.trim();
+ }
+ if(val.length > 0){
+ if(!escapeEntities) val = this.replaceEntitiesValue(val);
+
+ const newval = this.options.tagValueProcessor(tagName, val, jPath, hasAttributes, isLeafNode);
+ if(newval === null || newval === undefined){
+ //don't parse
+ return val;
+ }else if(typeof newval !== typeof val || newval !== val){
+ //overwrite
+ return newval;
+ }else if(this.options.trimValues){
+ return parseValue(val, this.options.parseTagValue, this.options.numberParseOptions);
+ }else{
+ const trimmedVal = val.trim();
+ if(trimmedVal === val){
+ return parseValue(val, this.options.parseTagValue, this.options.numberParseOptions);
+ }else{
+ return val;
+ }
+ }
+ }
+ }
+}
- // body is blob
- if (isBlob(body)) {
- body = body.stream();
- }
+function resolveNameSpace(tagname) {
+ if (this.options.removeNSPrefix) {
+ const tags = tagname.split(':');
+ const prefix = tagname.charAt(0) === '/' ? '/' : '';
+ if (tags[0] === 'xmlns') {
+ return '';
+ }
+ if (tags.length === 2) {
+ tagname = prefix + tags[1];
+ }
+ }
+ return tagname;
+}
- // body is buffer
- if (Buffer.isBuffer(body)) {
- return Body.Promise.resolve(body);
- }
+//TODO: change regex to capture NS
+//const attrsRegx = new RegExp("([\\w\\-\\.\\:]+)\\s*=\\s*(['\"])((.|\n)*?)\\2","gm");
+const attrsRegx = new RegExp('([^\\s=]+)\\s*(=\\s*([\'"])([\\s\\S]*?)\\3)?', 'gm');
- // istanbul ignore if: should never happen
- if (!(body instanceof Stream)) {
- return Body.Promise.resolve(Buffer.alloc(0));
- }
+function buildAttributesMap(attrStr, jPath, tagName) {
+ if (!this.options.ignoreAttributes && typeof attrStr === 'string') {
+ // attrStr = attrStr.replace(/\r?\n/g, ' ');
+ //attrStr = attrStr || attrStr.trim();
- // body is stream
- // get ready to actually consume the body
- let accum = [];
- let accumBytes = 0;
- let abort = false;
-
- return new Body.Promise(function (resolve, reject) {
- let resTimeout;
-
- // allow timeout on slow response body
- if (_this4.timeout) {
- resTimeout = setTimeout(function () {
- abort = true;
- reject(new FetchError(`Response timeout while trying to fetch ${_this4.url} (over ${_this4.timeout}ms)`, 'body-timeout'));
- }, _this4.timeout);
- }
+ const matches = util.getAllMatches(attrStr, attrsRegx);
+ const len = matches.length; //don't make it inline
+ const attrs = {};
+ for (let i = 0; i < len; i++) {
+ const attrName = this.resolveNameSpace(matches[i][1]);
+ let oldVal = matches[i][4];
+ let aName = this.options.attributeNamePrefix + attrName;
+ if (attrName.length) {
+ if (this.options.transformAttributeName) {
+ aName = this.options.transformAttributeName(aName);
+ }
+ if(aName === "__proto__") aName = "#__proto__";
+ if (oldVal !== undefined) {
+ if (this.options.trimValues) {
+ oldVal = oldVal.trim();
+ }
+ oldVal = this.replaceEntitiesValue(oldVal);
+ const newVal = this.options.attributeValueProcessor(attrName, oldVal, jPath);
+ if(newVal === null || newVal === undefined){
+ //don't parse
+ attrs[aName] = oldVal;
+ }else if(typeof newVal !== typeof oldVal || newVal !== oldVal){
+ //overwrite
+ attrs[aName] = newVal;
+ }else{
+ //parse
+ attrs[aName] = parseValue(
+ oldVal,
+ this.options.parseAttributeValue,
+ this.options.numberParseOptions
+ );
+ }
+ } else if (this.options.allowBooleanAttributes) {
+ attrs[aName] = true;
+ }
+ }
+ }
+ if (!Object.keys(attrs).length) {
+ return;
+ }
+ if (this.options.attributesGroupName) {
+ const attrCollection = {};
+ attrCollection[this.options.attributesGroupName] = attrs;
+ return attrCollection;
+ }
+ return attrs
+ }
+}
+
+const parseXml = function(xmlData) {
+ xmlData = xmlData.replace(/\r\n?/g, "\n"); //TODO: remove this line
+ const xmlObj = new xmlNode('!xml');
+ let currentNode = xmlObj;
+ let textData = "";
+ let jPath = "";
+ for(let i=0; i< xmlData.length; i++){//for each char in XML data
+ const ch = xmlData[i];
+ if(ch === '<'){
+ // const nextIndex = i+1;
+ // const _2ndChar = xmlData[nextIndex];
+ if( xmlData[i+1] === '/') {//Closing Tag
+ const closeIndex = findClosingIndex(xmlData, ">", i, "Closing Tag is not closed.")
+ let tagName = xmlData.substring(i+2,closeIndex).trim();
+
+ if(this.options.removeNSPrefix){
+ const colonIndex = tagName.indexOf(":");
+ if(colonIndex !== -1){
+ tagName = tagName.substr(colonIndex+1);
+ }
+ }
- // handle stream errors
- body.on('error', function (err) {
- if (err.name === 'AbortError') {
- // if the request was aborted, reject with this Error
- abort = true;
- reject(err);
- } else {
- // other errors, such as incorrect content-encoding
- reject(new FetchError(`Invalid response body while trying to fetch ${_this4.url}: ${err.message}`, 'system', err));
- }
- });
+ if(this.options.transformTagName) {
+ tagName = this.options.transformTagName(tagName);
+ }
- body.on('data', function (chunk) {
- if (abort || chunk === null) {
- return;
- }
+ if(currentNode){
+ textData = this.saveTextToParentTag(textData, currentNode, jPath);
+ }
- if (_this4.size && accumBytes + chunk.length > _this4.size) {
- abort = true;
- reject(new FetchError(`content size at ${_this4.url} over limit: ${_this4.size}`, 'max-size'));
- return;
- }
+ //check if last tag of nested tag was unpaired tag
+ const lastTagName = jPath.substring(jPath.lastIndexOf(".")+1);
+ if(tagName && this.options.unpairedTags.indexOf(tagName) !== -1 ){
+ throw new Error(`Unpaired tag can not be used as closing tag: `);
+ }
+ let propIndex = 0
+ if(lastTagName && this.options.unpairedTags.indexOf(lastTagName) !== -1 ){
+ propIndex = jPath.lastIndexOf('.', jPath.lastIndexOf('.')-1)
+ this.tagsNodeStack.pop();
+ }else{
+ propIndex = jPath.lastIndexOf(".");
+ }
+ jPath = jPath.substring(0, propIndex);
- accumBytes += chunk.length;
- accum.push(chunk);
- });
+ currentNode = this.tagsNodeStack.pop();//avoid recursion, set the parent tag scope
+ textData = "";
+ i = closeIndex;
+ } else if( xmlData[i+1] === '?') {
- body.on('end', function () {
- if (abort) {
- return;
- }
+ let tagData = readTagExp(xmlData,i, false, "?>");
+ if(!tagData) throw new Error("Pi Tag is not closed.");
- clearTimeout(resTimeout);
+ textData = this.saveTextToParentTag(textData, currentNode, jPath);
+ if( (this.options.ignoreDeclaration && tagData.tagName === "?xml") || this.options.ignorePiTags){
- try {
- resolve(Buffer.concat(accum, accumBytes));
- } catch (err) {
- // handle streams that have accumulated too much data (issue #414)
- reject(new FetchError(`Could not create Buffer from response body for ${_this4.url}: ${err.message}`, 'system', err));
- }
- });
- });
-}
+ }else{
+
+ const childNode = new xmlNode(tagData.tagName);
+ childNode.add(this.options.textNodeName, "");
+
+ if(tagData.tagName !== tagData.tagExp && tagData.attrExpPresent){
+ childNode[":@"] = this.buildAttributesMap(tagData.tagExp, jPath, tagData.tagName);
+ }
+ this.addChild(currentNode, childNode, jPath)
-/**
- * Detect buffer encoding and convert to target encoding
- * ref: http://www.w3.org/TR/2011/WD-html5-20110113/parsing.html#determining-the-character-encoding
- *
- * @param Buffer buffer Incoming buffer
- * @param String encoding Target encoding
- * @return String
- */
-function convertBody(buffer, headers) {
- if (typeof convert !== 'function') {
- throw new Error('The package `encoding` must be installed to use the textConverted() function');
- }
+ }
- const ct = headers.get('content-type');
- let charset = 'utf-8';
- let res, str;
- // header
- if (ct) {
- res = /charset=([^;]*)/i.exec(ct);
- }
+ i = tagData.closeIndex + 1;
+ } else if(xmlData.substr(i + 1, 3) === '!--') {
+ const endIndex = findClosingIndex(xmlData, "-->", i+4, "Comment is not closed.")
+ if(this.options.commentPropName){
+ const comment = xmlData.substring(i + 4, endIndex - 2);
- // no charset in content type, peek at response body for at most 1024 bytes
- str = buffer.slice(0, 1024).toString();
+ textData = this.saveTextToParentTag(textData, currentNode, jPath);
- // html5
- if (!res && str) {
- res = /", i, "CDATA is not closed.") - 2;
+ const tagExp = xmlData.substring(i + 9,closeIndex);
- // html4
- if (!res && str) {
- res = / 0 && tagExp.lastIndexOf("/") === tagExp.length - 1){
+ if(tagName[tagName.length - 1] === "/"){ //remove trailing '/'
+ tagName = tagName.substr(0, tagName.length - 1);
+ jPath = jPath.substr(0, jPath.length - 1);
+ tagExp = tagName;
+ }else{
+ tagExp = tagExp.substr(0, tagExp.length - 1);
+ }
+ i = result.closeIndex;
+ }
+ //unpaired tag
+ else if(this.options.unpairedTags.indexOf(tagName) !== -1){
+
+ i = result.closeIndex;
+ }
+ //normal tag
+ else{
+ //read until closing tag is found
+ const result = this.readStopNodeData(xmlData, rawTagName, closeIndex + 1);
+ if(!result) throw new Error(`Unexpected end of ${rawTagName}`);
+ i = result.i;
+ tagContent = result.tagContent;
+ }
- // turn raw buffers into a single utf-8 buffer
- return convert(buffer, 'UTF-8', charset).toString();
+ const childNode = new xmlNode(tagName);
+ if(tagName !== tagExp && attrExpPresent){
+ childNode[":@"] = this.buildAttributesMap(tagExp, jPath, tagName);
+ }
+ if(tagContent) {
+ tagContent = this.parseTextData(tagContent, tagName, jPath, true, attrExpPresent, true, true);
+ }
+
+ jPath = jPath.substr(0, jPath.lastIndexOf("."));
+ childNode.add(this.options.textNodeName, tagContent);
+
+ this.addChild(currentNode, childNode, jPath)
+ }else{
+ //selfClosing tag
+ if(tagExp.length > 0 && tagExp.lastIndexOf("/") === tagExp.length - 1){
+ if(tagName[tagName.length - 1] === "/"){ //remove trailing '/'
+ tagName = tagName.substr(0, tagName.length - 1);
+ jPath = jPath.substr(0, jPath.length - 1);
+ tagExp = tagName;
+ }else{
+ tagExp = tagExp.substr(0, tagExp.length - 1);
+ }
+
+ if(this.options.transformTagName) {
+ tagName = this.options.transformTagName(tagName);
+ }
+
+ const childNode = new xmlNode(tagName);
+ if(tagName !== tagExp && attrExpPresent){
+ childNode[":@"] = this.buildAttributesMap(tagExp, jPath, tagName);
+ }
+ this.addChild(currentNode, childNode, jPath)
+ jPath = jPath.substr(0, jPath.lastIndexOf("."));
+ }
+ //opening tag
+ else{
+ const childNode = new xmlNode( tagName);
+ this.tagsNodeStack.push(currentNode);
+
+ if(tagName !== tagExp && attrExpPresent){
+ childNode[":@"] = this.buildAttributesMap(tagExp, jPath, tagName);
+ }
+ this.addChild(currentNode, childNode, jPath)
+ currentNode = childNode;
+ }
+ textData = "";
+ i = closeIndex;
+ }
+ }
+ }else{
+ textData += xmlData[i];
+ }
+ }
+ return xmlObj.child;
}
-/**
- * Detect a URLSearchParams object
- * ref: https://github.com/bitinn/node-fetch/issues/296#issuecomment-307598143
- *
- * @param Object obj Object to detect by type or brand
- * @return String
- */
-function isURLSearchParams(obj) {
- // Duck-typing as a necessary condition.
- if (typeof obj !== 'object' || typeof obj.append !== 'function' || typeof obj.delete !== 'function' || typeof obj.get !== 'function' || typeof obj.getAll !== 'function' || typeof obj.has !== 'function' || typeof obj.set !== 'function') {
- return false;
- }
+function addChild(currentNode, childNode, jPath){
+ const result = this.options.updateTag(childNode.tagname, jPath, childNode[":@"])
+ if(result === false){
+ }else if(typeof result === "string"){
+ childNode.tagname = result
+ currentNode.addChild(childNode);
+ }else{
+ currentNode.addChild(childNode);
+ }
+}
+
+const replaceEntitiesValue = function(val){
+
+ if(this.options.processEntities){
+ for(let entityName in this.docTypeEntities){
+ const entity = this.docTypeEntities[entityName];
+ val = val.replace( entity.regx, entity.val);
+ }
+ for(let entityName in this.lastEntities){
+ const entity = this.lastEntities[entityName];
+ val = val.replace( entity.regex, entity.val);
+ }
+ if(this.options.htmlEntities){
+ for(let entityName in this.htmlEntities){
+ const entity = this.htmlEntities[entityName];
+ val = val.replace( entity.regex, entity.val);
+ }
+ }
+ val = val.replace( this.ampEntity.regex, this.ampEntity.val);
+ }
+ return val;
+}
+function saveTextToParentTag(textData, currentNode, jPath, isLeafNode) {
+ if (textData) { //store previously collected data as textNode
+ if(isLeafNode === undefined) isLeafNode = Object.keys(currentNode.child).length === 0
+
+ textData = this.parseTextData(textData,
+ currentNode.tagname,
+ jPath,
+ false,
+ currentNode[":@"] ? Object.keys(currentNode[":@"]).length !== 0 : false,
+ isLeafNode);
- // Brand-checking and more duck-typing as optional condition.
- return obj.constructor.name === 'URLSearchParams' || Object.prototype.toString.call(obj) === '[object URLSearchParams]' || typeof obj.sort === 'function';
+ if (textData !== undefined && textData !== "")
+ currentNode.add(this.options.textNodeName, textData);
+ textData = "";
+ }
+ return textData;
}
+//TODO: use jPath to simplify the logic
/**
- * Check if `obj` is a W3C `Blob` object (which `File` inherits from)
- * @param {*} obj
- * @return {boolean}
+ *
+ * @param {string[]} stopNodes
+ * @param {string} jPath
+ * @param {string} currentTagName
*/
-function isBlob(obj) {
- return typeof obj === 'object' && typeof obj.arrayBuffer === 'function' && typeof obj.type === 'string' && typeof obj.stream === 'function' && typeof obj.constructor === 'function' && typeof obj.constructor.name === 'string' && /^(Blob|File)$/.test(obj.constructor.name) && /^(Blob|File)$/.test(obj[Symbol.toStringTag]);
+function isItStopNode(stopNodes, jPath, currentTagName){
+ const allNodesExp = "*." + currentTagName;
+ for (const stopNodePath in stopNodes) {
+ const stopNodeExp = stopNodes[stopNodePath];
+ if( allNodesExp === stopNodeExp || jPath === stopNodeExp ) return true;
+ }
+ return false;
}
/**
- * Clone body given Res/Req instance
- *
- * @param Mixed instance Response or Request instance
- * @return Mixed
+ * Returns the tag Expression and where it is ending handling single-double quotes situation
+ * @param {string} xmlData
+ * @param {number} i starting index
+ * @returns
*/
-function clone(instance) {
- let p1, p2;
- let body = instance.body;
+function tagExpWithClosingIndex(xmlData, i, closingChar = ">"){
+ let attrBoundary;
+ let tagExp = "";
+ for (let index = i; index < xmlData.length; index++) {
+ let ch = xmlData[index];
+ if (attrBoundary) {
+ if (ch === attrBoundary) attrBoundary = "";//reset
+ } else if (ch === '"' || ch === "'") {
+ attrBoundary = ch;
+ } else if (ch === closingChar[0]) {
+ if(closingChar[1]){
+ if(xmlData[index + 1] === closingChar[1]){
+ return {
+ data: tagExp,
+ index: index
+ }
+ }
+ }else{
+ return {
+ data: tagExp,
+ index: index
+ }
+ }
+ } else if (ch === '\t') {
+ ch = " "
+ }
+ tagExp += ch;
+ }
+}
- // don't allow cloning a used body
- if (instance.bodyUsed) {
- throw new Error('cannot clone body after it is used');
- }
+function findClosingIndex(xmlData, str, i, errMsg){
+ const closingIndex = xmlData.indexOf(str, i);
+ if(closingIndex === -1){
+ throw new Error(errMsg)
+ }else{
+ return closingIndex + str.length - 1;
+ }
+}
- // check that body is a stream and not form-data object
- // note: we can't clone the form-data object without having it as a dependency
- if (body instanceof Stream && typeof body.getBoundary !== 'function') {
- // tee instance body
- p1 = new PassThrough();
- p2 = new PassThrough();
- body.pipe(p1);
- body.pipe(p2);
- // set instance body to teed body and return the other teed body
- instance[INTERNALS].body = p1;
- body = p2;
- }
+function readTagExp(xmlData,i, removeNSPrefix, closingChar = ">"){
+ const result = tagExpWithClosingIndex(xmlData, i+1, closingChar);
+ if(!result) return;
+ let tagExp = result.data;
+ const closeIndex = result.index;
+ const separatorIndex = tagExp.search(/\s/);
+ let tagName = tagExp;
+ let attrExpPresent = true;
+ if(separatorIndex !== -1){//separate tag name and attributes expression
+ tagName = tagExp.substring(0, separatorIndex);
+ tagExp = tagExp.substring(separatorIndex + 1).trimStart();
+ }
+
+ const rawTagName = tagName;
+ if(removeNSPrefix){
+ const colonIndex = tagName.indexOf(":");
+ if(colonIndex !== -1){
+ tagName = tagName.substr(colonIndex+1);
+ attrExpPresent = tagName !== result.data.substr(colonIndex + 1);
+ }
+ }
- return body;
+ return {
+ tagName: tagName,
+ tagExp: tagExp,
+ closeIndex: closeIndex,
+ attrExpPresent: attrExpPresent,
+ rawTagName: rawTagName,
+ }
+}
+/**
+ * find paired tag for a stop node
+ * @param {string} xmlData
+ * @param {string} tagName
+ * @param {number} i
+ */
+function readStopNodeData(xmlData, tagName, i){
+ const startIndex = i;
+ // Starting at 1 since we already have an open tag
+ let openTagCount = 1;
+
+ for (; i < xmlData.length; i++) {
+ if( xmlData[i] === "<"){
+ if (xmlData[i+1] === "/") {//close tag
+ const closeIndex = findClosingIndex(xmlData, ">", i, `${tagName} is not closed`);
+ let closeTagName = xmlData.substring(i+2,closeIndex).trim();
+ if(closeTagName === tagName){
+ openTagCount--;
+ if (openTagCount === 0) {
+ return {
+ tagContent: xmlData.substring(startIndex, i),
+ i : closeIndex
+ }
+ }
+ }
+ i=closeIndex;
+ } else if(xmlData[i+1] === '?') {
+ const closeIndex = findClosingIndex(xmlData, "?>", i+1, "StopNode is not closed.")
+ i=closeIndex;
+ } else if(xmlData.substr(i + 1, 3) === '!--') {
+ const closeIndex = findClosingIndex(xmlData, "-->", i+3, "StopNode is not closed.")
+ i=closeIndex;
+ } else if(xmlData.substr(i + 1, 2) === '![') {
+ const closeIndex = findClosingIndex(xmlData, "]]>", i, "StopNode is not closed.") - 2;
+ i=closeIndex;
+ } else {
+ const tagData = readTagExp(xmlData, i, '>')
+
+ if (tagData) {
+ const openTagName = tagData && tagData.tagName;
+ if (openTagName === tagName && tagData.tagExp[tagData.tagExp.length-1] !== "/") {
+ openTagCount++;
+ }
+ i=tagData.closeIndex;
+ }
+ }
+ }
+ }//end for loop
}
-/**
- * Performs the operation "extract a `Content-Type` value from |object|" as
- * specified in the specification:
- * https://fetch.spec.whatwg.org/#concept-bodyinit-extract
- *
- * This function assumes that instance.body is present.
- *
- * @param Mixed instance Any options.body input
- */
-function extractContentType(body) {
- if (body === null) {
- // body is null
- return null;
- } else if (typeof body === 'string') {
- // body is string
- return 'text/plain;charset=UTF-8';
- } else if (isURLSearchParams(body)) {
- // body is a URLSearchParams
- return 'application/x-www-form-urlencoded;charset=UTF-8';
- } else if (isBlob(body)) {
- // body is blob
- return body.type || null;
- } else if (Buffer.isBuffer(body)) {
- // body is buffer
- return null;
- } else if (Object.prototype.toString.call(body) === '[object ArrayBuffer]') {
- // body is ArrayBuffer
- return null;
- } else if (ArrayBuffer.isView(body)) {
- // body is ArrayBufferView
- return null;
- } else if (typeof body.getBoundary === 'function') {
- // detect form data input from form-data module
- return `multipart/form-data;boundary=${body.getBoundary()}`;
- } else if (body instanceof Stream) {
- // body is stream
- // can't really do much about this
- return null;
- } else {
- // Body constructor defaults other things to string
- return 'text/plain;charset=UTF-8';
- }
+function parseValue(val, shouldParse, options) {
+ if (shouldParse && typeof val === 'string') {
+ //console.log(options)
+ const newval = val.trim();
+ if(newval === 'true' ) return true;
+ else if(newval === 'false' ) return false;
+ else return toNumber(val, options);
+ } else {
+ if (util.isExist(val)) {
+ return val;
+ } else {
+ return '';
+ }
+ }
}
-/**
- * The Fetch Standard treats this as if "total bytes" is a property on the body.
- * For us, we have to explicitly get it with a function.
- *
- * ref: https://fetch.spec.whatwg.org/#concept-body-total-bytes
- *
- * @param Body instance Instance of Body
- * @return Number? Number of bytes, or null if not possible
- */
-function getTotalBytes(instance) {
- const body = instance.body;
+module.exports = OrderedObjParser;
- if (body === null) {
- // body is null
- return 0;
- } else if (isBlob(body)) {
- return body.size;
- } else if (Buffer.isBuffer(body)) {
- // body is buffer
- return body.length;
- } else if (body && typeof body.getLengthSync === 'function') {
- // detect form data input from form-data module
- if (body._lengthRetrievers && body._lengthRetrievers.length == 0 || // 1.x
- body.hasKnownLength && body.hasKnownLength()) {
- // 2.x
- return body.getLengthSync();
- }
- return null;
- } else {
- // body is stream
- return null;
- }
+
+/***/ }),
+
+/***/ 2380:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
+
+const { buildOptions} = __nccwpck_require__(2821);
+const OrderedObjParser = __nccwpck_require__(5832);
+const { prettify} = __nccwpck_require__(2882);
+const validator = __nccwpck_require__(1739);
+
+class XMLParser{
+
+ constructor(options){
+ this.externalEntities = {};
+ this.options = buildOptions(options);
+
+ }
+ /**
+ * Parse XML dats to JS object
+ * @param {string|Buffer} xmlData
+ * @param {boolean|Object} validationOption
+ */
+ parse(xmlData,validationOption){
+ if(typeof xmlData === "string"){
+ }else if( xmlData.toString){
+ xmlData = xmlData.toString();
+ }else{
+ throw new Error("XML data is accepted in String or Bytes[] form.")
+ }
+ if( validationOption){
+ if(validationOption === true) validationOption = {}; //validate with default options
+
+ const result = validator.validate(xmlData, validationOption);
+ if (result !== true) {
+ throw Error( `${result.err.msg}:${result.err.line}:${result.err.col}` )
+ }
+ }
+ const orderedObjParser = new OrderedObjParser(this.options);
+ orderedObjParser.addExternalEntities(this.externalEntities);
+ const orderedResult = orderedObjParser.parseXml(xmlData);
+ if(this.options.preserveOrder || orderedResult === undefined) return orderedResult;
+ else return prettify(orderedResult, this.options);
+ }
+
+ /**
+ * Add Entity which is not by default supported by this library
+ * @param {string} key
+ * @param {string} value
+ */
+ addEntity(key, value){
+ if(value.indexOf("&") !== -1){
+ throw new Error("Entity value can't have '&'")
+ }else if(key.indexOf("&") !== -1 || key.indexOf(";") !== -1){
+ throw new Error("An entity must be set without '&' and ';'. Eg. use '#xD' for '
'")
+ }else if(value === "&"){
+ throw new Error("An entity with value '&' is not permitted");
+ }else{
+ this.externalEntities[key] = value;
+ }
+ }
}
+module.exports = XMLParser;
+
+/***/ }),
+
+/***/ 2882:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+
/**
- * Write a Body to a Node.js WritableStream (e.g. http.Request) object.
- *
- * @param Body instance Instance of Body
- * @return Void
- */
-function writeToStream(dest, instance) {
- const body = instance.body;
-
-
- if (body === null) {
- // body is null
- dest.end();
- } else if (isBlob(body)) {
- body.stream().pipe(dest);
- } else if (Buffer.isBuffer(body)) {
- // body is buffer
- dest.write(body);
- dest.end();
- } else {
- // body is stream
- body.pipe(dest);
- }
+ *
+ * @param {array} node
+ * @param {any} options
+ * @returns
+ */
+function prettify(node, options){
+ return compress( node, options);
}
-// expose Promise
-Body.Promise = global.Promise;
-
/**
- * headers.js
- *
- * Headers class offers convenient helpers
+ *
+ * @param {array} arr
+ * @param {object} options
+ * @param {string} jPath
+ * @returns object
*/
+function compress(arr, options, jPath){
+ let text;
+ const compressedObj = {};
+ for (let i = 0; i < arr.length; i++) {
+ const tagObj = arr[i];
+ const property = propName(tagObj);
+ let newJpath = "";
+ if(jPath === undefined) newJpath = property;
+ else newJpath = jPath + "." + property;
-const invalidTokenRegex = /[^\^_`a-zA-Z\-0-9!#$%&'*+.|~]/;
-const invalidHeaderCharRegex = /[^\t\x20-\x7e\x80-\xff]/;
+ if(property === options.textNodeName){
+ if(text === undefined) text = tagObj[property];
+ else text += "" + tagObj[property];
+ }else if(property === undefined){
+ continue;
+ }else if(tagObj[property]){
+
+ let val = compress(tagObj[property], options, newJpath);
+ const isLeaf = isLeafTag(val, options);
-function validateName(name) {
- name = `${name}`;
- if (invalidTokenRegex.test(name) || name === '') {
- throw new TypeError(`${name} is not a legal HTTP header name`);
- }
+ if(tagObj[":@"]){
+ assignAttributes( val, tagObj[":@"], newJpath, options);
+ }else if(Object.keys(val).length === 1 && val[options.textNodeName] !== undefined && !options.alwaysCreateTextNode){
+ val = val[options.textNodeName];
+ }else if(Object.keys(val).length === 0){
+ if(options.alwaysCreateTextNode) val[options.textNodeName] = "";
+ else val = "";
+ }
+
+ if(compressedObj[property] !== undefined && compressedObj.hasOwnProperty(property)) {
+ if(!Array.isArray(compressedObj[property])) {
+ compressedObj[property] = [ compressedObj[property] ];
+ }
+ compressedObj[property].push(val);
+ }else{
+ //TODO: if a node is not an array, then check if it should be an array
+ //also determine if it is a leaf node
+ if (options.isArray(property, newJpath, isLeaf )) {
+ compressedObj[property] = [val];
+ }else{
+ compressedObj[property] = val;
+ }
+ }
+ }
+
+ }
+ // if(text && text.length > 0) compressedObj[options.textNodeName] = text;
+ if(typeof text === "string"){
+ if(text.length > 0) compressedObj[options.textNodeName] = text;
+ }else if(text !== undefined) compressedObj[options.textNodeName] = text;
+ return compressedObj;
}
-function validateValue(value) {
- value = `${value}`;
- if (invalidHeaderCharRegex.test(value)) {
- throw new TypeError(`${value} is not a legal HTTP header value`);
- }
+function propName(obj){
+ const keys = Object.keys(obj);
+ for (let i = 0; i < keys.length; i++) {
+ const key = keys[i];
+ if(key !== ":@") return key;
+ }
}
-/**
- * Find the key in the map object given a header name.
- *
- * Returns undefined if not found.
- *
- * @param String name Header name
- * @return String|Undefined
- */
-function find(map, name) {
- name = name.toLowerCase();
- for (const key in map) {
- if (key.toLowerCase() === name) {
- return key;
- }
- }
- return undefined;
+function assignAttributes(obj, attrMap, jpath, options){
+ if (attrMap) {
+ const keys = Object.keys(attrMap);
+ const len = keys.length; //don't make it inline
+ for (let i = 0; i < len; i++) {
+ const atrrName = keys[i];
+ if (options.isArray(atrrName, jpath + "." + atrrName, true, true)) {
+ obj[atrrName] = [ attrMap[atrrName] ];
+ } else {
+ obj[atrrName] = attrMap[atrrName];
+ }
+ }
+ }
}
-const MAP = Symbol('map');
-class Headers {
- /**
- * Headers class
- *
- * @param Object headers Response headers
- * @return Void
- */
- constructor() {
- let init = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : undefined;
-
- this[MAP] = Object.create(null);
-
- if (init instanceof Headers) {
- const rawHeaders = init.raw();
- const headerNames = Object.keys(rawHeaders);
-
- for (const headerName of headerNames) {
- for (const value of rawHeaders[headerName]) {
- this.append(headerName, value);
- }
- }
-
- return;
- }
+function isLeafTag(obj, options){
+ const { textNodeName } = options;
+ const propCount = Object.keys(obj).length;
+
+ if (propCount === 0) {
+ return true;
+ }
- // We don't worry about converting prop to ByteString here as append()
- // will handle it.
- if (init == null) ; else if (typeof init === 'object') {
- const method = init[Symbol.iterator];
- if (method != null) {
- if (typeof method !== 'function') {
- throw new TypeError('Header pairs must be iterable');
- }
+ if (
+ propCount === 1 &&
+ (obj[textNodeName] || typeof obj[textNodeName] === "boolean" || obj[textNodeName] === 0)
+ ) {
+ return true;
+ }
- // sequence>
- // Note: per spec we have to first exhaust the lists then process them
- const pairs = [];
- for (const pair of init) {
- if (typeof pair !== 'object' || typeof pair[Symbol.iterator] !== 'function') {
- throw new TypeError('Each header pair must be iterable');
- }
- pairs.push(Array.from(pair));
- }
+ return false;
+}
+exports.prettify = prettify;
- for (const pair of pairs) {
- if (pair.length !== 2) {
- throw new TypeError('Each header pair must be a name/value tuple');
- }
- this.append(pair[0], pair[1]);
- }
- } else {
- // record
- for (const key of Object.keys(init)) {
- const value = init[key];
- this.append(key, value);
- }
- }
- } else {
- throw new TypeError('Provided initializer must be an object');
- }
- }
- /**
- * Return combined header value given name
- *
- * @param String name Header name
- * @return Mixed
- */
- get(name) {
- name = `${name}`;
- validateName(name);
- const key = find(this[MAP], name);
- if (key === undefined) {
- return null;
- }
+/***/ }),
- return this[MAP][key].join(', ');
- }
+/***/ 7462:
+/***/ ((module) => {
- /**
- * Iterate over all headers
- *
- * @param Function callback Executed for each item with parameters (value, name, thisArg)
- * @param Boolean thisArg `this` context for callback function
- * @return Void
- */
- forEach(callback) {
- let thisArg = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : undefined;
-
- let pairs = getHeaders(this);
- let i = 0;
- while (i < pairs.length) {
- var _pairs$i = pairs[i];
- const name = _pairs$i[0],
- value = _pairs$i[1];
-
- callback.call(thisArg, value, name, this);
- pairs = getHeaders(this);
- i++;
- }
- }
+"use strict";
- /**
- * Overwrite header values given name
- *
- * @param String name Header name
- * @param String value Header value
- * @return Void
- */
- set(name, value) {
- name = `${name}`;
- value = `${value}`;
- validateName(name);
- validateValue(value);
- const key = find(this[MAP], name);
- this[MAP][key !== undefined ? key : name] = [value];
- }
- /**
- * Append a value onto existing header
- *
- * @param String name Header name
- * @param String value Header value
- * @return Void
- */
- append(name, value) {
- name = `${name}`;
- value = `${value}`;
- validateName(name);
- validateValue(value);
- const key = find(this[MAP], name);
- if (key !== undefined) {
- this[MAP][key].push(value);
- } else {
- this[MAP][name] = [value];
- }
- }
+class XmlNode{
+ constructor(tagname) {
+ this.tagname = tagname;
+ this.child = []; //nested tags, text, cdata, comments in order
+ this[":@"] = {}; //attributes map
+ }
+ add(key,val){
+ // this.child.push( {name : key, val: val, isCdata: isCdata });
+ if(key === "__proto__") key = "#__proto__";
+ this.child.push( {[key]: val });
+ }
+ addChild(node) {
+ if(node.tagname === "__proto__") node.tagname = "#__proto__";
+ if(node[":@"] && Object.keys(node[":@"]).length > 0){
+ this.child.push( { [node.tagname]: node.child, [":@"]: node[":@"] });
+ }else{
+ this.child.push( { [node.tagname]: node.child });
+ }
+ };
+};
- /**
- * Check for header name existence
- *
- * @param String name Header name
- * @return Boolean
- */
- has(name) {
- name = `${name}`;
- validateName(name);
- return find(this[MAP], name) !== undefined;
- }
- /**
- * Delete all header values given name
- *
- * @param String name Header name
- * @return Void
- */
- delete(name) {
- name = `${name}`;
- validateName(name);
- const key = find(this[MAP], name);
- if (key !== undefined) {
- delete this[MAP][key];
- }
- }
+module.exports = XmlNode;
- /**
- * Return raw headers (non-spec api)
- *
- * @return Object
- */
- raw() {
- return this[MAP];
- }
+/***/ }),
- /**
- * Get an iterator on keys.
- *
- * @return Iterator
- */
- keys() {
- return createHeadersIterator(this, 'key');
- }
+/***/ 1621:
+/***/ ((module) => {
- /**
- * Get an iterator on values.
- *
- * @return Iterator
- */
- values() {
- return createHeadersIterator(this, 'value');
- }
+"use strict";
- /**
- * Get an iterator on entries.
- *
- * This is the default iterator of the Headers object.
- *
- * @return Iterator
- */
- [Symbol.iterator]() {
- return createHeadersIterator(this, 'key+value');
- }
-}
-Headers.prototype.entries = Headers.prototype[Symbol.iterator];
-Object.defineProperty(Headers.prototype, Symbol.toStringTag, {
- value: 'Headers',
- writable: false,
- enumerable: false,
- configurable: true
-});
+module.exports = (flag, argv = process.argv) => {
+ const prefix = flag.startsWith('-') ? '' : (flag.length === 1 ? '-' : '--');
+ const position = argv.indexOf(prefix + flag);
+ const terminatorPosition = argv.indexOf('--');
+ return position !== -1 && (terminatorPosition === -1 || position < terminatorPosition);
+};
-Object.defineProperties(Headers.prototype, {
- get: { enumerable: true },
- forEach: { enumerable: true },
- set: { enumerable: true },
- append: { enumerable: true },
- has: { enumerable: true },
- delete: { enumerable: true },
- keys: { enumerable: true },
- values: { enumerable: true },
- entries: { enumerable: true }
-});
-function getHeaders(headers) {
- let kind = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : 'key+value';
+/***/ }),
- const keys = Object.keys(headers[MAP]).sort();
- return keys.map(kind === 'key' ? function (k) {
- return k.toLowerCase();
- } : kind === 'value' ? function (k) {
- return headers[MAP][k].join(', ');
- } : function (k) {
- return [k.toLowerCase(), headers[MAP][k].join(', ')];
- });
-}
+/***/ 3764:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
-const INTERNAL = Symbol('internal');
+"use strict";
-function createHeadersIterator(target, kind) {
- const iterator = Object.create(HeadersIteratorPrototype);
- iterator[INTERNAL] = {
- target,
- kind,
- index: 0
- };
- return iterator;
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ var desc = Object.getOwnPropertyDescriptor(m, k);
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+ desc = { enumerable: true, get: function() { return m[k]; } };
+ }
+ Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+ o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+ if (mod && mod.__esModule) return mod;
+ var result = {};
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+ __setModuleDefault(result, mod);
+ return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+ return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.HttpProxyAgent = void 0;
+const net = __importStar(__nccwpck_require__(1808));
+const tls = __importStar(__nccwpck_require__(4404));
+const debug_1 = __importDefault(__nccwpck_require__(8237));
+const events_1 = __nccwpck_require__(2361);
+const agent_base_1 = __nccwpck_require__(694);
+const url_1 = __nccwpck_require__(7310);
+const debug = (0, debug_1.default)('http-proxy-agent');
+/**
+ * The `HttpProxyAgent` implements an HTTP Agent subclass that connects
+ * to the specified "HTTP proxy server" in order to proxy HTTP requests.
+ */
+class HttpProxyAgent extends agent_base_1.Agent {
+ constructor(proxy, opts) {
+ super(opts);
+ this.proxy = typeof proxy === 'string' ? new url_1.URL(proxy) : proxy;
+ this.proxyHeaders = opts?.headers ?? {};
+ debug('Creating new HttpProxyAgent instance: %o', this.proxy.href);
+ // Trim off the brackets from IPv6 addresses
+ const host = (this.proxy.hostname || this.proxy.host).replace(/^\[|\]$/g, '');
+ const port = this.proxy.port
+ ? parseInt(this.proxy.port, 10)
+ : this.proxy.protocol === 'https:'
+ ? 443
+ : 80;
+ this.connectOpts = {
+ ...(opts ? omit(opts, 'headers') : null),
+ host,
+ port,
+ };
+ }
+ addRequest(req, opts) {
+ req._header = null;
+ this.setRequestProps(req, opts);
+ // @ts-expect-error `addRequest()` isn't defined in `@types/node`
+ super.addRequest(req, opts);
+ }
+ setRequestProps(req, opts) {
+ const { proxy } = this;
+ const protocol = opts.secureEndpoint ? 'https:' : 'http:';
+ const hostname = req.getHeader('host') || 'localhost';
+ const base = `${protocol}//${hostname}`;
+ const url = new url_1.URL(req.path, base);
+ if (opts.port !== 80) {
+ url.port = String(opts.port);
+ }
+ // Change the `http.ClientRequest` instance's "path" field
+ // to the absolute path of the URL that will be requested.
+ req.path = String(url);
+ // Inject the `Proxy-Authorization` header if necessary.
+ const headers = typeof this.proxyHeaders === 'function'
+ ? this.proxyHeaders()
+ : { ...this.proxyHeaders };
+ if (proxy.username || proxy.password) {
+ const auth = `${decodeURIComponent(proxy.username)}:${decodeURIComponent(proxy.password)}`;
+ headers['Proxy-Authorization'] = `Basic ${Buffer.from(auth).toString('base64')}`;
+ }
+ if (!headers['Proxy-Connection']) {
+ headers['Proxy-Connection'] = this.keepAlive
+ ? 'Keep-Alive'
+ : 'close';
+ }
+ for (const name of Object.keys(headers)) {
+ const value = headers[name];
+ if (value) {
+ req.setHeader(name, value);
+ }
+ }
+ }
+ async connect(req, opts) {
+ req._header = null;
+ if (!req.path.includes('://')) {
+ this.setRequestProps(req, opts);
+ }
+ // At this point, the http ClientRequest's internal `_header` field
+ // might have already been set. If this is the case then we'll need
+ // to re-generate the string since we just changed the `req.path`.
+ let first;
+ let endOfHeaders;
+ debug('Regenerating stored HTTP header string for request');
+ req._implicitHeader();
+ if (req.outputData && req.outputData.length > 0) {
+ debug('Patching connection write() output buffer with updated header');
+ first = req.outputData[0].data;
+ endOfHeaders = first.indexOf('\r\n\r\n') + 4;
+ req.outputData[0].data =
+ req._header + first.substring(endOfHeaders);
+ debug('Output buffer: %o', req.outputData[0].data);
+ }
+ // Create a socket connection to the proxy server.
+ let socket;
+ if (this.proxy.protocol === 'https:') {
+ debug('Creating `tls.Socket`: %o', this.connectOpts);
+ socket = tls.connect(this.connectOpts);
+ }
+ else {
+ debug('Creating `net.Socket`: %o', this.connectOpts);
+ socket = net.connect(this.connectOpts);
+ }
+ // Wait for the socket's `connect` event, so that this `callback()`
+ // function throws instead of the `http` request machinery. This is
+ // important for i.e. `PacProxyAgent` which determines a failed proxy
+ // connection via the `callback()` function throwing.
+ await (0, events_1.once)(socket, 'connect');
+ return socket;
+ }
}
+HttpProxyAgent.protocols = ['http', 'https'];
+exports.HttpProxyAgent = HttpProxyAgent;
+function omit(obj, ...keys) {
+ const ret = {};
+ let key;
+ for (key in obj) {
+ if (!keys.includes(key)) {
+ ret[key] = obj[key];
+ }
+ }
+ return ret;
+}
+//# sourceMappingURL=index.js.map
-const HeadersIteratorPrototype = Object.setPrototypeOf({
- next() {
- // istanbul ignore if
- if (!this || Object.getPrototypeOf(this) !== HeadersIteratorPrototype) {
- throw new TypeError('Value of `this` is not a HeadersIterator');
- }
-
- var _INTERNAL = this[INTERNAL];
- const target = _INTERNAL.target,
- kind = _INTERNAL.kind,
- index = _INTERNAL.index;
-
- const values = getHeaders(target, kind);
- const len = values.length;
- if (index >= len) {
- return {
- value: undefined,
- done: true
- };
- }
+/***/ }),
- this[INTERNAL].index = index + 1;
+/***/ 7219:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
- return {
- value: values[index],
- done: false
- };
- }
-}, Object.getPrototypeOf(Object.getPrototypeOf([][Symbol.iterator]())));
+"use strict";
-Object.defineProperty(HeadersIteratorPrototype, Symbol.toStringTag, {
- value: 'HeadersIterator',
- writable: false,
- enumerable: false,
- configurable: true
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ var desc = Object.getOwnPropertyDescriptor(m, k);
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+ desc = { enumerable: true, get: function() { return m[k]; } };
+ }
+ Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+ if (k2 === undefined) k2 = k;
+ o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+ o["default"] = v;
});
-
+var __importStar = (this && this.__importStar) || function (mod) {
+ if (mod && mod.__esModule) return mod;
+ var result = {};
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+ __setModuleDefault(result, mod);
+ return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+ return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.HttpsProxyAgent = void 0;
+const net = __importStar(__nccwpck_require__(1808));
+const tls = __importStar(__nccwpck_require__(4404));
+const assert_1 = __importDefault(__nccwpck_require__(9491));
+const debug_1 = __importDefault(__nccwpck_require__(8237));
+const agent_base_1 = __nccwpck_require__(694);
+const url_1 = __nccwpck_require__(7310);
+const parse_proxy_response_1 = __nccwpck_require__(595);
+const debug = (0, debug_1.default)('https-proxy-agent');
/**
- * Export the Headers object in a form that Node.js can consume.
+ * The `HttpsProxyAgent` implements an HTTP Agent subclass that connects to
+ * the specified "HTTP(s) proxy server" in order to proxy HTTPS requests.
*
- * @param Headers headers
- * @return Object
- */
-function exportNodeCompatibleHeaders(headers) {
- const obj = Object.assign({ __proto__: null }, headers[MAP]);
-
- // http.request() only supports string as Host header. This hack makes
- // specifying custom Host header possible.
- const hostHeaderKey = find(headers[MAP], 'Host');
- if (hostHeaderKey !== undefined) {
- obj[hostHeaderKey] = obj[hostHeaderKey][0];
- }
-
- return obj;
-}
-
-/**
- * Create a Headers object from an object of headers, ignoring those that do
- * not conform to HTTP grammar productions.
+ * Outgoing HTTP requests are first tunneled through the proxy server using the
+ * `CONNECT` HTTP request method to establish a connection to the proxy server,
+ * and then the proxy server connects to the destination target and issues the
+ * HTTP request from the proxy server.
*
- * @param Object obj Object of headers
- * @return Headers
- */
-function createHeadersLenient(obj) {
- const headers = new Headers();
- for (const name of Object.keys(obj)) {
- if (invalidTokenRegex.test(name)) {
- continue;
- }
- if (Array.isArray(obj[name])) {
- for (const val of obj[name]) {
- if (invalidHeaderCharRegex.test(val)) {
- continue;
- }
- if (headers[MAP][name] === undefined) {
- headers[MAP][name] = [val];
- } else {
- headers[MAP][name].push(val);
- }
- }
- } else if (!invalidHeaderCharRegex.test(obj[name])) {
- headers[MAP][name] = [obj[name]];
- }
- }
- return headers;
+ * `https:` requests have their socket connection upgraded to TLS once
+ * the connection to the proxy server has been established.
+ */
+class HttpsProxyAgent extends agent_base_1.Agent {
+ constructor(proxy, opts) {
+ super(opts);
+ this.options = { path: undefined };
+ this.proxy = typeof proxy === 'string' ? new url_1.URL(proxy) : proxy;
+ this.proxyHeaders = opts?.headers ?? {};
+ debug('Creating new HttpsProxyAgent instance: %o', this.proxy.href);
+ // Trim off the brackets from IPv6 addresses
+ const host = (this.proxy.hostname || this.proxy.host).replace(/^\[|\]$/g, '');
+ const port = this.proxy.port
+ ? parseInt(this.proxy.port, 10)
+ : this.proxy.protocol === 'https:'
+ ? 443
+ : 80;
+ this.connectOpts = {
+ // Attempt to negotiate http/1.1 for proxy servers that support http/2
+ ALPNProtocols: ['http/1.1'],
+ ...(opts ? omit(opts, 'headers') : null),
+ host,
+ port,
+ };
+ }
+ /**
+ * Called when the node-core HTTP client library is creating a
+ * new HTTP request.
+ */
+ async connect(req, opts) {
+ const { proxy } = this;
+ if (!opts.host) {
+ throw new TypeError('No "host" provided');
+ }
+ // Create a socket connection to the proxy server.
+ let socket;
+ if (proxy.protocol === 'https:') {
+ debug('Creating `tls.Socket`: %o', this.connectOpts);
+ const servername = this.connectOpts.servername || this.connectOpts.host;
+ socket = tls.connect({
+ ...this.connectOpts,
+ servername,
+ });
+ }
+ else {
+ debug('Creating `net.Socket`: %o', this.connectOpts);
+ socket = net.connect(this.connectOpts);
+ }
+ const headers = typeof this.proxyHeaders === 'function'
+ ? this.proxyHeaders()
+ : { ...this.proxyHeaders };
+ const host = net.isIPv6(opts.host) ? `[${opts.host}]` : opts.host;
+ let payload = `CONNECT ${host}:${opts.port} HTTP/1.1\r\n`;
+ // Inject the `Proxy-Authorization` header if necessary.
+ if (proxy.username || proxy.password) {
+ const auth = `${decodeURIComponent(proxy.username)}:${decodeURIComponent(proxy.password)}`;
+ headers['Proxy-Authorization'] = `Basic ${Buffer.from(auth).toString('base64')}`;
+ }
+ headers.Host = `${host}:${opts.port}`;
+ if (!headers['Proxy-Connection']) {
+ headers['Proxy-Connection'] = this.keepAlive
+ ? 'Keep-Alive'
+ : 'close';
+ }
+ for (const name of Object.keys(headers)) {
+ payload += `${name}: ${headers[name]}\r\n`;
+ }
+ const proxyResponsePromise = (0, parse_proxy_response_1.parseProxyResponse)(socket);
+ socket.write(`${payload}\r\n`);
+ const { connect, buffered } = await proxyResponsePromise;
+ req.emit('proxyConnect', connect);
+ this.emit('proxyConnect', connect, req);
+ if (connect.statusCode === 200) {
+ req.once('socket', resume);
+ if (opts.secureEndpoint) {
+ // The proxy is connecting to a TLS server, so upgrade
+ // this socket connection to a TLS connection.
+ debug('Upgrading socket connection to TLS');
+ const servername = opts.servername || opts.host;
+ return tls.connect({
+ ...omit(opts, 'host', 'path', 'port'),
+ socket,
+ servername,
+ });
+ }
+ return socket;
+ }
+ // Some other status code that's not 200... need to re-play the HTTP
+ // header "data" events onto the socket once the HTTP machinery is
+ // attached so that the node core `http` can parse and handle the
+ // error status code.
+ // Close the original socket, and a new "fake" socket is returned
+ // instead, so that the proxy doesn't get the HTTP request
+ // written to it (which may contain `Authorization` headers or other
+ // sensitive data).
+ //
+ // See: https://hackerone.com/reports/541502
+ socket.destroy();
+ const fakeSocket = new net.Socket({ writable: false });
+ fakeSocket.readable = true;
+ // Need to wait for the "socket" event to re-play the "data" events.
+ req.once('socket', (s) => {
+ debug('Replaying proxy buffer for failed request');
+ (0, assert_1.default)(s.listenerCount('data') > 0);
+ // Replay the "buffered" Buffer onto the fake `socket`, since at
+ // this point the HTTP module machinery has been hooked up for
+ // the user.
+ s.push(buffered);
+ s.push(null);
+ });
+ return fakeSocket;
+ }
}
+HttpsProxyAgent.protocols = ['http', 'https'];
+exports.HttpsProxyAgent = HttpsProxyAgent;
+function resume(socket) {
+ socket.resume();
+}
+function omit(obj, ...keys) {
+ const ret = {};
+ let key;
+ for (key in obj) {
+ if (!keys.includes(key)) {
+ ret[key] = obj[key];
+ }
+ }
+ return ret;
+}
+//# sourceMappingURL=index.js.map
-const INTERNALS$1 = Symbol('Response internals');
-
-// fix an issue where "STATUS_CODES" aren't a named export for node <10
-const STATUS_CODES = http.STATUS_CODES;
-
-/**
- * Response class
- *
- * @param Stream body Readable stream
- * @param Object opts Response options
- * @return Void
- */
-class Response {
- constructor() {
- let body = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
- let opts = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-
- Body.call(this, body, opts);
-
- const status = opts.status || 200;
- const headers = new Headers(opts.headers);
+/***/ }),
- if (body != null && !headers.has('Content-Type')) {
- const contentType = extractContentType(body);
- if (contentType) {
- headers.append('Content-Type', contentType);
- }
- }
+/***/ 595:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
- this[INTERNALS$1] = {
- url: opts.url,
- status,
- statusText: opts.statusText || STATUS_CODES[status],
- headers,
- counter: opts.counter
- };
- }
+"use strict";
- get url() {
- return this[INTERNALS$1].url || '';
- }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+ return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.parseProxyResponse = void 0;
+const debug_1 = __importDefault(__nccwpck_require__(8237));
+const debug = (0, debug_1.default)('https-proxy-agent:parse-proxy-response');
+function parseProxyResponse(socket) {
+ return new Promise((resolve, reject) => {
+ // we need to buffer any HTTP traffic that happens with the proxy before we get
+ // the CONNECT response, so that if the response is anything other than an "200"
+ // response code, then we can re-play the "data" events on the socket once the
+ // HTTP parser is hooked up...
+ let buffersLength = 0;
+ const buffers = [];
+ function read() {
+ const b = socket.read();
+ if (b)
+ ondata(b);
+ else
+ socket.once('readable', read);
+ }
+ function cleanup() {
+ socket.removeListener('end', onend);
+ socket.removeListener('error', onerror);
+ socket.removeListener('readable', read);
+ }
+ function onend() {
+ cleanup();
+ debug('onend');
+ reject(new Error('Proxy connection ended before receiving CONNECT response'));
+ }
+ function onerror(err) {
+ cleanup();
+ debug('onerror %o', err);
+ reject(err);
+ }
+ function ondata(b) {
+ buffers.push(b);
+ buffersLength += b.length;
+ const buffered = Buffer.concat(buffers, buffersLength);
+ const endOfHeaders = buffered.indexOf('\r\n\r\n');
+ if (endOfHeaders === -1) {
+ // keep buffering
+ debug('have not received end of HTTP headers yet...');
+ read();
+ return;
+ }
+ const headerParts = buffered
+ .slice(0, endOfHeaders)
+ .toString('ascii')
+ .split('\r\n');
+ const firstLine = headerParts.shift();
+ if (!firstLine) {
+ socket.destroy();
+ return reject(new Error('No header received from proxy CONNECT response'));
+ }
+ const firstLineParts = firstLine.split(' ');
+ const statusCode = +firstLineParts[1];
+ const statusText = firstLineParts.slice(2).join(' ');
+ const headers = {};
+ for (const header of headerParts) {
+ if (!header)
+ continue;
+ const firstColon = header.indexOf(':');
+ if (firstColon === -1) {
+ socket.destroy();
+ return reject(new Error(`Invalid header from proxy CONNECT response: "${header}"`));
+ }
+ const key = header.slice(0, firstColon).toLowerCase();
+ const value = header.slice(firstColon + 1).trimStart();
+ const current = headers[key];
+ if (typeof current === 'string') {
+ headers[key] = [current, value];
+ }
+ else if (Array.isArray(current)) {
+ current.push(value);
+ }
+ else {
+ headers[key] = value;
+ }
+ }
+ debug('got proxy server response: %o %o', firstLine, headers);
+ cleanup();
+ resolve({
+ connect: {
+ statusCode,
+ statusText,
+ headers,
+ },
+ buffered,
+ });
+ }
+ socket.on('error', onerror);
+ socket.on('end', onend);
+ read();
+ });
+}
+exports.parseProxyResponse = parseProxyResponse;
+//# sourceMappingURL=parse-proxy-response.js.map
- get status() {
- return this[INTERNALS$1].status;
- }
+/***/ }),
- /**
- * Convenience property representing if the request ended normally
- */
- get ok() {
- return this[INTERNALS$1].status >= 200 && this[INTERNALS$1].status < 300;
- }
+/***/ 3973:
+/***/ ((module, __unused_webpack_exports, __nccwpck_require__) => {
- get redirected() {
- return this[INTERNALS$1].counter > 0;
- }
+module.exports = minimatch
+minimatch.Minimatch = Minimatch
- get statusText() {
- return this[INTERNALS$1].statusText;
- }
+var path = (function () { try { return __nccwpck_require__(1017) } catch (e) {}}()) || {
+ sep: '/'
+}
+minimatch.sep = path.sep
- get headers() {
- return this[INTERNALS$1].headers;
- }
+var GLOBSTAR = minimatch.GLOBSTAR = Minimatch.GLOBSTAR = {}
+var expand = __nccwpck_require__(3717)
- /**
- * Clone this response
- *
- * @return Response
- */
- clone() {
- return new Response(clone(this), {
- url: this.url,
- status: this.status,
- statusText: this.statusText,
- headers: this.headers,
- ok: this.ok,
- redirected: this.redirected
- });
- }
+var plTypes = {
+ '!': { open: '(?:(?!(?:', close: '))[^/]*?)'},
+ '?': { open: '(?:', close: ')?' },
+ '+': { open: '(?:', close: ')+' },
+ '*': { open: '(?:', close: ')*' },
+ '@': { open: '(?:', close: ')' }
}
-Body.mixIn(Response.prototype);
-
-Object.defineProperties(Response.prototype, {
- url: { enumerable: true },
- status: { enumerable: true },
- ok: { enumerable: true },
- redirected: { enumerable: true },
- statusText: { enumerable: true },
- headers: { enumerable: true },
- clone: { enumerable: true }
-});
+// any single thing other than /
+// don't need to escape / when using new RegExp()
+var qmark = '[^/]'
-Object.defineProperty(Response.prototype, Symbol.toStringTag, {
- value: 'Response',
- writable: false,
- enumerable: false,
- configurable: true
-});
+// * => any number of characters
+var star = qmark + '*?'
-const INTERNALS$2 = Symbol('Request internals');
-const URL = Url.URL || whatwgUrl.URL;
+// ** when dots are allowed. Anything goes, except .. and .
+// not (^ or / followed by one or two dots followed by $ or /),
+// followed by anything, any number of times.
+var twoStarDot = '(?:(?!(?:\\\/|^)(?:\\.{1,2})($|\\\/)).)*?'
-// fix an issue where "format", "parse" aren't a named export for node <10
-const parse_url = Url.parse;
-const format_url = Url.format;
+// not a ^ or / followed by a dot,
+// followed by anything, any number of times.
+var twoStarNoDot = '(?:(?!(?:\\\/|^)\\.).)*?'
-/**
- * Wrapper around `new URL` to handle arbitrary URLs
- *
- * @param {string} urlStr
- * @return {void}
- */
-function parseURL(urlStr) {
- /*
- Check whether the URL is absolute or not
- Scheme: https://tools.ietf.org/html/rfc3986#section-3.1
- Absolute URL: https://tools.ietf.org/html/rfc3986#section-4.3
- */
- if (/^[a-zA-Z][a-zA-Z\d+\-.]*:/.exec(urlStr)) {
- urlStr = new URL(urlStr).toString();
- }
+// characters that need to be escaped in RegExp.
+var reSpecials = charSet('().*{}+?[]^$\\!')
- // Fallback to old implementation for arbitrary URLs
- return parse_url(urlStr);
+// "abc" -> { a:true, b:true, c:true }
+function charSet (s) {
+ return s.split('').reduce(function (set, c) {
+ set[c] = true
+ return set
+ }, {})
}
-const streamDestructionSupported = 'destroy' in Stream.Readable.prototype;
+// normalizes slashes.
+var slashSplit = /\/+/
-/**
- * Check if a value is an instance of Request.
- *
- * @param Mixed input
- * @return Boolean
- */
-function isRequest(input) {
- return typeof input === 'object' && typeof input[INTERNALS$2] === 'object';
+minimatch.filter = filter
+function filter (pattern, options) {
+ options = options || {}
+ return function (p, i, list) {
+ return minimatch(p, pattern, options)
+ }
}
-function isAbortSignal(signal) {
- const proto = signal && typeof signal === 'object' && Object.getPrototypeOf(signal);
- return !!(proto && proto.constructor.name === 'AbortSignal');
+function ext (a, b) {
+ b = b || {}
+ var t = {}
+ Object.keys(a).forEach(function (k) {
+ t[k] = a[k]
+ })
+ Object.keys(b).forEach(function (k) {
+ t[k] = b[k]
+ })
+ return t
}
-/**
- * Request class
- *
- * @param Mixed input Url or Request instance
- * @param Object init Custom options
- * @return Void
- */
-class Request {
- constructor(input) {
- let init = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-
- let parsedURL;
-
- // normalize input
- if (!isRequest(input)) {
- if (input && input.href) {
- // in order to support Node.js' Url objects; though WHATWG's URL objects
- // will fall into this branch also (since their `toString()` will return
- // `href` property anyway)
- parsedURL = parseURL(input.href);
- } else {
- // coerce input to a string before attempting to parse
- parsedURL = parseURL(`${input}`);
- }
- input = {};
- } else {
- parsedURL = parseURL(input.url);
- }
-
- let method = init.method || input.method || 'GET';
- method = method.toUpperCase();
+minimatch.defaults = function (def) {
+ if (!def || typeof def !== 'object' || !Object.keys(def).length) {
+ return minimatch
+ }
- if ((init.body != null || isRequest(input) && input.body !== null) && (method === 'GET' || method === 'HEAD')) {
- throw new TypeError('Request with GET/HEAD method cannot have body');
- }
+ var orig = minimatch
- let inputBody = init.body != null ? init.body : isRequest(input) && input.body !== null ? clone(input) : null;
+ var m = function minimatch (p, pattern, options) {
+ return orig(p, pattern, ext(def, options))
+ }
- Body.call(this, inputBody, {
- timeout: init.timeout || input.timeout || 0,
- size: init.size || input.size || 0
- });
+ m.Minimatch = function Minimatch (pattern, options) {
+ return new orig.Minimatch(pattern, ext(def, options))
+ }
+ m.Minimatch.defaults = function defaults (options) {
+ return orig.defaults(ext(def, options)).Minimatch
+ }
- const headers = new Headers(init.headers || input.headers || {});
+ m.filter = function filter (pattern, options) {
+ return orig.filter(pattern, ext(def, options))
+ }
- if (inputBody != null && !headers.has('Content-Type')) {
- const contentType = extractContentType(inputBody);
- if (contentType) {
- headers.append('Content-Type', contentType);
- }
- }
+ m.defaults = function defaults (options) {
+ return orig.defaults(ext(def, options))
+ }
- let signal = isRequest(input) ? input.signal : null;
- if ('signal' in init) signal = init.signal;
+ m.makeRe = function makeRe (pattern, options) {
+ return orig.makeRe(pattern, ext(def, options))
+ }
- if (signal != null && !isAbortSignal(signal)) {
- throw new TypeError('Expected signal to be an instanceof AbortSignal');
- }
+ m.braceExpand = function braceExpand (pattern, options) {
+ return orig.braceExpand(pattern, ext(def, options))
+ }
- this[INTERNALS$2] = {
- method,
- redirect: init.redirect || input.redirect || 'follow',
- headers,
- parsedURL,
- signal
- };
-
- // node-fetch-only options
- this.follow = init.follow !== undefined ? init.follow : input.follow !== undefined ? input.follow : 20;
- this.compress = init.compress !== undefined ? init.compress : input.compress !== undefined ? input.compress : true;
- this.counter = init.counter || input.counter || 0;
- this.agent = init.agent || input.agent;
- }
+ m.match = function (list, pattern, options) {
+ return orig.match(list, pattern, ext(def, options))
+ }
- get method() {
- return this[INTERNALS$2].method;
- }
+ return m
+}
- get url() {
- return format_url(this[INTERNALS$2].parsedURL);
- }
+Minimatch.defaults = function (def) {
+ return minimatch.defaults(def).Minimatch
+}
- get headers() {
- return this[INTERNALS$2].headers;
- }
+function minimatch (p, pattern, options) {
+ assertValidPattern(pattern)
- get redirect() {
- return this[INTERNALS$2].redirect;
- }
+ if (!options) options = {}
- get signal() {
- return this[INTERNALS$2].signal;
- }
+ // shortcut: comments match nothing.
+ if (!options.nocomment && pattern.charAt(0) === '#') {
+ return false
+ }
- /**
- * Clone this request
- *
- * @return Request
- */
- clone() {
- return new Request(this);
- }
+ return new Minimatch(pattern, options).match(p)
}
-Body.mixIn(Request.prototype);
-
-Object.defineProperty(Request.prototype, Symbol.toStringTag, {
- value: 'Request',
- writable: false,
- enumerable: false,
- configurable: true
-});
-
-Object.defineProperties(Request.prototype, {
- method: { enumerable: true },
- url: { enumerable: true },
- headers: { enumerable: true },
- redirect: { enumerable: true },
- clone: { enumerable: true },
- signal: { enumerable: true }
-});
+function Minimatch (pattern, options) {
+ if (!(this instanceof Minimatch)) {
+ return new Minimatch(pattern, options)
+ }
-/**
- * Convert a Request to Node.js http request options.
- *
- * @param Request A Request instance
- * @return Object The options object to be passed to http.request
- */
-function getNodeRequestOptions(request) {
- const parsedURL = request[INTERNALS$2].parsedURL;
- const headers = new Headers(request[INTERNALS$2].headers);
+ assertValidPattern(pattern)
- // fetch step 1.3
- if (!headers.has('Accept')) {
- headers.set('Accept', '*/*');
- }
+ if (!options) options = {}
- // Basic fetch
- if (!parsedURL.protocol || !parsedURL.hostname) {
- throw new TypeError('Only absolute URLs are supported');
- }
+ pattern = pattern.trim()
- if (!/^https?:$/.test(parsedURL.protocol)) {
- throw new TypeError('Only HTTP(S) protocols are supported');
- }
+ // windows support: need to use /, not \
+ if (!options.allowWindowsEscape && path.sep !== '/') {
+ pattern = pattern.split(path.sep).join('/')
+ }
- if (request.signal && request.body instanceof Stream.Readable && !streamDestructionSupported) {
- throw new Error('Cancellation of streamed requests with AbortSignal is not supported in node < 8');
- }
+ this.options = options
+ this.set = []
+ this.pattern = pattern
+ this.regexp = null
+ this.negate = false
+ this.comment = false
+ this.empty = false
+ this.partial = !!options.partial
- // HTTP-network-or-cache fetch steps 2.4-2.7
- let contentLengthValue = null;
- if (request.body == null && /^(POST|PUT)$/i.test(request.method)) {
- contentLengthValue = '0';
- }
- if (request.body != null) {
- const totalBytes = getTotalBytes(request);
- if (typeof totalBytes === 'number') {
- contentLengthValue = String(totalBytes);
- }
- }
- if (contentLengthValue) {
- headers.set('Content-Length', contentLengthValue);
- }
+ // make the set of regexps etc.
+ this.make()
+}
- // HTTP-network-or-cache fetch step 2.11
- if (!headers.has('User-Agent')) {
- headers.set('User-Agent', 'node-fetch/1.0 (+https://github.com/bitinn/node-fetch)');
- }
+Minimatch.prototype.debug = function () {}
- // HTTP-network-or-cache fetch step 2.15
- if (request.compress && !headers.has('Accept-Encoding')) {
- headers.set('Accept-Encoding', 'gzip,deflate');
- }
+Minimatch.prototype.make = make
+function make () {
+ var pattern = this.pattern
+ var options = this.options
- let agent = request.agent;
- if (typeof agent === 'function') {
- agent = agent(parsedURL);
- }
+ // empty patterns and comments match nothing.
+ if (!options.nocomment && pattern.charAt(0) === '#') {
+ this.comment = true
+ return
+ }
+ if (!pattern) {
+ this.empty = true
+ return
+ }
- // HTTP-network fetch step 4.2
- // chunked encoding is handled by Node.js
+ // step 1: figure out negation, etc.
+ this.parseNegate()
- return Object.assign({}, parsedURL, {
- method: request.method,
- headers: exportNodeCompatibleHeaders(headers),
- agent
- });
-}
+ // step 2: expand braces
+ var set = this.globSet = this.braceExpand()
-/**
- * abort-error.js
- *
- * AbortError interface for cancelled requests
- */
+ if (options.debug) this.debug = function debug() { console.error.apply(console, arguments) }
-/**
- * Create AbortError instance
- *
- * @param String message Error message for human
- * @return AbortError
- */
-function AbortError(message) {
- Error.call(this, message);
+ this.debug(this.pattern, set)
- this.type = 'aborted';
- this.message = message;
+ // step 3: now we have a set, so turn each one into a series of path-portion
+ // matching patterns.
+ // These will be regexps, except in the case of "**", which is
+ // set to the GLOBSTAR object for globstar behavior,
+ // and will not contain any / characters
+ set = this.globParts = set.map(function (s) {
+ return s.split(slashSplit)
+ })
- // hide custom error implementation details from end-users
- Error.captureStackTrace(this, this.constructor);
-}
+ this.debug(this.pattern, set)
-AbortError.prototype = Object.create(Error.prototype);
-AbortError.prototype.constructor = AbortError;
-AbortError.prototype.name = 'AbortError';
+ // glob --> regexps
+ set = set.map(function (s, si, set) {
+ return s.map(this.parse, this)
+ }, this)
-const URL$1 = Url.URL || whatwgUrl.URL;
+ this.debug(this.pattern, set)
-// fix an issue where "PassThrough", "resolve" aren't a named export for node <10
-const PassThrough$1 = Stream.PassThrough;
+ // filter out everything that didn't compile properly.
+ set = set.filter(function (s) {
+ return s.indexOf(false) === -1
+ })
-const isDomainOrSubdomain = function isDomainOrSubdomain(destination, original) {
- const orig = new URL$1(original).hostname;
- const dest = new URL$1(destination).hostname;
+ this.debug(this.pattern, set)
- return orig === dest || orig[orig.length - dest.length - 1] === '.' && orig.endsWith(dest);
-};
+ this.set = set
+}
-/**
- * isSameProtocol reports whether the two provided URLs use the same protocol.
- *
- * Both domains must already be in canonical form.
- * @param {string|URL} original
- * @param {string|URL} destination
- */
-const isSameProtocol = function isSameProtocol(destination, original) {
- const orig = new URL$1(original).protocol;
- const dest = new URL$1(destination).protocol;
+Minimatch.prototype.parseNegate = parseNegate
+function parseNegate () {
+ var pattern = this.pattern
+ var negate = false
+ var options = this.options
+ var negateOffset = 0
- return orig === dest;
-};
+ if (options.nonegate) return
-/**
- * Fetch function
- *
- * @param Mixed url Absolute url or Request instance
- * @param Object opts Fetch options
- * @return Promise
- */
-function fetch(url, opts) {
+ for (var i = 0, l = pattern.length
+ ; i < l && pattern.charAt(i) === '!'
+ ; i++) {
+ negate = !negate
+ negateOffset++
+ }
- // allow custom promise
- if (!fetch.Promise) {
- throw new Error('native promise missing, set fetch.Promise to your favorite alternative');
- }
+ if (negateOffset) this.pattern = pattern.substr(negateOffset)
+ this.negate = negate
+}
- Body.Promise = fetch.Promise;
+// Brace expansion:
+// a{b,c}d -> abd acd
+// a{b,}c -> abc ac
+// a{0..3}d -> a0d a1d a2d a3d
+// a{b,c{d,e}f}g -> abg acdfg acefg
+// a{b,c}d{e,f}g -> abdeg acdeg abdeg abdfg
+//
+// Invalid sets are not expanded.
+// a{2..}b -> a{2..}b
+// a{b}c -> a{b}c
+minimatch.braceExpand = function (pattern, options) {
+ return braceExpand(pattern, options)
+}
- // wrap http.request into fetch
- return new fetch.Promise(function (resolve, reject) {
- // build request object
- const request = new Request(url, opts);
- const options = getNodeRequestOptions(request);
+Minimatch.prototype.braceExpand = braceExpand
- const send = (options.protocol === 'https:' ? https : http).request;
- const signal = request.signal;
+function braceExpand (pattern, options) {
+ if (!options) {
+ if (this instanceof Minimatch) {
+ options = this.options
+ } else {
+ options = {}
+ }
+ }
- let response = null;
+ pattern = typeof pattern === 'undefined'
+ ? this.pattern : pattern
- const abort = function abort() {
- let error = new AbortError('The user aborted a request.');
- reject(error);
- if (request.body && request.body instanceof Stream.Readable) {
- destroyStream(request.body, error);
- }
- if (!response || !response.body) return;
- response.body.emit('error', error);
- };
+ assertValidPattern(pattern)
- if (signal && signal.aborted) {
- abort();
- return;
- }
+ // Thanks to Yeting Li for
+ // improving this regexp to avoid a ReDOS vulnerability.
+ if (options.nobrace || !/\{(?:(?!\{).)*\}/.test(pattern)) {
+ // shortcut. no need to expand.
+ return [pattern]
+ }
- const abortAndFinalize = function abortAndFinalize() {
- abort();
- finalize();
- };
+ return expand(pattern)
+}
- // send request
- const req = send(options);
- let reqTimeout;
+var MAX_PATTERN_LENGTH = 1024 * 64
+var assertValidPattern = function (pattern) {
+ if (typeof pattern !== 'string') {
+ throw new TypeError('invalid pattern')
+ }
- if (signal) {
- signal.addEventListener('abort', abortAndFinalize);
- }
+ if (pattern.length > MAX_PATTERN_LENGTH) {
+ throw new TypeError('pattern is too long')
+ }
+}
- function finalize() {
- req.abort();
- if (signal) signal.removeEventListener('abort', abortAndFinalize);
- clearTimeout(reqTimeout);
- }
+// parse a component of the expanded set.
+// At this point, no pattern may contain "/" in it
+// so we're going to return a 2d array, where each entry is the full
+// pattern, split on '/', and then turned into a regular expression.
+// A regexp is made at the end which joins each array with an
+// escaped /, and another full one which joins each regexp with |.
+//
+// Following the lead of Bash 4.1, note that "**" only has special meaning
+// when it is the *only* thing in a path portion. Otherwise, any series
+// of * is equivalent to a single *. Globstar behavior is enabled by
+// default, and can be disabled by setting options.noglobstar.
+Minimatch.prototype.parse = parse
+var SUBPARSE = {}
+function parse (pattern, isSub) {
+ assertValidPattern(pattern)
- if (request.timeout) {
- req.once('socket', function (socket) {
- reqTimeout = setTimeout(function () {
- reject(new FetchError(`network timeout at: ${request.url}`, 'request-timeout'));
- finalize();
- }, request.timeout);
- });
- }
+ var options = this.options
- req.on('error', function (err) {
- reject(new FetchError(`request to ${request.url} failed, reason: ${err.message}`, 'system', err));
+ // shortcuts
+ if (pattern === '**') {
+ if (!options.noglobstar)
+ return GLOBSTAR
+ else
+ pattern = '*'
+ }
+ if (pattern === '') return ''
- if (response && response.body) {
- destroyStream(response.body, err);
- }
+ var re = ''
+ var hasMagic = !!options.nocase
+ var escaping = false
+ // ? => one single character
+ var patternListStack = []
+ var negativeLists = []
+ var stateChar
+ var inClass = false
+ var reClassStart = -1
+ var classStart = -1
+ // . and .. never match anything that doesn't start with .,
+ // even when options.dot is set.
+ var patternStart = pattern.charAt(0) === '.' ? '' // anything
+ // not (start or / followed by . or .. followed by / or end)
+ : options.dot ? '(?!(?:^|\\\/)\\.{1,2}(?:$|\\\/))'
+ : '(?!\\.)'
+ var self = this
- finalize();
- });
+ function clearStateChar () {
+ if (stateChar) {
+ // we had some state-tracking character
+ // that wasn't consumed by this pass.
+ switch (stateChar) {
+ case '*':
+ re += star
+ hasMagic = true
+ break
+ case '?':
+ re += qmark
+ hasMagic = true
+ break
+ default:
+ re += '\\' + stateChar
+ break
+ }
+ self.debug('clearStateChar %j %j', stateChar, re)
+ stateChar = false
+ }
+ }
- fixResponseChunkedTransferBadEnding(req, function (err) {
- if (signal && signal.aborted) {
- return;
- }
+ for (var i = 0, len = pattern.length, c
+ ; (i < len) && (c = pattern.charAt(i))
+ ; i++) {
+ this.debug('%s\t%s %s %j', pattern, i, re, c)
- if (response && response.body) {
- destroyStream(response.body, err);
- }
- });
+ // skip over any that are escaped.
+ if (escaping && reSpecials[c]) {
+ re += '\\' + c
+ escaping = false
+ continue
+ }
- /* c8 ignore next 18 */
- if (parseInt(process.version.substring(1)) < 14) {
- // Before Node.js 14, pipeline() does not fully support async iterators and does not always
- // properly handle when the socket close/end events are out of order.
- req.on('socket', function (s) {
- s.addListener('close', function (hadError) {
- // if a data listener is still present we didn't end cleanly
- const hasDataListener = s.listenerCount('data') > 0;
-
- // if end happened before close but the socket didn't emit an error, do it now
- if (response && hasDataListener && !hadError && !(signal && signal.aborted)) {
- const err = new Error('Premature close');
- err.code = 'ERR_STREAM_PREMATURE_CLOSE';
- response.body.emit('error', err);
- }
- });
- });
- }
+ switch (c) {
+ /* istanbul ignore next */
+ case '/': {
+ // completely not allowed, even escaped.
+ // Should already be path-split by now.
+ return false
+ }
- req.on('response', function (res) {
- clearTimeout(reqTimeout);
-
- const headers = createHeadersLenient(res.headers);
-
- // HTTP fetch step 5
- if (fetch.isRedirect(res.statusCode)) {
- // HTTP fetch step 5.2
- const location = headers.get('Location');
-
- // HTTP fetch step 5.3
- let locationURL = null;
- try {
- locationURL = location === null ? null : new URL$1(location, request.url).toString();
- } catch (err) {
- // error here can only be invalid URL in Location: header
- // do not throw when options.redirect == manual
- // let the user extract the errorneous redirect URL
- if (request.redirect !== 'manual') {
- reject(new FetchError(`uri requested responds with an invalid redirect URL: ${location}`, 'invalid-redirect'));
- finalize();
- return;
- }
- }
+ case '\\':
+ clearStateChar()
+ escaping = true
+ continue
- // HTTP fetch step 5.5
- switch (request.redirect) {
- case 'error':
- reject(new FetchError(`uri requested responds with a redirect, redirect mode is set to error: ${request.url}`, 'no-redirect'));
- finalize();
- return;
- case 'manual':
- // node-fetch-specific step: make manual redirect a bit easier to use by setting the Location header value to the resolved URL.
- if (locationURL !== null) {
- // handle corrupted header
- try {
- headers.set('Location', locationURL);
- } catch (err) {
- // istanbul ignore next: nodejs server prevent invalid response headers, we can't test this through normal request
- reject(err);
- }
- }
- break;
- case 'follow':
- // HTTP-redirect fetch step 2
- if (locationURL === null) {
- break;
- }
-
- // HTTP-redirect fetch step 5
- if (request.counter >= request.follow) {
- reject(new FetchError(`maximum redirect reached at: ${request.url}`, 'max-redirect'));
- finalize();
- return;
- }
-
- // HTTP-redirect fetch step 6 (counter increment)
- // Create a new Request object.
- const requestOpts = {
- headers: new Headers(request.headers),
- follow: request.follow,
- counter: request.counter + 1,
- agent: request.agent,
- compress: request.compress,
- method: request.method,
- body: request.body,
- signal: request.signal,
- timeout: request.timeout,
- size: request.size
- };
-
- if (!isDomainOrSubdomain(request.url, locationURL) || !isSameProtocol(request.url, locationURL)) {
- for (const name of ['authorization', 'www-authenticate', 'cookie', 'cookie2']) {
- requestOpts.headers.delete(name);
- }
- }
-
- // HTTP-redirect fetch step 9
- if (res.statusCode !== 303 && request.body && getTotalBytes(request) === null) {
- reject(new FetchError('Cannot follow redirect with body being a readable stream', 'unsupported-redirect'));
- finalize();
- return;
- }
-
- // HTTP-redirect fetch step 11
- if (res.statusCode === 303 || (res.statusCode === 301 || res.statusCode === 302) && request.method === 'POST') {
- requestOpts.method = 'GET';
- requestOpts.body = undefined;
- requestOpts.headers.delete('content-length');
- }
-
- // HTTP-redirect fetch step 15
- resolve(fetch(new Request(locationURL, requestOpts)));
- finalize();
- return;
- }
- }
+ // the various stateChar values
+ // for the "extglob" stuff.
+ case '?':
+ case '*':
+ case '+':
+ case '@':
+ case '!':
+ this.debug('%s\t%s %s %j <-- stateChar', pattern, i, re, c)
- // prepare response
- res.once('end', function () {
- if (signal) signal.removeEventListener('abort', abortAndFinalize);
- });
- let body = res.pipe(new PassThrough$1());
-
- const response_options = {
- url: request.url,
- status: res.statusCode,
- statusText: res.statusMessage,
- headers: headers,
- size: request.size,
- timeout: request.timeout,
- counter: request.counter
- };
-
- // HTTP-network fetch step 12.1.1.3
- const codings = headers.get('Content-Encoding');
-
- // HTTP-network fetch step 12.1.1.4: handle content codings
-
- // in following scenarios we ignore compression support
- // 1. compression support is disabled
- // 2. HEAD request
- // 3. no Content-Encoding header
- // 4. no content response (204)
- // 5. content not modified response (304)
- if (!request.compress || request.method === 'HEAD' || codings === null || res.statusCode === 204 || res.statusCode === 304) {
- response = new Response(body, response_options);
- resolve(response);
- return;
- }
+ // all of those are literals inside a class, except that
+ // the glob [!a] means [^a] in regexp
+ if (inClass) {
+ this.debug(' in class')
+ if (c === '!' && i === classStart + 1) c = '^'
+ re += c
+ continue
+ }
- // For Node v6+
- // Be less strict when decoding compressed responses, since sometimes
- // servers send slightly invalid responses that are still accepted
- // by common browsers.
- // Always using Z_SYNC_FLUSH is what cURL does.
- const zlibOptions = {
- flush: zlib.Z_SYNC_FLUSH,
- finishFlush: zlib.Z_SYNC_FLUSH
- };
-
- // for gzip
- if (codings == 'gzip' || codings == 'x-gzip') {
- body = body.pipe(zlib.createGunzip(zlibOptions));
- response = new Response(body, response_options);
- resolve(response);
- return;
- }
+ // if we already have a stateChar, then it means
+ // that there was something like ** or +? in there.
+ // Handle the stateChar, then proceed with this one.
+ self.debug('call clearStateChar %j', stateChar)
+ clearStateChar()
+ stateChar = c
+ // if extglob is disabled, then +(asdf|foo) isn't a thing.
+ // just clear the statechar *now*, rather than even diving into
+ // the patternList stuff.
+ if (options.noext) clearStateChar()
+ continue
- // for deflate
- if (codings == 'deflate' || codings == 'x-deflate') {
- // handle the infamous raw deflate response from old servers
- // a hack for old IIS and Apache servers
- const raw = res.pipe(new PassThrough$1());
- raw.once('data', function (chunk) {
- // see http://stackoverflow.com/questions/37519828
- if ((chunk[0] & 0x0F) === 0x08) {
- body = body.pipe(zlib.createInflate());
- } else {
- body = body.pipe(zlib.createInflateRaw());
- }
- response = new Response(body, response_options);
- resolve(response);
- });
- raw.on('end', function () {
- // some old IIS servers return zero-length OK deflate responses, so 'data' is never emitted.
- if (!response) {
- response = new Response(body, response_options);
- resolve(response);
- }
- });
- return;
- }
+ case '(':
+ if (inClass) {
+ re += '('
+ continue
+ }
- // for br
- if (codings == 'br' && typeof zlib.createBrotliDecompress === 'function') {
- body = body.pipe(zlib.createBrotliDecompress());
- response = new Response(body, response_options);
- resolve(response);
- return;
- }
+ if (!stateChar) {
+ re += '\\('
+ continue
+ }
- // otherwise, use response as-is
- response = new Response(body, response_options);
- resolve(response);
- });
+ patternListStack.push({
+ type: stateChar,
+ start: i - 1,
+ reStart: re.length,
+ open: plTypes[stateChar].open,
+ close: plTypes[stateChar].close
+ })
+ // negation is (?:(?!js)[^/]*)
+ re += stateChar === '!' ? '(?:(?!(?:' : '(?:'
+ this.debug('plType %j %j', stateChar, re)
+ stateChar = false
+ continue
- writeToStream(req, request);
- });
-}
-function fixResponseChunkedTransferBadEnding(request, errorCallback) {
- let socket;
+ case ')':
+ if (inClass || !patternListStack.length) {
+ re += '\\)'
+ continue
+ }
- request.on('socket', function (s) {
- socket = s;
- });
+ clearStateChar()
+ hasMagic = true
+ var pl = patternListStack.pop()
+ // negation is (?:(?!js)[^/]*)
+ // The others are (?:)
+ re += pl.close
+ if (pl.type === '!') {
+ negativeLists.push(pl)
+ }
+ pl.reEnd = re.length
+ continue
- request.on('response', function (response) {
- const headers = response.headers;
-
- if (headers['transfer-encoding'] === 'chunked' && !headers['content-length']) {
- response.once('close', function (hadError) {
- // tests for socket presence, as in some situations the
- // the 'socket' event is not triggered for the request
- // (happens in deno), avoids `TypeError`
- // if a data listener is still present we didn't end cleanly
- const hasDataListener = socket && socket.listenerCount('data') > 0;
-
- if (hasDataListener && !hadError) {
- const err = new Error('Premature close');
- err.code = 'ERR_STREAM_PREMATURE_CLOSE';
- errorCallback(err);
- }
- });
- }
- });
-}
+ case '|':
+ if (inClass || !patternListStack.length || escaping) {
+ re += '\\|'
+ escaping = false
+ continue
+ }
-function destroyStream(stream, err) {
- if (stream.destroy) {
- stream.destroy(err);
- } else {
- // node < 8
- stream.emit('error', err);
- stream.end();
- }
-}
+ clearStateChar()
+ re += '|'
+ continue
-/**
- * Redirect code matching
- *
- * @param Number code Status code
- * @return Boolean
- */
-fetch.isRedirect = function (code) {
- return code === 301 || code === 302 || code === 303 || code === 307 || code === 308;
-};
+ // these are mostly the same in regexp and glob
+ case '[':
+ // swallow any state-tracking char before the [
+ clearStateChar()
-// expose Promise
-fetch.Promise = global.Promise;
+ if (inClass) {
+ re += '\\' + c
+ continue
+ }
-module.exports = exports = fetch;
-Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports["default"] = exports;
-exports.Headers = Headers;
-exports.Request = Request;
-exports.Response = Response;
-exports.FetchError = FetchError;
-exports.AbortError = AbortError;
+ inClass = true
+ classStart = i
+ reClassStart = re.length
+ re += c
+ continue
+ case ']':
+ // a right bracket shall lose its special
+ // meaning and represent itself in
+ // a bracket expression if it occurs
+ // first in the list. -- POSIX.2 2.8.3.2
+ if (i === classStart + 1 || !inClass) {
+ re += '\\' + c
+ escaping = false
+ continue
+ }
-/***/ }),
+ // handle the case where we left a class open.
+ // "[z-a]" is valid, equivalent to "\[z-a\]"
+ // split where the last [ was, make sure we don't have
+ // an invalid re. if so, re-walk the contents of the
+ // would-be class to re-translate any characters that
+ // were passed through as-is
+ // TODO: It would probably be faster to determine this
+ // without a try/catch and a new RegExp, but it's tricky
+ // to do safely. For now, this is safe and works.
+ var cs = pattern.substring(classStart + 1, i)
+ try {
+ RegExp('[' + cs + ']')
+ } catch (er) {
+ // not a valid class!
+ var sp = this.parse(cs, SUBPARSE)
+ re = re.substr(0, reClassStart) + '\\[' + sp[0] + '\\]'
+ hasMagic = hasMagic || sp[1]
+ inClass = false
+ continue
+ }
-/***/ 2043:
-/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+ // finish up the class.
+ hasMagic = true
+ inClass = false
+ re += c
+ continue
-;(function (sax) { // wrapper for non-node envs
- sax.parser = function (strict, opt) { return new SAXParser(strict, opt) }
- sax.SAXParser = SAXParser
- sax.SAXStream = SAXStream
- sax.createStream = createStream
-
- // When we pass the MAX_BUFFER_LENGTH position, start checking for buffer overruns.
- // When we check, schedule the next check for MAX_BUFFER_LENGTH - (max(buffer lengths)),
- // since that's the earliest that a buffer overrun could occur. This way, checks are
- // as rare as required, but as often as necessary to ensure never crossing this bound.
- // Furthermore, buffers are only tested at most once per write(), so passing a very
- // large string into write() might have undesirable effects, but this is manageable by
- // the caller, so it is assumed to be safe. Thus, a call to write() may, in the extreme
- // edge case, result in creating at most one complete copy of the string passed in.
- // Set to Infinity to have unlimited buffers.
- sax.MAX_BUFFER_LENGTH = 64 * 1024
-
- var buffers = [
- 'comment', 'sgmlDecl', 'textNode', 'tagName', 'doctype',
- 'procInstName', 'procInstBody', 'entity', 'attribName',
- 'attribValue', 'cdata', 'script'
- ]
+ default:
+ // swallow any state char that wasn't consumed
+ clearStateChar()
- sax.EVENTS = [
- 'text',
- 'processinginstruction',
- 'sgmldeclaration',
- 'doctype',
- 'comment',
- 'opentagstart',
- 'attribute',
- 'opentag',
- 'closetag',
- 'opencdata',
- 'cdata',
- 'closecdata',
- 'error',
- 'end',
- 'ready',
- 'script',
- 'opennamespace',
- 'closenamespace'
- ]
+ if (escaping) {
+ // no need
+ escaping = false
+ } else if (reSpecials[c]
+ && !(c === '^' && inClass)) {
+ re += '\\'
+ }
- function SAXParser (strict, opt) {
- if (!(this instanceof SAXParser)) {
- return new SAXParser(strict, opt)
- }
-
- var parser = this
- clearBuffers(parser)
- parser.q = parser.c = ''
- parser.bufferCheckPosition = sax.MAX_BUFFER_LENGTH
- parser.opt = opt || {}
- parser.opt.lowercase = parser.opt.lowercase || parser.opt.lowercasetags
- parser.looseCase = parser.opt.lowercase ? 'toLowerCase' : 'toUpperCase'
- parser.tags = []
- parser.closed = parser.closedRoot = parser.sawRoot = false
- parser.tag = parser.error = null
- parser.strict = !!strict
- parser.noscript = !!(strict || parser.opt.noscript)
- parser.state = S.BEGIN
- parser.strictEntities = parser.opt.strictEntities
- parser.ENTITIES = parser.strictEntities ? Object.create(sax.XML_ENTITIES) : Object.create(sax.ENTITIES)
- parser.attribList = []
-
- // namespaces form a prototype chain.
- // it always points at the current tag,
- // which protos to its parent tag.
- if (parser.opt.xmlns) {
- parser.ns = Object.create(rootNS)
- }
-
- // mostly just for error reporting
- parser.trackPosition = parser.opt.position !== false
- if (parser.trackPosition) {
- parser.position = parser.line = parser.column = 0
- }
- emit(parser, 'onready')
- }
-
- if (!Object.create) {
- Object.create = function (o) {
- function F () {}
- F.prototype = o
- var newf = new F()
- return newf
- }
- }
-
- if (!Object.keys) {
- Object.keys = function (o) {
- var a = []
- for (var i in o) if (o.hasOwnProperty(i)) a.push(i)
- return a
- }
- }
-
- function checkBufferLength (parser) {
- var maxAllowed = Math.max(sax.MAX_BUFFER_LENGTH, 10)
- var maxActual = 0
- for (var i = 0, l = buffers.length; i < l; i++) {
- var len = parser[buffers[i]].length
- if (len > maxAllowed) {
- // Text/cdata nodes can get big, and since they're buffered,
- // we can get here under normal conditions.
- // Avoid issues by emitting the text node now,
- // so at least it won't get any bigger.
- switch (buffers[i]) {
- case 'textNode':
- closeText(parser)
- break
+ re += c
- case 'cdata':
- emitNode(parser, 'oncdata', parser.cdata)
- parser.cdata = ''
- break
+ } // switch
+ } // for
- case 'script':
- emitNode(parser, 'onscript', parser.script)
- parser.script = ''
- break
+ // handle the case where we left a class open.
+ // "[abc" is valid, equivalent to "\[abc"
+ if (inClass) {
+ // split where the last [ was, and escape it
+ // this is a huge pita. We now have to re-walk
+ // the contents of the would-be class to re-translate
+ // any characters that were passed through as-is
+ cs = pattern.substr(classStart + 1)
+ sp = this.parse(cs, SUBPARSE)
+ re = re.substr(0, reClassStart) + '\\[' + sp[0]
+ hasMagic = hasMagic || sp[1]
+ }
- default:
- error(parser, 'Max buffer length exceeded: ' + buffers[i])
- }
+ // handle the case where we had a +( thing at the *end*
+ // of the pattern.
+ // each pattern list stack adds 3 chars, and we need to go through
+ // and escape any | chars that were passed through as-is for the regexp.
+ // Go through and escape them, taking care not to double-escape any
+ // | chars that were already escaped.
+ for (pl = patternListStack.pop(); pl; pl = patternListStack.pop()) {
+ var tail = re.slice(pl.reStart + pl.open.length)
+ this.debug('setting tail', re, pl)
+ // maybe some even number of \, then maybe 1 \, followed by a |
+ tail = tail.replace(/((?:\\{2}){0,64})(\\?)\|/g, function (_, $1, $2) {
+ if (!$2) {
+ // the | isn't already escaped, so escape it.
+ $2 = '\\'
}
- maxActual = Math.max(maxActual, len)
- }
- // schedule the next check for the earliest possible buffer overrun.
- var m = sax.MAX_BUFFER_LENGTH - maxActual
- parser.bufferCheckPosition = m + parser.position
- }
- function clearBuffers (parser) {
- for (var i = 0, l = buffers.length; i < l; i++) {
- parser[buffers[i]] = ''
- }
- }
+ // need to escape all those slashes *again*, without escaping the
+ // one that we need for escaping the | character. As it works out,
+ // escaping an even number of slashes can be done by simply repeating
+ // it exactly after itself. That's why this trick works.
+ //
+ // I am sorry that you have to see this.
+ return $1 + $1 + $2 + '|'
+ })
- function flushBuffers (parser) {
- closeText(parser)
- if (parser.cdata !== '') {
- emitNode(parser, 'oncdata', parser.cdata)
- parser.cdata = ''
- }
- if (parser.script !== '') {
- emitNode(parser, 'onscript', parser.script)
- parser.script = ''
- }
- }
+ this.debug('tail=%j\n %s', tail, tail, pl, re)
+ var t = pl.type === '*' ? star
+ : pl.type === '?' ? qmark
+ : '\\' + pl.type
- SAXParser.prototype = {
- end: function () { end(this) },
- write: write,
- resume: function () { this.error = null; return this },
- close: function () { return this.write(null) },
- flush: function () { flushBuffers(this) }
+ hasMagic = true
+ re = re.slice(0, pl.reStart) + t + '\\(' + tail
}
- var Stream
- try {
- Stream = (__nccwpck_require__(2781).Stream)
- } catch (ex) {
- Stream = function () {}
+ // handle trailing things that only matter at the very end.
+ clearStateChar()
+ if (escaping) {
+ // trailing \\
+ re += '\\\\'
}
- if (!Stream) Stream = function () {}
- var streamWraps = sax.EVENTS.filter(function (ev) {
- return ev !== 'error' && ev !== 'end'
- })
-
- function createStream (strict, opt) {
- return new SAXStream(strict, opt)
+ // only need to apply the nodot start if the re starts with
+ // something that could conceivably capture a dot
+ var addPatternStart = false
+ switch (re.charAt(0)) {
+ case '[': case '.': case '(': addPatternStart = true
}
- function SAXStream (strict, opt) {
- if (!(this instanceof SAXStream)) {
- return new SAXStream(strict, opt)
- }
-
- Stream.apply(this)
-
- this._parser = new SAXParser(strict, opt)
- this.writable = true
- this.readable = true
-
- var me = this
-
- this._parser.onend = function () {
- me.emit('end')
- }
-
- this._parser.onerror = function (er) {
- me.emit('error', er)
-
- // if didn't throw, then means error was handled.
- // go ahead and clear error, so we can write again.
- me._parser.error = null
- }
+ // Hack to work around lack of negative lookbehind in JS
+ // A pattern like: *.!(x).!(y|z) needs to ensure that a name
+ // like 'a.xyz.yz' doesn't match. So, the first negative
+ // lookahead, has to look ALL the way ahead, to the end of
+ // the pattern.
+ for (var n = negativeLists.length - 1; n > -1; n--) {
+ var nl = negativeLists[n]
- this._decoder = null
+ var nlBefore = re.slice(0, nl.reStart)
+ var nlFirst = re.slice(nl.reStart, nl.reEnd - 8)
+ var nlLast = re.slice(nl.reEnd - 8, nl.reEnd)
+ var nlAfter = re.slice(nl.reEnd)
- streamWraps.forEach(function (ev) {
- Object.defineProperty(me, 'on' + ev, {
- get: function () {
- return me._parser['on' + ev]
- },
- set: function (h) {
- if (!h) {
- me.removeAllListeners(ev)
- me._parser['on' + ev] = h
- return h
- }
- me.on(ev, h)
- },
- enumerable: true,
- configurable: false
- })
- })
- }
+ nlLast += nlAfter
- SAXStream.prototype = Object.create(Stream.prototype, {
- constructor: {
- value: SAXStream
+ // Handle nested stuff like *(*.js|!(*.json)), where open parens
+ // mean that we should *not* include the ) in the bit that is considered
+ // "after" the negated section.
+ var openParensBefore = nlBefore.split('(').length - 1
+ var cleanAfter = nlAfter
+ for (i = 0; i < openParensBefore; i++) {
+ cleanAfter = cleanAfter.replace(/\)[+*?]?/, '')
}
- })
+ nlAfter = cleanAfter
- SAXStream.prototype.write = function (data) {
- if (typeof Buffer === 'function' &&
- typeof Buffer.isBuffer === 'function' &&
- Buffer.isBuffer(data)) {
- if (!this._decoder) {
- var SD = (__nccwpck_require__(1576).StringDecoder)
- this._decoder = new SD('utf8')
- }
- data = this._decoder.write(data)
+ var dollar = ''
+ if (nlAfter === '' && isSub !== SUBPARSE) {
+ dollar = '$'
}
-
- this._parser.write(data.toString())
- this.emit('data', data)
- return true
+ var newRe = nlBefore + nlFirst + nlAfter + dollar + nlLast
+ re = newRe
}
- SAXStream.prototype.end = function (chunk) {
- if (chunk && chunk.length) {
- this.write(chunk)
- }
- this._parser.end()
- return true
+ // if the re is not "" at this point, then we need to make sure
+ // it doesn't match against an empty path part.
+ // Otherwise a/* will match a/, which it should not.
+ if (re !== '' && hasMagic) {
+ re = '(?=.)' + re
}
- SAXStream.prototype.on = function (ev, handler) {
- var me = this
- if (!me._parser['on' + ev] && streamWraps.indexOf(ev) !== -1) {
- me._parser['on' + ev] = function () {
- var args = arguments.length === 1 ? [arguments[0]] : Array.apply(null, arguments)
- args.splice(0, 0, ev)
- me.emit.apply(me, args)
- }
- }
-
- return Stream.prototype.on.call(me, ev, handler)
- }
-
- // this really needs to be replaced with character classes.
- // XML allows all manner of ridiculous numbers and digits.
- var CDATA = '[CDATA['
- var DOCTYPE = 'DOCTYPE'
- var XML_NAMESPACE = 'http://www.w3.org/XML/1998/namespace'
- var XMLNS_NAMESPACE = 'http://www.w3.org/2000/xmlns/'
- var rootNS = { xml: XML_NAMESPACE, xmlns: XMLNS_NAMESPACE }
-
- // http://www.w3.org/TR/REC-xml/#NT-NameStartChar
- // This implementation works on strings, a single character at a time
- // as such, it cannot ever support astral-plane characters (10000-EFFFF)
- // without a significant breaking change to either this parser, or the
- // JavaScript language. Implementation of an emoji-capable xml parser
- // is left as an exercise for the reader.
- var nameStart = /[:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]/
-
- var nameBody = /[:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u00B7\u0300-\u036F\u203F-\u2040.\d-]/
-
- var entityStart = /[#:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD]/
- var entityBody = /[#:_A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02FF\u0370-\u037D\u037F-\u1FFF\u200C-\u200D\u2070-\u218F\u2C00-\u2FEF\u3001-\uD7FF\uF900-\uFDCF\uFDF0-\uFFFD\u00B7\u0300-\u036F\u203F-\u2040.\d-]/
-
- function isWhitespace (c) {
- return c === ' ' || c === '\n' || c === '\r' || c === '\t'
- }
-
- function isQuote (c) {
- return c === '"' || c === '\''
- }
-
- function isAttribEnd (c) {
- return c === '>' || isWhitespace(c)
- }
-
- function isMatch (regex, c) {
- return regex.test(c)
- }
-
- function notMatch (regex, c) {
- return !isMatch(regex, c)
- }
-
- var S = 0
- sax.STATE = {
- BEGIN: S++, // leading byte order mark or whitespace
- BEGIN_WHITESPACE: S++, // leading whitespace
- TEXT: S++, // general stuff
- TEXT_ENTITY: S++, // & and such.
- OPEN_WAKA: S++, // <
- SGML_DECL: S++, //
- SCRIPT: S++, //