azure.storage.blob.appendblobservice.AppendBlobService.yml

### YamlMime:PythonClass
uid: azure.storage.blob.appendblobservice.AppendBlobService
name: AppendBlobService
fullName: azure.storage.blob.appendblobservice.AppendBlobService
module: azure.storage.blob.appendblobservice
inheritances:
- azure.storage.blob.baseblobservice.BaseBlobService
summary: 'An append blob is comprised of blocks and is optimized for append operations.

  When you modify an append blob, blocks are added to the end of the blob only,

  via the append_block operation. Updating or deleting of existing blocks is not

  supported. Unlike a block blob, an append blob does not expose its block IDs.


  Each block in an append blob can be a different size, up to a maximum of 4 MB,

  and an append blob can include up to 50,000 blocks. The maximum size of an

  append blob is therefore slightly more than 195 GB (4 MB X 50,000 blocks).


  :type *~azure.storage.common.TokenCredential*'
constructor:
  syntax: AppendBlobService(account_name=None, account_key=None, sas_token=None, is_emulated=False,
    protocol='https', endpoint_suffix='core.windows.net', custom_domain=None, request_session=None,
    connection_string=None, socket_timeout=None, token_credential=None)
  parameters:
  - name: account_name
    description: 'The storage account name. This is used to authenticate requests

      signed with an account key and to construct the storage endpoint. It

      is required unless a connection string is given, or if a custom

      domain is used with anonymous authentication.'
    defaultValue: None
    types:
    - <xref:str>
  - name: account_key
    description: 'The storage account key. This is used for shared key authentication.

      If neither account key or sas token is specified, anonymous access

      will be used.'
    defaultValue: None
    types:
    - <xref:str>
  - name: sas_token
    description: 'A shared access signature token to use to authenticate requests

      instead of the account key. If account key and sas token are both

      specified, account key will be used to sign. If neither are

      specified, anonymous access will be used.'
    defaultValue: None
    types:
    - <xref:str>
  - name: is_emulated
    description: 'Whether to use the emulator. Defaults to False. If specified, will

      override all other parameters besides connection string and request

      session.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: protocol
    description: The protocol to use for requests. Defaults to https.
    defaultValue: https
    types:
    - <xref:str>
  - name: endpoint_suffix
    description: 'The host base component of the url, minus the account name. Defaults

      to Azure (core.windows.net). Override this to use the China cloud

      (core.chinacloudapi.cn).'
    defaultValue: core.windows.net
    types:
    - <xref:str>
  - name: custom_domain
    description: 'The custom domain to use. This can be set in the Azure Portal. For

      example, ''www.mydomain.com''.'
    defaultValue: None
    types:
    - <xref:str>
  - name: request_session
    description: The session object to use for http requests.
    defaultValue: None
    types:
    - <xref:requests.Session>
  - name: connection_string
    description: 'If specified, this will override all other parameters besides

      request session. See

      [http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/](http://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string/)

      for the connection string format.'
    defaultValue: None
    types:
    - <xref:str>
  - name: socket_timeout
    description: 'If specified, this will override the default socket timeout. The
      timeout specified is in seconds.

      See DEFAULT_SOCKET_TIMEOUT in _constants.py for the default value.'
    defaultValue: None
    types:
    - <xref:int>
  - name: token_credential
    description: 'A token credential used to authenticate HTTPS requests. The token
      value

      should be updated before its expiration.'
    defaultValue: None
variables:
- description: 'The size of the blocks put by append_blob_from_* methods. Smaller
    blocks

    may be put if there is less data provided. The maximum block size the service

    supports is 4MB.'
  name: MAX_BLOCK_SIZE
  types:
  - <xref:int>
methods:
- uid: azure.storage.blob.appendblobservice.AppendBlobService.abort_copy_blob
  name: abort_copy_blob
  summary: 'Aborts a pending copy_blob operation, and leaves a destination blob

    with zero length and full metadata.'
  signature: abort_copy_blob(container_name, blob_name, copy_id, lease_id=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of destination container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of destination blob.
    isRequired: true
    types:
    - <xref:str>
  - name: copy_id
    description: 'Copy identifier provided in the copy.id of the original

      copy_blob operation.'
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: Required if the destination blob has an active infinite lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.acquire_blob_lease
  name: acquire_blob_lease
  summary: 'Requests a new lease. If the blob does not have an active lease, the Blob

    service creates a lease on the blob and returns a new lease ID.'
  signature: acquire_blob_lease(container_name, blob_name, lease_duration=-1, proposed_lease_id=None,
    if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None,
    timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_duration
    description: 'Specifies the duration of the lease, in seconds, or negative one

      (-1) for a lease that never expires. A non-infinite lease can be

      between 15 and 60 seconds. A lease duration cannot be changed

      using renew or change. Default is -1 (infinite lease).'
    defaultValue: '-1'
    types:
    - <xref:int>
  - name: proposed_lease_id
    description: 'Proposed lease ID, in a GUID string format. The Blob service

      returns 400 (Invalid request) if the proposed lease ID is not

      in the correct format.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: str
- uid: azure.storage.blob.appendblobservice.AppendBlobService.acquire_container_lease
  name: acquire_container_lease
  summary: 'Requests a new lease. If the container does not have an active lease,

    the Blob service creates a lease on the container and returns a new

    lease ID.'
  signature: acquire_container_lease(container_name, lease_duration=-1, proposed_lease_id=None,
    if_modified_since=None, if_unmodified_since=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_duration
    description: 'Specifies the duration of the lease, in seconds, or negative one

      (-1) for a lease that never expires. A non-infinite lease can be

      between 15 and 60 seconds. A lease duration cannot be changed

      using renew or change. Default is -1 (infinite lease).'
    defaultValue: '-1'
    types:
    - <xref:int>
  - name: proposed_lease_id
    description: 'Proposed lease ID, in a GUID string format. The Blob service returns

      400 (Invalid request) if the proposed lease ID is not in the correct format.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: str
- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_blob_from_bytes
  name: append_blob_from_bytes
  summary: 'Appends to the content of an existing blob from an array of bytes, with

    automatic chunking and progress notifications.'
  signature: append_blob_from_bytes(container_name, blob_name, blob, index=0, count=None,
    validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None,
    timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None,
    if_none_match=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of blob to create or update.
    isRequired: true
    types:
    - <xref:str>
  - name: blob
    description: Content of blob as an array of bytes.
    isRequired: true
    types:
    - <xref:bytes>
  - name: index
    description: Start index in the array of bytes.
    defaultValue: '0'
    types:
    - <xref:int>
  - name: count
    description: 'Number of bytes to upload. Set to None or negative value to upload

      all bytes starting from index.'
    defaultValue: None
    types:
    - <xref:int>
  - name: validate_content
    description: 'If true, calculates an MD5 hash for each chunk of the blob. The
      storage

      service checks the hash of the content that has arrived with the hash

      that was sent. This is primarily valuable for detecting bitflips on

      the wire if using http instead of https as https (the default) will

      already validate. Note that this MD5 hash is not stored with the

      blob.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: maxsize_condition
    description: 'Optional conditional header. The max length in bytes permitted for

      the append blob. If the Append Block operation would cause the blob

      to exceed that limit or if the blob size is already greater than the

      value specified in this header, the request will fail with

      MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).'
    defaultValue: None
    types:
    - <xref:int>
  - name: progress_callback
    description: 'Callback for progress with signature function(current, total) where

      current is the number of bytes transfered so far, and total is the

      size of the blob, or None if the total size is unknown.'
    defaultValue: None
    types:
    - <xref:func>(<xref:current>, <xref:total>)
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: 'The timeout parameter is expressed in seconds. This method may make

      multiple calls to the Azure service and the timeout will apply to

      each call individually.'
    defaultValue: None
    types:
    - <xref:int>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetime will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetime will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  return:
    description: ETag and last modified properties for the Append Blob
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_blob_from_path
  name: append_blob_from_path
  summary: 'Appends to the content of an existing blob from a file path, with automatic

    chunking and progress notifications.'
  signature: append_blob_from_path(container_name, blob_name, file_path, validate_content=False,
    maxsize_condition=None, progress_callback=None, lease_id=None, timeout=None, if_modified_since=None,
    if_unmodified_since=None, if_match=None, if_none_match=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of blob to create or update.
    isRequired: true
    types:
    - <xref:str>
  - name: file_path
    description: Path of the file to upload as the blob content.
    isRequired: true
    types:
    - <xref:str>
  - name: validate_content
    description: 'If true, calculates an MD5 hash for each chunk of the blob. The
      storage

      service checks the hash of the content that has arrived with the hash

      that was sent. This is primarily valuable for detecting bitflips on

      the wire if using http instead of https as https (the default) will

      already validate. Note that this MD5 hash is not stored with the

      blob.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: maxsize_condition
    description: 'Optional conditional header. The max length in bytes permitted for

      the append blob. If the Append Block operation would cause the blob

      to exceed that limit or if the blob size is already greater than the

      value specified in this header, the request will fail with

      MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).'
    defaultValue: None
    types:
    - <xref:int>
  - name: progress_callback
    description: 'Callback for progress with signature function(current, total) where

      current is the number of bytes transfered so far, and total is the

      size of the blob, or None if the total size is unknown.'
    defaultValue: None
    types:
    - <xref:func>(<xref:current>, <xref:total>)
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: 'The timeout parameter is expressed in seconds. This method may make

      multiple calls to the Azure service and the timeout will apply to

      each call individually.'
    defaultValue: None
    types:
    - <xref:int>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetime will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetime will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  return:
    description: ETag and last modified properties for the Append Blob
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_blob_from_stream
  name: append_blob_from_stream
  summary: 'Appends to the content of an existing blob from a file/stream, with

    automatic chunking and progress notifications.'
  signature: append_blob_from_stream(container_name, blob_name, stream, count=None,
    validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None,
    timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None,
    if_none_match=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of blob to create or update.
    isRequired: true
    types:
    - <xref:str>
  - name: stream
    description: Opened stream to upload as the blob content.
    isRequired: true
    types:
    - <xref:io.IOBase>
  - name: count
    description: 'Number of bytes to read from the stream. This is optional, but

      should be supplied for optimal performance.'
    defaultValue: None
    types:
    - <xref:int>
  - name: validate_content
    description: 'If true, calculates an MD5 hash for each chunk of the blob. The
      storage

      service checks the hash of the content that has arrived with the hash

      that was sent. This is primarily valuable for detecting bitflips on

      the wire if using http instead of https as https (the default) will

      already validate. Note that this MD5 hash is not stored with the

      blob.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: maxsize_condition
    description: 'Conditional header. The max length in bytes permitted for

      the append blob. If the Append Block operation would cause the blob

      to exceed that limit or if the blob size is already greater than the

      value specified in this header, the request will fail with

      MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).'
    defaultValue: None
    types:
    - <xref:int>
  - name: progress_callback
    description: 'Callback for progress with signature function(current, total) where

      current is the number of bytes transfered so far, and total is the

      size of the blob, or None if the total size is unknown.'
    defaultValue: None
    types:
    - <xref:func>(<xref:current>, <xref:total>)
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: 'The timeout parameter is expressed in seconds. This method may make

      multiple calls to the Azure service and the timeout will apply to

      each call individually.'
    defaultValue: None
    types:
    - <xref:int>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetime will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetime will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  return:
    description: ETag and last modified properties for the Append Blob
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_blob_from_text
  name: append_blob_from_text
  summary: 'Appends to the content of an existing blob from str/unicode, with

    automatic chunking and progress notifications.'
  signature: append_blob_from_text(container_name, blob_name, text, encoding='utf-8',
    validate_content=False, maxsize_condition=None, progress_callback=None, lease_id=None,
    timeout=None, if_modified_since=None, if_unmodified_since=None, if_match=None,
    if_none_match=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of blob to create or update.
    isRequired: true
    types:
    - <xref:str>
  - name: text
    description: Text to upload to the blob.
    isRequired: true
    types:
    - <xref:str>
  - name: encoding
    description: Python encoding to use to convert the text to bytes.
    defaultValue: utf-8
    types:
    - <xref:str>
  - name: validate_content
    description: 'If true, calculates an MD5 hash for each chunk of the blob. The
      storage

      service checks the hash of the content that has arrived with the hash

      that was sent. This is primarily valuable for detecting bitflips on

      the wire if using http instead of https as https (the default) will

      already validate. Note that this MD5 hash is not stored with the

      blob.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: maxsize_condition
    description: 'Optional conditional header. The max length in bytes permitted for

      the append blob. If the Append Block operation would cause the blob

      to exceed that limit or if the blob size is already greater than the

      value specified in this header, the request will fail with

      MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).'
    defaultValue: None
    types:
    - <xref:int>
  - name: progress_callback
    description: 'Callback for progress with signature function(current, total) where

      current is the number of bytes transfered so far, and total is the

      size of the blob, or None if the total size is unknown.'
    defaultValue: None
    types:
    - <xref:func>(<xref:current>, <xref:total>)
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: 'The timeout parameter is expressed in seconds. This method may make

      multiple calls to the Azure service and the timeout will apply to

      each call individually.'
    defaultValue: None
    types:
    - <xref:int>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetime will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetime will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  return:
    description: ETag and last modified properties for the Append Blob
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_block
  name: append_block
  summary: Commits a new block of data to the end of an existing append blob.
  signature: append_block(container_name, blob_name, block, validate_content=False,
    maxsize_condition=None, appendpos_condition=None, lease_id=None, if_modified_since=None,
    if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: block
    description: Content of the block in bytes.
    isRequired: true
    types:
    - <xref:bytes>
  - name: validate_content
    description: 'If true, calculates an MD5 hash of the block content. The storage

      service checks the hash of the content that has arrived

      with the hash that was sent. This is primarily valuable for detecting

      bitflips on the wire if using http instead of https as https (the default)

      will already validate. Note that this MD5 hash is not stored with the

      blob.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: maxsize_condition
    description: 'Optional conditional header. The max length in bytes permitted for

      the append blob. If the Append Block operation would cause the blob

      to exceed that limit or if the blob size is already greater than the

      value specified in this header, the request will fail with

      MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).'
    defaultValue: None
    types:
    - <xref:int>
  - name: appendpos_condition
    description: 'Optional conditional header, used only for the Append Block operation.

      A number indicating the byte offset to compare. Append Block will

      succeed only if the append position is equal to this number. If it

      is not, the request will fail with the

      AppendPositionConditionNotMet error

      (HTTP status code 412 - Precondition Failed).'
    defaultValue: None
    types:
    - <xref:int>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: 'ETag, last modified, append offset, and committed block count

      properties for the updated Append Blob'
    types:
    - <xref:azure.storage.blob.models.AppendBlockProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.append_block_from_url
  name: append_block_from_url
  summary: Creates a new block to be committed as part of a blob, where the contents
    are read from a source url.
  signature: append_block_from_url(container_name, blob_name, copy_source_url, source_range_start=None,
    source_range_end=None, source_content_md5=None, source_if_modified_since=None,
    source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None,
    maxsize_condition=None, appendpos_condition=None, lease_id=None, if_modified_since=None,
    if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of blob.
    isRequired: true
    types:
    - <xref:str>
  - name: copy_source_url
    description: 'The URL of the source data. It can point to any Azure Blob or File,
      that is either public or has a

      shared access signature attached.'
    isRequired: true
    types:
    - <xref:str>
  - name: source_range_start
    description: This indicates the start of the range of bytes(inclusive) that has
      to be taken from the copy source.
    defaultValue: None
    types:
    - <xref:int>
  - name: source_range_end
    description: This indicates the end of the range of bytes(inclusive) that has
      to be taken from the copy source.
    defaultValue: None
    types:
    - <xref:int>
  - name: source_content_md5
    description: If given, the service will calculate the MD5 hash of the block content
      and compare against this value.
    defaultValue: None
    types:
    - <xref:str>
  - name: source_if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the source resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: source_if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the source resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: source_if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the source resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: source_if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the source resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the source resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: maxsize_condition
    description: 'Optional conditional header. The max length in bytes permitted for

      the append blob. If the Append Block operation would cause the blob

      to exceed that limit or if the blob size is already greater than the

      value specified in this header, the request will fail with

      MaxBlobSizeConditionNotMet error (HTTP status code 412 - Precondition Failed).'
    defaultValue: None
    types:
    - <xref:int>
  - name: appendpos_condition
    description: 'Optional conditional header, used only for the Append Block operation.

      A number indicating the byte offset to compare. Append Block will

      succeed only if the append position is equal to this number. If it

      is not, the request will fail with the

      AppendPositionConditionNotMet error

      (HTTP status code 412 - Precondition Failed).'
    defaultValue: None
    types:
    - <xref:int>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.batch_delete_blobs
  name: batch_delete_blobs
  summary: 'Sends a batch of multiple blob delete requests.


    The blob delete method deletes the specified blob or snapshot. Note that deleting
    a blob also deletes all its

    snapshots. For more information, see [https://docs.microsoft.com/rest/api/storageservices/delete-blob](https://docs.microsoft.com/rest/api/storageservices/delete-blob)'
  signature: batch_delete_blobs(batch_delete_sub_requests, timeout=None)
  parameters:
  - name: batch_delete_sub_requests
    description: The blob delete requests to send as a batch.
    isRequired: true
    types:
    - <xref:list>(<xref:azure.storage.blob.models.BatchDeleteSubRequest>)
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: parsed batch delete HTTP response
    types:
    - <xref:list> <xref:of> <xref:azure.storage.blob.models.BatchSubResponse>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.break_blob_lease
  name: break_blob_lease
  summary: 'Breaks the lease, if the blob has an active lease. Once a lease is broken,

    it cannot be renewed. Any authorized request can break the lease; the request

    is not required to specify a matching lease ID. When a lease is broken,

    the lease break period is allowed to elapse, during which time no lease operation

    except break and release can be performed on the blob. When a lease is successfully

    broken, the response indicates the interval in seconds until a new lease can be
    acquired.


    A lease that has been broken can also be released, in which case another client
    may

    immediately acquire the lease on the blob.'
  signature: break_blob_lease(container_name, blob_name, lease_break_period=None,
    if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None,
    timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_break_period
    description: 'For a break operation, this is the proposed duration of

      seconds that the lease should continue before it is broken, between

      0 and 60 seconds. This break period is only used if it is shorter

      than the time remaining on the lease. If longer, the time remaining

      on the lease is used. A new lease will not be available before the

      break period has expired, but the lease may be held for longer than

      the break period. If this header does not appear with a break

      operation, a fixed-duration lease breaks after the remaining lease

      period elapses, and an infinite lease breaks immediately.'
    defaultValue: None
    types:
    - <xref:int>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: int
- uid: azure.storage.blob.appendblobservice.AppendBlobService.break_container_lease
  name: break_container_lease
  summary: 'Break the lease, if the container has an active lease. Once a lease is

    broken, it cannot be renewed. Any authorized request can break the lease;

    the request is not required to specify a matching lease ID. When a lease

    is broken, the lease break period is allowed to elapse, during which time

    no lease operation except break and release can be performed on the container.

    When a lease is successfully broken, the response indicates the interval

    in seconds until a new lease can be acquired.'
  signature: break_container_lease(container_name, lease_break_period=None, if_modified_since=None,
    if_unmodified_since=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_break_period
    description: 'This is the proposed duration of seconds that the lease

      should continue before it is broken, between 0 and 60 seconds. This

      break period is only used if it is shorter than the time remaining

      on the lease. If longer, the time remaining on the lease is used.

      A new lease will not be available before the break period has

      expired, but the lease may be held for longer than the break

      period. If this header does not appear with a break

      operation, a fixed-duration lease breaks after the remaining lease

      period elapses, and an infinite lease breaks immediately.'
    defaultValue: None
    types:
    - <xref:int>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: int
- uid: azure.storage.blob.appendblobservice.AppendBlobService.change_blob_lease
  name: change_blob_lease
  summary: 'Changes the lease ID of an active lease. A change must include the current

    lease ID and a new lease ID.'
  signature: change_blob_lease(container_name, blob_name, lease_id, proposed_lease_id,
    if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None,
    timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: Required if the blob has an active lease.
    isRequired: true
    types:
    - <xref:str>
  - name: proposed_lease_id
    description: 'Proposed lease ID, in a GUID string format. The Blob service returns

      400 (Invalid request) if the proposed lease ID is not in the correct format.'
    isRequired: true
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.change_container_lease
  name: change_container_lease
  summary: 'Change the lease ID of an active lease. A change must include the current

    lease ID and a new lease ID.'
  signature: change_container_lease(container_name, lease_id, proposed_lease_id, if_modified_since=None,
    if_unmodified_since=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: Lease ID for active lease.
    isRequired: true
    types:
    - <xref:str>
  - name: proposed_lease_id
    description: 'Proposed lease ID, in a GUID string format. The Blob service returns
      400

      (Invalid request) if the proposed lease ID is not in the correct format.'
    isRequired: true
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.copy_blob
  name: copy_blob
  summary: 'Copies a blob asynchronously. This operation returns a copy operation

    properties object, including a copy ID you can use to check or abort the

    copy operation. The Blob service copies blobs on a best-effort basis.


    The source blob for a copy operation may be a block blob, an append blob,

    or a page blob. If the destination blob already exists, it must be of the

    same blob type as the source blob. Any existing destination blob will be

    overwritten. The destination blob cannot be modified while a copy operation

    is in progress.


    When copying from a page blob, the Blob service creates a destination page

    blob of the source blob''s length, initially containing all zeroes. Then

    the source page ranges are enumerated, and non-empty ranges are copied.


    For a block blob or an append blob, the Blob service creates a committed

    blob of zero length before returning from this operation. When copying

    from a block blob, all committed blocks and their block IDs are copied.

    Uncommitted blocks are not copied. At the end of the copy operation, the

    destination blob will have the same committed block count as the source.


    When copying from an append blob, all committed blocks are copied. At the

    end of the copy operation, the destination blob will have the same committed

    block count as the source.


    For all blob types, you can call get_blob_properties on the destination

    blob to check the status of the copy operation. The final blob will be

    committed when the copy completes.'
  signature: copy_blob(container_name, blob_name, copy_source, metadata=None, source_if_modified_since=None,
    source_if_unmodified_since=None, source_if_match=None, source_if_none_match=None,
    destination_if_modified_since=None, destination_if_unmodified_since=None, destination_if_match=None,
    destination_if_none_match=None, destination_lease_id=None, source_lease_id=None,
    timeout=None)
  parameters:
  - name: container_name
    description: Name of the destination container. The container must exist.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: 'Name of the destination blob. If the destination blob exists, it
      will

      be overwritten. Otherwise, it will be created.'
    isRequired: true
    types:
    - <xref:str>
  - name: copy_source
    description: 'A URL of up to 2 KB in length that specifies an Azure file or blob.

      The value should be URL-encoded as it would appear in a request URI.

      If the source is in another account, the source must either be public

      or must be authenticated via a shared access signature. If the source

      is public, no authentication is required.

      Examples:

      [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob)

      [https://myaccount.blob.core.windows.net/mycontainer/myblob](https://myaccount.blob.core.windows.net/mycontainer/myblob)?snapshot=<DateTime>

      [https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken](https://otheraccount.blob.core.windows.net/mycontainer/myblob?sastoken)'
    isRequired: true
    types:
    - <xref:str>
  - name: metadata
    description: 'Name-value pairs associated with the blob as metadata. If no name-value

      pairs are specified, the operation will copy the metadata from the

      source blob or file to the destination blob. If one or more name-value

      pairs are specified, the destination blob is created with the specified

      metadata, and metadata is not copied from the source blob or file.'
    defaultValue: None
    types:
    - <xref:dict>(<xref:str>, <xref:str>)
  - name: source_if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this conditional header to copy the blob only if the source

      blob has been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: source_if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this conditional header to copy the blob only if the source blob

      has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: source_if_match
    description: 'An ETag value, or the wildcard character (*). Specify this conditional

      header to copy the source blob only if its ETag matches the value

      specified. If the ETag values do not match, the Blob service returns

      status code 412 (Precondition Failed). This header cannot be specified

      if the source is an Azure File.'
    defaultValue: None
    types:
    - <xref:ETag>
  - name: source_if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this conditional

      header to copy the blob only if its ETag does not match the value

      specified. If the values are identical, the Blob service returns status

      code 412 (Precondition Failed). This header cannot be specified if the

      source is an Azure File.'
    defaultValue: None
    types:
    - <xref:ETag>
  - name: destination_if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this conditional header to copy the blob only

      if the destination blob has been modified since the specified date/time.

      If the destination blob has not been modified, the Blob service returns

      status code 412 (Precondition Failed).'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: destination_if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this conditional header to copy the blob only

      if the destination blob has not been modified since the specified

      date/time. If the destination blob has been modified, the Blob service

      returns status code 412 (Precondition Failed).'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: destination_if_match
    description: 'An ETag value, or the wildcard character (*). Specify an ETag value
      for

      this conditional header to copy the blob only if the specified ETag value

      matches the ETag value for an existing destination blob. If the ETag for

      the destination blob does not match the ETag specified for If-Match, the

      Blob service returns status code 412 (Precondition Failed).'
    defaultValue: None
    types:
    - <xref:ETag>
  - name: destination_if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify an ETag value
      for

      this conditional header to copy the blob only if the specified ETag value

      does not match the ETag value for the destination blob. Specify the wildcard

      character (*) to perform the operation only if the destination blob does not

      exist. If the specified condition isn''t met, the Blob service returns status

      code 412 (Precondition Failed).'
    defaultValue: None
    types:
    - <xref:ETag>
  - name: destination_lease_id
    description: 'The lease ID specified for this header must match the lease ID of
      the

      destination blob. If the request does not include the lease ID or it is not

      valid, the operation fails with status code 412 (Precondition Failed).'
    defaultValue: None
    types:
    - <xref:str>
  - name: source_lease_id
    description: 'Specify this to perform the Copy Blob operation only if

      the lease ID given matches the active lease ID of the source blob.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: Copy operation properties such as status, source, and ID.
    types:
    - <xref:azure.storage.blob.models.CopyProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.create_blob
  name: create_blob
  summary: 'Creates a blob or overrides an existing blob. Use if_none_match=* to

    prevent overriding an existing blob.


    See create_blob_from_* for high level

    functions that handle the creation and upload of large blobs with

    automatic chunking and progress notifications.'
  signature: create_blob(container_name, blob_name, content_settings=None, metadata=None,
    lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None,
    if_none_match=None, timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of blob to create or update.
    isRequired: true
    types:
    - <xref:str>
  - name: content_settings
    description: ContentSettings object used to set blob properties.
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.ContentSettings>
  - name: metadata
    description: Name-value pairs associated with the blob as metadata.
    defaultValue: None
    types:
    - <xref:dict>(<xref:str>, <xref:str>)
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to

      perform the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: ETag and last modified properties for the updated Append Blob
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.create_container
  name: create_container
  summary: 'Creates a new container under the specified account. If the container

    with the same name already exists, the operation fails if

    fail_on_exist is True.'
  signature: create_container(container_name, metadata=None, public_access=None, fail_on_exist=False,
    timeout=None)
  parameters:
  - name: container_name
    description: 'Name of container to create.

      The container name may only contain lowercase letters, numbers, and hyphens,
      and must begin with a letter or

      a number. Each hyphen must be preceded and followed by a non-hyphen character.
      The name must also be

      between 3 and 63 characters long.'
    isRequired: true
    types:
    - <xref:str>
  - name: metadata
    description: 'A dict with name_value pairs to associate with the

      container as metadata. Example:{''Category'':''test''}'
    defaultValue: None
    types:
    - <xref:dict>(<xref:str>, <xref:str>)
  - name: public_access
    description: 'Possible values include: container, blob.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.PublicAccess>
  - name: fail_on_exist
    description: Specify whether to throw an exception when the container exists.
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: True if container is created, False if container already exists.
    types:
    - <xref:bool>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.delete_blob
  name: delete_blob
  summary: 'Marks the specified blob or snapshot for deletion.

    The blob is later deleted during garbage collection.


    Note that in order to delete a blob, you must delete all of its

    snapshots. You can delete both at the same time with the Delete

    Blob operation.


    If a delete retention policy is enabled for the service, then this operation soft
    deletes the blob or snapshot

    and retains the blob or snapshot for specified number of days.

    After specified number of days, blob''s data is removed from the service during
    garbage collection.

    Soft deleted blob or snapshot is accessible through List Blobs API specifying
    include=Include.Deleted option.

    Soft-deleted blob or snapshot can be restored using Undelete API.'
  signature: delete_blob(container_name, blob_name, snapshot=None, lease_id=None,
    delete_snapshots=None, if_modified_since=None, if_unmodified_since=None, if_match=None,
    if_none_match=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot
    description: 'The snapshot parameter is an opaque DateTime value that,

      when present, specifies the blob snapshot to delete.'
    defaultValue: None
    types:
    - <xref:str>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: delete_snapshots
    description: Required if the blob has associated snapshots.
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.DeleteSnapshot>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.delete_container
  name: delete_container
  summary: 'Marks the specified container for deletion. The container and any blobs

    contained within it are later deleted during garbage collection.'
  signature: delete_container(container_name, fail_not_exist=False, lease_id=None,
    if_modified_since=None, if_unmodified_since=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of container to delete.
    isRequired: true
    types:
    - <xref:str>
  - name: fail_not_exist
    description: 'Specify whether to throw an exception when the container doesn''t

      exist.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: lease_id
    description: 'If specified, delete_container only succeeds if the

      container''s lease is active and matches this ID.

      Required if the container has an active lease.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: True if container is deleted, False container doesn't exist.
    types:
    - <xref:bool>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.exists
  name: exists
  summary: 'Returns a boolean indicating whether the container exists (if blob_name

    is None), or otherwise a boolean indicating whether the blob exists.'
  signature: exists(container_name, blob_name=None, snapshot=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of a container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of a blob. If None, the container will be checked for existence.
    defaultValue: None
    types:
    - <xref:str>
  - name: snapshot
    description: 'The snapshot parameter is an opaque DateTime value that,

      when present, specifies the snapshot.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: A boolean indicating whether the resource exists.
    types:
    - <xref:bool>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.extract_date_and_request_id
  name: extract_date_and_request_id
  signature: static extract_date_and_request_id(retry_context)
  parameters:
  - name: retry_context
    isRequired: true
- uid: azure.storage.blob.appendblobservice.AppendBlobService.generate_account_shared_access_signature
  name: generate_account_shared_access_signature
  summary: 'Generates a shared access signature for the blob service.

    Use the returned signature with the sas_token parameter of any BlobService.'
  signature: generate_account_shared_access_signature(resource_types, permission,
    expiry, start=None, ip=None, protocol=None)
  parameters:
  - name: resource_types
    description: Specifies the resource types that are accessible with the account
      SAS.
    isRequired: true
    types:
    - <xref:ResourceTypes>
  - name: permission
    description: 'The permissions associated with the shared access signature. The

      user is restricted to operations allowed by the permissions.

      Required unless an id is given referencing a stored access policy

      which contains this field. This field must be omitted if it has been

      specified in an associated stored access policy.'
    isRequired: true
    types:
    - <xref:AccountPermissions>
  - name: expiry
    description: 'The time at which the shared access signature becomes invalid.

      Required unless an id is given referencing a stored access policy

      which contains this field. This field must be omitted if it has

      been specified in an associated stored access policy. Azure will always

      convert values to UTC. If a date is passed in without timezone info, it

      is assumed to be UTC.'
    isRequired: true
    types:
    - <xref:datetime>
    - <xref:str>
  - name: start
    description: 'The time at which the shared access signature becomes valid. If

      omitted, start time for this call is assumed to be the time when the

      storage service receives the request. Azure will always convert values

      to UTC. If a date is passed in without timezone info, it is assumed to

      be UTC.'
    defaultValue: None
    types:
    - <xref:datetime>
    - <xref:str>
  - name: ip
    description: 'Specifies an IP address or a range of IP addresses from which to
      accept requests.

      If the IP address from which the request originates does not match the IP address

      or address range specified on the SAS token, the request is not authenticated.

      For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS

      restricts the request to those IP addresses.'
    defaultValue: None
    types:
    - <xref:str>
  - name: protocol
    description: 'Specifies the protocol permitted for a request made. The default
      value

      is https,http. See <xref:azure.storage.common.models.Protocol> for possible
      values.'
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: A Shared Access Signature (sas) token.
    types:
    - <xref:str>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.generate_blob_shared_access_signature
  name: generate_blob_shared_access_signature
  summary: 'Generates a shared access signature for the blob or one of its snapshots.

    Use the returned signature with the sas_token parameter of any BlobService.'
  signature: generate_blob_shared_access_signature(container_name, blob_name, snapshot=None,
    permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None,
    content_disposition=None, content_encoding=None, content_language=None, content_type=None,
    user_delegation_key=None)
  parameters:
  - name: container_name
    description: Name of container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of blob.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot
    description: 'The snapshot parameter is an opaque DateTime value that,

      when present, specifies the blob snapshot to grant permission.'
    defaultValue: None
    types:
    - <xref:str>
  - name: permission
    description: 'The permissions associated with the shared access signature. The

      user is restricted to operations allowed by the permissions.

      Permissions must be ordered read, write, delete, list.

      Required unless an id is given referencing a stored access policy

      which contains this field. This field must be omitted if it has been

      specified in an associated stored access policy.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.BlobPermissions>
  - name: expiry
    description: 'The time at which the shared access signature becomes invalid.

      Required unless an id is given referencing a stored access policy

      which contains this field. This field must be omitted if it has

      been specified in an associated stored access policy. Azure will always

      convert values to UTC. If a date is passed in without timezone info, it

      is assumed to be UTC.'
    defaultValue: None
    types:
    - <xref:datetime>
    - <xref:str>
  - name: start
    description: 'The time at which the shared access signature becomes valid. If

      omitted, start time for this call is assumed to be the time when the

      storage service receives the request. Azure will always convert values

      to UTC. If a date is passed in without timezone info, it is assumed to

      be UTC.'
    defaultValue: None
    types:
    - <xref:datetime>
    - <xref:str>
  - name: id
    description: 'A unique value up to 64 characters in length that correlates to
      a

      stored access policy. To create a stored access policy, use <xref:azure.storage.blob.appendblobservice.AppendBlobService.set_container_acl>.'
    defaultValue: None
    types:
    - <xref:str>
  - name: ip
    description: 'Specifies an IP address or a range of IP addresses from which to
      accept requests.

      If the IP address from which the request originates does not match the IP address

      or address range specified on the SAS token, the request is not authenticated.

      For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS

      restricts the request to those IP addresses.'
    defaultValue: None
    types:
    - <xref:str>
  - name: protocol
    description: 'Specifies the protocol permitted for a request made. The default
      value

      is https,http. See <xref:azure.storage.common.models.Protocol> for possible
      values.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cache_control
    description: 'Response header value for Cache-Control when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: content_disposition
    description: 'Response header value for Content-Disposition when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: content_encoding
    description: 'Response header value for Content-Encoding when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: content_language
    description: 'Response header value for Content-Language when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: content_type
    description: 'Response header value for Content-Type when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: user_delegation_key
    description: 'Instead of an account key, the user could pass in a user delegation
      key.

      A user delegation key can be obtained from the service by authenticating with
      an AAD identity;

      this can be accomplished by calling get_user_delegation_key.

      When present, the SAS is signed with the user delegation key instead.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.UserDelegationKey>
  return:
    description: A Shared Access Signature (sas) token.
    types:
    - <xref:str>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.generate_container_shared_access_signature
  name: generate_container_shared_access_signature
  summary: 'Generates a shared access signature for the container.

    Use the returned signature with the sas_token parameter of any BlobService.'
  signature: generate_container_shared_access_signature(container_name, permission=None,
    expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None,
    content_disposition=None, content_encoding=None, content_language=None, content_type=None,
    user_delegation_key=None)
  parameters:
  - name: container_name
    description: Name of container.
    isRequired: true
    types:
    - <xref:str>
  - name: permission
    description: 'The permissions associated with the shared access signature. The

      user is restricted to operations allowed by the permissions.

      Permissions must be ordered read, write, delete, list.

      Required unless an id is given referencing a stored access policy

      which contains this field. This field must be omitted if it has been

      specified in an associated stored access policy.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.ContainerPermissions>
  - name: expiry
    description: 'The time at which the shared access signature becomes invalid.

      Required unless an id is given referencing a stored access policy

      which contains this field. This field must be omitted if it has

      been specified in an associated stored access policy. Azure will always

      convert values to UTC. If a date is passed in without timezone info, it

      is assumed to be UTC.'
    defaultValue: None
    types:
    - <xref:datetime>
    - <xref:str>
  - name: start
    description: 'The time at which the shared access signature becomes valid. If

      omitted, start time for this call is assumed to be the time when the

      storage service receives the request. Azure will always convert values

      to UTC. If a date is passed in without timezone info, it is assumed to

      be UTC.'
    defaultValue: None
    types:
    - <xref:datetime>
    - <xref:str>
  - name: id
    description: 'A unique value up to 64 characters in length that correlates to
      a

      stored access policy. To create a stored access policy, use

      set_blob_service_properties.'
    defaultValue: None
    types:
    - <xref:str>
  - name: ip
    description: 'Specifies an IP address or a range of IP addresses from which to
      accept requests.

      If the IP address from which the request originates does not match the IP address

      or address range specified on the SAS token, the request is not authenticated.

      For example, specifying sip=168.1.5.65 or sip=168.1.5.60-168.1.5.70 on the SAS

      restricts the request to those IP addresses.'
    defaultValue: None
    types:
    - <xref:str>
  - name: protocol
    description: 'Specifies the protocol permitted for a request made. The default
      value

      is https,http. See <xref:azure.storage.common.models.Protocol> for possible
      values.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cache_control
    description: 'Response header value for Cache-Control when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: content_disposition
    description: 'Response header value for Content-Disposition when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: content_encoding
    description: 'Response header value for Content-Encoding when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: content_language
    description: 'Response header value for Content-Language when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: content_type
    description: 'Response header value for Content-Type when resource is accessed

      using this shared access signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: user_delegation_key
    description: 'Instead of an account key, the user could pass in a user delegation
      key.

      A user delegation key can be obtained from the service by authenticating with
      an AAD identity;

      this can be accomplished by calling get_user_delegation_key.

      When present, the SAS is signed with the user delegation key instead.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.UserDelegationKey>
  return:
    description: A Shared Access Signature (sas) token.
    types:
    - <xref:str>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_account_information
  name: get_blob_account_information
  summary: 'Gets information related to the storage account.

    The information can also be retrieved if the user has a SAS to a container or
    blob.'
  signature: get_blob_account_information(container_name=None, blob_name=None, timeout=None)
  parameters:
  - name: container_name
    description: 'Name of existing container.

      Optional, unless using a SAS token to a specific container or blob, in which
      case it''s required.'
    defaultValue: None
    types:
    - <xref:str>
  - name: blob_name
    description: 'Name of existing blob.

      Optional, unless using a SAS token to a specific blob, in which case it''s required.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: The <xref:azure.storage.blob.models.AccountInformation>.
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_metadata
  name: get_blob_metadata
  summary: Returns all user-defined metadata for the specified blob or snapshot.
  signature: get_blob_metadata(container_name, blob_name, snapshot=None, lease_id=None,
    if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None,
    timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot
    description: 'The snapshot parameter is an opaque value that,

      when present, specifies the blob snapshot to retrieve.'
    defaultValue: None
    types:
    - <xref:str>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Decrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: A dictionary representing the blob metadata name, value pairs.
    types:
    - <xref:dict>(<xref:str>, <xref:str>)
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_properties
  name: get_blob_properties
  summary: 'Returns all user-defined metadata, standard HTTP properties, and

    system properties for the blob. It does not return the content of the blob.

    Returns <xref:azure.storage.blob.models.Blob>

    with <xref:azure.storage.blob.models.BlobProperties> and a metadata dict.'
  signature: get_blob_properties(container_name, blob_name, snapshot=None, lease_id=None,
    if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None,
    timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot
    description: 'The snapshot parameter is an opaque DateTime value that,

      when present, specifies the blob snapshot to retrieve.'
    defaultValue: None
    types:
    - <xref:str>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Decrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: a blob object including properties and metadata.
    types:
    - <xref:azure.storage.blob.models.Blob>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_service_properties
  name: get_blob_service_properties
  summary: 'Gets the properties of a storage account''s Blob service, including

    Azure Storage Analytics.'
  signature: get_blob_service_properties(timeout=None)
  parameters:
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: 'The blob <xref:azure.storage.common.models.ServiceProperties> with
      an attached

      target_version property.'
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_service_stats
  name: get_blob_service_stats
  summary: 'Retrieves statistics related to replication for the Blob service. It is

    only available when read-access geo-redundant replication is enabled for

    the storage account.


    With geo-redundant replication, Azure Storage maintains your data durable

    in two locations. In both locations, Azure Storage constantly maintains

    multiple healthy replicas of your data. The location where you read,

    create, update, or delete data is the primary storage account location.

    The primary location exists in the region you choose at the time you

    create an account via the Azure Management Azure classic portal, for

    example, North Central US. The location to which your data is replicated

    is the secondary location. The secondary location is automatically

    determined based on the location of the primary; it is in a second data

    center that resides in the same region as the primary location. Read-only

    access is available from the secondary location, if read-access geo-redundant

    replication is enabled for your storage account.'
  signature: get_blob_service_stats(timeout=None)
  parameters:
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: The blob service stats.
    types:
    - <xref:azure.storage.common.models.ServiceStats>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_to_bytes
  name: get_blob_to_bytes
  summary: 'Downloads a blob as an array of bytes, with automatic chunking and

    progress notifications. Returns an instance of <xref:azure.storage.blob.models.Blob>
    with

    properties, metadata, and content.'
  signature: get_blob_to_bytes(container_name, blob_name, snapshot=None, start_range=None,
    end_range=None, validate_content=False, progress_callback=None, max_connections=2,
    lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None,
    if_none_match=None, timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: snapshot
    description: 'The snapshot parameter is an opaque DateTime value that,

      when present, specifies the blob snapshot to retrieve.'
    defaultValue: None
    types:
    - <xref:str>
  - name: start_range
    description: 'Start of byte range to use for downloading a section of the blob.

      If no end_range is given, all bytes after the start_range will be downloaded.

      The start_range and end_range params are inclusive.

      Ex: start_range=0, end_range=511 will download first 512 bytes of blob.'
    defaultValue: None
    types:
    - <xref:int>
  - name: end_range
    description: 'End of byte range to use for downloading a section of the blob.

      If end_range is given, start_range must be provided.

      The start_range and end_range params are inclusive.

      Ex: start_range=0, end_range=511 will download first 512 bytes of blob.'
    defaultValue: None
    types:
    - <xref:int>
  - name: validate_content
    description: 'If set to true, validates an MD5 hash for each retrieved portion
      of

      the blob. This is primarily valuable for detecting bitflips on the wire

      if using http instead of https as https (the default) will already

      validate. Note that the service will only return transactional MD5s

      for chunks 4MB or less so the first get request will be of size

      self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If

      self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be

      thrown. As computing the MD5 takes processing time and more requests

      will need to be done due to the reduced chunk size there may be some

      increase in latency.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: progress_callback
    description: 'Callback for progress with signature function(current, total)

      where current is the number of bytes transfered so far, and total is

      the size of the blob if known.'
    defaultValue: None
    types:
    - <xref:func>(<xref:current>, <xref:total>)
  - name: max_connections
    description: 'If set to 2 or greater, an initial get will be done for the first

      self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob,

      the method returns at this point. If it is not, it will download the

      remaining data parallel using the number of threads equal to

      max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE.

      If set to 1, a single large get request will be done. This is not

      generally recommended but available if very few threads should be

      used, network requests are very expensive, or a non-seekable stream

      prevents parallel download. This may also be useful if many blobs are

      expected to be empty as an extra request is required for empty blobs

      if max_connections is greater than 1.'
    defaultValue: '2'
    types:
    - <xref:int>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Decrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: 'The timeout parameter is expressed in seconds. This method may make

      multiple calls to the Azure service and the timeout will apply to

      each call individually.'
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: 'A Blob with properties and metadata. If max_connections is greater

      than 1, the content_md5 (if set on the blob) will not be returned. If you

      require this value, either use get_blob_properties or set max_connections

      to 1.'
    types:
    - <xref:azure.storage.blob.models.Blob>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_to_path
  name: get_blob_to_path
  summary: 'Downloads a blob to a file path, with automatic chunking and progress

    notifications. Returns an instance of <xref:azure.storage.blob.models.Blob> with

    properties and metadata.'
  signature: get_blob_to_path(container_name, blob_name, file_path, open_mode='wb',
    snapshot=None, start_range=None, end_range=None, validate_content=False, progress_callback=None,
    max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None,
    if_match=None, if_none_match=None, timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: file_path
    description: Path of file to write out to.
    isRequired: true
    types:
    - <xref:str>
  - name: open_mode
    description: 'Mode to use when opening the file. Note that specifying append only

      open_mode prevents parallel download. So, max_connections must be set

      to 1 if this open_mode is used.'
    defaultValue: wb
    types:
    - <xref:str>
  - name: snapshot
    description: 'The snapshot parameter is an opaque DateTime value that,

      when present, specifies the blob snapshot to retrieve.'
    defaultValue: None
    types:
    - <xref:str>
  - name: start_range
    description: 'Start of byte range to use for downloading a section of the blob.

      If no end_range is given, all bytes after the start_range will be downloaded.

      The start_range and end_range params are inclusive.

      Ex: start_range=0, end_range=511 will download first 512 bytes of blob.'
    defaultValue: None
    types:
    - <xref:int>
  - name: end_range
    description: 'End of byte range to use for downloading a section of the blob.

      If end_range is given, start_range must be provided.

      The start_range and end_range params are inclusive.

      Ex: start_range=0, end_range=511 will download first 512 bytes of blob.'
    defaultValue: None
    types:
    - <xref:int>
  - name: validate_content
    description: 'If set to true, validates an MD5 hash for each retrieved portion
      of

      the blob. This is primarily valuable for detecting bitflips on the wire

      if using http instead of https as https (the default) will already

      validate. Note that the service will only return transactional MD5s

      for chunks 4MB or less so the first get request will be of size

      self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If

      self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be

      thrown. As computing the MD5 takes processing time and more requests

      will need to be done due to the reduced chunk size there may be some

      increase in latency.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: progress_callback
    description: 'Callback for progress with signature function(current, total)

      where current is the number of bytes transfered so far, and total is

      the size of the blob if known.'
    defaultValue: None
    types:
    - <xref:func>(<xref:current>, <xref:total>)
  - name: max_connections
    description: 'If set to 2 or greater, an initial get will be done for the first

      self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob,

      the method returns at this point. If it is not, it will download the

      remaining data parallel using the number of threads equal to

      max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE.

      If set to 1, a single large get request will be done. This is not

      generally recommended but available if very few threads should be

      used, network requests are very expensive, or a non-seekable stream

      prevents parallel download. This may also be useful if many blobs are

      expected to be empty as an extra request is required for empty blobs

      if max_connections is greater than 1.'
    defaultValue: '2'
    types:
    - <xref:int>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Decrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: 'The timeout parameter is expressed in seconds. This method may make

      multiple calls to the Azure service and the timeout will apply to

      each call individually.'
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: 'A Blob with properties and metadata. If max_connections is greater

      than 1, the content_md5 (if set on the blob) will not be returned. If you

      require this value, either use get_blob_properties or set max_connections

      to 1.'
    types:
    - <xref:azure.storage.blob.models.Blob>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_to_stream
  name: get_blob_to_stream
  summary: 'Downloads a blob to a stream, with automatic chunking and progress

    notifications. Returns an instance of <xref:azure.storage.blob.models.Blob> with

    properties and metadata.'
  signature: get_blob_to_stream(container_name, blob_name, stream, snapshot=None,
    start_range=None, end_range=None, validate_content=False, progress_callback=None,
    max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None,
    if_match=None, if_none_match=None, timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: stream
    description: Opened stream to write to.
    isRequired: true
    types:
    - <xref:io.IOBase>
  - name: snapshot
    description: 'The snapshot parameter is an opaque DateTime value that,

      when present, specifies the blob snapshot to retrieve.'
    defaultValue: None
    types:
    - <xref:str>
  - name: start_range
    description: 'Start of byte range to use for downloading a section of the blob.

      If no end_range is given, all bytes after the start_range will be downloaded.

      The start_range and end_range params are inclusive.

      Ex: start_range=0, end_range=511 will download first 512 bytes of blob.'
    defaultValue: None
    types:
    - <xref:int>
  - name: end_range
    description: 'End of byte range to use for downloading a section of the blob.

      If end_range is given, start_range must be provided.

      The start_range and end_range params are inclusive.

      Ex: start_range=0, end_range=511 will download first 512 bytes of blob.'
    defaultValue: None
    types:
    - <xref:int>
  - name: validate_content
    description: 'If set to true, validates an MD5 hash for each retrieved portion
      of

      the blob. This is primarily valuable for detecting bitflips on the wire

      if using http instead of https as https (the default) will already

      validate. Note that the service will only return transactional MD5s

      for chunks 4MB or less so the first get request will be of size

      self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If

      self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be

      thrown. As computing the MD5 takes processing time and more requests

      will need to be done due to the reduced chunk size there may be some

      increase in latency.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: progress_callback
    description: 'Callback for progress with signature function(current, total)

      where current is the number of bytes transfered so far, and total is

      the size of the blob if known.'
    defaultValue: None
    types:
    - <xref:func>(<xref:current>, <xref:total>)
  - name: max_connections
    description: 'If set to 2 or greater, an initial get will be done for the first

      self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob,

      the method returns at this point. If it is not, it will download the

      remaining data parallel using the number of threads equal to

      max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE.

      If set to 1, a single large get request will be done. This is not

      generally recommended but available if very few threads should be

      used, network requests are very expensive, or a non-seekable stream

      prevents parallel download. This may also be useful if many blobs are

      expected to be empty as an extra request is required for empty blobs

      if max_connections is greater than 1.'
    defaultValue: '2'
    types:
    - <xref:int>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Decrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: 'The timeout parameter is expressed in seconds. This method may make

      multiple calls to the Azure service and the timeout will apply to

      each call individually.'
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: 'A Blob with properties and metadata. If max_connections is greater

      than 1, the content_md5 (if set on the blob) will not be returned. If you

      require this value, either use get_blob_properties or set max_connections

      to 1.'
    types:
    - <xref:azure.storage.blob.models.Blob>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_blob_to_text
  name: get_blob_to_text
  summary: 'Downloads a blob as unicode text, with automatic chunking and progress

    notifications. Returns an instance of <xref:azure.storage.blob.models.Blob> with

    properties, metadata, and content.'
  signature: get_blob_to_text(container_name, blob_name, encoding='utf-8', snapshot=None,
    start_range=None, end_range=None, validate_content=False, progress_callback=None,
    max_connections=2, lease_id=None, if_modified_since=None, if_unmodified_since=None,
    if_match=None, if_none_match=None, timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: encoding
    description: Python encoding to use when decoding the blob data.
    defaultValue: utf-8
    types:
    - <xref:str>
  - name: snapshot
    description: 'The snapshot parameter is an opaque DateTime value that,

      when present, specifies the blob snapshot to retrieve.'
    defaultValue: None
    types:
    - <xref:str>
  - name: start_range
    description: 'Start of byte range to use for downloading a section of the blob.

      If no end_range is given, all bytes after the start_range will be downloaded.

      The start_range and end_range params are inclusive.

      Ex: start_range=0, end_range=511 will download first 512 bytes of blob.'
    defaultValue: None
    types:
    - <xref:int>
  - name: end_range
    description: 'End of byte range to use for downloading a section of the blob.

      If end_range is given, start_range must be provided.

      The start_range and end_range params are inclusive.

      Ex: start_range=0, end_range=511 will download first 512 bytes of blob.'
    defaultValue: None
    types:
    - <xref:int>
  - name: validate_content
    description: 'If set to true, validates an MD5 hash for each retrieved portion
      of

      the blob. This is primarily valuable for detecting bitflips on the wire

      if using http instead of https as https (the default) will already

      validate. Note that the service will only return transactional MD5s

      for chunks 4MB or less so the first get request will be of size

      self.MAX_CHUNK_GET_SIZE instead of self.MAX_SINGLE_GET_SIZE. If

      self.MAX_CHUNK_GET_SIZE was set to greater than 4MB an error will be

      thrown. As computing the MD5 takes processing time and more requests

      will need to be done due to the reduced chunk size there may be some

      increase in latency.'
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: progress_callback
    description: 'Callback for progress with signature function(current, total)

      where current is the number of bytes transfered so far, and total is

      the size of the blob if known.'
    defaultValue: None
    types:
    - <xref:func>(<xref:current>, <xref:total>)
  - name: max_connections
    description: 'If set to 2 or greater, an initial get will be done for the first

      self.MAX_SINGLE_GET_SIZE bytes of the blob. If this is the entire blob,

      the method returns at this point. If it is not, it will download the

      remaining data parallel using the number of threads equal to

      max_connections. Each chunk will be of size self.MAX_CHUNK_GET_SIZE.

      If set to 1, a single large get request will be done. This is not

      generally recommended but available if very few threads should be

      used, network requests are very expensive, or a non-seekable stream

      prevents parallel download. This may also be useful if many blobs are

      expected to be empty as an extra request is required for empty blobs

      if max_connections is greater than 1.'
    defaultValue: '2'
    types:
    - <xref:int>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Decrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: 'The timeout parameter is expressed in seconds. This method may make

      multiple calls to the Azure service and the timeout will apply to

      each call individually.'
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: 'A Blob with properties and metadata. If max_connections is greater

      than 1, the content_md5 (if set on the blob) will not be returned. If you

      require this value, either use get_blob_properties or set max_connections

      to 1.'
    types:
    - <xref:azure.storage.blob.models.Blob>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_container_acl
  name: get_container_acl
  summary: 'Gets the permissions for the specified container.

    The permissions indicate whether container data may be accessed publicly.'
  signature: get_container_acl(container_name, lease_id=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: 'If specified, get_container_acl only succeeds if the

      container''s lease is active and matches this ID.'
    defaultValue: None
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: 'A dictionary of access policies associated with the container. dict
      of str to

      <xref:azure.storage.common.models.AccessPolicy> and a public_access property

      if public access is turned on'
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_container_metadata
  name: get_container_metadata
  summary: Returns all user-defined metadata for the specified container.
  signature: get_container_metadata(container_name, lease_id=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: 'If specified, get_container_metadata only succeeds if the

      container''s lease is active and matches this ID.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: A dictionary representing the container metadata name, value pairs.
    types:
    - <xref:dict>(<xref:str>, <xref:str>)
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_container_properties
  name: get_container_properties
  summary: 'Returns all user-defined metadata and system properties for the specified

    container. The data returned does not include the container''s list of blobs.'
  signature: get_container_properties(container_name, lease_id=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: 'If specified, get_container_properties only succeeds if the

      container''s lease is active and matches this ID.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: properties for the specified container within a container object.
    types:
    - <xref:azure.storage.blob.models.Container>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.get_user_delegation_key
  name: get_user_delegation_key
  summary: 'Obtain a user delegation key for the purpose of signing SAS tokens.

    A token credential must be present on the service object for this request to succeed.'
  signature: get_user_delegation_key(key_start_time, key_expiry_time, timeout=None)
  parameters:
  - name: key_start_time
    description: A DateTime value. Indicates when the key becomes valid.
    isRequired: true
    types:
    - <xref:datetime>
  - name: key_expiry_time
    description: A DateTime value. Indicates when the key stops being valid.
    isRequired: true
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: The user delegation key.
    types:
    - <xref:azure.storage.blob.models.UserDelegationKey>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.list_blob_names
  name: list_blob_names
  summary: 'Returns a generator to list the blob names under the specified container.

    The generator will lazily follow the continuation tokens returned by

    the service and stop when all blobs have been returned or num_results is reached.


    If num_results is specified and the account has more than that number of

    blobs, the generator will have a populated next_marker field once it

    finishes. This marker can be used to create a new generator if more

    results are desired.'
  signature: list_blob_names(container_name, prefix=None, num_results=None, include=None,
    delimiter=None, marker=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: prefix
    description: 'Filters the results to return only blobs whose names

      begin with the specified prefix.'
    defaultValue: None
    types:
    - <xref:str>
  - name: num_results
    description: 'Specifies the maximum number of blobs to return,

      including all <xref:azure.storage.blob.appendblobservice.BlobPrefix> elements.
      If the request does not specify

      num_results or specifies a value greater than 5,000, the server will

      return up to 5,000 items. Setting num_results to a value less than

      or equal to zero results in error response code 400 (Bad Request).'
    defaultValue: None
    types:
    - <xref:int>
  - name: include
    description: Specifies one or more additional datasets to include in the response.
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.Include>
  - name: delimiter
    description: 'When the request includes this parameter, the operation

      returns a <xref:azure.storage.blob.models.BlobPrefix> element in the

      result list that acts as a placeholder for all 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.'
    defaultValue: None
    types:
    - <xref:str>
  - name: marker
    description: 'An opaque continuation token. This value can be retrieved from the

      next_marker field of a previous generator object if num_results was

      specified and that generator has finished enumerating results. If

      specified, this generator will begin returning results from the point

      where the previous generator stopped.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.list_blobs
  name: list_blobs
  summary: 'Returns a generator to list the blobs under the specified container.

    The generator will lazily follow the continuation tokens returned by

    the service and stop when all blobs have been returned or num_results is reached.


    If num_results is specified and the account has more than that number of

    blobs, the generator will have a populated next_marker field once it

    finishes. This marker can be used to create a new generator if more

    results are desired.'
  signature: list_blobs(container_name, prefix=None, num_results=None, include=None,
    delimiter=None, marker=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: prefix
    description: 'Filters the results to return only blobs whose names

      begin with the specified prefix.'
    defaultValue: None
    types:
    - <xref:str>
  - name: num_results
    description: 'Specifies the maximum number of blobs to return,

      including all <xref:azure.storage.blob.appendblobservice.BlobPrefix> elements.
      If the request does not specify

      num_results or specifies a value greater than 5,000, the server will

      return up to 5,000 items. Setting num_results to a value less than

      or equal to zero results in error response code 400 (Bad Request).'
    defaultValue: None
    types:
    - <xref:int>
  - name: include
    description: Specifies one or more additional datasets to include in the response.
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.Include>
  - name: delimiter
    description: 'When the request includes this parameter, the operation

      returns a <xref:azure.storage.blob.models.BlobPrefix> element in the

      result list that acts as a placeholder for all 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.'
    defaultValue: None
    types:
    - <xref:str>
  - name: marker
    description: 'An opaque continuation token. This value can be retrieved from the

      next_marker field of a previous generator object if num_results was

      specified and that generator has finished enumerating results. If

      specified, this generator will begin returning results from the point

      where the previous generator stopped.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.list_containers
  name: list_containers
  summary: 'Returns a generator to list the containers under the specified account.

    The generator will lazily follow the continuation tokens returned by

    the service and stop when all containers have been returned or num_results is
    reached.


    If num_results is specified and the account has more than that number of

    containers, the generator will have a populated next_marker field once it

    finishes. This marker can be used to create a new generator if more

    results are desired.'
  signature: list_containers(prefix=None, num_results=None, include_metadata=False,
    marker=None, timeout=None)
  parameters:
  - name: prefix
    description: 'Filters the results to return only containers whose names

      begin with the specified prefix.'
    defaultValue: None
    types:
    - <xref:str>
  - name: num_results
    description: 'Specifies the maximum number of containers to return. A single list

      request may return up to 1000 contianers and potentially a continuation

      token which should be followed to get additional resutls.'
    defaultValue: None
    types:
    - <xref:int>
  - name: include_metadata
    description: Specifies that container metadata be returned in the response.
    defaultValue: 'False'
    types:
    - <xref:bool>
  - name: marker
    description: 'An opaque continuation token. This value can be retrieved from the

      next_marker field of a previous generator object if num_results was

      specified and that generator has finished enumerating results. If

      specified, this generator will begin returning results from the point

      where the previous generator stopped.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.make_blob_url
  name: make_blob_url
  summary: Creates the url to access a blob.
  signature: make_blob_url(container_name, blob_name, protocol=None, sas_token=None,
    snapshot=None)
  parameters:
  - name: container_name
    description: Name of container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of blob.
    isRequired: true
    types:
    - <xref:str>
  - name: protocol
    description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the

      protocol specified when BaseBlobService was initialized.'
    defaultValue: None
    types:
    - <xref:str>
  - name: sas_token
    description: 'Shared access signature token created with

      generate_shared_access_signature.'
    defaultValue: None
    types:
    - <xref:str>
  - name: snapshot
    description: 'An string value that uniquely identifies the snapshot. The value
      of

      this query parameter indicates the snapshot version.'
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: blob access URL.
    types:
    - <xref:str>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.make_container_url
  name: make_container_url
  summary: Creates the url to access a container.
  signature: make_container_url(container_name, protocol=None, sas_token=None)
  parameters:
  - name: container_name
    description: Name of container.
    isRequired: true
    types:
    - <xref:str>
  - name: protocol
    description: 'Protocol to use: ''http'' or ''https''. If not specified, uses the

      protocol specified when BaseBlobService was initialized.'
    defaultValue: None
    types:
    - <xref:str>
  - name: sas_token
    description: 'Shared access signature token created with

      generate_shared_access_signature.'
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: container access URL.
    types:
    - <xref:str>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.release_blob_lease
  name: release_blob_lease
  summary: 'Releases the lease. The lease may be released if the lease ID specified
    on the

    request matches that associated with the blob. Releasing the lease allows another

    client to immediately acquire the lease for the blob as soon as the release is
    complete.'
  signature: release_blob_lease(container_name, blob_name, lease_id, if_modified_since=None,
    if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: Lease ID for active lease.
    isRequired: true
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.release_container_lease
  name: release_container_lease
  summary: 'Release the lease. The lease may be released if the lease_id specified
    matches

    that associated with the container. Releasing the lease allows another client

    to immediately acquire the lease for the container as soon as the release is complete.'
  signature: release_container_lease(container_name, lease_id, if_modified_since=None,
    if_unmodified_since=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: Lease ID for active lease.
    isRequired: true
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.renew_blob_lease
  name: renew_blob_lease
  summary: 'Renews the lease. The lease can be renewed if the lease ID specified on

    the request matches that associated with the blob. Note that the lease may

    be renewed even if it has expired as long as the blob has not been modified

    or leased again since the expiration of that lease. When you renew a lease,

    the lease duration clock resets.'
  signature: renew_blob_lease(container_name, blob_name, lease_id, if_modified_since=None,
    if_unmodified_since=None, if_match=None, if_none_match=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: Lease ID for active lease.
    isRequired: true
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: str
- uid: azure.storage.blob.appendblobservice.AppendBlobService.renew_container_lease
  name: renew_container_lease
  summary: 'Renews the lease. The lease can be renewed if the lease ID specified

    matches that associated with the container. Note that

    the lease may be renewed even if it has expired as long as the container

    has not been leased again since the expiration of that lease. When you

    renew a lease, the lease duration clock resets.'
  signature: renew_container_lease(container_name, lease_id, if_modified_since=None,
    if_unmodified_since=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: lease_id
    description: Lease ID for active lease.
    isRequired: true
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: str
- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_blob_metadata
  name: set_blob_metadata
  summary: 'Sets user-defined metadata for the specified blob as one or more

    name-value pairs.'
  signature: set_blob_metadata(container_name, blob_name, metadata=None, lease_id=None,
    if_modified_since=None, if_unmodified_since=None, if_match=None, if_none_match=None,
    timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: metadata
    description: 'Dict containing name and value pairs. Each call to this operation

      replaces all existing metadata attached to the blob. To remove all

      metadata from the blob, call this operation with no metadata headers.'
    defaultValue: None
    types:
    - <xref:dict>(<xref:str>, <xref:str>)
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: ETag and last modified properties for the updated Blob
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_blob_properties
  name: set_blob_properties
  summary: 'Sets system properties on the blob. If one property is set for the

    content_settings, all properties will be overriden.'
  signature: set_blob_properties(container_name, blob_name, content_settings=None,
    lease_id=None, if_modified_since=None, if_unmodified_since=None, if_match=None,
    if_none_match=None, timeout=None, cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: content_settings
    description: ContentSettings object used to set blob properties.
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.ContentSettings>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: ETag and last modified properties for the updated Blob
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_blob_service_properties
  name: set_blob_service_properties
  summary: 'Sets the properties of a storage account''s Blob service, including

    Azure Storage Analytics. If an element (ex Logging) is left as None, the

    existing settings on the service for that functionality are preserved.'
  signature: set_blob_service_properties(logging=None, hour_metrics=None, minute_metrics=None,
    cors=None, target_version=None, timeout=None, delete_retention_policy=None, static_website=None)
  parameters:
  - name: logging
    description: Groups the Azure Analytics Logging settings.
    defaultValue: None
    types:
    - <xref:azure.storage.common.models.Logging>
  - name: hour_metrics
    description: 'The hour metrics settings provide a summary of request

      statistics grouped by API in hourly aggregates for blobs.'
    defaultValue: None
    types:
    - <xref:azure.storage.common.models.Metrics>
  - name: minute_metrics
    description: 'The minute metrics settings provide request statistics

      for each minute for blobs.'
    defaultValue: None
    types:
    - <xref:azure.storage.common.models.Metrics>
  - name: cors
    description: 'You can include up to five CorsRule elements in the

      list. If an empty list is specified, all CORS rules will be deleted,

      and CORS will be disabled for the service.'
    defaultValue: None
    types:
    - list(<xref:azure.storage.common.models.CorsRule>)
  - name: target_version
    description: 'Indicates the default version to use for requests if an incoming

      request''s version is not specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  - name: delete_retention_policy
    description: 'The delete retention policy specifies whether to retain deleted
      blobs.

      It also specifies the number of days and versions of blob to keep.'
    defaultValue: None
    types:
    - <xref:azure.storage.common.models.DeleteRetentionPolicy>
  - name: static_website
    description: 'Specifies whether the static website feature is enabled,

      and if yes, indicates the index document and 404 error document to use.'
    defaultValue: None
    types:
    - <xref:azure.storage.common.models.StaticWebsite>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_container_acl
  name: set_container_acl
  summary: 'Sets the permissions for the specified container or stored access

    policies that may be used with Shared Access Signatures. The permissions

    indicate whether blobs in a container may be accessed publicly.'
  signature: set_container_acl(container_name, signed_identifiers=None, public_access=None,
    lease_id=None, if_modified_since=None, if_unmodified_since=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: signed_identifiers
    description: 'A dictionary of access policies to associate with the container.
      The

      dictionary may contain up to 5 elements. An empty dictionary

      will clear the access policies set on the service.'
    defaultValue: None
    types:
    - dict(str, <xref:azure.storage.common.models.AccessPolicy>)
  - name: public_access
    description: 'Possible values include: container, blob.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.PublicAccess>
  - name: lease_id
    description: 'If specified, set_container_acl only succeeds if the

      container''s lease is active and matches this ID.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A datetime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A datetime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: ETag and last modified properties for the updated Container
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_container_metadata
  name: set_container_metadata
  summary: 'Sets one or more user-defined name-value pairs for the specified

    container. Each call to this operation replaces all existing metadata

    attached to the container. To remove all metadata from the container,

    call this operation with no metadata dict.'
  signature: set_container_metadata(container_name, metadata=None, lease_id=None,
    if_modified_since=None, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: metadata
    description: 'A dict containing name-value pairs to associate with the container
      as

      metadata. Example: {''category'':''test''}'
    defaultValue: None
    types:
    - <xref:dict>(<xref:str>, <xref:str>)
  - name: lease_id
    description: 'If specified, set_container_metadata only succeeds if the

      container''s lease is active and matches this ID.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: ETag and last modified properties for the updated Container
    types:
    - <xref:azure.storage.blob.models.ResourceProperties>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.set_proxy
  name: set_proxy
  summary: Sets the proxy server host and port for the HTTP CONNECT Tunnelling.
  signature: set_proxy(host, port, user=None, password=None)
  parameters:
  - name: host
    description: 'Address of the proxy. Ex: ''192.168.0.100'''
    isRequired: true
    types:
    - <xref:str>
  - name: port
    description: 'Port of the proxy. Ex: 6000'
    isRequired: true
    types:
    - <xref:int>
  - name: user
    description: User for proxy authorization.
    defaultValue: None
    types:
    - <xref:str>
  - name: password
    description: Password for proxy authorization.
    defaultValue: None
    types:
    - <xref:str>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.snapshot_blob
  name: snapshot_blob
  summary: Creates a read-only snapshot of a blob.
  signature: snapshot_blob(container_name, blob_name, metadata=None, if_modified_since=None,
    if_unmodified_since=None, if_match=None, if_none_match=None, lease_id=None, timeout=None,
    cpk=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: metadata
    description: 'Specifies a user-defined name-value pair associated with the blob.

      If no name-value pairs are specified, the operation will copy the

      base blob metadata to the snapshot. If one or more name-value pairs

      are specified, the snapshot is created with the specified metadata,

      and metadata is not copied from the base blob.'
    defaultValue: None
    types:
    - <xref:dict>(<xref:str>, <xref:str>)
  - name: if_modified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only

      if the resource has been modified since the specified time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_unmodified_since
    description: 'A DateTime value. Azure expects the date value passed in to be UTC.

      If timezone is included, any non-UTC datetimes will be converted to UTC.

      If a date is passed in without timezone info, it is assumed to be UTC.

      Specify this header to perform the operation only if

      the resource has not been modified since the specified date/time.'
    defaultValue: None
    types:
    - <xref:datetime>
  - name: if_match
    description: 'An ETag value, or the wildcard character (*). Specify this header
      to perform

      the operation only if the resource''s ETag matches the value specified.'
    defaultValue: None
    types:
    - <xref:str>
  - name: if_none_match
    description: 'An ETag value, or the wildcard character (*). Specify this header

      to perform the operation only if the resource''s ETag does not match

      the value specified. Specify the wildcard character (*) to perform

      the operation only if the resource does not exist, and fail the

      operation if it does exist.'
    defaultValue: None
    types:
    - <xref:str>
  - name: lease_id
    description: Required if the blob has an active lease.
    defaultValue: None
    types:
    - <xref:str>
  - name: cpk
    description: 'Encrypts the data on the service-side with the given key.

      Use of customer-provided keys must be done over HTTPS.

      As the encryption key itself is provided in the request,

      a secure connection must be established to transfer the key.'
    defaultValue: None
    types:
    - <xref:azure.storage.blob.models.CustomerProvidedEncryptionKey>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
  return:
    description: snapshot properties
    types:
    - <xref:azure.storage.blob.models.Blob>
- uid: azure.storage.blob.appendblobservice.AppendBlobService.undelete_blob
  name: undelete_blob
  summary: 'The undelete Blob operation restores the contents and metadata of soft
    deleted blob or snapshot.

    Attempting to undelete a blob or snapshot that is not soft deleted will succeed
    without any changes.'
  signature: undelete_blob(container_name, blob_name, timeout=None)
  parameters:
  - name: container_name
    description: Name of existing container.
    isRequired: true
    types:
    - <xref:str>
  - name: blob_name
    description: Name of existing blob.
    isRequired: true
    types:
    - <xref:str>
  - name: timeout
    description: The timeout parameter is expressed in seconds.
    defaultValue: None
    types:
    - <xref:int>
attributes:
- uid: azure.storage.blob.appendblobservice.AppendBlobService.protocol
  name: protocol
- uid: azure.storage.blob.appendblobservice.AppendBlobService.request_session
  name: request_session
- uid: azure.storage.blob.appendblobservice.AppendBlobService.socket_timeout
  name: socket_timeout
- uid: azure.storage.blob.appendblobservice.AppendBlobService.MAX_BLOCK_SIZE
  name: MAX_BLOCK_SIZE
  signature: MAX_BLOCK_SIZE = 4194304
- uid: azure.storage.blob.appendblobservice.AppendBlobService.MAX_CHUNK_GET_SIZE
  name: MAX_CHUNK_GET_SIZE
  signature: MAX_CHUNK_GET_SIZE = 4194304
- uid: azure.storage.blob.appendblobservice.AppendBlobService.MAX_SINGLE_GET_SIZE
  name: MAX_SINGLE_GET_SIZE
  signature: MAX_SINGLE_GET_SIZE = 33554432