FileCreateOptions interface

Pakket:

@azure/storage-file-share

Opties voor het configureren van de het maken van bewerking.

Uitbreiding

FileAndDirectoryCreateCommonOptions,CommonOptions

Eigenschappen

abortSignal	Een implementatie van de AbortSignalLike-interface om de aanvraag te signaleren om de bewerking te annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.
content	Initiële gegevens.
contentChecksumAlgorithm	Opties om aan te geven welk algoritme gebruikt moet worden voor contentvalidatie bij het uploaden.
contentLength	Hiermee geeft u het aantal bytes dat wordt verzonden in de aanvraagbody. Wanneer de inhoud op NULL is gezet, moet de waarde van deze header op nul worden gezet.
contentMD5	Een MD5-hash van de inhoud. Deze hash wordt gebruikt om de integriteit van de gegevens tijdens het transport te controleren. Wanneer de header Content-MD5 is opgegeven, vergelijkt de File-service de hash van de inhoud die is aangekomen met de headerwaarde die is verzonden. Als de twee hashes niet overeenkomen, mislukt de bewerking met foutcode 400 (Ongeldige aanvraag).
fileHttpHeaders	HTTP-headers van bestanden, zoals Inhoudstype.
leaseAccessConditions	Voorwaarden voor leasetoegang.
metadata	Een verzameling sleutel-waardetekenreekspaar dat moet worden gekoppeld aan het bestandsopslagobject.
onProgress	Voortgang bij het bijwerken van gebeurtenis-handler.

Overgenomen eigenschappen

changeTime	De eigenschap Coordinated Universal Time (UTC) wijzigt tijd voor de map. Een waarde van nu kan worden gebruikt om de tijd van de aanvraag aan te geven. Standaard wordt de waarde ingesteld op het tijdstip van de aanvraag.
creationTime	De eigenschap Coordinated Universal Time (UTC) voor het maken van tijd voor de directory. Een waarde van nu kan worden gebruikt om de tijd van de aanvraag aan te geven. Standaard wordt de waarde ingesteld zoals nu.
fileAttributes	De bestandssysteemkenmerken die moeten worden ingesteld voor het bestand of de map.
filePermission	De machtiging (beveiligingsdescriptor) die moet worden ingesteld voor het bestand of de map in de SECURITY Descriptor Definition Language (SDDL) of binair bestand. Indien opgegeven, moet deze een eigenaar, groep en discretionaire toegangsbeheerlijst (DACL) hebben. Een waarde van overname kan worden doorgegeven om over te nemen van de bovenliggende map. Houd er rekening mee dat slechts één van filePermission of filePermissionKey kan worden opgegeven. En als beide niet zijn opgegeven, wordt overname ingesteld op filePermission als standaardwaarde per clientbibliotheek.
filePermissionFormat	Facultatief. Beschikbaar voor versie 2023-06-01 en hoger. Hiermee geeft u de indeling op waarin de machtiging wordt geretourneerd. Acceptabele waarden zijn SDDL of binair. Als x-ms-file-permission-format niet is opgegeven of expliciet is ingesteld op SDDL, wordt de machtiging geretourneerd in SDDL-indeling. Als x-ms-file-permission-format expliciet is ingesteld op binair, wordt de machtiging geretourneerd als een base64-tekenreeks die de binaire codering van de machtiging vertegenwoordigt
filePermissionKey	De sleutel van de machtiging die moet worden ingesteld voor het bestand of de map. Dit kan worden gemaakt met behulp van de Create-Permission-API. Houd er rekening mee dat slechts één van filePermission of filePermissionKey kan worden opgegeven.
lastWriteTime	De laatste schrijfeigenschap utc (Coordinated Universal Time) voor de map. Een waarde van nu kan worden gebruikt om de tijd van de aanvraag aan te geven. Standaard wordt de waarde ingesteld zoals nu.
posixProperties	Optionele eigenschappen die moeten worden ingesteld voor NFS-bestanden. Houd er rekening mee dat deze eigenschap alleen van toepassing is op bestanden die zijn gemaakt in NFS-shares.
tracingOptions

Eigenschapdetails

abortSignal

Een implementatie van de AbortSignalLike-interface om de aanvraag te signaleren om de bewerking te annuleren. Gebruik bijvoorbeeld de @azure/abort-controller om een AbortSignalte maken.

abortSignal?: AbortSignalLike

Waarde van eigenschap

AbortSignalLike

content

Initiële gegevens.

content?: RequestBodyType

Waarde van eigenschap

HttpRequestBody

contentChecksumAlgorithm

Opties om aan te geven welk algoritme gebruikt moet worden voor contentvalidatie bij het uploaden.

contentChecksumAlgorithm?: StorageChecksumAlgorithm

Waarde van eigenschap

StorageChecksumAlgorithm

contentLength

Hiermee geeft u het aantal bytes dat wordt verzonden in de aanvraagbody. Wanneer de inhoud op NULL is gezet, moet de waarde van deze header op nul worden gezet.

contentLength?: number

Waarde van eigenschap

number

contentMD5

