BlobContainerClient.GetBlobsByHierarchyAsync Método

Definição

Namespace:

Azure.Storage.Blobs

Assembly:

Azure.Storage.Blobs.dll

Pacote:

Azure.Storage.Blobs v12.19.1

Origem:

BlobContainerClient.cs

A GetBlobsByHierarchyAsync(BlobTraits, BlobStates, String, String, CancellationToken) operação retorna uma coleção assíncrona de blobs nesse contêiner. Enumerar os blobs pode fazer várias solicitações ao serviço ao buscar todos os valores. Os blobs são ordenados lexicograficamente pelo nome. Um delimiter pode ser usado para percorrer uma hierarquia virtual de blobs como se fosse um sistema de arquivos.

Para obter mais informações, consulte Listar Blobs.

public virtual Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobHierarchyItem> GetBlobsByHierarchyAsync (Azure.Storage.Blobs.Models.BlobTraits traits = Azure.Storage.Blobs.Models.BlobTraits.None, Azure.Storage.Blobs.Models.BlobStates states = Azure.Storage.Blobs.Models.BlobStates.None, string delimiter = default, string prefix = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetBlobsByHierarchyAsync : Azure.Storage.Blobs.Models.BlobTraits * Azure.Storage.Blobs.Models.BlobStates * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobHierarchyItem>
override this.GetBlobsByHierarchyAsync : Azure.Storage.Blobs.Models.BlobTraits * Azure.Storage.Blobs.Models.BlobStates * string * string * System.Threading.CancellationToken -> Azure.AsyncPageable<Azure.Storage.Blobs.Models.BlobHierarchyItem>

Public Overridable Function GetBlobsByHierarchyAsync (Optional traits As BlobTraits = Azure.Storage.Blobs.Models.BlobTraits.None, Optional states As BlobStates = Azure.Storage.Blobs.Models.BlobStates.None, Optional delimiter As String = Nothing, Optional prefix As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AsyncPageable(Of BlobHierarchyItem)

Parâmetros

traits

BlobTraits

Especifica as opções de característica para formatar os blobs.

states

BlobStates

Especifica as opções de estado para filtrar os blobs.

delimiter

String

Um delimiter que pode ser usado para percorrer uma hierarquia virtual de blobs como se fosse um sistema de arquivos. O delimitador pode ser um único caractere ou uma cadeia de caracteres. Prefix será retornado no lugar de todos os blobs cujos nomes começam com a mesma subcadeia de caracteres até a aparência do caractere delimitador. O valor de um prefixo é substring+delimiter, em que substring é a subcadeia de caracteres comum que inicia um ou mais nomes de blob e delimitador é o valor de delimiter. Você pode usar o valor do prefixo para fazer uma chamada subsequente para listar os blobs que começam com esse prefixo, especificando o valor do prefixo para o prefix.

Observe que cada elemento BlobPrefix retornado conta para o resultado máximo, assim como cada elemento Blob faz.

prefix

String

Especifica uma cadeia de caracteres que filtra os resultados para retornar apenas blobs cujo nome começa com o especificado prefix.

cancellationToken

CancellationToken

Opcional CancellationToken para propagar notificações de que a operação deve ser cancelada.

Retornos

AsyncPageable<BlobHierarchyItem>

Um AsyncPageable<T> que descreve os blobs no contêiner.

Comentários

Um RequestFailedException será gerado se ocorrer uma falha.