Add new ttl parameter to getRelayConfiguration (Azure#23568)

* Add ttl as parameter to GetRelayConfiguration

* Fix build errors

* Use correct version convention

* Fix build errors

* Fix build

* Only validate the TTL in live tests

Author: AriZavala2

sdk/communication/azure-communication-networktraversal/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release History
 
+## 1.1.0b1 (2022-03-18)
+
+### Features Added
+
+- Adding optional parameter to GetRelayConfiguration to choose credential Time-To-Live in seconds of max 48 hours.
+  The default value will be used if given value exceeds it.
+
+### Breaking Changes
+
+- Making User, RouteType and Ttl part of the options parameter
+- getRelayConfiguration can be called without parameters or passing the GetRelayConfigurationOptions parameter
+
 ## 1.0.0 (2022-02-04) (Deprecated)
 
 ### Breaking Changes

sdk/communication/azure-communication-networktraversal/azure/communication/networktraversal/_communication_relay_client.py

@@ -89,6 +89,7 @@ def get_relay_configuration(
             *,
             user=None, # type: CommunicationUserIdentifier
             route_type=None, # type: Optional[Union[str, "RouteType"]]
+            ttl=172800,  # type: Optional[int]
             **kwargs # type: Any
     ):
     # type: (...) -> CommunicationRelayConfiguration
@@ -102,8 +103,9 @@ def get_relay_configuration(
         """
         if user is None:
             return self._network_traversal_service_client.communication_network_traversal.issue_relay_configuration(
-                None, route_type, **kwargs)
+                route_type=route_type, ttl=ttl, **kwargs)
         return self._network_traversal_service_client.communication_network_traversal.issue_relay_configuration(
-            user.properties['id'],
-            route_type,
+            id=user.properties['id'],
+            route_type=route_type,
+            ttl=ttl,
             **kwargs)

sdk/communication/azure-communication-networktraversal/azure/communication/networktraversal/_generated/_communication_network_traversal_client.py

@@ -9,9 +9,10 @@
 from copy import deepcopy
 from typing import TYPE_CHECKING
 
-from azure.core import PipelineClient
 from msrest import Deserializer, Serializer
 
+from azure.core import PipelineClient
+
 from . import models
 from ._configuration import CommunicationNetworkTraversalClientConfiguration
 from .operations import CommunicationNetworkTraversalOperations
@@ -31,8 +32,8 @@ class CommunicationNetworkTraversalClient(object):
     :param endpoint: The communication resource, for example
      https://my-resource.communication.azure.com.
     :type endpoint: str
-    :keyword api_version: Api Version. The default value is "2022-02-01". Note that overriding this
-     default value may result in unsupported behavior.
+    :keyword api_version: Api Version. Default value is "2022-03-01-preview". Note that overriding
+     this default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 

sdk/communication/azure-communication-networktraversal/azure/communication/networktraversal/_generated/_configuration.py

@@ -17,15 +17,17 @@
 
 VERSION = "unknown"
 
-class CommunicationNetworkTraversalClientConfiguration(Configuration):
+class CommunicationNetworkTraversalClientConfiguration(Configuration):  # pylint: disable=too-many-instance-attributes
     """Configuration for CommunicationNetworkTraversalClient.
 
     Note that all parameters used to create this instance are saved as instance
     attributes.
 
-    :param endpoint: The communication resource, for example https://my-resource.communication.azure.com.
+    :param endpoint: The communication resource, for example
+     https://my-resource.communication.azure.com.
     :type endpoint: str
-    :keyword api_version: Api Version. The default value is "2022-02-01". Note that overriding this default value may result in unsupported behavior.
+    :keyword api_version: Api Version. Default value is "2022-03-01-preview". Note that overriding
+     this default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
@@ -36,7 +38,7 @@ def __init__(
     ):
         # type: (...) -> None
         super(CommunicationNetworkTraversalClientConfiguration, self).__init__(**kwargs)
-        api_version = kwargs.pop('api_version', "2022-02-01")  # type: str
+        api_version = kwargs.pop('api_version', "2022-03-01-preview")  # type: str
 
         if endpoint is None:
             raise ValueError("Parameter 'endpoint' must not be None.")

sdk/communication/azure-communication-networktraversal/azure/communication/networktraversal/_generated/aio/_communication_network_traversal_client.py

@@ -9,9 +9,10 @@
 from copy import deepcopy
 from typing import Any, Awaitable
 
+from msrest import Deserializer, Serializer
+
 from azure.core import AsyncPipelineClient
 from azure.core.rest import AsyncHttpResponse, HttpRequest
-from msrest import Deserializer, Serializer
 
 from .. import models
 from ._configuration import CommunicationNetworkTraversalClientConfiguration
@@ -26,8 +27,8 @@ class CommunicationNetworkTraversalClient:
     :param endpoint: The communication resource, for example
      https://my-resource.communication.azure.com.
     :type endpoint: str
-    :keyword api_version: Api Version. The default value is "2022-02-01". Note that overriding this
-     default value may result in unsupported behavior.
+    :keyword api_version: Api Version. Default value is "2022-03-01-preview". Note that overriding
+     this default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 

sdk/communication/azure-communication-networktraversal/azure/communication/networktraversal/_generated/aio/_configuration.py

@@ -13,15 +13,17 @@
 
 VERSION = "unknown"
 
-class CommunicationNetworkTraversalClientConfiguration(Configuration):
+class CommunicationNetworkTraversalClientConfiguration(Configuration):  # pylint: disable=too-many-instance-attributes
     """Configuration for CommunicationNetworkTraversalClient.
 
     Note that all parameters used to create this instance are saved as instance
     attributes.
 
-    :param endpoint: The communication resource, for example https://my-resource.communication.azure.com.
+    :param endpoint: The communication resource, for example
+     https://my-resource.communication.azure.com.
     :type endpoint: str
-    :keyword api_version: Api Version. The default value is "2022-02-01". Note that overriding this default value may result in unsupported behavior.
+    :keyword api_version: Api Version. Default value is "2022-03-01-preview". Note that overriding
+     this default value may result in unsupported behavior.
     :paramtype api_version: str
     """
 
@@ -31,7 +33,7 @@ def __init__(
         **kwargs: Any
     ) -> None:
         super(CommunicationNetworkTraversalClientConfiguration, self).__init__(**kwargs)
-        api_version = kwargs.pop('api_version', "2022-02-01")  # type: str
+        api_version = kwargs.pop('api_version', "2022-03-01-preview")  # type: str
 
         if endpoint is None:
             raise ValueError("Parameter 'endpoint' must not be None.")

sdk/communication/azure-communication-networktraversal/azure/communication/networktraversal/_generated/aio/operations/_communication_network_traversal_operations.py

@@ -1,13 +1,12 @@
+# pylint: disable=too-many-lines
 # coding=utf-8
 # --------------------------------------------------------------------------
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See License.txt in the project root for license information.
 # Code generated by Microsoft (R) AutoRest Code Generator.
 # Changes may cause incorrect behavior and will be lost if the code is regenerated.
 # --------------------------------------------------------------------------
-import functools
-from typing import Any, Callable, Dict, Generic, Optional, TypeVar, Union
-import warnings
+from typing import Any, Callable, Dict, Optional, TypeVar, Union
 
 from azure.core.exceptions import ClientAuthenticationError, HttpResponseError, ResourceExistsError, ResourceNotFoundError, map_error
 from azure.core.pipeline import PipelineResponse
@@ -22,32 +21,31 @@
 ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]]
 
 class CommunicationNetworkTraversalOperations:
