Add Service Certificate

The Add Service Certificate request may be specified as follows. Replace <subscription-id> with your subscription ID, and <service-name> with the DNS prefix name of your service:

URI Parameters

Request Headers

Request Body

The format of the request body is as follows:

Copy

<?xml version="1.0" encoding="utf-8"?>
<CertificateFile xmlns=”http://schemas.microsoft.com/windowsazure”>
  <Data>base64-encoded-file</Data>
  <CertificateFormat>file-format</CertificateFormat>
  <Password>pfx-file-password</Password>
</CertificateFile>

Important
The order of the elements in the request body is significant. If an element is required, it must appear in the XML in the order shown above.

 

Element name	Description
Data	The base-64 encoded form of the pfx or .cer file. Note The service certificate is added as either a .pfx or .cer file. When retrieving the service certificate using the List Service Certificates or Get Service Certificate operation, only the public portion of the certificate is returned as a .cer file.
CertificateFormat	The service certificate format. Windows Azure supports the pfx and cer file formats.
Password	The password for a .pfx certificate. A .cer certificate does not require a password.

The response includes an HTTP status code and a set of response headers.

Because Add Service Certificate is an asynchronous operation, you must call Get Operation Status to determine whether the operation is complete, has failed, or is still in progress.

Status Code

Response Headers

Response Body

Any management certificate associated with the subscription specified by <subscription-id> can be used to authenticate this operation. For additional details, see Authenticating Service Management Requests.

Use the Add Service Certificate operation to add an X.509 certificate to a hosted service for secure access to your web role and worker role applications. The operation returns immediately with a request ID in the x-ms-request-id header of the response to a successful request, while the certificate association with the hosted service is performed asynchronously by Windows Azure. To find out when the asynchronous add service certificate operation has completed, you can poll the Get Operation Status operation with the request ID. This will return an XML body with an Operation element containing a Status element which will have a value of InProgress, Failed, or Succeeded, depending on the status of the asynchronous operation. If you poll until the status is Failed or Succeeded, the Operation element will contain a status code representing the final status of the operation in the StatusCode element, and failed operations will contain additional error information in the Error element. See Get Operation Status for more details.

The following method constructs a request to add a service certificate, submits the request to the service, and returns the request ID.

public static string AddCertificate(string subscriptionId, string applicationName, X509Certificate2 managementCertificate, string pfxPath, string password)
{
    // Construct the request URI.    var req = (HttpWebRequest)WebRequest.Create(string.Format("https://management.core.windows.net/{0}/services/hostedservices/{1}/certificates", subscriptionId, applicationName));

    // Set the request method and the content type for the request.
    req.Method = "POST";
    req.ContentType = "application/xml";

    // Add the x-ms-version header.
    req.Headers.Add("x-ms-version", "2009-10-01");

    // Add the certificate.
    req.ClientCertificates.Add(managementCertificate);

    // Construct the request body.
    using (var writer = new StreamWriter(req.GetRequestStream()))
    {
        writer.Write(string.Format(@"<?xml version=""1.0"" encoding=""utf-8""?>
                                   <CertificateFile xmlns=""http://schemas.microsoft.com/windowsazure"">
                                   <Data>{0}</Data>
                                   <CertificateFormat>pfx</CertificateFormat>
                                   <Password>{1}</Password>
                                   </CertificateFile>", 
                                   Convert.ToBase64String(File.ReadAllBytes(pfxPath)), 
                                   password));
    }

    // Submit the request and return the request ID.
    return req.GetResponse().Headers["x-ms-request-id"];
}