BlobDownloadHeaders interface

Pakiet:

@azure/storage-blob

Definiuje nagłówki dla operacji Blob_download.

Właściwości

acceptRanges	Wskazuje, że usługa obsługuje żądania częściowej zawartości obiektu blob.
blobCommittedBlockCount	Liczba zatwierdzonych bloków znajdujących się w obiekcie blob. Ten nagłówek jest zwracany tylko dla uzupełnialnych obiektów blob.
blobContentMD5	Jeśli obiekt blob ma skrót MD5, a żądanie zawiera nagłówek zakresu (Zakres lub x-ms-range), ten nagłówek odpowiedzi jest zwracany z wartością wartości MD5 całego obiektu blob. Ta wartość może być równa wartości zwracanej w nagłówku Content-MD5, a ta ostatnia jest obliczana z żądanego zakresu
blobSequenceNumber	Bieżący numer sekwencji stronicowego obiektu blob. Ten nagłówek nie jest zwracany dla blokowych obiektów blob ani uzupełnialnych obiektów blob
blobType	Typ obiektu blob.
cacheControl	Ten nagłówek jest zwracany, jeśli został wcześniej określony dla obiektu blob.
clientRequestId	Jeśli w żądaniu zostanie wysłany nagłówek identyfikatora żądania klienta, ten nagłówek będzie obecny w odpowiedzi o tej samej wartości.
contentCrc64	Jeśli żądanie ma odczytać określony zakres, a x-ms-range-get-content-crc64 ma wartość true, żądanie zwraca wartość crc64 dla zakresu, o ile rozmiar zakresu jest mniejszy lub równy 4 MB. Jeśli oba pliki x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 zostaną określone w tym samym żądaniu, zakończy się niepowodzeniem z błędem 400(Nieprawidłowe żądanie).
contentDisposition	Ten nagłówek zwraca wartość, która została określona dla nagłówka "x-ms-blob-content-disposition". Pole nagłówek odpowiedzi Content-Disposition przekazuje dodatkowe informacje o sposobie przetwarzania ładunku odpowiedzi, a także może służyć do dołączania dodatkowych metadanych. Jeśli na przykład ustawiono wartość załącznika, oznacza to, że agent-użytkownik nie powinien wyświetlać odpowiedzi, ale zamiast tego wyświetli okno dialogowe Zapisz jako z nazwą inną niż określona nazwa obiektu blob.
contentEncoding	Ten nagłówek zwraca wartość, która została określona dla nagłówka żądania Content-Encoding
contentLanguage	Ten nagłówek zwraca wartość, która została określona dla nagłówka żądania Content-Language.
contentLength	Liczba bajtów znajdujących się w treści odpowiedzi.
contentMD5	Jeśli obiekt blob ma skrót MD5, a ta operacja polega na odczytaniu pełnego obiektu blob, ten nagłówek odpowiedzi zostanie zwrócony, aby klient mógł sprawdzić integralność zawartości komunikatu.
contentRange	Wskazuje zakres bajtów zwróconych w przypadku, gdy klient zażądał podzestawu obiektu blob, ustawiając nagłówek żądania "Zakres".
contentType	Typ nośnika treści odpowiedzi. W przypadku pobierania obiektu blob jest to "application/octet-stream"
copyCompletedOn	Czas ostatniej próby skopiowania obiektu blob, w którym ten obiekt blob był docelowym obiektem blob. Ta wartość może określać czas ukończenia, przerwania lub nieudanej próby kopiowania. Ten nagłówek nie jest wyświetlany, jeśli kopia oczekuje, jeśli ten obiekt blob nigdy nie był miejscem docelowym operacji kopiowania obiektu blob lub jeśli ten obiekt blob został zmodyfikowany po zakończonej operacji kopiowania obiektu blob przy użyciu ustawiania właściwości obiektu blob, umieszczania obiektu blob lub umieszczania listy bloków.
copyId	Identyfikator ciągu dla tej operacji kopiowania. Użyj polecenia Get Blob Properties (Pobierz właściwości obiektu blob), aby sprawdzić stan tej operacji kopiowania lub przekazać polecenie Abort Copy Blob (Abort Copy Blob), aby przerwać oczekującą kopię.
copyProgress	Zawiera liczbę skopiowanych bajtów i łączną liczbę bajtów w źródle w ostatniej próbie operacji kopiowania obiektu blob, w której ten obiekt blob był docelowym obiektem blob. Może pokazywać skopiowane bajty z zakresu od 0 do wartości Content-Length. Ten nagłówek nie jest wyświetlany, jeśli ten obiekt blob nigdy nie był miejscem docelowym operacji kopiowania obiektu blob lub jeśli ten obiekt blob został zmodyfikowany po zakończeniu operacji kopiowania obiektu blob przy użyciu ustawiania właściwości obiektu blob, umieszczania obiektu blob lub umieszczania listy blokowej
copySource	Adres URL o długości do 2 KB, który określa źródłowy obiekt blob lub plik używany w ostatniej próbie operacji kopiowania obiektu blob, gdzie ten obiekt blob był docelowym obiektem blob. Ten nagłówek nie jest wyświetlany, jeśli ten obiekt blob nigdy nie był miejscem docelowym operacji kopiowania obiektu blob lub jeśli ten obiekt blob został zmodyfikowany po zakończonej operacji kopiowania obiektu blob przy użyciu ustawiania właściwości obiektu blob, umieszczania obiektu blob lub umieszczania listy blokowej.
copyStatus	Stan operacji kopiowania zidentyfikowany przez x-ms-copy-id.
copyStatusDescription	Pojawia się tylko wtedy, gdy stan x-ms-copy-failed lub pending. Opisuje przyczynę ostatniej krytycznej lub niekrytycznej operacji kopiowania. Ten nagłówek nie jest wyświetlany, jeśli ten obiekt blob nigdy nie był miejscem docelowym operacji kopiowania obiektu blob lub jeśli ten obiekt blob został zmodyfikowany po zakończeniu operacji kopiowania obiektu blob przy użyciu ustawiania właściwości obiektu blob, umieszczania obiektu blob lub umieszczania listy blokowej
date	Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę, o której zainicjowano odpowiedź
encryptionKeySha256	Skrót SHA-256 klucza szyfrowania używany do szyfrowania obiektu blob. Ten nagłówek jest zwracany tylko wtedy, gdy obiekt blob został zaszyfrowany przy użyciu klucza dostarczonego przez klienta.
encryptionScope	Zwraca nazwę zakresu szyfrowania używanego do szyfrowania zawartości obiektu blob i metadanych aplikacji. Należy pamiętać, że brak tego nagłówka oznacza użycie domyślnego zakresu szyfrowania konta.
errorCode	Kod błędu
etag	Element ETag zawiera wartość, której można użyć do warunkowego wykonywania operacji. Jeśli wersja żądania to 2011-08-18 lub nowsza, wartość ETag będzie w cudzysłowie.
immutabilityPolicyExpiresOn	Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę wygaśnięcia zasad niezmienności obiektów blob.
immutabilityPolicyMode	Wskazuje tryb zasad niezmienności.
isCurrentVersion	Wartość tego nagłówka wskazuje, czy wersja tego obiektu blob jest bieżącą wersją, zobacz również nagłówek x-ms-version-id.
isSealed	Jeśli ten obiekt blob został zapieczętowany
isServerEncrypted	Wartość tego nagłówka jest ustawiona na wartość true, jeśli dane obiektu blob i metadane aplikacji są całkowicie szyfrowane przy użyciu określonego algorytmu. W przeciwnym razie wartość jest ustawiona na false (gdy obiekt blob jest niezaszyfrowany lub jeśli zaszyfrowane są tylko części metadanych obiektu blob/aplikacji).
lastAccessed	Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę ostatniego odczytu lub zapisu obiektu blob
lastModified	Zwraca datę i godzinę ostatniej modyfikacji kontenera. Każda operacja modyfikując obiekt blob, w tym aktualizację metadanych lub właściwości obiektu blob, zmienia czas ostatniej modyfikacji obiektu blob.
leaseDuration	Gdy obiekt blob jest dzierżawiony, określa, czy dzierżawa ma nieskończony, czy stały czas trwania.
leaseState	Stan dzierżawy obiektu blob.
leaseStatus	Bieżący stan dzierżawy obiektu blob.
legalHold	Wskazuje, czy na obiekcie blob znajduje się archiwizacja ze względów prawnych.
metadata
objectReplicationPolicyId	Fakultatywny. Prawidłowe tylko wtedy, gdy replikacja obiektów jest włączona dla kontenera magazynu i docelowego obiektu blob replikacji.
objectReplicationRules	Fakultatywny. Prawidłowe tylko wtedy, gdy replikacja obiektów jest włączona dla kontenera magazynu i źródłowego obiektu blob replikacji. Podczas pobierania tego nagłówka zostanie zwrócony nagłówek z identyfikatorem zasad i identyfikatorem reguły (np. x-ms-or-policyid_ruleid), a wartość będzie stanem replikacji (np. ukończenie, niepowodzenie).
requestId	Ten nagłówek jednoznacznie identyfikuje żądanie, które zostało wykonane i może służyć do rozwiązywania problemów z żądaniem.
tagCount	Liczba tagów skojarzonych z obiektem blob
version	Wskazuje wersję usługi Blob Service używaną do wykonania żądania. Ten nagłówek jest zwracany dla żądań wysyłanych w wersji 2009-09-19 lub nowszej.
versionId	Wartość DateTime zwrócona przez usługę, która jednoznacznie identyfikuje obiekt blob. Wartość tego nagłówka wskazuje wersję obiektu blob i może być używana w kolejnych żądaniach dostępu do tej wersji obiektu blob.

Szczegóły właściwości

acceptRanges

Wskazuje, że usługa obsługuje żądania częściowej zawartości obiektu blob.

acceptRanges?: string

Wartość właściwości

string

blobCommittedBlockCount

Liczba zatwierdzonych bloków znajdujących się w obiekcie blob. Ten nagłówek jest zwracany tylko dla uzupełnialnych obiektów blob.

blobCommittedBlockCount?: number

Wartość właściwości

number

blobContentMD5

Jeśli obiekt blob ma skrót MD5, a żądanie zawiera nagłówek zakresu (Zakres lub x-ms-range), ten nagłówek odpowiedzi jest zwracany z wartością wartości MD5 całego obiektu blob. Ta wartość może być równa wartości zwracanej w nagłówku Content-MD5, a ta ostatnia jest obliczana z żądanego zakresu

blobContentMD5?: Uint8Array

Wartość właściwości

Uint8Array

blobSequenceNumber

Bieżący numer sekwencji stronicowego obiektu blob. Ten nagłówek nie jest zwracany dla blokowych obiektów blob ani uzupełnialnych obiektów blob

blobSequenceNumber?: number

Wartość właściwości

number

blobType

Typ obiektu blob.

blobType?: BlobType

Wartość właściwości

BlobType

cacheControl

