@azure/storage-blob 12.13.0-beta.1 → 12.20.0-alpha.20230303.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 +13661 -14216
- 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 +3 -2
- package/dist-esm/storage-blob/src/BatchResponseParser.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobBatch.js +74 -87
- package/dist-esm/storage-blob/src/BlobBatch.js.map +1 -1
- package/dist-esm/storage-blob/src/BlobBatchClient.js +10 -23
- 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 +54 -83
- 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 +67 -165
- package/dist-esm/storage-blob/src/BlobServiceClient.js.map +1 -1
- package/dist-esm/storage-blob/src/Clients.js +651 -889
- package/dist-esm/storage-blob/src/Clients.js.map +1 -1
- package/dist-esm/storage-blob/src/ContainerClient.js +115 -238
- 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 +194 -40
- 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 +4 -17
- 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/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 +248 -1
- 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 +13 -11
- 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 +11 -27
- 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 +28 -110
- 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 +16 -43
- 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 +22 -86
- 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 +16 -54
- 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 +12 -42
- package/dist-esm/storage-blob/src/generated/src/operations/service.js.map +1 -1
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/appendBlob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/blockBlob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/container.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js +14 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/index.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/pageBlob.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js +9 -0
- package/dist-esm/storage-blob/src/generated/src/operationsInterfaces/service.js.map +1 -0
- package/dist-esm/storage-blob/src/generated/src/storageClient.js +32 -10
- package/dist-esm/storage-blob/src/generated/src/storageClient.js.map +1 -1
- package/dist-esm/storage-blob/src/generatedModels.js.map +1 -1
- package/dist-esm/storage-blob/src/index.browser.js +3 -2
- package/dist-esm/storage-blob/src/index.browser.js.map +1 -1
- package/dist-esm/storage-blob/src/index.js +3 -2
- 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/PathParameterWorkaroundPolicy.js +25 -0
- package/dist-esm/storage-blob/src/policies/PathParameterWorkaroundPolicy.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/RequestPolicy.js +40 -0
- package/dist-esm/storage-blob/src/policies/RequestPolicy.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js +2 -1
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js +31 -0
- package/dist-esm/storage-blob/src/policies/StorageBrowserPolicyV2.js.map +1 -0
- 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/StorageRetryPolicyV2.js +165 -0
- package/dist-esm/storage-blob/src/policies/StorageRetryPolicyV2.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicy.js.map +1 -1
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js +18 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.browser.js.map +1 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.js +131 -0
- package/dist-esm/storage-blob/src/policies/StorageSharedKeyCredentialPolicyV2.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 +10 -2
- package/dist-esm/storage-blob/src/utils/RetriableReadableStream.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/cache.js +5 -2
- 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 +5 -18
- package/dist-esm/storage-blob/src/utils/tracing.js.map +1 -1
- package/dist-esm/storage-blob/src/utils/utils.common.js +83 -42
- package/dist-esm/storage-blob/src/utils/utils.common.js.map +1 -1
- package/package.json +22 -15
- package/types/3.1/storage-blob.d.ts +2311 -604
- package/types/latest/storage-blob.d.ts +2612 -725
- package/dist-esm/storage-blob/src/TelemetryPolicyFactory.js +0 -50
- package/dist-esm/storage-blob/src/TelemetryPolicyFactory.js.map +0 -1
- package/dist-esm/storage-blob/src/generated/src/storageClientContext.js +0 -39
- package/dist-esm/storage-blob/src/generated/src/storageClientContext.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/StorageBearerTokenChallengeAuthenticationPolicy.js +0 -245
- package/dist-esm/storage-blob/src/policies/StorageBearerTokenChallengeAuthenticationPolicy.js.map +0 -1
- package/dist-esm/storage-blob/src/policies/TelemetryPolicy.js +0 -36
- package/dist-esm/storage-blob/src/policies/TelemetryPolicy.js.map +0 -1
@@ -2,31 +2,29 @@
|
|
2
2
|
|
3
3
|
import { AbortSignalLike } from '@azure/abort-controller';
|
4
4
|
import { AzureLogger } from '@azure/logger';
|
5
|
-
import { BaseRequestPolicy } from '@azure/core-http';
|
6
5
|
import { CancelOnProgress } from '@azure/core-lro';
|
7
|
-
import * as
|
8
|
-
import
|
9
|
-
import
|
10
|
-
import {
|
11
|
-
import {
|
12
|
-
import {
|
13
|
-
import {
|
14
|
-
import { KeepAliveOptions } from '@azure/core-http';
|
6
|
+
import * as coreClient from '@azure/core-client';
|
7
|
+
import * as coreHttpCompat from '@azure/core-http-compat';
|
8
|
+
import * as coreRestPipeline from '@azure/core-rest-pipeline';
|
9
|
+
import { HttpHeadersLike as HttpHeaders } from '@azure/core-http-compat';
|
10
|
+
import { CompatResponse as HttpOperationResponse } from '@azure/core-http-compat';
|
11
|
+
import { HttpPipelineLogLevel } from '@azure/core-http-compat';
|
12
|
+
import { RequestBodyType as HttpRequestBody } from '@azure/core-rest-pipeline';
|
13
|
+
import { KeepAliveOptions } from '@azure/core-http-compat';
|
15
14
|
import { OperationTracingOptions } from '@azure/core-tracing';
|
16
15
|
import { PagedAsyncIterableIterator } from '@azure/core-paging';
|
17
16
|
import { PollerLike } from '@azure/core-lro';
|
18
17
|
import { PollOperationState } from '@azure/core-lro';
|
19
|
-
import {
|
18
|
+
import { ProxySettings } from '@azure/core-rest-pipeline';
|
20
19
|
import { Readable } from 'stream';
|
21
|
-
import { RequestPolicy } from '@azure/core-http';
|
22
|
-
import { RequestPolicyFactory } from '@azure/core-http';
|
23
|
-
import { RequestPolicyOptions } from '@azure/core-http';
|
24
|
-
import { RestError } from '@azure/core-
|
25
|
-
import {
|
26
|
-
import {
|
27
|
-
import {
|
28
|
-
import {
|
29
|
-
import { WebResource } from '@azure/core-http';
|
20
|
+
import { RequestPolicy } from '@azure/core-http-compat';
|
21
|
+
import { RequestPolicyFactory } from '@azure/core-http-compat';
|
22
|
+
import { RequestPolicyOptionsLike as RequestPolicyOptions } from '@azure/core-http-compat';
|
23
|
+
import { RestError } from '@azure/core-rest-pipeline';
|
24
|
+
import { TokenCredential } from '@azure/core-auth';
|
25
|
+
import { TransferProgressEvent } from '@azure/core-rest-pipeline';
|
26
|
+
import { UserAgentPolicyOptions } from '@azure/core-rest-pipeline';
|
27
|
+
import { WebResourceLike as WebResource } from '@azure/core-http-compat';
|
30
28
|
|
31
29
|
/** An Access policy */
|
32
30
|
export declare interface AccessPolicy {
|
@@ -355,6 +353,41 @@ export declare class AnonymousCredentialPolicy extends CredentialPolicy {
|
|
355
353
|
constructor(nextPolicy: RequestPolicy, options: RequestPolicyOptions);
|
356
354
|
}
|
357
355
|
|
356
|
+
/** Interface representing a AppendBlob. */
|
357
|
+
declare interface AppendBlob {
|
358
|
+
/**
|
359
|
+
* The Create Append Blob operation creates a new append blob.
|
360
|
+
* @param contentLength The length of the request.
|
361
|
+
* @param options The options parameters.
|
362
|
+
*/
|
363
|
+
create(contentLength: number, options?: AppendBlobCreateOptionalParams): Promise<AppendBlobCreateResponse_2>;
|
364
|
+
/**
|
365
|
+
* The Append Block operation commits a new block of data to the end of an existing append blob. The
|
366
|
+
* Append Block operation is permitted only if the blob was created with x-ms-blob-type set to
|
367
|
+
* AppendBlob. Append Block is supported only on version 2015-02-21 version or later.
|
368
|
+
* @param contentLength The length of the request.
|
369
|
+
* @param body Initial data
|
370
|
+
* @param options The options parameters.
|
371
|
+
*/
|
372
|
+
appendBlock(contentLength: number, body: coreRestPipeline.RequestBodyType, options?: AppendBlobAppendBlockOptionalParams): Promise<AppendBlobAppendBlockResponse_2>;
|
373
|
+
/**
|
374
|
+
* The Append Block operation commits a new block of data to the end of an existing append blob where
|
375
|
+
* the contents are read from a source url. The Append Block operation is permitted only if the blob
|
376
|
+
* was created with x-ms-blob-type set to AppendBlob. Append Block is supported only on version
|
377
|
+
* 2015-02-21 version or later.
|
378
|
+
* @param sourceUrl Specify a URL to the copy source.
|
379
|
+
* @param contentLength The length of the request.
|
380
|
+
* @param options The options parameters.
|
381
|
+
*/
|
382
|
+
appendBlockFromUrl(sourceUrl: string, contentLength: number, options?: AppendBlobAppendBlockFromUrlOptionalParams): Promise<AppendBlobAppendBlockFromUrlResponse_2>;
|
383
|
+
/**
|
384
|
+
* The Seal operation seals the Append Blob to make it read-only. Seal is supported only on version
|
385
|
+
* 2019-12-12 version or later.
|
386
|
+
* @param options The options parameters.
|
387
|
+
*/
|
388
|
+
seal(options?: AppendBlobSealOptionalParams): Promise<AppendBlobSealResponse>;
|
389
|
+
}
|
390
|
+
|
358
391
|
/** Defines headers for AppendBlob_appendBlockFromUrl operation. */
|
359
392
|
export declare interface AppendBlobAppendBlockFromUrlHeaders {
|
360
393
|
/** 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. */
|
@@ -385,6 +418,36 @@ export declare interface AppendBlobAppendBlockFromUrlHeaders {
|
|
385
418
|
errorCode?: string;
|
386
419
|
}
|
387
420
|
|
421
|
+
/** Optional parameters. */
|
422
|
+
declare interface AppendBlobAppendBlockFromUrlOptionalParams extends coreClient.OperationOptions {
|
423
|
+
/** Parameter group */
|
424
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
425
|
+
/** Parameter group */
|
426
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
427
|
+
/** Parameter group */
|
428
|
+
cpkInfo?: CpkInfo;
|
429
|
+
/** Parameter group */
|
430
|
+
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
431
|
+
/** Parameter group */
|
432
|
+
appendPositionAccessConditions?: AppendPositionAccessConditions;
|
433
|
+
/** 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> */
|
434
|
+
timeoutInSeconds?: number;
|
435
|
+
/** 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. */
|
436
|
+
requestId?: string;
|
437
|
+
/** 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. */
|
438
|
+
encryptionScope?: string;
|
439
|
+
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
440
|
+
sourceContentMD5?: Uint8Array;
|
441
|
+
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
442
|
+
copySourceAuthorization?: string;
|
443
|
+
/** Specify the transactional md5 for the body, to be validated by the service. */
|
444
|
+
transactionalContentMD5?: Uint8Array;
|
445
|
+
/** Specify the crc64 calculated for the range of bytes that must be read from the copy source. */
|
446
|
+
sourceContentCrc64?: Uint8Array;
|
447
|
+
/** Bytes of source data in the specified range. */
|
448
|
+
sourceRange?: string;
|
449
|
+
}
|
450
|
+
|
388
451
|
/**
|
389
452
|
* Options to configure the {@link AppendBlobClient.appendBlockFromURL} operation.
|
390
453
|
*/
|
@@ -436,13 +499,10 @@ export declare interface AppendBlobAppendBlockFromURLOptions extends CommonOptio
|
|
436
499
|
}
|
437
500
|
|
438
501
|
/** Contains response data for the appendBlockFromUrl operation. */
|
439
|
-
export declare type AppendBlobAppendBlockFromUrlResponse = AppendBlobAppendBlockFromUrlHeaders
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
parsedHeaders: AppendBlobAppendBlockFromUrlHeaders;
|
444
|
-
};
|
445
|
-
};
|
502
|
+
export declare type AppendBlobAppendBlockFromUrlResponse = WithResponse<AppendBlobAppendBlockFromUrlHeaders, AppendBlobAppendBlockFromUrlHeaders>;
|
503
|
+
|
504
|
+
/** Contains response data for the appendBlockFromUrl operation. */
|
505
|
+
declare type AppendBlobAppendBlockFromUrlResponse_2 = AppendBlobAppendBlockFromUrlHeaders;
|
446
506
|
|
447
507
|
/** Defines headers for AppendBlob_appendBlock operation. */
|
448
508
|
export declare interface AppendBlobAppendBlockHeaders {
|
@@ -476,6 +536,28 @@ export declare interface AppendBlobAppendBlockHeaders {
|
|
476
536
|
errorCode?: string;
|
477
537
|
}
|
478
538
|
|
539
|
+
/** Optional parameters. */
|
540
|
+
declare interface AppendBlobAppendBlockOptionalParams extends coreClient.OperationOptions {
|
541
|
+
/** Parameter group */
|
542
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
543
|
+
/** Parameter group */
|
544
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
545
|
+
/** Parameter group */
|
546
|
+
cpkInfo?: CpkInfo;
|
547
|
+
/** Parameter group */
|
548
|
+
appendPositionAccessConditions?: AppendPositionAccessConditions;
|
549
|
+
/** 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> */
|
550
|
+
timeoutInSeconds?: number;
|
551
|
+
/** 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. */
|
552
|
+
requestId?: string;
|
553
|
+
/** 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. */
|
554
|
+
encryptionScope?: string;
|
555
|
+
/** Specify the transactional md5 for the body, to be validated by the service. */
|
556
|
+
transactionalContentMD5?: Uint8Array;
|
557
|
+
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
558
|
+
transactionalContentCrc64?: Uint8Array;
|
559
|
+
}
|
560
|
+
|
479
561
|
/**
|
480
562
|
* Options to configure the {@link AppendBlobClient.appendBlock} operation.
|
481
563
|
*/
|
@@ -521,13 +603,10 @@ export declare interface AppendBlobAppendBlockOptions extends CommonOptions {
|
|
521
603
|
}
|
522
604
|
|
523
605
|
/** Contains response data for the appendBlock operation. */
|
524
|
-
export declare type AppendBlobAppendBlockResponse = AppendBlobAppendBlockHeaders
|
525
|
-
|
526
|
-
|
527
|
-
|
528
|
-
parsedHeaders: AppendBlobAppendBlockHeaders;
|
529
|
-
};
|
530
|
-
};
|
606
|
+
export declare type AppendBlobAppendBlockResponse = WithResponse<AppendBlobAppendBlockHeaders, AppendBlobAppendBlockHeaders>;
|
607
|
+
|
608
|
+
/** Contains response data for the appendBlock operation. */
|
609
|
+
declare type AppendBlobAppendBlockResponse_2 = AppendBlobAppendBlockHeaders;
|
531
610
|
|
532
611
|
/**
|
533
612
|
* AppendBlobClient defines a set of operations applicable to append blobs.
|
@@ -751,6 +830,36 @@ export declare interface AppendBlobCreateIfNotExistsResponse extends AppendBlobC
|
|
751
830
|
succeeded: boolean;
|
752
831
|
}
|
753
832
|
|
833
|
+
/** Optional parameters. */
|
834
|
+
declare interface AppendBlobCreateOptionalParams extends coreClient.OperationOptions {
|
835
|
+
/** Parameter group */
|
836
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
837
|
+
/** Parameter group */
|
838
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
839
|
+
/** Parameter group */
|
840
|
+
cpkInfo?: CpkInfo;
|
841
|
+
/** Parameter group */
|
842
|
+
blobHttpHeaders?: BlobHTTPHeaders;
|
843
|
+
/** 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> */
|
844
|
+
timeoutInSeconds?: number;
|
845
|
+
/** 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. */
|
846
|
+
requestId?: string;
|
847
|
+
/** 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. */
|
848
|
+
metadata?: {
|
849
|
+
[propertyName: string]: string;
|
850
|
+
};
|
851
|
+
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
852
|
+
immutabilityPolicyExpiry?: Date;
|
853
|
+
/** Specifies the immutability policy mode to set on the blob. */
|
854
|
+
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
855
|
+
/** 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. */
|
856
|
+
encryptionScope?: string;
|
857
|
+
/** Optional. Used to set blob tags in various blob operations. */
|
858
|
+
blobTagsString?: string;
|
859
|
+
/** Specified if a legal hold should be set on the blob. */
|
860
|
+
legalHold?: boolean;
|
861
|
+
}
|
862
|
+
|
754
863
|
/**
|
755
864
|
* Options to configure {@link AppendBlobClient.create} operation.
|
756
865
|
*/
|
@@ -805,13 +914,10 @@ export declare interface AppendBlobCreateOptions extends CommonOptions {
|
|
805
914
|
}
|
806
915
|
|
807
916
|
/** Contains response data for the create operation. */
|
808
|
-
export declare type AppendBlobCreateResponse = AppendBlobCreateHeaders
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
parsedHeaders: AppendBlobCreateHeaders;
|
813
|
-
};
|
814
|
-
};
|
917
|
+
export declare type AppendBlobCreateResponse = WithResponse<AppendBlobCreateHeaders, AppendBlobCreateHeaders>;
|
918
|
+
|
919
|
+
/** Contains response data for the create operation. */
|
920
|
+
declare type AppendBlobCreateResponse_2 = AppendBlobCreateHeaders;
|
815
921
|
|
816
922
|
/**
|
817
923
|
* Conditions to add to the creation of this append blob.
|
@@ -819,6 +925,38 @@ export declare type AppendBlobCreateResponse = AppendBlobCreateHeaders & {
|
|
819
925
|
export declare interface AppendBlobRequestConditions extends BlobRequestConditions, AppendPositionAccessConditions {
|
820
926
|
}
|
821
927
|
|
928
|
+
/** Defines headers for AppendBlob_seal operation. */
|
929
|
+
declare interface AppendBlobSealHeaders {
|
930
|
+
/** 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. */
|
931
|
+
etag?: string;
|
932
|
+
/** 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. */
|
933
|
+
lastModified?: Date;
|
934
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
935
|
+
clientRequestId?: string;
|
936
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
937
|
+
requestId?: string;
|
938
|
+
/** 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. */
|
939
|
+
version?: string;
|
940
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
941
|
+
date?: Date;
|
942
|
+
/** If this blob has been sealed */
|
943
|
+
isSealed?: boolean;
|
944
|
+
}
|
945
|
+
|
946
|
+
/** Optional parameters. */
|
947
|
+
declare interface AppendBlobSealOptionalParams extends coreClient.OperationOptions {
|
948
|
+
/** Parameter group */
|
949
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
950
|
+
/** Parameter group */
|
951
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
952
|
+
/** Parameter group */
|
953
|
+
appendPositionAccessConditions?: AppendPositionAccessConditions;
|
954
|
+
/** 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> */
|
955
|
+
timeoutInSeconds?: number;
|
956
|
+
/** 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. */
|
957
|
+
requestId?: string;
|
958
|
+
}
|
959
|
+
|
822
960
|
/**
|
823
961
|
* Options to configure {@link AppendBlobClient.seal} operation.
|
824
962
|
*/
|
@@ -834,6 +972,9 @@ export declare interface AppendBlobSealOptions extends CommonOptions {
|
|
834
972
|
conditions?: AppendBlobRequestConditions;
|
835
973
|
}
|
836
974
|
|
975
|
+
/** Contains response data for the seal operation. */
|
976
|
+
declare type AppendBlobSealResponse = AppendBlobSealHeaders;
|
977
|
+
|
837
978
|
/** Parameter group */
|
838
979
|
export declare interface AppendPositionAccessConditions {
|
839
980
|
/** 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). */
|
@@ -845,7 +986,62 @@ export declare interface AppendPositionAccessConditions {
|
|
845
986
|
/** Defines values for ArchiveStatus. */
|
846
987
|
export declare type ArchiveStatus = "rehydrate-pending-to-hot" | "rehydrate-pending-to-cool";
|
847
988
|
|
848
|
-
|
989
|
+
/** Groups the settings used for formatting the response if the response should be Arrow formatted. */
|
990
|
+
declare interface ArrowConfiguration {
|
991
|
+
schema: ArrowField[];
|
992
|
+
}
|
993
|
+
|
994
|
+
/** Groups settings regarding specific field of an arrow schema */
|
995
|
+
declare interface ArrowField {
|
996
|
+
type: string;
|
997
|
+
name?: string;
|
998
|
+
precision?: number;
|
999
|
+
scale?: number;
|
1000
|
+
}
|
1001
|
+
|
1002
|
+
/**
|
1003
|
+
* The base class from which all request policies derive.
|
1004
|
+
*/
|
1005
|
+
export declare abstract class BaseRequestPolicy implements RequestPolicy {
|
1006
|
+
/**
|
1007
|
+
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
1008
|
+
*/
|
1009
|
+
readonly _nextPolicy: RequestPolicy;
|
1010
|
+
/**
|
1011
|
+
* The options that can be passed to a given request policy.
|
1012
|
+
*/
|
1013
|
+
readonly _options: RequestPolicyOptions;
|
1014
|
+
/**
|
1015
|
+
* The main method to implement that manipulates a request/response.
|
1016
|
+
*/
|
1017
|
+
protected constructor(
|
1018
|
+
/**
|
1019
|
+
* The next policy in the pipeline. Each policy is responsible for executing the next one if the request is to continue through the pipeline.
|
1020
|
+
*/
|
1021
|
+
_nextPolicy: RequestPolicy,
|
1022
|
+
/**
|
1023
|
+
* The options that can be passed to a given request policy.
|
1024
|
+
*/
|
1025
|
+
_options: RequestPolicyOptions);
|
1026
|
+
/**
|
1027
|
+
* Sends a network request based on the given web resource.
|
1028
|
+
* @param webResource - A {@link WebResourceLike} that describes a HTTP request to be made.
|
1029
|
+
*/
|
1030
|
+
abstract sendRequest(webResource: WebResource): Promise<HttpOperationResponse>;
|
1031
|
+
/**
|
1032
|
+
* Get whether or not a log with the provided log level should be logged.
|
1033
|
+
* @param logLevel - The log level of the log that will be logged.
|
1034
|
+
* @returns Whether or not a log with the provided log level should be logged.
|
1035
|
+
*/
|
1036
|
+
shouldLog(logLevel: HttpPipelineLogLevel): boolean;
|
1037
|
+
/**
|
1038
|
+
* Attempt to log the provided message to the provided logger. If no logger was provided or if
|
1039
|
+
* the log level does not meat the logger's threshold, then nothing will be logged.
|
1040
|
+
* @param logLevel - The log level of this log.
|
1041
|
+
* @param message - The message of this log.
|
1042
|
+
*/
|
1043
|
+
log(logLevel: HttpPipelineLogLevel, message: string): void;
|
1044
|
+
}
|
849
1045
|
|
850
1046
|
/**
|
851
1047
|
* A request associated with a batch operation.
|
@@ -893,6 +1089,175 @@ export declare interface BatchSubResponse {
|
|
893
1089
|
_request: BatchSubRequest;
|
894
1090
|
}
|
895
1091
|
|
1092
|
+
/** Interface representing a Blob. */
|
1093
|
+
declare interface Blob_2 {
|
1094
|
+
/**
|
1095
|
+
* The Download operation reads or downloads a blob from the system, including its metadata and
|
1096
|
+
* properties. You can also call Download to read a snapshot.
|
1097
|
+
* @param options The options parameters.
|
1098
|
+
*/
|
1099
|
+
download(options?: BlobDownloadOptionalParams): Promise<BlobDownloadResponseInternal>;
|
1100
|
+
/**
|
1101
|
+
* The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system
|
1102
|
+
* properties for the blob. It does not return the content of the blob.
|
1103
|
+
* @param options The options parameters.
|
1104
|
+
*/
|
1105
|
+
getProperties(options?: BlobGetPropertiesOptionalParams): Promise<BlobGetPropertiesResponse_2>;
|
1106
|
+
/**
|
1107
|
+
* If the storage account's soft delete feature is disabled then, when a blob is deleted, it is
|
1108
|
+
* permanently removed from the storage account. If the storage account's soft delete feature is
|
1109
|
+
* enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible
|
1110
|
+
* immediately. However, the blob service retains the blob or snapshot for the number of days specified
|
1111
|
+
* by the DeleteRetentionPolicy section of [Storage service properties]
|
1112
|
+
* (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is
|
1113
|
+
* permanently removed from the storage account. Note that you continue to be charged for the
|
1114
|
+
* soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the
|
1115
|
+
* "include=deleted" query parameter to discover which blobs and snapshots have been soft deleted. You
|
1116
|
+
* can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a
|
1117
|
+
* soft-deleted blob or snapshot causes the service to return an HTTP status code of 404
|
1118
|
+
* (ResourceNotFound).
|
1119
|
+
* @param options The options parameters.
|
1120
|
+
*/
|
1121
|
+
delete(options?: BlobDeleteOptionalParams): Promise<BlobDeleteResponse_2>;
|
1122
|
+
/**
|
1123
|
+
* Undelete a blob that was previously soft deleted
|
1124
|
+
* @param options The options parameters.
|
1125
|
+
*/
|
1126
|
+
undelete(options?: BlobUndeleteOptionalParams): Promise<BlobUndeleteResponse_2>;
|
1127
|
+
/**
|
1128
|
+
* Sets the time a blob will expire and be deleted.
|
1129
|
+
* @param expiryOptions Required. Indicates mode of the expiry time
|
1130
|
+
* @param options The options parameters.
|
1131
|
+
*/
|
1132
|
+
setExpiry(expiryOptions: BlobExpiryOptions, options?: BlobSetExpiryOptionalParams): Promise<BlobSetExpiryResponse>;
|
1133
|
+
/**
|
1134
|
+
* The Set HTTP Headers operation sets system properties on the blob
|
1135
|
+
* @param options The options parameters.
|
1136
|
+
*/
|
1137
|
+
setHttpHeaders(options?: BlobSetHttpHeadersOptionalParams): Promise<BlobSetHttpHeadersResponse>;
|
1138
|
+
/**
|
1139
|
+
* The Set Immutability Policy operation sets the immutability policy on the blob
|
1140
|
+
* @param options The options parameters.
|
1141
|
+
*/
|
1142
|
+
setImmutabilityPolicy(options?: BlobSetImmutabilityPolicyOptionalParams): Promise<BlobSetImmutabilityPolicyResponse_2>;
|
1143
|
+
/**
|
1144
|
+
* The Delete Immutability Policy operation deletes the immutability policy on the blob
|
1145
|
+
* @param options The options parameters.
|
1146
|
+
*/
|
1147
|
+
deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptionalParams): Promise<BlobDeleteImmutabilityPolicyResponse_2>;
|
1148
|
+
/**
|
1149
|
+
* The Set Legal Hold operation sets a legal hold on the blob.
|
1150
|
+
* @param legalHold Specified if a legal hold should be set on the blob.
|
1151
|
+
* @param options The options parameters.
|
1152
|
+
*/
|
1153
|
+
setLegalHold(legalHold: boolean, options?: BlobSetLegalHoldOptionalParams): Promise<BlobSetLegalHoldResponse_2>;
|
1154
|
+
/**
|
1155
|
+
* The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more
|
1156
|
+
* name-value pairs
|
1157
|
+
* @param options The options parameters.
|
1158
|
+
*/
|
1159
|
+
setMetadata(options?: BlobSetMetadataOptionalParams): Promise<BlobSetMetadataResponse_2>;
|
1160
|
+
/**
|
1161
|
+
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1162
|
+
* operations
|
1163
|
+
* @param options The options parameters.
|
1164
|
+
*/
|
1165
|
+
acquireLease(options?: BlobAcquireLeaseOptionalParams): Promise<BlobAcquireLeaseResponse>;
|
1166
|
+
/**
|
1167
|
+
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1168
|
+
* operations
|
1169
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
1170
|
+
* @param options The options parameters.
|
1171
|
+
*/
|
1172
|
+
releaseLease(leaseId: string, options?: BlobReleaseLeaseOptionalParams): Promise<BlobReleaseLeaseResponse>;
|
1173
|
+
/**
|
1174
|
+
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1175
|
+
* operations
|
1176
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
1177
|
+
* @param options The options parameters.
|
1178
|
+
*/
|
1179
|
+
renewLease(leaseId: string, options?: BlobRenewLeaseOptionalParams): Promise<BlobRenewLeaseResponse>;
|
1180
|
+
/**
|
1181
|
+
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1182
|
+
* operations
|
1183
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
1184
|
+
* @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
|
1185
|
+
* (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
|
1186
|
+
* (String) for a list of valid GUID string formats.
|
1187
|
+
* @param options The options parameters.
|
1188
|
+
*/
|
1189
|
+
changeLease(leaseId: string, proposedLeaseId: string, options?: BlobChangeLeaseOptionalParams): Promise<BlobChangeLeaseResponse>;
|
1190
|
+
/**
|
1191
|
+
* [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete
|
1192
|
+
* operations
|
1193
|
+
* @param options The options parameters.
|
1194
|
+
*/
|
1195
|
+
breakLease(options?: BlobBreakLeaseOptionalParams): Promise<BlobBreakLeaseResponse>;
|
1196
|
+
/**
|
1197
|
+
* The Create Snapshot operation creates a read-only snapshot of a blob
|
1198
|
+
* @param options The options parameters.
|
1199
|
+
*/
|
1200
|
+
createSnapshot(options?: BlobCreateSnapshotOptionalParams): Promise<BlobCreateSnapshotResponse_2>;
|
1201
|
+
/**
|
1202
|
+
* The Start Copy From URL operation copies a blob or an internet resource to a new blob.
|
1203
|
+
* @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
|
1204
|
+
* 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
|
1205
|
+
* appear in a request URI. The source blob must either be public or must be authenticated via a shared
|
1206
|
+
* access signature.
|
1207
|
+
* @param options The options parameters.
|
1208
|
+
*/
|
1209
|
+
startCopyFromURL(copySource: string, options?: BlobStartCopyFromURLOptionalParams): Promise<BlobStartCopyFromURLResponse_2>;
|
1210
|
+
/**
|
1211
|
+
* The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return
|
1212
|
+
* a response until the copy is complete.
|
1213
|
+
* @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
|
1214
|
+
* 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
|
1215
|
+
* appear in a request URI. The source blob must either be public or must be authenticated via a shared
|
1216
|
+
* access signature.
|
1217
|
+
* @param options The options parameters.
|
1218
|
+
*/
|
1219
|
+
copyFromURL(copySource: string, options?: BlobCopyFromURLOptionalParams): Promise<BlobCopyFromURLResponse_2>;
|
1220
|
+
/**
|
1221
|
+
* The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination
|
1222
|
+
* blob with zero length and full metadata.
|
1223
|
+
* @param copyId The copy identifier provided in the x-ms-copy-id header of the original Copy Blob
|
1224
|
+
* operation.
|
1225
|
+
* @param options The options parameters.
|
1226
|
+
*/
|
1227
|
+
abortCopyFromURL(copyId: string, options?: BlobAbortCopyFromURLOptionalParams): Promise<BlobAbortCopyFromURLResponse_2>;
|
1228
|
+
/**
|
1229
|
+
* The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium
|
1230
|
+
* storage account and on a block blob in a blob storage account (locally redundant storage only). A
|
1231
|
+
* premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block
|
1232
|
+
* blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's
|
1233
|
+
* ETag.
|
1234
|
+
* @param tier Indicates the tier to be set on the blob.
|
1235
|
+
* @param options The options parameters.
|
1236
|
+
*/
|
1237
|
+
setTier(tier: AccessTier, options?: BlobSetTierOptionalParams): Promise<BlobSetTierResponse_2>;
|
1238
|
+
/**
|
1239
|
+
* Returns the sku name and account kind
|
1240
|
+
* @param options The options parameters.
|
1241
|
+
*/
|
1242
|
+
getAccountInfo(options?: BlobGetAccountInfoOptionalParams): Promise<BlobGetAccountInfoResponse>;
|
1243
|
+
/**
|
1244
|
+
* The Query operation enables users to select/project on blob data by providing simple query
|
1245
|
+
* expressions.
|
1246
|
+
* @param options The options parameters.
|
1247
|
+
*/
|
1248
|
+
query(options?: BlobQueryOptionalParams): Promise<BlobQueryResponseInternal>;
|
1249
|
+
/**
|
1250
|
+
* The Get Tags operation enables users to get the tags associated with a blob.
|
1251
|
+
* @param options The options parameters.
|
1252
|
+
*/
|
1253
|
+
getTags(options?: BlobGetTagsOptionalParams): Promise<BlobGetTagsResponse_2>;
|
1254
|
+
/**
|
1255
|
+
* The Set Tags operation enables users to set tags on a blob.
|
1256
|
+
* @param options The options parameters.
|
1257
|
+
*/
|
1258
|
+
setTags(options?: BlobSetTagsOptionalParams): Promise<BlobSetTagsResponse_2>;
|
1259
|
+
}
|
1260
|
+
|
896
1261
|
/** Defines headers for Blob_abortCopyFromURL operation. */
|
897
1262
|
export declare interface BlobAbortCopyFromURLHeaders {
|
898
1263
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -907,6 +1272,16 @@ export declare interface BlobAbortCopyFromURLHeaders {
|
|
907
1272
|
errorCode?: string;
|
908
1273
|
}
|
909
1274
|
|
1275
|
+
/** Optional parameters. */
|
1276
|
+
declare interface BlobAbortCopyFromURLOptionalParams extends coreClient.OperationOptions {
|
1277
|
+
/** Parameter group */
|
1278
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
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
|
+
}
|
1284
|
+
|
910
1285
|
/**
|
911
1286
|
* Options to configure the {@link BlobClient.abortCopyFromURL} operation.
|
912
1287
|
*/
|
@@ -924,13 +1299,42 @@ export declare interface BlobAbortCopyFromURLOptions extends CommonOptions {
|
|
924
1299
|
}
|
925
1300
|
|
926
1301
|
/** Contains response data for the abortCopyFromURL operation. */
|
927
|
-
export declare type BlobAbortCopyFromURLResponse = BlobAbortCopyFromURLHeaders
|
928
|
-
|
929
|
-
|
930
|
-
|
931
|
-
|
932
|
-
|
933
|
-
|
1302
|
+
export declare type BlobAbortCopyFromURLResponse = WithResponse<BlobAbortCopyFromURLHeaders, BlobAbortCopyFromURLHeaders>;
|
1303
|
+
|
1304
|
+
/** Contains response data for the abortCopyFromURL operation. */
|
1305
|
+
declare type BlobAbortCopyFromURLResponse_2 = BlobAbortCopyFromURLHeaders;
|
1306
|
+
|
1307
|
+
/** Defines headers for Blob_acquireLease operation. */
|
1308
|
+
declare interface BlobAcquireLeaseHeaders {
|
1309
|
+
/** 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. */
|
1310
|
+
etag?: string;
|
1311
|
+
/** 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. */
|
1312
|
+
lastModified?: Date;
|
1313
|
+
/** Uniquely identifies a blobs' lease */
|
1314
|
+
leaseId?: string;
|
1315
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1316
|
+
clientRequestId?: string;
|
1317
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1318
|
+
requestId?: string;
|
1319
|
+
/** 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. */
|
1320
|
+
version?: string;
|
1321
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1322
|
+
date?: Date;
|
1323
|
+
}
|
1324
|
+
|
1325
|
+
/** Optional parameters. */
|
1326
|
+
declare interface BlobAcquireLeaseOptionalParams extends coreClient.OperationOptions {
|
1327
|
+
/** Parameter group */
|
1328
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
1329
|
+
/** 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> */
|
1330
|
+
timeoutInSeconds?: number;
|
1331
|
+
/** 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. */
|
1332
|
+
requestId?: string;
|
1333
|
+
/** 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. */
|
1334
|
+
duration?: number;
|
1335
|
+
/** 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. */
|
1336
|
+
proposedLeaseId?: string;
|
1337
|
+
}
|
934
1338
|
|
935
1339
|
/**
|
936
1340
|
* Options to configure Blob - Acquire Lease operation.
|
@@ -947,6 +1351,9 @@ export declare interface BlobAcquireLeaseOptions extends CommonOptions {
|
|
947
1351
|
conditions?: ModifiedAccessConditions;
|
948
1352
|
}
|
949
1353
|
|
1354
|
+
/** Contains response data for the acquireLease operation. */
|
1355
|
+
declare type BlobAcquireLeaseResponse = BlobAcquireLeaseHeaders;
|
1356
|
+
|
950
1357
|
/**
|
951
1358
|
* A BlobBatch represents an aggregated set of operations on blobs.
|
952
1359
|
* Currently, only `delete` and `setAccessTier` are supported.
|
@@ -1183,17 +1590,7 @@ export declare interface BlobBatchSubmitBatchOptionalParams extends ServiceSubmi
|
|
1183
1590
|
/**
|
1184
1591
|
* Contains response data for blob batch operations.
|
1185
1592
|
*/
|
1186
|
-
export declare type BlobBatchSubmitBatchResponse = ParsedBatchResponse & ServiceSubmitBatchHeaders
|
1187
|
-
/**
|
1188
|
-
* The underlying HTTP response.
|
1189
|
-
*/
|
1190
|
-
_response: HttpResponse & {
|
1191
|
-
/**
|
1192
|
-
* The parsed HTTP response headers.
|
1193
|
-
*/
|
1194
|
-
parsedHeaders: ServiceSubmitBatchHeaders;
|
1195
|
-
};
|
1196
|
-
};
|
1593
|
+
export declare type BlobBatchSubmitBatchResponse = WithResponse<ParsedBatchResponse & ServiceSubmitBatchHeaders, ServiceSubmitBatchHeaders>;
|
1197
1594
|
|
1198
1595
|
/**
|
1199
1596
|
* Options to configure the {@link BlobClient.beginCopyFromURL} operation.
|
@@ -1256,36 +1653,100 @@ export declare interface BlobBeginCopyFromUrlPollState extends PollOperationStat
|
|
1256
1653
|
export declare interface BlobBeginCopyFromURLResponse extends BlobStartCopyFromURLResponse {
|
1257
1654
|
}
|
1258
1655
|
|
1259
|
-
/**
|
1260
|
-
|
1261
|
-
*/
|
1262
|
-
|
1263
|
-
/**
|
1264
|
-
|
1265
|
-
|
1266
|
-
|
1267
|
-
|
1268
|
-
|
1269
|
-
|
1270
|
-
|
1271
|
-
|
1272
|
-
|
1273
|
-
|
1274
|
-
|
1275
|
-
|
1276
|
-
|
1277
|
-
|
1278
|
-
|
1279
|
-
|
1280
|
-
|
1281
|
-
|
1282
|
-
|
1283
|
-
/**
|
1656
|
+
/** Defines headers for Blob_breakLease operation. */
|
1657
|
+
declare interface BlobBreakLeaseHeaders {
|
1658
|
+
/** 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. */
|
1659
|
+
etag?: string;
|
1660
|
+
/** 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. */
|
1661
|
+
lastModified?: Date;
|
1662
|
+
/** Approximate time remaining in the lease period, in seconds. */
|
1663
|
+
leaseTime?: number;
|
1664
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1665
|
+
clientRequestId?: string;
|
1666
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1667
|
+
requestId?: string;
|
1668
|
+
/** 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. */
|
1669
|
+
version?: string;
|
1670
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1671
|
+
date?: Date;
|
1672
|
+
}
|
1673
|
+
|
1674
|
+
/** Optional parameters. */
|
1675
|
+
declare interface BlobBreakLeaseOptionalParams extends coreClient.OperationOptions {
|
1676
|
+
/** Parameter group */
|
1677
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
1678
|
+
/** 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> */
|
1679
|
+
timeoutInSeconds?: number;
|
1680
|
+
/** 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. */
|
1681
|
+
requestId?: string;
|
1682
|
+
/** 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. */
|
1683
|
+
breakPeriod?: number;
|
1684
|
+
}
|
1685
|
+
|
1686
|
+
/**
|
1687
|
+
* Options to configure Blob - Break Lease operation.
|
1688
|
+
*/
|
1689
|
+
export declare interface BlobBreakLeaseOptions extends CommonOptions {
|
1690
|
+
/**
|
1691
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
1692
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
1693
|
+
*/
|
1694
|
+
abortSignal?: AbortSignalLike;
|
1695
|
+
/**
|
1696
|
+
* Conditions to meet when breaking the lease of a blob.
|
1697
|
+
*/
|
1698
|
+
conditions?: ModifiedAccessConditions;
|
1699
|
+
}
|
1700
|
+
|
1701
|
+
/** Contains response data for the breakLease operation. */
|
1702
|
+
declare type BlobBreakLeaseResponse = BlobBreakLeaseHeaders;
|
1703
|
+
|
1704
|
+
/** Defines headers for Blob_changeLease operation. */
|
1705
|
+
declare interface BlobChangeLeaseHeaders {
|
1706
|
+
/** 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. */
|
1707
|
+
etag?: string;
|
1708
|
+
/** 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. */
|
1709
|
+
lastModified?: Date;
|
1710
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
1711
|
+
clientRequestId?: string;
|
1712
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
1713
|
+
requestId?: string;
|
1714
|
+
/** Uniquely identifies a blobs' lease */
|
1715
|
+
leaseId?: string;
|
1716
|
+
/** 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. */
|
1717
|
+
version?: string;
|
1718
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
1719
|
+
date?: Date;
|
1720
|
+
}
|
1721
|
+
|
1722
|
+
/** Optional parameters. */
|
1723
|
+
declare interface BlobChangeLeaseOptionalParams extends coreClient.OperationOptions {
|
1724
|
+
/** Parameter group */
|
1725
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
1726
|
+
/** 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> */
|
1727
|
+
timeoutInSeconds?: number;
|
1728
|
+
/** 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. */
|
1729
|
+
requestId?: string;
|
1730
|
+
}
|
1731
|
+
|
1732
|
+
/**
|
1733
|
+
* Options to configure Blob - Change Lease operation.
|
1734
|
+
*/
|
1735
|
+
export declare interface BlobChangeLeaseOptions extends CommonOptions {
|
1736
|
+
/**
|
1737
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
1738
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
1739
|
+
*/
|
1740
|
+
abortSignal?: AbortSignalLike;
|
1741
|
+
/**
|
1284
1742
|
* Conditions to meet when changing the lease of a blob.
|
1285
1743
|
*/
|
1286
1744
|
conditions?: ModifiedAccessConditions;
|
1287
1745
|
}
|
1288
1746
|
|
1747
|
+
/** Contains response data for the changeLease operation. */
|
1748
|
+
declare type BlobChangeLeaseResponse = BlobChangeLeaseHeaders;
|
1749
|
+
|
1289
1750
|
/**
|
1290
1751
|
* A BlobClient represents a URL to an Azure Storage blob; the blob may be a block blob,
|
1291
1752
|
* append blob, or page blob.
|
@@ -1739,7 +2200,7 @@ export declare class BlobClient extends StorageClient {
|
|
1739
2200
|
*/
|
1740
2201
|
deleteImmutabilityPolicy(options?: BlobDeleteImmutabilityPolicyOptions): Promise<BlobDeleteImmutabilityPolicyResponse>;
|
1741
2202
|
/**
|
1742
|
-
* Set
|
2203
|
+
* Set immutability policy on the blob.
|
1743
2204
|
*
|
1744
2205
|
* @param options - Optional options to set immutability policy on the blob.
|
1745
2206
|
*/
|
@@ -1771,7 +2232,7 @@ export declare interface BlobCopyFromURLHeaders {
|
|
1771
2232
|
/** String identifier for this copy operation. */
|
1772
2233
|
copyId?: string;
|
1773
2234
|
/** State of the copy operation identified by x-ms-copy-id. */
|
1774
|
-
copyStatus?:
|
2235
|
+
copyStatus?: "success";
|
1775
2236
|
/** 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. */
|
1776
2237
|
contentMD5?: Uint8Array;
|
1777
2238
|
/** This response header is returned so that the client can check for the integrity of the copied content. */
|
@@ -1782,14 +2243,47 @@ export declare interface BlobCopyFromURLHeaders {
|
|
1782
2243
|
errorCode?: string;
|
1783
2244
|
}
|
1784
2245
|
|
1785
|
-
/**
|
1786
|
-
|
1787
|
-
/**
|
1788
|
-
|
1789
|
-
|
1790
|
-
|
2246
|
+
/** Optional parameters. */
|
2247
|
+
declare interface BlobCopyFromURLOptionalParams extends coreClient.OperationOptions {
|
2248
|
+
/** Parameter group */
|
2249
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2250
|
+
/** Parameter group */
|
2251
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2252
|
+
/** Parameter group */
|
2253
|
+
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
2254
|
+
/** 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> */
|
2255
|
+
timeoutInSeconds?: number;
|
2256
|
+
/** 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. */
|
2257
|
+
requestId?: string;
|
2258
|
+
/** 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. */
|
2259
|
+
metadata?: {
|
2260
|
+
[propertyName: string]: string;
|
1791
2261
|
};
|
1792
|
-
|
2262
|
+
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
2263
|
+
immutabilityPolicyExpiry?: Date;
|
2264
|
+
/** Specifies the immutability policy mode to set on the blob. */
|
2265
|
+
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
2266
|
+
/** 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. */
|
2267
|
+
encryptionScope?: string;
|
2268
|
+
/** Optional. Indicates the tier to be set on the blob. */
|
2269
|
+
tier?: AccessTier;
|
2270
|
+
/** Optional. Used to set blob tags in various blob operations. */
|
2271
|
+
blobTagsString?: string;
|
2272
|
+
/** Specified if a legal hold should be set on the blob. */
|
2273
|
+
legalHold?: boolean;
|
2274
|
+
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
2275
|
+
sourceContentMD5?: Uint8Array;
|
2276
|
+
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
2277
|
+
copySourceAuthorization?: string;
|
2278
|
+
/** Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags. */
|
2279
|
+
copySourceTags?: BlobCopySourceTags;
|
2280
|
+
}
|
2281
|
+
|
2282
|
+
/** Contains response data for the copyFromURL operation. */
|
2283
|
+
export declare type BlobCopyFromURLResponse = WithResponse<BlobCopyFromURLHeaders, BlobCopyFromURLHeaders>;
|
2284
|
+
|
2285
|
+
/** Contains response data for the copyFromURL operation. */
|
2286
|
+
declare type BlobCopyFromURLResponse_2 = BlobCopyFromURLHeaders;
|
1793
2287
|
|
1794
2288
|
/** Defines values for BlobCopySourceTags. */
|
1795
2289
|
export declare type BlobCopySourceTags = "REPLACE" | "COPY";
|
@@ -1818,6 +2312,26 @@ export declare interface BlobCreateSnapshotHeaders {
|
|
1818
2312
|
errorCode?: string;
|
1819
2313
|
}
|
1820
2314
|
|
2315
|
+
/** Optional parameters. */
|
2316
|
+
declare interface BlobCreateSnapshotOptionalParams extends coreClient.OperationOptions {
|
2317
|
+
/** Parameter group */
|
2318
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2319
|
+
/** Parameter group */
|
2320
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2321
|
+
/** Parameter group */
|
2322
|
+
cpkInfo?: CpkInfo;
|
2323
|
+
/** 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> */
|
2324
|
+
timeoutInSeconds?: number;
|
2325
|
+
/** 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. */
|
2326
|
+
requestId?: string;
|
2327
|
+
/** 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. */
|
2328
|
+
metadata?: {
|
2329
|
+
[propertyName: string]: string;
|
2330
|
+
};
|
2331
|
+
/** 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. */
|
2332
|
+
encryptionScope?: string;
|
2333
|
+
}
|
2334
|
+
|
1821
2335
|
/**
|
1822
2336
|
* Options to configure the {@link BlobClient.createSnapshot} operation.
|
1823
2337
|
*/
|
@@ -1849,13 +2363,10 @@ export declare interface BlobCreateSnapshotOptions extends CommonOptions {
|
|
1849
2363
|
}
|
1850
2364
|
|
1851
2365
|
/** Contains response data for the createSnapshot operation. */
|
1852
|
-
export declare type BlobCreateSnapshotResponse = BlobCreateSnapshotHeaders
|
1853
|
-
|
1854
|
-
|
1855
|
-
|
1856
|
-
parsedHeaders: BlobCreateSnapshotHeaders;
|
1857
|
-
};
|
1858
|
-
};
|
2366
|
+
export declare type BlobCreateSnapshotResponse = WithResponse<BlobCreateSnapshotHeaders, BlobCreateSnapshotHeaders>;
|
2367
|
+
|
2368
|
+
/** Contains response data for the createSnapshot operation. */
|
2369
|
+
declare type BlobCreateSnapshotResponse_2 = BlobCreateSnapshotHeaders;
|
1859
2370
|
|
1860
2371
|
/** Defines headers for Blob_delete operation. */
|
1861
2372
|
export declare interface BlobDeleteHeaders {
|
@@ -1893,6 +2404,14 @@ export declare interface BlobDeleteImmutabilityPolicyHeaders {
|
|
1893
2404
|
date?: Date;
|
1894
2405
|
}
|
1895
2406
|
|
2407
|
+
/** Optional parameters. */
|
2408
|
+
declare interface BlobDeleteImmutabilityPolicyOptionalParams extends coreClient.OperationOptions {
|
2409
|
+
/** 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> */
|
2410
|
+
timeoutInSeconds?: number;
|
2411
|
+
/** 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. */
|
2412
|
+
requestId?: string;
|
2413
|
+
}
|
2414
|
+
|
1896
2415
|
/**
|
1897
2416
|
* Options for deleting immutability policy {@link BlobClient.deleteImmutabilityPolicy} operation.
|
1898
2417
|
*/
|
@@ -1905,13 +2424,30 @@ export declare interface BlobDeleteImmutabilityPolicyOptions extends CommonOptio
|
|
1905
2424
|
}
|
1906
2425
|
|
1907
2426
|
/** Contains response data for the deleteImmutabilityPolicy operation. */
|
1908
|
-
export declare type BlobDeleteImmutabilityPolicyResponse = BlobDeleteImmutabilityPolicyHeaders
|
1909
|
-
|
1910
|
-
|
1911
|
-
|
1912
|
-
|
1913
|
-
|
1914
|
-
|
2427
|
+
export declare type BlobDeleteImmutabilityPolicyResponse = WithResponse<BlobDeleteImmutabilityPolicyHeaders, BlobDeleteImmutabilityPolicyHeaders>;
|
2428
|
+
|
2429
|
+
/** Contains response data for the deleteImmutabilityPolicy operation. */
|
2430
|
+
declare type BlobDeleteImmutabilityPolicyResponse_2 = BlobDeleteImmutabilityPolicyHeaders;
|
2431
|
+
|
2432
|
+
/** Optional parameters. */
|
2433
|
+
declare interface BlobDeleteOptionalParams extends coreClient.OperationOptions {
|
2434
|
+
/** Parameter group */
|
2435
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2436
|
+
/** Parameter group */
|
2437
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2438
|
+
/** 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> */
|
2439
|
+
timeoutInSeconds?: number;
|
2440
|
+
/** 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. */
|
2441
|
+
requestId?: string;
|
2442
|
+
/** 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> */
|
2443
|
+
snapshot?: string;
|
2444
|
+
/** 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. */
|
2445
|
+
versionId?: string;
|
2446
|
+
/** 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 */
|
2447
|
+
deleteSnapshots?: DeleteSnapshotsOptionType;
|
2448
|
+
/** Optional. Only possible value is 'permanent', which specifies to permanently delete a blob if blob soft delete is enabled. */
|
2449
|
+
blobDeleteType?: string;
|
2450
|
+
}
|
1915
2451
|
|
1916
2452
|
/**
|
1917
2453
|
* Options to configure the {@link BlobClient.delete} operation.
|
@@ -1939,13 +2475,10 @@ export declare interface BlobDeleteOptions extends CommonOptions {
|
|
1939
2475
|
}
|
1940
2476
|
|
1941
2477
|
/** Contains response data for the delete operation. */
|
1942
|
-
export declare type BlobDeleteResponse = BlobDeleteHeaders
|
1943
|
-
|
1944
|
-
|
1945
|
-
|
1946
|
-
parsedHeaders: BlobDeleteHeaders;
|
1947
|
-
};
|
1948
|
-
};
|
2478
|
+
export declare type BlobDeleteResponse = WithResponse<BlobDeleteHeaders, BlobDeleteHeaders>;
|
2479
|
+
|
2480
|
+
/** Contains response data for the delete operation. */
|
2481
|
+
declare type BlobDeleteResponse_2 = BlobDeleteHeaders;
|
1949
2482
|
|
1950
2483
|
/** Defines headers for Blob_download operation. */
|
1951
2484
|
export declare interface BlobDownloadHeaders {
|
@@ -2043,7 +2576,7 @@ export declare interface BlobDownloadHeaders {
|
|
2043
2576
|
}
|
2044
2577
|
|
2045
2578
|
/** Optional parameters. */
|
2046
|
-
export declare interface BlobDownloadOptionalParams extends
|
2579
|
+
export declare interface BlobDownloadOptionalParams extends coreClient.OperationOptions {
|
2047
2580
|
/** Parameter group */
|
2048
2581
|
leaseAccessConditions?: LeaseAccessConditions;
|
2049
2582
|
/** Parameter group */
|
@@ -2121,7 +2654,7 @@ export declare interface BlobDownloadOptions extends CommonOptions {
|
|
2121
2654
|
}
|
2122
2655
|
|
2123
2656
|
/** Contains response data for the download operation. */
|
2124
|
-
export declare type
|
2657
|
+
export declare type BlobDownloadResponseInternal = BlobDownloadHeaders & {
|
2125
2658
|
/**
|
2126
2659
|
* BROWSER ONLY
|
2127
2660
|
*
|
@@ -2136,13 +2669,11 @@ export declare type BlobDownloadResponseModel = BlobDownloadHeaders & {
|
|
2136
2669
|
* Always `undefined` in the browser.
|
2137
2670
|
*/
|
2138
2671
|
readableStreamBody?: NodeJS.ReadableStream;
|
2139
|
-
/** The underlying HTTP response. */
|
2140
|
-
_response: coreHttp.HttpResponse & {
|
2141
|
-
/** The parsed HTTP response headers. */
|
2142
|
-
parsedHeaders: BlobDownloadHeaders;
|
2143
|
-
};
|
2144
2672
|
};
|
2145
2673
|
|
2674
|
+
/** Contains response data for the download operation. */
|
2675
|
+
export declare type BlobDownloadResponseModel = WithResponse<BlobDownloadResponseInternal, BlobDownloadHeaders>;
|
2676
|
+
|
2146
2677
|
/**
|
2147
2678
|
* Contains response data for the {@link BlobClient.download} operation.
|
2148
2679
|
*/
|
@@ -2223,6 +2754,18 @@ export declare interface BlobExistsOptions extends CommonOptions {
|
|
2223
2754
|
conditions?: BlobRequestConditions;
|
2224
2755
|
}
|
2225
2756
|
|
2757
|
+
/**
|
2758
|
+
* Defines values for BlobExpiryOptions. \
|
2759
|
+
* {@link KnownBlobExpiryOptions} can be used interchangeably with BlobExpiryOptions,
|
2760
|
+
* this enum contains the known values that the service supports.
|
2761
|
+
* ### Known values supported by the service
|
2762
|
+
* **NeverExpire** \
|
2763
|
+
* **RelativeToCreation** \
|
2764
|
+
* **RelativeToNow** \
|
2765
|
+
* **Absolute**
|
2766
|
+
*/
|
2767
|
+
declare type BlobExpiryOptions = string;
|
2768
|
+
|
2226
2769
|
/**
|
2227
2770
|
* An interface representing BlobFlatListSegment.
|
2228
2771
|
*/
|
@@ -2230,6 +2773,10 @@ export declare interface BlobFlatListSegment {
|
|
2230
2773
|
blobItems: BlobItem[];
|
2231
2774
|
}
|
2232
2775
|
|
2776
|
+
declare interface BlobFlatListSegment_2 {
|
2777
|
+
blobItems: BlobItemInternal_2[];
|
2778
|
+
}
|
2779
|
+
|
2233
2780
|
export declare interface BlobFlatListSegmentModel {
|
2234
2781
|
blobItems: BlobItemInternal[];
|
2235
2782
|
}
|
@@ -2244,6 +2791,29 @@ export declare interface BlobGenerateSasUrlOptions extends CommonGenerateSasUrlO
|
|
2244
2791
|
permissions?: BlobSASPermissions;
|
2245
2792
|
}
|
2246
2793
|
|
2794
|
+
/** Defines headers for Blob_getAccountInfo operation. */
|
2795
|
+
declare interface BlobGetAccountInfoHeaders {
|
2796
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
2797
|
+
clientRequestId?: string;
|
2798
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
2799
|
+
requestId?: string;
|
2800
|
+
/** 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. */
|
2801
|
+
version?: string;
|
2802
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
2803
|
+
date?: Date;
|
2804
|
+
/** Identifies the sku name of the account */
|
2805
|
+
skuName?: SkuName;
|
2806
|
+
/** Identifies the account kind */
|
2807
|
+
accountKind?: AccountKind;
|
2808
|
+
}
|
2809
|
+
|
2810
|
+
/** Optional parameters. */
|
2811
|
+
declare interface BlobGetAccountInfoOptionalParams extends coreClient.OperationOptions {
|
2812
|
+
}
|
2813
|
+
|
2814
|
+
/** Contains response data for the getAccountInfo operation. */
|
2815
|
+
declare type BlobGetAccountInfoResponse = BlobGetAccountInfoHeaders;
|
2816
|
+
|
2247
2817
|
/** Defines headers for Blob_getProperties operation. */
|
2248
2818
|
export declare interface BlobGetPropertiesHeaders {
|
2249
2819
|
/** 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. */
|
@@ -2351,6 +2921,24 @@ export declare interface BlobGetPropertiesHeaders {
|
|
2351
2921
|
errorCode?: string;
|
2352
2922
|
}
|
2353
2923
|
|
2924
|
+
/** Optional parameters. */
|
2925
|
+
declare interface BlobGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
2926
|
+
/** Parameter group */
|
2927
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2928
|
+
/** Parameter group */
|
2929
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
2930
|
+
/** Parameter group */
|
2931
|
+
cpkInfo?: CpkInfo;
|
2932
|
+
/** 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> */
|
2933
|
+
timeoutInSeconds?: number;
|
2934
|
+
/** 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. */
|
2935
|
+
requestId?: string;
|
2936
|
+
/** 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> */
|
2937
|
+
snapshot?: string;
|
2938
|
+
/** 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. */
|
2939
|
+
versionId?: string;
|
2940
|
+
}
|
2941
|
+
|
2354
2942
|
/**
|
2355
2943
|
* Options to configure the {@link BlobClient.getProperties} operation.
|
2356
2944
|
*/
|
@@ -2385,13 +2973,10 @@ export declare interface BlobGetPropertiesResponse extends BlobGetPropertiesResp
|
|
2385
2973
|
}
|
2386
2974
|
|
2387
2975
|
/** Contains response data for the getProperties operation. */
|
2388
|
-
|
2389
|
-
|
2390
|
-
|
2391
|
-
|
2392
|
-
parsedHeaders: BlobGetPropertiesHeaders;
|
2393
|
-
};
|
2394
|
-
};
|
2976
|
+
declare type BlobGetPropertiesResponse_2 = BlobGetPropertiesHeaders;
|
2977
|
+
|
2978
|
+
/** Contains response data for the getProperties operation. */
|
2979
|
+
export declare type BlobGetPropertiesResponseModel = WithResponse<BlobGetPropertiesHeaders, BlobGetPropertiesHeaders>;
|
2395
2980
|
|
2396
2981
|
/** Defines headers for Blob_getTags operation. */
|
2397
2982
|
export declare interface BlobGetTagsHeaders {
|
@@ -2407,6 +2992,22 @@ export declare interface BlobGetTagsHeaders {
|
|
2407
2992
|
errorCode?: string;
|
2408
2993
|
}
|
2409
2994
|
|
2995
|
+
/** Optional parameters. */
|
2996
|
+
declare interface BlobGetTagsOptionalParams extends coreClient.OperationOptions {
|
2997
|
+
/** Parameter group */
|
2998
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
2999
|
+
/** Parameter group */
|
3000
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
3001
|
+
/** 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> */
|
3002
|
+
timeoutInSeconds?: number;
|
3003
|
+
/** 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. */
|
3004
|
+
requestId?: string;
|
3005
|
+
/** 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> */
|
3006
|
+
snapshot?: string;
|
3007
|
+
/** 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. */
|
3008
|
+
versionId?: string;
|
3009
|
+
}
|
3010
|
+
|
2410
3011
|
/**
|
2411
3012
|
* Options to configure the {@link BlobClient.getTags} operation.
|
2412
3013
|
*/
|
@@ -2425,27 +3026,12 @@ export declare interface BlobGetTagsOptions extends CommonOptions {
|
|
2425
3026
|
/**
|
2426
3027
|
* Contains response data for the {@link BlobClient.getTags} operation.
|
2427
3028
|
*/
|
2428
|
-
export declare type BlobGetTagsResponse = {
|
3029
|
+
export declare type BlobGetTagsResponse = WithResponse<{
|
2429
3030
|
tags: Tags;
|
2430
|
-
} & BlobGetTagsHeaders
|
2431
|
-
|
2432
|
-
|
2433
|
-
|
2434
|
-
_response: HttpResponse & {
|
2435
|
-
/**
|
2436
|
-
* The parsed HTTP response headers.
|
2437
|
-
*/
|
2438
|
-
parsedHeaders: BlobGetTagsHeaders;
|
2439
|
-
/**
|
2440
|
-
* The response body as text (string format)
|
2441
|
-
*/
|
2442
|
-
bodyAsText: string;
|
2443
|
-
/**
|
2444
|
-
* The response body as parsed JSON or XML
|
2445
|
-
*/
|
2446
|
-
parsedBody: BlobTags;
|
2447
|
-
};
|
2448
|
-
};
|
3031
|
+
} & BlobGetTagsHeaders, BlobGetTagsHeaders, BlobTags>;
|
3032
|
+
|
3033
|
+
/** Contains response data for the getTags operation. */
|
3034
|
+
declare type BlobGetTagsResponse_2 = BlobGetTagsHeaders & BlobTags;
|
2449
3035
|
|
2450
3036
|
/**
|
2451
3037
|
* An interface representing BlobHierarchyListSegment.
|
@@ -2455,6 +3041,11 @@ export declare interface BlobHierarchyListSegment {
|
|
2455
3041
|
blobItems: BlobItem[];
|
2456
3042
|
}
|
2457
3043
|
|
3044
|
+
declare interface BlobHierarchyListSegment_2 {
|
3045
|
+
blobPrefixes?: BlobPrefix_2[];
|
3046
|
+
blobItems: BlobItemInternal_2[];
|
3047
|
+
}
|
3048
|
+
|
2458
3049
|
export declare interface BlobHierarchyListSegmentModel {
|
2459
3050
|
blobPrefixes?: BlobPrefix[];
|
2460
3051
|
blobItems: BlobItemInternal[];
|
@@ -2534,25 +3125,48 @@ export declare interface BlobItemInternal {
|
|
2534
3125
|
hasVersionsOnly?: boolean;
|
2535
3126
|
}
|
2536
3127
|
|
2537
|
-
/**
|
2538
|
-
|
2539
|
-
|
2540
|
-
|
2541
|
-
|
2542
|
-
|
2543
|
-
|
2544
|
-
|
2545
|
-
|
2546
|
-
|
2547
|
-
|
2548
|
-
|
2549
|
-
|
2550
|
-
|
2551
|
-
|
2552
|
-
|
2553
|
-
|
2554
|
-
|
2555
|
-
|
3128
|
+
/** An Azure Storage blob */
|
3129
|
+
declare interface BlobItemInternal_2 {
|
3130
|
+
name: BlobName;
|
3131
|
+
deleted: boolean;
|
3132
|
+
snapshot: string;
|
3133
|
+
versionId?: string;
|
3134
|
+
isCurrentVersion?: boolean;
|
3135
|
+
/** Properties of a blob */
|
3136
|
+
properties: BlobProperties;
|
3137
|
+
/** Dictionary of <string> */
|
3138
|
+
metadata?: {
|
3139
|
+
[propertyName: string]: string;
|
3140
|
+
};
|
3141
|
+
/** Blob tags */
|
3142
|
+
blobTags?: BlobTags;
|
3143
|
+
/** Dictionary of <string> */
|
3144
|
+
objectReplicationMetadata?: {
|
3145
|
+
[propertyName: string]: string;
|
3146
|
+
};
|
3147
|
+
/** Inactive root blobs which have any versions would have such tag with value true. */
|
3148
|
+
hasVersionsOnly?: boolean;
|
3149
|
+
}
|
3150
|
+
|
3151
|
+
/**
|
3152
|
+
* A client that manages leases for a {@link ContainerClient} or a {@link BlobClient}.
|
3153
|
+
*/
|
3154
|
+
export declare class BlobLeaseClient {
|
3155
|
+
private _leaseId;
|
3156
|
+
private _url;
|
3157
|
+
private _containerOrBlobOperation;
|
3158
|
+
private _isContainer;
|
3159
|
+
/**
|
3160
|
+
* Gets the lease Id.
|
3161
|
+
*
|
3162
|
+
* @readonly
|
3163
|
+
*/
|
3164
|
+
get leaseId(): string;
|
3165
|
+
/**
|
3166
|
+
* Gets the url.
|
3167
|
+
*
|
3168
|
+
* @readonly
|
3169
|
+
*/
|
2556
3170
|
get url(): string;
|
2557
3171
|
/**
|
2558
3172
|
* Creates an instance of BlobLeaseClient.
|
@@ -2619,10 +3233,21 @@ export declare class BlobLeaseClient {
|
|
2619
3233
|
breakLease(breakPeriod: number, options?: LeaseOperationOptions): Promise<LeaseOperationResponse>;
|
2620
3234
|
}
|
2621
3235
|
|
3236
|
+
declare interface BlobName {
|
3237
|
+
/** Indicates if the blob name is encoded. */
|
3238
|
+
encoded?: boolean;
|
3239
|
+
/** The name of the blob. */
|
3240
|
+
content?: string;
|
3241
|
+
}
|
3242
|
+
|
2622
3243
|
export declare interface BlobPrefix {
|
2623
3244
|
name: string;
|
2624
3245
|
}
|
2625
3246
|
|
3247
|
+
declare interface BlobPrefix_2 {
|
3248
|
+
name: BlobName;
|
3249
|
+
}
|
3250
|
+
|
2626
3251
|
/** Properties of a blob */
|
2627
3252
|
export declare interface BlobProperties {
|
2628
3253
|
createdOn?: Date;
|
@@ -2853,6 +3478,24 @@ export declare interface BlobQueryJsonTextConfiguration {
|
|
2853
3478
|
kind: "json";
|
2854
3479
|
}
|
2855
3480
|
|
3481
|
+
/** Optional parameters. */
|
3482
|
+
declare interface BlobQueryOptionalParams extends coreClient.OperationOptions {
|
3483
|
+
/** Parameter group */
|
3484
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
3485
|
+
/** Parameter group */
|
3486
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
3487
|
+
/** Parameter group */
|
3488
|
+
cpkInfo?: CpkInfo;
|
3489
|
+
/** 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> */
|
3490
|
+
timeoutInSeconds?: number;
|
3491
|
+
/** 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. */
|
3492
|
+
requestId?: string;
|
3493
|
+
/** 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> */
|
3494
|
+
snapshot?: string;
|
3495
|
+
/** the query request */
|
3496
|
+
queryRequest?: QueryRequest;
|
3497
|
+
}
|
3498
|
+
|
2856
3499
|
/**
|
2857
3500
|
* Options to query blob with Parquet format. Only valid for {@link BlockBlobQueryOptions.inputTextConfiguration}.
|
2858
3501
|
*/
|
@@ -2864,7 +3507,7 @@ export declare interface BlobQueryParquetConfiguration {
|
|
2864
3507
|
}
|
2865
3508
|
|
2866
3509
|
/** Contains response data for the query operation. */
|
2867
|
-
export declare type
|
3510
|
+
export declare type BlobQueryResponseInternal = BlobQueryHeaders & {
|
2868
3511
|
/**
|
2869
3512
|
* BROWSER ONLY
|
2870
3513
|
*
|
@@ -2879,13 +3522,37 @@ export declare type BlobQueryResponseModel = BlobQueryHeaders & {
|
|
2879
3522
|
* Always `undefined` in the browser.
|
2880
3523
|
*/
|
2881
3524
|
readableStreamBody?: NodeJS.ReadableStream;
|
2882
|
-
/** The underlying HTTP response. */
|
2883
|
-
_response: coreHttp.HttpResponse & {
|
2884
|
-
/** The parsed HTTP response headers. */
|
2885
|
-
parsedHeaders: BlobQueryHeaders;
|
2886
|
-
};
|
2887
3525
|
};
|
2888
3526
|
|
3527
|
+
/** Contains response data for the query operation. */
|
3528
|
+
export declare type BlobQueryResponseModel = WithResponse<BlobQueryResponseInternal, BlobQueryHeaders>;
|
3529
|
+
|
3530
|
+
/** Defines headers for Blob_releaseLease operation. */
|
3531
|
+
declare interface BlobReleaseLeaseHeaders {
|
3532
|
+
/** 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. */
|
3533
|
+
etag?: string;
|
3534
|
+
/** 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. */
|
3535
|
+
lastModified?: Date;
|
3536
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
3537
|
+
clientRequestId?: string;
|
3538
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
3539
|
+
requestId?: string;
|
3540
|
+
/** 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. */
|
3541
|
+
version?: string;
|
3542
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
3543
|
+
date?: Date;
|
3544
|
+
}
|
3545
|
+
|
3546
|
+
/** Optional parameters. */
|
3547
|
+
declare interface BlobReleaseLeaseOptionalParams extends coreClient.OperationOptions {
|
3548
|
+
/** Parameter group */
|
3549
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
3550
|
+
/** 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> */
|
3551
|
+
timeoutInSeconds?: number;
|
3552
|
+
/** 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. */
|
3553
|
+
requestId?: string;
|
3554
|
+
}
|
3555
|
+
|
2889
3556
|
/**
|
2890
3557
|
* Options to configure Blob - Release Lease operation.
|
2891
3558
|
*/
|
@@ -2901,6 +3568,37 @@ export declare interface BlobReleaseLeaseOptions extends CommonOptions {
|
|
2901
3568
|
conditions?: ModifiedAccessConditions;
|
2902
3569
|
}
|
2903
3570
|
|
3571
|
+
/** Contains response data for the releaseLease operation. */
|
3572
|
+
declare type BlobReleaseLeaseResponse = BlobReleaseLeaseHeaders;
|
3573
|
+
|
3574
|
+
/** Defines headers for Blob_renewLease operation. */
|
3575
|
+
declare interface BlobRenewLeaseHeaders {
|
3576
|
+
/** 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. */
|
3577
|
+
etag?: string;
|
3578
|
+
/** 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. */
|
3579
|
+
lastModified?: Date;
|
3580
|
+
/** Uniquely identifies a blobs' lease */
|
3581
|
+
leaseId?: string;
|
3582
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
3583
|
+
clientRequestId?: string;
|
3584
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
3585
|
+
requestId?: string;
|
3586
|
+
/** 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. */
|
3587
|
+
version?: string;
|
3588
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
3589
|
+
date?: Date;
|
3590
|
+
}
|
3591
|
+
|
3592
|
+
/** Optional parameters. */
|
3593
|
+
declare interface BlobRenewLeaseOptionalParams extends coreClient.OperationOptions {
|
3594
|
+
/** Parameter group */
|
3595
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
3596
|
+
/** 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> */
|
3597
|
+
timeoutInSeconds?: number;
|
3598
|
+
/** 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. */
|
3599
|
+
requestId?: string;
|
3600
|
+
}
|
3601
|
+
|
2904
3602
|
/**
|
2905
3603
|
* Options to configure Blob - Renew Lease operation.
|
2906
3604
|
*/
|
@@ -2916,6 +3614,9 @@ export declare interface BlobRenewLeaseOptions extends CommonOptions {
|
|
2916
3614
|
conditions?: ModifiedAccessConditions;
|
2917
3615
|
}
|
2918
3616
|
|
3617
|
+
/** Contains response data for the renewLease operation. */
|
3618
|
+
declare type BlobRenewLeaseResponse = BlobRenewLeaseHeaders;
|
3619
|
+
|
2919
3620
|
/**
|
2920
3621
|
* standard HTTP conditional headers, tags condition and lease condition
|
2921
3622
|
*/
|
@@ -3599,6 +4300,35 @@ export declare interface BlobServiceStatistics {
|
|
3599
4300
|
geoReplication?: GeoReplication;
|
3600
4301
|
}
|
3601
4302
|
|
4303
|
+
/** Defines headers for Blob_setExpiry operation. */
|
4304
|
+
declare interface BlobSetExpiryHeaders {
|
4305
|
+
/** 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. */
|
4306
|
+
etag?: string;
|
4307
|
+
/** 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. */
|
4308
|
+
lastModified?: Date;
|
4309
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
4310
|
+
clientRequestId?: string;
|
4311
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
4312
|
+
requestId?: string;
|
4313
|
+
/** 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. */
|
4314
|
+
version?: string;
|
4315
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated. */
|
4316
|
+
date?: Date;
|
4317
|
+
}
|
4318
|
+
|
4319
|
+
/** Optional parameters. */
|
4320
|
+
declare interface BlobSetExpiryOptionalParams extends coreClient.OperationOptions {
|
4321
|
+
/** 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> */
|
4322
|
+
timeoutInSeconds?: number;
|
4323
|
+
/** 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. */
|
4324
|
+
requestId?: string;
|
4325
|
+
/** The time to set the blob to expiry */
|
4326
|
+
expiresOn?: string;
|
4327
|
+
}
|
4328
|
+
|
4329
|
+
/** Contains response data for the setExpiry operation. */
|
4330
|
+
declare type BlobSetExpiryResponse = BlobSetExpiryHeaders;
|
4331
|
+
|
3602
4332
|
/** Defines headers for Blob_setHttpHeaders operation. */
|
3603
4333
|
export declare interface BlobSetHTTPHeadersHeaders {
|
3604
4334
|
/** 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. */
|
@@ -3619,6 +4349,20 @@ export declare interface BlobSetHTTPHeadersHeaders {
|
|
3619
4349
|
errorCode?: string;
|
3620
4350
|
}
|
3621
4351
|
|
4352
|
+
/** Optional parameters. */
|
4353
|
+
declare interface BlobSetHttpHeadersOptionalParams extends coreClient.OperationOptions {
|
4354
|
+
/** Parameter group */
|
4355
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
4356
|
+
/** Parameter group */
|
4357
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4358
|
+
/** Parameter group */
|
4359
|
+
blobHttpHeaders?: BlobHTTPHeaders;
|
4360
|
+
/** 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> */
|
4361
|
+
timeoutInSeconds?: number;
|
4362
|
+
/** 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. */
|
4363
|
+
requestId?: string;
|
4364
|
+
}
|
4365
|
+
|
3622
4366
|
/**
|
3623
4367
|
* Options to configure the {@link BlobClient.setHTTPHeaders} operation.
|
3624
4368
|
*/
|
@@ -3639,13 +4383,10 @@ export declare interface BlobSetHTTPHeadersOptions extends CommonOptions {
|
|
3639
4383
|
}
|
3640
4384
|
|
3641
4385
|
/** Contains response data for the setHttpHeaders operation. */
|
3642
|
-
export declare type BlobSetHTTPHeadersResponse = BlobSetHTTPHeadersHeaders
|
3643
|
-
|
3644
|
-
|
3645
|
-
|
3646
|
-
parsedHeaders: BlobSetHTTPHeadersHeaders;
|
3647
|
-
};
|
3648
|
-
};
|
4386
|
+
export declare type BlobSetHTTPHeadersResponse = WithResponse<BlobSetHTTPHeadersHeaders, BlobSetHTTPHeadersHeaders>;
|
4387
|
+
|
4388
|
+
/** Contains response data for the setHttpHeaders operation. */
|
4389
|
+
declare type BlobSetHttpHeadersResponse = BlobSetHTTPHeadersHeaders;
|
3649
4390
|
|
3650
4391
|
/** Defines headers for Blob_setImmutabilityPolicy operation. */
|
3651
4392
|
export declare interface BlobSetImmutabilityPolicyHeaders {
|
@@ -3663,6 +4404,20 @@ export declare interface BlobSetImmutabilityPolicyHeaders {
|
|
3663
4404
|
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
3664
4405
|
}
|
3665
4406
|
|
4407
|
+
/** Optional parameters. */
|
4408
|
+
declare interface BlobSetImmutabilityPolicyOptionalParams extends coreClient.OperationOptions {
|
4409
|
+
/** Parameter group */
|
4410
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4411
|
+
/** 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> */
|
4412
|
+
timeoutInSeconds?: number;
|
4413
|
+
/** 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. */
|
4414
|
+
requestId?: string;
|
4415
|
+
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
4416
|
+
immutabilityPolicyExpiry?: Date;
|
4417
|
+
/** Specifies the immutability policy mode to set on the blob. */
|
4418
|
+
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
4419
|
+
}
|
4420
|
+
|
3666
4421
|
/**
|
3667
4422
|
* Options for setting immutability policy {@link BlobClient.setImmutabilityPolicy} operation.
|
3668
4423
|
*/
|
@@ -3676,13 +4431,10 @@ export declare interface BlobSetImmutabilityPolicyOptions extends CommonOptions
|
|
3676
4431
|
}
|
3677
4432
|
|
3678
4433
|
/** Contains response data for the setImmutabilityPolicy operation. */
|
3679
|
-
export declare type BlobSetImmutabilityPolicyResponse = BlobSetImmutabilityPolicyHeaders
|
3680
|
-
|
3681
|
-
|
3682
|
-
|
3683
|
-
parsedHeaders: BlobSetImmutabilityPolicyHeaders;
|
3684
|
-
};
|
3685
|
-
};
|
4434
|
+
export declare type BlobSetImmutabilityPolicyResponse = WithResponse<BlobSetImmutabilityPolicyHeaders, BlobSetImmutabilityPolicyHeaders>;
|
4435
|
+
|
4436
|
+
/** Contains response data for the setImmutabilityPolicy operation. */
|
4437
|
+
declare type BlobSetImmutabilityPolicyResponse_2 = BlobSetImmutabilityPolicyHeaders;
|
3686
4438
|
|
3687
4439
|
/** Defines headers for Blob_setLegalHold operation. */
|
3688
4440
|
export declare interface BlobSetLegalHoldHeaders {
|
@@ -3698,6 +4450,14 @@ export declare interface BlobSetLegalHoldHeaders {
|
|
3698
4450
|
legalHold?: boolean;
|
3699
4451
|
}
|
3700
4452
|
|
4453
|
+
/** Optional parameters. */
|
4454
|
+
declare interface BlobSetLegalHoldOptionalParams extends coreClient.OperationOptions {
|
4455
|
+
/** 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> */
|
4456
|
+
timeoutInSeconds?: number;
|
4457
|
+
/** 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. */
|
4458
|
+
requestId?: string;
|
4459
|
+
}
|
4460
|
+
|
3701
4461
|
/**
|
3702
4462
|
* Options for setting legal hold {@link BlobClient.setLegalHold} operation.
|
3703
4463
|
*/
|
@@ -3710,13 +4470,10 @@ export declare interface BlobSetLegalHoldOptions extends CommonOptions {
|
|
3710
4470
|
}
|
3711
4471
|
|
3712
4472
|
/** Contains response data for the setLegalHold operation. */
|
3713
|
-
export declare type BlobSetLegalHoldResponse = BlobSetLegalHoldHeaders
|
3714
|
-
|
3715
|
-
|
3716
|
-
|
3717
|
-
parsedHeaders: BlobSetLegalHoldHeaders;
|
3718
|
-
};
|
3719
|
-
};
|
4473
|
+
export declare type BlobSetLegalHoldResponse = WithResponse<BlobSetLegalHoldHeaders, BlobSetLegalHoldHeaders>;
|
4474
|
+
|
4475
|
+
/** Contains response data for the setLegalHold operation. */
|
4476
|
+
declare type BlobSetLegalHoldResponse_2 = BlobSetLegalHoldHeaders;
|
3720
4477
|
|
3721
4478
|
/** Defines headers for Blob_setMetadata operation. */
|
3722
4479
|
export declare interface BlobSetMetadataHeaders {
|
@@ -3744,6 +4501,26 @@ export declare interface BlobSetMetadataHeaders {
|
|
3744
4501
|
errorCode?: string;
|
3745
4502
|
}
|
3746
4503
|
|
4504
|
+
/** Optional parameters. */
|
4505
|
+
declare interface BlobSetMetadataOptionalParams extends coreClient.OperationOptions {
|
4506
|
+
/** Parameter group */
|
4507
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
4508
|
+
/** Parameter group */
|
4509
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4510
|
+
/** Parameter group */
|
4511
|
+
cpkInfo?: CpkInfo;
|
4512
|
+
/** 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> */
|
4513
|
+
timeoutInSeconds?: number;
|
4514
|
+
/** 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. */
|
4515
|
+
requestId?: string;
|
4516
|
+
/** 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. */
|
4517
|
+
metadata?: {
|
4518
|
+
[propertyName: string]: string;
|
4519
|
+
};
|
4520
|
+
/** 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. */
|
4521
|
+
encryptionScope?: string;
|
4522
|
+
}
|
4523
|
+
|
3747
4524
|
/**
|
3748
4525
|
* Options to configure the {@link BlobClient.setMetadata} operation.
|
3749
4526
|
*/
|
@@ -3771,13 +4548,10 @@ export declare interface BlobSetMetadataOptions extends CommonOptions {
|
|
3771
4548
|
}
|
3772
4549
|
|
3773
4550
|
/** Contains response data for the setMetadata operation. */
|
3774
|
-
export declare type BlobSetMetadataResponse = BlobSetMetadataHeaders
|
3775
|
-
|
3776
|
-
|
3777
|
-
|
3778
|
-
parsedHeaders: BlobSetMetadataHeaders;
|
3779
|
-
};
|
3780
|
-
};
|
4551
|
+
export declare type BlobSetMetadataResponse = WithResponse<BlobSetMetadataHeaders, BlobSetMetadataHeaders>;
|
4552
|
+
|
4553
|
+
/** Contains response data for the setMetadata operation. */
|
4554
|
+
declare type BlobSetMetadataResponse_2 = BlobSetMetadataHeaders;
|
3781
4555
|
|
3782
4556
|
/** Defines headers for Blob_setTags operation. */
|
3783
4557
|
export declare interface BlobSetTagsHeaders {
|
@@ -3793,6 +4567,26 @@ export declare interface BlobSetTagsHeaders {
|
|
3793
4567
|
errorCode?: string;
|
3794
4568
|
}
|
3795
4569
|
|
4570
|
+
/** Optional parameters. */
|
4571
|
+
declare interface BlobSetTagsOptionalParams extends coreClient.OperationOptions {
|
4572
|
+
/** Parameter group */
|
4573
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
4574
|
+
/** Parameter group */
|
4575
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4576
|
+
/** 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> */
|
4577
|
+
timeoutInSeconds?: number;
|
4578
|
+
/** 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. */
|
4579
|
+
requestId?: string;
|
4580
|
+
/** 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. */
|
4581
|
+
versionId?: string;
|
4582
|
+
/** Blob tags */
|
4583
|
+
tags?: BlobTags;
|
4584
|
+
/** Specify the transactional md5 for the body, to be validated by the service. */
|
4585
|
+
transactionalContentMD5?: Uint8Array;
|
4586
|
+
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
4587
|
+
transactionalContentCrc64?: Uint8Array;
|
4588
|
+
}
|
4589
|
+
|
3796
4590
|
/**
|
3797
4591
|
* Options to configure the {@link BlobClient.setTags} operation.
|
3798
4592
|
*/
|
@@ -3809,13 +4603,10 @@ export declare interface BlobSetTagsOptions extends CommonOptions {
|
|
3809
4603
|
}
|
3810
4604
|
|
3811
4605
|
/** Contains response data for the setTags operation. */
|
3812
|
-
export declare type BlobSetTagsResponse = BlobSetTagsHeaders
|
3813
|
-
|
3814
|
-
|
3815
|
-
|
3816
|
-
parsedHeaders: BlobSetTagsHeaders;
|
3817
|
-
};
|
3818
|
-
};
|
4606
|
+
export declare type BlobSetTagsResponse = WithResponse<BlobSetTagsHeaders, BlobSetTagsHeaders>;
|
4607
|
+
|
4608
|
+
/** Contains response data for the setTags operation. */
|
4609
|
+
declare type BlobSetTagsResponse_2 = BlobSetTagsHeaders;
|
3819
4610
|
|
3820
4611
|
/** Defines headers for Blob_setTier operation. */
|
3821
4612
|
export declare interface BlobSetTierHeaders {
|
@@ -3829,6 +4620,24 @@ export declare interface BlobSetTierHeaders {
|
|
3829
4620
|
errorCode?: string;
|
3830
4621
|
}
|
3831
4622
|
|
4623
|
+
/** Optional parameters. */
|
4624
|
+
declare interface BlobSetTierOptionalParams extends coreClient.OperationOptions {
|
4625
|
+
/** Parameter group */
|
4626
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
4627
|
+
/** Parameter group */
|
4628
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4629
|
+
/** 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> */
|
4630
|
+
timeoutInSeconds?: number;
|
4631
|
+
/** 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. */
|
4632
|
+
requestId?: string;
|
4633
|
+
/** 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> */
|
4634
|
+
snapshot?: string;
|
4635
|
+
/** 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. */
|
4636
|
+
versionId?: string;
|
4637
|
+
/** Optional: Indicates the priority with which to rehydrate an archived blob. */
|
4638
|
+
rehydratePriority?: RehydratePriority;
|
4639
|
+
}
|
4640
|
+
|
3832
4641
|
/**
|
3833
4642
|
* Options to configure the {@link BlobClient.setAccessTier} operation.
|
3834
4643
|
*/
|
@@ -3851,13 +4660,10 @@ export declare interface BlobSetTierOptions extends CommonOptions {
|
|
3851
4660
|
}
|
3852
4661
|
|
3853
4662
|
/** Contains response data for the setTier operation. */
|
3854
|
-
export declare type BlobSetTierResponse = BlobSetTierHeaders
|
3855
|
-
|
3856
|
-
|
3857
|
-
|
3858
|
-
parsedHeaders: BlobSetTierHeaders;
|
3859
|
-
};
|
3860
|
-
};
|
4663
|
+
export declare type BlobSetTierResponse = WithResponse<BlobSetTierHeaders, BlobSetTierHeaders>;
|
4664
|
+
|
4665
|
+
/** Contains response data for the setTier operation. */
|
4666
|
+
declare type BlobSetTierResponse_2 = BlobSetTierHeaders;
|
3861
4667
|
|
3862
4668
|
/** Defines headers for Blob_startCopyFromURL operation. */
|
3863
4669
|
export declare interface BlobStartCopyFromURLHeaders {
|
@@ -3883,24 +4689,56 @@ export declare interface BlobStartCopyFromURLHeaders {
|
|
3883
4689
|
errorCode?: string;
|
3884
4690
|
}
|
3885
4691
|
|
3886
|
-
/**
|
3887
|
-
|
3888
|
-
*/
|
3889
|
-
|
3890
|
-
/**
|
3891
|
-
|
3892
|
-
|
3893
|
-
|
3894
|
-
|
3895
|
-
|
3896
|
-
|
3897
|
-
|
3898
|
-
metadata
|
3899
|
-
|
3900
|
-
|
3901
|
-
|
3902
|
-
|
3903
|
-
|
4692
|
+
/** Optional parameters. */
|
4693
|
+
declare interface BlobStartCopyFromURLOptionalParams extends coreClient.OperationOptions {
|
4694
|
+
/** Parameter group */
|
4695
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
4696
|
+
/** Parameter group */
|
4697
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
4698
|
+
/** Parameter group */
|
4699
|
+
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
4700
|
+
/** 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> */
|
4701
|
+
timeoutInSeconds?: number;
|
4702
|
+
/** 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. */
|
4703
|
+
requestId?: string;
|
4704
|
+
/** 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. */
|
4705
|
+
metadata?: {
|
4706
|
+
[propertyName: string]: string;
|
4707
|
+
};
|
4708
|
+
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
4709
|
+
immutabilityPolicyExpiry?: Date;
|
4710
|
+
/** Specifies the immutability policy mode to set on the blob. */
|
4711
|
+
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
4712
|
+
/** Optional. Indicates the tier to be set on the blob. */
|
4713
|
+
tier?: AccessTier;
|
4714
|
+
/** Optional: Indicates the priority with which to rehydrate an archived blob. */
|
4715
|
+
rehydratePriority?: RehydratePriority;
|
4716
|
+
/** Optional. Used to set blob tags in various blob operations. */
|
4717
|
+
blobTagsString?: string;
|
4718
|
+
/** Overrides the sealed state of the destination blob. Service version 2019-12-12 and newer. */
|
4719
|
+
sealBlob?: boolean;
|
4720
|
+
/** Specified if a legal hold should be set on the blob. */
|
4721
|
+
legalHold?: boolean;
|
4722
|
+
}
|
4723
|
+
|
4724
|
+
/**
|
4725
|
+
* Options to configure the {@link BlobClient.beginCopyFromURL} operation.
|
4726
|
+
*/
|
4727
|
+
export declare interface BlobStartCopyFromURLOptions extends CommonOptions {
|
4728
|
+
/**
|
4729
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
4730
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
4731
|
+
*/
|
4732
|
+
abortSignal?: AbortSignalLike;
|
4733
|
+
/**
|
4734
|
+
* A collection of key-value string pair to associate with the blob that are being copied.
|
4735
|
+
*/
|
4736
|
+
metadata?: Metadata;
|
4737
|
+
/**
|
4738
|
+
* Conditions to meet for the destination blob when copying from a URL to the blob.
|
4739
|
+
*/
|
4740
|
+
conditions?: BlobRequestConditions;
|
4741
|
+
/**
|
3904
4742
|
* Conditions to meet for the source Azure Blob/File when copying from a URL to the blob.
|
3905
4743
|
*/
|
3906
4744
|
sourceConditions?: ModifiedAccessConditions;
|
@@ -3937,13 +4775,10 @@ export declare interface BlobStartCopyFromURLOptions extends CommonOptions {
|
|
3937
4775
|
}
|
3938
4776
|
|
3939
4777
|
/** Contains response data for the startCopyFromURL operation. */
|
3940
|
-
export declare type BlobStartCopyFromURLResponse = BlobStartCopyFromURLHeaders
|
3941
|
-
|
3942
|
-
|
3943
|
-
|
3944
|
-
parsedHeaders: BlobStartCopyFromURLHeaders;
|
3945
|
-
};
|
3946
|
-
};
|
4778
|
+
export declare type BlobStartCopyFromURLResponse = WithResponse<BlobStartCopyFromURLHeaders, BlobStartCopyFromURLHeaders>;
|
4779
|
+
|
4780
|
+
/** Contains response data for the startCopyFromURL operation. */
|
4781
|
+
declare type BlobStartCopyFromURLResponse_2 = BlobStartCopyFromURLHeaders;
|
3947
4782
|
|
3948
4783
|
/**
|
3949
4784
|
* Options to configure the {@link BlobClient.syncCopyFromURL} operation.
|
@@ -4032,6 +4867,14 @@ export declare interface BlobUndeleteHeaders {
|
|
4032
4867
|
errorCode?: string;
|
4033
4868
|
}
|
4034
4869
|
|
4870
|
+
/** Optional parameters. */
|
4871
|
+
declare interface BlobUndeleteOptionalParams extends coreClient.OperationOptions {
|
4872
|
+
/** 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> */
|
4873
|
+
timeoutInSeconds?: number;
|
4874
|
+
/** 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. */
|
4875
|
+
requestId?: string;
|
4876
|
+
}
|
4877
|
+
|
4035
4878
|
/**
|
4036
4879
|
* Options to configure the {@link BlobClient.undelete} operation.
|
4037
4880
|
*/
|
@@ -4048,24 +4891,16 @@ export declare interface BlobUndeleteOptions extends CommonOptions {
|
|
4048
4891
|
}
|
4049
4892
|
|
4050
4893
|
/** Contains response data for the undelete operation. */
|
4051
|
-
export declare type BlobUndeleteResponse = BlobUndeleteHeaders
|
4052
|
-
|
4053
|
-
|
4054
|
-
|
4055
|
-
parsedHeaders: BlobUndeleteHeaders;
|
4056
|
-
};
|
4057
|
-
};
|
4894
|
+
export declare type BlobUndeleteResponse = WithResponse<BlobUndeleteHeaders, BlobUndeleteHeaders>;
|
4895
|
+
|
4896
|
+
/** Contains response data for the undelete operation. */
|
4897
|
+
declare type BlobUndeleteResponse_2 = BlobUndeleteHeaders;
|
4058
4898
|
|
4059
4899
|
/**
|
4060
4900
|
* Response type for {@link BlockBlobClient.uploadFile}, {@link BlockBlobClient.uploadStream}, and
|
4061
4901
|
* {@link BlockBlobClient.uploadBrowserDate}.
|
4062
4902
|
*/
|
4063
|
-
export declare type BlobUploadCommonResponse = BlockBlobUploadHeaders
|
4064
|
-
/**
|
4065
|
-
* The underlying HTTP response.
|
4066
|
-
*/
|
4067
|
-
_response: HttpResponse;
|
4068
|
-
};
|
4903
|
+
export declare type BlobUploadCommonResponse = WithResponse<BlockBlobUploadHeaders>;
|
4069
4904
|
|
4070
4905
|
/** Represents a single block in a block blob. It describes the block's ID and size. */
|
4071
4906
|
export declare interface Block {
|
@@ -4075,6 +4910,75 @@ export declare interface Block {
|
|
4075
4910
|
size: number;
|
4076
4911
|
}
|
4077
4912
|
|
4913
|
+
/** Interface representing a BlockBlob. */
|
4914
|
+
declare interface BlockBlob {
|
4915
|
+
/**
|
4916
|
+
* The Upload Block Blob operation updates the content of an existing block blob. Updating an existing
|
4917
|
+
* block blob overwrites any existing metadata on the blob. Partial updates are not supported with Put
|
4918
|
+
* Blob; the content of the existing blob is overwritten with the content of the new blob. To perform a
|
4919
|
+
* partial update of the content of a block blob, use the Put Block List operation.
|
4920
|
+
* @param contentLength The length of the request.
|
4921
|
+
* @param body Initial data
|
4922
|
+
* @param options The options parameters.
|
4923
|
+
*/
|
4924
|
+
upload(contentLength: number, body: coreRestPipeline.RequestBodyType, options?: BlockBlobUploadOptionalParams): Promise<BlockBlobUploadResponse_2>;
|
4925
|
+
/**
|
4926
|
+
* The Put Blob from URL operation creates a new Block Blob where the contents of the blob are read
|
4927
|
+
* from a given URL. This API is supported beginning with the 2020-04-08 version. Partial updates are
|
4928
|
+
* not supported with Put Blob from URL; the content of an existing blob is overwritten with the
|
4929
|
+
* content of the new blob. To perform partial updates to a block blob’s contents using a source URL,
|
4930
|
+
* use the Put Block from URL API in conjunction with Put Block List.
|
4931
|
+
* @param contentLength The length of the request.
|
4932
|
+
* @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
|
4933
|
+
* 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
|
4934
|
+
* appear in a request URI. The source blob must either be public or must be authenticated via a shared
|
4935
|
+
* access signature.
|
4936
|
+
* @param options The options parameters.
|
4937
|
+
*/
|
4938
|
+
putBlobFromUrl(contentLength: number, copySource: string, options?: BlockBlobPutBlobFromUrlOptionalParams): Promise<BlockBlobPutBlobFromUrlResponse_2>;
|
4939
|
+
/**
|
4940
|
+
* The Stage Block operation creates a new block to be committed as part of a blob
|
4941
|
+
* @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
|
4942
|
+
* must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
|
4943
|
+
* for the blockid parameter must be the same size for each block.
|
4944
|
+
* @param contentLength The length of the request.
|
4945
|
+
* @param body Initial data
|
4946
|
+
* @param options The options parameters.
|
4947
|
+
*/
|
4948
|
+
stageBlock(blockId: string, contentLength: number, body: coreRestPipeline.RequestBodyType, options?: BlockBlobStageBlockOptionalParams): Promise<BlockBlobStageBlockResponse_2>;
|
4949
|
+
/**
|
4950
|
+
* The Stage Block operation creates a new block to be committed as part of a blob where the contents
|
4951
|
+
* are read from a URL.
|
4952
|
+
* @param blockId A valid Base64 string value that identifies the block. Prior to encoding, the string
|
4953
|
+
* must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified
|
4954
|
+
* for the blockid parameter must be the same size for each block.
|
4955
|
+
* @param contentLength The length of the request.
|
4956
|
+
* @param sourceUrl Specify a URL to the copy source.
|
4957
|
+
* @param options The options parameters.
|
4958
|
+
*/
|
4959
|
+
stageBlockFromURL(blockId: string, contentLength: number, sourceUrl: string, options?: BlockBlobStageBlockFromURLOptionalParams): Promise<BlockBlobStageBlockFromURLResponse_2>;
|
4960
|
+
/**
|
4961
|
+
* The Commit Block List operation writes a blob by specifying the list of block IDs that make up the
|
4962
|
+
* blob. In order to be written as part of a blob, a block must have been successfully written to the
|
4963
|
+
* server in a prior Put Block operation. You can call Put Block List to update a blob by uploading
|
4964
|
+
* only those blocks that have changed, then committing the new and existing blocks together. You can
|
4965
|
+
* do this by specifying whether to commit a block from the committed block list or from the
|
4966
|
+
* uncommitted block list, or to commit the most recently uploaded version of the block, whichever list
|
4967
|
+
* it may belong to.
|
4968
|
+
* @param blocks Blob Blocks.
|
4969
|
+
* @param options The options parameters.
|
4970
|
+
*/
|
4971
|
+
commitBlockList(blocks: BlockLookupList, options?: BlockBlobCommitBlockListOptionalParams): Promise<BlockBlobCommitBlockListResponse_2>;
|
4972
|
+
/**
|
4973
|
+
* The Get Block List operation retrieves the list of blocks that have been uploaded as part of a block
|
4974
|
+
* blob
|
4975
|
+
* @param listType Specifies whether to return the list of committed blocks, the list of uncommitted
|
4976
|
+
* blocks, or both lists together.
|
4977
|
+
* @param options The options parameters.
|
4978
|
+
*/
|
4979
|
+
getBlockList(listType: BlockListType, options?: BlockBlobGetBlockListOptionalParams): Promise<BlockBlobGetBlockListResponseInternal>;
|
4980
|
+
}
|
4981
|
+
|
4078
4982
|
/**
|
4079
4983
|
* BlockBlobClient defines a set of operations applicable to block blobs.
|
4080
4984
|
*/
|
@@ -4401,6 +5305,42 @@ export declare interface BlockBlobCommitBlockListHeaders {
|
|
4401
5305
|
errorCode?: string;
|
4402
5306
|
}
|
4403
5307
|
|
5308
|
+
/** Optional parameters. */
|
5309
|
+
declare interface BlockBlobCommitBlockListOptionalParams extends coreClient.OperationOptions {
|
5310
|
+
/** Parameter group */
|
5311
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5312
|
+
/** Parameter group */
|
5313
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5314
|
+
/** Parameter group */
|
5315
|
+
cpkInfo?: CpkInfo;
|
5316
|
+
/** Parameter group */
|
5317
|
+
blobHttpHeaders?: BlobHTTPHeaders;
|
5318
|
+
/** 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> */
|
5319
|
+
timeoutInSeconds?: number;
|
5320
|
+
/** 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. */
|
5321
|
+
requestId?: string;
|
5322
|
+
/** 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. */
|
5323
|
+
metadata?: {
|
5324
|
+
[propertyName: string]: string;
|
5325
|
+
};
|
5326
|
+
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
5327
|
+
immutabilityPolicyExpiry?: Date;
|
5328
|
+
/** Specifies the immutability policy mode to set on the blob. */
|
5329
|
+
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
5330
|
+
/** 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. */
|
5331
|
+
encryptionScope?: string;
|
5332
|
+
/** Optional. Indicates the tier to be set on the blob. */
|
5333
|
+
tier?: AccessTier;
|
5334
|
+
/** Optional. Used to set blob tags in various blob operations. */
|
5335
|
+
blobTagsString?: string;
|
5336
|
+
/** Specified if a legal hold should be set on the blob. */
|
5337
|
+
legalHold?: boolean;
|
5338
|
+
/** Specify the transactional md5 for the body, to be validated by the service. */
|
5339
|
+
transactionalContentMD5?: Uint8Array;
|
5340
|
+
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
5341
|
+
transactionalContentCrc64?: Uint8Array;
|
5342
|
+
}
|
5343
|
+
|
4404
5344
|
/**
|
4405
5345
|
* Options to configure {@link BlockBlobClient.commitBlockList} operation.
|
4406
5346
|
*/
|
@@ -4457,13 +5397,10 @@ export declare interface BlockBlobCommitBlockListOptions extends CommonOptions {
|
|
4457
5397
|
}
|
4458
5398
|
|
4459
5399
|
/** Contains response data for the commitBlockList operation. */
|
4460
|
-
export declare type BlockBlobCommitBlockListResponse = BlockBlobCommitBlockListHeaders
|
4461
|
-
|
4462
|
-
|
4463
|
-
|
4464
|
-
parsedHeaders: BlockBlobCommitBlockListHeaders;
|
4465
|
-
};
|
4466
|
-
};
|
5400
|
+
export declare type BlockBlobCommitBlockListResponse = WithResponse<BlockBlobCommitBlockListHeaders, BlockBlobCommitBlockListHeaders>;
|
5401
|
+
|
5402
|
+
/** Contains response data for the commitBlockList operation. */
|
5403
|
+
declare type BlockBlobCommitBlockListResponse_2 = BlockBlobCommitBlockListHeaders;
|
4467
5404
|
|
4468
5405
|
/** Defines headers for BlockBlob_getBlockList operation. */
|
4469
5406
|
export declare interface BlockBlobGetBlockListHeaders {
|
@@ -4487,6 +5424,20 @@ export declare interface BlockBlobGetBlockListHeaders {
|
|
4487
5424
|
errorCode?: string;
|
4488
5425
|
}
|
4489
5426
|
|
5427
|
+
/** Optional parameters. */
|
5428
|
+
declare interface BlockBlobGetBlockListOptionalParams extends coreClient.OperationOptions {
|
5429
|
+
/** Parameter group */
|
5430
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5431
|
+
/** Parameter group */
|
5432
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5433
|
+
/** 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> */
|
5434
|
+
timeoutInSeconds?: number;
|
5435
|
+
/** 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. */
|
5436
|
+
requestId?: string;
|
5437
|
+
/** 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> */
|
5438
|
+
snapshot?: string;
|
5439
|
+
}
|
5440
|
+
|
4490
5441
|
/**
|
4491
5442
|
* Options to configure {@link BlockBlobClient.getBlockList} operation.
|
4492
5443
|
*/
|
@@ -4504,17 +5455,10 @@ export declare interface BlockBlobGetBlockListOptions extends CommonOptions {
|
|
4504
5455
|
}
|
4505
5456
|
|
4506
5457
|
/** Contains response data for the getBlockList operation. */
|
4507
|
-
export declare type BlockBlobGetBlockListResponse = BlockBlobGetBlockListHeaders
|
4508
|
-
|
4509
|
-
|
4510
|
-
|
4511
|
-
bodyAsText: string;
|
4512
|
-
/** The response body as parsed JSON or XML */
|
4513
|
-
parsedBody: BlockList;
|
4514
|
-
/** The parsed HTTP response headers. */
|
4515
|
-
parsedHeaders: BlockBlobGetBlockListHeaders;
|
4516
|
-
};
|
4517
|
-
};
|
5458
|
+
export declare type BlockBlobGetBlockListResponse = WithResponse<BlockBlobGetBlockListResponseInternal, BlockBlobGetBlockListHeaders>;
|
5459
|
+
|
5460
|
+
/** Contains response data for the getBlockList operation. */
|
5461
|
+
export declare type BlockBlobGetBlockListResponseInternal = BlockBlobGetBlockListHeaders & BlockList;
|
4518
5462
|
|
4519
5463
|
/**
|
4520
5464
|
* Option interface for {@link BlockBlobClient.uploadFile} and {@link BlockBlobClient.uploadSeekableStream}.
|
@@ -4607,14 +5551,49 @@ export declare interface BlockBlobPutBlobFromUrlHeaders {
|
|
4607
5551
|
errorCode?: string;
|
4608
5552
|
}
|
4609
5553
|
|
4610
|
-
/**
|
4611
|
-
|
4612
|
-
/**
|
4613
|
-
|
4614
|
-
|
4615
|
-
|
5554
|
+
/** Optional parameters. */
|
5555
|
+
declare interface BlockBlobPutBlobFromUrlOptionalParams extends coreClient.OperationOptions {
|
5556
|
+
/** Parameter group */
|
5557
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5558
|
+
/** Parameter group */
|
5559
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5560
|
+
/** Parameter group */
|
5561
|
+
cpkInfo?: CpkInfo;
|
5562
|
+
/** Parameter group */
|
5563
|
+
blobHttpHeaders?: BlobHTTPHeaders;
|
5564
|
+
/** Parameter group */
|
5565
|
+
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
5566
|
+
/** 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> */
|
5567
|
+
timeoutInSeconds?: number;
|
5568
|
+
/** 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. */
|
5569
|
+
requestId?: string;
|
5570
|
+
/** 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. */
|
5571
|
+
metadata?: {
|
5572
|
+
[propertyName: string]: string;
|
4616
5573
|
};
|
4617
|
-
|
5574
|
+
/** 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. */
|
5575
|
+
encryptionScope?: string;
|
5576
|
+
/** Optional. Indicates the tier to be set on the blob. */
|
5577
|
+
tier?: AccessTier;
|
5578
|
+
/** Optional. Used to set blob tags in various blob operations. */
|
5579
|
+
blobTagsString?: string;
|
5580
|
+
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
5581
|
+
sourceContentMD5?: Uint8Array;
|
5582
|
+
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
5583
|
+
copySourceAuthorization?: string;
|
5584
|
+
/** Optional, default 'replace'. Indicates if source tags should be copied or replaced with the tags specified by x-ms-tags. */
|
5585
|
+
copySourceTags?: BlobCopySourceTags;
|
5586
|
+
/** Specify the transactional md5 for the body, to be validated by the service. */
|
5587
|
+
transactionalContentMD5?: Uint8Array;
|
5588
|
+
/** Optional, default is true. Indicates if properties from the source blob should be copied. */
|
5589
|
+
copySourceBlobProperties?: boolean;
|
5590
|
+
}
|
5591
|
+
|
5592
|
+
/** Contains response data for the putBlobFromUrl operation. */
|
5593
|
+
export declare type BlockBlobPutBlobFromUrlResponse = WithResponse<BlockBlobPutBlobFromUrlHeaders, BlockBlobPutBlobFromUrlHeaders>;
|
5594
|
+
|
5595
|
+
/** Contains response data for the putBlobFromUrl operation. */
|
5596
|
+
declare type BlockBlobPutBlobFromUrlResponse_2 = BlockBlobPutBlobFromUrlHeaders;
|
4618
5597
|
|
4619
5598
|
/**
|
4620
5599
|
* Options to configure {@link BlockBlobClient.query} operation.
|
@@ -4675,6 +5654,30 @@ export declare interface BlockBlobStageBlockFromURLHeaders {
|
|
4675
5654
|
errorCode?: string;
|
4676
5655
|
}
|
4677
5656
|
|
5657
|
+
/** Optional parameters. */
|
5658
|
+
declare interface BlockBlobStageBlockFromURLOptionalParams extends coreClient.OperationOptions {
|
5659
|
+
/** Parameter group */
|
5660
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5661
|
+
/** Parameter group */
|
5662
|
+
cpkInfo?: CpkInfo;
|
5663
|
+
/** Parameter group */
|
5664
|
+
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
5665
|
+
/** 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> */
|
5666
|
+
timeoutInSeconds?: number;
|
5667
|
+
/** 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. */
|
5668
|
+
requestId?: string;
|
5669
|
+
/** 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. */
|
5670
|
+
encryptionScope?: string;
|
5671
|
+
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
5672
|
+
sourceContentMD5?: Uint8Array;
|
5673
|
+
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
5674
|
+
copySourceAuthorization?: string;
|
5675
|
+
/** Specify the crc64 calculated for the range of bytes that must be read from the copy source. */
|
5676
|
+
sourceContentCrc64?: Uint8Array;
|
5677
|
+
/** Bytes of source data in the specified range. */
|
5678
|
+
sourceRange?: string;
|
5679
|
+
}
|
5680
|
+
|
4678
5681
|
/**
|
4679
5682
|
* Options to configure {@link BlockBlobClient.stageBlockFromURL} operation.
|
4680
5683
|
*/
|
@@ -4728,13 +5731,10 @@ export declare interface BlockBlobStageBlockFromURLOptions extends CommonOptions
|
|
4728
5731
|
}
|
4729
5732
|
|
4730
5733
|
/** Contains response data for the stageBlockFromURL operation. */
|
4731
|
-
export declare type BlockBlobStageBlockFromURLResponse = BlockBlobStageBlockFromURLHeaders
|
4732
|
-
|
4733
|
-
|
4734
|
-
|
4735
|
-
parsedHeaders: BlockBlobStageBlockFromURLHeaders;
|
4736
|
-
};
|
4737
|
-
};
|
5734
|
+
export declare type BlockBlobStageBlockFromURLResponse = WithResponse<BlockBlobStageBlockFromURLHeaders, BlockBlobStageBlockFromURLHeaders>;
|
5735
|
+
|
5736
|
+
/** Contains response data for the stageBlockFromURL operation. */
|
5737
|
+
declare type BlockBlobStageBlockFromURLResponse_2 = BlockBlobStageBlockFromURLHeaders;
|
4738
5738
|
|
4739
5739
|
/** Defines headers for BlockBlob_stageBlock operation. */
|
4740
5740
|
export declare interface BlockBlobStageBlockHeaders {
|
@@ -4760,6 +5760,24 @@ export declare interface BlockBlobStageBlockHeaders {
|
|
4760
5760
|
errorCode?: string;
|
4761
5761
|
}
|
4762
5762
|
|
5763
|
+
/** Optional parameters. */
|
5764
|
+
declare interface BlockBlobStageBlockOptionalParams extends coreClient.OperationOptions {
|
5765
|
+
/** Parameter group */
|
5766
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5767
|
+
/** Parameter group */
|
5768
|
+
cpkInfo?: CpkInfo;
|
5769
|
+
/** 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> */
|
5770
|
+
timeoutInSeconds?: number;
|
5771
|
+
/** 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. */
|
5772
|
+
requestId?: string;
|
5773
|
+
/** 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. */
|
5774
|
+
encryptionScope?: string;
|
5775
|
+
/** Specify the transactional md5 for the body, to be validated by the service. */
|
5776
|
+
transactionalContentMD5?: Uint8Array;
|
5777
|
+
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
5778
|
+
transactionalContentCrc64?: Uint8Array;
|
5779
|
+
}
|
5780
|
+
|
4763
5781
|
/**
|
4764
5782
|
* Options to configure {@link BlockBlobClient.stageBlock} operation.
|
4765
5783
|
*/
|
@@ -4806,13 +5824,10 @@ export declare interface BlockBlobStageBlockOptions extends CommonOptions {
|
|
4806
5824
|
}
|
4807
5825
|
|
4808
5826
|
/** Contains response data for the stageBlock operation. */
|
4809
|
-
export declare type BlockBlobStageBlockResponse = BlockBlobStageBlockHeaders
|
4810
|
-
|
4811
|
-
|
4812
|
-
|
4813
|
-
parsedHeaders: BlockBlobStageBlockHeaders;
|
4814
|
-
};
|
4815
|
-
};
|
5827
|
+
export declare type BlockBlobStageBlockResponse = WithResponse<BlockBlobStageBlockHeaders, BlockBlobStageBlockHeaders>;
|
5828
|
+
|
5829
|
+
/** Contains response data for the stageBlock operation. */
|
5830
|
+
declare type BlockBlobStageBlockResponse_2 = BlockBlobStageBlockHeaders;
|
4816
5831
|
|
4817
5832
|
/**
|
4818
5833
|
* Options to configure {@link BlockBlobClient.syncUploadFromURL} operation.
|
@@ -4944,6 +5959,42 @@ export declare interface BlockBlobUploadHeaders {
|
|
4944
5959
|
errorCode?: string;
|
4945
5960
|
}
|
4946
5961
|
|
5962
|
+
/** Optional parameters. */
|
5963
|
+
declare interface BlockBlobUploadOptionalParams extends coreClient.OperationOptions {
|
5964
|
+
/** Parameter group */
|
5965
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
5966
|
+
/** Parameter group */
|
5967
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5968
|
+
/** Parameter group */
|
5969
|
+
cpkInfo?: CpkInfo;
|
5970
|
+
/** Parameter group */
|
5971
|
+
blobHttpHeaders?: BlobHTTPHeaders;
|
5972
|
+
/** 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> */
|
5973
|
+
timeoutInSeconds?: number;
|
5974
|
+
/** 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. */
|
5975
|
+
requestId?: string;
|
5976
|
+
/** 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. */
|
5977
|
+
metadata?: {
|
5978
|
+
[propertyName: string]: string;
|
5979
|
+
};
|
5980
|
+
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
5981
|
+
immutabilityPolicyExpiry?: Date;
|
5982
|
+
/** Specifies the immutability policy mode to set on the blob. */
|
5983
|
+
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
5984
|
+
/** 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. */
|
5985
|
+
encryptionScope?: string;
|
5986
|
+
/** Optional. Indicates the tier to be set on the blob. */
|
5987
|
+
tier?: AccessTier;
|
5988
|
+
/** Optional. Used to set blob tags in various blob operations. */
|
5989
|
+
blobTagsString?: string;
|
5990
|
+
/** Specified if a legal hold should be set on the blob. */
|
5991
|
+
legalHold?: boolean;
|
5992
|
+
/** Specify the transactional md5 for the body, to be validated by the service. */
|
5993
|
+
transactionalContentMD5?: Uint8Array;
|
5994
|
+
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
5995
|
+
transactionalContentCrc64?: Uint8Array;
|
5996
|
+
}
|
5997
|
+
|
4947
5998
|
/**
|
4948
5999
|
* Options to configure {@link BlockBlobClient.upload} operation.
|
4949
6000
|
*/
|
@@ -5007,13 +6058,10 @@ export declare interface BlockBlobUploadOptions extends CommonOptions {
|
|
5007
6058
|
}
|
5008
6059
|
|
5009
6060
|
/** Contains response data for the upload operation. */
|
5010
|
-
export declare type BlockBlobUploadResponse = BlockBlobUploadHeaders
|
5011
|
-
|
5012
|
-
|
5013
|
-
|
5014
|
-
parsedHeaders: BlockBlobUploadHeaders;
|
5015
|
-
};
|
5016
|
-
};
|
6061
|
+
export declare type BlockBlobUploadResponse = WithResponse<BlockBlobUploadHeaders, BlockBlobUploadHeaders>;
|
6062
|
+
|
6063
|
+
/** Contains response data for the upload operation. */
|
6064
|
+
declare type BlockBlobUploadResponse_2 = BlockBlobUploadHeaders;
|
5017
6065
|
|
5018
6066
|
/**
|
5019
6067
|
* Option interface for the {@link BlockBlobClient.uploadStream} operation.
|
@@ -5072,7 +6120,13 @@ export declare interface BlockList {
|
|
5072
6120
|
/** Defines values for BlockListType. */
|
5073
6121
|
export declare type BlockListType = "committed" | "uncommitted" | "all";
|
5074
6122
|
|
5075
|
-
declare interface
|
6123
|
+
declare interface BlockLookupList {
|
6124
|
+
committed?: string[];
|
6125
|
+
uncommitted?: string[];
|
6126
|
+
latest?: string[];
|
6127
|
+
}
|
6128
|
+
|
6129
|
+
export declare interface ClearRange {
|
5076
6130
|
start: number;
|
5077
6131
|
end: number;
|
5078
6132
|
}
|
@@ -5144,82 +6198,289 @@ export declare interface CommonOptions {
|
|
5144
6198
|
tracingOptions?: OperationTracingOptions;
|
5145
6199
|
}
|
5146
6200
|
|
5147
|
-
/**
|
5148
|
-
|
5149
|
-
*/
|
5150
|
-
export declare interface ContainerAcquireLeaseOptions extends CommonOptions {
|
6201
|
+
/** Interface representing a Container. */
|
6202
|
+
declare interface Container {
|
5151
6203
|
/**
|
5152
|
-
*
|
5153
|
-
*
|
6204
|
+
* creates a new container under the specified account. If the container with the same name already
|
6205
|
+
* exists, the operation fails
|
6206
|
+
* @param options The options parameters.
|
5154
6207
|
*/
|
5155
|
-
|
6208
|
+
create(options?: ContainerCreateOptionalParams): Promise<ContainerCreateResponse_2>;
|
5156
6209
|
/**
|
5157
|
-
*
|
6210
|
+
* returns all user-defined metadata and system properties for the specified container. The data
|
6211
|
+
* returned does not include the container's list of blobs
|
6212
|
+
* @param options The options parameters.
|
5158
6213
|
*/
|
5159
|
-
|
5160
|
-
}
|
5161
|
-
|
5162
|
-
/** Optional parameters. */
|
5163
|
-
export declare interface ContainerBreakLeaseOptionalParams extends coreHttp.OperationOptions {
|
5164
|
-
/** Parameter group */
|
5165
|
-
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
5166
|
-
/** 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> */
|
5167
|
-
timeoutInSeconds?: number;
|
5168
|
-
/** 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. */
|
5169
|
-
requestId?: string;
|
5170
|
-
/** 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. */
|
5171
|
-
breakPeriod?: number;
|
5172
|
-
}
|
5173
|
-
|
5174
|
-
/**
|
5175
|
-
* Options to configure Container - Break Lease operation.
|
5176
|
-
*/
|
5177
|
-
export declare interface ContainerBreakLeaseOptions extends CommonOptions {
|
6214
|
+
getProperties(options?: ContainerGetPropertiesOptionalParams): Promise<ContainerGetPropertiesResponse_2>;
|
5178
6215
|
/**
|
5179
|
-
*
|
5180
|
-
*
|
6216
|
+
* operation marks the specified container for deletion. The container and any blobs contained within
|
6217
|
+
* it are later deleted during garbage collection
|
6218
|
+
* @param options The options parameters.
|
5181
6219
|
*/
|
5182
|
-
|
6220
|
+
delete(options?: ContainerDeleteOptionalParams): Promise<ContainerDeleteResponse_2>;
|
5183
6221
|
/**
|
5184
|
-
*
|
6222
|
+
* operation sets one or more user-defined name-value pairs for the specified container.
|
6223
|
+
* @param options The options parameters.
|
5185
6224
|
*/
|
5186
|
-
|
5187
|
-
}
|
5188
|
-
|
5189
|
-
/**
|
5190
|
-
* Options to configure Container - Change Lease operation.
|
5191
|
-
*/
|
5192
|
-
export declare interface ContainerChangeLeaseOptions extends CommonOptions {
|
6225
|
+
setMetadata(options?: ContainerSetMetadataOptionalParams): Promise<ContainerSetMetadataResponse_2>;
|
5193
6226
|
/**
|
5194
|
-
*
|
5195
|
-
*
|
6227
|
+
* gets the permissions for the specified container. The permissions indicate whether container data
|
6228
|
+
* may be accessed publicly.
|
6229
|
+
* @param options The options parameters.
|
5196
6230
|
*/
|
5197
|
-
|
6231
|
+
getAccessPolicy(options?: ContainerGetAccessPolicyOptionalParams): Promise<ContainerGetAccessPolicyResponseModel>;
|
5198
6232
|
/**
|
5199
|
-
*
|
6233
|
+
* sets the permissions for the specified container. The permissions indicate whether blobs in a
|
6234
|
+
* container may be accessed publicly.
|
6235
|
+
* @param options The options parameters.
|
5200
6236
|
*/
|
5201
|
-
|
5202
|
-
}
|
5203
|
-
|
5204
|
-
/**
|
5205
|
-
* A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs.
|
5206
|
-
*/
|
5207
|
-
export declare class ContainerClient extends StorageClient {
|
6237
|
+
setAccessPolicy(options?: ContainerSetAccessPolicyOptionalParams): Promise<ContainerSetAccessPolicyResponse_2>;
|
5208
6238
|
/**
|
5209
|
-
*
|
6239
|
+
* Restores a previously-deleted container.
|
6240
|
+
* @param options The options parameters.
|
5210
6241
|
*/
|
5211
|
-
|
5212
|
-
private _containerName;
|
6242
|
+
restore(options?: ContainerRestoreOptionalParams): Promise<ContainerRestoreResponse>;
|
5213
6243
|
/**
|
5214
|
-
*
|
6244
|
+
* Renames an existing container.
|
6245
|
+
* @param sourceContainerName Required. Specifies the name of the container to rename.
|
6246
|
+
* @param options The options parameters.
|
5215
6247
|
*/
|
5216
|
-
|
6248
|
+
rename(sourceContainerName: string, options?: ContainerRenameOptionalParams): Promise<ContainerRenameResponse_2>;
|
5217
6249
|
/**
|
5218
|
-
*
|
5219
|
-
*
|
5220
|
-
*
|
5221
|
-
*
|
5222
|
-
*
|
6250
|
+
* The Batch operation allows multiple API calls to be embedded into a single HTTP request.
|
6251
|
+
* @param contentLength The length of the request.
|
6252
|
+
* @param multipartContentType Required. The value of this header must be multipart/mixed with a batch
|
6253
|
+
* boundary. Example header value: multipart/mixed; boundary=batch_<GUID>
|
6254
|
+
* @param body Initial data
|
6255
|
+
* @param options The options parameters.
|
6256
|
+
*/
|
6257
|
+
submitBatch(contentLength: number, multipartContentType: string, body: coreRestPipeline.RequestBodyType, options?: ContainerSubmitBatchOptionalParams): Promise<ContainerSubmitBatchResponse>;
|
6258
|
+
/**
|
6259
|
+
* The Filter Blobs operation enables callers to list blobs in a container whose tags match a given
|
6260
|
+
* search expression. Filter blobs searches within the given container.
|
6261
|
+
* @param options The options parameters.
|
6262
|
+
*/
|
6263
|
+
filterBlobs(options?: ContainerFilterBlobsOptionalParams): Promise<ContainerFilterBlobsResponse>;
|
6264
|
+
/**
|
6265
|
+
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6266
|
+
* be 15 to 60 seconds, or can be infinite
|
6267
|
+
* @param options The options parameters.
|
6268
|
+
*/
|
6269
|
+
acquireLease(options?: ContainerAcquireLeaseOptionalParams): Promise<ContainerAcquireLeaseResponse>;
|
6270
|
+
/**
|
6271
|
+
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6272
|
+
* be 15 to 60 seconds, or can be infinite
|
6273
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
6274
|
+
* @param options The options parameters.
|
6275
|
+
*/
|
6276
|
+
releaseLease(leaseId: string, options?: ContainerReleaseLeaseOptionalParams): Promise<ContainerReleaseLeaseResponse>;
|
6277
|
+
/**
|
6278
|
+
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6279
|
+
* be 15 to 60 seconds, or can be infinite
|
6280
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
6281
|
+
* @param options The options parameters.
|
6282
|
+
*/
|
6283
|
+
renewLease(leaseId: string, options?: ContainerRenewLeaseOptionalParams): Promise<ContainerRenewLeaseResponse>;
|
6284
|
+
/**
|
6285
|
+
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6286
|
+
* be 15 to 60 seconds, or can be infinite
|
6287
|
+
* @param options The options parameters.
|
6288
|
+
*/
|
6289
|
+
breakLease(options?: ContainerBreakLeaseOptionalParams): Promise<ContainerBreakLeaseResponse>;
|
6290
|
+
/**
|
6291
|
+
* [Update] establishes and manages a lock on a container for delete operations. The lock duration can
|
6292
|
+
* be 15 to 60 seconds, or can be infinite
|
6293
|
+
* @param leaseId Specifies the current lease ID on the resource.
|
6294
|
+
* @param proposedLeaseId Proposed lease ID, in a GUID string format. The Blob service returns 400
|
6295
|
+
* (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor
|
6296
|
+
* (String) for a list of valid GUID string formats.
|
6297
|
+
* @param options The options parameters.
|
6298
|
+
*/
|
6299
|
+
changeLease(leaseId: string, proposedLeaseId: string, options?: ContainerChangeLeaseOptionalParams): Promise<ContainerChangeLeaseResponse>;
|
6300
|
+
/**
|
6301
|
+
* [Update] The List Blobs operation returns a list of the blobs under the specified container
|
6302
|
+
* @param options The options parameters.
|
6303
|
+
*/
|
6304
|
+
listBlobFlatSegment(options?: ContainerListBlobFlatSegmentOptionalParams): Promise<ContainerListBlobFlatSegmentResponse_2>;
|
6305
|
+
/**
|
6306
|
+
* [Update] The List Blobs operation returns a list of the blobs under the specified container
|
6307
|
+
* @param delimiter When the request includes this parameter, the operation returns a BlobPrefix
|
6308
|
+
* element in the response body that acts as a placeholder for all blobs whose names begin with the
|
6309
|
+
* same substring up to the appearance of the delimiter character. The delimiter may be a single
|
6310
|
+
* character or a string.
|
6311
|
+
* @param options The options parameters.
|
6312
|
+
*/
|
6313
|
+
listBlobHierarchySegment(delimiter: string, options?: ContainerListBlobHierarchySegmentOptionalParams): Promise<ContainerListBlobHierarchySegmentResponse_2>;
|
6314
|
+
/**
|
6315
|
+
* Returns the sku name and account kind
|
6316
|
+
* @param options The options parameters.
|
6317
|
+
*/
|
6318
|
+
getAccountInfo(options?: ContainerGetAccountInfoOptionalParams): Promise<ContainerGetAccountInfoResponse>;
|
6319
|
+
}
|
6320
|
+
|
6321
|
+
/** Defines headers for Container_acquireLease operation. */
|
6322
|
+
declare interface ContainerAcquireLeaseHeaders {
|
6323
|
+
/** 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. */
|
6324
|
+
etag?: string;
|
6325
|
+
/** 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. */
|
6326
|
+
lastModified?: Date;
|
6327
|
+
/** Uniquely identifies a container's lease */
|
6328
|
+
leaseId?: string;
|
6329
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6330
|
+
clientRequestId?: string;
|
6331
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6332
|
+
requestId?: string;
|
6333
|
+
/** 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. */
|
6334
|
+
version?: string;
|
6335
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6336
|
+
date?: Date;
|
6337
|
+
}
|
6338
|
+
|
6339
|
+
/** Optional parameters. */
|
6340
|
+
declare interface ContainerAcquireLeaseOptionalParams extends coreClient.OperationOptions {
|
6341
|
+
/** Parameter group */
|
6342
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
6343
|
+
/** 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> */
|
6344
|
+
timeoutInSeconds?: number;
|
6345
|
+
/** 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. */
|
6346
|
+
requestId?: string;
|
6347
|
+
/** 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. */
|
6348
|
+
duration?: number;
|
6349
|
+
/** 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. */
|
6350
|
+
proposedLeaseId?: string;
|
6351
|
+
}
|
6352
|
+
|
6353
|
+
/**
|
6354
|
+
* Options to configure Container - Acquire Lease operation.
|
6355
|
+
*/
|
6356
|
+
export declare interface ContainerAcquireLeaseOptions extends CommonOptions {
|
6357
|
+
/**
|
6358
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
6359
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
6360
|
+
*/
|
6361
|
+
abortSignal?: AbortSignalLike;
|
6362
|
+
/**
|
6363
|
+
* Conditions to meet when acquiring the lease.
|
6364
|
+
*/
|
6365
|
+
conditions?: ModifiedAccessConditions;
|
6366
|
+
}
|
6367
|
+
|
6368
|
+
/** Contains response data for the acquireLease operation. */
|
6369
|
+
declare type ContainerAcquireLeaseResponse = ContainerAcquireLeaseHeaders;
|
6370
|
+
|
6371
|
+
/** Defines headers for Container_breakLease operation. */
|
6372
|
+
declare interface ContainerBreakLeaseHeaders {
|
6373
|
+
/** 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. */
|
6374
|
+
etag?: string;
|
6375
|
+
/** 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. */
|
6376
|
+
lastModified?: Date;
|
6377
|
+
/** Approximate time remaining in the lease period, in seconds. */
|
6378
|
+
leaseTime?: number;
|
6379
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6380
|
+
clientRequestId?: string;
|
6381
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6382
|
+
requestId?: string;
|
6383
|
+
/** 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. */
|
6384
|
+
version?: string;
|
6385
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6386
|
+
date?: Date;
|
6387
|
+
}
|
6388
|
+
|
6389
|
+
/** Optional parameters. */
|
6390
|
+
export declare interface ContainerBreakLeaseOptionalParams extends coreClient.OperationOptions {
|
6391
|
+
/** Parameter group */
|
6392
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
6393
|
+
/** 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> */
|
6394
|
+
timeoutInSeconds?: number;
|
6395
|
+
/** 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. */
|
6396
|
+
requestId?: string;
|
6397
|
+
/** 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. */
|
6398
|
+
breakPeriod?: number;
|
6399
|
+
}
|
6400
|
+
|
6401
|
+
/**
|
6402
|
+
* Options to configure Container - Break Lease operation.
|
6403
|
+
*/
|
6404
|
+
export declare interface ContainerBreakLeaseOptions extends CommonOptions {
|
6405
|
+
/**
|
6406
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
6407
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
6408
|
+
*/
|
6409
|
+
abortSignal?: AbortSignalLike;
|
6410
|
+
/**
|
6411
|
+
* Conditions to meet when breaking the lease.
|
6412
|
+
*/
|
6413
|
+
conditions?: ModifiedAccessConditions;
|
6414
|
+
}
|
6415
|
+
|
6416
|
+
/** Contains response data for the breakLease operation. */
|
6417
|
+
declare type ContainerBreakLeaseResponse = ContainerBreakLeaseHeaders;
|
6418
|
+
|
6419
|
+
/** Defines headers for Container_changeLease operation. */
|
6420
|
+
declare interface ContainerChangeLeaseHeaders {
|
6421
|
+
/** 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. */
|
6422
|
+
etag?: string;
|
6423
|
+
/** 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. */
|
6424
|
+
lastModified?: Date;
|
6425
|
+
/** Uniquely identifies a container's lease */
|
6426
|
+
leaseId?: string;
|
6427
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
6428
|
+
clientRequestId?: string;
|
6429
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
6430
|
+
requestId?: string;
|
6431
|
+
/** 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. */
|
6432
|
+
version?: string;
|
6433
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
6434
|
+
date?: Date;
|
6435
|
+
}
|
6436
|
+
|
6437
|
+
/** Optional parameters. */
|
6438
|
+
declare interface ContainerChangeLeaseOptionalParams extends coreClient.OperationOptions {
|
6439
|
+
/** Parameter group */
|
6440
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
6441
|
+
/** 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> */
|
6442
|
+
timeoutInSeconds?: number;
|
6443
|
+
/** 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. */
|
6444
|
+
requestId?: string;
|
6445
|
+
}
|
6446
|
+
|
6447
|
+
/**
|
6448
|
+
* Options to configure Container - Change Lease operation.
|
6449
|
+
*/
|
6450
|
+
export declare interface ContainerChangeLeaseOptions extends CommonOptions {
|
6451
|
+
/**
|
6452
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
6453
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
6454
|
+
*/
|
6455
|
+
abortSignal?: AbortSignalLike;
|
6456
|
+
/**
|
6457
|
+
* Conditions to meet when changing the lease.
|
6458
|
+
*/
|
6459
|
+
conditions?: ModifiedAccessConditions;
|
6460
|
+
}
|
6461
|
+
|
6462
|
+
/** Contains response data for the changeLease operation. */
|
6463
|
+
declare type ContainerChangeLeaseResponse = ContainerChangeLeaseHeaders;
|
6464
|
+
|
6465
|
+
/**
|
6466
|
+
* A ContainerClient represents a URL to the Azure Storage container allowing you to manipulate its blobs.
|
6467
|
+
*/
|
6468
|
+
export declare class ContainerClient extends StorageClient {
|
6469
|
+
/**
|
6470
|
+
* containerContext provided by protocol layer.
|
6471
|
+
*/
|
6472
|
+
private containerContext;
|
6473
|
+
private _containerName;
|
6474
|
+
/**
|
6475
|
+
* The name of the container.
|
6476
|
+
*/
|
6477
|
+
get containerName(): string;
|
6478
|
+
/**
|
6479
|
+
*
|
6480
|
+
* Creates an instance of ContainerClient.
|
6481
|
+
*
|
6482
|
+
* @param connectionString - Account connection string or a SAS connection string of an Azure storage account.
|
6483
|
+
* [ Note - Account connection string can only be used in NODE.JS runtime. ]
|
5223
6484
|
* Account connection string example -
|
5224
6485
|
* `DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net`
|
5225
6486
|
* SAS connection string example -
|
@@ -5836,6 +7097,22 @@ export declare interface ContainerCreateIfNotExistsResponse extends ContainerCre
|
|
5836
7097
|
succeeded: boolean;
|
5837
7098
|
}
|
5838
7099
|
|
7100
|
+
/** Optional parameters. */
|
7101
|
+
declare interface ContainerCreateOptionalParams extends coreClient.OperationOptions {
|
7102
|
+
/** Parameter group */
|
7103
|
+
containerEncryptionScope?: ContainerEncryptionScope;
|
7104
|
+
/** 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> */
|
7105
|
+
timeoutInSeconds?: number;
|
7106
|
+
/** 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. */
|
7107
|
+
requestId?: string;
|
7108
|
+
/** 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. */
|
7109
|
+
metadata?: {
|
7110
|
+
[propertyName: string]: string;
|
7111
|
+
};
|
7112
|
+
/** Specifies whether data in the container may be accessed publicly and the level of access */
|
7113
|
+
access?: PublicAccessType;
|
7114
|
+
}
|
7115
|
+
|
5839
7116
|
/**
|
5840
7117
|
* Options to configure {@link ContainerClient.create} operation.
|
5841
7118
|
*/
|
@@ -5862,13 +7139,10 @@ export declare interface ContainerCreateOptions extends CommonOptions {
|
|
5862
7139
|
}
|
5863
7140
|
|
5864
7141
|
/** Contains response data for the create operation. */
|
5865
|
-
export declare type ContainerCreateResponse = ContainerCreateHeaders
|
5866
|
-
|
5867
|
-
|
5868
|
-
|
5869
|
-
parsedHeaders: ContainerCreateHeaders;
|
5870
|
-
};
|
5871
|
-
};
|
7142
|
+
export declare type ContainerCreateResponse = WithResponse<ContainerCreateHeaders, ContainerCreateHeaders>;
|
7143
|
+
|
7144
|
+
/** Contains response data for the create operation. */
|
7145
|
+
declare type ContainerCreateResponse_2 = ContainerCreateHeaders;
|
5872
7146
|
|
5873
7147
|
/**
|
5874
7148
|
* Options to configure the {@link ContainerClient.deleteBlob} operation.
|
@@ -5920,14 +7194,23 @@ export declare interface ContainerDeleteMethodOptions extends CommonOptions {
|
|
5920
7194
|
conditions?: ContainerRequestConditions;
|
5921
7195
|
}
|
5922
7196
|
|
7197
|
+
/** Optional parameters. */
|
7198
|
+
declare interface ContainerDeleteOptionalParams extends coreClient.OperationOptions {
|
7199
|
+
/** Parameter group */
|
7200
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
7201
|
+
/** Parameter group */
|
7202
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
7203
|
+
/** 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> */
|
7204
|
+
timeoutInSeconds?: number;
|
7205
|
+
/** 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. */
|
7206
|
+
requestId?: string;
|
7207
|
+
}
|
7208
|
+
|
5923
7209
|
/** Contains response data for the delete operation. */
|
5924
|
-
export declare type ContainerDeleteResponse = ContainerDeleteHeaders
|
5925
|
-
|
5926
|
-
|
5927
|
-
|
5928
|
-
parsedHeaders: ContainerDeleteHeaders;
|
5929
|
-
};
|
5930
|
-
};
|
7210
|
+
export declare type ContainerDeleteResponse = WithResponse<ContainerDeleteHeaders, ContainerDeleteHeaders>;
|
7211
|
+
|
7212
|
+
/** Contains response data for the delete operation. */
|
7213
|
+
declare type ContainerDeleteResponse_2 = ContainerDeleteHeaders;
|
5931
7214
|
|
5932
7215
|
/** Parameter group */
|
5933
7216
|
export declare interface ContainerEncryptionScope {
|
@@ -5960,6 +7243,23 @@ export declare interface ContainerFilterBlobsHeaders {
|
|
5960
7243
|
date?: Date;
|
5961
7244
|
}
|
5962
7245
|
|
7246
|
+
/** Optional parameters. */
|
7247
|
+
declare interface ContainerFilterBlobsOptionalParams extends coreClient.OperationOptions {
|
7248
|
+
/** 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> */
|
7249
|
+
timeoutInSeconds?: number;
|
7250
|
+
/** 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. */
|
7251
|
+
requestId?: string;
|
7252
|
+
/** 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. */
|
7253
|
+
marker?: string;
|
7254
|
+
/** 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. */
|
7255
|
+
maxPageSize?: number;
|
7256
|
+
/** Filters the results to return only to return only blobs whose tags match the specified expression. */
|
7257
|
+
where?: string;
|
7258
|
+
}
|
7259
|
+
|
7260
|
+
/** Contains response data for the filterBlobs operation. */
|
7261
|
+
export declare type ContainerFilterBlobsResponse = ContainerFilterBlobsHeaders & FilterBlobSegmentModel;
|
7262
|
+
|
5963
7263
|
/**
|
5964
7264
|
* Options to configure the {@link BlobServiceClient.findBlobsByTags} operation.
|
5965
7265
|
*/
|
@@ -5974,25 +7274,7 @@ export declare interface ContainerFindBlobByTagsOptions extends CommonOptions {
|
|
5974
7274
|
/**
|
5975
7275
|
* The response of {@link BlobServiceClient.findBlobsByTags} operation.
|
5976
7276
|
*/
|
5977
|
-
export declare type ContainerFindBlobsByTagsSegmentResponse = FilterBlobSegment & ContainerFilterBlobsHeaders
|
5978
|
-
/**
|
5979
|
-
* The underlying HTTP response.
|
5980
|
-
*/
|
5981
|
-
_response: HttpResponse & {
|
5982
|
-
/**
|
5983
|
-
* The parsed HTTP response headers.
|
5984
|
-
*/
|
5985
|
-
parsedHeaders: ContainerFilterBlobsHeaders;
|
5986
|
-
/**
|
5987
|
-
* The response body as text (string format)
|
5988
|
-
*/
|
5989
|
-
bodyAsText: string;
|
5990
|
-
/**
|
5991
|
-
* The response body as parsed JSON or XML
|
5992
|
-
*/
|
5993
|
-
parsedBody: FilterBlobSegmentModel;
|
5994
|
-
};
|
5995
|
-
};
|
7277
|
+
export declare type ContainerFindBlobsByTagsSegmentResponse = WithResponse<FilterBlobSegment & ContainerFilterBlobsHeaders, ContainerFilterBlobsHeaders, FilterBlobSegmentModel>;
|
5996
7278
|
|
5997
7279
|
/**
|
5998
7280
|
* Options to configure {@link ContainerClient.generateSasUrl} operation.
|
@@ -6024,6 +7306,16 @@ export declare interface ContainerGetAccessPolicyHeaders {
|
|
6024
7306
|
errorCode?: string;
|
6025
7307
|
}
|
6026
7308
|
|
7309
|
+
/** Optional parameters. */
|
7310
|
+
declare interface ContainerGetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
7311
|
+
/** Parameter group */
|
7312
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
7313
|
+
/** 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> */
|
7314
|
+
timeoutInSeconds?: number;
|
7315
|
+
/** 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. */
|
7316
|
+
requestId?: string;
|
7317
|
+
}
|
7318
|
+
|
6027
7319
|
/**
|
6028
7320
|
* Options to configure {@link ContainerClient.getAccessPolicy} operation.
|
6029
7321
|
*/
|
@@ -6043,27 +7335,35 @@ export declare interface ContainerGetAccessPolicyOptions extends CommonOptions {
|
|
6043
7335
|
/**
|
6044
7336
|
* Contains response data for the {@link ContainerClient.getAccessPolicy} operation.
|
6045
7337
|
*/
|
6046
|
-
export declare type ContainerGetAccessPolicyResponse = {
|
7338
|
+
export declare type ContainerGetAccessPolicyResponse = WithResponse<{
|
6047
7339
|
signedIdentifiers: SignedIdentifier[];
|
6048
|
-
} & ContainerGetAccessPolicyHeaders
|
6049
|
-
|
6050
|
-
|
6051
|
-
|
6052
|
-
|
6053
|
-
|
6054
|
-
|
6055
|
-
|
6056
|
-
|
6057
|
-
|
6058
|
-
|
6059
|
-
|
6060
|
-
|
6061
|
-
|
6062
|
-
|
6063
|
-
|
6064
|
-
|
6065
|
-
|
6066
|
-
|
7340
|
+
} & ContainerGetAccessPolicyHeaders, ContainerGetAccessPolicyHeaders, SignedIdentifierModel>;
|
7341
|
+
|
7342
|
+
/** Contains response data for the getAccessPolicy operation. */
|
7343
|
+
export declare type ContainerGetAccessPolicyResponseModel = ContainerGetAccessPolicyHeaders & SignedIdentifierModel[];
|
7344
|
+
|
7345
|
+
/** Defines headers for Container_getAccountInfo operation. */
|
7346
|
+
declare interface ContainerGetAccountInfoHeaders {
|
7347
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
7348
|
+
clientRequestId?: string;
|
7349
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
7350
|
+
requestId?: string;
|
7351
|
+
/** 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. */
|
7352
|
+
version?: string;
|
7353
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
7354
|
+
date?: Date;
|
7355
|
+
/** Identifies the sku name of the account */
|
7356
|
+
skuName?: SkuName;
|
7357
|
+
/** Identifies the account kind */
|
7358
|
+
accountKind?: AccountKind;
|
7359
|
+
}
|
7360
|
+
|
7361
|
+
/** Optional parameters. */
|
7362
|
+
declare interface ContainerGetAccountInfoOptionalParams extends coreClient.OperationOptions {
|
7363
|
+
}
|
7364
|
+
|
7365
|
+
/** Contains response data for the getAccountInfo operation. */
|
7366
|
+
declare type ContainerGetAccountInfoResponse = ContainerGetAccountInfoHeaders;
|
6067
7367
|
|
6068
7368
|
/** Defines headers for Container_getProperties operation. */
|
6069
7369
|
export declare interface ContainerGetPropertiesHeaders {
|
@@ -6104,6 +7404,16 @@ export declare interface ContainerGetPropertiesHeaders {
|
|
6104
7404
|
errorCode?: string;
|
6105
7405
|
}
|
6106
7406
|
|
7407
|
+
/** Optional parameters. */
|
7408
|
+
declare interface ContainerGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
7409
|
+
/** Parameter group */
|
7410
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
7411
|
+
/** 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> */
|
7412
|
+
timeoutInSeconds?: number;
|
7413
|
+
/** 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. */
|
7414
|
+
requestId?: string;
|
7415
|
+
}
|
7416
|
+
|
6107
7417
|
/**
|
6108
7418
|
* Options to configure {@link ContainerClient.getProperties} operation.
|
6109
7419
|
*/
|
@@ -6121,13 +7431,10 @@ export declare interface ContainerGetPropertiesOptions extends CommonOptions {
|
|
6121
7431
|
}
|
6122
7432
|
|
6123
7433
|
/** Contains response data for the getProperties operation. */
|
6124
|
-
export declare type ContainerGetPropertiesResponse = ContainerGetPropertiesHeaders
|
6125
|
-
|
6126
|
-
|
6127
|
-
|
6128
|
-
parsedHeaders: ContainerGetPropertiesHeaders;
|
6129
|
-
};
|
6130
|
-
};
|
7434
|
+
export declare type ContainerGetPropertiesResponse = WithResponse<ContainerGetPropertiesHeaders, ContainerGetPropertiesHeaders>;
|
7435
|
+
|
7436
|
+
/** Contains response data for the getProperties operation. */
|
7437
|
+
declare type ContainerGetPropertiesResponse_2 = ContainerGetPropertiesHeaders;
|
6131
7438
|
|
6132
7439
|
/** An Azure Storage container */
|
6133
7440
|
export declare interface ContainerItem {
|
@@ -6158,28 +7465,29 @@ export declare interface ContainerListBlobFlatSegmentHeaders {
|
|
6158
7465
|
errorCode?: string;
|
6159
7466
|
}
|
6160
7467
|
|
7468
|
+
/** Optional parameters. */
|
7469
|
+
declare interface ContainerListBlobFlatSegmentOptionalParams extends coreClient.OperationOptions {
|
7470
|
+
/** 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> */
|
7471
|
+
timeoutInSeconds?: number;
|
7472
|
+
/** 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. */
|
7473
|
+
requestId?: string;
|
7474
|
+
/** Filters the results to return only containers whose name begins with the specified prefix. */
|
7475
|
+
prefix?: string;
|
7476
|
+
/** 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. */
|
7477
|
+
marker?: string;
|
7478
|
+
/** 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. */
|
7479
|
+
maxPageSize?: number;
|
7480
|
+
/** Include this parameter to specify one or more datasets to include in the response. */
|
7481
|
+
include?: ListBlobsIncludeItem[];
|
7482
|
+
}
|
7483
|
+
|
6161
7484
|
/**
|
6162
7485
|
* Contains response data for the listBlobFlatSegment operation.
|
6163
7486
|
*/
|
6164
|
-
export declare type ContainerListBlobFlatSegmentResponse = ListBlobsFlatSegmentResponse & ContainerListBlobFlatSegmentHeaders
|
6165
|
-
|
6166
|
-
|
6167
|
-
|
6168
|
-
_response: HttpResponse & {
|
6169
|
-
/**
|
6170
|
-
* The parsed HTTP response headers.
|
6171
|
-
*/
|
6172
|
-
parsedHeaders: ContainerListBlobFlatSegmentHeaders;
|
6173
|
-
/**
|
6174
|
-
* The response body as text (string format)
|
6175
|
-
*/
|
6176
|
-
bodyAsText: string;
|
6177
|
-
/**
|
6178
|
-
* The response body as parsed JSON or XML
|
6179
|
-
*/
|
6180
|
-
parsedBody: ListBlobsFlatSegmentResponseModel;
|
6181
|
-
};
|
6182
|
-
};
|
7487
|
+
export declare type ContainerListBlobFlatSegmentResponse = WithResponse<ListBlobsFlatSegmentResponse & ContainerListBlobFlatSegmentHeaders, ContainerListBlobFlatSegmentHeaders, ListBlobsFlatSegmentResponseModel>;
|
7488
|
+
|
7489
|
+
/** Contains response data for the listBlobFlatSegment operation. */
|
7490
|
+
declare type ContainerListBlobFlatSegmentResponse_2 = ContainerListBlobFlatSegmentHeaders & ListBlobsFlatSegmentResponse_2;
|
6183
7491
|
|
6184
7492
|
/** Defines headers for Container_listBlobHierarchySegment operation. */
|
6185
7493
|
export declare interface ContainerListBlobHierarchySegmentHeaders {
|
@@ -6197,28 +7505,29 @@ export declare interface ContainerListBlobHierarchySegmentHeaders {
|
|
6197
7505
|
errorCode?: string;
|
6198
7506
|
}
|
6199
7507
|
|
7508
|
+
/** Optional parameters. */
|
7509
|
+
declare interface ContainerListBlobHierarchySegmentOptionalParams extends coreClient.OperationOptions {
|
7510
|
+
/** 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> */
|
7511
|
+
timeoutInSeconds?: number;
|
7512
|
+
/** 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. */
|
7513
|
+
requestId?: string;
|
7514
|
+
/** Filters the results to return only containers whose name begins with the specified prefix. */
|
7515
|
+
prefix?: string;
|
7516
|
+
/** 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. */
|
7517
|
+
marker?: string;
|
7518
|
+
/** 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. */
|
7519
|
+
maxPageSize?: number;
|
7520
|
+
/** Include this parameter to specify one or more datasets to include in the response. */
|
7521
|
+
include?: ListBlobsIncludeItem[];
|
7522
|
+
}
|
7523
|
+
|
6200
7524
|
/**
|
6201
7525
|
* Contains response data for the listBlobHierarchySegment operation.
|
6202
7526
|
*/
|
6203
|
-
export declare type ContainerListBlobHierarchySegmentResponse = ListBlobsHierarchySegmentResponse & ContainerListBlobHierarchySegmentHeaders
|
6204
|
-
|
6205
|
-
|
6206
|
-
|
6207
|
-
_response: HttpResponse & {
|
6208
|
-
/**
|
6209
|
-
* The parsed HTTP response headers.
|
6210
|
-
*/
|
6211
|
-
parsedHeaders: ContainerListBlobHierarchySegmentHeaders;
|
6212
|
-
/**
|
6213
|
-
* The response body as text (string format)
|
6214
|
-
*/
|
6215
|
-
bodyAsText: string;
|
6216
|
-
/**
|
6217
|
-
* The response body as parsed JSON or XML
|
6218
|
-
*/
|
6219
|
-
parsedBody: ListBlobsHierarchySegmentResponseModel;
|
6220
|
-
};
|
6221
|
-
};
|
7527
|
+
export declare type ContainerListBlobHierarchySegmentResponse = WithResponse<ListBlobsHierarchySegmentResponse & ContainerListBlobHierarchySegmentHeaders, ContainerListBlobHierarchySegmentHeaders, ListBlobsHierarchySegmentResponseModel>;
|
7528
|
+
|
7529
|
+
/** Contains response data for the listBlobHierarchySegment operation. */
|
7530
|
+
declare type ContainerListBlobHierarchySegmentResponse_2 = ContainerListBlobHierarchySegmentHeaders & ListBlobsHierarchySegmentResponse_2;
|
6222
7531
|
|
6223
7532
|
/**
|
6224
7533
|
* Options to configure Container - List Blobs operations.
|
@@ -6298,6 +7607,32 @@ export declare interface ContainerProperties {
|
|
6298
7607
|
isImmutableStorageWithVersioningEnabled?: boolean;
|
6299
7608
|
}
|
6300
7609
|
|
7610
|
+
/** Defines headers for Container_releaseLease operation. */
|
7611
|
+
declare interface ContainerReleaseLeaseHeaders {
|
7612
|
+
/** 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. */
|
7613
|
+
etag?: string;
|
7614
|
+
/** 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. */
|
7615
|
+
lastModified?: Date;
|
7616
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
7617
|
+
clientRequestId?: string;
|
7618
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
7619
|
+
requestId?: string;
|
7620
|
+
/** 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. */
|
7621
|
+
version?: string;
|
7622
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
7623
|
+
date?: Date;
|
7624
|
+
}
|
7625
|
+
|
7626
|
+
/** Optional parameters. */
|
7627
|
+
declare interface ContainerReleaseLeaseOptionalParams extends coreClient.OperationOptions {
|
7628
|
+
/** Parameter group */
|
7629
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
7630
|
+
/** 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> */
|
7631
|
+
timeoutInSeconds?: number;
|
7632
|
+
/** 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. */
|
7633
|
+
requestId?: string;
|
7634
|
+
}
|
7635
|
+
|
6301
7636
|
/**
|
6302
7637
|
* Options to configure Container - Release Lease operation.
|
6303
7638
|
*/
|
@@ -6313,6 +7648,9 @@ export declare interface ContainerReleaseLeaseOptions extends CommonOptions {
|
|
6313
7648
|
conditions?: ModifiedAccessConditions;
|
6314
7649
|
}
|
6315
7650
|
|
7651
|
+
/** Contains response data for the releaseLease operation. */
|
7652
|
+
declare type ContainerReleaseLeaseResponse = ContainerReleaseLeaseHeaders;
|
7653
|
+
|
6316
7654
|
/** Defines headers for Container_rename operation. */
|
6317
7655
|
export declare interface ContainerRenameHeaders {
|
6318
7656
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -6327,14 +7665,49 @@ export declare interface ContainerRenameHeaders {
|
|
6327
7665
|
errorCode?: string;
|
6328
7666
|
}
|
6329
7667
|
|
7668
|
+
/** Optional parameters. */
|
7669
|
+
declare interface ContainerRenameOptionalParams extends coreClient.OperationOptions {
|
7670
|
+
/** 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> */
|
7671
|
+
timeoutInSeconds?: number;
|
7672
|
+
/** 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. */
|
7673
|
+
requestId?: string;
|
7674
|
+
/** A lease ID for the source path. If specified, the source path must have an active lease and the lease ID must match. */
|
7675
|
+
sourceLeaseId?: string;
|
7676
|
+
}
|
7677
|
+
|
6330
7678
|
/** Contains response data for the rename operation. */
|
6331
|
-
export declare type ContainerRenameResponse = ContainerRenameHeaders
|
6332
|
-
|
6333
|
-
|
6334
|
-
|
6335
|
-
|
6336
|
-
|
6337
|
-
|
7679
|
+
export declare type ContainerRenameResponse = WithResponse<ContainerRenameHeaders, ContainerRenameHeaders>;
|
7680
|
+
|
7681
|
+
/** Contains response data for the rename operation. */
|
7682
|
+
declare type ContainerRenameResponse_2 = ContainerRenameHeaders;
|
7683
|
+
|
7684
|
+
/** Defines headers for Container_renewLease operation. */
|
7685
|
+
declare interface ContainerRenewLeaseHeaders {
|
7686
|
+
/** 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. */
|
7687
|
+
etag?: string;
|
7688
|
+
/** 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. */
|
7689
|
+
lastModified?: Date;
|
7690
|
+
/** Uniquely identifies a container's lease */
|
7691
|
+
leaseId?: string;
|
7692
|
+
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
7693
|
+
clientRequestId?: string;
|
7694
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
7695
|
+
requestId?: string;
|
7696
|
+
/** 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. */
|
7697
|
+
version?: string;
|
7698
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
7699
|
+
date?: Date;
|
7700
|
+
}
|
7701
|
+
|
7702
|
+
/** Optional parameters. */
|
7703
|
+
declare interface ContainerRenewLeaseOptionalParams extends coreClient.OperationOptions {
|
7704
|
+
/** Parameter group */
|
7705
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
7706
|
+
/** 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> */
|
7707
|
+
timeoutInSeconds?: number;
|
7708
|
+
/** 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. */
|
7709
|
+
requestId?: string;
|
7710
|
+
}
|
6338
7711
|
|
6339
7712
|
/**
|
6340
7713
|
* Options to configure Container - Renew Lease operation.
|
@@ -6351,12 +7724,30 @@ export declare interface ContainerRenewLeaseOptions extends CommonOptions {
|
|
6351
7724
|
conditions?: ModifiedAccessConditions;
|
6352
7725
|
}
|
6353
7726
|
|
7727
|
+
/** Contains response data for the renewLease operation. */
|
7728
|
+
declare type ContainerRenewLeaseResponse = ContainerRenewLeaseHeaders;
|
7729
|
+
|
6354
7730
|
/**
|
6355
7731
|
* Conditions to meet for the container.
|
6356
7732
|
*/
|
6357
7733
|
export declare interface ContainerRequestConditions extends LeaseAccessConditions, ModificationConditions {
|
6358
7734
|
}
|
6359
7735
|
|
7736
|
+
/** Optional parameters. */
|
7737
|
+
declare interface ContainerRestoreOptionalParams extends coreClient.OperationOptions {
|
7738
|
+
/** 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> */
|
7739
|
+
timeoutInSeconds?: number;
|
7740
|
+
/** 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. */
|
7741
|
+
requestId?: string;
|
7742
|
+
/** Optional. Version 2019-12-12 and later. Specifies the name of the deleted container to restore. */
|
7743
|
+
deletedContainerName?: string;
|
7744
|
+
/** Optional. Version 2019-12-12 and later. Specifies the version of the deleted container to restore. */
|
7745
|
+
deletedContainerVersion?: string;
|
7746
|
+
}
|
7747
|
+
|
7748
|
+
/** Contains response data for the restore operation. */
|
7749
|
+
declare type ContainerRestoreResponse = ContainerUndeleteHeaders;
|
7750
|
+
|
6360
7751
|
/**
|
6361
7752
|
* This is a helper class to construct a string representing the permissions granted by a ServiceSAS to a container.
|
6362
7753
|
* Setting a value to true means that any SAS which uses these permissions will grant permissions for that operation.
|
@@ -6519,6 +7910,22 @@ export declare interface ContainerSetAccessPolicyHeaders {
|
|
6519
7910
|
errorCode?: string;
|
6520
7911
|
}
|
6521
7912
|
|
7913
|
+
/** Optional parameters. */
|
7914
|
+
declare interface ContainerSetAccessPolicyOptionalParams extends coreClient.OperationOptions {
|
7915
|
+
/** Parameter group */
|
7916
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
7917
|
+
/** Parameter group */
|
7918
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
7919
|
+
/** 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> */
|
7920
|
+
timeoutInSeconds?: number;
|
7921
|
+
/** 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. */
|
7922
|
+
requestId?: string;
|
7923
|
+
/** Specifies whether data in the container may be accessed publicly and the level of access */
|
7924
|
+
access?: PublicAccessType;
|
7925
|
+
/** the acls for the container */
|
7926
|
+
containerAcl?: SignedIdentifierModel[];
|
7927
|
+
}
|
7928
|
+
|
6522
7929
|
/**
|
6523
7930
|
* Options to configure {@link ContainerClient.setAccessPolicy} operation.
|
6524
7931
|
*/
|
@@ -6535,13 +7942,10 @@ export declare interface ContainerSetAccessPolicyOptions extends CommonOptions {
|
|
6535
7942
|
}
|
6536
7943
|
|
6537
7944
|
/** Contains response data for the setAccessPolicy operation. */
|
6538
|
-
export declare type ContainerSetAccessPolicyResponse = ContainerSetAccessPolicyHeaders
|
6539
|
-
|
6540
|
-
|
6541
|
-
|
6542
|
-
parsedHeaders: ContainerSetAccessPolicyHeaders;
|
6543
|
-
};
|
6544
|
-
};
|
7945
|
+
export declare type ContainerSetAccessPolicyResponse = WithResponse<ContainerSetAccessPolicyHeaders, ContainerSetAccessPolicyHeaders>;
|
7946
|
+
|
7947
|
+
/** Contains response data for the setAccessPolicy operation. */
|
7948
|
+
declare type ContainerSetAccessPolicyResponse_2 = ContainerSetAccessPolicyHeaders;
|
6545
7949
|
|
6546
7950
|
/** Defines headers for Container_setMetadata operation. */
|
6547
7951
|
export declare interface ContainerSetMetadataHeaders {
|
@@ -6561,29 +7965,78 @@ export declare interface ContainerSetMetadataHeaders {
|
|
6561
7965
|
errorCode?: string;
|
6562
7966
|
}
|
6563
7967
|
|
7968
|
+
/** Optional parameters. */
|
7969
|
+
declare interface ContainerSetMetadataOptionalParams extends coreClient.OperationOptions {
|
7970
|
+
/** Parameter group */
|
7971
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
7972
|
+
/** Parameter group */
|
7973
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
7974
|
+
/** 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> */
|
7975
|
+
timeoutInSeconds?: number;
|
7976
|
+
/** 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. */
|
7977
|
+
requestId?: string;
|
7978
|
+
/** 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. */
|
7979
|
+
metadata?: {
|
7980
|
+
[propertyName: string]: string;
|
7981
|
+
};
|
7982
|
+
}
|
7983
|
+
|
6564
7984
|
/**
|
6565
7985
|
* Options to configure {@link ContainerClient.setMetadata} operation.
|
6566
7986
|
*/
|
6567
7987
|
export declare interface ContainerSetMetadataOptions extends CommonOptions {
|
6568
7988
|
/**
|
6569
|
-
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
6570
|
-
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
7989
|
+
* An implementation of the `AbortSignalLike` interface to signal the request to cancel the operation.
|
7990
|
+
* For example, use the @azure/abort-controller to create an `AbortSignal`.
|
7991
|
+
*/
|
7992
|
+
abortSignal?: AbortSignalLike;
|
7993
|
+
/**
|
7994
|
+
* If specified, contains the lease id that must be matched and lease with this id
|
7995
|
+
* must be active in order for the operation to succeed.
|
7996
|
+
*/
|
7997
|
+
conditions?: ContainerRequestConditions;
|
7998
|
+
}
|
7999
|
+
|
8000
|
+
/** Contains response data for the setMetadata operation. */
|
8001
|
+
export declare type ContainerSetMetadataResponse = WithResponse<ContainerSetMetadataHeaders, ContainerSetMetadataHeaders>;
|
8002
|
+
|
8003
|
+
/** Contains response data for the setMetadata operation. */
|
8004
|
+
declare type ContainerSetMetadataResponse_2 = ContainerSetMetadataHeaders;
|
8005
|
+
|
8006
|
+
/** Defines headers for Container_submitBatch operation. */
|
8007
|
+
declare interface ContainerSubmitBatchHeaders {
|
8008
|
+
/** The media type of the body of the response. For batch requests, this is multipart/mixed; boundary=batchresponse_GUID */
|
8009
|
+
contentType?: string;
|
8010
|
+
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
8011
|
+
requestId?: string;
|
8012
|
+
/** 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. */
|
8013
|
+
version?: string;
|
8014
|
+
}
|
8015
|
+
|
8016
|
+
/** Optional parameters. */
|
8017
|
+
declare interface ContainerSubmitBatchOptionalParams extends coreClient.OperationOptions {
|
8018
|
+
/** 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> */
|
8019
|
+
timeoutInSeconds?: number;
|
8020
|
+
/** 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. */
|
8021
|
+
requestId?: string;
|
8022
|
+
}
|
8023
|
+
|
8024
|
+
/** Contains response data for the submitBatch operation. */
|
8025
|
+
declare type ContainerSubmitBatchResponse = ContainerSubmitBatchHeaders & {
|
8026
|
+
/**
|
8027
|
+
* BROWSER ONLY
|
8028
|
+
*
|
8029
|
+
* The response body as a browser Blob.
|
8030
|
+
* Always `undefined` in node.js.
|
6571
8031
|
*/
|
6572
|
-
|
8032
|
+
blobBody?: Promise<Blob>;
|
6573
8033
|
/**
|
6574
|
-
*
|
6575
|
-
*
|
8034
|
+
* NODEJS ONLY
|
8035
|
+
*
|
8036
|
+
* The response body as a node.js Readable stream.
|
8037
|
+
* Always `undefined` in the browser.
|
6576
8038
|
*/
|
6577
|
-
|
6578
|
-
}
|
6579
|
-
|
6580
|
-
/** Contains response data for the setMetadata operation. */
|
6581
|
-
export declare type ContainerSetMetadataResponse = ContainerSetMetadataHeaders & {
|
6582
|
-
/** The underlying HTTP response. */
|
6583
|
-
_response: coreHttp.HttpResponse & {
|
6584
|
-
/** The parsed HTTP response headers. */
|
6585
|
-
parsedHeaders: ContainerSetMetadataHeaders;
|
6586
|
-
};
|
8039
|
+
readableStreamBody?: NodeJS.ReadableStream;
|
6587
8040
|
};
|
6588
8041
|
|
6589
8042
|
/** Defines headers for Container_restore operation. */
|
@@ -6601,13 +8054,7 @@ export declare interface ContainerUndeleteHeaders {
|
|
6601
8054
|
}
|
6602
8055
|
|
6603
8056
|
/** Contains response data for the restore operation. */
|
6604
|
-
export declare type ContainerUndeleteResponse = ContainerUndeleteHeaders
|
6605
|
-
/** The underlying HTTP response. */
|
6606
|
-
_response: coreHttp.HttpResponse & {
|
6607
|
-
/** The parsed HTTP response headers. */
|
6608
|
-
parsedHeaders: ContainerUndeleteHeaders;
|
6609
|
-
};
|
6610
|
-
};
|
8057
|
+
export declare type ContainerUndeleteResponse = WithResponse<ContainerUndeleteHeaders, ContainerUndeleteHeaders>;
|
6611
8058
|
|
6612
8059
|
/**
|
6613
8060
|
* Defines the operations from a {@link BlobClient} that are needed for the poller
|
@@ -6687,13 +8134,25 @@ export declare type CredentialPolicyCreator = (nextPolicy: RequestPolicy, option
|
|
6687
8134
|
/** Defines values for DeleteSnapshotsOptionType. */
|
6688
8135
|
export declare type DeleteSnapshotsOptionType = "include" | "only";
|
6689
8136
|
|
6690
|
-
|
8137
|
+
/** Groups the settings used for interpreting the blob data if the blob is delimited text formatted. */
|
8138
|
+
declare interface DelimitedTextConfiguration {
|
8139
|
+
/** The string used to separate columns. */
|
8140
|
+
columnSeparator?: string;
|
8141
|
+
/** The string used to quote a specific field. */
|
8142
|
+
fieldQuote?: string;
|
8143
|
+
/** The string used to separate records. */
|
8144
|
+
recordSeparator?: string;
|
8145
|
+
/** The string used as an escape character. */
|
8146
|
+
escapeChar?: string;
|
8147
|
+
/** Represents whether the data has headers. */
|
8148
|
+
headersPresent?: boolean;
|
8149
|
+
}
|
6691
8150
|
|
6692
8151
|
/**
|
6693
8152
|
* Defines values for EncryptionAlgorithmType. \
|
6694
8153
|
* {@link KnownEncryptionAlgorithmType} can be used interchangeably with EncryptionAlgorithmType,
|
6695
8154
|
* this enum contains the known values that the service supports.
|
6696
|
-
* ###
|
8155
|
+
* ### Known values supported by the service
|
6697
8156
|
* **AES256**
|
6698
8157
|
*/
|
6699
8158
|
export declare type EncryptionAlgorithmType = string;
|
@@ -6909,7 +8368,25 @@ export { HttpOperationResponse }
|
|
6909
8368
|
|
6910
8369
|
export { HttpRequestBody }
|
6911
8370
|
|
6912
|
-
|
8371
|
+
/**
|
8372
|
+
* A representation of an HTTP response that
|
8373
|
+
* includes a reference to the request that
|
8374
|
+
* originated it.
|
8375
|
+
*/
|
8376
|
+
export declare interface HttpResponse {
|
8377
|
+
/**
|
8378
|
+
* The headers from the response.
|
8379
|
+
*/
|
8380
|
+
headers: HttpHeaders;
|
8381
|
+
/**
|
8382
|
+
* The original request that resulted in this response.
|
8383
|
+
*/
|
8384
|
+
request: WebResource;
|
8385
|
+
/**
|
8386
|
+
* The HTTP status code returned from the service.
|
8387
|
+
*/
|
8388
|
+
status: number;
|
8389
|
+
}
|
6913
8390
|
|
6914
8391
|
/**
|
6915
8392
|
* A helper to decide if a given argument satisfies the Pipeline contract
|
@@ -6918,6 +8395,20 @@ export { IHttpClient }
|
|
6918
8395
|
*/
|
6919
8396
|
export declare function isPipelineLike(pipeline: unknown): pipeline is PipelineLike;
|
6920
8397
|
|
8398
|
+
/** json text configuration */
|
8399
|
+
declare interface JsonTextConfiguration {
|
8400
|
+
/** The string used to separate records. */
|
8401
|
+
recordSeparator?: string;
|
8402
|
+
}
|
8403
|
+
|
8404
|
+
/** Key information */
|
8405
|
+
declare interface KeyInfo {
|
8406
|
+
/** The date-time the key is active in ISO 8601 UTC time */
|
8407
|
+
startsOn: string;
|
8408
|
+
/** The date-time the key expires in ISO 8601 UTC time */
|
8409
|
+
expiresOn: string;
|
8410
|
+
}
|
8411
|
+
|
6921
8412
|
/**
|
6922
8413
|
* The details for a specific lease.
|
6923
8414
|
*/
|
@@ -6996,17 +8487,7 @@ export declare interface LeaseOperationOptions extends CommonOptions {
|
|
6996
8487
|
*
|
6997
8488
|
* See {@link BlobLeaseClient}.
|
6998
8489
|
*/
|
6999
|
-
export declare type LeaseOperationResponse = Lease
|
7000
|
-
/**
|
7001
|
-
* The underlying HTTP response.
|
7002
|
-
*/
|
7003
|
-
_response: HttpResponse & {
|
7004
|
-
/**
|
7005
|
-
* The parsed HTTP response headers.
|
7006
|
-
*/
|
7007
|
-
parsedHeaders: Lease;
|
7008
|
-
};
|
7009
|
-
};
|
8490
|
+
export declare type LeaseOperationResponse = WithResponse<Lease, Lease>;
|
7010
8491
|
|
7011
8492
|
/** Defines values for LeaseStateType. */
|
7012
8493
|
export declare type LeaseStateType = "available" | "leased" | "expired" | "breaking" | "broken";
|
@@ -7027,6 +8508,17 @@ export declare interface ListBlobsFlatSegmentResponse {
|
|
7027
8508
|
continuationToken?: string;
|
7028
8509
|
}
|
7029
8510
|
|
8511
|
+
/** An enumeration of blobs */
|
8512
|
+
declare interface ListBlobsFlatSegmentResponse_2 {
|
8513
|
+
serviceEndpoint: string;
|
8514
|
+
containerName: string;
|
8515
|
+
prefix?: string;
|
8516
|
+
marker?: string;
|
8517
|
+
maxPageSize?: number;
|
8518
|
+
segment: BlobFlatListSegment_2;
|
8519
|
+
continuationToken?: string;
|
8520
|
+
}
|
8521
|
+
|
7030
8522
|
/** An enumeration of blobs */
|
7031
8523
|
export declare interface ListBlobsFlatSegmentResponseModel {
|
7032
8524
|
serviceEndpoint: string;
|
@@ -7052,6 +8544,18 @@ export declare interface ListBlobsHierarchySegmentResponse {
|
|
7052
8544
|
continuationToken?: string;
|
7053
8545
|
}
|
7054
8546
|
|
8547
|
+
/** An enumeration of blobs */
|
8548
|
+
declare interface ListBlobsHierarchySegmentResponse_2 {
|
8549
|
+
serviceEndpoint: string;
|
8550
|
+
containerName: string;
|
8551
|
+
prefix?: string;
|
8552
|
+
marker?: string;
|
8553
|
+
maxPageSize?: number;
|
8554
|
+
delimiter?: string;
|
8555
|
+
segment: BlobHierarchyListSegment_2;
|
8556
|
+
continuationToken?: string;
|
8557
|
+
}
|
8558
|
+
|
7055
8559
|
/** An enumeration of blobs */
|
7056
8560
|
export declare interface ListBlobsHierarchySegmentResponseModel {
|
7057
8561
|
serviceEndpoint: string;
|
@@ -7064,6 +8568,12 @@ export declare interface ListBlobsHierarchySegmentResponseModel {
|
|
7064
8568
|
continuationToken?: string;
|
7065
8569
|
}
|
7066
8570
|
|
8571
|
+
/** Defines values for ListBlobsIncludeItem. */
|
8572
|
+
declare type ListBlobsIncludeItem = "copy" | "deleted" | "metadata" | "snapshots" | "uncommittedblobs" | "versions" | "tags" | "immutabilitypolicy" | "legalhold" | "deletedwithversions";
|
8573
|
+
|
8574
|
+
/** Defines values for ListContainersIncludeType. */
|
8575
|
+
declare type ListContainersIncludeType = "metadata" | "deleted" | "system";
|
8576
|
+
|
7067
8577
|
/** An enumeration of containers */
|
7068
8578
|
export declare interface ListContainersSegmentResponse {
|
7069
8579
|
serviceEndpoint: string;
|
@@ -7212,6 +8722,83 @@ export declare interface ObjectReplicationRule {
|
|
7212
8722
|
*/
|
7213
8723
|
export declare type ObjectReplicationStatus = "complete" | "failed";
|
7214
8724
|
|
8725
|
+
/** Interface representing a PageBlob. */
|
8726
|
+
declare interface PageBlob {
|
8727
|
+
/**
|
8728
|
+
* The Create operation creates a new page blob.
|
8729
|
+
* @param contentLength The length of the request.
|
8730
|
+
* @param blobContentLength This header specifies the maximum size for the page blob, up to 1 TB. The
|
8731
|
+
* page blob size must be aligned to a 512-byte boundary.
|
8732
|
+
* @param options The options parameters.
|
8733
|
+
*/
|
8734
|
+
create(contentLength: number, blobContentLength: number, options?: PageBlobCreateOptionalParams): Promise<PageBlobCreateResponse_2>;
|
8735
|
+
/**
|
8736
|
+
* The Upload Pages operation writes a range of pages to a page blob
|
8737
|
+
* @param contentLength The length of the request.
|
8738
|
+
* @param body Initial data
|
8739
|
+
* @param options The options parameters.
|
8740
|
+
*/
|
8741
|
+
uploadPages(contentLength: number, body: coreRestPipeline.RequestBodyType, options?: PageBlobUploadPagesOptionalParams): Promise<PageBlobUploadPagesResponse_2>;
|
8742
|
+
/**
|
8743
|
+
* The Clear Pages operation clears a set of pages from a page blob
|
8744
|
+
* @param contentLength The length of the request.
|
8745
|
+
* @param options The options parameters.
|
8746
|
+
*/
|
8747
|
+
clearPages(contentLength: number, options?: PageBlobClearPagesOptionalParams): Promise<PageBlobClearPagesResponse_2>;
|
8748
|
+
/**
|
8749
|
+
* The Upload Pages operation writes a range of pages to a page blob where the contents are read from a
|
8750
|
+
* URL
|
8751
|
+
* @param sourceUrl Specify a URL to the copy source.
|
8752
|
+
* @param sourceRange Bytes of source data in the specified range. The length of this range should
|
8753
|
+
* match the ContentLength header and x-ms-range/Range destination range header.
|
8754
|
+
* @param contentLength The length of the request.
|
8755
|
+
* @param range The range of bytes to which the source range would be written. The range should be 512
|
8756
|
+
* aligned and range-end is required.
|
8757
|
+
* @param options The options parameters.
|
8758
|
+
*/
|
8759
|
+
uploadPagesFromURL(sourceUrl: string, sourceRange: string, contentLength: number, range: string, options?: PageBlobUploadPagesFromURLOptionalParams): Promise<PageBlobUploadPagesFromURLResponse_2>;
|
8760
|
+
/**
|
8761
|
+
* The Get Page Ranges operation returns the list of valid page ranges for a page blob or snapshot of a
|
8762
|
+
* page blob
|
8763
|
+
* @param options The options parameters.
|
8764
|
+
*/
|
8765
|
+
getPageRanges(options?: PageBlobGetPageRangesOptionalParams): Promise<PageBlobGetPageRangesResponseInternal>;
|
8766
|
+
/**
|
8767
|
+
* The Get Page Ranges Diff operation returns the list of valid page ranges for a page blob that were
|
8768
|
+
* changed between target blob and previous snapshot.
|
8769
|
+
* @param options The options parameters.
|
8770
|
+
*/
|
8771
|
+
getPageRangesDiff(options?: PageBlobGetPageRangesDiffOptionalParams): Promise<PageBlobGetPageRangesDiffResponseInternal>;
|
8772
|
+
/**
|
8773
|
+
* Resize the Blob
|
8774
|
+
* @param blobContentLength This header specifies the maximum size for the page blob, up to 1 TB. The
|
8775
|
+
* page blob size must be aligned to a 512-byte boundary.
|
8776
|
+
* @param options The options parameters.
|
8777
|
+
*/
|
8778
|
+
resize(blobContentLength: number, options?: PageBlobResizeOptionalParams): Promise<PageBlobResizeResponse_2>;
|
8779
|
+
/**
|
8780
|
+
* Update the sequence number of the blob
|
8781
|
+
* @param sequenceNumberAction Required if the x-ms-blob-sequence-number header is set for the request.
|
8782
|
+
* This property applies to page blobs only. This property indicates how the service should modify the
|
8783
|
+
* blob's sequence number
|
8784
|
+
* @param options The options parameters.
|
8785
|
+
*/
|
8786
|
+
updateSequenceNumber(sequenceNumberAction: SequenceNumberActionType, options?: PageBlobUpdateSequenceNumberOptionalParams): Promise<PageBlobUpdateSequenceNumberResponse_2>;
|
8787
|
+
/**
|
8788
|
+
* The Copy Incremental operation copies a snapshot of the source page blob to a destination page blob.
|
8789
|
+
* The snapshot is copied such that only the differential changes between the previously copied
|
8790
|
+
* snapshot are transferred to the destination. The copied snapshots are complete copies of the
|
8791
|
+
* original snapshot and can be read or copied from as usual. This API is supported since REST version
|
8792
|
+
* 2016-05-31.
|
8793
|
+
* @param copySource Specifies the name of the source page blob snapshot. This value is a URL of up to
|
8794
|
+
* 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would
|
8795
|
+
* appear in a request URI. The source blob must either be public or must be authenticated via a shared
|
8796
|
+
* access signature.
|
8797
|
+
* @param options The options parameters.
|
8798
|
+
*/
|
8799
|
+
copyIncremental(copySource: string, options?: PageBlobCopyIncrementalOptionalParams): Promise<PageBlobCopyIncrementalResponse_2>;
|
8800
|
+
}
|
8801
|
+
|
7215
8802
|
/** Defines headers for PageBlob_clearPages operation. */
|
7216
8803
|
export declare interface PageBlobClearPagesHeaders {
|
7217
8804
|
/** 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. */
|
@@ -7236,6 +8823,26 @@ export declare interface PageBlobClearPagesHeaders {
|
|
7236
8823
|
errorCode?: string;
|
7237
8824
|
}
|
7238
8825
|
|
8826
|
+
/** Optional parameters. */
|
8827
|
+
declare interface PageBlobClearPagesOptionalParams extends coreClient.OperationOptions {
|
8828
|
+
/** Parameter group */
|
8829
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
8830
|
+
/** Parameter group */
|
8831
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
8832
|
+
/** Parameter group */
|
8833
|
+
cpkInfo?: CpkInfo;
|
8834
|
+
/** Parameter group */
|
8835
|
+
sequenceNumberAccessConditions?: SequenceNumberAccessConditions;
|
8836
|
+
/** 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> */
|
8837
|
+
timeoutInSeconds?: number;
|
8838
|
+
/** 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. */
|
8839
|
+
requestId?: string;
|
8840
|
+
/** Return only the bytes of the blob in the specified range. */
|
8841
|
+
range?: string;
|
8842
|
+
/** 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. */
|
8843
|
+
encryptionScope?: string;
|
8844
|
+
}
|
8845
|
+
|
7239
8846
|
/**
|
7240
8847
|
* Options to configure the {@link PageBlobClient.clearPages} operation.
|
7241
8848
|
*/
|
@@ -7263,13 +8870,10 @@ export declare interface PageBlobClearPagesOptions extends CommonOptions {
|
|
7263
8870
|
}
|
7264
8871
|
|
7265
8872
|
/** Contains response data for the clearPages operation. */
|
7266
|
-
export declare type PageBlobClearPagesResponse = PageBlobClearPagesHeaders
|
7267
|
-
|
7268
|
-
|
7269
|
-
|
7270
|
-
parsedHeaders: PageBlobClearPagesHeaders;
|
7271
|
-
};
|
7272
|
-
};
|
8873
|
+
export declare type PageBlobClearPagesResponse = WithResponse<PageBlobClearPagesHeaders, PageBlobClearPagesHeaders>;
|
8874
|
+
|
8875
|
+
/** Contains response data for the clearPages operation. */
|
8876
|
+
declare type PageBlobClearPagesResponse_2 = PageBlobClearPagesHeaders;
|
7273
8877
|
|
7274
8878
|
/**
|
7275
8879
|
* PageBlobClient defines a set of operations applicable to page blobs.
|
@@ -7695,14 +9299,21 @@ export declare interface PageBlobCopyIncrementalHeaders {
|
|
7695
9299
|
errorCode?: string;
|
7696
9300
|
}
|
7697
9301
|
|
9302
|
+
/** Optional parameters. */
|
9303
|
+
declare interface PageBlobCopyIncrementalOptionalParams extends coreClient.OperationOptions {
|
9304
|
+
/** Parameter group */
|
9305
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9306
|
+
/** 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> */
|
9307
|
+
timeoutInSeconds?: number;
|
9308
|
+
/** 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. */
|
9309
|
+
requestId?: string;
|
9310
|
+
}
|
9311
|
+
|
7698
9312
|
/** Contains response data for the copyIncremental operation. */
|
7699
|
-
export declare type PageBlobCopyIncrementalResponse = PageBlobCopyIncrementalHeaders
|
7700
|
-
|
7701
|
-
|
7702
|
-
|
7703
|
-
parsedHeaders: PageBlobCopyIncrementalHeaders;
|
7704
|
-
};
|
7705
|
-
};
|
9313
|
+
export declare type PageBlobCopyIncrementalResponse = WithResponse<PageBlobCopyIncrementalHeaders, PageBlobCopyIncrementalHeaders>;
|
9314
|
+
|
9315
|
+
/** Contains response data for the copyIncremental operation. */
|
9316
|
+
declare type PageBlobCopyIncrementalResponse_2 = PageBlobCopyIncrementalHeaders;
|
7706
9317
|
|
7707
9318
|
/** Defines headers for PageBlob_create operation. */
|
7708
9319
|
export declare interface PageBlobCreateHeaders {
|
@@ -7794,6 +9405,40 @@ export declare interface PageBlobCreateIfNotExistsResponse extends PageBlobCreat
|
|
7794
9405
|
succeeded: boolean;
|
7795
9406
|
}
|
7796
9407
|
|
9408
|
+
/** Optional parameters. */
|
9409
|
+
declare interface PageBlobCreateOptionalParams extends coreClient.OperationOptions {
|
9410
|
+
/** Parameter group */
|
9411
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
9412
|
+
/** Parameter group */
|
9413
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9414
|
+
/** Parameter group */
|
9415
|
+
cpkInfo?: CpkInfo;
|
9416
|
+
/** Parameter group */
|
9417
|
+
blobHttpHeaders?: BlobHTTPHeaders;
|
9418
|
+
/** 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> */
|
9419
|
+
timeoutInSeconds?: number;
|
9420
|
+
/** 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. */
|
9421
|
+
requestId?: string;
|
9422
|
+
/** 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. */
|
9423
|
+
metadata?: {
|
9424
|
+
[propertyName: string]: string;
|
9425
|
+
};
|
9426
|
+
/** Specifies the date time when the blobs immutability policy is set to expire. */
|
9427
|
+
immutabilityPolicyExpiry?: Date;
|
9428
|
+
/** Specifies the immutability policy mode to set on the blob. */
|
9429
|
+
immutabilityPolicyMode?: BlobImmutabilityPolicyMode;
|
9430
|
+
/** 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. */
|
9431
|
+
encryptionScope?: string;
|
9432
|
+
/** Optional. Indicates the tier to be set on the blob. */
|
9433
|
+
tier?: AccessTier;
|
9434
|
+
/** Optional. Used to set blob tags in various blob operations. */
|
9435
|
+
blobTagsString?: string;
|
9436
|
+
/** Specified if a legal hold should be set on the blob. */
|
9437
|
+
legalHold?: boolean;
|
9438
|
+
/** 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. */
|
9439
|
+
blobSequenceNumber?: number;
|
9440
|
+
}
|
9441
|
+
|
7797
9442
|
/**
|
7798
9443
|
* Options to configure the {@link PageBlobClient.create} operation.
|
7799
9444
|
*/
|
@@ -7855,13 +9500,10 @@ export declare interface PageBlobCreateOptions extends CommonOptions {
|
|
7855
9500
|
}
|
7856
9501
|
|
7857
9502
|
/** Contains response data for the create operation. */
|
7858
|
-
export declare type PageBlobCreateResponse = PageBlobCreateHeaders
|
7859
|
-
|
7860
|
-
|
7861
|
-
|
7862
|
-
parsedHeaders: PageBlobCreateHeaders;
|
7863
|
-
};
|
7864
|
-
};
|
9503
|
+
export declare type PageBlobCreateResponse = WithResponse<PageBlobCreateHeaders, PageBlobCreateHeaders>;
|
9504
|
+
|
9505
|
+
/** Contains response data for the create operation. */
|
9506
|
+
declare type PageBlobCreateResponse_2 = PageBlobCreateHeaders;
|
7865
9507
|
|
7866
9508
|
/** Defines headers for PageBlob_getPageRangesDiff operation. */
|
7867
9509
|
export declare interface PageBlobGetPageRangesDiffHeaders {
|
@@ -7883,6 +9525,30 @@ export declare interface PageBlobGetPageRangesDiffHeaders {
|
|
7883
9525
|
errorCode?: string;
|
7884
9526
|
}
|
7885
9527
|
|
9528
|
+
/** Optional parameters. */
|
9529
|
+
declare interface PageBlobGetPageRangesDiffOptionalParams extends coreClient.OperationOptions {
|
9530
|
+
/** Parameter group */
|
9531
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
9532
|
+
/** Parameter group */
|
9533
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9534
|
+
/** 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> */
|
9535
|
+
timeoutInSeconds?: number;
|
9536
|
+
/** 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. */
|
9537
|
+
requestId?: string;
|
9538
|
+
/** 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. */
|
9539
|
+
marker?: string;
|
9540
|
+
/** 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. */
|
9541
|
+
maxPageSize?: number;
|
9542
|
+
/** 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> */
|
9543
|
+
snapshot?: string;
|
9544
|
+
/** Return only the bytes of the blob in the specified range. */
|
9545
|
+
range?: string;
|
9546
|
+
/** 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. */
|
9547
|
+
prevsnapshot?: string;
|
9548
|
+
/** 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. */
|
9549
|
+
prevSnapshotUrl?: string;
|
9550
|
+
}
|
9551
|
+
|
7886
9552
|
/**
|
7887
9553
|
* Options to configure the {@link PageBlobClient.getRangesDiff} operation.
|
7888
9554
|
*/
|
@@ -7905,38 +9571,14 @@ export declare interface PageBlobGetPageRangesDiffOptions extends CommonOptions
|
|
7905
9571
|
/**
|
7906
9572
|
* Contains response data for the {@link BlobClient.getPageRangesDiff} operation.
|
7907
9573
|
*/
|
7908
|
-
export declare interface PageBlobGetPageRangesDiffResponse extends PageList, PageBlobGetPageRangesDiffHeaders {
|
7909
|
-
/**
|
7910
|
-
* The underlying HTTP response.
|
7911
|
-
*/
|
7912
|
-
_response: HttpResponse & {
|
7913
|
-
/**
|
7914
|
-
* The parsed HTTP response headers.
|
7915
|
-
*/
|
7916
|
-
parsedHeaders: PageBlobGetPageRangesDiffHeaders;
|
7917
|
-
/**
|
7918
|
-
* The response body as text (string format)
|
7919
|
-
*/
|
7920
|
-
bodyAsText: string;
|
7921
|
-
/**
|
7922
|
-
* The response body as parsed JSON or XML
|
7923
|
-
*/
|
7924
|
-
parsedBody: PageList;
|
7925
|
-
};
|
9574
|
+
export declare interface PageBlobGetPageRangesDiffResponse extends PageList, PageBlobGetPageRangesDiffHeaders, ResponseWithBody<PageBlobGetPageRangesDiffHeaders, PageList> {
|
7926
9575
|
}
|
7927
9576
|
|
7928
9577
|
/** Contains response data for the getPageRangesDiff operation. */
|
7929
|
-
export declare type
|
7930
|
-
|
7931
|
-
|
7932
|
-
|
7933
|
-
bodyAsText: string;
|
7934
|
-
/** The response body as parsed JSON or XML */
|
7935
|
-
parsedBody: PageList_2;
|
7936
|
-
/** The parsed HTTP response headers. */
|
7937
|
-
parsedHeaders: PageBlobGetPageRangesDiffHeaders;
|
7938
|
-
};
|
7939
|
-
};
|
9578
|
+
export declare type PageBlobGetPageRangesDiffResponseInternal = PageBlobGetPageRangesDiffHeaders & PageListInternal;
|
9579
|
+
|
9580
|
+
/** Contains response data for the getPageRangesDiff operation. */
|
9581
|
+
export declare type PageBlobGetPageRangesDiffResponseModel = WithResponse<PageBlobGetPageRangesDiffResponseInternal, PageBlobGetPageRangesDiffHeaders, PageListInternal>;
|
7940
9582
|
|
7941
9583
|
/** Defines headers for PageBlob_getPageRanges operation. */
|
7942
9584
|
export declare interface PageBlobGetPageRangesHeaders {
|
@@ -7958,6 +9600,26 @@ export declare interface PageBlobGetPageRangesHeaders {
|
|
7958
9600
|
errorCode?: string;
|
7959
9601
|
}
|
7960
9602
|
|
9603
|
+
/** Optional parameters. */
|
9604
|
+
declare interface PageBlobGetPageRangesOptionalParams extends coreClient.OperationOptions {
|
9605
|
+
/** Parameter group */
|
9606
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
9607
|
+
/** Parameter group */
|
9608
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9609
|
+
/** 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> */
|
9610
|
+
timeoutInSeconds?: number;
|
9611
|
+
/** 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. */
|
9612
|
+
requestId?: string;
|
9613
|
+
/** 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. */
|
9614
|
+
marker?: string;
|
9615
|
+
/** 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. */
|
9616
|
+
maxPageSize?: number;
|
9617
|
+
/** 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> */
|
9618
|
+
snapshot?: string;
|
9619
|
+
/** Return only the bytes of the blob in the specified range. */
|
9620
|
+
range?: string;
|
9621
|
+
}
|
9622
|
+
|
7961
9623
|
/**
|
7962
9624
|
* Options to configure the {@link PageBlobClient.getPageRanges} operation.
|
7963
9625
|
*/
|
@@ -7976,38 +9638,14 @@ export declare interface PageBlobGetPageRangesOptions extends CommonOptions {
|
|
7976
9638
|
/**
|
7977
9639
|
* Contains response data for the {@link BlobClient.getPageRanges} operation.
|
7978
9640
|
*/
|
7979
|
-
export declare interface PageBlobGetPageRangesResponse extends PageList, PageBlobGetPageRangesHeaders {
|
7980
|
-
/**
|
7981
|
-
* The underlying HTTP response.
|
7982
|
-
*/
|
7983
|
-
_response: HttpResponse & {
|
7984
|
-
/**
|
7985
|
-
* The parsed HTTP response headers.
|
7986
|
-
*/
|
7987
|
-
parsedHeaders: PageBlobGetPageRangesHeaders;
|
7988
|
-
/**
|
7989
|
-
* The response body as text (string format)
|
7990
|
-
*/
|
7991
|
-
bodyAsText: string;
|
7992
|
-
/**
|
7993
|
-
* The response body as parsed JSON or XML
|
7994
|
-
*/
|
7995
|
-
parsedBody: PageList;
|
7996
|
-
};
|
9641
|
+
export declare interface PageBlobGetPageRangesResponse extends PageList, PageBlobGetPageRangesHeaders, ResponseWithBody<PageBlobGetPageRangesHeaders, PageList> {
|
7997
9642
|
}
|
7998
9643
|
|
7999
9644
|
/** Contains response data for the getPageRanges operation. */
|
8000
|
-
export declare type
|
8001
|
-
|
8002
|
-
|
8003
|
-
|
8004
|
-
bodyAsText: string;
|
8005
|
-
/** The response body as parsed JSON or XML */
|
8006
|
-
parsedBody: PageList_2;
|
8007
|
-
/** The parsed HTTP response headers. */
|
8008
|
-
parsedHeaders: PageBlobGetPageRangesHeaders;
|
8009
|
-
};
|
8010
|
-
};
|
9645
|
+
export declare type PageBlobGetPageRangesResponseInternal = PageBlobGetPageRangesHeaders & PageListInternal;
|
9646
|
+
|
9647
|
+
/** Contains response data for the getPageRanges operation. */
|
9648
|
+
export declare type PageBlobGetPageRangesResponseModel = WithResponse<PageBlobGetPageRangesResponseInternal, PageBlobGetPageRangesHeaders, PageListInternal>;
|
8011
9649
|
|
8012
9650
|
/**
|
8013
9651
|
* Options to configure the {@link PageBlobClient.listPageRangesDiff} operation.
|
@@ -8065,6 +9703,22 @@ export declare interface PageBlobResizeHeaders {
|
|
8065
9703
|
errorCode?: string;
|
8066
9704
|
}
|
8067
9705
|
|
9706
|
+
/** Optional parameters. */
|
9707
|
+
declare interface PageBlobResizeOptionalParams extends coreClient.OperationOptions {
|
9708
|
+
/** Parameter group */
|
9709
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
9710
|
+
/** Parameter group */
|
9711
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9712
|
+
/** Parameter group */
|
9713
|
+
cpkInfo?: CpkInfo;
|
9714
|
+
/** 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> */
|
9715
|
+
timeoutInSeconds?: number;
|
9716
|
+
/** 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. */
|
9717
|
+
requestId?: string;
|
9718
|
+
/** 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. */
|
9719
|
+
encryptionScope?: string;
|
9720
|
+
}
|
9721
|
+
|
8068
9722
|
/**
|
8069
9723
|
* Options to configure {@link PageBlobClient.resize} operation.
|
8070
9724
|
*/
|
@@ -8088,13 +9742,10 @@ export declare interface PageBlobResizeOptions extends CommonOptions {
|
|
8088
9742
|
}
|
8089
9743
|
|
8090
9744
|
/** Contains response data for the resize operation. */
|
8091
|
-
export declare type PageBlobResizeResponse = PageBlobResizeHeaders
|
8092
|
-
|
8093
|
-
|
8094
|
-
|
8095
|
-
parsedHeaders: PageBlobResizeHeaders;
|
8096
|
-
};
|
8097
|
-
};
|
9745
|
+
export declare type PageBlobResizeResponse = WithResponse<PageBlobResizeHeaders, PageBlobResizeHeaders>;
|
9746
|
+
|
9747
|
+
/** Contains response data for the resize operation. */
|
9748
|
+
declare type PageBlobResizeResponse_2 = PageBlobResizeHeaders;
|
8098
9749
|
|
8099
9750
|
/**
|
8100
9751
|
* Options to configure {@link PageBlobClient.startCopyIncremental} operation.
|
@@ -8123,12 +9774,26 @@ export declare interface PageBlobUpdateSequenceNumberHeaders {
|
|
8123
9774
|
clientRequestId?: string;
|
8124
9775
|
/** This header uniquely identifies the request that was made and can be used for troubleshooting the request. */
|
8125
9776
|
requestId?: string;
|
8126
|
-
/** 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. */
|
8127
|
-
version?: string;
|
8128
|
-
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
8129
|
-
date?: Date;
|
8130
|
-
/** Error Code */
|
8131
|
-
errorCode?: string;
|
9777
|
+
/** 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. */
|
9778
|
+
version?: string;
|
9779
|
+
/** UTC date/time value generated by the service that indicates the time at which the response was initiated */
|
9780
|
+
date?: Date;
|
9781
|
+
/** Error Code */
|
9782
|
+
errorCode?: string;
|
9783
|
+
}
|
9784
|
+
|
9785
|
+
/** Optional parameters. */
|
9786
|
+
declare interface PageBlobUpdateSequenceNumberOptionalParams extends coreClient.OperationOptions {
|
9787
|
+
/** Parameter group */
|
9788
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
9789
|
+
/** Parameter group */
|
9790
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9791
|
+
/** 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> */
|
9792
|
+
timeoutInSeconds?: number;
|
9793
|
+
/** 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. */
|
9794
|
+
requestId?: string;
|
9795
|
+
/** 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. */
|
9796
|
+
blobSequenceNumber?: number;
|
8132
9797
|
}
|
8133
9798
|
|
8134
9799
|
/**
|
@@ -8147,13 +9812,10 @@ export declare interface PageBlobUpdateSequenceNumberOptions extends CommonOptio
|
|
8147
9812
|
}
|
8148
9813
|
|
8149
9814
|
/** Contains response data for the updateSequenceNumber operation. */
|
8150
|
-
export declare type PageBlobUpdateSequenceNumberResponse = PageBlobUpdateSequenceNumberHeaders
|
8151
|
-
|
8152
|
-
|
8153
|
-
|
8154
|
-
parsedHeaders: PageBlobUpdateSequenceNumberHeaders;
|
8155
|
-
};
|
8156
|
-
};
|
9815
|
+
export declare type PageBlobUpdateSequenceNumberResponse = WithResponse<PageBlobUpdateSequenceNumberHeaders, PageBlobUpdateSequenceNumberHeaders>;
|
9816
|
+
|
9817
|
+
/** Contains response data for the updateSequenceNumber operation. */
|
9818
|
+
declare type PageBlobUpdateSequenceNumberResponse_2 = PageBlobUpdateSequenceNumberHeaders;
|
8157
9819
|
|
8158
9820
|
/** Defines headers for PageBlob_uploadPagesFromURL operation. */
|
8159
9821
|
export declare interface PageBlobUploadPagesFromURLHeaders {
|
@@ -8183,6 +9845,32 @@ export declare interface PageBlobUploadPagesFromURLHeaders {
|
|
8183
9845
|
errorCode?: string;
|
8184
9846
|
}
|
8185
9847
|
|
9848
|
+
/** Optional parameters. */
|
9849
|
+
declare interface PageBlobUploadPagesFromURLOptionalParams extends coreClient.OperationOptions {
|
9850
|
+
/** Parameter group */
|
9851
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
9852
|
+
/** Parameter group */
|
9853
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9854
|
+
/** Parameter group */
|
9855
|
+
cpkInfo?: CpkInfo;
|
9856
|
+
/** Parameter group */
|
9857
|
+
sourceModifiedAccessConditions?: SourceModifiedAccessConditions;
|
9858
|
+
/** Parameter group */
|
9859
|
+
sequenceNumberAccessConditions?: SequenceNumberAccessConditions;
|
9860
|
+
/** 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> */
|
9861
|
+
timeoutInSeconds?: number;
|
9862
|
+
/** 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. */
|
9863
|
+
requestId?: string;
|
9864
|
+
/** 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. */
|
9865
|
+
encryptionScope?: string;
|
9866
|
+
/** Specify the md5 calculated for the range of bytes that must be read from the copy source. */
|
9867
|
+
sourceContentMD5?: Uint8Array;
|
9868
|
+
/** Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source. */
|
9869
|
+
copySourceAuthorization?: string;
|
9870
|
+
/** Specify the crc64 calculated for the range of bytes that must be read from the copy source. */
|
9871
|
+
sourceContentCrc64?: Uint8Array;
|
9872
|
+
}
|
9873
|
+
|
8186
9874
|
/**
|
8187
9875
|
* Options to configure {@link PageBlobClient.uploadPagesFromURL} operation.
|
8188
9876
|
*/
|
@@ -8234,13 +9922,10 @@ export declare interface PageBlobUploadPagesFromURLOptions extends CommonOptions
|
|
8234
9922
|
}
|
8235
9923
|
|
8236
9924
|
/** Contains response data for the uploadPagesFromURL operation. */
|
8237
|
-
export declare type PageBlobUploadPagesFromURLResponse = PageBlobUploadPagesFromURLHeaders
|
8238
|
-
|
8239
|
-
|
8240
|
-
|
8241
|
-
parsedHeaders: PageBlobUploadPagesFromURLHeaders;
|
8242
|
-
};
|
8243
|
-
};
|
9925
|
+
export declare type PageBlobUploadPagesFromURLResponse = WithResponse<PageBlobUploadPagesFromURLHeaders, PageBlobUploadPagesFromURLHeaders>;
|
9926
|
+
|
9927
|
+
/** Contains response data for the uploadPagesFromURL operation. */
|
9928
|
+
declare type PageBlobUploadPagesFromURLResponse_2 = PageBlobUploadPagesFromURLHeaders;
|
8244
9929
|
|
8245
9930
|
/** Defines headers for PageBlob_uploadPages operation. */
|
8246
9931
|
export declare interface PageBlobUploadPagesHeaders {
|
@@ -8272,6 +9957,30 @@ export declare interface PageBlobUploadPagesHeaders {
|
|
8272
9957
|
errorCode?: string;
|
8273
9958
|
}
|
8274
9959
|
|
9960
|
+
/** Optional parameters. */
|
9961
|
+
declare interface PageBlobUploadPagesOptionalParams extends coreClient.OperationOptions {
|
9962
|
+
/** Parameter group */
|
9963
|
+
leaseAccessConditions?: LeaseAccessConditions;
|
9964
|
+
/** Parameter group */
|
9965
|
+
modifiedAccessConditions?: ModifiedAccessConditionsModel;
|
9966
|
+
/** Parameter group */
|
9967
|
+
cpkInfo?: CpkInfo;
|
9968
|
+
/** Parameter group */
|
9969
|
+
sequenceNumberAccessConditions?: SequenceNumberAccessConditions;
|
9970
|
+
/** 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> */
|
9971
|
+
timeoutInSeconds?: number;
|
9972
|
+
/** 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. */
|
9973
|
+
requestId?: string;
|
9974
|
+
/** Return only the bytes of the blob in the specified range. */
|
9975
|
+
range?: string;
|
9976
|
+
/** 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. */
|
9977
|
+
encryptionScope?: string;
|
9978
|
+
/** Specify the transactional md5 for the body, to be validated by the service. */
|
9979
|
+
transactionalContentMD5?: Uint8Array;
|
9980
|
+
/** Specify the transactional crc64 for the body, to be validated by the service. */
|
9981
|
+
transactionalContentCrc64?: Uint8Array;
|
9982
|
+
}
|
9983
|
+
|
8275
9984
|
/**
|
8276
9985
|
* Options to configure the {@link PageBlobClient.uploadPages} operation.
|
8277
9986
|
*/
|
@@ -8317,13 +10026,10 @@ export declare interface PageBlobUploadPagesOptions extends CommonOptions {
|
|
8317
10026
|
}
|
8318
10027
|
|
8319
10028
|
/** Contains response data for the uploadPages operation. */
|
8320
|
-
export declare type PageBlobUploadPagesResponse = PageBlobUploadPagesHeaders
|
8321
|
-
|
8322
|
-
|
8323
|
-
|
8324
|
-
parsedHeaders: PageBlobUploadPagesHeaders;
|
8325
|
-
};
|
8326
|
-
};
|
10029
|
+
export declare type PageBlobUploadPagesResponse = WithResponse<PageBlobUploadPagesHeaders, PageBlobUploadPagesHeaders>;
|
10030
|
+
|
10031
|
+
/** Contains response data for the uploadPages operation. */
|
10032
|
+
declare type PageBlobUploadPagesResponse_2 = PageBlobUploadPagesHeaders;
|
8327
10033
|
|
8328
10034
|
/**
|
8329
10035
|
* List of page ranges for a blob.
|
@@ -8341,13 +10047,13 @@ export declare interface PageList {
|
|
8341
10047
|
}
|
8342
10048
|
|
8343
10049
|
/** the list of pages */
|
8344
|
-
declare interface
|
10050
|
+
export declare interface PageListInternal {
|
8345
10051
|
pageRange?: PageRange[];
|
8346
10052
|
clearRange?: ClearRange[];
|
8347
10053
|
continuationToken?: string;
|
8348
10054
|
}
|
8349
10055
|
|
8350
|
-
declare interface PageRange {
|
10056
|
+
export declare interface PageRange {
|
8351
10057
|
start: number;
|
8352
10058
|
end: number;
|
8353
10059
|
}
|
@@ -8442,7 +10148,7 @@ export declare interface PipelineOptions {
|
|
8442
10148
|
/**
|
8443
10149
|
* Optional. Configures the HTTP client to send requests and receive responses.
|
8444
10150
|
*/
|
8445
|
-
httpClient?:
|
10151
|
+
httpClient?: RequestPolicy;
|
8446
10152
|
}
|
8447
10153
|
|
8448
10154
|
export { PollerLike }
|
@@ -8564,6 +10270,36 @@ export declare enum PremiumPageBlobTier {
|
|
8564
10270
|
/** Defines values for PublicAccessType. */
|
8565
10271
|
export declare type PublicAccessType = "container" | "blob";
|
8566
10272
|
|
10273
|
+
declare interface QueryFormat {
|
10274
|
+
/** The quick query format type. */
|
10275
|
+
type: QueryFormatType;
|
10276
|
+
/** Groups the settings used for interpreting the blob data if the blob is delimited text formatted. */
|
10277
|
+
delimitedTextConfiguration?: DelimitedTextConfiguration;
|
10278
|
+
/** json text configuration */
|
10279
|
+
jsonTextConfiguration?: JsonTextConfiguration;
|
10280
|
+
/** Groups the settings used for formatting the response if the response should be Arrow formatted. */
|
10281
|
+
arrowConfiguration?: ArrowConfiguration;
|
10282
|
+
/** parquet configuration */
|
10283
|
+
parquetTextConfiguration?: Record<string, unknown>;
|
10284
|
+
}
|
10285
|
+
|
10286
|
+
/** Defines values for QueryFormatType. */
|
10287
|
+
declare type QueryFormatType = "delimited" | "json" | "arrow" | "parquet";
|
10288
|
+
|
10289
|
+
/** Groups the set of query request settings. */
|
10290
|
+
declare interface QueryRequest {
|
10291
|
+
/** Required. The type of the provided query expression. */
|
10292
|
+
queryType: string;
|
10293
|
+
/** The query expression in SQL. The maximum size of the query expression is 256KiB. */
|
10294
|
+
expression: string;
|
10295
|
+
inputSerialization?: QuerySerialization;
|
10296
|
+
outputSerialization?: QuerySerialization;
|
10297
|
+
}
|
10298
|
+
|
10299
|
+
declare interface QuerySerialization {
|
10300
|
+
format: QueryFormat;
|
10301
|
+
}
|
10302
|
+
|
8567
10303
|
/**
|
8568
10304
|
* Range for Blob Service Operations.
|
8569
10305
|
* @see https://docs.microsoft.com/en-us/rest/api/storageservices/specifying-the-range-header-for-blob-service-operations
|
@@ -8584,12 +10320,63 @@ export { Range_2 as Range }
|
|
8584
10320
|
/** Defines values for RehydratePriority. */
|
8585
10321
|
export declare type RehydratePriority = "High" | "Standard";
|
8586
10322
|
|
10323
|
+
export { RequestPolicy as IHttpClient }
|
8587
10324
|
export { RequestPolicy }
|
8588
10325
|
|
8589
10326
|
export { RequestPolicyFactory }
|
8590
10327
|
|
8591
10328
|
export { RequestPolicyOptions }
|
8592
10329
|
|
10330
|
+
/**
|
10331
|
+
* An object with a simple _response property.
|
10332
|
+
*/
|
10333
|
+
export declare interface ResponseLike {
|
10334
|
+
/**
|
10335
|
+
* The underlying HTTP response.
|
10336
|
+
*/
|
10337
|
+
_response: HttpResponse;
|
10338
|
+
}
|
10339
|
+
|
10340
|
+
/**
|
10341
|
+
* An object with a _response property that has body
|
10342
|
+
* and headers already parsed into known types.
|
10343
|
+
*/
|
10344
|
+
export declare interface ResponseWithBody<Headers, Body> {
|
10345
|
+
/**
|
10346
|
+
* The underlying HTTP response.
|
10347
|
+
*/
|
10348
|
+
_response: HttpResponse & {
|
10349
|
+
/**
|
10350
|
+
* The parsed HTTP response headers.
|
10351
|
+
*/
|
10352
|
+
parsedHeaders: Headers;
|
10353
|
+
/**
|
10354
|
+
* The response body as text (string format)
|
10355
|
+
*/
|
10356
|
+
bodyAsText: string;
|
10357
|
+
/**
|
10358
|
+
* The response body as parsed JSON or XML
|
10359
|
+
*/
|
10360
|
+
parsedBody: Body;
|
10361
|
+
};
|
10362
|
+
}
|
10363
|
+
|
10364
|
+
/**
|
10365
|
+
* An object with a _response property that has
|
10366
|
+
* headers already parsed into a typed object.
|
10367
|
+
*/
|
10368
|
+
export declare interface ResponseWithHeaders<Headers> {
|
10369
|
+
/**
|
10370
|
+
* The underlying HTTP response.
|
10371
|
+
*/
|
10372
|
+
_response: HttpResponse & {
|
10373
|
+
/**
|
10374
|
+
* The parsed HTTP response headers.
|
10375
|
+
*/
|
10376
|
+
parsedHeaders: Headers;
|
10377
|
+
};
|
10378
|
+
}
|
10379
|
+
|
8593
10380
|
export { RestError }
|
8594
10381
|
|
8595
10382
|
/** the retention policy which determines how long the associated data should persist */
|
@@ -8914,6 +10701,77 @@ export declare interface SequenceNumberAccessConditions {
|
|
8914
10701
|
/** Defines values for SequenceNumberActionType. */
|
8915
10702
|
export declare type SequenceNumberActionType = "max" | "update" | "increment";
|
8916
10703
|
|
10704
|
+
/** Interface representing a Service. */
|
10705
|
+
declare interface Service {
|
10706
|
+
/**
|
10707
|
+
* Sets properties for a storage account's Blob service endpoint, including properties for Storage
|
10708
|
+
* Analytics and CORS (Cross-Origin Resource Sharing) rules
|
10709
|
+
* @param blobServiceProperties The StorageService properties.
|
10710
|
+
* @param options The options parameters.
|
10711
|
+
*/
|
10712
|
+
setProperties(blobServiceProperties: BlobServiceProperties, options?: ServiceSetPropertiesOptionalParams): Promise<ServiceSetPropertiesResponse_2>;
|
10713
|
+
/**
|
10714
|
+
* gets the properties of a storage account's Blob service, including properties for Storage Analytics
|
10715
|
+
* and CORS (Cross-Origin Resource Sharing) rules.
|
10716
|
+
* @param options The options parameters.
|
10717
|
+
*/
|
10718
|
+
getProperties(options?: ServiceGetPropertiesOptionalParams): Promise<ServiceGetPropertiesResponseInternal>;
|
10719
|
+
/**
|
10720
|
+
* Retrieves statistics related to replication for the Blob service. It is only available on the
|
10721
|
+
* secondary location endpoint when read-access geo-redundant replication is enabled for the storage
|
10722
|
+
* account.
|
10723
|
+
* @param options The options parameters.
|
10724
|
+
*/
|
10725
|
+
getStatistics(options?: ServiceGetStatisticsOptionalParams): Promise<ServiceGetStatisticsResponseInternal>;
|
10726
|
+
/**
|
10727
|
+
* The List Containers Segment operation returns a list of the containers under the specified account
|
10728
|
+
* @param options The options parameters.
|
10729
|
+
*/
|
10730
|
+
listContainersSegment(options?: ServiceListContainersSegmentOptionalParams): Promise<ServiceListContainersSegmentResponseInternal>;
|
10731
|
+
/**
|
10732
|
+
* Retrieves a user delegation key for the Blob service. This is only a valid operation when using
|
10733
|
+
* bearer token authentication.
|
10734
|
+
* @param keyInfo Key information
|
10735
|
+
* @param options The options parameters.
|
10736
|
+
*/
|
10737
|
+
getUserDelegationKey(keyInfo: KeyInfo, options?: ServiceGetUserDelegationKeyOptionalParams): Promise<ServiceGetUserDelegationKeyResponse_2>;
|
10738
|
+
/**
|
10739
|
+
* Returns the sku name and account kind
|
10740
|
+
* @param options The options parameters.
|
10741
|
+
*/
|
10742
|
+
getAccountInfo(options?: ServiceGetAccountInfoOptionalParams): Promise<ServiceGetAccountInfoResponse_2>;
|
10743
|
+
/**
|
10744
|
+
* The Batch operation allows multiple API calls to be embedded into a single HTTP request.
|
10745
|
+
* @param contentLength The length of the request.
|
10746
|
+
* @param multipartContentType Required. The value of this header must be multipart/mixed with a batch
|
10747
|
+
* boundary. Example header value: multipart/mixed; boundary=batch_<GUID>
|
10748
|
+
* @param body Initial data
|
10749
|
+
* @param options The options parameters.
|
10750
|
+
*/
|
10751
|
+
submitBatch(contentLength: number, multipartContentType: string, body: coreRestPipeline.RequestBodyType, options?: ServiceSubmitBatchOptionalParamsModel): Promise<ServiceSubmitBatchResponseInternal>;
|
10752
|
+
/**
|
10753
|
+
* The Filter Blobs operation enables callers to list blobs across all containers whose tags match a
|
10754
|
+
* given search expression. Filter blobs searches across all containers within a storage account but
|
10755
|
+
* can be scoped within the expression to a single container.
|
10756
|
+
* @param options The options parameters.
|
10757
|
+
*/
|
10758
|
+
filterBlobs(options?: ServiceFilterBlobsOptionalParams): Promise<ServiceFilterBlobsResponse>;
|
10759
|
+
}
|
10760
|
+
|
10761
|
+
/**
|
10762
|
+
* A subset of `@azure/core-http` ServiceClientOptions
|
10763
|
+
*/
|
10764
|
+
export declare interface ServiceClientOptions {
|
10765
|
+
/**
|
10766
|
+
* Optional. Configures the HTTP client to send requests and receive responses.
|
10767
|
+
*/
|
10768
|
+
httpClient?: RequestPolicy;
|
10769
|
+
/**
|
10770
|
+
* Optional. Overrides the default policy factories.
|
10771
|
+
*/
|
10772
|
+
requestPolicyFactories?: RequestPolicyFactory[] | ((defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]);
|
10773
|
+
}
|
10774
|
+
|
8917
10775
|
/** Defines headers for Service_filterBlobs operation. */
|
8918
10776
|
export declare interface ServiceFilterBlobsHeaders {
|
8919
10777
|
/** If a client request id header is sent in the request, this header will be present in the response with the same value. */
|
@@ -8928,6 +10786,23 @@ export declare interface ServiceFilterBlobsHeaders {
|
|
8928
10786
|
errorCode?: string;
|
8929
10787
|
}
|
8930
10788
|
|
10789
|
+
/** Optional parameters. */
|
10790
|
+
declare interface ServiceFilterBlobsOptionalParams extends coreClient.OperationOptions {
|
10791
|
+
/** 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> */
|
10792
|
+
timeoutInSeconds?: number;
|
10793
|
+
/** 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. */
|
10794
|
+
requestId?: string;
|
10795
|
+
/** 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. */
|
10796
|
+
marker?: string;
|
10797
|
+
/** 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. */
|
10798
|
+
maxPageSize?: number;
|
10799
|
+
/** Filters the results to return only to return only blobs whose tags match the specified expression. */
|
10800
|
+
where?: string;
|
10801
|
+
}
|
10802
|
+
|
10803
|
+
/** Contains response data for the filterBlobs operation. */
|
10804
|
+
declare type ServiceFilterBlobsResponse = ServiceFilterBlobsHeaders & FilterBlobSegmentModel;
|
10805
|
+
|
8931
10806
|
/**
|
8932
10807
|
* Options to configure the {@link BlobServiceClient.findBlobsByTags} operation.
|
8933
10808
|
*/
|
@@ -8942,25 +10817,7 @@ export declare interface ServiceFindBlobByTagsOptions extends CommonOptions {
|
|
8942
10817
|
/**
|
8943
10818
|
* The response of {@link BlobServiceClient.findBlobsByTags} operation.
|
8944
10819
|
*/
|
8945
|
-
export declare type ServiceFindBlobsByTagsSegmentResponse = FilterBlobSegment & ServiceFilterBlobsHeaders
|
8946
|
-
/**
|
8947
|
-
* The underlying HTTP response.
|
8948
|
-
*/
|
8949
|
-
_response: HttpResponse & {
|
8950
|
-
/**
|
8951
|
-
* The parsed HTTP response headers.
|
8952
|
-
*/
|
8953
|
-
parsedHeaders: ServiceFilterBlobsHeaders;
|
8954
|
-
/**
|
8955
|
-
* The response body as text (string format)
|
8956
|
-
*/
|
8957
|
-
bodyAsText: string;
|
8958
|
-
/**
|
8959
|
-
* The response body as parsed JSON or XML
|
8960
|
-
*/
|
8961
|
-
parsedBody: FilterBlobSegmentModel;
|
8962
|
-
};
|
8963
|
-
};
|
10820
|
+
export declare type ServiceFindBlobsByTagsSegmentResponse = WithResponse<FilterBlobSegment & ServiceFilterBlobsHeaders, ServiceFilterBlobsHeaders, FilterBlobSegmentModel>;
|
8964
10821
|
|
8965
10822
|
/**
|
8966
10823
|
* Options to configure {@link BlobServiceClient.generateAccountSasUrl} operation.
|
@@ -9009,6 +10866,10 @@ export declare interface ServiceGetAccountInfoHeaders {
|
|
9009
10866
|
errorCode?: string;
|
9010
10867
|
}
|
9011
10868
|
|
10869
|
+
/** Optional parameters. */
|
10870
|
+
declare interface ServiceGetAccountInfoOptionalParams extends coreClient.OperationOptions {
|
10871
|
+
}
|
10872
|
+
|
9012
10873
|
/**
|
9013
10874
|
* Options to configure the {@link BlobServiceClient.getAccountInfo} operation.
|
9014
10875
|
*/
|
@@ -9021,13 +10882,10 @@ export declare interface ServiceGetAccountInfoOptions extends CommonOptions {
|
|
9021
10882
|
}
|
9022
10883
|
|
9023
10884
|
/** Contains response data for the getAccountInfo operation. */
|
9024
|
-
export declare type ServiceGetAccountInfoResponse = ServiceGetAccountInfoHeaders
|
9025
|
-
|
9026
|
-
|
9027
|
-
|
9028
|
-
parsedHeaders: ServiceGetAccountInfoHeaders;
|
9029
|
-
};
|
9030
|
-
};
|
10885
|
+
export declare type ServiceGetAccountInfoResponse = WithResponse<ServiceGetAccountInfoHeaders, ServiceGetAccountInfoHeaders>;
|
10886
|
+
|
10887
|
+
/** Contains response data for the getAccountInfo operation. */
|
10888
|
+
declare type ServiceGetAccountInfoResponse_2 = ServiceGetAccountInfoHeaders;
|
9031
10889
|
|
9032
10890
|
/** Defines headers for Service_getProperties operation. */
|
9033
10891
|
export declare interface ServiceGetPropertiesHeaders {
|
@@ -9041,6 +10899,14 @@ export declare interface ServiceGetPropertiesHeaders {
|
|
9041
10899
|
errorCode?: string;
|
9042
10900
|
}
|
9043
10901
|
|
10902
|
+
/** Optional parameters. */
|
10903
|
+
declare interface ServiceGetPropertiesOptionalParams extends coreClient.OperationOptions {
|
10904
|
+
/** 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> */
|
10905
|
+
timeoutInSeconds?: number;
|
10906
|
+
/** 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. */
|
10907
|
+
requestId?: string;
|
10908
|
+
}
|
10909
|
+
|
9044
10910
|
/**
|
9045
10911
|
* Options to configure the {@link BlobServiceClient.getProperties} operation.
|
9046
10912
|
*/
|
@@ -9053,17 +10919,10 @@ export declare interface ServiceGetPropertiesOptions extends CommonOptions {
|
|
9053
10919
|
}
|
9054
10920
|
|
9055
10921
|
/** Contains response data for the getProperties operation. */
|
9056
|
-
export declare type ServiceGetPropertiesResponse = ServiceGetPropertiesHeaders
|
9057
|
-
|
9058
|
-
|
9059
|
-
|
9060
|
-
bodyAsText: string;
|
9061
|
-
/** The response body as parsed JSON or XML */
|
9062
|
-
parsedBody: BlobServiceProperties;
|
9063
|
-
/** The parsed HTTP response headers. */
|
9064
|
-
parsedHeaders: ServiceGetPropertiesHeaders;
|
9065
|
-
};
|
9066
|
-
};
|
10922
|
+
export declare type ServiceGetPropertiesResponse = WithResponse<ServiceGetPropertiesResponseInternal, ServiceGetPropertiesHeaders>;
|
10923
|
+
|
10924
|
+
/** Contains response data for the getProperties operation. */
|
10925
|
+
export declare type ServiceGetPropertiesResponseInternal = ServiceGetPropertiesHeaders & BlobServiceProperties;
|
9067
10926
|
|
9068
10927
|
/** Defines headers for Service_getStatistics operation. */
|
9069
10928
|
export declare interface ServiceGetStatisticsHeaders {
|
@@ -9079,6 +10938,14 @@ export declare interface ServiceGetStatisticsHeaders {
|
|
9079
10938
|
errorCode?: string;
|
9080
10939
|
}
|
9081
10940
|
|
10941
|
+
/** Optional parameters. */
|
10942
|
+
declare interface ServiceGetStatisticsOptionalParams extends coreClient.OperationOptions {
|
10943
|
+
/** 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> */
|
10944
|
+
timeoutInSeconds?: number;
|
10945
|
+
/** 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. */
|
10946
|
+
requestId?: string;
|
10947
|
+
}
|
10948
|
+
|
9082
10949
|
/**
|
9083
10950
|
* Options to configure the {@link BlobServiceClient.getStatistics} operation.
|
9084
10951
|
*/
|
@@ -9091,17 +10958,10 @@ export declare interface ServiceGetStatisticsOptions extends CommonOptions {
|
|
9091
10958
|
}
|
9092
10959
|
|
9093
10960
|
/** Contains response data for the getStatistics operation. */
|
9094
|
-
export declare type ServiceGetStatisticsResponse = ServiceGetStatisticsHeaders
|
9095
|
-
|
9096
|
-
|
9097
|
-
|
9098
|
-
bodyAsText: string;
|
9099
|
-
/** The response body as parsed JSON or XML */
|
9100
|
-
parsedBody: BlobServiceStatistics;
|
9101
|
-
/** The parsed HTTP response headers. */
|
9102
|
-
parsedHeaders: ServiceGetStatisticsHeaders;
|
9103
|
-
};
|
9104
|
-
};
|
10961
|
+
export declare type ServiceGetStatisticsResponse = WithResponse<ServiceGetStatisticsResponseInternal, ServiceGetStatisticsHeaders>;
|
10962
|
+
|
10963
|
+
/** Contains response data for the getStatistics operation. */
|
10964
|
+
export declare type ServiceGetStatisticsResponseInternal = ServiceGetStatisticsHeaders & BlobServiceStatistics;
|
9105
10965
|
|
9106
10966
|
/** Defines headers for Service_getUserDelegationKey operation. */
|
9107
10967
|
export declare interface ServiceGetUserDelegationKeyHeaders {
|
@@ -9117,6 +10977,14 @@ export declare interface ServiceGetUserDelegationKeyHeaders {
|
|
9117
10977
|
errorCode?: string;
|
9118
10978
|
}
|
9119
10979
|
|
10980
|
+
/** Optional parameters. */
|
10981
|
+
declare interface ServiceGetUserDelegationKeyOptionalParams extends coreClient.OperationOptions {
|
10982
|
+
/** 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> */
|
10983
|
+
timeoutInSeconds?: number;
|
10984
|
+
/** 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. */
|
10985
|
+
requestId?: string;
|
10986
|
+
}
|
10987
|
+
|
9120
10988
|
/**
|
9121
10989
|
* Options to configure the Service - Get User Delegation Key.
|
9122
10990
|
*/
|
@@ -9131,25 +10999,10 @@ export declare interface ServiceGetUserDelegationKeyOptions extends CommonOption
|
|
9131
10999
|
/**
|
9132
11000
|
* Contains response data for the {@link getUserDelegationKey} operation.
|
9133
11001
|
*/
|
9134
|
-
export declare type ServiceGetUserDelegationKeyResponse = UserDelegationKey & ServiceGetUserDelegationKeyHeaders
|
9135
|
-
|
9136
|
-
|
9137
|
-
|
9138
|
-
_response: HttpResponse & {
|
9139
|
-
/**
|
9140
|
-
* The parsed HTTP response headers.
|
9141
|
-
*/
|
9142
|
-
parsedHeaders: ServiceGetUserDelegationKeyHeaders;
|
9143
|
-
/**
|
9144
|
-
* The response body as text (string format)
|
9145
|
-
*/
|
9146
|
-
bodyAsText: string;
|
9147
|
-
/**
|
9148
|
-
* The response body as parsed JSON or XML
|
9149
|
-
*/
|
9150
|
-
parsedBody: UserDelegationKeyModel;
|
9151
|
-
};
|
9152
|
-
};
|
11002
|
+
export declare type ServiceGetUserDelegationKeyResponse = WithResponse<UserDelegationKey & ServiceGetUserDelegationKeyHeaders, ServiceGetUserDelegationKeyHeaders, UserDelegationKeyModel>;
|
11003
|
+
|
11004
|
+
/** Contains response data for the getUserDelegationKey operation. */
|
11005
|
+
declare type ServiceGetUserDelegationKeyResponse_2 = ServiceGetUserDelegationKeyHeaders & UserDelegationKeyModel;
|
9153
11006
|
|
9154
11007
|
/**
|
9155
11008
|
* Options to configure the {@link BlobServiceClient.listContainers} operation.
|
@@ -9192,18 +11045,27 @@ export declare interface ServiceListContainersSegmentHeaders {
|
|
9192
11045
|
errorCode?: string;
|
9193
11046
|
}
|
9194
11047
|
|
11048
|
+
/** Optional parameters. */
|
11049
|
+
declare interface ServiceListContainersSegmentOptionalParams extends coreClient.OperationOptions {
|
11050
|
+
/** 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> */
|
11051
|
+
timeoutInSeconds?: number;
|
11052
|
+
/** 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. */
|
11053
|
+
requestId?: string;
|
11054
|
+
/** Filters the results to return only containers whose name begins with the specified prefix. */
|
11055
|
+
prefix?: string;
|
11056
|
+
/** 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. */
|
11057
|
+
marker?: string;
|
11058
|
+
/** 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. */
|
11059
|
+
maxPageSize?: number;
|
11060
|
+
/** Include this parameter to specify that the container's metadata be returned as part of the response body. */
|
11061
|
+
include?: ListContainersIncludeType[];
|
11062
|
+
}
|
11063
|
+
|
9195
11064
|
/** Contains response data for the listContainersSegment operation. */
|
9196
|
-
export declare type ServiceListContainersSegmentResponse = ServiceListContainersSegmentHeaders
|
9197
|
-
|
9198
|
-
|
9199
|
-
|
9200
|
-
bodyAsText: string;
|
9201
|
-
/** The response body as parsed JSON or XML */
|
9202
|
-
parsedBody: ListContainersSegmentResponse;
|
9203
|
-
/** The parsed HTTP response headers. */
|
9204
|
-
parsedHeaders: ServiceListContainersSegmentHeaders;
|
9205
|
-
};
|
9206
|
-
};
|
11065
|
+
export declare type ServiceListContainersSegmentResponse = WithResponse<ServiceListContainersSegmentResponseInternal, ServiceListContainersSegmentHeaders>;
|
11066
|
+
|
11067
|
+
/** Contains response data for the listContainersSegment operation. */
|
11068
|
+
export declare type ServiceListContainersSegmentResponseInternal = ServiceListContainersSegmentHeaders & ListContainersSegmentResponse;
|
9207
11069
|
|
9208
11070
|
/**
|
9209
11071
|
* Options to configure {@link BlobServiceClient.renameContainer} operation.
|
@@ -9232,6 +11094,14 @@ export declare interface ServiceSetPropertiesHeaders {
|
|
9232
11094
|
errorCode?: string;
|
9233
11095
|
}
|
9234
11096
|
|
11097
|
+
/** Optional parameters. */
|
11098
|
+
declare interface ServiceSetPropertiesOptionalParams extends coreClient.OperationOptions {
|
11099
|
+
/** 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> */
|
11100
|
+
timeoutInSeconds?: number;
|
11101
|
+
/** 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. */
|
11102
|
+
requestId?: string;
|
11103
|
+
}
|
11104
|
+
|
9235
11105
|
/**
|
9236
11106
|
* Options to configure the {@link BlobServiceClient.setProperties} operation.
|
9237
11107
|
*/
|
@@ -9244,13 +11114,10 @@ export declare interface ServiceSetPropertiesOptions extends CommonOptions {
|
|
9244
11114
|
}
|
9245
11115
|
|
9246
11116
|
/** Contains response data for the setProperties operation. */
|
9247
|
-
export declare type ServiceSetPropertiesResponse = ServiceSetPropertiesHeaders
|
9248
|
-
|
9249
|
-
|
9250
|
-
|
9251
|
-
parsedHeaders: ServiceSetPropertiesHeaders;
|
9252
|
-
};
|
9253
|
-
};
|
11117
|
+
export declare type ServiceSetPropertiesResponse = WithResponse<ServiceSetPropertiesHeaders, ServiceSetPropertiesHeaders>;
|
11118
|
+
|
11119
|
+
/** Contains response data for the setProperties operation. */
|
11120
|
+
declare type ServiceSetPropertiesResponse_2 = ServiceSetPropertiesHeaders;
|
9254
11121
|
|
9255
11122
|
/** Defines headers for Service_submitBatch operation. */
|
9256
11123
|
export declare interface ServiceSubmitBatchHeaders {
|
@@ -9267,7 +11134,7 @@ export declare interface ServiceSubmitBatchHeaders {
|
|
9267
11134
|
}
|
9268
11135
|
|
9269
11136
|
/** Optional parameters. */
|
9270
|
-
export declare interface ServiceSubmitBatchOptionalParamsModel extends
|
11137
|
+
export declare interface ServiceSubmitBatchOptionalParamsModel extends coreClient.OperationOptions {
|
9271
11138
|
/** 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> */
|
9272
11139
|
timeoutInSeconds?: number;
|
9273
11140
|
/** 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. */
|
@@ -9275,7 +11142,7 @@ export declare interface ServiceSubmitBatchOptionalParamsModel extends coreHttp.
|
|
9275
11142
|
}
|
9276
11143
|
|
9277
11144
|
/** Contains response data for the submitBatch operation. */
|
9278
|
-
export declare type
|
11145
|
+
export declare type ServiceSubmitBatchResponseInternal = ServiceSubmitBatchHeaders & {
|
9279
11146
|
/**
|
9280
11147
|
* BROWSER ONLY
|
9281
11148
|
*
|
@@ -9290,13 +11157,11 @@ export declare type ServiceSubmitBatchResponseModel = ServiceSubmitBatchHeaders
|
|
9290
11157
|
* Always `undefined` in the browser.
|
9291
11158
|
*/
|
9292
11159
|
readableStreamBody?: NodeJS.ReadableStream;
|
9293
|
-
/** The underlying HTTP response. */
|
9294
|
-
_response: coreHttp.HttpResponse & {
|
9295
|
-
/** The parsed HTTP response headers. */
|
9296
|
-
parsedHeaders: ServiceSubmitBatchHeaders;
|
9297
|
-
};
|
9298
11160
|
};
|
9299
11161
|
|
11162
|
+
/** Contains response data for the submitBatch operation. */
|
11163
|
+
export declare type ServiceSubmitBatchResponseModel = WithResponse<ServiceSubmitBatchResponseInternal, ServiceSubmitBatchHeaders>;
|
11164
|
+
|
9300
11165
|
/**
|
9301
11166
|
* Options to configure {@link BlobServiceClient.undeleteContainer} operation.
|
9302
11167
|
*/
|
@@ -9353,6 +11218,20 @@ export declare interface SignedIdentifierModel {
|
|
9353
11218
|
/** Defines values for SkuName. */
|
9354
11219
|
export declare type SkuName = "Standard_LRS" | "Standard_GRS" | "Standard_RAGRS" | "Standard_ZRS" | "Premium_LRS";
|
9355
11220
|
|
11221
|
+
/** Parameter group */
|
11222
|
+
declare interface SourceModifiedAccessConditions {
|
11223
|
+
/** Specify this header value to operate only on a blob if it has been modified since the specified date/time. */
|
11224
|
+
sourceIfModifiedSince?: Date;
|
11225
|
+
/** Specify this header value to operate only on a blob if it has not been modified since the specified date/time. */
|
11226
|
+
sourceIfUnmodifiedSince?: Date;
|
11227
|
+
/** Specify an ETag value to operate only on blobs with a matching value. */
|
11228
|
+
sourceIfMatch?: string;
|
11229
|
+
/** Specify an ETag value to operate only on blobs without a matching value. */
|
11230
|
+
sourceIfNoneMatch?: string;
|
11231
|
+
/** Specify a SQL where clause on blob tags to operate only on blobs with a matching value. */
|
11232
|
+
sourceIfTags?: string;
|
11233
|
+
}
|
11234
|
+
|
9356
11235
|
/** The properties that enable an account to host a static website */
|
9357
11236
|
export declare interface StaticWebsite {
|
9358
11237
|
/** Indicates whether this account is hosting a static website */
|
@@ -9437,7 +11316,7 @@ declare abstract class StorageClient {
|
|
9437
11316
|
* StorageClient is a reference to protocol layer operations entry, which is
|
9438
11317
|
* generated by AutoRest generator.
|
9439
11318
|
*/
|
9440
|
-
protected readonly storageClientContext:
|
11319
|
+
protected readonly storageClientContext: StorageClient_2;
|
9441
11320
|
/**
|
9442
11321
|
*/
|
9443
11322
|
protected readonly isHttps: boolean;
|
@@ -9449,20 +11328,26 @@ declare abstract class StorageClient {
|
|
9449
11328
|
protected constructor(url: string, pipeline: PipelineLike);
|
9450
11329
|
}
|
9451
11330
|
|
9452
|
-
declare class
|
11331
|
+
declare class StorageClient_2 extends coreHttpCompat.ExtendedServiceClient {
|
9453
11332
|
url: string;
|
9454
11333
|
version: string;
|
9455
11334
|
/**
|
9456
|
-
* Initializes a new instance of the
|
11335
|
+
* Initializes a new instance of the StorageClient class.
|
9457
11336
|
* @param url The URL of the service account, container, or blob that is the target of the desired
|
9458
11337
|
* operation.
|
9459
11338
|
* @param options The parameter options
|
9460
11339
|
*/
|
9461
11340
|
constructor(url: string, options?: StorageClientOptionalParams);
|
11341
|
+
service: Service;
|
11342
|
+
container: Container;
|
11343
|
+
blob: Blob_2;
|
11344
|
+
pageBlob: PageBlob;
|
11345
|
+
appendBlob: AppendBlob;
|
11346
|
+
blockBlob: BlockBlob;
|
9462
11347
|
}
|
9463
11348
|
|
9464
11349
|
/** Optional parameters. */
|
9465
|
-
declare interface StorageClientOptionalParams extends
|
11350
|
+
declare interface StorageClientOptionalParams extends coreHttpCompat.ExtendedServiceClientOptions {
|
9466
11351
|
/** Specifies the version of the operation to use for this request. */
|
9467
11352
|
version?: string;
|
9468
11353
|
/** Overrides client endpoint. */
|
@@ -9481,11 +11366,11 @@ export declare interface StoragePipelineOptions {
|
|
9481
11366
|
/**
|
9482
11367
|
* Options to configure a proxy for outgoing requests.
|
9483
11368
|
*/
|
9484
|
-
proxyOptions?:
|
11369
|
+
proxyOptions?: ProxySettings;
|
9485
11370
|
/**
|
9486
11371
|
* Options for adding user agent details to outgoing requests.
|
9487
11372
|
*/
|
9488
|
-
userAgentOptions?:
|
11373
|
+
userAgentOptions?: UserAgentPolicyOptions;
|
9489
11374
|
/**
|
9490
11375
|
* Configures the built-in retry policy behavior.
|
9491
11376
|
*/
|
@@ -9497,7 +11382,7 @@ export declare interface StoragePipelineOptions {
|
|
9497
11382
|
/**
|
9498
11383
|
* Configures the HTTP client to send requests and receive responses.
|
9499
11384
|
*/
|
9500
|
-
httpClient?:
|
11385
|
+
httpClient?: RequestPolicy;
|
9501
11386
|
/**
|
9502
11387
|
* The audience used to retrieve an AAD token.
|
9503
11388
|
*/
|
@@ -9719,9 +11604,6 @@ export declare class StorageSharedKeyCredentialPolicy extends CredentialPolicy {
|
|
9719
11604
|
private getCanonicalizedResourceString;
|
9720
11605
|
}
|
9721
11606
|
|
9722
|
-
/** Defines values for SyncCopyStatusType. */
|
9723
|
-
export declare type SyncCopyStatusType = "success";
|
9724
|
-
|
9725
11607
|
/**
|
9726
11608
|
* Specifies HTTP options for conditional requests based on blob tags.
|
9727
11609
|
*/
|
@@ -9791,4 +11673,9 @@ export declare interface UserDelegationKeyModel {
|
|
9791
11673
|
|
9792
11674
|
export { WebResource }
|
9793
11675
|
|
11676
|
+
/**
|
11677
|
+
* A type that represents an operation result with a known _response property.
|
11678
|
+
*/
|
11679
|
+
export declare type WithResponse<T, Headers = undefined, Body = undefined> = T & (Body extends object ? ResponseWithBody<Headers, Body> : Headers extends object ? ResponseWithHeaders<Headers> : ResponseLike);
|
11680
|
+
|
9794
11681
|
export { }
|