Web API'lerini çağıran masaüstü uygulaması: Kod yapılandırması

Uygulamanızı oluşturduğunuza göre, kodu uygulamanın koordinatlarıyla yapılandırmayı öğreneceksiniz.

Masaüstü uygulamalarını destekleyen Microsoft kitaplıkları

Aşağıdaki Microsoft kitaplıkları masaüstü uygulamalarını destekler:

Dil / çerçeve	Proje açık GitHub	Paket	Alma birini seçin	Oturum açma kullanıcıları	Web API'lerine erişme	Genel kullanıma açık (GA) veya Genel önizleme1
Electron	MSAL Node.js	msal-node	—			Genel önizleme
Java	MSAL4J	msal4j	—			GA
macOS (Swift/Obj-C)	iOS ve macOS için MSAL	MSAL	Öğretici			GA
UWP	MSAL.NET	Microsoft.Identity.Client	Öğretici			GA
WPF	MSAL.NET	Microsoft.Identity.Client	Öğretici			GA

¹ Çevrimiçi Hizmetler için Evrensel Lisans Koşulları, Genel önizlemedeki kitaplıklar için geçerlidir.

Genel istemci uygulaması

Kod açısından bakıldığında masaüstü uygulamaları genel istemci uygulamalarıdır. Yapılandırma, etkileşimli kimlik doğrulaması kullanıp kullanmamanıza bağlı olarak biraz farklı olacaktır.

.NET

MSAL.NET IPublicClientApplicationoluşturmanız ve işlemeniz gerekir.

Yalnızca koda göre

Aşağıdaki kod bir genel istemci uygulamasının örneğini oluşturur ve Microsoft Azure genel bulutundaki kullanıcıları bir iş veya okul hesabı ya da kişisel bir Microsoft hesabıyla oturum açar.

IPublicClientApplication app = PublicClientApplicationBuilder.Create(clientId)
    .Build();

Daha önce görüldüğü gibi etkileşimli kimlik doğrulaması veya cihaz kodu akışı kullanmayı planlıyorsanız değiştiriciyi .WithRedirectUri kullanın.

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithDefaultRedirectUri()
        .Build();

Yapılandırma dosyalarını kullanma

Aşağıdaki kod, program aracılığıyla doldurulabilen veya bir yapılandırma dosyasından okunabilen bir yapılandırma nesnesinden bir genel istemci uygulamasının örneğini oluşturur.

PublicClientApplicationOptions options = GetOptions(); // your own method
IPublicClientApplication app = PublicClientApplicationBuilder.CreateWithApplicationOptions(options)
        .WithDefaultRedirectUri()
        .Build();

Daha ayrıntılı yapılandırma

Bir dizi değiştirici ekleyerek uygulama derlemesini ayrıntılı bir şekilde inceleyebilirsiniz. Örneğin, uygulamanızın burada gösterilen ABD Kamu gibi ulusal bir bulutta çok kiracılı bir uygulama olmasını istiyorsanız şunları yazabilirsiniz:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithDefaultRedirectUri()
        .WithAadAuthority(AzureCloudInstance.AzureUsGovernment,
                         AadAuthorityAudience.AzureAdMultipleOrgs)
        .Build();

MSAL.NET ayrıca Active Directory Federasyon Hizmetleri (AD FS) 2019 için bir değiştirici içerir:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithAdfsAuthority("https://consoso.com/adfs")
        .Build();

Son olarak, bir Azure Active Directory (Azure AD) B2C kiracısı için belirteç almak istiyorsanız, kiracınızı aşağıdaki kod parçacığında gösterildiği gibi belirtin:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithB2CAuthority("https://fabrikamb2c.b2clogin.com/tfp/{tenant}/{PolicySignInSignUp}")
        .Build();

Daha fazla bilgi edinin

MSAL.NET masaüstü uygulamasını yapılandırma hakkında daha fazla bilgi edinmek için:

