DataSourceDefinition.CredentialRetrieval Property

Gets or sets a value that indicates the way in which the report server retrieves data source credentials.

Namespace:  ReportService2010
Assembly:  ReportService2010 (in ReportService2010.dll)


Public Property CredentialRetrieval As CredentialRetrievalEnum
Dim instance As DataSourceDefinition
Dim value As CredentialRetrievalEnum

value = instance.CredentialRetrieval

instance.CredentialRetrieval = value
public CredentialRetrievalEnum CredentialRetrieval { get; set; }
property CredentialRetrievalEnum CredentialRetrieval {
    CredentialRetrievalEnum get ();
    void set (CredentialRetrievalEnum value);
member CredentialRetrieval : CredentialRetrievalEnum with get, set
function get CredentialRetrieval () : CredentialRetrievalEnum
function set CredentialRetrieval (value : CredentialRetrievalEnum)

Property Value

Type: ReportService2010.CredentialRetrievalEnum
A CredentialRetrievalEnum value which indicates the way in which the report server retrieves data source credentials.


You can use the CredentialRetrieval property to specify where to retrieve the credentials that will be used by the when the report server connects to an external data source.

There are four possible settings for this property:

  • None – The connection to the data source does not require connections.

  • Prompt - The report server requires that credentials be supplied. If credentials are not supplied, the report is not generated and an exception is raised.

  • Integrated- The report server uses the credentials of the user authenticated to the report server. Any other data source credentials that are supplied are ignored.

  • Store – The credentials are stored securely in the report server database.

There are several features of the report server that require the credential retrieval option to be either Store or None in order to successfully execute. These include schedule-based features such report execution snapshot generation, report history generation, and subscriptions.

When credentials and the connection string are stored in the report server database, they are encrypted.