Udostępnij za pośrednictwem


ShareFileClient class

Obiekt ShareFileClient reprezentuje adres URL pliku usługi Azure Storage.

Rozszerzenie

StorageClient

Konstruktory

ShareFileClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Tworzy wystąpienie klasy ShareFileClient.

ShareFileClient(string, Pipeline, ShareClientConfig)

Tworzy wystąpienie klasy ShareFileClient.

Właściwości

name

Nazwa pliku

path

Pełna ścieżka pliku

shareName

Nazwa udziału odpowiadająca temu klientowi plików

Właściwości dziedziczone

accountName
url

Wartość ciągu adresu URL.

Metody

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Przerywa oczekującą operację kopiowania pliku i pozostawia plik docelowy o zerowej długości i pełnych metadanych.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file

clearRange(number, number, FileClearRangeOptions)

Czyści określony zakres i zwalnia miejsce używane w magazynie dla tego zakresu.

create(number, FileCreateOptions)

Tworzy nowy plik lub zastępuje plik. Pamiętaj, że inicjuje tylko plik bez zawartości.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-file

delete(FileDeleteOptions)

Usuwa plik z konta magazynu. Po pomyślnym usunięciu pliku jest on natychmiast usuwany z indeksu konta magazynu i nie jest już dostępny dla klientów. Dane pliku zostaną później usunięte z usługi podczas odzyskiwania pamięci.

Usuwanie pliku zakończy się niepowodzeniem z kodem stanu 409 (konflikt) i kodem błędu SharingViolation, jeśli plik jest otwarty na kliencie SMB.

Usuwanie pliku nie jest obsługiwane w migawki udziału, która jest kopią udziału tylko do odczytu. Próba wykonania tej operacji na migawki udziału zakończy się niepowodzeniem z wartością 400 (InvalidQueryParameterValue)

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

deleteIfExists(FileDeleteOptions)

Usuwa plik z konta magazynu, jeśli istnieje. Po pomyślnym usunięciu pliku jest on natychmiast usuwany z indeksu konta magazynu i nie jest już dostępny dla klientów. Dane pliku zostaną później usunięte z usługi podczas odzyskiwania pamięci.

Usuwanie pliku zakończy się niepowodzeniem z kodem stanu 409 (konflikt) i kodem błędu SharingViolation, jeśli plik jest otwarty na kliencie SMB.

Usuwanie pliku nie jest obsługiwane w migawki udziału, która jest kopią udziału tylko do odczytu. Próba wykonania tej operacji na migawki udziału zakończy się niepowodzeniem z wartością 400 (InvalidQueryParameterValue)

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

download(number, number, FileDownloadOptions)

Odczytuje lub pobiera plik z systemu, w tym jego metadane i właściwości.

  • W Node.jsdane są zwracane w strumieniu czytelnym readableStreamBody
  • W przeglądarkach dane są zwracane w contentAsBlob obietnicy

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-file

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Pobiera plik platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby pobrać cały plik.

Ostrzeżenie: mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku plików większych niż ten rozmiar należy rozważyć downloadToFile.

downloadToBuffer(number, number, FileDownloadToBufferOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS

Pobiera plik platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby pobrać cały plik

Ostrzeżenie: mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku plików większych niż ten rozmiar należy rozważyć downloadToFile.

downloadToFile(string, number, number, FileDownloadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Pobiera obiekt blob platformy Azure do pliku lokalnego. Kończy się niepowodzeniem, jeśli dana ścieżka pliku już zakończy działanie. Przesunięcie i liczba są opcjonalne, przekaż odpowiednio 0 i niezdefiniowane, aby pobrać cały obiekt blob.

exists(FileExistsOptions)

Zwraca wartość true, jeśli określony plik istnieje; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący plik może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe pliki mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

forceCloseAllHandles(FileForceCloseHandlesOptions)

Wymuś zamknięcie wszystkich dojść dla pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles

forceCloseHandle(string, FileForceCloseHandlesOptions)

Wymuś zamknięcie określonego uchwytu dla pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles

generateSasStringToSign(FileGenerateSasUrlOptions)

Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

generateSasUrl(FileGenerateSasUrlOptions)

Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

getProperties(FileGetPropertiesOptions)

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla pliku. Nie zwraca zawartości pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-properties

getRangeList(FileGetRangeListOptions)

Zwraca listę prawidłowych zakresów dla pliku.

getRangeListDiff(string, FileGetRangeListOptions)

Zwraca listę zakresów, które różnią się między poprzednią migawką udziału a tym plikiem.

getShareLeaseClient(string)

Pobierz ShareLeaseClient, który zarządza dzierżawami w pliku.

listHandles(FileListHandlesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich dojść. w ramach określonego konta.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę dojść na stronach.

rename(string, FileRenameOptions)

Zmienia nazwę pliku. Ten interfejs API obsługuje tylko zmianę nazwy pliku w tym samym udziale.

resize(number, FileResizeOptions)

Zmień rozmiar pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties

setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)

Ustawia nagłówki HTTP w pliku.

Jeśli nie podano żadnej opcji lub nie podano żadnej wartości dla nagłówków HTTP pliku w opcjach, te nagłówki HTTP pliku bez wartości zostaną wyczyszczone.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties

setMetadata(Metadata, FileSetMetadataOptions)

Aktualizuje metadane zdefiniowane przez użytkownika dla określonego pliku.

Jeśli w parametrze opcji nie zdefiniowano żadnych metadanych, metadane pliku zostaną usunięte.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata

setProperties(FileProperties)

Ustawia właściwości pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties

startCopyFromURL(string, FileStartCopyOptions)

Kopiuje obiekt blob lub plik do pliku docelowego na koncie magazynu.

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Tworzy nowy plik platformy Azure lub zastępuje istniejący plik platformy Azure, a następnie przekazuje do niego bufor(Node)/Blob/ArrayBuffer/ArrayBufferView.

uploadFile(string, FileParallelUploadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy nowy plik platformy Azure lub zastępuje istniejący plik platformy Azure, a następnie przekazuje do niego plik lokalny.

uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)

Przekaż zakres bajtów do pliku. Tę operację można wywołać tylko w istniejącym pliku. Nie spowoduje to zmiany rozmiaru, właściwości ani metadanych pliku. Należy określić zarówno początek, jak i liczbę zakresów. Zakres może mieć rozmiar do 4 MB.

uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)

Przekaż zakres bajtów do pliku, w którym zawartość jest odczytywana z adresu URL innego pliku. Zakres może mieć rozmiar do 4 MB.

uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Akceptuje fabrykę strumienia z możliwością odczytu Node.js i przekazuje bloki do pliku platformy Azure. Fabryka strumieni z możliwością odczytu musi zwracać strumień z możliwością odczytu Node.js rozpoczynający się od zdefiniowanego przesunięcia. Przesunięcie jest przesunięciem w pliku platformy Azure, który ma zostać przekazany.

uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)

DOSTĘPNE TYLKO W PRZEGLĄDARKACH.

Przekazuje obiekt blob przeglądarki do pliku platformy Azure. Wymaga obiektu blobFactory jako źródła danych, które musi zwrócić obiekt blob z podanym przesunięciem i rozmiarem.

