Beispiel: Moderne OData-App für Windows 8-Desktop
Veröffentlicht: November 2016
Gilt für: Dynamics CRM 2015
Dieser Beispielcode ist für Microsoft Dynamics CRM 2015 und Microsoft Dynamics CRM Online 2015-Update.Dieser Code ist an folgender Position im Downloadpaket verfügbar:
SampleCode\CS\ModernAndMobileApps\ModernOdataApp
Laden Sie das Microsoft Dynamics CRM SDK-Paket herunter.
Anforderungen
Für dieses Beispiel sind die NuGet-Pakete Microsoft.Preview.WindowsAzure.ActiveDirectory.Authentication und Microsoft.IdentityModel.Clients.ActiveDirectory erforderlich. Diese Pakete werden automatisch heruntergeladen und installiert, wenn Sie die Lösung des Projekts laden.
Weitere Informationen zu den Anforderungen zum Ausführen des in diesem SDK enthaltenen Beispielcodes finden Sie unter Verwenden des Beispiel- und Hilfscode.
Demonstriert
.jpeg "Hauptbildschirm der Windows 8-Beispiel-App")
Gekachelte Benutzeroberfläche der Beispiel-App |
Dieses Beispiel zeigt, wie Sie eine moderne Windows 8.1-Desktopanwendung schreiben, die Anfragen an Organisationswebdienste senden kann, ohne eine Verknüpfung mit den SDK-Assemblys herzustellen. In diesem Beispiel werden das Microsoft Azure-Active Directory-Authentifizierungsbibliothek (Active Directory Authentication Library; ADAL)- und OData-Protokoll verwendet. Auf der Hauptseite der App werden zwar sieben Kacheln angezeigt, jedoch sind nur die Konten- und Aufgabenkacheln mit Ereignishandlercode verbunden. Die anderen Kacheln sind nur Platzhalter. Der Beispielcode ist für den Microsoft Dynamics CRM Online-Server und eine fiktive Organisation konfiguriert, kann aber auch mit einem IFD-Server verwendet werden. Codeausschnitte, die nur die wichtigen Abschnitte des vollständigen Beispiels zeigen, werden weiter unten in diesem Thema angezeigt. |
Beispiel
Der folgende Codeausschnitt zeigt, wie der Benutzer mit dem Organisationswebdienst authentifiziert wird.
using Microsoft.IdentityModel.Clients.ActiveDirectory;
using System;
using System.Threading.Tasks;
using Windows.UI.Popups;
using Windows.Security.Authentication.Web;
using System.Net;
using System.Threading;
using System.IO;
using System.Text;
namespace ModernOdataApp
{
/// <summary>
/// Manages authentication with the organization web service.
/// </summary>
public static class CurrentEnvironment
{
# region Class Level Members
private static AuthenticationContext _authenticationContext;
// TODO Set these string values as approppriate for your app registration and organization.
// For more information, see the SDK topic "Walkthrough: Register an app with Active Directory".
private const string _clientID = "893262be-fbdc-4556-9325-9f863b69495b";
public const string CrmServiceUrl = "https://my-domain.crm.dynamics.com/";
# endregion
// <summary>
/// Perform any required app initialization.
/// This is where authentication with Active Directory is performed.
public static async Task<string> Initialize()
{
Uri serviceUrl = new System.Uri(CrmServiceUrl + "/XRMServices/2011/Organization.svc/web?SdkClientVersion=6.1.0000.0000");
// Dyamics CRM Online OAuth URL.
string _oauthUrl = DiscoveryAuthority(serviceUrl);
// Obtain the redirect URL for the app. This is only needed for app registration.
Uri redirectUri = WebAuthenticationBroker.GetCurrentApplicationCallbackUri();
// Obtain an authentication token to access the web service.
_authenticationContext = new AuthenticationContext(_oauthUrl, false);
AuthenticationResult result = await _authenticationContext.AcquireTokenAsync(CrmServiceUrl, _clientID, redirectUri);
// Verify that an access token was successfully acquired.
if (result.Status != AuthenticationStatus.Success)
{
if (result.Error == "authentication_failed")
{
// Try again.
_authenticationContext = new AuthenticationContext(_oauthUrl, false);
result = await _authenticationContext.AcquireTokenAsync(CrmServiceUrl, _clientID, redirectUri);
}
else
{
DisplayErrorWhenAcquireTokenFails(result);
}
}
return result.AccessToken;
}
/// <summary>
/// Discover the authentication authority.
/// </summary>
/// <param name="serviceUrl">The URL of the organization's SOAP endpoint. </param>
/// <returns>The authority URL.</returns>
/// <remarks>The service URL must contain the SdkClient property.</remarks>
/// <example>https://contoso.crm.dynamics.com/XRMServices/2011/Organization.svc/web?SdkClientVersion=6.1.0.533;</example>
public static string DiscoveryAuthority(Uri serviceUrl)
{
// Use AuthenticationParameters to send a request to the organization's endpoint and
// receive tenant information in the 401 challenge.
Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters parameters = null;
HttpWebResponse response = null;
try
{
// Create a web request where the authorization header contains the word "Bearer".
HttpWebRequest httpWebRequest = (HttpWebRequest)WebRequest.Create(serviceUrl);
// The response is to be encoded.
httpWebRequest.ContentType = "application/x-www-form-urlencoded";
response = (HttpWebResponse)httpWebRequest.GetResponse();
}
catch (WebException ex)
{
response = (HttpWebResponse)ex.Response;
// A 401 error should be returned. Extract any parameters from the response.
// The response should contain an authorization_uri parameter.
parameters = Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters.
CreateFromResponseAuthenticateHeader((response.Headers)["WWW-Authenticate"]);
}
finally
{
if (response != null)
response.Dispose();
}
// Return the authority URL.
return parameters.Authority;
}
/// <summary>
/// Returns a response from an Internet resource.
/// </summary>
public static WebResponse GetResponse(this WebRequest request)
{
AutoResetEvent autoResetEvent = new AutoResetEvent(false);
IAsyncResult asyncResult = request.BeginGetResponse(r => autoResetEvent.Set(), null);
// Wait until the call is finished
autoResetEvent.WaitOne(DefaultRequestTimeout);
return request.EndGetResponse(asyncResult);
}
/// <summary>
/// Get the DefaultRequestTimeout from the server.
/// </summary>
public static TimeSpan DefaultRequestTimeout { get; set; }
/// <summary>
/// Display an error message to the user.
/// </summary>
/// <param name="result">The authentication result returned from AcquireTokenAsync().</param>
private static async void DisplayErrorWhenAcquireTokenFails(AuthenticationResult result)
{
MessageDialog dialog;
switch (result.Error)
{
case "authentication_canceled":
// User cancelled, so no need to display a message.
break;
case "temporarily_unavailable":
case "server_error":
dialog = new MessageDialog("Please retry the operation. If the error continues, please contact your administrator.",
"Sorry, an error has occurred.");
await dialog.ShowAsync();
break;
default:
// An error occurred when acquiring a token so show the error description in a MessageDialog.
dialog = new MessageDialog(string.Format(
"If the error continues, please contact your administrator.\n\nError: {0}\n\nError Description:\n\n{1}",
result.Error, result.ErrorDescription), "Sorry, an error has occurred.");
await dialog.ShowAsync();
break;
}
}
}
}
Damit dieser Code funktioniert, müssen Sie die App zunächst bei einem unterstützten Identitätsanbieter registrieren (AD FS oder Microsoft Azure Active Directory). Anschließend müssen Sie die Variablenwerte für _clientID und CrmServiceUrl im Code festlegen. Der Wert für Client-ID wurde bei der App-Registrierung definiert.Weitere Informationen:Exemplarische Vorgehensweise: Registrieren einer CRM-App bei Active Directory
Beispiel
Der folgende Codeausschnitt zeigt, wie Entitätsdatensätze aus dem Organisationswebdienst mit OData-Protokollcode in einer HTTP-Anforderung abgerufen werden. Das Authentifizierungszugriffstoken wird in der Autorisierungskopfzeile platziert.
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;
namespace ModernOdataApp
{
public static class HttpRequestBuilder
{
/// <summary>
/// Retrieve entity record data from the organization web service.
/// </summary>
/// <param name="accessToken">The web service authentication access token.</param>
/// <param name="Columns">The entity attributes to retrieve.</param>
/// <param name="entity">The target entity for which the data should be retreived.</param>
/// <returns>Response from the web service.</returns>
/// <remarks>Builds an OData HTTP request using passed parameters and sends the request to the server.</remarks>
public static async Task<string> Retrieve(string accessToken, string[] Columns, string entity)
{
// Build a list of entity attributes to retrieve as a string.
string columnsSet = "";
foreach (string Column in Columns)
{
columnsSet += "," + Column;
}
// The URL for the OData organization web service.
string url = CurrentEnvironment.CrmServiceUrl + "/XRMServices/2011/OrganizationData.svc/" + entity + "?$select=" + columnsSet.Remove(0, 1) + "";
// Build and send the HTTP request.
HttpClient httpClient = new HttpClient();
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", accessToken);
HttpRequestMessage req = new HttpRequestMessage(HttpMethod.Get, url);
req.Method = HttpMethod.Get;
// Wait for the web service response.
HttpResponseMessage response;
response = await httpClient.SendAsync(req);
var responseBodyAsText = await response.Content.ReadAsStringAsync();
return responseBodyAsText;
}
}
}
Siehe auch
Schreiben von mobilen und modernen Apps
Azure Authentication Library (AAL) für Windows Store: eine eingehende Betrachtung
Sichern einer Windows Store-Anwendung und eines REST-Webdiensts mithilfe von Azure AD
OData.org
© 2017 Microsoft. Alle Rechte vorbehalten. Copyright