rename to generate_sas (#16330)

Author: Rakshith Bhyravabhotla

sdk/eventgrid/azure-eventgrid/CHANGELOG.md

@@ -11,6 +11,7 @@
   - The `send` method in the `EventGridPubliserClient` is now replaced by the `send_events`.
   - `topic_hostname` is renamed to `endpoint` in the `EventGridPublisherClient`.
   - `data` is now a required param for `CloudEvent`.
+  - `azure.eventgrid.generate_shared_access_signature` method is now renamed to `generate_sas`.
 
   **Bug Fixes**
   - `EventGridEvent` has two additional required positional parameters namely, `data` and `data_version`.

sdk/eventgrid/azure-eventgrid/azure/eventgrid/__init__.py

@@ -6,11 +6,11 @@
 
 from ._publisher_client import EventGridPublisherClient
 from ._consumer import EventGridDeserializer
-from ._helpers import generate_shared_access_signature
+from ._helpers import generate_sas
 from ._models import CloudEvent, CustomEvent, EventGridEvent
 from ._version import VERSION
 
 __all__ = ['EventGridPublisherClient', 'EventGridDeserializer',
-            'CloudEvent', 'CustomEvent', 'EventGridEvent', 'generate_shared_access_signature'
+            'CloudEvent', 'CustomEvent', 'EventGridEvent', 'generate_sas'
             ]
 __version__ = VERSION

sdk/eventgrid/azure-eventgrid/azure/eventgrid/_helpers.py

@@ -20,7 +20,7 @@
 if TYPE_CHECKING:
     from datetime import datetime
 
-def generate_shared_access_signature(endpoint, shared_access_key, expiration_date_utc, **kwargs):
+def generate_sas(endpoint, shared_access_key, expiration_date_utc, **kwargs):
     # type: (str, str, datetime, Any) -> str
     """ Helper method to generate shared access signature given hostname, key, and expiration date.
         :param str endpoint: The topic endpoint to send the events to.

sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs1b_publish_custom_events_to_a_topic_with_signature.py

@@ -15,15 +15,15 @@
     "<YOUR-TOPIC-NAME>.<REGION-NAME>.eventgrid.azure.net".
 """
 import os
-from azure.eventgrid import EventGridPublisherClient, EventGridEvent, generate_shared_access_signature
+from azure.eventgrid import EventGridPublisherClient, EventGridEvent, generate_sas
 from azure.core.credentials import AzureKeyCredential, AzureSasCredential
 from datetime import datetime, timedelta
 
 topic_key = os.environ["EG_ACCESS_KEY"]
 endpoint = os.environ["EG_TOPIC_HOSTNAME"]
 expiration_date_utc = datetime.utcnow() + timedelta(hours=1)
 
-signature = generate_shared_access_signature(endpoint, topic_key, expiration_date_utc)
+signature = generate_sas(endpoint, topic_key, expiration_date_utc)
 credential = AzureSasCredential(signature)
 client = EventGridPublisherClient(endpoint, credential)
 

sdk/eventgrid/azure-eventgrid/samples/publish_samples/publish_with_shared_access_signature_sample.py

@@ -21,13 +21,13 @@
 
 from datetime import datetime, timedelta
 from azure.core.credentials import AzureSasCredential
-from azure.eventgrid import EventGridPublisherClient, CloudEvent, generate_shared_access_signature
+from azure.eventgrid import EventGridPublisherClient, CloudEvent, generate_sas
 
 key = os.environ["CLOUD_ACCESS_KEY"]
 endpoint = os.environ["CLOUD_TOPIC_HOSTNAME"]
 expiration_date_utc = datetime.utcnow() + timedelta(hours=1)
 
-signature = generate_shared_access_signature(endpoint, key, expiration_date_utc)
+signature = generate_sas(endpoint, key, expiration_date_utc)
 
 # authenticate client
 credential = AzureSasCredential(signature)

sdk/eventgrid/azure-eventgrid/tests/test_eg_publisher_client.py

@@ -16,7 +16,7 @@
 
 from azure_devtools.scenario_tests import ReplayableTest
 from azure.core.credentials import AzureKeyCredential, AzureSasCredential
-from azure.eventgrid import EventGridPublisherClient, CloudEvent, EventGridEvent, CustomEvent, generate_shared_access_signature
+from azure.eventgrid import EventGridPublisherClient, CloudEvent, EventGridEvent, CustomEvent, generate_sas
 
 from eventgrid_preparer import (
     CachedEventGridTopicPreparer
@@ -197,7 +197,7 @@ def test_send_cloud_event_dict(self, resource_group, eventgrid_topic, eventgrid_
     @CachedEventGridTopicPreparer(name_prefix='eventgridtest')
     def test_send_signature_credential(self, resource_group, eventgrid_topic, eventgrid_topic_primary_key, eventgrid_topic_endpoint):
         expiration_date_utc = dt.datetime.now(UTC()) + timedelta(hours=1)
-        signature = generate_shared_access_signature(eventgrid_topic_endpoint, eventgrid_topic_primary_key, expiration_date_utc)
+        signature = generate_sas(eventgrid_topic_endpoint, eventgrid_topic_primary_key, expiration_date_utc)
         credential = AzureSasCredential(signature)
         client = EventGridPublisherClient(eventgrid_topic_endpoint, credential)
         eg_event = EventGridEvent(

sdk/eventgrid/azure-eventgrid/tests/test_eg_publisher_client_async.py

@@ -17,7 +17,7 @@
 
 from azure_devtools.scenario_tests import ReplayableTest
 from azure.core.credentials import AzureKeyCredential, AzureSasCredential
-from azure.eventgrid import CloudEvent, EventGridEvent, CustomEvent, generate_shared_access_signature
+from azure.eventgrid import CloudEvent, EventGridEvent, CustomEvent, generate_sas
 from azure.eventgrid.aio import EventGridPublisherClient
 
 from eventgrid_preparer import (
@@ -216,7 +216,7 @@ async def test_send_cloud_event_data_none(self, resource_group, eventgrid_topic,
     @pytest.mark.asyncio
     async def test_send_signature_credential(self, resource_group, eventgrid_topic, eventgrid_topic_primary_key, eventgrid_topic_endpoint):
         expiration_date_utc = dt.datetime.now(UTC()) + timedelta(hours=1)
-        signature = generate_shared_access_signature(eventgrid_topic_endpoint, eventgrid_topic_primary_key, expiration_date_utc)
+        signature = generate_sas(eventgrid_topic_endpoint, eventgrid_topic_primary_key, expiration_date_utc)
         credential = AzureSasCredential(signature)
         client = EventGridPublisherClient(eventgrid_topic_endpoint, credential)
         eg_event = EventGridEvent(