@azure/storage-file-datalake 12.26.0 → 12.27.0-beta.1

package/dist/react-native/sas/DataLakeSASSignatureValues.d.ts

@@ -0,0 +1,205 @@
+import { StorageSharedKeyCredential } from "../credentials/StorageSharedKeyCredential.js";
+import { DataLakeSASPermissions } from "./DataLakeSASPermissions.js";
+import { FileSystemSASPermissions } from "./FileSystemSASPermissions.js";
+import type { UserDelegationKey } from "../models.js";
+import type { SasIPRange } from "./SasIPRange.js";
+import type { SASProtocol } from "./SASQueryParameters.js";
+import { SASQueryParameters } from "./SASQueryParameters.js";
+import { DirectorySASPermissions } from "./DirectorySASPermissions.js";
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * DataLakeSASSignatureValues is used to help generating Blob and DataLake service SAS tokens for containers, blobs, filesystem, directories and files.
+ */
+export interface DataLakeSASSignatureValues {
+    /**
+     * The version of the service this SAS will target. If not specified, it will default to the version targeted by the
+     * library.
+     */
+    version?: string;
+    /**
+     * Optional. SAS protocols, HTTPS only or HTTPSandHTTP
+     */
+    protocol?: SASProtocol;
+    /**
+     * Optional. When the SAS will take effect.
+     */
+    startsOn?: Date;
+    /**
+     * Optional only when identifier is provided. The time after which the SAS will no longer work.
+     */
+    expiresOn?: Date;
+    /**
+     * Optional only when identifier is provided.
+     * Please refer to {@link FileSystemSASPermissions}, {@link DirectorySASPermissions} or {@link DataLakeSASPermissions} depending on the resource
+     * being accessed for help constructing the permissions string.
+     */
+    permissions?: DataLakeSASPermissions | DirectorySASPermissions | FileSystemSASPermissions;
+    /**
+     * Optional. IP ranges allowed in this SAS.
+     */
+    ipRange?: SasIPRange;
+    /**
+     * The name of the file system the SAS user may access.
+     */
+    fileSystemName: string;
+    /**
+     * Optional. The path name of the directory or file SAS user may access. Required if snapshotTime is provided.
+     */
+    pathName?: string;
+    /**
+     * Optional. Beginning in version 2020-02-10, this value defines whether or not the {@link pathName} is a directory.
+     * If this value is set to true, the Path is a Directory for a Directory SAS. If set to false or default, the Path
+     * is a File Path for a File Path SAS.
+     */
+    isDirectory?: boolean;
+    /**
+     * Optional. Beginning in version 2020-02-10, indicate the depth of the directory specified in the canonicalizedresource field of the string-to-sign.
+     * The depth of the directory is the number of directories beneath the root folder.
+     */
+    directoryDepth?: number;
+    /**
+     * Optional. Beginning in version 2020-02-10, specifies the Authorized AAD Object Id in GUID format. The AAD Object ID of a user
+     * authorized by the owner of the user delegation key to perform the action granted by the SAS. The Azure Storage service will
+     * ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission
+     * check for the user specified in this value will be performed. This cannot be used in conjuction with {@link agentObjectId}.
+     * This is only used for User Delegation SAS.
+     */
+    preauthorizedAgentObjectId?: string;
+    /**
+     * Optional. Beginning in version 2020-02-10, specifies the Unauthorized AAD Object Id in GUID format. The AAD Object Id of a user that is assumed
+     * to be unauthorized by the owner of the user delegation key. The Azure Storage Service will perform an additional POSIX ACL check to determine
+     * if the user is authorized to perform the requested operation. This cannot be used in conjuction with {@link preauthorizedAgentObjectId}.
+     * This is only used for User Delegation SAS.
+     */
+    agentObjectId?: string;
+    /**
+     * Optional. Beginning in version 2020-02-10, this is a GUID value that will be logged in the storage diagnostic logs and can be used to
+     * correlate SAS generation with storage resource access. This is only used for User Delegation SAS.
+     */
+    correlationId?: string;
+    /**
+     * Optional. Snapshot timestamp string the SAS user may access. Only supported from API version 2018-11-09.
+     */
+    snapshotTime?: string;
+    /**
+     * Optional. The name of the access policy on the file system this SAS references if any.
+     *
+     * @see https://learn.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
+     */
+    identifier?: string;
+    /**
+     * Optional. Encryption scope to use when sending requests authorized with this SAS URI.
+     */
+    encryptionScope?: string;
+    /**
+     * Optional. The cache-control header for the SAS.
+     */
+    cacheControl?: string;
+    /**
+     * Optional. The content-disposition header for the SAS.
+     */
+    contentDisposition?: string;
+    /**
+     * Optional. The content-encoding header for the SAS.
+     */
+    contentEncoding?: string;
+    /**
+     * Optional. The content-language header for the SAS.
+     */
+    contentLanguage?: string;
+    /**
+     * Optional. The content-type header for the SAS.
+     */
+    contentType?: string;
+}
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * 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.
+ *
+ * Fill in the required details before running the following snippets.
+ * @example
+ * ```ts snippet:ignore
+ * // Generate service level SAS for a file system
+ * const containerSAS = generateDataLakeSASQueryParameters({
+ *     fileSystemName, // Required
+ *     permissions: ContainerSASPermissions.parse("racwdl"), // Required
+ *     startsOn: new Date(), // Optional
+ *     expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
+ *     ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
+ *     protocol: SASProtocol.HttpsAndHttp, // Optional
+ *     version: "2016-05-31" // Optional
+ *   },
+ *   sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
+ * ).toString();
+ * ```
+ *
+ * // Fill in the required details before running the snippet.
+ * @example
+ * ```ts snippet:ignore
+ * // Generate service level SAS for a file
+ * const fileSAS = generateDataLakeSASQueryParameters({
+ *     fileSystemName, // Required
+ *     fileName, // Required
+ *     permissions: DataLakeSASPermissions.parse("racwd"), // Required
+ *     startsOn: new Date(), // Optional
+ *     expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
+ *     cacheControl: "cache-control-override", // Optional
+ *     contentDisposition: "content-disposition-override", // Optional
+ *     contentEncoding: "content-encoding-override", // Optional
+ *     contentLanguage: "content-language-override", // Optional
+ *     contentType: "content-type-override", // Optional
+ *     ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
+ *     protocol: SASProtocol.HttpsAndHttp, // Optional
+ *     version: "2016-05-31" // Optional
+ *   },
+ *   sharedKeyCredential // StorageSharedKeyCredential - `new StorageSharedKeyCredential(account, accountKey)`
+ * ).toString();
+ * ```
+ *
+ * @param dataLakeSASSignatureValues -
+ * @param sharedKeyCredential -
+ */
+export declare function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredential: StorageSharedKeyCredential): SASQueryParameters;
+/**
+ * ONLY AVAILABLE IN NODE.JS RUNTIME.
+ *
+ * Creates an instance of SASQueryParameters.
+ * WARNING: identifier will be ignored when generating user delegation SAS, permissions and expiresOn are required.
+ *
+ * @example
+ * ```ts snippet:ignore
+ * // Generate user delegation SAS for a file system
+ * const userDelegationKey = await dataLakeServiceClient.getUserDelegationKey(startsOn, expiresOn);
+ * const fileSystemSAS = generateDataLakeSASQueryParameters({
+ *     fileSystemName, // Required
+ *     permissions: FileSystemSASPermissions.parse("racwdl"), // Required
+ *     startsOn, // Optional. Date type
+ *     expiresOn, // Required. Date type
+ *     ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
+ *     protocol: SASProtocol.HttpsAndHttp, // Optional
+ *     version: "2018-11-09" // Must greater than or equal to 2018-11-09 to generate user delegation SAS
+ *   },
+ *   userDelegationKey, // UserDelegationKey
+ *   accountName
+ * ).toString();
+ * ```
+ *
+ * @param dataLakeSASSignatureValues -
+ * @param userDelegationKey - Return value of `blobServiceClient.getUserDelegationKey()`
+ * @param accountName -
+ */
+export declare function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters;
+export declare function generateDataLakeSASQueryParametersInternal(dataLakeSASSignatureValues: DataLakeSASSignatureValues, sharedKeyCredentialOrUserDelegationKey: StorageSharedKeyCredential | UserDelegationKey, accountName?: string): {
+    sasQueryParameter: SASQueryParameters;
+    stringToSign: string;
+};
+//# sourceMappingURL=DataLakeSASSignatureValues.d.ts.map

package/dist/react-native/sas/DataLakeSASSignatureValues.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DataLakeSASSignatureValues.d.ts","sourceRoot":"","sources":["../../../src/sas/DataLakeSASSignatureValues.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAE1F,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAElD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAG7D,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,sBAAsB,GAAG,uBAAuB,GAAG,wBAAwB,CAAC;IAE1F;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IAErB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,wBAAgB,kCAAkC,CAChD,0BAA0B,EAAE,0BAA0B,EACtD,mBAAmB,EAAE,0BAA0B,GAC9C,kBAAkB,CAAC;AAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,kCAAkC,CAChD,0BAA0B,EAAE,0BAA0B,EACtD,iBAAiB,EAAE,iBAAiB,EACpC,WAAW,EAAE,MAAM,GAClB,kBAAkB,CAAC;AActB,wBAAgB,0CAA0C,CACxD,0BAA0B,EAAE,0BAA0B,EACtD,sCAAsC,EAAE,0BAA0B,GAAG,iBAAiB,EACtF,WAAW,CAAC,EAAE,MAAM,GACnB;IAAE,iBAAiB,EAAE,kBAAkB,CAAC;IAAC,YAAY,EAAE,MAAM,CAAA;CAAE,CAkFjE"}