@azure/identity 1.0.0-preview.1 → 1.0.0-preview.2

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## 1.0.0-preview.2 - 2019-08-05
+
+- Introduced the following credential types:
+  - [`DeviceCodeCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/devicecodecredential.html)
+  - [`InteractiveBrowserCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/interactivebrowsercredential.html)
+  - [`UsernamePasswordCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/usernamepasswordcredential.html)
+- This library can now be used in the browser!  The following credential types supported in browser builds:
+  - `ClientSecretCredential`
+  - `UsernamePasswordCredential`
+  - `InteractiveBrowserCredential`
+
+## 1.0.0-preview.1 - 2019-06-27
+
+For release notes and more information please visit https://aka.ms/azure-sdk-preview1-js
+
+- Introduced the following credential types:
+  - [`DefaultAzureCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/defaultazurecredential.html)
+  - [`EnvironmentCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/environmentcredential.html)
+  - [`ManagedIdentityCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/managedidentitycredential.html)
+  - [`ClientSecretCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/clientsecretcredential.html)
+  - [`ClientCertificateCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/clientcertificatecredential.html)
+  - [`ChainedTokenCredential`](https://azure.github.io/azure-sdk-for-js/identity/classes/chainedtokencredential.html)

package/README.md

@@ -12,11 +12,12 @@ to authenticate API requests. It supports token authentication using an Azure Ac
   - if you don't have one, you can sign up for a [free account](https://azure.microsoft.com/free/)
 - Node.js 8 LTS or higher
 
-**NOTE:** The credential implementations in this library are not yet supported in the browser.  We will provide browser-supported implementations for some in a future preview release.
+**NOTE:** The credential implementations in this library are not yet supported in the browser. We will provide browser-supported implementations for some in a future preview release.
 
 ### Install the package
 
 Install Azure Identity with `npm`:
+
 ```sh
 npm install --save @azure/identity
 ```
@@ -25,24 +26,27 @@ npm install --save @azure/identity
 
 ### Credentials
 
-Azure Identity offers a variety of credential classes that are accepted by Azure SDK data plane clients. Each client library documents its Azure Identity integration in its README and samples.  Azure SDK management plane libraries (those starting with `@azure/arm-*`)
+Azure Identity offers a variety of credential classes that are accepted by Azure SDK data plane clients. Each client library documents its Azure Identity integration in its README and samples. Azure SDK management plane libraries (those starting with `@azure/arm-*`)
 do not accept these credentials.
 
 Credentials differ mostly in configuration:
 
-|credential class|identity|configuration
-|-|-|-
-|`DefaultAzureCredential`|service principal or managed identity|none for managed identity; [environment variables](#environment-variables) for service principal
-|`ManagedIdentityCredential`|managed identity|none
-|`EnvironmentCredential`|service principal|[environment variables](#environment-variables)
-|`ClientSecretCredential`|service principal|constructor parameters
-|`ClientCertificateCredential`|service principal|constructor parameters
+| credential class                   | identity                              | configuration                                                                                    |
+| ---------------------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------ |
+| [`DefaultAzureCredential`][1]      | service principal or managed identity | none for managed identity; [environment variables](#environment-variables) for service principal |
+| [`ManagedIdentityCredential`][2]   | managed identity                      | none                                                                                             |
+| [`EnvironmentCredential`][3]       | service principal                     | [environment variables](#environment-variables)                                                  |
+| [`ClientSecretCredential`][4]      | service principal                     | constructor parameters                                                                           |
+| [`ClientCertificateCredential`][5] | service principal                     | constructor parameters                                                                           |
+| [`DeviceCodeCredential`][6]        | app registration details              | constructor parameters                                                                           |
+| [`InteractiveBrowserCredential`][7]| app registration details              | constructor parameters                                                                           |
+| [`UsernamePasswordCredential`][8]  | user principal                        | constructor parameters                                                                           |
 
 Credentials can be chained and tried in turn until one succeeds; see [chaining credentials](#chaining-credentials) for details.
 
 ### DefaultAzureCredential
 
-`DefaultAzureCredential` is appropriate for most scenarios. It supports authenticating as a service principal or managed identity. To authenticate as a service principal, provide configuration in environment variables as described in the next section.  Currently this credential attempts to use the `EnvironmentCredential` and `ManagedIdentityCredential`, in that order.
+`DefaultAzureCredential` is appropriate for most scenarios. It supports authenticating as a service principal or managed identity. To authenticate as a service principal, provide configuration in environment variables as described in the next section. Currently this credential attempts to use the `EnvironmentCredential` and `ManagedIdentityCredential`, in that order.
 
 Authenticating as a managed identity requires no configuration, but does require platform support. See the [managed identity documentation](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/services-support-managed-identities) for more information.
 
@@ -50,11 +54,11 @@ Authenticating as a managed identity requires no configuration, but does require
 
 `DefaultAzureCredential` and `EnvironmentCredential` are configured for service principal authentication with these environment variables:
 
-|variable name|value
-|-|-
-|`AZURE_CLIENT_ID`|service principal's app id
-|`AZURE_TENANT_ID`|id of the principal's Azure Active Directory tenant
-|`AZURE_CLIENT_SECRET`|one of the service principal's client secrets
+| variable name         | value                                               |
+| --------------------- | --------------------------------------------------- |
+| `AZURE_CLIENT_ID`     | service principal's app id                          |
+| `AZURE_TENANT_ID`     | id of the principal's Azure Active Directory tenant |
+| `AZURE_CLIENT_SECRET` | one of the service principal's client secrets       |
 
 ## Examples
 
@@ -64,7 +68,7 @@ Authenticating as a managed identity requires no configuration, but does require
 // The default credential first checks environment variables for configuration as described above.
 // If environment configuration is incomplete, it will try managed identity.
 const { KeysClient } = require("@azure/keyvault-keys");
-const { DefaultAzureCredential } = require('@azure/identity');
+const { DefaultAzureCredential } = require("@azure/identity");
 
 // Azure SDK clients accept the credential as a parameter
 const credential = new DefaultAzureCredential();
@@ -73,23 +77,29 @@ const getResult = await client.getKey("MyKeyName");
 ```
 
 ### Authenticating as a service principal:
+
 ```javascript
 // Using a client secret
-const { ClientSecretCredential } = require('@azure/identity');
+const { ClientSecretCredential } = require("@azure/identity");
 const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
 
 // Using a PEM-encoded certificate with a private key, not password protected
-const { ClientCertificateCredential } = require('@azure/identity');
-const credential = new ClientCertificateCredential(tenantId, clientId, "/app/certs/certificate.pem")
+const { ClientCertificateCredential } = require("@azure/identity");
+const credential = new ClientCertificateCredential(
+  tenantId,
+  clientId,
+  "/app/certs/certificate.pem"
+);
 
 // Using environment variables (see "Environment variables" above for variable names)
-const { EnvironmentCredential } = require('@azure/identity');
+const { EnvironmentCredential } = require("@azure/identity");
 const credential = new EnvironmentCredential();
 ```
 
 ### Chaining credentials:
+
 ```javascript
-const { ClientSecretCredential, ChainedTokenCredential } = require('@azure/identity');
+const { ClientSecretCredential, ChainedTokenCredential } = require("@azure/identity");
 
 // When an access token is requested, the chain will try each
 // credential in order, stopping when one provides a token
@@ -105,16 +115,22 @@ const client = new KeysClient(vaultUrl, credentialChain);
 ## Troubleshooting
 
 ### General
-Credentials raise `AuthenticationError` when they fail to authenticate.  This class has a `message` field which describes why authentication failed.  An `AggregateAuthenticationError` will be raised by `ChainedTokenCredential` with an `errors` field containing an array of errors from each credential in the chain.
+
+Credentials raise `AuthenticationError` when they fail to authenticate. This class has a `message` field which describes why authentication failed. An `AggregateAuthenticationError` will be raised by `ChainedTokenCredential` with an `errors` field containing an array of errors from each credential in the chain.
 
 ## Next steps
 
+### Read the documentation
+
+API documentation for this library can be found on our [documentation site](https://azure.github.io/azure-sdk-for-js/identity/index.html).
+
 ### Provide Feedback
 
 If you encounter bugs or have suggestions, please [open an issue](https://github.com/Azure/azure-sdk-for-js/issues).
 
 ## Contributing
-This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+
+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).
 
@@ -122,6 +138,17 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
 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.
 
+If you'd like to contribute to this library, please read the [contributing guide](../../../CONTRIBUTING.md) to learn more about how to build and test the code.
+
 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+[1]: https://azure.github.io/azure-sdk-for-js/identity/classes/defaultazurecredential.html
+[2]: https://azure.github.io/azure-sdk-for-js/identity/classes/managedidentitycredential.html
+[3]: https://azure.github.io/azure-sdk-for-js/identity/classes/environmentcredential.html
+[4]: https://azure.github.io/azure-sdk-for-js/identity/classes/clientsecretcredential.html
+[5]: https://azure.github.io/azure-sdk-for-js/identity/classes/clientcertificatecredential.html
+[6]: https://azure.github.io/azure-sdk-for-js/identity/classes/devicecodecredential.html
+[7]: https://azure.github.io/azure-sdk-for-js/identity/classes/interactivebrowsercredential.html
+[8]: https://azure.github.io/azure-sdk-for-js/identity/classes/usernamepasswordcredential.html