Skip to content

Commit b54db98

Browse files
jaschrep-msftyaotongms
jaschrep-msft
authored and
yaotongms
committed
src, test, and samples projects for DataMovement.Files.Shares (Azure#38678)
* src, test, and samples projects for DataMovement.Files.Shares * placeholder readme * remove shared source * more csproj * blank changelog
1 parent 66ae32a commit b54db98

File tree

7 files changed

+261
-0
lines changed

7 files changed

+261
-0
lines changed

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/BreakingChanges.txt‎

Whitespace-only changes.

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/CHANGELOG.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Release History
2+
3+
## 12.0.0-beta.1 (Unreleased)
4+
5+
### Features Added
6+
7+
### Breaking Changes
8+
9+
### Bugs Fixed

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/README.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Azure Storage Data Movement File Shares client library for .NET
2+
3+
> Server Version: 2020-04-08, 2020-02-10, 2019-12-12, 2019-07-07, and 2020-02-02
4+
5+
Azure Storage is a Microsoft-managed service providing cloud storage that is
6+
highly available, secure, durable, scalable, and redundant. Azure Storage
7+
includes Azure Blobs (objects), Azure Data Lake Storage Gen2, Azure Files,
8+
and Azure Queues.
9+
10+
The Azure Storage Data Movement library is optimized for uploading, downloading and
11+
copying customer data.
12+
13+
The Azure.Storage.DataMovement.Files.Shares library provides infrastructure shared by the other
14+
Azure Storage client libraries.
15+
16+
[Source code][source] | [Package (NuGet)][package] | [API reference documentation][docs] | [REST API documentation][rest_docs] | [Product documentation][product_docs]
17+
18+
## Getting started
19+
20+
### Install the package
21+
22+
Install the Azure Storage client library for .NET you'd like to use with
23+
[NuGet][nuget] and the `Azure.Storage.DataMovement.Files.Shares` client library will be included:
24+
25+
```dotnetcli
26+
dotnet add package Azure.Storage.DataMovement --prerelease
27+
dotnet add package Azure.Storage.DataMovement.Files.Shares --prerelease
28+
```
29+
30+
### Prerequisites
31+
32+
You need an [Azure subscription][azure_sub] and a
33+
[Storage Account][storage_account_docs] to use this package.
34+
35+
To create a new Storage Account, you can use the [Azure Portal][storage_account_create_portal],
36+
[Azure PowerShell][storage_account_create_ps], or the [Azure CLI][storage_account_create_cli].
37+
Here's an example using the Azure CLI:
38+
39+
```Powershell
40+
az storage account create --name MyStorageAccount --resource-group MyResourceGroup --location westus --sku Standard_LRS
41+
```
42+
43+
### Authenticate the client
44+
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).
45+
46+
## Key concepts
47+
48+
The Azure Storage Common client library contains shared infrastructure like
49+
[authentication credentials][auth_credentials] and [RequestFailedException][RequestFailedException].
50+
51+
### Thread safety
52+
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.
53+
54+
### Additional concepts
55+
<!-- CLIENT COMMON BAR -->
56+
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
57+
[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) |
58+
[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) |
59+
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
60+
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) |
61+
[Mocking](https://learn.microsoft.com/dotnet/azure/sdk/unit-testing-mocking) |
62+
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
63+
<!-- CLIENT COMMON BAR -->
64+
65+
## Examples
66+
67+
This section demonstrates usage of Data Movement for interacting with blob storage.
68+
69+
70+
### Initializing File Storage `StorageResource`
71+
72+
***TODO***
73+
74+
### Upload
75+
76+
***TODO***
77+
78+
### Download
79+
80+
***TODO***
81+
82+
### File Copy
83+
84+
***TODO***
85+
86+
## Troubleshooting
87+
88+
***TODO***
89+
90+
## Next steps
91+
92+
***TODO***
93+
94+
## Contributing
95+
96+
See the [Storage CONTRIBUTING.md][storage_contrib] for details on building,
97+
testing, and contributing to these libraries.
98+
99+
This project welcomes contributions and suggestions. Most contributions require
100+
you to agree to a Contributor License Agreement (CLA) declaring that you have
101+
the right to, and actually do, grant us the rights to use your contribution. For
102+
details, visit [cla.microsoft.com][cla].
103+
104+
This project has adopted the [Microsoft Open Source Code of Conduct][coc].
105+
For more information see the [Code of Conduct FAQ][coc_faq]
106+
or contact [[email protected]][coc_contact] with any
107+
additional questions or comments.
108+
109+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fstorage%2FAzure.Storage.Common%2FREADME.png)
110+
111+
<!-- LINKS -->
112+
[source]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.Common/src
113+
[package]: https://www.nuget.org/packages/Azure.Storage.Common/
114+
[docs]: https://docs.microsoft.com/dotnet/api/azure.storage
115+
[rest_docs]: https://docs.microsoft.com/rest/api/storageservices/
116+
[product_docs]: https://docs.microsoft.com/azure/storage/
117+
[nuget]: https://www.nuget.org/
118+
[storage_account_docs]: https://docs.microsoft.com/azure/storage/common/storage-account-overview
119+
[storage_account_create_ps]: https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-powershell
120+
[storage_account_create_cli]: https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-cli
121+
[storage_account_create_portal]: https://docs.microsoft.com/azure/storage/common/storage-quickstart-create-account?tabs=azure-portal
122+
[azure_cli]: https://docs.microsoft.com/cli/azure
123+
[azure_sub]: https://azure.microsoft.com/free/dotnet/
124+
[RequestFailedException]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/core/Azure.Core/src/RequestFailedException.cs
125+
[error_codes]: https://docs.microsoft.com/rest/api/storageservices/common-rest-api-error-codes
126+
[samples]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.DataMovement.Blobs/samples
127+
[storage_contrib]: https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/storage/CONTRIBUTING.md
128+
[cla]: https://cla.microsoft.com
129+
[coc]: https://opensource.microsoft.com/codeofconduct/
130+
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
131+
[coc_contact]: mailto:[email protected]

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/samples/Azure.Storage.DataMovement.Files.Shares.Samples.Tests.csproj‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<PropertyGroup>
3+
<TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
4+
<AssemblyTitle>Microsoft Azure.Storage.DataMovement.Files.Shares client library samples</AssemblyTitle>
5+
<IsPackable>false</IsPackable>
6+
</PropertyGroup>
7+
<ItemGroup>
8+
<Compile Include="$(AzureStorageSharedTestSources)\**\*.cs" LinkBase="Shared" />
9+
<Compile Remove="$(AzureStorageSharedTestSources)\AzuriteFixture.cs" />
10+
<Compile Remove="$(AzureStorageSharedTestSources)\AzuriteNUnitFixture.cs" />
11+
<Compile Remove="$(AzureStorageSharedTestSources)\StorageTestBase.SasVersion.cs" />
12+
<Compile Remove="$(AzureStorageSharedTestSources)\ClientSideEncryptionTestExtensions.cs" />
13+
<Compile Remove="$(AzureStorageSharedTestSources)\RepeatingStream.cs" />
14+
<Compile Remove="$(AzureStorageSharedTestSources)\TransferValidationTestBase.cs" />
15+
<Compile Remove="$(AzureStorageSharedTestSources)\Sas\*.cs" />
16+
<None Include="$(AzureStorageSharedTestSources)\*.xml">
17+
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
18+
</None>
19+
</ItemGroup>
20+
<ItemGroup>
21+
<Compile Include="$(AzureCoreSharedSources)ArrayBufferWriter.cs" LinkBase="Shared\Core" />
22+
<Compile Include="$(AzureCoreSharedSources)NoBodyResponseOfT.cs" LinkBase="Shared\Core" />
23+
<Compile Include="$(AzureCoreSharedSources)TaskExtensions.cs" LinkBase="Shared\Core" />
24+
</ItemGroup>
25+
<ItemGroup>
26+
<Compile Include="$(AzureStorageSharedSources)Constants.cs" LinkBase="Shared" />
27+
<Compile Include="$(AzureStorageSharedSources)Errors.cs" LinkBase="Shared" />
28+
<Compile Include="$(AzureStorageSharedSources)SasExtensions.cs" LinkBase="Shared" />
29+
<Compile Include="$(AzureStorageSharedSources)StorageConnectionString.cs" LinkBase="Shared" />
30+
<Compile Include="$(AzureStorageSharedSources)SharedAccessSignatureCredentials.cs" LinkBase="Shared" />
31+
<Compile Include="$(AzureStorageSharedSources)UriExtensions.cs" LinkBase="Shared" />
32+
<Compile Include="$(AzureStorageSharedSources)UriQueryParamsCollection.cs" LinkBase="Shared" />
33+
<Compile Include="$(AzureStorageSharedSources)StorageExceptionExtensions.cs" LinkBase="Shared" />
34+
</ItemGroup>
35+
</Project>

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/src/Azure.Storage.DataMovement.Files.Shares.csproj‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<PropertyGroup>
3+
<TargetFrameworks>$(RequiredTargetFrameworks);net6.0</TargetFrameworks>
4+
<IncludeGeneratorSharedCode>true</IncludeGeneratorSharedCode>
5+
</PropertyGroup>
6+
<PropertyGroup>
7+
<AssemblyTitle>Microsoft Azure.Storage.DataMovement.Blobs client library</AssemblyTitle>
8+
<Version>12.0.0-beta.1</Version>
9+
<DefineConstants>FileDataMovementSDK;$(DefineConstants)</DefineConstants>
10+
<PackageTags>Microsoft Azure Storage DataMovement, DataMovement, Microsoft, Azure, StorageScalable, azureofficial</PackageTags>
11+
<Description>
12+
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.
13+
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
14+
in addition to the breaking changes https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/storage/Azure.Storage.Blob.DataMovement/BreakingChanges.txt
15+
Microsoft Azure Storage quickstarts and tutorials - https://docs.microsoft.com/en-us/azure/storage/
16+
Microsoft Azure Storage REST API Reference - https://docs.microsoft.com/en-us/rest/api/storageservices/
17+
</Description>
18+
<IncludeOperationsSharedSource>true</IncludeOperationsSharedSource>
19+
<RootNamespace>Azure.Storage.DataMovement.Files.Shares</RootNamespace>
20+
<PackageId />
21+
</PropertyGroup>
22+
<ItemGroup>
23+
<!--<PackageReference Include="Azure.Storage.Files.Shares" />-->
24+
<ProjectReference Include="$(MSBuildThisFileDirectory)..\..\Azure.Storage.Files.Shares\src\Azure.Storage.Files.Shares.csproj" />
25+
<PackageReference Include="System.Threading.Channels" />
26+
</ItemGroup>
27+
<ItemGroup>
28+
<ProjectReference Include="$(MSBuildThisFileDirectory)..\..\Azure.Storage.DataMovement\src\Azure.Storage.DataMovement.csproj" />
29+
</ItemGroup>
30+
<ItemGroup>
31+
<Compile Include="$(AzureCoreSharedSources)CancellationHelper.cs" LinkBase="SharedCore" />
32+
<Compile Include="$(AzureCoreSharedSources)SyncAsyncEventHandlerExtensions.cs" LinkBase="Shared\Core" />
33+
</ItemGroup>
34+
<ItemGroup>
35+
<PackageReference Include="Azure.Core" />
36+
</ItemGroup>
37+
<ItemGroup>
38+
</ItemGroup>
39+
</Project>