-    """CommunicationNetworkTraversalOperations async operations.
-
-    You should not instantiate this class directly. Instead, you should create a Client instance that
-    instantiates it for you and attaches it as an attribute.
+    """
+    .. warning::
+        **DO NOT** instantiate this class directly.
 
-    :ivar models: Alias to model classes used in this operation group.
-    :type models: ~azure.communication.networktraversal.models
-    :param client: Client for service requests.
-    :param config: Configuration of service client.
-    :param serializer: An object model serializer.
-    :param deserializer: An object model deserializer.
+        Instead, you should access the following operations through
+        :class:`~azure.communication.networktraversal.aio.CommunicationNetworkTraversalClient`'s
+        :attr:`communication_network_traversal` attribute.
     """
 
     models = _models
 
-    def __init__(self, client, config, serializer, deserializer) -> None:
-        self._client = client
-        self._serialize = serializer
-        self._deserialize = deserializer
-        self._config = config
+    def __init__(self, *args, **kwargs) -> None:
+        args = list(args)
+        self._client = args.pop(0) if args else kwargs.pop("client")
+        self._config = args.pop(0) if args else kwargs.pop("config")
+        self._serialize = args.pop(0) if args else kwargs.pop("serializer")
+        self._deserialize = args.pop(0) if args else kwargs.pop("deserializer")
+
 
     @distributed_trace_async
     async def issue_relay_configuration(
         self,
         id: Optional[str] = None,
         route_type: Optional[Union[str, "_models.RouteType"]] = None,
+        ttl: Optional[int] = 172800,
         **kwargs: Any
     ) -> "_models.CommunicationRelayConfiguration":
         """Issue a configuration for an STUN/TURN server.
