Skip to content

Commit 0c016cf

Browse files
authored
[Storage]Edit doc for api_version (Azure#21085)
* [Storage]Edit doc for api_version * pylint fix
1 parent 9beca49 commit 0c016cf

18 files changed

+36
-36
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,8 @@ class BlobClient(StorageAccountHostsMixin): # pylint: disable=too-many-public-m
101101
If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential
102102
- except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError.
103103
:keyword str api_version:
104-
The Storage API version to use for requests. Default value is '2019-07-07'.
105-
Setting to an older version may result in reduced feature compatibility.
104+
The Storage API version to use for requests. Default value is the most recent service version that is
105+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
106106
107107
.. versionadded:: 12.2.0
108108

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,8 +77,8 @@ class BlobServiceClient(StorageAccountHostsMixin):
7777
If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential
7878
- except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError.
7979
:keyword str api_version:
80-
The Storage API version to use for requests. Default value is '2019-07-07'.
81-
Setting to an older version may result in reduced feature compatibility.
80+
The Storage API version to use for requests. Default value is the most recent service version that is
81+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
8282
8383
.. versionadded:: 12.2.0
8484

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ class ContainerClient(StorageAccountHostsMixin): # pylint: disable=too-many-p
9494
If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential
9595
- except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError.
9696
:keyword str api_version:
97-
The Storage API version to use for requests. Default value is '2019-07-07'.
98-
Setting to an older version may result in reduced feature compatibility.
97+
The Storage API version to use for requests. Default value is the most recent service version that is
98+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
9999
100100
.. versionadded:: 12.2.0
101101

sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_client_async.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ class BlobClient(AsyncStorageAccountHostsMixin, BlobClientBase): # pylint: disa
6565
If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential
6666
- except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError.
6767
:keyword str api_version:
68-
The Storage API version to use for requests. Default value is '2019-07-07'.
69-
Setting to an older version may result in reduced feature compatibility.
68+
The Storage API version to use for requests. Default value is the most recent service version that is
69+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
7070
7171
.. versionadded:: 12.2.0
7272

sdk/storage/azure-storage-blob/azure/storage/blob/aio/_blob_service_client_async.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ class BlobServiceClient(AsyncStorageAccountHostsMixin, BlobServiceClientBase):
6868
If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential
6969
- except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError.
7070
:keyword str api_version:
71-
The Storage API version to use for requests. Default value is '2019-07-07'.
72-
Setting to an older version may result in reduced feature compatibility.
71+
The Storage API version to use for requests. Default value is the most recent service version that is
72+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
7373
7474
.. versionadded:: 12.2.0
7575

sdk/storage/azure-storage-blob/azure/storage/blob/aio/_container_client_async.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ class ContainerClient(AsyncStorageAccountHostsMixin, ContainerClientBase):
6666
If the resource URI already contains a SAS token, this will be ignored in favor of an explicit credential
6767
- except in the case of AzureSasCredential, where the conflicting SAS tokens will raise a ValueError.
6868
:keyword str api_version:
69-
The Storage API version to use for requests. Default value is '2019-07-07'.
70-
Setting to an older version may result in reduced feature compatibility.
69+
The Storage API version to use for requests. Default value is the most recent service version that is
70+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
7171
7272
.. versionadded:: 12.2.0
7373

sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ class ShareDirectoryClient(StorageAccountHostsMixin):
6868
an instance of a AzureSasCredential from azure.core.credentials or an account
6969
shared access key.
7070
:keyword str api_version:
71-
The Storage API version to use for requests. Default value is '2019-07-07'.
72-
Setting to an older version may result in reduced feature compatibility.
71+
The Storage API version to use for requests. Default value is the most recent service version that is
72+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
7373
7474
.. versionadded:: 12.1.0
7575

sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,8 +119,8 @@ class ShareFileClient(StorageAccountHostsMixin):
119119
an instance of a AzureSasCredential from azure.core.credentials or an account
120120
shared access key.
121121
:keyword str api_version:
122-
The Storage API version to use for requests. Default value is '2019-07-07'.
123-
Setting to an older version may result in reduced feature compatibility.
122+
The Storage API version to use for requests. Default value is the most recent service version that is
123+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
124124
125125
.. versionadded:: 12.1.0
126126

sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ class ShareClient(StorageAccountHostsMixin):
6767
an instance of a AzureSasCredential from azure.core.credentials or an account
6868
shared access key.
6969
:keyword str api_version:
70-
The Storage API version to use for requests. Default value is '2019-07-07'.
71-
Setting to an older version may result in reduced feature compatibility.
70+
The Storage API version to use for requests. Default value is the most recent service version that is
71+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
7272
7373
.. versionadded:: 12.1.0
7474

sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ class ShareServiceClient(StorageAccountHostsMixin):
6363
an instance of a AzureSasCredential from azure.core.credentials or an account
6464
shared access key.
6565
:keyword str api_version:
66-
The Storage API version to use for requests. Default value is '2019-07-07'.
67-
Setting to an older version may result in reduced feature compatibility.
66+
The Storage API version to use for requests. Default value is the most recent service version that is
67+
compatible with the current SDK. Setting to an older version may result in reduced feature compatibility.
6868
6969
.. versionadded:: 12.1.0
7070

0 commit comments

Comments
 (0)