• üzerinde PublicClientApplicationBuilderkullanılabilen tüm değiştiricilerin listesi için PublicClientApplicationBuilder başvuru belgelerine bakın.
• içinde kullanıma sunulan tüm seçeneklerin açıklaması için, başvuru belgelerindeki PublicClientApplicationOptionsPublicClientApplicationOptions bölümüne bakın.

Yapılandırma seçenekleriyle tam örnek

Aşağıdaki appsettings.json yapılandırma dosyasına sahip bir .NET konsol uygulaması düşünün:

{
  "Authentication": {
    "AzureCloudInstance": "AzurePublic",
    "AadAuthorityAudience": "AzureAdMultipleOrgs",
    "ClientId": "00001111-aaaa-2222-bbbb-3333cccc4444"
  },

  "WebAPI": {
    "MicrosoftGraphBaseEndpoint": "https://graph.microsoft.com"
  }
}

kullanarak bu dosyada okumak için çok az kodunuz var. NET tarafından sağlanan yapılandırma çerçevesi:

public class SampleConfiguration
{
 /// <summary>
 /// Authentication options
 /// </summary>
 public PublicClientApplicationOptions PublicClientApplicationOptions { get; set; }

 /// <summary>
 /// Base URL for Microsoft Graph (it varies depending on whether the application runs
 /// in Microsoft Azure public clouds or national or sovereign clouds)
 /// </summary>
 public string MicrosoftGraphBaseEndpoint { get; set; }

 /// <summary>
 /// Reads the configuration from a JSON file
 /// </summary>
 /// <param name="path">Path to the configuration json file</param>
 /// <returns>SampleConfiguration as read from the json file</returns>
 public static SampleConfiguration ReadFromJsonFile(string path)
 {
  // .NET configuration
  IConfigurationRoot Configuration;
  var builder = new ConfigurationBuilder()
                    .SetBasePath(Directory.GetCurrentDirectory())
                    .AddJsonFile(path);
  Configuration = builder.Build();

  // Read the auth and graph endpoint configuration
  SampleConfiguration config = new SampleConfiguration()
  {
   PublicClientApplicationOptions = new PublicClientApplicationOptions()
  };
  Configuration.Bind("Authentication", config.PublicClientApplicationOptions);
  config.MicrosoftGraphBaseEndpoint =
  Configuration.GetValue<string>("WebAPI:MicrosoftGraphBaseEndpoint");
  return config;
 }
}

Şimdi uygulamanızı oluşturmak için aşağıdaki kodu yazın:

SampleConfiguration config = SampleConfiguration.ReadFromJsonFile("appsettings.json");
var app = PublicClientApplicationBuilder.CreateWithApplicationOptions(config.PublicClientApplicationOptions)
           .WithDefaultRedirectUri()
           .Build();

yöntemine .Build() yapılan çağrıdan önce, daha önce görüldüğü gibi yöntemlere .WithXXX yapılan çağrılarla yapılandırmanızı geçersiz kılabilirsiniz.

Java

Örnekleri yapılandırmak için MSAL Java geliştirme örneklerinde kullanılan sınıf aşağıdadır: TestData.

PublicClientApplication pca = PublicClientApplication.builder(CLIENT_ID)
        .authority(AUTHORITY)
        .build();

MacOS

Aşağıdaki kod bir genel istemci uygulamasının örneğini oluşturur ve Microsoft Azure genel bulutundaki kullanıcıları bir iş veya okul hesabı ya da kişisel bir Microsoft hesabıyla oturum açar.

Hızlı yapılandırma

Objective-C:

NSError *msalError = nil;

MSALPublicClientApplicationConfig *config = [[MSALPublicClientApplicationConfig alloc] initWithClientId:@"<your-client-id-here>"];
MSALPublicClientApplication *application = [[MSALPublicClientApplication alloc] initWithConfiguration:config error:&msalError];

Çabuk:

let config = MSALPublicClientApplicationConfig(clientId: "<your-client-id-here>")
if let application = try? MSALPublicClientApplication(configuration: config){ /* Use application */}

Daha ayrıntılı yapılandırma

