Improve samples in EG

scripts/devops_tasks/test_run_samples.py

@@ -24,8 +24,10 @@
     "azure-eventgrid": [
         "__init__.py",
         "consume_cloud_events_from_eventhub.py",
-        "consume_cloud_events_from_service_bus_queue.py",
-        "consume_cloud_events_from_storage_queue.py"],
+        "consume_eventgrid_events_from_service_bus_queue.py",
+        "consume_cloud_events_from_storage_queue.py",
+        "sample_publish_events_to_a_topic_using_sas_credential.py",
+        "sample_publish_events_to_a_topic_using_sas_credential_async.py"],
     "azure-eventhub": [
         "authenticate_with_sas_token.py",
         "connection_to_custom_endpoint_address.py",

sdk/eventgrid/azure-eventgrid/README.md

@@ -145,9 +145,9 @@ The following section provides several code snippets illustrating common pattern
 
 These code samples show common champion scenario operations with the Azure Event Grid client library.
 
-* Publish Custom Events to a topic: [cs1_publish_custom_events_to_a_topic.py][python-eg-sample-customevent]
-* Publish Custom events to a domain topic: [cs2_publish_custom_events_to_a_domain_topic.py][python-eg-sample-customevent-to-domain]
-* Publish a Cloud Event: [cs6_publish_events_using_cloud_events_1.0_schema.py][python-eg-sample-send-cloudevent]
+* Publish EventGrid Events to a topic: [sample_publish_eg_events_to_a_topic.py][python-eg-sample-egevent]
+* Publish EventGrid Events to a domain: [sample_publish_eg_events_to_a_domain.py][python-eg-sample-egevent-to-domain]
+* Publish a Cloud Event: [sample_publish_events_using_cloud_events_1.0_schema.py][python-eg-sample-send-cloudevent]
 
 More samples can be found [here][python-eg-samples].
 
@@ -180,9 +180,9 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
 [azure_core_ref_docs]: https://aka.ms/azsdk/python/core/docs
 [azure_subscription]: https://azure.microsoft.com/free/
 
-[python-eg-sample-customevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs1_publish_custom_events_to_a_topic.py
-[python-eg-sample-customevent-to-domain]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs2_publish_custom_events_to_a_domain_topic.py
-[python-eg-sample-send-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs5_publish_events_using_cloud_events_1.0_schema.py
+[python-eg-sample-egevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_eg_events_to_a_topic.py
+[python-eg-sample-egevent-to-domain]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_eg_events_to_a_domain.py
+[python-eg-sample-send-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_events_using_cloud_events_1.0_schema.py
 [publisher-service-doc]: https://docs.microsoft.com/azure/event-grid/concepts
 
 [cla]: https://cla.microsoft.com

sdk/eventgrid/azure-eventgrid/dev_requirements.txt

@@ -3,3 +3,4 @@
 -e ../../core/azure-core
 -e ../../identity/azure-identity
 -e ../azure-mgmt-eventgrid
+aiohttp>=3.0; python_version >= '3.5'

sdk/eventgrid/azure-eventgrid/migration_guide.md

@@ -63,15 +63,15 @@ cloud_event = {
 
 | In v1.3 | Equivalent in v2.0 | Sample |
 |---|---|---|
-|`EventGridClient(credentials)`|`EventGridPublisherClient(endpoint, credential)`|[Sample for client construction](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs5_publish_events_using_cloud_events_1.0_schema.py)|
+|`EventGridClient(credentials)`|`EventGridPublisherClient(endpoint, credential)`|[Sample for client construction](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_events_using_cloud_events_1.0_schema.py)|
 
 ### Publishing Events
 
 The `publish_events` API is replaced with `send` in v2.0. Additionally, `send` API accepts `CloudEvent`, `EventGridEvent` along with their dict representations.
 
 | In v1.3 | Equivalent in v2.0 | Sample |
 |---|---|---|
-|`EventGridClient(credentials).publish_events(topic_hostname, events)`|`EventGridPublisherClient(endpoint, credential).send(events)`|[Sample for client construction](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs5_publish_events_using_cloud_events_1.0_schema.py)|
+|`EventGridClient(credentials).publish_events(topic_hostname, events)`|`EventGridPublisherClient(endpoint, credential).send(events)`|[Sample for client construction](https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_events_using_cloud_events_1.0_schema.py)|
 
 ## Additional samples
 

sdk/eventgrid/azure-eventgrid/samples/README.md

@@ -10,13 +10,60 @@ urlFragment: azure-eventgrid-samples
 
 # Azure Event Grid Client Library Python Samples
 
+## Sync samples
 These code samples show common champion scenario operations with the Azure Event Grid client library.
 
-* Publish Custom Events to a topic: [cs1_publish_custom_events_to_a_topic.py][python-eg-sample-customevent]
-* Publish Custom events to a domain topic: [cs2_publish_custom_events_to_a_domain_topic.py][python-eg-sample-customevent-to-domain]
-* Publish a Cloud Event: [cs6_publish_events_using_cloud_events_1.0_schema.py][python-eg-sample-send-cloudevent]
+* Generate Shared Access Signature: [sample_generate_sas.py][python-eg-generate-sas]
+
+* Publish events to a topic using SAS: [sample_publish_events_to_a_topic_using_sas_credential_async.py][python-eg-sample-send-using-sas]
+* Publish Event Grid Events to a topic: [sample_publish_eg_events_to_a_topic.py][python-eg-sample-eg-event]
+* Publish EventGrid Events to a domain topic: [sample_publish_eg_events_to_a_domain_topic.py][python-eg-sample-eg-event-to-domain]
+* Publish a Cloud Event: [sample_publish_events_using_cloud_events_1.0_schema.py][python-eg-sample-send-cloudevent]
+* Publish a Custom Schema: [sample_publish_custom_schema_to_a_topic.py][python-eg-publish-custom-schema]
+
+To publish events, dict representation of the models could also be used as follows:
+* Publish EventGridEvent as dict like representation: [sample_publish_eg_event_using_dict.py][python-eg-sample-send-eg-as-dict]
+* Publish CloudEvent as dict like representation: [sample_publish_cloud_event_using_dict.py][python-eg-sample-send-cloudevent-as-dict]
+
+* Consume a Custom Payload of raw cloudevent data: [sample_consume_custom_payload.py][python-eg-sample-consume-custom-payload]
+
+## Async samples
+These code samples show common champion scenario operations with the Azure Event Grid client library using the async client.
+
+* Publish events to a topic using SAS: [sample_publish_events_to_a_topic_using_sas_credential_async.py][python-eg-sample-send-using-sas-async]
+* Publish EventGrid Events to a topic: [sample_publish_eg_events_to_a_topic_async.py][python-eg-sample-eg-event-async]
+* Publish EventGrid Events to a domain topic: [sample_publish_eg_events_to_a_domain_topic_async.py][python-eg-sample-eg-event-to-domain-async]
+* Publish a Cloud Event: [sample_publish_events_using_cloud_events_1.0_schema_async.py][python-eg-sample-send-cloudevent-async]
+* Publish a Custom Schema: [sample_publish_custom_schema_to_a_topic_async.py][python-eg-publish-custom-schema-async]
+
+To publish events, dict representation of the models could also be used as follows:
+* Publish EventGridEvent as dict like representation: [sample_publish_eg_event_using_dict_async.py][python-eg-sample-send-eg-as-dict-async]
+* Publish CloudEvent as dict like representation: [sample_publish_cloud_event_using_dict_async.py][python-eg-sample-send-cloudevent-as-dict-async]
+
+## More Samples
+
+* More samples related to the send scenario can be seen [here][python-eg-publish-samples].
+* To see more samples related to consuming a payload from different messaging services as a typed object, please visit [Consume Samples][python-eg-consume-samples]
+
+
+[python-eg-generate-sas]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_generate_sas.py
+[python-eg-sample-send-using-sas]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_events_to_a_topic_using_sas_credential.py
+[python-eg-sample-eg-event]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_eg_events_to_a_topic.py
+[python-eg-sample-eg-event-to-domain]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_eg_events_to_a_domain.py
+[python-eg-sample-send-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_events_using_cloud_events_1.0_schema.py
+[python-eg-publish-custom-schema]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_custom_schema_to_a_topic.py
+[python-eg-sample-send-eg-as-dict]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_eg_event_using_dict.py
+[python-eg-sample-send-cloudevent-as-dict]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/sync_samples/sample_publish_cloud_event_using_dict.py
+
+[python-eg-sample-send-using-sas-async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_events_to_a_topic_using_sas_credential_async.py
+[python-eg-sample-eg-event-async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_eg_events_to_a_topic_async.py
+[python-eg-sample-eg-event-to-domain-async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_eg_events_to_a_domain_async.py
+[python-eg-sample-send-cloudevent-async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_events_using_cloud_events_1.0_schema_async.py
+[python-eg-publish-custom-schema-async]:https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_custom_schema_to_a_topic_async.py
+[python-eg-sample-send-eg-as-dict-async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_eg_event_using_dict_async.py
+[python-eg-sample-send-cloudevent-as-dict-async]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_cloud_event_using_dict_async.py
+
+[python-eg-publish-samples]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/publish_samples
+[python-eg-consume-samples]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/consume_samples
 
-[python-eg-sample-customevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs1_publish_custom_events_to_a_topic.py
-[python-eg-sample-customevent-to-domain]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs2_publish_custom_events_to_a_domain_topic.py
-[python-eg-sample-send-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs5_publish_events_using_cloud_events_1.0_schema.py
 [publisher-service-doc]: https://docs.microsoft.com/azure/event-grid/concepts

sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_cloud_event_using_dict_async.py

@@ -0,0 +1,47 @@
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+"""
+FILE: sample_publish_cloud_event_using_dict_async.py
+DESCRIPTION:
+    These samples demonstrate creating a list of CloudEvents using dict representations
+    and sending then as a list.
+USAGE:
+    python sample_publish_cloud_event_using_dict_async.py
+    Set the environment variables with your own values before running the sample:
+    1) CLOUD_ACCESS_KEY - The access key of your eventgrid account.
+    2) CLOUD_TOPIC_HOSTNAME - The topic hostname. Typically it exists in the format
+    "<YOUR-TOPIC-NAME>.<REGION-NAME>.eventgrid.azure.net".
+"""
+import os
+import asyncio
+from azure.eventgrid import CloudEvent
+from azure.eventgrid.aio import EventGridPublisherClient
+from azure.core.credentials import AzureKeyCredential
+
+topic_key = os.environ["CLOUD_ACCESS_KEY"]
+endpoint = os.environ["CLOUD_TOPIC_HOSTNAME"]
+
+async def publish():
+    credential = AzureKeyCredential(topic_key)
+    client = EventGridPublisherClient(endpoint, credential)
+
+    async with client:
+        client.send([
+            {
+                "type": "Contoso.Items.ItemReceived",
+                "source": "/contoso/items",	
+                "data": {	
+                    "itemSku": "Contoso Item SKU #1"	
+                },	
+                "subject": "Door1",	
+                "specversion": "1.0",	
+                "id": "randomclouduuid11"
+            }
+        ])
+
+if __name__ == '__main__':
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(publish())

sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_custom_schema_to_a_topic_async.py

@@ -0,0 +1,62 @@
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+"""
+FILE: sample_publish_custom_schema_to_a_topic_async.py
+DESCRIPTION:
+    These samples demonstrate creating a list of Custom Events and sending them as a list.
+USAGE:
+    python sample_publish_custom_schema_to_a_topic_async.py
+    Set the environment variables with your own values before running the sample:
+    1) CUSTOM_SCHEMA_ACCESS_KEY - The access key of your eventgrid account.
+    2) CUSTOM_SCHEMA_TOPIC_HOSTNAME - The topic hostname. Typically it exists in the format
+    "<YOUR-TOPIC-NAME>.<REGION-NAME>.eventgrid.azure.net".
+"""
+import os
+import asyncio
+from random import randint, sample
+import time
+import uuid
+from msrest.serialization import UTC
+import datetime as dt
+
+from azure.core.credentials import AzureKeyCredential
+from azure.eventgrid.aio import EventGridPublisherClient
+
+key = os.environ["CUSTOM_SCHEMA_ACCESS_KEY"]
+endpoint = os.environ["CUSTOM_SCHEMA_TOPIC_HOSTNAME"]
+
+async def publish_event():
+    # authenticate client
+    credential = AzureKeyCredential(key)
+    client = EventGridPublisherClient(endpoint, credential)
+
+    custom_schema_event = {
+        "customSubject": "sample",
+        "customEventType": "sample.event",
+        "customDataVersion": "2.0",
+        "customId": uuid.uuid4(),
+        "customEventTime": dt.datetime.now(UTC()).isoformat(),
+        "customData": "sample data"
+    }
+
+    # publish events
+    for _  in range(3):
+
+        event_list = []     # list of events to publish
+        # create events and append to list
+        for j in range(randint(1, 3)):
+            event_list.append(custom_schema_event)
+
+        async with client:
+            # publish list of events
+            client.send(event_list)
+            print("Batch of size {} published".format(len(event_list)))
+            time.sleep(randint(1, 5))
+
+
+if __name__ == '__main__':
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(publish_event())

sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_eg_event_using_dict_async.py

@@ -0,0 +1,58 @@
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+"""
+FILE: sample_publish_eg_event_using_dict_async.py
+DESCRIPTION:
+    These samples demonstrate sending an EventGrid Event as a dict representation
+    directly to a topic. The dict representation should be that of the serialized
+    model of EventGridEvent.
+USAGE:
+    python sample_publish_eg_event_using_dict_async.py
+    Set the environment variables with your own values before running the sample:
+    1) EG_ACCESS_KEY - The access key of your eventgrid account.
+    2) EG_TOPIC_HOSTNAME - The topic hostname. Typically it exists in the format
+    "<YOUR-TOPIC-NAME>.<REGION-NAME>.eventgrid.azure.net".
+"""
+import os
+import asyncio
+from datetime import datetime
+from azure.eventgrid import EventGridEvent
+from azure.eventgrid.aio import EventGridPublisherClient
+from azure.core.credentials import AzureKeyCredential
+
+topic_key = os.environ["EG_ACCESS_KEY"]
+endpoint = os.environ["EG_TOPIC_HOSTNAME"]
+
+async def publish():
+    credential = AzureKeyCredential(topic_key)
+    client = EventGridPublisherClient(endpoint, credential)
+    event0 = {	
+        "eventType": "Contoso.Items.ItemReceived",	
+        "data": {	
+            "itemSku": "Contoso Item SKU #1"	
+        },	
+        "subject": "Door1",	
+        "dataVersion": "2.0",	
+        "id": "randomuuid11",	
+        "eventTime": datetime.utcnow()
+    }	
+    event1 = {	
+        "eventType": "Contoso.Items.ItemReceived",	
+        "data": {	
+            "itemSku": "Contoso Item SKU #2"	
+        },	
+        "subject": "Door1",	
+        "dataVersion": "2.0",	
+        "id": "randomuuid12",	
+        "eventTime": datetime.utcnow()
+    }
+
+    async with client:	
+        await client.send([event0, event1])
+
+if __name__ == '__main__':
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(publish())

sdk/eventgrid/azure-eventgrid/samples/async_samples/sample_publish_eg_events_to_a_domain_async.py

@@ -0,0 +1,54 @@
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+"""
+FILE: sample_publish_eg_events_to_a_domain_async.py
+DESCRIPTION:
+    These samples demonstrate creating a list of EventGrid Events and sending them as a list to a topic
+    in a domain.
+USAGE:
+    python sample_publish_eg_events_to_a_domain_async.py
+    Set the environment variables with your own values before running the sample:
+    1) EG_ACCESS_KEY - The access key of your eventgrid account.
+    2) EG_TOPIC_HOSTNAME - The topic hostname. Typically it exists in the format
+    "<YOUR-TOPIC-NAME>.<REGION-NAME>.eventgrid.azure.net".
+"""
+import os
+import asyncio
+from azure.eventgrid import EventGridEvent
+from azure.eventgrid.aio import EventGridPublisherClient
+from azure.core.credentials import AzureKeyCredential
+
+domain_key = os.environ["EG_DOMAIN_ACCESS_KEY"]
+domain_hostname = os.environ["EG_DOMAIN_TOPIC_HOSTNAME"]
+
+async def publish():
+    credential = AzureKeyCredential(domain_key)
+    client = EventGridPublisherClient(domain_hostname, credential)
+
+    await client.send([
+        EventGridEvent(
+            topic="MyCustomDomainTopic1",
+            event_type="Contoso.Items.ItemReceived",
+            data={
+                "itemSku": "Contoso Item SKU #1"
+            },
+            subject="Door1",
+            data_version="2.0"
+        ),
+        EventGridEvent(
+            topic="MyCustomDomainTopic2",
+            event_type="Contoso.Items.ItemReceived",
+            data={
+                "itemSku": "Contoso Item SKU #2"
+            },
+            subject="Door1",
+            data_version="2.0"
+        )
+    ])
+
+if __name__ == '__main__':
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(publish())