Skip to content

Commit a85700c

Browse files
[Storage] Improve generate_blob_sas version_id documentation (Azure#29802)
* Clarify vid not in output SAS * Revert "Clarify vid not in output SAS" This reverts commit ce39666. * Clarify vid not in output SAS * Revert "Clarify vid not in output SAS" This reverts commit ce39666. * Clarify mechanics of version_id in SAS gen
1 parent 87e1257 commit a85700c

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

sdk/storage/azure-storage-blob/azure/storage/blob/_shared_access_signature.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -561,7 +561,10 @@ def generate_blob_sas(
561561
For example, specifying ip=168.1.5.65 or ip=168.1.5.60-168.1.5.70 on the SAS
562562
restricts the request to those IP addresses.
563563
:keyword str version_id:
564-
An optional blob version ID. This parameter is only for versioning enabled account
564+
An optional blob version ID. This parameter is only applicable for versioning-enabled
565+
Storage accounts. Note that the 'versionid' query parameter is not included in the output
566+
SAS. Therefore, please provide the 'version_id' parameter to any APIs when using the output
567+
SAS to operate on a specific version.
565568
566569
.. versionadded:: 12.4.0
567570
This keyword argument was introduced in API version '2019-12-12'.

0 commit comments

Comments
 (0)