Update a certificate's description

 

The Update a certificate's description operation updates description a specified certificate without changing other properties.

To specify the request, replace <subscription-id> with your subscription ID, <cloud-service-name> with the name of the cloud service to use for making the request, <automation-account-name> with the name of the automation account to use for making the request, and <certificate-name> with the name of the certificate to update. Include required URI parameters.

Method

Request URI

PATCH

https://management.core.windows.net/<subscription-id>/cloudServices/<cloud-service-name>/resources/automation/~/automationAccounts/<automation-account-name>/cerificates/<certificate-name>?api-version=2014-12-08

Parameter

Description

api-version

Required. Must be set to 2014-12-08.

The request headers in the following table are required.

Request Header

Description

Content-Type

Set to application/json. Do not include a specification for charset.

x-ms-version

Specifies the version of the operation. Set to 2013-06-01 or a later version.

JSON
Copy 
{
   "properties":{
      "description":"Certificate for Litware.com - 2015"
   }
}

Element

Required

Type

Description

description

No (can be an empty string)

String

A description of the certificate.

A successful operation returns 200 (OK). For information about common error codes, see HTTP/1.1 Status Code Definitions.

Request Header

Description

x-ms-request-id

A unique identifier for the current operation.

JSON
Copy 
{
   "name":"SSLCert-Litware.com",
   "properties":{
      "description":"Certificate for Litware.com - 2015",
      "isExportable":false,
      "thumbprint":"0735053FAEDB0F971D9111CDCCA5ACADE1E1734E",
      "expiryTime":"2017-02-25T23:54:23+00:00",
      "creationTime":"2015-04-05T19:35:56.44+00:00",
      "lastModifiedTime":"2015-04-05T19:42:49.293+00:00"
   }
}

Element

Description

name

Friendly name for the certificate.

description

Description of the certificate or additional information.

isExportable

true if the certificate can be exported; otherwise false.

thumbprint

The thumbprint of the certificate.

expriryTime

The date and time the certificate expires.

creationTime

The date and time the certificate was created.

lastmodificationTime

The date and time the certificate was last changed.

Show: