add default value 'api-key' for --credential-key-header-name

autorest/codegen/__init__.py

@@ -173,9 +173,9 @@ def _get_credential_param(self, azure_arm, credential, credential_default_policy
                     "--credential-key-header-name."
                 )
             if not credential_key_header_name:
-                raise ValueError(
-                    "With default credential policy type AzureKeyCredentialPolicy, you must pass in the name "
-                    "of the key header with the flag --credential-key-header-name"
+                credential_key_header_name = "api-key"
+                _LOGGER.info(
+                    "Defaulting the AzureKeyCredentialPolicy header's name to 'api-key'"
                 )
         return credential_scopes, credential_key_header_name
 

test/multiapi/AcceptanceTests/asynctests/test_multiapi_credential_default_policy.py

@@ -40,4 +40,4 @@ async def default_client(credential, authentication_policy):
 def test_multiapi_credential_default_policy_type(default_client):
     # making sure that the authentication policy is AzureKeyCredentialPolicy
     assert isinstance(default_client._config.authentication_policy, AzureKeyCredentialPolicy)
-    assert default_client._config.authentication_policy._name == "Authorization"
+    assert default_client._config.authentication_policy._name == "api-key"

test/multiapi/AcceptanceTests/test_multiapi_credential_default_policy.py

@@ -38,4 +38,4 @@ def default_client(authentication_policy):
 def test_multiapi_credential_default_policy_type(default_client):
     # making sure that the authentication policy is AzureKeyCredentialPolicy
     assert isinstance(default_client._config.authentication_policy, AzureKeyCredentialPolicy)
-    assert default_client._config.authentication_policy._name == "Authorization"
+    assert default_client._config.authentication_policy._name == "api-key"

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/_configuration.py

@@ -61,4 +61,4 @@ def _configure(
         self.redirect_policy = kwargs.get('redirect_policy') or policies.RedirectPolicy(**kwargs)
         self.authentication_policy = kwargs.get('authentication_policy')
         if self.credential and not self.authentication_policy:
-            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'Authorization', **kwargs)
+            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'api-key', **kwargs)

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/aio/_configuration.py

@@ -54,4 +54,4 @@ def _configure(
         self.redirect_policy = kwargs.get('redirect_policy') or policies.AsyncRedirectPolicy(**kwargs)
         self.authentication_policy = kwargs.get('authentication_policy')
         if self.credential and not self.authentication_policy:
-            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'Authorization', **kwargs)
+            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'api-key', **kwargs)

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/_configuration.py

@@ -60,4 +60,4 @@ def _configure(
         self.redirect_policy = kwargs.get('redirect_policy') or policies.RedirectPolicy(**kwargs)
         self.authentication_policy = kwargs.get('authentication_policy')
         if self.credential and not self.authentication_policy:
-            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'Authorization', **kwargs)
+            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'api-key', **kwargs)

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/_metadata.json

@@ -39,7 +39,7 @@
         "credential_scopes": null,
         "credential_default_policy_type": "AzureKeyCredentialPolicy",
         "credential_default_policy_type_has_async_version": false,
-        "credential_key_header_name": "Authorization",
+        "credential_key_header_name": "api-key",
         "sync_imports": "{\"regular\": {\"azurecore\": {\"azure.core.configuration\": [\"Configuration\"], \"azure.core.pipeline\": [\"policies\"], \"azure.mgmt.core.policies\": [\"ARMHttpLoggingPolicy\"]}, \"local\": {\"._version\": [\"VERSION\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\"]}, \"azurecore\": {\"azure.core.credentials\": [\"AzureKeyCredential\"]}}}",
         "async_imports": "{\"regular\": {\"azurecore\": {\"azure.core.configuration\": [\"Configuration\"], \"azure.core.pipeline\": [\"policies\"], \"azure.mgmt.core.policies\": [\"ARMHttpLoggingPolicy\"]}, \"local\": {\".._version\": [\"VERSION\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\"]}, \"azurecore\": {\"azure.core.credentials\": [\"AzureKeyCredential\"]}}}"
     },

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v1/aio/_configuration.py

@@ -53,4 +53,4 @@ def _configure(
         self.redirect_policy = kwargs.get('redirect_policy') or policies.AsyncRedirectPolicy(**kwargs)
         self.authentication_policy = kwargs.get('authentication_policy')
         if self.credential and not self.authentication_policy:
-            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'Authorization', **kwargs)
+            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'api-key', **kwargs)

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v2/_configuration.py

