ShareDirectoryClient class

Odwołanie

Pakiet:: @azure/storage-file-share

Obiekt ShareDirectoryClient reprezentuje adres URL katalogu usługi Azure Storage, co umożliwia manipulowanie jego plikami i katalogami.

Extends: StorageClient

Konstruktory

ShareDirectoryClient(string, Credential_2 \| TokenCredential, ShareClientOptions)	Tworzy wystąpienie klasy DirectoryClient.
ShareDirectoryClient(string, Pipeline, ShareClientConfig)	Tworzy wystąpienie klasy DirectoryClient.

Właściwości

name	Nazwa katalogu
path	Pełna ścieżka katalogu
shareName	Nazwa udziału odpowiadająca temu klientowi katalogu

Właściwości dziedziczone

accountName
url	Wartość ciągu adresu URL.

Metody

create(DirectoryCreateOptions)	Tworzy nowy katalog w określonym udziale lub katalogu nadrzędnym. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	Tworzy nowy plik lub zastępuje plik w tym katalogu. Zanotuj, że inicjuje tylko plik bez zawartości. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-file
createIfNotExists(DirectoryCreateOptions)	Tworzy nowy katalog w określonym udziale lub katalogu nadrzędnym, jeśli jeszcze nie istnieje. Jeśli katalog już istnieje, nie jest on modyfikowany. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
createSubdirectory(string, DirectoryCreateOptions)	Tworzy nowy podkatalog w tym katalogu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory
delete(DirectoryDeleteOptions)	Usuwa określony pusty katalog. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	Usuwa określony plik w tym katalogu z konta magazynu. Po pomyślnym usunięciu pliku zostanie natychmiast usunięty z indeksu konta magazynu i nie będzie 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 migawce udziału, która jest kopią udziału tylko do odczytu. Próba wykonania tej operacji na migawce udziału zakończy się niepowodzeniem z wartością 400 (InvalidQueryParameterValue) Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2
deleteIfExists(DirectoryDeleteOptions)	Usuwa określony pusty katalog, jeśli istnieje. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory
deleteSubdirectory(string, DirectoryDeleteOptions)	Usuwa określony pusty podkatalog w tym katalogu. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory
exists(DirectoryExistsOptions)	Zwraca wartość true, jeśli określony katalog istnieje; w przeciwnym razie wartość false. UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący katalog może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe katalogi mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.
forceCloseAllHandles(DirectoryForceCloseHandlesSegmentOptions)	Wymuś zamknięcie wszystkich dojść dla katalogu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
forceCloseHandle(string, DirectoryForceCloseHandlesOptions)	Wymuś zamknięcie określonego dojścia dla katalogu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/force-close-handles
getDirectoryClient(string)	Tworzy obiekt ShareDirectoryClient dla katalogu podrzędnego.
getFileClient(string)	Tworzy obiekt ShareFileClient .
getProperties(DirectoryGetPropertiesOptions)	Zwraca wszystkie właściwości systemu dla określonego katalogu, a także może służyć do sprawdzania istnienia katalogu. Zwrócone dane nie zawierają plików w katalogu ani żadnych podkatalogach. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/get-directory-properties
listFilesAndDirectories(DirectoryListFilesAndDirectoriesOptions)	Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich plików i katalogów w ramach określonego konta. Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę plików i katalogów na stronach. Przykład użycia `for await` składni: let i = 1; for await (const entity of directoryClient.listFilesAndDirectories()) { if (entity.kind === "directory") { console.log(`${i++} - directory\t: ${entity.name}`); } else { console.log(`${i++} - file\t: ${entity.name}`); } } Przykład przy użyciu polecenia `iter.next()`: let i = 1; let iter = directoryClient.listFilesAndDirectories(); let entity = await iter.next(); while (!entity.done) { if (entity.value.kind === "directory") { console.log(`${i++} - directory\t: ${entity.value.name}`); } else { console.log(`${i++} - file\t: ${entity.value.name}`); } entity = await iter.next(); } Przykład przy użyciu polecenia `byPage()`: // passing optional maxPageSize in the page settings let i = 1; for await (const response of directoryClient .listFilesAndDirectories() .byPage({ maxPageSize: 20 })) { for (const fileItem of response.segment.fileItems) { console.log(`${i++} - file\t: ${fileItem.name}`); } for (const dirItem of response.segment.directoryItems) { console.log(`${i++} - directory\t: ${dirItem.name}`); } } Przykład użycia stronicowania ze znacznikiem: let i = 1; let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 3 }); let response = (await iterator.next()).value; // Prints 3 file and directory names for (const fileItem of response.segment.fileItems) { console.log(`${i++} - file\t: ${fileItem.name}`); } for (const dirItem of response.segment.directoryItems) { console.log(`${i++} - directory\t: ${dirItem.name}`); } // Gets next marker let dirMarker = response.continuationToken; // Passing next marker as continuationToken iterator = directoryClient .listFilesAndDirectories() .byPage({ continuationToken: dirMarker, maxPageSize: 4 }); response = (await iterator.next()).value; // Prints 10 file and directory names for (const fileItem of response.segment.fileItems) { console.log(`${i++} - file\t: ${fileItem.name}`); } for (const dirItem of response.segment.directoryItems) { console.log(`${i++} - directory\t: ${dirItem.name}`); }
listHandles(DirectoryListHandlesOptions)	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. Przykład użycia `for await` składni: let i = 1; let iter = dirClient.listHandles(); for await (const handle of iter) { console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`); } Przykład przy użyciu polecenia `iter.next()`: let i = 1; let iter = dirClient.listHandles(); let handleItem = await iter.next(); while (!handleItem.done) { console.log(`Handle ${i++}: ${handleItem.value.path}, opened time ${handleItem.value.openTime}, clientIp ${handleItem.value.clientIp}`); handleItem = await iter.next(); } Przykład przy użyciu polecenia `byPage()`: // passing optional maxPageSize in the page settings let i = 1; for await (const response of dirClient.listHandles({ recursive: true }).byPage({ maxPageSize: 20 })) { if (response.handleList) { for (const handle of response.handleList) { console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`); } } } Przykład użycia stronicowania ze znacznikiem: let i = 1; let iterator = dirClient.listHandles().byPage({ maxPageSize: 2 }); let response = await iterator.next(); // Prints 2 handles if (response.value.handleList) { for (const handle of response.value.handleList) { console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`); } } // Gets next marker let marker = response.value.continuationToken; // Passing next marker as continuationToken console.log(` continuation`); iterator = dirClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 }); response = await iterator.next(); // Prints 2 more handles assuming you have more than four directory/files opened if (!response.done && response.value.handleList) { for (const handle of response.value.handleList) { console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`); } }
rename(string, DirectoryRenameOptions)	Zmienia nazwę katalogu. Ten interfejs API obsługuje tylko zmianę nazwy katalogu w tym samym udziale.
setMetadata(Metadata, DirectorySetMetadataOptions)	Aktualizacje metadanych zdefiniowanych przez użytkownika dla określonego katalogu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-directory-metadata
setProperties(DirectoryProperties)	Ustawia właściwości w katalogu. Zobacz https://docs.microsoft.com/en-us/rest/api/storageservices/set-directory-properties

