diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/Azure.Template.Contoso.sln b/sdk/contosowidgetmanager/Azure.Template.Contoso/Azure.Template.Contoso.sln new file mode 100644 index 000000000000..97d2158f0f3f --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/Azure.Template.Contoso.sln @@ -0,0 +1,69 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.29709.97 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.TestFramework", "..\..\core\Azure.Core.TestFramework\src\Azure.Core.TestFramework.csproj", "{ECC730C1-4AEA-420C-916A-66B19B79E4DC}" +EndProject +Project("{39F89386-8234-473F-B359-C425A238659C}") = "Azure.Template.Contoso.Perf", "perf\Azure.Template.Contoso.Perf.csproj", "{30C5FF85-655A-49FC-A324-16438130FF3F}" +EndProject +Project("{39F89386-8234-473F-B359-C425A238659C}") = "Azure.Template.Contoso.Stress", "stress\Azure.Template.Contoso.Stress.csproj", "{47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Template.Contoso", "src\Azure.Template.Contoso.csproj", "{8329CCFD-9104-4499-BF84-8B0BD221D8C5}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Template.Contoso.Tests", "tests\Azure.Template.Contoso.Tests.csproj", "{BB9D3688-0B71-410C-8D3B-1D8CD63A1B5A}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.Build.0 = Release|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.Build.0 = Release|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.Build.0 = Release|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.ActiveCfg = Release|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.Build.0 = Release|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.Build.0 = Release|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Release|Any CPU.Build.0 = Release|Any CPU + {30C5FF85-655A-49FC-A324-16438130FF3F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {30C5FF85-655A-49FC-A324-16438130FF3F}.Debug|Any CPU.Build.0 = Debug|Any CPU + {30C5FF85-655A-49FC-A324-16438130FF3F}.Release|Any CPU.ActiveCfg = Release|Any CPU + {30C5FF85-655A-49FC-A324-16438130FF3F}.Release|Any CPU.Build.0 = Release|Any CPU + {47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}.Debug|Any CPU.Build.0 = Debug|Any CPU + {47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}.Release|Any CPU.ActiveCfg = Release|Any CPU + {47E3BC66-5C4F-47CD-A37B-A973E54BCBA9}.Release|Any CPU.Build.0 = Release|Any CPU + {8329CCFD-9104-4499-BF84-8B0BD221D8C5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8329CCFD-9104-4499-BF84-8B0BD221D8C5}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8329CCFD-9104-4499-BF84-8B0BD221D8C5}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8329CCFD-9104-4499-BF84-8B0BD221D8C5}.Release|Any CPU.Build.0 = Release|Any CPU + {BB9D3688-0B71-410C-8D3B-1D8CD63A1B5A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {BB9D3688-0B71-410C-8D3B-1D8CD63A1B5A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {BB9D3688-0B71-410C-8D3B-1D8CD63A1B5A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {BB9D3688-0B71-410C-8D3B-1D8CD63A1B5A}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {A97F4B90-2591-4689-B1F8-5F21FE6D6CAE} + EndGlobalSection +EndGlobal diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/CHANGELOG.md b/sdk/contosowidgetmanager/Azure.Template.Contoso/CHANGELOG.md new file mode 100644 index 000000000000..13dd08af78ab --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/CHANGELOG.md @@ -0,0 +1,11 @@ +# Release History + +## 1.0.0-beta.1 (Unreleased) + +### Features Added + +### Breaking Changes + +### Bugs Fixed + +### Other Changes diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/Directory.Build.props b/sdk/contosowidgetmanager/Azure.Template.Contoso/Directory.Build.props new file mode 100644 index 000000000000..1a9611bd4924 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/Directory.Build.props @@ -0,0 +1,6 @@ + + + + diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/README.md b/sdk/contosowidgetmanager/Azure.Template.Contoso/README.md new file mode 100644 index 000000000000..ac3943c62886 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/README.md @@ -0,0 +1,90 @@ +# Azure Contoso client library for .NET + +This section should give out brief introduction of the client library. + +* 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/)). +* 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. + + [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) + +## Getting started + +This section should include everything a developer needs to do to install and create their first client connection *very quickly*. + +### Install the package + +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. + +Install the client library for .NET with [NuGet](https://www.nuget.org/ ): + +```dotnetcli +dotnet add package Azure.Template.Contoso --prerelease +``` + +### Prerequisites + +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: + +> 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`. + +### Authenticate the client + +If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. + +For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. + +## Key concepts + +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. + +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: + +### 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://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#mocking) | +[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) + + +## Examples + +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). + +### + +You can create a client and call the client's `` method. + +```C# Snippet:Azure_Template_Contoso_Scenario +``` + +## Troubleshooting + +Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. + +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. + +If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. + +## Next steps + +* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. +* If appropriate, point users to other packages that might be useful. +* 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. + +## Contributing + +This is a template, but your SDK readme should include details on how to contribute code to the repo/package. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net/sdk/contosowidgetmanager/Azure.Template.Contoso/README.png) \ No newline at end of file diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/api/Azure.Template.Contoso.netstandard2.0.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/api/Azure.Template.Contoso.netstandard2.0.cs new file mode 100644 index 000000000000..faa552d274d2 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/api/Azure.Template.Contoso.netstandard2.0.cs @@ -0,0 +1,17 @@ +namespace Azure.Template.Contoso +{ + public partial class ContosoClient + { + protected ContosoClient() { } + public ContosoClient(string endpoint, Azure.Core.TokenCredential credential, Azure.Template.Contoso.ContosoClientOptions options = null) { } + public virtual Azure.Core.Pipeline.HttpPipeline Pipeline { get { throw null; } } + } + public partial class ContosoClientOptions : Azure.Core.ClientOptions + { + public ContosoClientOptions(Azure.Template.Contoso.Generated.ContosoClientOptions.ServiceVersion version = Azure.Template.Contoso.Generated.ContosoClientOptions.ServiceVersion.V1_0_0) { } + public enum ServiceVersion + { + V1_0_0 = 1, + } + } +} \ No newline at end of file diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/Azure.Template.Contoso.Perf.csproj b/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/Azure.Template.Contoso.Perf.csproj new file mode 100644 index 000000000000..c426a97ed2e6 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/Azure.Template.Contoso.Perf.csproj @@ -0,0 +1,16 @@ + + + + Exe + + + + + + + + + + + + diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/ContosoClientTest.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/ContosoClientTest.cs new file mode 100644 index 000000000000..87ac198882ad --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/ContosoClientTest.cs @@ -0,0 +1,36 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Threading; +using System.Threading.Tasks; +using Azure.Identity; +using Azure.Test.Perf; +using CommandLine; + +namespace Azure.Template.Contoso.Perf +{ + public class ContosoClientTest : PerfTest + { + /* please refer to https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template/perf/TemplateClientTest.cs to write perf test. */ + + public ContosoClientTest(ContosoClientPerfOptions options) : base(options) + { + } + public class ContosoClientPerfOptions : PerfOptions + { + } + + public override void Run(CancellationToken cancellationToken) + { + } + + public override async Task RunAsync(CancellationToken cancellationToken) + { + await Task.Run(() => + { + Console.WriteLine("exec some async operation"); + }); + } + } +} diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/Program.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/Program.cs new file mode 100644 index 000000000000..78a52ddce190 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/perf/Program.cs @@ -0,0 +1,7 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.Reflection; +using Azure.Test.Perf; + + await PerfProgram.Main(Assembly.GetEntryAssembly(), args); diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/README.md b/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/README.md new file mode 100644 index 000000000000..75932dda1e70 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/README.md @@ -0,0 +1,14 @@ +--- +page_type: sample +languages: +- csharp +products: +# Including relevant stubs from https://review.docs.microsoft.com/help/contribute/metadata-taxonomies#product +- azure +name: Azure.Template.Contoso samples for .NET +description: Samples for the Azure.Template.Contoso client library. +--- + +# Azure.Template.Contoso Samples + + diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/Sample1_HelloWorld.md b/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/Sample1_HelloWorld.md new file mode 100644 index 000000000000..4f4ed39a60d6 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/Sample1_HelloWorld.md @@ -0,0 +1,15 @@ +# + +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. + +## + +You can create a client and call the client's `` method + +```C# Snippet:Azure_Template_Contoso_Scenario +``` + +To see the full example source files, see: +* [HelloWorld](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/Sample1_HelloWorld.cs)) + + \ No newline at end of file diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/Sample1_HelloWorldAsync.md b/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/Sample1_HelloWorldAsync.md new file mode 100644 index 000000000000..0d84234adc36 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/samples/Sample1_HelloWorldAsync.md @@ -0,0 +1,15 @@ +# + +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. + +## asynchronously + +You can create a client and call the client's `` method + +```C# Snippet:Azure_Template_Contoso_ScenarioAsync +``` + +To see the full example source files, see: +* [HelloWorld](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/Sample1_HelloWorldAsync.cs)) + + \ No newline at end of file diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/src/Azure.Template.Contoso.csproj b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/Azure.Template.Contoso.csproj new file mode 100644 index 000000000000..62a0e8439709 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/Azure.Template.Contoso.csproj @@ -0,0 +1,22 @@ + + + This is the Contoso client library for developing .NET applications with rich experience. + Azure SDK Code Generation Contoso for Azure Data Plane + 1.0.0-beta.1 + Azure Contoso + $(RequiredTargetFrameworks) + true + + + + + + + + + + + + + + diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/src/Generated/Docs/ContosoClient.xml b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/Generated/Docs/ContosoClient.xml new file mode 100644 index 000000000000..ae3e1711e609 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/Generated/Docs/ContosoClient.xml @@ -0,0 +1,81 @@ + + + + + +This sample shows how to call GetSecretAsync with required parameters and parse the result. +", credential); + +Response response = await client.GetSecretAsync(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contentType").ToString()); +Console.WriteLine(result.GetProperty("tags").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("kid").ToString()); +Console.WriteLine(result.GetProperty("managed").ToString()); +]]> + + +The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission. + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for SecretBundle: +{ + value: string, # Optional. The secret value. + id: string, # Optional. The secret id. + contentType: string, # Optional. The content type of the secret. + tags: Dictionary<string, string>, # Optional. Application specific metadata in the form of key-value pairs. + kid: string, # Optional. If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. + managed: boolean, # Optional. True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. +} + + + + + + +This sample shows how to call GetSecret with required parameters and parse the result. +", credential); + +Response response = client.GetSecret(""); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value").ToString()); +Console.WriteLine(result.GetProperty("id").ToString()); +Console.WriteLine(result.GetProperty("contentType").ToString()); +Console.WriteLine(result.GetProperty("tags").GetProperty("").ToString()); +Console.WriteLine(result.GetProperty("kid").ToString()); +Console.WriteLine(result.GetProperty("managed").ToString()); +]]> + + +The GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission. + +Below is the JSON schema for the response payload. + +Response Body: + +Schema for SecretBundle: +{ + value: string, # Optional. The secret value. + id: string, # Optional. The secret id. + contentType: string, # Optional. The content type of the secret. + tags: Dictionary<string, string>, # Optional. Application specific metadata in the form of key-value pairs. + kid: string, # Optional. If this is a secret backing a KV certificate, then this field specifies the corresponding key backing the KV certificate. + managed: boolean, # Optional. True if the secret's lifetime is managed by key vault. If this is a secret backing a certificate, then managed will be true. +} + + + + + + \ No newline at end of file diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/src/GlobalSuppressions.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/GlobalSuppressions.cs new file mode 100644 index 000000000000..9b3803f9838c --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/GlobalSuppressions.cs @@ -0,0 +1,6 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.Diagnostics.CodeAnalysis; + +[assembly: SuppressMessage("Usage", "AZC0002:DO ensure all service methods, both asynchronous and synchronous, take an optional CancellationToken parameter called cancellationToken.", Justification = "CancellationToken can be passed through RequestOptions")] \ No newline at end of file diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/src/cadl-location.yaml b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/cadl-location.yaml new file mode 100644 index 000000000000..f388cf86b204 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/cadl-location.yaml @@ -0,0 +1,3 @@ +directory: documentation/cadl-sample-project/specification/contosowidgetmanager/Contoso.WidgetManager +spec-root-dir: /mnt/vss/_work/1/s/azure-rest-api-specs + diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/src/properties/AssemblyInfo.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/properties/AssemblyInfo.cs new file mode 100644 index 000000000000..3e4a0606e53f --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/src/properties/AssemblyInfo.cs @@ -0,0 +1,13 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.Runtime.CompilerServices; + +// Replace with test project/test project public key and uncomment to make internal members visible to +// your test project. If not needed, this can be deleted. +// [assembly: InternalsVisibleTo("Azure.Template.Contoso.Generated.Tests, PublicKey=0024000004800000940000000602000000240000525341310004000001000100d15ddcb29688295338af4b7686603fe614abd555e09efba8fb88ee09e1f7b1ccaeed2e8f823fa9eef3fdd60217fc012ea67d2479751a0b8c087a4185541b851bd8b16f8d91b840e51b1cb0ba6fe647997e57429265e85ef62d565db50a69ae1647d54d7bd855e4db3d8a91510e5bcbd0edfbbecaa20a7bd9ae74593daa7b11b4")] + +// Replace Microsoft.Test with the correct resource provider namepace for your service and uncomment. +// See https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-services-resource-providers +// for the list of possible values. +[assembly: Azure.Core.AzureResourceProviderNamespace("Microsoft.Contosowidgetmanager")] diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/Azure.Template.Contoso.Stress.csproj b/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/Azure.Template.Contoso.Stress.csproj new file mode 100644 index 000000000000..3f23765433a4 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/Azure.Template.Contoso.Stress.csproj @@ -0,0 +1,16 @@ + + + + Exe + + + + + + + + + + + + diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/ContosoClientTest.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/ContosoClientTest.cs new file mode 100644 index 000000000000..cc6b0111e2dc --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/ContosoClientTest.cs @@ -0,0 +1,36 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Threading; +using System.Threading.Tasks; +using Azure.Identity; +using Azure.Test.Stress; +using CommandLine; + +namespace Azure.Template.Contoso.Stress +{ + public class ContosoClientTest : StressTest + { + public ContosoClientTest(ContosoClientStressOptions options, ContosoClientStressMetrics metrics) : base(options, metrics) + { + } + + /* please refer to https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template/stress/TemplateClientTest.cs to write stress tests. */ + + public override async Task RunAsync(CancellationToken cancellationToken) + { + await Task.Run(() => + { + Console.WriteLine("exec some async operation"); + }); + } + public class ContosoClientStressMetrics : StressMetrics + { + } + + public class ContosoClientStressOptions : StressOptions + { + } + } +} diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/Program.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/Program.cs new file mode 100644 index 000000000000..d25a1b56e291 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/stress/Program.cs @@ -0,0 +1,7 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.Reflection; +using Azure.Test.Stress; + +await StressProgram.Main(Assembly.GetEntryAssembly(), args); diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Azure.Template.Contoso.Tests.csproj b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Azure.Template.Contoso.Tests.csproj new file mode 100644 index 000000000000..0e77d4db13b1 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Azure.Template.Contoso.Tests.csproj @@ -0,0 +1,25 @@ + + + $(RequiredTargetFrameworks) + + + $(NoWarn);CS1591 + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/ContosoClientTest.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/ContosoClientTest.cs new file mode 100644 index 000000000000..b5d83d30e1ed --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/ContosoClientTest.cs @@ -0,0 +1,42 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.IO; +using System.Net.Http; +using System.Text.Json; +using System.Threading.Tasks; +using Azure.Core.Pipeline; +using Azure.Core.TestFramework; +using NUnit.Framework; + +namespace Azure.Template.Contoso.Tests +{ + public class ContosoClientTest: RecordedTestBase + { + public ContosoClientTest(bool isAsync) : base(isAsync) + { + } + + /* please refer to https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template/tests/TemplateClientLiveTests.cs to write tests. */ + + [RecordedTest] + public void TestOperation() + { + Assert.IsTrue(true); + } + + #region Helpers + + private static BinaryData GetContentFromResponse(Response r) + { + // Workaround azure/azure-sdk-for-net#21048, which prevents .Content from working when dealing with responses + // from the playback system. + + MemoryStream ms = new MemoryStream(); + r.ContentStream.CopyTo(ms); + return new BinaryData(ms.ToArray()); + } + #endregion + } +} diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/ContosoClientTestEnvironment.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/ContosoClientTestEnvironment.cs new file mode 100644 index 000000000000..1b2d8c91a624 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/ContosoClientTestEnvironment.cs @@ -0,0 +1,14 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using Azure.Core.TestFramework; + +namespace Azure.Template.Contoso.Tests +{ + public class ContosoClientTestEnvironment : TestEnvironment + { + public string Endpoint => GetRecordedVariable("Contoso_ENDPOINT"); + + // Add other client paramters here as above. + } +} diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/README.md b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/README.md new file mode 100644 index 000000000000..d223fe8abcae --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/README.md @@ -0,0 +1,3 @@ +Source files in this directory are written as tests from which samples are extracted. +They are not intended to be viewed directly and help ensure our samples compile and work correctly. +See our [list of samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/contosowidgetmanager/Azure.Template.Contoso/samples) for more explanation about how to use this client library. diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/Sample1_HelloWorld.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/Sample1_HelloWorld.cs new file mode 100644 index 000000000000..06ba0cb5f444 --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/Sample1_HelloWorld.cs @@ -0,0 +1,21 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Linq; +using System.Text.Json; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Core.TestFramework; +using NUnit.Framework; + +namespace Azure.Template.Contoso.Tests.Samples +{ + public partial class ContosoSamples: SamplesBase + { + /* please refer to https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template/tests/Samples/Sample1.HelloWorld.cs to write samples. */ + #region Snippet:Azure_Template_Contoso_Scenario + + #endregion + } +} diff --git a/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/Sample1_HelloWorldAsync.cs b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/Sample1_HelloWorldAsync.cs new file mode 100644 index 000000000000..bfb216cfd2dd --- /dev/null +++ b/sdk/contosowidgetmanager/Azure.Template.Contoso/tests/Samples/Sample1_HelloWorldAsync.cs @@ -0,0 +1,21 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System; +using System.Linq; +using System.Text.Json; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Core.TestFramework; +using NUnit.Framework; + +namespace Azure.Template.Contoso.Tests.Samples +{ + public partial class ContosoSamples: SamplesBase + { + /* please refer to https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/template/Azure.Template/tests/Samples/Sample1.HelloWorldAsync.cs to write samples. */ + #region Snippet:Azure_Template_Contoso_ScenarioAsync + + #endregion + } +} diff --git a/sdk/contosowidgetmanager/ci.yml b/sdk/contosowidgetmanager/ci.yml new file mode 100644 index 000000000000..f5df8deaf0a7 --- /dev/null +++ b/sdk/contosowidgetmanager/ci.yml @@ -0,0 +1,31 @@ +# NOTE: Please refer to https://aka.ms/azsdk/engsys/ci-yaml before editing this file. + +trigger: + branches: + include: + - main + - hotfix/* + - release/* + paths: + include: + - sdk/contosowidgetmanager/ + +pr: + branches: + include: + - main + - feature/* + - hotfix/* + - release/* + paths: + include: + - sdk/contosowidgetmanager/ + +extends: + template: /eng/pipelines/templates/stages/archetype-sdk-client.yml + parameters: + ServiceDirectory: contosowidgetmanager + ArtifactName: packages + Artifacts: + - name: Azure.Template.Contoso + safeName: AzureTemplateContoso