@azure/storage-blob 12.8.0-beta.1 → 12.8.0

package/typings/3.1/storage-blob.d.ts

@@ -134,7 +134,7 @@ export declare interface AccountSASPermissionsLike {
      */
     write?: boolean;
     /**
-     * Permission to create blobs and files granted.
+     * Permission to delete blobs and files granted.
      */
     delete?: boolean;
     /**
@@ -555,7 +555,7 @@ export declare class AppendBlobClient extends BlobClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new AppendBlobClient object identical to the source but with the
      * specified snapshot timestamp.
@@ -1014,7 +1014,7 @@ export declare class BlobBatchClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a {@link BlobBatch}.
      * A BlobBatch represents an aggregated set of operations on blobs.
@@ -1124,12 +1124,7 @@ export declare type BlobBatchSetBlobsAccessTierResponse = BlobBatchSubmitBatchRe
 /**
  * Options to configure the Service - Submit Batch Optional Params.
  */
-export declare interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmitBatchOptionalParamsModel, CommonOptions {
-    /**
-     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
-     * For example, use the @azure/abort-controller to create an `AbortSignal`.
-     */
-    abortSignal?: AbortSignalLike;
+export declare interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmitBatchOptionalParamsModel {
 }
 /**
  * Contains response data for blob batch operations.
@@ -1291,7 +1286,7 @@ export declare class BlobClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new BlobClient object identical to the source but with the specified snapshot timestamp.
      * Provide "" will remove the snapshot and return a Client to the base blob.
@@ -3066,7 +3061,7 @@ export declare class BlobServiceClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a {@link ContainerClient} object
      *
@@ -3951,7 +3946,7 @@ export declare class BlockBlobClient extends BlobClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new BlockBlobClient object identical to the source but with the
      * specified snapshot timestamp.
@@ -5015,7 +5010,7 @@ export declare class ContainerClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new container under the specified account. If the container with
      * the same name already exists, the operation fails.
@@ -5832,7 +5827,7 @@ export declare interface ContainerListBlobsOptions extends CommonOptions {
     /**
      * Specifies whether deleted blob with versions be returned in the response.
      */
-    includeDeletedwithVersions?: boolean;
+    includeDeletedWithVersions?: boolean;
     /**
      * Specifies whether blob immutability policy be returned in the response.
      */
@@ -6404,12 +6399,18 @@ export declare interface HttpAuthorization {
     /**
      * the credentials containing the authentication information of the user agent for the resource being requested.
      */
-    parameter: string;
+    value: string;
 }
 export { HttpHeaders };
 export { HttpOperationResponse };
 export { HttpRequestBody };
 export { IHttpClient };
+/**
+ * A helper to decide if a given argument satisfies the Pipeline contract
+ * @param pipeline - An argument that may be a Pipeline
+ * @returns true when the argument satisfies the Pipeline contract
+ */
+export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
 /**
  * The details for a specific lease.
  */
@@ -6790,7 +6791,7 @@ export declare class PageBlobClient extends BlobClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new PageBlobClient object identical to the source but with the
      * specified snapshot timestamp.
@@ -7527,7 +7528,7 @@ export declare interface ParsedBatchResponse {
  * Refer to {@link newPipeline} and provided policies before implementing your
  * customized Pipeline.
  */
-export declare class Pipeline {
+export declare class Pipeline implements PipelineLike {
     /**
      * A list of chained request policy factories.
      */
@@ -7551,6 +7552,31 @@ export declare class Pipeline {
      */
     toServiceClientOptions(): ServiceClientOptions;
 }
+/**
+ * An interface for the {@link Pipeline} class containing HTTP request policies.
+ * You can create a default Pipeline by calling {@link newPipeline}.
+ * Or you can create a Pipeline with your own policies by the constructor of Pipeline.
+ *
+ * Refer to {@link newPipeline} and provided policies before implementing your
+ * customized Pipeline.
+ */
+export declare interface PipelineLike {
+    /**
+     * A list of chained request policy factories.
+     */
+    readonly factories: RequestPolicyFactory[];
+    /**
+     * Configures pipeline logger and HTTP client.
+     */
+    readonly options: PipelineOptions;
+    /**
+     * Transfer Pipeline object to ServiceClientOptions object which is required by
+     * ServiceClient constructor.
+     *
+     * @returns The ServiceClientOptions object from this Pipeline.
+     */
+    toServiceClientOptions(): ServiceClientOptions;
+}
 /**
  * Option interface for Pipeline constructor.
  */
@@ -7674,7 +7700,7 @@ export declare enum SASProtocol {
 /**
  * Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
  * by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link BlobSASSignatureValues}
- * types. Once generated, it can be encoded into a {@code String} and appended to a URL directly (though caution should
+ * types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
  * be taken here in case there are existing query parameters, which might affect the appropriate means of appending
  * these query parameters).
  *
@@ -8414,7 +8440,7 @@ declare abstract class StorageClient {
      * @param url - url to resource
      * @param pipeline - request policy pipeline.
      */
-    protected constructor(url: string, pipeline: Pipeline);
+    protected constructor(url: string, pipeline: PipelineLike);
 }
 declare class StorageClientContext extends coreHttp.ServiceClient {
     url: string;

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

@@ -139,7 +139,7 @@ export declare interface AccountSASPermissionsLike {
      */
     write?: boolean;
     /**
-     * Permission to create blobs and files granted.
+     * Permission to delete blobs and files granted.
      */
     delete?: boolean;
     /**
@@ -572,7 +572,7 @@ export declare class AppendBlobClient extends BlobClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new AppendBlobClient object identical to the source but with the
      * specified snapshot timestamp.
@@ -1048,7 +1048,7 @@ export declare class BlobBatchClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a {@link BlobBatch}.
      * A BlobBatch represents an aggregated set of operations on blobs.
@@ -1161,12 +1161,7 @@ export declare type BlobBatchSetBlobsAccessTierResponse = BlobBatchSubmitBatchRe
 /**
  * Options to configure the Service - Submit Batch Optional Params.
  */
-export declare interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmitBatchOptionalParamsModel, CommonOptions {
-    /**
-     * An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
-     * For example, use the @azure/abort-controller to create an `AbortSignal`.
-     */
-    abortSignal?: AbortSignalLike;
+export declare interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmitBatchOptionalParamsModel {
 }
 
 /**
@@ -1341,7 +1336,7 @@ export declare class BlobClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new BlobClient object identical to the source but with the specified snapshot timestamp.
      * Provide "" will remove the snapshot and return a Client to the base blob.
@@ -3181,7 +3176,7 @@ export declare class BlobServiceClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a {@link ContainerClient} object
      *
@@ -4099,7 +4094,7 @@ export declare class BlockBlobClient extends BlobClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new BlockBlobClient object identical to the source but with the
      * specified snapshot timestamp.
@@ -5197,7 +5192,7 @@ export declare class ContainerClient extends StorageClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new container under the specified account. If the container with
      * the same name already exists, the operation fails.
@@ -6038,7 +6033,7 @@ export declare interface ContainerListBlobsOptions extends CommonOptions {
     /**
      * Specifies whether deleted blob with versions be returned in the response.
      */
-    includeDeletedwithVersions?: boolean;
+    includeDeletedWithVersions?: boolean;
     /**
      * Specifies whether blob immutability policy be returned in the response.
      */
@@ -6645,13 +6640,20 @@ export declare interface HttpAuthorization {
     /**
      * the credentials containing the authentication information of the user agent for the resource being requested.
      */
-    parameter: string;
+    value: string;
 }
 export { HttpHeaders }
 export { HttpOperationResponse }
 export { HttpRequestBody }
 export { IHttpClient }
 
+/**
+ * A helper to decide if a given argument satisfies the Pipeline contract
+ * @param pipeline - An argument that may be a Pipeline
+ * @returns true when the argument satisfies the Pipeline contract
+ */
+export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
+
 /**
  * The details for a specific lease.
  */
@@ -7061,7 +7063,7 @@ export declare class PageBlobClient extends BlobClient {
      * @param pipeline - Call newPipeline() to create a default
      *                            pipeline, or provide a customized pipeline.
      */
-    constructor(url: string, pipeline: Pipeline);
+    constructor(url: string, pipeline: PipelineLike);
     /**
      * Creates a new PageBlobClient object identical to the source but with the
      * specified snapshot timestamp.
@@ -7828,7 +7830,7 @@ export declare interface ParsedBatchResponse {
  * Refer to {@link newPipeline} and provided policies before implementing your
  * customized Pipeline.
  */
-export declare class Pipeline {
+export declare class Pipeline implements PipelineLike {
     /**
      * A list of chained request policy factories.
      */
@@ -7853,6 +7855,32 @@ export declare class Pipeline {
     toServiceClientOptions(): ServiceClientOptions;
 }
 
+/**
+ * An interface for the {@link Pipeline} class containing HTTP request policies.
+ * You can create a default Pipeline by calling {@link newPipeline}.
+ * Or you can create a Pipeline with your own policies by the constructor of Pipeline.
+ *
+ * Refer to {@link newPipeline} and provided policies before implementing your
+ * customized Pipeline.
+ */
+export declare interface PipelineLike {
+    /**
+     * A list of chained request policy factories.
+     */
+    readonly factories: RequestPolicyFactory[];
+    /**
+     * Configures pipeline logger and HTTP client.
+     */
+    readonly options: PipelineOptions;
+    /**
+     * Transfer Pipeline object to ServiceClientOptions object which is required by
+     * ServiceClient constructor.
+     *
+     * @returns The ServiceClientOptions object from this Pipeline.
+     */
+    toServiceClientOptions(): ServiceClientOptions;
+}
+
 /**
  * Option interface for Pipeline constructor.
  */
@@ -7984,7 +8012,7 @@ export declare enum SASProtocol {
 /**
  * Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly
  * by the user; it is only generated by the {@link AccountSASSignatureValues} and {@link BlobSASSignatureValues}
- * types. Once generated, it can be encoded into a {@code String} and appended to a URL directly (though caution should
+ * types. Once generated, it can be encoded into a {@link String} and appended to a URL directly (though caution should
  * be taken here in case there are existing query parameters, which might affect the appropriate means of appending
  * these query parameters).
  *
@@ -8766,7 +8794,7 @@ declare abstract class StorageClient {
      * @param url - url to resource
      * @param pipeline - request policy pipeline.
      */
-    protected constructor(url: string, pipeline: Pipeline);
+    protected constructor(url: string, pipeline: PipelineLike);
 }
 
 declare class StorageClientContext extends coreHttp.ServiceClient {