@@ -150,15 +150,15 @@ examples:
150150 blob_samples_authentication.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" \
151151 : [], \" names\" : [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\ \
152152 \\ 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\" \
154154 , \" xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
155155 : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n from azure.storage.blob\
156156 \ import BlobClient\n blob_client = BlobClient.from_blob_url(blob_url=\" https://account.blob.core.windows.net/container/blob-name\" \
157157 )\n\n ````\n\n Creating the BlobClient from a SAS URL to a blob.<!--[!code-python[Main](les\\ \
158158 blob_samples_authentication.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" \
159159 : [], \" names\" : [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\ \
160160 \\ 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\" \
162162 , \" xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
163163 : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n from azure.storage.blob\
164164 \ 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:
192192 \ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
193193 dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
194194 \\ 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\" , \" \
196196 xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
197197 : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n # Passing\
198198 \ in copy id to abort copy operation\n if props.copy.status != \" success\" :\n \
@@ -298,7 +298,7 @@ methods:
298298 \ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
299299 dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
300300 \\ 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\" , \" \
302302 xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
303303 : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n # Acquire\
304304 \ a lease on the blob\n lease = blob_client.acquire_lease()\n\n # Delete blob\
@@ -1406,7 +1406,7 @@ methods:
14061406 \ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
14071407 dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
14081408 \\ 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\" , \" \
14101410 xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
14111411 : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n # Create a\
14121412 \ read-only snapshot of the blob at this point in time\n snapshot_blob = blob_client.create_snapshot()\n \
@@ -1528,7 +1528,7 @@ methods:
15281528 - " Delete a blob.<!--[!code-python[Main](les\\ blob_samples_hello_world.py )]-->\n \
15291529 \n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" \
15301530 : [], \" 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\\ \
15321532 \\ samples\\\\ blob_samples_hello_world.py\" , \" xml:space\" : \" preserve\" , \" force\" \
15331533 : false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" \
15341534 linenos\" : false} -->\n\n ````python\n\n blob_client.delete_blob()\n\n ````\n "
@@ -1541,6 +1541,12 @@ methods:
15411541 *New in version 12.10.0:* This operation was introduced in API version '' 2020-10-02'' .'
15421542 signature : ' delete_immutability_policy(**kwargs: Any) -> None'
15431543 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>
15441550 - name : timeout
15451551 description : ' Sets the server-side timeout for the operation in seconds. For more
15461552 details see
@@ -1720,7 +1726,7 @@ methods:
17201726 - " Download a blob.<!--[!code-python[Main](les\\ blob_samples_hello_world.py )]-->\n \
17211727 \n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" \
17221728 : [], \" 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\\ \
17241730 \\ samples\\\\ blob_samples_hello_world.py\" , \" xml:space\" : \" preserve\" , \" force\" \
17251731 : false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" \
17261732 linenos\" : false} -->\n\n ````python\n\n with open(DEST_FILE, \" wb\" ) as my_blob:\n \
@@ -1920,7 +1926,7 @@ methods:
19201926 blob_samples_authentication.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" \
19211927 : [], \" names\" : [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ \
19221928 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\\\\ \
19241930 blob_samples_authentication.py\" , \" xml:space\" : \" preserve\" , \" force\" : false,\
19251931 \ \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" linenos\" \
19261932 : false} -->\n\n ````python\n\n from azure.storage.blob import BlobClient\n \
@@ -2037,7 +2043,7 @@ methods:
20372043 \ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
20382044 dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
20392045 \\ 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\" , \" \
20412047 xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
20422048 : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n properties\
20432049 \ = blob_client.get_blob_properties()\n\n ````\n "
@@ -2658,7 +2664,7 @@ methods:
26582664 blob_samples_query.py )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [],\
26592665 \ \" names\" : [], \" dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\ \
26602666 \\ 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\" , \" \
26622668 xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" highlight_args\" \
26632669 : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n\n errors = []\n \
26642670 \ def on_error(error):\n errors.append(error)\n\n # upload the csv file\n \
@@ -3142,6 +3148,12 @@ methods:
31423148 types :
31433149 - <xref:azure.storage.blob.ImmutabilityPolicy>
31443150 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>
31453157 - name : timeout
31463158 description : ' Sets the server-side timeout for the operation in seconds. For more
31473159 details see
@@ -3173,6 +3185,12 @@ methods:
31733185 types :
31743186 - <xref:bool>
31753187 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>
31763194 - name : timeout
31773195 description : ' Sets the server-side timeout for the operation in seconds. For more
31783196 details see
@@ -3937,7 +3955,7 @@ methods:
39373955 - " Copy a blob from a URL.<!--[!code-python[Main](les\\ blob_samples_common.py )]-->\n \
39383956 \n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" \
39393957 : [], \" 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\\ \
39413959 \\ samples\\\\ blob_samples_common.py\" , \" xml:space\" : \" preserve\" , \" force\" \
39423960 : false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" \
39433961 linenos\" : false} -->\n\n ````python\n\n # Get the blob client with the source\
@@ -3983,7 +4001,7 @@ methods:
39834001 - " Undeleting a blob.<!--[!code-python[Main](les\\ blob_samples_common.py )]-->\n \
39844002 \n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" dupnames\" \
39854003 : [], \" 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\\ \
39874005 \\ samples\\\\ blob_samples_common.py\" , \" xml:space\" : \" preserve\" , \" force\" \
39884006 : false, \" language\" : \" python\" , \" highlight_args\" : {\" linenostart\" : 1}, \" \
39894007 linenos\" : false} -->\n\n ````python\n\n # Undelete the blob before the retention\
@@ -4257,7 +4275,7 @@ methods:
42574275 \ )]-->\n\n <!-- literal_block {\" ids\" : [], \" classes\" : [], \" names\" : [], \" \
42584276 dupnames\" : [], \" backrefs\" : [], \" source\" : \" C:\\\\ hostedtoolcache\\\\ windows\\ \
42594277 \\ 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\" \
42614279 , \" xml:space\" : \" preserve\" , \" force\" : false, \" language\" : \" python\" , \" \
42624280 highlight_args\" : {\" linenostart\" : 1}, \" linenos\" : false} -->\n\n ````python\n \
42634281 \n # Upload content to block blob\n with open(SOURCE_FILE, \" rb\" ) as data:\n \
@@ -4268,7 +4286,8 @@ methods:
42684286 given URL.
42694287
42704288 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]'
42724291 parameters :
42734292 - name : source_url
42744293 description : ' A URL of up to 2 KB in length that specifies a file or blob.
@@ -4294,6 +4313,10 @@ methods:
42944313 types :
42954314 - <xref:str>
42964315 keywordOnlyParameters :
4316+ - name : metadata
4317+ description : Name-value pairs associated with the blob as metadata.
4318+ types :
4319+ - <xref:dict>(<xref:str>, <xref:str>)
42974320 - name : overwrite
42984321 description : ' Whether the blob to be uploaded should overwrite the current data.
42994322
0 commit comments