uploadStream(Readable, number, number, number, FileUploadStreamOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy nowy plik platformy Azure lub zastępuje istniejący plik platformy Azure, a następnie przekazuje do niego strumień z możliwością odczytu Node.js. Ta metoda spróbuje utworzyć plik platformy Azure, a następnie rozpocznie przekazywanie fragmentu według fragmentu. Rozmiar fragmentu jest definiowany przez parametr bufferSize. Upewnij się, że potencjalny rozmiar strumienia nie przekracza rozmiaru pliku.

PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI:

  • Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość z parametrem bufferSize, co pozwoli uniknąć operacji Buffer.concat().
withShareSnapshot(string)

Tworzy nowy obiekt ShareFileClient identyczny ze źródłem, ale z określonym sygnaturą czasową migawki udziału. Podaj wartość "" spowoduje usunięcie migawki i zwrócenie adresu URL do podstawowego obiektu ShareFileClient.

Szczegóły konstruktora

ShareFileClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Tworzy wystąpienie klasy ShareFileClient.

new ShareFileClient(url: string, credential?: Credential_2 | TokenCredential, options?: ShareClientOptions)

Parametry

url

string

Ciąg adresu URL wskazujący plik usługi Azure Storage, taki jak "https://myaccount.file.core.windows.net/myshare/mydirectory/file". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący plik. Zakodowany ciąg adresu URL nie zostanie dwukrotnie uniknięci. Tylko znaki specjalne w ścieżce adresu URL zostaną uniknięci. Jeśli jednak nazwa pliku lub katalogu zawiera %, nazwa pliku lub katalogu musi być zakodowana w adresie URL. Taki jak plik o nazwie "myfile%", adres URL powinien mieć wartość "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

credential

Credential | TokenCredential

Na przykład , StorageSharedKeyCredential lub TokenCredential, Jeśli nie określono, jest używana funkcja AnonymousCredential.

options
ShareClientOptions

Fakultatywny. Opcje konfigurowania potoku HTTP.

ShareFileClient(string, Pipeline, ShareClientConfig)

Tworzy wystąpienie klasy ShareFileClient.

new ShareFileClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Parametry

url

string

Ciąg adresu URL wskazujący plik usługi Azure Storage, taki jak "https://myaccount.file.core.windows.net/myshare/mydirectory/file". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.file.core.windows.net/myshare/mydirectory/file?sasString". Ta metoda akceptuje zakodowany adres URL lub niekodowany adres URL wskazujący plik. Zakodowany ciąg adresu URL nie zostanie dwukrotnie uniknięci. Tylko znaki specjalne w ścieżce adresu URL zostaną uniknięci. Jeśli jednak nazwa pliku lub katalogu zawiera %, nazwa pliku lub katalogu musi być zakodowana w adresie URL. Taki jak plik o nazwie "myfile%", adres URL powinien mieć wartość "https://myaccount.file.core.windows.net/myshare/mydirectory/myfile%25".

pipeline
Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok lub podaj dostosowany potok.

Szczegóły właściwości

name

Nazwa pliku

string name

Wartość właściwości

string

path

Pełna ścieżka pliku

string path

Wartość właściwości

string

shareName

Nazwa udziału odpowiadająca temu klientowi plików

string shareName

Wartość właściwości

string

Szczegóły właściwości dziedziczonej

accountName

accountName: string

Wartość właściwości

string

dziedziczone z StorageClient.accountName

url

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

dziedziczone z StorageClient.url

Szczegóły metody

abortCopyFromURL(string, FileAbortCopyFromURLOptions)

Przerywa oczekującą operację kopiowania pliku i pozostawia plik docelowy o zerowej długości i pełnych metadanych.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/abort-copy-file

function abortCopyFromURL(copyId: string, options?: FileAbortCopyFromURLOptions): Promise<FileAbortCopyResponse>

Parametry

copyId

string

Identyfikator operacji kopiowania pliku do przerwania.

options
FileAbortCopyFromURLOptions

Opcje operacji Przerwanie kopiowania pliku z adresu URL.

Zwraca

clearRange(number, number, FileClearRangeOptions)

Czyści określony zakres i zwalnia miejsce używane w magazynie dla tego zakresu.

function clearRange(offset: number, contentLength: number, options?: FileClearRangeOptions): Promise<FileUploadRangeResponse>

Parametry

offset

number

contentLength

number

options
FileClearRangeOptions

Opcje operacji Wyczyść zakres plików.

Zwraca

create(number, FileCreateOptions)

Tworzy nowy plik lub zastępuje plik. Pamiętaj, że inicjuje tylko plik bez zawartości.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-file

function create(size: number, options?: FileCreateOptions): Promise<FileCreateResponse>

Parametry

size

number

Określa maksymalny rozmiar w bajtach dla pliku, do 4 TB.

options
FileCreateOptions

Opcje operacji tworzenia pliku.

Zwraca

Dane odpowiedzi dla operacji Tworzenia pliku.

Przykładowe użycie:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

delete(FileDeleteOptions)

Usuwa plik z konta magazynu. Po pomyślnym usunięciu pliku jest on natychmiast usuwany z indeksu konta magazynu i nie jest już dostępny dla klientów. Dane pliku zostaną później usunięte z usługi podczas odzyskiwania pamięci.

Usuwanie pliku zakończy się niepowodzeniem z kodem stanu 409 (konflikt) i kodem błędu SharingViolation, jeśli plik jest otwarty na kliencie SMB.

Usuwanie pliku nie jest obsługiwane w migawki udziału, która jest kopią udziału tylko do odczytu. Próba wykonania tej operacji na migawki udziału zakończy się niepowodzeniem z wartością 400 (InvalidQueryParameterValue)

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

function delete(options?: FileDeleteOptions): Promise<FileDeleteResponse>

Parametry

options
FileDeleteOptions

Opcje operacji usuwania pliku.

Zwraca

Dane odpowiedzi dla operacji Usuwania pliku.

deleteIfExists(FileDeleteOptions)

Usuwa plik z konta magazynu, jeśli istnieje. Po pomyślnym usunięciu pliku jest on natychmiast usuwany z indeksu konta magazynu i nie jest już dostępny dla klientów. Dane pliku zostaną później usunięte z usługi podczas odzyskiwania pamięci.

Usuwanie pliku zakończy się niepowodzeniem z kodem stanu 409 (konflikt) i kodem błędu SharingViolation, jeśli plik jest otwarty na kliencie SMB.

Usuwanie pliku nie jest obsługiwane w migawki udziału, która jest kopią udziału tylko do odczytu. Próba wykonania tej operacji na migawki udziału zakończy się niepowodzeniem z wartością 400 (InvalidQueryParameterValue)

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2

function deleteIfExists(options?: FileDeleteOptions): Promise<FileDeleteIfExistsResponse>

Parametry

Zwraca

download(number, number, FileDownloadOptions)

Odczytuje lub pobiera plik z systemu, w tym jego metadane i właściwości.

  • W Node.jsdane są zwracane w strumieniu czytelnym readableStreamBody
  • W przeglądarkach dane są zwracane w contentAsBlob obietnicy

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-file

function download(offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

Parametry

offset

number

Z której pozycji pliku do pobrania, większe lub równe 0

count

number

Ilość danych do pobrania, większa niż 0. Zostanie pobrany na koniec, gdy niezdefiniowany

options
FileDownloadOptions

Opcje operacji pobierania pliku.

Zwraca

Dane odpowiedzi dla operacji Pobierania pliku.

Przykładowe użycie (Node.js):

// Download a file to a string
const downloadFileResponse = await fileClient.download();
console.log(
  "Downloaded file content:",
  (await streamToBuffer(downloadFileResponse.readableStreamBody)).toString()}
);

// A helper method used to read a Node.js readable stream into string
async function streamToBuffer(readableStream) {
  return new Promise((resolve, reject) => {
    const chunks = [];
    readableStream.on("data", (data) => {
      chunks.push(data instanceof Buffer ? data : Buffer.from(data));
    });
    readableStream.on("end", () => {
      resolve(Buffer.concat(chunks));
    });
    readableStream.on("error", reject);
  });
}

Przykładowe użycie (przeglądarki):

// Download a file to a string
const downloadFileResponse = await fileClient.download(0);
console.log(
  "Downloaded file content:",
  await blobToString(await downloadFileResponse.blobBody)}
);

