Skip to content

Commit 6378fae

Browse files
committed
Grammatical improvements and end link creation for Creator articles
1 parent 7835201 commit 6378fae

9 files changed

+230
-185
lines changed

articles/azure-maps/creator-facility-ontology.md

Lines changed: 140 additions & 114 deletions
Large diffs are not rendered by default.
Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Azure Maps Creator service geographic scope
33
description: Learn about Azure Maps Creator service's geographic mappings in Azure Maps
4-
author: eriklindeman
5-
ms.author: eriklind
4+
author: brendansco
5+
ms.author: Brendanc
66
ms.date: 05/18/2021
77
ms.topic: conceptual
88
ms.service: azure-maps
@@ -12,7 +12,7 @@ ms.custom: mvc, references_regions
1212

1313
# Creator service geographic scope
1414

15-
Azure Maps Creator is a geographically scoped service. Creator offers a resource provider API that, given an Azure region, creates an instance of Creator data deployed at the geographical level. The mapping from an Azure region to geography happens behind the scenes as described in the table below. For more details on Azure regions and geographies, see [Azure geographies](https://azure.microsoft.com/global-infrastructure/geographies).
15+
Azure Maps Creator is a geographically scoped service. Creator offers a resource provider API that, given an Azure region, creates an instance of Creator data deployed at the geographical level. The mapping from an Azure region to geography happens behind the scenes as described in the following table. For more information on Azure regions and geographies, see [Azure geographies].
1616

1717
## Data locations
1818

@@ -22,8 +22,9 @@ For disaster recovery and high availability, Microsoft may replicate customer da
2222

2323
The following table describes the mapping between geography and supported Azure regions, and the respective geographic API endpoint. For example, if a Creator account is provisioned in the West US 2 region that falls within the United States geography, all API calls to the Conversion service must be made to `us.atlas.microsoft.com/conversion/convert`.
2424

25-
2625
| Azure Geographic areas (geos) | Azure datacenters (regions) | API geographic endpoint |
2726
|------------------------|----------------------|-------------|
2827
| Europe| West Europe, North Europe | eu.atlas.microsoft.com |
2928
|United States | West US 2, East US 2 | us.atlas.microsoft.com |
29+
30+
[Azure geographies]: https://azure.microsoft.com/global-infrastructure/geographies

articles/azure-maps/creator-indoor-maps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22
title: Work with indoor maps in Azure Maps Creator
33
titleSuffix: Azure Maps Creator
44
description: This article introduces concepts that apply to Azure Maps Creator services
5-
author: eriklindeman
6-
ms.author: eriklind
5+
author: brendansco
6+
ms.author: Brendanc
77
ms.date: 04/01/2022
88
ms.topic: conceptual
99
ms.service: azure-maps

articles/azure-maps/creator-long-running-operation-v2.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Azure Maps long-running operation API V2
33
description: Learn about long-running asynchronous V2 background processing in Azure Maps
4-
author: eriklindeman
5-
ms.author: eriklind
4+
author: brendansco
5+
ms.author: Brendanc
66
ms.date: 05/18/2021
77
ms.topic: conceptual
88
ms.service: azure-maps
@@ -12,11 +12,11 @@ ms.custom: mvc
1212

1313
# Creator Long-Running Operation API V2
1414

15-
Some APIs in Azure Maps use an [Asynchronous Request-Reply pattern](/azure/architecture/patterns/async-request-reply). This pattern allows Azure Maps to provide highly available and responsive services. This article explains Azure Map's specific implementation of long-running asynchronous background processing.
15+
Some APIs in Azure Maps use an [Asynchronous Request-Reply pattern]. This pattern allows Azure Maps to provide highly available and responsive services. This article explains Azure Map's specific implementation of long-running asynchronous background processing.
1616

1717
## Submit a request
1818

19-
A client application starts a long-running operation through a synchronous call to an HTTP API. Typically, this call is in the form of an HTTP POST request. When an asynchronous workload is successfully created, the API will return an HTTP `202` status code, indicating that the request has been accepted. This response contains a `Location` header pointing to an endpoint that the client can poll to check the status of the long-running operation.
19+
A client application starts a long-running operation through a synchronous call to an HTTP API. Typically, this call is in the form of an HTTP POST request. When an asynchronous workload is successfully created, the API returns an HTTP `202` status code, indicating that the request has been accepted. This response contains a `Location` header pointing to an endpoint that the client can poll to check the status of the long-running operation.
2020

2121
### Example of a success response
2222

@@ -26,11 +26,11 @@ Operation-Location: https://atlas.microsoft.com/service/operations/{operationId}
2626
2727
```
2828

29-
If the call doesn't pass validation, the API will instead return an HTTP `400` response for a Bad Request. The response body will provide the client more information on why the request was invalid.
29+
If the call doesn't pass validation, the API returns an HTTP `400` response for a Bad Request. The response body provides the client more information on why the request was invalid.
3030

3131
### Monitor the operation status
3232

33-
The location endpoint provided in the accepted response headers can be polled to check the status of the long-running operation. The response body from operation status request will always contain the `status` and the `created` properties. The `status` property shows the current state of the long-running operation. Possible states include `"NotStarted"`, `"Running"`, `"Succeeded"`, and `"Failed"`. The `created` property shows the time the initial request was made to start the long-running operation. When the state is either `"NotStarted"` or `"Running"`, a `Retry-After` header will also be provided with the response. The `Retry-After` header, measured in seconds, can be used to determine when the next polling call to the operation status API should be made.
33+
The location endpoint provided in the accepted response headers can be polled to check the status of the long-running operation. The response body from operation status request always contains the `status` and the `created` properties. The `status` property shows the current state of the long-running operation. Possible states include `"NotStarted"`, `"Running"`, `"Succeeded"`, and `"Failed"`. The `created` property shows the time the initial request was made to start the long-running operation. When the state is either `"NotStarted"` or `"Running"`, a `Retry-After` header is also provided with the response. The `Retry-After` header, measured in seconds, can be used to determine when the next polling call to the operation status API should be made.
3434

3535
### Example of running a status response
3636

@@ -46,7 +46,7 @@ Retry-After: 30
4646

4747
## Handle operation completion
4848

49-
Upon completing the long-running operation, the status of the response will either be `"Succeeded"` or `"Failed"`. All responses will return an HTTP 200 OK code. When a new resource has been created from a long-running operation, the response will also contain a `Resource-Location` header that points to metadata about the resource. Upon a failure, the response will have an `error` property in the body. The error data adheres to the OData error specification.
49+
Once the long-running operation completes, the status of the response is either `"Succeeded"` or `"Failed"`. All responses return an HTTP 200 OK code. When a new resource has been created from a long-running operation, the response also contains a `Resource-Location` header that points to metadata about the resource. Upon a failure, the response has an `error` property in the body. The error data adheres to the OData error specification.
5050

5151
### Example of success response
5252

@@ -79,3 +79,5 @@ Status: 200 OK
7979
}
8080
}
8181
```
82+
83+
[Asynchronous Request-Reply pattern]: /azure/architecture/patterns/async-request-reply

articles/azure-maps/creator-long-running-operation.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Azure Maps Long-Running Operation API
33
description: Learn about long-running asynchronous background processing in Azure Maps
4-
author: eriklindeman
5-
ms.author: eriklind
4+
author: brendansco
5+
ms.author: Brendanc
66
ms.date: 12/07/2020
77
ms.topic: conceptual
88
ms.service: azure-maps
@@ -12,11 +12,11 @@ ms.custom: mvc
1212

1313
# Creator Long-Running Operation API
1414

15-
Some APIs in Azure Maps use an [Asynchronous Request-Reply pattern](/azure/architecture/patterns/async-request-reply). This pattern allows Azure Maps to provide highly available and responsive services. This article explains Azure Map's specific implementation of long-running asynchronous background processing.
15+
Some APIs in Azure Maps use an [Asynchronous Request-Reply pattern]. This pattern allows Azure Maps to provide highly available and responsive services. This article explains Azure Map's specific implementation of long-running asynchronous background processing.
1616

1717
## Submitting a request
1818

19-
A client application starts a long-running operation through a synchronous call to an HTTP API. Typically, this call is in the form of an HTTP POST request. When an asynchronous workload is successfully created, the API will return an HTTP `202` status code, indicating that the request has been accepted. This response contains a `Location` header pointing to an endpoint that the client can poll to check the status of the long-running operation.
19+
A client application starts a long-running operation through a synchronous call to an HTTP API. Typically, this call is in the form of an HTTP POST request. When an asynchronous workload is successfully created, the API returns an HTTP `202` status code, indicating that the request has been accepted. This response contains a `Location` header pointing to an endpoint that the client can poll to check the status of the long-running operation.
2020

2121
### Example of a success response
2222

@@ -26,11 +26,11 @@ Location: https://atlas.microsoft.com/service/operations/{operationId}
2626
2727
```
2828

29-
If the call doesn't pass validation, the API will instead return an HTTP `400` response for a Bad Request. The response body will provide the client more information on why the request was invalid.
29+
If the call doesn't pass validation, the API returns an HTTP `400` response for a Bad Request. The response body provides the client more information on why the request was invalid.
3030

3131
### Monitoring the operation status
3232

33-
The location endpoint provided in the accepted response headers can be polled to check the status of the long-running operation. The response body from operation status request will always contain the `status` and the `createdDateTime` properties. The `status` property shows the current state of the long-running operation. Possible states include `"NotStarted"`, `"Running"`, `"Succeeded"`, and `"Failed"`. The `createdDateTime` property shows the time the initial request was made to start the long-running operation. When the state is either `"NotStarted"` or `"Running"`, a `Retry-After` header will also be provided with the response. The `Retry-After` header, measured in seconds, can be used to determine when the next polling call to the operation status API should be made.
33+
The location endpoint provided in the accepted response headers can be polled to check the status of the long-running operation. The response body from operation status request contains the `status` and the `createdDateTime` properties. The `status` property shows the current state of the long-running operation. Possible states include `"NotStarted"`, `"Running"`, `"Succeeded"`, and `"Failed"`. The `createdDateTime` property shows the time the initial request was made to start the long-running operation. When the state is either `"NotStarted"` or `"Running"`, a `Retry-After` header is also provided with the response. The `Retry-After` header, measured in seconds, can be used to determine when the next polling call to the operation status API should be made.
3434

3535
### Example of running a status response
3636

@@ -46,7 +46,7 @@ Retry-After: 30
4646

4747
## Handling operation completion
4848

49-
Upon completing the long-running operation, the status of the response will either be `"Succeeded"` or `"Failed"`. When a new resource has been created from a long-running operation, the success response will return an HTTP `201 Created` status code. The response will also contain a `Location` header that points to metadata about the resource. When no new resource has been created, the success response will return an HTTP `200 OK` status code. Upon a failure, the response status code will also be the `200 OK`code. However, the response will have an `error` property in the body. The error data adheres to the OData error specification.
49+
Once the long-running operation completes, the status of the response is either `"Succeeded"` or `"Failed"`. When a new resource has been created from a long-running operation, the success response returns an HTTP `201 Created` status code. The response also contains a `Location` header that points to metadata about the resource. When no new resource has been created, the success response returns an HTTP `200 OK` status code. Upon a failure, the response status code is also `200 OK`. However, the response has an `error` property in the body. The error data adheres to the OData error specification.
5050

5151
### Example of success response
5252

@@ -80,3 +80,5 @@ Status: 200 OK
8080
}
8181
}
8282
```
83+
84+
[Asynchronous Request-Reply pattern]: /azure/architecture/patterns/async-request-reply

articles/azure-maps/how-to-creator-feature-stateset.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ If using a tool like [Postman], it should look like this:
4242

4343
:::image type="content" source="./media/tutorial-creator-indoor-maps/stateset-header.png"alt-text="A screenshot of Postman showing the Header tab of the POST request that shows the Content Type Key with a value of application forward slash json.":::
4444

45-
Finally, in the **Body** of the HTTP request, include the style information in raw JSON format, this applies different colors to the `occupied` property depending on its value:
45+
Finally, in the **Body** of the HTTP request, include the style information in raw JSON format, which applies different colors to the `occupied` property depending on its value:
4646

4747
```json
4848
{
@@ -61,13 +61,13 @@ Finally, in the **Body** of the HTTP request, include the style information in r
6161
}
6262
```
6363

64-
After the response returns successfully, copy the `statesetId` from the response body. In the next section, you'll use the `statesetId` to change the `occupancy` property state of the unit with feature `id` "UNIT26". If using Postman, it will appear as follows:
64+
After the response returns successfully, copy the `statesetId` from the response body. In the next section, you'll use the `statesetId` to change the `occupancy` property state of the unit with feature `id` "UNIT26". If using Postman, it appears as follows:
6565

6666
:::image type="content" source="./media/tutorial-creator-indoor-maps/response-stateset-id.png"alt-text="A screenshot of Postman showing the resource Stateset ID value in the responses body.":::
6767

6868
## Update a feature state
6969

70-
In this section you will learn how to update the `occupied` state of the unit with feature `id` "UNIT26". To do this, create a new **HTTP PUT Request** calling the [Feature Statesets API]. The request should look like the following URL (replace `{statesetId}` with the `statesetId` obtained in [Create a feature stateset](#create-a-feature-stateset)):
70+
This section demonstrates how to update the `occupied` state of the unit with feature `id` "UNIT26". To update the `occupied` state, create a new **HTTP PUT Request** calling the [Feature Statesets API]. The request should look like the following URL (replace `{statesetId}` with the `statesetId` obtained in [Create a feature stateset]):
7171

7272
```http
7373
https://us.atlas.microsoft.com/featurestatesets/{statesetId}/featureStates/UNIT26?api-version=2.0&subscription-key={Your-Azure-Maps-Subscription-key}
@@ -79,7 +79,7 @@ If using a tool like [Postman], it should look like this:
7979

8080
:::image type="content" source="./media/tutorial-creator-indoor-maps/stateset-header.png"alt-text="A screenshot of the header tab information for stateset creation.":::
8181

82-
Finally, in the **Body** of the HTTP request, include the style information in raw JSON format, this applies different colors to the `occupied` property depending on its value:
82+
Finally, in the **Body** of the HTTP request, include the style information in raw JSON format, which applies different colors to the `occupied` property depending on its value:
8383

8484
```json
8585
{
@@ -96,11 +96,11 @@ Finally, in the **Body** of the HTTP request, include the style information in r
9696
>[!NOTE]
9797
> The update will be saved only if the time posted stamp is after the time stamp of the previous request.
9898
99-
Once the HTTP request is sent and the update completes, you'll receive a `200 OK` HTTP status code. If you implemented [dynamic styling] for an indoor map, the update displays at the specified time stamp in your rendered map.
99+
Once the HTTP request is sent and the update completes, you receive a `200 OK` HTTP status code. If you implemented [dynamic styling] for an indoor map, the update displays at the specified time stamp in your rendered map.
100100

101101
## Additional information
102102

103-
* For information on how to retrieve the state of a feature using its feature id, see [Feature State - List States].
103+
* For information on how to retrieve the state of a feature using its feature ID, see [Feature State - List States].
104104
* For information on how to delete the stateset and its resources, see [Feature State - Delete Stateset].
105105
* For information on using the Azure Maps Creator [Feature State service] to apply styles that are based on the dynamic properties of indoor map data features, see how to article [Implement dynamic styling for Creator indoor maps].
106106

@@ -113,16 +113,24 @@ Learn how to implement dynamic styling for indoor maps.
113113
> [!div class="nextstepaction"]
114114
> [dynamic styling]
115115
116+
<!--------- Internal Links --------------->
117+
[Create a feature stateset]: #create-a-feature-stateset
118+
119+
<!--------- learn.microsoft.com links --------------->
116120
[Access to Creator Services]: how-to-manage-creator.md#access-to-creator-services
117-
[Query datasets with WFS API]: how-to-creator-wfs.md
118-
[Stateset API]: /rest/api/maps/v2/feature-state/create-stateset
119-
[Feature Statesets API]: /rest/api/maps/v2/feature-state/create-stateset
120-
[Feature statesets]: /rest/api/maps/v2/feature-state
121121
[Check the dataset creation status]: tutorial-creator-indoor-maps.md#check-the-dataset-creation-status
122+
[Creator Indoor Maps]: creator-indoor-maps.md
122123
[dynamic styling]: indoor-map-dynamic-styling.md
123-
[Feature State - List States]: /rest/api/maps/v2/feature-state/list-states
124-
[Feature State - Delete Stateset]: /rest/api/maps/v2/feature-state/delete-stateset
125-
[Feature State service]: /rest/api/maps/v2/feature-state
126124
[Implement dynamic styling for Creator indoor maps]: indoor-map-dynamic-styling.md
127-
[Creator Indoor Maps]: creator-indoor-maps.md
125+
[Query datasets with WFS API]: how-to-creator-wfs.md
126+
127+
<!--------- External Links --------------->
128128
[Postman]: https://www.postman.com/
129+
130+
<!--------- REST API Links --------------->
131+
[Feature State - Delete Stateset]: /rest/api/maps/v2/feature-state/delete-stateset
132+
[Feature State - List States]: /rest/api/maps/v2/feature-state/list-states
133+
[Feature State service]: /rest/api/maps/v2/feature-state
134+
[Feature Statesets API]: /rest/api/maps/v2/feature-state/create-stateset
135+
[Feature statesets]: /rest/api/maps/v2/feature-state
136+
[Stateset API]: /rest/api/maps/v2/feature-state/create-stateset

0 commit comments

Comments
 (0)