Share-n-dipity

SharePoint serendipity is the effect by which one accidentally discovers something fortunate, especially while looking for something else entirely. In this case, it is the occassional musings, observations, and Ouija board readings about the phabulously

Debugging SharePoint Apps That Are Hosted In Windows Azure Web Sites

Debugging SharePoint Apps That Are Hosted In Windows Azure Web Sites

  • Comments 3
  • Likes

Today, I'm going to be the lazy human I'm so frequently accused of being by my somewhat faithful dog Shasta, and bring together two posts written by two other folks into one uber "ain't it cool how this all works together post" by me.  Here are the two concepts we're combining today:

Now, once our SharePoint App has been published to a Windows Azure web site, the error prone and/or forward-thinking amongst you may be wondering...um, great...so what do I do to track down bugs?  Well that's where the second piece of brilliant advice that I had nothing to do with comes in.

Now, let's briefly walk through the steps to combine these two nuggets of goodness:

  1. Create a SharePoint provider hosted app and verify that it works.
  2. Create an Azure web site and download publishing profile. (in Vesa's video)
  3. Use appregnew.aspx to get a client ID and client secret. (in Vesa's video)
  4. Publish the App to your Windows Azure site using the publishing profile, client ID and client secret retrieved in the previous steps. (in Vesa's video)
  5. Create the app package, install it to your app catalog, and add it to your site. (in Vesa's video)
  6. Open Server Explorer in Visual Studio 2013, right-click on the Windows Azure node and select Connect to Windows Azure...
  7. Expand to see all the Azure services, and then expand the collection of Web Sites.
  8. Right-click on the Azure web site where you published your provider-hosted app and select Attach Debugger.
  9. The browser opens to your Azure web site, and VS.NET starts up in debugging mode.  Set your breakpoints in your code and start debugging!

See the remotely debugging Azure web sites post for the details on pre-requisites, but in short you need Visual Studio 2013 and the Azure 2.2 SDK for VS 2013; you will find a link to that in the blog post. (NOTE:  that same post also describes how to do this with Visual Studio 2012 but I have not tried that)  This actually works pretty great and I was able to get a first-hand experience using it when I went through the steps for this blog post.  As it turns out, the SharePoint site where I installed my sample application uses the Url https://sps2.  Well, the problem of course is that in my Azure Web site, my code was trying to make a CSOM call to an endpoint at "sps2".  That works great when I'm in my lab environment, but out in the interwebs that Azure lives in of course it cannot resolve to a simple NetBIOS name (remember, this code is running server side, not client side).  So as a result it was blowing up.  By using this cool new debugging feature I was able to find my issue, appropriately for this debugging post.  Here's a screenshot of it in action:

 

Comments
  • I love the new debugging stuff in Azure Websites ... so handy for those "well it works on my machine" moments.  Something else i have been doing in all my Azure code is adding some tracing/debugging output using SignalR. This gives you a real time monitoring visibility in your code ... good for non-intrusively debugging your code. When you do the VS debugging for Azure it will stop other requests from executing so sometimes you need a little lighter touch if your code is in production.  I wrote it up here if you are interested:  

    www.looselytyped.net/.../sharepoint-provider-hosted-apps-in-azure-monitoring-tip

  • Hello Steve,

    I followed your steps, but I get error -
    "A remote operation is taking longer than expected"

    and then alert error message
    "The following error occurred when tried to launch remote debugging: Exception from HRESULT: 0x89710023"

    Could you please guide, if I am missing something?
    Thank you.

  • Nanddeep,

    Check http://stackoverflow.com/questions/21188108/azure-remote-debugging-failed-to-enable-remote-debuggingexception-from-hresult

Your comment has been posted.   Close
Thank you, your comment requires moderation so it may take a while to appear.   Close
Leave a Comment