diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/BreakingChanges.txt b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/BreakingChanges.txt new file mode 100644 index 0000000000000..e69de29bb2d1d diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/CHANGELOG.md b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/CHANGELOG.md new file mode 100644 index 0000000000000..a08605b7158ad --- /dev/null +++ b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/CHANGELOG.md @@ -0,0 +1,9 @@ +# Release History + +## 12.0.0-beta.1 (Unreleased) + +### Features Added + +### Breaking Changes + +### Bugs Fixed diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md new file mode 100644 index 0000000000000..0fdc0b3610178 --- /dev/null +++ b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md @@ -0,0 +1,131 @@ +# Azure Storage Data Movement File Shares client library for .NET + +> Server Version: 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. Azure Storage +includes Azure Blobs (objects), Azure Data Lake Storage Gen2, Azure Files, +and Azure Queues. + +The Azure Storage Data Movement library is optimized for uploading, downloading and +copying customer data. + +The Azure.Storage.DataMovement.Files.Shares library provides infrastructure shared by the other +Azure Storage client libraries. + +[Source code][source] | [Package (NuGet)][package] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs] + +## Getting started + +### Install the package + +Install the Azure Storage client library for .NET you'd like to use with +[NuGet][nuget] and the `Azure.Storage.DataMovement.Files.Shares` client library will be included: + +```dotnetcli +dotnet add package Azure.Storage.DataMovement --prerelease +dotnet add package Azure.Storage.DataMovement.Files.Shares --prerelease +``` + +### Prerequisites + +You need an [Azure subscription][azure_sub] and a +[Storage Account][storage_account_docs] to use this package. + +To create a new Storage Account, you can use the [Azure Portal][storage_account_create_portal], +[Azure PowerShell][storage_account_create_ps], or the [Azure CLI][storage_account_create_cli]. +Here's an example using the Azure CLI: + +```Powershell +az storage account create --name MyStorageAccount --resource-group MyResourceGroup --location westus --sku Standard_LRS +``` + +### Authenticate the client +The Azure.Storage.DataMovement.Files.Shares library uses clients from the Azure.Storage.Files.Shares package to communicate with the Azure File Storage service. For more information see the Azure.Storage.Files.Shares [authentication documentation](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.Files.Shares#authenticate-the-client). + +## Key concepts + +The Azure Storage Common client library contains shared infrastructure like +[authentication credentials][auth_credentials] and [RequestFailedException][RequestFailedException]. + +### Thread safety +We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads. + +### Additional concepts + +[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | +[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | +[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) | +[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | +[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) | +[Mocking](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking) | +[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) + + +## Examples + +This section demonstrates usage of Data Movement for interacting with blob storage. + + +### Initializing File Storage `StorageResource` + +***TODO*** + +### Upload + +***TODO*** + +### Download + +***TODO*** + +### File Copy + +***TODO*** + +## Troubleshooting + +***TODO*** + +## Next steps + +***TODO*** + +## Contributing + +See the [Storage CONTRIBUTING.md][storage_contrib] for details on building, +testing, and contributing to these libraries. + +This project welcomes contributions and suggestions. Most contributions require +you to agree to a Contributor License Agreement (CLA) declaring that you have +the right to, and actually do, grant us the rights to use your contribution. For +details, visit [cla.microsoft.com][cla]. + +This project has adopted the [Microsoft Open Source Code of Conduct][coc]. +For more information see the [Code of Conduct FAQ][coc_faq] +or contact [opencode@microsoft.com][coc_contact] with any +additional questions or comments. + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fstorage%2FAzure.Storage.Common%2FREADME.png) + + +[source]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.Common/src +[package]: https://www.nuget.org/packages/Azure.Storage.Common/ +[docs]: https://docs.microsoft.com/dotnet/api/azure.storage +[rest_docs]: https://docs.microsoft.com/rest/api/storageservices/ +[product_docs]: https://docs.microsoft.com/azure/storage/ +[nuget]: https://www.nuget.org/ +[storage_account_docs]: https://docs.microsoft.com/azure/storage/common/storage-account-overview +[storage_account_create_ps]: https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell +[storage_account_create_cli]: https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-cli +[storage_account_create_portal]: https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal +[azure_cli]: https://docs.microsoft.com/cli/azure +[azure_sub]: https://azure.microsoft.com/free/dotnet/ +[RequestFailedException]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/core/Azure.Core/src/RequestFailedException.cs +[error_codes]: https://docs.microsoft.com/rest/api/storageservices/common-rest-api-error-codes +[samples]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.DataMovement.Blobs/samples +[storage_contrib]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/CONTRIBUTING.md +[cla]: https://cla.microsoft.com +[coc]: https://opensource.microsoft.com/codeofconduct/ +[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/ +[coc_contact]: mailto:opencode@microsoft.com diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/samples/Azure.Storage.DataMovement.Files.Shares.Samples.Tests.csproj b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/samples/Azure.Storage.DataMovement.Files.Shares.Samples.Tests.csproj new file mode 100644 index 0000000000000..e50b5044f2a64 --- /dev/null +++ b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/samples/Azure.Storage.DataMovement.Files.Shares.Samples.Tests.csproj @@ -0,0 +1,35 @@ + + + $(RequiredTargetFrameworks) + Microsoft Azure.Storage.DataMovement.Files.Shares client library samples + false + + + + + + + + + + + + PreserveNewest + + + + + + + + + + + + + + + + + + diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/src/Azure.Storage.DataMovement.Files.Shares.csproj b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/src/Azure.Storage.DataMovement.Files.Shares.csproj new file mode 100644 index 0000000000000..a2e444e50928e --- /dev/null +++ b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/src/Azure.Storage.DataMovement.Files.Shares.csproj @@ -0,0 +1,39 @@ + + + $(RequiredTargetFrameworks);net6.0 + true + + + Microsoft Azure.Storage.DataMovement.Blobs client library + 12.0.0-beta.1 + FileDataMovementSDK;$(DefineConstants) + Microsoft Azure Storage DataMovement, DataMovement, Microsoft, Azure, StorageScalable, azureofficial + + This client library enables working with the Microsoft Azure Storage services which include the blob and file services for storing binary and text data, and the queue service for storing messages that may be accessed by a client. + For this release see notes - https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blob.DataMovement/README.md and https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blob.DataMovement/CHANGELOG.md + in addition to the breaking changes https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blob.DataMovement/BreakingChanges.txt + Microsoft Azure Storage quickstarts and tutorials - https://docs.microsoft.com/en-us/azure/storage/ + Microsoft Azure Storage REST API Reference - https://docs.microsoft.com/en-us/rest/api/storageservices/ + + true + Azure.Storage.DataMovement.Files.Shares + + + + + + + + + + + + + + + + + + + + diff --git a/sdk/storage/Azure.Storage.DataMovement.Files.Shares/tests/Azure.Storage.DataMovement.Files.Shares.Tests.csproj b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/tests/Azure.Storage.DataMovement.Files.Shares.Tests.csproj new file mode 100644 index 0000000000000..e3712cbcf5468 --- /dev/null +++ b/sdk/storage/Azure.Storage.DataMovement.Files.Shares/tests/Azure.Storage.DataMovement.Files.Shares.Tests.csproj @@ -0,0 +1,29 @@ + + + $(RequiredTargetFrameworks) + Microsoft Azure.Storage.DataMovement.Files.Shareas client library tests + BlobDataMovementSDK;$(DefineConstants) + false + + + + DMBlobs + + + + + + + + + + PreserveNewest + + + + + + PreserveNewest + + + diff --git a/sdk/storage/Azure.Storage.sln b/sdk/storage/Azure.Storage.sln index a1e3472b8ae0e..d1ab9ccc2e624 100644 --- a/sdk/storage/Azure.Storage.sln +++ b/sdk/storage/Azure.Storage.sln @@ -155,6 +155,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Storage.DataMovement. EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Storage.Files.DataLake.Perf", "Azure.Storage.Files.DataLake\perf\Azure.Storage.Files.DataLake.Perf\Azure.Storage.Files.DataLake.Perf.csproj", "{0323A01E-E360-4D22-B1F4-15FD2DB39437}" EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Storage.DataMovement.Files.Shares", "Azure.Storage.DataMovement.Files.Shares\src\Azure.Storage.DataMovement.Files.Shares.csproj", "{D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Storage.DataMovement.Files.Shares.Tests", "Azure.Storage.DataMovement.Files.Shares\tests\Azure.Storage.DataMovement.Files.Shares.Tests.csproj", "{4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}" +EndProject +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Storage.DataMovement.Files.Shares.Samples.Tests", "Azure.Storage.DataMovement.Files.Shares\samples\Azure.Storage.DataMovement.Files.Shares.Samples.Tests.csproj", "{A564BB94-1867-4D43-98AB-F3C38E9AFA30}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -333,6 +339,18 @@ Global {0323A01E-E360-4D22-B1F4-15FD2DB39437}.Debug|Any CPU.Build.0 = Debug|Any CPU {0323A01E-E360-4D22-B1F4-15FD2DB39437}.Release|Any CPU.ActiveCfg = Release|Any CPU {0323A01E-E360-4D22-B1F4-15FD2DB39437}.Release|Any CPU.Build.0 = Release|Any CPU + {D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}.Release|Any CPU.Build.0 = Release|Any CPU + {4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}.Debug|Any CPU.Build.0 = Debug|Any CPU + {4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}.Release|Any CPU.ActiveCfg = Release|Any CPU + {4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}.Release|Any CPU.Build.0 = Release|Any CPU + {A564BB94-1867-4D43-98AB-F3C38E9AFA30}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A564BB94-1867-4D43-98AB-F3C38E9AFA30}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A564BB94-1867-4D43-98AB-F3C38E9AFA30}.Release|Any CPU.ActiveCfg = Release|Any CPU + {A564BB94-1867-4D43-98AB-F3C38E9AFA30}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE