ShareDirectoryClient class

Cria uma instância do DirectoryClient.

new ShareDirectoryClient(url: string, credential?: Credential_2, options?: StoragePipelineOptions)

Parâmetros

Cria uma instância do DirectoryClient.

new ShareDirectoryClient(url: string, pipeline: Pipeline)

Parâmetros

O nome do diretório

string name

Valor de Propriedade

O caminho completo do diretório

string path

Valor de Propriedade

O nome da partilha correspondente a este cliente de diretório

string shareName

Valor de Propriedade

accountName: string

Valor de Propriedade

Herdado deStorageClient.accountName

Valor da cadeia de URL.

url: string

Valor de Propriedade

Herdado deStorageClient.url

Cria um novo diretório no diretório de partilha ou principal especificado.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação diretório.

Cria um novo ficheiro ou substitui um ficheiro neste diretório. Tenha em atenção que apenas inicializa o ficheiro sem conteúdo.

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

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

Parâmetros

Devoluções

Dados de resposta de criação de ficheiros e o cliente de ficheiro correspondente.

Cria um novo diretório no diretório de partilha ou principal especificado se ainda não existir. Se o diretório já existir, não será modificado.

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

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

Parâmetros

Devoluções

Cria um novo subdiretório neste diretório.

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

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

Parâmetros

Devoluções

O diretório cria dados de resposta e a instância directoryClient correspondente.

Remove o diretório vazio especificado. Tenha em atenção que o diretório tem de estar vazio antes de poder ser eliminado.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação Eliminação de Diretórios.

Remove o ficheiro especificado neste diretório da conta de armazenamento. Quando um ficheiro é eliminado com êxito, é imediatamente removido do índice da conta de armazenamento e já não está acessível aos clientes. Os dados do ficheiro são posteriormente removidos do serviço durante a recolha do lixo. Eliminar Ficheiro falhará com o código de estado 409 (Conflito) e o código de erro SharingViolation se o ficheiro estiver aberto num cliente SMB.

Eliminar Ficheiro não é suportado num instantâneo de partilha, que é uma cópia só de leitura de uma partilha. Uma tentativa de executar esta operação num instantâneo de partilha falhará com 400 (InvalidQueryParameterValue)

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

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

Parâmetros

Devoluções

Dados de resposta de eliminação de ficheiros.

Remove o diretório vazio especificado se existir. Tenha em atenção que o diretório tem de estar vazio antes de poder ser eliminado.

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

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

Parâmetros

Devoluções

Remove o subdiretório vazio especificado neste diretório. Tenha em atenção que o diretório tem de estar vazio antes de poder ser eliminado.

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

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

Parâmetros

Devoluções

Dados de resposta de eliminação de diretórios.

Devolve verdadeiro se o diretório especificado existir; falso de outra forma. NOTA: utilize esta função com cuidado, uma vez que um diretório existente pode ser eliminado por outros clientes ou aplicações. Os novos diretórios vice-versa podem ser adicionados por outros clientes ou aplicações após a conclusão desta função.

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

Parâmetros

Devoluções

Forçar fechar todas as alças de um diretório.

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

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

Parâmetros

Devoluções

Forçar a fecho de uma alça específica para um diretório.

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

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

Parâmetros

Devoluções

Cria um objeto ShareDirectoryClient para um subdiretório.

function getDirectoryClient(subDirectoryName: string): ShareDirectoryClient

Parâmetros

Devoluções

O objeto ShareDirectoryClient para o nome do subdiretório especificado.

Utilização de exemplo:

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

Cria um ShareFileClient objeto.

function getFileClient(fileName: string): ShareFileClient

Parâmetros

Devoluções

Um novo objeto ShareFileClient para o nome de ficheiro especificado.

Utilização de exemplo:

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

Devolve todas as propriedades do sistema para o diretório especificado e também pode ser utilizado para verificar a existência de um diretório. Os dados devolvidos não incluem os ficheiros no diretório ou subdiretórios.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação Obter Propriedades do Diretório.

Devolve um iterador iterável assíncrono para listar todos os ficheiros e diretórios na conta especificada. .byPage() devolve um iterador iterável assíncrono para listar os ficheiros e diretórios em páginas.

Exemplo com for await sintaxe:

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

Exemplo com 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();
}

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

Exemplo a utilizar a paginação com um marcador:

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>

Parâmetros

Devoluções

Um asyncIterableIterator que suporta paginação.

Devolve um iterador iterável assíncrono para listar todos os identificadores. na conta especificada. .byPage() devolve um iterador iterável assíncrono para listar os identificadores nas páginas.

Exemplo com for await sintaxe:

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

Exemplo com 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();
}

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

Exemplo a utilizar a paginação com um marcador:

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>

Parâmetros

Devoluções

Muda o nome de um diretório. Esta API só suporta mudar o nome de um diretório na mesma partilha.

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

Parâmetros

Devoluções

Dados de resposta para a operação de mudança de nome do ficheiro.

Utilização de exemplo:

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

Atualizações metadados definidos pelo utilizador para o diretório especificado.

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

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

Parâmetros

Devoluções

Dados de resposta para a operação de Metadados do Conjunto de Diretórios.

Define as propriedades no diretório.

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

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

Parâmetros

Devoluções