@@ -150,15 +150,15 @@ examples:
150
150
blob_samples_authentication.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" \
151
151
: [], \" names\" : [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\ \
152
152
\\ windows\\\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\ \
153
- \\ 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ blob_samples_authentication.py\" \
153
+ \\ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ blob_samples_authentication.py\" \
154
154
, \" xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
155
155
: {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n from azure.storage.blob\
156
156
\ import BlobClient\n blob_client = BlobClient.from_blob_url(blob_url=\" https://account.blob.core.windows.net/container/blob-name\" \
157
157
)\n\n ````\n\n Creating the BlobClient from a SAS URL to a blob.<!--[!code-python[Main](les\\ \
158
158
blob_samples_authentication.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" \
159
159
: [], \" names\" : [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\ \
160
160
\\ windows\\\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\ \
161
- \\ 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ blob_samples_authentication.py\" \
161
+ \\ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ blob_samples_authentication.py\" \
162
162
, \" xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
163
163
: {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n from azure.storage.blob\
164
164
\ import BlobClient\n\n sas_url = \" https://account.blob.core.windows.net/container/blob-name?sv=2015-04-05&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D\" \
@@ -192,7 +192,7 @@ methods:
192
192
\ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
193
193
dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
194
194
\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ \
195
- 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ blob_samples_common.py\" , \" \
195
+ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ blob_samples_common.py\" , \" \
196
196
xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
197
197
: {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n # Passing\
198
198
\ in copy id to abort copy operation\n if props.copy.status != \" success\" :\n \
@@ -298,7 +298,7 @@ methods:
298
298
\ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
299
299
dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
300
300
\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ \
301
- 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ blob_samples_common.py\" , \" \
301
+ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ blob_samples_common.py\" , \" \
302
302
xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
303
303
: {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n # Acquire\
304
304
\ a lease on the blob\n lease = blob_client.acquire_lease()\n\n # Delete blob\
@@ -1406,7 +1406,7 @@ methods:
1406
1406
\ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
1407
1407
dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
1408
1408
\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ \
1409
- 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ blob_samples_common.py\" , \" \
1409
+ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ blob_samples_common.py\" , \" \
1410
1410
xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
1411
1411
: {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n # Create a\
1412
1412
\ read-only snapshot of the blob at this point in time\n snapshot_blob = blob_client.create_snapshot()\n \
@@ -1528,7 +1528,7 @@ methods:
1528
1528
- " Delete a blob.<!--[!code-python[Main](les\\ blob_samples_hello_world.py )]-->\n \
1529
1529
\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" \
1530
1530
: [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\\\ Python\\ \
1531
- \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure-storage-blob- 12.23 .0b1\\ \
1531
+ \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure_storage_blob- 12.24 .0b1\\ \
1532
1532
\\ samples\\\\ blob_samples_hello_world.py\" , \" xml:space\" : \" preserve\" , \" force\" \
1533
1533
: false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" \
1534
1534
linenos\" : false} -->\n\n ````python\n\n blob_client.delete_blob()\n\n ````\n "
@@ -1541,6 +1541,12 @@ methods:
1541
1541
*New in version 12.10.0:* This operation was introduced in API version '' 2020-10-02'' .'
1542
1542
signature : ' delete_immutability_policy(**kwargs: Any) -> None'
1543
1543
keywordOnlyParameters :
1544
+ - name : version_id
1545
+ description : ' The version id parameter is an opaque DateTime
1546
+
1547
+ value that, when present, specifies the version of the blob to check if it exists.'
1548
+ types :
1549
+ - <xref:str>
1544
1550
- name : timeout
1545
1551
description : ' Sets the server-side timeout for the operation in seconds. For more
1546
1552
details see
@@ -1720,7 +1726,7 @@ methods:
1720
1726
- " Download a blob.<!--[!code-python[Main](les\\ blob_samples_hello_world.py )]-->\n \
1721
1727
\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" \
1722
1728
: [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\\\ Python\\ \
1723
- \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure-storage-blob- 12.23 .0b1\\ \
1729
+ \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure_storage_blob- 12.24 .0b1\\ \
1724
1730
\\ samples\\\\ blob_samples_hello_world.py\" , \" xml:space\" : \" preserve\" , \" force\" \
1725
1731
: false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" \
1726
1732
linenos\" : false} -->\n\n ````python\n\n with open(DEST_FILE, \" wb\" ) as my_blob:\n \
@@ -1920,7 +1926,7 @@ methods:
1920
1926
blob_samples_authentication.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" \
1921
1927
: [], \" names\" : [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ \
1922
1928
hostedtoolcache\\\\ windows\\\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\ \
1923
- \\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ \
1929
+ \\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ \
1924
1930
blob_samples_authentication.py\" , \" xml:space\" : \" preserve\" , \" force\" : false,\
1925
1931
\ \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" linenos\" \
1926
1932
: false} -->\n\n ````python\n\n from azure.storage.blob import BlobClient\n \
@@ -2037,7 +2043,7 @@ methods:
2037
2043
\ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
2038
2044
dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
2039
2045
\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ \
2040
- 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ blob_samples_common.py\" , \" \
2046
+ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ blob_samples_common.py\" , \" \
2041
2047
xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
2042
2048
: {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n properties\
2043
2049
\ = blob_client.get_blob_properties()\n\n ````\n "
@@ -2658,7 +2664,7 @@ methods:
2658
2664
blob_samples_query.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [],\
2659
2665
\ \" names\" : [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\ \
2660
2666
\\ windows\\\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\ \
2661
- \\ 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ blob_samples_query.py\" , \" \
2667
+ \\ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ blob_samples_query.py\" , \" \
2662
2668
xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
2663
2669
: {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n errors = []\n \
2664
2670
\ def on_error(error):\n errors.append(error)\n\n # upload the csv file\n \
@@ -3142,6 +3148,12 @@ methods:
3142
3148
types :
3143
3149
- <xref:azure.storage.blob.ImmutabilityPolicy>
3144
3150
keywordOnlyParameters :
3151
+ - name : version_id
3152
+ description : ' The version id parameter is an opaque DateTime
3153
+
3154
+ value that, when present, specifies the version of the blob to check if it exists.'
3155
+ types :
3156
+ - <xref:str>
3145
3157
- name : timeout
3146
3158
description : ' Sets the server-side timeout for the operation in seconds. For more
3147
3159
details see
@@ -3173,6 +3185,12 @@ methods:
3173
3185
types :
3174
3186
- <xref:bool>
3175
3187
keywordOnlyParameters :
3188
+ - name : version_id
3189
+ description : ' The version id parameter is an opaque DateTime
3190
+
3191
+ value that, when present, specifies the version of the blob to check if it exists.'
3192
+ types :
3193
+ - <xref:str>
3176
3194
- name : timeout
3177
3195
description : ' Sets the server-side timeout for the operation in seconds. For more
3178
3196
details see
@@ -3937,7 +3955,7 @@ methods:
3937
3955
- " Copy a blob from a URL.<!--[!code-python[Main](les\\ blob_samples_common.py )]-->\n \
3938
3956
\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" \
3939
3957
: [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\\\ Python\\ \
3940
- \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure-storage-blob- 12.23 .0b1\\ \
3958
+ \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure_storage_blob- 12.24 .0b1\\ \
3941
3959
\\ samples\\\\ blob_samples_common.py\" , \" xml:space\" : \" preserve\" , \" force\" \
3942
3960
: false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" \
3943
3961
linenos\" : false} -->\n\n ````python\n\n # Get the blob client with the source\
@@ -3983,7 +4001,7 @@ methods:
3983
4001
- " Undeleting a blob.<!--[!code-python[Main](les\\ blob_samples_common.py )]-->\n \
3984
4002
\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" \
3985
4003
: [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\\\ Python\\ \
3986
- \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure-storage-blob- 12.23 .0b1\\ \
4004
+ \\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ 222\\\\ azure_storage_blob- 12.24 .0b1\\ \
3987
4005
\\ samples\\\\ blob_samples_common.py\" , \" xml:space\" : \" preserve\" , \" force\" \
3988
4006
: false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" \
3989
4007
linenos\" : false} -->\n\n ````python\n\n # Undelete the blob before the retention\
@@ -4257,7 +4275,7 @@ methods:
4257
4275
\ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
4258
4276
dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
4259
4277
\\ Python\\\\ 3.11.9\\\\ x64\\\\ Lib\\\\ site-packages\\\\ py2docfx\\\\ dist_temp\\\\ \
4260
- 222\\\\ azure-storage-blob- 12.23 .0b1\\\\ samples\\\\ blob_samples_hello_world.py\" \
4278
+ 222\\\\ azure_storage_blob- 12.24 .0b1\\\\ samples\\\\ blob_samples_hello_world.py\" \
4261
4279
, \" xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" \
4262
4280
highlight_args\" : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n \
4263
4281
\n # Upload content to block blob\n with open(SOURCE_FILE, \" rb\" ) as data:\n \
@@ -4268,7 +4286,8 @@ methods:
4268
4286
given URL.
4269
4287
4270
4288
The content of an existing blob is overwritten with the new blob.'
4271
- signature : ' upload_blob_from_url(source_url: str, **kwargs: Any) -> Dict[str, Any]'
4289
+ signature : ' upload_blob_from_url(source_url: str, *, metadata: Dict[str, str] |
4290
+ None = None, **kwargs: Any) -> Dict[str, Any]'
4272
4291
parameters :
4273
4292
- name : source_url
4274
4293
description : ' A URL of up to 2 KB in length that specifies a file or blob.
@@ -4294,6 +4313,10 @@ methods:
4294
4313
types :
4295
4314
- <xref:str>
4296
4315
keywordOnlyParameters :
4316
+ - name : metadata
4317
+ description : Name-value pairs associated with the blob as metadata.
4318
+ types :
4319
+ - <xref:dict>(<xref:str>, <xref:str>)
4297
4320
- name : overwrite
4298
4321
description : ' Whether the blob to be uploaded should overwrite the current data.
4299
4322
0 commit comments