File class
Klass som representerar en fil.
Konstruktorer
| File(Storage |
Skapa en fil. |
Metoder
Konstruktorinformation
File(StorageClientContext)
Skapa en fil.
new File(client: StorageClientContext)
Parametrar
- client
- StorageClientContext
Referens till tjänstklienten.
Metodinformation
abortCopy(string, FileAbortCopyOptionalParams, ServiceCallback<void>)
function abortCopy(copyId: string, options: FileAbortCopyOptionalParams, callback: ServiceCallback<void>)
Parametrar
- copyId
-
string
Kopieringsidentifieraren som anges i rubriken x-ms-copy-id för den ursprungliga kopieringsfilen.
- options
- FileAbortCopyOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
abortCopy(string, Models.FileAbortCopyOptionalParams)
Avbryter en väntande kopieringsfilåtgärd och lämnar en målfil med noll längd och fullständiga metadata.
function abortCopy(copyId: string, options?: Models.FileAbortCopyOptionalParams)
Parametrar
- copyId
-
string
Kopieringsidentifieraren som anges i rubriken x-ms-copy-id för den ursprungliga kopieringsfilen.
- options
- Models.FileAbortCopyOptionalParams
Returer
Promise<Models.FileAbortCopyResponse>
Löfte<Models.FileAbortCopyResponse>
abortCopy(string, ServiceCallback<void>)
function abortCopy(copyId: string, callback: ServiceCallback<void>)
Parametrar
- copyId
-
string
Kopieringsidentifieraren som anges i rubriken x-ms-copy-id för den ursprungliga kopieringsfilen.
- callback
-
ServiceCallback<void>
Återanropet
create(number, string, string, string, FileCreateOptionalParams, ServiceCallback<void>)
function create(fileContentLength: number, fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options: FileCreateOptionalParams, callback: ServiceCallback<void>)
Parametrar
- fileContentLength
-
number
Anger den maximala storleken för filen, upp till 1 TB.
- fileAttributes
-
string
Om det anges ska de angivna filattributen anges. Standardvärde: Arkiv för fil och katalog för katalog. "Ingen" kan också anges som standard.
- fileCreationTime
-
string
Skapandetid för filen/katalogen.
- fileLastWriteTime
-
string
Senaste skrivtid för filen/katalogen.
- options
- FileCreateOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
create(number, string, string, string, Models.FileCreateOptionalParams)
Skapar en ny fil eller ersätter en fil. Observera att den endast initierar filen utan innehåll.
function create(fileContentLength: number, fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options?: Models.FileCreateOptionalParams)
Parametrar
- fileContentLength
-
number
Anger den maximala storleken för filen, upp till 1 TB.
- fileAttributes
-
string
Om det anges ska de angivna filattributen anges. Standardvärde: Arkiv för fil och katalog för katalog. "Ingen" kan också anges som standard.
- fileCreationTime
-
string
Skapandetid för filen/katalogen.
- fileLastWriteTime
-
string
Senaste skrivtid för filen/katalogen.
- options
- Models.FileCreateOptionalParams
Returer
Promise<Models.FileCreateResponse>
Löfte<Models.FileCreateResponse>
create(number, string, string, string, ServiceCallback<void>)
function create(fileContentLength: number, fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, callback: ServiceCallback<void>)
Parametrar
- fileContentLength
-
number
Anger den maximala storleken för filen, upp till 1 TB.
- fileAttributes
-
string
Om det anges ska de angivna filattributen anges. Standardvärde: Arkiv för fil och katalog för katalog. "Ingen" kan också anges som standard.
- fileCreationTime
-
string
Skapandetid för filen/katalogen.
- fileLastWriteTime
-
string
Senaste skrivtid för filen/katalogen.
- callback
-
ServiceCallback<void>
Återanropet
deleteMethod(FileDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(options: FileDeleteMethodOptionalParams, callback: ServiceCallback<void>)
Parametrar
- options
- FileDeleteMethodOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
deleteMethod(Models.FileDeleteMethodOptionalParams)
tar bort filen från lagringskontot.
function deleteMethod(options?: Models.FileDeleteMethodOptionalParams)
Parametrar
- options
- Models.FileDeleteMethodOptionalParams
Returer
Promise<Models.FileDeleteResponse>
Löfte<Models.FileDeleteResponse>
deleteMethod(ServiceCallback<void>)
function deleteMethod(callback: ServiceCallback<void>)
Parametrar
- callback
-
ServiceCallback<void>
Återanropet
download(FileDownloadOptionalParams, ServiceCallback<void>)
function download(options: FileDownloadOptionalParams, callback: ServiceCallback<void>)
Parametrar
- options
- FileDownloadOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
download(Models.FileDownloadOptionalParams)
Läser eller laddar ned en fil från systemet, inklusive dess metadata och egenskaper.
function download(options?: Models.FileDownloadOptionalParams)
Parametrar
- options
- Models.FileDownloadOptionalParams
Returer
Promise<Models.FileDownloadResponse>
Löfte<Models.FileDownloadResponse>
download(ServiceCallback<void>)
function download(callback: ServiceCallback<void>)
Parametrar
- callback
-
ServiceCallback<void>
Återanropet
forceCloseHandles(string, FileForceCloseHandlesOptionalParams, ServiceCallback<void>)
function forceCloseHandles(handleId: string, options: FileForceCloseHandlesOptionalParams, callback: ServiceCallback<void>)
Parametrar
- handleId
-
string
Anger handtags-ID som öppnas på filen eller katalogen som ska stängas. Asterix ('*') är ett jokertecken som anger alla referenser.
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
forceCloseHandles(string, Models.FileForceCloseHandlesOptionalParams)
Stänger alla referenser öppna för angiven fil
function forceCloseHandles(handleId: string, options?: Models.FileForceCloseHandlesOptionalParams)
Parametrar
- handleId
-
string
Anger handtags-ID som öppnas på filen eller katalogen som ska stängas. Asterix ('*') är ett jokertecken som anger alla referenser.
- options
- Models.FileForceCloseHandlesOptionalParams
Returer
Promise<Models.FileForceCloseHandlesResponse>
Löfte<Models.FileForceCloseHandlesResponse>
forceCloseHandles(string, ServiceCallback<void>)
function forceCloseHandles(handleId: string, callback: ServiceCallback<void>)
Parametrar
- handleId
-
string
Anger handtags-ID som öppnas på filen eller katalogen som ska stängas. Asterix ('*') är ett jokertecken som anger alla referenser.
- callback
-
ServiceCallback<void>
Återanropet
getProperties(FileGetPropertiesOptionalParams, ServiceCallback<void>)
function getProperties(options: FileGetPropertiesOptionalParams, callback: ServiceCallback<void>)
Parametrar
- options
- FileGetPropertiesOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
getProperties(Models.FileGetPropertiesOptionalParams)
Returnerar alla användardefinierade metadata, http-standardegenskaper och systemegenskaper för filen. Det returnerar inte innehållet i filen.
function getProperties(options?: Models.FileGetPropertiesOptionalParams)
Parametrar
- options
- Models.FileGetPropertiesOptionalParams
Returer
Promise<Models.FileGetPropertiesResponse>
Löfte<Models.FileGetPropertiesResponse>
getProperties(ServiceCallback<void>)
function getProperties(callback: ServiceCallback<void>)
Parametrar
- callback
-
ServiceCallback<void>
Återanropet
getRangeList(FileGetRangeListOptionalParams, ServiceCallback<Range[]>)
function getRangeList(options: FileGetRangeListOptionalParams, callback: ServiceCallback<Range[]>)
Parametrar
- options
- FileGetRangeListOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<Range[]>
Återanropet
getRangeList(Models.FileGetRangeListOptionalParams)
Returnerar listan över giltiga intervall för en fil.
function getRangeList(options?: Models.FileGetRangeListOptionalParams)
Parametrar
- options
- Models.FileGetRangeListOptionalParams
Returer
Promise<Models.FileGetRangeListResponse>
Löfte<Models.FileGetRangeListResponse>
getRangeList(ServiceCallback<Range[]>)
function getRangeList(callback: ServiceCallback<Range[]>)
Parametrar
- callback
-
ServiceCallback<Range[]>
Återanropet
listHandles(FileListHandlesOptionalParams, ServiceCallback<ListHandlesResponse>)
function listHandles(options: FileListHandlesOptionalParams, callback: ServiceCallback<ListHandlesResponse>)
Parametrar
- options
- FileListHandlesOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<ListHandlesResponse>
Återanropet
listHandles(Models.FileListHandlesOptionalParams)
Listreferenser för fil
function listHandles(options?: Models.FileListHandlesOptionalParams)
Parametrar
- options
- Models.FileListHandlesOptionalParams
Returer
Promise<Models.FileListHandlesResponse>
Löfte<Models.FileListHandlesResponse>
listHandles(ServiceCallback<ListHandlesResponse>)
function listHandles(callback: ServiceCallback<ListHandlesResponse>)
Parametrar
- callback
-
ServiceCallback<ListHandlesResponse>
Återanropet
setHTTPHeaders(string, string, string, FileSetHTTPHeadersOptionalParams, ServiceCallback<void>)
function setHTTPHeaders(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options: FileSetHTTPHeadersOptionalParams, callback: ServiceCallback<void>)
Parametrar
- fileAttributes
-
string
Om det anges ska de angivna filattributen anges. Standardvärde: Arkiv för fil och katalog för katalog. "Ingen" kan också anges som standard.
- fileCreationTime
-
string
Skapandetid för filen/katalogen.
- fileLastWriteTime
-
string
Senaste skrivtid för filen/katalogen.
- options
- FileSetHTTPHeadersOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
setHTTPHeaders(string, string, string, Models.FileSetHTTPHeadersOptionalParams)
Anger HTTP-huvuden på filen.
function setHTTPHeaders(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, options?: Models.FileSetHTTPHeadersOptionalParams)
Parametrar
- fileAttributes
-
string
Om det anges ska de angivna filattributen anges. Standardvärde: Arkiv för fil och katalog för katalog. "Ingen" kan också anges som standard.
- fileCreationTime
-
string
Skapandetid för filen/katalogen.
- fileLastWriteTime
-
string
Senaste skrivtid för filen/katalogen.
- options
- Models.FileSetHTTPHeadersOptionalParams
Returer
Promise<Models.FileSetHTTPHeadersResponse>
Löfte<Models.FileSetHTTPHeadersResponse>
setHTTPHeaders(string, string, string, ServiceCallback<void>)
function setHTTPHeaders(fileAttributes: string, fileCreationTime: string, fileLastWriteTime: string, callback: ServiceCallback<void>)
Parametrar
- fileAttributes
-
string
Om det anges ska de angivna filattributen anges. Standardvärde: Arkiv för fil och katalog för katalog. "Ingen" kan också anges som standard.
- fileCreationTime
-
string
Skapandetid för filen/katalogen.
- fileLastWriteTime
-
string
Senaste skrivtid för filen/katalogen.
- callback
-
ServiceCallback<void>
Återanropet
setMetadata(FileSetMetadataOptionalParams, ServiceCallback<void>)
function setMetadata(options: FileSetMetadataOptionalParams, callback: ServiceCallback<void>)
Parametrar
- options
- FileSetMetadataOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
setMetadata(Models.FileSetMetadataOptionalParams)
Uppdaterar användardefinierade metadata för den angivna filen.
function setMetadata(options?: Models.FileSetMetadataOptionalParams)
Parametrar
- options
- Models.FileSetMetadataOptionalParams
Returer
Promise<Models.FileSetMetadataResponse>
Löfte<Models.FileSetMetadataResponse>
setMetadata(ServiceCallback<void>)
function setMetadata(callback: ServiceCallback<void>)
Parametrar
- callback
-
ServiceCallback<void>
Återanropet
startCopy(string, FileStartCopyOptionalParams, ServiceCallback<void>)
function startCopy(copySource: string, options: FileStartCopyOptionalParams, callback: ServiceCallback<void>)
Parametrar
- copySource
-
string
Anger URL:en för källfilen eller bloben, upp till 2 kB. Om du vill kopiera en fil till en annan fil inom samma lagringskonto kan du använda delad nyckel för att autentisera källfilen. Om du kopierar en fil från ett annat lagringskonto, eller om du kopierar en blob från samma lagringskonto eller ett annat lagringskonto, måste du autentisera källfilen eller bloben med en signatur för delad åtkomst. Om källan är en offentlig blob krävs ingen autentisering för att utföra kopieringsåtgärden. En fil i en resursögonblicksbild kan också anges som en kopieringskälla.
- options
- FileStartCopyOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
startCopy(string, Models.FileStartCopyOptionalParams)
Kopierar en blob eller fil till en målfil i lagringskontot.
function startCopy(copySource: string, options?: Models.FileStartCopyOptionalParams)
Parametrar
- copySource
-
string
Anger URL:en för källfilen eller bloben, upp till 2 kB. Om du vill kopiera en fil till en annan fil inom samma lagringskonto kan du använda delad nyckel för att autentisera källfilen. Om du kopierar en fil från ett annat lagringskonto, eller om du kopierar en blob från samma lagringskonto eller ett annat lagringskonto, måste du autentisera källfilen eller bloben med en signatur för delad åtkomst. Om källan är en offentlig blob krävs ingen autentisering för att utföra kopieringsåtgärden. En fil i en resursögonblicksbild kan också anges som en kopieringskälla.
- options
- Models.FileStartCopyOptionalParams
Returer
Promise<Models.FileStartCopyResponse>
Löfte<Models.FileStartCopyResponse>
startCopy(string, ServiceCallback<void>)
function startCopy(copySource: string, callback: ServiceCallback<void>)
Parametrar
- copySource
-
string
Anger URL:en för källfilen eller bloben, upp till 2 kB. Om du vill kopiera en fil till en annan fil inom samma lagringskonto kan du använda delad nyckel för att autentisera källfilen. Om du kopierar en fil från ett annat lagringskonto, eller om du kopierar en blob från samma lagringskonto eller ett annat lagringskonto, måste du autentisera källfilen eller bloben med en signatur för delad åtkomst. Om källan är en offentlig blob krävs ingen autentisering för att utföra kopieringsåtgärden. En fil i en resursögonblicksbild kan också anges som en kopieringskälla.
- callback
-
ServiceCallback<void>
Återanropet
uploadRange(string, Models.FileRangeWriteType, number, FileUploadRangeOptionalParams, ServiceCallback<void>)
function uploadRange(range: string, fileRangeWrite: Models.FileRangeWriteType, contentLength: number, options: FileUploadRangeOptionalParams, callback: ServiceCallback<void>)
Parametrar
- range
-
string
Anger det intervall med byte som ska skrivas. Både början och slutet av intervallet måste anges. För en uppdateringsåtgärd kan intervallet vara upp till 4 MB stort. För en tydlig åtgärd kan intervallet vara upp till värdet för filens fulla storlek. Filtjänsten accepterar endast ett enda byteintervall för rubrikerna Intervall och X-ms-range, och byteintervallet måste anges i följande format: bytes=startByte-endByte.
- fileRangeWrite
- Models.FileRangeWriteType
Ange något av följande alternativ: – Uppdatera: Skriver byte som anges av begärandetexten till det angivna intervallet. Rubrikerna Intervall och Innehållslängd måste matcha för att utföra uppdateringen. – Rensa: Rensar det angivna intervallet och frigör det utrymme som används i lagringen för det intervallet. Om du vill rensa ett intervall anger du rubriken Innehållslängd till noll och ställer in områdesrubriken på ett värde som anger intervallet som ska rensas, upp till maximal filstorlek. Möjliga värden är: "update", "clear"
- contentLength
-
number
Anger antalet byte som överförs i begärandetexten. När rubriken x-ms-write är inställd på att rensas måste värdet för det här huvudet vara inställt på noll.
- options
- FileUploadRangeOptionalParams
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
uploadRange(string, Models.FileRangeWriteType, number, Models.FileUploadRangeOptionalParams)
Ladda upp ett intervall med byte till en fil.
function uploadRange(range: string, fileRangeWrite: Models.FileRangeWriteType, contentLength: number, options?: Models.FileUploadRangeOptionalParams)
Parametrar
- range
-
string
Anger det intervall med byte som ska skrivas. Både början och slutet av intervallet måste anges. För en uppdateringsåtgärd kan intervallet vara upp till 4 MB stort. För en tydlig åtgärd kan intervallet vara upp till värdet för filens fulla storlek. Filtjänsten accepterar endast ett enda byteintervall för rubrikerna Intervall och X-ms-range, och byteintervallet måste anges i följande format: bytes=startByte-endByte.
- fileRangeWrite
- Models.FileRangeWriteType
Ange något av följande alternativ: – Uppdatera: Skriver byte som anges av begärandetexten till det angivna intervallet. Rubrikerna Intervall och Innehållslängd måste matcha för att utföra uppdateringen. – Rensa: Rensar det angivna intervallet och frigör det utrymme som används i lagringen för det intervallet. Om du vill rensa ett intervall anger du rubriken Innehållslängd till noll och ställer in områdesrubriken på ett värde som anger intervallet som ska rensas, upp till maximal filstorlek. Möjliga värden är: "update", "clear"
- contentLength
-
number
Anger antalet byte som överförs i begärandetexten. När rubriken x-ms-write är inställd på att rensas måste värdet för det här huvudet vara inställt på noll.
- options
- Models.FileUploadRangeOptionalParams
Returer
Promise<Models.FileUploadRangeResponse>
Löfte<Models.FileUploadRangeResponse>
uploadRange(string, Models.FileRangeWriteType, number, ServiceCallback<void>)
function uploadRange(range: string, fileRangeWrite: Models.FileRangeWriteType, contentLength: number, callback: ServiceCallback<void>)
Parametrar
- range
-
string
Anger det intervall med byte som ska skrivas. Både början och slutet av intervallet måste anges. För en uppdateringsåtgärd kan intervallet vara upp till 4 MB stort. För en tydlig åtgärd kan intervallet vara upp till värdet för filens fulla storlek. Filtjänsten accepterar endast ett enda byteintervall för rubrikerna Intervall och X-ms-range, och byteintervallet måste anges i följande format: bytes=startByte-endByte.
- fileRangeWrite
- Models.FileRangeWriteType
Ange något av följande alternativ: – Uppdatera: Skriver byte som anges av begärandetexten till det angivna intervallet. Rubrikerna Intervall och Innehållslängd måste matcha för att utföra uppdateringen. – Rensa: Rensar det angivna intervallet och frigör det utrymme som används i lagringen för det intervallet. Om du vill rensa ett intervall anger du rubriken Innehållslängd till noll och ställer in områdesrubriken på ett värde som anger intervallet som ska rensas, upp till maximal filstorlek. Möjliga värden är: "update", "clear"
- contentLength
-
number
Anger antalet byte som överförs i begärandetexten. När rubriken x-ms-write är inställd på att rensas måste värdet för det här huvudet vara inställt på noll.
- callback
-
ServiceCallback<void>
Återanropet
uploadRangeFromURL(string, string, string, number, FileUploadRangeFromURLOptionalParams, ServiceCallback<void>)
function uploadRangeFromURL(range: string, copySource: string, sourceRange: string, contentLength: number, options: FileUploadRangeFromURLOptionalParams, callback: ServiceCallback<void>)
Parametrar
- range
-
string
Skriver data till det angivna byteintervallet i filen.
- copySource
-
string
Anger URL:en för källfilen eller bloben, upp till 2 kB. Om du vill kopiera en fil till en annan fil inom samma lagringskonto kan du använda delad nyckel för att autentisera källfilen. Om du kopierar en fil från ett annat lagringskonto, eller om du kopierar en blob från samma lagringskonto eller ett annat lagringskonto, måste du autentisera källfilen eller bloben med en signatur för delad åtkomst. Om källan är en offentlig blob krävs ingen autentisering för att utföra kopieringsåtgärden. En fil i en resursögonblicksbild kan också anges som en kopieringskälla.
- sourceRange
-
string
Byte av källdata i det angivna intervallet.
- contentLength
-
number
Anger antalet byte som överförs i begärandetexten. När rubriken x-ms-write är inställd på att rensas måste värdet för det här huvudet vara inställt på noll.
De valfria parametrarna
- callback
-
ServiceCallback<void>
Återanropet
uploadRangeFromURL(string, string, string, number, Models.FileUploadRangeFromURLOptionalParams)
Ladda upp ett intervall med byte till en fil där innehållet läse från en URL.
function uploadRangeFromURL(range: string, copySource: string, sourceRange: string, contentLength: number, options?: Models.FileUploadRangeFromURLOptionalParams)
Parametrar
- range
-
string
Skriver data till det angivna byteintervallet i filen.
- copySource
-
string
Anger URL:en för källfilen eller bloben, upp till 2 kB. Om du vill kopiera en fil till en annan fil inom samma lagringskonto kan du använda delad nyckel för att autentisera källfilen. Om du kopierar en fil från ett annat lagringskonto, eller om du kopierar en blob från samma lagringskonto eller ett annat lagringskonto, måste du autentisera källfilen eller bloben med en signatur för delad åtkomst. Om källan är en offentlig blob krävs ingen autentisering för att utföra kopieringsåtgärden. En fil i en resursögonblicksbild kan också anges som en kopieringskälla.
- sourceRange
-
string
Byte av källdata i det angivna intervallet.
- contentLength
-
number
Anger antalet byte som överförs i begärandetexten. När rubriken x-ms-write är inställd på att rensas måste värdet för det här huvudet vara inställt på noll.
- options
- Models.FileUploadRangeFromURLOptionalParams
Returer
Promise<Models.FileUploadRangeFromURLResponse>
Löfte<Models.FileUploadRangeFromURLResponse>
uploadRangeFromURL(string, string, string, number, ServiceCallback<void>)
function uploadRangeFromURL(range: string, copySource: string, sourceRange: string, contentLength: number, callback: ServiceCallback<void>)
Parametrar
- range
-
string
Skriver data till det angivna byteintervallet i filen.
- copySource
-
string
Anger URL:en för källfilen eller bloben, upp till 2 kB. Om du vill kopiera en fil till en annan fil inom samma lagringskonto kan du använda delad nyckel för att autentisera källfilen. Om du kopierar en fil från ett annat lagringskonto, eller om du kopierar en blob från samma lagringskonto eller ett annat lagringskonto, måste du autentisera källfilen eller bloben med en signatur för delad åtkomst. Om källan är en offentlig blob krävs ingen autentisering för att utföra kopieringsåtgärden. En fil i en resursögonblicksbild kan också anges som en kopieringskälla.
- sourceRange
-
string
Byte av källdata i det angivna intervallet.
- contentLength
-
number
Anger antalet byte som överförs i begärandetexten. När rubriken x-ms-write är inställd på att rensas måste värdet för det här huvudet vara inställt på noll.
- callback
-
ServiceCallback<void>
Återanropet