Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions sdk/storage/storage-blob/src/AppendBlobClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ import { newPipeline, NewPipelineOptions, Pipeline } from "./Pipeline";
import { URLConstants } from "./utils/constants";
import { setURLParameter, extractConnectionStringParts } from "./utils/utils.common";
import { SharedKeyCredential } from "./credentials/SharedKeyCredential";
import { Credential } from "./credentials/Credential";
import { AnonymousCredential } from "./credentials/AnonymousCredential";

/**
Expand Down Expand Up @@ -149,13 +148,17 @@ export class AppendBlobClient extends BlobClient {
* Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
* However, if a blob name includes ? or %, blob name must be encoded in the URL.
* Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
* @param {Credential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* @param {SharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* or a TokenCredential from @azure/identity. If not specified,
* AnonymousCredential is used.
* @param {NewPipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
* @memberof AppendBlobClient
*/
constructor(url: string, credential: Credential | TokenCredential, options?: NewPipelineOptions);
constructor(
url: string,
credential: SharedKeyCredential | AnonymousCredential | TokenCredential,
options?: NewPipelineOptions
);
/**
* Creates an instance of AppendBlobClient.
* This method accepts an encoded URL or non-encoded URL pointing to an append blob.
Expand All @@ -177,7 +180,12 @@ export class AppendBlobClient extends BlobClient {
constructor(url: string, pipeline: Pipeline);
constructor(
urlOrConnectionString: string,
credentialOrPipelineOrContainerName: string | Credential | TokenCredential | Pipeline,
credentialOrPipelineOrContainerName:
| string
| SharedKeyCredential
| AnonymousCredential
| TokenCredential
| Pipeline,
blobNameOrOptions?: string | NewPipelineOptions,
options?: NewPipelineOptions
) {
Expand All @@ -187,7 +195,8 @@ export class AppendBlobClient extends BlobClient {
if (credentialOrPipelineOrContainerName instanceof Pipeline) {
pipeline = credentialOrPipelineOrContainerName;
} else if (
credentialOrPipelineOrContainerName instanceof Credential ||
credentialOrPipelineOrContainerName instanceof SharedKeyCredential ||
credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
isTokenCredential(credentialOrPipelineOrContainerName)
) {
options = blobNameOrOptions as NewPipelineOptions;
Expand Down
19 changes: 14 additions & 5 deletions sdk/storage/storage-blob/src/BlobClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import {
import { AppendBlobClient, StorageClient } from "./internal";
import { BlockBlobClient } from "./internal";
import { PageBlobClient } from "./internal";
import { Credential } from "./credentials/Credential";
import { SharedKeyCredential } from "./credentials/SharedKeyCredential";
import { AnonymousCredential } from "./credentials/AnonymousCredential";
import { Batch } from "./utils/Batch";
Expand Down Expand Up @@ -584,13 +583,17 @@ export class BlobClient extends StorageClient {
* @param {string} url A Client string pointing to Azure Storage blob service, such as
* "https://myaccount.blob.core.windows.net". You can append a SAS
* if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
* @param {Credential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* @param {SharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* or a TokenCredential from @azure/identity. If not specified,
* AnonymousCredential is used.
* @param {NewPipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
* @memberof BlobClient
*/
constructor(url: string, credential?: Credential | TokenCredential, options?: NewPipelineOptions);
constructor(
url: string,
credential?: SharedKeyCredential | AnonymousCredential | TokenCredential,
options?: NewPipelineOptions
);
/**
* Creates an instance of BlobClient.
* This method accepts an encoded URL or non-encoded URL pointing to a blob.
Expand All @@ -612,15 +615,21 @@ export class BlobClient extends StorageClient {
constructor(url: string, pipeline: Pipeline);
constructor(
urlOrConnectionString: string,
credentialOrPipelineOrContainerName?: string | Credential | TokenCredential | Pipeline,
credentialOrPipelineOrContainerName?:
| string
| SharedKeyCredential
| AnonymousCredential
| TokenCredential
| Pipeline,
blobNameOrOptions?: string | NewPipelineOptions,
options?: NewPipelineOptions
) {
let pipeline: Pipeline;
if (credentialOrPipelineOrContainerName instanceof Pipeline) {
pipeline = credentialOrPipelineOrContainerName;
} else if (
credentialOrPipelineOrContainerName instanceof Credential ||
credentialOrPipelineOrContainerName instanceof SharedKeyCredential ||
credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
isTokenCredential(credentialOrPipelineOrContainerName)
) {
options = blobNameOrOptions as NewPipelineOptions;
Expand Down
14 changes: 9 additions & 5 deletions sdk/storage/storage-blob/src/BlobServiceClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ import {
ContainerDeleteMethodOptions
} from "./ContainerClient";
import { appendToURLPath, extractConnectionStringParts } from "./utils/utils.common";
import { Credential } from "./credentials/Credential";
import { SharedKeyCredential } from "./credentials/SharedKeyCredential";
import { AnonymousCredential } from "./credentials/AnonymousCredential";
import { StorageClient } from "./internal";
Expand Down Expand Up @@ -201,13 +200,17 @@ export class BlobServiceClient extends StorageClient {
* @param {string} url A Client string pointing to Azure Storage blob service, such as
* "https://myaccount.blob.core.windows.net". You can append a SAS
* if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
* @param {Credential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* @param {SharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* or a TokenCredential from @azure/identity. If not specified,
* AnonymousCredential is used.
* @param {NewPipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
* @memberof BlobServiceClient
*/
constructor(url: string, credential?: Credential | TokenCredential, options?: NewPipelineOptions);
constructor(
url: string,
credential?: SharedKeyCredential | AnonymousCredential | TokenCredential,
options?: NewPipelineOptions
);
/**
* Creates an instance of BlobServiceClient.
*
Expand All @@ -221,14 +224,15 @@ export class BlobServiceClient extends StorageClient {
constructor(url: string, pipeline: Pipeline);
constructor(
url: string,
credentialOrPipeline?: Credential | TokenCredential | Pipeline,
credentialOrPipeline?: SharedKeyCredential | AnonymousCredential | TokenCredential | Pipeline,
options?: NewPipelineOptions
) {
let pipeline: Pipeline;
if (credentialOrPipeline instanceof Pipeline) {
pipeline = credentialOrPipeline;
} else if (
credentialOrPipeline instanceof Credential ||
credentialOrPipeline instanceof SharedKeyCredential ||
credentialOrPipeline instanceof AnonymousCredential ||
isTokenCredential(credentialOrPipeline)
) {
pipeline = newPipeline(credentialOrPipeline, options);
Expand Down
19 changes: 14 additions & 5 deletions sdk/storage/storage-blob/src/BlockBlobClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ import {
generateBlockID
} from "./utils/utils.common";
import { SharedKeyCredential } from "./credentials/SharedKeyCredential";
import { Credential } from "./credentials/Credential";
import { AnonymousCredential } from "./credentials/AnonymousCredential";
import {
URLConstants,
Expand Down Expand Up @@ -427,11 +426,15 @@ export class BlockBlobClient extends BlobClient {
* Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
* However, if a blob name includes ? or %, blob name must be encoded in the URL.
* Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
* @param {Credential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential or TokenCredential.
* @param {SharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential or TokenCredential.
* @param {NewPipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
* @memberof BlockBlobClient
*/
constructor(url: string, credential?: Credential | TokenCredential, options?: NewPipelineOptions);
constructor(
url: string,
credential?: SharedKeyCredential | AnonymousCredential | TokenCredential,
options?: NewPipelineOptions
);
/**
* Creates an instance of BlockBlobClient.
* This method accepts an encoded URL or non-encoded URL pointing to a block blob.
Expand All @@ -453,7 +456,12 @@ export class BlockBlobClient extends BlobClient {
constructor(url: string, pipeline: Pipeline);
constructor(
urlOrConnectionString: string,
credentialOrPipelineOrContainerName?: string | Credential | TokenCredential | Pipeline,
credentialOrPipelineOrContainerName?:
| string
| SharedKeyCredential
| AnonymousCredential
| TokenCredential
| Pipeline,
blobNameOrOptions?: string | NewPipelineOptions,
options?: NewPipelineOptions
) {
Expand All @@ -463,7 +471,8 @@ export class BlockBlobClient extends BlobClient {
if (credentialOrPipelineOrContainerName instanceof Pipeline) {
pipeline = credentialOrPipelineOrContainerName;
} else if (
credentialOrPipelineOrContainerName instanceof Credential ||
credentialOrPipelineOrContainerName instanceof SharedKeyCredential ||
credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
isTokenCredential(credentialOrPipelineOrContainerName)
) {
options = blobNameOrOptions as NewPipelineOptions;
Expand Down
19 changes: 14 additions & 5 deletions sdk/storage/storage-blob/src/ContainerClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ import {
BlockBlobUploadOptions,
BlobDeleteOptions
} from "./internal";
import { Credential } from "./credentials/Credential";
import { SharedKeyCredential } from "./credentials/SharedKeyCredential";
import { AnonymousCredential } from "./credentials/AnonymousCredential";
import { LeaseClient } from "./LeaseClient";
Expand Down Expand Up @@ -481,13 +480,17 @@ export class ContainerClient extends StorageClient {
* Encoded URL string will NOT be escaped twice, only special characters in URL path will be escaped.
* However, if a blob name includes ? or %, blob name must be encoded in the URL.
* Such as a blob named "my?blob%", the URL should be "https://myaccount.blob.core.windows.net/mycontainer/my%3Fblob%25".
* @param {Credential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* @param {SharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* or a TokenCredential from @azure/identity. If not specified,
* AnonymousCredential is used.
* @param {NewPipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
* @memberof ContainerClient
*/
constructor(url: string, credential?: Credential | TokenCredential, options?: NewPipelineOptions);
constructor(
url: string,
credential?: SharedKeyCredential | AnonymousCredential | TokenCredential,
options?: NewPipelineOptions
);
/**
* Creates an instance of PageBlobClient.
* This method accepts an encoded URL or non-encoded URL pointing to a page blob.
Expand All @@ -510,14 +513,20 @@ export class ContainerClient extends StorageClient {
constructor(url: string, pipeline: Pipeline);
constructor(
urlOrConnectionString: string,
credentialOrPipelineOrContainerName?: string | Credential | TokenCredential | Pipeline,
credentialOrPipelineOrContainerName?:
| string
| SharedKeyCredential
| AnonymousCredential
| TokenCredential
| Pipeline,
options?: NewPipelineOptions
) {
let pipeline: Pipeline;
if (credentialOrPipelineOrContainerName instanceof Pipeline) {
pipeline = credentialOrPipelineOrContainerName;
} else if (
credentialOrPipelineOrContainerName instanceof Credential ||
credentialOrPipelineOrContainerName instanceof SharedKeyCredential ||
credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
isTokenCredential(credentialOrPipelineOrContainerName)
) {
pipeline = newPipeline(credentialOrPipelineOrContainerName, options);
Expand Down
19 changes: 14 additions & 5 deletions sdk/storage/storage-blob/src/PageBlobClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ import { newPipeline, NewPipelineOptions, Pipeline } from "./Pipeline";
import { URLConstants } from "./utils/constants";
import { setURLParameter, extractConnectionStringParts } from "./utils/utils.common";
import { SharedKeyCredential } from "./credentials/SharedKeyCredential";
import { Credential } from "./credentials/Credential";
import { AnonymousCredential } from "./credentials/AnonymousCredential";

/**
Expand Down Expand Up @@ -309,12 +308,16 @@ export class PageBlobClient extends BlobClient {
* @param {string} url A Client string pointing to Azure Storage blob service, such as
* "https://myaccount.blob.core.windows.net". You can append a SAS
* if using AnonymousCredential, such as "https://myaccount.blob.core.windows.net?sasString".
* @param {Credential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* @param {SharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* or a TokenCredential from @azure/identity.
* @param {NewPipelineOptions} [options] Optional. Options to configure the HTTP pipeline.
* @memberof PageBlobClient
*/
constructor(url: string, credential: Credential | TokenCredential, options?: NewPipelineOptions);
constructor(
url: string,
credential: SharedKeyCredential | AnonymousCredential | TokenCredential,
options?: NewPipelineOptions
);
/**
* Creates an instance of PageBlobClient.
*
Expand All @@ -333,7 +336,12 @@ export class PageBlobClient extends BlobClient {
constructor(url: string, pipeline: Pipeline);
constructor(
urlOrConnectionString: string,
credentialOrPipelineOrContainerName: string | Credential | TokenCredential | Pipeline,
credentialOrPipelineOrContainerName:
| string
| SharedKeyCredential
| AnonymousCredential
| TokenCredential
| Pipeline,
blobNameOrOptions?: string | NewPipelineOptions,
options?: NewPipelineOptions
) {
Expand All @@ -343,7 +351,8 @@ export class PageBlobClient extends BlobClient {
if (credentialOrPipelineOrContainerName instanceof Pipeline) {
pipeline = credentialOrPipelineOrContainerName;
} else if (
credentialOrPipelineOrContainerName instanceof Credential ||
credentialOrPipelineOrContainerName instanceof SharedKeyCredential ||
credentialOrPipelineOrContainerName instanceof AnonymousCredential ||
isTokenCredential(credentialOrPipelineOrContainerName)
) {
options = blobNameOrOptions as NewPipelineOptions;
Expand Down
7 changes: 4 additions & 3 deletions sdk/storage/storage-blob/src/Pipeline.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,12 @@ import {
} from "@azure/core-http";

import { BrowserPolicyFactory } from "./BrowserPolicyFactory";
import { Credential } from "./credentials/Credential";
import { LoggingPolicyFactory } from "./LoggingPolicyFactory";
import { RetryOptions, RetryPolicyFactory } from "./RetryPolicyFactory";
import { TelemetryOptions, TelemetryPolicyFactory } from "./TelemetryPolicyFactory";
import { UniqueRequestIDPolicyFactory } from "./UniqueRequestIDPolicyFactory";
import { SharedKeyCredential } from "./credentials/SharedKeyCredential";
import { AnonymousCredential } from "./credentials/AnonymousCredential";

// Export following interfaces and types for customers who want to implement their
// own RequestPolicy or HTTPClient
Expand Down Expand Up @@ -188,13 +189,13 @@ export interface NewPipelineOptions {
* Creates a new Pipeline object with Credential provided.
*
* @export
* @param {Credential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* @param {SharedKeyCredential | AnonymousCredential | TokenCredential} credential Such as AnonymousCredential, SharedKeyCredential, RawTokenCredential,
* or a TokenCredential from @azure/identity.
* @param {NewPipelineOptions} [pipelineOptions] Optional. Options.
* @returns {Pipeline} A new Pipeline object.
*/
export function newPipeline(
credential: Credential | TokenCredential,
credential: SharedKeyCredential | AnonymousCredential | TokenCredential,
pipelineOptions: NewPipelineOptions = {}
): Pipeline {
// Order is important. Closer to the API at the top & closer to the network at the bottom.
Expand Down
Loading