‎sdk/storage/Azure.Storage.DataMovement.Files.Shares/tests/Azure.Storage.DataMovement.Files.Shares.Tests.csproj‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
<PropertyGroup>
3+
<TargetFrameworks>$(RequiredTargetFrameworks)</TargetFrameworks>
4+
<AssemblyTitle>Microsoft Azure.Storage.DataMovement.Files.Shareas client library tests</AssemblyTitle>
5+
<DefineConstants>BlobDataMovementSDK;$(DefineConstants)</DefineConstants>
6+
<IsPackable>false</IsPackable>
7+
</PropertyGroup>
8+
<ItemGroup>
9+
<ProjectReference Include="$(MSBuildThisFileDirectory)..\src\Azure.Storage.DataMovement.Files.Shares.csproj">
10+
<Aliases>DMBlobs</Aliases>
11+
</ProjectReference>
12+
<ProjectReference Include="$(MSBuildThisFileDirectory)..\..\Azure.Storage.DataMovement\src\Azure.Storage.DataMovement.csproj" />
13+
</ItemGroup>
14+
<ItemGroup>
15+
</ItemGroup>
16+
<ItemGroup>
17+
</ItemGroup>
18+
<ItemGroup>
19+
<None Include="$(AzureStorageSharedTestSources)\*.xml">
20+
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
21+
</None>
22+
<None Include="$(AzureStorageSharedTestSources)\azurite_cert.pem" CopyToOutputDirectory="PreserveNewest" />
23+
</ItemGroup>
24+
<ItemGroup>
25+
<Content Include="Resources\**">
26+
<CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
27+
</Content>
28+
</ItemGroup>
29+
</Project>