Ten nagłówek jest zwracany, jeśli został wcześniej określony dla obiektu blob.

cacheControl?: string

Wartość właściwości

string

clientRequestId

Jeśli w żądaniu zostanie wysłany nagłówek identyfikatora żądania klienta, ten nagłówek będzie obecny w odpowiedzi o tej samej wartości.

clientRequestId?: string

Wartość właściwości

string

contentCrc64

Jeśli żądanie ma odczytać określony zakres, a x-ms-range-get-content-crc64 ma wartość true, żądanie zwraca wartość crc64 dla zakresu, o ile rozmiar zakresu jest mniejszy lub równy 4 MB. Jeśli oba pliki x-ms-range-get-content-crc64 & x-ms-range-get-content-md5 zostaną określone w tym samym żądaniu, zakończy się niepowodzeniem z błędem 400(Nieprawidłowe żądanie).

contentCrc64?: Uint8Array

Wartość właściwości

Uint8Array

contentDisposition

Ten nagłówek zwraca wartość, która została określona dla nagłówka "x-ms-blob-content-disposition". Pole nagłówek odpowiedzi Content-Disposition przekazuje dodatkowe informacje o sposobie przetwarzania ładunku odpowiedzi, a także może służyć do dołączania dodatkowych metadanych. Jeśli na przykład ustawiono wartość załącznika, oznacza to, że agent-użytkownik nie powinien wyświetlać odpowiedzi, ale zamiast tego wyświetli okno dialogowe Zapisz jako z nazwą inną niż określona nazwa obiektu blob.

contentDisposition?: string

Wartość właściwości

string

contentEncoding

Ten nagłówek zwraca wartość, która została określona dla nagłówka żądania Content-Encoding

contentEncoding?: string

Wartość właściwości

string

contentLanguage

Ten nagłówek zwraca wartość, która została określona dla nagłówka żądania Content-Language.

contentLanguage?: string

Wartość właściwości

string

contentLength

Liczba bajtów znajdujących się w treści odpowiedzi.

contentLength?: number

Wartość właściwości

number

contentMD5

Jeśli obiekt blob ma skrót MD5, a ta operacja polega na odczytaniu pełnego obiektu blob, ten nagłówek odpowiedzi zostanie zwrócony, aby klient mógł sprawdzić integralność zawartości komunikatu.

