Expand Minimize

Use ExecuteQueryRetry to ensure SharePoint isn't saturated with requests.

PnP has an implementations to retry execute queries in a safe retry loop that prevents requests being rejected.

CheckId SPC029017
TypeName UseExecuteQueryRetry
Severity Warning
Type Assembly

Standard SharePoint CSOM

while (retryAttempts < retryCount)
{
    try
    {
        // ClientTag property is limited to 32 chars
        if (string.IsNullOrEmpty(clientTag))
        {
            clientTag = "UniqueIdentifier";
        }
        if (clientTag.Length > 32)
        {
            clientTag = clientTag.Substring(0, 32);
        }
        
        clientContext.ClientTag = clientTag;
        clientContext.ExecuteQuery();
        return;
    }
    catch (WebException wex)
    {
        var response = wex.Response as HttpWebResponse;
        
        if (response != null && (response.StatusCode == (HttpStatusCode)429 || response.StatusCode == (HttpStatusCode)503))
        {
            Thread.Sleep(backoffInterval);
            retryAttempts++;
            backoffInterval = backoffInterval * 2;
        }
        else
        {
            throw;
        }
    }
}

Using PnP
clientContext.ExecuteQueryRetry();

To suppress this violation in managed code add the following attribute to the method which contains the instruction (available since SPCAF version v5.2). Learn more about SuppressMessage here.

// Important: Ensure to have #define CODE_ANALYSIS at the beginning of your .cs file
[SuppressMessage("Rencore.Analyzers.Assemblies.Rules.PnP.PnPBestPracticesGroup", "SPC029017:UseExecuteQueryRetry", Justification = "Provide reason for suppression here")]
Disclaimer: The views and opinions expressed in this documentation and in SPCAF do not necessarily reflect the opinions and recommendations of Microsoft or any member of Microsoft. SPCAF and RENCORE are registered trademarks of Rencore. All other trademarks, service marks, collective marks, copyrights, registered names, and marks used or cited by this documentation are the property of their respective owners.