‎sdk/storage/Azure.Storage.sln‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,12 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Storage.DataMovement.
155155
EndProject
156156
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}"
157157
EndProject
158+
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}"
159+
EndProject
160+
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}"
161+
EndProject
162+
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}"
163+
EndProject
158164
Global
159165
GlobalSection(SolutionConfigurationPlatforms) = preSolution
160166
Debug|Any CPU = Debug|Any CPU
@@ -333,6 +339,18 @@ Global
333339
{0323A01E-E360-4D22-B1F4-15FD2DB39437}.Debug|Any CPU.Build.0 = Debug|Any CPU
334340
{0323A01E-E360-4D22-B1F4-15FD2DB39437}.Release|Any CPU.ActiveCfg = Release|Any CPU
335341
{0323A01E-E360-4D22-B1F4-15FD2DB39437}.Release|Any CPU.Build.0 = Release|Any CPU
342+
{D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
343+
{D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}.Debug|Any CPU.Build.0 = Debug|Any CPU
344+
{D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}.Release|Any CPU.ActiveCfg = Release|Any CPU
345+
{D3FFA4E3-4DDE-4496-9907-6CCCC315A8A2}.Release|Any CPU.Build.0 = Release|Any CPU
346+
{4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
347+
{4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}.Debug|Any CPU.Build.0 = Debug|Any CPU
348+
{4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}.Release|Any CPU.ActiveCfg = Release|Any CPU
349+
{4F45B7CD-8A15-4B95-8A57-B6E8A4DD8B02}.Release|Any CPU.Build.0 = Release|Any CPU
350+
{A564BB94-1867-4D43-98AB-F3C38E9AFA30}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
351+
{A564BB94-1867-4D43-98AB-F3C38E9AFA30}.Debug|Any CPU.Build.0 = Debug|Any CPU
352+
{A564BB94-1867-4D43-98AB-F3C38E9AFA30}.Release|Any CPU.ActiveCfg = Release|Any CPU
353+
{A564BB94-1867-4D43-98AB-F3C38E9AFA30}.Release|Any CPU.Build.0 = Release|Any CPU
336354
EndGlobalSection
337355
GlobalSection(SolutionProperties) = preSolution
338356
HideSolutionNode = FALSE

0 commit comments

Comments
 (0)