-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
src, test, and samples projects for DataMovement.Files.Shares (#38678)
* src, test, and samples projects for DataMovement.Files.Shares * placeholder readme * remove shared source * more csproj * blank changelog
- Loading branch information
1 parent
7f26772
commit 9deaf30
Showing
7 changed files
with
261 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
9 changes: 9 additions & 0 deletions
9
sdk/storage/Azure.Storage.DataMovement.Files.Shares/CHANGELOG.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| # Release History | ||
|
|
||
| ## 12.0.0-beta.1 (Unreleased) | ||
|
|
||
| ### Features Added | ||
|
|
||
| ### Breaking Changes | ||
|
|
||
| ### Bugs Fixed |
131 changes: 131 additions & 0 deletions
131
sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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 COMMON BAR --> | ||
| [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/) | ||
| <!-- CLIENT COMMON BAR --> | ||
|
|
||
| ## 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 [[email protected]][coc_contact] with any | ||
| additional questions or comments. | ||
|
|
||
|  | ||
|
|
||
| <!-- LINKS --> | ||
| [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:[email protected] |
35 changes: 35 additions & 0 deletions
35
...ovement.Files.Shares/samples/Azure.Storage.DataMovement.Files.Shares.Samples.Tests.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks> | ||
| <AssemblyTitle>Microsoft Azure.Storage.DataMovement.Files.Shares client library samples</AssemblyTitle> | ||
| <IsPackable>false</IsPackable> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <Compile Include="$(AzureStorageSharedTestSources)\**\*.cs" LinkBase="Shared" /> | ||
| <Compile Remove="$(AzureStorageSharedTestSources)\AzuriteFixture.cs" /> | ||
| <Compile Remove="$(AzureStorageSharedTestSources)\AzuriteNUnitFixture.cs" /> | ||
| <Compile Remove="$(AzureStorageSharedTestSources)\StorageTestBase.SasVersion.cs" /> | ||
| <Compile Remove="$(AzureStorageSharedTestSources)\ClientSideEncryptionTestExtensions.cs" /> | ||
| <Compile Remove="$(AzureStorageSharedTestSources)\RepeatingStream.cs" /> | ||
| <Compile Remove="$(AzureStorageSharedTestSources)\TransferValidationTestBase.cs" /> | ||
| <Compile Remove="$(AzureStorageSharedTestSources)\Sas\*.cs" /> | ||
| <None Include="$(AzureStorageSharedTestSources)\*.xml"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </None> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Compile Include="$(AzureCoreSharedSources)ArrayBufferWriter.cs" LinkBase="Shared\Core" /> | ||
| <Compile Include="$(AzureCoreSharedSources)NoBodyResponseOfT.cs" LinkBase="Shared\Core" /> | ||
| <Compile Include="$(AzureCoreSharedSources)TaskExtensions.cs" LinkBase="Shared\Core" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Compile Include="$(AzureStorageSharedSources)Constants.cs" LinkBase="Shared" /> | ||
| <Compile Include="$(AzureStorageSharedSources)Errors.cs" LinkBase="Shared" /> | ||
| <Compile Include="$(AzureStorageSharedSources)SasExtensions.cs" LinkBase="Shared" /> | ||
| <Compile Include="$(AzureStorageSharedSources)StorageConnectionString.cs" LinkBase="Shared" /> | ||
| <Compile Include="$(AzureStorageSharedSources)SharedAccessSignatureCredentials.cs" LinkBase="Shared" /> | ||
| <Compile Include="$(AzureStorageSharedSources)UriExtensions.cs" LinkBase="Shared" /> | ||
| <Compile Include="$(AzureStorageSharedSources)UriQueryParamsCollection.cs" LinkBase="Shared" /> | ||
| <Compile Include="$(AzureStorageSharedSources)StorageExceptionExtensions.cs" LinkBase="Shared" /> | ||
| </ItemGroup> | ||
| </Project> |
39 changes: 39 additions & 0 deletions
39
...zure.Storage.DataMovement.Files.Shares/src/Azure.Storage.DataMovement.Files.Shares.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>$(RequiredTargetFrameworks);net6.0</TargetFrameworks> | ||
| <IncludeGeneratorSharedCode>true</IncludeGeneratorSharedCode> | ||
| </PropertyGroup> | ||
| <PropertyGroup> | ||
| <AssemblyTitle>Microsoft Azure.Storage.DataMovement.Blobs client library</AssemblyTitle> | ||
| <Version>12.0.0-beta.1</Version> | ||
| <DefineConstants>FileDataMovementSDK;$(DefineConstants)</DefineConstants> | ||
| <PackageTags>Microsoft Azure Storage DataMovement, DataMovement, Microsoft, Azure, StorageScalable, azureofficial</PackageTags> | ||
| <Description> | ||
| 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/ | ||
| </Description> | ||
| <IncludeOperationsSharedSource>true</IncludeOperationsSharedSource> | ||
| <RootNamespace>Azure.Storage.DataMovement.Files.Shares</RootNamespace> | ||
| <PackageId /> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <!--<PackageReference Include="Azure.Storage.Files.Shares" />--> | ||
| <ProjectReference Include="$(MSBuildThisFileDirectory)..\..\Azure.Storage.Files.Shares\src\Azure.Storage.Files.Shares.csproj" /> | ||
| <PackageReference Include="System.Threading.Channels" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="$(MSBuildThisFileDirectory)..\..\Azure.Storage.DataMovement\src\Azure.Storage.DataMovement.csproj" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Compile Include="$(AzureCoreSharedSources)CancellationHelper.cs" LinkBase="SharedCore" /> | ||
| <Compile Include="$(AzureCoreSharedSources)SyncAsyncEventHandlerExtensions.cs" LinkBase="Shared\Core" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="Azure.Core" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| </ItemGroup> | ||
| </Project> |
29 changes: 29 additions & 0 deletions
29
...rage.DataMovement.Files.Shares/tests/Azure.Storage.DataMovement.Files.Shares.Tests.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks> | ||
| <AssemblyTitle>Microsoft Azure.Storage.DataMovement.Files.Shareas client library tests</AssemblyTitle> | ||
| <DefineConstants>BlobDataMovementSDK;$(DefineConstants)</DefineConstants> | ||
| <IsPackable>false</IsPackable> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="$(MSBuildThisFileDirectory)..\src\Azure.Storage.DataMovement.Files.Shares.csproj"> | ||
| <Aliases>DMBlobs</Aliases> | ||
| </ProjectReference> | ||
| <ProjectReference Include="$(MSBuildThisFileDirectory)..\..\Azure.Storage.DataMovement\src\Azure.Storage.DataMovement.csproj" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <None Include="$(AzureStorageSharedTestSources)\*.xml"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </None> | ||
| <None Include="$(AzureStorageSharedTestSources)\azurite_cert.pem" CopyToOutputDirectory="PreserveNewest" /> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <Content Include="Resources\**"> | ||
| <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory> | ||
| </Content> | ||
| </ItemGroup> | ||
| </Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters