@azure/storage-file-datalake
Version:
Microsoft Azure Storage SDK for JavaScript - DataLake
65 lines • 2.26 kB
TypeScript
/**
* ONLY AVAILABLE IN NODE.JS RUNTIME.
*
* This is a helper class to construct a string representing the permissions granted by a ServiceSAS. 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 DataLakeSASSignatureValues} 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.
*/
export declare class DataLakeSASPermissions {
/**
* Creates a {@link DataLakeSASPermissions} 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 -
*/
static parse(permissions: string): DataLakeSASPermissions;
/**
* Specifies Read access granted.
*/
read: boolean;
/**
* Specifies Add access granted.
*/
add: boolean;
/**
* Specifies Create access granted.
*/
create: boolean;
/**
* Specifies Write access granted.
*/
write: boolean;
/**
* Specifies Delete access granted.
*/
delete: boolean;
/**
* Specifies Move access granted.
*/
move: boolean;
/**
* Specifies Execute access granted.
*/
execute: boolean;
/**
* Specifies Ownership access granted, which allows the caller to set owner, owning group,
* or act as the owner when renaming or deleting a blob (file or directory) within a folder
* that has the sticky bit set.
*/
manageOwnership: boolean;
/**
* Specifies Permission access granted, which allows the caller to set permissions and
* POSIX ACLs on blobs (files and directories).
*/
manageAccessControl: boolean;
/**
* 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 DataLakeSASPermissions
*/
toString(): string;
}
//# sourceMappingURL=DataLakeSASPermissions.d.ts.map