WebConnectionStringBuilder Class

Provides a simple way to create and manage the contents of connection strings used for a Microsoft Dataverse connection.

Definition

Namespace: Configuration.Helper
Assembly: Configuration.Helper (in Configuration.Helper.dll) Version: 2.0.5
C#
public class WebConnectionStringBuilder : DbConnectionStringBuilder
Inheritance
Object    DbConnectionStringBuilder    WebConnectionStringBuilder

Remarks

Constructors

WebConnectionStringBuilderInitializes a new instance of the WebConnectionStringBuilder class.
WebConnectionStringBuilder(String) Initializes a new instance of the WebConnectionStringBuilder class using a supplied connection string.

Properties

AuthenticationTypeGets or sets the authentication type to connect to Dataverse environment.
ClientId Gets or sets the ClientID assigned when the registered application in Azure Active Directory or Active Directory Federation Services (AD FS).
ClientSecretGets or sets the secret when authentication type is set to ClientSecret.
DomainGets or sets the domain that will verify user credentials.
HomeRealmUriGets or sets the Home Realm Uniform Resource Identifier.
IntegratedSecurity Gets or sets whether to use current windows credentials to attempt to create a token for the instances. As of NuGet release Microsoft.CrmSdk.XrmTooling.CoreAssembly Version 9.1.0.21
LoginPrompt Gets or sets whether the user is prompted for credentials if the credentials are not supplied.
PasswordGets or sets the password for the user name associated with the credentials.
RedirectUri Gets or sets the redirect URI of the application registered in Azure Active Directory or Active Directory Federation Services (AD FS).
RequireNewInstance Gets or sets whether to reuse an existing connection if recalled while the connection is still active.
SkipDiscovery Gets or sets whether to call instance discovery to determine the connection URI for a given instance. As of NuGet release Microsoft.CrmSdk.XrmTooling.CoreAssembly Version 9.0.2.7
StoreName Gets or sets the store name where the certificate identified by thumb-print can be found. When set, Thumb-print is required.
Thumbprint Gets or sets the thumb-print of the certificate to be utilized during an S2S connection. When set, AppID is required and UserID and Password values are ignored.
TokenCacheStorePath Gets or sets the full path to the location where the user token cache should be stored.
Url Gets or sets the URL to the Dataverse environment. The URL can use HTTP or HTTPS protocol, and the port is optional.
UserNameGets or sets the user name associated with the credentials.

See Also