@azure/storage-blob 12.13.0-alpha.20230202.2 → 12.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +7002 -6423
- package/dist/index.js.map +1 -1
- package/dist-esm/storage-blob/src/BatchResponse.js.map +1 -1
- package/dist-esm/storage-blob/src/BatchResponseParser.js +2 -3
- package/dist-esm/storage-blob/src/BatchResponseParser.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobBatch.js +87 -74
- package/dist-esm/storage-blob/src/BlobBatch.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobBatchClient.js +23 -10
- package/dist-esm/storage-blob/src/BlobBatchClient.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobDownloadResponse.js +9 -1
- package/dist-esm/storage-blob/src/BlobDownloadResponse.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobLeaseClient.js +83 -54
- package/dist-esm/storage-blob/src/BlobLeaseClient.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobQueryResponse.browser.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobQueryResponse.js +1 -1
- package/dist-esm/storage-blob/src/BlobQueryResponse.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobServiceClient.js +165 -67
- package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -1
- package/dist-esm/storage-blob/src/Clients.js +889 -651
- package/dist-esm/storage-blob/src/Clients.js.map +1 -1
- package/dist-esm/storage-blob/src/ContainerClient.js +238 -115
- package/dist-esm/storage-blob/src/ContainerClient.js.map +1 -1
- package/dist-esm/storage-blob/src/PageBlobRangeResponse.js.map +1 -1
- package/dist-esm/storage-blob/src/Pipeline.js +40 -194
- package/dist-esm/storage-blob/src/Pipeline.js.map +1 -1
- package/dist-esm/storage-blob/src/StorageBrowserPolicyFactory.js.map +1 -1
- package/dist-esm/storage-blob/src/StorageClient.js +17 -4
- package/dist-esm/storage-blob/src/StorageClient.js.map +1 -1
- package/dist-esm/storage-blob/src/StorageRetryPolicyFactory.js.map +1 -1
- package/dist-esm/storage-blob/src/TelemetryPolicyFactory.js +50 -0
- package/dist-esm/storage-blob/src/TelemetryPolicyFactory.js.map +1 -0
- package/dist-esm/storage-blob/src/credentials/AnonymousCredential.js.map +1 -1
- package/dist-esm/storage-blob/src/credentials/Credential.js.map +1 -1
- package/dist-esm/storage-blob/src/credentials/StorageSharedKeyCredential.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/index.js +1 -1
- package/dist-esm/storage-blob/src/generated/src/index.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/models/index.js +1 -248
- package/dist-esm/storage-blob/src/generated/src/models/index.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/models/mappers.js +18 -13
- package/dist-esm/storage-blob/src/generated/src/models/mappers.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/models/parameters.js +5 -5
- package/dist-esm/storage-blob/src/generated/src/models/parameters.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js +27 -11
- package/dist-esm/storage-blob/src/generated/src/operations/appendBlob.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/operations/blob.js +110 -28
- package/dist-esm/storage-blob/src/generated/src/operations/blob.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js +43 -16
- package/dist-esm/storage-blob/src/generated/src/operations/blockBlob.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/operations/container.js +86 -22
- package/dist-esm/storage-blob/src/generated/src/operations/container.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js +54 -16
- package/dist-esm/storage-blob/src/generated/src/operations/pageBlob.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/operations/service.js +42 -12
- package/dist-esm/storage-blob/src/generated/src/operations/service.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/storageClient.js +10 -32
- package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/storageClientContext.js +39 -0
- package/dist-esm/storage-blob/src/generated/src/storageClientContext.js.map +1 -0
- package/dist-esm/storage-blob/src/generatedModels.js +5 -1
- package/dist-esm/storage-blob/src/generatedModels.js.map +1 -1
- package/dist-esm/storage-blob/src/index.browser.js +2 -3
- package/dist-esm/storage-blob/src/index.browser.js.map +1 -1
- package/dist-esm/storage-blob/src/index.js +2 -3
- package/dist-esm/storage-blob/src/index.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/AnonymousCredentialPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/CredentialPolicy.js +1 -1
- package/dist-esm/storage-blob/src/policies/CredentialPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageBearerTokenChallengeAuthenticationPolicy.js +245 -0
- package/dist-esm/storage-blob/src/policies/StorageBearerTokenChallengeAuthenticationPolicy.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js +1 -2
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js +1 -1
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/TelemetryPolicy.js +36 -0
- package/dist-esm/storage-blob/src/policies/TelemetryPolicy.js.map +1 -0
- package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js +1 -1
- package/dist-esm/storage-blob/src/pollers/BlobStartCopyFromUrlPoller.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/BlobQuickQueryStream.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js +2 -10
- package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/cache.js +2 -5
- package/dist-esm/storage-blob/src/utils/cache.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/constants.js +1 -1
- package/dist-esm/storage-blob/src/utils/constants.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/tracing.js +18 -5
- package/dist-esm/storage-blob/src/utils/tracing.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/utils.common.js +44 -84
- package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -1
- package/package.json +15 -22
- package/types/3.1/storage-blob.d.ts +628 -2329
- package/types/latest/storage-blob.d.ts +612 -2492
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js +0 -9
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js +0 -9
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js +0 -9
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js +0 -9
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js +0 -14
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js +0 -9
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js +0 -9
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/PathParameterWorkaroundPolicy.js +0 -25
- package/dist-esm/storage-blob/src/policies/PathParameterWorkaroundPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/RequestPolicy.js +0 -40
- package/dist-esm/storage-blob/src/policies/RequestPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js +0 -31
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js +0 -165
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js +0 -18
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +0 -131
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js.map +0 -1
@@ -1,29 +1,31 @@
|
|
1
1
|
/// <reference types="node" />
|
2
2
|
import { AbortSignalLike } from '@azure/abort-controller';
|
3
3
|
import { AzureLogger } from '@azure/logger';
|
4
|
+
import { BaseRequestPolicy } from '@azure/core-http';
|
4
5
|
import { CancelOnProgress } from '@azure/core-lro';
|
5
|
-
import * as
|
6
|
-
import
|
7
|
-
import
|
8
|
-
import {
|
9
|
-
import {
|
10
|
-
import {
|
11
|
-
import {
|
12
|
-
import { KeepAliveOptions } from '@azure/core-http
|
6
|
+
import * as coreHttp from '@azure/core-http';
|
7
|
+
import { deserializationPolicy } from '@azure/core-http';
|
8
|
+
import { HttpHeaders } from '@azure/core-http';
|
9
|
+
import { HttpOperationResponse } from '@azure/core-http';
|
10
|
+
import { HttpRequestBody } from '@azure/core-http';
|
11
|
+
import { HttpResponse } from '@azure/core-http';
|
12
|
+
import { HttpClient as IHttpClient } from '@azure/core-http';
|
13
|
+
import { KeepAliveOptions } from '@azure/core-http';
|
13
14
|
import { OperationTracingOptions } from '@azure/core-tracing';
|
14
15
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
15
16
|
import { PollerLike } from '@azure/core-lro';
|
16
17
|
import { PollOperationState } from '@azure/core-lro';
|
17
|
-
import {
|
18
|
+
import { ProxyOptions } from '@azure/core-http';
|
18
19
|
import { Readable } from 'stream';
|
19
|
-
import { RequestPolicy } from '@azure/core-http
|
20
|
-
import { RequestPolicyFactory } from '@azure/core-http
|
21
|
-
import {
|
22
|
-
import { RestError } from '@azure/core-
|
23
|
-
import {
|
24
|
-
import {
|
25
|
-
import {
|
26
|
-
import {
|
20
|
+
import { RequestPolicy } from '@azure/core-http';
|
21
|
+
import { RequestPolicyFactory } from '@azure/core-http';
|
22
|
+
import { RequestPolicyOptions } from '@azure/core-http';
|
23
|
+
import { RestError } from '@azure/core-http';
|
24
|
+
import { ServiceClientOptions } from '@azure/core-http';
|
25
|
+
import { TokenCredential } from '@azure/core-http';
|
26
|
+
import { TransferProgressEvent } from '@azure/core-http';
|
27
|
+
import { UserAgentOptions } from '@azure/core-http';
|
28
|
+
import { WebResource } from '@azure/core-http';
|
27
29
|
/** An Access policy */
|
28
30
|
export declare interface AccessPolicy {
|
29
31
|
/** the date-time the policy is active */
|
@@ -341,40 +343,6 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
341
343
|
*/
|
342
344
|
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
343
345
|
}
|
344
|
-
/** Interface representing a AppendBlob. */
|
345
|
-
declare interface AppendBlob {
|
346
|
-
/**
|
347
|
-
* The Create Append Blob operation creates a new append blob.
|
348
|
-
* @param contentLength The length of the request.
|
349
|
-
* @param options The options parameters.
|
350
|
-
*/
|
351
|
-
create(contentLength: number, options?: AppendBlobCreateOptionalParams): Promise<AppendBlobCreateResponse_2>;
|
352
|
-
/**
|
353
|
-
* The Append Block operation commits a new block of data to the end of an existing append blob. The
|
354
|
-
* Append Block operation is permitted only if the blob was created with x-ms-blob-type set to
|
355
|
-
* AppendBlob. Append Block is supported only on version 2015-02-21 version or later.
|
356
|
-
* @param contentLength The length of the request.
|
357
|
-
* @param body Initial data
|
358
|
-
* @param options The options parameters.
|
359
|
-
*/
|
360
|
-
appendBlock(contentLength: number, body: coreRestPipeline.RequestBodyType, options?: AppendBlobAppendBlockOptionalParams): Promise<AppendBlobAppendBlockResponse_2>;
|
361
|
-
/**
|
362
|
-
* The Append Block operation commits a new block of data to the end of an existing append blob where
|
363
|
-
* the contents are read from a source url. The Append Block operation is permitted only if the blob
|
364
|
-
* was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version
|
365
|
-
* 2015-02-21 version or later.
|
366
|
-
* @param sourceUrl Specify a URL to the copy source.
|
367
|
-
* @param contentLength The length of the request.
|
368
|
-
* @param options The options parameters.
|
369
|
-
*/
|
370
|
-
appendBlockFromUrl(sourceUrl: string, contentLength: number, options?: AppendBlobAppendBlockFromUrlOptionalParams): Promise<AppendBlobAppendBlockFromUrlResponse_2>;
|
371
|
-
/**
|
372
|
-
* The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version
|
373
|
-
* 2019-12-12 version or later.
|
374
|
-
* @param options The options parameters.
|
375
|
-
*/
|
376
|
-
seal(options?: AppendBlobSealOptionalParams): Promise<AppendBlobSealResponse>;
|
377
|
-
}
|
378
346
|
/** Defines headers for AppendBlob_appendBlockFromUrl operation. */
|
379
347
|
export declare interface AppendBlobAppendBlockFromUrlHeaders {
|
380
348
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -404,35 +372,6 @@ export declare interface AppendBlobAppendBlockFromUrlHeaders {
|
|
404
372
|
/** Error Code */
|
405
373
|
errorCode?: string;
|
406
374
|
}
|
407
|
-
/** Optional parameters. */
|
408
|
-
declare interface AppendBlobAppendBlockFromUrlOptionalParams extends coreClient.OperationOptions {
|
409
|
-
/** Parameter group */
|
410
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
411
|
-
/** Parameter group */
|
412
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
413
|
-
/** Parameter group */
|
414
|
-
cpkInfo?: CpkInfo;
|
415
|
-
/** Parameter group */
|
416
|
-
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
417
|
-
/** Parameter group */
|
418
|
-
appendPositionAccessConditions?: AppendPositionAccessConditions;
|
419
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
420
|
-
timeoutInSeconds?: number;
|
421
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
422
|
-
requestId?: string;
|
423
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
424
|
-
encryptionScope?: string;
|
425
|
-
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
426
|
-
sourceContentMD5?: Uint8Array;
|
427
|
-
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
428
|
-
copySourceAuthorization?: string;
|
429
|
-
/** Specify the transactional md5 for the body, to be validated by the service. */
|
430
|
-
transactionalContentMD5?: Uint8Array;
|
431
|
-
/** Specify the crc64 calculated for the range of bytes that must be read from the copy source. */
|
432
|
-
sourceContentCrc64?: Uint8Array;
|
433
|
-
/** Bytes of source data in the specified range. */
|
434
|
-
sourceRange?: string;
|
435
|
-
}
|
436
375
|
/**
|
437
376
|
* Options to configure the {@link AppendBlobClient.appendBlockFromURL} operation.
|
438
377
|
*/
|
@@ -483,9 +422,13 @@ export declare interface AppendBlobAppendBlockFromURLOptions extends CommonOptio
|
|
483
422
|
sourceAuthorization?: HttpAuthorization;
|
484
423
|
}
|
485
424
|
/** Contains response data for the appendBlockFromUrl operation. */
|
486
|
-
export declare type AppendBlobAppendBlockFromUrlResponse =
|
487
|
-
/**
|
488
|
-
|
425
|
+
export declare type AppendBlobAppendBlockFromUrlResponse = AppendBlobAppendBlockFromUrlHeaders & {
|
426
|
+
/** The underlying HTTP response. */
|
427
|
+
_response: coreHttp.HttpResponse & {
|
428
|
+
/** The parsed HTTP response headers. */
|
429
|
+
parsedHeaders: AppendBlobAppendBlockFromUrlHeaders;
|
430
|
+
};
|
431
|
+
};
|
489
432
|
/** Defines headers for AppendBlob_appendBlock operation. */
|
490
433
|
export declare interface AppendBlobAppendBlockHeaders {
|
491
434
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -517,27 +460,6 @@ export declare interface AppendBlobAppendBlockHeaders {
|
|
517
460
|
/** Error Code */
|
518
461
|
errorCode?: string;
|
519
462
|
}
|
520
|
-
/** Optional parameters. */
|
521
|
-
declare interface AppendBlobAppendBlockOptionalParams extends coreClient.OperationOptions {
|
522
|
-
/** Parameter group */
|
523
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
524
|
-
/** Parameter group */
|
525
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
526
|
-
/** Parameter group */
|
527
|
-
cpkInfo?: CpkInfo;
|
528
|
-
/** Parameter group */
|
529
|
-
appendPositionAccessConditions?: AppendPositionAccessConditions;
|
530
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
531
|
-
timeoutInSeconds?: number;
|
532
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
533
|
-
requestId?: string;
|
534
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
535
|
-
encryptionScope?: string;
|
536
|
-
/** Specify the transactional md5 for the body, to be validated by the service. */
|
537
|
-
transactionalContentMD5?: Uint8Array;
|
538
|
-
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
539
|
-
transactionalContentCrc64?: Uint8Array;
|
540
|
-
}
|
541
463
|
/**
|
542
464
|
* Options to configure the {@link AppendBlobClient.appendBlock} operation.
|
543
465
|
*/
|
@@ -582,9 +504,13 @@ export declare interface AppendBlobAppendBlockOptions extends CommonOptions {
|
|
582
504
|
encryptionScope?: string;
|
583
505
|
}
|
584
506
|
/** Contains response data for the appendBlock operation. */
|
585
|
-
export declare type AppendBlobAppendBlockResponse =
|
586
|
-
/**
|
587
|
-
|
507
|
+
export declare type AppendBlobAppendBlockResponse = AppendBlobAppendBlockHeaders & {
|
508
|
+
/** The underlying HTTP response. */
|
509
|
+
_response: coreHttp.HttpResponse & {
|
510
|
+
/** The parsed HTTP response headers. */
|
511
|
+
parsedHeaders: AppendBlobAppendBlockHeaders;
|
512
|
+
};
|
513
|
+
};
|
588
514
|
/**
|
589
515
|
* AppendBlobClient defines a set of operations applicable to append blobs.
|
590
516
|
*/
|
@@ -803,35 +729,6 @@ export declare interface AppendBlobCreateIfNotExistsResponse extends AppendBlobC
|
|
803
729
|
*/
|
804
730
|
succeeded: boolean;
|
805
731
|
}
|
806
|
-
/** Optional parameters. */
|
807
|
-
declare interface AppendBlobCreateOptionalParams extends coreClient.OperationOptions {
|
808
|
-
/** Parameter group */
|
809
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
810
|
-
/** Parameter group */
|
811
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
812
|
-
/** Parameter group */
|
813
|
-
cpkInfo?: CpkInfo;
|
814
|
-
/** Parameter group */
|
815
|
-
blobHttpHeaders?: BlobHTTPHeaders;
|
816
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
817
|
-
timeoutInSeconds?: number;
|
818
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
819
|
-
requestId?: string;
|
820
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
821
|
-
metadata?: {
|
822
|
-
[propertyName: string]: string;
|
823
|
-
};
|
824
|
-
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
825
|
-
immutabilityPolicyExpiry?: Date;
|
826
|
-
/** Specifies the immutability policy mode to set on the blob. */
|
827
|
-
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
828
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
829
|
-
encryptionScope?: string;
|
830
|
-
/** Optional. Used to set blob tags in various blob operations. */
|
831
|
-
blobTagsString?: string;
|
832
|
-
/** Specified if a legal hold should be set on the blob. */
|
833
|
-
legalHold?: boolean;
|
834
|
-
}
|
835
732
|
/**
|
836
733
|
* Options to configure {@link AppendBlobClient.create} operation.
|
837
734
|
*/
|
@@ -885,44 +782,18 @@ export declare interface AppendBlobCreateOptions extends CommonOptions {
|
|
885
782
|
tags?: Tags;
|
886
783
|
}
|
887
784
|
/** Contains response data for the create operation. */
|
888
|
-
export declare type AppendBlobCreateResponse =
|
889
|
-
/**
|
890
|
-
|
785
|
+
export declare type AppendBlobCreateResponse = AppendBlobCreateHeaders & {
|
786
|
+
/** The underlying HTTP response. */
|
787
|
+
_response: coreHttp.HttpResponse & {
|
788
|
+
/** The parsed HTTP response headers. */
|
789
|
+
parsedHeaders: AppendBlobCreateHeaders;
|
790
|
+
};
|
791
|
+
};
|
891
792
|
/**
|
892
793
|
* Conditions to add to the creation of this append blob.
|
893
794
|
*/
|
894
795
|
export declare interface AppendBlobRequestConditions extends BlobRequestConditions, AppendPositionAccessConditions {
|
895
796
|
}
|
896
|
-
/** Defines headers for AppendBlob_seal operation. */
|
897
|
-
declare interface AppendBlobSealHeaders {
|
898
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
899
|
-
etag?: string;
|
900
|
-
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
901
|
-
lastModified?: Date;
|
902
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
903
|
-
clientRequestId?: string;
|
904
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
905
|
-
requestId?: string;
|
906
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
907
|
-
version?: string;
|
908
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
909
|
-
date?: Date;
|
910
|
-
/** If this blob has been sealed */
|
911
|
-
isSealed?: boolean;
|
912
|
-
}
|
913
|
-
/** Optional parameters. */
|
914
|
-
declare interface AppendBlobSealOptionalParams extends coreClient.OperationOptions {
|
915
|
-
/** Parameter group */
|
916
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
917
|
-
/** Parameter group */
|
918
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
919
|
-
/** Parameter group */
|
920
|
-
appendPositionAccessConditions?: AppendPositionAccessConditions;
|
921
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
922
|
-
timeoutInSeconds?: number;
|
923
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
924
|
-
requestId?: string;
|
925
|
-
}
|
926
797
|
/**
|
927
798
|
* Options to configure {@link AppendBlobClient.seal} operation.
|
928
799
|
*/
|
@@ -937,8 +808,6 @@ export declare interface AppendBlobSealOptions extends CommonOptions {
|
|
937
808
|
*/
|
938
809
|
conditions?: AppendBlobRequestConditions;
|
939
810
|
}
|
940
|
-
/** Contains response data for the seal operation. */
|
941
|
-
declare type AppendBlobSealResponse = AppendBlobSealHeaders;
|
942
811
|
/** Parameter group */
|
943
812
|
export declare interface AppendPositionAccessConditions {
|
944
813
|
/** Optional conditional header. The max length in bytes permitted for the append blob. If the Append Block operation would cause the blob to exceed that limit or if the blob size is already greater than the value specified in this header, the request will fail with MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed). */
|
@@ -948,60 +817,7 @@ export declare interface AppendPositionAccessConditions {
|
|
948
817
|
}
|
949
818
|
/** Defines values for ArchiveStatus. */
|
950
819
|
export declare type ArchiveStatus = "rehydrate-pending-to-hot" | "rehydrate-pending-to-cool";
|
951
|
-
|
952
|
-
declare interface ArrowConfiguration {
|
953
|
-
schema: ArrowField[];
|
954
|
-
}
|
955
|
-
/** Groups settings regarding specific field of an arrow schema */
|
956
|
-
declare interface ArrowField {
|
957
|
-
type: string;
|
958
|
-
name?: string;
|
959
|
-
precision?: number;
|
960
|
-
scale?: number;
|
961
|
-
}
|
962
|
-
/**
|
963
|
-
* The base class from which all request policies derive.
|
964
|
-
*/
|
965
|
-
export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
966
|
-
/**
|
967
|
-
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
968
|
-
*/
|
969
|
-
readonly _nextPolicy: RequestPolicy;
|
970
|
-
/**
|
971
|
-
* The options that can be passed to a given request policy.
|
972
|
-
*/
|
973
|
-
readonly _options: RequestPolicyOptions;
|
974
|
-
/**
|
975
|
-
* The main method to implement that manipulates a request/response.
|
976
|
-
*/
|
977
|
-
protected constructor(
|
978
|
-
/**
|
979
|
-
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
980
|
-
*/
|
981
|
-
_nextPolicy: RequestPolicy,
|
982
|
-
/**
|
983
|
-
* The options that can be passed to a given request policy.
|
984
|
-
*/
|
985
|
-
_options: RequestPolicyOptions);
|
986
|
-
/**
|
987
|
-
* Sends a network request based on the given web resource.
|
988
|
-
* @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
|
989
|
-
*/
|
990
|
-
abstract sendRequest(webResource: WebResource): Promise<HttpOperationResponse>;
|
991
|
-
/**
|
992
|
-
* Get whether or not a log with the provided log level should be logged.
|
993
|
-
* @param logLevel - The log level of the log that will be logged.
|
994
|
-
* @returns Whether or not a log with the provided log level should be logged.
|
995
|
-
*/
|
996
|
-
shouldLog(logLevel: HttpPipelineLogLevel): boolean;
|
997
|
-
/**
|
998
|
-
* Attempt to log the provided message to the provided logger. If no logger was provided or if
|
999
|
-
* the log level does not meat the logger's threshold, then nothing will be logged.
|
1000
|
-
* @param logLevel - The log level of this log.
|
1001
|
-
* @param message - The message of this log.
|
1002
|
-
*/
|
1003
|
-
log(logLevel: HttpPipelineLogLevel, message: string): void;
|
1004
|
-
}
|
820
|
+
export { BaseRequestPolicy };
|
1005
821
|
/**
|
1006
822
|
* A request associated with a batch operation.
|
1007
823
|
*/
|
@@ -1046,174 +862,6 @@ export declare interface BatchSubResponse {
|
|
1046
862
|
*/
|
1047
863
|
_request: BatchSubRequest;
|
1048
864
|
}
|
1049
|
-
/** Interface representing a Blob. */
|
1050
|
-
declare interface Blob_2 {
|
1051
|
-
/**
|
1052
|
-
* The Download operation reads or downloads a blob from the system, including its metadata and
|
1053
|
-
* properties. You can also call Download to read a snapshot.
|
1054
|
-
* @param options The options parameters.
|
1055
|
-
*/
|
1056
|
-
download(options?: BlobDownloadOptionalParams): Promise<BlobDownloadResponseInternal>;
|
1057
|
-
/**
|
1058
|
-
* The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system
|
1059
|
-
* properties for the blob. It does not return the content of the blob.
|
1060
|
-
* @param options The options parameters.
|
1061
|
-
*/
|
1062
|
-
getProperties(options?: BlobGetPropertiesOptionalParams): Promise<BlobGetPropertiesResponse_2>;
|
1063
|
-
/**
|
1064
|
-
* If the storage account's soft delete feature is disabled then, when a blob is deleted, it is
|
1065
|
-
* permanently removed from the storage account. If the storage account's soft delete feature is
|
1066
|
-
* enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible
|
1067
|
-
* immediately. However, the blob service retains the blob or snapshot for the number of days specified
|
1068
|
-
* by the DeleteRetentionPolicy section of [Storage service properties]
|
1069
|
-
* (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is
|
1070
|
-
* permanently removed from the storage account. Note that you continue to be charged for the
|
1071
|
-
* soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the
|
1072
|
-
* "include=deleted" query parameter to discover which blobs and snapshots have been soft deleted. You
|
1073
|
-
* can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a
|
1074
|
-
* soft-deleted blob or snapshot causes the service to return an HTTP status code of 404
|
1075
|
-
* (ResourceNotFound).
|
1076
|
-
* @param options The options parameters.
|
1077
|
-
*/
|
1078
|
-
delete(options?: BlobDeleteOptionalParams): Promise<BlobDeleteResponse_2>;
|
1079
|
-
/**
|
1080
|
-
* Undelete a blob that was previously soft deleted
|
1081
|
-
* @param options The options parameters.
|
1082
|
-
*/
|
1083
|
-
undelete(options?: BlobUndeleteOptionalParams): Promise<BlobUndeleteResponse_2>;
|
1084
|
-
/**
|
1085
|
-
* Sets the time a blob will expire and be deleted.
|
1086
|
-
* @param expiryOptions Required. Indicates mode of the expiry time
|
1087
|
-
* @param options The options parameters.
|
1088
|
-
*/
|
1089
|
-
setExpiry(expiryOptions: BlobExpiryOptions, options?: BlobSetExpiryOptionalParams): Promise<BlobSetExpiryResponse>;
|
1090
|
-
/**
|
1091
|
-
* The Set HTTP Headers operation sets system properties on the blob
|
1092
|
-
* @param options The options parameters.
|
1093
|
-
*/
|
1094
|
-
setHttpHeaders(options?: BlobSetHttpHeadersOptionalParams): Promise<BlobSetHttpHeadersResponse>;
|
1095
|
-
/**
|
1096
|
-
* The Set Immutability Policy operation sets the immutability policy on the blob
|
1097
|
-
* @param options The options parameters.
|
1098
|
-
*/
|
1099
|
-
setImmutabilityPolicy(options?: BlobSetImmutabilityPolicyOptionalParams): Promise<BlobSetImmutabilityPolicyResponse_2>;
|
1100
|
-
/**
|
1101
|
-
* The Delete Immutability Policy operation deletes the immutability policy on the blob
|
1102
|
-
* @param options The options parameters.
|
1103
|
-
*/
|
1104
|
-
deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptionalParams): Promise<BlobDeleteImmutabilityPolicyResponse_2>;
|
1105
|
-
/**
|
1106
|
-
* The Set Legal Hold operation sets a legal hold on the blob.
|
1107
|
-
* @param legalHold Specified if a legal hold should be set on the blob.
|
1108
|
-
* @param options The options parameters.
|
1109
|
-
*/
|
1110
|
-
setLegalHold(legalHold: boolean, options?: BlobSetLegalHoldOptionalParams): Promise<BlobSetLegalHoldResponse_2>;
|
1111
|
-
/**
|
1112
|
-
* The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more
|
1113
|
-
* name-value pairs
|
1114
|
-
* @param options The options parameters.
|
1115
|
-
*/
|
1116
|
-
setMetadata(options?: BlobSetMetadataOptionalParams): Promise<BlobSetMetadataResponse_2>;
|
1117
|
-
/**
|
1118
|
-
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1119
|
-
* operations
|
1120
|
-
* @param options The options parameters.
|
1121
|
-
*/
|
1122
|
-
acquireLease(options?: BlobAcquireLeaseOptionalParams): Promise<BlobAcquireLeaseResponse>;
|
1123
|
-
/**
|
1124
|
-
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1125
|
-
* operations
|
1126
|
-
* @param leaseId Specifies the current lease ID on the resource.
|
1127
|
-
* @param options The options parameters.
|
1128
|
-
*/
|
1129
|
-
releaseLease(leaseId: string, options?: BlobReleaseLeaseOptionalParams): Promise<BlobReleaseLeaseResponse>;
|
1130
|
-
/**
|
1131
|
-
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1132
|
-
* operations
|
1133
|
-
* @param leaseId Specifies the current lease ID on the resource.
|
1134
|
-
* @param options The options parameters.
|
1135
|
-
*/
|
1136
|
-
renewLease(leaseId: string, options?: BlobRenewLeaseOptionalParams): Promise<BlobRenewLeaseResponse>;
|
1137
|
-
/**
|
1138
|
-
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1139
|
-
* operations
|
1140
|
-
* @param leaseId Specifies the current lease ID on the resource.
|
1141
|
-
* @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
|
1142
|
-
* (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
|
1143
|
-
* (String) for a list of valid GUID string formats.
|
1144
|
-
* @param options The options parameters.
|
1145
|
-
*/
|
1146
|
-
changeLease(leaseId: string, proposedLeaseId: string, options?: BlobChangeLeaseOptionalParams): Promise<BlobChangeLeaseResponse>;
|
1147
|
-
/**
|
1148
|
-
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1149
|
-
* operations
|
1150
|
-
* @param options The options parameters.
|
1151
|
-
*/
|
1152
|
-
breakLease(options?: BlobBreakLeaseOptionalParams): Promise<BlobBreakLeaseResponse>;
|
1153
|
-
/**
|
1154
|
-
* The Create Snapshot operation creates a read-only snapshot of a blob
|
1155
|
-
* @param options The options parameters.
|
1156
|
-
*/
|
1157
|
-
createSnapshot(options?: BlobCreateSnapshotOptionalParams): Promise<BlobCreateSnapshotResponse_2>;
|
1158
|
-
/**
|
1159
|
-
* The Start Copy From URL operation copies a blob or an internet resource to a new blob.
|
1160
|
-
* @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
|
1161
|
-
* 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
|
1162
|
-
* appear in a request URI. The source blob must either be public or must be authenticated via a shared
|
1163
|
-
* access signature.
|
1164
|
-
* @param options The options parameters.
|
1165
|
-
*/
|
1166
|
-
startCopyFromURL(copySource: string, options?: BlobStartCopyFromURLOptionalParams): Promise<BlobStartCopyFromURLResponse_2>;
|
1167
|
-
/**
|
1168
|
-
* The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return
|
1169
|
-
* a response until the copy is complete.
|
1170
|
-
* @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
|
1171
|
-
* 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
|
1172
|
-
* appear in a request URI. The source blob must either be public or must be authenticated via a shared
|
1173
|
-
* access signature.
|
1174
|
-
* @param options The options parameters.
|
1175
|
-
*/
|
1176
|
-
copyFromURL(copySource: string, options?: BlobCopyFromURLOptionalParams): Promise<BlobCopyFromURLResponse_2>;
|
1177
|
-
/**
|
1178
|
-
* The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination
|
1179
|
-
* blob with zero length and full metadata.
|
1180
|
-
* @param copyId The copy identifier provided in the x-ms-copy-id header of the original Copy Blob
|
1181
|
-
* operation.
|
1182
|
-
* @param options The options parameters.
|
1183
|
-
*/
|
1184
|
-
abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptionalParams): Promise<BlobAbortCopyFromURLResponse_2>;
|
1185
|
-
/**
|
1186
|
-
* The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium
|
1187
|
-
* storage account and on a block blob in a blob storage account (locally redundant storage only). A
|
1188
|
-
* premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block
|
1189
|
-
* blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's
|
1190
|
-
* ETag.
|
1191
|
-
* @param tier Indicates the tier to be set on the blob.
|
1192
|
-
* @param options The options parameters.
|
1193
|
-
*/
|
1194
|
-
setTier(tier: AccessTier, options?: BlobSetTierOptionalParams): Promise<BlobSetTierResponse_2>;
|
1195
|
-
/**
|
1196
|
-
* Returns the sku name and account kind
|
1197
|
-
* @param options The options parameters.
|
1198
|
-
*/
|
1199
|
-
getAccountInfo(options?: BlobGetAccountInfoOptionalParams): Promise<BlobGetAccountInfoResponse>;
|
1200
|
-
/**
|
1201
|
-
* The Query operation enables users to select/project on blob data by providing simple query
|
1202
|
-
* expressions.
|
1203
|
-
* @param options The options parameters.
|
1204
|
-
*/
|
1205
|
-
query(options?: BlobQueryOptionalParams): Promise<BlobQueryResponseInternal>;
|
1206
|
-
/**
|
1207
|
-
* The Get Tags operation enables users to get the tags associated with a blob.
|
1208
|
-
* @param options The options parameters.
|
1209
|
-
*/
|
1210
|
-
getTags(options?: BlobGetTagsOptionalParams): Promise<BlobGetTagsResponse_2>;
|
1211
|
-
/**
|
1212
|
-
* The Set Tags operation enables users to set tags on a blob.
|
1213
|
-
* @param options The options parameters.
|
1214
|
-
*/
|
1215
|
-
setTags(options?: BlobSetTagsOptionalParams): Promise<BlobSetTagsResponse_2>;
|
1216
|
-
}
|
1217
865
|
/** Defines headers for Blob_abortCopyFromURL operation. */
|
1218
866
|
export declare interface BlobAbortCopyFromURLHeaders {
|
1219
867
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -1227,15 +875,6 @@ export declare interface BlobAbortCopyFromURLHeaders {
|
|
1227
875
|
/** Error Code */
|
1228
876
|
errorCode?: string;
|
1229
877
|
}
|
1230
|
-
/** Optional parameters. */
|
1231
|
-
declare interface BlobAbortCopyFromURLOptionalParams extends coreClient.OperationOptions {
|
1232
|
-
/** Parameter group */
|
1233
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
1234
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
1235
|
-
timeoutInSeconds?: number;
|
1236
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1237
|
-
requestId?: string;
|
1238
|
-
}
|
1239
878
|
/**
|
1240
879
|
* Options to configure the {@link BlobClient.abortCopyFromURL} operation.
|
1241
880
|
*/
|
@@ -1252,39 +891,13 @@ export declare interface BlobAbortCopyFromURLOptions extends CommonOptions {
|
|
1252
891
|
conditions?: LeaseAccessConditions;
|
1253
892
|
}
|
1254
893
|
/** Contains response data for the abortCopyFromURL operation. */
|
1255
|
-
export declare type BlobAbortCopyFromURLResponse =
|
1256
|
-
/**
|
1257
|
-
|
1258
|
-
/**
|
1259
|
-
|
1260
|
-
|
1261
|
-
|
1262
|
-
/** Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
1263
|
-
lastModified?: Date;
|
1264
|
-
/** Uniquely identifies a blobs' lease */
|
1265
|
-
leaseId?: string;
|
1266
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1267
|
-
clientRequestId?: string;
|
1268
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1269
|
-
requestId?: string;
|
1270
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
1271
|
-
version?: string;
|
1272
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1273
|
-
date?: Date;
|
1274
|
-
}
|
1275
|
-
/** Optional parameters. */
|
1276
|
-
declare interface BlobAcquireLeaseOptionalParams extends coreClient.OperationOptions {
|
1277
|
-
/** Parameter group */
|
1278
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
1279
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
1280
|
-
timeoutInSeconds?: number;
|
1281
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1282
|
-
requestId?: string;
|
1283
|
-
/** Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. */
|
1284
|
-
duration?: number;
|
1285
|
-
/** Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. */
|
1286
|
-
proposedLeaseId?: string;
|
1287
|
-
}
|
894
|
+
export declare type BlobAbortCopyFromURLResponse = BlobAbortCopyFromURLHeaders & {
|
895
|
+
/** The underlying HTTP response. */
|
896
|
+
_response: coreHttp.HttpResponse & {
|
897
|
+
/** The parsed HTTP response headers. */
|
898
|
+
parsedHeaders: BlobAbortCopyFromURLHeaders;
|
899
|
+
};
|
900
|
+
};
|
1288
901
|
/**
|
1289
902
|
* Options to configure Blob - Acquire Lease operation.
|
1290
903
|
*/
|
@@ -1299,8 +912,6 @@ export declare interface BlobAcquireLeaseOptions extends CommonOptions {
|
|
1299
912
|
*/
|
1300
913
|
conditions?: ModifiedAccessConditions;
|
1301
914
|
}
|
1302
|
-
/** Contains response data for the acquireLease operation. */
|
1303
|
-
declare type BlobAcquireLeaseResponse = BlobAcquireLeaseHeaders;
|
1304
915
|
/**
|
1305
916
|
* A BlobBatch represents an aggregated set of operations on blobs.
|
1306
917
|
* Currently, only `delete` and `setAccessTier` are supported.
|
@@ -1532,7 +1143,17 @@ export declare interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmi
|
|
1532
1143
|
/**
|
1533
1144
|
* Contains response data for blob batch operations.
|
1534
1145
|
*/
|
1535
|
-
export declare type BlobBatchSubmitBatchResponse =
|
1146
|
+
export declare type BlobBatchSubmitBatchResponse = ParsedBatchResponse & ServiceSubmitBatchHeaders & {
|
1147
|
+
/**
|
1148
|
+
* The underlying HTTP response.
|
1149
|
+
*/
|
1150
|
+
_response: HttpResponse & {
|
1151
|
+
/**
|
1152
|
+
* The parsed HTTP response headers.
|
1153
|
+
*/
|
1154
|
+
parsedHeaders: ServiceSubmitBatchHeaders;
|
1155
|
+
};
|
1156
|
+
};
|
1536
1157
|
/**
|
1537
1158
|
* Options to configure the {@link BlobClient.beginCopyFromURL} operation.
|
1538
1159
|
*/
|
@@ -1591,34 +1212,6 @@ export declare interface BlobBeginCopyFromUrlPollState extends PollOperationStat
|
|
1591
1212
|
*/
|
1592
1213
|
export declare interface BlobBeginCopyFromURLResponse extends BlobStartCopyFromURLResponse {
|
1593
1214
|
}
|
1594
|
-
/** Defines headers for Blob_breakLease operation. */
|
1595
|
-
declare interface BlobBreakLeaseHeaders {
|
1596
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
1597
|
-
etag?: string;
|
1598
|
-
/** Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
1599
|
-
lastModified?: Date;
|
1600
|
-
/** Approximate time remaining in the lease period, in seconds. */
|
1601
|
-
leaseTime?: number;
|
1602
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1603
|
-
clientRequestId?: string;
|
1604
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1605
|
-
requestId?: string;
|
1606
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
1607
|
-
version?: string;
|
1608
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1609
|
-
date?: Date;
|
1610
|
-
}
|
1611
|
-
/** Optional parameters. */
|
1612
|
-
declare interface BlobBreakLeaseOptionalParams extends coreClient.OperationOptions {
|
1613
|
-
/** Parameter group */
|
1614
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
1615
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
1616
|
-
timeoutInSeconds?: number;
|
1617
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1618
|
-
requestId?: string;
|
1619
|
-
/** For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately. */
|
1620
|
-
breakPeriod?: number;
|
1621
|
-
}
|
1622
1215
|
/**
|
1623
1216
|
* Options to configure Blob - Break Lease operation.
|
1624
1217
|
*/
|
@@ -1633,34 +1226,6 @@ export declare interface BlobBreakLeaseOptions extends CommonOptions {
|
|
1633
1226
|
*/
|
1634
1227
|
conditions?: ModifiedAccessConditions;
|
1635
1228
|
}
|
1636
|
-
/** Contains response data for the breakLease operation. */
|
1637
|
-
declare type BlobBreakLeaseResponse = BlobBreakLeaseHeaders;
|
1638
|
-
/** Defines headers for Blob_changeLease operation. */
|
1639
|
-
declare interface BlobChangeLeaseHeaders {
|
1640
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
1641
|
-
etag?: string;
|
1642
|
-
/** Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
1643
|
-
lastModified?: Date;
|
1644
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1645
|
-
clientRequestId?: string;
|
1646
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1647
|
-
requestId?: string;
|
1648
|
-
/** Uniquely identifies a blobs' lease */
|
1649
|
-
leaseId?: string;
|
1650
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
1651
|
-
version?: string;
|
1652
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1653
|
-
date?: Date;
|
1654
|
-
}
|
1655
|
-
/** Optional parameters. */
|
1656
|
-
declare interface BlobChangeLeaseOptionalParams extends coreClient.OperationOptions {
|
1657
|
-
/** Parameter group */
|
1658
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
1659
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
1660
|
-
timeoutInSeconds?: number;
|
1661
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
1662
|
-
requestId?: string;
|
1663
|
-
}
|
1664
1229
|
/**
|
1665
1230
|
* Options to configure Blob - Change Lease operation.
|
1666
1231
|
*/
|
@@ -1675,8 +1240,6 @@ export declare interface BlobChangeLeaseOptions extends CommonOptions {
|
|
1675
1240
|
*/
|
1676
1241
|
conditions?: ModifiedAccessConditions;
|
1677
1242
|
}
|
1678
|
-
/** Contains response data for the changeLease operation. */
|
1679
|
-
declare type BlobChangeLeaseResponse = BlobChangeLeaseHeaders;
|
1680
1243
|
/**
|
1681
1244
|
* A BlobClient represents a URL to an Azure Storage blob; the blob may be a block blob,
|
1682
1245
|
* append blob, or page blob.
|
@@ -2130,7 +1693,7 @@ export declare class BlobClient extends StorageClient {
|
|
2130
1693
|
*/
|
2131
1694
|
deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>;
|
2132
1695
|
/**
|
2133
|
-
* Set
|
1696
|
+
* Set immutablility policy on the blob.
|
2134
1697
|
*
|
2135
1698
|
* @param options - Optional options to set immutability policy on the blob.
|
2136
1699
|
*/
|
@@ -2161,7 +1724,7 @@ export declare interface BlobCopyFromURLHeaders {
|
|
2161
1724
|
/** String identifier for this copy operation. */
|
2162
1725
|
copyId?: string;
|
2163
1726
|
/** State of the copy operation identified by x-ms-copy-id. */
|
2164
|
-
copyStatus?:
|
1727
|
+
copyStatus?: SyncCopyStatusType;
|
2165
1728
|
/** This response header is returned so that the client can check for the integrity of the copied content. This header is only returned if the source content MD5 was specified. */
|
2166
1729
|
contentMD5?: Uint8Array;
|
2167
1730
|
/** This response header is returned so that the client can check for the integrity of the copied content. */
|
@@ -2171,45 +1734,14 @@ export declare interface BlobCopyFromURLHeaders {
|
|
2171
1734
|
/** Error Code */
|
2172
1735
|
errorCode?: string;
|
2173
1736
|
}
|
2174
|
-
/** Optional parameters. */
|
2175
|
-
declare interface BlobCopyFromURLOptionalParams extends coreClient.OperationOptions {
|
2176
|
-
/** Parameter group */
|
2177
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
2178
|
-
/** Parameter group */
|
2179
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2180
|
-
/** Parameter group */
|
2181
|
-
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
2182
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
2183
|
-
timeoutInSeconds?: number;
|
2184
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
2185
|
-
requestId?: string;
|
2186
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
2187
|
-
metadata?: {
|
2188
|
-
[propertyName: string]: string;
|
2189
|
-
};
|
2190
|
-
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
2191
|
-
immutabilityPolicyExpiry?: Date;
|
2192
|
-
/** Specifies the immutability policy mode to set on the blob. */
|
2193
|
-
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
2194
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
2195
|
-
encryptionScope?: string;
|
2196
|
-
/** Optional. Indicates the tier to be set on the blob. */
|
2197
|
-
tier?: AccessTier;
|
2198
|
-
/** Optional. Used to set blob tags in various blob operations. */
|
2199
|
-
blobTagsString?: string;
|
2200
|
-
/** Specified if a legal hold should be set on the blob. */
|
2201
|
-
legalHold?: boolean;
|
2202
|
-
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
2203
|
-
sourceContentMD5?: Uint8Array;
|
2204
|
-
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
2205
|
-
copySourceAuthorization?: string;
|
2206
|
-
/** Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags. */
|
2207
|
-
copySourceTags?: BlobCopySourceTags;
|
2208
|
-
}
|
2209
|
-
/** Contains response data for the copyFromURL operation. */
|
2210
|
-
export declare type BlobCopyFromURLResponse = WithResponse<BlobCopyFromURLHeaders, BlobCopyFromURLHeaders>;
|
2211
1737
|
/** Contains response data for the copyFromURL operation. */
|
2212
|
-
declare type
|
1738
|
+
export declare type BlobCopyFromURLResponse = BlobCopyFromURLHeaders & {
|
1739
|
+
/** The underlying HTTP response. */
|
1740
|
+
_response: coreHttp.HttpResponse & {
|
1741
|
+
/** The parsed HTTP response headers. */
|
1742
|
+
parsedHeaders: BlobCopyFromURLHeaders;
|
1743
|
+
};
|
1744
|
+
};
|
2213
1745
|
/** Defines values for BlobCopySourceTags. */
|
2214
1746
|
export declare type BlobCopySourceTags = "REPLACE" | "COPY";
|
2215
1747
|
/** Defines headers for Blob_createSnapshot operation. */
|
@@ -2235,25 +1767,6 @@ export declare interface BlobCreateSnapshotHeaders {
|
|
2235
1767
|
/** Error Code */
|
2236
1768
|
errorCode?: string;
|
2237
1769
|
}
|
2238
|
-
/** Optional parameters. */
|
2239
|
-
declare interface BlobCreateSnapshotOptionalParams extends coreClient.OperationOptions {
|
2240
|
-
/** Parameter group */
|
2241
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
2242
|
-
/** Parameter group */
|
2243
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2244
|
-
/** Parameter group */
|
2245
|
-
cpkInfo?: CpkInfo;
|
2246
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
2247
|
-
timeoutInSeconds?: number;
|
2248
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
2249
|
-
requestId?: string;
|
2250
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
2251
|
-
metadata?: {
|
2252
|
-
[propertyName: string]: string;
|
2253
|
-
};
|
2254
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
2255
|
-
encryptionScope?: string;
|
2256
|
-
}
|
2257
1770
|
/**
|
2258
1771
|
* Options to configure the {@link BlobClient.createSnapshot} operation.
|
2259
1772
|
*/
|
@@ -2284,9 +1797,13 @@ export declare interface BlobCreateSnapshotOptions extends CommonOptions {
|
|
2284
1797
|
encryptionScope?: string;
|
2285
1798
|
}
|
2286
1799
|
/** Contains response data for the createSnapshot operation. */
|
2287
|
-
export declare type BlobCreateSnapshotResponse =
|
2288
|
-
/**
|
2289
|
-
|
1800
|
+
export declare type BlobCreateSnapshotResponse = BlobCreateSnapshotHeaders & {
|
1801
|
+
/** The underlying HTTP response. */
|
1802
|
+
_response: coreHttp.HttpResponse & {
|
1803
|
+
/** The parsed HTTP response headers. */
|
1804
|
+
parsedHeaders: BlobCreateSnapshotHeaders;
|
1805
|
+
};
|
1806
|
+
};
|
2290
1807
|
/** Defines headers for Blob_delete operation. */
|
2291
1808
|
export declare interface BlobDeleteHeaders {
|
2292
1809
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -2320,46 +1837,24 @@ export declare interface BlobDeleteImmutabilityPolicyHeaders {
|
|
2320
1837
|
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
2321
1838
|
date?: Date;
|
2322
1839
|
}
|
2323
|
-
/**
|
2324
|
-
|
2325
|
-
|
2326
|
-
|
2327
|
-
/**
|
2328
|
-
|
2329
|
-
|
2330
|
-
|
2331
|
-
|
2332
|
-
|
2333
|
-
|
2334
|
-
|
2335
|
-
|
2336
|
-
|
2337
|
-
|
2338
|
-
|
2339
|
-
}
|
2340
|
-
|
2341
|
-
export declare type BlobDeleteImmutabilityPolicyResponse = WithResponse<BlobDeleteImmutabilityPolicyHeaders, BlobDeleteImmutabilityPolicyHeaders>;
|
2342
|
-
/** Contains response data for the deleteImmutabilityPolicy operation. */
|
2343
|
-
declare type BlobDeleteImmutabilityPolicyResponse_2 = BlobDeleteImmutabilityPolicyHeaders;
|
2344
|
-
/** Optional parameters. */
|
2345
|
-
declare interface BlobDeleteOptionalParams extends coreClient.OperationOptions {
|
2346
|
-
/** Parameter group */
|
2347
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
2348
|
-
/** Parameter group */
|
2349
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2350
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
2351
|
-
timeoutInSeconds?: number;
|
2352
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
2353
|
-
requestId?: string;
|
2354
|
-
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating a Snapshot of a Blob.</a> */
|
2355
|
-
snapshot?: string;
|
2356
|
-
/** The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. */
|
2357
|
-
versionId?: string;
|
2358
|
-
/** Required if the blob has associated snapshots. Specify one of the following two options: include: Delete the base blob and all of its snapshots. only: Delete only the blob's snapshots and not the blob itself */
|
2359
|
-
deleteSnapshots?: DeleteSnapshotsOptionType;
|
2360
|
-
/** Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled. */
|
2361
|
-
blobDeleteType?: string;
|
2362
|
-
}
|
1840
|
+
/**
|
1841
|
+
* Options for deleting immutability policy {@link BlobClient.deleteImmutabilityPolicy} operation.
|
1842
|
+
*/
|
1843
|
+
export declare interface BlobDeleteImmutabilityPolicyOptions extends CommonOptions {
|
1844
|
+
/**
|
1845
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
1846
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
1847
|
+
*/
|
1848
|
+
abortSignal?: AbortSignalLike;
|
1849
|
+
}
|
1850
|
+
/** Contains response data for the deleteImmutabilityPolicy operation. */
|
1851
|
+
export declare type BlobDeleteImmutabilityPolicyResponse = BlobDeleteImmutabilityPolicyHeaders & {
|
1852
|
+
/** The underlying HTTP response. */
|
1853
|
+
_response: coreHttp.HttpResponse & {
|
1854
|
+
/** The parsed HTTP response headers. */
|
1855
|
+
parsedHeaders: BlobDeleteImmutabilityPolicyHeaders;
|
1856
|
+
};
|
1857
|
+
};
|
2363
1858
|
/**
|
2364
1859
|
* Options to configure the {@link BlobClient.delete} operation.
|
2365
1860
|
*/
|
@@ -2385,13 +1880,19 @@ export declare interface BlobDeleteOptions extends CommonOptions {
|
|
2385
1880
|
customerProvidedKey?: CpkInfo;
|
2386
1881
|
}
|
2387
1882
|
/** Contains response data for the delete operation. */
|
2388
|
-
export declare type BlobDeleteResponse =
|
2389
|
-
/**
|
2390
|
-
|
1883
|
+
export declare type BlobDeleteResponse = BlobDeleteHeaders & {
|
1884
|
+
/** The underlying HTTP response. */
|
1885
|
+
_response: coreHttp.HttpResponse & {
|
1886
|
+
/** The parsed HTTP response headers. */
|
1887
|
+
parsedHeaders: BlobDeleteHeaders;
|
1888
|
+
};
|
1889
|
+
};
|
2391
1890
|
/** Defines headers for Blob_download operation. */
|
2392
1891
|
export declare interface BlobDownloadHeaders {
|
2393
1892
|
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
2394
1893
|
lastModified?: Date;
|
1894
|
+
/** Returns the date and time the blob was created. */
|
1895
|
+
createdOn?: Date;
|
2395
1896
|
metadata?: {
|
2396
1897
|
[propertyName: string]: string;
|
2397
1898
|
};
|
@@ -2483,7 +1984,7 @@ export declare interface BlobDownloadHeaders {
|
|
2483
1984
|
contentCrc64?: Uint8Array;
|
2484
1985
|
}
|
2485
1986
|
/** Optional parameters. */
|
2486
|
-
export declare interface BlobDownloadOptionalParams extends
|
1987
|
+
export declare interface BlobDownloadOptionalParams extends coreHttp.OperationOptions {
|
2487
1988
|
/** Parameter group */
|
2488
1989
|
leaseAccessConditions?: LeaseAccessConditions;
|
2489
1990
|
/** Parameter group */
|
@@ -2559,7 +2060,7 @@ export declare interface BlobDownloadOptions extends CommonOptions {
|
|
2559
2060
|
customerProvidedKey?: CpkInfo;
|
2560
2061
|
}
|
2561
2062
|
/** Contains response data for the download operation. */
|
2562
|
-
export declare type
|
2063
|
+
export declare type BlobDownloadResponseModel = BlobDownloadHeaders & {
|
2563
2064
|
/**
|
2564
2065
|
* BROWSER ONLY
|
2565
2066
|
*
|
@@ -2574,9 +2075,12 @@ export declare type BlobDownloadResponseInternal = BlobDownloadHeaders & {
|
|
2574
2075
|
* Always `undefined` in the browser.
|
2575
2076
|
*/
|
2576
2077
|
readableStreamBody?: NodeJS.ReadableStream;
|
2078
|
+
/** The underlying HTTP response. */
|
2079
|
+
_response: coreHttp.HttpResponse & {
|
2080
|
+
/** The parsed HTTP response headers. */
|
2081
|
+
parsedHeaders: BlobDownloadHeaders;
|
2082
|
+
};
|
2577
2083
|
};
|
2578
|
-
/** Contains response data for the download operation. */
|
2579
|
-
export declare type BlobDownloadResponseModel = WithResponse<BlobDownloadResponseInternal, BlobDownloadHeaders>;
|
2580
2084
|
/**
|
2581
2085
|
* Contains response data for the {@link BlobClient.download} operation.
|
2582
2086
|
*/
|
@@ -2654,26 +2158,12 @@ export declare interface BlobExistsOptions extends CommonOptions {
|
|
2654
2158
|
*/
|
2655
2159
|
conditions?: BlobRequestConditions;
|
2656
2160
|
}
|
2657
|
-
/**
|
2658
|
-
* Defines values for BlobExpiryOptions. \
|
2659
|
-
* {@link KnownBlobExpiryOptions} can be used interchangeably with BlobExpiryOptions,
|
2660
|
-
* this enum contains the known values that the service supports.
|
2661
|
-
* ### Known values supported by the service
|
2662
|
-
* **NeverExpire** \
|
2663
|
-
* **RelativeToCreation** \
|
2664
|
-
* **RelativeToNow** \
|
2665
|
-
* **Absolute**
|
2666
|
-
*/
|
2667
|
-
declare type BlobExpiryOptions = string;
|
2668
2161
|
/**
|
2669
2162
|
* An interface representing BlobFlatListSegment.
|
2670
2163
|
*/
|
2671
2164
|
export declare interface BlobFlatListSegment {
|
2672
2165
|
blobItems: BlobItem[];
|
2673
2166
|
}
|
2674
|
-
declare interface BlobFlatListSegment_2 {
|
2675
|
-
blobItems: BlobItemInternal_2[];
|
2676
|
-
}
|
2677
2167
|
export declare interface BlobFlatListSegmentModel {
|
2678
2168
|
blobItems: BlobItemInternal[];
|
2679
2169
|
}
|
@@ -2686,26 +2176,6 @@ export declare interface BlobGenerateSasUrlOptions extends CommonGenerateSasUrlO
|
|
2686
2176
|
*/
|
2687
2177
|
permissions?: BlobSASPermissions;
|
2688
2178
|
}
|
2689
|
-
/** Defines headers for Blob_getAccountInfo operation. */
|
2690
|
-
declare interface BlobGetAccountInfoHeaders {
|
2691
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
2692
|
-
clientRequestId?: string;
|
2693
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2694
|
-
requestId?: string;
|
2695
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
2696
|
-
version?: string;
|
2697
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
2698
|
-
date?: Date;
|
2699
|
-
/** Identifies the sku name of the account */
|
2700
|
-
skuName?: SkuName;
|
2701
|
-
/** Identifies the account kind */
|
2702
|
-
accountKind?: AccountKind;
|
2703
|
-
}
|
2704
|
-
/** Optional parameters. */
|
2705
|
-
declare interface BlobGetAccountInfoOptionalParams extends coreClient.OperationOptions {
|
2706
|
-
}
|
2707
|
-
/** Contains response data for the getAccountInfo operation. */
|
2708
|
-
declare type BlobGetAccountInfoResponse = BlobGetAccountInfoHeaders;
|
2709
2179
|
/** Defines headers for Blob_getProperties operation. */
|
2710
2180
|
export declare interface BlobGetPropertiesHeaders {
|
2711
2181
|
/** Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
@@ -2812,23 +2282,6 @@ export declare interface BlobGetPropertiesHeaders {
|
|
2812
2282
|
/** Error Code */
|
2813
2283
|
errorCode?: string;
|
2814
2284
|
}
|
2815
|
-
/** Optional parameters. */
|
2816
|
-
declare interface BlobGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
2817
|
-
/** Parameter group */
|
2818
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
2819
|
-
/** Parameter group */
|
2820
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2821
|
-
/** Parameter group */
|
2822
|
-
cpkInfo?: CpkInfo;
|
2823
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
2824
|
-
timeoutInSeconds?: number;
|
2825
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
2826
|
-
requestId?: string;
|
2827
|
-
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating a Snapshot of a Blob.</a> */
|
2828
|
-
snapshot?: string;
|
2829
|
-
/** The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. */
|
2830
|
-
versionId?: string;
|
2831
|
-
}
|
2832
2285
|
/**
|
2833
2286
|
* Options to configure the {@link BlobClient.getProperties} operation.
|
2834
2287
|
*/
|
@@ -2861,9 +2314,13 @@ export declare interface BlobGetPropertiesResponse extends BlobGetPropertiesResp
|
|
2861
2314
|
objectReplicationDestinationPolicyId?: string;
|
2862
2315
|
}
|
2863
2316
|
/** Contains response data for the getProperties operation. */
|
2864
|
-
declare type
|
2865
|
-
/**
|
2866
|
-
|
2317
|
+
export declare type BlobGetPropertiesResponseModel = BlobGetPropertiesHeaders & {
|
2318
|
+
/** The underlying HTTP response. */
|
2319
|
+
_response: coreHttp.HttpResponse & {
|
2320
|
+
/** The parsed HTTP response headers. */
|
2321
|
+
parsedHeaders: BlobGetPropertiesHeaders;
|
2322
|
+
};
|
2323
|
+
};
|
2867
2324
|
/** Defines headers for Blob_getTags operation. */
|
2868
2325
|
export declare interface BlobGetTagsHeaders {
|
2869
2326
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -2877,21 +2334,6 @@ export declare interface BlobGetTagsHeaders {
|
|
2877
2334
|
/** Error Code */
|
2878
2335
|
errorCode?: string;
|
2879
2336
|
}
|
2880
|
-
/** Optional parameters. */
|
2881
|
-
declare interface BlobGetTagsOptionalParams extends coreClient.OperationOptions {
|
2882
|
-
/** Parameter group */
|
2883
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
2884
|
-
/** Parameter group */
|
2885
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2886
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
2887
|
-
timeoutInSeconds?: number;
|
2888
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
2889
|
-
requestId?: string;
|
2890
|
-
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating a Snapshot of a Blob.</a> */
|
2891
|
-
snapshot?: string;
|
2892
|
-
/** The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. */
|
2893
|
-
versionId?: string;
|
2894
|
-
}
|
2895
2337
|
/**
|
2896
2338
|
* Options to configure the {@link BlobClient.getTags} operation.
|
2897
2339
|
*/
|
@@ -2909,11 +2351,27 @@ export declare interface BlobGetTagsOptions extends CommonOptions {
|
|
2909
2351
|
/**
|
2910
2352
|
* Contains response data for the {@link BlobClient.getTags} operation.
|
2911
2353
|
*/
|
2912
|
-
export declare type BlobGetTagsResponse =
|
2354
|
+
export declare type BlobGetTagsResponse = {
|
2913
2355
|
tags: Tags;
|
2914
|
-
} & BlobGetTagsHeaders
|
2915
|
-
/**
|
2916
|
-
|
2356
|
+
} & BlobGetTagsHeaders & {
|
2357
|
+
/**
|
2358
|
+
* The underlying HTTP response.
|
2359
|
+
*/
|
2360
|
+
_response: HttpResponse & {
|
2361
|
+
/**
|
2362
|
+
* The parsed HTTP response headers.
|
2363
|
+
*/
|
2364
|
+
parsedHeaders: BlobGetTagsHeaders;
|
2365
|
+
/**
|
2366
|
+
* The response body as text (string format)
|
2367
|
+
*/
|
2368
|
+
bodyAsText: string;
|
2369
|
+
/**
|
2370
|
+
* The response body as parsed JSON or XML
|
2371
|
+
*/
|
2372
|
+
parsedBody: BlobTags;
|
2373
|
+
};
|
2374
|
+
};
|
2917
2375
|
/**
|
2918
2376
|
* An interface representing BlobHierarchyListSegment.
|
2919
2377
|
*/
|
@@ -2921,10 +2379,6 @@ export declare interface BlobHierarchyListSegment {
|
|
2921
2379
|
blobPrefixes?: BlobPrefix[];
|
2922
2380
|
blobItems: BlobItem[];
|
2923
2381
|
}
|
2924
|
-
declare interface BlobHierarchyListSegment_2 {
|
2925
|
-
blobPrefixes?: BlobPrefix_2[];
|
2926
|
-
blobItems: BlobItemInternal_2[];
|
2927
|
-
}
|
2928
2382
|
export declare interface BlobHierarchyListSegmentModel {
|
2929
2383
|
blobPrefixes?: BlobPrefix[];
|
2930
2384
|
blobItems: BlobItemInternal[];
|
@@ -2998,28 +2452,6 @@ export declare interface BlobItemInternal {
|
|
2998
2452
|
/** Inactive root blobs which have any versions would have such tag with value true. */
|
2999
2453
|
hasVersionsOnly?: boolean;
|
3000
2454
|
}
|
3001
|
-
/** An Azure Storage blob */
|
3002
|
-
declare interface BlobItemInternal_2 {
|
3003
|
-
name: BlobName;
|
3004
|
-
deleted: boolean;
|
3005
|
-
snapshot: string;
|
3006
|
-
versionId?: string;
|
3007
|
-
isCurrentVersion?: boolean;
|
3008
|
-
/** Properties of a blob */
|
3009
|
-
properties: BlobProperties;
|
3010
|
-
/** Dictionary of <string> */
|
3011
|
-
metadata?: {
|
3012
|
-
[propertyName: string]: string;
|
3013
|
-
};
|
3014
|
-
/** Blob tags */
|
3015
|
-
blobTags?: BlobTags;
|
3016
|
-
/** Dictionary of <string> */
|
3017
|
-
objectReplicationMetadata?: {
|
3018
|
-
[propertyName: string]: string;
|
3019
|
-
};
|
3020
|
-
/** Inactive root blobs which have any versions would have such tag with value true. */
|
3021
|
-
hasVersionsOnly?: boolean;
|
3022
|
-
}
|
3023
2455
|
/**
|
3024
2456
|
* A client that manages leases for a {@link ContainerClient} or a {@link BlobClient}.
|
3025
2457
|
*/
|
@@ -3104,18 +2536,9 @@ export declare class BlobLeaseClient {
|
|
3104
2536
|
*/
|
3105
2537
|
breakLease(breakPeriod: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
|
3106
2538
|
}
|
3107
|
-
declare interface BlobName {
|
3108
|
-
/** Indicates if the blob name is encoded. */
|
3109
|
-
encoded?: boolean;
|
3110
|
-
/** The name of the blob. */
|
3111
|
-
content?: string;
|
3112
|
-
}
|
3113
2539
|
export declare interface BlobPrefix {
|
3114
2540
|
name: string;
|
3115
2541
|
}
|
3116
|
-
declare interface BlobPrefix_2 {
|
3117
|
-
name: BlobName;
|
3118
|
-
}
|
3119
2542
|
/** Properties of a blob */
|
3120
2543
|
export declare interface BlobProperties {
|
3121
2544
|
createdOn?: Date;
|
@@ -3338,23 +2761,6 @@ export declare interface BlobQueryJsonTextConfiguration {
|
|
3338
2761
|
*/
|
3339
2762
|
kind: "json";
|
3340
2763
|
}
|
3341
|
-
/** Optional parameters. */
|
3342
|
-
declare interface BlobQueryOptionalParams extends coreClient.OperationOptions {
|
3343
|
-
/** Parameter group */
|
3344
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
3345
|
-
/** Parameter group */
|
3346
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
3347
|
-
/** Parameter group */
|
3348
|
-
cpkInfo?: CpkInfo;
|
3349
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
3350
|
-
timeoutInSeconds?: number;
|
3351
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
3352
|
-
requestId?: string;
|
3353
|
-
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating a Snapshot of a Blob.</a> */
|
3354
|
-
snapshot?: string;
|
3355
|
-
/** the query request */
|
3356
|
-
queryRequest?: QueryRequest;
|
3357
|
-
}
|
3358
2764
|
/**
|
3359
2765
|
* Options to query blob with Parquet format. Only valid for {@link BlockBlobQueryOptions.inputTextConfiguration}.
|
3360
2766
|
*/
|
@@ -3365,7 +2771,7 @@ export declare interface BlobQueryParquetConfiguration {
|
|
3365
2771
|
kind: "parquet";
|
3366
2772
|
}
|
3367
2773
|
/** Contains response data for the query operation. */
|
3368
|
-
export declare type
|
2774
|
+
export declare type BlobQueryResponseModel = BlobQueryHeaders & {
|
3369
2775
|
/**
|
3370
2776
|
* BROWSER ONLY
|
3371
2777
|
*
|
@@ -3380,33 +2786,12 @@ export declare type BlobQueryResponseInternal = BlobQueryHeaders & {
|
|
3380
2786
|
* Always `undefined` in the browser.
|
3381
2787
|
*/
|
3382
2788
|
readableStreamBody?: NodeJS.ReadableStream;
|
2789
|
+
/** The underlying HTTP response. */
|
2790
|
+
_response: coreHttp.HttpResponse & {
|
2791
|
+
/** The parsed HTTP response headers. */
|
2792
|
+
parsedHeaders: BlobQueryHeaders;
|
2793
|
+
};
|
3383
2794
|
};
|
3384
|
-
/** Contains response data for the query operation. */
|
3385
|
-
export declare type BlobQueryResponseModel = WithResponse<BlobQueryResponseInternal, BlobQueryHeaders>;
|
3386
|
-
/** Defines headers for Blob_releaseLease operation. */
|
3387
|
-
declare interface BlobReleaseLeaseHeaders {
|
3388
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
3389
|
-
etag?: string;
|
3390
|
-
/** Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
3391
|
-
lastModified?: Date;
|
3392
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
3393
|
-
clientRequestId?: string;
|
3394
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
3395
|
-
requestId?: string;
|
3396
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
3397
|
-
version?: string;
|
3398
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
3399
|
-
date?: Date;
|
3400
|
-
}
|
3401
|
-
/** Optional parameters. */
|
3402
|
-
declare interface BlobReleaseLeaseOptionalParams extends coreClient.OperationOptions {
|
3403
|
-
/** Parameter group */
|
3404
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
3405
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
3406
|
-
timeoutInSeconds?: number;
|
3407
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
3408
|
-
requestId?: string;
|
3409
|
-
}
|
3410
2795
|
/**
|
3411
2796
|
* Options to configure Blob - Release Lease operation.
|
3412
2797
|
*/
|
@@ -3421,34 +2806,6 @@ export declare interface BlobReleaseLeaseOptions extends CommonOptions {
|
|
3421
2806
|
*/
|
3422
2807
|
conditions?: ModifiedAccessConditions;
|
3423
2808
|
}
|
3424
|
-
/** Contains response data for the releaseLease operation. */
|
3425
|
-
declare type BlobReleaseLeaseResponse = BlobReleaseLeaseHeaders;
|
3426
|
-
/** Defines headers for Blob_renewLease operation. */
|
3427
|
-
declare interface BlobRenewLeaseHeaders {
|
3428
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
3429
|
-
etag?: string;
|
3430
|
-
/** Returns the date and time the blob was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
3431
|
-
lastModified?: Date;
|
3432
|
-
/** Uniquely identifies a blobs' lease */
|
3433
|
-
leaseId?: string;
|
3434
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
3435
|
-
clientRequestId?: string;
|
3436
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
3437
|
-
requestId?: string;
|
3438
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
3439
|
-
version?: string;
|
3440
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
3441
|
-
date?: Date;
|
3442
|
-
}
|
3443
|
-
/** Optional parameters. */
|
3444
|
-
declare interface BlobRenewLeaseOptionalParams extends coreClient.OperationOptions {
|
3445
|
-
/** Parameter group */
|
3446
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
3447
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
3448
|
-
timeoutInSeconds?: number;
|
3449
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
3450
|
-
requestId?: string;
|
3451
|
-
}
|
3452
2809
|
/**
|
3453
2810
|
* Options to configure Blob - Renew Lease operation.
|
3454
2811
|
*/
|
@@ -3463,8 +2820,6 @@ export declare interface BlobRenewLeaseOptions extends CommonOptions {
|
|
3463
2820
|
*/
|
3464
2821
|
conditions?: ModifiedAccessConditions;
|
3465
2822
|
}
|
3466
|
-
/** Contains response data for the renewLease operation. */
|
3467
|
-
declare type BlobRenewLeaseResponse = BlobRenewLeaseHeaders;
|
3468
2823
|
/**
|
3469
2824
|
* standard HTTP conditional headers, tags condition and lease condition
|
3470
2825
|
*/
|
@@ -4141,32 +3496,6 @@ export declare interface BlobServiceStatistics {
|
|
4141
3496
|
/** Geo-Replication information for the Secondary Storage Service */
|
4142
3497
|
geoReplication?: GeoReplication;
|
4143
3498
|
}
|
4144
|
-
/** Defines headers for Blob_setExpiry operation. */
|
4145
|
-
declare interface BlobSetExpiryHeaders {
|
4146
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
4147
|
-
etag?: string;
|
4148
|
-
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
4149
|
-
lastModified?: Date;
|
4150
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
4151
|
-
clientRequestId?: string;
|
4152
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
4153
|
-
requestId?: string;
|
4154
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
4155
|
-
version?: string;
|
4156
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
4157
|
-
date?: Date;
|
4158
|
-
}
|
4159
|
-
/** Optional parameters. */
|
4160
|
-
declare interface BlobSetExpiryOptionalParams extends coreClient.OperationOptions {
|
4161
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4162
|
-
timeoutInSeconds?: number;
|
4163
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4164
|
-
requestId?: string;
|
4165
|
-
/** The time to set the blob to expiry */
|
4166
|
-
expiresOn?: string;
|
4167
|
-
}
|
4168
|
-
/** Contains response data for the setExpiry operation. */
|
4169
|
-
declare type BlobSetExpiryResponse = BlobSetExpiryHeaders;
|
4170
3499
|
/** Defines headers for Blob_setHttpHeaders operation. */
|
4171
3500
|
export declare interface BlobSetHTTPHeadersHeaders {
|
4172
3501
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -4186,19 +3515,6 @@ export declare interface BlobSetHTTPHeadersHeaders {
|
|
4186
3515
|
/** Error Code */
|
4187
3516
|
errorCode?: string;
|
4188
3517
|
}
|
4189
|
-
/** Optional parameters. */
|
4190
|
-
declare interface BlobSetHttpHeadersOptionalParams extends coreClient.OperationOptions {
|
4191
|
-
/** Parameter group */
|
4192
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
4193
|
-
/** Parameter group */
|
4194
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4195
|
-
/** Parameter group */
|
4196
|
-
blobHttpHeaders?: BlobHTTPHeaders;
|
4197
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4198
|
-
timeoutInSeconds?: number;
|
4199
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4200
|
-
requestId?: string;
|
4201
|
-
}
|
4202
3518
|
/**
|
4203
3519
|
* Options to configure the {@link BlobClient.setHTTPHeaders} operation.
|
4204
3520
|
*/
|
@@ -4218,9 +3534,13 @@ export declare interface BlobSetHTTPHeadersOptions extends CommonOptions {
|
|
4218
3534
|
customerProvidedKey?: CpkInfo;
|
4219
3535
|
}
|
4220
3536
|
/** Contains response data for the setHttpHeaders operation. */
|
4221
|
-
export declare type BlobSetHTTPHeadersResponse =
|
4222
|
-
/**
|
4223
|
-
|
3537
|
+
export declare type BlobSetHTTPHeadersResponse = BlobSetHTTPHeadersHeaders & {
|
3538
|
+
/** The underlying HTTP response. */
|
3539
|
+
_response: coreHttp.HttpResponse & {
|
3540
|
+
/** The parsed HTTP response headers. */
|
3541
|
+
parsedHeaders: BlobSetHTTPHeadersHeaders;
|
3542
|
+
};
|
3543
|
+
};
|
4224
3544
|
/** Defines headers for Blob_setImmutabilityPolicy operation. */
|
4225
3545
|
export declare interface BlobSetImmutabilityPolicyHeaders {
|
4226
3546
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -4236,19 +3556,6 @@ export declare interface BlobSetImmutabilityPolicyHeaders {
|
|
4236
3556
|
/** Indicates immutability policy mode. */
|
4237
3557
|
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
4238
3558
|
}
|
4239
|
-
/** Optional parameters. */
|
4240
|
-
declare interface BlobSetImmutabilityPolicyOptionalParams extends coreClient.OperationOptions {
|
4241
|
-
/** Parameter group */
|
4242
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4243
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4244
|
-
timeoutInSeconds?: number;
|
4245
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4246
|
-
requestId?: string;
|
4247
|
-
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
4248
|
-
immutabilityPolicyExpiry?: Date;
|
4249
|
-
/** Specifies the immutability policy mode to set on the blob. */
|
4250
|
-
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
4251
|
-
}
|
4252
3559
|
/**
|
4253
3560
|
* Options for setting immutability policy {@link BlobClient.setImmutabilityPolicy} operation.
|
4254
3561
|
*/
|
@@ -4261,9 +3568,13 @@ export declare interface BlobSetImmutabilityPolicyOptions extends CommonOptions
|
|
4261
3568
|
modifiedAccessCondition?: ModificationConditions;
|
4262
3569
|
}
|
4263
3570
|
/** Contains response data for the setImmutabilityPolicy operation. */
|
4264
|
-
export declare type BlobSetImmutabilityPolicyResponse =
|
4265
|
-
/**
|
4266
|
-
|
3571
|
+
export declare type BlobSetImmutabilityPolicyResponse = BlobSetImmutabilityPolicyHeaders & {
|
3572
|
+
/** The underlying HTTP response. */
|
3573
|
+
_response: coreHttp.HttpResponse & {
|
3574
|
+
/** The parsed HTTP response headers. */
|
3575
|
+
parsedHeaders: BlobSetImmutabilityPolicyHeaders;
|
3576
|
+
};
|
3577
|
+
};
|
4267
3578
|
/** Defines headers for Blob_setLegalHold operation. */
|
4268
3579
|
export declare interface BlobSetLegalHoldHeaders {
|
4269
3580
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -4277,13 +3588,6 @@ export declare interface BlobSetLegalHoldHeaders {
|
|
4277
3588
|
/** Indicates if the blob has a legal hold. */
|
4278
3589
|
legalHold?: boolean;
|
4279
3590
|
}
|
4280
|
-
/** Optional parameters. */
|
4281
|
-
declare interface BlobSetLegalHoldOptionalParams extends coreClient.OperationOptions {
|
4282
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4283
|
-
timeoutInSeconds?: number;
|
4284
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4285
|
-
requestId?: string;
|
4286
|
-
}
|
4287
3591
|
/**
|
4288
3592
|
* Options for setting legal hold {@link BlobClient.setLegalHold} operation.
|
4289
3593
|
*/
|
@@ -4295,9 +3599,13 @@ export declare interface BlobSetLegalHoldOptions extends CommonOptions {
|
|
4295
3599
|
abortSignal?: AbortSignalLike;
|
4296
3600
|
}
|
4297
3601
|
/** Contains response data for the setLegalHold operation. */
|
4298
|
-
export declare type BlobSetLegalHoldResponse =
|
4299
|
-
/**
|
4300
|
-
|
3602
|
+
export declare type BlobSetLegalHoldResponse = BlobSetLegalHoldHeaders & {
|
3603
|
+
/** The underlying HTTP response. */
|
3604
|
+
_response: coreHttp.HttpResponse & {
|
3605
|
+
/** The parsed HTTP response headers. */
|
3606
|
+
parsedHeaders: BlobSetLegalHoldHeaders;
|
3607
|
+
};
|
3608
|
+
};
|
4301
3609
|
/** Defines headers for Blob_setMetadata operation. */
|
4302
3610
|
export declare interface BlobSetMetadataHeaders {
|
4303
3611
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -4308,39 +3616,20 @@ export declare interface BlobSetMetadataHeaders {
|
|
4308
3616
|
clientRequestId?: string;
|
4309
3617
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
4310
3618
|
requestId?: string;
|
4311
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
4312
|
-
version?: string;
|
4313
|
-
/** A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. */
|
4314
|
-
versionId?: string;
|
4315
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
4316
|
-
date?: Date;
|
4317
|
-
/** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
|
4318
|
-
isServerEncrypted?: boolean;
|
4319
|
-
/** The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key. */
|
4320
|
-
encryptionKeySha256?: string;
|
4321
|
-
/** Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. */
|
4322
|
-
encryptionScope?: string;
|
4323
|
-
/** Error Code */
|
4324
|
-
errorCode?: string;
|
4325
|
-
}
|
4326
|
-
/** Optional parameters. */
|
4327
|
-
declare interface BlobSetMetadataOptionalParams extends coreClient.OperationOptions {
|
4328
|
-
/** Parameter group */
|
4329
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
4330
|
-
/** Parameter group */
|
4331
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4332
|
-
/** Parameter group */
|
4333
|
-
cpkInfo?: CpkInfo;
|
4334
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4335
|
-
timeoutInSeconds?: number;
|
4336
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4337
|
-
requestId?: string;
|
4338
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
4339
|
-
metadata?: {
|
4340
|
-
[propertyName: string]: string;
|
4341
|
-
};
|
4342
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
3619
|
+
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
3620
|
+
version?: string;
|
3621
|
+
/** A DateTime value returned by the service that uniquely identifies the blob. The value of this header indicates the blob version, and may be used in subsequent requests to access this version of the blob. */
|
3622
|
+
versionId?: string;
|
3623
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
3624
|
+
date?: Date;
|
3625
|
+
/** The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise. */
|
3626
|
+
isServerEncrypted?: boolean;
|
3627
|
+
/** The SHA-256 hash of the encryption key used to encrypt the metadata. This header is only returned when the metadata was encrypted with a customer-provided key. */
|
3628
|
+
encryptionKeySha256?: string;
|
3629
|
+
/** Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope. */
|
4343
3630
|
encryptionScope?: string;
|
3631
|
+
/** Error Code */
|
3632
|
+
errorCode?: string;
|
4344
3633
|
}
|
4345
3634
|
/**
|
4346
3635
|
* Options to configure the {@link BlobClient.setMetadata} operation.
|
@@ -4368,9 +3657,13 @@ export declare interface BlobSetMetadataOptions extends CommonOptions {
|
|
4368
3657
|
encryptionScope?: string;
|
4369
3658
|
}
|
4370
3659
|
/** Contains response data for the setMetadata operation. */
|
4371
|
-
export declare type BlobSetMetadataResponse =
|
4372
|
-
/**
|
4373
|
-
|
3660
|
+
export declare type BlobSetMetadataResponse = BlobSetMetadataHeaders & {
|
3661
|
+
/** The underlying HTTP response. */
|
3662
|
+
_response: coreHttp.HttpResponse & {
|
3663
|
+
/** The parsed HTTP response headers. */
|
3664
|
+
parsedHeaders: BlobSetMetadataHeaders;
|
3665
|
+
};
|
3666
|
+
};
|
4374
3667
|
/** Defines headers for Blob_setTags operation. */
|
4375
3668
|
export declare interface BlobSetTagsHeaders {
|
4376
3669
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -4384,25 +3677,6 @@ export declare interface BlobSetTagsHeaders {
|
|
4384
3677
|
/** Error Code */
|
4385
3678
|
errorCode?: string;
|
4386
3679
|
}
|
4387
|
-
/** Optional parameters. */
|
4388
|
-
declare interface BlobSetTagsOptionalParams extends coreClient.OperationOptions {
|
4389
|
-
/** Parameter group */
|
4390
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
4391
|
-
/** Parameter group */
|
4392
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4393
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4394
|
-
timeoutInSeconds?: number;
|
4395
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4396
|
-
requestId?: string;
|
4397
|
-
/** The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. */
|
4398
|
-
versionId?: string;
|
4399
|
-
/** Blob tags */
|
4400
|
-
tags?: BlobTags;
|
4401
|
-
/** Specify the transactional md5 for the body, to be validated by the service. */
|
4402
|
-
transactionalContentMD5?: Uint8Array;
|
4403
|
-
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
4404
|
-
transactionalContentCrc64?: Uint8Array;
|
4405
|
-
}
|
4406
3680
|
/**
|
4407
3681
|
* Options to configure the {@link BlobClient.setTags} operation.
|
4408
3682
|
*/
|
@@ -4418,9 +3692,13 @@ export declare interface BlobSetTagsOptions extends CommonOptions {
|
|
4418
3692
|
conditions?: TagConditions & LeaseAccessConditions;
|
4419
3693
|
}
|
4420
3694
|
/** Contains response data for the setTags operation. */
|
4421
|
-
export declare type BlobSetTagsResponse =
|
4422
|
-
/**
|
4423
|
-
|
3695
|
+
export declare type BlobSetTagsResponse = BlobSetTagsHeaders & {
|
3696
|
+
/** The underlying HTTP response. */
|
3697
|
+
_response: coreHttp.HttpResponse & {
|
3698
|
+
/** The parsed HTTP response headers. */
|
3699
|
+
parsedHeaders: BlobSetTagsHeaders;
|
3700
|
+
};
|
3701
|
+
};
|
4424
3702
|
/** Defines headers for Blob_setTier operation. */
|
4425
3703
|
export declare interface BlobSetTierHeaders {
|
4426
3704
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -4432,23 +3710,6 @@ export declare interface BlobSetTierHeaders {
|
|
4432
3710
|
/** Error Code */
|
4433
3711
|
errorCode?: string;
|
4434
3712
|
}
|
4435
|
-
/** Optional parameters. */
|
4436
|
-
declare interface BlobSetTierOptionalParams extends coreClient.OperationOptions {
|
4437
|
-
/** Parameter group */
|
4438
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
4439
|
-
/** Parameter group */
|
4440
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4441
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4442
|
-
timeoutInSeconds?: number;
|
4443
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4444
|
-
requestId?: string;
|
4445
|
-
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating a Snapshot of a Blob.</a> */
|
4446
|
-
snapshot?: string;
|
4447
|
-
/** The version id parameter is an opaque DateTime value that, when present, specifies the version of the blob to operate on. It's for service version 2019-10-10 and newer. */
|
4448
|
-
versionId?: string;
|
4449
|
-
/** Optional: Indicates the priority with which to rehydrate an archived blob. */
|
4450
|
-
rehydratePriority?: RehydratePriority;
|
4451
|
-
}
|
4452
3713
|
/**
|
4453
3714
|
* Options to configure the {@link BlobClient.setAccessTier} operation.
|
4454
3715
|
*/
|
@@ -4470,9 +3731,13 @@ export declare interface BlobSetTierOptions extends CommonOptions {
|
|
4470
3731
|
rehydratePriority?: RehydratePriority;
|
4471
3732
|
}
|
4472
3733
|
/** Contains response data for the setTier operation. */
|
4473
|
-
export declare type BlobSetTierResponse =
|
4474
|
-
/**
|
4475
|
-
|
3734
|
+
export declare type BlobSetTierResponse = BlobSetTierHeaders & {
|
3735
|
+
/** The underlying HTTP response. */
|
3736
|
+
_response: coreHttp.HttpResponse & {
|
3737
|
+
/** The parsed HTTP response headers. */
|
3738
|
+
parsedHeaders: BlobSetTierHeaders;
|
3739
|
+
};
|
3740
|
+
};
|
4476
3741
|
/** Defines headers for Blob_startCopyFromURL operation. */
|
4477
3742
|
export declare interface BlobStartCopyFromURLHeaders {
|
4478
3743
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -4496,37 +3761,6 @@ export declare interface BlobStartCopyFromURLHeaders {
|
|
4496
3761
|
/** Error Code */
|
4497
3762
|
errorCode?: string;
|
4498
3763
|
}
|
4499
|
-
/** Optional parameters. */
|
4500
|
-
declare interface BlobStartCopyFromURLOptionalParams extends coreClient.OperationOptions {
|
4501
|
-
/** Parameter group */
|
4502
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
4503
|
-
/** Parameter group */
|
4504
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4505
|
-
/** Parameter group */
|
4506
|
-
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
4507
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4508
|
-
timeoutInSeconds?: number;
|
4509
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4510
|
-
requestId?: string;
|
4511
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
4512
|
-
metadata?: {
|
4513
|
-
[propertyName: string]: string;
|
4514
|
-
};
|
4515
|
-
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
4516
|
-
immutabilityPolicyExpiry?: Date;
|
4517
|
-
/** Specifies the immutability policy mode to set on the blob. */
|
4518
|
-
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
4519
|
-
/** Optional. Indicates the tier to be set on the blob. */
|
4520
|
-
tier?: AccessTier;
|
4521
|
-
/** Optional: Indicates the priority with which to rehydrate an archived blob. */
|
4522
|
-
rehydratePriority?: RehydratePriority;
|
4523
|
-
/** Optional. Used to set blob tags in various blob operations. */
|
4524
|
-
blobTagsString?: string;
|
4525
|
-
/** Overrides the sealed state of the destination blob. Service version 2019-12-12 and newer. */
|
4526
|
-
sealBlob?: boolean;
|
4527
|
-
/** Specified if a legal hold should be set on the blob. */
|
4528
|
-
legalHold?: boolean;
|
4529
|
-
}
|
4530
3764
|
/**
|
4531
3765
|
* Options to configure the {@link BlobClient.beginCopyFromURL} operation.
|
4532
3766
|
*/
|
@@ -4580,9 +3814,13 @@ export declare interface BlobStartCopyFromURLOptions extends CommonOptions {
|
|
4580
3814
|
sealBlob?: boolean;
|
4581
3815
|
}
|
4582
3816
|
/** Contains response data for the startCopyFromURL operation. */
|
4583
|
-
export declare type BlobStartCopyFromURLResponse =
|
4584
|
-
/**
|
4585
|
-
|
3817
|
+
export declare type BlobStartCopyFromURLResponse = BlobStartCopyFromURLHeaders & {
|
3818
|
+
/** The underlying HTTP response. */
|
3819
|
+
_response: coreHttp.HttpResponse & {
|
3820
|
+
/** The parsed HTTP response headers. */
|
3821
|
+
parsedHeaders: BlobStartCopyFromURLHeaders;
|
3822
|
+
};
|
3823
|
+
};
|
4586
3824
|
/**
|
4587
3825
|
* Options to configure the {@link BlobClient.syncCopyFromURL} operation.
|
4588
3826
|
*/
|
@@ -4665,13 +3903,6 @@ export declare interface BlobUndeleteHeaders {
|
|
4665
3903
|
/** Error Code */
|
4666
3904
|
errorCode?: string;
|
4667
3905
|
}
|
4668
|
-
/** Optional parameters. */
|
4669
|
-
declare interface BlobUndeleteOptionalParams extends coreClient.OperationOptions {
|
4670
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
4671
|
-
timeoutInSeconds?: number;
|
4672
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
4673
|
-
requestId?: string;
|
4674
|
-
}
|
4675
3906
|
/**
|
4676
3907
|
* Options to configure the {@link BlobClient.undelete} operation.
|
4677
3908
|
*/
|
@@ -4687,14 +3918,23 @@ export declare interface BlobUndeleteOptions extends CommonOptions {
|
|
4687
3918
|
customerProvidedKey?: CpkInfo;
|
4688
3919
|
}
|
4689
3920
|
/** Contains response data for the undelete operation. */
|
4690
|
-
export declare type BlobUndeleteResponse =
|
4691
|
-
/**
|
4692
|
-
|
3921
|
+
export declare type BlobUndeleteResponse = BlobUndeleteHeaders & {
|
3922
|
+
/** The underlying HTTP response. */
|
3923
|
+
_response: coreHttp.HttpResponse & {
|
3924
|
+
/** The parsed HTTP response headers. */
|
3925
|
+
parsedHeaders: BlobUndeleteHeaders;
|
3926
|
+
};
|
3927
|
+
};
|
4693
3928
|
/**
|
4694
3929
|
* Response type for {@link BlockBlobClient.uploadFile}, {@link BlockBlobClient.uploadStream}, and
|
4695
3930
|
* {@link BlockBlobClient.uploadBrowserDate}.
|
4696
3931
|
*/
|
4697
|
-
export declare type BlobUploadCommonResponse =
|
3932
|
+
export declare type BlobUploadCommonResponse = BlockBlobUploadHeaders & {
|
3933
|
+
/**
|
3934
|
+
* The underlying HTTP response.
|
3935
|
+
*/
|
3936
|
+
_response: HttpResponse;
|
3937
|
+
};
|
4698
3938
|
/** Represents a single block in a block blob. It describes the block's ID and size. */
|
4699
3939
|
export declare interface Block {
|
4700
3940
|
/** The base64 encoded block ID. */
|
@@ -4702,74 +3942,6 @@ export declare interface Block {
|
|
4702
3942
|
/** The block size in bytes. */
|
4703
3943
|
size: number;
|
4704
3944
|
}
|
4705
|
-
/** Interface representing a BlockBlob. */
|
4706
|
-
declare interface BlockBlob {
|
4707
|
-
/**
|
4708
|
-
* The Upload Block Blob operation updates the content of an existing block blob. Updating an existing
|
4709
|
-
* block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put
|
4710
|
-
* Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a
|
4711
|
-
* partial update of the content of a block blob, use the Put Block List operation.
|
4712
|
-
* @param contentLength The length of the request.
|
4713
|
-
* @param body Initial data
|
4714
|
-
* @param options The options parameters.
|
4715
|
-
*/
|
4716
|
-
upload(contentLength: number, body: coreRestPipeline.RequestBodyType, options?: BlockBlobUploadOptionalParams): Promise<BlockBlobUploadResponse_2>;
|
4717
|
-
/**
|
4718
|
-
* The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read
|
4719
|
-
* from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are
|
4720
|
-
* not supported with Put Blob from URL; the content of an existing blob is overwritten with the
|
4721
|
-
* content of the new blob. To perform partial updates to a block blob’s contents using a source URL,
|
4722
|
-
* use the Put Block from URL API in conjunction with Put Block List.
|
4723
|
-
* @param contentLength The length of the request.
|
4724
|
-
* @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
|
4725
|
-
* 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
|
4726
|
-
* appear in a request URI. The source blob must either be public or must be authenticated via a shared
|
4727
|
-
* access signature.
|
4728
|
-
* @param options The options parameters.
|
4729
|
-
*/
|
4730
|
-
putBlobFromUrl(contentLength: number, copySource: string, options?: BlockBlobPutBlobFromUrlOptionalParams): Promise<BlockBlobPutBlobFromUrlResponse_2>;
|
4731
|
-
/**
|
4732
|
-
* The Stage Block operation creates a new block to be committed as part of a blob
|
4733
|
-
* @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
|
4734
|
-
* must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
|
4735
|
-
* for the blockid parameter must be the same size for each block.
|
4736
|
-
* @param contentLength The length of the request.
|
4737
|
-
* @param body Initial data
|
4738
|
-
* @param options The options parameters.
|
4739
|
-
*/
|
4740
|
-
stageBlock(blockId: string, contentLength: number, body: coreRestPipeline.RequestBodyType, options?: BlockBlobStageBlockOptionalParams): Promise<BlockBlobStageBlockResponse_2>;
|
4741
|
-
/**
|
4742
|
-
* The Stage Block operation creates a new block to be committed as part of a blob where the contents
|
4743
|
-
* are read from a URL.
|
4744
|
-
* @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
|
4745
|
-
* must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
|
4746
|
-
* for the blockid parameter must be the same size for each block.
|
4747
|
-
* @param contentLength The length of the request.
|
4748
|
-
* @param sourceUrl Specify a URL to the copy source.
|
4749
|
-
* @param options The options parameters.
|
4750
|
-
*/
|
4751
|
-
stageBlockFromURL(blockId: string, contentLength: number, sourceUrl: string, options?: BlockBlobStageBlockFromURLOptionalParams): Promise<BlockBlobStageBlockFromURLResponse_2>;
|
4752
|
-
/**
|
4753
|
-
* The Commit Block List operation writes a blob by specifying the list of block IDs that make up the
|
4754
|
-
* blob. In order to be written as part of a blob, a block must have been successfully written to the
|
4755
|
-
* server in a prior Put Block operation. You can call Put Block List to update a blob by uploading
|
4756
|
-
* only those blocks that have changed, then committing the new and existing blocks together. You can
|
4757
|
-
* do this by specifying whether to commit a block from the committed block list or from the
|
4758
|
-
* uncommitted block list, or to commit the most recently uploaded version of the block, whichever list
|
4759
|
-
* it may belong to.
|
4760
|
-
* @param blocks Blob Blocks.
|
4761
|
-
* @param options The options parameters.
|
4762
|
-
*/
|
4763
|
-
commitBlockList(blocks: BlockLookupList, options?: BlockBlobCommitBlockListOptionalParams): Promise<BlockBlobCommitBlockListResponse_2>;
|
4764
|
-
/**
|
4765
|
-
* The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block
|
4766
|
-
* blob
|
4767
|
-
* @param listType Specifies whether to return the list of committed blocks, the list of uncommitted
|
4768
|
-
* blocks, or both lists together.
|
4769
|
-
* @param options The options parameters.
|
4770
|
-
*/
|
4771
|
-
getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptionalParams): Promise<BlockBlobGetBlockListResponseInternal>;
|
4772
|
-
}
|
4773
3945
|
/**
|
4774
3946
|
* BlockBlobClient defines a set of operations applicable to block blobs.
|
4775
3947
|
*/
|
@@ -5094,41 +4266,6 @@ export declare interface BlockBlobCommitBlockListHeaders {
|
|
5094
4266
|
/** Error Code */
|
5095
4267
|
errorCode?: string;
|
5096
4268
|
}
|
5097
|
-
/** Optional parameters. */
|
5098
|
-
declare interface BlockBlobCommitBlockListOptionalParams extends coreClient.OperationOptions {
|
5099
|
-
/** Parameter group */
|
5100
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
5101
|
-
/** Parameter group */
|
5102
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5103
|
-
/** Parameter group */
|
5104
|
-
cpkInfo?: CpkInfo;
|
5105
|
-
/** Parameter group */
|
5106
|
-
blobHttpHeaders?: BlobHTTPHeaders;
|
5107
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
5108
|
-
timeoutInSeconds?: number;
|
5109
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
5110
|
-
requestId?: string;
|
5111
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
5112
|
-
metadata?: {
|
5113
|
-
[propertyName: string]: string;
|
5114
|
-
};
|
5115
|
-
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
5116
|
-
immutabilityPolicyExpiry?: Date;
|
5117
|
-
/** Specifies the immutability policy mode to set on the blob. */
|
5118
|
-
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
5119
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
5120
|
-
encryptionScope?: string;
|
5121
|
-
/** Optional. Indicates the tier to be set on the blob. */
|
5122
|
-
tier?: AccessTier;
|
5123
|
-
/** Optional. Used to set blob tags in various blob operations. */
|
5124
|
-
blobTagsString?: string;
|
5125
|
-
/** Specified if a legal hold should be set on the blob. */
|
5126
|
-
legalHold?: boolean;
|
5127
|
-
/** Specify the transactional md5 for the body, to be validated by the service. */
|
5128
|
-
transactionalContentMD5?: Uint8Array;
|
5129
|
-
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
5130
|
-
transactionalContentCrc64?: Uint8Array;
|
5131
|
-
}
|
5132
4269
|
/**
|
5133
4270
|
* Options to configure {@link BlockBlobClient.commitBlockList} operation.
|
5134
4271
|
*/
|
@@ -5184,9 +4321,13 @@ export declare interface BlockBlobCommitBlockListOptions extends CommonOptions {
|
|
5184
4321
|
tags?: Tags;
|
5185
4322
|
}
|
5186
4323
|
/** Contains response data for the commitBlockList operation. */
|
5187
|
-
export declare type BlockBlobCommitBlockListResponse =
|
5188
|
-
/**
|
5189
|
-
|
4324
|
+
export declare type BlockBlobCommitBlockListResponse = BlockBlobCommitBlockListHeaders & {
|
4325
|
+
/** The underlying HTTP response. */
|
4326
|
+
_response: coreHttp.HttpResponse & {
|
4327
|
+
/** The parsed HTTP response headers. */
|
4328
|
+
parsedHeaders: BlockBlobCommitBlockListHeaders;
|
4329
|
+
};
|
4330
|
+
};
|
5190
4331
|
/** Defines headers for BlockBlob_getBlockList operation. */
|
5191
4332
|
export declare interface BlockBlobGetBlockListHeaders {
|
5192
4333
|
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
@@ -5208,19 +4349,6 @@ export declare interface BlockBlobGetBlockListHeaders {
|
|
5208
4349
|
/** Error Code */
|
5209
4350
|
errorCode?: string;
|
5210
4351
|
}
|
5211
|
-
/** Optional parameters. */
|
5212
|
-
declare interface BlockBlobGetBlockListOptionalParams extends coreClient.OperationOptions {
|
5213
|
-
/** Parameter group */
|
5214
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
5215
|
-
/** Parameter group */
|
5216
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5217
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
5218
|
-
timeoutInSeconds?: number;
|
5219
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
5220
|
-
requestId?: string;
|
5221
|
-
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating a Snapshot of a Blob.</a> */
|
5222
|
-
snapshot?: string;
|
5223
|
-
}
|
5224
4352
|
/**
|
5225
4353
|
* Options to configure {@link BlockBlobClient.getBlockList} operation.
|
5226
4354
|
*/
|
@@ -5237,9 +4365,17 @@ export declare interface BlockBlobGetBlockListOptions extends CommonOptions {
|
|
5237
4365
|
conditions?: LeaseAccessConditions & TagConditions;
|
5238
4366
|
}
|
5239
4367
|
/** Contains response data for the getBlockList operation. */
|
5240
|
-
export declare type BlockBlobGetBlockListResponse =
|
5241
|
-
/**
|
5242
|
-
|
4368
|
+
export declare type BlockBlobGetBlockListResponse = BlockBlobGetBlockListHeaders & BlockList & {
|
4369
|
+
/** The underlying HTTP response. */
|
4370
|
+
_response: coreHttp.HttpResponse & {
|
4371
|
+
/** The response body as text (string format) */
|
4372
|
+
bodyAsText: string;
|
4373
|
+
/** The response body as parsed JSON or XML */
|
4374
|
+
parsedBody: BlockList;
|
4375
|
+
/** The parsed HTTP response headers. */
|
4376
|
+
parsedHeaders: BlockBlobGetBlockListHeaders;
|
4377
|
+
};
|
4378
|
+
};
|
5243
4379
|
/**
|
5244
4380
|
* Option interface for {@link BlockBlobClient.uploadFile} and {@link BlockBlobClient.uploadSeekableStream}.
|
5245
4381
|
*/
|
@@ -5329,47 +4465,14 @@ export declare interface BlockBlobPutBlobFromUrlHeaders {
|
|
5329
4465
|
/** Error Code */
|
5330
4466
|
errorCode?: string;
|
5331
4467
|
}
|
5332
|
-
/** Optional parameters. */
|
5333
|
-
declare interface BlockBlobPutBlobFromUrlOptionalParams extends coreClient.OperationOptions {
|
5334
|
-
/** Parameter group */
|
5335
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
5336
|
-
/** Parameter group */
|
5337
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5338
|
-
/** Parameter group */
|
5339
|
-
cpkInfo?: CpkInfo;
|
5340
|
-
/** Parameter group */
|
5341
|
-
blobHttpHeaders?: BlobHTTPHeaders;
|
5342
|
-
/** Parameter group */
|
5343
|
-
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
5344
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
5345
|
-
timeoutInSeconds?: number;
|
5346
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
5347
|
-
requestId?: string;
|
5348
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
5349
|
-
metadata?: {
|
5350
|
-
[propertyName: string]: string;
|
5351
|
-
};
|
5352
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
5353
|
-
encryptionScope?: string;
|
5354
|
-
/** Optional. Indicates the tier to be set on the blob. */
|
5355
|
-
tier?: AccessTier;
|
5356
|
-
/** Optional. Used to set blob tags in various blob operations. */
|
5357
|
-
blobTagsString?: string;
|
5358
|
-
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
5359
|
-
sourceContentMD5?: Uint8Array;
|
5360
|
-
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
5361
|
-
copySourceAuthorization?: string;
|
5362
|
-
/** Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags. */
|
5363
|
-
copySourceTags?: BlobCopySourceTags;
|
5364
|
-
/** Specify the transactional md5 for the body, to be validated by the service. */
|
5365
|
-
transactionalContentMD5?: Uint8Array;
|
5366
|
-
/** Optional, default is true. Indicates if properties from the source blob should be copied. */
|
5367
|
-
copySourceBlobProperties?: boolean;
|
5368
|
-
}
|
5369
|
-
/** Contains response data for the putBlobFromUrl operation. */
|
5370
|
-
export declare type BlockBlobPutBlobFromUrlResponse = WithResponse<BlockBlobPutBlobFromUrlHeaders, BlockBlobPutBlobFromUrlHeaders>;
|
5371
4468
|
/** Contains response data for the putBlobFromUrl operation. */
|
5372
|
-
declare type
|
4469
|
+
export declare type BlockBlobPutBlobFromUrlResponse = BlockBlobPutBlobFromUrlHeaders & {
|
4470
|
+
/** The underlying HTTP response. */
|
4471
|
+
_response: coreHttp.HttpResponse & {
|
4472
|
+
/** The parsed HTTP response headers. */
|
4473
|
+
parsedHeaders: BlockBlobPutBlobFromUrlHeaders;
|
4474
|
+
};
|
4475
|
+
};
|
5373
4476
|
/**
|
5374
4477
|
* Options to configure {@link BlockBlobClient.query} operation.
|
5375
4478
|
*/
|
@@ -5427,29 +4530,6 @@ export declare interface BlockBlobStageBlockFromURLHeaders {
|
|
5427
4530
|
/** Error Code */
|
5428
4531
|
errorCode?: string;
|
5429
4532
|
}
|
5430
|
-
/** Optional parameters. */
|
5431
|
-
declare interface BlockBlobStageBlockFromURLOptionalParams extends coreClient.OperationOptions {
|
5432
|
-
/** Parameter group */
|
5433
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
5434
|
-
/** Parameter group */
|
5435
|
-
cpkInfo?: CpkInfo;
|
5436
|
-
/** Parameter group */
|
5437
|
-
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
5438
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
5439
|
-
timeoutInSeconds?: number;
|
5440
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
5441
|
-
requestId?: string;
|
5442
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
5443
|
-
encryptionScope?: string;
|
5444
|
-
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
5445
|
-
sourceContentMD5?: Uint8Array;
|
5446
|
-
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
5447
|
-
copySourceAuthorization?: string;
|
5448
|
-
/** Specify the crc64 calculated for the range of bytes that must be read from the copy source. */
|
5449
|
-
sourceContentCrc64?: Uint8Array;
|
5450
|
-
/** Bytes of source data in the specified range. */
|
5451
|
-
sourceRange?: string;
|
5452
|
-
}
|
5453
4533
|
/**
|
5454
4534
|
* Options to configure {@link BlockBlobClient.stageBlockFromURL} operation.
|
5455
4535
|
*/
|
@@ -5502,9 +4582,13 @@ export declare interface BlockBlobStageBlockFromURLOptions extends CommonOptions
|
|
5502
4582
|
sourceAuthorization?: HttpAuthorization;
|
5503
4583
|
}
|
5504
4584
|
/** Contains response data for the stageBlockFromURL operation. */
|
5505
|
-
export declare type BlockBlobStageBlockFromURLResponse =
|
5506
|
-
/**
|
5507
|
-
|
4585
|
+
export declare type BlockBlobStageBlockFromURLResponse = BlockBlobStageBlockFromURLHeaders & {
|
4586
|
+
/** The underlying HTTP response. */
|
4587
|
+
_response: coreHttp.HttpResponse & {
|
4588
|
+
/** The parsed HTTP response headers. */
|
4589
|
+
parsedHeaders: BlockBlobStageBlockFromURLHeaders;
|
4590
|
+
};
|
4591
|
+
};
|
5508
4592
|
/** Defines headers for BlockBlob_stageBlock operation. */
|
5509
4593
|
export declare interface BlockBlobStageBlockHeaders {
|
5510
4594
|
/** This header is returned so that the client can check for message content integrity. The value of this header is computed by the Blob service; it is not necessarily the same value specified in the request headers. */
|
@@ -5528,23 +4612,6 @@ export declare interface BlockBlobStageBlockHeaders {
|
|
5528
4612
|
/** Error Code */
|
5529
4613
|
errorCode?: string;
|
5530
4614
|
}
|
5531
|
-
/** Optional parameters. */
|
5532
|
-
declare interface BlockBlobStageBlockOptionalParams extends coreClient.OperationOptions {
|
5533
|
-
/** Parameter group */
|
5534
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
5535
|
-
/** Parameter group */
|
5536
|
-
cpkInfo?: CpkInfo;
|
5537
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
5538
|
-
timeoutInSeconds?: number;
|
5539
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
5540
|
-
requestId?: string;
|
5541
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
5542
|
-
encryptionScope?: string;
|
5543
|
-
/** Specify the transactional md5 for the body, to be validated by the service. */
|
5544
|
-
transactionalContentMD5?: Uint8Array;
|
5545
|
-
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
5546
|
-
transactionalContentCrc64?: Uint8Array;
|
5547
|
-
}
|
5548
4615
|
/**
|
5549
4616
|
* Options to configure {@link BlockBlobClient.stageBlock} operation.
|
5550
4617
|
*/
|
@@ -5590,9 +4657,13 @@ export declare interface BlockBlobStageBlockOptions extends CommonOptions {
|
|
5590
4657
|
encryptionScope?: string;
|
5591
4658
|
}
|
5592
4659
|
/** Contains response data for the stageBlock operation. */
|
5593
|
-
export declare type BlockBlobStageBlockResponse =
|
5594
|
-
/**
|
5595
|
-
|
4660
|
+
export declare type BlockBlobStageBlockResponse = BlockBlobStageBlockHeaders & {
|
4661
|
+
/** The underlying HTTP response. */
|
4662
|
+
_response: coreHttp.HttpResponse & {
|
4663
|
+
/** The parsed HTTP response headers. */
|
4664
|
+
parsedHeaders: BlockBlobStageBlockHeaders;
|
4665
|
+
};
|
4666
|
+
};
|
5596
4667
|
/**
|
5597
4668
|
* Options to configure {@link BlockBlobClient.syncUploadFromURL} operation.
|
5598
4669
|
*/
|
@@ -5720,41 +4791,6 @@ export declare interface BlockBlobUploadHeaders {
|
|
5720
4791
|
/** Error Code */
|
5721
4792
|
errorCode?: string;
|
5722
4793
|
}
|
5723
|
-
/** Optional parameters. */
|
5724
|
-
declare interface BlockBlobUploadOptionalParams extends coreClient.OperationOptions {
|
5725
|
-
/** Parameter group */
|
5726
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
5727
|
-
/** Parameter group */
|
5728
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5729
|
-
/** Parameter group */
|
5730
|
-
cpkInfo?: CpkInfo;
|
5731
|
-
/** Parameter group */
|
5732
|
-
blobHttpHeaders?: BlobHTTPHeaders;
|
5733
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
5734
|
-
timeoutInSeconds?: number;
|
5735
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
5736
|
-
requestId?: string;
|
5737
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
5738
|
-
metadata?: {
|
5739
|
-
[propertyName: string]: string;
|
5740
|
-
};
|
5741
|
-
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
5742
|
-
immutabilityPolicyExpiry?: Date;
|
5743
|
-
/** Specifies the immutability policy mode to set on the blob. */
|
5744
|
-
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
5745
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
5746
|
-
encryptionScope?: string;
|
5747
|
-
/** Optional. Indicates the tier to be set on the blob. */
|
5748
|
-
tier?: AccessTier;
|
5749
|
-
/** Optional. Used to set blob tags in various blob operations. */
|
5750
|
-
blobTagsString?: string;
|
5751
|
-
/** Specified if a legal hold should be set on the blob. */
|
5752
|
-
legalHold?: boolean;
|
5753
|
-
/** Specify the transactional md5 for the body, to be validated by the service. */
|
5754
|
-
transactionalContentMD5?: Uint8Array;
|
5755
|
-
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
5756
|
-
transactionalContentCrc64?: Uint8Array;
|
5757
|
-
}
|
5758
4794
|
/**
|
5759
4795
|
* Options to configure {@link BlockBlobClient.upload} operation.
|
5760
4796
|
*/
|
@@ -5817,9 +4853,13 @@ export declare interface BlockBlobUploadOptions extends CommonOptions {
|
|
5817
4853
|
tags?: Tags;
|
5818
4854
|
}
|
5819
4855
|
/** Contains response data for the upload operation. */
|
5820
|
-
export declare type BlockBlobUploadResponse =
|
5821
|
-
/**
|
5822
|
-
|
4856
|
+
export declare type BlockBlobUploadResponse = BlockBlobUploadHeaders & {
|
4857
|
+
/** The underlying HTTP response. */
|
4858
|
+
_response: coreHttp.HttpResponse & {
|
4859
|
+
/** The parsed HTTP response headers. */
|
4860
|
+
parsedHeaders: BlockBlobUploadHeaders;
|
4861
|
+
};
|
4862
|
+
};
|
5823
4863
|
/**
|
5824
4864
|
* Option interface for the {@link BlockBlobClient.uploadStream} operation.
|
5825
4865
|
*/
|
@@ -5874,12 +4914,7 @@ export declare interface BlockList {
|
|
5874
4914
|
}
|
5875
4915
|
/** Defines values for BlockListType. */
|
5876
4916
|
export declare type BlockListType = "committed" | "uncommitted" | "all";
|
5877
|
-
declare interface
|
5878
|
-
committed?: string[];
|
5879
|
-
uncommitted?: string[];
|
5880
|
-
latest?: string[];
|
5881
|
-
}
|
5882
|
-
export declare interface ClearRange {
|
4917
|
+
declare interface ClearRange {
|
5883
4918
|
start: number;
|
5884
4919
|
end: number;
|
5885
4920
|
}
|
@@ -5941,161 +4976,12 @@ export declare interface CommonGenerateSasUrlOptions {
|
|
5941
4976
|
}
|
5942
4977
|
/**
|
5943
4978
|
* An interface for options common to every remote operation.
|
5944
|
-
*/
|
5945
|
-
export declare interface CommonOptions {
|
5946
|
-
/**
|
5947
|
-
* Options to configure spans created when tracing is enabled.
|
5948
|
-
*/
|
5949
|
-
tracingOptions?: OperationTracingOptions;
|
5950
|
-
}
|
5951
|
-
/** Interface representing a Container. */
|
5952
|
-
declare interface Container {
|
5953
|
-
/**
|
5954
|
-
* creates a new container under the specified account. If the container with the same name already
|
5955
|
-
* exists, the operation fails
|
5956
|
-
* @param options The options parameters.
|
5957
|
-
*/
|
5958
|
-
create(options?: ContainerCreateOptionalParams): Promise<ContainerCreateResponse_2>;
|
5959
|
-
/**
|
5960
|
-
* returns all user-defined metadata and system properties for the specified container. The data
|
5961
|
-
* returned does not include the container's list of blobs
|
5962
|
-
* @param options The options parameters.
|
5963
|
-
*/
|
5964
|
-
getProperties(options?: ContainerGetPropertiesOptionalParams): Promise<ContainerGetPropertiesResponse_2>;
|
5965
|
-
/**
|
5966
|
-
* operation marks the specified container for deletion. The container and any blobs contained within
|
5967
|
-
* it are later deleted during garbage collection
|
5968
|
-
* @param options The options parameters.
|
5969
|
-
*/
|
5970
|
-
delete(options?: ContainerDeleteOptionalParams): Promise<ContainerDeleteResponse_2>;
|
5971
|
-
/**
|
5972
|
-
* operation sets one or more user-defined name-value pairs for the specified container.
|
5973
|
-
* @param options The options parameters.
|
5974
|
-
*/
|
5975
|
-
setMetadata(options?: ContainerSetMetadataOptionalParams): Promise<ContainerSetMetadataResponse_2>;
|
5976
|
-
/**
|
5977
|
-
* gets the permissions for the specified container. The permissions indicate whether container data
|
5978
|
-
* may be accessed publicly.
|
5979
|
-
* @param options The options parameters.
|
5980
|
-
*/
|
5981
|
-
getAccessPolicy(options?: ContainerGetAccessPolicyOptionalParams): Promise<ContainerGetAccessPolicyResponseModel>;
|
5982
|
-
/**
|
5983
|
-
* sets the permissions for the specified container. The permissions indicate whether blobs in a
|
5984
|
-
* container may be accessed publicly.
|
5985
|
-
* @param options The options parameters.
|
5986
|
-
*/
|
5987
|
-
setAccessPolicy(options?: ContainerSetAccessPolicyOptionalParams): Promise<ContainerSetAccessPolicyResponse_2>;
|
5988
|
-
/**
|
5989
|
-
* Restores a previously-deleted container.
|
5990
|
-
* @param options The options parameters.
|
5991
|
-
*/
|
5992
|
-
restore(options?: ContainerRestoreOptionalParams): Promise<ContainerRestoreResponse>;
|
5993
|
-
/**
|
5994
|
-
* Renames an existing container.
|
5995
|
-
* @param sourceContainerName Required. Specifies the name of the container to rename.
|
5996
|
-
* @param options The options parameters.
|
5997
|
-
*/
|
5998
|
-
rename(sourceContainerName: string, options?: ContainerRenameOptionalParams): Promise<ContainerRenameResponse_2>;
|
5999
|
-
/**
|
6000
|
-
* The Batch operation allows multiple API calls to be embedded into a single HTTP request.
|
6001
|
-
* @param contentLength The length of the request.
|
6002
|
-
* @param multipartContentType Required. The value of this header must be multipart/mixed with a batch
|
6003
|
-
* boundary. Example header value: multipart/mixed; boundary=batch_<GUID>
|
6004
|
-
* @param body Initial data
|
6005
|
-
* @param options The options parameters.
|
6006
|
-
*/
|
6007
|
-
submitBatch(contentLength: number, multipartContentType: string, body: coreRestPipeline.RequestBodyType, options?: ContainerSubmitBatchOptionalParams): Promise<ContainerSubmitBatchResponse>;
|
6008
|
-
/**
|
6009
|
-
* The Filter Blobs operation enables callers to list blobs in a container whose tags match a given
|
6010
|
-
* search expression. Filter blobs searches within the given container.
|
6011
|
-
* @param options The options parameters.
|
6012
|
-
*/
|
6013
|
-
filterBlobs(options?: ContainerFilterBlobsOptionalParams): Promise<ContainerFilterBlobsResponse>;
|
6014
|
-
/**
|
6015
|
-
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6016
|
-
* be 15 to 60 seconds, or can be infinite
|
6017
|
-
* @param options The options parameters.
|
6018
|
-
*/
|
6019
|
-
acquireLease(options?: ContainerAcquireLeaseOptionalParams): Promise<ContainerAcquireLeaseResponse>;
|
6020
|
-
/**
|
6021
|
-
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6022
|
-
* be 15 to 60 seconds, or can be infinite
|
6023
|
-
* @param leaseId Specifies the current lease ID on the resource.
|
6024
|
-
* @param options The options parameters.
|
6025
|
-
*/
|
6026
|
-
releaseLease(leaseId: string, options?: ContainerReleaseLeaseOptionalParams): Promise<ContainerReleaseLeaseResponse>;
|
6027
|
-
/**
|
6028
|
-
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6029
|
-
* be 15 to 60 seconds, or can be infinite
|
6030
|
-
* @param leaseId Specifies the current lease ID on the resource.
|
6031
|
-
* @param options The options parameters.
|
6032
|
-
*/
|
6033
|
-
renewLease(leaseId: string, options?: ContainerRenewLeaseOptionalParams): Promise<ContainerRenewLeaseResponse>;
|
6034
|
-
/**
|
6035
|
-
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6036
|
-
* be 15 to 60 seconds, or can be infinite
|
6037
|
-
* @param options The options parameters.
|
6038
|
-
*/
|
6039
|
-
breakLease(options?: ContainerBreakLeaseOptionalParams): Promise<ContainerBreakLeaseResponse>;
|
6040
|
-
/**
|
6041
|
-
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6042
|
-
* be 15 to 60 seconds, or can be infinite
|
6043
|
-
* @param leaseId Specifies the current lease ID on the resource.
|
6044
|
-
* @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
|
6045
|
-
* (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
|
6046
|
-
* (String) for a list of valid GUID string formats.
|
6047
|
-
* @param options The options parameters.
|
6048
|
-
*/
|
6049
|
-
changeLease(leaseId: string, proposedLeaseId: string, options?: ContainerChangeLeaseOptionalParams): Promise<ContainerChangeLeaseResponse>;
|
6050
|
-
/**
|
6051
|
-
* [Update] The List Blobs operation returns a list of the blobs under the specified container
|
6052
|
-
* @param options The options parameters.
|
6053
|
-
*/
|
6054
|
-
listBlobFlatSegment(options?: ContainerListBlobFlatSegmentOptionalParams): Promise<ContainerListBlobFlatSegmentResponse_2>;
|
6055
|
-
/**
|
6056
|
-
* [Update] The List Blobs operation returns a list of the blobs under the specified container
|
6057
|
-
* @param delimiter When the request includes this parameter, the operation returns a BlobPrefix
|
6058
|
-
* element in the response body that acts as a placeholder for all blobs whose names begin with the
|
6059
|
-
* same substring up to the appearance of the delimiter character. The delimiter may be a single
|
6060
|
-
* character or a string.
|
6061
|
-
* @param options The options parameters.
|
6062
|
-
*/
|
6063
|
-
listBlobHierarchySegment(delimiter: string, options?: ContainerListBlobHierarchySegmentOptionalParams): Promise<ContainerListBlobHierarchySegmentResponse_2>;
|
4979
|
+
*/
|
4980
|
+
export declare interface CommonOptions {
|
6064
4981
|
/**
|
6065
|
-
*
|
6066
|
-
* @param options The options parameters.
|
4982
|
+
* Options to configure spans created when tracing is enabled.
|
6067
4983
|
*/
|
6068
|
-
|
6069
|
-
}
|
6070
|
-
/** Defines headers for Container_acquireLease operation. */
|
6071
|
-
declare interface ContainerAcquireLeaseHeaders {
|
6072
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
6073
|
-
etag?: string;
|
6074
|
-
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
6075
|
-
lastModified?: Date;
|
6076
|
-
/** Uniquely identifies a container's lease */
|
6077
|
-
leaseId?: string;
|
6078
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6079
|
-
clientRequestId?: string;
|
6080
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6081
|
-
requestId?: string;
|
6082
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
6083
|
-
version?: string;
|
6084
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6085
|
-
date?: Date;
|
6086
|
-
}
|
6087
|
-
/** Optional parameters. */
|
6088
|
-
declare interface ContainerAcquireLeaseOptionalParams extends coreClient.OperationOptions {
|
6089
|
-
/** Parameter group */
|
6090
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
6091
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
6092
|
-
timeoutInSeconds?: number;
|
6093
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
6094
|
-
requestId?: string;
|
6095
|
-
/** Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change. */
|
6096
|
-
duration?: number;
|
6097
|
-
/** Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats. */
|
6098
|
-
proposedLeaseId?: string;
|
4984
|
+
tracingOptions?: OperationTracingOptions;
|
6099
4985
|
}
|
6100
4986
|
/**
|
6101
4987
|
* Options to configure Container - Acquire Lease operation.
|
@@ -6111,27 +4997,8 @@ export declare interface ContainerAcquireLeaseOptions extends CommonOptions {
|
|
6111
4997
|
*/
|
6112
4998
|
conditions?: ModifiedAccessConditions;
|
6113
4999
|
}
|
6114
|
-
/** Contains response data for the acquireLease operation. */
|
6115
|
-
declare type ContainerAcquireLeaseResponse = ContainerAcquireLeaseHeaders;
|
6116
|
-
/** Defines headers for Container_breakLease operation. */
|
6117
|
-
declare interface ContainerBreakLeaseHeaders {
|
6118
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
6119
|
-
etag?: string;
|
6120
|
-
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
6121
|
-
lastModified?: Date;
|
6122
|
-
/** Approximate time remaining in the lease period, in seconds. */
|
6123
|
-
leaseTime?: number;
|
6124
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6125
|
-
clientRequestId?: string;
|
6126
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6127
|
-
requestId?: string;
|
6128
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
6129
|
-
version?: string;
|
6130
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6131
|
-
date?: Date;
|
6132
|
-
}
|
6133
5000
|
/** Optional parameters. */
|
6134
|
-
export declare interface ContainerBreakLeaseOptionalParams extends
|
5001
|
+
export declare interface ContainerBreakLeaseOptionalParams extends coreHttp.OperationOptions {
|
6135
5002
|
/** Parameter group */
|
6136
5003
|
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
6137
5004
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
@@ -6155,34 +5022,6 @@ export declare interface ContainerBreakLeaseOptions extends CommonOptions {
|
|
6155
5022
|
*/
|
6156
5023
|
conditions?: ModifiedAccessConditions;
|
6157
5024
|
}
|
6158
|
-
/** Contains response data for the breakLease operation. */
|
6159
|
-
declare type ContainerBreakLeaseResponse = ContainerBreakLeaseHeaders;
|
6160
|
-
/** Defines headers for Container_changeLease operation. */
|
6161
|
-
declare interface ContainerChangeLeaseHeaders {
|
6162
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
6163
|
-
etag?: string;
|
6164
|
-
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
6165
|
-
lastModified?: Date;
|
6166
|
-
/** Uniquely identifies a container's lease */
|
6167
|
-
leaseId?: string;
|
6168
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6169
|
-
clientRequestId?: string;
|
6170
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6171
|
-
requestId?: string;
|
6172
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
6173
|
-
version?: string;
|
6174
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6175
|
-
date?: Date;
|
6176
|
-
}
|
6177
|
-
/** Optional parameters. */
|
6178
|
-
declare interface ContainerChangeLeaseOptionalParams extends coreClient.OperationOptions {
|
6179
|
-
/** Parameter group */
|
6180
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
6181
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
6182
|
-
timeoutInSeconds?: number;
|
6183
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
6184
|
-
requestId?: string;
|
6185
|
-
}
|
6186
5025
|
/**
|
6187
5026
|
* Options to configure Container - Change Lease operation.
|
6188
5027
|
*/
|
@@ -6197,8 +5036,6 @@ export declare interface ContainerChangeLeaseOptions extends CommonOptions {
|
|
6197
5036
|
*/
|
6198
5037
|
conditions?: ModifiedAccessConditions;
|
6199
5038
|
}
|
6200
|
-
/** Contains response data for the changeLease operation. */
|
6201
|
-
declare type ContainerChangeLeaseResponse = ContainerChangeLeaseHeaders;
|
6202
5039
|
/**
|
6203
5040
|
* A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs.
|
6204
5041
|
*/
|
@@ -6831,21 +5668,6 @@ export declare interface ContainerCreateIfNotExistsResponse extends ContainerCre
|
|
6831
5668
|
*/
|
6832
5669
|
succeeded: boolean;
|
6833
5670
|
}
|
6834
|
-
/** Optional parameters. */
|
6835
|
-
declare interface ContainerCreateOptionalParams extends coreClient.OperationOptions {
|
6836
|
-
/** Parameter group */
|
6837
|
-
containerEncryptionScope?: ContainerEncryptionScope;
|
6838
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
6839
|
-
timeoutInSeconds?: number;
|
6840
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
6841
|
-
requestId?: string;
|
6842
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
6843
|
-
metadata?: {
|
6844
|
-
[propertyName: string]: string;
|
6845
|
-
};
|
6846
|
-
/** Specifies whether data in the container may be accessed publicly and the level of access */
|
6847
|
-
access?: PublicAccessType;
|
6848
|
-
}
|
6849
5671
|
/**
|
6850
5672
|
* Options to configure {@link ContainerClient.create} operation.
|
6851
5673
|
*/
|
@@ -6871,9 +5693,13 @@ export declare interface ContainerCreateOptions extends CommonOptions {
|
|
6871
5693
|
containerEncryptionScope?: ContainerEncryptionScope;
|
6872
5694
|
}
|
6873
5695
|
/** Contains response data for the create operation. */
|
6874
|
-
export declare type ContainerCreateResponse =
|
6875
|
-
/**
|
6876
|
-
|
5696
|
+
export declare type ContainerCreateResponse = ContainerCreateHeaders & {
|
5697
|
+
/** The underlying HTTP response. */
|
5698
|
+
_response: coreHttp.HttpResponse & {
|
5699
|
+
/** The parsed HTTP response headers. */
|
5700
|
+
parsedHeaders: ContainerCreateHeaders;
|
5701
|
+
};
|
5702
|
+
};
|
6877
5703
|
/**
|
6878
5704
|
* Options to configure the {@link ContainerClient.deleteBlob} operation.
|
6879
5705
|
*/
|
@@ -6920,21 +5746,14 @@ export declare interface ContainerDeleteMethodOptions extends CommonOptions {
|
|
6920
5746
|
*/
|
6921
5747
|
conditions?: ContainerRequestConditions;
|
6922
5748
|
}
|
6923
|
-
/** Optional parameters. */
|
6924
|
-
declare interface ContainerDeleteOptionalParams extends coreClient.OperationOptions {
|
6925
|
-
/** Parameter group */
|
6926
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
6927
|
-
/** Parameter group */
|
6928
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
6929
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
6930
|
-
timeoutInSeconds?: number;
|
6931
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
6932
|
-
requestId?: string;
|
6933
|
-
}
|
6934
|
-
/** Contains response data for the delete operation. */
|
6935
|
-
export declare type ContainerDeleteResponse = WithResponse<ContainerDeleteHeaders, ContainerDeleteHeaders>;
|
6936
5749
|
/** Contains response data for the delete operation. */
|
6937
|
-
declare type
|
5750
|
+
export declare type ContainerDeleteResponse = ContainerDeleteHeaders & {
|
5751
|
+
/** The underlying HTTP response. */
|
5752
|
+
_response: coreHttp.HttpResponse & {
|
5753
|
+
/** The parsed HTTP response headers. */
|
5754
|
+
parsedHeaders: ContainerDeleteHeaders;
|
5755
|
+
};
|
5756
|
+
};
|
6938
5757
|
/** Parameter group */
|
6939
5758
|
export declare interface ContainerEncryptionScope {
|
6940
5759
|
/** Optional. Version 2019-07-07 and later. Specifies the default encryption scope to set on the container and use for all future writes. */
|
@@ -6963,21 +5782,6 @@ export declare interface ContainerFilterBlobsHeaders {
|
|
6963
5782
|
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6964
5783
|
date?: Date;
|
6965
5784
|
}
|
6966
|
-
/** Optional parameters. */
|
6967
|
-
declare interface ContainerFilterBlobsOptionalParams extends coreClient.OperationOptions {
|
6968
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
6969
|
-
timeoutInSeconds?: number;
|
6970
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
6971
|
-
requestId?: string;
|
6972
|
-
/** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
|
6973
|
-
marker?: string;
|
6974
|
-
/** Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. */
|
6975
|
-
maxPageSize?: number;
|
6976
|
-
/** Filters the results to return only to return only blobs whose tags match the specified expression. */
|
6977
|
-
where?: string;
|
6978
|
-
}
|
6979
|
-
/** Contains response data for the filterBlobs operation. */
|
6980
|
-
export declare type ContainerFilterBlobsResponse = ContainerFilterBlobsHeaders & FilterBlobSegmentModel;
|
6981
5785
|
/**
|
6982
5786
|
* Options to configure the {@link BlobServiceClient.findBlobsByTags} operation.
|
6983
5787
|
*/
|
@@ -6991,7 +5795,25 @@ export declare interface ContainerFindBlobByTagsOptions extends CommonOptions {
|
|
6991
5795
|
/**
|
6992
5796
|
* The response of {@link BlobServiceClient.findBlobsByTags} operation.
|
6993
5797
|
*/
|
6994
|
-
export declare type ContainerFindBlobsByTagsSegmentResponse =
|
5798
|
+
export declare type ContainerFindBlobsByTagsSegmentResponse = FilterBlobSegment & ContainerFilterBlobsHeaders & {
|
5799
|
+
/**
|
5800
|
+
* The underlying HTTP response.
|
5801
|
+
*/
|
5802
|
+
_response: HttpResponse & {
|
5803
|
+
/**
|
5804
|
+
* The parsed HTTP response headers.
|
5805
|
+
*/
|
5806
|
+
parsedHeaders: ContainerFilterBlobsHeaders;
|
5807
|
+
/**
|
5808
|
+
* The response body as text (string format)
|
5809
|
+
*/
|
5810
|
+
bodyAsText: string;
|
5811
|
+
/**
|
5812
|
+
* The response body as parsed JSON or XML
|
5813
|
+
*/
|
5814
|
+
parsedBody: FilterBlobSegmentModel;
|
5815
|
+
};
|
5816
|
+
};
|
6995
5817
|
/**
|
6996
5818
|
* Options to configure {@link ContainerClient.generateSasUrl} operation.
|
6997
5819
|
*/
|
@@ -7020,15 +5842,6 @@ export declare interface ContainerGetAccessPolicyHeaders {
|
|
7020
5842
|
/** Error Code */
|
7021
5843
|
errorCode?: string;
|
7022
5844
|
}
|
7023
|
-
/** Optional parameters. */
|
7024
|
-
declare interface ContainerGetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
7025
|
-
/** Parameter group */
|
7026
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
7027
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7028
|
-
timeoutInSeconds?: number;
|
7029
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7030
|
-
requestId?: string;
|
7031
|
-
}
|
7032
5845
|
/**
|
7033
5846
|
* Options to configure {@link ContainerClient.getAccessPolicy} operation.
|
7034
5847
|
*/
|
@@ -7047,31 +5860,27 @@ export declare interface ContainerGetAccessPolicyOptions extends CommonOptions {
|
|
7047
5860
|
/**
|
7048
5861
|
* Contains response data for the {@link ContainerClient.getAccessPolicy} operation.
|
7049
5862
|
*/
|
7050
|
-
export declare type ContainerGetAccessPolicyResponse =
|
5863
|
+
export declare type ContainerGetAccessPolicyResponse = {
|
7051
5864
|
signedIdentifiers: SignedIdentifier[];
|
7052
|
-
} & ContainerGetAccessPolicyHeaders
|
7053
|
-
/**
|
7054
|
-
|
7055
|
-
|
7056
|
-
|
7057
|
-
|
7058
|
-
|
7059
|
-
|
7060
|
-
|
7061
|
-
|
7062
|
-
|
7063
|
-
|
7064
|
-
|
7065
|
-
|
7066
|
-
|
7067
|
-
|
7068
|
-
|
7069
|
-
}
|
7070
|
-
|
7071
|
-
declare interface ContainerGetAccountInfoOptionalParams extends coreClient.OperationOptions {
|
7072
|
-
}
|
7073
|
-
/** Contains response data for the getAccountInfo operation. */
|
7074
|
-
declare type ContainerGetAccountInfoResponse = ContainerGetAccountInfoHeaders;
|
5865
|
+
} & ContainerGetAccessPolicyHeaders & {
|
5866
|
+
/**
|
5867
|
+
* The underlying HTTP response.
|
5868
|
+
*/
|
5869
|
+
_response: HttpResponse & {
|
5870
|
+
/**
|
5871
|
+
* The parsed HTTP response headers.
|
5872
|
+
*/
|
5873
|
+
parsedHeaders: ContainerGetAccessPolicyHeaders;
|
5874
|
+
/**
|
5875
|
+
* The response body as text (string format)
|
5876
|
+
*/
|
5877
|
+
bodyAsText: string;
|
5878
|
+
/**
|
5879
|
+
* The response body as parsed JSON or XML
|
5880
|
+
*/
|
5881
|
+
parsedBody: SignedIdentifierModel[];
|
5882
|
+
};
|
5883
|
+
};
|
7075
5884
|
/** Defines headers for Container_getProperties operation. */
|
7076
5885
|
export declare interface ContainerGetPropertiesHeaders {
|
7077
5886
|
metadata?: {
|
@@ -7110,15 +5919,6 @@ export declare interface ContainerGetPropertiesHeaders {
|
|
7110
5919
|
/** Error Code */
|
7111
5920
|
errorCode?: string;
|
7112
5921
|
}
|
7113
|
-
/** Optional parameters. */
|
7114
|
-
declare interface ContainerGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
7115
|
-
/** Parameter group */
|
7116
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
7117
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7118
|
-
timeoutInSeconds?: number;
|
7119
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7120
|
-
requestId?: string;
|
7121
|
-
}
|
7122
5922
|
/**
|
7123
5923
|
* Options to configure {@link ContainerClient.getProperties} operation.
|
7124
5924
|
*/
|
@@ -7135,9 +5935,13 @@ export declare interface ContainerGetPropertiesOptions extends CommonOptions {
|
|
7135
5935
|
conditions?: LeaseAccessConditions;
|
7136
5936
|
}
|
7137
5937
|
/** Contains response data for the getProperties operation. */
|
7138
|
-
export declare type ContainerGetPropertiesResponse =
|
7139
|
-
/**
|
7140
|
-
|
5938
|
+
export declare type ContainerGetPropertiesResponse = ContainerGetPropertiesHeaders & {
|
5939
|
+
/** The underlying HTTP response. */
|
5940
|
+
_response: coreHttp.HttpResponse & {
|
5941
|
+
/** The parsed HTTP response headers. */
|
5942
|
+
parsedHeaders: ContainerGetPropertiesHeaders;
|
5943
|
+
};
|
5944
|
+
};
|
7141
5945
|
/** An Azure Storage container */
|
7142
5946
|
export declare interface ContainerItem {
|
7143
5947
|
name: string;
|
@@ -7165,27 +5969,28 @@ export declare interface ContainerListBlobFlatSegmentHeaders {
|
|
7165
5969
|
/** Error Code */
|
7166
5970
|
errorCode?: string;
|
7167
5971
|
}
|
7168
|
-
/** Optional parameters. */
|
7169
|
-
declare interface ContainerListBlobFlatSegmentOptionalParams extends coreClient.OperationOptions {
|
7170
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7171
|
-
timeoutInSeconds?: number;
|
7172
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7173
|
-
requestId?: string;
|
7174
|
-
/** Filters the results to return only containers whose name begins with the specified prefix. */
|
7175
|
-
prefix?: string;
|
7176
|
-
/** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
|
7177
|
-
marker?: string;
|
7178
|
-
/** Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. */
|
7179
|
-
maxPageSize?: number;
|
7180
|
-
/** Include this parameter to specify one or more datasets to include in the response. */
|
7181
|
-
include?: ListBlobsIncludeItem[];
|
7182
|
-
}
|
7183
5972
|
/**
|
7184
5973
|
* Contains response data for the listBlobFlatSegment operation.
|
7185
5974
|
*/
|
7186
|
-
export declare type ContainerListBlobFlatSegmentResponse =
|
7187
|
-
/**
|
7188
|
-
|
5975
|
+
export declare type ContainerListBlobFlatSegmentResponse = ListBlobsFlatSegmentResponse & ContainerListBlobFlatSegmentHeaders & {
|
5976
|
+
/**
|
5977
|
+
* The underlying HTTP response.
|
5978
|
+
*/
|
5979
|
+
_response: HttpResponse & {
|
5980
|
+
/**
|
5981
|
+
* The parsed HTTP response headers.
|
5982
|
+
*/
|
5983
|
+
parsedHeaders: ContainerListBlobFlatSegmentHeaders;
|
5984
|
+
/**
|
5985
|
+
* The response body as text (string format)
|
5986
|
+
*/
|
5987
|
+
bodyAsText: string;
|
5988
|
+
/**
|
5989
|
+
* The response body as parsed JSON or XML
|
5990
|
+
*/
|
5991
|
+
parsedBody: ListBlobsFlatSegmentResponseModel;
|
5992
|
+
};
|
5993
|
+
};
|
7189
5994
|
/** Defines headers for Container_listBlobHierarchySegment operation. */
|
7190
5995
|
export declare interface ContainerListBlobHierarchySegmentHeaders {
|
7191
5996
|
/** The media type of the body of the response. For List Blobs this is 'application/xml' */
|
@@ -7201,27 +6006,28 @@ export declare interface ContainerListBlobHierarchySegmentHeaders {
|
|
7201
6006
|
/** Error Code */
|
7202
6007
|
errorCode?: string;
|
7203
6008
|
}
|
7204
|
-
/** Optional parameters. */
|
7205
|
-
declare interface ContainerListBlobHierarchySegmentOptionalParams extends coreClient.OperationOptions {
|
7206
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7207
|
-
timeoutInSeconds?: number;
|
7208
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7209
|
-
requestId?: string;
|
7210
|
-
/** Filters the results to return only containers whose name begins with the specified prefix. */
|
7211
|
-
prefix?: string;
|
7212
|
-
/** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
|
7213
|
-
marker?: string;
|
7214
|
-
/** Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. */
|
7215
|
-
maxPageSize?: number;
|
7216
|
-
/** Include this parameter to specify one or more datasets to include in the response. */
|
7217
|
-
include?: ListBlobsIncludeItem[];
|
7218
|
-
}
|
7219
6009
|
/**
|
7220
6010
|
* Contains response data for the listBlobHierarchySegment operation.
|
7221
6011
|
*/
|
7222
|
-
export declare type ContainerListBlobHierarchySegmentResponse =
|
7223
|
-
/**
|
7224
|
-
|
6012
|
+
export declare type ContainerListBlobHierarchySegmentResponse = ListBlobsHierarchySegmentResponse & ContainerListBlobHierarchySegmentHeaders & {
|
6013
|
+
/**
|
6014
|
+
* The underlying HTTP response.
|
6015
|
+
*/
|
6016
|
+
_response: HttpResponse & {
|
6017
|
+
/**
|
6018
|
+
* The parsed HTTP response headers.
|
6019
|
+
*/
|
6020
|
+
parsedHeaders: ContainerListBlobHierarchySegmentHeaders;
|
6021
|
+
/**
|
6022
|
+
* The response body as text (string format)
|
6023
|
+
*/
|
6024
|
+
bodyAsText: string;
|
6025
|
+
/**
|
6026
|
+
* The response body as parsed JSON or XML
|
6027
|
+
*/
|
6028
|
+
parsedBody: ListBlobsHierarchySegmentResponseModel;
|
6029
|
+
};
|
6030
|
+
};
|
7225
6031
|
/**
|
7226
6032
|
* Options to configure Container - List Blobs operations.
|
7227
6033
|
*
|
@@ -7298,30 +6104,6 @@ export declare interface ContainerProperties {
|
|
7298
6104
|
/** Indicates if version level worm is enabled on this container. */
|
7299
6105
|
isImmutableStorageWithVersioningEnabled?: boolean;
|
7300
6106
|
}
|
7301
|
-
/** Defines headers for Container_releaseLease operation. */
|
7302
|
-
declare interface ContainerReleaseLeaseHeaders {
|
7303
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
7304
|
-
etag?: string;
|
7305
|
-
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
7306
|
-
lastModified?: Date;
|
7307
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
7308
|
-
clientRequestId?: string;
|
7309
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
7310
|
-
requestId?: string;
|
7311
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
7312
|
-
version?: string;
|
7313
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
7314
|
-
date?: Date;
|
7315
|
-
}
|
7316
|
-
/** Optional parameters. */
|
7317
|
-
declare interface ContainerReleaseLeaseOptionalParams extends coreClient.OperationOptions {
|
7318
|
-
/** Parameter group */
|
7319
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
7320
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7321
|
-
timeoutInSeconds?: number;
|
7322
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7323
|
-
requestId?: string;
|
7324
|
-
}
|
7325
6107
|
/**
|
7326
6108
|
* Options to configure Container - Release Lease operation.
|
7327
6109
|
*/
|
@@ -7334,44 +6116,10 @@ export declare interface ContainerReleaseLeaseOptions extends CommonOptions {
|
|
7334
6116
|
/**
|
7335
6117
|
* Conditions to meet when releasing the lease.
|
7336
6118
|
*/
|
7337
|
-
conditions?: ModifiedAccessConditions;
|
7338
|
-
}
|
7339
|
-
/** Contains response data for the releaseLease operation. */
|
7340
|
-
declare type ContainerReleaseLeaseResponse = ContainerReleaseLeaseHeaders;
|
7341
|
-
/** Defines headers for Container_rename operation. */
|
7342
|
-
export declare interface ContainerRenameHeaders {
|
7343
|
-
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
7344
|
-
clientRequestId?: string;
|
7345
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
7346
|
-
requestId?: string;
|
7347
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
7348
|
-
version?: string;
|
7349
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
7350
|
-
date?: Date;
|
7351
|
-
/** Error Code */
|
7352
|
-
errorCode?: string;
|
7353
|
-
}
|
7354
|
-
/** Optional parameters. */
|
7355
|
-
declare interface ContainerRenameOptionalParams extends coreClient.OperationOptions {
|
7356
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7357
|
-
timeoutInSeconds?: number;
|
7358
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7359
|
-
requestId?: string;
|
7360
|
-
/** A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. */
|
7361
|
-
sourceLeaseId?: string;
|
6119
|
+
conditions?: ModifiedAccessConditions;
|
7362
6120
|
}
|
7363
|
-
/**
|
7364
|
-
export declare
|
7365
|
-
/** Contains response data for the rename operation. */
|
7366
|
-
declare type ContainerRenameResponse_2 = ContainerRenameHeaders;
|
7367
|
-
/** Defines headers for Container_renewLease operation. */
|
7368
|
-
declare interface ContainerRenewLeaseHeaders {
|
7369
|
-
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
7370
|
-
etag?: string;
|
7371
|
-
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
7372
|
-
lastModified?: Date;
|
7373
|
-
/** Uniquely identifies a container's lease */
|
7374
|
-
leaseId?: string;
|
6121
|
+
/** Defines headers for Container_rename operation. */
|
6122
|
+
export declare interface ContainerRenameHeaders {
|
7375
6123
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
7376
6124
|
clientRequestId?: string;
|
7377
6125
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
@@ -7380,16 +6128,17 @@ declare interface ContainerRenewLeaseHeaders {
|
|
7380
6128
|
version?: string;
|
7381
6129
|
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
7382
6130
|
date?: Date;
|
6131
|
+
/** Error Code */
|
6132
|
+
errorCode?: string;
|
7383
6133
|
}
|
7384
|
-
/**
|
7385
|
-
declare
|
7386
|
-
/**
|
7387
|
-
|
7388
|
-
|
7389
|
-
|
7390
|
-
|
7391
|
-
|
7392
|
-
}
|
6134
|
+
/** Contains response data for the rename operation. */
|
6135
|
+
export declare type ContainerRenameResponse = ContainerRenameHeaders & {
|
6136
|
+
/** The underlying HTTP response. */
|
6137
|
+
_response: coreHttp.HttpResponse & {
|
6138
|
+
/** The parsed HTTP response headers. */
|
6139
|
+
parsedHeaders: ContainerRenameHeaders;
|
6140
|
+
};
|
6141
|
+
};
|
7393
6142
|
/**
|
7394
6143
|
* Options to configure Container - Renew Lease operation.
|
7395
6144
|
*/
|
@@ -7404,26 +6153,11 @@ export declare interface ContainerRenewLeaseOptions extends CommonOptions {
|
|
7404
6153
|
*/
|
7405
6154
|
conditions?: ModifiedAccessConditions;
|
7406
6155
|
}
|
7407
|
-
/** Contains response data for the renewLease operation. */
|
7408
|
-
declare type ContainerRenewLeaseResponse = ContainerRenewLeaseHeaders;
|
7409
6156
|
/**
|
7410
6157
|
* Conditions to meet for the container.
|
7411
6158
|
*/
|
7412
6159
|
export declare interface ContainerRequestConditions extends LeaseAccessConditions, ModificationConditions {
|
7413
6160
|
}
|
7414
|
-
/** Optional parameters. */
|
7415
|
-
declare interface ContainerRestoreOptionalParams extends coreClient.OperationOptions {
|
7416
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7417
|
-
timeoutInSeconds?: number;
|
7418
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7419
|
-
requestId?: string;
|
7420
|
-
/** Optional. Version 2019-12-12 and later. Specifies the name of the deleted container to restore. */
|
7421
|
-
deletedContainerName?: string;
|
7422
|
-
/** Optional. Version 2019-12-12 and later. Specifies the version of the deleted container to restore. */
|
7423
|
-
deletedContainerVersion?: string;
|
7424
|
-
}
|
7425
|
-
/** Contains response data for the restore operation. */
|
7426
|
-
declare type ContainerRestoreResponse = ContainerUndeleteHeaders;
|
7427
6161
|
/**
|
7428
6162
|
* This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container.
|
7429
6163
|
* Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation.
|
@@ -7583,21 +6317,6 @@ export declare interface ContainerSetAccessPolicyHeaders {
|
|
7583
6317
|
/** Error Code */
|
7584
6318
|
errorCode?: string;
|
7585
6319
|
}
|
7586
|
-
/** Optional parameters. */
|
7587
|
-
declare interface ContainerSetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
7588
|
-
/** Parameter group */
|
7589
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
7590
|
-
/** Parameter group */
|
7591
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
7592
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7593
|
-
timeoutInSeconds?: number;
|
7594
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7595
|
-
requestId?: string;
|
7596
|
-
/** Specifies whether data in the container may be accessed publicly and the level of access */
|
7597
|
-
access?: PublicAccessType;
|
7598
|
-
/** the acls for the container */
|
7599
|
-
containerAcl?: SignedIdentifierModel[];
|
7600
|
-
}
|
7601
6320
|
/**
|
7602
6321
|
* Options to configure {@link ContainerClient.setAccessPolicy} operation.
|
7603
6322
|
*/
|
@@ -7613,9 +6332,13 @@ export declare interface ContainerSetAccessPolicyOptions extends CommonOptions {
|
|
7613
6332
|
conditions?: ContainerRequestConditions;
|
7614
6333
|
}
|
7615
6334
|
/** Contains response data for the setAccessPolicy operation. */
|
7616
|
-
export declare type ContainerSetAccessPolicyResponse =
|
7617
|
-
/**
|
7618
|
-
|
6335
|
+
export declare type ContainerSetAccessPolicyResponse = ContainerSetAccessPolicyHeaders & {
|
6336
|
+
/** The underlying HTTP response. */
|
6337
|
+
_response: coreHttp.HttpResponse & {
|
6338
|
+
/** The parsed HTTP response headers. */
|
6339
|
+
parsedHeaders: ContainerSetAccessPolicyHeaders;
|
6340
|
+
};
|
6341
|
+
};
|
7619
6342
|
/** Defines headers for Container_setMetadata operation. */
|
7620
6343
|
export declare interface ContainerSetMetadataHeaders {
|
7621
6344
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -7633,21 +6356,6 @@ export declare interface ContainerSetMetadataHeaders {
|
|
7633
6356
|
/** Error Code */
|
7634
6357
|
errorCode?: string;
|
7635
6358
|
}
|
7636
|
-
/** Optional parameters. */
|
7637
|
-
declare interface ContainerSetMetadataOptionalParams extends coreClient.OperationOptions {
|
7638
|
-
/** Parameter group */
|
7639
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
7640
|
-
/** Parameter group */
|
7641
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
7642
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7643
|
-
timeoutInSeconds?: number;
|
7644
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7645
|
-
requestId?: string;
|
7646
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
7647
|
-
metadata?: {
|
7648
|
-
[propertyName: string]: string;
|
7649
|
-
};
|
7650
|
-
}
|
7651
6359
|
/**
|
7652
6360
|
* Options to configure {@link ContainerClient.setMetadata} operation.
|
7653
6361
|
*/
|
@@ -7664,41 +6372,12 @@ export declare interface ContainerSetMetadataOptions extends CommonOptions {
|
|
7664
6372
|
conditions?: ContainerRequestConditions;
|
7665
6373
|
}
|
7666
6374
|
/** Contains response data for the setMetadata operation. */
|
7667
|
-
export declare type ContainerSetMetadataResponse =
|
7668
|
-
/**
|
7669
|
-
|
7670
|
-
/**
|
7671
|
-
|
7672
|
-
|
7673
|
-
contentType?: string;
|
7674
|
-
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
7675
|
-
requestId?: string;
|
7676
|
-
/** Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above. */
|
7677
|
-
version?: string;
|
7678
|
-
}
|
7679
|
-
/** Optional parameters. */
|
7680
|
-
declare interface ContainerSubmitBatchOptionalParams extends coreClient.OperationOptions {
|
7681
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
7682
|
-
timeoutInSeconds?: number;
|
7683
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
7684
|
-
requestId?: string;
|
7685
|
-
}
|
7686
|
-
/** Contains response data for the submitBatch operation. */
|
7687
|
-
declare type ContainerSubmitBatchResponse = ContainerSubmitBatchHeaders & {
|
7688
|
-
/**
|
7689
|
-
* BROWSER ONLY
|
7690
|
-
*
|
7691
|
-
* The response body as a browser Blob.
|
7692
|
-
* Always `undefined` in node.js.
|
7693
|
-
*/
|
7694
|
-
blobBody?: Promise<Blob>;
|
7695
|
-
/**
|
7696
|
-
* NODEJS ONLY
|
7697
|
-
*
|
7698
|
-
* The response body as a node.js Readable stream.
|
7699
|
-
* Always `undefined` in the browser.
|
7700
|
-
*/
|
7701
|
-
readableStreamBody?: NodeJS.ReadableStream;
|
6375
|
+
export declare type ContainerSetMetadataResponse = ContainerSetMetadataHeaders & {
|
6376
|
+
/** The underlying HTTP response. */
|
6377
|
+
_response: coreHttp.HttpResponse & {
|
6378
|
+
/** The parsed HTTP response headers. */
|
6379
|
+
parsedHeaders: ContainerSetMetadataHeaders;
|
6380
|
+
};
|
7702
6381
|
};
|
7703
6382
|
/** Defines headers for Container_restore operation. */
|
7704
6383
|
export declare interface ContainerUndeleteHeaders {
|
@@ -7714,7 +6393,13 @@ export declare interface ContainerUndeleteHeaders {
|
|
7714
6393
|
errorCode?: string;
|
7715
6394
|
}
|
7716
6395
|
/** Contains response data for the restore operation. */
|
7717
|
-
export declare type ContainerUndeleteResponse =
|
6396
|
+
export declare type ContainerUndeleteResponse = ContainerUndeleteHeaders & {
|
6397
|
+
/** The underlying HTTP response. */
|
6398
|
+
_response: coreHttp.HttpResponse & {
|
6399
|
+
/** The parsed HTTP response headers. */
|
6400
|
+
parsedHeaders: ContainerUndeleteHeaders;
|
6401
|
+
};
|
6402
|
+
};
|
7718
6403
|
/**
|
7719
6404
|
* Defines the operations from a {@link BlobClient} that are needed for the poller
|
7720
6405
|
* returned by {@link BlobClient.beginCopyFromURL} to work.
|
@@ -7785,24 +6470,12 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
|
|
7785
6470
|
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
|
7786
6471
|
/** Defines values for DeleteSnapshotsOptionType. */
|
7787
6472
|
export declare type DeleteSnapshotsOptionType = "include" | "only";
|
7788
|
-
|
7789
|
-
declare interface DelimitedTextConfiguration {
|
7790
|
-
/** The string used to separate columns. */
|
7791
|
-
columnSeparator?: string;
|
7792
|
-
/** The string used to quote a specific field. */
|
7793
|
-
fieldQuote?: string;
|
7794
|
-
/** The string used to separate records. */
|
7795
|
-
recordSeparator?: string;
|
7796
|
-
/** The string used as an escape character. */
|
7797
|
-
escapeChar?: string;
|
7798
|
-
/** Represents whether the data has headers. */
|
7799
|
-
headersPresent?: boolean;
|
7800
|
-
}
|
6473
|
+
export { deserializationPolicy };
|
7801
6474
|
/**
|
7802
6475
|
* Defines values for EncryptionAlgorithmType. \
|
7803
6476
|
* {@link KnownEncryptionAlgorithmType} can be used interchangeably with EncryptionAlgorithmType,
|
7804
6477
|
* this enum contains the known values that the service supports.
|
7805
|
-
* ###
|
6478
|
+
* ### Know values supported by the service
|
7806
6479
|
* **AES256**
|
7807
6480
|
*/
|
7808
6481
|
export declare type EncryptionAlgorithmType = string;
|
@@ -8004,42 +6677,16 @@ export declare interface HttpAuthorization {
|
|
8004
6677
|
export { HttpHeaders };
|
8005
6678
|
export { HttpOperationResponse };
|
8006
6679
|
export { HttpRequestBody };
|
8007
|
-
|
8008
|
-
* A representation of an HTTP response that
|
8009
|
-
* includes a reference to the request that
|
8010
|
-
* originated it.
|
8011
|
-
*/
|
8012
|
-
export declare interface HttpResponse {
|
8013
|
-
/**
|
8014
|
-
* The headers from the response.
|
8015
|
-
*/
|
8016
|
-
headers: HttpHeaders;
|
8017
|
-
/**
|
8018
|
-
* The original request that resulted in this response.
|
8019
|
-
*/
|
8020
|
-
request: WebResource;
|
8021
|
-
/**
|
8022
|
-
* The HTTP status code returned from the service.
|
8023
|
-
*/
|
8024
|
-
status: number;
|
8025
|
-
}
|
6680
|
+
export { IHttpClient };
|
8026
6681
|
/**
|
8027
6682
|
* A helper to decide if a given argument satisfies the Pipeline contract
|
8028
6683
|
* @param pipeline - An argument that may be a Pipeline
|
8029
6684
|
* @returns true when the argument satisfies the Pipeline contract
|
8030
6685
|
*/
|
8031
6686
|
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
8032
|
-
/**
|
8033
|
-
declare
|
8034
|
-
|
8035
|
-
recordSeparator?: string;
|
8036
|
-
}
|
8037
|
-
/** Key information */
|
8038
|
-
declare interface KeyInfo {
|
8039
|
-
/** The date-time the key is active in ISO 8601 UTC time */
|
8040
|
-
startsOn: string;
|
8041
|
-
/** The date-time the key expires in ISO 8601 UTC time */
|
8042
|
-
expiresOn: string;
|
6687
|
+
/** Known values of {@link EncryptionAlgorithmType} that the service accepts. */
|
6688
|
+
export declare enum KnownEncryptionAlgorithmType {
|
6689
|
+
AES256 = "AES256"
|
8043
6690
|
}
|
8044
6691
|
/**
|
8045
6692
|
* The details for a specific lease.
|
@@ -8115,7 +6762,17 @@ export declare interface LeaseOperationOptions extends CommonOptions {
|
|
8115
6762
|
*
|
8116
6763
|
* See {@link BlobLeaseClient}.
|
8117
6764
|
*/
|
8118
|
-
export declare type LeaseOperationResponse =
|
6765
|
+
export declare type LeaseOperationResponse = Lease & {
|
6766
|
+
/**
|
6767
|
+
* The underlying HTTP response.
|
6768
|
+
*/
|
6769
|
+
_response: HttpResponse & {
|
6770
|
+
/**
|
6771
|
+
* The parsed HTTP response headers.
|
6772
|
+
*/
|
6773
|
+
parsedHeaders: Lease;
|
6774
|
+
};
|
6775
|
+
};
|
8119
6776
|
/** Defines values for LeaseStateType. */
|
8120
6777
|
export declare type LeaseStateType = "available" | "leased" | "expired" | "breaking" | "broken";
|
8121
6778
|
/** Defines values for LeaseStatusType. */
|
@@ -8133,16 +6790,6 @@ export declare interface ListBlobsFlatSegmentResponse {
|
|
8133
6790
|
continuationToken?: string;
|
8134
6791
|
}
|
8135
6792
|
/** An enumeration of blobs */
|
8136
|
-
declare interface ListBlobsFlatSegmentResponse_2 {
|
8137
|
-
serviceEndpoint: string;
|
8138
|
-
containerName: string;
|
8139
|
-
prefix?: string;
|
8140
|
-
marker?: string;
|
8141
|
-
maxPageSize?: number;
|
8142
|
-
segment: BlobFlatListSegment_2;
|
8143
|
-
continuationToken?: string;
|
8144
|
-
}
|
8145
|
-
/** An enumeration of blobs */
|
8146
6793
|
export declare interface ListBlobsFlatSegmentResponseModel {
|
8147
6794
|
serviceEndpoint: string;
|
8148
6795
|
containerName: string;
|
@@ -8166,17 +6813,6 @@ export declare interface ListBlobsHierarchySegmentResponse {
|
|
8166
6813
|
continuationToken?: string;
|
8167
6814
|
}
|
8168
6815
|
/** An enumeration of blobs */
|
8169
|
-
declare interface ListBlobsHierarchySegmentResponse_2 {
|
8170
|
-
serviceEndpoint: string;
|
8171
|
-
containerName: string;
|
8172
|
-
prefix?: string;
|
8173
|
-
marker?: string;
|
8174
|
-
maxPageSize?: number;
|
8175
|
-
delimiter?: string;
|
8176
|
-
segment: BlobHierarchyListSegment_2;
|
8177
|
-
continuationToken?: string;
|
8178
|
-
}
|
8179
|
-
/** An enumeration of blobs */
|
8180
6816
|
export declare interface ListBlobsHierarchySegmentResponseModel {
|
8181
6817
|
serviceEndpoint: string;
|
8182
6818
|
containerName: string;
|
@@ -8187,10 +6823,6 @@ export declare interface ListBlobsHierarchySegmentResponseModel {
|
|
8187
6823
|
segment: BlobHierarchyListSegmentModel;
|
8188
6824
|
continuationToken?: string;
|
8189
6825
|
}
|
8190
|
-
/** Defines values for ListBlobsIncludeItem. */
|
8191
|
-
declare type ListBlobsIncludeItem = "copy" | "deleted" | "metadata" | "snapshots" | "uncommittedblobs" | "versions" | "tags" | "immutabilitypolicy" | "legalhold" | "deletedwithversions";
|
8192
|
-
/** Defines values for ListContainersIncludeType. */
|
8193
|
-
declare type ListContainersIncludeType = "metadata" | "deleted" | "system";
|
8194
6826
|
/** An enumeration of containers */
|
8195
6827
|
export declare interface ListContainersSegmentResponse {
|
8196
6828
|
serviceEndpoint: string;
|
@@ -8326,82 +6958,6 @@ export declare interface ObjectReplicationRule {
|
|
8326
6958
|
* Object Replication Policy(s) applied. See {@link ObjectReplicationPolicy} and {@link ObjectReplicationRule}.
|
8327
6959
|
*/
|
8328
6960
|
export declare type ObjectReplicationStatus = "complete" | "failed";
|
8329
|
-
/** Interface representing a PageBlob. */
|
8330
|
-
declare interface PageBlob {
|
8331
|
-
/**
|
8332
|
-
* The Create operation creates a new page blob.
|
8333
|
-
* @param contentLength The length of the request.
|
8334
|
-
* @param blobContentLength This header specifies the maximum size for the page blob, up to 1 TB. The
|
8335
|
-
* page blob size must be aligned to a 512-byte boundary.
|
8336
|
-
* @param options The options parameters.
|
8337
|
-
*/
|
8338
|
-
create(contentLength: number, blobContentLength: number, options?: PageBlobCreateOptionalParams): Promise<PageBlobCreateResponse_2>;
|
8339
|
-
/**
|
8340
|
-
* The Upload Pages operation writes a range of pages to a page blob
|
8341
|
-
* @param contentLength The length of the request.
|
8342
|
-
* @param body Initial data
|
8343
|
-
* @param options The options parameters.
|
8344
|
-
*/
|
8345
|
-
uploadPages(contentLength: number, body: coreRestPipeline.RequestBodyType, options?: PageBlobUploadPagesOptionalParams): Promise<PageBlobUploadPagesResponse_2>;
|
8346
|
-
/**
|
8347
|
-
* The Clear Pages operation clears a set of pages from a page blob
|
8348
|
-
* @param contentLength The length of the request.
|
8349
|
-
* @param options The options parameters.
|
8350
|
-
*/
|
8351
|
-
clearPages(contentLength: number, options?: PageBlobClearPagesOptionalParams): Promise<PageBlobClearPagesResponse_2>;
|
8352
|
-
/**
|
8353
|
-
* The Upload Pages operation writes a range of pages to a page blob where the contents are read from a
|
8354
|
-
* URL
|
8355
|
-
* @param sourceUrl Specify a URL to the copy source.
|
8356
|
-
* @param sourceRange Bytes of source data in the specified range. The length of this range should
|
8357
|
-
* match the ContentLength header and x-ms-range/Range destination range header.
|
8358
|
-
* @param contentLength The length of the request.
|
8359
|
-
* @param range The range of bytes to which the source range would be written. The range should be 512
|
8360
|
-
* aligned and range-end is required.
|
8361
|
-
* @param options The options parameters.
|
8362
|
-
*/
|
8363
|
-
uploadPagesFromURL(sourceUrl: string, sourceRange: string, contentLength: number, range: string, options?: PageBlobUploadPagesFromURLOptionalParams): Promise<PageBlobUploadPagesFromURLResponse_2>;
|
8364
|
-
/**
|
8365
|
-
* The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a
|
8366
|
-
* page blob
|
8367
|
-
* @param options The options parameters.
|
8368
|
-
*/
|
8369
|
-
getPageRanges(options?: PageBlobGetPageRangesOptionalParams): Promise<PageBlobGetPageRangesResponseInternal>;
|
8370
|
-
/**
|
8371
|
-
* The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were
|
8372
|
-
* changed between target blob and previous snapshot.
|
8373
|
-
* @param options The options parameters.
|
8374
|
-
*/
|
8375
|
-
getPageRangesDiff(options?: PageBlobGetPageRangesDiffOptionalParams): Promise<PageBlobGetPageRangesDiffResponseInternal>;
|
8376
|
-
/**
|
8377
|
-
* Resize the Blob
|
8378
|
-
* @param blobContentLength This header specifies the maximum size for the page blob, up to 1 TB. The
|
8379
|
-
* page blob size must be aligned to a 512-byte boundary.
|
8380
|
-
* @param options The options parameters.
|
8381
|
-
*/
|
8382
|
-
resize(blobContentLength: number, options?: PageBlobResizeOptionalParams): Promise<PageBlobResizeResponse_2>;
|
8383
|
-
/**
|
8384
|
-
* Update the sequence number of the blob
|
8385
|
-
* @param sequenceNumberAction Required if the x-ms-blob-sequence-number header is set for the request.
|
8386
|
-
* This property applies to page blobs only. This property indicates how the service should modify the
|
8387
|
-
* blob's sequence number
|
8388
|
-
* @param options The options parameters.
|
8389
|
-
*/
|
8390
|
-
updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, options?: PageBlobUpdateSequenceNumberOptionalParams): Promise<PageBlobUpdateSequenceNumberResponse_2>;
|
8391
|
-
/**
|
8392
|
-
* The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob.
|
8393
|
-
* The snapshot is copied such that only the differential changes between the previously copied
|
8394
|
-
* snapshot are transferred to the destination. The copied snapshots are complete copies of the
|
8395
|
-
* original snapshot and can be read or copied from as usual. This API is supported since REST version
|
8396
|
-
* 2016-05-31.
|
8397
|
-
* @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
|
8398
|
-
* 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
|
8399
|
-
* appear in a request URI. The source blob must either be public or must be authenticated via a shared
|
8400
|
-
* access signature.
|
8401
|
-
* @param options The options parameters.
|
8402
|
-
*/
|
8403
|
-
copyIncremental(copySource: string, options?: PageBlobCopyIncrementalOptionalParams): Promise<PageBlobCopyIncrementalResponse_2>;
|
8404
|
-
}
|
8405
6961
|
/** Defines headers for PageBlob_clearPages operation. */
|
8406
6962
|
export declare interface PageBlobClearPagesHeaders {
|
8407
6963
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -8425,25 +6981,6 @@ export declare interface PageBlobClearPagesHeaders {
|
|
8425
6981
|
/** Error Code */
|
8426
6982
|
errorCode?: string;
|
8427
6983
|
}
|
8428
|
-
/** Optional parameters. */
|
8429
|
-
declare interface PageBlobClearPagesOptionalParams extends coreClient.OperationOptions {
|
8430
|
-
/** Parameter group */
|
8431
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
8432
|
-
/** Parameter group */
|
8433
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
8434
|
-
/** Parameter group */
|
8435
|
-
cpkInfo?: CpkInfo;
|
8436
|
-
/** Parameter group */
|
8437
|
-
sequenceNumberAccessConditions?: SequenceNumberAccessConditions;
|
8438
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
8439
|
-
timeoutInSeconds?: number;
|
8440
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
8441
|
-
requestId?: string;
|
8442
|
-
/** Return only the bytes of the blob in the specified range. */
|
8443
|
-
range?: string;
|
8444
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
8445
|
-
encryptionScope?: string;
|
8446
|
-
}
|
8447
6984
|
/**
|
8448
6985
|
* Options to configure the {@link PageBlobClient.clearPages} operation.
|
8449
6986
|
*/
|
@@ -8470,9 +7007,13 @@ export declare interface PageBlobClearPagesOptions extends CommonOptions {
|
|
8470
7007
|
encryptionScope?: string;
|
8471
7008
|
}
|
8472
7009
|
/** Contains response data for the clearPages operation. */
|
8473
|
-
export declare type PageBlobClearPagesResponse =
|
8474
|
-
/**
|
8475
|
-
|
7010
|
+
export declare type PageBlobClearPagesResponse = PageBlobClearPagesHeaders & {
|
7011
|
+
/** The underlying HTTP response. */
|
7012
|
+
_response: coreHttp.HttpResponse & {
|
7013
|
+
/** The parsed HTTP response headers. */
|
7014
|
+
parsedHeaders: PageBlobClearPagesHeaders;
|
7015
|
+
};
|
7016
|
+
};
|
8476
7017
|
/**
|
8477
7018
|
* PageBlobClient defines a set of operations applicable to page blobs.
|
8478
7019
|
*/
|
@@ -8895,19 +7436,14 @@ export declare interface PageBlobCopyIncrementalHeaders {
|
|
8895
7436
|
/** Error Code */
|
8896
7437
|
errorCode?: string;
|
8897
7438
|
}
|
8898
|
-
/** Optional parameters. */
|
8899
|
-
declare interface PageBlobCopyIncrementalOptionalParams extends coreClient.OperationOptions {
|
8900
|
-
/** Parameter group */
|
8901
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
8902
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
8903
|
-
timeoutInSeconds?: number;
|
8904
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
8905
|
-
requestId?: string;
|
8906
|
-
}
|
8907
7439
|
/** Contains response data for the copyIncremental operation. */
|
8908
|
-
export declare type PageBlobCopyIncrementalResponse =
|
8909
|
-
/**
|
8910
|
-
|
7440
|
+
export declare type PageBlobCopyIncrementalResponse = PageBlobCopyIncrementalHeaders & {
|
7441
|
+
/** The underlying HTTP response. */
|
7442
|
+
_response: coreHttp.HttpResponse & {
|
7443
|
+
/** The parsed HTTP response headers. */
|
7444
|
+
parsedHeaders: PageBlobCopyIncrementalHeaders;
|
7445
|
+
};
|
7446
|
+
};
|
8911
7447
|
/** Defines headers for PageBlob_create operation. */
|
8912
7448
|
export declare interface PageBlobCreateHeaders {
|
8913
7449
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -8995,39 +7531,6 @@ export declare interface PageBlobCreateIfNotExistsResponse extends PageBlobCreat
|
|
8995
7531
|
*/
|
8996
7532
|
succeeded: boolean;
|
8997
7533
|
}
|
8998
|
-
/** Optional parameters. */
|
8999
|
-
declare interface PageBlobCreateOptionalParams extends coreClient.OperationOptions {
|
9000
|
-
/** Parameter group */
|
9001
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
9002
|
-
/** Parameter group */
|
9003
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9004
|
-
/** Parameter group */
|
9005
|
-
cpkInfo?: CpkInfo;
|
9006
|
-
/** Parameter group */
|
9007
|
-
blobHttpHeaders?: BlobHTTPHeaders;
|
9008
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
9009
|
-
timeoutInSeconds?: number;
|
9010
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
9011
|
-
requestId?: string;
|
9012
|
-
/** Optional. Specifies a user-defined name-value pair associated with the blob. If no name-value pairs are specified, the operation will copy the metadata from the source blob or file to the destination blob. If one or more name-value pairs are specified, the destination blob is created with the specified metadata, and metadata is not copied from the source blob or file. Note that beginning with version 2009-09-19, metadata names must adhere to the naming rules for C# identifiers. See Naming and Referencing Containers, Blobs, and Metadata for more information. */
|
9013
|
-
metadata?: {
|
9014
|
-
[propertyName: string]: string;
|
9015
|
-
};
|
9016
|
-
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
9017
|
-
immutabilityPolicyExpiry?: Date;
|
9018
|
-
/** Specifies the immutability policy mode to set on the blob. */
|
9019
|
-
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
9020
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
9021
|
-
encryptionScope?: string;
|
9022
|
-
/** Optional. Indicates the tier to be set on the blob. */
|
9023
|
-
tier?: AccessTier;
|
9024
|
-
/** Optional. Used to set blob tags in various blob operations. */
|
9025
|
-
blobTagsString?: string;
|
9026
|
-
/** Specified if a legal hold should be set on the blob. */
|
9027
|
-
legalHold?: boolean;
|
9028
|
-
/** Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. */
|
9029
|
-
blobSequenceNumber?: number;
|
9030
|
-
}
|
9031
7534
|
/**
|
9032
7535
|
* Options to configure the {@link PageBlobClient.create} operation.
|
9033
7536
|
*/
|
@@ -9088,9 +7591,13 @@ export declare interface PageBlobCreateOptions extends CommonOptions {
|
|
9088
7591
|
tags?: Tags;
|
9089
7592
|
}
|
9090
7593
|
/** Contains response data for the create operation. */
|
9091
|
-
export declare type PageBlobCreateResponse =
|
9092
|
-
/**
|
9093
|
-
|
7594
|
+
export declare type PageBlobCreateResponse = PageBlobCreateHeaders & {
|
7595
|
+
/** The underlying HTTP response. */
|
7596
|
+
_response: coreHttp.HttpResponse & {
|
7597
|
+
/** The parsed HTTP response headers. */
|
7598
|
+
parsedHeaders: PageBlobCreateHeaders;
|
7599
|
+
};
|
7600
|
+
};
|
9094
7601
|
/** Defines headers for PageBlob_getPageRangesDiff operation. */
|
9095
7602
|
export declare interface PageBlobGetPageRangesDiffHeaders {
|
9096
7603
|
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
@@ -9110,29 +7617,6 @@ export declare interface PageBlobGetPageRangesDiffHeaders {
|
|
9110
7617
|
/** Error Code */
|
9111
7618
|
errorCode?: string;
|
9112
7619
|
}
|
9113
|
-
/** Optional parameters. */
|
9114
|
-
declare interface PageBlobGetPageRangesDiffOptionalParams extends coreClient.OperationOptions {
|
9115
|
-
/** Parameter group */
|
9116
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
9117
|
-
/** Parameter group */
|
9118
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9119
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
9120
|
-
timeoutInSeconds?: number;
|
9121
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
9122
|
-
requestId?: string;
|
9123
|
-
/** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
|
9124
|
-
marker?: string;
|
9125
|
-
/** Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. */
|
9126
|
-
maxPageSize?: number;
|
9127
|
-
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating a Snapshot of a Blob.</a> */
|
9128
|
-
snapshot?: string;
|
9129
|
-
/** Return only the bytes of the blob in the specified range. */
|
9130
|
-
range?: string;
|
9131
|
-
/** Optional in version 2015-07-08 and newer. The prevsnapshot parameter is a DateTime value that specifies that the response will contain only pages that were changed between target blob and previous snapshot. Changed pages include both updated and cleared pages. The target blob may be a snapshot, as long as the snapshot specified by prevsnapshot is the older of the two. Note that incremental snapshots are currently supported only for blobs created on or after January 1, 2016. */
|
9132
|
-
prevsnapshot?: string;
|
9133
|
-
/** Optional. This header is only supported in service versions 2019-04-19 and after and specifies the URL of a previous snapshot of the target blob. The response will only contain pages that were changed between the target blob and its previous snapshot. */
|
9134
|
-
prevSnapshotUrl?: string;
|
9135
|
-
}
|
9136
7620
|
/**
|
9137
7621
|
* Options to configure the {@link PageBlobClient.getRangesDiff} operation.
|
9138
7622
|
*/
|
@@ -9154,12 +7638,37 @@ export declare interface PageBlobGetPageRangesDiffOptions extends CommonOptions
|
|
9154
7638
|
/**
|
9155
7639
|
* Contains response data for the {@link BlobClient.getPageRangesDiff} operation.
|
9156
7640
|
*/
|
9157
|
-
export declare interface PageBlobGetPageRangesDiffResponse extends PageList, PageBlobGetPageRangesDiffHeaders
|
7641
|
+
export declare interface PageBlobGetPageRangesDiffResponse extends PageList, PageBlobGetPageRangesDiffHeaders {
|
7642
|
+
/**
|
7643
|
+
* The underlying HTTP response.
|
7644
|
+
*/
|
7645
|
+
_response: HttpResponse & {
|
7646
|
+
/**
|
7647
|
+
* The parsed HTTP response headers.
|
7648
|
+
*/
|
7649
|
+
parsedHeaders: PageBlobGetPageRangesDiffHeaders;
|
7650
|
+
/**
|
7651
|
+
* The response body as text (string format)
|
7652
|
+
*/
|
7653
|
+
bodyAsText: string;
|
7654
|
+
/**
|
7655
|
+
* The response body as parsed JSON or XML
|
7656
|
+
*/
|
7657
|
+
parsedBody: PageList;
|
7658
|
+
};
|
9158
7659
|
}
|
9159
7660
|
/** Contains response data for the getPageRangesDiff operation. */
|
9160
|
-
export declare type
|
9161
|
-
/**
|
9162
|
-
|
7661
|
+
export declare type PageBlobGetPageRangesDiffResponseModel = PageBlobGetPageRangesDiffHeaders & PageList_2 & {
|
7662
|
+
/** The underlying HTTP response. */
|
7663
|
+
_response: coreHttp.HttpResponse & {
|
7664
|
+
/** The response body as text (string format) */
|
7665
|
+
bodyAsText: string;
|
7666
|
+
/** The response body as parsed JSON or XML */
|
7667
|
+
parsedBody: PageList_2;
|
7668
|
+
/** The parsed HTTP response headers. */
|
7669
|
+
parsedHeaders: PageBlobGetPageRangesDiffHeaders;
|
7670
|
+
};
|
7671
|
+
};
|
9163
7672
|
/** Defines headers for PageBlob_getPageRanges operation. */
|
9164
7673
|
export declare interface PageBlobGetPageRangesHeaders {
|
9165
7674
|
/** Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob. */
|
@@ -9179,25 +7688,6 @@ export declare interface PageBlobGetPageRangesHeaders {
|
|
9179
7688
|
/** Error Code */
|
9180
7689
|
errorCode?: string;
|
9181
7690
|
}
|
9182
|
-
/** Optional parameters. */
|
9183
|
-
declare interface PageBlobGetPageRangesOptionalParams extends coreClient.OperationOptions {
|
9184
|
-
/** Parameter group */
|
9185
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
9186
|
-
/** Parameter group */
|
9187
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9188
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
9189
|
-
timeoutInSeconds?: number;
|
9190
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
9191
|
-
requestId?: string;
|
9192
|
-
/** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
|
9193
|
-
marker?: string;
|
9194
|
-
/** Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. */
|
9195
|
-
maxPageSize?: number;
|
9196
|
-
/** The snapshot parameter is an opaque DateTime value that, when present, specifies the blob snapshot to retrieve. For more information on working with blob snapshots, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/creating-a-snapshot-of-a-blob">Creating a Snapshot of a Blob.</a> */
|
9197
|
-
snapshot?: string;
|
9198
|
-
/** Return only the bytes of the blob in the specified range. */
|
9199
|
-
range?: string;
|
9200
|
-
}
|
9201
7691
|
/**
|
9202
7692
|
* Options to configure the {@link PageBlobClient.getPageRanges} operation.
|
9203
7693
|
*/
|
@@ -9215,12 +7705,37 @@ export declare interface PageBlobGetPageRangesOptions extends CommonOptions {
|
|
9215
7705
|
/**
|
9216
7706
|
* Contains response data for the {@link BlobClient.getPageRanges} operation.
|
9217
7707
|
*/
|
9218
|
-
export declare interface PageBlobGetPageRangesResponse extends PageList, PageBlobGetPageRangesHeaders
|
7708
|
+
export declare interface PageBlobGetPageRangesResponse extends PageList, PageBlobGetPageRangesHeaders {
|
7709
|
+
/**
|
7710
|
+
* The underlying HTTP response.
|
7711
|
+
*/
|
7712
|
+
_response: HttpResponse & {
|
7713
|
+
/**
|
7714
|
+
* The parsed HTTP response headers.
|
7715
|
+
*/
|
7716
|
+
parsedHeaders: PageBlobGetPageRangesHeaders;
|
7717
|
+
/**
|
7718
|
+
* The response body as text (string format)
|
7719
|
+
*/
|
7720
|
+
bodyAsText: string;
|
7721
|
+
/**
|
7722
|
+
* The response body as parsed JSON or XML
|
7723
|
+
*/
|
7724
|
+
parsedBody: PageList;
|
7725
|
+
};
|
9219
7726
|
}
|
9220
7727
|
/** Contains response data for the getPageRanges operation. */
|
9221
|
-
export declare type
|
9222
|
-
/**
|
9223
|
-
|
7728
|
+
export declare type PageBlobGetPageRangesResponseModel = PageBlobGetPageRangesHeaders & PageList_2 & {
|
7729
|
+
/** The underlying HTTP response. */
|
7730
|
+
_response: coreHttp.HttpResponse & {
|
7731
|
+
/** The response body as text (string format) */
|
7732
|
+
bodyAsText: string;
|
7733
|
+
/** The response body as parsed JSON or XML */
|
7734
|
+
parsedBody: PageList_2;
|
7735
|
+
/** The parsed HTTP response headers. */
|
7736
|
+
parsedHeaders: PageBlobGetPageRangesHeaders;
|
7737
|
+
};
|
7738
|
+
};
|
9224
7739
|
/**
|
9225
7740
|
* Options to configure the {@link PageBlobClient.listPageRangesDiff} operation.
|
9226
7741
|
*/
|
@@ -9273,21 +7788,6 @@ export declare interface PageBlobResizeHeaders {
|
|
9273
7788
|
/** Error Code */
|
9274
7789
|
errorCode?: string;
|
9275
7790
|
}
|
9276
|
-
/** Optional parameters. */
|
9277
|
-
declare interface PageBlobResizeOptionalParams extends coreClient.OperationOptions {
|
9278
|
-
/** Parameter group */
|
9279
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
9280
|
-
/** Parameter group */
|
9281
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9282
|
-
/** Parameter group */
|
9283
|
-
cpkInfo?: CpkInfo;
|
9284
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
9285
|
-
timeoutInSeconds?: number;
|
9286
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
9287
|
-
requestId?: string;
|
9288
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
9289
|
-
encryptionScope?: string;
|
9290
|
-
}
|
9291
7791
|
/**
|
9292
7792
|
* Options to configure {@link PageBlobClient.resize} operation.
|
9293
7793
|
*/
|
@@ -9310,9 +7810,13 @@ export declare interface PageBlobResizeOptions extends CommonOptions {
|
|
9310
7810
|
encryptionScope?: string;
|
9311
7811
|
}
|
9312
7812
|
/** Contains response data for the resize operation. */
|
9313
|
-
export declare type PageBlobResizeResponse =
|
9314
|
-
/**
|
9315
|
-
|
7813
|
+
export declare type PageBlobResizeResponse = PageBlobResizeHeaders & {
|
7814
|
+
/** The underlying HTTP response. */
|
7815
|
+
_response: coreHttp.HttpResponse & {
|
7816
|
+
/** The parsed HTTP response headers. */
|
7817
|
+
parsedHeaders: PageBlobResizeHeaders;
|
7818
|
+
};
|
7819
|
+
};
|
9316
7820
|
/**
|
9317
7821
|
* Options to configure {@link PageBlobClient.startCopyIncremental} operation.
|
9318
7822
|
*/
|
@@ -9346,19 +7850,6 @@ export declare interface PageBlobUpdateSequenceNumberHeaders {
|
|
9346
7850
|
/** Error Code */
|
9347
7851
|
errorCode?: string;
|
9348
7852
|
}
|
9349
|
-
/** Optional parameters. */
|
9350
|
-
declare interface PageBlobUpdateSequenceNumberOptionalParams extends coreClient.OperationOptions {
|
9351
|
-
/** Parameter group */
|
9352
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
9353
|
-
/** Parameter group */
|
9354
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9355
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
9356
|
-
timeoutInSeconds?: number;
|
9357
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
9358
|
-
requestId?: string;
|
9359
|
-
/** Set for page blobs only. The sequence number is a user-controlled value that you can use to track requests. The value of the sequence number must be between 0 and 2^63 - 1. */
|
9360
|
-
blobSequenceNumber?: number;
|
9361
|
-
}
|
9362
7853
|
/**
|
9363
7854
|
* Options to configure {@link PageBlobClient.updateSequenceNumber} operation.
|
9364
7855
|
*/
|
@@ -9374,9 +7865,13 @@ export declare interface PageBlobUpdateSequenceNumberOptions extends CommonOptio
|
|
9374
7865
|
conditions?: BlobRequestConditions;
|
9375
7866
|
}
|
9376
7867
|
/** Contains response data for the updateSequenceNumber operation. */
|
9377
|
-
export declare type PageBlobUpdateSequenceNumberResponse =
|
9378
|
-
/**
|
9379
|
-
|
7868
|
+
export declare type PageBlobUpdateSequenceNumberResponse = PageBlobUpdateSequenceNumberHeaders & {
|
7869
|
+
/** The underlying HTTP response. */
|
7870
|
+
_response: coreHttp.HttpResponse & {
|
7871
|
+
/** The parsed HTTP response headers. */
|
7872
|
+
parsedHeaders: PageBlobUpdateSequenceNumberHeaders;
|
7873
|
+
};
|
7874
|
+
};
|
9380
7875
|
/** Defines headers for PageBlob_uploadPagesFromURL operation. */
|
9381
7876
|
export declare interface PageBlobUploadPagesFromURLHeaders {
|
9382
7877
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -9404,31 +7899,6 @@ export declare interface PageBlobUploadPagesFromURLHeaders {
|
|
9404
7899
|
/** Error Code */
|
9405
7900
|
errorCode?: string;
|
9406
7901
|
}
|
9407
|
-
/** Optional parameters. */
|
9408
|
-
declare interface PageBlobUploadPagesFromURLOptionalParams extends coreClient.OperationOptions {
|
9409
|
-
/** Parameter group */
|
9410
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
9411
|
-
/** Parameter group */
|
9412
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9413
|
-
/** Parameter group */
|
9414
|
-
cpkInfo?: CpkInfo;
|
9415
|
-
/** Parameter group */
|
9416
|
-
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
9417
|
-
/** Parameter group */
|
9418
|
-
sequenceNumberAccessConditions?: SequenceNumberAccessConditions;
|
9419
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
9420
|
-
timeoutInSeconds?: number;
|
9421
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
9422
|
-
requestId?: string;
|
9423
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
9424
|
-
encryptionScope?: string;
|
9425
|
-
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
9426
|
-
sourceContentMD5?: Uint8Array;
|
9427
|
-
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
9428
|
-
copySourceAuthorization?: string;
|
9429
|
-
/** Specify the crc64 calculated for the range of bytes that must be read from the copy source. */
|
9430
|
-
sourceContentCrc64?: Uint8Array;
|
9431
|
-
}
|
9432
7902
|
/**
|
9433
7903
|
* Options to configure {@link PageBlobClient.uploadPagesFromURL} operation.
|
9434
7904
|
*/
|
@@ -9479,9 +7949,13 @@ export declare interface PageBlobUploadPagesFromURLOptions extends CommonOptions
|
|
9479
7949
|
sourceAuthorization?: HttpAuthorization;
|
9480
7950
|
}
|
9481
7951
|
/** Contains response data for the uploadPagesFromURL operation. */
|
9482
|
-
export declare type PageBlobUploadPagesFromURLResponse =
|
9483
|
-
/**
|
9484
|
-
|
7952
|
+
export declare type PageBlobUploadPagesFromURLResponse = PageBlobUploadPagesFromURLHeaders & {
|
7953
|
+
/** The underlying HTTP response. */
|
7954
|
+
_response: coreHttp.HttpResponse & {
|
7955
|
+
/** The parsed HTTP response headers. */
|
7956
|
+
parsedHeaders: PageBlobUploadPagesFromURLHeaders;
|
7957
|
+
};
|
7958
|
+
};
|
9485
7959
|
/** Defines headers for PageBlob_uploadPages operation. */
|
9486
7960
|
export declare interface PageBlobUploadPagesHeaders {
|
9487
7961
|
/** The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes. */
|
@@ -9511,29 +7985,6 @@ export declare interface PageBlobUploadPagesHeaders {
|
|
9511
7985
|
/** Error Code */
|
9512
7986
|
errorCode?: string;
|
9513
7987
|
}
|
9514
|
-
/** Optional parameters. */
|
9515
|
-
declare interface PageBlobUploadPagesOptionalParams extends coreClient.OperationOptions {
|
9516
|
-
/** Parameter group */
|
9517
|
-
leaseAccessConditions?: LeaseAccessConditions;
|
9518
|
-
/** Parameter group */
|
9519
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9520
|
-
/** Parameter group */
|
9521
|
-
cpkInfo?: CpkInfo;
|
9522
|
-
/** Parameter group */
|
9523
|
-
sequenceNumberAccessConditions?: SequenceNumberAccessConditions;
|
9524
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
9525
|
-
timeoutInSeconds?: number;
|
9526
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
9527
|
-
requestId?: string;
|
9528
|
-
/** Return only the bytes of the blob in the specified range. */
|
9529
|
-
range?: string;
|
9530
|
-
/** Optional. Version 2019-07-07 and later. Specifies the name of the encryption scope to use to encrypt the data provided in the request. If not specified, encryption is performed with the default account encryption scope. For more information, see Encryption at Rest for Azure Storage Services. */
|
9531
|
-
encryptionScope?: string;
|
9532
|
-
/** Specify the transactional md5 for the body, to be validated by the service. */
|
9533
|
-
transactionalContentMD5?: Uint8Array;
|
9534
|
-
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
9535
|
-
transactionalContentCrc64?: Uint8Array;
|
9536
|
-
}
|
9537
7988
|
/**
|
9538
7989
|
* Options to configure the {@link PageBlobClient.uploadPages} operation.
|
9539
7990
|
*/
|
@@ -9578,9 +8029,13 @@ export declare interface PageBlobUploadPagesOptions extends CommonOptions {
|
|
9578
8029
|
encryptionScope?: string;
|
9579
8030
|
}
|
9580
8031
|
/** Contains response data for the uploadPages operation. */
|
9581
|
-
export declare type PageBlobUploadPagesResponse =
|
9582
|
-
/**
|
9583
|
-
|
8032
|
+
export declare type PageBlobUploadPagesResponse = PageBlobUploadPagesHeaders & {
|
8033
|
+
/** The underlying HTTP response. */
|
8034
|
+
_response: coreHttp.HttpResponse & {
|
8035
|
+
/** The parsed HTTP response headers. */
|
8036
|
+
parsedHeaders: PageBlobUploadPagesHeaders;
|
8037
|
+
};
|
8038
|
+
};
|
9584
8039
|
/**
|
9585
8040
|
* List of page ranges for a blob.
|
9586
8041
|
*/
|
@@ -9596,12 +8051,12 @@ export declare interface PageList {
|
|
9596
8051
|
clearRange?: Range_2[];
|
9597
8052
|
}
|
9598
8053
|
/** the list of pages */
|
9599
|
-
|
8054
|
+
declare interface PageList_2 {
|
9600
8055
|
pageRange?: PageRange[];
|
9601
8056
|
clearRange?: ClearRange[];
|
9602
8057
|
continuationToken?: string;
|
9603
8058
|
}
|
9604
|
-
|
8059
|
+
declare interface PageRange {
|
9605
8060
|
start: number;
|
9606
8061
|
end: number;
|
9607
8062
|
}
|
@@ -9691,7 +8146,7 @@ export declare interface PipelineOptions {
|
|
9691
8146
|
/**
|
9692
8147
|
* Optional. Configures the HTTP client to send requests and receive responses.
|
9693
8148
|
*/
|
9694
|
-
httpClient?:
|
8149
|
+
httpClient?: IHttpClient;
|
9695
8150
|
}
|
9696
8151
|
export { PollerLike };
|
9697
8152
|
/**
|
@@ -9807,32 +8262,6 @@ export declare enum PremiumPageBlobTier {
|
|
9807
8262
|
}
|
9808
8263
|
/** Defines values for PublicAccessType. */
|
9809
8264
|
export declare type PublicAccessType = "container" | "blob";
|
9810
|
-
declare interface QueryFormat {
|
9811
|
-
/** The quick query format type. */
|
9812
|
-
type: QueryFormatType;
|
9813
|
-
/** Groups the settings used for interpreting the blob data if the blob is delimited text formatted. */
|
9814
|
-
delimitedTextConfiguration?: DelimitedTextConfiguration;
|
9815
|
-
/** json text configuration */
|
9816
|
-
jsonTextConfiguration?: JsonTextConfiguration;
|
9817
|
-
/** Groups the settings used for formatting the response if the response should be Arrow formatted. */
|
9818
|
-
arrowConfiguration?: ArrowConfiguration;
|
9819
|
-
/** parquet configuration */
|
9820
|
-
parquetTextConfiguration?: Record<string, unknown>;
|
9821
|
-
}
|
9822
|
-
/** Defines values for QueryFormatType. */
|
9823
|
-
declare type QueryFormatType = "delimited" | "json" | "arrow" | "parquet";
|
9824
|
-
/** Groups the set of query request settings. */
|
9825
|
-
declare interface QueryRequest {
|
9826
|
-
/** Required. The type of the provided query expression. */
|
9827
|
-
queryType: string;
|
9828
|
-
/** The query expression in SQL. The maximum size of the query expression is 256KiB. */
|
9829
|
-
expression: string;
|
9830
|
-
inputSerialization?: QuerySerialization;
|
9831
|
-
outputSerialization?: QuerySerialization;
|
9832
|
-
}
|
9833
|
-
declare interface QuerySerialization {
|
9834
|
-
format: QueryFormat;
|
9835
|
-
}
|
9836
8265
|
/**
|
9837
8266
|
* Range for Blob Service Operations.
|
9838
8267
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations
|
@@ -9851,57 +8280,9 @@ declare interface Range_2 {
|
|
9851
8280
|
export { Range_2 as Range };
|
9852
8281
|
/** Defines values for RehydratePriority. */
|
9853
8282
|
export declare type RehydratePriority = "High" | "Standard";
|
9854
|
-
export { RequestPolicy as IHttpClient };
|
9855
8283
|
export { RequestPolicy };
|
9856
8284
|
export { RequestPolicyFactory };
|
9857
8285
|
export { RequestPolicyOptions };
|
9858
|
-
/**
|
9859
|
-
* An object with a simple _response property.
|
9860
|
-
*/
|
9861
|
-
export declare interface ResponseLike {
|
9862
|
-
/**
|
9863
|
-
* The underlying HTTP response.
|
9864
|
-
*/
|
9865
|
-
_response: HttpResponse;
|
9866
|
-
}
|
9867
|
-
/**
|
9868
|
-
* An object with a _response property that has body
|
9869
|
-
* and headers already parsed into known types.
|
9870
|
-
*/
|
9871
|
-
export declare interface ResponseWithBody<Headers, Body> {
|
9872
|
-
/**
|
9873
|
-
* The underlying HTTP response.
|
9874
|
-
*/
|
9875
|
-
_response: HttpResponse & {
|
9876
|
-
/**
|
9877
|
-
* The parsed HTTP response headers.
|
9878
|
-
*/
|
9879
|
-
parsedHeaders: Headers;
|
9880
|
-
/**
|
9881
|
-
* The response body as text (string format)
|
9882
|
-
*/
|
9883
|
-
bodyAsText: string;
|
9884
|
-
/**
|
9885
|
-
* The response body as parsed JSON or XML
|
9886
|
-
*/
|
9887
|
-
parsedBody: Body;
|
9888
|
-
};
|
9889
|
-
}
|
9890
|
-
/**
|
9891
|
-
* An object with a _response property that has
|
9892
|
-
* headers already parsed into a typed object.
|
9893
|
-
*/
|
9894
|
-
export declare interface ResponseWithHeaders<Headers> {
|
9895
|
-
/**
|
9896
|
-
* The underlying HTTP response.
|
9897
|
-
*/
|
9898
|
-
_response: HttpResponse & {
|
9899
|
-
/**
|
9900
|
-
* The parsed HTTP response headers.
|
9901
|
-
*/
|
9902
|
-
parsedHeaders: Headers;
|
9903
|
-
};
|
9904
|
-
}
|
9905
8286
|
export { RestError };
|
9906
8287
|
/** the retention policy which determines how long the associated data should persist */
|
9907
8288
|
export declare interface RetentionPolicy {
|
@@ -10218,75 +8599,6 @@ export declare interface SequenceNumberAccessConditions {
|
|
10218
8599
|
}
|
10219
8600
|
/** Defines values for SequenceNumberActionType. */
|
10220
8601
|
export declare type SequenceNumberActionType = "max" | "update" | "increment";
|
10221
|
-
/** Interface representing a Service. */
|
10222
|
-
declare interface Service {
|
10223
|
-
/**
|
10224
|
-
* Sets properties for a storage account's Blob service endpoint, including properties for Storage
|
10225
|
-
* Analytics and CORS (Cross-Origin Resource Sharing) rules
|
10226
|
-
* @param blobServiceProperties The StorageService properties.
|
10227
|
-
* @param options The options parameters.
|
10228
|
-
*/
|
10229
|
-
setProperties(blobServiceProperties: BlobServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesResponse_2>;
|
10230
|
-
/**
|
10231
|
-
* gets the properties of a storage account's Blob service, including properties for Storage Analytics
|
10232
|
-
* and CORS (Cross-Origin Resource Sharing) rules.
|
10233
|
-
* @param options The options parameters.
|
10234
|
-
*/
|
10235
|
-
getProperties(options?: ServiceGetPropertiesOptionalParams): Promise<ServiceGetPropertiesResponseInternal>;
|
10236
|
-
/**
|
10237
|
-
* Retrieves statistics related to replication for the Blob service. It is only available on the
|
10238
|
-
* secondary location endpoint when read-access geo-redundant replication is enabled for the storage
|
10239
|
-
* account.
|
10240
|
-
* @param options The options parameters.
|
10241
|
-
*/
|
10242
|
-
getStatistics(options?: ServiceGetStatisticsOptionalParams): Promise<ServiceGetStatisticsResponseInternal>;
|
10243
|
-
/**
|
10244
|
-
* The List Containers Segment operation returns a list of the containers under the specified account
|
10245
|
-
* @param options The options parameters.
|
10246
|
-
*/
|
10247
|
-
listContainersSegment(options?: ServiceListContainersSegmentOptionalParams): Promise<ServiceListContainersSegmentResponseInternal>;
|
10248
|
-
/**
|
10249
|
-
* Retrieves a user delegation key for the Blob service. This is only a valid operation when using
|
10250
|
-
* bearer token authentication.
|
10251
|
-
* @param keyInfo Key information
|
10252
|
-
* @param options The options parameters.
|
10253
|
-
*/
|
10254
|
-
getUserDelegationKey(keyInfo: KeyInfo, options?: ServiceGetUserDelegationKeyOptionalParams): Promise<ServiceGetUserDelegationKeyResponse_2>;
|
10255
|
-
/**
|
10256
|
-
* Returns the sku name and account kind
|
10257
|
-
* @param options The options parameters.
|
10258
|
-
*/
|
10259
|
-
getAccountInfo(options?: ServiceGetAccountInfoOptionalParams): Promise<ServiceGetAccountInfoResponse_2>;
|
10260
|
-
/**
|
10261
|
-
* The Batch operation allows multiple API calls to be embedded into a single HTTP request.
|
10262
|
-
* @param contentLength The length of the request.
|
10263
|
-
* @param multipartContentType Required. The value of this header must be multipart/mixed with a batch
|
10264
|
-
* boundary. Example header value: multipart/mixed; boundary=batch_<GUID>
|
10265
|
-
* @param body Initial data
|
10266
|
-
* @param options The options parameters.
|
10267
|
-
*/
|
10268
|
-
submitBatch(contentLength: number, multipartContentType: string, body: coreRestPipeline.RequestBodyType, options?: ServiceSubmitBatchOptionalParamsModel): Promise<ServiceSubmitBatchResponseInternal>;
|
10269
|
-
/**
|
10270
|
-
* The Filter Blobs operation enables callers to list blobs across all containers whose tags match a
|
10271
|
-
* given search expression. Filter blobs searches across all containers within a storage account but
|
10272
|
-
* can be scoped within the expression to a single container.
|
10273
|
-
* @param options The options parameters.
|
10274
|
-
*/
|
10275
|
-
filterBlobs(options?: ServiceFilterBlobsOptionalParams): Promise<ServiceFilterBlobsResponse>;
|
10276
|
-
}
|
10277
|
-
/**
|
10278
|
-
* A subset of `@azure/core-http` ServiceClientOptions
|
10279
|
-
*/
|
10280
|
-
export declare interface ServiceClientOptions {
|
10281
|
-
/**
|
10282
|
-
* Optional. Configures the HTTP client to send requests and receive responses.
|
10283
|
-
*/
|
10284
|
-
httpClient?: RequestPolicy;
|
10285
|
-
/**
|
10286
|
-
* Optional. Overrides the default policy factories.
|
10287
|
-
*/
|
10288
|
-
requestPolicyFactories?: RequestPolicyFactory[] | ((defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]);
|
10289
|
-
}
|
10290
8602
|
/** Defines headers for Service_filterBlobs operation. */
|
10291
8603
|
export declare interface ServiceFilterBlobsHeaders {
|
10292
8604
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -10300,21 +8612,6 @@ export declare interface ServiceFilterBlobsHeaders {
|
|
10300
8612
|
/** Error Code */
|
10301
8613
|
errorCode?: string;
|
10302
8614
|
}
|
10303
|
-
/** Optional parameters. */
|
10304
|
-
declare interface ServiceFilterBlobsOptionalParams extends coreClient.OperationOptions {
|
10305
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
10306
|
-
timeoutInSeconds?: number;
|
10307
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
10308
|
-
requestId?: string;
|
10309
|
-
/** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
|
10310
|
-
marker?: string;
|
10311
|
-
/** Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. */
|
10312
|
-
maxPageSize?: number;
|
10313
|
-
/** Filters the results to return only to return only blobs whose tags match the specified expression. */
|
10314
|
-
where?: string;
|
10315
|
-
}
|
10316
|
-
/** Contains response data for the filterBlobs operation. */
|
10317
|
-
declare type ServiceFilterBlobsResponse = ServiceFilterBlobsHeaders & FilterBlobSegmentModel;
|
10318
8615
|
/**
|
10319
8616
|
* Options to configure the {@link BlobServiceClient.findBlobsByTags} operation.
|
10320
8617
|
*/
|
@@ -10328,7 +8625,25 @@ export declare interface ServiceFindBlobByTagsOptions extends CommonOptions {
|
|
10328
8625
|
/**
|
10329
8626
|
* The response of {@link BlobServiceClient.findBlobsByTags} operation.
|
10330
8627
|
*/
|
10331
|
-
export declare type ServiceFindBlobsByTagsSegmentResponse =
|
8628
|
+
export declare type ServiceFindBlobsByTagsSegmentResponse = FilterBlobSegment & ServiceFilterBlobsHeaders & {
|
8629
|
+
/**
|
8630
|
+
* The underlying HTTP response.
|
8631
|
+
*/
|
8632
|
+
_response: HttpResponse & {
|
8633
|
+
/**
|
8634
|
+
* The parsed HTTP response headers.
|
8635
|
+
*/
|
8636
|
+
parsedHeaders: ServiceFilterBlobsHeaders;
|
8637
|
+
/**
|
8638
|
+
* The response body as text (string format)
|
8639
|
+
*/
|
8640
|
+
bodyAsText: string;
|
8641
|
+
/**
|
8642
|
+
* The response body as parsed JSON or XML
|
8643
|
+
*/
|
8644
|
+
parsedBody: FilterBlobSegmentModel;
|
8645
|
+
};
|
8646
|
+
};
|
10332
8647
|
/**
|
10333
8648
|
* Options to configure {@link BlobServiceClient.generateAccountSasUrl} operation.
|
10334
8649
|
*/
|
@@ -10374,9 +8689,6 @@ export declare interface ServiceGetAccountInfoHeaders {
|
|
10374
8689
|
/** Error Code */
|
10375
8690
|
errorCode?: string;
|
10376
8691
|
}
|
10377
|
-
/** Optional parameters. */
|
10378
|
-
declare interface ServiceGetAccountInfoOptionalParams extends coreClient.OperationOptions {
|
10379
|
-
}
|
10380
8692
|
/**
|
10381
8693
|
* Options to configure the {@link BlobServiceClient.getAccountInfo} operation.
|
10382
8694
|
*/
|
@@ -10388,9 +8700,13 @@ export declare interface ServiceGetAccountInfoOptions extends CommonOptions {
|
|
10388
8700
|
abortSignal?: AbortSignalLike;
|
10389
8701
|
}
|
10390
8702
|
/** Contains response data for the getAccountInfo operation. */
|
10391
|
-
export declare type ServiceGetAccountInfoResponse =
|
10392
|
-
/**
|
10393
|
-
|
8703
|
+
export declare type ServiceGetAccountInfoResponse = ServiceGetAccountInfoHeaders & {
|
8704
|
+
/** The underlying HTTP response. */
|
8705
|
+
_response: coreHttp.HttpResponse & {
|
8706
|
+
/** The parsed HTTP response headers. */
|
8707
|
+
parsedHeaders: ServiceGetAccountInfoHeaders;
|
8708
|
+
};
|
8709
|
+
};
|
10394
8710
|
/** Defines headers for Service_getProperties operation. */
|
10395
8711
|
export declare interface ServiceGetPropertiesHeaders {
|
10396
8712
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -10402,13 +8718,6 @@ export declare interface ServiceGetPropertiesHeaders {
|
|
10402
8718
|
/** Error Code */
|
10403
8719
|
errorCode?: string;
|
10404
8720
|
}
|
10405
|
-
/** Optional parameters. */
|
10406
|
-
declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
10407
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
10408
|
-
timeoutInSeconds?: number;
|
10409
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
10410
|
-
requestId?: string;
|
10411
|
-
}
|
10412
8721
|
/**
|
10413
8722
|
* Options to configure the {@link BlobServiceClient.getProperties} operation.
|
10414
8723
|
*/
|
@@ -10420,9 +8729,17 @@ export declare interface ServiceGetPropertiesOptions extends CommonOptions {
|
|
10420
8729
|
abortSignal?: AbortSignalLike;
|
10421
8730
|
}
|
10422
8731
|
/** Contains response data for the getProperties operation. */
|
10423
|
-
export declare type ServiceGetPropertiesResponse =
|
10424
|
-
/**
|
10425
|
-
|
8732
|
+
export declare type ServiceGetPropertiesResponse = ServiceGetPropertiesHeaders & BlobServiceProperties & {
|
8733
|
+
/** The underlying HTTP response. */
|
8734
|
+
_response: coreHttp.HttpResponse & {
|
8735
|
+
/** The response body as text (string format) */
|
8736
|
+
bodyAsText: string;
|
8737
|
+
/** The response body as parsed JSON or XML */
|
8738
|
+
parsedBody: BlobServiceProperties;
|
8739
|
+
/** The parsed HTTP response headers. */
|
8740
|
+
parsedHeaders: ServiceGetPropertiesHeaders;
|
8741
|
+
};
|
8742
|
+
};
|
10426
8743
|
/** Defines headers for Service_getStatistics operation. */
|
10427
8744
|
export declare interface ServiceGetStatisticsHeaders {
|
10428
8745
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -10436,13 +8753,6 @@ export declare interface ServiceGetStatisticsHeaders {
|
|
10436
8753
|
/** Error Code */
|
10437
8754
|
errorCode?: string;
|
10438
8755
|
}
|
10439
|
-
/** Optional parameters. */
|
10440
|
-
declare interface ServiceGetStatisticsOptionalParams extends coreClient.OperationOptions {
|
10441
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
10442
|
-
timeoutInSeconds?: number;
|
10443
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
10444
|
-
requestId?: string;
|
10445
|
-
}
|
10446
8756
|
/**
|
10447
8757
|
* Options to configure the {@link BlobServiceClient.getStatistics} operation.
|
10448
8758
|
*/
|
@@ -10454,9 +8764,17 @@ export declare interface ServiceGetStatisticsOptions extends CommonOptions {
|
|
10454
8764
|
abortSignal?: AbortSignalLike;
|
10455
8765
|
}
|
10456
8766
|
/** Contains response data for the getStatistics operation. */
|
10457
|
-
export declare type ServiceGetStatisticsResponse =
|
10458
|
-
/**
|
10459
|
-
|
8767
|
+
export declare type ServiceGetStatisticsResponse = ServiceGetStatisticsHeaders & BlobServiceStatistics & {
|
8768
|
+
/** The underlying HTTP response. */
|
8769
|
+
_response: coreHttp.HttpResponse & {
|
8770
|
+
/** The response body as text (string format) */
|
8771
|
+
bodyAsText: string;
|
8772
|
+
/** The response body as parsed JSON or XML */
|
8773
|
+
parsedBody: BlobServiceStatistics;
|
8774
|
+
/** The parsed HTTP response headers. */
|
8775
|
+
parsedHeaders: ServiceGetStatisticsHeaders;
|
8776
|
+
};
|
8777
|
+
};
|
10460
8778
|
/** Defines headers for Service_getUserDelegationKey operation. */
|
10461
8779
|
export declare interface ServiceGetUserDelegationKeyHeaders {
|
10462
8780
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -10470,13 +8788,6 @@ export declare interface ServiceGetUserDelegationKeyHeaders {
|
|
10470
8788
|
/** Error Code */
|
10471
8789
|
errorCode?: string;
|
10472
8790
|
}
|
10473
|
-
/** Optional parameters. */
|
10474
|
-
declare interface ServiceGetUserDelegationKeyOptionalParams extends coreClient.OperationOptions {
|
10475
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
10476
|
-
timeoutInSeconds?: number;
|
10477
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
10478
|
-
requestId?: string;
|
10479
|
-
}
|
10480
8791
|
/**
|
10481
8792
|
* Options to configure the Service - Get User Delegation Key.
|
10482
8793
|
*/
|
@@ -10490,9 +8801,25 @@ export declare interface ServiceGetUserDelegationKeyOptions extends CommonOption
|
|
10490
8801
|
/**
|
10491
8802
|
* Contains response data for the {@link getUserDelegationKey} operation.
|
10492
8803
|
*/
|
10493
|
-
export declare type ServiceGetUserDelegationKeyResponse =
|
10494
|
-
/**
|
10495
|
-
|
8804
|
+
export declare type ServiceGetUserDelegationKeyResponse = UserDelegationKey & ServiceGetUserDelegationKeyHeaders & {
|
8805
|
+
/**
|
8806
|
+
* The underlying HTTP response.
|
8807
|
+
*/
|
8808
|
+
_response: HttpResponse & {
|
8809
|
+
/**
|
8810
|
+
* The parsed HTTP response headers.
|
8811
|
+
*/
|
8812
|
+
parsedHeaders: ServiceGetUserDelegationKeyHeaders;
|
8813
|
+
/**
|
8814
|
+
* The response body as text (string format)
|
8815
|
+
*/
|
8816
|
+
bodyAsText: string;
|
8817
|
+
/**
|
8818
|
+
* The response body as parsed JSON or XML
|
8819
|
+
*/
|
8820
|
+
parsedBody: UserDelegationKeyModel;
|
8821
|
+
};
|
8822
|
+
};
|
10496
8823
|
/**
|
10497
8824
|
* Options to configure the {@link BlobServiceClient.listContainers} operation.
|
10498
8825
|
*/
|
@@ -10532,25 +8859,18 @@ export declare interface ServiceListContainersSegmentHeaders {
|
|
10532
8859
|
/** Error Code */
|
10533
8860
|
errorCode?: string;
|
10534
8861
|
}
|
10535
|
-
/** Optional parameters. */
|
10536
|
-
declare interface ServiceListContainersSegmentOptionalParams extends coreClient.OperationOptions {
|
10537
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
10538
|
-
timeoutInSeconds?: number;
|
10539
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
10540
|
-
requestId?: string;
|
10541
|
-
/** Filters the results to return only containers whose name begins with the specified prefix. */
|
10542
|
-
prefix?: string;
|
10543
|
-
/** A string value that identifies the portion of the list of containers to be returned with the next listing operation. The operation returns the ContinuationToken value within the response body if the listing operation did not return all containers remaining to be listed with the current page. The NextMarker value can be used as the value for the marker parameter in a subsequent call to request the next page of list items. The marker value is opaque to the client. */
|
10544
|
-
marker?: string;
|
10545
|
-
/** Specifies the maximum number of containers to return. If the request does not specify maxresults, or specifies a value greater than 5000, the server will return up to 5000 items. Note that if the listing operation crosses a partition boundary, then the service will return a continuation token for retrieving the remainder of the results. For this reason, it is possible that the service will return fewer results than specified by maxresults, or than the default of 5000. */
|
10546
|
-
maxPageSize?: number;
|
10547
|
-
/** Include this parameter to specify that the container's metadata be returned as part of the response body. */
|
10548
|
-
include?: ListContainersIncludeType[];
|
10549
|
-
}
|
10550
8862
|
/** Contains response data for the listContainersSegment operation. */
|
10551
|
-
export declare type ServiceListContainersSegmentResponse =
|
10552
|
-
/**
|
10553
|
-
|
8863
|
+
export declare type ServiceListContainersSegmentResponse = ServiceListContainersSegmentHeaders & ListContainersSegmentResponse & {
|
8864
|
+
/** The underlying HTTP response. */
|
8865
|
+
_response: coreHttp.HttpResponse & {
|
8866
|
+
/** The response body as text (string format) */
|
8867
|
+
bodyAsText: string;
|
8868
|
+
/** The response body as parsed JSON or XML */
|
8869
|
+
parsedBody: ListContainersSegmentResponse;
|
8870
|
+
/** The parsed HTTP response headers. */
|
8871
|
+
parsedHeaders: ServiceListContainersSegmentHeaders;
|
8872
|
+
};
|
8873
|
+
};
|
10554
8874
|
/**
|
10555
8875
|
* Options to configure {@link BlobServiceClient.renameContainer} operation.
|
10556
8876
|
*/
|
@@ -10576,13 +8896,6 @@ export declare interface ServiceSetPropertiesHeaders {
|
|
10576
8896
|
/** Error Code */
|
10577
8897
|
errorCode?: string;
|
10578
8898
|
}
|
10579
|
-
/** Optional parameters. */
|
10580
|
-
declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
|
10581
|
-
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
10582
|
-
timeoutInSeconds?: number;
|
10583
|
-
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
10584
|
-
requestId?: string;
|
10585
|
-
}
|
10586
8899
|
/**
|
10587
8900
|
* Options to configure the {@link BlobServiceClient.setProperties} operation.
|
10588
8901
|
*/
|
@@ -10594,9 +8907,13 @@ export declare interface ServiceSetPropertiesOptions extends CommonOptions {
|
|
10594
8907
|
abortSignal?: AbortSignalLike;
|
10595
8908
|
}
|
10596
8909
|
/** Contains response data for the setProperties operation. */
|
10597
|
-
export declare type ServiceSetPropertiesResponse =
|
10598
|
-
/**
|
10599
|
-
|
8910
|
+
export declare type ServiceSetPropertiesResponse = ServiceSetPropertiesHeaders & {
|
8911
|
+
/** The underlying HTTP response. */
|
8912
|
+
_response: coreHttp.HttpResponse & {
|
8913
|
+
/** The parsed HTTP response headers. */
|
8914
|
+
parsedHeaders: ServiceSetPropertiesHeaders;
|
8915
|
+
};
|
8916
|
+
};
|
10600
8917
|
/** Defines headers for Service_submitBatch operation. */
|
10601
8918
|
export declare interface ServiceSubmitBatchHeaders {
|
10602
8919
|
/** The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID */
|
@@ -10611,14 +8928,14 @@ export declare interface ServiceSubmitBatchHeaders {
|
|
10611
8928
|
errorCode?: string;
|
10612
8929
|
}
|
10613
8930
|
/** Optional parameters. */
|
10614
|
-
export declare interface ServiceSubmitBatchOptionalParamsModel extends
|
8931
|
+
export declare interface ServiceSubmitBatchOptionalParamsModel extends coreHttp.OperationOptions {
|
10615
8932
|
/** The timeout parameter is expressed in seconds. For more information, see <a href="https://docs.microsoft.com/en-us/rest/api/storageservices/fileservices/setting-timeouts-for-blob-service-operations">Setting Timeouts for Blob Service Operations.</a> */
|
10616
8933
|
timeoutInSeconds?: number;
|
10617
8934
|
/** Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled. */
|
10618
8935
|
requestId?: string;
|
10619
8936
|
}
|
10620
8937
|
/** Contains response data for the submitBatch operation. */
|
10621
|
-
export declare type
|
8938
|
+
export declare type ServiceSubmitBatchResponseModel = ServiceSubmitBatchHeaders & {
|
10622
8939
|
/**
|
10623
8940
|
* BROWSER ONLY
|
10624
8941
|
*
|
@@ -10633,9 +8950,12 @@ export declare type ServiceSubmitBatchResponseInternal = ServiceSubmitBatchHeade
|
|
10633
8950
|
* Always `undefined` in the browser.
|
10634
8951
|
*/
|
10635
8952
|
readableStreamBody?: NodeJS.ReadableStream;
|
8953
|
+
/** The underlying HTTP response. */
|
8954
|
+
_response: coreHttp.HttpResponse & {
|
8955
|
+
/** The parsed HTTP response headers. */
|
8956
|
+
parsedHeaders: ServiceSubmitBatchHeaders;
|
8957
|
+
};
|
10636
8958
|
};
|
10637
|
-
/** Contains response data for the submitBatch operation. */
|
10638
|
-
export declare type ServiceSubmitBatchResponseModel = WithResponse<ServiceSubmitBatchResponseInternal, ServiceSubmitBatchHeaders>;
|
10639
8959
|
/**
|
10640
8960
|
* Options to configure {@link BlobServiceClient.undeleteContainer} operation.
|
10641
8961
|
*/
|
@@ -10688,19 +9008,6 @@ export declare interface SignedIdentifierModel {
|
|
10688
9008
|
}
|
10689
9009
|
/** Defines values for SkuName. */
|
10690
9010
|
export declare type SkuName = "Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS";
|
10691
|
-
/** Parameter group */
|
10692
|
-
declare interface SourceModifiedAccessConditions {
|
10693
|
-
/** Specify this header value to operate only on a blob if it has been modified since the specified date/time. */
|
10694
|
-
sourceIfModifiedSince?: Date;
|
10695
|
-
/** Specify this header value to operate only on a blob if it has not been modified since the specified date/time. */
|
10696
|
-
sourceIfUnmodifiedSince?: Date;
|
10697
|
-
/** Specify an ETag value to operate only on blobs with a matching value. */
|
10698
|
-
sourceIfMatch?: string;
|
10699
|
-
/** Specify an ETag value to operate only on blobs without a matching value. */
|
10700
|
-
sourceIfNoneMatch?: string;
|
10701
|
-
/** Specify a SQL where clause on blob tags to operate only on blobs with a matching value. */
|
10702
|
-
sourceIfTags?: string;
|
10703
|
-
}
|
10704
9011
|
/** The properties that enable an account to host a static website */
|
10705
9012
|
export declare interface StaticWebsite {
|
10706
9013
|
/** Indicates whether this account is hosting a static website */
|
@@ -10781,7 +9088,7 @@ declare abstract class StorageClient {
|
|
10781
9088
|
* StorageClient is a reference to protocol layer operations entry, which is
|
10782
9089
|
* generated by AutoRest generator.
|
10783
9090
|
*/
|
10784
|
-
protected readonly storageClientContext:
|
9091
|
+
protected readonly storageClientContext: StorageClientContext;
|
10785
9092
|
/**
|
10786
9093
|
*/
|
10787
9094
|
protected readonly isHttps: boolean;
|
@@ -10792,25 +9099,19 @@ declare abstract class StorageClient {
|
|
10792
9099
|
*/
|
10793
9100
|
protected constructor(url: string, pipeline: PipelineLike);
|
10794
9101
|
}
|
10795
|
-
declare class
|
9102
|
+
declare class StorageClientContext extends coreHttp.ServiceClient {
|
10796
9103
|
url: string;
|
10797
9104
|
version: string;
|
10798
9105
|
/**
|
10799
|
-
* Initializes a new instance of the
|
9106
|
+
* Initializes a new instance of the StorageClientContext class.
|
10800
9107
|
* @param url The URL of the service account, container, or blob that is the target of the desired
|
10801
9108
|
* operation.
|
10802
9109
|
* @param options The parameter options
|
10803
9110
|
*/
|
10804
9111
|
constructor(url: string, options?: StorageClientOptionalParams);
|
10805
|
-
service: Service;
|
10806
|
-
container: Container;
|
10807
|
-
blob: Blob_2;
|
10808
|
-
pageBlob: PageBlob;
|
10809
|
-
appendBlob: AppendBlob;
|
10810
|
-
blockBlob: BlockBlob;
|
10811
9112
|
}
|
10812
9113
|
/** Optional parameters. */
|
10813
|
-
declare interface StorageClientOptionalParams extends
|
9114
|
+
declare interface StorageClientOptionalParams extends coreHttp.ServiceClientOptions {
|
10814
9115
|
/** Specifies the version of the operation to use for this request. */
|
10815
9116
|
version?: string;
|
10816
9117
|
/** Overrides client endpoint. */
|
@@ -10827,11 +9128,11 @@ export declare interface StoragePipelineOptions {
|
|
10827
9128
|
/**
|
10828
9129
|
* Options to configure a proxy for outgoing requests.
|
10829
9130
|
*/
|
10830
|
-
proxyOptions?:
|
9131
|
+
proxyOptions?: ProxyOptions;
|
10831
9132
|
/**
|
10832
9133
|
* Options for adding user agent details to outgoing requests.
|
10833
9134
|
*/
|
10834
|
-
userAgentOptions?:
|
9135
|
+
userAgentOptions?: UserAgentOptions;
|
10835
9136
|
/**
|
10836
9137
|
* Configures the built-in retry policy behavior.
|
10837
9138
|
*/
|
@@ -10843,7 +9144,7 @@ export declare interface StoragePipelineOptions {
|
|
10843
9144
|
/**
|
10844
9145
|
* Configures the HTTP client to send requests and receive responses.
|
10845
9146
|
*/
|
10846
|
-
httpClient?:
|
9147
|
+
httpClient?: IHttpClient;
|
10847
9148
|
/**
|
10848
9149
|
* The audience used to retrieve an AAD token.
|
10849
9150
|
*/
|
@@ -11058,6 +9359,8 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
11058
9359
|
*/
|
11059
9360
|
private getCanonicalizedResourceString;
|
11060
9361
|
}
|
9362
|
+
/** Defines values for SyncCopyStatusType. */
|
9363
|
+
export declare type SyncCopyStatusType = "success";
|
11061
9364
|
/**
|
11062
9365
|
* Specifies HTTP options for conditional requests based on blob tags.
|
11063
9366
|
*/
|
@@ -11122,8 +9425,4 @@ export declare interface UserDelegationKeyModel {
|
|
11122
9425
|
value: string;
|
11123
9426
|
}
|
11124
9427
|
export { WebResource };
|
11125
|
-
/**
|
11126
|
-
* A type that represents an operation result with a known _response property.
|
11127
|
-
*/
|
11128
|
-
export declare type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
|
11129
9428
|
export {};
|