azure-storage-blobs
blob_options.hpp
1 // Copyright (c) Microsoft Corporation. All rights reserved.
2 // SPDX-License-Identifier: MIT
3 
4 #pragma once
5 
6 #include <chrono>
7 #include <cstdint>
8 #include <memory>
9 #include <string>
10 #include <vector>
11 
12 #include <azure/core/internal/client_options.hpp>
13 #include <azure/core/match_conditions.hpp>
14 #include <azure/core/modified_conditions.hpp>
15 #include <azure/storage/common/access_conditions.hpp>
16 
17 #include "azure/storage/blobs/protocol/blob_rest_client.hpp"
18 
19 namespace Azure { namespace Storage { namespace Blobs {
20 
24  struct BlobContainerAccessConditions final : public Azure::ModifiedConditions,
25  public LeaseAccessConditions
26  {
27  };
28 
33  {
38  virtual ~TagAccessConditions() = default;
39 
45  Azure::Nullable<std::string> TagConditions;
46  };
47 
51  struct BlobAccessConditions : public Azure::ModifiedConditions,
52  public Azure::MatchConditions,
53  public LeaseAccessConditions,
54  public TagAccessConditions
55  {
56  };
57 
61  struct LeaseBlobAccessConditions final : public Azure::ModifiedConditions,
62  public Azure::MatchConditions,
63  public TagAccessConditions
64  {
65  };
66 
71  {
76  Azure::Nullable<int64_t> IfMaxSizeLessThanOrEqual;
77 
82  Azure::Nullable<int64_t> IfAppendPositionEqual;
83  };
84 
89  {
94  Azure::Nullable<int64_t> IfSequenceNumberLessThan;
95 
100  Azure::Nullable<int64_t> IfSequenceNumberLessThanOrEqual;
101 
106  Azure::Nullable<int64_t> IfSequenceNumberEqual;
107  };
108 
113  struct EncryptionKey final
114  {
118  std::string Key;
119 
123  std::vector<uint8_t> KeyHash;
124 
129  };
130 
134  struct BlobClientOptions final : Azure::Core::_internal::ClientOptions
135  {
139  Azure::Nullable<EncryptionKey> CustomerProvidedKey;
140 
144  Azure::Nullable<std::string> EncryptionScope;
145 
154 
158  std::string ApiVersion = _detail::ApiVersion;
159  };
160 
165  {
170  Azure::Nullable<std::string> Prefix;
171 
180  Azure::Nullable<std::string> ContinuationToken;
181 
185  Azure::Nullable<int32_t> PageSizeHint;
186 
190  Models::ListBlobContainersIncludeFlags Include = Models::ListBlobContainersIncludeFlags::None;
191  };
192 
197  {
202  Azure::DateTime StartsOn = std::chrono::system_clock::now();
203  };
204 
209  {
210  };
211 
216  {
217  };
218 
223  {
224  };
225 
230  {
231  };
232 
237  {
244  Azure::Nullable<std::string> ContinuationToken;
245 
249  Azure::Nullable<int32_t> PageSizeHint;
250  };
251 
256  {
262 
266  Storage::Metadata Metadata;
267 
271  Azure::Nullable<std::string> DefaultEncryptionScope;
272 
277  Azure::Nullable<bool> PreventEncryptionScopeOverride;
278  };
279 
284  {
289  };
290 
295  {
296  };
297 
302  {
306  LeaseAccessConditions AccessConditions;
307  };
308 
313  {
317  struct : public LeaseAccessConditions
318  {
323  Azure::Nullable<Azure::DateTime> IfModifiedSince;
324  } AccessConditions;
325  };
326 
331  struct ListBlobsOptions final
332  {
337  Azure::Nullable<std::string> Prefix;
338 
347  Azure::Nullable<std::string> ContinuationToken;
348 
352  Azure::Nullable<int32_t> PageSizeHint;
353 
357  Models::ListBlobsIncludeFlags Include = Models::ListBlobsIncludeFlags::None;
358  };
359 
364  {
368  LeaseAccessConditions AccessConditions;
369  };
370 
375  {
381 
386  std::vector<Models::SignedIdentifier> SignedIdentifiers;
387 
392  };
393 
398  {
403  };
404 
409  {
414  };
415 
420  {
425  };
426 
431  {
437  Azure::Nullable<Models::RehydratePriority> RehydratePriority;
438  };
439 
444  {
452  Storage::Metadata Metadata;
453 
458 
463 
467  Azure::Nullable<Models::AccessTier> AccessTier;
468 
474  Azure::Nullable<Models::RehydratePriority> RehydratePriority;
475 
479  Azure::Nullable<bool> ShouldSealDestination;
480  };
481 
486  {
490  LeaseAccessConditions AccessConditions;
491  };
492 
496  struct DownloadBlobOptions final
497  {
501  Azure::Nullable<Core::Http::HttpRange> Range;
502 
507  Azure::Nullable<HashAlgorithm> RangeHashAlgorithm;
508 
513  };
514 
519  {
523  Azure::Nullable<Core::Http::HttpRange> Range;
524 
528  struct
529  {
535  int64_t InitialChunkSize = 256 * 1024 * 1024;
536 
540  int64_t ChunkSize = 4 * 1024 * 1024;
541 
545  int32_t Concurrency = 5;
547  };
548 
553  {
560  Storage::Metadata Metadata;
561 
566  };
567 
571  struct DeleteBlobOptions final
572  {
578  Azure::Nullable<Models::DeleteSnapshotsOption> DeleteSnapshots;
579 
584  };
585 
589  struct UndeleteBlobOptions final
590  {
591  };
592 
596  struct AcquireLeaseOptions final
597  {
602  };
603 
607  struct RenewLeaseOptions final
608  {
613  };
614 
618  struct ChangeLeaseOptions final
619  {
624  };
625 
629  struct ReleaseLeaseOptions final
630  {
635  };
636 
640  struct BreakLeaseOptions final
641  {
649  Azure::Nullable<std::chrono::seconds> BreakPeriod;
650 
655  };
656 
660  struct SetBlobTagsOptions final
661  {
666  };
667 
671  struct GetBlobTagsOptions final
672  {
677  };
678 
683  {
689  Azure::Nullable<ContentHash> TransactionalContentHash;
690 
695 
699  Storage::Metadata Metadata;
700 
704  Azure::Nullable<Models::AccessTier> AccessTier;
705 
710  };
711 
716  {
721 
725  Storage::Metadata Metadata;
726 
730  Azure::Nullable<Models::AccessTier> AccessTier;
731 
735  struct
736  {
741  int64_t SingleUploadThreshold = 256 * 1024 * 1024;
742 
747  Azure::Nullable<int64_t> ChunkSize;
748 
752  int32_t Concurrency = 5;
754  };
755 
759  struct StageBlockOptions final
760  {
766  Azure::Nullable<ContentHash> TransactionalContentHash;
767 
771  LeaseAccessConditions AccessConditions;
772  };
773 
778  {
782  Azure::Nullable<Core::Http::HttpRange> SourceRange;
783 
789  Azure::Nullable<ContentHash> TransactionalContentHash;
790 
794  LeaseAccessConditions AccessConditions;
795 
799  struct : public Azure::ModifiedConditions, public Azure::MatchConditions
800  {
801  } SourceAccessConditions;
802  };
803 
808  {
813 
817  Storage::Metadata Metadata;
818 
822  Azure::Nullable<Models::AccessTier> AccessTier;
823 
828  };
829 
833  struct GetBlockListOptions final
834  {
840 
844  struct : public LeaseAccessConditions, public TagAccessConditions
845  {
846  } AccessConditions;
847  };
848 
853  {
858 
862  Storage::Metadata Metadata;
863 
868  };
869 
873  struct AppendBlockOptions final
874  {
880  Azure::Nullable<ContentHash> TransactionalContentHash;
881 
886  };
887 
892  {
896  Azure::Nullable<Core::Http::HttpRange> SourceRange;
897 
903  Azure::Nullable<ContentHash> TransactionalContentHash;
904 
909  };
910 
915  {
920  };
921 
926  {
931  Azure::Nullable<int64_t> SequenceNumber;
932 
937 
941  Storage::Metadata Metadata;
942 
946  Azure::Nullable<Models::AccessTier> AccessTier;
947 
952  };
953 
957  struct UploadPagesOptions final
958  {
964  Azure::Nullable<ContentHash> TransactionalContentHash;
965 
970  };
971 
976  {
982  Azure::Nullable<ContentHash> TransactionalContentHash;
983 
988  };
989 
993  struct ClearPagesOptions final
994  {
999  };
1000 
1005  {
1010  };
1011 
1016  {
1021  Azure::Nullable<Core::Http::HttpRange> Range;
1022 
1027  };
1028 
1033  {
1038  };
1039 
1040 }}} // namespace Azure::Storage::Blobs
Azure::Storage::Blobs::ListBlobsOptions::Include
Models::ListBlobsIncludeFlags Include
Specifies one or more datasets to include in the response.
Definition: blob_options.hpp:357
Azure::Storage::Blobs::ChangeLeaseOptions
Optional parameters for Azure::Storage::Blobs::BlobLeaseClient::Change.
Definition: blob_options.hpp:619
Azure::Storage::Blobs::BlobClientOptions::EncryptionScope
Azure::Nullable< std::string > EncryptionScope
Holds the encryption scope used when making requests.
Definition: blob_options.hpp:144
Azure::Storage::Blobs::UploadBlockBlobFromOptions::Metadata
Storage::Metadata Metadata
Name-value pairs associated with the blob as metadata.
Definition: blob_options.hpp:725
Azure::Storage::Blobs::SealAppendBlobOptions::AccessConditions
AppendBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:919
Azure::Storage::Blobs::GetBlockListOptions
Optional parameters for Azure::Storage::Blobs::BlockBlobClient::GetBlockList.
Definition: blob_options.hpp:834
Azure::Storage::Blobs::StartBlobCopyIncrementalOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:1037
Azure::Storage::Blobs::DownloadBlobToOptions::Range
Azure::Nullable< Core::Http::HttpRange > Range
Downloads only the bytes of the blob in the specified range.
Definition: blob_options.hpp:523
Azure::Storage::Blobs::DownloadBlobOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:512
Azure::Storage::Blobs::PageBlobAccessConditions::IfSequenceNumberEqual
Azure::Nullable< int64_t > IfSequenceNumberEqual
IfSequenceNumberEqual ensures that the page blob operation succeeds only if the blob's sequence numbe...
Definition: blob_options.hpp:106
Azure::Storage::Blobs::SetBlobContainerAccessPolicyOptions
Optional parameters for Azure::Storage::Blobs::BlobContainerClient::SetAccessPolicy.
Definition: blob_options.hpp:375
Azure::Storage::Blobs::EncryptionKey::Key
std::string Key
Base64 encoded string of the AES256 encryption key.
Definition: blob_options.hpp:118
Azure::Storage::Blobs::AcquireLeaseOptions
Optional parameters for Azure::Storage::Blobs::BlobLeaseClient::Acquire.
Definition: blob_options.hpp:597
Azure::Storage::Blobs::AppendBlockFromUriOptions::SourceRange
Azure::Nullable< Core::Http::HttpRange > SourceRange
Uploads only the bytes of the source blob in the specified range.
Definition: blob_options.hpp:896
Azure::Storage::Blobs::GetPageRangesOptions
Optional parameters for Azure::Storage::Blobs::PageBlobClient::GetPageRanges.
Definition: blob_options.hpp:1016
Azure::Storage::Blobs::DownloadBlobOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::Download.
Definition: blob_options.hpp:497
Azure::Storage::Blobs::Models::BlockListType
Extensible enum used to specify blocks to list.
Definition: blob_rest_client.hpp:1463
Azure::Storage::Blobs::ClearPagesOptions
Optional parameters for Azure::Storage::Blobs::PageBlobClient::ClearPages.
Definition: blob_options.hpp:994
Azure::Storage::Blobs::CreatePageBlobOptions::SequenceNumber
Azure::Nullable< int64_t > SequenceNumber
The sequence number is a user-controlled value that you can use to track requests....
Definition: blob_options.hpp:931
Azure::Storage::Blobs::AppendBlockOptions
Optional parameters for Azure::Storage::Blobs::AppendBlobClient::AppendBlock.
Definition: blob_options.hpp:874
Azure::Storage::Blobs::GetBlobContainerPropertiesOptions::AccessConditions
LeaseAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:306
Azure::Storage::Blobs::DeleteBlobOptions::DeleteSnapshots
Azure::Nullable< Models::DeleteSnapshotsOption > DeleteSnapshots
Specifies to delete either the base blob and all of its snapshots, or only the blob's snapshots and n...
Definition: blob_options.hpp:578
Azure::Storage::Blobs::CreateBlobContainerOptions::AccessType
Models::PublicAccessType AccessType
Specifies whether data in the container may be accessed publicly and the level of access.
Definition: blob_options.hpp:261
Azure::Storage::Blobs::SetBlobContainerAccessPolicyOptions::AccessConditions
BlobContainerAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:391
Azure::Storage::Blobs::BlobClientOptions::SecondaryHostForRetryReads
std::string SecondaryHostForRetryReads
Definition: blob_options.hpp:153
Azure::Storage::Blobs::BreakLeaseOptions::BreakPeriod
Azure::Nullable< std::chrono::seconds > BreakPeriod
Proposed duration the lease should continue before it is broken, in seconds, between 0 and 60....
Definition: blob_options.hpp:649
Azure::Storage::Blobs::CreatePageBlobOptions::AccessTier
Azure::Nullable< Models::AccessTier > AccessTier
Indicates the tier to be set on blob.
Definition: blob_options.hpp:946
Azure::Storage::Blobs::SetBlobContainerAccessPolicyOptions::AccessType
Models::PublicAccessType AccessType
Specifies whether data in the container may be accessed publicly and the level of access.
Definition: blob_options.hpp:380
Azure::Storage::Blobs::UploadBlockBlobOptions::HttpHeaders
Models::BlobHttpHeaders HttpHeaders
The standard HTTP header system properties to set.
Definition: blob_options.hpp:694
Azure::Storage::Blobs::SetBlobContainerMetadataOptions
Optional parameters for Azure::Storage::Blobs::BlobContainerClient::SetMetadata.
Definition: blob_options.hpp:313
Azure::Storage::Blobs::Models::BlockListType::Committed
AZ_STORAGE_BLOBS_DLLEXPORT static const BlockListType Committed
Definition: blob_rest_client.hpp:1473
Azure::Storage::Blobs::StartBlobCopyFromUriOptions::RehydratePriority
Azure::Nullable< Models::RehydratePriority > RehydratePriority
Indicates the priority with which to rehydrate an archived blob. The priority can be set on a blob on...
Definition: blob_options.hpp:474
Azure::Storage::Blobs::UploadBlockBlobOptions
Optional parameters for Azure::Storage::Blobs::BlockBlobClient::Upload.
Definition: blob_options.hpp:683
Azure::Storage::Blobs::GetUserDelegationKeyOptions
Optional parameters for Azure::Storage::Blobs::BlobServiceClient::GetUserDelegationKey.
Definition: blob_options.hpp:197
Azure::Storage::Blobs::AppendBlobAccessConditions::IfAppendPositionEqual
Azure::Nullable< int64_t > IfAppendPositionEqual
Ensures that the AppendBlock operation succeeds only if the append position is equal to this value.
Definition: blob_options.hpp:82
Azure::Storage::Blobs::GetAccountInfoOptions
Optional parameters for Azure::Storage::Blobs::BlobServiceClient::GetAccountInfo.
Definition: blob_options.hpp:223
Azure::Storage::Blobs::UploadPagesOptions
Optional parameters for Azure::Storage::Blobs::PageBlobClient::UploadPages.
Definition: blob_options.hpp:958
Azure::Storage::Blobs::CreatePageBlobOptions
Optional parameters for Azure::Storage::Blobs::PageBlobClient::Create.
Definition: blob_options.hpp:926
Azure::Storage::Blobs::PageBlobAccessConditions::IfSequenceNumberLessThan
Azure::Nullable< int64_t > IfSequenceNumberLessThan
IfSequenceNumberLessThan ensures that the page blob operation succeeds only if the blob's sequence nu...
Definition: blob_options.hpp:94
Azure::Storage::Blobs::AppendBlockFromUriOptions::AccessConditions
AppendBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:908
Azure::Storage::Blobs::UploadPagesFromUriOptions
Optional parameters for Azure::Storage::Blobs::PageBlobClient::UploadPagesFromUri.
Definition: blob_options.hpp:976
Azure::Storage::Blobs::SetBlobHttpHeadersOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::SetHttpHeaders.
Definition: blob_options.hpp:409
Azure::Storage::Blobs::PageBlobAccessConditions::IfSequenceNumberLessThanOrEqual
Azure::Nullable< int64_t > IfSequenceNumberLessThanOrEqual
IfSequenceNumberLessThanOrEqual ensures that the page blob operation succeeds only if the blob's sequ...
Definition: blob_options.hpp:100
Azure::Storage::Blobs::StartBlobCopyIncrementalOptions
Optional parameters for Azure::Storage::Blobs::PageBlobClient::StartCopyIncremental.
Definition: blob_options.hpp:1033
Azure::Storage::Blobs::CommitBlockListOptions::AccessTier
Azure::Nullable< Models::AccessTier > AccessTier
Indicates the tier to be set on blob.
Definition: blob_options.hpp:822
Azure::Storage::Blobs::CreateBlobSnapshotOptions::Metadata
Storage::Metadata Metadata
Specifies user-defined name-value pairs associated with the blob. If no name-value pairs are specifie...
Definition: blob_options.hpp:560
Azure::Storage::Blobs::StartBlobCopyFromUriOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:457
Azure::Storage::Blobs::DownloadBlobOptions::Range
Azure::Nullable< Core::Http::HttpRange > Range
Downloads only the bytes of the blob in the specified range.
Definition: blob_options.hpp:501
Azure::Storage::Blobs::UploadPagesFromUriOptions::AccessConditions
PageBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:987
Azure::Storage::Blobs::EncryptionKey
Wrapper for an encryption key to be used with client provided key server-side encryption.
Definition: blob_options.hpp:114
Azure::Storage::Blobs::UploadBlockBlobFromOptions
Optional parameters for Azure::Storage::Blobs::BlockBlobClient::UploadFrom.
Definition: blob_options.hpp:716
Azure::Storage::Blobs::CreatePageBlobOptions::Metadata
Storage::Metadata Metadata
Name-value pairs associated with the blob as metadata.
Definition: blob_options.hpp:941
Azure::Storage::Blobs::CreateBlobSnapshotOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:565
Azure::Storage::Blobs::ChangeLeaseOptions::AccessConditions
LeaseBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:623
Azure::Storage::Blobs::ListBlobsOptions
Optional parameters for Azure::Storage::Blobs::BlobContainerClient::ListBlobs and Azure::Storage::Blo...
Definition: blob_options.hpp:332
Azure::Storage::Blobs::EncryptionKey::KeyHash
std::vector< uint8_t > KeyHash
SHA256 hash of the AES256 encryption key.
Definition: blob_options.hpp:123
Azure::Storage::Blobs::SetBlobContainerMetadataOptions::IfModifiedSince
Azure::Nullable< Azure::DateTime > IfModifiedSince
Specify this header to perform the operation only if the resource has been modified since the specifi...
Definition: blob_options.hpp:323
Azure::Storage::Blobs::ListBlobContainersOptions
Optional parameters for Azure::Storage::Blobs::BlobServiceClient::ListBlobContainers.
Definition: blob_options.hpp:165
Azure::Storage::Blobs::CreateBlobContainerOptions::Metadata
Storage::Metadata Metadata
Name-value pairs to associate with the container as metadata.
Definition: blob_options.hpp:266
Azure::Storage::Blobs::AppendBlockFromUriOptions
Optional parameters for Azure::Storage::Blobs::AppendBlobClient::AppendBlockFromUri.
Definition: blob_options.hpp:892
Azure::Storage::Blobs::ListBlobContainersOptions::ContinuationToken
Azure::Nullable< std::string > ContinuationToken
A string value that identifies the portion of the list of containers to be returned with the next lis...
Definition: blob_options.hpp:180
Azure::Storage::Blobs::CreateAppendBlobOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:867
Azure::Storage::Blobs::StageBlockOptions::TransactionalContentHash
Azure::Nullable< ContentHash > TransactionalContentHash
Hash of the blob content. This hash is used to verify the integrity of the blob during transport....
Definition: blob_options.hpp:766
Azure::Storage::Blobs::ReleaseLeaseOptions::AccessConditions
LeaseBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:634
Azure::Storage::Blobs::BlobContainerAccessConditions
Specifies access conditions for a container.
Definition: blob_options.hpp:26
Azure::Storage::Blobs::AppendBlockOptions::AccessConditions
AppendBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:885
Azure::Storage::Blobs::CreateAppendBlobOptions::Metadata
Storage::Metadata Metadata
Name-value pairs associated with the blob as metadata.
Definition: blob_options.hpp:862
Azure::Storage::Blobs::BlobClientOptions::ApiVersion
std::string ApiVersion
Definition: blob_options.hpp:158
Azure::Storage::Blobs::SetBlobContainerAccessPolicyOptions::SignedIdentifiers
std::vector< Models::SignedIdentifier > SignedIdentifiers
Stored access policies that you can use to provide fine grained control over container permissions.
Definition: blob_options.hpp:386
Azure::Storage::Blobs::DownloadBlobToOptions::TransferOptions
struct Azure::Storage::Blobs::DownloadBlobToOptions::@0 TransferOptions
Options for parallel transfer.
Azure::Storage::Blobs::BlobClientOptions::CustomerProvidedKey
Azure::Nullable< EncryptionKey > CustomerProvidedKey
Holds the customer provided key used when making requests.
Definition: blob_options.hpp:139
Azure::Storage::Blobs::FindBlobsByTagsOptions::PageSizeHint
Azure::Nullable< int32_t > PageSizeHint
Specifies the maximum number of blobs to return.
Definition: blob_options.hpp:249
Azure::Storage::Blobs::BlobAccessConditions
Specifies access conditions for a blob.
Definition: blob_options.hpp:55
Azure::Storage::Blobs::SetServicePropertiesOptions
Optional parameters for Azure::Storage::Blobs::BlobServiceClient::SetProperties.
Definition: blob_options.hpp:209
Azure::Storage::Blobs::RenewLeaseOptions::AccessConditions
LeaseBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:612
Azure::Storage::Blobs::PageBlobAccessConditions
Specifies access conditions for a page blob.
Definition: blob_options.hpp:89
Azure::Storage::Blobs::StartBlobCopyFromUriOptions::SourceAccessConditions
BlobAccessConditions SourceAccessConditions
Optional conditions that the source must meet to perform this operation.
Definition: blob_options.hpp:462
Azure::Storage::Blobs::AppendBlockFromUriOptions::TransactionalContentHash
Azure::Nullable< ContentHash > TransactionalContentHash
Hash of the blob content. This hash is used to verify the integrity of the blob during transport....
Definition: blob_options.hpp:903
Azure::Storage::Blobs::SetBlobTagsOptions::AccessConditions
TagAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:665
Azure::Storage::Blobs::ResizePageBlobOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:1009
Azure::Storage::Blobs::BlobClientOptions
Client options used to initialize all kinds of blob clients.
Definition: blob_options.hpp:135
Azure::Storage::Blobs::CommitBlockListOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:827
Azure::Storage::Blobs::UploadBlockBlobFromOptions::Concurrency
int32_t Concurrency
The maximum number of threads that may be used in a parallel transfer.
Definition: blob_options.hpp:752
Azure::Storage::Blobs::ListBlobsOptions::PageSizeHint
Azure::Nullable< int32_t > PageSizeHint
Specifies the maximum number of blobs to return.
Definition: blob_options.hpp:352
Azure::Storage::Blobs::SetBlobHttpHeadersOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:413
Azure::Storage::Blobs::StageBlockFromUriOptions::TransactionalContentHash
Azure::Nullable< ContentHash > TransactionalContentHash
Hash of the blob content. This hash is used to verify the integrity of the blob during transport....
Definition: blob_options.hpp:789
Azure::Storage::Blobs::TagAccessConditions::TagConditions
Azure::Nullable< std::string > TagConditions
Optional SQL statement to apply to the tags of the Blob. Refer to https://docs.microsoft....
Definition: blob_options.hpp:45
Azure::Storage::Blobs::UploadBlockBlobFromOptions::ChunkSize
Azure::Nullable< int64_t > ChunkSize
The maximum number of bytes in a single request. This value cannot be larger than 4000 MiB.
Definition: blob_options.hpp:747
Azure::Storage::Blobs::UploadBlockBlobOptions::TransactionalContentHash
Azure::Nullable< ContentHash > TransactionalContentHash
Hash of the blob content. This hash is used to verify the integrity of the blob during transport....
Definition: blob_options.hpp:689
Azure::Storage::Blobs::CreateBlobContainerOptions::PreventEncryptionScopeOverride
Azure::Nullable< bool > PreventEncryptionScopeOverride
If true, prevents any blob upload from specifying a different encryption scope.
Definition: blob_options.hpp:277
Azure::Storage::Blobs::GetPageRangesOptions::Range
Azure::Nullable< Core::Http::HttpRange > Range
Optionally specifies the range of bytes over which to list ranges, inclusively. If omitted,...
Definition: blob_options.hpp:1021
Azure::Storage::Blobs::CreateAppendBlobOptions
Optional parameters for Azure::Storage::Blobs::AppendBlobClient::Create.
Definition: blob_options.hpp:853
Azure::Storage::Blobs::CreatePageBlobOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:951
Azure::Storage::Blobs::DownloadBlobToOptions::ChunkSize
int64_t ChunkSize
The maximum number of bytes in a single request.
Definition: blob_options.hpp:540
Azure::Storage::Blobs::DeleteBlobContainerOptions
Optional parameters for Azure::Storage::Blobs::BlobContainerClient::Delete.
Definition: blob_options.hpp:284
Azure::Storage::Blobs::GetBlobTagsOptions::AccessConditions
TagAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:676
Azure::Storage::Blobs::SetBlobMetadataOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::SetMetadata.
Definition: blob_options.hpp:420
Azure::Storage::Blobs::UploadBlockBlobFromOptions::AccessTier
Azure::Nullable< Models::AccessTier > AccessTier
Indicates the tier to be set on blob.
Definition: blob_options.hpp:730
Azure::Storage::Blobs::CommitBlockListOptions::Metadata
Storage::Metadata Metadata
Name-value pairs associated with the blob as metadata.
Definition: blob_options.hpp:817
Azure::Storage::Blobs::ListBlobContainersOptions::PageSizeHint
Azure::Nullable< int32_t > PageSizeHint
Specifies the maximum number of containers to return.
Definition: blob_options.hpp:185
Azure::Storage::Blobs::StartBlobCopyFromUriOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::StartCopyFromUri.
Definition: blob_options.hpp:444
Azure::Storage::Blobs::AppendBlobAccessConditions::IfMaxSizeLessThanOrEqual
Azure::Nullable< int64_t > IfMaxSizeLessThanOrEqual
Ensures that the AppendBlock operation succeeds only if the append blob's size is less than or equal ...
Definition: blob_options.hpp:76
Azure::Storage::Blobs::UploadPagesOptions::TransactionalContentHash
Azure::Nullable< ContentHash > TransactionalContentHash
Hash of the blob content. This hash is used to verify the integrity of the blob during transport....
Definition: blob_options.hpp:964
Azure::Storage::Blobs::SetBlobTagsOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::SetTags.
Definition: blob_options.hpp:661
Azure::Storage::Blobs::CommitBlockListOptions
Optional parameters for Azure::Storage::Blobs::BlockBlobClient::CommitBlockList.
Definition: blob_options.hpp:808
Azure::Storage::Blobs::GetBlobContainerAccessPolicyOptions
Optional parameters for Azure::Storage::Blobs::BlobContainerClient::GetAccessPolicy.
Definition: blob_options.hpp:364
Azure::Storage::Blobs::FindBlobsByTagsOptions
Optional parameters for Azure::Storage::Blobs::BlobServiceClient::FindBlobsByTags.
Definition: blob_options.hpp:237
Azure::Storage::Blobs::Models::EncryptionAlgorithmType
Extensible enum used to identify encryption algorithm.
Definition: blob_rest_client.hpp:1800
Azure::Storage::Blobs::GetBlobServiceStatisticsOptions
Optional parameters for Azure::Storage::Blobs::BlobServiceClient::GetStatistics.
Definition: blob_options.hpp:230
Azure::Storage::Blobs::CreateBlobContainerOptions::DefaultEncryptionScope
Azure::Nullable< std::string > DefaultEncryptionScope
The encryption scope to use as the default on the container.
Definition: blob_options.hpp:271
Azure::Storage::Blobs::ListBlobsOptions::ContinuationToken
Azure::Nullable< std::string > ContinuationToken
A string value that identifies the portion of the list of blobs to be returned with the next listing ...
Definition: blob_options.hpp:347
Azure::Storage::Blobs::GetBlobContainerAccessPolicyOptions::AccessConditions
LeaseAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:368
Azure::Storage::Blobs::AbortBlobCopyFromUriOptions::AccessConditions
LeaseAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:490
Azure::Storage::Blobs::UploadBlockBlobOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:709
Azure::Storage::Blobs::CreateAppendBlobOptions::HttpHeaders
Models::BlobHttpHeaders HttpHeaders
The standard HTTP header system properties to set.
Definition: blob_options.hpp:857
Azure::Storage::Blobs::StartBlobCopyFromUriOptions::ShouldSealDestination
Azure::Nullable< bool > ShouldSealDestination
If the destination blob should be sealed. Only applicable for Append Blobs.
Definition: blob_options.hpp:479
Azure::Storage::Blobs::DeleteBlobContainerOptions::AccessConditions
BlobContainerAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:288
Azure::Storage::Blobs::DeleteBlobOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:583
Azure::Storage::Blobs::GetUserDelegationKeyOptions::StartsOn
Azure::DateTime StartsOn
Start time for the key's validity. The time should be specified in UTC, and will be truncated to seco...
Definition: blob_options.hpp:202
Azure::Storage::Blobs::UploadBlockBlobFromOptions::TransferOptions
struct Azure::Storage::Blobs::UploadBlockBlobFromOptions::@1 TransferOptions
Options for parallel transfer.
Azure::Storage::Blobs::DeleteBlobOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::Delete.
Definition: blob_options.hpp:572
Azure::Storage::Blobs::DownloadBlobToOptions::Concurrency
int32_t Concurrency
The maximum number of threads that may be used in a parallel transfer.
Definition: blob_options.hpp:545
Azure::Storage::Blobs::ReleaseLeaseOptions
Optional parameters for Azure::Storage::Blobs::BlobLeaseClient::Release.
Definition: blob_options.hpp:630
Azure::Storage::Blobs::GetBlobContainerPropertiesOptions
Optional parameters for Azure::Storage::Blobs::BlobContainerClient::GetProperties.
Definition: blob_options.hpp:302
Azure::Storage::Blobs::CreateBlobSnapshotOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::CreateSnapshot.
Definition: blob_options.hpp:553
Azure::Storage::Blobs::SealAppendBlobOptions
Optional parameters for Azure::Storage::Blobs::AppendBlobClient::Seal.
Definition: blob_options.hpp:915
Azure::Storage::Blobs::UploadBlockBlobFromOptions::SingleUploadThreshold
int64_t SingleUploadThreshold
Blob smaller than this will be uploaded with a single upload operation. This value cannot be larger t...
Definition: blob_options.hpp:741
Azure::Storage::Blobs::DownloadBlobToOptions::InitialChunkSize
int64_t InitialChunkSize
The size of the first range request in bytes. Blobs smaller than this limit will be downloaded in a s...
Definition: blob_options.hpp:535
Azure::Storage::Blobs::TagAccessConditions
Specifies HTTP options for conditional requests based on tags.
Definition: blob_options.hpp:33
Azure::Storage::Blobs::CommitBlockListOptions::HttpHeaders
Models::BlobHttpHeaders HttpHeaders
The standard HTTP header system properties to set.
Definition: blob_options.hpp:812
Azure::Storage::Blobs::ResizePageBlobOptions
Optional parameters for Azure::Storage::Blobs::PageBlobClient::Resize.
Definition: blob_options.hpp:1005
Azure::Storage::Blobs::StartBlobCopyFromUriOptions::Metadata
Storage::Metadata Metadata
Specifies user-defined name-value pairs associated with the blob. If no name-value pairs are specifie...
Definition: blob_options.hpp:452
Azure::Storage::Blobs::ListBlobContainersOptions::Prefix
Azure::Nullable< std::string > Prefix
Specifies a string that filters the results to return only containers whose name begins with the spec...
Definition: blob_options.hpp:170
Azure::Storage::Blobs::StageBlockOptions
Optional parameters for Azure::Storage::Blobs::BlockBlobClient::StageBlock.
Definition: blob_options.hpp:760
Azure::Storage::Blobs::GetBlockListOptions::ListType
Models::BlockListType ListType
Specifies whether to return the list of committed blocks, the list of uncommitted blocks,...
Definition: blob_options.hpp:839
Azure::Storage::Blobs::StageBlockOptions::AccessConditions
LeaseAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:771
Azure::Storage::Blobs::UploadBlockBlobOptions::AccessTier
Azure::Nullable< Models::AccessTier > AccessTier
Indicates the tier to be set on blob.
Definition: blob_options.hpp:704
Azure::Storage::Blobs::AppendBlobAccessConditions
Specifies access conditions for an append blob.
Definition: blob_options.hpp:71
Azure::Storage::Blobs::ListBlobsOptions::Prefix
Azure::Nullable< std::string > Prefix
Specifies a string that filters the results to return only blobs whose name begins with the specified...
Definition: blob_options.hpp:337
Azure::Storage::Blobs::UndeleteBlobContainerOptions
Optional parameters for #Azure::Storage::Blobs::BlobContainerClient::Undelete.
Definition: blob_options.hpp:295
Azure::Storage::Blobs::Models::PublicAccessType::None
AZ_STORAGE_BLOBS_DLLEXPORT static const PublicAccessType None
Definition: blob_rest_client.hpp:272
Azure::Storage::Blobs::UploadBlockBlobFromOptions::HttpHeaders
Models::BlobHttpHeaders HttpHeaders
The standard HTTP header system properties to set.
Definition: blob_options.hpp:720
Azure::Storage::Blobs::StageBlockFromUriOptions::AccessConditions
LeaseAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:794
Azure::Storage::Blobs::StageBlockFromUriOptions::SourceRange
Azure::Nullable< Core::Http::HttpRange > SourceRange
Uploads only the bytes of the source blob in the specified range.
Definition: blob_options.hpp:782
Azure::Storage::Blobs::StartBlobCopyFromUriOptions::AccessTier
Azure::Nullable< Models::AccessTier > AccessTier
Specifies the tier to be set on the target blob.
Definition: blob_options.hpp:467
Azure::Storage::Blobs::AppendBlockOptions::TransactionalContentHash
Azure::Nullable< ContentHash > TransactionalContentHash
Hash of the blob content. This hash is used to verify the integrity of the blob during transport....
Definition: blob_options.hpp:880
Azure::Storage::Blobs::AbortBlobCopyFromUriOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::AbortCopyFromUri.
Definition: blob_options.hpp:486
Azure::Storage::Blobs::FindBlobsByTagsOptions::ContinuationToken
Azure::Nullable< std::string > ContinuationToken
A string value that identifies the portion of the result set to be returned with the next operation....
Definition: blob_options.hpp:244
Azure::Storage::Blobs::EncryptionKey::Algorithm
Models::EncryptionAlgorithmType Algorithm
The algorithm for Azure Blob Storage to encrypt with.
Definition: blob_options.hpp:128
Azure::Storage::Blobs::LeaseBlobAccessConditions
Specifies access conditions for blob lease operations.
Definition: blob_options.hpp:64
Azure::Storage::Blobs::ListBlobContainersOptions::Include
Models::ListBlobContainersIncludeFlags Include
Specifies that the container's metadata be returned.
Definition: blob_options.hpp:190
Azure::Storage::Blobs::DownloadBlobOptions::RangeHashAlgorithm
Azure::Nullable< HashAlgorithm > RangeHashAlgorithm
When specified together with Range, service returns hash for the range as long as the range is less t...
Definition: blob_options.hpp:507
Azure::Storage::Blobs::CreatePageBlobOptions::HttpHeaders
Models::BlobHttpHeaders HttpHeaders
The standard HTTP header system properties to set.
Definition: blob_options.hpp:936
Azure::Storage::Blobs::GetServicePropertiesOptions
Optional parameters for Azure::Storage::Blobs::BlobServiceClient::GetProperties.
Definition: blob_options.hpp:216
Azure::Storage::Blobs::DownloadBlobToOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::DownloadTo.
Definition: blob_options.hpp:519
Azure::Storage::Blobs::GetBlobTagsOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::GetTags.
Definition: blob_options.hpp:672
Azure::Storage::Blobs::GetBlobPropertiesOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::GetProperties.
Definition: blob_options.hpp:398
Azure::Storage::Blobs::BreakLeaseOptions::AccessConditions
LeaseBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:654
Azure::Storage::Blobs::UploadBlockBlobOptions::Metadata
Storage::Metadata Metadata
Name-value pairs associated with the blob as metadata.
Definition: blob_options.hpp:699
Azure::Storage::Blobs::AcquireLeaseOptions::AccessConditions
LeaseBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:601
Azure::Storage::Blobs::StageBlockFromUriOptions
Optional parameters for Azure::Storage::Blobs::BlockBlobClient::StageBlockFromUri.
Definition: blob_options.hpp:778
Azure::Storage::Blobs::TagAccessConditions::~TagAccessConditions
virtual ~TagAccessConditions()=default
Destructor.
Azure::Storage::Blobs::ClearPagesOptions::AccessConditions
PageBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:998
Azure::Storage::Blobs::CreateBlobContainerOptions
Optional parameters for Azure::Storage::Blobs::BlobContainerClient::Create.
Definition: blob_options.hpp:256
Azure::Storage::Blobs::UploadPagesOptions::AccessConditions
PageBlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:969
Azure::Storage::Blobs::Models::PublicAccessType
Extensible enum used to indicates whether data in the container may be accessed publicly and the leve...
Definition: blob_rest_client.hpp:250
Azure::Storage::Blobs::UndeleteBlobOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::Undelete.
Definition: blob_options.hpp:590
Azure::Storage::Blobs::RenewLeaseOptions
Optional parameters for Azure::Storage::Blobs::BlobLeaseClient::Renew.
Definition: blob_options.hpp:608
Azure::Storage::Blobs::SetBlobMetadataOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:424
Azure::Storage::Blobs::BreakLeaseOptions
Optional parameters for Azure::Storage::Blobs::BlobLeaseClient::Break.
Definition: blob_options.hpp:641
Azure::Storage::Blobs::Models::BlobHttpHeaders
Standard HTTP properties supported by containers and blobs.
Definition: blob_rest_client.hpp:714
Azure::Storage::Blobs::UploadPagesFromUriOptions::TransactionalContentHash
Azure::Nullable< ContentHash > TransactionalContentHash
Hash of the blob content. This hash is used to verify the integrity of the blob during transport....
Definition: blob_options.hpp:982
Azure::Storage::Blobs::GetBlobPropertiesOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:402
Azure::Storage::Blobs::SetBlobAccessTierOptions::RehydratePriority
Azure::Nullable< Models::RehydratePriority > RehydratePriority
Indicates the priority with which to rehydrate an archived blob. The priority can be set on a blob on...
Definition: blob_options.hpp:437
Azure::Storage::Blobs::GetPageRangesOptions::AccessConditions
BlobAccessConditions AccessConditions
Optional conditions that must be met to perform this operation.
Definition: blob_options.hpp:1026
Azure::Storage::Blobs::SetBlobAccessTierOptions
Optional parameters for Azure::Storage::Blobs::BlobClient::SetAccessTier.
Definition: blob_options.hpp:431