@@ -56,14 +54,14 @@ async def issue_relay_configuration(
 
         :param id: An identity to be associated with telemetry for data relayed using the returned
          credentials. Must be an existing ACS user identity. If not provided, the telemetry will not
-         contain an associated identity value.
+         contain an associated identity value. Default value is None.
         :type id: str
         :param route_type: Filter the routing methodology returned. If not provided, will return all
-         route types in separate ICE servers.
+         route types in separate ICE servers. Default value is None.
         :type route_type: str or ~azure.communication.networktraversal.models.RouteType
-        :keyword api_version: Api Version. The default value is "2022-02-01". Note that overriding this
-         default value may result in unsupported behavior.
-        :paramtype api_version: str
+        :param ttl: The credential Time-To-Live (TTL), in seconds. The default value will be used if
+         given value exceeds it. Default value is 172800.
+        :type ttl: int
         :keyword callable cls: A custom type or function that will be passed the direct response
         :return: CommunicationRelayConfiguration, or the result of cls(response)
         :rtype: ~azure.communication.networktraversal.models.CommunicationRelayConfiguration
@@ -75,10 +73,10 @@ async def issue_relay_configuration(
         }
         error_map.update(kwargs.pop('error_map', {}))
 
-        api_version = kwargs.pop('api_version', "2022-02-01")  # type: str
+        api_version = kwargs.pop('api_version', "2022-03-01-preview")  # type: str
         content_type = kwargs.pop('content_type', "application/json")  # type: Optional[str]
 
-        _body = _models.CommunicationRelayConfigurationRequest(id=id, route_type=route_type)
+        _body = _models.CommunicationRelayConfigurationRequest(id=id, route_type=route_type, ttl=ttl)
         if _body is not None:
             _json = self._serialize.body(_body, 'CommunicationRelayConfigurationRequest')
         else:
@@ -96,7 +94,11 @@ async def issue_relay_configuration(
         }
         request.url = self._client.format_url(request.url, **path_format_arguments)
 
-        pipeline_response = await self._client._pipeline.run(request, stream=False, **kwargs)
+        pipeline_response = await self._client._pipeline.run(  # pylint: disable=protected-access
+            request,
+            stream=False,
+            **kwargs
+        )
         response = pipeline_response.http_response
 
         if response.status_code not in [200]:
@@ -111,5 +113,5 @@ async def issue_relay_configuration(
 
         return deserialized
 
-    issue_relay_configuration.metadata = {'url': '/networkTraversal/:issueRelayConfiguration'}  # type: ignore
+    issue_relay_configuration.metadata = {'url': "/networkTraversal/:issueRelayConfiguration"}  # type: ignore
 

sdk/communication/azure-communication-networktraversal/azure/communication/networktraversal/_generated/models/_models.py

@@ -199,11 +199,19 @@ class CommunicationRelayConfigurationRequest(msrest.serialization.Model):
     :ivar route_type: Filter the routing methodology returned. If not provided, will return all
      route types in separate ICE servers. Possible values include: "any", "nearest".
     :vartype route_type: str or ~azure.communication.networktraversal.models.RouteType
+    :ivar ttl: The credential Time-To-Live (TTL), in seconds. The default value will be used if
+     given value exceeds it.
+    :vartype ttl: int
     """
 
+    _validation = {
+        'ttl': {'maximum': 172800, 'minimum': 0},
+    }
+
     _attribute_map = {
         'id': {'key': 'id', 'type': 'str'},
         'route_type': {'key': 'routeType', 'type': 'str'},
+        'ttl': {'key': 'ttl', 'type': 'int'},
     }
 
     def __init__(
@@ -218,7 +226,11 @@ def __init__(
         :keyword route_type: Filter the routing methodology returned. If not provided, will return all
          route types in separate ICE servers. Possible values include: "any", "nearest".
         :paramtype route_type: str or ~azure.communication.networktraversal.models.RouteType
+        :keyword ttl: The credential Time-To-Live (TTL), in seconds. The default value will be used if
+         given value exceeds it.
+        :paramtype ttl: int
         """
         super(CommunicationRelayConfigurationRequest, self).__init__(**kwargs)
         self.id = kwargs.get('id', None)
         self.route_type = kwargs.get('route_type', None)
+        self.ttl = kwargs.get('ttl', 172800)

sdk/communication/azure-communication-networktraversal/azure/communication/networktraversal/_generated/models/_models_py3.py

@@ -217,18 +217,27 @@ class CommunicationRelayConfigurationRequest(msrest.serialization.Model):
     :ivar route_type: Filter the routing methodology returned. If not provided, will return all
      route types in separate ICE servers. Possible values include: "any", "nearest".
     :vartype route_type: str or ~azure.communication.networktraversal.models.RouteType
+    :ivar ttl: The credential Time-To-Live (TTL), in seconds. The default value will be used if
+     given value exceeds it.
+    :vartype ttl: int
     """
 
+    _validation = {
+        'ttl': {'maximum': 172800, 'minimum': 0},
+    }
+
     _attribute_map = {
         'id': {'key': 'id', 'type': 'str'},
         'route_type': {'key': 'routeType', 'type': 'str'},
+        'ttl': {'key': 'ttl', 'type': 'int'},
     }
 
     def __init__(
         self,
         *,
         id: Optional[str] = None,
         route_type: Optional[Union[str, "RouteType"]] = None,
+        ttl: Optional[int] = 172800,
         **kwargs
     ):
         """
@@ -239,7 +248,11 @@ def __init__(
         :keyword route_type: Filter the routing methodology returned. If not provided, will return all
          route types in separate ICE servers. Possible values include: "any", "nearest".
         :paramtype route_type: str or ~azure.communication.networktraversal.models.RouteType
+        :keyword ttl: The credential Time-To-Live (TTL), in seconds. The default value will be used if
+         given value exceeds it.
+        :paramtype ttl: int
         """
         super(CommunicationRelayConfigurationRequest, self).__init__(**kwargs)
         self.id = id
         self.route_type = route_type
+        self.ttl = ttl