From ed54f8f11c3ee62784179ce45a193bdb08ab2c47 Mon Sep 17 00:00:00 2001 From: xiafu Date: Mon, 29 Mar 2021 14:24:51 -0700 Subject: [PATCH 1/3] [Doc][Fix]Add link for optional configuration --- .../azure-storage-blob/azure/storage/blob/_blob_client.py | 4 ++++ .../azure/storage/blob/_blob_service_client.py | 4 ++++ .../azure/storage/blob/_container_client.py | 4 ++++ .../azure/storage/fileshare/_directory_client.py | 4 ++++ .../azure/storage/fileshare/_file_client.py | 4 ++++ .../azure/storage/fileshare/_share_client.py | 4 ++++ .../azure/storage/fileshare/_share_service_client.py | 4 ++++ .../azure-storage-queue/azure/storage/queue/_queue_client.py | 4 ++++ .../azure/storage/queue/_queue_service_client.py | 4 ++++ 9 files changed, 36 insertions(+) diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py index 3ef190102edf..ab34bbf516cf 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py @@ -75,6 +75,10 @@ class BlobClient(StorageAccountHostsMixin): # pylint: disable=too-many-public-methods """A client to interact with a specific blob, although that blob may not yet exist. + For more optional configuration, please click + here. + :param str account_url: The URI to the storage account. In order to create a client given the full URI to the blob, use the :func:`from_blob_url` classmethod. diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py index 26298ee7fb28..8dff08e4731c 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py @@ -60,6 +60,10 @@ class BlobServiceClient(StorageAccountHostsMixin): For operations relating to a specific container or blob, clients for those entities can also be retrieved using the `get_client` functions. + For more optional configuration, please click + here. + :param str account_url: The URL to the blob storage account. Any other entities included in the URL path (e.g. container or blob) will be discarded. This URL can be optionally diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py index 20dcd62eb9fe..ed95783068a8 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py @@ -76,6 +76,10 @@ class ContainerClient(StorageAccountHostsMixin): For operations relating to a specific blob within this container, a blob client can be retrieved using the :func:`~get_blob_client` function. + For more optional configuration, please click + here. + :param str account_url: The URI to the storage account. In order to create a client given the full URI to the container, use the :func:`from_container_url` classmethod. diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py index 9d0b55a0aca8..a19223e4b707 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py @@ -46,6 +46,10 @@ class ShareDirectoryClient(StorageAccountHostsMixin): For operations relating to a specific subdirectory or file in this share, the clients for those entities can also be retrieved using the :func:`get_subdirectory_client` and :func:`get_file_client` functions. + For more optional configuration, please click + here. + :param str account_url: The URI to the storage account. In order to create a client given the full URI to the directory, use the :func:`from_directory_url` classmethod. diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py index ff0938fe4d58..d2a991655666 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py @@ -97,6 +97,10 @@ def _upload_file_helper( class ShareFileClient(StorageAccountHostsMixin): """A client to interact with a specific file, although that file may not yet exist. + For more optional configuration, please click + here. + :param str account_url: The URI to the storage account. In order to create a client given the full URI to the file, use the :func:`from_file_url` classmethod. diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py index db0d1c9cb0d9..9b334fe89dab 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py @@ -48,6 +48,10 @@ class ShareClient(StorageAccountHostsMixin): For operations relating to a specific directory or file in this share, the clients for those entities can also be retrieved using the :func:`get_directory_client` and :func:`get_file_client` functions. + For more optional configuration, please click + here. + :param str account_url: The URI to the storage account. In order to create a client given the full URI to the share, use the :func:`from_share_url` classmethod. diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py index 74c28d882487..087d9786bb9f 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py @@ -49,6 +49,10 @@ class ShareServiceClient(StorageAccountHostsMixin): For operations relating to a specific share, a client for that entity can also be retrieved using the :func:`get_share_client` function. + For more optional configuration, please click + here. + :param str account_url: The URL to the file share storage account. Any other entities included in the URL path (e.g. share or file) will be discarded. This URL can be optionally diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py index 3a75db386fe6..c698f7eea289 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py @@ -41,6 +41,10 @@ class QueueClient(StorageAccountHostsMixin): """A client to interact with a specific Queue. + For more optional configuration, please click + here. + :param str account_url: The URL to the storage account. In order to create a client given the full URI to the queue, use the :func:`from_queue_url` classmethod. diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py index d9faf38e5da8..2d41e22bfb4a 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py @@ -51,6 +51,10 @@ class QueueServiceClient(StorageAccountHostsMixin): For operations relating to a specific queue, a client for this entity can be retrieved using the :func:`~get_queue_client` function. + For more optional configuration, please click + here. + :param str account_url: The URL to the queue service endpoint. Any other entities included in the URL path (e.g. queue) will be discarded. This URL can be optionally From 393b0e8f3e14563b7d6a4b89c20cdca8978094c3 Mon Sep 17 00:00:00 2001 From: xiafu Date: Mon, 29 Mar 2021 15:24:30 -0700 Subject: [PATCH 2/3] modify --- .../azure-storage-blob/azure/storage/blob/_blob_client.py | 4 ++-- .../azure/storage/blob/_blob_service_client.py | 4 ++-- .../azure/storage/blob/_container_client.py | 4 ++-- .../azure/storage/fileshare/_directory_client.py | 4 ++-- .../azure/storage/fileshare/_file_client.py | 4 ++-- .../azure/storage/fileshare/_share_client.py | 4 ++-- .../azure/storage/fileshare/_share_service_client.py | 4 ++-- .../azure-storage-queue/azure/storage/queue/_queue_client.py | 4 ++-- .../azure/storage/queue/_queue_service_client.py | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py index ab34bbf516cf..f08a88be7cb2 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py @@ -76,8 +76,8 @@ class BlobClient(StorageAccountHostsMixin): # pylint: disable=too-many-public-m """A client to interact with a specific blob, although that blob may not yet exist. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the blob, diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py index 8dff08e4731c..1f089c6cc029 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py @@ -61,8 +61,8 @@ class BlobServiceClient(StorageAccountHostsMixin): can also be retrieved using the `get_client` functions. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URL to the blob storage account. Any other entities included diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py index ed95783068a8..79951fe49b75 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py @@ -77,8 +77,8 @@ class ContainerClient(StorageAccountHostsMixin): retrieved using the :func:`~get_blob_client` function. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the container, diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py index a19223e4b707..8e4d707adcc1 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py @@ -47,8 +47,8 @@ class ShareDirectoryClient(StorageAccountHostsMixin): entities can also be retrieved using the :func:`get_subdirectory_client` and :func:`get_file_client` functions. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the directory, diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py index d2a991655666..66eb9cdcf832 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py @@ -98,8 +98,8 @@ class ShareFileClient(StorageAccountHostsMixin): """A client to interact with a specific file, although that file may not yet exist. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py index 9b334fe89dab..72723e7453d7 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py @@ -49,8 +49,8 @@ class ShareClient(StorageAccountHostsMixin): those entities can also be retrieved using the :func:`get_directory_client` and :func:`get_file_client` functions. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the share, diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py index 087d9786bb9f..fa12ca9dc61d 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py @@ -50,8 +50,8 @@ class ShareServiceClient(StorageAccountHostsMixin): can also be retrieved using the :func:`get_share_client` function. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URL to the file share storage account. Any other entities included diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py index c698f7eea289..acb0b6b46748 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py @@ -42,8 +42,8 @@ class QueueClient(StorageAccountHostsMixin): """A client to interact with a specific Queue. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URL to the storage account. In order to create a client given the full URI to the queue, diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py index 2d41e22bfb4a..1c5f73b0a3e7 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py @@ -52,8 +52,8 @@ class QueueServiceClient(StorageAccountHostsMixin): can be retrieved using the :func:`~get_queue_client` function. For more optional configuration, please click - here. + :code:`here`. :param str account_url: The URL to the queue service endpoint. Any other entities included From f008a0cb6ab3237ddbbf88e0d47d15654083fac4 Mon Sep 17 00:00:00 2001 From: xiafu Date: Tue, 30 Mar 2021 11:17:53 -0700 Subject: [PATCH 3/3] fix doc --- .../azure-storage-blob/azure/storage/blob/_blob_client.py | 4 ++-- .../azure/storage/blob/_blob_service_client.py | 4 ++-- .../azure/storage/blob/_container_client.py | 4 ++-- .../azure/storage/fileshare/_directory_client.py | 4 ++-- .../azure/storage/fileshare/_file_client.py | 4 ++-- .../azure/storage/fileshare/_share_client.py | 4 ++-- .../azure/storage/fileshare/_share_service_client.py | 4 ++-- .../azure-storage-queue/azure/storage/queue/_queue_client.py | 4 ++-- .../azure/storage/queue/_queue_service_client.py | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py index f08a88be7cb2..7457e245435b 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_client.py @@ -76,8 +76,8 @@ class BlobClient(StorageAccountHostsMixin): # pylint: disable=too-many-public-m """A client to interact with a specific blob, although that blob may not yet exist. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the blob, diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py index 1f089c6cc029..6016a8a10ef8 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_blob_service_client.py @@ -61,8 +61,8 @@ class BlobServiceClient(StorageAccountHostsMixin): can also be retrieved using the `get_client` functions. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URL to the blob storage account. Any other entities included diff --git a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py index 79951fe49b75..de920fac1eda 100644 --- a/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py +++ b/sdk/storage/azure-storage-blob/azure/storage/blob/_container_client.py @@ -77,8 +77,8 @@ class ContainerClient(StorageAccountHostsMixin): retrieved using the :func:`~get_blob_client` function. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the container, diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py index 8e4d707adcc1..557c94f08e17 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_directory_client.py @@ -47,8 +47,8 @@ class ShareDirectoryClient(StorageAccountHostsMixin): entities can also be retrieved using the :func:`get_subdirectory_client` and :func:`get_file_client` functions. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the directory, diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py index 66eb9cdcf832..acd4c99dd3eb 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_file_client.py @@ -98,8 +98,8 @@ class ShareFileClient(StorageAccountHostsMixin): """A client to interact with a specific file, although that file may not yet exist. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py index 72723e7453d7..afb4457cb6b0 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_client.py @@ -49,8 +49,8 @@ class ShareClient(StorageAccountHostsMixin): those entities can also be retrieved using the :func:`get_directory_client` and :func:`get_file_client` functions. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URI to the storage account. In order to create a client given the full URI to the share, diff --git a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py index fa12ca9dc61d..600426b6b0e3 100644 --- a/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py +++ b/sdk/storage/azure-storage-file-share/azure/storage/fileshare/_share_service_client.py @@ -50,8 +50,8 @@ class ShareServiceClient(StorageAccountHostsMixin): can also be retrieved using the :func:`get_share_client` function. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URL to the file share storage account. Any other entities included diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py index acb0b6b46748..c1e33aaacd00 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_client.py @@ -42,8 +42,8 @@ class QueueClient(StorageAccountHostsMixin): """A client to interact with a specific Queue. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URL to the storage account. In order to create a client given the full URI to the queue, diff --git a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py index 1c5f73b0a3e7..b6f8a64646ea 100644 --- a/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py +++ b/sdk/storage/azure-storage-queue/azure/storage/queue/_queue_service_client.py @@ -52,8 +52,8 @@ class QueueServiceClient(StorageAccountHostsMixin): can be retrieved using the :func:`~get_queue_client` function. For more optional configuration, please click - :code:`here`. + `here `_. :param str account_url: The URL to the queue service endpoint. Any other entities included