FileGetPropertiesHeaders interface

Pakket:

@azure/storage-file-share

Hiermee definieert u headers voor File_getProperties bewerking.

Eigenschappen

cacheControl	Als de Cache-Control aanvraagheader eerder is ingesteld voor het bestand, wordt de Cache-Control waarde geretourneerd in deze header.
contentDisposition	Retourneert de waarde die is opgegeven voor de header x-ms-content-disposition en geeft aan hoe het antwoord moet worden verwerkt.
contentEncoding	Als de aanvraagheader content-encoding eerder is ingesteld voor het bestand, wordt de waarde Content-Encoding geretourneerd in deze header.
contentLanguage	Retourneert de waarde die is opgegeven voor de aanvraagheader Content-Language.
contentLength	De grootte van het bestand in bytes. Deze header retourneert de waarde van de 'x-ms-content-length'-header die bij het bestand is opgeslagen.
contentMD5	Als de Content-MD5-header is ingesteld voor het bestand, wordt de Content-MD5-antwoordheader geretourneerd, zodat de client kan controleren op integriteit van de berichtinhoud.
contentType	Het inhoudstype dat is opgegeven voor het bestand. Het standaardinhoudstype is 'application/octet-stream'
copyCompletedOn	Sluitingstijd van de laatste poging om bestand te kopiëren waarbij dit bestand het doelbestand was. Deze waarde kan het tijdstip opgeven van een voltooide, afgebroken of mislukte kopieerpoging.
copyId	Tekenreeks-id voor de laatste poging om bestand te kopiëren waarbij dit bestand het doelbestand was.
copyProgress	Bevat het aantal bytes dat is gekopieerd en het totale aantal bytes in de bron in de laatste poging bestand kopiëren waarbij dit bestand het doelbestand was. Kan tussen 0 en bytes met lengte van inhoud weergeven die zijn gekopieerd.
copySource	URL met een lengte van maximaal 2 kB die het bronbestand aangeeft dat is gebruikt in de laatste poging bestand kopiëren waarbij dit bestand het doelbestand was.
copyStatus	Status van de kopieerbewerking geïdentificeerd door 'x-ms-copy-id'.
copyStatusDescription	Wordt alleen weergegeven wanneer x-ms-copy-status mislukt of in behandeling is. Beschrijft de oorzaak van een fatale of niet-fatale kopieerbewerkingsfout.
date	Een UTC-datum/tijd-waarde die is gegenereerd door de service die het tijdstip aangeeft waarop het antwoord is gestart.
errorCode	Foutcode
etag	De ETag bevat een waarde die u kunt gebruiken om bewerkingen voorwaardelijk uit te voeren, tussen aanhalingstekens.
fileAttributes	Kenmerken die zijn ingesteld voor het bestand.
fileChangeOn	Wijzig de tijd voor het bestand.
fileCreatedOn	Aanmaaktijd voor het bestand.
fileId	De fileId van het bestand.
fileLastWriteOn	Laatste schrijftijd voor het bestand.
fileParentId	De bovenliggende fileId van het bestand.
filePermissionKey	Sleutel van de machtigingenset voor het bestand.
fileType	Retourneert het type Bestand. Gereserveerd voor toekomstig gebruik.
isServerEncrypted	De waarde van deze header wordt ingesteld op true als de bestandsgegevens en metagegevens van de toepassing volledig zijn versleuteld met behulp van het opgegeven algoritme. Anders wordt de waarde ingesteld op false (wanneer het bestand niet is versleuteld of als alleen delen van de metagegevens van het bestand/de toepassing zijn versleuteld).
lastModified	Retourneert de datum en tijd waarop het bestand voor het laatst is gewijzigd. De datumnotatie volgt RFC 1123. Elke bewerking die het bestand of de eigenschappen ervan wijzigt, wordt de laatste wijzigingstijd bijgewerkt.
leaseDuration	Wanneer een bestand wordt geleased, geeft u aan of de lease een oneindige of een vaste duur heeft.
leaseState	Leasestatus van het bestand.
leaseStatus	De huidige leasestatus van het bestand.
metadata	Een set naam-waardeparen die als door de gebruiker gedefinieerde metagegevens aan dit bestand zijn gekoppeld.
requestId	Deze header identificeert op unieke wijze de aanvraag die is gedaan en kan worden gebruikt voor het oplossen van problemen met de aanvraag.
version	Geeft de versie aan van de bestandsservice die wordt gebruikt om de aanvraag uit te voeren.

Eigenschapdetails

cacheControl

Als de Cache-Control aanvraagheader eerder is ingesteld voor het bestand, wordt de Cache-Control waarde geretourneerd in deze header.

cacheControl?: string

Waarde van eigenschap

string

contentDisposition

Retourneert de waarde die is opgegeven voor de header x-ms-content-disposition en geeft aan hoe het antwoord moet worden verwerkt.

contentDisposition?: string

Waarde van eigenschap

string

contentEncoding

Als de aanvraagheader content-encoding eerder is ingesteld voor het bestand, wordt de waarde Content-Encoding geretourneerd in deze header.

contentEncoding?: string

Waarde van eigenschap

string

contentLanguage

Retourneert de waarde die is opgegeven voor de aanvraagheader Content-Language.

contentLanguage?: string

Waarde van eigenschap

string

contentLength

De grootte van het bestand in bytes. Deze header retourneert de waarde van de 'x-ms-content-length'-header die bij het bestand is opgeslagen.

