Class PnPGlobalSettingsOptions

Namespace

PnP.Core.Services

Assembly

PnP.Core.dll

PnP Core SDK settings class

public class PnPGlobalSettingsOptions

Inheritance

object

PnPGlobalSettingsOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PnPGlobalSettingsOptions()

Default constructor

public PnPGlobalSettingsOptions()

Properties

AADTenantId

AAD tenant id, used for telemetry purposes. Can be customized via configuration

public Guid AADTenantId { get; set; }

Property Value

Guid

AzureADLoginAuthority

Returns the Azure AD Login authority (e.g. login.microsoftonline.com) to use when Environment is set to Custom

public string AzureADLoginAuthority { get; set; }

Property Value

string

DisableTelemetry

Turns on/off telemetry, can be customized via configuration. Defaults to false.

public bool DisableTelemetry { get; set; }

Property Value

bool

Environment

The Microsoft 365 cloud environment that's used

public Microsoft365Environment? Environment { get; set; }

Property Value

Microsoft365Environment?

HttpAzureActiveDirectoryDelayInSeconds

How many seconds to wait for the next retry attempt. Defaults to 3

public int HttpAzureActiveDirectoryDelayInSeconds { get; set; }

Property Value

int

HttpAzureActiveDirectoryMaxRetries

When not using retry-after, how many times can a retry be made. Defaults to 10

public int HttpAzureActiveDirectoryMaxRetries { get; set; }

Property Value

int

HttpAzureActiveDirectoryUseIncrementalDelay

Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true

public bool HttpAzureActiveDirectoryUseIncrementalDelay { get; set; }

Property Value

bool

HttpAzureActiveDirectoryUseRetryAfterHeader

Use the Retry-After header for calculating the delay in case of a retry. Defaults to true

public bool HttpAzureActiveDirectoryUseRetryAfterHeader { get; set; }

Property Value

bool

HttpMicrosoftGraphDelayInSeconds

How many seconds to wait for the next retry attempt. Defaults to 3

public int HttpMicrosoftGraphDelayInSeconds { get; set; }

Property Value

int

HttpMicrosoftGraphMaxRetries

When not using retry-after, how many times can a retry be made. Defaults to 10

public int HttpMicrosoftGraphMaxRetries { get; set; }

Property Value

int

HttpMicrosoftGraphUseIncrementalDelay

Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true

public bool HttpMicrosoftGraphUseIncrementalDelay { get; set; }

Property Value

bool

HttpMicrosoftGraphUseRetryAfterHeader

Use the Retry-After header for calculating the delay in case of a retry. Defaults to true

public bool HttpMicrosoftGraphUseRetryAfterHeader { get; set; }

Property Value

bool

HttpRateLimiterMinimumCapacityLeft

When set (e.g. to 10%) then RateLimit response headers coming from SharePoint and Graph are used: if there's less then the set value (e.g. 10%) capacity left before getting throttled the pending request will be delayed until the 1 minute window is reset. Defaults to 0 (disabled).

public int HttpRateLimiterMinimumCapacityLeft { get; set; }

Property Value

int

HttpSharePointRestDefaultPageSize

Defines the default page size for querying items in SharePoint REST

public int HttpSharePointRestDefaultPageSize { get; set; }

Property Value

int

HttpSharePointRestDelayInSeconds

How many seconds to wait for the next retry attempt. Defaults to 3

public int HttpSharePointRestDelayInSeconds { get; set; }

Property Value

int

HttpSharePointRestMaxRetries

When not using retry-after, how many times can a retry be made. Defaults to 10

public int HttpSharePointRestMaxRetries { get; set; }

Property Value

int

HttpSharePointRestUseIncrementalDelay

Use an incremental strategy for the delay: each retry doubles the previous delay time. Defaults to true

public bool HttpSharePointRestUseIncrementalDelay { get; set; }

Property Value

bool

HttpSharePointRestUseRetryAfterHeader

Use the Retry-After header for calculating the delay in case of a retry. Defaults to false

public bool HttpSharePointRestUseRetryAfterHeader { get; set; }

Property Value

bool

HttpTimeout

Max duration of a http request in seconds. Defaults to 100 seconds, set to value -1 for an infinite timeout

public int HttpTimeout { get; set; }

Property Value

int

HttpUserAgent

User agent value, can be customized via configuration

public string HttpUserAgent { get; }

Property Value

string

MicrosoftGraphAuthority

Returns the Microsoft Graph authority (e.g. graph.microsoft.com) to use when Environment is set to Custom

public string MicrosoftGraphAuthority { get; set; }

Property Value

string

VersionTag

Version tag used in telemetry

public string VersionTag { get; }

Property Value

string