Skip to content
This repository was archived by the owner on Feb 12, 2025. It is now read-only.

Commit 7d292c3

Browse files
authored
add notice about upcoming retirement (#699)
* add notice about upcoming retirement * remove locale-specific URLs
1 parent 4990699 commit 7d292c3

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# NOTE: The modules in this repo will go out of support by March 31, 2023. Additional information can be found [here](https://azure.microsoft.com/updates/support-for-azure-sdk-libraries-that-do-not-conform-to-our-current-azure-sdk-guidelines-will-be-retired-as-of-31-march-2023/).
2+
13
# go-autorest
24

35
[![GoDoc](https://godoc.org/github.com/Azure/go-autorest/autorest?status.png)](https://godoc.org/github.com/Azure/go-autorest/autorest)

autorest/adal/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# NOTE: This module will go out of support by March 31, 2023. For authenticating with Azure AD, use module [azidentity](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity) instead. For help migrating from `adal` to `azidentiy` please consult the [migration guide](https://aka.ms/azsdk/go/identity/migration). General information about the retirement of this and other legacy modules can be found [here](https://azure.microsoft.com/updates/support-for-azure-sdk-libraries-that-do-not-conform-to-our-current-azure-sdk-guidelines-will-be-retired-as-of-31-march-2023/).
2+
13
# Azure Active Directory authentication for Go
24

35
This is a standalone package for authenticating with Azure Active
@@ -18,7 +20,7 @@ go get -u github.com/Azure/go-autorest/autorest/adal
1820

1921
## Usage
2022

21-
An Active Directory application is required in order to use this library. An application can be registered in the [Azure Portal](https://portal.azure.com/) by following these [guidelines](https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-integrating-applications) or using the [Azure CLI](https://github.com/Azure/azure-cli).
23+
An Active Directory application is required in order to use this library. An application can be registered in the [Azure Portal](https://portal.azure.com/) by following these [guidelines](https://docs.microsoft.com/azure/active-directory/develop/active-directory-integrating-applications) or using the [Azure CLI](https://github.com/Azure/azure-cli).
2224

2325
### Register an Azure AD Application with secret
2426

@@ -88,7 +90,7 @@ An Active Directory application is required in order to use this library. An app
8890
### Grant the necessary permissions
8991

9092
Azure relies on a Role-Based Access Control (RBAC) model to manage the access to resources at a fine-grained
91-
level. There is a set of [pre-defined roles](https://docs.microsoft.com/en-us/azure/active-directory/role-based-access-built-in-roles)
93+
level. There is a set of [pre-defined roles](https://docs.microsoft.com/azure/active-directory/role-based-access-built-in-roles)
9294
which can be assigned to a service principal of an Azure AD application depending of your needs.
9395

9496
```
@@ -104,7 +106,7 @@ It is also possible to define custom role definitions.
104106
az role definition create --role-definition role-definition.json
105107
```
106108

107-
* Check [custom roles](https://docs.microsoft.com/en-us/azure/active-directory/role-based-access-control-custom-roles) for more details regarding the content of `role-definition.json` file.
109+
* Check [custom roles](https://docs.microsoft.com/azure/active-directory/role-based-access-control-custom-roles) for more details regarding the content of `role-definition.json` file.
108110

109111

110112
### Acquire Access Token

autorest/azure/auth/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# NOTE: This module will go out of support by March 31, 2023. For authenticating with Azure AD, use module [azidentity](https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/azidentity) instead. For help migrating from `auth` to `azidentiy` please consult the [migration guide](https://aka.ms/azsdk/go/identity/migration). General information about the retirement of this and other legacy modules can be found [here](https://azure.microsoft.com/updates/support-for-azure-sdk-libraries-that-do-not-conform-to-our-current-azure-sdk-guidelines-will-be-retired-as-of-31-march-2023/).
2+
13
## Authentication
24

35
Typical SDK operations must be authenticated and authorized. The `autorest.Authorizer`
@@ -52,7 +54,7 @@ below.
5254
> for more info. Copy the new principal's ID, secret, and tenant ID for use in
5355
> your app, or consider the `--sdk-auth` parameter for serialized output.
5456
55-
[azure managed service identity]: https://docs.microsoft.com/en-us/azure/active-directory/msi-overview
57+
[azure managed service identity]: https://docs.microsoft.com/azure/active-directory/msi-overview
5658

5759
- The `auth.NewAuthorizerFromEnvironment()` described above creates an authorizer
5860
from the first available of the following configuration:
@@ -81,7 +83,7 @@ below.
8183
4. **Azure Managed Service Identity**: Delegate credential management to the
8284
platform. Requires that code is running in Azure, e.g. on a VM. All
8385
configuration is handled by Azure. See [Azure Managed Service
84-
Identity](https://docs.microsoft.com/en-us/azure/active-directory/msi-overview)
86+
Identity](https://docs.microsoft.com/azure/active-directory/msi-overview)
8587
for more details.
8688

8789
- The `auth.NewAuthorizerFromFile()` method creates an authorizer using
@@ -114,7 +116,7 @@ below.
114116

115117
To use `NewAuthorizerFromCLI()` or `NewAuthorizerFromCLIWithResource()`, follow these steps:
116118

117-
1. Install [Azure CLI v2.0.12](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) or later. Upgrade earlier versions.
119+
1. Install [Azure CLI v2.0.12](https://docs.microsoft.com/cli/azure/install-azure-cli) or later. Upgrade earlier versions.
118120
2. Use `az login` to sign in to Azure.
119121

120122
If you receive an error, use `az account get-access-token` to verify access.

0 commit comments

Comments
 (0)