Udostępnij za pośrednictwem

ShareDirectoryClient class

  • Odwołanie
Pakiet:
@azure/storage-file-share

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

Rozszerzenie

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://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)

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

Zobacz https://learn.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 modyfikowany.

Zobacz https://learn.microsoft.com/en-us/rest/api/storageservices/create-directory
createSubdirectory(string, DirectoryCreateOptions)

Tworzy nowy podkatalog w tym katalogu.

Zobacz https://learn.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://learn.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 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://learn.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://learn.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://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory
exists(DirectoryExistsOptions)

Zwraca wartość true, jeśli istnieje określony katalog; 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://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
forceCloseHandle(string, DirectoryForceCloseHandlesOptions)

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

Zobacz https://learn.microsoft.com/en-us/rest/api/storageservices/force-close-handles
getDirectoryClient(string)

Tworzy obiekt ShareDirectoryClient dla podkatalogu.
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://learn.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 składni for await:

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 użycia 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 użycia 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 składni for await:

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 użycia 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 użycia 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)

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

Zobacz https://learn.microsoft.com/en-us/rest/api/storageservices/set-directory-metadata
setProperties(DirectoryProperties)

Ustawia właściwości w katalogu.

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

Szczegóły konstruktora

ShareDirectoryClient(string, Credential_2 | TokenCredential, ShareClientOptions)

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 jest używana funkcja AnonymousCredential, na przykład "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 dwukrotnie uniknięci. Tylko znaki specjalne w ścieżce adresu URL zostaną uniknięci. 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

Fakultatywny. Opcje konfigurowania potoku HTTP.

ShareDirectoryClient(string, Pipeline, ShareClientConfig)

Tworzy wystąpienie klasy DirectoryClient.

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

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 jest używana funkcja AnonymousCredential, na przykład "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 dwukrotnie uniknięci. Tylko znaki specjalne w ścieżce adresu URL zostaną uniknięci. 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".

pipeline
Pipeline

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

options
ShareClientConfig

Szczegóły właściwości

name

Nazwa katalogu

string name

Wartość właściwości

string

path

Pełna ścieżka katalogu

string path

Wartość właściwości

string

shareName

Nazwa udziału odpowiadająca temu klientowi katalogu

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

create(DirectoryCreateOptions)

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

Zobacz https://learn.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 Katalog.

createFile(string, number, FileCreateOptions)

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

Zobacz https://learn.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.

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 modyfikowany.

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

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

Parametry

options
DirectoryCreateOptions

Zwraca

Promise<DirectoryCreateIfNotExistsResponse>

createSubdirectory(string, DirectoryCreateOptions)

Tworzy nowy podkatalog w tym katalogu.

Zobacz https://learn.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.

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://learn.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.

deleteFile(string, FileDeleteOptions)

Usuwa określony plik w tym katalogu 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://learn.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.

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://learn.microsoft.com/en-us/rest/api/storageservices/delete-directory

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

Parametry

options
DirectoryDeleteOptions

Zwraca

Promise<DirectoryDeleteIfExistsResponse>

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://learn.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.

exists(DirectoryExistsOptions)

Zwraca wartość true, jeśli istnieje określony katalog; 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>

forceCloseAllHandles(DirectoryForceCloseHandlesSegmentOptions)

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

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

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

Parametry

options
DirectoryForceCloseHandlesSegmentOptions

Zwraca

Promise<CloseHandlesInfo>

forceCloseHandle(string, DirectoryForceCloseHandlesOptions)

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

Zobacz https://learn.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>

getDirectoryClient(string)

Tworzy obiekt ShareDirectoryClient dla podkatalogu.

function getDirectoryClient(subDirectoryName: string): ShareDirectoryClient

Parametry

subDirectoryName

string

Nazwa podkatalogu

Zwraca

ShareDirectoryClient

Obiekt ShareDirectoryClient dla danej nazwy podkatalogu.

Przykładowe użycie:

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

getFileClient(string)

Tworzy obiekt ShareFileClient.

function getFileClient(fileName: string): ShareFileClient

Parametry

fileName

string

Nazwa pliku.

Zwraca

ShareFileClient

Nowy obiekt ShareFileClient dla podanej nazwy pliku.

Przykładowe użycie:

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!")

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://learn.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 w katalogu.

Zwraca

Promise<DirectoryGetPropertiesResponse>

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

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 składni for await:

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 użycia 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 użycia 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 operacji.

Zwraca

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

AsyncIterableIterator, który obsługuje stronicowanie.

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 składni for await:

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 użycia 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 użycia 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>

rename(string, DirectoryRenameOptions)

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 którego ma być zmieniona nazwa. Ś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ładowe użycie:


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

setMetadata(Metadata, DirectorySetMetadataOptions)

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

Zobacz https://learn.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 ustawiania metadanych w katalogu.

Zwraca

Promise<DirectorySetMetadataResponse>

Dane odpowiedzi dla operacji ustawiania metadanych zestawu katalogów.

setProperties(DirectoryProperties)

Ustawia właściwości w katalogu.

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

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

Parametry

properties
DirectoryProperties

Zwraca

Promise<DirectorySetPropertiesResponse>