I am confused by the delete_snapshots parameter. In function parameter list, it is in boolean and in description, it is string.
What is the right one?
|
def delete_blob(self, delete_snapshots=False, **kwargs): |
|
# type: (str, **Any) -> None |
|
"""Marks the specified blob 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 |
|
and retains the blob for a specified number of days. |
|
After the specified number of days, the blob's data is removed from the service during garbage collection. |
|
Soft deleted blob is accessible through :func:`~ContainerClient.list_blobs()` specifying `include=['deleted']` |
|
option. Soft-deleted blob can be restored using :func:`undelete` operation. |
|
|
|
:param str delete_snapshots: |
|
Required if the blob has associated snapshots. Values include: |
|
- "only": Deletes only the blobs snapshots. |
|
- "include": Deletes the blob along with all snapshots. |
I am confused by the
delete_snapshotsparameter. In function parameter list, it is in boolean and in description, it is string.What is the right one?
azure-sdk-for-python/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py
Lines 981 to 999 in c9240aa