Bir dizi değiştirici ekleyerek uygulama derlemesini ayrıntılı bir şekilde inceleyebilirsiniz. Örneğin, uygulamanızın burada gösterilen ABD Kamu gibi ulusal bir bulutta çok kiracılı bir uygulama olmasını istiyorsanız şunları yazabilirsiniz:

Objective-C:

MSALAADAuthority *aadAuthority =
                [[MSALAADAuthority alloc] initWithCloudInstance:MSALAzureUsGovernmentCloudInstance
                                                   audienceType:MSALAzureADMultipleOrgsAudience
                                                      rawTenant:nil
                                                          error:nil];

MSALPublicClientApplicationConfig *config =
                [[MSALPublicClientApplicationConfig alloc] initWithClientId:@"<your-client-id-here>"
                                                                redirectUri:@"<your-redirect-uri-here>"
                                                                  authority:aadAuthority];

NSError *applicationError = nil;
MSALPublicClientApplication *application =
                [[MSALPublicClientApplication alloc] initWithConfiguration:config error:&applicationError];

Çabuk:

let authority = try? MSALAADAuthority(cloudInstance: .usGovernmentCloudInstance, audienceType: .azureADMultipleOrgsAudience, rawTenant: nil)

let config = MSALPublicClientApplicationConfig(clientId: "<your-client-id-here>", redirectUri: "<your-redirect-uri-here>", authority: authority)
if let application = try? MSALPublicClientApplication(configuration: config) { /* Use application */}

Node.js

Yapılandırma parametreleri JavaScript dosyası gibi birçok kaynaktan veya ortam değişkenlerinden yüklenebilir. Aşağıda bir authConfig.js dosyası kullanılmıştır.

/*
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

const { LogLevel } = require("@azure/msal-node");

/**
 * Configuration object to be passed to MSAL instance on creation.
 * For a full list of MSAL.js configuration parameters, visit:
 * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/configuration.md
 */
const AAD_ENDPOINT_HOST = "Enter_the_Cloud_Instance_Id_Here"; // include the trailing slash

const msalConfig = {
    auth: {
        clientId: "Enter_the_Application_Id_Here",
        authority: `${AAD_ENDPOINT_HOST}Enter_the_Tenant_Info_Here`,
    },
    system: {
        loggerOptions: {
            loggerCallback(loglevel, message, containsPii) {
                console.log(message);
            },
            piiLoggingEnabled: false,
            logLevel: LogLevel.Verbose,
        },
    },
};

/**
 * Add here the endpoints and scopes when obtaining an access token for protected web APIs. For more information, see:
 * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/resources-and-scopes.md
 */
const GRAPH_ENDPOINT_HOST = "Enter_the_Graph_Endpoint_Here"; // include the trailing slash

const protectedResources = {
    graphMe: {
        endpoint: `${GRAPH_ENDPOINT_HOST}v1.0/me`,
        scopes: ["User.Read"],
    }
};


module.exports = {
    msalConfig: msalConfig,
    protectedResources: protectedResources,
};

yapılandırma nesnesini authConfig.js dosyasından içeri aktarın. MSAL Düğümü aşağıda gösterildiği gibi en az düzeyde başlatılabilir. Kullanılabilir yapılandırma seçeneklerine bakın.

const { PublicClientApplication } = require('@azure/msal-node');
const { msalConfig } = require('./authConfig')

/**
* Initialize a public client application. For more information, visit:
* https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/initialize-public-client-application.md
*/
clientApplication = new PublicClientApplication(msalConfig);

Python

config = json.load(open(sys.argv[1]))

app = msal.PublicClientApplication(
    config["client_id"], authority=config["authority"],
    # token_cache=...  # Default cache is in memory only.
                       # You can learn how to use SerializableTokenCache from
                       # https://msal-python.rtfd.io/en/latest/#msal.SerializableTokenCache
    )

Sonraki adımlar

Bu senaryoda , masaüstü uygulaması için belirteç alma adlı sonraki makaleye geçin.