azure.storage.blob.aio.BlobPrefix.yml

### YamlMime:PythonClass
uid: azure.storage.blob.aio.BlobPrefix
name: BlobPrefix
fullName: azure.storage.blob.aio.BlobPrefix
module: azure.storage.blob.aio
inheritances:
- azure.core.async_paging.AsyncItemPaged
- azure.storage.blob._shared.models.DictMixin
summary: 'An Iterable of Blob properties.


  Returned from walk_blobs when a delimiter is used.

  Can be thought of as a virtual blob directory.'
constructor:
  syntax: BlobPrefix(*args, **kwargs)
  parameters:
  - name: command
    description: Function to retrieve the next page of items.
    isRequired: true
    types:
    - <xref:callable>
  - name: prefix
    description: 'Filters the results to return only blobs whose names

      begin with the specified prefix.'
    isRequired: true
    types:
    - <xref:str>
  - name: results_per_page
    description: 'The maximum number of blobs to retrieve per

      call.'
    isRequired: true
    types:
    - <xref:int>
  - name: marker
    description: An opaque continuation token.
    isRequired: true
    types:
    - <xref:str>
  - name: delimiter
    description: 'Used to capture blobs whose names begin with the same substring
      up to

      the appearance of the delimiter character. The delimiter may be a single

      character or a string.'
    isRequired: true
    types:
    - <xref:str>
  - name: location_mode
    description: 'Specifies the location the request should be sent to.

      This mode only applies for RA-GRS accounts which allow secondary read access.

      Options include ''primary'' or ''secondary''.'
    isRequired: true
variables:
- description: The prefix, or "directory name" of the blob.
  name: name
  types:
  - <xref:str>
- description: A blob name prefix being used to filter the list.
  name: prefix
  types:
  - <xref:str>
- description: The maximum number of results retrieved per API call.
  name: results_per_page
  types:
  - <xref:int>
- description: The continuation token of the current page of results.
  name: marker
  types:
  - <xref:str>
- description: 'The location mode being used to list results. The available

    options include "primary" and "secondary".'
  name: location_mode
  types:
  - <xref:str>
- description: The current page of listed results.
  name: current_page
  types:
  - <xref:list>(<xref:azure.storage.blob.models.BlobProperties>)
- description: The container that the blobs are listed from.
  name: container
  types:
  - <xref:str>
- description: A delimiting character used for hierarchy listing.
  name: delimiter
  types:
  - <xref:str>
methods:
- uid: azure.storage.blob.aio.BlobPrefix.by_page
  name: by_page
  summary: Get an async iterator of pages of objects, instead of an async iterator
    of objects.
  signature: 'by_page(continuation_token: str | None = None) -> AsyncIterator[AsyncIterator[ReturnType]]'
  parameters:
  - name: continuation_token
    description: 'An opaque continuation token. This value can be retrieved from the

      continuation_token field of a previous generator object. If specified,

      this generator will begin returning results from this point.'
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An async iterator of pages (themselves async iterator of objects)
    types:
    - <xref:typing.AsyncIterator>[<xref:typing.AsyncIterator>[<xref:ReturnType>]]
- uid: azure.storage.blob.aio.BlobPrefix.get
  name: get
  signature: get(key, default=None)
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.storage.blob.aio.BlobPrefix.has_key
  name: has_key
  signature: has_key(k)
  parameters:
  - name: k
    isRequired: true
- uid: azure.storage.blob.aio.BlobPrefix.items
  name: items
  signature: items()
- uid: azure.storage.blob.aio.BlobPrefix.keys
  name: keys
  signature: keys()
- uid: azure.storage.blob.aio.BlobPrefix.update
  name: update
  signature: update(*args, **kwargs)
- uid: azure.storage.blob.aio.BlobPrefix.values
  name: values
  signature: values()