Apply ClientOptions analyzers to client libraries. (#6915)

Azure · Jul 16, 2019 · 9dea72e · 9dea72e
1 parent 369ea8e
commit 9dea72e
Show file tree

Hide file tree

Showing 8 changed files with 192 additions and 3 deletions.
diff --git a/eng/Packages.Data.props b/eng/Packages.Data.props
@@ -9,7 +9,7 @@
   <ItemGroup>
     <PackageReference Update="ApprovalTests" Version="3.0.22" />
     <PackageReference Update="ApprovalUtilities" Version="3.0.22" />
-    <PackageReference Update="Azure.ClientSdk.Analyzers" Version="0.1.1-dev.20190503.1" />
+    <PackageReference Update="Azure.ClientSdk.Analyzers" Version="0.1.1-dev.20190711.4" />
     <PackageReference Update="Azure.Core" Version="1.0.0-preview.6" />
     <PackageReference Update="BenchmarkDotNet" Version="0.11.5" />
     <PackageReference Update="FsCheck.Xunit" Version="2.14.0" />

diff --git a/sdk/appconfiguration/Azure.ApplicationModel.Configuration/src/ConfigurationClientOptions.cs b/sdk/appconfiguration/Azure.ApplicationModel.Configuration/src/ConfigurationClientOptions.cs
@@ -10,5 +10,36 @@ namespace Azure.ApplicationModel.Configuration
     /// </summary>
     public class ConfigurationClientOptions: ClientOptions
     {
+        /// <summary>
+        /// The latest service version supported by this client library.
+        /// </summary>
+        internal const ServiceVersion LatestVersion = ServiceVersion.Default;
+
+        /// <summary>
+        /// The versions of App Config Service supported by this client library.
+        /// </summary>
+        public enum ServiceVersion
+        {
+            Default = 0
+        }
+
+        /// <summary>
+        /// Gets the <see cref="ServiceVersion"/> of the service API used when
+        /// making requests.
+        /// </summary>
+        public ServiceVersion Version { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="ConfigurationClientOptions"/>
+        /// class.
+        /// </summary>
+        /// <param name="version">
+        /// The <see cref="ServiceVersion"/> of the service API used when
+        /// making requests. 
+        /// </param>
+        public ConfigurationClientOptions(ServiceVersion version = ServiceVersion.Default)
+        {
+            this.Version = version;
+        }
     }
 }
diff --git a/sdk/keyvault/Azure.Security.KeyVault.Certificates/src/CertificateClientOptions.cs b/sdk/keyvault/Azure.Security.KeyVault.Certificates/src/CertificateClientOptions.cs
@@ -8,5 +8,45 @@ namespace Azure.Security.KeyVault.Certificates
 {
     public class CertificateClientOptions : ClientOptions
     {
+        /// <summary>
+        /// The latest service version supported by this client library.
+        /// For more information, see 
+        /// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>
+        /// </summary>
+        internal const ServiceVersion LatestVersion = ServiceVersion.V7_0;
+
+        /// <summary>
+        /// The versions of Azure Key Vault supported by this client
+        /// library. 
+        /// </summary>
+        public enum ServiceVersion
+        {
+#pragma warning disable CA1707 // Identifiers should not contain underscores
+            /// <summary>
+            /// The Key Vault API version 7.0.
+            /// </summary>
+            V7_0 = 0
+#pragma warning restore CA1707 // Identifiers should not contain underscores
+        }
+
+        /// <summary>
+        /// Gets the <see cref="ServiceVersion"/> of the service API used when
+        /// making requests. For more information, see 
+        /// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>
+        /// </summary>
+        public ServiceVersion Version { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="CertificateClientOptions"/>
+        /// class.
+        /// </summary>
+        /// <param name="version">
+        /// The <see cref="ServiceVersion"/> of the service API used when
+        /// making requests.
+        /// </param>
+        public CertificateClientOptions(ServiceVersion version = ServiceVersion.V7_0)
+        {
+            this.Version = version;
+        }
     }
 }
diff --git a/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClient.cs b/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClient.cs
@@ -51,6 +51,7 @@ public KeyClient(Uri vaultUri, TokenCredential credential, KeyClientOptions opti
         {
             _vaultUri = vaultUri ?? throw new ArgumentNullException(nameof(credential));
             options = options ?? new KeyClientOptions();
+            this.ApiVersion = options.GetVersionString();
 
             _pipeline = HttpPipelineBuilder.Build(options,
                     bufferResponse: true,

diff --git a/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientOptions.cs b/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClientOptions.cs
@@ -3,6 +3,7 @@
 // license information.
 
 using Azure.Core.Pipeline;
+using System;
 
 namespace Azure.Security.KeyVault.Keys
 {
@@ -11,5 +12,62 @@ namespace Azure.Security.KeyVault.Keys
     /// </summary>
     public class KeyClientOptions : ClientOptions
     {
+        /// <summary>
+        /// The latest service version supported by this client library.
+        /// For more information, see 
+        /// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>
+        /// </summary>
+        internal const ServiceVersion LatestVersion = ServiceVersion.V7_0;
+
+        /// <summary>
+        /// The versions of Azure Key Vault supported by this client
+        /// library. 
+        /// </summary>
+        public enum ServiceVersion
+        {
+#pragma warning disable CA1707 // Identifiers should not contain underscores
+            /// <summary>
+            /// The Key Vault API version 7.0.
+            /// </summary>
+            V7_0 = 0
+#pragma warning restore CA1707 // Identifiers should not contain underscores
+        }
+
+        /// <summary>
+        /// Gets the <see cref="ServiceVersion"/> of the service API used when
+        /// making requests. For more information, see 
+        /// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>
+        /// </summary>
+        public ServiceVersion Version { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="KeyClientOptions"/>
+        /// class.
+        /// </summary>
+        /// <param name="version">
+        /// The <see cref="ServiceVersion"/> of the service API used when
+        /// making requests. 
+        /// </param>
+        public KeyClientOptions(ServiceVersion version = ServiceVersion.V7_0)
+        {
+            this.Version = version;
+        }
+
+        internal string GetVersionString()
+        {
+            var version = string.Empty;
+
+            switch (this.Version)
+            {
+                case ServiceVersion.V7_0:
+                    version = "7.0";
+                    break;
+
+                default:
+                    throw new ArgumentException(this.Version.ToString());
+            }
+
+            return version;
+        }
     }
 }
diff --git a/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClient_private.cs b/sdk/keyvault/Azure.Security.KeyVault.Keys/src/KeyClient_private.cs
@@ -9,9 +9,9 @@ namespace Azure.Security.KeyVault.Keys
 {
     public partial class KeyClient
     {
-        private const string ApiVersion = "7.0";
         private const string KeysPath = "/keys/";
         private const string DeletedKeysPath = "/deletedkeys/";
+        private readonly string ApiVersion;
 
         private async Task<Response<TResult>> SendRequestAsync<TContent, TResult>(RequestMethod method, TContent content, Func<TResult> resultFactory, CancellationToken cancellationToken, params string[] path)
             where TContent : Model

diff --git a/sdk/keyvault/Azure.Security.KeyVault.Secrets/src/SecretClient.cs b/sdk/keyvault/Azure.Security.KeyVault.Secrets/src/SecretClient.cs
@@ -21,7 +21,7 @@ namespace Azure.Security.KeyVault.Secrets
     public class SecretClient
     {
         private readonly Uri _vaultUri;
-        private const string ApiVersion = "7.0";
+        private readonly string ApiVersion;
         private readonly HttpPipeline _pipeline;
 
         private const string SecretsPath = "/secrets/";
@@ -56,6 +56,7 @@ public SecretClient(Uri vaultUri, TokenCredential credential, SecretClientOption
         {
             _vaultUri = vaultUri ?? throw new ArgumentNullException(nameof(credential));
             options = options ?? new SecretClientOptions();
+            this.ApiVersion = options.GetVersionString();
 
             _pipeline = HttpPipelineBuilder.Build(options,
                     bufferResponse: true,

diff --git a/sdk/keyvault/Azure.Security.KeyVault.Secrets/src/SecretClientOptions.cs b/sdk/keyvault/Azure.Security.KeyVault.Secrets/src/SecretClientOptions.cs
@@ -3,6 +3,7 @@
 // license information.
 
 using Azure.Core.Pipeline;
+using System;
 
 namespace Azure.Security.KeyVault.Secrets
 {
@@ -11,5 +12,62 @@ namespace Azure.Security.KeyVault.Secrets
     /// </summary>
     public class SecretClientOptions : ClientOptions
     {
+        /// <summary>
+        /// The latest service version supported by this client library.
+        /// For more information, see 
+        /// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>
+        /// </summary>
+        internal const ServiceVersion LatestVersion = ServiceVersion.V7_0;
+
+        /// <summary>
+        /// The versions of Azure Key Vault supported by this client
+        /// library. 
+        /// </summary>
+        public enum ServiceVersion
+        {
+#pragma warning disable CA1707 // Identifiers should not contain underscores
+            /// <summary>
+            /// The Key Vault API version 7.0.
+            /// </summary>
+            V7_0 = 0
+#pragma warning restore CA1707 // Identifiers should not contain underscores
+        }
+
+        /// <summary>
+        /// Gets the <see cref="ServiceVersion"/> of the service API used when
+        /// making requests. For more information, see 
+        /// <see href="https://docs.microsoft.com/en-us/rest/api/keyvault/key-vault-versions"/>
+        /// </summary>
+        public ServiceVersion Version { get; }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="SecretClientOptions"/>
+        /// class.
+        /// </summary>
+        /// <param name="version">
+        /// The <see cref="ServiceVersion"/> of the service API used when
+        /// making requests. 
+        /// </param>
+        public SecretClientOptions(ServiceVersion version = ServiceVersion.V7_0)
+        {
+            this.Version = version;
+        }
+
+        internal string GetVersionString()
+        {
+            var version = string.Empty;
+
+            switch (this.Version)
+            {
+                case ServiceVersion.V7_0:
+                    version = "7.0";
+                    break;
+
+                default:
+                    throw new ArgumentException(this.Version.ToString());
+            }
+
+            return version;
+        }
     }
 }