@azure/storage-blob 12.23.0-beta.1 → 12.24.0-alpha.20240612.4

package/types/latest/storage-blob.d.ts

@@ -74,7 +74,7 @@ export declare class AccountSASPermissions {
      */
     write: boolean;
     /**
-     * Permission to create blobs and files granted.
+     * Permission to delete blobs and files granted.
      */
     delete: boolean;
     /**
@@ -1239,7 +1239,7 @@ declare interface Blob_2 {
      * Returns the sku name and account kind
      * @param options The options parameters.
      */
-    getAccountInfo(options?: BlobGetAccountInfoOptionalParams): Promise<BlobGetAccountInfoResponse>;
+    getAccountInfo(options?: BlobGetAccountInfoOptionalParams): Promise<BlobGetAccountInfoResponse_2>;
     /**
      * The Query operation enables users to select/project on blob data by providing simple query
      * expressions.
@@ -2211,6 +2211,17 @@ export declare class BlobClient extends StorageClient {
      * @param options - Optional options to set legal hold on the blob.
      */
     setLegalHold(legalHoldEnabled: boolean, options?: BlobSetLegalHoldOptions): Promise<BlobSetLegalHoldResponse>;
+    /**
+     * 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.
+     */
+    getAccountInfo(options?: BlobGetAccountInfoOptions): Promise<BlobGetAccountInfoResponse>;
 }
 
 /** Defines headers for Blob_copyFromURL operation. */
@@ -2232,7 +2243,7 @@ export declare interface BlobCopyFromURLHeaders {
     /** String identifier for this copy operation. */
     copyId?: string;
     /** State of the copy operation identified by x-ms-copy-id. */
-    copyStatus?: "success";
+    copyStatus?: SyncCopyStatusType;
     /** This response header is returned so that the client can check for the integrity of the copied content. This header is only returned if the source content MD5 was specified. */
     contentMD5?: Uint8Array;
     /** This response header is returned so that the client can check for the integrity of the copied content. */
@@ -2794,7 +2805,7 @@ export declare interface BlobGenerateSasUrlOptions extends CommonGenerateSasUrlO
 }
 
 /** Defines headers for Blob_getAccountInfo operation. */
