Class PnPGlobalSettingsOptions

PnP Core SDK settings class

Inheritance

System.Object

PnPGlobalSettingsOptions

Namespace: PnP.Core.Services

Assembly: PnP.Core.dll

Syntax

public class PnPGlobalSettingsOptions : object

Constructors

PnPGlobalSettingsOptions()

Default constructor

Declaration

public PnPGlobalSettingsOptions()

Properties

AADTenantId

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

Declaration

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

Declaration

public string AzureADLoginAuthority { get; set; }

Property Value

System.String

DisableTelemetry

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

Declaration

public bool DisableTelemetry { get; set; }

Property Value

System.Boolean

Environment

The Microsoft 365 cloud environment that's used

Declaration

public Microsoft365Environment? Environment { get; set; }

Property Value

System.Nullable<Microsoft365Environment>

HttpAzureActiveDirectoryDelayInSeconds

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

Declaration

public int HttpAzureActiveDirectoryDelayInSeconds { get; set; }

Property Value

System.Int32

HttpAzureActiveDirectoryMaxRetries

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

Declaration

public int HttpAzureActiveDirectoryMaxRetries { get; set; }

Property Value

System.Int32

HttpAzureActiveDirectoryUseIncrementalDelay

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

Declaration

public bool HttpAzureActiveDirectoryUseIncrementalDelay { get; set; }

Property Value

System.Boolean

HttpAzureActiveDirectoryUseRetryAfterHeader

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

Declaration

public bool HttpAzureActiveDirectoryUseRetryAfterHeader { get; set; }

Property Value

System.Boolean

HttpMicrosoftGraphDelayInSeconds

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

Declaration

public int HttpMicrosoftGraphDelayInSeconds { get; set; }

Property Value

System.Int32

HttpMicrosoftGraphMaxRetries

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

Declaration

public int HttpMicrosoftGraphMaxRetries { get; set; }

Property Value

System.Int32

HttpMicrosoftGraphUseIncrementalDelay

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

Declaration

public bool HttpMicrosoftGraphUseIncrementalDelay { get; set; }

Property Value

System.Boolean

HttpMicrosoftGraphUseRetryAfterHeader

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

Declaration

public bool HttpMicrosoftGraphUseRetryAfterHeader { get; set; }

Property Value

System.Boolean

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).

Declaration

public int HttpRateLimiterMinimumCapacityLeft { get; set; }

Property Value

System.Int32

HttpSharePointRestDefaultPageSize

Defines the default page size for querying items in SharePoint REST

Declaration

public int HttpSharePointRestDefaultPageSize { get; set; }

Property Value

System.Int32

HttpSharePointRestDelayInSeconds

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

Declaration

public int HttpSharePointRestDelayInSeconds { get; set; }

Property Value

System.Int32

HttpSharePointRestMaxRetries

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

Declaration

public int HttpSharePointRestMaxRetries { get; set; }

Property Value

System.Int32

HttpSharePointRestUseIncrementalDelay

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

Declaration

public bool HttpSharePointRestUseIncrementalDelay { get; set; }

Property Value

System.Boolean

HttpSharePointRestUseRetryAfterHeader

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

Declaration

public bool HttpSharePointRestUseRetryAfterHeader { get; set; }

Property Value

System.Boolean

HttpTimeout

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

Declaration

public int HttpTimeout { get; set; }

Property Value

System.Int32

HttpUserAgent

User agent value, can be customized via configuration

Declaration

public string HttpUserAgent { get; }

Property Value

System.String

MicrosoftGraphAuthority

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

Declaration

public string MicrosoftGraphAuthority { get; set; }

Property Value

System.String

VersionTag

Version tag used in telemetry

Declaration

public string VersionTag { get; }

Property Value

System.String