Table of Contents

Class Constants.HeaderConstants

Namespace
Microsoft.WindowsAzure.Storage.Shared.Protocol
Assembly
Microsoft.WindowsAzure.Storage.dll

Constants for HTTP headers.

public static class Constants.HeaderConstants
Inheritance
Constants.HeaderConstants
Inherited Members

Fields

AccessTierChangeTimeHeader

Header for the last time the tier was modified.

public const string AccessTierChangeTimeHeader = "x-ms-access-tier-change-time"

Field Value

string

AccessTierHeader

Header for the blob tier.

public const string AccessTierHeader = "x-ms-access-tier"

Field Value

string

AccessTierInferredHeader

Header for the blob tier inferred.

public const string AccessTierInferredHeader = "x-ms-access-tier-inferred"

Field Value

string

AppendBlob

Specifies the append blob type.

public const string AppendBlob = "AppendBlob"

Field Value

string

ApproximateMessagesCount

Header that specifies approximate message count of a queue.

public const string ApproximateMessagesCount = "x-ms-approximate-messages-count"

Field Value

string

ArchiveStatusHeader

Header for the archive status.

public const string ArchiveStatusHeader = "x-ms-archive-status"

Field Value

string

BlobAppendOffset

Header that specifies the blob append offset.

public const string BlobAppendOffset = "x-ms-blob-append-offset"

Field Value

string

BlobCacheControlHeader

Header that specifies blob caching control.

public const string BlobCacheControlHeader = "x-ms-blob-cache-control"

Field Value

string

BlobCommittedBlockCount

Header that specifies committed block count.

public const string BlobCommittedBlockCount = "x-ms-blob-committed-block-count"

Field Value

string

BlobContentDispositionRequestHeader

Request header that specifies the blob content disposition.

public const string BlobContentDispositionRequestHeader = "x-ms-blob-content-disposition"

Field Value

string

BlobContentEncodingHeader

Header that specifies blob content encoding.

public const string BlobContentEncodingHeader = "x-ms-blob-content-encoding"

Field Value

string

BlobContentLanguageHeader

Header that specifies blob content language.

public const string BlobContentLanguageHeader = "x-ms-blob-content-language"

Field Value

string

BlobContentLengthHeader

Header that specifies blob content length.

public const string BlobContentLengthHeader = "x-ms-blob-content-length"

Field Value

string

BlobContentMD5Header

Header that specifies blob content MD5.

public const string BlobContentMD5Header = "x-ms-blob-content-md5"

Field Value

string

BlobContentTypeHeader

Header that specifies blob content type.

public const string BlobContentTypeHeader = "x-ms-blob-content-type"

Field Value

string

BlobPublicAccess

Header that specifies public access to blobs.

public const string BlobPublicAccess = "x-ms-blob-public-access"

Field Value

string

BlobSequenceNumber

Header that specifies blob sequence number.

public const string BlobSequenceNumber = "x-ms-blob-sequence-number"

Field Value

string

BlobType

Header for the blob type.

public const string BlobType = "x-ms-blob-type"

Field Value

string

BlockBlob

Specifies the block blob type.

public const string BlockBlob = "BlockBlob"

Field Value

string

ClientRequestIdHeader

Header indicating the client request ID.

public const string ClientRequestIdHeader = "x-ms-client-request-id"

Field Value

string

ContainerPublicAccessType

Header that specifies whether data in the container may be accessed publicly and what level of access is to be allowed.

public const string ContainerPublicAccessType = "x-ms-blob-public-access"

Field Value

string

ContentDispositionResponseHeader

Header that specifies content disposition.

public const string ContentDispositionResponseHeader = "Content-Disposition"

Field Value

string

ContentLanguageHeader

Header that specifies content language.

public const string ContentLanguageHeader = "Content-Language"

Field Value

string

ContentLengthHeader

Header that specifies content length.

public const string ContentLengthHeader = "Content-Length"

Field Value

string

CopyActionAbort

The value of the copy action header that signifies an abort operation.

public const string CopyActionAbort = "abort"

Field Value

string

CopyActionHeader

Header that specifies the copy action.

public const string CopyActionHeader = "x-ms-copy-action"

Field Value

string

CopyCompletionTimeHeader

Header that specifies the conclusion time of the last attempted blob copy operation where this blob was the destination blob.

public const string CopyCompletionTimeHeader = "x-ms-copy-completion-time"

Field Value

string

CopyDescriptionHeader

Header that specifies a copy error message.

public const string CopyDescriptionHeader = "x-ms-copy-status-description"

Field Value

string

CopyDestinationSnapshotHeader

Header that specifies the snapshot time of the last successful incremental copy snapshot.

public const string CopyDestinationSnapshotHeader = "x-ms-copy-destination-snapshot"

Field Value

string

CopyIdHeader

Header that specifies the copy ID.

public const string CopyIdHeader = "x-ms-copy-id"

Field Value

string

CopyProgressHeader

Header that specifies the copy progress.

