From 7d292c3e1ef48ddb17139e6b1e88af02a55117b1 Mon Sep 17 00:00:00 2001 From: Joel Hendrix Date: Thu, 19 May 2022 15:06:09 -0700 Subject: [PATCH] add notice about upcoming retirement (#699) * add notice about upcoming retirement * remove locale-specific URLs --- README.md | 2 ++ autorest/adal/README.md | 8 +++++--- autorest/azure/auth/README.md | 8 +++++--- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index de1e19a44..cb3485829 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +# 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/). + # go-autorest [![GoDoc](https://godoc.org/github.com/Azure/go-autorest/autorest?status.png)](https://godoc.org/github.com/Azure/go-autorest/autorest) diff --git a/autorest/adal/README.md b/autorest/adal/README.md index fec416a9c..b11eb0788 100644 --- a/autorest/adal/README.md +++ b/autorest/adal/README.md @@ -1,3 +1,5 @@ +# 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/). + # Azure Active Directory authentication for Go This is a standalone package for authenticating with Azure Active @@ -18,7 +20,7 @@ go get -u github.com/Azure/go-autorest/autorest/adal ## Usage -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). +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). ### Register an Azure AD Application with secret @@ -88,7 +90,7 @@ An Active Directory application is required in order to use this library. An app ### Grant the necessary permissions Azure relies on a Role-Based Access Control (RBAC) model to manage the access to resources at a fine-grained -level. There is a set of [pre-defined roles](https://docs.microsoft.com/en-us/azure/active-directory/role-based-access-built-in-roles) +level. There is a set of [pre-defined roles](https://docs.microsoft.com/azure/active-directory/role-based-access-built-in-roles) which can be assigned to a service principal of an Azure AD application depending of your needs. ``` @@ -104,7 +106,7 @@ It is also possible to define custom role definitions. az role definition create --role-definition role-definition.json ``` -* 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. +* 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. ### Acquire Access Token diff --git a/autorest/azure/auth/README.md b/autorest/azure/auth/README.md index 72408d800..05bef8a80 100644 --- a/autorest/azure/auth/README.md +++ b/autorest/azure/auth/README.md @@ -1,3 +1,5 @@ +# 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/). + ## Authentication Typical SDK operations must be authenticated and authorized. The `autorest.Authorizer` @@ -52,7 +54,7 @@ below. > for more info. Copy the new principal's ID, secret, and tenant ID for use in > your app, or consider the `--sdk-auth` parameter for serialized output. -[azure managed service identity]: https://docs.microsoft.com/en-us/azure/active-directory/msi-overview +[azure managed service identity]: https://docs.microsoft.com/azure/active-directory/msi-overview - The `auth.NewAuthorizerFromEnvironment()` described above creates an authorizer from the first available of the following configuration: @@ -81,7 +83,7 @@ below. 4. **Azure Managed Service Identity**: Delegate credential management to the platform. Requires that code is running in Azure, e.g. on a VM. All configuration is handled by Azure. See [Azure Managed Service - Identity](https://docs.microsoft.com/en-us/azure/active-directory/msi-overview) + Identity](https://docs.microsoft.com/azure/active-directory/msi-overview) for more details. - The `auth.NewAuthorizerFromFile()` method creates an authorizer using @@ -114,7 +116,7 @@ below. To use `NewAuthorizerFromCLI()` or `NewAuthorizerFromCLIWithResource()`, follow these steps: - 1. Install [Azure CLI v2.0.12](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli) or later. Upgrade earlier versions. + 1. Install [Azure CLI v2.0.12](https://docs.microsoft.com/cli/azure/install-azure-cli) or later. Upgrade earlier versions. 2. Use `az login` to sign in to Azure. If you receive an error, use `az account get-access-token` to verify access.