Skip to content

Update master to main #14909

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
weshaggard merged 1 commit into from
Jun 24, 2021
Merged

Update master to main #14909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ Please verify the following before submitting your PR, thank you!
- [ ] Tests are included and/or updated for code changes.
- [ ] Updates to [CHANGELOG.md][] are included.
- [ ] MIT license headers are included in each file.

[Azure/autorest.go]: https://github.com/Azure/autorest.go
[CHANGELOG.md]: https://github.com/Azure/azure-sdk-for-go/blob/master/CHANGELOG.md
[CHANGELOG.md]: https://github.com/Azure/azure-sdk-for-go/blob/main/CHANGELOG.md
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

| Package Path | Changelog |
| :--- | :---: |
| `github.com/Azure/azure-sdk-for-go/services/preview/security/mgmt/v3.0/security` | [details](https://github.com/Azure/azure-sdk-for-go/tree/master/services/preview/security/mgmt/v3.0/security/CHANGELOG.md) |
| `github.com/Azure/azure-sdk-for-go/services/preview/security/mgmt/v3.0/security` | [details](https://github.com/Azure/azure-sdk-for-go/tree/main/services/preview/security/mgmt/v3.0/security/CHANGELOG.md) |

## `v55.2.0`

Expand Down
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Azure SDK for Go

[![godoc](https://godoc.org/github.com/Azure/azure-sdk-for-go?status.svg)](https://godoc.org/github.com/Azure/azure-sdk-for-go)
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/go/Azure.azure-sdk-for-go?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=640&branchName=master)
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/go/Azure.azure-sdk-for-go?branchName=main)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=640&branchName=main)

azure-sdk-for-go provides Go packages for managing and using Azure services.
It officially supports the last two major releases of Go. Older versions of
Expand Down Expand Up @@ -93,7 +93,7 @@ section](#authentication).
`res, err := c.CreateOrUpdate(...)`.
4. Handle responses and errors.

[services_dir]: https://github.com/Azure/azure-sdk-for-go/tree/master/services
[services_dir]: https://github.com/Azure/azure-sdk-for-go/tree/main/services

For example, to create a new virtual network (substitute your own values for
strings in angle brackets):
Expand Down Expand Up @@ -245,16 +245,16 @@ below.

- The `auth.NewAuthorizerFromCLI()` method creates an authorizer which
uses [Azure CLI][] to obtain its credentials.

The default audience being requested is `https://management.azure.com` (Azure ARM API).
To specify your own audience, export `AZURE_AD_RESOURCE` as an evironment variable.
This is read by `auth.NewAuthorizerFromCLI()` and passed to Azure CLI to acquire the access token.

For example, to request an access token for Azure Key Vault, export
```
AZURE_AD_RESOURCE="https://vault.azure.net"
```

- `auth.NewAuthorizerFromCLIWithResource(AUDIENCE_URL_OR_APPLICATION_ID)` - this method is self contained and does
not require exporting environment variables. For example, to request an access token for Azure Key Vault:
```
Expand All @@ -269,7 +269,7 @@ below.
If you receive an error, use `az account get-access-token` to verify access.

If Azure CLI is not installed to the default directory, you may receive an error
reporting that `az` cannot be found.
reporting that `az` cannot be found.
Use the `AzureCLIPath` environment variable to define the Azure CLI installation folder.

If you are signed in to Azure CLI using multiple accounts or your account has
Expand Down Expand Up @@ -590,6 +590,6 @@ Security issues and bugs should be reported privately, via email, to the Microso

## Contribute

See [CONTRIBUTING.md](https://github.com/Azure/azure-sdk-for-go/blob/master/CONTRIBUTING.md).
See [CONTRIBUTING.md](https://github.com/Azure/azure-sdk-for-go/blob/main/CONTRIBUTING.md).

[samples_repo]: https://github.com/Azure-Samples/azure-sdk-for-go-samples
2 changes: 1 addition & 1 deletion documentation/code-generation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ generator –r –v –l=temp –version=v11.2.0-beta C:/azure-rest-api-specs/sp

## Generate Azure SDK for Go profiles

Take a look into the [profile generator documentation](https://github.com/Azure/azure-sdk-for-go/tree/master/tools/profileBuilder)
Take a look into the [profile generator documentation](https://github.com/Azure/azure-sdk-for-go/tree/main/tools/profileBuilder)
2 changes: 1 addition & 1 deletion sdk/agfood/armagfood/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `armagfood` module provides operations for working with Azure agfood.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/agfood/armagfood)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/agfood/armagfood)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/armcore/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![PkgGoDev](https://pkg.go.dev/badge/github.com/Azure/azure-sdk-for-go/sdk/armcore)](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/armcore)
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/go/go%20-%20armcore%20-%20ci?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1844&branchName=master)
[![Code Coverage](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1844/master)](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1844/master)
[![Code Coverage](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1844/master)](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1844/main)

The `armcore` module provides functions and types for Go SDK ARM client modules.
These modules follow the [Azure SDK Design Guidelines for Go](https://azure.github.io/azure-sdk/golang_introduction.html).
Expand Down
2 changes: 1 addition & 1 deletion sdk/authorization/armauthorization/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `armauthorization` module provides operations for working with Azure Authorization.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/authorization/armauthorization)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/authorization/armauthorization)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/azcore/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![PkgGoDev](https://pkg.go.dev/badge/github.com/Azure/azure-sdk-for-go/sdk/azcore)](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azcore)
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/go/go%20-%20azcore%20-%20ci?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1843&branchName=master)
[![Code Coverage](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1843/master)](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1843/master)
[![Code Coverage](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1843/master)](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1843/main)

The `azcore` module provides a set of common interfaces and types for Go SDK client modules.
These modules follow the [Azure SDK Design Guidelines for Go](https://azure.github.io/azure-sdk/golang_introduction.html).
Expand Down
18 changes: 9 additions & 9 deletions sdk/azidentity/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@

[![PkgGoDev](https://pkg.go.dev/badge/github.com/Azure/azure-sdk-for-go/sdk/azidentity)](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity)
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/go/go%20-%20azidentity?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1846&branchName=master)
[![Code Coverage](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1846/master)](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1846/master)
[![Code Coverage](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1846/master)](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1846/main)

The `azidentity` module provides a set of credential types for use with
Azure SDK clients that support Azure Active Directory (AAD) token authentication.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/azidentity)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/azidentity)
| [Azure Active Directory documentation](https://docs.microsoft.com/azure/active-directory/)

# Getting started
Expand Down Expand Up @@ -67,7 +67,7 @@ The `DefaultAzureCredential` is appropriate for most scenarios where the applica
> Note: `DefaultAzureCredential` is intended to simplify getting started with the SDK by handling common scenarios with reasonable default behaviors. Developers who want more control or whose scenario isn't served by the default settings should use other credential types.

The `DefaultAzureCredential` will attempt to authenticate via the following mechanisms in order.

![DefaultAzureCredential authentication flow](img/DAC_flow.PNG)

- Environment - The `DefaultAzureCredential` will read account information specified via [environment variables](#environment-variables) and use it to authenticate.
Expand All @@ -76,10 +76,10 @@ The `DefaultAzureCredential` is appropriate for most scenarios where the applica


## Examples
You can find more examples of using various credentials in [Azure Identity Examples Wiki page](https://github.com/Azure/azure-sdk-for-go/wiki/Azure-Identity-Examples).
You can find more examples of using various credentials in [Azure Identity Examples Wiki page](https://github.com/Azure/azure-sdk-for-go/wiki/Azure-Identity-Examples).

### Authenticating with `DefaultAzureCredential`
This example demonstrates authenticating the `ResourcesClient` from the [armresources][armresources_library] module using `DefaultAzureCredential`.
This example demonstrates authenticating the `ResourcesClient` from the [armresources][armresources_library] module using `DefaultAzureCredential`.

```go
// The default credential checks environment variables for configuration.
Expand Down Expand Up @@ -183,7 +183,7 @@ client := armresources.NewResourcesClient(armcore.NewDefaultConnection(cred, nil

## Environment Variables

DefaultAzureCredential] and
DefaultAzureCredential] and
EnvironmentCredential can be configured with
environment variables. Each type of authentication requires values for specific
variables:
Expand Down Expand Up @@ -242,7 +242,7 @@ To obtain more detailed logging, including request/response bodies and header va
azcore.Log().SetListener(func(cls LogClassification, s string) {
fmt.Println(s) // printing log out to the console
})

// Include only azidentity credential logs
azcore.Log().SetClassifications(azidentity.LogCredential)
```
Expand Down Expand Up @@ -279,7 +279,7 @@ or contact [[email protected]](mailto:[email protected]) with any
additional questions or comments.

[azure_cli]: https://docs.microsoft.com/cli/azure
[armresources_library]: https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/resources/armresources
[azblob]: https://github.com/Azure/azure-sdk-for-go/tree/master/sdk
[armresources_library]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resources/armresources
[azblob]: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-go%2Fsdk%2Fidentity%2Fazure-identity%2FREADME.png)
2 changes: 1 addition & 1 deletion sdk/compute/armcompute/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `armcompute` module provides operations for working with Azure compute.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/compute/armcompute)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/compute/armcompute)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/keyvault/armkeyvault/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `armkeyvault` module provides operations for working with Azure Keyvault resources.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/keyvault/armkeyvault)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/keyvault/armkeyvault)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/network/armnetwork/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `armnetwork` module provides operations for working with Azure Network resources.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/network/armnetwork)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/network/armnetwork)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/privatedns/armprivatedns/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `armprivatedns` module provides operations for working with Azure agfood.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/privatedns/armprivatedns)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/privatedns/armprivatedns)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/resources/armresources/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `armresources` module provides operations for working with Azure resources and resource groups.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/resources/armresources)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/resources/armresources)

# Getting Started

Expand Down
4 changes: 2 additions & 2 deletions sdk/samples/azidentity/SDKV1Adapter/example_SDKV1_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ func ExampleNewDefaultAzureCredential() {
// ExampleNewClientSecretCredential for using the ClientSecretCredential with the NewAzureIdentityCredentialAdapter and assigning the credential to the
// SDK V1 authorizer.
// NewAzureIdentityCredentialAdapter can take any credential type defined in azidentity and convert it to an authorizer that is compatible with the Azure SDK for Go
// V1 implementation. For a list of the credentials that azidentity includes, please see: https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/azidentity.
// V1 implementation. For a list of the credentials that azidentity includes, please see: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/azidentity.
// NewClientSecretCredential can be used in place of auth.NewClientCredentialsConfig().
func ExampleNewClientSecretCredential() {
groupsClient := resources.NewGroupsClient(subscriptionID)
Expand Down Expand Up @@ -110,7 +110,7 @@ func ExampleNewClientSecretCredential() {
// ExampleNewEnvironmentCredential for using the EnvironmentCredential with the NewAzureIdentityCredentialAdapter and assigning the credential to the
// SDK V1 authorizer.
// NewAzureIdentityCredentialAdapter can take any credential type defined in azidentity and convert it to an authorizer that is compatible with the Azure SDK for Go
// V1 implementation. For a list of the credentials that azidentity includes, please see: https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/azidentity.
// V1 implementation. For a list of the credentials that azidentity includes, please see: https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/azidentity.
// NewEnvironmentCredential can be used in place of auth.NewAuthorizerFromEnvironment(). An important distinction is that NewEnvironmentCredential does not include Managed
// Identity credential, for a credential that also checks the environment for Managed Identity credential use the NewDefaultAzureCredentialAdapter. Alternatively,
// create a custom credential chain with NewChainedTokenCredential and add all desired token credentials to try into the chain.
Expand Down
2 changes: 1 addition & 1 deletion sdk/storage/armstorage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `armstorage` module provides operations for working with Azure storage resources.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/storage/armstorage)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/storage/armstorage)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/synapse/azartifacts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

The `azartifacts` module provides operations for working with Azure synapse.

[Source code](https://github.com/Azure/azure-sdk-for-go/tree/master/sdk/synapse/azartifacts)
[Source code](https://github.com/Azure/azure-sdk-for-go/tree/main/sdk/synapse/azartifacts)

# Getting started

Expand Down
2 changes: 1 addition & 1 deletion sdk/to/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![PkgGoDev](https://pkg.go.dev/badge/github.com/Azure/azure-sdk-for-go/sdk/to)](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/to)
[![Build Status](https://dev.azure.com/azure-sdk/public/_apis/build/status/go/go%20-%20to%20-%20ci?branchName=master)](https://dev.azure.com/azure-sdk/public/_build/latest?definitionId=1845&branchName=master)
[![Code Coverage](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1845/master)](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1845/master)
[![Code Coverage](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1845/master)](https://img.shields.io/azure-devops/coverage/azure-sdk/public/1845/main)

The `to` module contains various helper type-conversion functions.
These modules follow the [Azure SDK Design Guidelines for Go](https://azure.github.io/azure-sdk/golang_introduction.html).
Expand Down
4 changes: 2 additions & 2 deletions services/classic/management/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Azure Service Management packages for Go

The `github.com/Azure/azure-sdk-for-go/services/classic/management` packages are used to perform operations using the Azure Service Management (ASM), aka classic deployment model. Read more about [Azure Resource Manager vs. classic deployment](https://azure.microsoft.com/documentation/articles/resource-manager-deployment-model/). Packages for Azure Resource Manager are in the [services](https://github.com/Azure/azure-sdk-for-go/tree/master/services) folder.
The `github.com/Azure/azure-sdk-for-go/services/classic/management` packages are used to perform operations using the Azure Service Management (ASM), aka classic deployment model. Read more about [Azure Resource Manager vs. classic deployment](https://azure.microsoft.com/documentation/articles/resource-manager-deployment-model/). Packages for Azure Resource Manager are in the [services](https://github.com/Azure/azure-sdk-for-go/tree/main/services) folder.
Note that this package requires Go 1.7+ to build.
This package is in mainteinance mode and will only receive bug fixes. It is recommended to [migrate to Azure Resource Manager](https://docs.microsoft.com/azure/azure-resource-manager/resource-manager-deployment-model) deployment model.

## First a Sidenote: Authentication and the Azure Service Manager

The client currently supports authentication to the Service Management
API with certificates or Azure `.publishSettings` file. You can
API with certificates or Azure `.publishSettings` file. You can
download the `.publishSettings` file for your subscriptions
[here](https://manage.windowsazure.com/publishsettings).
2 changes: 1 addition & 1 deletion storage/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The `github.com/Azure/azure-sdk-for-go/storage` package is used to manage
resources: containers, blobs, tables, and queues.

To manage storage *accounts* use Azure Resource Manager (ARM) via the packages
at [github.com/Azure/azure-sdk-for-go/services/storage](https://github.com/Azure/azure-sdk-for-go/tree/master/services/storage).
at [github.com/Azure/azure-sdk-for-go/services/storage](https://github.com/Azure/azure-sdk-for-go/tree/main/services/storage).

This package also supports the [Azure Storage
Emulator](https://azure.microsoft.com/documentation/articles/storage-use-emulator/)
Expand Down