ShareDirectoryClient class

Crée une instance de DirectoryClient.

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

Paramètres

Crée une instance de DirectoryClient.

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

Paramètres

Nom du répertoire

string name

Valeur de propriété

Chemin d’accès complet du répertoire

string path

Valeur de propriété

Nom de partage correspondant à ce client d’annuaire

string shareName

Valeur de propriété

accountName: string

Valeur de propriété

Hérité de StorageClient.accountName

Valeur de chaîne d’URL.

url: string

Valeur de propriété

Hérité de StorageClient.url

Crée un répertoire sous le partage ou le répertoire parent spécifié.

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

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

Paramètres

Retours

Données de réponse pour l’opération Directory.

Crée un fichier ou remplace un fichier sous ce répertoire. Notez qu’il initialise uniquement le fichier sans contenu.

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

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

Paramètres

Retours

Données de réponse de création de fichier et le client de fichier correspondant.

Crée un répertoire sous le partage ou le répertoire parent spécifié s’il n’existe pas déjà. Si le répertoire existe déjà, il n’est pas modifié.

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

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

Paramètres

Retours

Crée un sous-répertoire sous ce répertoire.

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

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

Paramètres

Retours

Créez des données de réponse de répertoire et l’instance DirectoryClient correspondante.

Supprime le répertoire vide spécifié. Le répertoire doit être vide pour que vous puissiez le supprimer.

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

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

Paramètres

Retours

Données de réponse pour l’opération De suppression d’annuaire.

Supprime du compte de stockage le fichier spécifié sous ce répertoire. Quand un fichier est supprimé correctement, il est immédiatement retiré de l'index du compte de stockage et n'est plus accessible aux clients. Les données du fichier sont ensuite supprimées du service lors du nettoyage de la mémoire.

La suppression du fichier échoue avec le code d’état 409 (Conflit) et le code d’erreur SharingViolation si le fichier est ouvert sur un client SMB.

Supprimer un fichier n’est pas pris en charge sur un instantané de partage, qui est une copie en lecture seule d’un partage. Une tentative d’exécution de cette opération sur un instantané de partage échoue avec 400 (InvalidQueryParameterValue)

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

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

Paramètres

Retours

Données de réponse de suppression de fichier.

Supprime le répertoire vide spécifié s’il existe. Le répertoire doit être vide pour que vous puissiez le supprimer.

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

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

Paramètres

Retours

Supprime le sous-répertoire vide spécifié sous ce répertoire. Le répertoire doit être vide pour que vous puissiez le supprimer.

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

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

Paramètres

Retours

Données de réponse de suppression d’annuaire.

Retourne true si le répertoire spécifié existe ; false dans le cas contraire.

REMARQUE : utilisez cette fonction avec précaution, car un répertoire existant peut être supprimé par d’autres clients ou applications. Inversement, de nouveaux répertoires peuvent être ajoutés par d’autres clients ou applications une fois cette fonction terminée.

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

Paramètres

Retours

Forcer la fermeture de tous les handles d’un répertoire.

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

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

Paramètres

Retours

Forcer la fermeture d’un handle spécifique pour un répertoire.

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

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

Paramètres

Retours

Crée un objet ShareDirectoryClient pour un sous-répertoire.

function getDirectoryClient(subDirectoryName: string): ShareDirectoryClient

Paramètres

Retours

Objet ShareDirectoryClient pour le nom de sous-répertoire donné.

Exemple d’utilisation :

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

Crée un objet ShareFileClient .

function getFileClient(fileName: string): ShareFileClient

Paramètres

Retours

Nouvel objet ShareFileClient pour le nom de fichier donné.

Exemple d’utilisation :

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

Retourne toutes les propriétés système du répertoire spécifié et peut également être utilisée pour vérifier l’existence d’un répertoire. Les données renvoyées n'incluent pas les fichiers figurant dans le répertoire ou ses sous-répertoires.

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

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

Paramètres

Retours

Données de réponse pour l’opération Obtenir les propriétés du répertoire.

Retourne un itérateur itérable asynchrone pour répertorier tous les fichiers et répertoires sous le compte spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les fichiers et les répertoires dans les pages.

Exemple utilisant la for await syntaxe :

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}`);
  }
}

Exemple utilisant 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();
}

Exemple utilisant 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}`);
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

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>

Paramètres

Retours

AsyncIterableIterator qui prend en charge la pagination.

Retourne un itérateur itérable asynchrone pour répertorier tous les handles. sous le compte spécifié.

.byPage() retourne un itérateur itérable asynchrone pour répertorier les handles dans les pages.

Exemple utilisant la for await syntaxe :

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}`);
}

Exemple utilisant 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();
}

Exemple utilisant 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}`);
    }
  }
}

Exemple d’utilisation de la pagination avec un marqueur :

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>

Paramètres

Retours

Renomme un répertoire. Cette API prend uniquement en charge le renommage d’un répertoire dans le même partage.

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

Paramètres

Retours

Données de réponse pour l’opération de renommage de fichier.

Exemple d’utilisation :

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

Mises à jour métadonnées définies par l’utilisateur pour le répertoire spécifié.

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

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

Paramètres

Retours

Données de réponse pour l’opération de métadonnées d’ensemble d’annuaires.

Définit les propriétés du répertoire.

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

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

Paramètres

Retours