-declare interface BlobGetAccountInfoHeaders {
+export declare interface BlobGetAccountInfoHeaders {
     /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
     clientRequestId?: string;
     /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
@@ -2807,14 +2818,34 @@ declare interface BlobGetAccountInfoHeaders {
     skuName?: SkuName;
     /** Identifies the account kind */
     accountKind?: AccountKind;
+    /** Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. */
+    isHierarchicalNamespaceEnabled?: boolean;
 }
 
 /** Optional parameters. */
 declare interface BlobGetAccountInfoOptionalParams extends coreClient.OperationOptions {
+    /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
+    timeoutInSeconds?: number;
+    /** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
+    requestId?: string;
+}
+
+/**
+ * Options to configure the {@link BlobClient.getAccountInfo} operation.
+ */
+export declare interface BlobGetAccountInfoOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
 }
 
 /** Contains response data for the getAccountInfo operation. */
-declare type BlobGetAccountInfoResponse = BlobGetAccountInfoHeaders;
+export declare type BlobGetAccountInfoResponse = WithResponse<BlobGetAccountInfoHeaders, BlobGetAccountInfoHeaders>;
+
+/** Contains response data for the getAccountInfo operation. */
+declare type BlobGetAccountInfoResponse_2 = BlobGetAccountInfoHeaders;
 
 /** Defines headers for Blob_getProperties operation. */
 export declare interface BlobGetPropertiesHeaders {
@@ -6317,7 +6348,7 @@ declare interface Container {
      * Returns the sku name and account kind
      * @param options The options parameters.
      */
-    getAccountInfo(options?: ContainerGetAccountInfoOptionalParams): Promise<ContainerGetAccountInfoResponse>;
+    getAccountInfo(options?: ContainerGetAccountInfoOptionalParams): Promise<ContainerGetAccountInfoResponse_2>;
 }
 
 /** Defines headers for Container_acquireLease operation. */
@@ -7048,6 +7079,17 @@ export declare class ContainerClient extends StorageClient {
      * @param options - Options to find blobs by tags.
      */
     findBlobsByTags(tagFilterSqlExpression: string, options?: ContainerFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ContainerFindBlobsByTagsSegmentResponse>;
+    /**
+     * 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.
+     */
+    getAccountInfo(options?: ContainerGetAccountInfoOptions): Promise<ContainerGetAccountInfoResponse>;
     private getContainerNameFromUrl;
     /**
      * Only available for ContainerClient constructed with a shared key credential.
@@ -7345,7 +7387,7 @@ export declare type ContainerGetAccessPolicyResponse = WithResponse<{
 export declare type ContainerGetAccessPolicyResponseModel = ContainerGetAccessPolicyHeaders & SignedIdentifierModel[];
 
 /** Defines headers for Container_getAccountInfo operation. */
-declare interface ContainerGetAccountInfoHeaders {
+export declare interface ContainerGetAccountInfoHeaders {
     /** If a client request id header is sent in the request, this header will be present in the response with the same value. */
     clientRequestId?: string;
     /** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
@@ -7358,14 +7400,34 @@ declare interface ContainerGetAccountInfoHeaders {
     skuName?: SkuName;
     /** Identifies the account kind */
     accountKind?: AccountKind;
+    /** Version 2019-07-07 and newer. Indicates if the account has a hierarchical namespace enabled. */
+    isHierarchicalNamespaceEnabled?: boolean;
 }
 
 /** Optional parameters. */
 declare interface ContainerGetAccountInfoOptionalParams extends coreClient.OperationOptions {
+    /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
+    timeoutInSeconds?: number;
+    /** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
+    requestId?: string;
+}
+
+/**
+ * Options to configure the {@link ContainerClient.getAccountInfo} operation.
+ */
+export declare interface ContainerGetAccountInfoOptions extends CommonOptions {
+    /**
+     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
+     * For example, use the &commat;azure/abort-controller to create an `AbortSignal`.
+     */
+    abortSignal?: AbortSignalLike;
 }
 
 /** Contains response data for the getAccountInfo operation. */
-declare type ContainerGetAccountInfoResponse = ContainerGetAccountInfoHeaders;
+export declare type ContainerGetAccountInfoResponse = WithResponse<ContainerGetAccountInfoHeaders, ContainerGetAccountInfoHeaders>;
+
+/** Contains response data for the getAccountInfo operation. */
+declare type ContainerGetAccountInfoResponse_2 = ContainerGetAccountInfoHeaders;
 
 /** Defines headers for Container_getProperties operation. */
 export declare interface ContainerGetPropertiesHeaders {
@@ -8244,7 +8306,7 @@ export declare function generateAccountSASQueryParameters(accountSASSignatureVal
  *     containerName, // Required
  *     permissions: ContainerSASPermissions.parse("racwdl"), // Required
  *     startsOn: new Date(), // Optional
- *     expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
+ *     expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Required. Date type
  *     ipRange: { start: "0.0.0.0", end: "255.255.255.255" }, // Optional
  *     protocol: SASProtocol.HttpsAndHttp, // Optional
  *     version: "2016-05-31" // Optional
@@ -8262,7 +8324,7 @@ export declare function generateAccountSASQueryParameters(accountSASSignatureVal
  * await containerClient.setAccessPolicy(undefined, [
  *   {
  *     accessPolicy: {
- *       expiresOn: new Date(new Date().valueOf() + 86400), // Date type
+ *       expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Date type
  *       permissions: ContainerSASPermissions.parse("racwdl").toString(),
  *       startsOn: new Date() // Date type
  *     },
@@ -8288,7 +8350,7 @@ export declare function generateAccountSASQueryParameters(accountSASSignatureVal
  *     blobName, // Required
  *     permissions: BlobSASPermissions.parse("racwd"), // Required
  *     startsOn: new Date(), // Optional
- *     expiresOn: new Date(new Date().valueOf() + 86400), // Required. Date type
+ *     expiresOn: new Date(new Date().valueOf() + 86400 * 1000), // Required. Date type
  *     cacheControl: "cache-control-override", // Optional
  *     contentDisposition: "content-disposition-override", // Optional
  *     contentEncoding: "content-encoding-override", // Optional
@@ -8349,6 +8411,12 @@ export declare interface GeoReplication {
 /** Defines values for GeoReplicationStatusType. */
 export declare type GeoReplicationStatusType = "live" | "bootstrap" | "unavailable";
 
+/**
+ *
+ * To get OAuth audience for a storage account for blob service.
+ */
+export declare function getBlobServiceAccountAudience(storageAccountName: string): string;
+
 /**
  * Represents authentication information in Authorization, ProxyAuthorization,
  * WWW-Authenticate, and Proxy-Authenticate header values.
@@ -10875,6 +10943,10 @@ export declare interface ServiceGetAccountInfoHeaders {
 
 /** Optional parameters. */
 declare interface ServiceGetAccountInfoOptionalParams extends coreClient.OperationOptions {
+    /** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
+    timeoutInSeconds?: number;
+    /** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
+    requestId?: string;
 }
 
 /**
@@ -11392,6 +11464,7 @@ export declare interface StoragePipelineOptions {
     httpClient?: RequestPolicy;
     /**
      * The audience used to retrieve an AAD token.
+     * By default, audience 'https://storage.azure.com/.default' will be used.
      */
     audience?: string | string[];
 }
@@ -11611,6 +11684,9 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
     private getCanonicalizedResourceString;
 }
 
+/** Defines values for SyncCopyStatusType. */
+export declare type SyncCopyStatusType = "success";
+
 /**
  * Specifies HTTP options for conditional requests based on blob tags.
  */