contentMD5?: Uint8Array

Wartość właściwości

Uint8Array

contentRange

Wskazuje zakres bajtów zwróconych w przypadku, gdy klient zażądał podzestawu obiektu blob, ustawiając nagłówek żądania "Zakres".

contentRange?: string

Wartość właściwości

string

contentType

Typ nośnika treści odpowiedzi. W przypadku pobierania obiektu blob jest to "application/octet-stream"

contentType?: string

Wartość właściwości

string

copyCompletedOn

Czas ostatniej próby skopiowania obiektu blob, w którym ten obiekt blob był docelowym obiektem blob. Ta wartość może określać czas ukończenia, przerwania lub nieudanej próby kopiowania. Ten nagłówek nie jest wyświetlany, jeśli kopia oczekuje, jeśli ten obiekt blob nigdy nie był miejscem docelowym operacji kopiowania obiektu blob lub jeśli ten obiekt blob został zmodyfikowany po zakończonej operacji kopiowania obiektu blob przy użyciu ustawiania właściwości obiektu blob, umieszczania obiektu blob lub umieszczania listy bloków.

copyCompletedOn?: Date

Wartość właściwości

Date

copyId

Identyfikator ciągu dla tej operacji kopiowania. Użyj polecenia Get Blob Properties (Pobierz właściwości obiektu blob), aby sprawdzić stan tej operacji kopiowania lub przekazać polecenie Abort Copy Blob (Abort Copy Blob), aby przerwać oczekującą kopię.

copyId?: string

Wartość właściwości

string

copyProgress

Zawiera liczbę skopiowanych bajtów i łączną liczbę bajtów w źródle w ostatniej próbie operacji kopiowania obiektu blob, w której ten obiekt blob był docelowym obiektem blob. Może pokazywać skopiowane bajty z zakresu od 0 do wartości Content-Length. Ten nagłówek nie jest wyświetlany, jeśli ten obiekt blob nigdy nie był miejscem docelowym operacji kopiowania obiektu blob lub jeśli ten obiekt blob został zmodyfikowany po zakończeniu operacji kopiowania obiektu blob przy użyciu ustawiania właściwości obiektu blob, umieszczania obiektu blob lub umieszczania listy blokowej

copyProgress?: string

Wartość właściwości

string

copySource

Adres URL o długości do 2 KB, który określa źródłowy obiekt blob lub plik używany w ostatniej próbie operacji kopiowania obiektu blob, gdzie ten obiekt blob był docelowym obiektem blob. Ten nagłówek nie jest wyświetlany, jeśli ten obiekt blob nigdy nie był miejscem docelowym operacji kopiowania obiektu blob lub jeśli ten obiekt blob został zmodyfikowany po zakończonej operacji kopiowania obiektu blob przy użyciu ustawiania właściwości obiektu blob, umieszczania obiektu blob lub umieszczania listy blokowej.

copySource?: string

Wartość właściwości

string

copyStatus

Stan operacji kopiowania zidentyfikowany przez x-ms-copy-id.

copyStatus?: CopyStatusType

Wartość właściwości

CopyStatusType

copyStatusDescription

Pojawia się tylko wtedy, gdy stan x-ms-copy-failed lub pending. Opisuje przyczynę ostatniej krytycznej lub niekrytycznej operacji kopiowania. Ten nagłówek nie jest wyświetlany, jeśli ten obiekt blob nigdy nie był miejscem docelowym operacji kopiowania obiektu blob lub jeśli ten obiekt blob został zmodyfikowany po zakończeniu operacji kopiowania obiektu blob przy użyciu ustawiania właściwości obiektu blob, umieszczania obiektu blob lub umieszczania listy blokowej

copyStatusDescription?: string

Wartość właściwości

string

date

Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę, o której zainicjowano odpowiedź

date?: Date

Wartość właściwości

Date

encryptionKeySha256

Skrót SHA-256 klucza szyfrowania używany do szyfrowania obiektu blob. Ten nagłówek jest zwracany tylko wtedy, gdy obiekt blob został zaszyfrowany przy użyciu klucza dostarczonego przez klienta.

encryptionKeySha256?: string

Wartość właściwości

string

encryptionScope

Zwraca nazwę zakresu szyfrowania używanego do szyfrowania zawartości obiektu blob i metadanych aplikacji. Należy pamiętać, że brak tego nagłówka oznacza użycie domyślnego zakresu szyfrowania konta.

encryptionScope?: string