Een MD5-hash van de inhoud. Deze hash wordt gebruikt om de integriteit van de gegevens tijdens het transport te controleren. Wanneer de header Content-MD5 is opgegeven, vergelijkt de File-service de hash van de inhoud die is aangekomen met de headerwaarde die is verzonden. Als de twee hashes niet overeenkomen, mislukt de bewerking met foutcode 400 (Ongeldige aanvraag).

contentMD5?: Uint8Array

Waarde van eigenschap

Uint8Array

fileHttpHeaders

HTTP-headers van bestanden, zoals Inhoudstype.

fileHttpHeaders?: FileHttpHeaders

Waarde van eigenschap

FileHttpHeaders

leaseAccessConditions

Voorwaarden voor leasetoegang.

leaseAccessConditions?: LeaseAccessConditions

Waarde van eigenschap

LeaseAccessConditions

metadata

Een verzameling sleutel-waardetekenreekspaar dat moet worden gekoppeld aan het bestandsopslagobject.

metadata?: Metadata

Waarde van eigenschap

Metadata

onProgress

Voortgang bij het bijwerken van gebeurtenis-handler.

onProgress?: (progress: TransferProgressEvent) => void

Waarde van eigenschap

(progress: TransferProgressEvent) => void

Details van overgenomen eigenschap

changeTime

De eigenschap Coordinated Universal Time (UTC) wijzigt tijd voor de map. Een waarde van nu kan worden gebruikt om de tijd van de aanvraag aan te geven. Standaard wordt de waarde ingesteld op het tijdstip van de aanvraag.

changeTime?: Date | "now"

Waarde van eigenschap

Date | "now"

overgenomen vanFileAndDirectoryCreateCommonOptions.changeTime

creationTime

De eigenschap Coordinated Universal Time (UTC) voor het maken van tijd voor de directory. Een waarde van nu kan worden gebruikt om de tijd van de aanvraag aan te geven. Standaard wordt de waarde ingesteld zoals nu.

creationTime?: Date | "now"

Waarde van eigenschap

Date | "now"

overgenomen vanFileAndDirectoryCreateCommonOptions.creationTime

fileAttributes

De bestandssysteemkenmerken die moeten worden ingesteld voor het bestand of de map.

fileAttributes?: FileSystemAttributes

Waarde van eigenschap

FileSystemAttributes

overgenomen vanFileAndDirectoryCreateCommonOptions.fileAttributes

filePermission

De machtiging (beveiligingsdescriptor) die moet worden ingesteld voor het bestand of de map in de SECURITY Descriptor Definition Language (SDDL) of binair bestand. Indien opgegeven, moet deze een eigenaar, groep en discretionaire toegangsbeheerlijst (DACL) hebben. Een waarde van overname kan worden doorgegeven om over te nemen van de bovenliggende map.

Houd er rekening mee dat slechts één van filePermission of filePermissionKey kan worden opgegeven. En als beide niet zijn opgegeven, wordt overname ingesteld op filePermission als standaardwaarde per clientbibliotheek.

filePermission?: string

Waarde van eigenschap

string

overgenomen vanFileAndDirectoryCreateCommonOptions.filePermission-

filePermissionFormat

Facultatief. Beschikbaar voor versie 2023-06-01 en hoger. Hiermee geeft u de indeling op waarin de machtiging wordt geretourneerd. Acceptabele waarden zijn SDDL of binair. Als x-ms-file-permission-format niet is opgegeven of expliciet is ingesteld op SDDL, wordt de machtiging geretourneerd in SDDL-indeling. Als x-ms-file-permission-format expliciet is ingesteld op binair, wordt de machtiging geretourneerd als een base64-tekenreeks die de binaire codering van de machtiging vertegenwoordigt

filePermissionFormat?: FilePermissionFormat

Waarde van eigenschap

FilePermissionFormat

overgenomen vanFileAndDirectoryCreateCommonOptions.filePermissionFormat

filePermissionKey

De sleutel van de machtiging die moet worden ingesteld voor het bestand of de map. Dit kan worden gemaakt met behulp van de Create-Permission-API.

Houd er rekening mee dat slechts één van filePermission of filePermissionKey kan worden opgegeven.

filePermissionKey?: string

Waarde van eigenschap

string

overgenomen vanFileAndDirectoryCreateCommonOptions.filePermissionKey

lastWriteTime

De laatste schrijfeigenschap utc (Coordinated Universal Time) voor de map. Een waarde van nu kan worden gebruikt om de tijd van de aanvraag aan te geven. Standaard wordt de waarde ingesteld zoals nu.

lastWriteTime?: Date | "now"

Waarde van eigenschap

Date | "now"

overgenomen vanFileAndDirectoryCreateCommonOptions.lastWriteTime

posixProperties

Optionele eigenschappen die moeten worden ingesteld voor NFS-bestanden. Houd er rekening mee dat deze eigenschap alleen van toepassing is op bestanden die zijn gemaakt in NFS-shares.

posixProperties?: FilePosixProperties

Waarde van eigenschap

FilePosixProperties

overgenomen vanFileAndDirectoryCreateCommonOptions.posixProperties

tracingOptions

tracingOptions?: OperationTracingOptions

Waarde van eigenschap

OperationTracingOptions

overgenomen vanCommonOptions.tracingOptions-