diff --git a/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/CHANGELOG.md b/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/CHANGELOG.md index 9ad47baa79f2c..4d7e41a4dbc3c 100644 --- a/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/CHANGELOG.md +++ b/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/CHANGELOG.md @@ -5,6 +5,10 @@ ### New Features - Added support for AAD authentication in `MetricsAdvisorClient` and `MetricsAdvisorAdministrationClient`. +### Breaking Changes +- In `MetricsAdvisorKeyCredential`, renamed the parameter `key` to `subscriptionKey` in the method `UpdateSubscriptionKey`. +- In `MetricsAdvisorKeyCredential`, renamed the parameter `key` to `apiKey` in the method `UpdateApiKey`. + ### Key Bug Fixes - Fixed a bug in which setting `WebNotificationHook.CertificatePassword` would actually set the property `Username` instead. - Fixed a bug in which an `ArgumentNullException` was thrown when getting a `DataFeed` from the service as a Viewer. diff --git a/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/api/Azure.AI.MetricsAdvisor.netstandard2.0.cs b/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/api/Azure.AI.MetricsAdvisor.netstandard2.0.cs index f75951db6a044..bccbc255c8c6f 100644 --- a/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/api/Azure.AI.MetricsAdvisor.netstandard2.0.cs +++ b/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/api/Azure.AI.MetricsAdvisor.netstandard2.0.cs @@ -216,8 +216,8 @@ public enum ServiceVersion public partial class MetricsAdvisorKeyCredential { public MetricsAdvisorKeyCredential(string subscriptionKey, string apiKey) { } - public void UpdateApiKey(string key) { } - public void UpdateSubscriptionKey(string key) { } + public void UpdateApiKey(string apiKey) { } + public void UpdateSubscriptionKey(string subscriptionKey) { } } } namespace Azure.AI.MetricsAdvisor.Administration diff --git a/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/src/MetricsAdvisorKeyCredential.cs b/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/src/MetricsAdvisorKeyCredential.cs index b7ce4b75343e9..a8139bb1b3947 100644 --- a/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/src/MetricsAdvisorKeyCredential.cs +++ b/sdk/metricsadvisor/Azure.AI.MetricsAdvisor/src/MetricsAdvisorKeyCredential.cs @@ -20,8 +20,8 @@ public class MetricsAdvisorKeyCredential /// /// Initializes a new instance of the class. /// - /// Key to use to authenticate with the Azure service. - /// Key to use to authenticate the user with the Metrics Advisor service. Used to identify administrators. + /// The subscription key to use to authenticate with the Azure service. + /// The API key to use to authenticate the user with the Metrics Advisor service. Used to identify administrators. /// or is null. /// or is empty. public MetricsAdvisorKeyCredential(string subscriptionKey, string apiKey) @@ -43,29 +43,29 @@ internal string ApiKey } /// - /// Updates the service key. This is intended to be used when you've regenerated - /// your service key and want to update long lived clients. + /// Updates the subscription key. This is intended to be used when you've regenerated + /// your subscription key and want to update long lived clients. /// - /// Key to authenticate the service against. - /// is null. - /// is empty. - public void UpdateSubscriptionKey(string key) + /// The subscription key to authenticate the service against. + /// is null. + /// is empty. + public void UpdateSubscriptionKey(string subscriptionKey) { - Argument.AssertNotNullOrEmpty(key, nameof(key)); - SubscriptionKey = key; + Argument.AssertNotNullOrEmpty(subscriptionKey, nameof(subscriptionKey)); + SubscriptionKey = subscriptionKey; } /// /// Updates the API key. This is intended to be used when you've regenerated your /// API key and want to update long lived clients. /// - /// Key to use to authenticate the user with the Metrics Advisor service. Used to identify administrators. - /// is null. - /// is empty. - public void UpdateApiKey(string key) + /// The API key to use to authenticate the user with the Metrics Advisor service. Used to identify administrators. + /// is null. + /// is empty. + public void UpdateApiKey(string apiKey) { - Argument.AssertNotNullOrEmpty(key, nameof(key)); - ApiKey = key; + Argument.AssertNotNullOrEmpty(apiKey, nameof(apiKey)); + ApiKey = apiKey; } } }