Skip to content

Commit dcb0898

Browse files
Merge pull request #296063 from DENKEN02MSFT/ADTFreshnessTop40_Row36
ADT Freshness - row 36
2 parents 5f67ea7 + 53a2a7b commit dcb0898

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

articles/digital-twins/how-to-use-apis.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: baanders
77
ms.service: azure-digital-twins
88
services: digital-twins
99
ms.topic: how-to
10-
ms.date: 08/07/2024
10+
ms.date: 03/10/2025
1111
---
1212

1313
# How to send requests to the Azure Digital Twins APIs using Visual Studio
@@ -17,8 +17,8 @@ ms.date: 08/07/2024
1717
This article contains information about the following steps:
1818

1919
1. Set up a Visual Studio project and `.http` file, with variables that represent your Azure Digital Twins instance.
20-
1. Use the Azure CLI to [get a bearer token](#add-bearer-token) that you can use to make API requests in Visual Studio.
21-
1. Use the [Azure Digital Twins REST API documentation](/rest/api/azure-digitaltwins/) as a resource to craft requests in the `.http` file, and send them to the Azure Digital Twins APIs.
20+
1. To authorize API requests in Visual Studio, use the Azure CLI to [get a bearer token](#add-bearer-token).
21+
1. To craft requests in the `.http` file and send them to the Azure Digital Twins APIs, use the [Azure Digital Twins REST API documentation](/rest/api/azure-digitaltwins/) as a resource.
2222

2323
Azure Digital Twins has two sets of APIs that you can work with: *data plane* and *control plane*. For more information about the difference between these API sets, see [Azure Digital Twins APIs and SDKs](concepts-apis-sdks.md). This article contains instructions for both API sets.
2424

@@ -38,7 +38,7 @@ Next, [download Visual Studio 2022](https://visualstudio.microsoft.com/vs/previe
3838

3939
## Set up Visual Studio project
4040

41-
In this section, you set up the project in Visual Studio that will be used to craft HTTP requests.
41+
In this section, you set up the project in Visual Studio that is used to craft HTTP requests.
4242

4343
Open Visual Studio on your machine, and create a new project. Use the **ASP.NET Core Empty** project template.
4444

@@ -48,9 +48,9 @@ Follow the instructions in [Create an .http file](/aspnet/core/test/http-files#c
4848

4949
### Add variables
5050

51-
Next, add some variables at the top of your `.http` file that will be used to connect to your Azure Digital Twins resource.
51+
Next, add some variables at the top of your `.http` file that are used to connect to your Azure Digital Twins resource.
5252

53-
The set of variables you need depends on which set of APIs you're using, so use the tabs below to select between [data plane](concepts-apis-sdks.md#data-plane-overview) and [control plane](concepts-apis-sdks.md#control-plane-overview) APIs.
53+
The set of variables you need depends on which set of APIs you're using, so use the following tabs to select between [data plane](concepts-apis-sdks.md#data-plane-overview) and [control plane](concepts-apis-sdks.md#control-plane-overview) APIs.
5454

5555
# [Data plane](#tab/data-plane)
5656

@@ -75,7 +75,7 @@ Add the following variables for control plane requests. They contain placeholder
7575

7676
## Add bearer token
7777

78-
Now that you've set up your Azure Digital Twins instance and Visual Studio project, you need to get a bearer token that HTTP requests can use to authorize against the Azure Digital Twins APIs.
78+
Now that you set up your Azure Digital Twins instance and Visual Studio project, you need to get a bearer token that HTTP requests can use to authorize against the Azure Digital Twins APIs.
7979

8080
There are multiple ways to obtain this token. This article uses the [Azure CLI](/cli/azure/install-azure-cli) to sign into your Azure account and obtain a token that way.
8181

@@ -90,7 +90,7 @@ Otherwise, you can open an [Azure Cloud Shell](https://shell.azure.com) window i
9090
9191
2. Next, use the [az account get-access-token](/cli/azure/account#az-account-get-access-token()) command to get a bearer token with access to the Azure Digital Twins service. In this command, you pass in the resource ID for the Azure Digital Twins service endpoint, in order to get an access token that can access Azure Digital Twins resources.
9292
93-
The required context for the token depends on which set of APIs you're using, so use the tabs below to select between [data plane](concepts-apis-sdks.md#data-plane-overview) and [control plane](concepts-apis-sdks.md#control-plane-overview) APIs.
93+
The required context for the token depends on which set of APIs you're using, so use the following tabs to select between [data plane](concepts-apis-sdks.md#data-plane-overview) and [control plane](concepts-apis-sdks.md#control-plane-overview) APIs.
9494
9595
# [Data plane](#tab/data-plane)
9696
@@ -112,7 +112,7 @@ Otherwise, you can open an [Azure Cloud Shell](https://shell.azure.com) window i
112112
>[!NOTE]
113113
> If you need to access your Azure Digital Twins instance using a service principal or user account that belongs to a different Microsoft Entra tenant from the instance, you need to request a token from the Azure Digital Twins instance's "home" tenant. For more information on this process, see [Write app authentication code](how-to-authenticate-client.md#authenticate-across-tenants).
114114
115-
3. Copy the value of `accessToken` in the result. This value is your **token value** that you'll paste into Visual Studio to authorize your requests.
115+
3. Copy the value of `accessToken` in the result. This value is your **token value** that you paste into Visual Studio to authorize your requests.
116116
117117
:::image type="content" source="media/how-to-use-apis/console-access-token.png" alt-text="Screenshot of the console showing the result of the az account get-access-token command. The accessToken field with a sample value is highlighted." lightbox="media/how-to-use-apis/console-access-token.png":::
118118
@@ -151,23 +151,23 @@ Now that your `.http` file is set up, you can add requests to the Azure Digital
151151

152152
Start by opening the [Azure Digital Twins REST API reference](/rest/api/azure-digitaltwins/). This documentation contains details of all the operations covered by the APIs. Navigate to the reference page of the request you want to run.
153153

154-
This article will use the [DigitalTwins Update API](/rest/api/digital-twins/dataplane/twins/digital-twins-update) from the data plane as an example.
154+
This article uses the [DigitalTwins Update API](/rest/api/digital-twins/dataplane/twins/digital-twins-update) from the data plane as an example.
155155

156156
1. **Add request template**: Copy the HTTP request shown in the reference documentation.
157157

158158
:::image type="content" source="media/how-to-use-apis/copy-request.png" alt-text="Screenshot of the HTTP request in the Digital Twins API documentation." lightbox="media/how-to-use-apis/copy-request.png":::
159159

160160
In Visual Studio, paste the request in a new line below the variables in your `.http` file.
161-
1. **Add parameters**: Look at the **URI Parameters** section of the reference documentation to see which parameter values are needed by the request. You can replace some with the [variables](#add-variables) you created earlier, and fill in other parameter values as appropriate. To reference a variable, put the variable name in double curly braces, like `{{variable}}`. For more details, see [Variables](/aspnet/core/test/http-files#variables).
161+
1. **Add parameters**: Look at the **URI Parameters** section of the reference documentation to see which parameter values are needed by the request. You can replace some with the [variables](#add-variables) you created earlier, and fill in other parameter values as appropriate. To reference a variable, put the variable name in double curly braces, like `{{variable}}`. For more information, see [Variables](/aspnet/core/test/http-files#variables).
162162

163163
>[!NOTE]
164-
>For data plane requests, `digitaltwins-hostname` is also a parameter. Replace this with `{{hostName}}` to use the value of your host name variable.
164+
>For data plane requests, `digitaltwins-hostname` is also a parameter. Replace this parameter value with `{{hostName}}` to use the value of your host name variable.
165165
166166
Here's how this step looks in an example request:
167167

168168
:::image type="content" source="media/how-to-use-apis/add-parameters.png" alt-text="Screenshot of the request with parameters in Visual Studio." lightbox="media/how-to-use-apis/add-parameters.png":::
169169

170-
1. **Add authorization**: Add the following line (exactly as written) directly underneath the request, to specify authentication with your bearer token variable.
170+
1. **Add authorization**: To specify authentication with your bearer token variable, add the following line (exactly as written) directly underneath the request.
171171

172172
```http
173173
Authorization: Bearer {{token}}
@@ -176,13 +176,13 @@ This article will use the [DigitalTwins Update API](/rest/api/digital-twins/data
176176
Here's how this step looks in an example request:
177177
178178
:::image type="content" source="media/how-to-use-apis/add-authorization.png" alt-text="Screenshot of the request with authorization line in Visual Studio." lightbox="media/how-to-use-apis/add-authorization.png":::
179-
1. **Add additional headers**: Look at the **Request Header** section of the reference documentation to see which header values can accompany the request. You may also want to include traditional HTTP headers like `Content-Type`. Add each header on its own line in the format `HeaderName: Value`. For more details, see [Request headers](/aspnet/core/test/http-files#request-headers).
179+
1. **Add additional headers**: Look at the **Request Header** section of the reference documentation to see which header values can accompany the request. You might also want to include traditional HTTP headers like `Content-Type`. Add each header on its own line in the format `HeaderName: Value`. For more information, see [Request headers](/aspnet/core/test/http-files#request-headers).
180180
181181
Here's how this step looks in an example request:
182182
183183
:::image type="content" source="media/how-to-use-apis/add-header.png" alt-text="Screenshot of the request with another header in Visual Studio." lightbox="media/how-to-use-apis/add-header.png":::
184184
185-
1. **Add body**: Look at the **Request Body** section of the reference documentation to see what body information might be needed by the request. Add the request body after a blank line. For more details, see [Request body](/aspnet/core/test/http-files#request-body).
185+
1. **Add body**: Look at the **Request Body** section of the reference documentation to see what body information might be needed by the request. Add the request body after a blank line. For more information, see [Request body](/aspnet/core/test/http-files#request-body).
186186
187187
Here's how this step looks in an example request:
188188
:::image type="content" source="media/how-to-use-apis/add-body.png" alt-text="Screenshot of the request with a body in Visual Studio." lightbox="media/how-to-use-apis/add-body.png":::
@@ -195,14 +195,14 @@ Visual Studio brings up a pane with the details of the response. Look at the **R
195195
196196
:::image type="content" source="media/how-to-use-apis/response.png" alt-text="Screenshot of the response in Visual Studio." lightbox="media/how-to-use-apis/response.png":::
197197
198-
### Add additional requests
198+
### Add more requests
199199
200200
To add more requests to the `.http` file, separate them with `###` as a delimiter.
201201
202202
:::image type="content" source="media/how-to-use-apis/multiple-requests.png" alt-text="Screenshot of multiple requests in one file in Visual Studio." lightbox="media/how-to-use-apis/multiple-requests.png":::
203203
204204
## Next steps
205205
206-
For more details about sending requests with `.http` files in Visual Studio, including syntax details and advanced scenarios, see [Use .http files in Visual Studio 2022](/aspnet/core/test/http-files).
206+
For more information about sending requests with `.http` files in Visual Studio, including syntax details and advanced scenarios, see [Use .http files in Visual Studio 2022](/aspnet/core/test/http-files).
207207
208208
To learn more about the Digital Twins APIs, read [Azure Digital Twins APIs and SDKs](concepts-apis-sdks.md), or view the [reference documentation for the REST APIs](/rest/api/azure-digitaltwins/).

0 commit comments

Comments
 (0)