-
Notifications
You must be signed in to change notification settings - Fork 252
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: OfficeGlobal <[email protected]>
- Loading branch information
1 parent
1414fe0
commit 761ad39
Showing
6 changed files
with
690 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# Biblioteca cliente .NET de Microsoft Graph | ||
|
||
[![Estado de la compilación](https://ci.appveyor.com/api/projects/status/m8qncaosr2ry4ks6/branch/master?svg=true)](https://ci.appveyor.com/project/MIchaelMainer/msgraph-sdk-dotnet/branch/master) | ||
[![Versión de NuGet](https://buildstats.info/nuget/Microsoft.Graph)](https://www.nuget.org/packages/Microsoft.Graph/) | ||
|
||
¡Integre la [API de Microsoft Graph](https://graph.microsoft.io) en su | ||
proyecto de .NET! | ||
|
||
La biblioteca cliente .NET de Microsoft Graph se dirige a .NetStandard 1.1 y .NET Framework 4.5. | ||
|
||
## Instalación mediante NuGet | ||
|
||
Para instalar la biblioteca cliente a través de NuGet: | ||
|
||
* Busque `Microsoft.Graph` en la biblioteca NuGet o | ||
* Escriba `Install-Package Microsoft.Graph` en la Consola del Administrador de paquetes. | ||
|
||
## Introducción | ||
|
||
### 1. Registrar la aplicación | ||
|
||
Registre su aplicación para usar la API de Microsoft Graph con el [Portal de registro de aplicaciones de Microsoft](https://aka.ms/appregistrations). | ||
|
||
### 2. Autenticarse para el servicio de Microsoft Graph | ||
|
||
La Biblioteca cliente .NET de Microsoft Graph no incluye actualmente ninguna implementación de autenticación predeterminada. | ||
Hay un conjunto de proveedores de autenticación preliminar disponibles en el repositorio [msgraph-sdk-dotnet-auth](https://github.com/microsoftgraph/msgraph-sdk-dotnet-auth). Como alternativa, puede usar la clase integrada **DelegateAuthenticationProvider** para autenticar cada solicitud. | ||
Para obtener más información sobre `DelegateAuthenticationProvider`, vea la [información general de la biblioteca](docs/overview.md). | ||
|
||
La biblioteca recomendada para autenticar la Identidad de Microsoft (Azure AD) es [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet). | ||
|
||
Para ver un ejemplo de cómo autenticar una aplicación para UWP con el extremo de autenticación V2, vea la [Biblioteca de conexión UWP de Microsoft Graph](https://github.com/OfficeDev/Microsoft-Graph-UWP-Connect-Library). | ||
|
||
### 3. Crear un objeto de cliente de Microsoft Graph con un proveedor de autenticación | ||
|
||
Una instancia de la clase **GraphServiceClient** controla las solicitudes de creación, su envío a la API de Microsoft Graph y el procesamiento de las respuestas. | ||
Para crear una nueva instancia de esta clase, | ||
tiene que proporcionar una instancia de | ||
`IAuthenticationProvider` que pueda autenticar solicitudes en Microsoft Graph. | ||
|
||
Para obtener más información sobre la inicialización de una instancia de cliente, vea la [información general de la biblioteca](docs/overview.md) | ||
|
||
### 4. Realizar solicitudes a Graph | ||
|
||
Una vez que haya completado la autenticación y tenga un GraphServiceClient, puede empezar a realizar llamadas al servicio. | ||
Las solicitudes en el SDK siguen | ||
el formato de la sintaxis RESTful de la API de Microsoft Graph. | ||
|
||
Por ejemplo, para recuperar la unidad predeterminada de un usuario: | ||
|
||
```csharp | ||
var drive = await graphClient.Me.Drive.Request().GetAsync(); | ||
``` | ||
|
||
`GetAsync` devolverá un objeto `Drive` en caso de éxito y | ||
producirá un `ServiceException` en caso de error. | ||
|
||
Para obtener la carpeta raíz del usuario actual de la unidad predeterminada: | ||
|
||
```csharp | ||
var rootItem = await graphClient.Me.Drive.Root.Request().GetAsync(); | ||
``` | ||
|
||
`GetAsync` devolverá un `DriveItem` en caso de éxito y producirá un | ||
`ServiceException` en caso de error. | ||
|
||
Para obtener información general sobre cómo está diseñado el SDK, vea [información general](docs/overview.md). | ||
|
||
Las aplicaciones de ejemplo siguientes también están disponibles: | ||
* [Ejemplo de conexión UWP de Microsoft Graph](https://github.com/microsoftgraph/uwp-csharp-connect-sample) | ||
* [Ejemplo de fragmentos de código UWP para Microsoft Graph](https://github.com/microsoftgraph/uwp-csharp-snippets-sample) | ||
* [Ejemplo de MeetingBot de Microsoft Graph para UWP ](https://github.com/microsoftgraph/uwp-csharp-meetingbot-sample) | ||
* [Ejemplo de conexión de Microsoft Graph para ASP.NET 4.6](https://github.com/microsoftgraph/aspnet-connect-sample) | ||
* [Ejemplo de fragmentos de Microsoft Graph para ASP.NET 4.6](https://github.com/microsoftgraph/aspnet-snippets-sample) | ||
* [Biblioteca de fragmentos de Microsoft Graph SDK para Xamarin.Forms](https://github.com/microsoftgraph/xamarin-csharp-snippets-sample) | ||
* [Ejemplo de conexión de Microsoft Graph para Xamarin Forms](https://github.com/microsoftgraph/xamarin-csharp-connect-sample) | ||
* [Ejemplo del Administrador de reuniones de Microsoft Graph para Xamarin.Forms](https://github.com/microsoftgraph/xamarin-csharp-meetingmanager-sample) | ||
* [Ejemplo del Administrador de propiedad de Microsoft Graph para Xamarin Native](https://github.com/microsoftgraph/xamarin-csharp-propertymanager-sample) | ||
|
||
## Documentación y recursos | ||
|
||
* [Información general](docs/overview.md) | ||
* [Colecciones](docs/collections.md) | ||
* [Errores](docs/errors.md) | ||
* [Encabezados](docs/headers.md) | ||
* [API de Microsoft Graph](https://graph.microsoft.io) | ||
* [Notas de la versión](https://github.com/microsoftgraph/msgraph-sdk-dotnet/releases) | ||
|
||
## Notas | ||
|
||
Si desea usar una versión mayor que NewtonSoft.Json 6.0.1, instale primero NewtonSoft.Json. Por ejemplo, primero tendrá que instalar NewtonSoft.Json 9.0.1, si desea usar esto en la biblioteca mientras dirige .Net Core con standard1.0. | ||
|
||
Instale System.Runtime.InteropServices.RuntimeInformation antes de instalar Microsoft Graph >= 1.3, si tiene un problema al actualizar el paquete para una solución Xamarin. Es posible que también tenga que actualizar las referencias a Microsoft.NETCore.UniversalWindowsPlatform para >=5.2.2. | ||
|
||
## Problemas | ||
|
||
Para ver o registrar problemas, consulte [problemas](https://github.com/microsoftgraph/msgraph-sdk-dotnet/issues). | ||
|
||
Este proyecto ha adoptado el [Código de conducta de código abierto de Microsoft](https://opensource.microsoft.com/codeofconduct/). Para obtener más información, vea [Preguntas frecuentes sobre el código de conducta](https://opensource.microsoft.com/codeofconduct/faq/) o póngase en contacto con [[email protected]](mailto:[email protected]) si tiene otras preguntas o comentarios. | ||
|
||
## Otros recursos | ||
|
||
* Paquete NuGet: [https://www.nuget.org/packages/Microsoft.Graph](https://www.nuget.org/packages/Microsoft.Graph) | ||
|
||
## Creación local de la biblioteca | ||
|
||
Si está pensando en crear la biblioteca de forma local con el fin de contribuir al código o ejecutar pruebas, tendrá que: | ||
|
||
- Tener instalado el SDK de .NET Core (> 1.0) | ||
- Ejecutar `dotnet restore` desde la línea de comandos en el directorio de paquetes | ||
- Ejecutar `nuget restore` y `msbuild` desde CLI o ejecutar Crear desde Visual Studio para restaurar paquetes de Nuget y crear el proyecto | ||
|
||
## Licencia | ||
|
||
Copyright (c) Microsoft Corporation. Reservados todos los derechos. Publicado bajo la [licencia](LICENSE.txt) MIT. Consulte [Avisos de terceros](https://github.com/microsoftgraph/msgraph-sdk-dotnet/blob/master/THIRD%20PARTY%20NOTICES) para obtener información sobre los paquetes a los que se hace referencia mediante NuGet. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
# Bibliothèque cliente .NET Microsoft Graph | ||
|
||
[![État de la build](https://ci.appveyor.com/api/projects/status/m8qncaosr2ry4ks6/branch/master?svg=true)](https://ci.appveyor.com/project/MIchaelMainer/msgraph-sdk-dotnet/branch/master) | ||
[![version NuGet](https://buildstats.info/nuget/Microsoft.Graph)](https://www.nuget.org/packages/Microsoft.Graph/) | ||
|
||
Intégrez l'[API Microsoft Graph](https://graph.microsoft.io) | ||
dans votre projet .NET ! | ||
|
||
Cibles de la bibliothèque cliente Microsoft Graph .NET. NetStandard 1.1 et .NET Framework 4.5. | ||
|
||
## Installation via NuGet | ||
|
||
Installation de la bibliothèque cliente via NuGet : | ||
|
||
* Recherchez `Microsoft.Graph` dans la bibliothèque NuGet, ou | ||
* Tapez `Installe-package Microsoft.Graph` dans la console du Gestionnaire de package. | ||
|
||
## Prise en main | ||
|
||
### 1. Inscription de votre application | ||
|
||
Vous devez inscrire votre application dans le [Portail d’inscription des applications de Microsoft](https://aka.ms/appregistrations) pour utiliser l'API Microsoft Graph. | ||
|
||
### 2. S'authentifier au service de Microsoft Graph | ||
|
||
La bibliothèque client Microsoft Graph .NET n'inclut pas actuellement les implémentations d'authentification par défaut. | ||
Une liste de fournisseurs d'authentification en préversion est disponible dans le référentiel [msgraph-sdk-dotnet-auth](https://github.com/microsoftgraph/msgraph-sdk-dotnet-auth). | ||
Vous pouvez également utiliser la classe intégrée **DelegateAuthenticationProvider** pour authentifier chaque demande. Pour plus d’informations sur `DelegateAuthenticationProvider`, consultez la [présentation de la bibliothèque](docs/overview.md). | ||
|
||
La bibliothèque recommandée pour l’authentification auprès de Microsoft Identity (Azure AD) est [MSAL](https://github.com/AzureAD/microsoft-authentication-library-for-dotnet). | ||
|
||
Pour obtenir un exemple d’authentification d’une application UWP utilisant le point de terminaison d’authentification V2, voir la [Bibliothèque de connexion Microsoft Graph UWP](https://github.com/OfficeDev/Microsoft-Graph-UWP-Connect-Library). | ||
|
||
### 3. Créer un objet client Microsoft Graph avec un fournisseur d’authentification | ||
|
||
Une instance de la classe **GraphServiceClient** gère la création de demandes en les envoyant vers l’API Microsoft Graph et en traitant les réponses. | ||
Pour créer une nouvelle instance de cette classe, | ||
vous devez fournir une instance | ||
`IAuthenticationProvider` pouvant authentifier les demandes adressées à Microsoft Graph. | ||
|
||
Pour plus d’informations sur l’initialisation d’une instance client, voir la [présentation de la bibliothèque](docs/overview.md) | ||
|
||
### 4. Formuler des demandes auprès du Graph | ||
|
||
Lorsque vous avez terminé l'authentification et que vous disposez de GraphServiceClient, vous pouvez effectuer des appels vers le service. | ||
Les demandes dans le kit de développement logiciel | ||
respectent le format de la syntaxe RESTful de l’API Microsoft Graph. | ||
|
||
Par exemple, pour récupérer le lecteur par défaut d’un utilisateur : | ||
|
||
```csharp | ||
var drive = await graphClient.Me.Drive.Request().GetAsync(); | ||
``` | ||
|
||
`GetAsync` renvoie un objet `Drive` en cas de réussite, | ||
et lève une `ServiceException` en cas d’erreur. | ||
|
||
Obtenir le dossier racine du lecteur par défaut de l’utilisateur actuel : | ||
|
||
```csharp | ||
var rootItem = await graphClient.Me.Drive.Root.Request().GetAsync(); | ||
``` | ||
|
||
`GetAsync` renvoie un objet `DriveItem` en cas de réussite, | ||
et lève une `ServiceException` en cas d’erreur. | ||
|
||
Pour obtenir une vue générale sur la conception du kit de développement logiciel, voir [vue d’ensemble](docs/overview.md). | ||
|
||
Les exemples d’applications suivantes sont également disponibles : | ||
* [Exemple de connexion Microsoft Graph UWP](https://github.com/microsoftgraph/uwp-csharp-connect-sample) | ||
* [Petits exemples Microsoft Graph UWP](https://github.com/microsoftgraph/uwp-csharp-snippets-sample) | ||
* [Exemple Microsoft Graph MeetingBot pour UWP](https://github.com/microsoftgraph/uwp-csharp-meetingbot-sample) | ||
* [Exemple de connexion Microsoft Graph pour ASP.NET 4.6](https://github.com/microsoftgraph/aspnet-connect-sample) | ||
* [Petits exemples Microsoft Graph pour ASP.NET 4.6](https://github.com/microsoftgraph/aspnet-snippets-sample) | ||
* [Bibliothèque d’extraits Microsoft Graph SDK pour Xamarin.Forms](https://github.com/microsoftgraph/xamarin-csharp-snippets-sample) | ||
* [Exemple de connexion Microsoft Graph pour Xamarin.Forms](https://github.com/microsoftgraph/xamarin-csharp-connect-sample) | ||
* [Exemple de gestionnaire de réunions Microsoft Graph pour Xamarin.Forms](https://github.com/microsoftgraph/xamarin-csharp-meetingmanager-sample) | ||
* [Exemple de gestionnaire de propriétés Microsoft Graph pour Xamarin Native](https://github.com/microsoftgraph/xamarin-csharp-propertymanager-sample) | ||
|
||
## Documentation et ressources | ||
|
||
* [Vue d'ensemble](docs/overview.md) | ||
* [Collections](docs/collections.md) | ||
* [Erreurs](docs/errors.md) | ||
* [En-têtes](docs/headers.md) | ||
* [API Microsoft Graph](https://graph.microsoft.io) | ||
* [Notes de publication](https://github.com/microsoftgraph/msgraph-sdk-dotnet/releases) | ||
|
||
## Remarques | ||
|
||
Installez NewtonSoft.Json tout d’abord si vous voulez utiliser une version ultérieure à NewtonSoft.json 6.0.1. Par exemple, vous devez installer NewtonSoft.json 9.0.1 au préalable si vous voulez l'utiliser pour la bibliothèque tout en ciblant .Net Core avec standard1.0. | ||
|
||
Installez System.Runtime.InteropServices.RuntimeInformation avant d'installer Microsoft.Graph >=1.3 si vous rencontrez un problème lors de la mise à jour de package d'une solution Xamarin. Vous devrez peut-être également mettre à jour les références sur Microsoft.NETCore.UniversalWindowsPlatform vers > = 5.2.2. | ||
|
||
## Problèmes | ||
|
||
Pour afficher ou enregistrer des problèmes, voir [problèmes](https://github.com/microsoftgraph/msgraph-sdk-dotnet/issues). | ||
|
||
Ce projet a adopté le [Code de conduite Open Source de Microsoft](https://opensource.microsoft.com/codeofconduct/). Pour en savoir plus, reportez-vous à la [FAQ relative au code de conduite](https://opensource.microsoft.com/codeofconduct/faq/) ou contactez [[email protected]](mailto:[email protected]) pour toute question ou tout commentaire. | ||
|
||
## Autres ressources | ||
|
||
* Package NuGet : [https://www.nuget.org/packages/Microsoft.Graph](https://www.nuget.org/packages/Microsoft.Graph) | ||
|
||
## Création d’une bibliothèque locale | ||
|
||
Si vous envisagez de créer la bibliothèque localement à des fins de codes de contribution ou d’exécution de tests, vous devez : | ||
|
||
- Installer le .NET Core SDK (> 1.0) | ||
- Exécuter `dotnet restore` à partir de la ligne de commande dans le répertoire de votre package | ||
- Exécuter `nuget restore` et `msbuild` à partir de l'interface de ligne de commande (CLI) ou exécutez la Build à partir de Visual Studio pour restaurer les packages Nuget et créer le projet | ||
|
||
## Licence | ||
|
||
Copyright (c) Microsoft Corporation. Tous droits réservés. Sous [licence MIT](LICENSE.txt). Pour plus d'informations sur les packages référencés via NuGet, voir les [Notifications tierces](https://github.com/microsoftgraph/msgraph-sdk-dotnet/blob/master/THIRD%20PARTY%20NOTICES). |
Oops, something went wrong.