@azure/data-tables/dist/browser/sas/generateAccountSas.d.ts

An isomorphic client library for the Azure Tables service.

import type { AccountSasPermissions } from "./accountSasPermissions.js";
import type { AccountSasServices } from "./accountSasServices.js";
import type { NamedKeyCredential } from "@azure/core-auth";
import type { SasIPRange } from "./sasIPRange.js";
import type { SasProtocol } from "./sasQueryParameters.js";
/**
 * Generates a Table 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://learn.microsoft.com/rest/api/storageservices/create-account-sas
 *
 * @param options - Optional parameters.
 * @returns An account SAS token
 */
export declare function generateAccountSas(credential: NamedKeyCredential, options?: AccountSasOptions): string;
/**
 * Options to configure {@link generateAccountSas} operation.
 */
export interface AccountSasOptions {
    /**
     * The time at which the shared access signature becomes invalid. Default to an hour later if not provided.
     */
    expiresOn?: Date;
    /**
     * Specifies the list of permissions to be associated with the SAS.
     */
    permissions?: AccountSasPermissions;
    /**
     * Specifies the resource types associated with the shared access signature.
     */
    resourceTypes?: string;
    /**
     * The version of the service this SAS will target. If not specified, it will default to the version targeted by the
     * library.
     */
    version?: string;
    /**
     * SAS protocols allowed.
     */
    protocol?: SasProtocol;
    /**
     * When the SAS will take effect.
     */
    startsOn?: Date;
    /**
     * IP range allowed.
     */
    ipRange?: SasIPRange;
    /**
     * Account services
     */
    services?: AccountSasServices;
}
//# sourceMappingURL=generateAccountSas.d.ts.map