@azure/storage-blob 12.13.0-alpha.20230126.2 → 12.13.0-beta.1
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 +5893 -5343
- 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 +1 -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 +11 -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.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 -8
- package/dist-esm/storage-blob/src/utils/cache.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/constants.js +2 -2
- 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 +42 -91
- package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -1
- package/package.json +8 -16
- package/types/3.1/storage-blob.d.ts +625 -2332
- package/types/latest/storage-blob.d.ts +606 -2493
- 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. */
|
@@ -2316,50 +1833,28 @@ export declare interface BlobDeleteImmutabilityPolicyHeaders {
|
|
2316
1833
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2317
1834
|
requestId?: string;
|
2318
1835
|
/** 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. */
|
2319
|
-
version?: string;
|
2320
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
2321
|
-
date?: Date;
|
2322
|
-
}
|
2323
|
-
/**
|
2324
|
-
|
2325
|
-
|
2326
|
-
|
2327
|
-
/**
|
2328
|
-
|
2329
|
-
|
2330
|
-
|
2331
|
-
|
2332
|
-
*/
|
2333
|
-
export declare interface BlobDeleteImmutabilityPolicyOptions extends CommonOptions {
|
2334
|
-
/**
|
2335
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
2336
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
2337
|
-
*/
|
2338
|
-
abortSignal?: AbortSignalLike;
|
2339
|
-
}
|
2340
|
-
/** Contains response data for the deleteImmutabilityPolicy operation. */
|
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;
|
1836
|
+
version?: string;
|
1837
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1838
|
+
date?: Date;
|
1839
|
+
}
|
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;
|
2362
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,9 +1880,13 @@ 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. */
|
@@ -2483,7 +1982,7 @@ export declare interface BlobDownloadHeaders {
|
|
2483
1982
|
contentCrc64?: Uint8Array;
|
2484
1983
|
}
|
2485
1984
|
/** Optional parameters. */
|
2486
|
-
export declare interface BlobDownloadOptionalParams extends
|
1985
|
+
export declare interface BlobDownloadOptionalParams extends coreHttp.OperationOptions {
|
2487
1986
|
/** Parameter group */
|
2488
1987
|
leaseAccessConditions?: LeaseAccessConditions;
|
2489
1988
|
/** Parameter group */
|
@@ -2559,7 +2058,7 @@ export declare interface BlobDownloadOptions extends CommonOptions {
|
|
2559
2058
|
customerProvidedKey?: CpkInfo;
|
2560
2059
|
}
|
2561
2060
|
/** Contains response data for the download operation. */
|
2562
|
-
export declare type
|
2061
|
+
export declare type BlobDownloadResponseModel = BlobDownloadHeaders & {
|
2563
2062
|
/**
|
2564
2063
|
* BROWSER ONLY
|
2565
2064
|
*
|
@@ -2574,9 +2073,12 @@ export declare type BlobDownloadResponseInternal = BlobDownloadHeaders & {
|
|
2574
2073
|
* Always `undefined` in the browser.
|
2575
2074
|
*/
|
2576
2075
|
readableStreamBody?: NodeJS.ReadableStream;
|
2076
|
+
/** The underlying HTTP response. */
|
2077
|
+
_response: coreHttp.HttpResponse & {
|
2078
|
+
/** The parsed HTTP response headers. */
|
2079
|
+
parsedHeaders: BlobDownloadHeaders;
|
2080
|
+
};
|
2577
2081
|
};
|
2578
|
-
/** Contains response data for the download operation. */
|
2579
|
-
export declare type BlobDownloadResponseModel = WithResponse<BlobDownloadResponseInternal, BlobDownloadHeaders>;
|
2580
2082
|
/**
|
2581
2083
|
* Contains response data for the {@link BlobClient.download} operation.
|
2582
2084
|
*/
|
@@ -2654,26 +2156,12 @@ export declare interface BlobExistsOptions extends CommonOptions {
|
|
2654
2156
|
*/
|
2655
2157
|
conditions?: BlobRequestConditions;
|
2656
2158
|
}
|
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
2159
|
/**
|
2669
2160
|
* An interface representing BlobFlatListSegment.
|
2670
2161
|
*/
|
2671
2162
|
export declare interface BlobFlatListSegment {
|
2672
2163
|
blobItems: BlobItem[];
|
2673
2164
|
}
|
2674
|
-
declare interface BlobFlatListSegment_2 {
|
2675
|
-
blobItems: BlobItemInternal_2[];
|
2676
|
-
}
|
2677
2165
|
export declare interface BlobFlatListSegmentModel {
|
2678
2166
|
blobItems: BlobItemInternal[];
|
2679
2167
|
}
|
@@ -2686,26 +2174,6 @@ export declare interface BlobGenerateSasUrlOptions extends CommonGenerateSasUrlO
|
|
2686
2174
|
*/
|
2687
2175
|
permissions?: BlobSASPermissions;
|
2688
2176
|
}
|
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
2177
|
/** Defines headers for Blob_getProperties operation. */
|
2710
2178
|
export declare interface BlobGetPropertiesHeaders {
|
2711
2179
|
/** 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 +2280,6 @@ export declare interface BlobGetPropertiesHeaders {
|
|
2812
2280
|
/** Error Code */
|
2813
2281
|
errorCode?: string;
|
2814
2282
|
}
|
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
2283
|
/**
|
2833
2284
|
* Options to configure the {@link BlobClient.getProperties} operation.
|
2834
2285
|
*/
|
@@ -2861,9 +2312,13 @@ export declare interface BlobGetPropertiesResponse extends BlobGetPropertiesResp
|
|
2861
2312
|
objectReplicationDestinationPolicyId?: string;
|
2862
2313
|
}
|
2863
2314
|
/** Contains response data for the getProperties operation. */
|
2864
|
-
declare type
|
2865
|
-
/**
|
2866
|
-
|
2315
|
+
export declare type BlobGetPropertiesResponseModel = BlobGetPropertiesHeaders & {
|
2316
|
+
/** The underlying HTTP response. */
|
2317
|
+
_response: coreHttp.HttpResponse & {
|
2318
|
+
/** The parsed HTTP response headers. */
|
2319
|
+
parsedHeaders: BlobGetPropertiesHeaders;
|
2320
|
+
};
|
2321
|
+
};
|
2867
2322
|
/** Defines headers for Blob_getTags operation. */
|
2868
2323
|
export declare interface BlobGetTagsHeaders {
|
2869
2324
|
/** 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 +2332,6 @@ export declare interface BlobGetTagsHeaders {
|
|
2877
2332
|
/** Error Code */
|
2878
2333
|
errorCode?: string;
|
2879
2334
|
}
|
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
2335
|
/**
|
2896
2336
|
* Options to configure the {@link BlobClient.getTags} operation.
|
2897
2337
|
*/
|
@@ -2909,11 +2349,27 @@ export declare interface BlobGetTagsOptions extends CommonOptions {
|
|
2909
2349
|
/**
|
2910
2350
|
* Contains response data for the {@link BlobClient.getTags} operation.
|
2911
2351
|
*/
|
2912
|
-
export declare type BlobGetTagsResponse =
|
2352
|
+
export declare type BlobGetTagsResponse = {
|
2913
2353
|
tags: Tags;
|
2914
|
-
} & BlobGetTagsHeaders
|
2915
|
-
/**
|
2916
|
-
|
2354
|
+
} & BlobGetTagsHeaders & {
|
2355
|
+
/**
|
2356
|
+
* The underlying HTTP response.
|
2357
|
+
*/
|
2358
|
+
_response: HttpResponse & {
|
2359
|
+
/**
|
2360
|
+
* The parsed HTTP response headers.
|
2361
|
+
*/
|
2362
|
+
parsedHeaders: BlobGetTagsHeaders;
|
2363
|
+
/**
|
2364
|
+
* The response body as text (string format)
|
2365
|
+
*/
|
2366
|
+
bodyAsText: string;
|
2367
|
+
/**
|
2368
|
+
* The response body as parsed JSON or XML
|
2369
|
+
*/
|
2370
|
+
parsedBody: BlobTags;
|
2371
|
+
};
|
2372
|
+
};
|
2917
2373
|
/**
|
2918
2374
|
* An interface representing BlobHierarchyListSegment.
|
2919
2375
|
*/
|
@@ -2921,10 +2377,6 @@ export declare interface BlobHierarchyListSegment {
|
|
2921
2377
|
blobPrefixes?: BlobPrefix[];
|
2922
2378
|
blobItems: BlobItem[];
|
2923
2379
|
}
|
2924
|
-
declare interface BlobHierarchyListSegment_2 {
|
2925
|
-
blobPrefixes?: BlobPrefix_2[];
|
2926
|
-
blobItems: BlobItemInternal_2[];
|
2927
|
-
}
|
2928
2380
|
export declare interface BlobHierarchyListSegmentModel {
|
2929
2381
|
blobPrefixes?: BlobPrefix[];
|
2930
2382
|
blobItems: BlobItemInternal[];
|
@@ -2998,28 +2450,6 @@ export declare interface BlobItemInternal {
|
|
2998
2450
|
/** Inactive root blobs which have any versions would have such tag with value true. */
|
2999
2451
|
hasVersionsOnly?: boolean;
|
3000
2452
|
}
|
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
2453
|
/**
|
3024
2454
|
* A client that manages leases for a {@link ContainerClient} or a {@link BlobClient}.
|
3025
2455
|
*/
|
@@ -3104,18 +2534,9 @@ export declare class BlobLeaseClient {
|
|
3104
2534
|
*/
|
3105
2535
|
breakLease(breakPeriod: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
|
3106
2536
|
}
|
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
2537
|
export declare interface BlobPrefix {
|
3114
2538
|
name: string;
|
3115
2539
|
}
|
3116
|
-
declare interface BlobPrefix_2 {
|
3117
|
-
name: BlobName;
|
3118
|
-
}
|
3119
2540
|
/** Properties of a blob */
|
3120
2541
|
export declare interface BlobProperties {
|
3121
2542
|
createdOn?: Date;
|
@@ -3338,23 +2759,6 @@ export declare interface BlobQueryJsonTextConfiguration {
|
|
3338
2759
|
*/
|
3339
2760
|
kind: "json";
|
3340
2761
|
}
|
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
2762
|
/**
|
3359
2763
|
* Options to query blob with Parquet format. Only valid for {@link BlockBlobQueryOptions.inputTextConfiguration}.
|
3360
2764
|
*/
|
@@ -3365,7 +2769,7 @@ export declare interface BlobQueryParquetConfiguration {
|
|
3365
2769
|
kind: "parquet";
|
3366
2770
|
}
|
3367
2771
|
/** Contains response data for the query operation. */
|
3368
|
-
export declare type
|
2772
|
+
export declare type BlobQueryResponseModel = BlobQueryHeaders & {
|
3369
2773
|
/**
|
3370
2774
|
* BROWSER ONLY
|
3371
2775
|
*
|
@@ -3380,33 +2784,12 @@ export declare type BlobQueryResponseInternal = BlobQueryHeaders & {
|
|
3380
2784
|
* Always `undefined` in the browser.
|
3381
2785
|
*/
|
3382
2786
|
readableStreamBody?: NodeJS.ReadableStream;
|
2787
|
+
/** The underlying HTTP response. */
|
2788
|
+
_response: coreHttp.HttpResponse & {
|
2789
|
+
/** The parsed HTTP response headers. */
|
2790
|
+
parsedHeaders: BlobQueryHeaders;
|
2791
|
+
};
|
3383
2792
|
};
|
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
2793
|
/**
|
3411
2794
|
* Options to configure Blob - Release Lease operation.
|
3412
2795
|
*/
|
@@ -3421,34 +2804,6 @@ export declare interface BlobReleaseLeaseOptions extends CommonOptions {
|
|
3421
2804
|
*/
|
3422
2805
|
conditions?: ModifiedAccessConditions;
|
3423
2806
|
}
|
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
2807
|
/**
|
3453
2808
|
* Options to configure Blob - Renew Lease operation.
|
3454
2809
|
*/
|
@@ -3463,8 +2818,6 @@ export declare interface BlobRenewLeaseOptions extends CommonOptions {
|
|
3463
2818
|
*/
|
3464
2819
|
conditions?: ModifiedAccessConditions;
|
3465
2820
|
}
|
3466
|
-
/** Contains response data for the renewLease operation. */
|
3467
|
-
declare type BlobRenewLeaseResponse = BlobRenewLeaseHeaders;
|
3468
2821
|
/**
|
3469
2822
|
* standard HTTP conditional headers, tags condition and lease condition
|
3470
2823
|
*/
|
@@ -4141,32 +3494,6 @@ export declare interface BlobServiceStatistics {
|
|
4141
3494
|
/** Geo-Replication information for the Secondary Storage Service */
|
4142
3495
|
geoReplication?: GeoReplication;
|
4143
3496
|
}
|
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
3497
|
/** Defines headers for Blob_setHttpHeaders operation. */
|
4171
3498
|
export declare interface BlobSetHTTPHeadersHeaders {
|
4172
3499
|
/** 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 +3513,6 @@ export declare interface BlobSetHTTPHeadersHeaders {
|
|
4186
3513
|
/** Error Code */
|
4187
3514
|
errorCode?: string;
|
4188
3515
|
}
|
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
3516
|
/**
|
4203
3517
|
* Options to configure the {@link BlobClient.setHTTPHeaders} operation.
|
4204
3518
|
*/
|
@@ -4218,9 +3532,13 @@ export declare interface BlobSetHTTPHeadersOptions extends CommonOptions {
|
|
4218
3532
|
customerProvidedKey?: CpkInfo;
|
4219
3533
|
}
|
4220
3534
|
/** Contains response data for the setHttpHeaders operation. */
|
4221
|
-
export declare type BlobSetHTTPHeadersResponse =
|
4222
|
-
/**
|
4223
|
-
|
3535
|
+
export declare type BlobSetHTTPHeadersResponse = BlobSetHTTPHeadersHeaders & {
|
3536
|
+
/** The underlying HTTP response. */
|
3537
|
+
_response: coreHttp.HttpResponse & {
|
3538
|
+
/** The parsed HTTP response headers. */
|
3539
|
+
parsedHeaders: BlobSetHTTPHeadersHeaders;
|
3540
|
+
};
|
3541
|
+
};
|
4224
3542
|
/** Defines headers for Blob_setImmutabilityPolicy operation. */
|
4225
3543
|
export declare interface BlobSetImmutabilityPolicyHeaders {
|
4226
3544
|
/** 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 +3554,6 @@ export declare interface BlobSetImmutabilityPolicyHeaders {
|
|
4236
3554
|
/** Indicates immutability policy mode. */
|
4237
3555
|
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
4238
3556
|
}
|
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
3557
|
/**
|
4253
3558
|
* Options for setting immutability policy {@link BlobClient.setImmutabilityPolicy} operation.
|
4254
3559
|
*/
|
@@ -4261,9 +3566,13 @@ export declare interface BlobSetImmutabilityPolicyOptions extends CommonOptions
|
|
4261
3566
|
modifiedAccessCondition?: ModificationConditions;
|
4262
3567
|
}
|
4263
3568
|
/** Contains response data for the setImmutabilityPolicy operation. */
|
4264
|
-
export declare type BlobSetImmutabilityPolicyResponse =
|
4265
|
-
/**
|
4266
|
-
|
3569
|
+
export declare type BlobSetImmutabilityPolicyResponse = BlobSetImmutabilityPolicyHeaders & {
|
3570
|
+
/** The underlying HTTP response. */
|
3571
|
+
_response: coreHttp.HttpResponse & {
|
3572
|
+
/** The parsed HTTP response headers. */
|
3573
|
+
parsedHeaders: BlobSetImmutabilityPolicyHeaders;
|
3574
|
+
};
|
3575
|
+
};
|
4267
3576
|
/** Defines headers for Blob_setLegalHold operation. */
|
4268
3577
|
export declare interface BlobSetLegalHoldHeaders {
|
4269
3578
|
/** 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 +3586,6 @@ export declare interface BlobSetLegalHoldHeaders {
|
|
4277
3586
|
/** Indicates if the blob has a legal hold. */
|
4278
3587
|
legalHold?: boolean;
|
4279
3588
|
}
|
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
3589
|
/**
|
4288
3590
|
* Options for setting legal hold {@link BlobClient.setLegalHold} operation.
|
4289
3591
|
*/
|
@@ -4295,9 +3597,13 @@ export declare interface BlobSetLegalHoldOptions extends CommonOptions {
|
|
4295
3597
|
abortSignal?: AbortSignalLike;
|
4296
3598
|
}
|
4297
3599
|
/** Contains response data for the setLegalHold operation. */
|
4298
|
-
export declare type BlobSetLegalHoldResponse =
|
4299
|
-
/**
|
4300
|
-
|
3600
|
+
export declare type BlobSetLegalHoldResponse = BlobSetLegalHoldHeaders & {
|
3601
|
+
/** The underlying HTTP response. */
|
3602
|
+
_response: coreHttp.HttpResponse & {
|
3603
|
+
/** The parsed HTTP response headers. */
|
3604
|
+
parsedHeaders: BlobSetLegalHoldHeaders;
|
3605
|
+
};
|
3606
|
+
};
|
4301
3607
|
/** Defines headers for Blob_setMetadata operation. */
|
4302
3608
|
export declare interface BlobSetMetadataHeaders {
|
4303
3609
|
/** 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. */
|
@@ -4309,38 +3615,19 @@ export declare interface BlobSetMetadataHeaders {
|
|
4309
3615
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
4310
3616
|
requestId?: string;
|
4311
3617
|
/** 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. */
|
3618
|
+
version?: string;
|
3619
|
+
/** 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. */
|
3620
|
+
versionId?: string;
|
3621
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
3622
|
+
date?: Date;
|
3623
|
+
/** 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. */
|
3624
|
+
isServerEncrypted?: boolean;
|
3625
|
+
/** 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. */
|
3626
|
+
encryptionKeySha256?: string;
|
3627
|
+
/** 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
3628
|
encryptionScope?: string;
|
3629
|
+
/** Error Code */
|
3630
|
+
errorCode?: string;
|
4344
3631
|
}
|
4345
3632
|
/**
|
4346
3633
|
* Options to configure the {@link BlobClient.setMetadata} operation.
|
@@ -4368,9 +3655,13 @@ export declare interface BlobSetMetadataOptions extends CommonOptions {
|
|
4368
3655
|
encryptionScope?: string;
|
4369
3656
|
}
|
4370
3657
|
/** Contains response data for the setMetadata operation. */
|
4371
|
-
export declare type BlobSetMetadataResponse =
|
4372
|
-
/**
|
4373
|
-
|
3658
|
+
export declare type BlobSetMetadataResponse = BlobSetMetadataHeaders & {
|
3659
|
+
/** The underlying HTTP response. */
|
3660
|
+
_response: coreHttp.HttpResponse & {
|
3661
|
+
/** The parsed HTTP response headers. */
|
3662
|
+
parsedHeaders: BlobSetMetadataHeaders;
|
3663
|
+
};
|
3664
|
+
};
|
4374
3665
|
/** Defines headers for Blob_setTags operation. */
|
4375
3666
|
export declare interface BlobSetTagsHeaders {
|
4376
3667
|
/** 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 +3675,6 @@ export declare interface BlobSetTagsHeaders {
|
|
4384
3675
|
/** Error Code */
|
4385
3676
|
errorCode?: string;
|
4386
3677
|
}
|
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
3678
|
/**
|
4407
3679
|
* Options to configure the {@link BlobClient.setTags} operation.
|
4408
3680
|
*/
|
@@ -4418,9 +3690,13 @@ export declare interface BlobSetTagsOptions extends CommonOptions {
|
|
4418
3690
|
conditions?: TagConditions & LeaseAccessConditions;
|
4419
3691
|
}
|
4420
3692
|
/** Contains response data for the setTags operation. */
|
4421
|
-
export declare type BlobSetTagsResponse =
|
4422
|
-
/**
|
4423
|
-
|
3693
|
+
export declare type BlobSetTagsResponse = BlobSetTagsHeaders & {
|
3694
|
+
/** The underlying HTTP response. */
|
3695
|
+
_response: coreHttp.HttpResponse & {
|
3696
|
+
/** The parsed HTTP response headers. */
|
3697
|
+
parsedHeaders: BlobSetTagsHeaders;
|
3698
|
+
};
|
3699
|
+
};
|
4424
3700
|
/** Defines headers for Blob_setTier operation. */
|
4425
3701
|
export declare interface BlobSetTierHeaders {
|
4426
3702
|
/** 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 +3708,6 @@ export declare interface BlobSetTierHeaders {
|
|
4432
3708
|
/** Error Code */
|
4433
3709
|
errorCode?: string;
|
4434
3710
|
}
|
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
3711
|
/**
|
4453
3712
|
* Options to configure the {@link BlobClient.setAccessTier} operation.
|
4454
3713
|
*/
|
@@ -4470,9 +3729,13 @@ export declare interface BlobSetTierOptions extends CommonOptions {
|
|
4470
3729
|
rehydratePriority?: RehydratePriority;
|
4471
3730
|
}
|
4472
3731
|
/** Contains response data for the setTier operation. */
|
4473
|
-
export declare type BlobSetTierResponse =
|
4474
|
-
/**
|
4475
|
-
|
3732
|
+
export declare type BlobSetTierResponse = BlobSetTierHeaders & {
|
3733
|
+
/** The underlying HTTP response. */
|
3734
|
+
_response: coreHttp.HttpResponse & {
|
3735
|
+
/** The parsed HTTP response headers. */
|
3736
|
+
parsedHeaders: BlobSetTierHeaders;
|
3737
|
+
};
|
3738
|
+
};
|
4476
3739
|
/** Defines headers for Blob_startCopyFromURL operation. */
|
4477
3740
|
export declare interface BlobStartCopyFromURLHeaders {
|
4478
3741
|
/** 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 +3759,6 @@ export declare interface BlobStartCopyFromURLHeaders {
|
|
4496
3759
|
/** Error Code */
|
4497
3760
|
errorCode?: string;
|
4498
3761
|
}
|
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
3762
|
/**
|
4531
3763
|
* Options to configure the {@link BlobClient.beginCopyFromURL} operation.
|
4532
3764
|
*/
|
@@ -4580,9 +3812,13 @@ export declare interface BlobStartCopyFromURLOptions extends CommonOptions {
|
|
4580
3812
|
sealBlob?: boolean;
|
4581
3813
|
}
|
4582
3814
|
/** Contains response data for the startCopyFromURL operation. */
|
4583
|
-
export declare type BlobStartCopyFromURLResponse =
|
4584
|
-
/**
|
4585
|
-
|
3815
|
+
export declare type BlobStartCopyFromURLResponse = BlobStartCopyFromURLHeaders & {
|
3816
|
+
/** The underlying HTTP response. */
|
3817
|
+
_response: coreHttp.HttpResponse & {
|
3818
|
+
/** The parsed HTTP response headers. */
|
3819
|
+
parsedHeaders: BlobStartCopyFromURLHeaders;
|
3820
|
+
};
|
3821
|
+
};
|
4586
3822
|
/**
|
4587
3823
|
* Options to configure the {@link BlobClient.syncCopyFromURL} operation.
|
4588
3824
|
*/
|
@@ -4665,13 +3901,6 @@ export declare interface BlobUndeleteHeaders {
|
|
4665
3901
|
/** Error Code */
|
4666
3902
|
errorCode?: string;
|
4667
3903
|
}
|
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
3904
|
/**
|
4676
3905
|
* Options to configure the {@link BlobClient.undelete} operation.
|
4677
3906
|
*/
|
@@ -4687,14 +3916,23 @@ export declare interface BlobUndeleteOptions extends CommonOptions {
|
|
4687
3916
|
customerProvidedKey?: CpkInfo;
|
4688
3917
|
}
|
4689
3918
|
/** Contains response data for the undelete operation. */
|
4690
|
-
export declare type BlobUndeleteResponse =
|
4691
|
-
/**
|
4692
|
-
|
3919
|
+
export declare type BlobUndeleteResponse = BlobUndeleteHeaders & {
|
3920
|
+
/** The underlying HTTP response. */
|
3921
|
+
_response: coreHttp.HttpResponse & {
|
3922
|
+
/** The parsed HTTP response headers. */
|
3923
|
+
parsedHeaders: BlobUndeleteHeaders;
|
3924
|
+
};
|
3925
|
+
};
|
4693
3926
|
/**
|
4694
3927
|
* Response type for {@link BlockBlobClient.uploadFile}, {@link BlockBlobClient.uploadStream}, and
|
4695
3928
|
* {@link BlockBlobClient.uploadBrowserDate}.
|
4696
3929
|
*/
|
4697
|
-
export declare type BlobUploadCommonResponse =
|
3930
|
+
export declare type BlobUploadCommonResponse = BlockBlobUploadHeaders & {
|
3931
|
+
/**
|
3932
|
+
* The underlying HTTP response.
|
3933
|
+
*/
|
3934
|
+
_response: HttpResponse;
|
3935
|
+
};
|
4698
3936
|
/** Represents a single block in a block blob. It describes the block's ID and size. */
|
4699
3937
|
export declare interface Block {
|
4700
3938
|
/** The base64 encoded block ID. */
|
@@ -4702,74 +3940,6 @@ export declare interface Block {
|
|
4702
3940
|
/** The block size in bytes. */
|
4703
3941
|
size: number;
|
4704
3942
|
}
|
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
3943
|
/**
|
4774
3944
|
* BlockBlobClient defines a set of operations applicable to block blobs.
|
4775
3945
|
*/
|
@@ -5094,41 +4264,6 @@ export declare interface BlockBlobCommitBlockListHeaders {
|
|
5094
4264
|
/** Error Code */
|
5095
4265
|
errorCode?: string;
|
5096
4266
|
}
|
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
4267
|
/**
|
5133
4268
|
* Options to configure {@link BlockBlobClient.commitBlockList} operation.
|
5134
4269
|
*/
|
@@ -5184,9 +4319,13 @@ export declare interface BlockBlobCommitBlockListOptions extends CommonOptions {
|
|
5184
4319
|
tags?: Tags;
|
5185
4320
|
}
|
5186
4321
|
/** Contains response data for the commitBlockList operation. */
|
5187
|
-
export declare type BlockBlobCommitBlockListResponse =
|
5188
|
-
/**
|
5189
|
-
|
4322
|
+
export declare type BlockBlobCommitBlockListResponse = BlockBlobCommitBlockListHeaders & {
|
4323
|
+
/** The underlying HTTP response. */
|
4324
|
+
_response: coreHttp.HttpResponse & {
|
4325
|
+
/** The parsed HTTP response headers. */
|
4326
|
+
parsedHeaders: BlockBlobCommitBlockListHeaders;
|
4327
|
+
};
|
4328
|
+
};
|
5190
4329
|
/** Defines headers for BlockBlob_getBlockList operation. */
|
5191
4330
|
export declare interface BlockBlobGetBlockListHeaders {
|
5192
4331
|
/** 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 +4347,6 @@ export declare interface BlockBlobGetBlockListHeaders {
|
|
5208
4347
|
/** Error Code */
|
5209
4348
|
errorCode?: string;
|
5210
4349
|
}
|
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
4350
|
/**
|
5225
4351
|
* Options to configure {@link BlockBlobClient.getBlockList} operation.
|
5226
4352
|
*/
|
@@ -5237,9 +4363,17 @@ export declare interface BlockBlobGetBlockListOptions extends CommonOptions {
|
|
5237
4363
|
conditions?: LeaseAccessConditions & TagConditions;
|
5238
4364
|
}
|
5239
4365
|
/** Contains response data for the getBlockList operation. */
|
5240
|
-
export declare type BlockBlobGetBlockListResponse =
|
5241
|
-
/**
|
5242
|
-
|
4366
|
+
export declare type BlockBlobGetBlockListResponse = BlockBlobGetBlockListHeaders & BlockList & {
|
4367
|
+
/** The underlying HTTP response. */
|
4368
|
+
_response: coreHttp.HttpResponse & {
|
4369
|
+
/** The response body as text (string format) */
|
4370
|
+
bodyAsText: string;
|
4371
|
+
/** The response body as parsed JSON or XML */
|
4372
|
+
parsedBody: BlockList;
|
4373
|
+
/** The parsed HTTP response headers. */
|
4374
|
+
parsedHeaders: BlockBlobGetBlockListHeaders;
|
4375
|
+
};
|
4376
|
+
};
|
5243
4377
|
/**
|
5244
4378
|
* Option interface for {@link BlockBlobClient.uploadFile} and {@link BlockBlobClient.uploadSeekableStream}.
|
5245
4379
|
*/
|
@@ -5329,47 +4463,14 @@ export declare interface BlockBlobPutBlobFromUrlHeaders {
|
|
5329
4463
|
/** Error Code */
|
5330
4464
|
errorCode?: string;
|
5331
4465
|
}
|
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
4466
|
/** Contains response data for the putBlobFromUrl operation. */
|
5370
|
-
export declare type BlockBlobPutBlobFromUrlResponse =
|
5371
|
-
/**
|
5372
|
-
|
4467
|
+
export declare type BlockBlobPutBlobFromUrlResponse = BlockBlobPutBlobFromUrlHeaders & {
|
4468
|
+
/** The underlying HTTP response. */
|
4469
|
+
_response: coreHttp.HttpResponse & {
|
4470
|
+
/** The parsed HTTP response headers. */
|
4471
|
+
parsedHeaders: BlockBlobPutBlobFromUrlHeaders;
|
4472
|
+
};
|
4473
|
+
};
|
5373
4474
|
/**
|
5374
4475
|
* Options to configure {@link BlockBlobClient.query} operation.
|
5375
4476
|
*/
|
@@ -5427,29 +4528,6 @@ export declare interface BlockBlobStageBlockFromURLHeaders {
|
|
5427
4528
|
/** Error Code */
|
5428
4529
|
errorCode?: string;
|
5429
4530
|
}
|
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
4531
|
/**
|
5454
4532
|
* Options to configure {@link BlockBlobClient.stageBlockFromURL} operation.
|
5455
4533
|
*/
|
@@ -5502,9 +4580,13 @@ export declare interface BlockBlobStageBlockFromURLOptions extends CommonOptions
|
|
5502
4580
|
sourceAuthorization?: HttpAuthorization;
|
5503
4581
|
}
|
5504
4582
|
/** Contains response data for the stageBlockFromURL operation. */
|
5505
|
-
export declare type BlockBlobStageBlockFromURLResponse =
|
5506
|
-
/**
|
5507
|
-
|
4583
|
+
export declare type BlockBlobStageBlockFromURLResponse = BlockBlobStageBlockFromURLHeaders & {
|
4584
|
+
/** The underlying HTTP response. */
|
4585
|
+
_response: coreHttp.HttpResponse & {
|
4586
|
+
/** The parsed HTTP response headers. */
|
4587
|
+
parsedHeaders: BlockBlobStageBlockFromURLHeaders;
|
4588
|
+
};
|
4589
|
+
};
|
5508
4590
|
/** Defines headers for BlockBlob_stageBlock operation. */
|
5509
4591
|
export declare interface BlockBlobStageBlockHeaders {
|
5510
4592
|
/** 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 +4610,6 @@ export declare interface BlockBlobStageBlockHeaders {
|
|
5528
4610
|
/** Error Code */
|
5529
4611
|
errorCode?: string;
|
5530
4612
|
}
|
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
4613
|
/**
|
5549
4614
|
* Options to configure {@link BlockBlobClient.stageBlock} operation.
|
5550
4615
|
*/
|
@@ -5590,9 +4655,13 @@ export declare interface BlockBlobStageBlockOptions extends CommonOptions {
|
|
5590
4655
|
encryptionScope?: string;
|
5591
4656
|
}
|
5592
4657
|
/** Contains response data for the stageBlock operation. */
|
5593
|
-
export declare type BlockBlobStageBlockResponse =
|
5594
|
-
/**
|
5595
|
-
|
4658
|
+
export declare type BlockBlobStageBlockResponse = BlockBlobStageBlockHeaders & {
|
4659
|
+
/** The underlying HTTP response. */
|
4660
|
+
_response: coreHttp.HttpResponse & {
|
4661
|
+
/** The parsed HTTP response headers. */
|
4662
|
+
parsedHeaders: BlockBlobStageBlockHeaders;
|
4663
|
+
};
|
4664
|
+
};
|
5596
4665
|
/**
|
5597
4666
|
* Options to configure {@link BlockBlobClient.syncUploadFromURL} operation.
|
5598
4667
|
*/
|
@@ -5720,41 +4789,6 @@ export declare interface BlockBlobUploadHeaders {
|
|
5720
4789
|
/** Error Code */
|
5721
4790
|
errorCode?: string;
|
5722
4791
|
}
|
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
4792
|
/**
|
5759
4793
|
* Options to configure {@link BlockBlobClient.upload} operation.
|
5760
4794
|
*/
|
@@ -5817,9 +4851,13 @@ export declare interface BlockBlobUploadOptions extends CommonOptions {
|
|
5817
4851
|
tags?: Tags;
|
5818
4852
|
}
|
5819
4853
|
/** Contains response data for the upload operation. */
|
5820
|
-
export declare type BlockBlobUploadResponse =
|
5821
|
-
/**
|
5822
|
-
|
4854
|
+
export declare type BlockBlobUploadResponse = BlockBlobUploadHeaders & {
|
4855
|
+
/** The underlying HTTP response. */
|
4856
|
+
_response: coreHttp.HttpResponse & {
|
4857
|
+
/** The parsed HTTP response headers. */
|
4858
|
+
parsedHeaders: BlockBlobUploadHeaders;
|
4859
|
+
};
|
4860
|
+
};
|
5823
4861
|
/**
|
5824
4862
|
* Option interface for the {@link BlockBlobClient.uploadStream} operation.
|
5825
4863
|
*/
|
@@ -5874,12 +4912,7 @@ export declare interface BlockList {
|
|
5874
4912
|
}
|
5875
4913
|
/** Defines values for BlockListType. */
|
5876
4914
|
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 {
|
4915
|
+
declare interface ClearRange {
|
5883
4916
|
start: number;
|
5884
4917
|
end: number;
|
5885
4918
|
}
|
@@ -5940,162 +4973,13 @@ export declare interface CommonGenerateSasUrlOptions {
|
|
5940
4973
|
contentType?: string;
|
5941
4974
|
}
|
5942
4975
|
/**
|
5943
|
-
* 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>;
|
4976
|
+
* An interface for options common to every remote operation.
|
4977
|
+
*/
|
4978
|
+
export declare interface CommonOptions {
|
6064
4979
|
/**
|
6065
|
-
*
|
6066
|
-
* @param options The options parameters.
|
4980
|
+
* Options to configure spans created when tracing is enabled.
|
6067
4981
|
*/
|
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;
|
4982
|
+
tracingOptions?: OperationTracingOptions;
|
6099
4983
|
}
|
6100
4984
|
/**
|
6101
4985
|
* Options to configure Container - Acquire Lease operation.
|
@@ -6111,27 +4995,8 @@ export declare interface ContainerAcquireLeaseOptions extends CommonOptions {
|
|
6111
4995
|
*/
|
6112
4996
|
conditions?: ModifiedAccessConditions;
|
6113
4997
|
}
|
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
4998
|
/** Optional parameters. */
|
6134
|
-
export declare interface ContainerBreakLeaseOptionalParams extends
|
4999
|
+
export declare interface ContainerBreakLeaseOptionalParams extends coreHttp.OperationOptions {
|
6135
5000
|
/** Parameter group */
|
6136
5001
|
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
6137
5002
|
/** 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 +5020,6 @@ export declare interface ContainerBreakLeaseOptions extends CommonOptions {
|
|
6155
5020
|
*/
|
6156
5021
|
conditions?: ModifiedAccessConditions;
|
6157
5022
|
}
|
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
5023
|
/**
|
6187
5024
|
* Options to configure Container - Change Lease operation.
|
6188
5025
|
*/
|
@@ -6197,8 +5034,6 @@ export declare interface ContainerChangeLeaseOptions extends CommonOptions {
|
|
6197
5034
|
*/
|
6198
5035
|
conditions?: ModifiedAccessConditions;
|
6199
5036
|
}
|
6200
|
-
/** Contains response data for the changeLease operation. */
|
6201
|
-
declare type ContainerChangeLeaseResponse = ContainerChangeLeaseHeaders;
|
6202
5037
|
/**
|
6203
5038
|
* A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs.
|
6204
5039
|
*/
|
@@ -6831,21 +5666,6 @@ export declare interface ContainerCreateIfNotExistsResponse extends ContainerCre
|
|
6831
5666
|
*/
|
6832
5667
|
succeeded: boolean;
|
6833
5668
|
}
|
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
5669
|
/**
|
6850
5670
|
* Options to configure {@link ContainerClient.create} operation.
|
6851
5671
|
*/
|
@@ -6871,9 +5691,13 @@ export declare interface ContainerCreateOptions extends CommonOptions {
|
|
6871
5691
|
containerEncryptionScope?: ContainerEncryptionScope;
|
6872
5692
|
}
|
6873
5693
|
/** Contains response data for the create operation. */
|
6874
|
-
export declare type ContainerCreateResponse =
|
6875
|
-
/**
|
6876
|
-
|
5694
|
+
export declare type ContainerCreateResponse = ContainerCreateHeaders & {
|
5695
|
+
/** The underlying HTTP response. */
|
5696
|
+
_response: coreHttp.HttpResponse & {
|
5697
|
+
/** The parsed HTTP response headers. */
|
5698
|
+
parsedHeaders: ContainerCreateHeaders;
|
5699
|
+
};
|
5700
|
+
};
|
6877
5701
|
/**
|
6878
5702
|
* Options to configure the {@link ContainerClient.deleteBlob} operation.
|
6879
5703
|
*/
|
@@ -6920,21 +5744,14 @@ export declare interface ContainerDeleteMethodOptions extends CommonOptions {
|
|
6920
5744
|
*/
|
6921
5745
|
conditions?: ContainerRequestConditions;
|
6922
5746
|
}
|
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
5747
|
/** Contains response data for the delete operation. */
|
6935
|
-
export declare type ContainerDeleteResponse =
|
6936
|
-
/**
|
6937
|
-
|
5748
|
+
export declare type ContainerDeleteResponse = ContainerDeleteHeaders & {
|
5749
|
+
/** The underlying HTTP response. */
|
5750
|
+
_response: coreHttp.HttpResponse & {
|
5751
|
+
/** The parsed HTTP response headers. */
|
5752
|
+
parsedHeaders: ContainerDeleteHeaders;
|
5753
|
+
};
|
5754
|
+
};
|
6938
5755
|
/** Parameter group */
|
6939
5756
|
export declare interface ContainerEncryptionScope {
|
6940
5757
|
/** 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 +5780,6 @@ export declare interface ContainerFilterBlobsHeaders {
|
|
6963
5780
|
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6964
5781
|
date?: Date;
|
6965
5782
|
}
|
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
5783
|
/**
|
6982
5784
|
* Options to configure the {@link BlobServiceClient.findBlobsByTags} operation.
|
6983
5785
|
*/
|
@@ -6991,7 +5793,25 @@ export declare interface ContainerFindBlobByTagsOptions extends CommonOptions {
|
|
6991
5793
|
/**
|
6992
5794
|
* The response of {@link BlobServiceClient.findBlobsByTags} operation.
|
6993
5795
|
*/
|
6994
|
-
export declare type ContainerFindBlobsByTagsSegmentResponse =
|
5796
|
+
export declare type ContainerFindBlobsByTagsSegmentResponse = FilterBlobSegment & ContainerFilterBlobsHeaders & {
|
5797
|
+
/**
|
5798
|
+
* The underlying HTTP response.
|
5799
|
+
*/
|
5800
|
+
_response: HttpResponse & {
|
5801
|
+
/**
|
5802
|
+
* The parsed HTTP response headers.
|
5803
|
+
*/
|
5804
|
+
parsedHeaders: ContainerFilterBlobsHeaders;
|
5805
|
+
/**
|
5806
|
+
* The response body as text (string format)
|
5807
|
+
*/
|
5808
|
+
bodyAsText: string;
|
5809
|
+
/**
|
5810
|
+
* The response body as parsed JSON or XML
|
5811
|
+
*/
|
5812
|
+
parsedBody: FilterBlobSegmentModel;
|
5813
|
+
};
|
5814
|
+
};
|
6995
5815
|
/**
|
6996
5816
|
* Options to configure {@link ContainerClient.generateSasUrl} operation.
|
6997
5817
|
*/
|
@@ -7020,15 +5840,6 @@ export declare interface ContainerGetAccessPolicyHeaders {
|
|
7020
5840
|
/** Error Code */
|
7021
5841
|
errorCode?: string;
|
7022
5842
|
}
|
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
5843
|
/**
|
7033
5844
|
* Options to configure {@link ContainerClient.getAccessPolicy} operation.
|
7034
5845
|
*/
|
@@ -7047,31 +5858,27 @@ export declare interface ContainerGetAccessPolicyOptions extends CommonOptions {
|
|
7047
5858
|
/**
|
7048
5859
|
* Contains response data for the {@link ContainerClient.getAccessPolicy} operation.
|
7049
5860
|
*/
|
7050
|
-
export declare type ContainerGetAccessPolicyResponse =
|
5861
|
+
export declare type ContainerGetAccessPolicyResponse = {
|
7051
5862
|
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;
|
5863
|
+
} & ContainerGetAccessPolicyHeaders & {
|
5864
|
+
/**
|
5865
|
+
* The underlying HTTP response.
|
5866
|
+
*/
|
5867
|
+
_response: HttpResponse & {
|
5868
|
+
/**
|
5869
|
+
* The parsed HTTP response headers.
|
5870
|
+
*/
|
5871
|
+
parsedHeaders: ContainerGetAccessPolicyHeaders;
|
5872
|
+
/**
|
5873
|
+
* The response body as text (string format)
|
5874
|
+
*/
|
5875
|
+
bodyAsText: string;
|
5876
|
+
/**
|
5877
|
+
* The response body as parsed JSON or XML
|
5878
|
+
*/
|
5879
|
+
parsedBody: SignedIdentifierModel[];
|
5880
|
+
};
|
5881
|
+
};
|
7075
5882
|
/** Defines headers for Container_getProperties operation. */
|
7076
5883
|
export declare interface ContainerGetPropertiesHeaders {
|
7077
5884
|
metadata?: {
|
@@ -7110,15 +5917,6 @@ export declare interface ContainerGetPropertiesHeaders {
|
|
7110
5917
|
/** Error Code */
|
7111
5918
|
errorCode?: string;
|
7112
5919
|
}
|
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
5920
|
/**
|
7123
5921
|
* Options to configure {@link ContainerClient.getProperties} operation.
|
7124
5922
|
*/
|
@@ -7135,9 +5933,13 @@ export declare interface ContainerGetPropertiesOptions extends CommonOptions {
|
|
7135
5933
|
conditions?: LeaseAccessConditions;
|
7136
5934
|
}
|
7137
5935
|
/** Contains response data for the getProperties operation. */
|
7138
|
-
export declare type ContainerGetPropertiesResponse =
|
7139
|
-
/**
|
7140
|
-
|
5936
|
+
export declare type ContainerGetPropertiesResponse = ContainerGetPropertiesHeaders & {
|
5937
|
+
/** The underlying HTTP response. */
|
5938
|
+
_response: coreHttp.HttpResponse & {
|
5939
|
+
/** The parsed HTTP response headers. */
|
5940
|
+
parsedHeaders: ContainerGetPropertiesHeaders;
|
5941
|
+
};
|
5942
|
+
};
|
7141
5943
|
/** An Azure Storage container */
|
7142
5944
|
export declare interface ContainerItem {
|
7143
5945
|
name: string;
|
@@ -7165,27 +5967,28 @@ export declare interface ContainerListBlobFlatSegmentHeaders {
|
|
7165
5967
|
/** Error Code */
|
7166
5968
|
errorCode?: string;
|
7167
5969
|
}
|
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
5970
|
/**
|
7184
5971
|
* Contains response data for the listBlobFlatSegment operation.
|
7185
5972
|
*/
|
7186
|
-
export declare type ContainerListBlobFlatSegmentResponse =
|
7187
|
-
/**
|
7188
|
-
|
5973
|
+
export declare type ContainerListBlobFlatSegmentResponse = ListBlobsFlatSegmentResponse & ContainerListBlobFlatSegmentHeaders & {
|
5974
|
+
/**
|
5975
|
+
* The underlying HTTP response.
|
5976
|
+
*/
|
5977
|
+
_response: HttpResponse & {
|
5978
|
+
/**
|
5979
|
+
* The parsed HTTP response headers.
|
5980
|
+
*/
|
5981
|
+
parsedHeaders: ContainerListBlobFlatSegmentHeaders;
|
5982
|
+
/**
|
5983
|
+
* The response body as text (string format)
|
5984
|
+
*/
|
5985
|
+
bodyAsText: string;
|
5986
|
+
/**
|
5987
|
+
* The response body as parsed JSON or XML
|
5988
|
+
*/
|
5989
|
+
parsedBody: ListBlobsFlatSegmentResponseModel;
|
5990
|
+
};
|
5991
|
+
};
|
7189
5992
|
/** Defines headers for Container_listBlobHierarchySegment operation. */
|
7190
5993
|
export declare interface ContainerListBlobHierarchySegmentHeaders {
|
7191
5994
|
/** The media type of the body of the response. For List Blobs this is 'application/xml' */
|
@@ -7201,27 +6004,28 @@ export declare interface ContainerListBlobHierarchySegmentHeaders {
|
|
7201
6004
|
/** Error Code */
|
7202
6005
|
errorCode?: string;
|
7203
6006
|
}
|
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
6007
|
/**
|
7220
6008
|
* Contains response data for the listBlobHierarchySegment operation.
|
7221
6009
|
*/
|
7222
|
-
export declare type ContainerListBlobHierarchySegmentResponse =
|
7223
|
-
/**
|
7224
|
-
|
6010
|
+
export declare type ContainerListBlobHierarchySegmentResponse = ListBlobsHierarchySegmentResponse & ContainerListBlobHierarchySegmentHeaders & {
|
6011
|
+
/**
|
6012
|
+
* The underlying HTTP response.
|
6013
|
+
*/
|
6014
|
+
_response: HttpResponse & {
|
6015
|
+
/**
|
6016
|
+
* The parsed HTTP response headers.
|
6017
|
+
*/
|
6018
|
+
parsedHeaders: ContainerListBlobHierarchySegmentHeaders;
|
6019
|
+
/**
|
6020
|
+
* The response body as text (string format)
|
6021
|
+
*/
|
6022
|
+
bodyAsText: string;
|
6023
|
+
/**
|
6024
|
+
* The response body as parsed JSON or XML
|
6025
|
+
*/
|
6026
|
+
parsedBody: ListBlobsHierarchySegmentResponseModel;
|
6027
|
+
};
|
6028
|
+
};
|
7225
6029
|
/**
|
7226
6030
|
* Options to configure Container - List Blobs operations.
|
7227
6031
|
*
|
@@ -7298,30 +6102,6 @@ export declare interface ContainerProperties {
|
|
7298
6102
|
/** Indicates if version level worm is enabled on this container. */
|
7299
6103
|
isImmutableStorageWithVersioningEnabled?: boolean;
|
7300
6104
|
}
|
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
6105
|
/**
|
7326
6106
|
* Options to configure Container - Release Lease operation.
|
7327
6107
|
*/
|
@@ -7336,42 +6116,8 @@ export declare interface ContainerReleaseLeaseOptions extends CommonOptions {
|
|
7336
6116
|
*/
|
7337
6117
|
conditions?: ModifiedAccessConditions;
|
7338
6118
|
}
|
7339
|
-
/**
|
7340
|
-
declare
|
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;
|
7362
|
-
}
|
7363
|
-
/** Contains response data for the rename operation. */
|
7364
|
-
export declare type ContainerRenameResponse = WithResponse<ContainerRenameHeaders, ContainerRenameHeaders>;
|
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;
|
6119
|
+
/** Defines headers for Container_rename operation. */
|
6120
|
+
export declare interface ContainerRenameHeaders {
|
7375
6121
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
7376
6122
|
clientRequestId?: string;
|
7377
6123
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
@@ -7380,16 +6126,17 @@ declare interface ContainerRenewLeaseHeaders {
|
|
7380
6126
|
version?: string;
|
7381
6127
|
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
7382
6128
|
date?: Date;
|
6129
|
+
/** Error Code */
|
6130
|
+
errorCode?: string;
|
7383
6131
|
}
|
7384
|
-
/**
|
7385
|
-
declare
|
7386
|
-
/**
|
7387
|
-
|
7388
|
-
|
7389
|
-
|
7390
|
-
|
7391
|
-
|
7392
|
-
}
|
6132
|
+
/** Contains response data for the rename operation. */
|
6133
|
+
export declare type ContainerRenameResponse = ContainerRenameHeaders & {
|
6134
|
+
/** The underlying HTTP response. */
|
6135
|
+
_response: coreHttp.HttpResponse & {
|
6136
|
+
/** The parsed HTTP response headers. */
|
6137
|
+
parsedHeaders: ContainerRenameHeaders;
|
6138
|
+
};
|
6139
|
+
};
|
7393
6140
|
/**
|
7394
6141
|
* Options to configure Container - Renew Lease operation.
|
7395
6142
|
*/
|
@@ -7404,26 +6151,11 @@ export declare interface ContainerRenewLeaseOptions extends CommonOptions {
|
|
7404
6151
|
*/
|
7405
6152
|
conditions?: ModifiedAccessConditions;
|
7406
6153
|
}
|
7407
|
-
/** Contains response data for the renewLease operation. */
|
7408
|
-
declare type ContainerRenewLeaseResponse = ContainerRenewLeaseHeaders;
|
7409
6154
|
/**
|
7410
6155
|
* Conditions to meet for the container.
|
7411
6156
|
*/
|
7412
6157
|
export declare interface ContainerRequestConditions extends LeaseAccessConditions, ModificationConditions {
|
7413
6158
|
}
|
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
6159
|
/**
|
7428
6160
|
* This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container.
|
7429
6161
|
* Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation.
|
@@ -7583,21 +6315,6 @@ export declare interface ContainerSetAccessPolicyHeaders {
|
|
7583
6315
|
/** Error Code */
|
7584
6316
|
errorCode?: string;
|
7585
6317
|
}
|
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
6318
|
/**
|
7602
6319
|
* Options to configure {@link ContainerClient.setAccessPolicy} operation.
|
7603
6320
|
*/
|
@@ -7613,9 +6330,13 @@ export declare interface ContainerSetAccessPolicyOptions extends CommonOptions {
|
|
7613
6330
|
conditions?: ContainerRequestConditions;
|
7614
6331
|
}
|
7615
6332
|
/** Contains response data for the setAccessPolicy operation. */
|
7616
|
-
export declare type ContainerSetAccessPolicyResponse =
|
7617
|
-
/**
|
7618
|
-
|
6333
|
+
export declare type ContainerSetAccessPolicyResponse = ContainerSetAccessPolicyHeaders & {
|
6334
|
+
/** The underlying HTTP response. */
|
6335
|
+
_response: coreHttp.HttpResponse & {
|
6336
|
+
/** The parsed HTTP response headers. */
|
6337
|
+
parsedHeaders: ContainerSetAccessPolicyHeaders;
|
6338
|
+
};
|
6339
|
+
};
|
7619
6340
|
/** Defines headers for Container_setMetadata operation. */
|
7620
6341
|
export declare interface ContainerSetMetadataHeaders {
|
7621
6342
|
/** 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 +6354,6 @@ export declare interface ContainerSetMetadataHeaders {
|
|
7633
6354
|
/** Error Code */
|
7634
6355
|
errorCode?: string;
|
7635
6356
|
}
|
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
6357
|
/**
|
7652
6358
|
* Options to configure {@link ContainerClient.setMetadata} operation.
|
7653
6359
|
*/
|
@@ -7664,41 +6370,12 @@ export declare interface ContainerSetMetadataOptions extends CommonOptions {
|
|
7664
6370
|
conditions?: ContainerRequestConditions;
|
7665
6371
|
}
|
7666
6372
|
/** 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;
|
6373
|
+
export declare type ContainerSetMetadataResponse = ContainerSetMetadataHeaders & {
|
6374
|
+
/** The underlying HTTP response. */
|
6375
|
+
_response: coreHttp.HttpResponse & {
|
6376
|
+
/** The parsed HTTP response headers. */
|
6377
|
+
parsedHeaders: ContainerSetMetadataHeaders;
|
6378
|
+
};
|
7702
6379
|
};
|
7703
6380
|
/** Defines headers for Container_restore operation. */
|
7704
6381
|
export declare interface ContainerUndeleteHeaders {
|
@@ -7714,7 +6391,13 @@ export declare interface ContainerUndeleteHeaders {
|
|
7714
6391
|
errorCode?: string;
|
7715
6392
|
}
|
7716
6393
|
/** Contains response data for the restore operation. */
|
7717
|
-
export declare type ContainerUndeleteResponse =
|
6394
|
+
export declare type ContainerUndeleteResponse = ContainerUndeleteHeaders & {
|
6395
|
+
/** The underlying HTTP response. */
|
6396
|
+
_response: coreHttp.HttpResponse & {
|
6397
|
+
/** The parsed HTTP response headers. */
|
6398
|
+
parsedHeaders: ContainerUndeleteHeaders;
|
6399
|
+
};
|
6400
|
+
};
|
7718
6401
|
/**
|
7719
6402
|
* Defines the operations from a {@link BlobClient} that are needed for the poller
|
7720
6403
|
* returned by {@link BlobClient.beginCopyFromURL} to work.
|
@@ -7785,24 +6468,12 @@ export declare abstract class CredentialPolicy extends BaseRequestPolicy {
|
|
7785
6468
|
export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, options: RequestPolicyOptions) => CredentialPolicy;
|
7786
6469
|
/** Defines values for DeleteSnapshotsOptionType. */
|
7787
6470
|
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
|
-
}
|
6471
|
+
export { deserializationPolicy };
|
7801
6472
|
/**
|
7802
6473
|
* Defines values for EncryptionAlgorithmType. \
|
7803
6474
|
* {@link KnownEncryptionAlgorithmType} can be used interchangeably with EncryptionAlgorithmType,
|
7804
6475
|
* this enum contains the known values that the service supports.
|
7805
|
-
* ###
|
6476
|
+
* ### Know values supported by the service
|
7806
6477
|
* **AES256**
|
7807
6478
|
*/
|
7808
6479
|
export declare type EncryptionAlgorithmType = string;
|
@@ -8004,43 +6675,13 @@ export declare interface HttpAuthorization {
|
|
8004
6675
|
export { HttpHeaders };
|
8005
6676
|
export { HttpOperationResponse };
|
8006
6677
|
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
|
-
}
|
6678
|
+
export { IHttpClient };
|
8026
6679
|
/**
|
8027
6680
|
* A helper to decide if a given argument satisfies the Pipeline contract
|
8028
6681
|
* @param pipeline - An argument that may be a Pipeline
|
8029
6682
|
* @returns true when the argument satisfies the Pipeline contract
|
8030
6683
|
*/
|
8031
6684
|
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
8032
|
-
/** json text configuration */
|
8033
|
-
declare interface JsonTextConfiguration {
|
8034
|
-
/** The string used to separate records. */
|
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;
|
8043
|
-
}
|
8044
6685
|
/**
|
8045
6686
|
* The details for a specific lease.
|
8046
6687
|
*/
|
@@ -8115,7 +6756,17 @@ export declare interface LeaseOperationOptions extends CommonOptions {
|
|
8115
6756
|
*
|
8116
6757
|
* See {@link BlobLeaseClient}.
|
8117
6758
|
*/
|
8118
|
-
export declare type LeaseOperationResponse =
|
6759
|
+
export declare type LeaseOperationResponse = Lease & {
|
6760
|
+
/**
|
6761
|
+
* The underlying HTTP response.
|
6762
|
+
*/
|
6763
|
+
_response: HttpResponse & {
|
6764
|
+
/**
|
6765
|
+
* The parsed HTTP response headers.
|
6766
|
+
*/
|
6767
|
+
parsedHeaders: Lease;
|
6768
|
+
};
|
6769
|
+
};
|
8119
6770
|
/** Defines values for LeaseStateType. */
|
8120
6771
|
export declare type LeaseStateType = "available" | "leased" | "expired" | "breaking" | "broken";
|
8121
6772
|
/** Defines values for LeaseStatusType. */
|
@@ -8133,16 +6784,6 @@ export declare interface ListBlobsFlatSegmentResponse {
|
|
8133
6784
|
continuationToken?: string;
|
8134
6785
|
}
|
8135
6786
|
/** 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
6787
|
export declare interface ListBlobsFlatSegmentResponseModel {
|
8147
6788
|
serviceEndpoint: string;
|
8148
6789
|
containerName: string;
|
@@ -8166,17 +6807,6 @@ export declare interface ListBlobsHierarchySegmentResponse {
|
|
8166
6807
|
continuationToken?: string;
|
8167
6808
|
}
|
8168
6809
|
/** 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
6810
|
export declare interface ListBlobsHierarchySegmentResponseModel {
|
8181
6811
|
serviceEndpoint: string;
|
8182
6812
|
containerName: string;
|
@@ -8187,10 +6817,6 @@ export declare interface ListBlobsHierarchySegmentResponseModel {
|
|
8187
6817
|
segment: BlobHierarchyListSegmentModel;
|
8188
6818
|
continuationToken?: string;
|
8189
6819
|
}
|
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
6820
|
/** An enumeration of containers */
|
8195
6821
|
export declare interface ListContainersSegmentResponse {
|
8196
6822
|
serviceEndpoint: string;
|
@@ -8326,82 +6952,6 @@ export declare interface ObjectReplicationRule {
|
|
8326
6952
|
* Object Replication Policy(s) applied. See {@link ObjectReplicationPolicy} and {@link ObjectReplicationRule}.
|
8327
6953
|
*/
|
8328
6954
|
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
6955
|
/** Defines headers for PageBlob_clearPages operation. */
|
8406
6956
|
export declare interface PageBlobClearPagesHeaders {
|
8407
6957
|
/** 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 +6975,6 @@ export declare interface PageBlobClearPagesHeaders {
|
|
8425
6975
|
/** Error Code */
|
8426
6976
|
errorCode?: string;
|
8427
6977
|
}
|
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
6978
|
/**
|
8448
6979
|
* Options to configure the {@link PageBlobClient.clearPages} operation.
|
8449
6980
|
*/
|
@@ -8470,9 +7001,13 @@ export declare interface PageBlobClearPagesOptions extends CommonOptions {
|
|
8470
7001
|
encryptionScope?: string;
|
8471
7002
|
}
|
8472
7003
|
/** Contains response data for the clearPages operation. */
|
8473
|
-
export declare type PageBlobClearPagesResponse =
|
8474
|
-
/**
|
8475
|
-
|
7004
|
+
export declare type PageBlobClearPagesResponse = PageBlobClearPagesHeaders & {
|
7005
|
+
/** The underlying HTTP response. */
|
7006
|
+
_response: coreHttp.HttpResponse & {
|
7007
|
+
/** The parsed HTTP response headers. */
|
7008
|
+
parsedHeaders: PageBlobClearPagesHeaders;
|
7009
|
+
};
|
7010
|
+
};
|
8476
7011
|
/**
|
8477
7012
|
* PageBlobClient defines a set of operations applicable to page blobs.
|
8478
7013
|
*/
|
@@ -8895,19 +7430,14 @@ export declare interface PageBlobCopyIncrementalHeaders {
|
|
8895
7430
|
/** Error Code */
|
8896
7431
|
errorCode?: string;
|
8897
7432
|
}
|
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
7433
|
/** Contains response data for the copyIncremental operation. */
|
8908
|
-
export declare type PageBlobCopyIncrementalResponse =
|
8909
|
-
/**
|
8910
|
-
|
7434
|
+
export declare type PageBlobCopyIncrementalResponse = PageBlobCopyIncrementalHeaders & {
|
7435
|
+
/** The underlying HTTP response. */
|
7436
|
+
_response: coreHttp.HttpResponse & {
|
7437
|
+
/** The parsed HTTP response headers. */
|
7438
|
+
parsedHeaders: PageBlobCopyIncrementalHeaders;
|
7439
|
+
};
|
7440
|
+
};
|
8911
7441
|
/** Defines headers for PageBlob_create operation. */
|
8912
7442
|
export declare interface PageBlobCreateHeaders {
|
8913
7443
|
/** 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 +7525,6 @@ export declare interface PageBlobCreateIfNotExistsResponse extends PageBlobCreat
|
|
8995
7525
|
*/
|
8996
7526
|
succeeded: boolean;
|
8997
7527
|
}
|
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
7528
|
/**
|
9032
7529
|
* Options to configure the {@link PageBlobClient.create} operation.
|
9033
7530
|
*/
|
@@ -9088,9 +7585,13 @@ export declare interface PageBlobCreateOptions extends CommonOptions {
|
|
9088
7585
|
tags?: Tags;
|
9089
7586
|
}
|
9090
7587
|
/** Contains response data for the create operation. */
|
9091
|
-
export declare type PageBlobCreateResponse =
|
9092
|
-
/**
|
9093
|
-
|
7588
|
+
export declare type PageBlobCreateResponse = PageBlobCreateHeaders & {
|
7589
|
+
/** The underlying HTTP response. */
|
7590
|
+
_response: coreHttp.HttpResponse & {
|
7591
|
+
/** The parsed HTTP response headers. */
|
7592
|
+
parsedHeaders: PageBlobCreateHeaders;
|
7593
|
+
};
|
7594
|
+
};
|
9094
7595
|
/** Defines headers for PageBlob_getPageRangesDiff operation. */
|
9095
7596
|
export declare interface PageBlobGetPageRangesDiffHeaders {
|
9096
7597
|
/** 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 +7611,6 @@ export declare interface PageBlobGetPageRangesDiffHeaders {
|
|
9110
7611
|
/** Error Code */
|
9111
7612
|
errorCode?: string;
|
9112
7613
|
}
|
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
7614
|
/**
|
9137
7615
|
* Options to configure the {@link PageBlobClient.getRangesDiff} operation.
|
9138
7616
|
*/
|
@@ -9154,12 +7632,37 @@ export declare interface PageBlobGetPageRangesDiffOptions extends CommonOptions
|
|
9154
7632
|
/**
|
9155
7633
|
* Contains response data for the {@link BlobClient.getPageRangesDiff} operation.
|
9156
7634
|
*/
|
9157
|
-
export declare interface PageBlobGetPageRangesDiffResponse extends PageList, PageBlobGetPageRangesDiffHeaders
|
7635
|
+
export declare interface PageBlobGetPageRangesDiffResponse extends PageList, PageBlobGetPageRangesDiffHeaders {
|
7636
|
+
/**
|
7637
|
+
* The underlying HTTP response.
|
7638
|
+
*/
|
7639
|
+
_response: HttpResponse & {
|
7640
|
+
/**
|
7641
|
+
* The parsed HTTP response headers.
|
7642
|
+
*/
|
7643
|
+
parsedHeaders: PageBlobGetPageRangesDiffHeaders;
|
7644
|
+
/**
|
7645
|
+
* The response body as text (string format)
|
7646
|
+
*/
|
7647
|
+
bodyAsText: string;
|
7648
|
+
/**
|
7649
|
+
* The response body as parsed JSON or XML
|
7650
|
+
*/
|
7651
|
+
parsedBody: PageList;
|
7652
|
+
};
|
9158
7653
|
}
|
9159
7654
|
/** Contains response data for the getPageRangesDiff operation. */
|
9160
|
-
export declare type
|
9161
|
-
/**
|
9162
|
-
|
7655
|
+
export declare type PageBlobGetPageRangesDiffResponseModel = PageBlobGetPageRangesDiffHeaders & PageList_2 & {
|
7656
|
+
/** The underlying HTTP response. */
|
7657
|
+
_response: coreHttp.HttpResponse & {
|
7658
|
+
/** The response body as text (string format) */
|
7659
|
+
bodyAsText: string;
|
7660
|
+
/** The response body as parsed JSON or XML */
|
7661
|
+
parsedBody: PageList_2;
|
7662
|
+
/** The parsed HTTP response headers. */
|
7663
|
+
parsedHeaders: PageBlobGetPageRangesDiffHeaders;
|
7664
|
+
};
|
7665
|
+
};
|
9163
7666
|
/** Defines headers for PageBlob_getPageRanges operation. */
|
9164
7667
|
export declare interface PageBlobGetPageRangesHeaders {
|
9165
7668
|
/** 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 +7682,6 @@ export declare interface PageBlobGetPageRangesHeaders {
|
|
9179
7682
|
/** Error Code */
|
9180
7683
|
errorCode?: string;
|
9181
7684
|
}
|
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
7685
|
/**
|
9202
7686
|
* Options to configure the {@link PageBlobClient.getPageRanges} operation.
|
9203
7687
|
*/
|
@@ -9215,12 +7699,37 @@ export declare interface PageBlobGetPageRangesOptions extends CommonOptions {
|
|
9215
7699
|
/**
|
9216
7700
|
* Contains response data for the {@link BlobClient.getPageRanges} operation.
|
9217
7701
|
*/
|
9218
|
-
export declare interface PageBlobGetPageRangesResponse extends PageList, PageBlobGetPageRangesHeaders
|
7702
|
+
export declare interface PageBlobGetPageRangesResponse extends PageList, PageBlobGetPageRangesHeaders {
|
7703
|
+
/**
|
7704
|
+
* The underlying HTTP response.
|
7705
|
+
*/
|
7706
|
+
_response: HttpResponse & {
|
7707
|
+
/**
|
7708
|
+
* The parsed HTTP response headers.
|
7709
|
+
*/
|
7710
|
+
parsedHeaders: PageBlobGetPageRangesHeaders;
|
7711
|
+
/**
|
7712
|
+
* The response body as text (string format)
|
7713
|
+
*/
|
7714
|
+
bodyAsText: string;
|
7715
|
+
/**
|
7716
|
+
* The response body as parsed JSON or XML
|
7717
|
+
*/
|
7718
|
+
parsedBody: PageList;
|
7719
|
+
};
|
9219
7720
|
}
|
9220
7721
|
/** Contains response data for the getPageRanges operation. */
|
9221
|
-
export declare type
|
9222
|
-
/**
|
9223
|
-
|
7722
|
+
export declare type PageBlobGetPageRangesResponseModel = PageBlobGetPageRangesHeaders & PageList_2 & {
|
7723
|
+
/** The underlying HTTP response. */
|
7724
|
+
_response: coreHttp.HttpResponse & {
|
7725
|
+
/** The response body as text (string format) */
|
7726
|
+
bodyAsText: string;
|
7727
|
+
/** The response body as parsed JSON or XML */
|
7728
|
+
parsedBody: PageList_2;
|
7729
|
+
/** The parsed HTTP response headers. */
|
7730
|
+
parsedHeaders: PageBlobGetPageRangesHeaders;
|
7731
|
+
};
|
7732
|
+
};
|
9224
7733
|
/**
|
9225
7734
|
* Options to configure the {@link PageBlobClient.listPageRangesDiff} operation.
|
9226
7735
|
*/
|
@@ -9273,21 +7782,6 @@ export declare interface PageBlobResizeHeaders {
|
|
9273
7782
|
/** Error Code */
|
9274
7783
|
errorCode?: string;
|
9275
7784
|
}
|
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
7785
|
/**
|
9292
7786
|
* Options to configure {@link PageBlobClient.resize} operation.
|
9293
7787
|
*/
|
@@ -9310,9 +7804,13 @@ export declare interface PageBlobResizeOptions extends CommonOptions {
|
|
9310
7804
|
encryptionScope?: string;
|
9311
7805
|
}
|
9312
7806
|
/** Contains response data for the resize operation. */
|
9313
|
-
export declare type PageBlobResizeResponse =
|
9314
|
-
/**
|
9315
|
-
|
7807
|
+
export declare type PageBlobResizeResponse = PageBlobResizeHeaders & {
|
7808
|
+
/** The underlying HTTP response. */
|
7809
|
+
_response: coreHttp.HttpResponse & {
|
7810
|
+
/** The parsed HTTP response headers. */
|
7811
|
+
parsedHeaders: PageBlobResizeHeaders;
|
7812
|
+
};
|
7813
|
+
};
|
9316
7814
|
/**
|
9317
7815
|
* Options to configure {@link PageBlobClient.startCopyIncremental} operation.
|
9318
7816
|
*/
|
@@ -9346,19 +7844,6 @@ export declare interface PageBlobUpdateSequenceNumberHeaders {
|
|
9346
7844
|
/** Error Code */
|
9347
7845
|
errorCode?: string;
|
9348
7846
|
}
|
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
7847
|
/**
|
9363
7848
|
* Options to configure {@link PageBlobClient.updateSequenceNumber} operation.
|
9364
7849
|
*/
|
@@ -9374,9 +7859,13 @@ export declare interface PageBlobUpdateSequenceNumberOptions extends CommonOptio
|
|
9374
7859
|
conditions?: BlobRequestConditions;
|
9375
7860
|
}
|
9376
7861
|
/** Contains response data for the updateSequenceNumber operation. */
|
9377
|
-
export declare type PageBlobUpdateSequenceNumberResponse =
|
9378
|
-
/**
|
9379
|
-
|
7862
|
+
export declare type PageBlobUpdateSequenceNumberResponse = PageBlobUpdateSequenceNumberHeaders & {
|
7863
|
+
/** The underlying HTTP response. */
|
7864
|
+
_response: coreHttp.HttpResponse & {
|
7865
|
+
/** The parsed HTTP response headers. */
|
7866
|
+
parsedHeaders: PageBlobUpdateSequenceNumberHeaders;
|
7867
|
+
};
|
7868
|
+
};
|
9380
7869
|
/** Defines headers for PageBlob_uploadPagesFromURL operation. */
|
9381
7870
|
export declare interface PageBlobUploadPagesFromURLHeaders {
|
9382
7871
|
/** 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 +7893,6 @@ export declare interface PageBlobUploadPagesFromURLHeaders {
|
|
9404
7893
|
/** Error Code */
|
9405
7894
|
errorCode?: string;
|
9406
7895
|
}
|
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
7896
|
/**
|
9433
7897
|
* Options to configure {@link PageBlobClient.uploadPagesFromURL} operation.
|
9434
7898
|
*/
|
@@ -9479,9 +7943,13 @@ export declare interface PageBlobUploadPagesFromURLOptions extends CommonOptions
|
|
9479
7943
|
sourceAuthorization?: HttpAuthorization;
|
9480
7944
|
}
|
9481
7945
|
/** Contains response data for the uploadPagesFromURL operation. */
|
9482
|
-
export declare type PageBlobUploadPagesFromURLResponse =
|
9483
|
-
/**
|
9484
|
-
|
7946
|
+
export declare type PageBlobUploadPagesFromURLResponse = PageBlobUploadPagesFromURLHeaders & {
|
7947
|
+
/** The underlying HTTP response. */
|
7948
|
+
_response: coreHttp.HttpResponse & {
|
7949
|
+
/** The parsed HTTP response headers. */
|
7950
|
+
parsedHeaders: PageBlobUploadPagesFromURLHeaders;
|
7951
|
+
};
|
7952
|
+
};
|
9485
7953
|
/** Defines headers for PageBlob_uploadPages operation. */
|
9486
7954
|
export declare interface PageBlobUploadPagesHeaders {
|
9487
7955
|
/** 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 +7979,6 @@ export declare interface PageBlobUploadPagesHeaders {
|
|
9511
7979
|
/** Error Code */
|
9512
7980
|
errorCode?: string;
|
9513
7981
|
}
|
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
7982
|
/**
|
9538
7983
|
* Options to configure the {@link PageBlobClient.uploadPages} operation.
|
9539
7984
|
*/
|
@@ -9578,9 +8023,13 @@ export declare interface PageBlobUploadPagesOptions extends CommonOptions {
|
|
9578
8023
|
encryptionScope?: string;
|
9579
8024
|
}
|
9580
8025
|
/** Contains response data for the uploadPages operation. */
|
9581
|
-
export declare type PageBlobUploadPagesResponse =
|
9582
|
-
/**
|
9583
|
-
|
8026
|
+
export declare type PageBlobUploadPagesResponse = PageBlobUploadPagesHeaders & {
|
8027
|
+
/** The underlying HTTP response. */
|
8028
|
+
_response: coreHttp.HttpResponse & {
|
8029
|
+
/** The parsed HTTP response headers. */
|
8030
|
+
parsedHeaders: PageBlobUploadPagesHeaders;
|
8031
|
+
};
|
8032
|
+
};
|
9584
8033
|
/**
|
9585
8034
|
* List of page ranges for a blob.
|
9586
8035
|
*/
|
@@ -9596,12 +8045,12 @@ export declare interface PageList {
|
|
9596
8045
|
clearRange?: Range_2[];
|
9597
8046
|
}
|
9598
8047
|
/** the list of pages */
|
9599
|
-
|
8048
|
+
declare interface PageList_2 {
|
9600
8049
|
pageRange?: PageRange[];
|
9601
8050
|
clearRange?: ClearRange[];
|
9602
8051
|
continuationToken?: string;
|
9603
8052
|
}
|
9604
|
-
|
8053
|
+
declare interface PageRange {
|
9605
8054
|
start: number;
|
9606
8055
|
end: number;
|
9607
8056
|
}
|
@@ -9691,7 +8140,7 @@ export declare interface PipelineOptions {
|
|
9691
8140
|
/**
|
9692
8141
|
* Optional. Configures the HTTP client to send requests and receive responses.
|
9693
8142
|
*/
|
9694
|
-
httpClient?:
|
8143
|
+
httpClient?: IHttpClient;
|
9695
8144
|
}
|
9696
8145
|
export { PollerLike };
|
9697
8146
|
/**
|
@@ -9807,32 +8256,6 @@ export declare enum PremiumPageBlobTier {
|
|
9807
8256
|
}
|
9808
8257
|
/** Defines values for PublicAccessType. */
|
9809
8258
|
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
8259
|
/**
|
9837
8260
|
* Range for Blob Service Operations.
|
9838
8261
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations
|
@@ -9851,57 +8274,9 @@ declare interface Range_2 {
|
|
9851
8274
|
export { Range_2 as Range };
|
9852
8275
|
/** Defines values for RehydratePriority. */
|
9853
8276
|
export declare type RehydratePriority = "High" | "Standard";
|
9854
|
-
export { RequestPolicy as IHttpClient };
|
9855
8277
|
export { RequestPolicy };
|
9856
8278
|
export { RequestPolicyFactory };
|
9857
8279
|
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
8280
|
export { RestError };
|
9906
8281
|
/** the retention policy which determines how long the associated data should persist */
|
9907
8282
|
export declare interface RetentionPolicy {
|
@@ -10218,75 +8593,6 @@ export declare interface SequenceNumberAccessConditions {
|
|
10218
8593
|
}
|
10219
8594
|
/** Defines values for SequenceNumberActionType. */
|
10220
8595
|
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
8596
|
/** Defines headers for Service_filterBlobs operation. */
|
10291
8597
|
export declare interface ServiceFilterBlobsHeaders {
|
10292
8598
|
/** 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 +8606,6 @@ export declare interface ServiceFilterBlobsHeaders {
|
|
10300
8606
|
/** Error Code */
|
10301
8607
|
errorCode?: string;
|
10302
8608
|
}
|
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
8609
|
/**
|
10319
8610
|
* Options to configure the {@link BlobServiceClient.findBlobsByTags} operation.
|
10320
8611
|
*/
|
@@ -10328,7 +8619,25 @@ export declare interface ServiceFindBlobByTagsOptions extends CommonOptions {
|
|
10328
8619
|
/**
|
10329
8620
|
* The response of {@link BlobServiceClient.findBlobsByTags} operation.
|
10330
8621
|
*/
|
10331
|
-
export declare type ServiceFindBlobsByTagsSegmentResponse =
|
8622
|
+
export declare type ServiceFindBlobsByTagsSegmentResponse = FilterBlobSegment & ServiceFilterBlobsHeaders & {
|
8623
|
+
/**
|
8624
|
+
* The underlying HTTP response.
|
8625
|
+
*/
|
8626
|
+
_response: HttpResponse & {
|
8627
|
+
/**
|
8628
|
+
* The parsed HTTP response headers.
|
8629
|
+
*/
|
8630
|
+
parsedHeaders: ServiceFilterBlobsHeaders;
|
8631
|
+
/**
|
8632
|
+
* The response body as text (string format)
|
8633
|
+
*/
|
8634
|
+
bodyAsText: string;
|
8635
|
+
/**
|
8636
|
+
* The response body as parsed JSON or XML
|
8637
|
+
*/
|
8638
|
+
parsedBody: FilterBlobSegmentModel;
|
8639
|
+
};
|
8640
|
+
};
|
10332
8641
|
/**
|
10333
8642
|
* Options to configure {@link BlobServiceClient.generateAccountSasUrl} operation.
|
10334
8643
|
*/
|
@@ -10374,9 +8683,6 @@ export declare interface ServiceGetAccountInfoHeaders {
|
|
10374
8683
|
/** Error Code */
|
10375
8684
|
errorCode?: string;
|
10376
8685
|
}
|
10377
|
-
/** Optional parameters. */
|
10378
|
-
declare interface ServiceGetAccountInfoOptionalParams extends coreClient.OperationOptions {
|
10379
|
-
}
|
10380
8686
|
/**
|
10381
8687
|
* Options to configure the {@link BlobServiceClient.getAccountInfo} operation.
|
10382
8688
|
*/
|
@@ -10388,9 +8694,13 @@ export declare interface ServiceGetAccountInfoOptions extends CommonOptions {
|
|
10388
8694
|
abortSignal?: AbortSignalLike;
|
10389
8695
|
}
|
10390
8696
|
/** Contains response data for the getAccountInfo operation. */
|
10391
|
-
export declare type ServiceGetAccountInfoResponse =
|
10392
|
-
/**
|
10393
|
-
|
8697
|
+
export declare type ServiceGetAccountInfoResponse = ServiceGetAccountInfoHeaders & {
|
8698
|
+
/** The underlying HTTP response. */
|
8699
|
+
_response: coreHttp.HttpResponse & {
|
8700
|
+
/** The parsed HTTP response headers. */
|
8701
|
+
parsedHeaders: ServiceGetAccountInfoHeaders;
|
8702
|
+
};
|
8703
|
+
};
|
10394
8704
|
/** Defines headers for Service_getProperties operation. */
|
10395
8705
|
export declare interface ServiceGetPropertiesHeaders {
|
10396
8706
|
/** 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 +8712,6 @@ export declare interface ServiceGetPropertiesHeaders {
|
|
10402
8712
|
/** Error Code */
|
10403
8713
|
errorCode?: string;
|
10404
8714
|
}
|
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
8715
|
/**
|
10413
8716
|
* Options to configure the {@link BlobServiceClient.getProperties} operation.
|
10414
8717
|
*/
|
@@ -10420,9 +8723,17 @@ export declare interface ServiceGetPropertiesOptions extends CommonOptions {
|
|
10420
8723
|
abortSignal?: AbortSignalLike;
|
10421
8724
|
}
|
10422
8725
|
/** Contains response data for the getProperties operation. */
|
10423
|
-
export declare type ServiceGetPropertiesResponse =
|
10424
|
-
/**
|
10425
|
-
|
8726
|
+
export declare type ServiceGetPropertiesResponse = ServiceGetPropertiesHeaders & BlobServiceProperties & {
|
8727
|
+
/** The underlying HTTP response. */
|
8728
|
+
_response: coreHttp.HttpResponse & {
|
8729
|
+
/** The response body as text (string format) */
|
8730
|
+
bodyAsText: string;
|
8731
|
+
/** The response body as parsed JSON or XML */
|
8732
|
+
parsedBody: BlobServiceProperties;
|
8733
|
+
/** The parsed HTTP response headers. */
|
8734
|
+
parsedHeaders: ServiceGetPropertiesHeaders;
|
8735
|
+
};
|
8736
|
+
};
|
10426
8737
|
/** Defines headers for Service_getStatistics operation. */
|
10427
8738
|
export declare interface ServiceGetStatisticsHeaders {
|
10428
8739
|
/** 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 +8747,6 @@ export declare interface ServiceGetStatisticsHeaders {
|
|
10436
8747
|
/** Error Code */
|
10437
8748
|
errorCode?: string;
|
10438
8749
|
}
|
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
8750
|
/**
|
10447
8751
|
* Options to configure the {@link BlobServiceClient.getStatistics} operation.
|
10448
8752
|
*/
|
@@ -10454,9 +8758,17 @@ export declare interface ServiceGetStatisticsOptions extends CommonOptions {
|
|
10454
8758
|
abortSignal?: AbortSignalLike;
|
10455
8759
|
}
|
10456
8760
|
/** Contains response data for the getStatistics operation. */
|
10457
|
-
export declare type ServiceGetStatisticsResponse =
|
10458
|
-
/**
|
10459
|
-
|
8761
|
+
export declare type ServiceGetStatisticsResponse = ServiceGetStatisticsHeaders & BlobServiceStatistics & {
|
8762
|
+
/** The underlying HTTP response. */
|
8763
|
+
_response: coreHttp.HttpResponse & {
|
8764
|
+
/** The response body as text (string format) */
|
8765
|
+
bodyAsText: string;
|
8766
|
+
/** The response body as parsed JSON or XML */
|
8767
|
+
parsedBody: BlobServiceStatistics;
|
8768
|
+
/** The parsed HTTP response headers. */
|
8769
|
+
parsedHeaders: ServiceGetStatisticsHeaders;
|
8770
|
+
};
|
8771
|
+
};
|
10460
8772
|
/** Defines headers for Service_getUserDelegationKey operation. */
|
10461
8773
|
export declare interface ServiceGetUserDelegationKeyHeaders {
|
10462
8774
|
/** 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 +8782,6 @@ export declare interface ServiceGetUserDelegationKeyHeaders {
|
|
10470
8782
|
/** Error Code */
|
10471
8783
|
errorCode?: string;
|
10472
8784
|
}
|
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
8785
|
/**
|
10481
8786
|
* Options to configure the Service - Get User Delegation Key.
|
10482
8787
|
*/
|
@@ -10490,9 +8795,25 @@ export declare interface ServiceGetUserDelegationKeyOptions extends CommonOption
|
|
10490
8795
|
/**
|
10491
8796
|
* Contains response data for the {@link getUserDelegationKey} operation.
|
10492
8797
|
*/
|
10493
|
-
export declare type ServiceGetUserDelegationKeyResponse =
|
10494
|
-
/**
|
10495
|
-
|
8798
|
+
export declare type ServiceGetUserDelegationKeyResponse = UserDelegationKey & ServiceGetUserDelegationKeyHeaders & {
|
8799
|
+
/**
|
8800
|
+
* The underlying HTTP response.
|
8801
|
+
*/
|
8802
|
+
_response: HttpResponse & {
|
8803
|
+
/**
|
8804
|
+
* The parsed HTTP response headers.
|
8805
|
+
*/
|
8806
|
+
parsedHeaders: ServiceGetUserDelegationKeyHeaders;
|
8807
|
+
/**
|
8808
|
+
* The response body as text (string format)
|
8809
|
+
*/
|
8810
|
+
bodyAsText: string;
|
8811
|
+
/**
|
8812
|
+
* The response body as parsed JSON or XML
|
8813
|
+
*/
|
8814
|
+
parsedBody: UserDelegationKeyModel;
|
8815
|
+
};
|
8816
|
+
};
|
10496
8817
|
/**
|
10497
8818
|
* Options to configure the {@link BlobServiceClient.listContainers} operation.
|
10498
8819
|
*/
|
@@ -10532,25 +8853,18 @@ export declare interface ServiceListContainersSegmentHeaders {
|
|
10532
8853
|
/** Error Code */
|
10533
8854
|
errorCode?: string;
|
10534
8855
|
}
|
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
8856
|
/** Contains response data for the listContainersSegment operation. */
|
10551
|
-
export declare type ServiceListContainersSegmentResponse =
|
10552
|
-
/**
|
10553
|
-
|
8857
|
+
export declare type ServiceListContainersSegmentResponse = ServiceListContainersSegmentHeaders & ListContainersSegmentResponse & {
|
8858
|
+
/** The underlying HTTP response. */
|
8859
|
+
_response: coreHttp.HttpResponse & {
|
8860
|
+
/** The response body as text (string format) */
|
8861
|
+
bodyAsText: string;
|
8862
|
+
/** The response body as parsed JSON or XML */
|
8863
|
+
parsedBody: ListContainersSegmentResponse;
|
8864
|
+
/** The parsed HTTP response headers. */
|
8865
|
+
parsedHeaders: ServiceListContainersSegmentHeaders;
|
8866
|
+
};
|
8867
|
+
};
|
10554
8868
|
/**
|
10555
8869
|
* Options to configure {@link BlobServiceClient.renameContainer} operation.
|
10556
8870
|
*/
|
@@ -10576,13 +8890,6 @@ export declare interface ServiceSetPropertiesHeaders {
|
|
10576
8890
|
/** Error Code */
|
10577
8891
|
errorCode?: string;
|
10578
8892
|
}
|
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
8893
|
/**
|
10587
8894
|
* Options to configure the {@link BlobServiceClient.setProperties} operation.
|
10588
8895
|
*/
|
@@ -10594,9 +8901,13 @@ export declare interface ServiceSetPropertiesOptions extends CommonOptions {
|
|
10594
8901
|
abortSignal?: AbortSignalLike;
|
10595
8902
|
}
|
10596
8903
|
/** Contains response data for the setProperties operation. */
|
10597
|
-
export declare type ServiceSetPropertiesResponse =
|
10598
|
-
/**
|
10599
|
-
|
8904
|
+
export declare type ServiceSetPropertiesResponse = ServiceSetPropertiesHeaders & {
|
8905
|
+
/** The underlying HTTP response. */
|
8906
|
+
_response: coreHttp.HttpResponse & {
|
8907
|
+
/** The parsed HTTP response headers. */
|
8908
|
+
parsedHeaders: ServiceSetPropertiesHeaders;
|
8909
|
+
};
|
8910
|
+
};
|
10600
8911
|
/** Defines headers for Service_submitBatch operation. */
|
10601
8912
|
export declare interface ServiceSubmitBatchHeaders {
|
10602
8913
|
/** The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID */
|
@@ -10611,14 +8922,14 @@ export declare interface ServiceSubmitBatchHeaders {
|
|
10611
8922
|
errorCode?: string;
|
10612
8923
|
}
|
10613
8924
|
/** Optional parameters. */
|
10614
|
-
export declare interface ServiceSubmitBatchOptionalParamsModel extends
|
8925
|
+
export declare interface ServiceSubmitBatchOptionalParamsModel extends coreHttp.OperationOptions {
|
10615
8926
|
/** 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
8927
|
timeoutInSeconds?: number;
|
10617
8928
|
/** 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
8929
|
requestId?: string;
|
10619
8930
|
}
|
10620
8931
|
/** Contains response data for the submitBatch operation. */
|
10621
|
-
export declare type
|
8932
|
+
export declare type ServiceSubmitBatchResponseModel = ServiceSubmitBatchHeaders & {
|
10622
8933
|
/**
|
10623
8934
|
* BROWSER ONLY
|
10624
8935
|
*
|
@@ -10633,9 +8944,12 @@ export declare type ServiceSubmitBatchResponseInternal = ServiceSubmitBatchHeade
|
|
10633
8944
|
* Always `undefined` in the browser.
|
10634
8945
|
*/
|
10635
8946
|
readableStreamBody?: NodeJS.ReadableStream;
|
8947
|
+
/** The underlying HTTP response. */
|
8948
|
+
_response: coreHttp.HttpResponse & {
|
8949
|
+
/** The parsed HTTP response headers. */
|
8950
|
+
parsedHeaders: ServiceSubmitBatchHeaders;
|
8951
|
+
};
|
10636
8952
|
};
|
10637
|
-
/** Contains response data for the submitBatch operation. */
|
10638
|
-
export declare type ServiceSubmitBatchResponseModel = WithResponse<ServiceSubmitBatchResponseInternal, ServiceSubmitBatchHeaders>;
|
10639
8953
|
/**
|
10640
8954
|
* Options to configure {@link BlobServiceClient.undeleteContainer} operation.
|
10641
8955
|
*/
|
@@ -10688,19 +9002,6 @@ export declare interface SignedIdentifierModel {
|
|
10688
9002
|
}
|
10689
9003
|
/** Defines values for SkuName. */
|
10690
9004
|
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
9005
|
/** The properties that enable an account to host a static website */
|
10705
9006
|
export declare interface StaticWebsite {
|
10706
9007
|
/** Indicates whether this account is hosting a static website */
|
@@ -10781,7 +9082,7 @@ declare abstract class StorageClient {
|
|
10781
9082
|
* StorageClient is a reference to protocol layer operations entry, which is
|
10782
9083
|
* generated by AutoRest generator.
|
10783
9084
|
*/
|
10784
|
-
protected readonly storageClientContext:
|
9085
|
+
protected readonly storageClientContext: StorageClientContext;
|
10785
9086
|
/**
|
10786
9087
|
*/
|
10787
9088
|
protected readonly isHttps: boolean;
|
@@ -10792,25 +9093,19 @@ declare abstract class StorageClient {
|
|
10792
9093
|
*/
|
10793
9094
|
protected constructor(url: string, pipeline: PipelineLike);
|
10794
9095
|
}
|
10795
|
-
declare class
|
9096
|
+
declare class StorageClientContext extends coreHttp.ServiceClient {
|
10796
9097
|
url: string;
|
10797
9098
|
version: string;
|
10798
9099
|
/**
|
10799
|
-
* Initializes a new instance of the
|
9100
|
+
* Initializes a new instance of the StorageClientContext class.
|
10800
9101
|
* @param url The URL of the service account, container, or blob that is the target of the desired
|
10801
9102
|
* operation.
|
10802
9103
|
* @param options The parameter options
|
10803
9104
|
*/
|
10804
9105
|
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
9106
|
}
|
10812
9107
|
/** Optional parameters. */
|
10813
|
-
declare interface StorageClientOptionalParams extends
|
9108
|
+
declare interface StorageClientOptionalParams extends coreHttp.ServiceClientOptions {
|
10814
9109
|
/** Specifies the version of the operation to use for this request. */
|
10815
9110
|
version?: string;
|
10816
9111
|
/** Overrides client endpoint. */
|
@@ -10827,11 +9122,11 @@ export declare interface StoragePipelineOptions {
|
|
10827
9122
|
/**
|
10828
9123
|
* Options to configure a proxy for outgoing requests.
|
10829
9124
|
*/
|
10830
|
-
proxyOptions?:
|
9125
|
+
proxyOptions?: ProxyOptions;
|
10831
9126
|
/**
|
10832
9127
|
* Options for adding user agent details to outgoing requests.
|
10833
9128
|
*/
|
10834
|
-
userAgentOptions?:
|
9129
|
+
userAgentOptions?: UserAgentOptions;
|
10835
9130
|
/**
|
10836
9131
|
* Configures the built-in retry policy behavior.
|
10837
9132
|
*/
|
@@ -10843,7 +9138,7 @@ export declare interface StoragePipelineOptions {
|
|
10843
9138
|
/**
|
10844
9139
|
* Configures the HTTP client to send requests and receive responses.
|
10845
9140
|
*/
|
10846
|
-
httpClient?:
|
9141
|
+
httpClient?: IHttpClient;
|
10847
9142
|
/**
|
10848
9143
|
* The audience used to retrieve an AAD token.
|
10849
9144
|
*/
|
@@ -11058,6 +9353,8 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
11058
9353
|
*/
|
11059
9354
|
private getCanonicalizedResourceString;
|
11060
9355
|
}
|
9356
|
+
/** Defines values for SyncCopyStatusType. */
|
9357
|
+
export declare type SyncCopyStatusType = "success";
|
11061
9358
|
/**
|
11062
9359
|
* Specifies HTTP options for conditional requests based on blob tags.
|
11063
9360
|
*/
|
@@ -11122,8 +9419,4 @@ export declare interface UserDelegationKeyModel {
|
|
11122
9419
|
value: string;
|
11123
9420
|
}
|
11124
9421
|
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
9422
|
export {};
|