Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions sdk/resourcemanager/elasticsan/armelasticsan/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Release History

## 0.1.0 (2022-10-21)

The package of `github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elasticsan/armelasticsan` 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).
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
# Azure Elasticsans Module for Go
# Azure Elasticsan Module for Go

[![PkgGoDev](https://pkg.go.dev/badge/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elasticsans/armelasticsans)](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elasticsans/armelasticsans)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elasticsan/armelasticsan)](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elasticsan/armelasticsan)

The `armelasticsans` module provides operations for working with Azure Elasticsans.
The `armelasticsan` module provides operations for working with Azure Elasticsan.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/elasticsans/armelasticsans)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resourcemanager/elasticsan/armelasticsan)

# Getting started

## Prerequisites

- an [Azure subscription](https://azure.microsoft.com/free/)
- Go 1.19 or above
- 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 Elasticsans module:
Install the Azure Elasticsan module:

```sh
go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elasticsans/armelasticsans
go get github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/elasticsan/armelasticsan
```

## Authorization

When creating a client, you will need to provide a credential for authenticating with Azure Elasticsans. The `azidentity` module provides facilities for various ways of authenticating with Azure including client/secret, certificate, managed identity, and more.
When creating a client, you will need to provide a credential for authenticating with Azure Elasticsan. 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)
Expand All @@ -35,10 +35,10 @@ For more information on authentication, please see the documentation for `aziden

## Clients

Azure Elasticsans modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.
Azure Elasticsan modules consist of one or more clients. A client groups a set of related APIs, providing access to its functionality within the specified subscription. Create one or more clients to access the APIs you require using your credential.

```go
client, err := armelasticsans.NewSKUsClient(<subscription ID>, cred, nil)
client, err := armelasticsan.NewVolumesClient(<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).
Expand All @@ -49,13 +49,13 @@ options := arm.ClientOptions{
Cloud: cloud.AzureChina,
},
}
client, err := armelasticsans.NewSKUsClient(<subscription ID>, cred, &options)
client, err := armelasticsan.NewVolumesClient(<subscription ID>, cred, &options)
```

## 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 `Elasticsans` label.
[open an issue](https://github.com/Azure/azure-sdk-for-go/issues) and assign the `Elasticsan` label.

# Contributing

Expand Down
13 changes: 13 additions & 0 deletions sdk/resourcemanager/elasticsan/armelasticsan/autorest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### AutoRest Configuration

> see https://aka.ms/autorest

``` yaml
azure-arm: true
require:
- https://github.com/Azure/azure-rest-api-specs/blob/e1da7cbab8d4f554484dedb676ba7bdbdf6cdf78/specification/elasticsan/resource-manager/readme.md
- https://github.com/Azure/azure-rest-api-specs/blob/e1da7cbab8d4f554484dedb676ba7bdbdf6cdf78/specification/elasticsan/resource-manager/readme.go.md
license-header: MICROSOFT_MIT_NO_VERSION
module-version: 0.1.0

```
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
// Licensed under the MIT License. See License.txt in the project root for license information.

// This file enables 'go generate' to regenerate this specific SDK
//go:generate pwsh ../../../../eng/scripts/build.ps1 -skipBuild -cleanGenerated -format -tidy -generate -alwaysSetBodyParamRequired -removeUnreferencedTypes resourcemanager/elasticsans/armelasticsans
//go:generate pwsh ../../../../eng/scripts/build.ps1 -skipBuild -cleanGenerated -format -tidy -generate -alwaysSetBodyParamRequired -removeUnreferencedTypes resourcemanager/elasticsan/armelasticsan

package armelasticsans
package armelasticsan
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ trigger:
- release/*
paths:
include:
- sdk/resourcemanager/elasticsans/armelasticsans/
- sdk/resourcemanager/elasticsan/armelasticsan/

pr:
branches:
Expand All @@ -19,10 +19,10 @@ pr:
- release/*
paths:
include:
- sdk/resourcemanager/elasticsans/armelasticsans/
- sdk/resourcemanager/elasticsan/armelasticsan/

stages:
- template: /eng/pipelines/templates/jobs/archetype-sdk-client.yml
parameters:
IncludeRelease: true
ServiceDirectory: 'resourcemanager/elasticsans/armelasticsans'
ServiceDirectory: 'resourcemanager/elasticsan/armelasticsan'

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading