Skip to content

[EventGrid] Adjust README verbiage in preparation for UX pilot study with feedback #15729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
KieranBrantnerMagee wants to merge 4 commits into from
Closed

[EventGrid] Adjust README verbiage in preparation for UX pilot study with feedback #15729

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82c6b16
Adjust README verbiage in preparation for UX pilot study with feedback
KieranBrantnerMagee Dec 9, 2020
54cef2b
Add UX study feedback in light of pilot study
KieranBrantnerMagee Dec 10, 2020
88dc4cb
Round 2 UX study feedback. clarify some model comments, and add some…
KieranBrantnerMagee Dec 11, 2020
acf94a2
Merge branch 'master' into kibrantn/eventgrid/ux-study-working-branch
Jan 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions sdk/eventgrid/azure-eventgrid/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,22 +38,25 @@ In order to interact with the Event Grid service, you will need to create an ins
A **topic_hostname** and **credential** are necessary to instantiate the client object.

#### Looking up the endpoint
You can find the endpoint and the hostname on the Azure portal.
You can find the topic endpoint within the Event Grid Topic resource on the Azure portal.
The topic hostname is the URL host component of this endpoint. (Everything up-to and including "eventgrid.azure.net".)

#### Create the client with AzureKeyCredential

To use an API key as the `credential` parameter,
To use an Access Key as the `credential` parameter,
pass the key as a string into an instance of [AzureKeyCredential][azure-key-credential].

```python
from azure.core.credentials import AzureKeyCredential
from azure.eventgrid import EventGridPublisherClient

topic_hostname = "https://<name>.<region>.eventgrid.azure.net"
credential = AzureKeyCredential("<api_key>")
credential = AzureKeyCredential("<access_key>")
eg_publisher_client = EventGridPublisherClient(topic_hostname, credential)
```

> **Note:** A client may also be authenticated via SAS signature, using the `EventGridSharedAccessSignatureCredential`. A sample demonstrating this, as well as how to generate that signature utilizing `generate_shared_access_signature` is available [here][python-eg-sample-publish-sas-signature].

## Key concepts

Information about the key concepts on Event Grid, see [Concepts in Azure Event Grid][publisher-service-doc]
Expand Down Expand Up @@ -250,6 +253,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
[python-eg-sample-consume-customevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs4_consume_custom_events.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-consume-cloudevent]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/champion_scenarios/cs6_consume_events_using_cloud_events_1.0_schema.py
[python-eg-sample-publish-sas-signature]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/eventgrid/azure-eventgrid/samples/publish_samples/publish_with_shared_access_signature_sample.py
[publisher-service-doc]: https://docs.microsoft.com/azure/event-grid/concepts

[cla]: https://cla.microsoft.com
Expand Down