Szczegóły konstruktora

Tworzy wystąpienie klasy DirectoryClient.

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

Parametry

url: string

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

credential: Credential | TokenCredential

Na przykład AnonymousCredential lub StorageSharedKeyCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options: ShareClientOptions

Opcjonalny. Opcje konfigurowania potoku HTTP.

Tworzy wystąpienie klasy DirectoryClient.

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

Parametry

url: string

pipeline: Pipeline

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

options: ShareClientConfig

Szczegóły właściwości

Nazwa katalogu

string name

Wartość właściwości

string

Pełna ścieżka katalogu

string path

Wartość właściwości

string

Nazwa udziału odpowiadająca temu klientowi katalogu

string shareName

Wartość właściwości

string

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

accountName: string

Wartość właściwości

string

Dziedziczone z StorageClient.accountName

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

Dziedziczone z StorageClient.url

Szczegóły metody

Tworzy nowy katalog w określonym udziale lub katalogu nadrzędnym.

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

function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>

Parametry

options: DirectoryCreateOptions

Opcje operacji tworzenia katalogu.

Zwraca

Promise<DirectoryCreateResponse>

Dane odpowiedzi dla operacji katalogu.

Tworzy nowy plik lub zastępuje plik w tym katalogu. Zanotuj, że inicjuje tylko plik bez zawartości.

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

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Parametry

fileName: string

size: number

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

options: FileCreateOptions

Opcje operacji tworzenia pliku.

Zwraca

Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Dane odpowiedzi tworzenia pliku i odpowiedni klient pliku.

