Skip to content

Commit b7f6048

Browse files
rkodevrkodev
committed
update readme
1 parent a73070f commit b7f6048

4 files changed

Lines changed: 27 additions & 29 deletions

File tree

‎.gitignore‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
node_modules/
22
lib/
33
*.log
4-
*.tgz
4+
*.tgz
5+
6+
*.idea/

‎README.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
# Microsoft Graph SDK for Typescript
22

3-
Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your Typescript application!
3+
Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://learn.microsoft.com/graph/overview) into your Typescript application!
44

5-
> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
5+
> [!NOTE]
6+
> The Microsoft Graph Typescript SDK is currently in Pre-Release. This SDK allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
67
7-
>
8-
> **Note:** the Microsoft Graph Typescript SDK is currently in Pre-Release.
98

109
## 1. Installation
1110

@@ -24,14 +23,14 @@ npm install @microsoft/msgraph-sdk-users
2423
2524
### 2.1 Register your application
2625

27-
Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://docs.microsoft.com/graph/auth-register-app-v2).
26+
Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://learn.microsoft.com/graph/auth-register-app-v2).
2827

2928
### 2.2 Create an AuthenticationProvider object
3029

3130
An instance of the **GraphServiceClient** class handles building client. To create a new instance of this class, you need to provide an instance of **AuthenticationProvider**, which can authenticate requests to Microsoft Graph.
3231

3332
<!-- TODO restore that and remove the snippets below once the SDK hits GA and the public documentation has been updated -->
34-
<!-- For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://docs.microsoft.com/graph/sdks/choose-authentication-providers?tabs=typescript). -->
33+
<!-- For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://learn.microsoft.com/graph/sdks/choose-authentication-providers?tabs=typescript). -->
3534

3635
#### 2.2.1 Authorization Code Provider
3736

@@ -150,7 +149,7 @@ const graphServiceClient = createGraphServiceClient(requestAdapter);
150149

151150
## 3. Make requests against the service
152151

153-
After you have a **GraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://docs.microsoft.com/graph/api/overview?view=graph-rest-1.0).
152+
After you have a **GraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://learn.microsoft.com/graph/api/overview?view=graph-rest-1.0).
154153

155154
### 3.1 Get user's detailed information
156155

@@ -170,9 +169,9 @@ const jane = await graphServiceClient.users.byUserId("jane@contoso.com").get();
170169

171170
For more detailed documentation, see:
172171