contentLength?: number

Waarde van eigenschap

number

contentMD5

Als de Content-MD5-header is ingesteld voor het bestand, wordt de Content-MD5-antwoordheader geretourneerd, zodat de client kan controleren op integriteit van de berichtinhoud.

contentMD5?: Uint8Array

Waarde van eigenschap

Uint8Array

contentType

Het inhoudstype dat is opgegeven voor het bestand. Het standaardinhoudstype is 'application/octet-stream'

contentType?: string

Waarde van eigenschap

string

copyCompletedOn

Sluitingstijd van de laatste poging om bestand te kopiëren waarbij dit bestand het doelbestand was. Deze waarde kan het tijdstip opgeven van een voltooide, afgebroken of mislukte kopieerpoging.

copyCompletedOn?: Date

Waarde van eigenschap

Date

copyId

Tekenreeks-id voor de laatste poging om bestand te kopiëren waarbij dit bestand het doelbestand was.

copyId?: string

Waarde van eigenschap

string

copyProgress

Bevat het aantal bytes dat is gekopieerd en het totale aantal bytes in de bron in de laatste poging bestand kopiëren waarbij dit bestand het doelbestand was. Kan tussen 0 en bytes met lengte van inhoud weergeven die zijn gekopieerd.

copyProgress?: string

Waarde van eigenschap

string

copySource

URL met een lengte van maximaal 2 kB die het bronbestand aangeeft dat is gebruikt in de laatste poging bestand kopiëren waarbij dit bestand het doelbestand was.

copySource?: string

Waarde van eigenschap

string

copyStatus

Status van de kopieerbewerking geïdentificeerd door 'x-ms-copy-id'.

copyStatus?: CopyStatusType

Waarde van eigenschap

CopyStatusType

copyStatusDescription

Wordt alleen weergegeven wanneer x-ms-copy-status mislukt of in behandeling is. Beschrijft de oorzaak van een fatale of niet-fatale kopieerbewerkingsfout.

copyStatusDescription?: string

Waarde van eigenschap

string

date

Een UTC-datum/tijd-waarde die is gegenereerd door de service die het tijdstip aangeeft waarop het antwoord is gestart.

date?: Date

Waarde van eigenschap

Date

errorCode

Foutcode

errorCode?: string

Waarde van eigenschap

string

etag

De ETag bevat een waarde die u kunt gebruiken om bewerkingen voorwaardelijk uit te voeren, tussen aanhalingstekens.

etag?: string

Waarde van eigenschap

string

fileAttributes

Kenmerken die zijn ingesteld voor het bestand.

fileAttributes?: string

Waarde van eigenschap

string

fileChangeOn

Wijzig de tijd voor het bestand.

fileChangeOn?: Date

Waarde van eigenschap

Date

fileCreatedOn

Aanmaaktijd voor het bestand.

fileCreatedOn?: Date

Waarde van eigenschap

Date

fileId

De fileId van het bestand.

fileId?: string

Waarde van eigenschap

string

fileLastWriteOn

Laatste schrijftijd voor het bestand.

fileLastWriteOn?: Date

Waarde van eigenschap

Date

fileParentId

De bovenliggende fileId van het bestand.

fileParentId?: string

Waarde van eigenschap

string

filePermissionKey

Sleutel van de machtigingenset voor het bestand.

filePermissionKey?: string

Waarde van eigenschap

string

fileType

Retourneert het type Bestand. Gereserveerd voor toekomstig gebruik.

fileType?: string

Waarde van eigenschap

string

isServerEncrypted

De waarde van deze header wordt ingesteld op true als de bestandsgegevens en metagegevens van de toepassing volledig zijn versleuteld met behulp van het opgegeven algoritme. Anders wordt de waarde ingesteld op false (wanneer het bestand niet is versleuteld of als alleen delen van de metagegevens van het bestand/de toepassing zijn versleuteld).

isServerEncrypted?: boolean

Waarde van eigenschap

boolean

lastModified

Retourneert de datum en tijd waarop het bestand voor het laatst is gewijzigd. De datumnotatie volgt RFC 1123. Elke bewerking die het bestand of de eigenschappen ervan wijzigt, wordt de laatste wijzigingstijd bijgewerkt.

lastModified?: Date

Waarde van eigenschap

Date

leaseDuration

Wanneer een bestand wordt geleased, geeft u aan of de lease een oneindige of een vaste duur heeft.

leaseDuration?: LeaseDurationType

Waarde van eigenschap

LeaseDurationType

leaseState

Leasestatus van het bestand.

leaseState?: LeaseStateType

Waarde van eigenschap

LeaseStateType

leaseStatus

De huidige leasestatus van het bestand.

leaseStatus?: LeaseStatusType

Waarde van eigenschap

LeaseStatusType

metadata

Een set naam-waardeparen die als door de gebruiker gedefinieerde metagegevens aan dit bestand zijn gekoppeld.

metadata?: {[propertyName: string]: string}

Waarde van eigenschap

{[propertyName: string]: string}

requestId

Deze header identificeert op unieke wijze de aanvraag die is gedaan en kan worden gebruikt voor het oplossen van problemen met de aanvraag.

requestId?: string

Waarde van eigenschap

string

version

Geeft de versie aan van de bestandsservice die wordt gebruikt om de aanvraag uit te voeren.

version?: string

Waarde van eigenschap

string