Skip to content

Resolve interface comments #38702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EmmaZhu wants to merge 2 commits into
base: main
Choose a base branch
from
+182 −112
Open

Resolve interface comments #38702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37cd79c
Resolve interface comments
EmmaZhu May 27, 2026
c88cf8f
Resolve test failure
EmmaZhu May 27, 2026
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
60 changes: 30 additions & 30 deletions sdk/storage/storage-blob/review/storage-blob-browser.api.diff.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand All @@ -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<AppendBlobCreateHeaders, AppendBlobCreateHeaders>;

Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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);
Expand All @@ -218,7 +218,7 @@ For the complete API surface, see the corresponding -node.api.md file.
downloadToBuffer(offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>;
downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: BlobDownloadToBufferOptions): Promise<Buffer>;
downloadToFile(filePath: string, offset?: number, count?: number, options?: BlobDownloadOptions): Promise<BlobDownloadResponseParsed>;
@@ -632,14 +557,8 @@
@@ -635,14 +560,8 @@
// @public
export type BlobDownloadResponseModel = WithResponse<BlobDownloadResponseInternal, BlobDownloadHeaders>;

Expand All @@ -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
Expand All @@ -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 {
Expand All @@ -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 {
Expand All @@ -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;
}

Expand Down Expand Up @@ -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<ContainerDeleteResponse>;
findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>;
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<ServiceGetAccountInfoResponse>;
getBlobBatchClient(): BlobBatchClient;
@@ -1709,8 +1558,9 @@
@@ -1718,8 +1567,9 @@
encryptionScope?: string;
expiresOn?: Date;
identifier?: string;
Expand All @@ -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<FilterBlobSegment & ContainerFilterBlobsHeaders, ContainerFilterBlobsHeaders, FilterBlobSegmentModel>;

// @public
Expand All @@ -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 {
}

Expand Down Expand Up @@ -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<ContainerUndeleteHeaders, ContainerUndeleteHeaders>;

Expand All @@ -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 }
Expand All @@ -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;
}

Expand All @@ -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";

Expand All @@ -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;
}

Expand All @@ -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;
}

Expand All @@ -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;
Expand All @@ -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 {
Expand All @@ -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;
}

Expand All @@ -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;
}
Expand Down Expand Up @@ -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;
}

Expand Down Expand Up @@ -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;
}
Expand All @@ -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 }
Expand Down
31 changes: 23 additions & 8 deletions sdk/storage/storage-blob/review/storage-blob-node.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ export type AppendBlobAppendBlockResponse = WithResponse<AppendBlobAppendBlockHe

// @public
export class AppendBlobClient extends BlobClient {
constructor(connectionString: string, containerName: string, blobName: string, options?: BlobClientOptions);
constructor(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobClientOptions);
constructor(connectionString: string, containerName: string, blobName: string, options?: AppendBlobClientOptions);
constructor(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: AppendBlobClientOptions);
constructor(url: string, pipeline: PipelineLike, options?: BlobClientConfig);
appendBlock(body: HttpRequestBody, contentLength: number, options?: AppendBlobAppendBlockOptions): Promise<AppendBlobAppendBlockResponse>;
appendBlockFromURL(sourceURL: string, sourceOffset: number, count: number, options?: AppendBlobAppendBlockFromURLOptions): Promise<AppendBlobAppendBlockFromUrlResponse>;
Expand All @@ -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;
Expand Down Expand Up @@ -1156,15 +1159,15 @@ 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;
containerCreateResponse: ContainerCreateResponse;
}>;
deleteContainer(containerName: string, options?: ContainerDeleteMethodOptions): Promise<ContainerDeleteResponse>;
findBlobsByTags(tagFilterSqlExpression: string, options?: ServiceFindBlobByTagsOptions): PagedAsyncIterableIterator<FilterBlobItem, ServiceFindBlobsByTagsSegmentResponse>;
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<ServiceGetAccountInfoResponse>;
Expand All @@ -1182,6 +1185,9 @@ export class BlobServiceClient extends StorageClient {
}>;
}

// @public
export type BlobServiceClientOptions = StoragePipelineOptions & BlobClientConfig;

// @public
export interface BlobServiceProperties {
blobAnalyticsLogging?: Logging;
Expand Down Expand Up @@ -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<BlockBlobCommitBlockListResponse>;
getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptions): Promise<BlockBlobGetBlockListResponse>;
Expand All @@ -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;
Expand Down Expand Up @@ -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<ContainerCreateResponse>;
Expand Down Expand Up @@ -1786,6 +1795,9 @@ export class ContainerClient extends StorageClient {
}>;
}

// @public
export type ContainerClientOptions = StoragePipelineOptions & BlobClientConfig;

// @public
export interface ContainerCreateHeaders {
clientRequestId?: string;
Expand Down Expand Up @@ -2511,8 +2523,8 @@ export type PageBlobClearPagesResponse = WithResponse<PageBlobClearPagesHeaders,

// @public
export class PageBlobClient extends BlobClient {
constructor(connectionString: string, containerName: string, blobName: string, options?: BlobClientOptions);
constructor(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: BlobClientOptions);
constructor(connectionString: string, containerName: string, blobName: string, options?: PageBlobClientOptions);
constructor(url: string, credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: PageBlobClientOptions);
constructor(url: string, pipeline: PipelineLike, options?: BlobClientConfig);
clearPages(offset?: number, count?: number, options?: PageBlobClearPagesOptions): Promise<PageBlobClearPagesResponse>;
create(size: number, options?: PageBlobCreateOptions): Promise<PageBlobCreateResponse>;
Expand All @@ -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;
Expand Down
Loading