// A helper method used to convert a browser Blob into string.
export async function blobToString(blob: Blob): Promise<string> {
  const fileReader = new FileReader();
  return new Promise<string>((resolve, reject) => {
    fileReader.onloadend = (ev: any) => {
      resolve(ev.target!.result);
    };
    fileReader.onerror = reject;
    fileReader.readAsText(blob);
  });
}

downloadToBuffer(Buffer, number, number, FileDownloadToBufferOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Pobiera plik platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby pobrać cały plik.

Ostrzeżenie: mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku plików większych niż ten rozmiar należy rozważyć downloadToFile.

function downloadToBuffer(buffer: Buffer, offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

Parametry

buffer

Buffer

Bufor do wypełnienia, musi mieć długość większą niż liczba

offset

number

Z której pozycji pliku platformy Azure do pobrania

count

number

Ile danych należy pobrać. Zostanie pobrany na koniec po przekazaniu niezdefiniowanego

Zwraca

Promise<Buffer>

downloadToBuffer(number, number, FileDownloadToBufferOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS

Pobiera plik platformy Azure równolegle do buforu. Przesunięcie i liczba są opcjonalne, przekaż 0 dla obu, aby pobrać cały plik

Ostrzeżenie: mogą obsługiwać tylko pliki do około jednego gigabajta w systemach 32-bitowych lub około dwóch gigabajtów w systemach 64-bitowych z powodu ograniczeń Node.js/V8. W przypadku plików większych niż ten rozmiar należy rozważyć downloadToFile.

function downloadToBuffer(offset?: number, count?: number, options?: FileDownloadToBufferOptions): Promise<Buffer>

Parametry

offset

number

Z której pozycji pliku platformy Azure do pobrania

count

number

Ile danych należy pobrać. Zostanie pobrany na koniec po przekazaniu niezdefiniowanego

Zwraca

Promise<Buffer>

downloadToFile(string, number, number, FileDownloadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Pobiera obiekt blob platformy Azure do pliku lokalnego. Kończy się niepowodzeniem, jeśli dana ścieżka pliku już zakończy działanie. Przesunięcie i liczba są opcjonalne, przekaż odpowiednio 0 i niezdefiniowane, aby pobrać cały obiekt blob.

function downloadToFile(filePath: string, offset?: number, count?: number, options?: FileDownloadOptions): Promise<FileDownloadResponseModel>

Parametry

filePath

string

offset

number

Z której pozycji blokowego obiektu blob do pobrania.

count

number

Ile danych należy pobrać. Po przekazaniu niezdefiniowanego zostanie pobrany koniec.

options
FileDownloadOptions

Opcje pobierania obiektów blob.

Zwraca

Dane odpowiedzi dla operacji pobierania obiektu blob, ale z funkcją readableStreamBody ustawioną na niezdefiniowaną, ponieważ jego zawartość jest już odczytywana i zapisywana w pliku lokalnym w określonej ścieżce.

exists(FileExistsOptions)

Zwraca wartość true, jeśli określony plik istnieje; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący plik może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe pliki mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

function exists(options?: FileExistsOptions): Promise<boolean>

Parametry

options
FileExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

forceCloseAllHandles(FileForceCloseHandlesOptions)

Wymuś zamknięcie wszystkich dojść dla pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles

function forceCloseAllHandles(options?: FileForceCloseHandlesOptions): Promise<CloseHandlesInfo>

Parametry

options
FileForceCloseHandlesOptions

Opcje wymuszania operacji zamykania dojść.

Zwraca

Promise<CloseHandlesInfo>

forceCloseHandle(string, FileForceCloseHandlesOptions)

Wymuś zamknięcie określonego uchwytu dla pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles

function forceCloseHandle(handleId: string, options?: FileForceCloseHandlesOptions): Promise<FileForceCloseHandlesResponse>

Parametry

handleId

string

Określony identyfikator uchwytu, nie może być gwiazdką "*". Użyj metody forceCloseAllHandles(), aby zamknąć wszystkie dojścia.

Zwraca

generateSasStringToSign(FileGenerateSasUrlOptions)

Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: FileGenerateSasUrlOptions): string

Parametry

options
FileGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

generateSasUrl(FileGenerateSasUrlOptions)

Dostępne tylko dla klientów skonstruowanych przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: FileGenerateSasUrlOptions): string

Parametry

options
FileGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

getProperties(FileGetPropertiesOptions)

Zwraca wszystkie metadane zdefiniowane przez użytkownika, standardowe właściwości PROTOKOŁU HTTP i właściwości systemu dla pliku. Nie zwraca zawartości pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-file-properties

function getProperties(options?: FileGetPropertiesOptions): Promise<FileGetPropertiesResponse>

Parametry

options
FileGetPropertiesOptions

Opcje operacji Pobierz właściwości pliku.

Zwraca

Dane odpowiedzi dla operacji Pobieranie właściwości pliku.

getRangeList(FileGetRangeListOptions)

Zwraca listę prawidłowych zakresów dla pliku.

function getRangeList(options?: FileGetRangeListOptions): Promise<FileGetRangeListResponse>

Parametry

options
FileGetRangeListOptions

Opcje operacji Pobieranie listy zakresów.

Zwraca

getRangeListDiff(string, FileGetRangeListOptions)

Zwraca listę zakresów, które różnią się między poprzednią migawką udziału a tym plikiem.

function getRangeListDiff(prevShareSnapshot: string, options?: FileGetRangeListOptions): Promise<FileGetRangeListDiffResponse>

Parametry

prevShareSnapshot

string

Poprzedni parametr migawki jest nieprzezroczystą wartością DateTime, która określa poprzednią migawkę udziału do porównania.

Zwraca

getShareLeaseClient(string)

Pobierz ShareLeaseClient, który zarządza dzierżawami w pliku.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parametry

proposeLeaseId

string

Początkowy proponowany identyfikator dzierżawy.

Zwraca

Nowy obiekt ShareLeaseClient do zarządzania dzierżawami w pliku.

listHandles(FileListHandlesOptions)

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich dojść. w ramach określonego konta.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę dojść na stronach.

function listHandles(options?: FileListHandlesOptions): PagedAsyncIterableIterator<HandleItem, FileListHandlesResponse, PageSettings>

Parametry

options
FileListHandlesOptions

Opcje wyświetlania listy operacji obsługi.

AsyncIterableIterator, który obsługuje stronicowanie.

Zwraca

rename(string, FileRenameOptions)

Zmienia nazwę pliku. Ten interfejs API obsługuje tylko zmianę nazwy pliku w tym samym udziale.

function rename(destinationPath: string, options?: FileRenameOptions): Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

Parametry

destinationPath

string

Określa ścieżkę docelową, do którego ma być zmieniona nazwa. Ścieżka zostanie zakodowana w celu wprowadzenia do adresu URL w celu określenia miejsca docelowego.

options
FileRenameOptions

Opcje operacji zmiany nazwy.

Zwraca

Promise<{ destinationFileClient: ShareFileClient, fileRenameResponse: FileRenameResponse }>

Dane odpowiedzi dla operacji zmiany nazwy pliku.

Przykładowe użycie:


// Rename the file
await fileClient.rename(destinationPath);
console.log("Renamed file successfully!");

resize(number, FileResizeOptions)

Zmień rozmiar pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties

function resize(length: number, options?: FileResizeOptions): Promise<FileSetHTTPHeadersResponse>

Parametry

length

number

Zmienia rozmiar pliku na określony rozmiar w bajtach. Jeśli określona wartość bajtu jest mniejsza niż bieżący rozmiar pliku, wszystkie zakresy powyżej określonej wartości bajtowej zostaną wyczyszczone.

options
FileResizeOptions

Opcje operacji zmiany rozmiaru pliku.

Zwraca

Dane odpowiedzi dla operacji Ustawianie nagłówków HTTP pliku.

setHttpHeaders(FileHttpHeaders, FileSetHttpHeadersOptions)

Ustawia nagłówki HTTP w pliku.

Jeśli nie podano żadnej opcji lub nie podano żadnej wartości dla nagłówków HTTP pliku w opcjach, te nagłówki HTTP pliku bez wartości zostaną wyczyszczone.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties

function setHttpHeaders(fileHttpHeaders?: FileHttpHeaders, options?: FileSetHttpHeadersOptions): Promise<FileSetHTTPHeadersResponse>

Parametry

fileHttpHeaders
FileHttpHeaders
options
FileSetHttpHeadersOptions

Opcje ustawiania operacji nagłówków HTTP.

Zwraca

Dane odpowiedzi dla operacji Ustawianie nagłówków HTTP pliku.

setMetadata(Metadata, FileSetMetadataOptions)

Aktualizuje metadane zdefiniowane przez użytkownika dla określonego pliku.

Jeśli w parametrze opcji nie zdefiniowano żadnych metadanych, metadane pliku zostaną usunięte.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-metadata

function setMetadata(metadata?: Metadata, options?: FileSetMetadataOptions): Promise<FileSetMetadataResponse>

Parametry

metadata
Metadata

Jeśli nie podano żadnych metadanych, wszystkie istniejące metadane katalogu zostaną usunięte

options
FileSetMetadataOptions

Opcje operacji ustawiania metadanych zestawu plików.

Zwraca

Dane odpowiedzi dla operacji ustawiania metadanych zestawu plików.

setProperties(FileProperties)

Ustawia właściwości pliku.

Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-file-properties

function setProperties(properties?: FileProperties): Promise<SetPropertiesResponse>

Parametry

properties
FileProperties

Właściwości pliku. W przypadku nagłówków HTTP pliku (np. Content-Type), jeśli nie podano żadnych wartości, istniejące nagłówki HTTP zostaną usunięte. W przypadku innych właściwości pliku (np. fileAttributes), jeśli nie podano żadnych wartości, istniejące wartości zostaną zachowane.

Zwraca

startCopyFromURL(string, FileStartCopyOptions)

Kopiuje obiekt blob lub plik do pliku docelowego na koncie magazynu.

function startCopyFromURL(copySource: string, options?: FileStartCopyOptions): Promise<FileStartCopyResponse>

Parametry

copySource

string

Określa adres URL pliku źródłowego lub obiektu blob o długości do 2 KB. Aby skopiować plik do innego pliku na tym samym koncie magazynu, możesz użyć klucza wspólnego do uwierzytelniania pliku źródłowego. Jeśli kopiujesz plik z innego konta magazynu lub kopiujesz obiekt blob z tego samego konta magazynu lub innego konta magazynu, musisz uwierzytelnić plik źródłowy lub obiekt blob przy użyciu sygnatury dostępu współdzielonego. Jeśli źródło jest publicznym obiektem blob, do wykonania operacji kopiowania nie jest wymagane żadne uwierzytelnianie. Plik w migawce udziału można również określić jako źródło kopii.

options
FileStartCopyOptions

Opcje uruchamiania operacji kopiowania pliku.

Zwraca

uploadData(Blob | ArrayBuffer | ArrayBufferView | Buffer, FileParallelUploadOptions)

Tworzy nowy plik platformy Azure lub zastępuje istniejący plik platformy Azure, a następnie przekazuje do niego bufor(Node)/Blob/ArrayBuffer/ArrayBufferView.

function uploadData(data: Blob | ArrayBuffer | ArrayBufferView | Buffer, options?: FileParallelUploadOptions): Promise<void>

Parametry

data

Blob | ArrayBuffer | ArrayBufferView | Buffer

Buffer(Node), Blob, ArrayBuffer lub ArrayBufferView

Zwraca

Promise<void>

uploadFile(string, FileParallelUploadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy nowy plik platformy Azure lub zastępuje istniejący plik platformy Azure, a następnie przekazuje do niego plik lokalny.

function uploadFile(filePath: string, options?: FileParallelUploadOptions): Promise<void>

Parametry

filePath

string

Pełna ścieżka pliku lokalnego

Zwraca

Promise<void>

uploadRange(RequestBodyType, number, number, FileUploadRangeOptions)

Przekaż zakres bajtów do pliku. Tę operację można wywołać tylko w istniejącym pliku. Nie spowoduje to zmiany rozmiaru, właściwości ani metadanych pliku. Należy określić zarówno początek, jak i liczbę zakresów. Zakres może mieć rozmiar do 4 MB.

function uploadRange(body: RequestBodyType, offset: number, contentLength: number, options?: FileUploadRangeOptions): Promise<FileUploadRangeResponse>

Parametry

body
HttpRequestBody

Obiekt blob, ciąg, ArrayBuffer, ArrayBufferView lub funkcja zwracająca nowy strumień z możliwością odczytu, którego przesunięcie pochodzi od źródła danych.

offset

number

Przesunięcie położenia docelowego pliku platformy Azure do przekazania.

contentLength

number

Długość ciała w bajtach. Użyj metody Buffer.byteLength(), aby obliczyć długość treści dla ciągu, w tym niekodowane znaki base64/szesnastkowe.

options
FileUploadRangeOptions

Opcje operacji Przekazywania zakresu plików.

Zwraca

Dane odpowiedzi dla operacji Przekazywanie zakresu plików.

Przykładowe użycie:

const content = "Hello world!";

// Create the file
await fileClient.create(content.length);
console.log("Created file successfully!");

// Then upload data to the file
await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

uploadRangeFromURL(string, number, number, number, FileUploadRangeFromURLOptions)

Przekaż zakres bajtów do pliku, w którym zawartość jest odczytywana z adresu URL innego pliku. Zakres może mieć rozmiar do 4 MB.

function uploadRangeFromURL(sourceURL: string, sourceOffset: number, destOffset: number, count: number, options?: FileUploadRangeFromURLOptions): Promise<FileUploadRangeFromURLResponse>

Parametry

sourceURL

string

Określ adres URL źródła kopii, sygnaturę dostępu współdzielonego (SAS), która może być potrzebna do uwierzytelniania.

sourceOffset

number

Przesunięcie źródła do skopiowania. Przekaż wartość 0, aby skopiować z początku pliku źródłowego.

destOffset

number

Przesunięcie pliku docelowego.

count

number

Liczba bajtów do przekazania z pliku źródłowego.

options
FileUploadRangeFromURLOptions

Opcje konfigurowania pliku — przekazywanie zakresu z operacji adresu URL.

Zwraca

uploadResetableStream((offset: number, count?: number) => ReadableStream, number, FileParallelUploadOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Akceptuje fabrykę strumienia z możliwością odczytu Node.js i przekazuje bloki do pliku platformy Azure. Fabryka strumieni z możliwością odczytu musi zwracać strumień z możliwością odczytu Node.js rozpoczynający się od zdefiniowanego przesunięcia. Przesunięcie jest przesunięciem w pliku platformy Azure, który ma zostać przekazany.

function uploadResetableStream(streamFactory: (offset: number, count?: number) => ReadableStream, size: number, options?: FileParallelUploadOptions): Promise<void>

Parametry

streamFactory

(offset: number, count?: number) => ReadableStream

Zwraca strumień z możliwością odczytu Node.js rozpoczynający się od zdefiniowanego przesunięcia

size

number

Rozmiar pliku platformy Azure

Zwraca

Promise<void>

uploadSeekableBlob((offset: number, size: number) => Blob, number, FileParallelUploadOptions)

DOSTĘPNE TYLKO W PRZEGLĄDARKACH.

Przekazuje obiekt blob przeglądarki do pliku platformy Azure. Wymaga obiektu blobFactory jako źródła danych, które musi zwrócić obiekt blob z podanym przesunięciem i rozmiarem.

function uploadSeekableBlob(blobFactory: (offset: number, size: number) => Blob, size: number, options?: FileParallelUploadOptions): Promise<void>

Parametry

blobFactory

(offset: number, size: number) => Blob

size

number

Zwraca

Promise<void>

uploadStream(Readable, number, number, number, FileUploadStreamOptions)

DOSTĘPNE TYLKO W ŚRODOWISKU URUCHOMIENIOWYM NODE.JS.

Tworzy nowy plik platformy Azure lub zastępuje istniejący plik platformy Azure, a następnie przekazuje do niego strumień z możliwością odczytu Node.js. Ta metoda spróbuje utworzyć plik platformy Azure, a następnie rozpocznie przekazywanie fragmentu według fragmentu. Rozmiar fragmentu jest definiowany przez parametr bufferSize. Upewnij się, że potencjalny rozmiar strumienia nie przekracza rozmiaru pliku.

PORADY DOTYCZĄCE POPRAWY WYDAJNOŚCI:

  • Strumień wejściowy highWaterMark lepiej ustawić tę samą wartość z parametrem bufferSize, co pozwoli uniknąć operacji Buffer.concat().
function uploadStream(stream: Readable, size: number, bufferSize: number, maxBuffers: number, options?: FileUploadStreamOptions): Promise<void>

Parametry

stream

Readable

Node.js strumienia z możliwością odczytu. Musi być mniejszy lub równy rozmiarowi pliku.

size

number

Rozmiar pliku do utworzenia. Maksymalny dozwolony rozmiar to 4 TB. Jeśli ta wartość jest większa niż rozmiar strumienia, w ogonie pliku będą puste bajty.

bufferSize

number

Rozmiar każdego buforu przydzielonego w bajtach, a także rozmiar fragmentu/zakresu podczas przekazywania pliku. Rozmiar musi być większy niż 0 i mniejszy lub równy 4 * 1024 * 1024 * 1024 (4 MB)

maxBuffers

number

Maksymalna liczba zostanie przydzielona podczas przekazywania, dodatnia korelacja z maksymalną współbieżnością przekazywania

Zwraca

Promise<void>

withShareSnapshot(string)

Tworzy nowy obiekt ShareFileClient identyczny ze źródłem, ale z określonym sygnaturą czasową migawki udziału. Podaj wartość "" spowoduje usunięcie migawki i zwrócenie adresu URL do podstawowego obiektu ShareFileClient.

function withShareSnapshot(shareSnapshot: string): ShareFileClient

Parametry

shareSnapshot

string

Sygnatura czasowa migawki udziału.

Zwraca

Nowy obiekt ShareFileClient identyczny ze źródłem, ale z określonym sygnaturą czasową migawki udziału.