@azure/storage-blob 12.8.0-beta.1 → 12.8.1-alpha.20210930.1

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

@@ -1,5 +1,6 @@
 /// <reference types="node" />
 import { AbortSignalLike } from '@azure/abort-controller';
+import { AzureLogger } from '@azure/logger';
 import { BaseRequestPolicy } from '@azure/core-http';
 import * as coreHttp from '@azure/core-http';
 import { deserializationPolicy } from '@azure/core-http';
@@ -134,7 +135,7 @@ export declare interface AccountSASPermissionsLike {
      */
     write?: boolean;
     /**
-     * Permission to create blobs and files granted.
+     * Permission to delete blobs and files granted.
      */
     delete?: boolean;
     /**
@@ -308,7 +309,7 @@ export declare interface AccountSASSignatureValues {
  * HTTP(S) requests that read public resources or for use with Shared Access
  * Signatures (SAS).
  */
-export declare class AnonymousCredential extends Credential {
+export declare class AnonymousCredential extends Credential_2 {
     /**
      * Creates an {@link AnonymousCredentialPolicy} object.
      *
@@ -555,7 +556,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 +1015,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 +1125,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 &commat;azure/abort-controller to create an `AbortSignal`.
-     */
-    abortSignal?: AbortSignalLike;
+export declare interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmitBatchOptionalParamsModel {
 }
 /**
  * Contains response data for blob batch operations.
@@ -1291,7 +1287,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 +3062,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 +3947,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.
@@ -4487,7 +4483,7 @@ export declare interface BlockBlobStageBlockFromURLOptions extends CommonOptions
      * Specifies the bytes of the source Blob/File to upload.
      * If not specified, the entire content is uploaded as a single block.
      */
-    range?: Range;
+    range?: Range_2;
     /**
      * If specified, contains the lease id that must be matched and lease with this id
      * must be active in order for the operation to succeed.
@@ -5015,7 +5011,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 +5828,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.
      */
@@ -6174,7 +6170,7 @@ export declare interface CpkInfo {
  * Credential is an abstract class for Azure Storage HTTP requests signing. This
  * class will host an credentialPolicyCreator factory which generates CredentialPolicy.
  */
-export declare abstract class Credential implements RequestPolicyFactory {
+declare abstract class Credential_2 implements RequestPolicyFactory {
     /**
      * Creates a RequestPolicy object.
      *
@@ -6183,6 +6179,7 @@ export declare abstract class Credential implements RequestPolicyFactory {
      */
     create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }
+export { Credential_2 as Credential };
 /**
  * Credential policy used to sign HTTP(S) requests before sending. This is an
  * abstract class.
@@ -6404,12 +6401,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.
  */
@@ -6561,7 +6564,7 @@ export declare interface ListContainersSegmentResponse {
 /**
  * The `@azure/logger` configuration for this package.
  */
-export declare const logger: import("@azure/logger").AzureLogger;
+export declare const logger: AzureLogger;
 /** Azure Analytics Logging settings. */
 export declare interface Logging {
     /** The version of Storage Analytics to configure. */
@@ -6790,7 +6793,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.
@@ -7495,12 +7498,12 @@ export declare interface PageList {
     /**
      * Valid non-overlapping page ranges.
      */
-    pageRange?: Range[];
+    pageRange?: Range_2[];
     /**
      * Present if the prevSnapshot parameter was specified and there were cleared
      * pages between the previous snapshot and the target snapshot.
      */
-    clearRange?: Range[];
+    clearRange?: Range_2[];
 }
 /**
  * The multipart/mixed response which contains the response for each subrequest.
@@ -7527,7 +7530,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 +7554,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.
  */
@@ -7619,7 +7647,7 @@ export declare type PublicAccessType = "container" | "blob";
  * Range for Blob Service Operations.
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations
  */
-export declare interface Range {
+declare interface Range_2 {
     /**
      * StartByte, larger than or equal 0.
      */
@@ -7630,6 +7658,7 @@ export declare interface Range {
      */
     count?: number;
 }
+export { Range_2 as Range };
 /** Defines values for RehydratePriority. */
 export declare type RehydratePriority = "High" | "Standard";
 export { RequestPolicy };
@@ -7674,7 +7703,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 +8443,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;
@@ -8593,7 +8622,7 @@ export declare enum StorageRetryPolicyType {
  *
  * StorageSharedKeyCredential for account key authorization of Azure Storage service.
  */
-export declare class StorageSharedKeyCredential extends Credential {
+export declare class StorageSharedKeyCredential extends Credential_2 {
     /**
      * Azure Storage account name; readonly.
      */

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

@@ -1,5 +1,7 @@
 /// <reference types="node" />
+
 import { AbortSignalLike } from '@azure/abort-controller';
+import { AzureLogger } from '@azure/logger';
 import { BaseRequestPolicy } from '@azure/core-http';
 import * as coreHttp from '@azure/core-http';
 import { deserializationPolicy } from '@azure/core-http';
@@ -139,7 +141,7 @@ export declare interface AccountSASPermissionsLike {
      */
     write?: boolean;
     /**
-     * Permission to create blobs and files granted.
+     * Permission to delete blobs and files granted.
      */
     delete?: boolean;
     /**
@@ -317,7 +319,7 @@ export declare interface AccountSASSignatureValues {
  * HTTP(S) requests that read public resources or for use with Shared Access
  * Signatures (SAS).
  */
-export declare class AnonymousCredential extends Credential {
+export declare class AnonymousCredential extends Credential_2 {
     /**
      * Creates an {@link AnonymousCredentialPolicy} object.
      *
@@ -572,7 +574,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.
@@ -829,6 +831,7 @@ export declare interface AppendPositionAccessConditions {
 
 /** Defines values for ArchiveStatus. */
 export declare type ArchiveStatus = "rehydrate-pending-to-hot" | "rehydrate-pending-to-cool";
+
 export { BaseRequestPolicy }
 
 /**
@@ -1048,7 +1051,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 +1164,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 &commat;azure/abort-controller to create an `AbortSignal`.
-     */
-    abortSignal?: AbortSignalLike;
+export declare interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmitBatchOptionalParamsModel {
 }
 
 /**
@@ -1341,7 +1339,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 +3179,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 +4097,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.
@@ -4647,7 +4645,7 @@ export declare interface BlockBlobStageBlockFromURLOptions extends CommonOptions
      * Specifies the bytes of the source Blob/File to upload.
      * If not specified, the entire content is uploaded as a single block.
      */
-    range?: Range;
+    range?: Range_2;
     /**
      * If specified, contains the lease id that must be matched and lease with this id
      * must be active in order for the operation to succeed.
@@ -5197,7 +5195,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 +6036,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.
      */
@@ -6401,7 +6399,7 @@ export declare interface CpkInfo {
  * Credential is an abstract class for Azure Storage HTTP requests signing. This
  * class will host an credentialPolicyCreator factory which generates CredentialPolicy.
  */
-export declare abstract class Credential implements RequestPolicyFactory {
+declare abstract class Credential_2 implements RequestPolicyFactory {
     /**
      * Creates a RequestPolicy object.
      *
@@ -6410,6 +6408,7 @@ export declare abstract class Credential implements RequestPolicyFactory {
      */
     create(_nextPolicy: RequestPolicy, _options: RequestPolicyOptions): RequestPolicy;
 }
+export { Credential_2 as Credential }
 
 /**
  * Credential policy used to sign HTTP(S) requests before sending. This is an
@@ -6438,6 +6437,7 @@ export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, option
 
 /** Defines values for DeleteSnapshotsOptionType. */
 export declare type DeleteSnapshotsOptionType = "include" | "only";
+
 export { deserializationPolicy }
 
 /** Defines values for EncryptionAlgorithmType. */
@@ -6645,13 +6645,24 @@ 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.
  */
@@ -6817,7 +6828,7 @@ export declare interface ListContainersSegmentResponse {
 /**
  * The `@azure/logger` configuration for this package.
  */
-export declare const logger: import("@azure/logger").AzureLogger;
+export declare const logger: AzureLogger;
 
 /** Azure Analytics Logging settings. */
 export declare interface Logging {
@@ -7061,7 +7072,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.
@@ -7794,12 +7805,12 @@ export declare interface PageList {
     /**
      * Valid non-overlapping page ranges.
      */
-    pageRange?: Range[];
+    pageRange?: Range_2[];
     /**
      * Present if the prevSnapshot parameter was specified and there were cleared
      * pages between the previous snapshot and the target snapshot.
      */
-    clearRange?: Range[];
+    clearRange?: Range_2[];
 }
 
 /**
@@ -7828,7 +7839,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 +7864,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.
  */
@@ -7862,7 +7899,9 @@ export declare interface PipelineOptions {
      */
     httpClient?: IHttpClient;
 }
+
 export { PollerLike }
+
 export { PollOperationState }
 
 /**
@@ -7924,7 +7963,7 @@ export declare type PublicAccessType = "container" | "blob";
  * Range for Blob Service Operations.
  * @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations
  */
-export declare interface Range {
+declare interface Range_2 {
     /**
      * StartByte, larger than or equal 0.
      */
@@ -7935,12 +7974,17 @@ export declare interface Range {
      */
     count?: number;
 }
+export { Range_2 as Range }
 
 /** Defines values for RehydratePriority. */
 export declare type RehydratePriority = "High" | "Standard";
+
 export { RequestPolicy }
+
 export { RequestPolicyFactory }
+
 export { RequestPolicyOptions }
+
 export { RestError }
 
 /** the retention policy which determines how long the associated data should persist */
@@ -7984,7 +8028,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 +8810,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 {
@@ -8954,7 +8998,7 @@ export declare enum StorageRetryPolicyType {
  *
  * StorageSharedKeyCredential for account key authorization of Azure Storage service.
  */
-export declare class StorageSharedKeyCredential extends Credential {
+export declare class StorageSharedKeyCredential extends Credential_2 {
     /**
      * Azure Storage account name; readonly.
      */
@@ -9104,6 +9148,7 @@ export declare interface UserDelegationKeyModel {
     /** The key as a base64 string */
     value: string;
 }
+
 export { WebResource }
 
 export { }