Upload hot garbage
This commit is contained in:
BIN
test2/packages/Azure.Identity.1.11.4/.signature.p7s
vendored
Normal file
BIN
test2/packages/Azure.Identity.1.11.4/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
test2/packages/Azure.Identity.1.11.4/Azure.Identity.1.11.4.nupkg
vendored
Normal file
BIN
test2/packages/Azure.Identity.1.11.4/Azure.Identity.1.11.4.nupkg
vendored
Normal file
Binary file not shown.
714
test2/packages/Azure.Identity.1.11.4/CHANGELOG.md
vendored
Normal file
714
test2/packages/Azure.Identity.1.11.4/CHANGELOG.md
vendored
Normal file
@@ -0,0 +1,714 @@
|
||||
# Release History
|
||||
|
||||
## 1.11.4 (2024-06-10)
|
||||
|
||||
### Bugs Fixed
|
||||
- Managed identity bug fixes
|
||||
|
||||
## 1.11.3 (2024-05-07)
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed a regression in `DefaultAzureCredential` probe request behavior for IMDS managed identity environments. [#43796](https://github.com/Azure/azure-sdk-for-net/issues/43796)
|
||||
|
||||
## 1.11.2 (2024-04-19)
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed an issue which caused claims to be incorrectly added to confidential client credentials such as `DeviceCodeCredential` [#43468](https://github.com/Azure/azure-sdk-for-net/issues/43468)
|
||||
|
||||
## 1.11.1 (2024-04-16)
|
||||
|
||||
### Other Changes
|
||||
- Updated Microsoft.Identity.Client and related dependencies to version 4.60.3
|
||||
|
||||
## 1.11.0 (2024-04-09)
|
||||
|
||||
### Bugs Fixed
|
||||
- `AzurePowerShellCredential` now handles the case where it falls back to legacy PowerShell without relying on the error message string.
|
||||
|
||||
### Breaking Changes
|
||||
- `DefaultAzureCredential` now sends a probe request with no retries for IMDS managed identity environments to avoid excessive retry delays when the IMDS endpoint is not available. This should improve credential chain resolution for local development scenarios. See [BREAKING_CHANGES.md](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/BREAKING_CHANGES.md#1110).
|
||||
|
||||
## 1.11.0-beta.1 (2024-02-06)
|
||||
|
||||
### Bugs Fixed
|
||||
- Claims from the `TokenRequestContext` are now correctly sent through to MSAL in `ConfidentialClient` credentials. [#40451](https://github.com/Azure/azure-sdk-for-net/issues/40451).
|
||||
- `ManagedIdentityCredential` is more lenient with the error message it matches when falling through to the next credential in the chain in the case that Docker Desktop returns a 403 response when attempting to access the IMDS endpoint. [#38218](https://github.com/Azure/azure-sdk-for-net/issues/38218)
|
||||
|
||||
### Other Changes
|
||||
- `AzureCliCredential` utilizes the new `expires_on` property returned by `az account get-access-token` to determine token expiration.
|
||||
|
||||
## 1.10.4 (2023-11-13)
|
||||
|
||||
### Other Changes
|
||||
- Distributed tracing with `ActivitySource` is stable and no longer requires the [Experimental feature-flag](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md).
|
||||
|
||||
|
||||
## 1.10.3 (2023-10-18)
|
||||
|
||||
### Bugs Fixed
|
||||
- `ManagedIdentityCredential` will now correctly retry when the instance metadata endpoint returns a 410 response. [#28568](https://github.com/Azure/azure-sdk-for-net/issues/28568)
|
||||
|
||||
### Other Changes
|
||||
- Updated Microsoft.Identity.Client dependency to version 4.56.0
|
||||
|
||||
## 1.10.2 (2023-10-10)
|
||||
|
||||
### Bugs Fixed
|
||||
|
||||
- Bug fixes for development time credentials.
|
||||
|
||||
|
||||
## 1.10.1 (2023-09-12)
|
||||
|
||||
### Bugs Fixed
|
||||
|
||||
- `ManagedIdentityCredential` will fall through to the next credential in the chain in the case that Docker Desktop returns a 403 response when attempting to access the IMDS endpoint. [#38218](https://github.com/Azure/azure-sdk-for-net/issues/38218)
|
||||
- Fixed an issue where interactive credentials would still prompt on the first GetToken request even when the cache is populated and an AuthenticationRecord is provided. [#38431](https://github.com/Azure/azure-sdk-for-net/issues/38431)
|
||||
|
||||
## 1.10.0 (2023-08-14)
|
||||
|
||||
### Features Added
|
||||
- Added `BrowserCustomization` property to `InteractiveBrowserCredential` to enable web view customization for interactive authentication.
|
||||
|
||||
### Bugs Fixed
|
||||
|
||||
- ManagedIdentityCredential will no longer attempt to parse invalid json payloads on responses from the managed identity endpoint.
|
||||
- Fixed an issue where AzurePowerShellCredential fails to parse the token response from Azure PowerShell. [#22638](https://github.com/Azure/azure-sdk-for-net/issues/22638)
|
||||
|
||||
## 1.10.0-beta.1 (2023-07-17)
|
||||
|
||||
### Features Added
|
||||
- Continuous Access Evaluation (CAE) is now configurable per-request by setting the `IsCaeEnabled` property of `TokenRequestContext` via its constructor.
|
||||
- Added `IsUnsafeSupportLoggingEnabled` property to `TokenCredentialOptions` which equates to passing 'true' for the `enablePiiLogging` parameter to the 'WithLogging' method on the MSAL client builder.
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed an issue with `TokenCachePersistenceOptions` where credentials in the same process would share the same cache, even if they had different configured names.
|
||||
- ManagedIdentityCredential now ignores empty ClientId values. [#37100](https://github.com/Azure/azure-sdk-for-net/issues/37100)
|
||||
- ManagedIdentityCredential will no longer attempt to parse invalid json payloads on responses from the managed identity endpoint.
|
||||
- When utilizing `EnvironmentCredential` from `DefaultAzureCredential` the credential will now override the `TENANT_ID` environment value if the TenantId value is set in `DefaultAzureCredentialOptions`.
|
||||
|
||||
### Other Changes
|
||||
- All developer credentials in the `DefaultAzureCredential` credential chain will fall through to the next credential in the chain on any failure. Previously, some exceptions would throw `AuthenticationFailedException`, which stops further progress in the chain.
|
||||
|
||||
## 1.9.0 (2023-05-09)
|
||||
|
||||
### Breaking Changes
|
||||
- Changed visibility of all environment variable based properties on `EnvironmentCredentialOptions` to internal. These options are again only configurable via environment variables.
|
||||
|
||||
## 1.9.0-beta.3 (2023-04-12)
|
||||
|
||||
### Breaking Changes
|
||||
- Renamed the developer credential options timeout settings as follows:
|
||||
- `AzureCliCredential` to `AzureCliCredentialOptions.ProcessTimeout`
|
||||
- `AzurePowerShellCredential` to `AzurePowerShellCredentialOptions.ProcessTimeout`
|
||||
- `VisualStudioCredential` to `VisualStudioCredentialOptions.ProcessTimeout`
|
||||
- `AzureDeveloperCliCredential` to `AzureDeveloperCliCredentialOptions.ProcessTimeout`
|
||||
|
||||
### Bugs Fixed
|
||||
- Setting `DefaultAzureCredentialOptions.ExcludeWorkloadIdentityCredential` to `true` also excludes `TokenExchangeManagedIdentitySource` when using `DefaultAzureCredential` selects the `ManagedIdentityCredential`
|
||||
|
||||
## 1.9.0-beta.2 (2023-02-21)
|
||||
|
||||
### Features Added
|
||||
- Allow `VisualStudioCredential` on non-Windows platforms
|
||||
- Added `AzureDeveloperCliCredential` for Azure Developer CLI
|
||||
- Added `WorkloadIdentityCredential` to support Azure Workload Identity authentication
|
||||
- Added `WorkloadIdentityCredential` and `AzureDeveloperCliCredential` to the `DefaultAzureCredential` authentication flow.
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed `ManagedIdentityCredential` authentication in sovereign clouds for services specifying `TenantId` through authentication challenge [#34077](https://github.com/Azure/azure-sdk-for-net/issues/34077)
|
||||
|
||||
### Breaking Changes
|
||||
- Previously, if environment variables for username and password auth are set in addition to the AZURE_CLIENT_CERTIFICATE_PATH, EnvironmentCredential would select the `UsernamePasswordCredential`. After this change, `ClientCertificateCredential` will be selected, which is consistent with all other languages. This is potentially a behavioral breaking change.
|
||||
|
||||
## 1.8.2 (2023-02-08)
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed error message parsing in `AzurePowerShellCredential` which would misinterpret Microsoft Entra ID errors with the need to install PowerShell. [#31998](https://github.com/Azure/azure-sdk-for-net/issues/31998)
|
||||
- Fix regional endpoint validation error when using `ManagedIdentityCredential`. [#32498])(https://github.com/Azure/azure-sdk-for-net/issues/32498)
|
||||
|
||||
## 1.8.1 (2023-01-13)
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed an issue when using `ManagedIdentityCredential` in combination with authorities other than Azure public cloud that resulted in a incorrect instance metadata validation error. [#32498](https://github.com/Azure/azure-sdk-for-net/issues/32498)
|
||||
|
||||
## 1.8.0 (2022-11-08)
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed error message parsing in `AzureCliCredential` which would misinterpret Microsoft Entra ID errors with the need to login with `az login`. [#26894](https://github.com/Azure/azure-sdk-for-net/issues/26894), [#29109](https://github.com/Azure/azure-sdk-for-net/issues/29109)
|
||||
- `ManagedIdentityCredential` will no longer fail when a response received from the endpoint is invalid JSON. It now treats this scenario as if the credential is unavailable. [#30467](https://github.com/Azure/azure-sdk-for-net/issues/30467), [#32061](https://github.com/Azure/azure-sdk-for-net/issues/32061)
|
||||
|
||||
## 1.9.0-beta.1 (2022-10-13)
|
||||
|
||||
### Features Added
|
||||
- Credentials that are implemented via launching a sub-process to acquire tokens now have configurable timeouts. This addresses scenarios where these proceses can take longer than the current default timeout values. (A community contribution, courtesy of _[reynaldoburgos](https://github.com/reynaldoburgos)_). The affected credentials and their associated options are:
|
||||
- `AzureCliCredential` and `AzureCliCredentialOptions.CliProcessTimeout`
|
||||
- `AzurePowerShellCredential` and `AzurePowerShellCredentialOptions.PowerShellProcessTimeout`
|
||||
- `VisualStudioCredential` and `VisualStudioCredentialOptions.VisualStudioProcessTimeout`
|
||||
- `DefaultAzureCredential` and `DefaultAzureCredentialOptions.DeveloperCredentialTimeout` Note: this option applies to all developer credentials above when using `DefaultAzureCredential`.
|
||||
|
||||
### Acknowledgments
|
||||
Thank you to our developer community members who helped to make Azure Identity better with their contributions to this release:
|
||||
|
||||
- _[reynaldoburgos](https://github.com/reynaldoburgos)_
|
||||
|
||||
## 1.8.0-beta.1 (2022-10-13)
|
||||
|
||||
### Features Added
|
||||
- Reintroduced `ManagedIdentityCredential` token caching support from 1.7.0-beta.1
|
||||
- `EnvironmentCredential` updated to support specifying a certificate password via the `AZURE_CLIENT_CERTIFICATE_PASSWORD` environment variable
|
||||
|
||||
### Breaking Changes
|
||||
- Excluded `VisualStudioCodeCredential` from `DefaultAzureCredential` token chain by default as SDK authentication via Visual Studio Code is broken due to issue [#27263](https://github.com/Azure/azure-sdk-for-net/issues/27263). The `VisualStudioCodeCredential` will be re-enabled in the `DefaultAzureCredential` flow once a fix is in place. Issue [#30525](https://github.com/Azure/azure-sdk-for-net/issues/30525) tracks this. In the meantime Visual Studio Code users can authenticate their development environment using the [Azure CLI](https://learn.microsoft.com/cli/azure/).
|
||||
|
||||
## 1.7.0 (2022-09-19)
|
||||
|
||||
### Features Added
|
||||
- Added `AdditionallyAllowedTenants` to the following credential options to force explicit opt-in behavior for multi-tenant authentication:
|
||||
- `AuthorizationCodeCredentialOptions`
|
||||
- `AzureCliCredentialOptions`
|
||||
- `AzurePowerShellCredentialOptions`
|
||||
- `ClientAssertionCredentialOptions`
|
||||
- `ClientCertificateCredentialOptions`
|
||||
- `ClientSecretCredentialOptions`
|
||||
- `DefaultAzureCredentialOptions`
|
||||
- `OnBehalfOfCredentialOptions`
|
||||
- `UsernamePasswordCredentialOptions`
|
||||
- `VisualStudioCodeCredentialOptions`
|
||||
- `VisualStudioCredentialOptions`
|
||||
- Added `TenantId` to `DefaultAzureCredentialOptions` to avoid having to set `InteractiveBrowserTenantId`, `SharedTokenCacheTenantId`, `VisualStudioCodeTenantId`, and `VisualStudioTenantId` individually.
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed overly restrictive scope validation to allow the '_' character, for common scopes such as `user_impersonation` [#30647](https://github.com/Azure/azure-sdk-for-net/issues/30647)
|
||||
|
||||
### Breaking Changes
|
||||
- Credential types supporting multi-tenant authentication will now throw `AuthenticationFailedException` if the requested tenant ID doesn't match the credential's tenant ID, and is not included in the `AdditionallyAllowedTenants` option. Applications must now explicitly add additional tenants to the `AdditionallyAllowedTenants` list, or add '*' to list, to enable acquiring tokens from tenants other than the originally specified tenant ID. See [BREAKING_CHANGES.md](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/BREAKING_CHANGES.md#170).
|
||||
- `ManagedIdentityCredential` token caching added in 1.7.0-beta.1 has been removed from this release and will be added back in 1.8.0-beta.1
|
||||
|
||||
## 1.7.0-beta.1 (2022-08-09)
|
||||
|
||||
### Features Added
|
||||
- `ManagedIdentityCredential` will now internally cache tokens. Apps can call `GetToken` or `GetTokenAsync` directly without needing to cache to avoid throttling.
|
||||
|
||||
## 1.6.1 (2022-08-08)
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed `AZURE_REGIONAL_AUTHORITY_NAME` support in `ClientCertificateCredential` [#29112](https://github.com/Azure/azure-sdk-for-net/issues/29112)
|
||||
- Fixed regression in `SharedTokenCacheCredential` default behavior [#28029](https://github.com/Azure/azure-sdk-for-net/issues/28029)
|
||||
- Fixed legacy PowerShell discovery failures [#28030](https://github.com/Azure/azure-sdk-for-net/issues/28030) (A community contribution, courtesy of _[nerddtvg](https://github.com/nerddtvg)_)
|
||||
|
||||
### Other Changes
|
||||
- Documentation improvements to `TokenCacheRefreshArgs` and `EnvironmentCredential` (Community contributions, courtesy of _[pmaytak](https://github.com/pmaytak)_ and _[goenning](https://github.com/goenning)_)
|
||||
|
||||
### Acknowledgments
|
||||
|
||||
Thank you to our developer community members who helped to make Azure Identity better with their contributions to this release:
|
||||
|
||||
- _[nerddtvg](https://github.com/nerddtvg)_
|
||||
- _[pmaytak](https://github.com/pmaytak)_
|
||||
- _[goenning](https://github.com/goenning)_
|
||||
|
||||
## 1.6.0 (2022-04-05)
|
||||
|
||||
### Features Added
|
||||
- Added a new property under the `Diagnostics` options available on `TokenCredentialOptions` and all sub-types. If set to `true`, we try to log the account identifiers by parsing the received access token. The account identifiers we try to log are the:
|
||||
- Application or Client Identifier
|
||||
- User Principal Name
|
||||
- Tenant Identifier
|
||||
- Object Identifier of the authenticated user or app
|
||||
- `ManagedIdentityCredential` now attempts to use the newest "2019-08-01" api version for App Service Managed Identity sources. The newer API version will be used if the `IDENTITY_ENDPOINT` and `IDENTITY_HEADER` environment variables are set.
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed an issue where the x5c header is not sent for `OnBehalfOfCredential` when the `SendCertificateChain` option is set. [#27679](https://github.com/Azure/azure-sdk-for-net/issues/27679)
|
||||
|
||||
## 1.6.0-beta.1 (2022-02-11)
|
||||
|
||||
### Features Added
|
||||
- `EnvironmentCredential` now supports certificate subject name / issuer based authentication with `AZURE_CLIENT_SEND_CERTIFICATE_CHAIN` environment variable (A community contribution, courtesy of _[trevorlacey-msft](https://github.com/trevorlacey-msft))_.
|
||||
- `ManagedIdentityCredential` now supports accepting a `ResourceIdentifier` argument to specify a User Assigned Managed Identity by resource Id rather than client Id. `DefaultAzureCredential` also supports this via the `ManagedIdentityResourceId` property of `DefaultAzureCredentialOptions`.
|
||||
- Added `ClientAssertionCredential` for authenticating service principals with a presigned client assertion.
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed `AuthenticationFailedException` from `AzurePowerSheellCredential` when not logged in on non-windows platforms [#23498](https://github.com/Azure/azure-sdk-for-net/issues/23498)
|
||||
- Fixed `ManagedIdentityCredential` response parsing to handle non-json responses [#24158](https://github.com/Azure/azure-sdk-for-net/issues/24158)
|
||||
|
||||
### Other Changes
|
||||
- Upgraded MSAL dependency to version 4.39.0
|
||||
|
||||
### Acknowledgments
|
||||
|
||||
Thank you to our developer community members who helped to make Azure Identity better with their contributions to this release:
|
||||
|
||||
- Trevor Lacey _([GitHub](https://github.com/trevorlacey-msft))_
|
||||
|
||||
## 1.5.0 (2021-10-14)
|
||||
|
||||
### Breaking Changes from 1.5.0-beta.4
|
||||
- The `AllowMultiTenantAuthentication` option has been removed and the default behavior is now as if it were true. The multi-tenant discovery feature can be totally disabled by either setting an `AppContext` switch named "Azure.Identity.DisableTenantDiscovery" to `true` or by setting the environment variable "AZURE_IDENTITY_DISABLE_MULTITENANTAUTH" to "true".
|
||||
- Removed the `IsPIILoggingEnabled` property from `TokenCredentialOptions`, similar functionality is planned to be added to `TokenCredentialOptions.Diagnostics` in a later release.
|
||||
- Removed `RegionalAuthority` from `ClientCertificateCredentialOptions` and `ClientSecretCredentialOptions`, along with the `RegionalAuthority` type.
|
||||
- Renamed struct `TokenCacheDetails` to `TokenCacheData`.
|
||||
- Renamed class `TokenCacheNotificationDetails` to `TokenCacheRefreshArgs`.
|
||||
- Updated `CacheBytes` property on `TokenCacheData` to be readonly and a required constructor parameter.
|
||||
|
||||
### Bugs Fixed
|
||||
- Fixed issue with `AuthorizationCodeCredential` not specifying correct redirectUrl (Issue [#24183](https://github.com/Azure/azure-sdk-for-net/issues/24183))
|
||||
|
||||
### Other Changes
|
||||
- Updated error messages to include links to the Azure.Identity troubleshooting guide.
|
||||
|
||||
## 1.5.0-beta.4 (2021-09-08)
|
||||
|
||||
### Features Added
|
||||
|
||||
- `DefaultAzureCredentialOptions` now has a `InteractiveBrowserClientId` property which allows passing a ClientId value to the `InteractiveBrowserCredential` when constructing a `DefaultAzureCredential`.
|
||||
- Implement `OnBehalfOfCredential` which enables authentication to Microsoft Entra ID using an On-Behalf-Of flow.
|
||||
- Added support to `ManagedIdentityCredential` for Azure hosts using federated token exchange for managed identity.
|
||||
|
||||
### Bugs Fixed
|
||||
- Refactored IMDS discovery to remove socket probing and caching of failures to improve `ManagedIdentityCredential` resiliency. [#23028](https://github.com/Azure/azure-sdk-for-net/issues/23028)
|
||||
- Updated `UsernamePasswordCredential` to use cached tokens when available [#23324](https://github.com/Azure/azure-sdk-for-net/issues/23324)
|
||||
|
||||
### Other Changes
|
||||
|
||||
- Updated credentials using `MsalConfidentialClient` to include MSAL log output in logs
|
||||
- Added additional logging to `AzureCliCredential`, `AzurePowerShellCredential`, `VisualStudioCredential`, and `VisualStudioCodeCredential` when `IsPIILoggingEnabled` is set to true.
|
||||
|
||||
## 1.5.0-beta.3 (2021-08-10)
|
||||
|
||||
### Acknowledgments
|
||||
|
||||
Thank you to our developer community members who helped to make Azure Identity better with their contributions to this release:
|
||||
|
||||
- Tomas Pajurek _([tpajurek-dtml](https://github.com/tomas-pajurek))_
|
||||
|
||||
### Features Added
|
||||
|
||||
- A new trace event is now logged when `DefaultAzureCredential` selects a credential during initialization.
|
||||
- Added `AzureApplicationCredential`
|
||||
- Added `IsPIILoggingEnabled` property to `TokenCredentialOptions`, which controls whether MSAL PII logging is enabled, and other sensitive credential related logging content.
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Renamed `AZURE_POD_IDENTITY_TOKEN_URL` to `AZURE_POD_IDENTITY_AUTHORITY_HOST`. The value should now be a host, for example "http://169.254.169.254" (the default).
|
||||
|
||||
### Bugs Fixed
|
||||
|
||||
- Stopped loading `$PROFILE` and checking for updates when using `AzurePowerShellCredential`.
|
||||
- Fixed unrecognized argument issue in `AzureCliCredential` when specifying the `TenantId` option. [#23158](https://github.com/Azure/azure-sdk-for-net/issues/23158) (A community contribution, courtesy of _[tomas-pajurek](https://github.com/tomas-pajurek))_.
|
||||
- Handled an additional error scenario for AzureCliCredential that prompts developers to run `az login` when needed. [#21758](https://github.com/Azure/azure-sdk-for-net/issues/21758)
|
||||
- Fixed an issue in `EnvironmentCredential` where the supplied `options` were not getting properly applied. [#22787](https://github.com/Azure/azure-sdk-for-net/issues/22787)
|
||||
- Fixed DateTime parsing to use the current culture in AzurePowerShellCredential. [#22638](https://github.com/Azure/azure-sdk-for-net/issues/22638)
|
||||
|
||||
## 1.4.1 (2021-08-04)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fixed issue resulting in duplicate event source names when executing in Azure Functions
|
||||
|
||||
## 1.5.0-beta.2 (2021-07-12)
|
||||
|
||||
### New Features
|
||||
|
||||
- Added regional STS support to client credential types
|
||||
- Added `RegionalAuthority` extensible enum
|
||||
- Added `RegionalAuthority` property to `ClientSecretCredentialOptions` and `ClientCertificateCredentialOptions`
|
||||
- Added support to `ManagedIdentityCredential` for Bridge to Kubernetes local development authentication.
|
||||
- TenantId values returned from service challenge responses can now be used to request tokens from the correct tenantId. To support this feature, there is a new `AllowMultiTenantAuthentication` option on `TokenCredentialOptions`.
|
||||
- By default, `AllowMultiTenantAuthentication` is false. When this option property is false and the tenant Id configured in the credential options differs from the tenant Id set in the `TokenRequestContext` sent to a credential, an `AuthorizationFailedException` will be thrown. This is potentially breaking change as it could be a different exception than what was thrown previously. This exception behavior can be overridden by either setting an `AppContext` switch named "Azure.Identity.EnableLegacyTenantSelection" to `true` or by setting the environment variable "AZURE_IDENTITY_ENABLE_LEGACY_TENANT_SELECTION" to "true". Note: AppContext switches can also be configured via configuration like below:
|
||||
- Added `OnBehalfOfFlowCredential` which enables support for Microsoft Entra On-Behalf-Of (OBO) flow. See the [Microsoft Entra ID documentation](https://learn.microsoft.com/entra/identity-platform/v2-oauth2-on-behalf-of-flow) to learn more about OBO flow scenarios.
|
||||
|
||||
```xml
|
||||
<ItemGroup>
|
||||
<RuntimeHostConfigurationOption Include="Azure.Identity.EnableLegacyTenantSelection" Value="true" />
|
||||
</ItemGroup>
|
||||
```
|
||||
|
||||
## 1.5.0-beta.1 (2021-06-08)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Added `LoginHint` property to `InteractiveBrowserCredentialOptions` which allows a user name to be pre-selected for interactive logins. Setting this option skips the account selection prompt and immediately attempts to login with the specified account.
|
||||
- Added `AuthorizationCodeCredentialOptions` which allows for configuration of a ReplyUri.
|
||||
|
||||
## 1.4.0 (2021-05-12)
|
||||
|
||||
### New Features
|
||||
|
||||
- By default, the MSAL Public Client Client Capabilities are populated with "CP1" to enable support for [Continuous Access Evaluation (CAE)](https://learn.microsoft.com/entra/identity-platform/app-resilience-continuous-access-evaluation).
|
||||
This indicates to Microsoft Entra ID that your application is CAE ready and can handle the CAE claim challenge. This capability can be disabled, if necessary, by either setting an `AppContext` switch named "Azure.Identity.DisableCP1" to `true` or by setting the environment variable;
|
||||
"AZURE_IDENTITY_DISABLE_CP1" to "true". Note: AppContext switches can also be configured via configuration like below:
|
||||
|
||||
```xml
|
||||
<ItemGroup>
|
||||
<RuntimeHostConfigurationOption Include="Azure.Identity.DisableCP1" Value="true" />
|
||||
</ItemGroup>
|
||||
```
|
||||
### Fixes and improvements
|
||||
|
||||
- The Microsoft Authentication Library (MSAL) dependency versions have been updated to the latest
|
||||
- Microsoft.Identity.Client version 4.30.1, Microsoft.Identity.Client.Extensions.Msal version 2.18.4.
|
||||
|
||||
## 1.4.0-beta.5 (2021-04-06)
|
||||
|
||||
### Acknowledgments
|
||||
|
||||
Thank you to our developer community members who helped to make Azure Identity better with their contributions to this release:
|
||||
|
||||
- Marco Mansi _([GitHub](https://github.com/olandese))_
|
||||
|
||||
### New Features
|
||||
|
||||
- Added `AzurePowerShellCredential` to `DefaultAzureCredential` (A community contribution, courtesy of _[olandese](https://github.com/olandese))_
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- When logging is enabled, the log output from Microsoft Authentication Library (MSAL) is also logged.
|
||||
- Fixed an issue where an account credential fails to load from the cache when EnableGuestTenantAuthentication is true and the account found in the cache has multiple matching tenantIds ([#18276](https://github.com/Azure/azure-sdk-for-net/issues/18276)).
|
||||
- Fixed deadlock issue in `InteractiveBrowserCredential` when running in a UI application ([#18418](https://github.com/Azure/azure-sdk-for-net/issues/18418)).
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- `TokenCache` class is moved removed from the public API surface and has been replaced by `TokenCachePersistenceOptions` for configuration of disk based persistence of the token cache.
|
||||
|
||||
## 1.4.0-beta.4 (2021-03-09)
|
||||
|
||||
### Fixes and Improvements
|
||||
|
||||
- Added the `[Serializable]` attribute to all custom exception types.
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Update the default value of `ExcludeSharedTokenCacheCredential` on `DefaultAzureCredentialsOptions` to true, to exclude the `SharedTokenCacheCredential` from the `DefaultAzureCredential` by default. See [BREAKING_CHANGES.md](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/BREAKING_CHANGES.md#140)
|
||||
|
||||
## 1.4.0-beta.3 (2021-02-09)
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- The `IDisposable` interface has been removed from `TokenCache`.
|
||||
|
||||
### New Features
|
||||
|
||||
- All credentials added support to handle the `Claims` property on `TokenRequestContext`
|
||||
|
||||
## 1.4.0-beta.2 (2021-01-29)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fixed issue in `HttpExtensions` causing the omission of content headers on requests ([#17448](https://github.com/Azure/azure-sdk-for-net/issues/17448))
|
||||
- Made `EnvironmentCredential` to account for both null and empty string when checking for the presense of the environment variables ([#18031](https://github.com/Azure/azure-sdk-for-net/issues/18031))
|
||||
|
||||
## 1.3.0 (2020-11-12)
|
||||
|
||||
### New Features
|
||||
|
||||
- Added support for Service Fabric managed identity authentication to `ManagedIdentityCredential`.
|
||||
- Added support for Azure Arc managed identity authentication to `ManagedIdentityCredential`.
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fix race condition in `ProcessRunner` causing `VisualStudioCredential` and `AzureCliCredential` to fail intermittently ([#16211](https://github.com/Azure/azure-sdk-for-net/issues/16211))
|
||||
- Fix `VisualStudioCodeCredential` to raise `CredentialUnavailableException` when reading from VS Code's stored secret ([#16795](https://github.com/Azure/azure-sdk-for-net/issues/16795))
|
||||
- Prevent `VisualStudioCodeCredential` using invalid authentication data when no user is signed in to Visual Studio Code ([#15870](https://github.com/Azure/azure-sdk-for-net/issues/15870))
|
||||
- Fix deadlock in `ProcessRunner` causing `AzureCliCredential` and `VisualStudioCredential` to fail due to timeout ([#14691](https://github.com/Azure/azure-sdk-for-net/issues/14691), [14207](https://github.com/Azure/azure-sdk-for-net/issues/14207))
|
||||
- Fix issue with `AzureCliCredential` incorrectly parsing expires on property returned from `az account get-access-token` ([#15801](https://github.com/Azure/azure-sdk-for-net/issues/15801))
|
||||
- Fix issue causing `DeviceCodeCredential` and `InteractiveBrowserCredential` to improperly authenticate to the home tenant for silent authentication calls after initial authentication ([#13801](https://github.com/Azure/azure-sdk-for-net/issues/13801))
|
||||
- Fix cache loading issue in `SharedTokenCacheCredential` on Linux ([#12939](https://github.com/Azure/azure-sdk-for-net/issues/12939))
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Rename property `IncludeX5CCliamHeader` on `ClientCertificateCredentialOptions` to `SendCertificateChain`
|
||||
- Removing Application Authentication APIs for GA release. These will be reintroduced in 1.4.0-beta.1.
|
||||
- Removed class `AuthenticationRecord`
|
||||
- Removed class `AuthenticationRequiredException`
|
||||
- Removed class `ClientSecretCredentialOptions` and `ClientSecretCredential` constructor overloads accepting this type
|
||||
- Removed class `UsernamePasswordCredentialOptions` and `UsernamePasswordCredential` constructor overloads accepting this type
|
||||
- Removed properties `EnablePersistentCache` and `AllowUnprotectedCache` from `ClientCertificateCredentialOptions`, `DeviceCodeCredentialOptions` and `InteractiveBrowserCredentialOptions`
|
||||
- Removed properties `AuthenticationRecord` and `DisableAutomaticAuthentication` from `DeviceCodeCredentialOptions` and `InteractiveBrowserCredentialOptions`
|
||||
- Removed properties `AllowUnencryptedCache`and `AuthenticationRecord` from `SharedTokenCacheCredentialOptions`
|
||||
- Removed methods `Authenticate` and `AuthenticateAsync` from `DeviceCodeCredential`, `InteractiveBrowserCredential` and `UsernamePasswordCredential`
|
||||
|
||||
## 1.4.0-beta.1 (2020-10-15)
|
||||
|
||||
### New Features
|
||||
|
||||
- Redesigned Application Authentication APIs
|
||||
- Adds `TokenCache` and `TokenCache` classes to give more user control over how the tokens are cached and how the cache is persisted.
|
||||
- Adds `TokenCache` property to options for credentials supporting token cache configuration.
|
||||
|
||||
## 1.3.0-beta.2 (2020-10-07)
|
||||
|
||||
### New Features
|
||||
|
||||
- Update `DeviceCodeCredential` to output device code information and authentication instructions in the console, in the case no `deviceCodeCallback` is specified.
|
||||
- Added `DeviceCodeCallback` to `DeviceCodeCredentialOptions`
|
||||
- Added default constructor to `DeviceCodeCredential`
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Replaced `DeviceCodeCredential` constructor overload taking `deviceCodeCallback` and `DeviceCodeCredentialOptions` with constructor taking only `DeviceCodeCredentialOptions`
|
||||
|
||||
## 1.3.0-beta.1 (2020-09-11)
|
||||
|
||||
### New Features
|
||||
|
||||
- Restoring Application Authentication APIs from 1.2.0-preview.6
|
||||
- Added support for App Service Managed Identity API version `2019-08-01` ([#13687](https://github.com/Azure/azure-sdk-for-net/issues/13687))
|
||||
- Added `IncludeX5CClaimHeader` to `ClientCertificateCredentialOptions` to enable subject name / issuer authentication with the `ClientCertificateCredential`.
|
||||
- Added `RedirectUri` to `InteractiveBrowserCredentialOptions` to enable authentication with user specified application with a custom redirect url.
|
||||
- Added `IdentityModelFactory` to enable constructing models from the Azure.Identity library for mocking.
|
||||
- Unify exception handling between `DefaultAzureCredential` and `ChainedTokenCredential` ([#14408](https://github.com/Azure/azure-sdk-for-net/issues/14408))
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Updated `MsalPublicClient` and `MsalConfidentialClient` to respect `CancellationToken` during initialization ([#13201](https://github.com/Azure/azure-sdk-for-net/issues/13201))
|
||||
- Fixed `VisualStudioCodeCredential` crashes on macOS (Issue [#14362](https://github.com/Azure/azure-sdk-for-net/issues/14362))
|
||||
- Fixed issue with non GUID Client Ids (Issue [#14585](https://github.com/Azure/azure-sdk-for-net/issues/14585))
|
||||
- Update `VisualStudioCredential` and `VisualStudioCodeCredential` to throw `CredentialUnavailableException` for ADFS tenant (Issue [#14639](https://github.com/Azure/azure-sdk-for-net/issues/14639))
|
||||
|
||||
## 1.2.3 (2020-09-11)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fixed issue with `DefaultAzureCredential` incorrectly catching `AuthenticationFailedException` (Issue [#14974](https://github.com/Azure/azure-sdk-for-net/issues/14974))
|
||||
- Fixed issue with `DefaultAzureCredential` throwing exceptions during concurrent calls (Issue [#15013](https://github.com/Azure/azure-sdk-for-net/issues/15013))
|
||||
|
||||
## 1.2.2 (2020-08-20)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fixed issue with `InteractiveBrowserCredential` not specifying correct redirectUrl (Issue [#13940](https://github.com/Azure/azure-sdk-for-net/issues/13940))
|
||||
|
||||
## 1.2.1 (2020-08-18)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Bug in TaskExtensions.EnsureCompleted method that causes it to unconditionally throw an exception in the environments with synchronization context
|
||||
|
||||
## 1.2.0 (2020-08-10)
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Removing Application Authentication APIs for GA release. These will be reintroduced in 1.3.0-preview.
|
||||
- Removed class `AuthenticationRecord`
|
||||
- Removed class `AuthenticationRequiredException`
|
||||
- Removed class `ClientCertificateCredentialOptions` and `ClientCertificateCredential` constructor overloads accepting this type
|
||||
- Removed class `ClientSecretCredentialOptions` and `ClientSecretCredential` constructor overloads accepting this type
|
||||
- Removed class `DeviceCodeCredentialOptions` and `DeviceCodeCredential` constructor overloads accepting this type
|
||||
- Removed class `InteractiveBrowserCredentialOptions` and `InteractiveBrowserCredential` constructor overloads accepting this type
|
||||
- Removed class `UsernamePasswordCredentialOptions` and `UsernamePasswordCredential` constructor overloads accepting this type
|
||||
- Removed methods `Authenticate` and `AuthenticateAsync` from `DeviceCodeCredential`
|
||||
- Removed methods `Authenticate` and `AuthenticateAsync` from `InteractiveBrowserCredential`
|
||||
- Removed methods `Authenticate` and `AuthenticateAsync` from `UsernamePasswordCredential`
|
||||
- Removed properties `AllowUnencryptedCache`and `AuthenticationRecord` from `SharedTokenCacheCredentialOptions`
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fixed excess errors in `DefaultAzureCredential` tracing (Issue [#10659](https://github.com/Azure/azure-sdk-for-net/issues/10659))
|
||||
- Fixed concurrency issue in `DefaultAzureCredential` (Issue [#13044](https://github.com/Azure/azure-sdk-for-net/issues/13044))
|
||||
|
||||
## 1.2.0-preview.6 (2020-07-22)
|
||||
|
||||
### New Features
|
||||
|
||||
- Added the read only property `ClientId` to `AuthenticationRecord`.
|
||||
- Added the property `AllowUnencryptedCache` to the option classes `ClientCertificateCredentialOptions`, `ClientSecretCredentialOptions`, `DeviceCodeCredentialOptions`, `InteractiveBrowserCredentialOptions` and `SharedTokenCacheCredentialOptions` which when set to true allows the credential to fall back to storing tokens in an unencrypted file if no OS level user encryption is available when `EnablePersistentCache` is set to true.
|
||||
- Added the property `AuthenticationRecord` to the option class `SharedTokenCacheCredentialOptions` to support silent authentication for accounts previously authenticated with an interactive credential.
|
||||
- Added option class `UsernamePasswordCredentialOptions` which supports the options `EnablePersistentCache` and `AllowUnencryptedCache`.
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Rename type `KnownAuthorityHosts` to `AzureAuthorityHosts`
|
||||
- Rename property `AzureChinaCloud` to `AzureChina`
|
||||
- Rename property `AzureGermanCloud` to `AzureGermany`
|
||||
- Rename property `AzureUSGovernment` to `AzureGovernment`
|
||||
- Rename property `AzureCloud` to `AzurePublicCloud`
|
||||
|
||||
## 1.2.0-preview.5 (2020-07-08)
|
||||
|
||||
### New Features
|
||||
|
||||
- Added options classes `ClientCertificateCredentialOptions` and `ClientSecretCredentialOptions` which support the following new option
|
||||
- `EnablePersistentCache` configures these credentials to use a persistent cache shared between credentials which set this option. By default the cache is per credential and in memory only.
|
||||
|
||||
## 1.2.0-preview.4 (2020-06-10)
|
||||
|
||||
### New Features
|
||||
|
||||
- Makes `AzureCliCredential`, `VisualStudioCredential` and `VisualStudioCodeCredential` public to allow direct usage.
|
||||
- Added `Authenticate` methods to `UsernamePasswordCredential`
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fix `SharedTokenCacheCredential` account filter to be case-insensitive (Issue [#10816](https://github.com/Azure/azure-sdk-for-net/issues/10816))
|
||||
- Update `VisualStudioCodeCredential` to properly throw `CredentialUnavailableException` when re-authentication is needed. (Issue [#11595](https://github.com/Azure/azure-sdk-for-net/issues/11595))
|
||||
|
||||
## 1.2.0-preview.3 (2020-05-05)
|
||||
|
||||
### New Features
|
||||
|
||||
- First preview of new API for authenticating users with `DeviceCodeCredential` and `InteractiveBrowserCredential`
|
||||
- Added method `Authenticate` which pro-actively interacts with the user to authenticate if necessary and returns a serializable `AuthenticationRecord`
|
||||
- Added Options classes `DeviceCodeCredentialOptions` and `InteractiveBrowserCredentialOptions` which support the following new options
|
||||
- `AuthenticationRecord` enables initializing a credential with an `AuthenticationRecord` returned from a prior call to `Authenticate`
|
||||
- `DisableAutomaticAuthentication` disables automatic user interaction causing the credential to throw an `AuthenticationRequiredException` when interactive authentication is necessary.
|
||||
- `EnablePersistentCache` configures these credentials to use a persistent cache shared between credentials which set this option. By default the cache is per credential and in memory only.
|
||||
|
||||
## 1.2.0-preview.2 (2020-04-06)
|
||||
|
||||
### New Features
|
||||
|
||||
- Updates `DefaultAzureCredential` to enable authenticating through Visual Studio
|
||||
- Updates `DefaultAzureCredential` to enable authentication through Visual Studio Code
|
||||
|
||||
## 1.2.0-preview.1 (2020-03-10)
|
||||
|
||||
### New Features
|
||||
|
||||
- Updating `DefaultAzureCredential` to enable authenticating through the Azure CLI
|
||||
- `ClientCertificateCredential` now supports being constructed with a path to an unencrypted certificate (in either PFX or PEM format)
|
||||
- `EnvironmentCredential` now supports reading a certificate path from `AZURE_CLIENT_CERTIFICATE_PATH`
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fix an issue where `EnvironmentCredential` did not behave correctly when `AZURE_USERNAME` and `AZURE_PASSWORD` where set
|
||||
- Added `KnownAuthorityHosts` class to aid in sovereign cloud configuration.
|
||||
|
||||
## 1.1.1 (2020-02-10)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fixed `UsernamePasswordCredential` constructor parameter mishandling
|
||||
- Updated `ManagedIdentityCredential` endpoint discovery to avoid throwing
|
||||
- Fixed `ManagedIdentityCredential` to raise `CredentialUnavailableException` on 400 return from the service where no identity has been assigned
|
||||
- Updated error messaging from `DefaultAzureCredential` to more easily root cause failures
|
||||
|
||||
## 1.1.0 (2019-11-25)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Update `SharedTokenCacheCredential` to filter accounts by tenant id
|
||||
- Added `SharedTokenCacheCredentialOptions` class with properties `TenantId` and `Username`
|
||||
- Added constructor overload to `SharedTokenCacheCredential` which accepts `SharedTokenCacheCredentialOptions`
|
||||
- Added property `SharedTokenCacheTenantId` to `DefaultAzureCredentialOptions`
|
||||
- Support for personal account authentication in `DefaultAzureCredential`, `InteractiveBrowserCredential`, and `SharedTokenCacheCredential`
|
||||
- Added `InteractiveBrowserTenantId` to `DefaultAzureCredentialOptions`
|
||||
- Fixed issue with `ManagedIdentityCredential` authentication with user assigned identities
|
||||
|
||||
## 1.0.0 (2019-10-29)
|
||||
|
||||
- First stable release of Azure.Identity package.
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Rename `AzureCredentialOptions` -> `TokenCredentialOptions`
|
||||
- Renamed property `VerificationUrl` -> `VerificationUri` and changed type from `string` to `Uri`
|
||||
- Updated `ClientSecretCredential` class
|
||||
- Removed property `ClientId`
|
||||
- Removed property `ClientSecret`
|
||||
- Removed property `TenantId`
|
||||
- Updated `ClientCertificateCredential` class
|
||||
- Removed property `ClientId`
|
||||
- Removed property `ClientCertificate`
|
||||
- Removed property `TenantId`
|
||||
- Updated `DefaultAzureCredential` class to derive directly from `TokenCredential` rather than `ChainedTokenCredential`
|
||||
- Updated `DefaultAzureCredentialOptions` class
|
||||
- Renamed property `PreferredAccountUsername` -> `SharedTokenCacheUsername`
|
||||
- Renamed property `IncludeEnvironmentCredential` -> `ExcludeEnvironmentCredential`
|
||||
- Renamed property `IncludeManagedIdentityCredential` -> `ExcludeManagedIdentityCredential`
|
||||
- Renamed property `IncludeSharedTokenCacheCredential` -> `ExcludeSharedTokenCacheCredential`
|
||||
- Renamed property `IncludeInteractiveBrowserCredential` -> `ExcludeInteractiveBrowserCredential`
|
||||
- Updated `DeviceCodeInfo` class
|
||||
- Removed property `Interval`
|
||||
- Renamed property `VerificationUrl` -> `VerificationUri` and changed type from `string` to `Uri`
|
||||
- Updated `InteractiveBrowserCredential` class
|
||||
- Reordered constructor parameters `tenantId` and `clientId` to be consistent with other credential types
|
||||
- Updated `SharedTokenCacheCredential` class
|
||||
- Updated constructor to take `TokenCredentialOptions`
|
||||
- Removed `clientId` constructor parameter
|
||||
- Removed class `SharedTokenCacheCredentialOptions`
|
||||
- Updated exception model across the Azure.Identity library.
|
||||
- `TokenCredential` implementations in the Azure.Identity library now throw exceptions rather than returning `default`(`AccessToken`) when no token is obtained
|
||||
- Added the `CredentialUnavailableExcpetion` exception type to distinguish cases when failure to obtain an `AccessToken` was expected
|
||||
|
||||
### Dependency Changes
|
||||
|
||||
- Adopted Azure.Core 1.0.0
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Update `ManagedIdentityCredential` IMDS availability check to handle immediate network failures
|
||||
- Added a `DefaultAzureCredential` constructor overload to enable interactive credential types by default
|
||||
|
||||
## 1.0.0-preview.5 (2019-10-07)
|
||||
|
||||
### Dependency Changes
|
||||
|
||||
- Adopted Azure.Core 1.0.0-preview.9
|
||||
|
||||
### New Features
|
||||
|
||||
- Added `DefaultAzureCredentialOptions` for configuring the `DefaultAzureCredential` authentication flow
|
||||
- Added `InteractiveBrowserCredential` to the `DefaultAzureCredential` authentication flow, but excluded by default
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Updated `InteractiveBrowserCredential` and `DeviceCodeCredential` to optionally accept a tenantId to support non-multitenant applications
|
||||
|
||||
## 1.0.0-preview.4 (2019-09-10)
|
||||
|
||||
### Breaking Changes
|
||||
|
||||
- Modified GetToken abstraction to accept `TokenRequest` structure rather than `string[]` for forwards compatibility
|
||||
|
||||
### Dependency Changes
|
||||
|
||||
- Adopted Azure.Core 1.0.0-preview.8
|
||||
|
||||
### New Features
|
||||
|
||||
- Added `SharedTokenCacheCredential` to support Single Sign On with developer tooling
|
||||
- Updated `DefaultAzureCredential`authentication flow to include the `SharedTokenCacheCredential`
|
||||
|
||||
## 1.0.0-preview.3 (2019-08-06)
|
||||
|
||||
### Dependency Changes
|
||||
|
||||
- Adopted Azure.Core 1.0.0-preview.7
|
||||
- Adopted Microsoft.Identity.Client 4.1.0
|
||||
|
||||
### New Features
|
||||
|
||||
- User Principal Authentication
|
||||
- Added `DeviceCodeCredential` class
|
||||
- Added `InteractiveBrowserCredential` class
|
||||
- Added `UsernamePasswordCredential` class
|
||||
- Support for Azure SDK ASP .NET Core integration
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Added identity client distributed tracing support
|
||||
|
||||
## 1.0.0-preview.2 (2019-07-02)
|
||||
|
||||
### Fixes and improvements
|
||||
|
||||
- Fix to ManagedIdentityCredential to properly parse expires_on from response
|
||||
|
||||
## 1.0.0-preview.1 (2019-06-27)
|
||||
|
||||
Version 1.0.0-preview.1 is the first preview of our efforts to create a user-friendly authentication API for Azure SDK client libraries. For more
|
||||
information about preview releases of other Azure SDK libraries, please visit https://aka.ms/azure-sdk-preview1-net.
|
||||
|
||||
### New Features
|
||||
|
||||
- Azure Service Authentication
|
||||
- Added `DefaultAzureCredential` class
|
||||
- Added `ChainedTokenCredential` class
|
||||
- Service Principal Authentication
|
||||
- Added `ClientSecretCredential` class
|
||||
- Added `ClientCertificateCredential` class
|
||||
- Managed Identity Authentication
|
||||
- Added `ManagedIdentityCredential` class
|
||||
|
||||
See the [documentation](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/README.md) for more details. User authentication will be added in an upcoming preview release.
|
||||
435
test2/packages/Azure.Identity.1.11.4/README.md
vendored
Normal file
435
test2/packages/Azure.Identity.1.11.4/README.md
vendored
Normal file
@@ -0,0 +1,435 @@
|
||||
# Azure Identity client library for .NET
|
||||
|
||||
The Azure Identity library provides [Microsoft Entra ID](https://learn.microsoft.com/entra/fundamentals/whatis) ([formerly Azure Active Directory](https://learn.microsoft.com/entra/fundamentals/new-name)) token authentication support across the Azure SDK. It provides a set of [`TokenCredential`](https://learn.microsoft.com/dotnet/api/azure.core.tokencredential?view=azure-dotnet) implementations which can be used to construct Azure SDK clients which support Microsoft Entra token authentication.
|
||||
|
||||
[Source code][source] | [Package (NuGet)][package] | [API reference documentation][identity_api_docs] | [Microsoft Entra ID documentation][entraid_doc]
|
||||
|
||||
## Getting started
|
||||
|
||||
### Install the package
|
||||
|
||||
Install the Azure Identity client library for .NET with [NuGet][nuget]:
|
||||
|
||||
```dotnetcli
|
||||
dotnet add package Azure.Identity
|
||||
```
|
||||
|
||||
### Prerequisites
|
||||
|
||||
* An [Azure subscription][azure_sub].
|
||||
* The [Azure CLI][azure_cli] can also be useful for authenticating in a development environment, creating accounts, and managing account roles.
|
||||
|
||||
### Authenticate the client
|
||||
|
||||
When debugging and executing code locally it is typical for a developer to use their own account for authenticating calls to Azure services. There are several developer tools which can be used to perform this authentication in your development environment.
|
||||
|
||||
#### Authenticate via Visual Studio
|
||||
|
||||
Developers using Visual Studio 2017 or later can authenticate a Microsoft Entra account through the IDE. Applications using the `DefaultAzureCredential` or the `VisualStudioCredential` can then use this account to authenticate calls in their application when running locally.
|
||||
|
||||
To authenticate in Visual Studio, select the **Tools** > **Options** menu to launch the Options dialog. Then navigate to the `Azure Service Authentication` options to sign in with your Microsoft Entra account.
|
||||
|
||||
![Visual Studio Account Selection][vs_login_image]
|
||||
|
||||
#### Authenticate via Visual Studio Code
|
||||
|
||||
Developers using Visual Studio Code can use the [Azure Account extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) to authenticate via the editor. Applications using the `DefaultAzureCredential` or the `VisualStudioCodeCredential` can then use this account to authenticate calls in their application when running locally.
|
||||
|
||||
It's a [known issue](https://github.com/Azure/azure-sdk-for-net/issues/30525) that `VisualStudioCodeCredential` doesn't work with [Azure Account extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account) versions newer than **0.9.11**. A long-term fix to this problem is in progress. In the meantime, consider [authenticating via the Azure CLI](#authenticating-via-the-azure-cli).
|
||||
|
||||
#### Authenticate via the Azure CLI
|
||||
|
||||
Developers coding outside of an IDE can also use the [Azure CLI][azure_cli] to authenticate. Applications using the `DefaultAzureCredential` or the `AzureCliCredential` can then use this account to authenticate calls in their application when running locally.
|
||||
|
||||
To authenticate with the [Azure CLI][azure_cli], users can run the command `az login`. For users running on a system with a default web browser, the Azure CLI will launch the browser to authenticate the user.
|
||||
|
||||
![Azure CLI Account Sign In][azure_cli_login_image]
|
||||
|
||||
For systems without a default web browser, the `az login` command will use the device code authentication flow. The user can also force the Azure CLI to use the device code flow rather than launching a browser by specifying the `--use-device-code` argument.
|
||||
|
||||
![Azure CLI Account Device Code Sign In][azure_cli_login_device_code_image]
|
||||
|
||||
#### Authenticate via the Azure Developer CLI
|
||||
|
||||
Developers coding outside of an IDE can also use the [Azure Developer CLI][azure_developer_cli] to authenticate. Applications using the `DefaultAzureCredential` or the `AzureDeveloperCliCredential` can then use this account to authenticate calls in their application when running locally.
|
||||
|
||||
To authenticate with the [Azure Developer CLI][azure_developer_cli], users can run the command `azd auth login`. For users running on a system with a default web browser, the Azure Developer CLI will launch the browser to authenticate the user.
|
||||
|
||||
For systems without a default web browser, the `azd auth login --use-device-code` command will use the device code authentication flow.
|
||||
|
||||
#### Authenticate via Azure PowerShell
|
||||
|
||||
Developers coding outside of an IDE can also use [Azure PowerShell][azure_powerShell] to authenticate. Applications using the `DefaultAzureCredential` or the `AzurePowerShellCredential` can then use this account to authenticate calls in their application when running locally.
|
||||
|
||||
To authenticate with [Azure PowerShell][azure_powerShell], users can run the command `Connect-AzAccount`. For users running on a system with a default web browser and version 5.0.0 or later of azure PowerShell, it will launch the browser to authenticate the user.
|
||||
|
||||
For systems without a default web browser, the `Connect-AzAccount` command will use the device code authentication flow. The user can also force Azure PowerShell to use the device code flow rather than launching a browser by specifying the `UseDeviceAuthentication` argument.
|
||||
|
||||
## Key concepts
|
||||
|
||||
### Credentials
|
||||
|
||||
A credential is a class which contains or can obtain the data needed for a service client to authenticate requests. Service clients across the Azure SDK accept credentials when they're constructed. Service clients use those credentials to authenticate requests to the service.
|
||||
|
||||
The Azure Identity library focuses on OAuth authentication with Microsoft Entra ID, and it offers a variety of credential classes capable of acquiring a Microsoft Entra token to authenticate service requests. All of the credential classes in this library are implementations of the `TokenCredential` abstract class in [Azure.Core][azure_core_library], and any of them can be used to construct service clients capable of authenticating with a `TokenCredential`.
|
||||
|
||||
See [Credential Classes](#credential-classes) for a complete listing of available credential types.
|
||||
|
||||
### DefaultAzureCredential
|
||||
|
||||
The `DefaultAzureCredential` is appropriate for most scenarios where the application is intended to ultimately be run in Azure. This is because the `DefaultAzureCredential` combines credentials commonly used to authenticate when deployed, with credentials used to authenticate in a development environment.
|
||||
|
||||
> 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` attempts to authenticate via the following mechanisms, in this order, stopping when one succeeds:
|
||||
|
||||
![DefaultAzureCredential authentication flow][default_azure_credential_authflow_image]
|
||||
|
||||
1. **Environment** - The `DefaultAzureCredential` will read account information specified via [environment variables](#environment-variables) and use it to authenticate.
|
||||
1. **Workload Identity** - If the application is deployed to an Azure host with Workload Identity enabled, the `DefaultAzureCredential` will authenticate with that account.
|
||||
1. **Managed Identity** - If the application is deployed to an Azure host with Managed Identity enabled, the `DefaultAzureCredential` will authenticate with that account.
|
||||
1. **Visual Studio** - If the developer has authenticated via Visual Studio, the `DefaultAzureCredential` will authenticate with that account.
|
||||
1. **Visual Studio Code** - Currently excluded by default as SDK authentication via Visual Studio Code is broken due to issue [#27263](https://github.com/Azure/azure-sdk-for-net/issues/27263). The `VisualStudioCodeCredential` will be re-enabled in the `DefaultAzureCredential` flow once a fix is in place. Issue [#30525](https://github.com/Azure/azure-sdk-for-net/issues/30525) tracks this. In the meantime Visual Studio Code users can authenticate their development environment using the [Azure CLI](https://learn.microsoft.com/cli/azure/).
|
||||
1. **Azure CLI** - If the developer has authenticated an account via the Azure CLI `az login` command, the `DefaultAzureCredential` will authenticate with that account.
|
||||
1. **Azure PowerShell** - If the developer has authenticated an account via the Azure PowerShell `Connect-AzAccount` command, the `DefaultAzureCredential` will authenticate with that account.
|
||||
1. **Azure Developer CLI** - If the developer has authenticated via the Azure Developer CLI `azd auth login` command, the `DefaultAzureCredential` will authenticate with that account.
|
||||
1. **Interactive browser** - If enabled, the `DefaultAzureCredential` will interactively authenticate the developer via the current system's default browser. By default, this credential type is disabled.
|
||||
|
||||
#### Continuation policy
|
||||
|
||||
As of version 1.10.1, `DefaultAzureCredential` will attempt to authenticate with all developer credentials until one succeeds, regardless of any errors previous developer credentials experienced. For example, a developer credential may attempt to get a token and fail, so `DefaultAzureCredential` will continue to the next credential in the flow. Deployed service credentials will stop the flow with a thrown exception if they're able to attempt token retrieval, but don't receive one. Prior to version 1.10.1, developer credentials would similarly stop the authentication flow if token retrieval failed.
|
||||
|
||||
This behavior allows for trying all of the developer credentials on your machine while having predictable deployed behavior.
|
||||
|
||||
## Examples
|
||||
|
||||
### Authenticate with `DefaultAzureCredential`
|
||||
|
||||
This example demonstrates authenticating the `SecretClient` from the [Azure.Security.KeyVault.Secrets][secrets_client_library] client library using the `DefaultAzureCredential`.
|
||||
|
||||
```C# Snippet:AuthenticatingWithDefaultAzureCredential
|
||||
// Create a secret client using the DefaultAzureCredential
|
||||
var client = new SecretClient(new Uri("https://myvault.vault.azure.net/"), new DefaultAzureCredential());
|
||||
```
|
||||
|
||||
### Enable interactive authentication with `DefaultAzureCredential`
|
||||
|
||||
Interactive authentication is disabled in the `DefaultAzureCredential` by default. This example demonstrates two ways of enabling the interactive authentication portion of the `DefaultAzureCredential`. When enabled the `DefaultAzureCredential` will fall back to interactively authenticating the developer via the system's default browser if when no other credentials are available. This example then authenticates an `EventHubProducerClient` from the [Azure.Messaging.EventHubs][eventhubs_client_library] client library using the `DefaultAzureCredential` with interactive authentication enabled.
|
||||
|
||||
```C# Snippet:EnableInteractiveAuthentication
|
||||
// the includeInteractiveCredentials constructor parameter can be used to enable interactive authentication
|
||||
var credential = new DefaultAzureCredential(includeInteractiveCredentials: true);
|
||||
|
||||
var eventHubClient = new EventHubProducerClient("myeventhub.eventhubs.windows.net", "myhubpath", credential);
|
||||
```
|
||||
|
||||
### Specify a user-assigned managed identity with `DefaultAzureCredential`
|
||||
|
||||
Many Azure hosts allow the assignment of a user-assigned managed identity. This example demonstrates configuring the `DefaultAzureCredential` to authenticate a user-assigned identity when deployed to an Azure host. It then authenticates a `BlobClient` from the [Azure.Storage.Blobs][blobs_client_library] client library with credential.
|
||||
|
||||
```C# Snippet:UserAssignedManagedIdentity
|
||||
// When deployed to an azure host, the default azure credential will authenticate the specified user assigned managed identity.
|
||||
|
||||
string userAssignedClientId = "<your managed identity client Id>";
|
||||
var credential = new DefaultAzureCredential(new DefaultAzureCredentialOptions { ManagedIdentityClientId = userAssignedClientId });
|
||||
|
||||
var blobClient = new BlobClient(new Uri("https://myaccount.blob.core.windows.net/mycontainer/myblob"), credential);
|
||||
```
|
||||
|
||||
In addition to configuring the `ManagedIdentityClientId` via code, it can also be set using the `AZURE_CLIENT_ID` environment variable. These two approaches are equivalent when using the `DefaultAzureCredential`.
|
||||
|
||||
### Define a custom authentication flow with `ChainedTokenCredential`
|
||||
|
||||
While the `DefaultAzureCredential` is generally the quickest way to get started developing applications for Azure, more advanced users may want to customize the credentials considered when authenticating. The `ChainedTokenCredential` enables users to combine multiple credential instances to define a customized chain of credentials. This example demonstrates creating a `ChainedTokenCredential` which will attempt to authenticate using managed identity, and fall back to authenticating via the Azure CLI if managed identity is unavailable in the current environment. The credential is then used to authenticate an `EventHubProducerClient` from the [Azure.Messaging.EventHubs][eventhubs_client_library] client library.
|
||||
|
||||
```C# Snippet:CustomChainedTokenCredential
|
||||
// Authenticate using managed identity if it is available; otherwise use the Azure CLI to authenticate.
|
||||
|
||||
var credential = new ChainedTokenCredential(new ManagedIdentityCredential(), new AzureCliCredential());
|
||||
|
||||
var eventHubProducerClient = new EventHubProducerClient("myeventhub.eventhubs.windows.net", "myhubpath", credential);
|
||||
```
|
||||
|
||||
## Managed identity support
|
||||
|
||||
[Managed identity authentication](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/overview) is supported via either the `DefaultAzureCredential` or the `ManagedIdentityCredential` directly for the following Azure services:
|
||||
|
||||
* [Azure App Service and Azure Functions](https://learn.microsoft.com/azure/app-service/overview-managed-identity?tabs=dotnet)
|
||||
* [Azure Arc](https://learn.microsoft.com/azure/azure-arc/servers/managed-identity-authentication)
|
||||
* [Azure Cloud Shell](https://learn.microsoft.com/azure/cloud-shell/msi-authorization)
|
||||
* [Azure Kubernetes Service](https://learn.microsoft.com/azure/aks/use-managed-identity)
|
||||
* [Azure Service Fabric](https://learn.microsoft.com/azure/service-fabric/concepts-managed-identity)
|
||||
* [Azure Virtual Machines](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/how-to-use-vm-token)
|
||||
* [Azure Virtual Machines Scale Sets](https://learn.microsoft.com/entra/identity/managed-identities-azure-resources/qs-configure-powershell-windows-vmss)
|
||||
|
||||
### Examples
|
||||
|
||||
These examples demonstrate authenticating the `SecretClient` from the [Azure.Security.KeyVault.Secrets][secrets_client_library] client library using the `ManagedIdentityCredential`.
|
||||
|
||||
#### Authenticate with a user-assigned managed identity
|
||||
|
||||
```C# Snippet:AuthenticatingWithManagedIdentityCredentialUserAssigned
|
||||
var credential = new ManagedIdentityCredential(clientId: userAssignedClientId);
|
||||
var client = new SecretClient(new Uri("https://myvault.vault.azure.net/"), credential);
|
||||
```
|
||||
|
||||
#### Authenticate with a system-assigned managed identity
|
||||
|
||||
```C# Snippet:AuthenticatingWithManagedIdentityCredentialSystemAssigned
|
||||
var credential = new ManagedIdentityCredential();
|
||||
var client = new SecretClient(new Uri("https://myvault.vault.azure.net/"), credential);
|
||||
```
|
||||
|
||||
## Cloud configuration
|
||||
|
||||
Credentials default to authenticating to the Microsoft Entra endpoint for the Azure public cloud. To access resources in other clouds, such as Azure Government or a private cloud, configure credentials with the `AuthorityHost` argument. [AzureAuthorityHosts](https://learn.microsoft.com/dotnet/api/azure.identity.azureauthorityhosts?view=azure-dotnet) defines authorities for well-known clouds:
|
||||
|
||||
```C# Snippet:AuthenticatingWithAuthorityHost
|
||||
var credential = new DefaultAzureCredential(new DefaultAzureCredentialOptions { AuthorityHost = AzureAuthorityHosts.AzureGovernment });
|
||||
```
|
||||
|
||||
Not all credentials require this configuration. Credentials which authenticate through a development tool, such as `AzureCliCredential`, use that tool's configuration.
|
||||
|
||||
## Credential classes
|
||||
|
||||
### Authenticate Azure-hosted applications
|
||||
|
||||
|Credential | Usage
|
||||
|-|-
|
||||
|[`DefaultAzureCredential`][ref_DefaultAzureCredential]|Provides a simplified authentication experience to quickly start developing applications run in Azure.
|
||||
|[`ChainedTokenCredential`][ref_ChainedTokenCredential]|Allows users to define custom authentication flows composing multiple credentials.
|
||||
|[`EnvironmentCredential`][ref_EnvironmentCredential]|Authenticates a service principal or user via credential information specified in environment variables.
|
||||
|[`ManagedIdentityCredential`][ref_ManagedIdentityCredential]|Authenticates the managed identity of an Azure resource.
|
||||
|[`WorkloadIdentityCredential`][ref_WorkloadIdentityCredential]|Supports [Microsoft Entra Workload ID](https://learn.microsoft.com/azure/aks/workload-identity-overview) on Kubernetes.
|
||||
|
||||
### Authenticate service principals
|
||||
|
||||
|Credential | Usage | Reference
|
||||
|-|-|-
|
||||
|[`ClientAssertionCredential`][ref_ClientAssertionCredential]|Authenticates a service principal using a signed client assertion. |
|
||||
|[`ClientCertificateCredential`][ref_ClientCertificateCredential]|Authenticates a service principal using a certificate. | [Service principal authentication](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals)
|
||||
|[`ClientSecretCredential`][ref_ClientSecretCredential]|Authenticates a service principal using a secret. | [Service principal authentication](https://learn.microsoft.com/entra/identity-platform/app-objects-and-service-principals)
|
||||
|
||||
### Authenticate users
|
||||
|
||||
|Credential | Usage | Reference
|
||||
|-|-|-
|
||||
|[`AuthorizationCodeCredential`][ref_AuthorizationCodeCredential]|Authenticates a user with a previously obtained authorization code. | [OAuth2 authentication code](https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow)
|
||||
|[`DeviceCodeCredential`][ref_DeviceCodeCredential]|Interactively authenticates a user on devices with limited UI. | [Device code authentication](https://learn.microsoft.com/entra/identity-platform/v2-oauth2-device-code)
|
||||
|[`InteractiveBrowserCredential`][ref_InteractiveBrowserCredential]|Interactively authenticates a user with the default system browser. | [OAuth2 authentication code](https://learn.microsoft.com/entra/identity-platform/v2-oauth2-auth-code-flow)
|
||||
|[`OnBehalfOfCredential`][ref_OnBehalfOfCredential]|Propagates the delegated user identity and permissions through the request chain. | [On-behalf-of authentication](https://learn.microsoft.com/entra/identity-platform/v2-oauth2-on-behalf-of-flow)
|
||||
|[`UsernamePasswordCredential`][ref_UsernamePasswordCredential]|Authenticates a user with a username and password. | [Username + password authentication](https://learn.microsoft.com/entra/identity-platform/v2-oauth-ropc)
|
||||
|
||||
### Authenticate via development tools
|
||||
|
||||
|Credential | Usage | Reference
|
||||
|-|-|-
|
||||
|[`AzureCliCredential`][ref_AzureCliCredential]|Authenticates in a development environment with the Azure CLI. | [Azure CLI authentication](https://learn.microsoft.com/cli/azure/authenticate-azure-cli)
|
||||
|[`AzureDeveloperCliCredential`][ref_AzureDeveloperCliCredential]|Authenticates in a development environment with the Azure Developer CLI. | [Azure Developer CLI Reference](https://learn.microsoft.com/azure/developer/azure-developer-cli/reference)
|
||||
|[`AzurePowerShellCredential`][ref_AzurePowerShellCredential]|Authenticates in a development environment with the Azure PowerShell. | [Azure PowerShell authentication](https://learn.microsoft.com/powershell/azure/authenticate-azureps)
|
||||
|[`VisualStudioCredential`][ref_VisualStudioCredential]|Authenticates in a development environment with Visual Studio. | [Visual Studio configuration](https://learn.microsoft.com/dotnet/azure/configure-visual-studio)
|
||||
|[`VisualStudioCodeCredential`][ref_VisualStudioCodeCredential]| Authenticates as the user signed in to the Visual Studio Code Azure Account extension. | [VS Code Azure Account extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.azure-account)
|
||||
|
||||
> __Note:__ All credential implementations in the Azure Identity library are threadsafe, and a single credential instance can be used by multiple service clients.
|
||||
|
||||
## Environment variables
|
||||
|
||||
[`DefaultAzureCredential`][ref_DefaultAzureCredential] and [`EnvironmentCredential`][ref_EnvironmentCredential] can be configured with environment variables. Each type of authentication requires values for specific variables:
|
||||
|
||||
### Service principal with secret
|
||||
|
||||
|Variable name|Value
|
||||
|-|-
|
||||
|`AZURE_CLIENT_ID`|ID of a Microsoft Entra application
|
||||
|`AZURE_TENANT_ID`|ID of the application's Microsoft Entra tenant
|
||||
|`AZURE_CLIENT_SECRET`|one of the application's client secrets
|
||||
|
||||
### Service principal with certificate
|
||||
|
||||
|variable name|Value
|
||||
|-|-
|
||||
|`AZURE_CLIENT_ID`|ID of a Microsoft Entra application
|
||||
|`AZURE_TENANT_ID`|ID of the application's Microsoft Entra tenant
|
||||
|`AZURE_CLIENT_CERTIFICATE_PATH`|path to a PFX or PEM-encoded certificate file including private key
|
||||
|`AZURE_CLIENT_CERTIFICATE_PASSWORD`|(optional) the password protecting the certificate file (currently only supported for PFX (PKCS12) certificates)
|
||||
|`AZURE_CLIENT_SEND_CERTIFICATE_CHAIN`|(optional) send certificate chain in x5c header to support subject name / issuer based authentication
|
||||
|
||||
### Username and password
|
||||
|
||||
|Variable name|Value
|
||||
|-|-
|
||||
|`AZURE_CLIENT_ID`|ID of a Microsoft Entra application
|
||||
|`AZURE_TENANT_ID`|ID of the application's Microsoft Entra tenant
|
||||
|`AZURE_USERNAME`|a username (usually an email address)
|
||||
|`AZURE_PASSWORD`|that user's password
|
||||
|
||||
### Managed identity (`DefaultAzureCredential`)
|
||||
|
||||
|Variable name|Value
|
||||
|-|-
|
||||
|`AZURE_CLIENT_ID`|The client ID for the user-assigned managed identity. If defined, used as the default value for `ManagedIdentityClientId` in `DefaultAzureCredentialOptions`
|
||||
|
||||
Configuration is attempted in the above order. For example, if values for a
|
||||
client secret and certificate are both present, the client secret will be used.
|
||||
|
||||
## Continuous Access Evaluation
|
||||
|
||||
As of version 1.10.0, accessing resources protected by [Continuous Access Evaluation (CAE)][cae] is possible on a per-request basis. This behavior can be enabled by setting the `IsCaeEnabled` property of `TokenRequestContext` via its constructor. CAE isn't supported for developer and managed identity credentials.
|
||||
|
||||
|
||||
## Token caching
|
||||
|
||||
Token caching is a feature provided by the Azure Identity library that allows apps to:
|
||||
|
||||
* Cache tokens in memory (default) or on disk (opt-in).
|
||||
* Improve resilience and performance.
|
||||
* Reduce the number of requests made to Microsoft Entra ID to obtain access tokens.
|
||||
|
||||
The Azure Identity library offers both in-memory and persistent disk caching. For more details, see the [token caching documentation](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/samples/TokenCache.md)
|
||||
|
||||
# Brokered Authentication
|
||||
|
||||
An authentication broker is an application that runs on a user’s machine and manages the authentication handshakes and token maintenance for connected accounts. Currently, only the Windows Web Account Manager (WAM) is supported. To enable support, use the `Azure.Identity.Broker` package. For details on authenticating using WAM, see the [broker package documentation](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity.Broker/README.md).
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
See the [troubleshooting guide](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/identity/Azure.Identity/TROUBLESHOOTING.md) for details on how to diagnose various failure scenarios.
|
||||
|
||||
### Error handling
|
||||
|
||||
Errors arising from authentication can be raised on any service client method which makes a request to the service. This is because the first time the token is requested from the credential is on the first call to the service, and any subsequent calls might need to refresh the token. In order to distinguish these failures from failures in the service client Azure Identity classes raise the `AuthenticationFailedException` with details to the source of the error in the exception message as well as possibly the error message. Depending on the application these errors may or may not be recoverable.
|
||||
|
||||
``` c#
|
||||
using Azure.Identity;
|
||||
using Azure.Security.KeyVault.Secrets;
|
||||
|
||||
// Create a secret client using the DefaultAzureCredential
|
||||
var client = new SecretClient(new Uri("https://myvault.vault.azure.net/"), new DefaultAzureCredential());
|
||||
|
||||
try
|
||||
{
|
||||
KeyVaultSecret secret = await client.GetSecretAsync("secret1");
|
||||
}
|
||||
catch (AuthenticationFailedException e)
|
||||
{
|
||||
Console.WriteLine($"Authentication Failed. {e.Message}");
|
||||
}
|
||||
```
|
||||
|
||||
For more information on dealing with errors arising from failed requests to Microsoft Entra ID or managed identity endpoints, see the Microsoft Entra ID [documentation on authorization error codes][entraid_err_doc].
|
||||
|
||||
### Logging
|
||||
|
||||
The Azure Identity library provides the same [logging capabilities](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md#logging) as the rest of the Azure SDK.
|
||||
|
||||
The simplest way to see the logs to help debug authentication issues is to enable the console logging.
|
||||
|
||||
``` c#
|
||||
// Setup a listener to monitor logged events.
|
||||
using AzureEventSourceListener listener = AzureEventSourceListener.CreateConsoleLogger();
|
||||
```
|
||||
|
||||
All credentials can be configured with diagnostic options, in the same way as other clients in the SDK.
|
||||
|
||||
> **CAUTION:** Requests and responses in the Azure Identity library contain sensitive information. Precaution must be taken to protect logs, when customizing the output, to avoid compromising account security.
|
||||
|
||||
``` c#
|
||||
DefaultAzureCredentialOptions options = new DefaultAzureCredentialOptions
|
||||
{
|
||||
Diagnostics =
|
||||
{
|
||||
LoggedHeaderNames = { "x-ms-request-id" },
|
||||
LoggedQueryParameters = { "api-version" },
|
||||
IsLoggingContentEnabled = true
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
When troubleshooting authentication issues, you may also want to enable logging of sensitive information. To enable this type of logging, set the `IsLoggingContentEnabled` property to `true`. To only log details about the account that was used to attempt authentication and authorization, set `IsAccountIdentifierLoggingEnabled` to `true`.
|
||||
|
||||
```c#
|
||||
DefaultAzureCredentialOptions options = new DefaultAzureCredentialOptions
|
||||
{
|
||||
Diagnostics =
|
||||
{
|
||||
LoggedHeaderNames = { "x-ms-request-id" },
|
||||
LoggedQueryParameters = { "api-version" },
|
||||
IsAccountIdentifierLoggingEnabled = true
|
||||
}
|
||||
};
|
||||
```
|
||||
|
||||
### Thread safety
|
||||
|
||||
We guarantee that all credential instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)).
|
||||
This ensures that the recommendation of reusing credential instances is always safe, even across threads.
|
||||
|
||||
### Additional concepts
|
||||
|
||||
[Client options](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) |
|
||||
[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) |
|
||||
[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/samples/Diagnostics.md) |
|
||||
[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/master/sdk/core/Azure.Core/README.md#mocking) |
|
||||
[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/)
|
||||
|
||||
## Next steps
|
||||
|
||||
### Client libraries supporting authentication with Azure Identity
|
||||
|
||||
Many of the client libraries listed [here](https://azure.github.io/azure-sdk/releases/latest/dotnet.html) support authenticating with `TokenCredential` and the Azure Identity library.
|
||||
There you will also find links where you can learn more about their use, including additional documentation and samples.
|
||||
|
||||
### Known Issues
|
||||
|
||||
This library doesn't currently support scenarios relating to the [Azure AD B2C](https://learn.microsoft.com/azure/active-directory-b2c/overview) service.
|
||||
|
||||
Open issues for the `Azure.Identity` library can be found [here](https://github.com/Azure/azure-sdk-for-net/issues?q=is%3Aissue+is%3Aopen+label%3AAzure.Identity).
|
||||
|
||||
## Contributing
|
||||
|
||||
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.
|
||||
|
||||
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide 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.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct][code_of_conduct]. For more information see the [Code of Conduct FAQ][code_of_conduct_faq] or contact opencode@microsoft.com with any additional questions or comments.
|
||||
|
||||
|
||||
[azure_cli]: https://learn.microsoft.com/cli/azure
|
||||
[azure_developer_cli]:https://aka.ms/azure-dev
|
||||
[azure_powerShell]: https://learn.microsoft.com/powershell/azure
|
||||
[azure_sub]: https://azure.microsoft.com/free/dotnet/
|
||||
[source]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity/src
|
||||
[package]: https://www.nuget.org/packages/Azure.Identity
|
||||
[entraid_doc]: https://learn.microsoft.com/entra/identity/
|
||||
[entraid_err_doc]: https://learn.microsoft.com/entra/identity-platform/reference-error-codes
|
||||
[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
|
||||
[code_of_conduct_faq]: https://opensource.microsoft.com/codeofconduct/faq/
|
||||
[nuget]: https://www.nuget.org/
|
||||
[secrets_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/keyvault/Azure.Security.KeyVault.Secrets
|
||||
[blobs_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/storage/Azure.Storage.Blobs
|
||||
[eventhubs_client_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/eventhub/Azure.Messaging.EventHubs
|
||||
[azure_core_library]: https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/core/Azure.Core
|
||||
[identity_api_docs]: https://learn.microsoft.com/dotnet/api/azure.identity?view=azure-dotnet
|
||||
[vs_login_image]: https://raw.githubusercontent.com/Azure/azure-sdk-for-net/main/sdk/identity/Azure.Identity/images/VsLoginDialog.png
|
||||
[azure_cli_login_image]: https://raw.githubusercontent.com/Azure/azure-sdk-for-net/main/sdk/identity/Azure.Identity/images/AzureCliLogin.png
|
||||
[azure_cli_login_device_code_image]: https://raw.githubusercontent.com/Azure/azure-sdk-for-net/main/sdk/identity/Azure.Identity/images/AzureCliLoginDeviceCode.png
|
||||
[default_azure_credential_authflow_image]: https://raw.githubusercontent.com/Azure/azure-sdk-for-net/main/sdk/identity/Azure.Identity/images/mermaidjs/DefaultAzureCredentialAuthFlow.svg
|
||||
[ref_AuthorizationCodeCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.authorizationcodecredential?view=azure-dotnet
|
||||
[ref_AzureCliCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.azureclicredential?view=azure-dotnet
|
||||
[ref_AzureDeveloperCliCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.azuredeveloperclicredential?view=azure-dotnet
|
||||
[ref_AzurePowerShellCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.azurepowershellcredential?view=azure-dotnet
|
||||
[ref_ChainedTokenCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.chainedtokencredential?view=azure-dotnet
|
||||
[ref_ClientAssertionCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.clientassertioncredential?view=azure-dotnet
|
||||
[ref_ClientCertificateCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.clientcertificatecredential?view=azure-dotnet
|
||||
[ref_ClientSecretCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.clientsecretcredential?view=azure-dotnet
|
||||
[ref_DefaultAzureCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.defaultazurecredential?view=azure-dotnet
|
||||
[ref_DeviceCodeCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.devicecodecredential?view=azure-dotnet
|
||||
[ref_EnvironmentCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.environmentcredential?view=azure-dotnet
|
||||
[ref_InteractiveBrowserCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.interactivebrowsercredential?view=azure-dotnet
|
||||
[ref_ManagedIdentityCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.managedidentitycredential?view=azure-dotnet
|
||||
[ref_OnBehalfOfCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.onbehalfofcredential?view=azure-dotnet
|
||||
[ref_UsernamePasswordCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.usernamepasswordcredential?view=azure-dotnet
|
||||
[ref_VisualStudioCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.visualstudiocredential?view=azure-dotnet
|
||||
[ref_VisualStudioCodeCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.visualstudiocodecredential?view=azure-dotnet
|
||||
[ref_WorkloadIdentityCredential]: https://learn.microsoft.com/dotnet/api/azure.identity.workloadidentitycredential?view=azure-dotnet
|
||||
[cae]: https://learn.microsoft.com/entra/identity/conditional-access/concept-continuous-access-evaluation
|
||||
BIN
test2/packages/Azure.Identity.1.11.4/azureicon.png
vendored
Normal file
BIN
test2/packages/Azure.Identity.1.11.4/azureicon.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 3.5 KiB |
BIN
test2/packages/Azure.Identity.1.11.4/lib/netstandard2.0/Azure.Identity.dll
vendored
Normal file
BIN
test2/packages/Azure.Identity.1.11.4/lib/netstandard2.0/Azure.Identity.dll
vendored
Normal file
Binary file not shown.
3339
test2/packages/Azure.Identity.1.11.4/lib/netstandard2.0/Azure.Identity.xml
vendored
Normal file
3339
test2/packages/Azure.Identity.1.11.4/lib/netstandard2.0/Azure.Identity.xml
vendored
Normal file
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user