Skip to content

Commit 0547834

Browse files
Azure Quantum client for Azure SDK for .NET (Azure#18177)
* Add .gitignore * Initial commit of auto-generated client * Regenerate Azure Quantum client w/ Track2 template * matusthemostlygreat - adding my changes back in * matusthemostlygreat - client compiles again * matusthemostlygreat - client builds again * matusthemostlygreat - trying to get it to compile * matusthemostlygreat - pulled in the core nugget * matusthemostlygreat - compiles now * matusthemostlygreat - maybe closer to compiling * matusthemostlygreat - rename Azure.Template -> Azure.Quantum.Jobs * matusthemostlygreat - fix some QuantumJobsClient.cs * matusthemostlygreat - expose methods * matusthemostlygreat - comments * matusthemostlygreat - fixed some stuff * matusthemostlygreat - fixed a bunch of warnings and errors * matusthemostlygreat - adding client * matusthemostlygreat - restructured composition and naming * matusthemostlygreat - quota * matusthemostlygreat - delete old code * matusthemostlygreat - integrated georges changes * matusthemostlygreat - can now get jobs successfully * matusthemostlygreat - checking in console app * matusthemostlygreat - MiniSecretClient -> QuantumJobsClient, and packaging * matusthemostlygreat - tests compile * matusthemostlygreat - trying to record tests * matusthemostlygreat - regen swagger * matusthemostlygreat - fix instrumentation * matusthemostlygreat - generated recorded test data * matusthemostlygreat - QuantumJobClient * matusthemostlygreat - fixed xml comment errors * matusthemostlygreat - renamed to QuantumJobQuota * matusthemostlygreat - implemented pageable and fixed all errors * matusthemostlygreat - sanitized * matusthemostlygreat - trying to revert * matusthemostlygreat - revert * matusthemostlygreat - pr fixes * matusthemostlygreat - values * matusthemostlygreat - more pr * matusthemostlygreat - basic verify and more pr feedback * matusthemostlygreat - exposed other methods * matusthemostlygreat - more pr changes * matusthemostlygreat - more pr feedback * arm template * matusthemostlygreat - removed consoleapp and subscriptionid * matusthemostlygreat - more deletes * add outputs * matusthemostlygreat - use test vars * matusthemostlygreat - removed incomplete projs and regened apis * matusthemostlygreat - more fixes * Update sdk/quantum/Azure.Quantum.Jobs/README.md Co-authored-by: tg-msft <tg-msft@users.noreply.github.com> * Update sdk/quantum/Azure.Quantum.Jobs/README.md Co-authored-by: tg-msft <tg-msft@users.noreply.github.com> * matusthemostlygreat - more pr updates * matusthemostlygreat - restored deleted template folder * Fixing the ci.yaml * Fixing test.yaml * Fixing broken link * Trying to add missing variables to the recorded tests * Trying to add missing variables to recorded test * Temporarily removing the code snippets * matusthemostlygreat - fixed vars * matusthemostlygreat - TestEnvironment.Credential * matusthemostlygreat - fix vars * matusthemostlygreat - missed json vars and ressurected outputs * Trying a simple C# snippet * Updating snippet name * Trying a C# snippet that compiles * Adding a sample for the snippet * Remove trailing whitespaces * Rename C# snippet * Update exported api Co-authored-by: Victor XField Co-authored-by: George Moussa Co-authored-by: XField
1 parent af5c730 commit 0547834

File tree

63 files changed

+10839
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+10839
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
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.Quantum.Jobs", "src\Azure.Quantum.Jobs.csproj", "{E33D09D9-D809-472C-82E6-6A26BDB86FC2}"
7+
EndProject
8+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Quantum.Jobs.Tests", "tests\Azure.Quantum.Jobs.Tests.csproj", "{4F476D56-DDE7-43D3-8CB4-BA1E77F5A300}"
9+
EndProject
10+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.TestFramework", "..\..\core\Azure.Core.TestFramework\src\Azure.Core.TestFramework.csproj", "{8052009B-2126-44A3-88CD-4F3B17894C64}"
11+
EndProject
12+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Test.Stress", "..\..\..\common\Stress\Azure.Test.Stress\Azure.Test.Stress.csproj", "{0B991CA1-E570-4292-BABF-E011D9613C7B}"
13+
EndProject
14+
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Test.Perf", "..\..\..\common\Perf\Azure.Test.Perf\Azure.Test.Perf.csproj", "{0ED9C8A0-9A19-4750-8DD3-61D086288283}"
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+
{E33D09D9-D809-472C-82E6-6A26BDB86FC2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
23+
{E33D09D9-D809-472C-82E6-6A26BDB86FC2}.Debug|Any CPU.Build.0 = Debug|Any CPU
24+
{E33D09D9-D809-472C-82E6-6A26BDB86FC2}.Release|Any CPU.ActiveCfg = Release|Any CPU
25+
{E33D09D9-D809-472C-82E6-6A26BDB86FC2}.Release|Any CPU.Build.0 = Release|Any CPU
26+
{4F476D56-DDE7-43D3-8CB4-BA1E77F5A300}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
27+
{4F476D56-DDE7-43D3-8CB4-BA1E77F5A300}.Debug|Any CPU.Build.0 = Debug|Any CPU
28+
{4F476D56-DDE7-43D3-8CB4-BA1E77F5A300}.Release|Any CPU.ActiveCfg = Release|Any CPU
29+
{4F476D56-DDE7-43D3-8CB4-BA1E77F5A300}.Release|Any CPU.Build.0 = Release|Any CPU
30+
{8052009B-2126-44A3-88CD-4F3B17894C64}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
31+
{8052009B-2126-44A3-88CD-4F3B17894C64}.Debug|Any CPU.Build.0 = Debug|Any CPU
32+
{8052009B-2126-44A3-88CD-4F3B17894C64}.Release|Any CPU.ActiveCfg = Release|Any CPU
33+
{8052009B-2126-44A3-88CD-4F3B17894C64}.Release|Any CPU.Build.0 = Release|Any CPU
34+
{0B991CA1-E570-4292-BABF-E011D9613C7B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
35+
{0B991CA1-E570-4292-BABF-E011D9613C7B}.Debug|Any CPU.Build.0 = Debug|Any CPU
36+
{0B991CA1-E570-4292-BABF-E011D9613C7B}.Release|Any CPU.ActiveCfg = Release|Any CPU
37+
{0B991CA1-E570-4292-BABF-E011D9613C7B}.Release|Any CPU.Build.0 = Release|Any CPU
38+
{0ED9C8A0-9A19-4750-8DD3-61D086288283}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
39+
{0ED9C8A0-9A19-4750-8DD3-61D086288283}.Debug|Any CPU.Build.0 = Debug|Any CPU
40+
{0ED9C8A0-9A19-4750-8DD3-61D086288283}.Release|Any CPU.ActiveCfg = Release|Any CPU
41+
{0ED9C8A0-9A19-4750-8DD3-61D086288283}.Release|Any CPU.Build.0 = Release|Any CPU
42+
EndGlobalSection
43+
GlobalSection(SolutionProperties) = preSolution
44+
HideSolutionNode = FALSE
45+
EndGlobalSection
46+
GlobalSection(ExtensibilityGlobals) = postSolution
47+
SolutionGuid = {A97F4B90-2591-4689-B1F8-5F21FE6D6CAE}
48+
EndGlobalSection
49+
EndGlobal
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Release History
2+
## 1.0.0-beta.1 (Unreleased)
3+
### Added
4+
- Initial preview of Azure.Quantum.Jobs
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>
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Azure Quantum Jobs client library for .NET
2+
3+
Use the guidelines in each section of this template to ensure consistency and readability of your README. The README resides in your package's GitHub repository at the root of its directory within the repo. It's also used as the package distribution page (NuGet, PyPi, npm, etc.) and as a Quickstart on docs.microsoft.com. See [Azure.Quantum.Jobs/README.md](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/template/Azure.Template/README.md) for an example following this template.
4+
5+
**Title**: The H1 of your README should be in the format: `# [Product Name] client library for [Language]`
6+
7+
* All headings, including the H1, should use **sentence-style capitalization**. Refer to the [Microsoft Style Guide][style-guide-msft] and [Microsoft Cloud Style Guide][style-guide-cloud] for more information.
8+
* Example: `# Azure Batch client library for Python`
9+
10+
# Azure Template client library for .NET
11+
12+
**Introduction**: The introduction appears directly under the title (H1) of your README.
13+
14+
* **DO NOT** use an "Introduction" or "Overview" heading (H2) for this section.
15+
* 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/)).
16+
* 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.
17+
* Include this single line of links targeting your product's content at the bottom of the introduction, making any adjustments as necessary (for example, NuGet instead of PyPi):
18+
19+
[Source code](https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/batch/azure-batch) | [Package (PyPi)](https://pypi.org/project/azure-batch/) | [API reference documentation](https://docs.microsoft.com/python/api/overview/azure/batch?view=azure-python) | [Product documentation](https://docs.microsoft.com/azure/batch/)
20+
21+
> TIP: Your README should be as **brief** as possible but **no more brief** than necessary to get a developer new to Azure, the service, or the package up and running quickly. Keep it brief, but include everything a developer needs to make their first API call successfully.
22+
23+
## Getting started
24+
25+
This section should include everything a developer needs to do to install and create their first client connection *very quickly*.
26+
27+
### Install the package
28+
29+
First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `pip install package-name`, but should enable a developer to successfully install the package from NuGet, pip, npm, Maven, or even cloning a GitHub repository.
30+
31+
### Prerequisites
32+
33+
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:
34+
35+
> You must have an [Azure subscription](https://azure.microsoft.com/free/), [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API), and [Python 3.6+](https://www.python.org/downloads/) to use this package.
36+
37+
### Authenticate the client
38+
39+
If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating.
40+
41+
For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object.
42+
43+
## Key concepts
44+
45+
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.
46+
47+
## Examples
48+
49+
Include code snippets and short descriptions for each task you listed in the [Introduction](#introduction) (the bulleted list). Briefly explain each operation, but include enough clarity to explain complex or otherwise tricky operations.
50+
51+
If possible, use the same example snippets that your in-code documentation uses. For example, use the snippets in your `examples.py` that Sphinx ingests via its [literalinclude](https://www.sphinx-doc.org/en/1.5/markup/code.html?highlight=code%20examples#includes) directive. The `examples.py` file containing the snippets should reside alongside your package's code, and should be tested in an automated fashion.
52+
53+
Each example in the *Examples* section starts with an H3 that describes the example. At the top of this section, just under the *Examples* H2, add a bulleted list linking to each example H3. Each example should deep-link to the types and/or members used in the example.
54+
55+
### Get the thing
56+
57+
The `get_thing` method retrieves a Thing from the service. The `id` parameter is the unique ID of the Thing, not its "name" property.
58+
59+
```C# Snippet:Azure_Quantum_Jobs_GetJobs
60+
var client = new QuantumJobClient("subscriptionId", "resourceGroupName", "workspaceName", "location");
61+
var jobs = client.GetJobs();
62+
```
63+
64+
## Troubleshooting
65+
66+
Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery.
67+
68+
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.
69+
70+
If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code.
71+
72+
## Next steps
73+
74+
* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory.
75+
* If appropriate, point users to other packages that might be useful.
76+
* 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.
77+
78+
## Contributing
79+
80+
This is a template, but your SDK readme should include details on how to contribute code to the repo/package.
81+
82+
<!-- LINKS -->
83+
[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization
84+
[style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide
85+
86+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net%2Fsdk%2Fquantum%2FAzure.Quantum.Jobs%2FREADME.png)

0 commit comments

Comments
 (0)