Skip to content

Commit 80a09b2

Browse files
committed
improved parameters section
1 parent f28bd40 commit 80a09b2

File tree

1 file changed

+32
-18
lines changed

1 file changed

+32
-18
lines changed

articles/time-series-insights/time-series-insights-authentication-and-authorization.md

Lines changed: 32 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -100,43 +100,57 @@ To perform authenticated queries against the [Time Series Insights REST APIs](ht
100100

101101
> [!IMPORTANT]
102102
> The token must be issued exactly to the `https://api.timeseries.azure.com/` resource (also known as the "audience" of the token).
103-
> * Your [Postman](https://www.getpostman.com/) **AuthURL** with therefore conform to: `https://login.microsoftonline.com/microsoft.onmicrosoft.com/oauth2/authorize?resource=https://api.timeseries.azure.com/`
103+
> * Your [Postman](https://www.getpostman.com/) **AuthURL** will therefore be: `https://login.microsoftonline.com/microsoft.onmicrosoft.com/oauth2/authorize?resource=https://api.timeseries.azure.com/`
104104
105105
> [!TIP]
106106
> See the hosted Azure Time Series Insights [client SDK sample visualization](https://tsiclientsample.azurewebsites.net/) to see how to authenticate with the Time Series Insights APIs programmatically using the [JavaScript Client SDK](https://github.com/microsoft/tsiclient/blob/master/docs/API.md) along with charts and graphs.
107107
108108
### HTTP headers
109109

110-
Required request headers:
110+
Required request headers are described below.
111111

112-
- `Authorization` for authentication and authorization, a valid OAuth 2.0 Bearer token must be passed in the Authorization header. The token must be issued exactly to the `https://api.timeseries.azure.com/` resource (also known as the "audience" of the token).
112+
| Required request header | Description |
113+
| --- | --- |
114+
| Authorization | To authenticate with Time Series Insights, a valid OAuth 2.0 Bearer token must be passed in the **Authorization** header. |
113115

114-
Optional request headers:
116+
> [!IMPORTANT]
117+
> * The token must be issued exactly to `https://api.timeseries.azure.com/` (which is known as the "audience" of the token).
118+
> * Note that `https://api.timeseries.azure.com/` is valid but `https://api.timeseries.azure.com` is not.
119+
120+
Optional request headers are described below.
115121

116-
- `Content-type` - only `application/json` is supported.
117-
- `x-ms-client-request-id` - a client request ID. Service records this value. Allows the service to trace operation across services.
118-
- `x-ms-client-session-id` - a client session ID. Service records this value. Allows the service to trace a group of related operations across services.
119-
- `x-ms-client-application-name` - name of the application that generated this request. Service records this value.
122+
| Optional request header | Description |
123+
| --- | --- |
124+
| Content-type | only `application/json` is supported. |
125+
| x-ms-client-request-id | A client request ID. The service records this value. Allows the service to trace operation across services. |
126+
| x-ms-client-session-id | A client session ID. The service records this value. Allows the service to trace a group of related operations across services. |
127+
| x-ms-client-application-name | Name of the application that generated this request. The service records this value. |
120128

121-
Response headers:
129+
Optional but recommended response headers are described below.
122130

123-
- `Content-type` - only `application/json` is supported.
124-
- `x-ms-request-id` - server-generated request ID. Can be used to contact Microsoft to investigate a request.
131+
| Response header | Description |
132+
| --- | --- |
133+
| Content-type | Only `application/json` is supported. |
134+
| x-ms-request-id | Server-generated request ID. Can be used to contact Microsoft to investigate a request. |
125135

126136
### HTTP parameters
127137

128-
Required URL query string parameters will depend on API version:
138+
Required URL query string parameters depend on API version.
129139

130-
- `api-version=2016-12-12`
131-
- `api-version=2018-11-01-preview`
132-
- `api-version=2018-08-15-preview`
140+
| Release | Possible API version values |
141+
| --- | --- |
142+
| General Availability | `api-version=2016-12-12`|
143+
| Preview | `api-version=2018-11-01-preview` |
144+
| Preview | `api-version=2018-08-15-preview` |
133145

134146
> [!TIP]
135-
> The required API query value to use for each API is specified in the [reference documentation](https://docs.microsoft.com/rest/api/time-series-insights/).
147+
> The required API query value to use for each API is given in the [reference documentation](https://docs.microsoft.com/rest/api/time-series-insights/).
136148
137-
Optional URL query string parameters:
149+
Optional URL query string parameters include setting a timeout for HTTP request execution times.
138150

139-
- `timeout=<timeout>` – server-side timeout for the request execution. Applicable only to the [Get Environment Events](https://docs.microsoft.com/rest/api/time-series-insights/ga-query-api#get-environment-events-api) and [Get Environment Aggregates](https://docs.microsoft.com/rest/api/time-series-insights/ga-query-api#get-environment-aggregates-api) APIs. Timeout value should be in ISO 8601 duration format, for example `"PT20S"` and should be in the range `1-30 s`. Default value is `30 s`.
151+
| Optional query parameter | Description |
152+
| --- | --- |
153+
| `timeout=<timeout>` | Server-side timeout for HTTP request execution. Applicable only to the [Get Environment Events](https://docs.microsoft.com/rest/api/time-series-insights/ga-query-api#get-environment-events-api) and [Get Environment Aggregates](https://docs.microsoft.com/rest/api/time-series-insights/ga-query-api#get-environment-aggregates-api) APIs. Timeout value should be in ISO 8601 duration format, for example `"PT20S"` and should be in the range `1-30 s`. Default value is `30 s`. |
140154

141155
## Next steps
142156

0 commit comments

Comments
 (0)