public const string CopyProgressHeader = "x-ms-copy-progress"

Field Value

string

CopySourceHeader

Header for copy source.

public const string CopySourceHeader = "x-ms-copy-source"

Field Value

string

CopyStatusHeader

Header that specifies the copy status.

public const string CopyStatusHeader = "x-ms-copy-status"

Field Value

string

CopyTypeHeader

Header that specifies the copy type.

public const string CopyTypeHeader = "x-ms-copy-type"

Field Value

string

CreationTimeHeader

Header that specifies the creation time value for the resource.

public const string CreationTimeHeader = "x-ms-creation-time"

Field Value

string

Date

Header that specifies the date.

public const string Date = "x-ms-date"

Field Value

string

DeleteSnapshotHeader

Header to delete snapshots.

public const string DeleteSnapshotHeader = "x-ms-delete-snapshots"

Field Value

string

EtagHeader

Header that specifies the ETag value for the resource.

public const string EtagHeader = "ETag"

Field Value

string

FalseHeader

False Header.

public const string FalseHeader = "false"

Field Value

string

File

Specifies the file type.

public const string File = "File"

Field Value

string

FileCacheControlHeader

Header that specifies file caching control.

public const string FileCacheControlHeader = "x-ms-cache-control"

Field Value

string

FileContentDispositionRequestHeader

Request header that specifies the file content disposition.

public const string FileContentDispositionRequestHeader = "x-ms-content-disposition"

Field Value

string

FileContentEncodingHeader

Header that specifies file content encoding.

public const string FileContentEncodingHeader = "x-ms-content-encoding"

Field Value

string

FileContentLanguageHeader

Header that specifies file content language.

public const string FileContentLanguageHeader = "x-ms-content-language"

Field Value

string

FileContentLengthHeader

Header that specifies file content length.

public const string FileContentLengthHeader = "x-ms-content-length"

Field Value

string

FileContentMD5Header

Header that specifies file content MD5.

public const string FileContentMD5Header = "x-ms-content-md5"

Field Value

string

FileContentTypeHeader

Header that specifies file content type.

public const string FileContentTypeHeader = "x-ms-content-type"

Field Value

string

FileRangeWrite

Header that specifies the file write mode.

public const string FileRangeWrite = "x-ms-write"

Field Value

string

FileType

Header for the file type.

public const string FileType = "x-ms-type"

Field Value

string

HasImmutabilityPolicyHeader

Header that specifies the immutability policy value for the resource.

public const string HasImmutabilityPolicyHeader = "x-ms-has-immutability-policy"

Field Value

string

HasLegalHoldHeader

Header that specifies the legal hold value for the resource.

public const string HasLegalHoldHeader = "x-ms-has-legal-hold"

Field Value

string

IfAppendPositionEqualHeader

Header for the blob-condition-appendpos condition.

public const string IfAppendPositionEqualHeader = "x-ms-blob-condition-appendpos"

Field Value

string

IfMaxSizeLessThanOrEqualHeader

Header for the blob-condition-maxsize condition.

public const string IfMaxSizeLessThanOrEqualHeader = "x-ms-blob-condition-maxsize"

Field Value

string

IfSequenceNumberEqHeader

Header for the If-Sequence-Number-EQ condition.

public const string IfSequenceNumberEqHeader = "x-ms-if-sequence-number-eq"

Field Value

string

IfSequenceNumberLEHeader

Header for the If-Sequence-Number-LE condition.

public const string IfSequenceNumberLEHeader = "x-ms-if-sequence-number-le"

Field Value

string

IfSequenceNumberLTHeader

Header for the If-Sequence-Number-LT condition.

public const string IfSequenceNumberLTHeader = "x-ms-if-sequence-number-lt"

Field Value

string

IncludeSnapshotsValue

Specifies snapshots are to be included.

public const string IncludeSnapshotsValue = "include"

Field Value

string

IncrementalCopyHeader

Header that specifies an incremental copy.

public const string IncrementalCopyHeader = "x-ms-incremental-copy"

Field Value

string

KeyNameHeader

Header that specifies the key name for explicit keys.

public const string KeyNameHeader = "x-ms-key-name"

Field Value

string

LeaseActionHeader

Header that specifies the lease action to perform.

public const string LeaseActionHeader = "x-ms-lease-action"

Field Value

string

LeaseBreakPeriodHeader

Header that specifies the break period of a lease.

public const string LeaseBreakPeriodHeader = "x-ms-lease-break-period"

Field Value

string

LeaseDurationHeader

Header that specifies the duration of a lease.

public const string LeaseDurationHeader = "x-ms-lease-duration"

Field Value

string

LeaseIdHeader

Header that specifies lease ID.

public const string LeaseIdHeader = "x-ms-lease-id"

Field Value

string

LeaseState

Header that specifies lease status.

public const string LeaseState = "x-ms-lease-state"

Field Value

string

LeaseStatus

Header that specifies lease status.

public const string LeaseStatus = "x-ms-lease-status"

