Skip to content

Commit 0d5339a

Browse files
committed
fixed all Acrolynx issues
1 parent 88486b5 commit 0d5339a

8 files changed

+43
-43
lines changed

articles/event-grid/cloud-event-schema.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This article describes CloudEvents schema with Event Grid.
1717

1818
## Sample event using CloudEvents schema
1919

20-
Here is an example of an Azure Blob Storage event in the CloudEvents format:
20+
Here's an example of an Azure Blob Storage event in the CloudEvents format:
2121

2222
```json
2323
{
@@ -50,7 +50,7 @@ The headers values for events delivered in the CloudEvents schema and the Event
5050

5151
## Event Grid for CloudEvents
5252

53-
You can use Event Grid for both input and output of events in CloudEvents schema. You can use CloudEvents for system events, like Blob Storage events and IoT Hub events, and custom events. In addition to supporting CloudEvents, Event Grid suppports a proprietary, non-extensible, yet fully-functional [Event Grid event format](event-schema.md). The following table describes the transformation supported when using CloudEvents and Event Grid formats as an input schema in topics and as an output schema in event subscriptions. Note that an Event Grid output schema cannot be used when using CloudEvents as an input schema because CloudEvents supports [extension attributes](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md#cloudevent-attribute-extensions) which are not supported by the Event Grid schema.
53+
You can use Event Grid for both input and output of events in CloudEvents schema. You can use CloudEvents for system events, like Blob Storage events and IoT Hub events, and custom events. In addition to supporting CloudEvents, Event Grid supports a proprietary, nonextensible, yet fully functional [Event Grid event format](event-schema.md). The following table describes the transformation supported when using CloudEvents and Event Grid formats as an input schema in topics and as an output schema in event subscriptions. An Event Grid output schema can't be used when using CloudEvents as an input schema because CloudEvents supports [extension attributes](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md#cloudevent-attribute-extensions) that aren't supported by the Event Grid schema.
5454

5555
| Input schema | Output schema
5656
|--------------------|---------------------
@@ -59,7 +59,7 @@ You can use Event Grid for both input and output of events in CloudEvents schema
5959
| Event Grid format | Event Grid format
6060

6161

62-
For all event schemas, Event Grid requires validation when publishing to an event grid topic and when creating an event subscription. For more information, see [Event Grid security and authentication](security-authentication.md).
62+
For all event schemas, Event Grid requires validation when publishing to an Event Grid topic and when creating an event subscription. For more information, see [Event Grid security and authentication](security-authentication.md).
6363

6464
## Next steps
6565
See [How to use CloudEvents v1.0 schema with Event Grid](cloudevents-schema.md).

articles/event-grid/concepts-pull-delivery.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ A Namespace also provides DNS-integrated network endpoints and a range of access
6262

6363
## Throughput units
6464

65-
The capacity of Azure Event Grid namespace is controlled by throughput units (TUs) and allows user to control capacity of their namespace resource for message ingress and egress. See [Azure Event Grid quotas and limits](quotas-limits.md) for more information.
65+
The capacity of Azure Event Grid namespace is controlled by throughput units (TUs) and allows user to control capacity of their namespace resource for message ingress and egress. For more information, see [Azure Event Grid quotas and limits](quotas-limits.md).
6666

6767
## Topics
6868

articles/event-grid/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Azure Event Grid concepts (push delivery)
3-
description: Describes Azure Event Grid concepts that pertains to push delivery. Defines several key components of Event Grid.
3+
description: Describes Azure Event Grid concepts that pertain to push delivery. Defines several key components of Event Grid.
44
ms.topic: conceptual
55
ms.date: 05/24/2023
66
---

articles/event-grid/create-view-manage-event-subscriptions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,23 +77,23 @@ ms.date: 05/24/2023
7777

7878
### Simplified resource model
7979

80-
The event subscriptions under a [Namespace Topic](concepts-pull-delivery.md#namespace-topics) feature a simplified filtering configuration model when compared to that of event subscriptions to domains and to custom, system, partner, and domain topics. The filtering capabilities are the the same except for the scenarios documented in the following sections.
80+
The event subscriptions under a [Namespace Topic](concepts-pull-delivery.md#namespace-topics) feature a simplified filtering configuration model when compared to that of event subscriptions to domains and to custom, system, partner, and domain topics. The filtering capabilities are the same except for the scenarios documented in the following sections.
8181

8282
#### Filter on event data
8383

84-
Filtering on event `data` is not currently supported. This capability will be available in a future release.
84+
Filtering on event `data` isn't currently supported. This capability will be available in a future release.
8585

8686
#### Subject begins with
8787

88-
There is no dedicated configuration properties to specify filters on `subject`. You can configure filters in the following way to filter the context attribute `subject` with a value that begins with a string.
88+
There's no dedicated configuration properties to specify filters on `subject`. You can configure filters in the following way to filter the context attribute `subject` with a value that begins with a string.
8989

9090
| key value | operator | value |
9191
|-----------|:---------:|-----------|
9292
| subject | String begins with | **your string** |
9393

9494
#### Subject ends with
9595

96-
There is no dedicated configuration properties to specify filters on `subject`. You can configure filters in the following way to filter the context attribute `subject` with a value that ends with a string.
96+
There's no dedicated configuration properties to specify filters on `subject`. You can configure filters in the following way to filter the context attribute `subject` with a value that ends with a string.
9797

9898
| key value | operator | value |
9999
|-----------|:---------:|-----------|

articles/event-grid/event-schema.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
title: Azure Event Grid event schema
3-
description: Describes the properties and schema for the proprietary, non-extensible, yet fully-functional Event Grid format.
3+
description: Describes the properties and schema for the proprietary, nonextensible, yet fully functional Event Grid format.
44
ms.topic: reference
55
ms.date: 05/24/2023
66
---
77

88
# Azure Event Grid event schema
99

10-
This article describes the Event Grid schema, which is a proprietary, non-extensible, yet fully-functional event format. Event Grid still supports this event format and will continue to support it. However, [CloudEvents](cloud-event-schema.md) is the recommended event format to use. If you are using applications that use the Event Grid format, you may find useful the information in the [CloudEvents] section that describes the transformations between the Event Grid and CloudEvents format supported by Event Grid.
10+
This article describes the Event Grid schema, which is a proprietary, nonextensible, yet fully functional event format. Event Grid still supports this event format and will continue to support it. However, [CloudEvents](cloud-event-schema.md) is the recommended event format to use. If you're using applications that use the Event Grid format, you may find useful the information in the [CloudEvents] section that describes the transformations between the Event Grid and CloudEvents format supported by Event Grid.
1111

1212
This article describes in detail the properties and schema for the Event Grid format. Events consist of a set of four required string properties. The properties are common to all events from any publisher. The data object has properties that are specific to each publisher. For system topics, these properties are specific to the resource provider, such as Azure Storage or Azure Event Hubs.
1313

14-
Event sources send events to Azure Event Grid in an array, which can have several event objects. When posting events to an event grid topic, the array can have a total size of up to 1 MB. Each event in the array is limited to 1 MB. If an event or the array is greater than the size limits, you receive the response **413 Payload Too Large**. Operations are charged in 64 KB increments though. So, events over 64 KB will incur operations charges as though they were multiple events. For example, an event that is 130 KB would incur operations as though it were 3 separate events.
14+
Event sources send events to Azure Event Grid in an array, which can have several event objects. When posting events to an Event Grid topic, the array can have a total size of up to 1 MB. Each event in the array is limited to 1 MB. If an event or the array is greater than the size limits, you receive the response **413 Payload Too Large**. Operations are charged in 64 KB increments though. So, events over 64 KB incur operations charges as though they were multiple events. For example, an event that is 130 KB would incur operations as though it were three separate events.
1515

1616
Event Grid sends the events to subscribers in an array that has a single event. This behavior may change in the future.
1717

@@ -74,14 +74,14 @@ All events have the same following top-level data:
7474

7575
| Property | Type | Required | Description |
7676
| -------- | ---- | -------- | ----------- |
77-
| topic | string | No, but if included, must match the Event Grid topic Azure Resource Manager ID exactly. If not included, Event Grid will stamp onto the event. | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. |
78-
| subject | string | Yes | Publisher-defined path to the event subject. |
79-
| eventType | string | Yes | One of the registered event types for this event source. |
77+
| `topic` | string | No, but if included, must match the Event Grid topic Azure Resource Manager ID exactly. If not included, Event Grid stamps onto the event. | Full resource path to the event source. This field isn't writeable. Event Grid provides this value. |
78+
| `subject` | string | Yes | Publisher-defined path to the event subject. |
79+
| `eventType` | string | Yes | One of the registered event types for this event source. |
8080
| eventTime | string | Yes | The time the event is generated based on the provider's UTC time. |
81-
| id | string | Yes | Unique identifier for the event. |
82-
| data | object | No | Event data specific to the resource provider. |
83-
| dataVersion | string | No, but will be stamped with an empty value. | The schema version of the data object. The publisher defines the schema version. |
84-
| metadataVersion | string | Not required, but if included, must match the Event Grid Schema `metadataVersion` exactly (currently, only `1`). If not included, Event Grid will stamp onto the event. | The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value. |
81+
| `id` | string | Yes | Unique identifier for the event. |
82+
| `data` | object | No | Event data specific to the resource provider. |
83+
| `dataVersion` | string | No, but will be stamped with an empty value. | The schema version of the data object. The publisher defines the schema version. |
84+
| `metadataVersion` | string | Not required, but if included, must match the Event Grid Schema `metadataVersion` exactly (currently, only `1`). If not included, Event Grid stamps onto the event. | The schema version of the event metadata. Event Grid defines the schema of the top-level properties. Event Grid provides this value. |
8585

8686
To learn about the properties in the data object, see the event source:
8787

@@ -104,7 +104,7 @@ When publishing events to custom topics, create subjects for your events that ma
104104
Sometimes your subject needs more detail about what happened. For example, the **Storage Accounts** publisher provides the subject `/blobServices/default/containers/<container-name>/blobs/<file>` when a file is added to a container. A subscriber could filter by the path `/blobServices/default/containers/testcontainer` to get all events for that container but not other containers in the storage account. A subscriber could also filter or route by the suffix `.txt` to only work with text files.
105105

106106
## CloudEvents
107-
CloudEvents is the recommended event format to use. Azure Event Grid will continue investing in features related to at least [CloudEvents JSON](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md) format. Given the fact that some event sources like Azure services use the Event Grid format, the following table is provided to help help you understand the transformation supported when using CloudEvents and Event Grid formats as an input schema in topics and as an output schema in event subscriptions. Note that an Event Grid output schema cannot be used when using CloudEvents as an input schema because CloudEvents supports [extension attributes](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md#cloudevent-attribute-extensions) which are not supported by the Event Grid schema.
107+
CloudEvents is the recommended event format to use. Azure Event Grid continues investing in features related to at least [CloudEvents JSON](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md) format. Given the fact that some event sources like Azure services use the Event Grid format, the following table is provided to help you understand the transformation supported when using CloudEvents and Event Grid formats as an input schema in topics and as an output schema in event subscriptions. An Event Grid output schema can't be used when using CloudEvents as an input schema because CloudEvents supports [extension attributes](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/primer.md#cloudevent-attribute-extensions) that aren't supported by the Event Grid schema.
108108

109109
| Input schema | Output schema
110110
|--------------------|---------------------

articles/event-grid/publish-events-using-namespace-topics.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.date: 05/24/2023
1212

1313
This article describes the steps to publish and consume events using the [CloudEvents](https://github.com/cloudevents/spec) with [JSON format](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md) using namespace topics and event subscriptions.
1414

15-
Follow the steps in this article if you need to send application events to Event Grid so that they are received by consumer clients. Consumers connect to Event Grid to read the events ([pull delivery](pull-delivery-overview.md)).
15+
Follow the steps in this article if you need to send application events to Event Grid so that they're received by consumer clients. Consumers connect to Event Grid to read the events ([pull delivery](pull-delivery-overview.md)).
1616

1717
>[!Important]
1818
> Namespaces, namespace topics, and event subscriptions associated to namespace topics are iniatially available in the following regions:
@@ -46,8 +46,8 @@ The resource group is a logical collection into which Azure resources are deploy
4646

4747
Create a resource group with the [az group create](/cli/azure/group#az-group-create) command. We use this resource group to contain all resources created in this article.
4848

49-
The general steps to use CloudShell to run commands are:
50-
- Click on **Open Cloud Shell** to see an Azure Cloud Shell window on the right pane.
49+
The general steps to use Cloud Shell to run commands are:
50+
- Select **Open Cloud Shell** to see an Azure Cloud Shell window on the right pane.
5151
- Copy the command and paste into the Azure Cloud Shell window.
5252
- Press ENTER to run the command.
5353

@@ -78,7 +78,7 @@ Set the name you want to provide to your namespace on an environmental variable.
7878
namespace=<your-namespace-name>
7979
```
8080