Wartość właściwości

string

errorCode

Kod błędu

errorCode?: string

Wartość właściwości

string

etag

Element ETag zawiera wartość, której można użyć do warunkowego wykonywania operacji. Jeśli wersja żądania to 2011-08-18 lub nowsza, wartość ETag będzie w cudzysłowie.

etag?: string

Wartość właściwości

string

immutabilityPolicyExpiresOn

Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę wygaśnięcia zasad niezmienności obiektów blob.

immutabilityPolicyExpiresOn?: Date

Wartość właściwości

Date

immutabilityPolicyMode

Wskazuje tryb zasad niezmienności.

immutabilityPolicyMode?: BlobImmutabilityPolicyMode

Wartość właściwości

BlobImmutabilityPolicyMode

isCurrentVersion

Wartość tego nagłówka wskazuje, czy wersja tego obiektu blob jest bieżącą wersją, zobacz również nagłówek x-ms-version-id.

isCurrentVersion?: boolean

Wartość właściwości

boolean

isSealed

Jeśli ten obiekt blob został zapieczętowany

isSealed?: boolean

Wartość właściwości

boolean

isServerEncrypted

Wartość tego nagłówka jest ustawiona na wartość true, jeśli dane obiektu blob i metadane aplikacji są całkowicie szyfrowane przy użyciu określonego algorytmu. W przeciwnym razie wartość jest ustawiona na false (gdy obiekt blob jest niezaszyfrowany lub jeśli zaszyfrowane są tylko części metadanych obiektu blob/aplikacji).

isServerEncrypted?: boolean

Wartość właściwości

boolean

lastAccessed

Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę ostatniego odczytu lub zapisu obiektu blob

lastAccessed?: Date

Wartość właściwości

Date

lastModified

Zwraca datę i godzinę ostatniej modyfikacji kontenera. Każda operacja modyfikując obiekt blob, w tym aktualizację metadanych lub właściwości obiektu blob, zmienia czas ostatniej modyfikacji obiektu blob.

lastModified?: Date

Wartość właściwości

Date

leaseDuration

Gdy obiekt blob jest dzierżawiony, określa, czy dzierżawa ma nieskończony, czy stały czas trwania.

leaseDuration?: LeaseDurationType

Wartość właściwości

LeaseDurationType

leaseState

Stan dzierżawy obiektu blob.

leaseState?: LeaseStateType

Wartość właściwości

LeaseStateType

leaseStatus

Bieżący stan dzierżawy obiektu blob.

leaseStatus?: LeaseStatusType

Wartość właściwości

LeaseStatusType

legalHold

Wskazuje, czy na obiekcie blob znajduje się archiwizacja ze względów prawnych.

legalHold?: boolean

Wartość właściwości

boolean

metadata

metadata?: [key: string]: string

Wartość właściwości

[key: string]: string

objectReplicationPolicyId

Fakultatywny. Prawidłowe tylko wtedy, gdy replikacja obiektów jest włączona dla kontenera magazynu i docelowego obiektu blob replikacji.

objectReplicationPolicyId?: string

Wartość właściwości

string

objectReplicationRules

Fakultatywny. Prawidłowe tylko wtedy, gdy replikacja obiektów jest włączona dla kontenera magazynu i źródłowego obiektu blob replikacji. Podczas pobierania tego nagłówka zostanie zwrócony nagłówek z identyfikatorem zasad i identyfikatorem reguły (np. x-ms-or-policyid_ruleid), a wartość będzie stanem replikacji (np. ukończenie, niepowodzenie).

objectReplicationRules?: [key: string]: string

Wartość właściwości

[key: string]: string

requestId

Ten nagłówek jednoznacznie identyfikuje żądanie, które zostało wykonane i może służyć do rozwiązywania problemów z żądaniem.

requestId?: string

Wartość właściwości

string

tagCount

Liczba tagów skojarzonych z obiektem blob

tagCount?: number

Wartość właściwości

number

version

Wskazuje wersję usługi Blob Service używaną do wykonania żądania. Ten nagłówek jest zwracany dla żądań wysyłanych w wersji 2009-09-19 lub nowszej.

version?: string

Wartość właściwości

string

versionId

Wartość DateTime zwrócona przez usługę, która jednoznacznie identyfikuje obiekt blob. Wartość tego nagłówka wskazuje wersję obiektu blob i może być używana w kolejnych żądaniach dostępu do tej wersji obiektu blob.

versionId?: string

Wartość właściwości

string