Tworzy nowy katalog w określonym udziale lub katalogu nadrzędnym, jeśli jeszcze nie istnieje. Jeśli katalog już istnieje, nie jest on modyfikowany.

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

function createIfNotExists(options?: DirectoryCreateOptions): Promise<DirectoryCreateIfNotExistsResponse>

Parametry

options: DirectoryCreateOptions

Zwraca

Promise<DirectoryCreateIfNotExistsResponse>

Tworzy nowy podkatalog w tym katalogu.

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

function createSubdirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Parametry

directoryName: string

options: DirectoryCreateOptions

Opcje operacji tworzenia katalogu.

Zwraca

Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Katalog tworzy dane odpowiedzi i odpowiadające mu wystąpienie DirectoryClient.

Usuwa określony pusty katalog. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć.

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

function delete(options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

Parametry

options: DirectoryDeleteOptions

Opcje operacji usuwania katalogu.

Zwraca

Promise<DirectoryDeleteResponse>

Dane odpowiedzi dla operacji Usuwanie katalogu.

Usuwa określony plik w tym katalogu z konta magazynu. Po pomyślnym usunięciu pliku zostanie natychmiast usunięty z indeksu konta magazynu i nie będzie 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 migawce udziału, która jest kopią udziału tylko do odczytu. Próba wykonania tej operacji na migawce udziału zakończy się niepowodzeniem z wartością 400 (InvalidQueryParameterValue)

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

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

Parametry

fileName: string

Nazwa pliku do usunięcia

options: FileDeleteOptions

Opcje operacji usuwania pliku.

Zwraca

Promise<FileDeleteResponse>

Dane odpowiedzi na usunięcie pliku.

Usuwa określony pusty katalog, jeśli istnieje. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć.

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

function deleteIfExists(options?: DirectoryDeleteOptions): Promise<DirectoryDeleteIfExistsResponse>

Parametry

options: DirectoryDeleteOptions

Zwraca

Promise<DirectoryDeleteIfExistsResponse>

Usuwa określony pusty podkatalog w tym katalogu. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć.

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

function deleteSubdirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

Parametry

directoryName: string

options: DirectoryDeleteOptions

Opcje operacji usuwania katalogu.

Zwraca

Promise<DirectoryDeleteResponse>

Dane odpowiedzi na usunięcie katalogu.

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

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

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

Parametry

options: DirectoryExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

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

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

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

Parametry

options: DirectoryForceCloseHandlesSegmentOptions

Zwraca

Promise<CloseHandlesInfo>

Wymuś zamknięcie określonego dojścia dla katalogu.

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

function forceCloseHandle(handleId: string, options?: DirectoryForceCloseHandlesOptions): Promise<DirectoryForceCloseHandlesResponse>

Parametry

handleId: string

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

options: DirectoryForceCloseHandlesOptions

Zwraca

Promise<DirectoryForceCloseHandlesResponse>

Tworzy obiekt ShareDirectoryClient dla katalogu podrzędnego.

function getDirectoryClient(subDirectoryName: string): ShareDirectoryClient

Parametry

subDirectoryName: string

Nazwa podkatalogu

Zwraca

ShareDirectoryClient

Obiekt ShareDirectoryClient dla danej nazwy podkatalogu.

Przykład użycia:

const directoryClient = shareClient.getDirectoryClient("<directory name>");
await directoryClient.create();
console.log("Created directory successfully");

Tworzy obiekt ShareFileClient .

function getFileClient(fileName: string): ShareFileClient

Parametry

fileName: string

Nazwa pliku.

Zwraca

ShareFileClient

Nowy obiekt ShareFileClient dla danej nazwy pliku.

Przykład użycia:

const content = "Hello world!"

const fileClient = directoryClient.getFileClient("<file name>");

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

await fileClient.uploadRange(content, 0, content.length);
console.log("Updated file successfully!")

Zwraca wszystkie właściwości systemu dla określonego katalogu, a także może służyć do sprawdzania istnienia katalogu. Zwrócone dane nie zawierają plików w katalogu ani żadnych podkatalogach.

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

function getProperties(options?: DirectoryGetPropertiesOptions): Promise<DirectoryGetPropertiesResponse>

Parametry

options: DirectoryGetPropertiesOptions

Opcje operacji Pobieranie właściwości do katalogu.

Zwraca

Promise<DirectoryGetPropertiesResponse>

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

Zwraca iterator asynchroniczny, aby wyświetlić listę wszystkich plików i katalogów w ramach określonego konta.

Funkcja .byPage() zwraca iterator asynchroniczny, aby wyświetlić listę plików i katalogów na stronach.

Przykład użycia for await składni:

let i = 1;
for await (const entity of directoryClient.listFilesAndDirectories()) {
  if (entity.kind === "directory") {
    console.log(`${i++} - directory\t: ${entity.name}`);
  } else {
    console.log(`${i++} - file\t: ${entity.name}`);
  }
}

Przykład przy użyciu polecenia iter.next():

let i = 1;
let iter = directoryClient.listFilesAndDirectories();
let entity = await iter.next();
while (!entity.done) {
  if (entity.value.kind === "directory") {
    console.log(`${i++} - directory\t: ${entity.value.name}`);
  } else {
    console.log(`${i++} - file\t: ${entity.value.name}`);
  }
  entity = await iter.next();
}

Przykład przy użyciu polecenia byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of directoryClient
  .listFilesAndDirectories()
  .byPage({ maxPageSize: 20 })) {
  for (const fileItem of response.segment.fileItems) {
    console.log(`${i++} - file\t: ${fileItem.name}`);
  }
  for (const dirItem of response.segment.directoryItems) {
    console.log(`${i++} - directory\t: ${dirItem.name}`);
  }
}

