From 9a4e7d515de70397eb740219b023b796dd734c9f Mon Sep 17 00:00:00 2001 From: Jocelyn Schreppler Date: Tue, 7 Nov 2023 15:57:09 -0500 Subject: [PATCH 1/4] Introduce "known issues" page Adds the page to datamovement base folder. Readmes for base, blob, and file packages add a reference to this page as their first H2 section of the document. --- .../Azure.Storage.DataMovement.Blobs/README.md | 4 ++++ .../README.md | 4 ++++ .../Azure.Storage.DataMovement/KnownIssues.md | 13 +++++++++++++ sdk/storage/Azure.Storage.DataMovement/README.md | 6 ++++++ 4 files changed, 27 insertions(+) create mode 100644 sdk/storage/Azure.Storage.DataMovement/KnownIssues.md diff --git a/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md b/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md index 0e9b4bf45e28..7a1bf1bdf91d 100644 --- a/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md +++ b/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md @@ -15,6 +15,10 @@ Azure Storage client libraries. [Source code][source] | [Package (NuGet)][package] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] +## Known Issues + +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](../Azure.Storage.DataMovement/KnownIssues) for detailed information. + ## Getting started ### Install the package diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md index 0fdc0b361017..83f902d72f2c 100644 --- a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md +++ b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md @@ -15,6 +15,10 @@ Azure Storage client libraries. [Source code][source] | [Package (NuGet)][package] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] +## Known Issues + +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](../Azure.Storage.DataMovement/KnownIssues) for detailed information. + ## Getting started ### Install the package diff --git a/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md b/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md new file mode 100644 index 000000000000..e69edfee00b9 --- /dev/null +++ b/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md @@ -0,0 +1,13 @@ +# Known Issues + +Azure.Storage.DataMovement is still in beta. Not all functionality is currently implemented, and there are known issues that may cause problems for your application. Significant known issues are documented below + +## Preserving properties and metadata on copy + +When copying data between blobs, blob properties and blob metadata are not preserved. There is currently no support for this feature; properties and metadata can only be defined by the caller to be applied uniformly to each destination blob. + +This limitation also exists for share files and directories. + +### Client-side encryption support + +**There is no support for copying client-side encrypted blobs.** Since client-side encryption is built on blob metadata, the necessary information to decrypt the blob will not be transferred in a service-to-service copy. Azure.Storage.Blobs will not be able to decrypt the copied blob. If that metadata is lost, your blob contents will be lost forever. diff --git a/sdk/storage/Azure.Storage.DataMovement/README.md b/sdk/storage/Azure.Storage.DataMovement/README.md index 79820866edff..f228dbf051b2 100644 --- a/sdk/storage/Azure.Storage.DataMovement/README.md +++ b/sdk/storage/Azure.Storage.DataMovement/README.md @@ -2,6 +2,8 @@ > Server Version: 2021-02-12, 2020-12-06, 2020-10-02, 2020-08-04, 2020-06-12, 2020-04-08, 2020-02-10, 2019-12-12, 2019-07-07, and 2020-02-02 + + Azure Storage is a Microsoft-managed service providing cloud storage that is highly available, secure, durable, scalable, and redundant. @@ -12,6 +14,10 @@ Currently this version of the Data Movement library only supports Blobs. [Source code][source] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] +## Known Issues + +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](./KnownIssues) for detailed information. + ## Getting started ### Install the package From e88e68349138185843867c677634a127157a8014 Mon Sep 17 00:00:00 2001 From: Jocelyn Schreppler Date: Fri, 10 Nov 2023 14:33:56 -0500 Subject: [PATCH 2/4] reorganize readme --- sdk/storage/Azure.Storage.DataMovement.Blobs/README.md | 10 ++++++---- .../Azure.Storage.DataMovement.Files.Shares/README.md | 10 ++++++---- sdk/storage/Azure.Storage.DataMovement/README.md | 8 ++++---- 3 files changed, 16 insertions(+), 12 deletions(-) diff --git a/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md b/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md index 7a1bf1bdf91d..66f6b06edfca 100644 --- a/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md +++ b/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md @@ -2,6 +2,12 @@ > Server Version: 2020-04-08, 2020-02-10, 2019-12-12, 2019-07-07, and 2020-02-02 +## Project Status: Beta + +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](./KnownIssues) for detailed information. + +--- + Azure Storage is a Microsoft-managed service providing cloud storage that is highly available, secure, durable, scalable, and redundant. Azure Storage includes Azure Blobs (objects), Azure Data Lake Storage Gen2, Azure Files, @@ -15,10 +21,6 @@ Azure Storage client libraries. [Source code][source] | [Package (NuGet)][package] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] -## Known Issues - -This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](../Azure.Storage.DataMovement/KnownIssues) for detailed information. - ## Getting started ### Install the package diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md index 83f902d72f2c..8dac5279030b 100644 --- a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md +++ b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md @@ -2,6 +2,12 @@ > Server Version: 2020-04-08, 2020-02-10, 2019-12-12, 2019-07-07, and 2020-02-02 +## Project Status: Beta + +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](./KnownIssues) for detailed information. + +--- + Azure Storage is a Microsoft-managed service providing cloud storage that is highly available, secure, durable, scalable, and redundant. Azure Storage includes Azure Blobs (objects), Azure Data Lake Storage Gen2, Azure Files, @@ -15,10 +21,6 @@ Azure Storage client libraries. [Source code][source] | [Package (NuGet)][package] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] -## Known Issues - -This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](../Azure.Storage.DataMovement/KnownIssues) for detailed information. - ## Getting started ### Install the package diff --git a/sdk/storage/Azure.Storage.DataMovement/README.md b/sdk/storage/Azure.Storage.DataMovement/README.md index f228dbf051b2..8f4f9e8c04ff 100644 --- a/sdk/storage/Azure.Storage.DataMovement/README.md +++ b/sdk/storage/Azure.Storage.DataMovement/README.md @@ -2,7 +2,11 @@ > Server Version: 2021-02-12, 2020-12-06, 2020-10-02, 2020-08-04, 2020-06-12, 2020-04-08, 2020-02-10, 2019-12-12, 2019-07-07, and 2020-02-02 +## Project Status: Beta +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](./KnownIssues) for detailed information. + +--- Azure Storage is a Microsoft-managed service providing cloud storage that is highly available, secure, durable, scalable, and redundant. @@ -14,10 +18,6 @@ Currently this version of the Data Movement library only supports Blobs. [Source code][source] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] -## Known Issues - -This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](./KnownIssues) for detailed information. - ## Getting started ### Install the package From 860f5af5cc79074b21bf79d3500267a3ff131d56 Mon Sep 17 00:00:00 2001 From: Jocelyn Schreppler Date: Fri, 10 Nov 2023 14:37:51 -0500 Subject: [PATCH 3/4] add issue re:transfer sizes --- sdk/storage/Azure.Storage.DataMovement/KnownIssues.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md b/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md index e69edfee00b9..3c454cb48f01 100644 --- a/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md +++ b/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md @@ -11,3 +11,7 @@ This limitation also exists for share files and directories. ### Client-side encryption support **There is no support for copying client-side encrypted blobs.** Since client-side encryption is built on blob metadata, the necessary information to decrypt the blob will not be transferred in a service-to-service copy. Azure.Storage.Blobs will not be able to decrypt the copied blob. If that metadata is lost, your blob contents will be lost forever. + +## Transfer Sizes + +The Azure Storage REST service has various limitations as to the size of request body it will accept, depending on the operation being performed. While the DataMovement library attempts to clamp transfer chunk sizes down to accepted levels, it is not always accurate. Please refer to the [REST documentation](https://learn.microsoft.com/en-us/rest/api/storageservices/) for information on transfer size limitations. From bd8efe94e2a2c34e97442a27a79efde204618252 Mon Sep 17 00:00:00 2001 From: Jocelyn Schreppler Date: Fri, 10 Nov 2023 14:54:27 -0500 Subject: [PATCH 4/4] link style checks --- sdk/storage/Azure.Storage.DataMovement.Blobs/README.md | 2 +- sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md | 2 +- sdk/storage/Azure.Storage.DataMovement/KnownIssues.md | 2 +- sdk/storage/Azure.Storage.DataMovement/README.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md b/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md index 66f6b06edfca..192475c53b56 100644 --- a/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md +++ b/sdk/storage/Azure.Storage.DataMovement.Blobs/README.md @@ -4,7 +4,7 @@ ## Project Status: Beta -This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](./KnownIssues) for detailed information. +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md) for detailed information. --- diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md index 8dac5279030b..8537edd77979 100644 --- a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md +++ b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md @@ -4,7 +4,7 @@ ## Project Status: Beta -This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](./KnownIssues) for detailed information. +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md) for detailed information. --- diff --git a/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md b/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md index 3c454cb48f01..5fae453c905d 100644 --- a/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md +++ b/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md @@ -14,4 +14,4 @@ This limitation also exists for share files and directories. ## Transfer Sizes -The Azure Storage REST service has various limitations as to the size of request body it will accept, depending on the operation being performed. While the DataMovement library attempts to clamp transfer chunk sizes down to accepted levels, it is not always accurate. Please refer to the [REST documentation](https://learn.microsoft.com/en-us/rest/api/storageservices/) for information on transfer size limitations. +The Azure Storage REST service has various limitations as to the size of request body it will accept, depending on the operation being performed. While the DataMovement library attempts to clamp transfer chunk sizes down to accepted levels, it is not always accurate. Please refer to the [REST documentation](https://learn.microsoft.com/rest/api/storageservices/) for information on transfer size limitations. diff --git a/sdk/storage/Azure.Storage.DataMovement/README.md b/sdk/storage/Azure.Storage.DataMovement/README.md index 8f4f9e8c04ff..3bbd85204695 100644 --- a/sdk/storage/Azure.Storage.DataMovement/README.md +++ b/sdk/storage/Azure.Storage.DataMovement/README.md @@ -4,7 +4,7 @@ ## Project Status: Beta -This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](./KnownIssues) for detailed information. +This product is in beta. Some features will be missing or have significant bugs. Please see [Known Issues](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/Azure.Storage.DataMovement/KnownIssues.md) for detailed information. ---