Class ConfigurationExtensions

Extensions for Microsoft.Extensions.Configuration.IConfiguration.

Inheritance

object

Namespace: Umbraco.Extensions

Assembly: Umbraco.Core.dll

Syntax

public static class ConfigurationExtensions

Methods

View Source

GetConnectionStringProviderName(IConfiguration, string)

Gets the provider name for the connection string name (shorthand for GetSection("ConnectionStrings")[name + "_ProviderName"]).

Declaration

public static string? GetConnectionStringProviderName(this IConfiguration configuration, string name)

Parameters

Type	Name	Description
IConfiguration	configuration	The configuration.
string	name	The connection string key.

Returns

Type	Description
string	The provider name.

Remarks

This uses the same convention as the Configuration API for connection string environment variables.

View Source

GetModelsMode(IConfiguration)

Declaration

public static string GetModelsMode(this IConfiguration configuration)

Parameters

Type	Name	Description
IConfiguration	configuration

Returns

Type	Description
string

View Source

GetRuntimeMode(IConfiguration)

Gets the Umbraco runtime mode.

Declaration

public static RuntimeMode GetRuntimeMode(this IConfiguration configuration)

Parameters

Type	Name	Description
IConfiguration	configuration	The configuration.

Returns

Type	Description
RuntimeMode	The Umbraco runtime mode.

View Source

GetUmbracoConnectionString(IConfiguration, string)

Gets the Umbraco connection string (shorthand for GetSection("ConnectionStrings")[name] and replacing the |DataDirectory| placeholder).

Declaration

public static string? GetUmbracoConnectionString(this IConfiguration configuration, string name = "umbracoDbDSN")

Parameters

Type	Name	Description
IConfiguration	configuration	The configuration.
string	name	The connection string key.

Returns

Type	Description
string	The Umbraco connection string.

View Source

GetUmbracoConnectionString(IConfiguration, string, out string?)

Gets the Umbraco connection string and provider name (shorthand for GetSection("ConnectionStrings")[name] and replacing the |DataDirectory| placeholder).

Declaration

public static string? GetUmbracoConnectionString(this IConfiguration configuration, string name, out string? providerName)

Parameters

Type	Name	Description
IConfiguration	configuration	The configuration.
string	name	The name.
string	providerName	The provider name.

Returns

Type	Description
string	The Umbraco connection string.

View Source

GetUmbracoConnectionString(IConfiguration, out string?)

Gets the Umbraco connection string and provider name (shorthand for GetSection("ConnectionStrings")[Constants.System.UmbracoConnectionName] and replacing the |DataDirectory| placeholder).

Declaration

public static string? GetUmbracoConnectionString(this IConfiguration configuration, out string? providerName)

Parameters

Type	Name	Description
IConfiguration	configuration	The configuration.
string	providerName	The provider name.

Returns

Type	Description
string	The Umbraco connection string.