Przykład użycia stronicowania ze znacznikiem:

let i = 1;
let iterator = directoryClient.listFilesAndDirectories().byPage({ maxPageSize: 3 });
let response = (await iterator.next()).value;

// Prints 3 file and directory names
for (const fileItem of response.segment.fileItems) {
  console.log(`${i++} - file\t: ${fileItem.name}`);
}

for (const dirItem of response.segment.directoryItems) {
  console.log(`${i++} - directory\t: ${dirItem.name}`);
}

// Gets next marker
let dirMarker = response.continuationToken;

// Passing next marker as continuationToken
iterator = directoryClient
  .listFilesAndDirectories()
  .byPage({ continuationToken: dirMarker, maxPageSize: 4 });
response = (await iterator.next()).value;

// Prints 10 file and directory names
for (const fileItem of response.segment.fileItems) {
  console.log(`${i++} - file\t: ${fileItem.name}`);
}

for (const dirItem of response.segment.directoryItems) {
  console.log(`${i++} - directory\t: ${dirItem.name}`);
}

function listFilesAndDirectories(options?: DirectoryListFilesAndDirectoriesOptions): PagedAsyncIterableIterator<({ kind: "file" } & FileItem) | ({ kind: "directory" } & DirectoryItem), DirectoryListFilesAndDirectoriesSegmentResponse, PageSettings>

Parametry

options: DirectoryListFilesAndDirectoriesOptions

Opcje wyświetlania listy plików i katalogów.

Zwraca

PagedAsyncIterableIterator<({ kind: "file" } & FileItem) | ({ kind: "directory" } & DirectoryItem), DirectoryListFilesAndDirectoriesSegmentResponse, PageSettings>

AsyncIterableIterator, który obsługuje stronicowanie.

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.

Przykład użycia for await składni:

let i = 1;
let iter = dirClient.listHandles();
for await (const handle of iter) {
  console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
}

Przykład przy użyciu polecenia iter.next():

let i = 1;
let iter = dirClient.listHandles();
let handleItem = await iter.next();
while (!handleItem.done) {
  console.log(`Handle ${i++}: ${handleItem.value.path}, opened time ${handleItem.value.openTime}, clientIp ${handleItem.value.clientIp}`);
  handleItem = await iter.next();
}

Przykład przy użyciu polecenia byPage():

// passing optional maxPageSize in the page settings
let i = 1;
for await (const response of dirClient.listHandles({ recursive: true }).byPage({ maxPageSize: 20 })) {
  if (response.handleList) {
    for (const handle of response.handleList) {
      console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
    }
  }
}

Przykład użycia stronicowania ze znacznikiem:

let i = 1;
let iterator = dirClient.listHandles().byPage({ maxPageSize: 2 });
let response = await iterator.next();

// Prints 2 handles
if (response.value.handleList) {
  for (const handle of response.value.handleList) {
    console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
  }
}

// Gets next marker
let marker = response.value.continuationToken;