81-
Create a namespace. You may want to change the location where it is deployed.
81+
Create a namespace. You may want to change the location where it's deployed.
8282

8383
```azurecli-interactive
8484
az resource create --resource-group $resource_group --namespace Microsoft.EventGrid --resource-type namespaces --name $namespace --location centraluseuap --properties "{}"
@@ -101,7 +101,7 @@ az resource create --resource-group $resource_group --namespace Microsoft.EventG
101101

102102
## Create an event subscription
103103

104-
Create an event subscription setting its delivery mode to *queue*, which supports [pull delivery](pull-delivery-overview.md#pull-delivery-1). For more information on all configuration options, refer to the latest Event Grid control plane [REST API](/rest/api/eventgrid).
104+
Create an event subscription setting its delivery mode to *queue*, which supports [pull delivery](pull-delivery-overview.md#pull-delivery-1). For more information on all configuration options,see the latest Event Grid control plane [REST API](/rest/api/eventgrid).
105105

106106
Set the name of your event subscription on a variable:
107107
```azurecli-interactive
@@ -142,7 +142,7 @@ Create a sample CloudEvents-compliant event:
142142
event=' { "specversion": "1.0", "id": "'"$RANDOM"'", "type": "com.yourcompany.order.ordercreatedV2", "source" : "/mycontext", "subject": "orders/O-234595", "time": "'`date +%Y-%m-%dT%H:%M:%SZ`'", "datacontenttype" : "application/json", "data":{ "orderId": "O-234595", "url": "https://yourcompany.com/orders/o-234595"}} '
143143
```
144144

145-
The `data` element is the payload of your event. Any well-formed JSON can go in this field. See the [CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md) specifications for more information on properties (also known as context attributes) that can go in an event.
145+
The `data` element is the payload of your event. Any well-formed JSON can go in this field. For more information on properties (also known as context attributes) that can go in an event, see the [CloudEvents](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md) specifications.
146146

147147
CURL is a utility that sends HTTP requests. In this article, use CURL to send the event to the topic.
148148

0 commit comments

Comments
 (0)