Skip to content

Commit acf795f

Browse files
authored
[Identity] Hide dev credential timeout API for 1.8.0 release (Azure#31788)
* [Identity] Hide dev credential timeout API for 1.8.0 release * update API spec * update changelog for release
1 parent 8b07647 commit acf795f

File tree

6 files changed

+5
-24
lines changed

6 files changed

+5
-24
lines changed

sdk/identity/Azure.Identity/CHANGELOG.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,14 @@
11
# Release History
22

3-
## 1.8.0-beta.1 (Unreleased)
3+
## 1.8.0-beta.1 (2022-10-13)
44

55
### Features Added
6-
- 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:
7-
- `AzureCliCredential` and `AzureCliCredentialOptions.CliProcessTimeout`
8-
- `AzurePowerShellCredential` and `AzurePowerShellCredentialOptions.PowerShellProcessTimeout`
9-
- `VisualStudioCredential` and `VisualStudioCredentialOptions.VisualStudioProcessTimeout`
10-
- `DefaultAzureCredential` and `DefaultAzureCredentialOptions.DeveloperCredentialTimeout` Note: this option applies to all developer credentials above when using `DefaultAzureCredential`.
116
- Reintroduced `ManagedIdentityCredential` token caching support from 1.7.0-beta.1
127
- `EnvironmentCredential` updated to support specifying a certificate password via the `AZURE_CLIENT_CERTIFICATE_PASSWORD` environment variable
138

149
### Breaking Changes
1510
- 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/).
1611

17-
### Bugs Fixed
18-
19-
### Other Changes
20-
21-
### Acknowledgments
22-
23-
Thank you to our developer community members who helped to make Azure Identity better with their contributions to this release:
24-
25-
- _[reynaldoburgos](https://github.com/reynaldoburgos)_
26-
2712
## 1.7.0 (2022-09-19)
2813

2914
### Features Added

sdk/identity/Azure.Identity/api/Azure.Identity.netstandard2.0.cs

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ public partial class AzureCliCredentialOptions : Azure.Identity.TokenCredentialO
6060
{
6161
public AzureCliCredentialOptions() { }
6262
public System.Collections.Generic.IList<string> AdditionallyAllowedTenants { get { throw null; } }
63-
public System.TimeSpan? CliProcessTimeout { get { throw null; } set { } }
6463
public string TenantId { get { throw null; } set { } }
6564
}
6665
public partial class AzurePowerShellCredential : Azure.Core.TokenCredential
@@ -74,7 +73,6 @@ public partial class AzurePowerShellCredentialOptions : Azure.Identity.TokenCred
7473
{
7574
public AzurePowerShellCredentialOptions() { }
7675
public System.Collections.Generic.IList<string> AdditionallyAllowedTenants { get { throw null; } }
77-
public System.TimeSpan? PowerShellProcessTimeout { get { throw null; } set { } }
7876
public string TenantId { get { throw null; } set { } }
7977
}
8078
public partial class ChainedTokenCredential : Azure.Core.TokenCredential
@@ -149,7 +147,6 @@ public partial class DefaultAzureCredentialOptions : Azure.Identity.TokenCredent
149147
{
150148
public DefaultAzureCredentialOptions() { }
151149
public System.Collections.Generic.IList<string> AdditionallyAllowedTenants { get { throw null; } }
152-
public System.TimeSpan? DeveloperCredentialTimeout { get { throw null; } set { } }
153150
public bool ExcludeAzureCliCredential { get { throw null; } set { } }
154151
public bool ExcludeAzurePowerShellCredential { get { throw null; } set { } }
155152
public bool ExcludeEnvironmentCredential { get { throw null; } set { } }
@@ -381,6 +378,5 @@ public partial class VisualStudioCredentialOptions : Azure.Identity.TokenCredent
381378
public VisualStudioCredentialOptions() { }
382379
public System.Collections.Generic.IList<string> AdditionallyAllowedTenants { get { throw null; } }
383380
public string TenantId { get { throw null; } set { } }
384-
public System.TimeSpan? VisualStudioProcessTimeout { get { throw null; } set { } }
385381
}
386382
}

sdk/identity/Azure.Identity/src/Credentials/AzureCliCredentialOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ public class AzureCliCredentialOptions : TokenCredentialOptions
2626
/// <summary>
2727
/// The Cli process timeout.
2828
/// </summary>
29-
public TimeSpan? CliProcessTimeout { get; set; }
29+
internal TimeSpan? CliProcessTimeout { get; set; }
3030
}
3131
}

sdk/identity/Azure.Identity/src/Credentials/AzurePowerShellCredentialOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ public class AzurePowerShellCredentialOptions : TokenCredentialOptions
2626
/// <summary>
2727
/// The Powershell process timeout.
2828
/// </summary>
29-
public TimeSpan? PowerShellProcessTimeout { get; set; } = TimeSpan.FromSeconds(10);
29+
internal TimeSpan? PowerShellProcessTimeout { get; set; } = TimeSpan.FromSeconds(10);
3030
}
3131
}

sdk/identity/Azure.Identity/src/Credentials/DefaultAzureCredentialOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ public string VisualStudioCodeTenantId
198198
/// <summary>
199199
/// Specifies timeout for Developer credentials. e.g. Visual Studio, Azure CLI, Azure Powershell.
200200
/// </summary>
201-
public TimeSpan? DeveloperCredentialTimeout { get; set; } = TimeSpan.FromSeconds(30);
201+
internal TimeSpan? DeveloperCredentialTimeout { get; set; } = TimeSpan.FromSeconds(30);
202202

203203
/// <summary>
204204
/// Specifies whether the <see cref="EnvironmentCredential"/> will be excluded from the authentication flow. Setting to true disables reading

sdk/identity/Azure.Identity/src/Credentials/VisualStudioCredentialOptions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ public string TenantId
3232
/// <summary>
3333
/// The VisualStudio process timeout.
3434
/// </summary>
35-
public TimeSpan? VisualStudioProcessTimeout { get; set; }
35+
internal TimeSpan? VisualStudioProcessTimeout { get; set; }
3636
}
3737
}

0 commit comments

Comments
 (0)