diff --git a/sdk/storage/storage-blob/review/storage-blob-browser.api.diff.md b/sdk/storage/storage-blob/review/storage-blob-browser.api.diff.md index bb94b5507e7d..77fc84a9eff8 100644 --- a/sdk/storage/storage-blob/review/storage-blob-browser.api.diff.md +++ b/sdk/storage/storage-blob/review/storage-blob-browser.api.diff.md @@ -133,7 +133,7 @@ For the complete API surface, see the corresponding -node.api.md file. customerProvidedKey?: CpkInfo; encryptionScope?: string; sourceAuthorization?: HttpAuthorization; -@@ -241,8 +173,9 @@ +@@ -244,8 +176,9 @@ customerProvidedKey?: CpkInfo; encryptionScope?: string; immutabilityPolicy?: BlobImmutabilityPolicy; @@ -143,7 +143,7 @@ For the complete API surface, see the corresponding -node.api.md file. } // @public -@@ -253,8 +186,9 @@ +@@ -256,8 +189,9 @@ // @public export interface AppendBlobCreateOptions extends CommonOptions { abortSignal?: AbortSignalLike; @@ -153,7 +153,7 @@ For the complete API surface, see the corresponding -node.api.md file. customerProvidedKey?: CpkInfo; encryptionScope?: string; immutabilityPolicy?: BlobImmutabilityPolicy; -@@ -266,12 +200,8 @@ +@@ -269,12 +203,8 @@ // @public export type AppendBlobCreateResponse = WithResponse; @@ -166,7 +166,7 @@ For the complete API surface, see the corresponding -node.api.md file. abortSignal?: AbortSignalLike; conditions?: AppendBlobRequestConditions; } -@@ -323,8 +253,9 @@ +@@ -326,8 +256,9 @@ // @public export interface BlobAcquireLeaseOptions extends CommonOptions { @@ -176,7 +176,7 @@ For the complete API surface, see the corresponding -node.api.md file. } // @public -@@ -366,22 +297,14 @@ +@@ -369,22 +300,14 @@ // @public export interface BlobBeginCopyFromURLOptions extends BlobStartCopyFromURLOptions { @@ -200,7 +200,7 @@ For the complete API surface, see the corresponding -node.api.md file. } // @public -@@ -403,15 +326,17 @@ +@@ -406,15 +329,17 @@ constructor(connectionString: string, containerName: string, blobName: string, options?: BlobClientOptions); constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobClientOptions); constructor(url: string, pipeline: PipelineLike, options?: BlobClientConfig); @@ -218,7 +218,7 @@ For the complete API surface, see the corresponding -node.api.md file. downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise; downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise; downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise; -@@ -632,14 +557,8 @@ +@@ -635,14 +560,8 @@ // @public export type BlobDownloadResponseModel = WithResponse; @@ -233,7 +233,7 @@ For the complete API surface, see the corresponding -node.api.md file. abortSignal?: AbortSignalLike; blockSize?: number; concurrency?: number; -@@ -670,8 +589,9 @@ +@@ -673,8 +592,9 @@ } // @public @@ -243,7 +243,7 @@ For the complete API surface, see the corresponding -node.api.md file. } // @public -@@ -761,8 +681,9 @@ +@@ -764,8 +684,9 @@ // @public export interface BlobGetPropertiesResponse extends BlobGetPropertiesResponseModel { @@ -253,7 +253,7 @@ For the complete API surface, see the corresponding -node.api.md file. } // @public -@@ -985,23 +906,13 @@ +@@ -988,23 +909,13 @@ // @public export interface BlobQueryArrowConfiguration { @@ -278,7 +278,7 @@ For the complete API surface, see the corresponding -node.api.md file. columnSeparator?: string; escapeCharacter?: string; fieldQuote?: string; -@@ -1091,71 +1002,8 @@ +@@ -1094,71 +1005,8 @@ conditions?: ModifiedAccessConditions; } @@ -347,20 +347,20 @@ For the complete API surface, see the corresponding -node.api.md file. - -// @public export class BlobServiceClient extends StorageClient { - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobServiceClientOptions); constructor(url: string, pipeline: PipelineLike, options?: BlobClientConfig); createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ -@@ -1164,8 +1012,9 @@ +@@ -1167,8 +1015,9 @@ }>; deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise; findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions): PagedAsyncIterableIterator; - static fromConnectionString(connectionString: string, options?: BlobClientOptions): BlobServiceClient; + static fromConnectionString(connectionString: string, options?: BlobServiceClientOptions): BlobServiceClient; + // Warning: (ae-forgotten-export) The symbol "AccountSASPermissions" needs to be exported by the entry point index.d.ts generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise; getBlobBatchClient(): BlobBatchClient; -@@ -1709,8 +1558,9 @@ +@@ -1718,8 +1567,9 @@ encryptionScope?: string; expiresOn?: Date; identifier?: string; @@ -370,7 +370,7 @@ For the complete API surface, see the corresponding -node.api.md file. startsOn?: Date; version?: string; } -@@ -1872,8 +1722,9 @@ +@@ -1884,8 +1734,9 @@ export type ContainerFindBlobsByTagsSegmentResponse = WithResponse; // @public @@ -380,7 +380,7 @@ For the complete API surface, see the corresponding -node.api.md file. } // @public -@@ -2068,45 +1919,8 @@ +@@ -2080,45 +1931,8 @@ export interface ContainerRequestConditions extends LeaseAccessConditions, ModificationConditions { } @@ -426,7 +426,7 @@ For the complete API surface, see the corresponding -node.api.md file. clientRequestId?: string; date?: Date; errorCode?: string; -@@ -2157,13 +1971,8 @@ +@@ -2169,13 +1983,8 @@ // @public export type ContainerUndeleteResponse = WithResponse; @@ -440,7 +440,7 @@ For the complete API surface, see the corresponding -node.api.md file. // @public export interface CorsRule { -@@ -2184,10 +1993,8 @@ +@@ -2196,10 +2005,8 @@ export { Credential_2 as Credential } export { CredentialPolicy } @@ -451,7 +451,7 @@ For the complete API surface, see the corresponding -node.api.md file. export type DeleteSnapshotsOptionType = "include" | "only"; // @public -@@ -2238,17 +2045,8 @@ +@@ -2250,17 +2057,8 @@ where: string; } @@ -469,7 +469,7 @@ For the complete API surface, see the corresponding -node.api.md file. lastSyncOn: Date; status: GeoReplicationStatusType; } -@@ -2256,11 +2054,8 @@ +@@ -2268,11 +2066,8 @@ // @public export type GeoReplicationStatusType = "live" | "bootstrap" | "unavailable"; @@ -481,7 +481,7 @@ For the complete API surface, see the corresponding -node.api.md file. scheme: string; value: string; } -@@ -2432,13 +2227,8 @@ +@@ -2444,13 +2239,8 @@ ifNoneMatch?: string; } @@ -495,7 +495,7 @@ For the complete API surface, see the corresponding -node.api.md file. enabled: boolean; includeAPIs?: boolean; retentionPolicy?: RetentionPolicy; -@@ -2451,12 +2241,8 @@ +@@ -2463,12 +2253,8 @@ ifUnmodifiedSince?: Date; } @@ -508,7 +508,7 @@ For the complete API surface, see the corresponding -node.api.md file. ifMatch?: string; ifModifiedSince?: Date; ifNoneMatch?: string; -@@ -2466,26 +2252,9 @@ +@@ -2478,26 +2264,9 @@ // @public export function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline; @@ -535,7 +535,7 @@ For the complete API surface, see the corresponding -node.api.md file. blobSequenceNumber?: number; clientRequestId?: string; contentMD5?: Uint8Array; -@@ -2500,8 +2269,9 @@ +@@ -2512,8 +2281,9 @@ // @public export interface PageBlobClearPagesOptions extends CommonOptions { @@ -545,7 +545,7 @@ For the complete API surface, see the corresponding -node.api.md file. customerProvidedKey?: CpkInfo; encryptionScope?: string; } -@@ -2667,12 +2437,8 @@ +@@ -2682,12 +2452,8 @@ conditions?: BlobRequestConditions; } @@ -558,7 +558,7 @@ For the complete API surface, see the corresponding -node.api.md file. blobSequenceNumber?: number; clientRequestId?: string; date?: Date; -@@ -2846,31 +2612,9 @@ +@@ -2861,31 +2627,9 @@ export interface PipelineOptions { httpClient?: RequestPolicy; } @@ -590,7 +590,7 @@ For the complete API surface, see the corresponding -node.api.md file. P10 = "P10", P15 = "P15", P20 = "P20", -@@ -2945,68 +2689,8 @@ +@@ -2960,68 +2704,8 @@ start: string; } @@ -659,7 +659,7 @@ For the complete API surface, see the corresponding -node.api.md file. ifSequenceNumberEqualTo?: number; ifSequenceNumberLessThan?: number; ifSequenceNumberLessThanOrEqualTo?: number; -@@ -3225,21 +2909,19 @@ +@@ -3240,21 +2924,19 @@ errorDocument404Path?: string; indexDocument?: string; } @@ -685,7 +685,7 @@ For the complete API surface, see the corresponding -node.api.md file. export const StorageOAuthScopes: string | string[]; // @public -@@ -3255,16 +2937,14 @@ +@@ -3270,16 +2952,14 @@ export { StorageRetryOptions } export { StorageRetryPolicy } diff --git a/sdk/storage/storage-blob/review/storage-blob-node.api.md b/sdk/storage/storage-blob/review/storage-blob-node.api.md index 3282cfc2e5a2..b8ce27b9c6a6 100644 --- a/sdk/storage/storage-blob/review/storage-blob-node.api.md +++ b/sdk/storage/storage-blob/review/storage-blob-node.api.md @@ -207,8 +207,8 @@ export type AppendBlobAppendBlockResponse = WithResponse; appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise; @@ -218,6 +218,9 @@ export class AppendBlobClient extends BlobClient { withSnapshot(snapshot: string): AppendBlobClient; } +// @public +export type AppendBlobClientOptions = StoragePipelineOptions & BlobClientConfig; + // @public export interface AppendBlobCreateHeaders { clientRequestId?: string; @@ -1156,7 +1159,7 @@ export interface BlobSASSignatureValues { // @public export class BlobServiceClient extends StorageClient { - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobServiceClientOptions); constructor(url: string, pipeline: PipelineLike, options?: BlobClientConfig); createContainer(containerName: string, options?: ContainerCreateOptions): Promise<{ containerClient: ContainerClient; @@ -1164,7 +1167,7 @@ export class BlobServiceClient extends StorageClient { }>; deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise; findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions): PagedAsyncIterableIterator; - static fromConnectionString(connectionString: string, options?: BlobClientOptions): BlobServiceClient; + static fromConnectionString(connectionString: string, options?: BlobServiceClientOptions): BlobServiceClient; generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; getAccountInfo(options?: ServiceGetAccountInfoOptions): Promise; @@ -1182,6 +1185,9 @@ export class BlobServiceClient extends StorageClient { }>; } +// @public +export type BlobServiceClientOptions = StoragePipelineOptions & BlobClientConfig; + // @public export interface BlobServiceProperties { blobAnalyticsLogging?: Logging; @@ -1414,7 +1420,7 @@ export interface Block { // @public export class BlockBlobClient extends BlobClient { constructor(connectionString: string, containerName: string, blobName: string, options?: StoragePipelineOptions); - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlockBlobClientOptions); constructor(url: string, pipeline: PipelineLike, options?: BlobClientConfig); commitBlockList(blocks: string[], options?: BlockBlobCommitBlockListOptions): Promise; getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise; @@ -1431,6 +1437,9 @@ export class BlockBlobClient extends BlobClient { withSnapshot(snapshot: string): BlockBlobClient; } +// @public +export type BlockBlobClientOptions = StoragePipelineOptions & BlobClientConfig; + // @public export interface BlockBlobCommitBlockListHeaders { clientRequestId?: string; @@ -1749,7 +1758,7 @@ export interface ContainerChangeLeaseOptions extends CommonOptions { // @public export class ContainerClient extends StorageClient { constructor(connectionString: string, containerName: string, options?: StoragePipelineOptions); - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: ContainerClientOptions); constructor(url: string, pipeline: PipelineLike, options?: BlobClientConfig); get containerName(): string; create(options?: ContainerCreateOptions): Promise; @@ -1786,6 +1795,9 @@ export class ContainerClient extends StorageClient { }>; } +// @public +export type ContainerClientOptions = StoragePipelineOptions & BlobClientConfig; + // @public export interface ContainerCreateHeaders { clientRequestId?: string; @@ -2511,8 +2523,8 @@ export type PageBlobClearPagesResponse = WithResponse; create(size: number, options?: PageBlobCreateOptions): Promise; @@ -2530,6 +2542,9 @@ export class PageBlobClient extends BlobClient { withSnapshot(snapshot: string): PageBlobClient; } +// @public +export type PageBlobClientOptions = StoragePipelineOptions & BlobClientConfig; + // @public export interface PageBlobCopyIncrementalHeaders { clientRequestId?: string; diff --git a/sdk/storage/storage-blob/src/BlobServiceClient.ts b/sdk/storage/storage-blob/src/BlobServiceClient.ts index 26f7146e90f2..f30fb11d1a88 100644 --- a/sdk/storage/storage-blob/src/BlobServiceClient.ts +++ b/sdk/storage/storage-blob/src/BlobServiceClient.ts @@ -66,7 +66,7 @@ import type { ServiceListContainersSegmentHeaders, ServiceSetPropertiesHeaders, } from "./generated/src/index.js"; -import { BlobClientConfig, BlobClientOptions } from "./models.js"; +import type { BlobClientConfig, BlobServiceClientOptions } from "./models.js"; /** * Options to configure the {@link BlobServiceClient.getProperties} operation. @@ -354,7 +354,7 @@ export class BlobServiceClient extends StorageClient { connectionString: string, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: BlobServiceClientOptions, ): BlobServiceClient { options = options || {}; const extractedCreds = extractConnectionStringParts(connectionString); @@ -435,7 +435,7 @@ export class BlobServiceClient extends StorageClient { credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: BlobServiceClientOptions, ); /** * Creates an instance of BlobServiceClient. @@ -456,7 +456,7 @@ export class BlobServiceClient extends StorageClient { | PipelineLike, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: BlobServiceClientOptions, ) { options = options ?? {}; let pipeline: PipelineLike; diff --git a/sdk/storage/storage-blob/src/Clients.ts b/sdk/storage/storage-blob/src/Clients.ts index 6d57a84eb56a..c4e707cdd769 100644 --- a/sdk/storage/storage-blob/src/Clients.ts +++ b/sdk/storage/storage-blob/src/Clients.ts @@ -148,6 +148,9 @@ import type { BlobClientOptions, BlobClientConfig, AccessTierModifiedConditions, + BlockBlobClientOptions, + AppendBlobClientOptions, + PageBlobClientOptions, } from "./models.js"; import { ensureCpkIfSpecified, toAccessTier, StorageChecksumAlgorithm } from "./models.js"; import type { @@ -2724,7 +2727,7 @@ export class AppendBlobClient extends BlobClient { blobName: string, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: AppendBlobClientOptions, ); /** * Creates an instance of AppendBlobClient. @@ -2748,7 +2751,7 @@ export class AppendBlobClient extends BlobClient { credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: AppendBlobClientOptions, ); /** * Creates an instance of AppendBlobClient. @@ -2776,10 +2779,10 @@ export class AppendBlobClient extends BlobClient { | AnonymousCredential | TokenCredential | PipelineLike, - blobNameOrOptions?: string | BlobClientOptions, + blobNameOrOptions?: string | AppendBlobClientOptions, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: AppendBlobClientOptions, ) { // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead. // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options); @@ -3821,7 +3824,7 @@ export class BlockBlobClient extends BlobClient { credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: BlockBlobClientOptions, ); /** * Creates an instance of BlockBlobClient. @@ -3849,10 +3852,10 @@ export class BlockBlobClient extends BlobClient { | AnonymousCredential | TokenCredential | PipelineLike, - blobNameOrOptions?: string | BlobClientOptions, + blobNameOrOptions?: string | BlockBlobClientOptions, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: BlockBlobClientOptions, ) { // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead. // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options); @@ -5158,7 +5161,7 @@ export class PageBlobClient extends BlobClient { blobName: string, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: PageBlobClientOptions, ); /** * Creates an instance of PageBlobClient. @@ -5177,7 +5180,7 @@ export class PageBlobClient extends BlobClient { credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: PageBlobClientOptions, ); /** * Creates an instance of PageBlobClient. @@ -5202,10 +5205,10 @@ export class PageBlobClient extends BlobClient { | AnonymousCredential | TokenCredential | PipelineLike, - blobNameOrOptions?: string | BlobClientOptions, + blobNameOrOptions?: string | PageBlobClientOptions, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: PageBlobClientOptions, ) { // In TypeScript we cannot simply pass all parameters to super() like below so have to duplicate the code instead. // super(s, credentialOrPipelineOrContainerNameOrOptions, blobNameOrOptions, options); diff --git a/sdk/storage/storage-blob/src/ContainerClient.ts b/sdk/storage/storage-blob/src/ContainerClient.ts index 7d53c1f1ef7b..699bfd34fcb3 100644 --- a/sdk/storage/storage-blob/src/ContainerClient.ts +++ b/sdk/storage/storage-blob/src/ContainerClient.ts @@ -43,8 +43,8 @@ import type { Tags, ContainerRequestConditions, ModifiedAccessConditions, - BlobClientOptions, BlobClientConfig, + ContainerClientOptions, } from "./models.js"; import type { PipelineLike, StoragePipelineOptions } from "./Pipeline.js"; import { newPipeline, isPipelineLike } from "./Pipeline.js"; @@ -649,7 +649,7 @@ export class ContainerClient extends StorageClient { credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: ContainerClientOptions, ); /** * Creates an instance of ContainerClient. @@ -675,7 +675,7 @@ export class ContainerClient extends StorageClient { | PipelineLike, // Legacy, no fix for eslint error without breaking. Disable it for this interface. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options*/ - options?: BlobClientOptions, + options?: ContainerClientOptions, ) { let pipeline: PipelineLike; let url: string; diff --git a/sdk/storage/storage-blob/src/index-browser.mts b/sdk/storage/storage-blob/src/index-browser.mts index a5a1df23da52..5a8308486fb5 100644 --- a/sdk/storage/storage-blob/src/index-browser.mts +++ b/sdk/storage/storage-blob/src/index-browser.mts @@ -14,6 +14,11 @@ export type { SasIPRange } from "./sas/SasIPRange.js"; export type { Range } from "./Range.js"; export { type BlobClientOptions, + type AppendBlobClientOptions, + type BlockBlobClientOptions, + type PageBlobClientOptions, + type ContainerClientOptions, + type BlobServiceClientOptions, type BlobClientConfig, BlockBlobTier, type BlobImmutabilityPolicy, diff --git a/sdk/storage/storage-blob/src/index.ts b/sdk/storage/storage-blob/src/index.ts index 4099f534915d..d7a8feb9d3b1 100644 --- a/sdk/storage/storage-blob/src/index.ts +++ b/sdk/storage/storage-blob/src/index.ts @@ -28,6 +28,11 @@ export type { SasIPRange } from "./sas/SasIPRange.js"; export type { Range } from "./Range.js"; export { type BlobClientOptions, + type AppendBlobClientOptions, + type BlockBlobClientOptions, + type PageBlobClientOptions, + type ContainerClientOptions, + type BlobServiceClientOptions, type BlobClientConfig, BlockBlobTier, PremiumPageBlobTier, diff --git a/sdk/storage/storage-blob/src/models.ts b/sdk/storage/storage-blob/src/models.ts index 5376c7e05fac..f119162fdcf3 100644 --- a/sdk/storage/storage-blob/src/models.ts +++ b/sdk/storage/storage-blob/src/models.ts @@ -439,6 +439,26 @@ export interface BlobClientConfig { } /** - * Options for creating blob client instances + * Options for creating BlobClient instances */ export type BlobClientOptions = StoragePipelineOptions & BlobClientConfig; +/** + * Options for creating BlockBlobClient instances + */ +export type BlockBlobClientOptions = StoragePipelineOptions & BlobClientConfig; +/** + * Options for creating PageBlobClient instances + */ +export type PageBlobClientOptions = StoragePipelineOptions & BlobClientConfig; +/** + * Options for creating AppendBlobClient instances + */ +export type AppendBlobClientOptions = StoragePipelineOptions & BlobClientConfig; +/** + * Options for creating ContainerClient instances + */ +export type ContainerClientOptions = StoragePipelineOptions & BlobClientConfig; +/** + * Options for creating BlobServiceClient instances + */ +export type BlobServiceClientOptions = StoragePipelineOptions & BlobClientConfig; diff --git a/sdk/storage/storage-file-datalake/review/storage-file-datalake-browser.api.diff.md b/sdk/storage/storage-file-datalake/review/storage-file-datalake-browser.api.diff.md index 97033856aed0..be4fda91e226 100644 --- a/sdk/storage/storage-file-datalake/review/storage-file-datalake-browser.api.diff.md +++ b/sdk/storage/storage-file-datalake/review/storage-file-datalake-browser.api.diff.md @@ -118,17 +118,17 @@ For the complete API surface, see the corresponding -node.api.md file. export class DataLakeAclChangeFailedError extends Error { constructor(error: RestError | Error, continuationToken?: string); continuationToken?: string; -@@ -314,8 +266,9 @@ +@@ -311,8 +263,9 @@ } // @public export class DataLakeFileClient extends DataLakePathClient { + // Warning: (ae-forgotten-export) The symbol "StorageSharedKeyCredential" needs to be exported by the entry point index.d.ts - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeFileClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); append(body: HttpRequestBody, offset: number, length: number, options?: FileAppendOptions): Promise; create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise; -@@ -423,55 +376,13 @@ +@@ -429,55 +382,13 @@ export interface DataLakeRequestConditions extends ModifiedAccessConditions, LeaseAccessConditions { } @@ -177,15 +177,15 @@ For the complete API surface, see the corresponding -node.api.md file. - -// @public export class DataLakeServiceClient extends StorageClient { - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeServiceClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); - static fromConnectionString(connectionString: string, options?: DataLakeClientOptions): DataLakeServiceClient; + static fromConnectionString(connectionString: string, options?: DataLakeServiceClientOptions): DataLakeServiceClient; + // Warning: (ae-forgotten-export) The symbol "AccountSASPermissions" needs to be exported by the entry point index.d.ts generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient; getProperties(options?: ServiceGetPropertiesOptions): Promise; -@@ -524,28 +435,13 @@ +@@ -533,28 +444,13 @@ } // @public @@ -215,7 +215,7 @@ For the complete API surface, see the corresponding -node.api.md file. // @public (undocumented) export interface FileAppendOptions extends CommonOptions { -@@ -610,8 +506,9 @@ +@@ -619,8 +515,9 @@ export type FileFlushResponse = WithResponse; // @public @@ -225,7 +225,7 @@ For the complete API surface, see the corresponding -node.api.md file. } // @public -@@ -880,8 +777,9 @@ +@@ -889,8 +786,9 @@ } // @public @@ -235,7 +235,7 @@ For the complete API surface, see the corresponding -node.api.md file. } // @public (undocumented) -@@ -1028,24 +926,8 @@ +@@ -1037,24 +935,8 @@ // @public export type FileSystemRenameResponse = ContainerRenameResponse; @@ -260,7 +260,7 @@ For the complete API surface, see the corresponding -node.api.md file. export interface FileSystemSetAccessPolicyHeaders { // (undocumented) clientRequestId?: string; -@@ -1116,17 +998,8 @@ +@@ -1125,17 +1007,8 @@ // @public (undocumented) export type FileUploadResponse = WithResponse; @@ -278,7 +278,7 @@ For the complete API surface, see the corresponding -node.api.md file. export { HttpHeaders } -@@ -1235,10 +1108,8 @@ +@@ -1244,10 +1117,8 @@ // @public export function newPipeline(credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, pipelineOptions?: StoragePipelineOptions): Pipeline; @@ -289,7 +289,7 @@ For the complete API surface, see the corresponding -node.api.md file. export interface Path { // (undocumented) contentLength?: number; -@@ -1908,78 +1779,8 @@ +@@ -1917,78 +1788,8 @@ // (undocumented) write: boolean; } @@ -368,7 +368,7 @@ For the complete API surface, see the corresponding -node.api.md file. // @public export interface ServiceGenerateAccountSasUrlOptions { -@@ -2087,12 +1888,8 @@ +@@ -2096,12 +1897,8 @@ export { StorageRetryPolicyFactory } export { StorageRetryPolicyType } diff --git a/sdk/storage/storage-file-datalake/review/storage-file-datalake-node.api.md b/sdk/storage/storage-file-datalake/review/storage-file-datalake-node.api.md index 70ad016741cc..48a52cbe0c2b 100644 --- a/sdk/storage/storage-file-datalake/review/storage-file-datalake-node.api.md +++ b/sdk/storage/storage-file-datalake/review/storage-file-datalake-node.api.md @@ -296,9 +296,6 @@ export interface DataLakeClientConfig { uploadContentChecksumAlgorithm?: StorageChecksumAlgorithm; } -// @public -export type DataLakeClientOptions = StoragePipelineOptions & DataLakeClientConfig; - // @public export class DataLakeDirectoryClient extends DataLakePathClient { create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise; @@ -315,7 +312,7 @@ export class DataLakeDirectoryClient extends DataLakePathClient { // @public export class DataLakeFileClient extends DataLakePathClient { - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeFileClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); append(body: HttpRequestBody, offset: number, length: number, options?: FileAppendOptions): Promise; create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise; @@ -338,11 +335,14 @@ export class DataLakeFileClient extends DataLakePathClient { uploadStream(stream: Readable, options?: FileParallelUploadOptions): Promise; } +// @public +export type DataLakeFileClientOptions = StoragePipelineOptions & DataLakeClientConfig; + // Warning: (ae-forgotten-export) The symbol "StorageClient" needs to be exported by the entry point index.d.ts // // @public export class DataLakeFileSystemClient extends StorageClient { - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeFileSystemClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); create(options?: FileSystemCreateOptions): Promise; createIfNotExists(options?: FileSystemCreateOptions): Promise; @@ -366,6 +366,9 @@ export class DataLakeFileSystemClient extends StorageClient { undeletePath(deletedPath: string, deletionId: string, options?: FileSystemUndeletePathOption): Promise; } +// @public +export type DataLakeFileSystemClientOptions = StoragePipelineOptions & DataLakeClientConfig; + // @public export interface DataLakeGetUserDelegationKeyParameters { delegatedUserTenantId: string; @@ -394,7 +397,7 @@ export class DataLakeLeaseClient { // @public export class DataLakePathClient extends StorageClient { - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakePathClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise; createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise; @@ -419,6 +422,9 @@ export class DataLakePathClient extends StorageClient { updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise; } +// @public +export type DataLakePathClientOptions = StoragePipelineOptions & DataLakeClientConfig; + // @public (undocumented) export interface DataLakeRequestConditions extends ModifiedAccessConditions, LeaseAccessConditions { } @@ -468,9 +474,9 @@ export interface DataLakeSASSignatureValues { // @public export class DataLakeServiceClient extends StorageClient { - constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); + constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeServiceClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); - static fromConnectionString(connectionString: string, options?: DataLakeClientOptions): DataLakeServiceClient; + static fromConnectionString(connectionString: string, options?: DataLakeServiceClientOptions): DataLakeServiceClient; generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; getFileSystemClient(fileSystemName: string): DataLakeFileSystemClient; @@ -485,6 +491,9 @@ export class DataLakeServiceClient extends StorageClient { }>; } +// @public +export type DataLakeServiceClientOptions = StoragePipelineOptions & DataLakeClientConfig; + export { DataLakeServiceGetPropertiesResponse } export { DataLakeServiceProperties } diff --git a/sdk/storage/storage-file-datalake/review/storage-file-datalake-react-native.api.diff.md b/sdk/storage/storage-file-datalake/review/storage-file-datalake-react-native.api.diff.md index b7f7ba15a0da..ba713328be8c 100644 --- a/sdk/storage/storage-file-datalake/review/storage-file-datalake-react-native.api.diff.md +++ b/sdk/storage/storage-file-datalake/review/storage-file-datalake-react-native.api.diff.md @@ -7,14 +7,14 @@ For the complete API surface, see the corresponding -node.api.md file. =================================================================== --- NodeJS +++ react-native -@@ -314,9 +314,10 @@ +@@ -311,9 +311,10 @@ } // @public export class DataLakeFileClient extends DataLakePathClient { -- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); +- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeFileClientOptions); + // Warning: (ae-forgotten-export) The symbol "StorageSharedKeyCredential_2" needs to be exported by the entry point index.d.ts -+ constructor(url: string, credential?: StorageSharedKeyCredential_2 | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); ++ constructor(url: string, credential?: StorageSharedKeyCredential_2 | AnonymousCredential | TokenCredential, options?: DataLakeFileClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); append(body: HttpRequestBody, offset: number, length: number, options?: FileAppendOptions): Promise; create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise; @@ -24,35 +24,35 @@ For the complete API surface, see the corresponding -node.api.md file. // // @public export class DataLakeFileSystemClient extends StorageClient { -- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); -+ constructor(url: string, credential?: StorageSharedKeyCredential_2 | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); +- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeFileSystemClientOptions); ++ constructor(url: string, credential?: StorageSharedKeyCredential_2 | AnonymousCredential | TokenCredential, options?: DataLakeFileSystemClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); create(options?: FileSystemCreateOptions): Promise; createIfNotExists(options?: FileSystemCreateOptions): Promise; delete(options?: FileSystemDeleteOptions): Promise; -@@ -393,9 +394,9 @@ +@@ -396,9 +397,9 @@ } // @public export class DataLakePathClient extends StorageClient { -- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); -+ constructor(url: string, credential?: StorageSharedKeyCredential_2 | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); +- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakePathClientOptions); ++ constructor(url: string, credential?: StorageSharedKeyCredential_2 | AnonymousCredential | TokenCredential, options?: DataLakePathClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise; createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise; delete(recursive?: boolean, options?: PathDeleteOptions): Promise; -@@ -467,9 +468,9 @@ +@@ -473,9 +474,9 @@ } // @public export class DataLakeServiceClient extends StorageClient { -- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); -+ constructor(url: string, credential?: StorageSharedKeyCredential_2 | AnonymousCredential | TokenCredential, options?: DataLakeClientOptions); +- constructor(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: DataLakeServiceClientOptions); ++ constructor(url: string, credential?: StorageSharedKeyCredential_2 | AnonymousCredential | TokenCredential, options?: DataLakeServiceClientOptions); constructor(url: string, pipeline: Pipeline, options?: DataLakeClientConfig); - static fromConnectionString(connectionString: string, options?: DataLakeClientOptions): DataLakeServiceClient; + static fromConnectionString(connectionString: string, options?: DataLakeServiceClientOptions): DataLakeServiceClient; generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string; -@@ -1116,12 +1117,12 @@ +@@ -1125,12 +1126,12 @@ // @public (undocumented) export type FileUploadResponse = WithResponse; @@ -67,7 +67,7 @@ For the complete API surface, see the corresponding -node.api.md file. // @public export function generateDataLakeSASQueryParameters(dataLakeSASSignatureValues: DataLakeSASSignatureValues, userDelegationKey: UserDelegationKey, accountName: string): SASQueryParameters; -@@ -1233,9 +1234,9 @@ +@@ -1242,9 +1243,9 @@ // @public (undocumented) export type ModifiedAccessConditions = Omit; diff --git a/sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts b/sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts index ceb18351d5f0..203c5a0e3902 100644 --- a/sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts +++ b/sdk/storage/storage-file-datalake/src/DataLakeFileSystemClient.ts @@ -41,8 +41,8 @@ import type { FileSystemUndeletePathOption, ListDeletedPathsSegmentOptions, PathUndeleteHeaders, - DataLakeClientOptions, DataLakeClientConfig, + DataLakeFileSystemClientOptions, } from "./models.js"; import { StorageClient } from "./StorageClient.js"; import { toContainerPublicAccessType, toPublicAccessType, toPermissions } from "./transforms.js"; @@ -97,7 +97,7 @@ export class DataLakeFileSystemClient extends StorageClient { credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakeFileSystemClientOptions, ); /** @@ -120,7 +120,7 @@ export class DataLakeFileSystemClient extends StorageClient { | Pipeline, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakeFileSystemClientOptions, ) { if (isPipelineLike(credentialOrPipeline)) { super(url, credentialOrPipeline, options); diff --git a/sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts b/sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts index 950d7970c9f8..e65ba14fc9d1 100644 --- a/sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts +++ b/sdk/storage/storage-file-datalake/src/DataLakeServiceClient.ts @@ -24,9 +24,9 @@ import type { ServiceListFileSystemsSegmentResponse, ServiceUndeleteFileSystemOptions, FileSystemUndeleteResponse, - DataLakeClientOptions, DataLakeClientConfig, DataLakeGetUserDelegationKeyParameters, + DataLakeServiceClientOptions, } from "./models.js"; import { StorageClient } from "./StorageClient.js"; import { @@ -80,7 +80,7 @@ export class DataLakeServiceClient extends StorageClient { connectionString: string, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakeServiceClientOptions, ): DataLakeServiceClient { options = options || {}; const extractedCreds = extractConnectionStringParts(connectionString); @@ -126,7 +126,7 @@ export class DataLakeServiceClient extends StorageClient { credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakeServiceClientOptions, ); /** @@ -149,7 +149,7 @@ export class DataLakeServiceClient extends StorageClient { | Pipeline, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakeServiceClientOptions, ) { if (isPipelineLike(credentialOrPipeline)) { super(url, credentialOrPipeline, options); diff --git a/sdk/storage/storage-file-datalake/src/clients.ts b/sdk/storage/storage-file-datalake/src/clients.ts index 40d17002a376..c58caebbd0b1 100644 --- a/sdk/storage/storage-file-datalake/src/clients.ts +++ b/sdk/storage/storage-file-datalake/src/clients.ts @@ -18,7 +18,8 @@ import { PathOperationsImpl as Path } from "./generated/src/operations/index.js" import type { AccessControlChanges, DataLakeClientConfig, - DataLakeClientOptions, + DataLakeFileClientOptions, + DataLakePathClientOptions, DirectoryCreateIfNotExistsOptions, DirectoryCreateIfNotExistsResponse, DirectoryCreateOptions, @@ -238,7 +239,7 @@ export class DataLakePathClient extends StorageClient { credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakePathClientOptions, ); /** @@ -261,7 +262,7 @@ export class DataLakePathClient extends StorageClient { | Pipeline, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakePathClientOptions, ) { if (isPipelineLike(credentialOrPipeline)) { super(url, credentialOrPipeline, options); @@ -1135,7 +1136,7 @@ export class DataLakeFileClient extends DataLakePathClient { credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakeFileClientOptions, ); /** @@ -1158,7 +1159,7 @@ export class DataLakeFileClient extends DataLakePathClient { | Pipeline, // Legacy, no way to fix the eslint error without breaking. Disable the rule for this line. /* eslint-disable-next-line @azure/azure-sdk/ts-naming-options */ - options?: DataLakeClientOptions, + options?: DataLakeFileClientOptions, ) { if (isPipelineLike(credentialOrPipeline)) { super(url, credentialOrPipeline, options); diff --git a/sdk/storage/storage-file-datalake/src/models.ts b/sdk/storage/storage-file-datalake/src/models.ts index d6788c250ee7..ea6d6e671b67 100644 --- a/sdk/storage/storage-file-datalake/src/models.ts +++ b/sdk/storage/storage-file-datalake/src/models.ts @@ -1673,9 +1673,21 @@ export interface DataLakeClientConfig { } /** - * Options for creating blob client instances + * Options for creating DataLakeFileSystemClient instances */ -export type DataLakeClientOptions = StoragePipelineOptions & DataLakeClientConfig; +export type DataLakeFileSystemClientOptions = StoragePipelineOptions & DataLakeClientConfig; +/** + * Options for creating DataLakeServiceClient instances + */ +export type DataLakeServiceClientOptions = StoragePipelineOptions & DataLakeClientConfig; +/** + * Options for creating DataLakePathClient instances + */ +export type DataLakePathClientOptions = StoragePipelineOptions & DataLakeClientConfig; +/** + * Options for creating DataLakeFileClient instances + */ +export type DataLakeFileClientOptions = StoragePipelineOptions & DataLakeClientConfig; /** * Request headers used in generating a SAS token diff --git a/sdk/storage/storage-file-datalake/test/utils/index-browser.mts b/sdk/storage/storage-file-datalake/test/utils/index-browser.mts index 3eec3c8a29d3..6ee460b22601 100644 --- a/sdk/storage/storage-file-datalake/test/utils/index-browser.mts +++ b/sdk/storage/storage-file-datalake/test/utils/index-browser.mts @@ -2,7 +2,7 @@ // Licensed under the MIT License. import type { TokenCredential } from "@azure/core-auth"; -import { DataLakeClientOptions, DataLakeServiceClient, newPipeline } from "../../src/index.js"; +import { DataLakeServiceClient, type DataLakeServiceClientOptions, newPipeline } from "../../src/index.js"; import { AnonymousCredential } from "@azure/storage-common"; import { configureStorageClient, SimpleTokenCredential } from "./testutils.common.js"; import type { Recorder } from "@azure-tools/test-recorder"; @@ -29,7 +29,7 @@ export function getGenericDataLakeServiceClient( recorder: Recorder, accountType: string, accountNameSuffix: string = "", - pipelineOptions: DataLakeClientOptions = {}, + pipelineOptions: DataLakeServiceClientOptions = {}, ): DataLakeServiceClient { const accountNameEnvVar = `${accountType}ACCOUNT_NAME`; const accountSASEnvVar = `${accountType}ACCOUNT_SAS`; @@ -72,7 +72,7 @@ export function getTokenDataLakeServiceClient(recorder: Recorder): DataLakeServi } export function getDataLakeServiceClient(recorder: Recorder, - pipelineOptions: DataLakeClientOptions = {}, + pipelineOptions: DataLakeServiceClientOptions = {}, ): DataLakeServiceClient { return getGenericDataLakeServiceClient(recorder, "DFS_", "", pipelineOptions); } diff --git a/sdk/storage/storage-file-datalake/test/utils/index.ts b/sdk/storage/storage-file-datalake/test/utils/index.ts index 25d73d4e273c..6252ff2c9786 100644 --- a/sdk/storage/storage-file-datalake/test/utils/index.ts +++ b/sdk/storage/storage-file-datalake/test/utils/index.ts @@ -10,7 +10,7 @@ import fs from "node:fs"; import path from "node:path"; import { DataLakeServiceClient } from "../../src/DataLakeServiceClient.js"; -import type { DataLakeClientOptions, StoragePipelineOptions } from "../../src/index.js"; +import type { DataLakeServiceClientOptions, StoragePipelineOptions } from "../../src/index.js"; import { newPipeline, StorageSharedKeyCredential } from "../../src/index.js"; import { getUniqueName, @@ -99,7 +99,7 @@ export function getGenericDataLakeServiceClient( recorder: Recorder, accountType: string, accountNameSuffix: string = "", - pipelineOptions: DataLakeClientOptions = {}, + pipelineOptions: DataLakeServiceClientOptions = {}, ): DataLakeServiceClient { if ( env.STORAGE_CONNECTION_STRING && @@ -136,7 +136,7 @@ export function getTokenDataLakeServiceClient(recorder: Recorder): DataLakeServi export function getDataLakeServiceClient( recorder: Recorder, - pipelineOptions: DataLakeClientOptions = {}, + pipelineOptions: DataLakeServiceClientOptions = {}, ): DataLakeServiceClient { return getGenericDataLakeServiceClient(recorder, "DFS_", undefined, pipelineOptions); }