forked from Azure/azure-sdk-for-go
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 31871 in Azure/azure-rest-api-specs
Merge e374fad5ed22490dc710e28ca4219b55176e6862 into bf420af156ea90b4226e96582bdb4c9647491ae6
- Loading branch information
SDKAuto
committed
Dec 20, 2024
1 parent
ba0c64b
commit b078f15
Showing
23 changed files
with
2,595 additions
and
0 deletions.
There are no files selected for viewing
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,8 @@ | ||
# Release History | ||
|
||
## 0.1.0 (2024-12-20) | ||
### Other Changes | ||
|
||
The package of `github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/contoso/armcontoso` is using our [next generation design principles](https://azure.github.io/azure-sdk/general_introduction.html). | ||
|
||
To learn more, please refer to our documentation [Quick Start](https://aka.ms/azsdk/go/mgmt). |
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,21 @@ | ||
MIT License | ||
|
||
Copyright (c) Microsoft Corporation. All rights reserved. | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
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,90 @@ | ||
# Azure Contoso Module for Go | ||
|
||
The `armcontoso` module provides operations for working with Azure Contoso. | ||
|
||
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/contoso/armcontoso) | ||
|
||
# Getting started | ||
|
||
## Prerequisites | ||
|
||
- an [Azure subscription](https://azure.microsoft.com/free/) | ||
- Go 1.18 or above (You could download and install the latest version of Go from [here](https://go.dev/doc/install). It will replace the existing Go on your machine. If you want to install multiple Go versions on the same machine, you could refer this [doc](https://go.dev/doc/manage-install).) | ||
|
||
## Install the package | ||
|
||
This project uses [Go modules](https://github.com/golang/go/wiki/Modules) for versioning and dependency management. | ||
|
||
Install the Azure Contoso module: | ||
|
||
```sh | ||
go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/contoso/armcontoso | ||
``` | ||
|
||
## Authorization | ||
|
||
When creating a client, you will need to provide a credential for authenticating with Azure Contoso. The `azidentity` module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more. | ||
|
||
```go | ||
cred, err := azidentity.NewDefaultAzureCredential(nil) | ||
``` | ||
|
||
For more information on authentication, please see the documentation for `azidentity` at [pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity). | ||
|
||
## Client Factory | ||
|
||
Azure Contoso module consists of one or more clients. We provide a client factory which could be used to create any client in this module. | ||
|
||
```go | ||
clientFactory, err := armcontoso.NewClientFactory(<subscription ID>, cred, nil) | ||
``` | ||
|
||
You can use `ClientOptions` in package `github.com/Azure/azure-sdk-for-go/sdk/azcore/arm` to set endpoint to connect with public and sovereign clouds as well as Azure Stack. For more information, please see the documentation for `azcore` at [pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore). | ||
|
||
```go | ||
options := arm.ClientOptions { | ||
ClientOptions: azcore.ClientOptions { | ||
Cloud: cloud.AzureChina, | ||
}, | ||
} | ||
clientFactory, err := armcontoso.NewClientFactory(<subscription ID>, cred, &options) | ||
``` | ||
|
||
## Clients | ||
|
||
A client groups a set of related APIs, providing access to its functionality. Create one or more clients to access the APIs you require using client factory. | ||
|
||
```go | ||
client := clientFactory.NewEmployeesClient() | ||
``` | ||
|
||
## Fakes | ||
|
||
The fake package contains types used for constructing in-memory fake servers used in unit tests. | ||
This allows writing tests to cover various success/error conditions without the need for connecting to a live service. | ||
|
||
Please see https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/samples/fakes for details and examples on how to use fakes. | ||
|
||
## Provide Feedback | ||
|
||
If you encounter bugs or have suggestions, please | ||
[open an issue](https://github.com/Azure/azure-sdk-for-go/issues) and assign the `Contoso` label. | ||
|
||
# Contributing | ||
|
||
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 [https://cla.microsoft.com](https://cla.microsoft.com). | ||
|
||
When you submit a pull request, a CLA-bot will automatically determine whether | ||
you need to provide a CLA and decorate the PR appropriately (e.g., label, | ||
comment). Simply follow the instructions provided by the bot. You will only | ||
need to do this once across all repos using our CLA. | ||
|
||
This project has adopted the | ||
[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
For more information, see the | ||
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) | ||
or contact [[email protected]](mailto:[email protected]) with any | ||
additional questions or comments. |
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,28 @@ | ||
# NOTE: Please refer to https://aka.ms/azsdk/engsys/ci-yaml before editing this file. | ||
trigger: | ||
branches: | ||
include: | ||
- main | ||
- feature/* | ||
- hotfix/* | ||
- release/* | ||
paths: | ||
include: | ||
- sdk/resourcemanager/contoso/armcontoso/ | ||
|
||
pr: | ||
branches: | ||
include: | ||
- main | ||
- feature/* | ||
- hotfix/* | ||
- release/* | ||
paths: | ||
include: | ||
- sdk/resourcemanager/contoso/armcontoso/ | ||
|
||
extends: | ||
template: /eng/pipelines/templates/jobs/archetype-sdk-client.yml | ||
parameters: | ||
IncludeRelease: true | ||
ServiceDirectory: 'resourcemanager/contoso/armcontoso' |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.