Field Value

string

LeaseTimeHeader

Header that specifies the remaining lease time.

public const string LeaseTimeHeader = "x-ms-lease-time"

Field Value

string

NextVisibleTime

Header that specifies the next visible time for a message.

public const string NextVisibleTime = "x-ms-time-next-visible"

Field Value

string

PageBlob

Specifies the page blob type.

public const string PageBlob = "PageBlob"

Field Value

string

PageWrite

Header that specifies page write mode.

public const string PageWrite = "x-ms-page-write"

Field Value

string

PeekOnly

Header that specifies whether to peek-only.

public const string PeekOnly = "peekonly"

Field Value

string

PopReceipt

Header that specifies the pop receipt for a message.

public const string PopReceipt = "x-ms-popreceipt"

Field Value

string

PrefixForStorageHeader

Master Microsoft Azure Storage header prefix.

public const string PrefixForStorageHeader = "x-ms-"

Field Value

string

PrefixForStorageMetadata

Header prefix for metadata.

public const string PrefixForStorageMetadata = "x-ms-meta-"

Field Value

string

PrefixForStorageProperties

Header prefix for properties.

public const string PrefixForStorageProperties = "x-ms-prop-"

Field Value

string

ProposedLeaseIdHeader

Header that specifies the proposed lease ID for a leasing operation.

public const string ProposedLeaseIdHeader = "x-ms-proposed-lease-id"

Field Value

string

RangeContentMD5Header

Header for range content MD5.

public const string RangeContentMD5Header = "x-ms-range-get-content-md5"

Field Value

string

RangeHeader

Header for data ranges.

public const string RangeHeader = "x-ms-range"

Field Value

string

RangeHeaderFormat

Format string for specifying ranges.

public const string RangeHeaderFormat = "bytes={0}-{1}"

Field Value

string

RequestIdHeader

Header indicating the request ID.

public const string RequestIdHeader = "x-ms-request-id"

Field Value

string

RequiresSyncHeader

Header for copy sync.

public const string RequiresSyncHeader = "x-ms-requires-sync"

Field Value

string

SequenceNumberAction

Header that specifies sequence number action.

public const string SequenceNumberAction = "x-ms-sequence-number-action"

Field Value

string

ServerEncrypted

Header that specifies if a resourse is fully encrypted server-side.

public const string ServerEncrypted = "x-ms-server-encrypted"

Field Value

string

ServerRequestEncrypted

Header that acknowledges the data used for write operation is encrypted server-side.

public const string ServerRequestEncrypted = "x-ms-request-server-encrypted"

Field Value

string

ShareQuota

Header that specifies the share quota, in gigabytes.

public const string ShareQuota = "x-ms-share-quota"

Field Value

string

ShareSize

Header that specifies the share size, in gigabytes.

public const string ShareSize = "x-ms-share-size"

Field Value

string

SnapshotHeader

Header for snapshots.

public const string SnapshotHeader = "x-ms-snapshot"

Field Value

string

SnapshotsOnlyValue

Specifies only snapshots are to be included.

public const string SnapshotsOnlyValue = "only"

Field Value

string

SourceContentMD5Header

Header that specifies source content MD5.

public const string SourceContentMD5Header = "x-ms-source-content-md5"

Field Value

string

SourceIfMatchHeader

Header for the If-Match condition.

public const string SourceIfMatchHeader = "x-ms-source-if-match"

Field Value

string

SourceIfModifiedSinceHeader

Header for the If-Modified-Since condition.

public const string SourceIfModifiedSinceHeader = "x-ms-source-if-modified-since"

Field Value

string

SourceIfNoneMatchHeader

Header for the If-None-Match condition.

public const string SourceIfNoneMatchHeader = "x-ms-source-if-none-match"

Field Value

string

SourceIfUnmodifiedSinceHeader

Header for the If-Unmodified-Since condition.

public const string SourceIfUnmodifiedSinceHeader = "x-ms-source-if-unmodified-since"

Field Value

string

SourceRangeHeader

Header for source ranges.

public const string SourceRangeHeader = "x-ms-source-range"

Field Value

string

StorageVersionHeader

Header for storage version.

public const string StorageVersionHeader = "x-ms-version"

Field Value

string

TargetStorageVersion

Current storage version header value. Every time this version changes, assembly version needs to be updated as well.

public const string TargetStorageVersion = "2018-03-28"

Field Value

string

TrueHeader

True Header.

public const string TrueHeader = "true"

Field Value

string

UserAgent

Specifies the value to use for UserAgent header.

public static readonly string UserAgent

Field Value

string

UserAgentComment

Specifies the comment to use for UserAgent header.

public static readonly string UserAgentComment

Field Value

string

UserAgentProductName

Specifies the value to use for UserAgent header.

public const string UserAgentProductName = "Azure-Storage"

Field Value

string

UserAgentProductVersion

Specifies the value to use for UserAgent header.

public const string UserAgentProductVersion = "9.3.2"

Field Value

string