package
0.15.0
Repository: https://github.com/azure/azure-storage-blob-go.git
Documentation: pkg.go.dev

# Functions

DoBatchTransfer helps to execute operations in a batch manner.
DownloadBlobToBuffer downloads an Azure blob to a buffer with parallel.
DownloadBlobToFile downloads an Azure blob to a local file.
FormatTimesForSASSigning converts a time.Time to a snapshotTimeFormat string suitable for a SASField's StartTime or ExpiryTime fields.
NewAnonymousCredential creates an anonymous credential for use with HTTP(S) requests that read public resource or for use with Shared Access Signatures (SAS).
NewAppendBlobURL creates an AppendBlobURL object using the specified URL and request policy pipeline.
NewBlobURL creates a BlobURL object using the specified URL and request policy pipeline.
NewBlobURLParts parses a URL initializing BlobURLParts' fields including any SAS-related & snapshot query parameters.
NewBlockBlobURL creates a BlockBlobURL object using the specified URL and request policy pipeline.
NewClientProvidedKeyOptions function.
NewContainerURL creates a ContainerURL object using the specified URL and request policy pipeline.
No description provided by the author
TODO this was supposed to be generatedNewKeyInfo creates a new KeyInfo struct with the correct time formatting & conversion.
NewPageBlobURL creates a PageBlobURL object using the specified URL and request policy pipeline.
NewPipeline creates a Pipeline using the specified credentials and options.
NewRequestLogPolicyFactory creates a RequestLogPolicyFactory object configured using the specified options.
NewResponseError creates an error object that implements the error interface.
NewRetryPolicyFactory creates a RetryPolicyFactory object configured using the specified options.
NewRetryReader creates a retry reader.
NewServiceURL creates a ServiceURL object using the specified URL and request policy pipeline.
NewSharedKeyCredential creates an immutable SharedKeyCredential containing the storage account's name and either its primary or secondary key.
NewStaticBuffer creates a TransferManager that will use a channel as a circular buffer that can hold "max" buffers of "size".
NewSyncPool creates a TransferManager that will use a sync.Pool that can hold a non-capped number of buffers constrained by concurrency.
NewTelemetryPolicyFactory creates a factory that can create telemetry policy objects which add telemetry information to outgoing HTTP requests.
NewTokenCredential creates a token credential for use with role-based access control (RBAC) access to Azure Storage resources.
NewUniqueRequestIDPolicyFactory creates a UniqueRequestIDPolicyFactory object that sets the request's x-ms-client-request-id header if it doesn't already exist.
NewUserDelegationCredential creates a new UserDelegationCredential using a Storage account's name and a user delegation key from it.
PossibleAccessTierTypeValues returns an array of possible values for the AccessTierType const type.
PossibleAccountKindTypeValues returns an array of possible values for the AccountKindType const type.
PossibleArchiveStatusTypeValues returns an array of possible values for the ArchiveStatusType const type.
PossibleBlobDeleteTypeValues returns an array of possible values for the BlobDeleteType const type.
PossibleBlobExpiryOptionsTypeValues returns an array of possible values for the BlobExpiryOptionsType const type.
PossibleBlobImmutabilityPolicyModeTypeValues returns an array of possible values for the BlobImmutabilityPolicyModeType const type.
PossibleBlobTypeValues returns an array of possible values for the BlobType const type.
PossibleBlockListTypeValues returns an array of possible values for the BlockListType const type.
PossibleCopyStatusTypeValues returns an array of possible values for the CopyStatusType const type.
PossibleDeleteSnapshotsOptionTypeValues returns an array of possible values for the DeleteSnapshotsOptionType const type.
PossibleEncryptionAlgorithmTypeValues returns an array of possible values for the EncryptionAlgorithmType const type.
PossibleGeoReplicationStatusTypeValues returns an array of possible values for the GeoReplicationStatusType const type.
PossibleLeaseDurationTypeValues returns an array of possible values for the LeaseDurationType const type.
PossibleLeaseStateTypeValues returns an array of possible values for the LeaseStateType const type.
PossibleLeaseStatusTypeValues returns an array of possible values for the LeaseStatusType const type.
PossibleListBlobsIncludeItemTypeValues returns an array of possible values for the ListBlobsIncludeItemType const type.
PossibleListContainersIncludeTypeValues returns an array of possible values for the ListContainersIncludeType const type.
PossiblePremiumPageBlobAccessTierTypeValues returns an array of possible values for the PremiumPageBlobAccessTierType const type.
PossiblePublicAccessTypeValues returns an array of possible values for the PublicAccessType const type.
PossibleQueryFormatTypeValues returns an array of possible values for the QueryFormatType const type.
PossibleRehydratePriorityTypeValues returns an array of possible values for the RehydratePriorityType const type.
PossibleSequenceNumberActionTypeValues returns an array of possible values for the SequenceNumberActionType const type.
PossibleSkuNameTypeValues returns an array of possible values for the SkuNameType const type.
PossibleStorageErrorCodeTypeValues returns an array of possible values for the StorageErrorCodeType const type.
PossibleSyncCopyStatusTypeValues returns an array of possible values for the SyncCopyStatusType const type.
RedactSigQueryParam redacts the 'sig' query parameter in URL's raw query to protect secret.
No description provided by the author
No description provided by the author
UploadBufferToBlockBlob uploads a buffer in blocks to a block blob.
UploadFileToBlockBlob uploads a file in blocks to a block blob.
UploadStreamToBlockBlob copies the file held in io.Reader to the Blob at blockBlobURL.
UserAgent returns the UserAgent string to use when sending http.Requests.
Version returns the semantic version (see http://semver.org) of the client.

# Constants

AccessTierArchive ...
AccessTierCool ...
AccessTierHot ...
AccessTierNone represents an empty AccessTierType.
AccessTierP10 ...
AccessTierP15 ...
AccessTierP20 ...
AccessTierP30 ...
AccessTierP4 ...
AccessTierP40 ...
AccessTierP50 ...
AccessTierP6 ...
AccessTierP60 ...
AccessTierP70 ...
AccessTierP80 ...
AccountKindBlobStorage ...
AccountKindBlockBlobStorage ...
AccountKindFileStorage ...
AccountKindNone represents an empty AccountKindType.
AccountKindStorage ...
AccountKindStorageV2 ...
4MB.
AppendBlobMaxBlocks indicates the maximum number of blocks allowed in an append blob.
ArchiveStatusNone represents an empty ArchiveStatusType.
ArchiveStatusRehydratePendingToCool ...
ArchiveStatusRehydratePendingToHot ...
BlobAppendBlob ...
BlobBlockBlob ...
4MB.
BlobDeleteNone represents an empty BlobDeleteType.
BlobDeletePermanent ...
BlobExpiryOptionsAbsolute ...
BlobExpiryOptionsNeverExpire ...
BlobExpiryOptionsNone represents an empty BlobExpiryOptionsType.
BlobExpiryOptionsRelativeToCreation ...
BlobExpiryOptionsRelativeToNow ...
BlobImmutabilityPolicyModeLocked ...
BlobImmutabilityPolicyModeMutable ...
BlobImmutabilityPolicyModeNone represents an empty BlobImmutabilityPolicyModeType.
BlobImmutabilityPolicyModeUnlocked ...
BlobNone represents an empty BlobType.
BlobPageBlob ...
BlockBlobMaxBlocks indicates the maximum number of blocks allowed in a block blob.
4000MiB.
256MB.
BlockListAll ...
BlockListCommitted ...
BlockListNone represents an empty BlockListType.
BlockListUncommitted ...
ContainerNameLogs is the special Azure Storage name used to identify a storage account's logs container.
ContainerNameRoot is the special Azure Storage name used to identify a storage account's root container.
CopyStatusAborted ...
CopyStatusFailed ...
CopyStatusNone represents an empty CopyStatusType.
CopyStatusPending ...
CopyStatusSuccess ...
No description provided by the author
DeleteSnapshotsOptionInclude ...
DeleteSnapshotsOptionNone represents an empty DeleteSnapshotsOptionType.
DeleteSnapshotsOptionOnly ...
EncryptionAlgorithmAES256 ...
EncryptionAlgorithmNone represents an empty EncryptionAlgorithmType.
ETagAny matches any entity tag.
ETagNone represents an empty entity tag.
GeoReplicationStatusBootstrap ...
GeoReplicationStatusLive ...
GeoReplicationStatusNone represents an empty GeoReplicationStatusType.
GeoReplicationStatusUnavailable ...
LeaseBreakNaturally tells ContainerURL's or BlobURL's BreakLease method to break the lease using service semantics.
LeaseDurationFixed ...
LeaseDurationInfinite ...
LeaseDurationNone represents an empty LeaseDurationType.
LeaseStateAvailable ...
LeaseStateBreaking ...
LeaseStateBroken ...
LeaseStateExpired ...
LeaseStateLeased ...
LeaseStateNone represents an empty LeaseStateType.
LeaseStatusLocked ...
LeaseStatusNone represents an empty LeaseStatusType.
LeaseStatusUnlocked ...
ListBlobsIncludeItemCopy ...
ListBlobsIncludeItemDeleted ...
ListBlobsIncludeItemDeletedwithversions ...
ListBlobsIncludeItemImmutabilitypolicy ...
ListBlobsIncludeItemLegalhold ...
ListBlobsIncludeItemMetadata ...
ListBlobsIncludeItemNone represents an empty ListBlobsIncludeItemType.
ListBlobsIncludeItemPermissions ...
ListBlobsIncludeItemSnapshots ...
ListBlobsIncludeItemTags ...
ListBlobsIncludeItemUncommittedblobs ...
ListBlobsIncludeItemVersions ...
ListContainersIncludeDeleted ...
ListContainersIncludeMetadata ...
ListContainersIncludeNone represents an empty ListContainersIncludeType.
ListContainersIncludeSystem ...
4MB.
PageBlobPageBytes indicates the number of bytes in a page (512).
PremiumPageBlobAccessTierNone represents an empty PremiumPageBlobAccessTierType.
PremiumPageBlobAccessTierP10 ...
PremiumPageBlobAccessTierP15 ...
PremiumPageBlobAccessTierP20 ...
PremiumPageBlobAccessTierP30 ...
PremiumPageBlobAccessTierP4 ...
PremiumPageBlobAccessTierP40 ...
PremiumPageBlobAccessTierP50 ...
PremiumPageBlobAccessTierP6 ...
PremiumPageBlobAccessTierP60 ...
PremiumPageBlobAccessTierP70 ...
PremiumPageBlobAccessTierP80 ...
PublicAccessBlob ...
PublicAccessContainer ...
PublicAccessNone represents an empty PublicAccessType.
QueryFormatArrow ...
QueryFormatDelimited ...
QueryFormatJSON ...
QueryFormatNone represents an empty QueryFormatType.
QueryFormatParquet ...
No description provided by the author
RehydratePriorityHigh ...
RehydratePriorityNone represents an empty RehydratePriorityType.
RehydratePriorityStandard ...
RetryPolicyExponential tells the pipeline to use an exponential back-off retry policy.
RetryPolicyFixed tells the pipeline to use a fixed back-off retry policy.
SASProtocolHTTPS can be specified for a SAS protocol.
SASProtocolHTTPSandHTTP can be specified for a SAS protocol.
"2017-07-27T00:00:00Z" // ISO 8601.
SASVersion indicates the SAS version.
SequenceNumberActionIncrement ...
SequenceNumberActionMax ...
SequenceNumberActionNone represents an empty SequenceNumberActionType.
SequenceNumberActionUpdate ...
ServiceCodeAccountAlreadyExists means the specified account already exists.
ServiceCodeAccountBeingCreated means the specified account is in the process of being created (403).
ServiceCodeAccountIsDisabled means the specified account is disabled (403).
ServiceCodeAppendPositionConditionNotMet means the append position condition specified was not met.
ServiceCodeAuthenticationFailed means the server failed to authenticate the request.
ServiceCodeBlobAlreadyExists means the specified blob already exists.
ServiceCodeBlobArchived means this operation is not permitted on an archived blob.
ServiceCodeBlobBeingRehydrated means this operation is not permitted because the blob is being rehydrated.
ServiceCodeBlobNotArchived means this blob is currently not in the archived state.
ServiceCodeBlobNotFound means the specified blob does not exist.
ServiceCodeBlobOverwritten means the blob has been recreated since the previous snapshot was taken.
ServiceCodeBlobTierInadequateForContentLength means the specified blob tier size limit cannot be less than content length.
ServiceCodeBlockCountExceedsLimit means the committed block count cannot exceed the maximum limit of 50,000 blocks or that the uncommitted block count cannot exceed the maximum limit of 100,000 blocks.
ServiceCodeBlockListTooLong means the block list may not contain more than 50,000 blocks.
ServiceCodeCannotChangeToLowerTier means that a higher blob tier has already been explicitly set.
ServiceCodeCannotVerifyCopySource means that the service could not verify the copy source within the specified time.
ServiceCodeConditionHeadersNotSupported means the condition headers are not supported (400).
ServiceCodeConditionNotMet means the condition specified in the conditional header(s) was not met for a read/write operation (304/412).
ServiceCodeContainerAlreadyExists means the specified container already exists.
ServiceCodeContainerBeingDeleted means the specified container is being deleted.
ServiceCodeContainerDisabled means the specified container has been disabled by the administrator.
ServiceCodeContainerNotFound means the specified container does not exist.
ServiceCodeContentLengthLargerThanTierLimit means the blob's content length cannot exceed its tier limit.
ServiceCodeCopyAcrossAccountsNotSupported means the copy source account and destination account must be the same.
ServiceCodeCopyIDMismatch means the specified copy ID did not match the copy ID for the pending copy operation.
ServiceCodeEmptyMetadataKey means the key for one of the metadata key-value pairs is empty (400).
ServiceCodeFeatureEncryptionMismatch means the given customer specified encryption does not match the encryption used to encrypt the blob.
ServiceCodeFeatureVersionMismatch means the type of blob in the container is unrecognized by this version or that the operation for AppendBlob requires at least version 2015-02-21.
ServiceCodeIncrementalCopyBlobMismatch means the specified source blob is different than the copy source of the existing incremental copy blob.
ServiceCodeIncrementalCopyOfEarlierVersionSnapshotNotAllowed means the specified snapshot is earlier than the last snapshot copied into the incremental copy blob.
ServiceCodeIncrementalCopySourceMustBeSnapshot means the source for incremental copy request must be a snapshot.
ServiceCodeInfiniteLeaseDurationRequired means the lease ID matched, but the specified lease must be an infinite-duration lease.
ServiceCodeInsufficientAccountPermissions means read operations are currently disabled or Write operations are not allowed or The account being accessed does not have sufficient permissions to execute this operation (403).
ServiceCodeInternalError means the server encountered an internal error.
ServiceCodeInvalidAuthenticationInfo means the authentication information was not provided in the correct format.
ServiceCodeInvalidBlobOrBlock means the specified blob or block content is invalid.
ServiceCodeInvalidBlobType means the blob type is invalid for this operation.
ServiceCodeInvalidBlockID means the specified block ID is invalid.
ServiceCodeInvalidBlockList means the specified block list is invalid.
ServiceCodeInvalidHeaderValue means the value provided for one of the HTTP headers was not in the correct format (400).
ServiceCodeInvalidHTTPVerb means the HTTP verb specified was not recognized by the server (400).
ServiceCodeInvalidInput means one of the request inputs is not valid (400).
ServiceCodeInvalidMd5 means the MD5 value specified in the request is invalid.
ServiceCodeInvalidMetadata means the specified metadata is invalid.
ServiceCodeInvalidOperation means an invalid operation against a blob snapshot.
ServiceCodeInvalidPageRange means the page range specified is invalid.
ServiceCodeInvalidQueryParameterValue means an invalid value was specified for one of the query parameters in the request URI (400).
ServiceCodeInvalidRange means the range specified is invalid for the current size of the resource (416).
ServiceCodeInvalidResourceName means the specified resource name contains invalid characters (400).
ServiceCodeInvalidSourceBlobType means the copy source blob type is invalid for this operation.
ServiceCodeInvalidSourceBlobURL means the source URL for incremental copy request must be valid Azure Storage blob URL.
ServiceCodeInvalidURI means the requested URI does not represent any resource on the server (400).
ServiceCodeInvalidVersionForPageBlobOperation means that all operations on page blobs require at least version 2009-09-19.
ServiceCodeInvalidXMLDocument means the specified XML is not syntactically valid (400).
ServiceCodeInvalidXMLNodeValue means the value provided for one of the XML nodes in the request body was not in the correct format (400).
ServiceCodeLeaseAlreadyBroken means the lease has already been broken and cannot be broken again.
ServiceCodeLeaseAlreadyPresent means there is already a lease present.
ServiceCodeLeaseIDMismatchWithBlobOperation means the lease ID specified did not match the lease ID for the blob.
ServiceCodeLeaseIDMismatchWithContainerOperation means the lease ID specified did not match the lease ID for the container.
ServiceCodeLeaseIDMismatchWithLeaseOperation means the lease ID specified did not match the lease ID for the blob/container.
ServiceCodeLeaseIDMissing means there is currently a lease on the blob/container and no lease ID was specified in the request.
ServiceCodeLeaseIsBreakingAndCannotBeAcquired means the lease ID matched, but the lease is currently in breaking state and cannot be acquired until it is broken.
ServiceCodeLeaseIsBreakingAndCannotBeChanged means the lease ID matched, but the lease is currently in breaking state and cannot be changed.
ServiceCodeLeaseIsBrokenAndCannotBeRenewed means the lease ID matched, but the lease has been broken explicitly and cannot be renewed.
ServiceCodeLeaseLost means a lease ID was specified, but the lease for the blob/container has expired.
ServiceCodeLeaseNotPresentWithBlobOperation means there is currently no lease on the blob.
ServiceCodeLeaseNotPresentWithContainerOperation means there is currently no lease on the container.
ServiceCodeLeaseNotPresentWithLeaseOperation means there is currently no lease on the blob/container.
ServiceCodeMaxBlobSizeConditionNotMet means the max blob size condition specified was not met.
ServiceCodeMd5Mismatch means the MD5 value specified in the request did not match the MD5 value calculated by the server (400).
ServiceCodeMetadataTooLarge means the size of the specified metadata exceeds the maximum size permitted (400).
ServiceCodeMissingContentLengthHeader means the Content-Length header was not specified (411).
ServiceCodeMissingRequiredHeader means a required HTTP header was not specified (400).
ServiceCodeMissingRequiredQueryParameter means a required query parameter was not specified for this request (400).
ServiceCodeMissingRequiredXMLNode means a required XML node was not specified in the request body (400).
ServiceCodeMultipleConditionHeadersNotSupported means multiple condition headers are not supported (400).
ServiceCodeNoAuthenticationInformation means the specified authentication for the resource does not exist (401).
ServiceCodeNone is the default value.
ServiceCodeNoPendingCopyOperation means there is currently no pending copy operation.
ServiceCodeOperationNotAllowedOnIncrementalCopyBlob means the specified operation is not allowed on an incremental copy blob.
ServiceCodeOperationTimedOut means the operation could not be completed within the permitted time (500).
ServiceCodeOutOfRangeInput means one of the request inputs is out of range (400).
ServiceCodeOutOfRangeQueryParameterValue means a query parameter specified in the request URI is outside the permissible range (400).
ServiceCodePendingCopyOperation means there is currently a pending copy operation.
ServiceCodePreviousSnapshotCannotBeNewer means the prevsnapshot query parameter value cannot be newer than snapshot query parameter value.
ServiceCodePreviousSnapshotNotFound means the previous snapshot is not found.
ServiceCodePreviousSnapshotOperationNotSupported means that differential Get Page Ranges is not supported on the previous snapshot.
ServiceCodeRequestBodyTooLarge means the size of the request body exceeds the maximum size permitted (413).
ServiceCodeRequestURLFailedToParse means the url in the request could not be parsed (400).
ServiceCodeResourceAlreadyExists means the specified resource already exists (409).
ServiceCodeResourceNotFound means the specified resource does not exist (404).
ServiceCodeResourceTypeMismatch means the specified resource type does not match the type of the existing resource (409).
ServiceCodeSequenceNumberConditionNotMet means the sequence number condition specified was not met.
ServiceCodeSequenceNumberIncrementTooLarge means the sequence number increment cannot be performed because it would result in overflow of the sequence number.
ServiceCodeServerBusy means the server is currently unable to receive requests.
ServiceCodeSnaphotOperationRateExceeded means the rate of snapshot operations against this blob has been exceeded.
ServiceCodeSnapshotCountExceeded means the snapshot count against this blob has been exceeded.
ServiceCodeSnapshotsPresent means this operation is not permitted while the blob has snapshots.
ServiceCodeSourceConditionNotMet means the source condition specified using HTTP conditional header(s) is not met.
ServiceCodeSystemInUse means this blob is in use by the system.
ServiceCodeTargetConditionNotMet means the target condition specified using HTTP conditional header(s) is not met.
ServiceCodeUnauthorizedBlobOverwrite means this request is not authorized to perform blob overwrites.
ServiceCodeUnsupportedHeader means one of the HTTP headers specified in the request is not supported (400).
ServiceCodeUnsupportedHTTPVerb means the resource doesn't support the specified HTTP verb (405).
ServiceCodeUnsupportedQueryParameter means one of the query parameters specified in the request URI is not supported (400).
ServiceCodeUnsupportedXMLNode means one of the XML nodes specified in the request body is not supported (400).
ServiceVersion specifies the version of the operations used in this package.
SkuNameNone represents an empty SkuNameType.
SkuNamePremiumLRS ...
SkuNameStandardGRS ...
SkuNameStandardLRS ...
SkuNameStandardRAGRS ...
SkuNameStandardZRS ...
No description provided by the author
StorageErrorCodeAccountAlreadyExists ...
StorageErrorCodeAccountBeingCreated ...
StorageErrorCodeAccountIsDisabled ...
StorageErrorCodeAppendPositionConditionNotMet ...
StorageErrorCodeAuthenticationFailed ...
StorageErrorCodeAuthorizationFailure ...
StorageErrorCodeAuthorizationPermissionMismatch ...
StorageErrorCodeAuthorizationProtocolMismatch ...
StorageErrorCodeAuthorizationResourceTypeMismatch ...
StorageErrorCodeAuthorizationServiceMismatch ...
StorageErrorCodeAuthorizationSourceIPMismatch ...
StorageErrorCodeBlobAlreadyExists ...
StorageErrorCodeBlobArchived ...
StorageErrorCodeBlobBeingRehydrated ...
StorageErrorCodeBlobImmutableDueToPolicy ...
StorageErrorCodeBlobNotArchived ...
StorageErrorCodeBlobNotFound ...
StorageErrorCodeBlobOverwritten ...
StorageErrorCodeBlobTierInadequateForContentLength ...
StorageErrorCodeBlobUsesCustomerSpecifiedEncryption ...
StorageErrorCodeBlockCountExceedsLimit ...
StorageErrorCodeBlockListTooLong ...
StorageErrorCodeCannotChangeToLowerTier ...
StorageErrorCodeCannotVerifyCopySource ...
StorageErrorCodeConditionHeadersNotSupported ...
StorageErrorCodeConditionNotMet ...
StorageErrorCodeContainerAlreadyExists ...
StorageErrorCodeContainerBeingDeleted ...
StorageErrorCodeContainerDisabled ...
StorageErrorCodeContainerNotFound ...
StorageErrorCodeContentLengthLargerThanTierLimit ...
StorageErrorCodeCopyAcrossAccountsNotSupported ...
StorageErrorCodeCopyIDMismatch ...
StorageErrorCodeEmptyMetadataKey ...
StorageErrorCodeFeatureVersionMismatch ...
StorageErrorCodeIncrementalCopyBlobMismatch ...
StorageErrorCodeIncrementalCopyOfEralierVersionSnapshotNotAllowed ...
StorageErrorCodeIncrementalCopySourceMustBeSnapshot ...
StorageErrorCodeInfiniteLeaseDurationRequired ...
StorageErrorCodeInsufficientAccountPermissions ...
StorageErrorCodeInternalError ...
StorageErrorCodeInvalidAuthenticationInfo ...
StorageErrorCodeInvalidBlobOrBlock ...
StorageErrorCodeInvalidBlobTier ...
StorageErrorCodeInvalidBlobType ...
StorageErrorCodeInvalidBlockID ...
StorageErrorCodeInvalidBlockList ...
StorageErrorCodeInvalidHeaderValue ...
StorageErrorCodeInvalidHTTPVerb ...
StorageErrorCodeInvalidInput ...
StorageErrorCodeInvalidMd5 ...
StorageErrorCodeInvalidMetadata ...
StorageErrorCodeInvalidOperation ...
StorageErrorCodeInvalidPageRange ...
StorageErrorCodeInvalidQueryParameterValue ...
StorageErrorCodeInvalidRange ...
StorageErrorCodeInvalidResourceName ...
StorageErrorCodeInvalidSourceBlobType ...
StorageErrorCodeInvalidSourceBlobURL ...
StorageErrorCodeInvalidURI ...
StorageErrorCodeInvalidVersionForPageBlobOperation ...
StorageErrorCodeInvalidXMLDocument ...
StorageErrorCodeInvalidXMLNodeValue ...
StorageErrorCodeLeaseAlreadyBroken ...
StorageErrorCodeLeaseAlreadyPresent ...
StorageErrorCodeLeaseIDMismatchWithBlobOperation ...
StorageErrorCodeLeaseIDMismatchWithContainerOperation ...
StorageErrorCodeLeaseIDMismatchWithLeaseOperation ...
StorageErrorCodeLeaseIDMissing ...
StorageErrorCodeLeaseIsBreakingAndCannotBeAcquired ...
StorageErrorCodeLeaseIsBreakingAndCannotBeChanged ...
StorageErrorCodeLeaseIsBrokenAndCannotBeRenewed ...
StorageErrorCodeLeaseLost ...
StorageErrorCodeLeaseNotPresentWithBlobOperation ...
StorageErrorCodeLeaseNotPresentWithContainerOperation ...
StorageErrorCodeLeaseNotPresentWithLeaseOperation ...
StorageErrorCodeMaxBlobSizeConditionNotMet ...
StorageErrorCodeMd5Mismatch ...
StorageErrorCodeMetadataTooLarge ...
StorageErrorCodeMissingContentLengthHeader ...
StorageErrorCodeMissingRequiredHeader ...
StorageErrorCodeMissingRequiredQueryParameter ...
StorageErrorCodeMissingRequiredXMLNode ...
StorageErrorCodeMultipleConditionHeadersNotSupported ...
StorageErrorCodeNoAuthenticationInformation ...
StorageErrorCodeNone represents an empty StorageErrorCodeType.
StorageErrorCodeNoPendingCopyOperation ...
StorageErrorCodeOperationNotAllowedOnIncrementalCopyBlob ...
StorageErrorCodeOperationTimedOut ...
StorageErrorCodeOutOfRangeInput ...
StorageErrorCodeOutOfRangeQueryParameterValue ...
StorageErrorCodePendingCopyOperation ...
StorageErrorCodePreviousSnapshotCannotBeNewer ...
StorageErrorCodePreviousSnapshotNotFound ...
StorageErrorCodePreviousSnapshotOperationNotSupported ...
StorageErrorCodeRequestBodyTooLarge ...
StorageErrorCodeRequestURLFailedToParse ...
StorageErrorCodeResourceAlreadyExists ...
StorageErrorCodeResourceNotFound ...
StorageErrorCodeResourceTypeMismatch ...
StorageErrorCodeSequenceNumberConditionNotMet ...
StorageErrorCodeSequenceNumberIncrementTooLarge ...
StorageErrorCodeServerBusy ...
StorageErrorCodeSnapshotCountExceeded ...
StorageErrorCodeSnapshotOperationRateExceeded ...
StorageErrorCodeSnapshotsPresent ...
StorageErrorCodeSourceConditionNotMet ...
StorageErrorCodeSystemInUse ...
StorageErrorCodeTargetConditionNotMet ...
StorageErrorCodeUnauthorizedBlobOverwrite ...
StorageErrorCodeUnsupportedHeader ...
StorageErrorCodeUnsupportedHTTPVerb ...
StorageErrorCodeUnsupportedQueryParameter ...
StorageErrorCodeUnsupportedXMLNode ...
SyncCopyStatusNone represents an empty SyncCopyStatusType.
SyncCopyStatusSuccess ...

# Variables

No description provided by the author
No description provided by the author
ISO 8601 formats, please refer to https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas for more details.

# Structs

AccessPolicy - An Access policy.
The AccessPolicyPermission type simplifies creating the permissions string for a container's access policy.
The AccountSASPermissions type simplifies creating the permissions string for an Azure Storage Account SAS.
The AccountSASResourceTypes type simplifies creating the resource types string for an Azure Storage Account SAS.
The AccountSASServices type simplifies creating the services string for an Azure Storage Account SAS.
AccountSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage account.
No description provided by the author
AppendBlobAppendBlockFromURLResponse ...
AppendBlobAppendBlockResponse ...
AppendBlobCreateResponse ...
AppendBlobSealResponse ...
AppendBlobURL defines a set of operations applicable to append blobs.
AppendPositionAccessConditions identifies append blob-specific access conditions which you optionally set.
ArrowConfiguration - Groups the settings used for formatting the response if the response should be Arrow formatted.
ArrowField - Groups settings regarding specific field of an arrow schema.
BatchTransferOptions identifies options used by DoBatchTransfer.
BlobAbortCopyFromURLResponse ...
BlobAccessConditions identifies blob-specific access conditions which you optionally set.
BlobAcquireLeaseResponse ...
BlobBreakLeaseResponse ...
BlobChangeLeaseResponse ...
BlobCopyFromURLResponse ...
BlobCreateSnapshotResponse ...
BlobDeleteImmutabilityPolicyResponse ...
BlobDeleteResponse ...
BlobFlatListSegment ...
BlobGetAccountInfoResponse ...
BlobGetPropertiesResponse ...
BlobHierarchyListSegment ...
BlobHTTPHeaders contains read/writeable blob properties.
BlobItemInternal - An Azure Storage blob.
BlobListingDetails indicates what additional information the service should return with each blob.
BlobPrefix ...
BlobPropertiesInternal - Properties of a blob.
BlobReleaseLeaseResponse ...
BlobRenewLeaseResponse ...
The BlobSASPermissions type simplifies creating the permissions string for an Azure Storage blob SAS.
BlobSASSignatureValues is used to generate a Shared Access Signature (SAS) for an Azure Storage container or blob.
BlobSetExpiryResponse ...
BlobSetHTTPHeadersResponse ...
BlobSetImmutabilityPolicyResponse ...
BlobSetLegalHoldResponse ...
BlobSetMetadataResponse ...
BlobSetTagsResponse ...
BlobSetTierResponse ...
BlobStartCopyFromURLResponse ...
BlobTag ...
BlobTags - Blob tags.
BlobUndeleteResponse ...
A BlobURL represents a URL to an Azure Storage blob; the blob may be a block blob, append blob, or page blob.
A BlobURLParts object represents the components that make up an Azure Storage Container/Blob URL.
Block - Represents a single block in a block blob.
BlockBlobCommitBlockListResponse ...
BlockBlobPutBlobFromURLResponse ...
BlockBlobStageBlockFromURLResponse ...
BlockBlobStageBlockResponse ...
BlockBlobUploadResponse ...
BlockBlobURL defines a set of operations applicable to block blobs.
BlockList ...
BlockLookupList ...
ClearRange ...
ClientProvidedKeyOptions contains headers which may be be specified from service version 2019-02-02 or higher to encrypts the data on the service-side with the given key.
ContainerAccessConditions identifies container-specific access conditions which you optionally set.
ContainerAcquireLeaseResponse ...
ContainerBreakLeaseResponse ...
ContainerChangeLeaseResponse ...
ContainerCreateResponse ...
ContainerDeleteResponse ...
ContainerGetAccountInfoResponse ...
ContainerGetPropertiesResponse ...
ContainerItem - An Azure Storage container.
ContainerProperties - Properties of a container.
ContainerReleaseLeaseResponse ...
ContainerRenameResponse ...
ContainerRenewLeaseResponse ...
ContainerRestoreResponse ...
The ContainerSASPermissions type simplifies creating the permissions string for an Azure Storage container SAS.
ContainerSetAccessPolicyResponse ...
ContainerSetMetadataResponse ...
A ContainerURL represents a URL to the Azure Storage container allowing you to manipulate its blobs.
CorsRule - CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain.
DelimitedTextConfiguration - Groups the settings used for interpreting the blob data if the blob is delimited text formatted.
DownloadFromBlobOptions identifies options used by the DownloadBlobToBuffer and DownloadBlobToFile functions.
DownloadResponse wraps AutoRest generated downloadResponse and helps to provide info for retry.
FilterBlobItem - Blob info from a Filter Blobs API call.
FilterBlobSegment - The result of a Filter Blobs API call.
GeoReplication - Geo-Replication information for the Secondary Storage Service.
HTTPGetterInfo is passed to an HTTPGetter function passing it parameters that should be used to make an HTTP GET request.
No description provided by the author
IPEndpointStyleInfo is used for IP endpoint style URL when working with Azure storage emulator.
IPRange represents a SAS IP range's start IP and (optionally) end IP.
JSONTextConfiguration - json text configuration.
KeyInfo - Key information.
LeaseAccessConditions identifies lease access conditions for a container or blob which you optionally set.
ListBlobsFlatSegmentResponse - An enumeration of blobs.
ListBlobsHierarchySegmentResponse - An enumeration of blobs.
ListBlobsSegmentOptions defines options available when calling ListBlobs.
ListContainersFlatDetail indicates what additional information the service should return with each container.
ListContainersOptions defines options available when calling ListContainers.
ListContainersSegmentResponse - An enumeration of containers.
Logging - Azure Analytics Logging settings.
Marker represents an opaque value used in paged responses.
Metrics - a summary of request statistics grouped by API in hour or minute aggregates for blobs.
ModifiedAccessConditions identifies standard HTTP access conditions which you optionally set.
No description provided by the author
PageBlobClearPagesResponse ...
PageBlobCopyIncrementalResponse ...
PageBlobCreateResponse ...
PageBlobResizeResponse ...
PageBlobUpdateSequenceNumberResponse ...
PageBlobUploadPagesFromURLResponse ...
PageBlobUploadPagesResponse ...
PageBlobURL defines a set of operations applicable to page blobs.
PageList - the list of pages.
PageRange ...
PipelineOptions is used to configure a request policy pipeline's retry policy and logging.
QueryFormat ...
QueryRequest - Groups the set of query request settings.
QueryResponse - Wraps the response from the blobClient.Query method.
QuerySerialization ...
RequestLogOptions configures the retry policy's behavior.
RetentionPolicy - the retention policy which determines how long the associated data should persist.
RetryOptions configures the retry policy's behavior.
RetryReaderOptions contains properties which can help to decide when to do retry.
A SASQueryParameters object represents the components that make up an Azure Storage SAS' query parameters.
SequenceNumberAccessConditions identifies page blob-specific access conditions which you optionally set.
ServiceGetAccountInfoResponse ...
ServiceSetPropertiesResponse ...
A ServiceURL represents a URL to the Azure Storage Blob service allowing you to manipulate blob containers.
SharedKeyCredential contains an account's name and its primary or secondary key.
SignedIdentifier - signed identifier.
SignedIdentifiers - Wraps the response from the containerClient.GetAccessPolicy method.
StaticWebsite - The properties that enable an account to host a static website.
StorageServiceProperties - Storage Service Properties.
StorageServiceStats - Stats for the storage service.
SubmitBatchResponse - Wraps the response from the containerClient.SubmitBatch method.
TelemetryOptions configures the telemetry policy's behavior.
UploadStreamOptions (defunct) was used internally.
UploadStreamToBlockBlobOptions is options for UploadStreamToBlockBlob.
UploadToBlockBlobOptions identifies options used by the UploadBufferToBlockBlob and UploadFileToBlockBlob functions.
No description provided by the author
UserDelegationKey - A user delegation key.

# Interfaces

CommonResponse returns the headers common to all blob REST API responses.
Credential represent any credential type; it is used to create a credential policy Factory.
ResponseError identifies a responder-generated network or response parsing error.
StorageAccountCredential is a wrapper interface for SharedKeyCredential and UserDelegationCredential.
StorageError identifies a responder-generated network or response parsing error.
TokenCredential represents a token credential (which is also a pipeline.Factory).
TransferManager provides a buffer and thread pool manager for certain transfer options.

# Type aliases

AccessTierType enumerates the values for access tier type.
AccountKindType enumerates the values for account kind type.
ArchiveStatusType enumerates the values for archive status type.
BlobDeleteType enumerates the values for blob delete type.
BlobExpiryOptionsType enumerates the values for blob expiry options type.
BlobImmutabilityPolicyModeType enumerates the values for blob immutability policy mode type.
No description provided by the author
BlobType enumerates the values for blob type.
BlockListType enumerates the values for block list type.
CopyStatusType enumerates the values for copy status type.
DeleteSnapshotsOptionType enumerates the values for delete snapshots option type.
EncryptionAlgorithmType enumerates the values for encryption algorithm type.
ETag is an entity tag.
FailedReadNotifier is a function type that represents the notification function called when a read fails.
GeoReplicationStatusType enumerates the values for geo replication status type.
HTTPGetter is a function type that refers to a method that performs an HTTP GET operation.
LeaseDurationType enumerates the values for lease duration type.
LeaseStateType enumerates the values for lease state type.
LeaseStatusType enumerates the values for lease status type.
ListBlobsIncludeItemType enumerates the values for list blobs include item type.
ListContainersIncludeType enumerates the values for list containers include type.
Metadata contains metadata key/value pairs.
PremiumPageBlobAccessTierType enumerates the values for premium page blob access tier type.
PublicAccessType enumerates the values for public access type.
QueryFormatType enumerates the values for query format type.
RehydratePriorityType enumerates the values for rehydrate priority type.
RetryPolicy tells the pipeline what kind of retry policy to use.
No description provided by the author
SequenceNumberActionType enumerates the values for sequence number action type.
ServiceCodeType is a string identifying a storage service error.
SkuNameType enumerates the values for sku name type.
StorageErrorCodeType enumerates the values for storage error code type.
SyncCopyStatusType enumerates the values for sync copy status type.
TokenRefresher represents a callback method that you write; this method is called periodically so you can refresh the token credential's value.