Class PnPProvisioningContext

Class to wrap any PnP Provisioning process in order to share the same security context across different Object Handlers

Inheritance
System.Object
PnPProvisioningContext
Namespace: PnP.Framework.Provisioning.ObjectHandlers
Assembly: PnP.Framework.dll
Syntax
public class PnPProvisioningContext : IDisposable

Constructors

PnPProvisioningContext(AcquireTokenAsyncDelegate, AcquireCookieAsyncDelegate, Dictionary<String, Object>, AzureEnvironment)

Constructor for the content

Declaration
public PnPProvisioningContext(AcquireTokenAsyncDelegate acquireTokenAsyncDelegate = null, AcquireCookieAsyncDelegate acquireCookieAsyncDelegate = null, Dictionary<string, object> properties = null, AzureEnvironment azureEnvironment = default(AzureEnvironment))
Parameters
AcquireTokenAsyncDelegate acquireTokenAsyncDelegate

Asynchronous delegate to acquire an access token for a specific resource and with a specific scope
AcquireCookieAsyncDelegate acquireCookieAsyncDelegate

Asynchronous delegate to acquire a cookie for a specific resource
Dictionary<System.String, System.Object> properties

Properties to add to the Property Bag of the current context
AzureEnvironment azureEnvironment

The Azure Cloud Deployment to use. This is used to determine the Graph endpoint. Defaults to 'Production' / 'Global'

Properties

AcquireCookieAsync

Asynchronous delegate to acquire a cookie for a specific resource

Declaration
public AcquireCookieAsyncDelegate AcquireCookieAsync { get; }
Property Value
AcquireCookieAsyncDelegate

AcquireTokenAsync

Asynchronous delegate to acquire an access token for a specific resource and with a specific scope

Declaration
public AcquireTokenAsyncDelegate AcquireTokenAsync { get; }
Property Value
AcquireTokenAsyncDelegate

AzureEnvironment

Defines the Cloud Deployment the current user is connected to.

Declaration
public AzureEnvironment AzureEnvironment { get; }
Property Value
AzureEnvironment

Current

Declaration
public static PnPProvisioningContext Current { get; set; }
Property Value
PnPProvisioningContext

Properties

Property Bag of properties for the current context

Declaration
public Dictionary<string, object> Properties { get; }
Property Value
Dictionary<System.String, System.Object>

Methods

AcquireCookie(String)

Synchronous delegate to acquire a cookie for a specific resource

Declaration
public string AcquireCookie(string resource)
Parameters
System.String resource

The target resource
Returns
System.String

The Cookie for the requested resource

AcquireToken(String, String)

Synchronous delegate to acquire an access token for a specific resource and with a specific scope

Declaration
public string AcquireToken(string resource, string scope)
Parameters
System.String resource

The target resource
System.String scope

The scope for the target resource
Returns
System.String

The Access Token for the requested resource, with the requested scope

AcquireTokenWithMultipleScopes(String, String[])

Declaration
public string AcquireTokenWithMultipleScopes(string resource, params string[] scope)
Parameters
System.String resource

System.String[] scope

Returns
System.String

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

Finalize()

Declaration
protected void Finalize()

Extension Methods