// Passing next marker as continuationToken
console.log(`    continuation`);
iterator = dirClient.listHandles().byPage({ continuationToken: marker, maxPageSize: 10 });
response = await iterator.next();

// Prints 2 more handles assuming you have more than four directory/files opened
if (!response.done && response.value.handleList) {
  for (const handle of response.value.handleList) {
    console.log(`Handle ${i++}: ${handle.path}, opened time ${handle.openTime}, clientIp ${handle.clientIp}`);
  }
}

function listHandles(options?: DirectoryListHandlesOptions): PagedAsyncIterableIterator<HandleItem, DirectoryListHandlesResponse, PageSettings>

Parametry

options: DirectoryListHandlesOptions

Opcje wyświetlania listy operacji obsługi.

AsyncIterableIterator, który obsługuje stronicowanie.

Zwraca

PagedAsyncIterableIterator<HandleItem, DirectoryListHandlesResponse, PageSettings>

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

function rename(destinationPath: string, options?: DirectoryRenameOptions): Promise<{ destinationDirectoryClient: ShareDirectoryClient, directoryRenameResponse: DirectoryRenameResponse }>

Parametry

destinationPath: string

Określa ścieżkę docelową do zmiany nazwy na. Ścieżka zostanie zakodowana w celu wprowadzenia do adresu URL w celu określenia miejsca docelowego.

options: DirectoryRenameOptions

Opcje operacji zmiany nazwy.

Zwraca

Promise<{ destinationDirectoryClient: ShareDirectoryClient, directoryRenameResponse: DirectoryRenameResponse }>

Dane odpowiedzi dla operacji zmiany nazwy pliku.

Przykład użycia:


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

Aktualizacje metadanych zdefiniowanych przez użytkownika dla określonego katalogu.

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

function setMetadata(metadata?: Metadata, options?: DirectorySetMetadataOptions): Promise<DirectorySetMetadataResponse>

Parametry

metadata: Metadata

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

options: DirectorySetMetadataOptions

Opcje operacji Ustawianie metadanych w katalogu.

Zwraca

Promise<DirectorySetMetadataResponse>

Dane odpowiedzi dla operacji ustawiania metadanych zestawu katalogów.

Ustawia właściwości w katalogu.

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

function setProperties(properties?: DirectoryProperties): Promise<DirectorySetPropertiesResponse>

Parametry

properties: DirectoryProperties

Zwraca

Promise<DirectorySetPropertiesResponse>

Udostępnij za pośrednictwem

ShareDirectoryClient class

Konstruktory

Właściwości

Właściwości dziedziczone

Metody

Szczegóły konstruktora

ShareDirectoryClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Parametry

ShareDirectoryClient(string, Pipeline, ShareClientConfig)

Parametry

Szczegóły właściwości

name

Wartość właściwości

path

Wartość właściwości

shareName

Wartość właściwości

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

accountName

Wartość właściwości

url

Wartość właściwości

Szczegóły metody

create(DirectoryCreateOptions)

Parametry

Zwraca

createFile(string, number, FileCreateOptions)

Parametry

Zwraca

createIfNotExists(DirectoryCreateOptions)

Parametry

Zwraca

createSubdirectory(string, DirectoryCreateOptions)

Parametry

Zwraca

delete(DirectoryDeleteOptions)

Parametry

Zwraca

deleteFile(string, FileDeleteOptions)

Parametry

Zwraca

deleteIfExists(DirectoryDeleteOptions)

Parametry

Zwraca

deleteSubdirectory(string, DirectoryDeleteOptions)

Parametry

Zwraca

exists(DirectoryExistsOptions)

Parametry

Zwraca

forceCloseAllHandles(DirectoryForceCloseHandlesSegmentOptions)

Parametry

Zwraca

forceCloseHandle(string, DirectoryForceCloseHandlesOptions)

Parametry

Zwraca

getDirectoryClient(string)

Parametry

Zwraca

getFileClient(string)

Parametry

Zwraca

getProperties(DirectoryGetPropertiesOptions)

Parametry

Zwraca

listFilesAndDirectories(DirectoryListFilesAndDirectoriesOptions)

Parametry

Zwraca

listHandles(DirectoryListHandlesOptions)

Parametry

Zwraca

rename(string, DirectoryRenameOptions)

Parametry

Zwraca

setMetadata(Metadata, DirectorySetMetadataOptions)

Parametry

Zwraca

setProperties(DirectoryProperties)

Parametry