173-
* [Overview](https://docs.microsoft.com/graph/overview)
174-
* [Collections](https://docs.microsoft.com/graph/sdks/paging)
175-
* [Making requests](https://docs.microsoft.com/graph/sdks/create-requests)
172+
* [Overview](https://learn.microsoft.com/graph/overview)
173+
* [Collections](https://learn.microsoft.com/graph/sdks/paging)
174+
* [Making requests](https://learn.microsoft.com/graph/sdks/create-requests)
176175
* [Known issues](https://github.com/MicrosoftGraph/msgraph-sdk-typescript/issues)
177176
* [Contributions](https://github.com/microsoftgraph/msgraph-sdk-typescript/blob/main/CONTRIBUTING.md)
178177

‎packages/msgraph-sdk-admin/README.md‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,11 @@
11
# `@microsoft/msgraph-sdk-admin`
22

3-
Get started with the Microsoft Graph SDK for TypeScript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your TypeScript application!
4-
5-
> **Note:** This package is a complementary package that allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
3+
Get started with the Microsoft Graph SDK for TypeScript by integrating the [Microsoft Graph API](https://learn.microsoft.com/graph/overview) into your TypeScript application!
64

75
This package provides a fluent API for interacting with Microsoft Graph administrative functions.
86

9-
> **Note:** This package is not a standalone package and is most functional when used in conjunction with the main Microsoft Graph SDK. Please refer to the installation and setup of [@microsoft/msgraph-sdk](https://github.com/microsoftgraph/msgraph-sdk-typescript/blob/main/README.md) for more information on setting up and using the SDK.
7+
> [!NOTE]
8+
> This package requires the `@microsoft/msgraph-sdk` package. It allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
109
1110

1211
## Installation
@@ -57,9 +56,9 @@ const graphServiceClient = createGraphServiceClient(requestAdapter);
5756

5857
For more detailed documentation, see:
5958

60-
* [Overview](https://docs.microsoft.com/graph/overview)
61-
* [Collections](https://docs.microsoft.com/graph/sdks/paging)
62-
* [Making requests](https://docs.microsoft.com/graph/sdks/create-requests)
59+
* [Overview](https://learn.microsoft.com/graph/overview)
60+
* [Collections](https://learn.microsoft.com/graph/sdks/paging)
61+
* [Making requests](https://learn.microsoft.com/graph/sdks/create-requests)
6362
* [Known issues](https://github.com/MicrosoftGraph/msgraph-sdk-typescript/issues)
6463
* [Contributions](https://github.com/microsoftgraph/msgraph-sdk-typescript/blob/main/CONTRIBUTING.md)
6564

‎packages/msgraph-sdk/README.md‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
# Microsoft Graph SDK for Typescript
22

3-
Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your Typescript application!
3+
Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://learn.microsoft.com/graph/overview) into your Typescript application!
44

5-
> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
6-
7-
>
8-
> **Note:** the Microsoft Graph Typescript SDK is currently in Pre-Release.
5+
> [!NOTE]
6+
> This SDK allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
97
108
## 1. Installation
119

@@ -24,14 +22,14 @@ npm install @microsoft/msgraph-sdk-users
2422
2523
### 2.1 Register your application
2624

27-
Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://docs.microsoft.com/graph/auth-register-app-v2).
25+
Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://learn.microsoft.com/graph/auth-register-app-v2).
2826

2927
### 2.2 Create an AuthenticationProvider object
3028

3129
An instance of the **GraphServiceClient** class handles building client. To create a new instance of this class, you need to provide an instance of **AuthenticationProvider**, which can authenticate requests to Microsoft Graph.
3230

3331
<!-- TODO restore that and remove the snippets below once the SDK hits GA and the public documentation has been updated -->
34-
<!-- For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://docs.microsoft.com/graph/sdks/choose-authentication-providers?tabs=typescript). -->
32+
<!-- For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://learn.microsoft.com/graph/sdks/choose-authentication-providers?tabs=typescript). -->
3533

3634
#### 2.2.1 Authorization Code Provider
3735

@@ -150,7 +148,7 @@ const graphServiceClient = createGraphServiceClient(requestAdapter);
150148

151149
## 3. Make requests against the service
152150

153-
After you have a **GraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://docs.microsoft.com/graph/api/overview?view=graph-rest-1.0).
151+
After you have a **GraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://learn.microsoft.com/graph/api/overview?view=graph-rest-1.0).
154152

155153
### 3.1 Get user's detailed information
156154

@@ -170,9 +168,9 @@ const jane = await graphServiceClient.users.byUserId("jane@contoso.com").get();
170168

171169
For more detailed documentation, see:
172170

173-
* [Overview](https://docs.microsoft.com/graph/overview)
174-
* [Collections](https://docs.microsoft.com/graph/sdks/paging)
175-
* [Making requests](https://docs.microsoft.com/graph/sdks/create-requests)
171+
* [Overview](https://learn.microsoft.com/graph/overview)
172+
* [Collections](https://learn.microsoft.com/graph/sdks/paging)
173+
* [Making requests](https://learn.microsoft.com/graph/sdks/create-requests)
176174
* [Known issues](https://github.com/MicrosoftGraph/msgraph-sdk-typescript/issues)
177175
* [Contributions](https://github.com/microsoftgraph/msgraph-sdk-typescript/blob/main/CONTRIBUTING.md)
178176

0 commit comments

Comments
 (0)