@@ -60,4 +60,4 @@ def _configure(
         self.redirect_policy = kwargs.get('redirect_policy') or policies.RedirectPolicy(**kwargs)
         self.authentication_policy = kwargs.get('authentication_policy')
         if self.credential and not self.authentication_policy:
-            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'Authorization', **kwargs)
+            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'api-key', **kwargs)

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v2/_metadata.json

@@ -39,7 +39,7 @@
         "credential_scopes": null,
         "credential_default_policy_type": "AzureKeyCredentialPolicy",
         "credential_default_policy_type_has_async_version": false,
-        "credential_key_header_name": "Authorization",
+        "credential_key_header_name": "api-key",
         "sync_imports": "{\"regular\": {\"azurecore\": {\"azure.core.configuration\": [\"Configuration\"], \"azure.core.pipeline\": [\"policies\"], \"azure.mgmt.core.policies\": [\"ARMHttpLoggingPolicy\"]}, \"local\": {\"._version\": [\"VERSION\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\"]}, \"azurecore\": {\"azure.core.credentials\": [\"AzureKeyCredential\"]}}}",
         "async_imports": "{\"regular\": {\"azurecore\": {\"azure.core.configuration\": [\"Configuration\"], \"azure.core.pipeline\": [\"policies\"], \"azure.mgmt.core.policies\": [\"ARMHttpLoggingPolicy\"]}, \"local\": {\".._version\": [\"VERSION\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\"]}, \"azurecore\": {\"azure.core.credentials\": [\"AzureKeyCredential\"]}}}"
     },

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v2/aio/_configuration.py

@@ -53,4 +53,4 @@ def _configure(
         self.redirect_policy = kwargs.get('redirect_policy') or policies.AsyncRedirectPolicy(**kwargs)
         self.authentication_policy = kwargs.get('authentication_policy')
         if self.credential and not self.authentication_policy:
-            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'Authorization', **kwargs)
+            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'api-key', **kwargs)

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v3/_configuration.py

@@ -60,4 +60,4 @@ def _configure(
         self.redirect_policy = kwargs.get('redirect_policy') or policies.RedirectPolicy(**kwargs)
         self.authentication_policy = kwargs.get('authentication_policy')
         if self.credential and not self.authentication_policy:
-            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'Authorization', **kwargs)
+            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'api-key', **kwargs)

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v3/_metadata.json

@@ -39,7 +39,7 @@
         "credential_scopes": null,
         "credential_default_policy_type": "AzureKeyCredentialPolicy",
         "credential_default_policy_type_has_async_version": false,
-        "credential_key_header_name": "Authorization",
+        "credential_key_header_name": "api-key",
         "sync_imports": "{\"regular\": {\"azurecore\": {\"azure.core.configuration\": [\"Configuration\"], \"azure.core.pipeline\": [\"policies\"], \"azure.mgmt.core.policies\": [\"ARMHttpLoggingPolicy\"]}, \"local\": {\"._version\": [\"VERSION\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\"]}, \"azurecore\": {\"azure.core.credentials\": [\"AzureKeyCredential\"]}}}",
         "async_imports": "{\"regular\": {\"azurecore\": {\"azure.core.configuration\": [\"Configuration\"], \"azure.core.pipeline\": [\"policies\"], \"azure.mgmt.core.policies\": [\"ARMHttpLoggingPolicy\"]}, \"local\": {\".._version\": [\"VERSION\"]}}, \"conditional\": {\"stdlib\": {\"typing\": [\"Any\"]}, \"azurecore\": {\"azure.core.credentials\": [\"AzureKeyCredential\"]}}}"
     },

test/multiapi/Expected/AcceptanceTests/MultiapiCredentialDefaultPolicy/multiapicredentialdefaultpolicy/v3/aio/_configuration.py

@@ -53,4 +53,4 @@ def _configure(
         self.redirect_policy = kwargs.get('redirect_policy') or policies.AsyncRedirectPolicy(**kwargs)
         self.authentication_policy = kwargs.get('authentication_policy')
         if self.credential and not self.authentication_policy:
-            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'Authorization', **kwargs)
+            self.authentication_policy = policies.AzureKeyCredentialPolicy(self.credential, 'api-key', **kwargs)

test/multiapi/specification/multiapicredentialdefaultpolicy/README.md

@@ -30,7 +30,6 @@ license-header: MICROSOFT_MIT_NO_VERSION
 azure-arm: true
 add-credentials: true
 credential-default-policy-type: AzureKeyCredentialPolicy
-credential-key-header-name: Authorization
 ```
 
 ``` yaml $(multiapi)