@azure/storage-blob 12.9.1-alpha.20220401.1 → 12.10.0-beta.1

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

@@ -1790,6 +1790,9 @@ export declare type BlobCopyFromURLResponse = BlobCopyFromURLHeaders & {
     };
 };
 
+/** Defines values for BlobCopySourceTags. */
+export declare type BlobCopySourceTags = "REPLACE" | "COPY";
+
 /** Defines headers for Blob_createSnapshot operation. */
 export declare interface BlobCreateSnapshotHeaders {
     /** Uniquely identifies the snapshot and indicates the snapshot version. It may be used in subsequent requests to access the snapshot */
@@ -3990,6 +3993,10 @@ export declare interface BlobSyncCopyFromURLOptions extends CommonOptions {
      * Optional. Version 2019-07-07 and later.  Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope.  For more information, see Encryption at Rest for Azure Storage Services.
      */
     encryptionScope?: string;
+    /**
+     * Optional. Default 'REPLACE'.  Indicates if source tags should be copied or replaced with the tags specified by {@link tags}.
+     */
+    copySourceTags?: BlobCopySourceTags;
 }
 
 export declare interface BlobTag {
@@ -4873,6 +4880,10 @@ export declare interface BlockBlobSyncUploadFromURLOptions extends CommonOptions
      * Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source.
      */
     sourceAuthorization?: HttpAuthorization;
+    /**
+     * Optional, default 'replace'.  Indicates if source tags should be copied or replaced with the tags specified by {@link tags}.
+     */
+    copySourceTags?: BlobCopySourceTags;
 }
 
 /**
@@ -5051,6 +5062,11 @@ export declare interface BlockList {
 /** Defines values for BlockListType. */
 export declare type BlockListType = "committed" | "uncommitted" | "all";
 
+declare interface ClearRange {
+    start: number;
+    end: number;
+}
+
 /**
  * Common options of {@link BlobGenerateSasUrlOptions} and {@link ContainerGenerateSasUrlOptions}.
  */
@@ -6612,7 +6628,7 @@ export declare interface CpkInfo {
     encryptionKey?: string;
     /** The SHA-256 hash of the provided encryption key. Must be provided if the x-ms-encryption-key header is provided. */
     encryptionKeySha256?: string;
-    /** The algorithm used to produce the encryption key hash. Currently, the only accepted value is \"AES256\". Must be provided if the x-ms-encryption-key header is provided. */
+    /** The algorithm used to produce the encryption key hash. Currently, the only accepted value is "AES256". Must be provided if the x-ms-encryption-key header is provided. */
     encryptionAlgorithm?: EncryptionAlgorithmType;
 }
 
@@ -7360,6 +7376,114 @@ export declare class PageBlobClient extends BlobClient {
      * @returns Response data for the Page Blob Get Ranges operation.
      */
     getPageRanges(offset?: number, count?: number, options?: PageBlobGetPageRangesOptions): Promise<PageBlobGetPageRangesResponse>;
+    /**
+     * 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 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.
+     */
+    private listPageRangesSegment;
+    /**
+     * 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.
+     */
+    private listPageRangeItemSegments;
+    /**
+     * Returns an AsyncIterableIterator of {@link PageRangeInfo} objects
+     *
+     * @param offset - Starting byte position of the page ranges.
+     * @param count - Number of bytes to get.
+     * @param options - Options to List Page Ranges operation.
+     */
+    private listPageRangeItems;
+    /**
+     * 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
+     * // Get the pageBlobClient before you run these snippets,
+     * // Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
+     * let i = 1;
+     * for await (const pageRange of pageBlobClient.listPageRanges()) {
+     *   console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+     * }
+     * ```
+     *
+     * 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.
+     */
+    listPageRanges(offset?: number, count?: number, options?: PageBlobListPageRangesOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesResponseModel>;
     /**
      * 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
@@ -7371,6 +7495,120 @@ export declare class PageBlobClient extends BlobClient {
      * @returns Response data for the Page Blob Get Page Range Diff operation.
      */
     getPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobGetPageRangesDiffOptions): Promise<PageBlobGetPageRangesDiffResponse>;
+    /**
+     * 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 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.
+     */
+    private listPageRangesDiffSegment;
+    /**
+     * Returns an AsyncIterableIterator for {@link PageBlobGetPageRangesDiffResponseModel}
+     *
+     *
+     * @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.
+     */
+    private listPageRangeDiffItemSegments;
+    /**
+     * Returns an AsyncIterableIterator of {@link PageRangeInfo} objects
+     *
+     * @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.
+     */
+    private listPageRangeDiffItems;
+    /**
+     * 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
+     *
+     *  .byPage() returns an async iterable iterator to list of page ranges that differ between a specified snapshot and this page blob.
+     *
+     * Example using `for await` syntax:
+     *
+     * ```js
+     * // Get the pageBlobClient before you run these snippets,
+     * // Can be obtained from `blobServiceClient.getContainerClient("<your-container-name>").getPageBlobClient("<your-blob-name>");`
+     * let i = 1;
+     * for await (const pageRange of pageBlobClient.listPageRangesDiff()) {
+     *   console.log(`Page range ${i++}: ${pageRange.start} - ${pageRange.end}`);
+     * }
+     * ```
+     *
+     * Example using `iter.next()`:
+     *
+     * ```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();
+     * }
+     * ```
+     *
+     * Example using `byPage()`:
+     *
+     * ```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}`);
+     *   }
+     * }
+     * ```
+     *
+     * Example using paging with a marker:
+     *
+     * ```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.
+     */
+    listPageRangesDiff(offset: number, count: number, prevSnapshot: string, options?: PageBlobListPageRangesDiffOptions): PagedAsyncIterableIterator<PageRangeInfo, PageBlobGetPageRangesDiffResponseModel>;
     /**
      * 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
@@ -7607,6 +7845,33 @@ export declare type PageBlobCreateResponse = PageBlobCreateHeaders & {
     };
 };
 
+/**
+ * Options to configure the {@link PageBlobClient.getPageRanges} operation.
+ */
+export declare interface PageBlobGetPageRangesDiffForManagedDisksInPagesOptions 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;
+    /**
+     * Conditions to meet when getting page ranges diff.
+     */
+    conditions?: BlobRequestConditions;
+    /**
+     * Starting byte position of the page ranges.
+     */
+    offset: number;
+    /**
+     * Number of bytes to get.
+     */
+    count: number;
+    /**
+     * URL of snapshot to retrieve the difference.
+     */
+    prevSnapshotUrl: string;
+}
+
 /** Defines headers for PageBlob_getPageRangesDiff operation. */
 export declare interface PageBlobGetPageRangesDiffHeaders {
     /** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
@@ -7669,6 +7934,19 @@ export declare interface PageBlobGetPageRangesDiffResponse extends PageList, Pag
     };
 }
 
+/** Contains response data for the getPageRangesDiff operation. */
+export declare type PageBlobGetPageRangesDiffResponseModel = PageBlobGetPageRangesDiffHeaders & PageList_2 & {
+    /** The underlying HTTP response. */
+    _response: coreHttp.HttpResponse & {
+        /** The response body as text (string format) */
+        bodyAsText: string;
+        /** The response body as parsed JSON or XML */
+        parsedBody: PageList_2;
+        /** The parsed HTTP response headers. */
+        parsedHeaders: PageBlobGetPageRangesDiffHeaders;
+    };
+};
+
 /** Defines headers for PageBlob_getPageRanges operation. */
 export declare interface PageBlobGetPageRangesHeaders {
     /** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
@@ -7727,6 +8005,49 @@ export declare interface PageBlobGetPageRangesResponse extends PageList, PageBlo
     };
 }
 
+/** Contains response data for the getPageRanges operation. */
+export declare type PageBlobGetPageRangesResponseModel = PageBlobGetPageRangesHeaders & PageList_2 & {
+    /** The underlying HTTP response. */
+    _response: coreHttp.HttpResponse & {
+        /** The response body as text (string format) */
+        bodyAsText: string;
+        /** The response body as parsed JSON or XML */
+        parsedBody: PageList_2;
+        /** The parsed HTTP response headers. */
+        parsedHeaders: PageBlobGetPageRangesHeaders;
+    };
+};
+
+/**
+ * Options to configure the {@link PageBlobClient.listPageRangesDiff} operation.
+ */
+export declare interface PageBlobListPageRangesDiffOptions 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;
+    /**
+     * Conditions to meet when getting page ranges diff.
+     */
+    conditions?: BlobRequestConditions;
+}
+
+/**
+ * Options to configure the {@link PageBlobClient.listPageRanges} operation.
+ */
+export declare interface PageBlobListPageRangesOptions 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;
+    /**
+     * Conditions to meet when getting page ranges.
+     */
+    conditions?: BlobRequestConditions;
+}
+
 /**
  * Conditions to add to the creation of this page blob.
  */
@@ -8028,6 +8349,24 @@ export declare interface PageList {
     clearRange?: Range_2[];
 }
 
+/** the list of pages */
+declare interface PageList_2 {
+    pageRange?: PageRange[];
+    clearRange?: ClearRange[];
+    continuationToken?: string;
+}
+
+declare interface PageRange {
+    start: number;
+    end: number;
+}
+
+export declare interface PageRangeInfo {
+    start: number;
+    end: number;
+    isClear: boolean;
+}
+
 /**
  * The multipart/mixed response which contains the response for each subrequest.
  */