Skip to content

Commit 661d394

Browse files
author
SDKAuto
committed
CodeGen from PR 22229 in Azure/azure-rest-api-specs
Update Cadl sample project (Azure#22229) * Update Cadl sample project - Move sample project under specification folder - remove project.json file from individual project - Add global project.json file under specifications folder
1 parent 6fb0cd6 commit 661d394

25 files changed

+621
-0
lines changed

‎sdk/contosowidgetmanager/Azure.Template.Contoso/Azure.Template.Contoso.sln‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
2+
Microsoft Visual Studio Solution File, Format Version 12.00
3+
# Visual Studio Version 16
4+
VisualStudioVersion = 16.0.29709.97
5+
MinimumVisualStudioVersion = 10.0.40219.1
6+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.TestFramework", "..\..\core\Azure.Core.TestFramework\src\Azure.Core.TestFramework.csproj", "{ECC730C1-4AEA-420C-916A-66B19B79E4DC}"
7+
EndProject
8+
Project("{7AC3020F-2AA5-43D9-8684-37547EEAE288}") = "Azure.Template.Contoso.Perf", "perf\Azure.Template.Contoso.Perf.csproj", "{30C5FF85-655A-49FC-A324-16438130FF3F}"
9+
EndProject
10+
Project("{7AC3020F-2AA5-43D9-8684-37547EEAE288}") = "Azure.Template.Contoso.Stress", "stress\Azure.Template.Contoso.Stress.csproj", "{47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}"
11+
EndProject
12+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Template.Contoso", "src\Azure.Template.Contoso.csproj", "{F6C2B637-D0E9-45D3-895C-90D6CD04934B}"
13+
EndProject
14+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Template.Contoso.Tests", "tests\Azure.Template.Contoso.Tests.csproj", "{7709135E-FAF2-4EDC-A4E7-B514F30F7AE7}"
15+
EndProject
16+
Global
17+
GlobalSection(SolutionConfigurationPlatforms) = preSolution
18+
Debug|Any CPU = Debug|Any CPU
19+
Release|Any CPU = Release|Any CPU
20+
EndGlobalSection
21+
GlobalSection(ProjectConfigurationPlatforms) = postSolution
22+
{B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
23+
{B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.Build.0 = Debug|Any CPU
24+
{B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.ActiveCfg = Release|Any CPU
25+
{B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.Build.0 = Release|Any CPU
26+
{8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
27+
{8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.Build.0 = Debug|Any CPU
28+
{8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.ActiveCfg = Release|Any CPU
29+
{8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.Build.0 = Release|Any CPU
30+
{ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
31+
{ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.Build.0 = Debug|Any CPU
32+
{ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.ActiveCfg = Release|Any CPU
33+
{ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.Build.0 = Release|Any CPU
34+
{A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
35+
{A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.Build.0 = Debug|Any CPU
36+
{A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.ActiveCfg = Release|Any CPU
37+
{A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.Build.0 = Release|Any CPU
38+
{FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
39+
{FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.Build.0 = Debug|Any CPU
40+
{FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.ActiveCfg = Release|Any CPU
41+
{FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.Build.0 = Release|Any CPU
42+
{85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
43+
{85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Debug|Any CPU.Build.0 = Debug|Any CPU
44+
{85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Release|Any CPU.ActiveCfg = Release|Any CPU
45+
{85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Release|Any CPU.Build.0 = Release|Any CPU
46+
{30C5FF85-655A-49FC-A324-16438130FF3F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
47+
{30C5FF85-655A-49FC-A324-16438130FF3F}.Debug|Any CPU.Build.0 = Debug|Any CPU
48+
{30C5FF85-655A-49FC-A324-16438130FF3F}.Release|Any CPU.ActiveCfg = Release|Any CPU
49+
{30C5FF85-655A-49FC-A324-16438130FF3F}.Release|Any CPU.Build.0 = Release|Any CPU
50+
{47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
51+
{47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}.Debug|Any CPU.Build.0 = Debug|Any CPU
52+
{47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}.Release|Any CPU.ActiveCfg = Release|Any CPU
53+
{47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}.Release|Any CPU.Build.0 = Release|Any CPU
54+
{F6C2B637-D0E9-45D3-895C-90D6CD04934B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
55+
{F6C2B637-D0E9-45D3-895C-90D6CD04934B}.Debug|Any CPU.Build.0 = Debug|Any CPU
56+
{F6C2B637-D0E9-45D3-895C-90D6CD04934B}.Release|Any CPU.ActiveCfg = Release|Any CPU
57+
{F6C2B637-D0E9-45D3-895C-90D6CD04934B}.Release|Any CPU.Build.0 = Release|Any CPU
58+
{7709135E-FAF2-4EDC-A4E7-B514F30F7AE7}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
59+
{7709135E-FAF2-4EDC-A4E7-B514F30F7AE7}.Debug|Any CPU.Build.0 = Debug|Any CPU
60+
{7709135E-FAF2-4EDC-A4E7-B514F30F7AE7}.Release|Any CPU.ActiveCfg = Release|Any CPU
61+
{7709135E-FAF2-4EDC-A4E7-B514F30F7AE7}.Release|Any CPU.Build.0 = Release|Any CPU
62+
EndGlobalSection
63+
GlobalSection(SolutionProperties) = preSolution
64+
HideSolutionNode = FALSE
65+
EndGlobalSection
66+
GlobalSection(ExtensibilityGlobals) = postSolution
67+
SolutionGuid = {A97F4B90-2591-4689-B1F8-5F21FE6D6CAE}
68+
EndGlobalSection
69+
EndGlobal

‎sdk/contosowidgetmanager/Azure.Template.Contoso/CHANGELOG.md‎

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

‎sdk/contosowidgetmanager/Azure.Template.Contoso/Directory.Build.props‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
2+
<!--
3+
Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
4+
-->
5+
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
6+
</Project>

‎sdk/contosowidgetmanager/Azure.Template.Contoso/README.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Azure Contoso client library for .NET
2+
3+
This section should give out brief introduction of the client library.
4+
5+
* First sentence: **Describe the service** briefly. You can usually use the first line of the service's docs landing page for this (Example: [Cosmos DB docs landing page](https://docs.microsoft.com/azure/cosmos-db/)).
6+
* Next, add a **bulleted list** of the **most common tasks** supported by the package or library, prefaced with "Use the client library for [Product Name] to:". Then, provide code snippets for these tasks in the [Examples](#examples) section later in the document. Keep the task list short but include those tasks most developers need to perform with your package.
7+
8+
[Source code](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/contosowidgetmanager/Azure.Template.Contoso/src) | [Package (NuGet)](https://www.nuget.org/packages/Azure.Template.Contoso) | [API reference documentation](https://azure.github.io/azure-sdk-for-net) | [Product documentation](https://docs.microsoft.com/azure)
9+
10+
## Getting started
11+
12+
This section should include everything a developer needs to do to install and create their first client connection *very quickly*.
13+
14+
### Install the package
15+
16+
First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `dotnet add package package-name`, but should enable a developer to successfully install the package from NuGet, npm, or even cloning a GitHub repository.
17+
18+
Install the client library for .NET with [NuGet](https://www.nuget.org/ ):
19+
20+
```dotnetcli
21+
dotnet add package Azure.Template.Contoso --prerelease
22+
```
23+
24+
### Prerequisites
25+
26+
Include a section after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB:
27+
28+
> You must have an [Azure subscription](https://azure.microsoft.com/free/dotnet/) and [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API). In order to take advantage of the C# 8.0 syntax, it is recommended that you compile using the [.NET Core SDK](https://dotnet.microsoft.com/download) 3.0 or higher with a [language version](https://docs.microsoft.com/dotnet/csharp/language-reference/configure-language-version#override-a-default) of `latest`. It is also possible to compile with the .NET Core SDK 2.1.x using a language version of `preview`.
29+
30+
### Authenticate the client
31+
32+
If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating.
33+
34+
For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object.
35+
36+
## Key concepts
37+
38+
The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity.
39+
40+
Include the *Thread safety* and *Additional concepts* sections below at the end of your *Key concepts* section. You may remove or add links depending on what your library makes use of:
41+
42+
### Thread safety
43+
44+
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.
45+
46+
### Additional concepts
47+
<!-- CLIENT COMMON BAR -->
48+
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
49+
[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) |
50+
[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) |
51+
[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) |
52+
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) |
53+
[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#mocking) |
54+
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
55+
<!-- CLIENT COMMON BAR -->
56+
57+
## Examples
58+
59+
You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/contosowidgetmanager/Azure.Template.Contoso/samples).
60+
61+
### <scenario>
62+
63+
You can create a client and call the client's `<operation>` method.
64+
65+
```C# Snippet:Azure_Template_Contoso_Scenario
66+
Console.WriteLine("Hello, world!");
67+
```
68+
69+
## Troubleshooting
70+
71+
Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery.
72+
73+
Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API.
74+
75+
If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code.
76+
77+
## Next steps
78+
79+
* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory.
80+
* If appropriate, point users to other packages that might be useful.
81+
* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for.
82+
83+
## Contributing
84+
85+
This is a template, but your SDK readme should include details on how to contribute code to the repo/package.
86+
87+
<!-- LINKS -->
88+
[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization
89+
[style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide
90+
91+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net/sdk/contosowidgetmanager/Azure.Template.Contoso/README.png)

‎sdk/contosowidgetmanager/Azure.Template.Contoso/api/Azure.Template.Contoso.netstandard2.0.cs‎

Whitespace-only changes.

‎sdk/contosowidgetmanager/Azure.Template.Contoso/perf/Azure.Template.Contoso.Perf.csproj‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<OutputType>Exe</OutputType>
5+
</PropertyGroup>
6+
7+
<ItemGroup>
8+
<ProjectReference Include="..\src\Azure.Template.Contoso.csproj" />
9+
<ProjectReference Include="..\..\..\..\common\Perf\Azure.Test.Perf\Azure.Test.Perf.csproj" />
10+
</ItemGroup>
11+
12+
<ItemGroup>
13+
<PackageReference Include="Azure.Identity" />
14+
</ItemGroup>
15+
16+
</Project>

‎sdk/contosowidgetmanager/Azure.Template.Contoso/perf/ContosoClientTest.cs‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using System;
5+
using System.Threading;
6+
using System.Threading.Tasks;
7+
using Azure.Identity;
8+
using Azure.Test.Perf;
9+
using CommandLine;
10+
11+
namespace Azure.Template.Contoso.Perf
12+
{
13+
public class ContosoClientTest : PerfTest<ContosoClientTest.ContosoClientPerfOptions>
14+
{
15+
/* please refer to https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template/perf/TemplateClientTest.cs to write perf test. */
16+
17+
public ContosoClientTest(ContosoClientPerfOptions options) : base(options)
18+
{
19+
}
20+
public class ContosoClientPerfOptions : PerfOptions
21+
{
22+
}
23+
24+
public override void Run(CancellationToken cancellationToken)
25+
{
26+
}
27+
28+
public override async Task RunAsync(CancellationToken cancellationToken)
29+
{
30+
await Task.Run(() =>
31+
{
32+
Console.WriteLine("exec some async operation");
33+
});
34+
}
35+
}
36+
}

‎sdk/contosowidgetmanager/Azure.Template.Contoso/perf/Program.cs‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// Copyright (c) Microsoft Corporation. All rights reserved.
2+
// Licensed under the MIT License.
3+
4+
using System.Reflection;
5+
using Azure.Test.Perf;
6+
7+
await PerfProgram.Main(Assembly.GetEntryAssembly(), args);

‎sdk/contosowidgetmanager/Azure.Template.Contoso/samples/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
page_type: sample
3+
languages:
4+
- csharp
5+
products:
6+
# Including relevant stubs from https://review.docs.microsoft.com/help/contribute/metadata-taxonomies#product
7+
- azure
8+
name: Azure.Template.Contoso samples for .NET
9+
description: Samples for the Azure.Template.Contoso client library.
10+
---
11+
12+
# Azure.Template.Contoso Samples
13+
14+
<!-- please refer to <https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template/samples/README.md> to write sample readme. -->

‎sdk/contosowidgetmanager/Azure.Template.Contoso/samples/Sample1_HelloWorld.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# <scenario_list>
2+
3+
To use these samples, you'll first need to set up resources. See [getting started](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/contosowidgetmanager/Azure.Template.Contoso/README.md#getting-started) for details.
4+
5+
## <scenario>
6+
7+
You can create a client and call the client's `<operation>` method
8+
9+
<!-- please refer to <https://github.com/Azure/azure-sdk-for-net/main/sdk/template/Azure.Template/samples/Sample1_HelloWorld.md> to write sample readme file. -->
10+
```C# Snippet:Azure_Template_Contoso_Scenario
11+
Console.WriteLine("Hello, world!");
12+
```

0 commit comments

Comments
 (0)