Update a credential

Article
01/06/2016

The Update a credential operation updates the username, description, and password of a specified credential.

Request

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 <credential-name> with the name of the credential 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>/credentials/<credential-name>?api-version=2014-12-08

URI Parameters

Uri Parameter	Description
api-version	Required. Must be set to 2014-12-08.

Request Headers

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.

Request Body

In this example, just the password is updated.

{
   "properties":{
      "password":"!$anchorBlue",
   }
}

Element	Required	Type	Description
password	Yes	String	The password of the credential.

Response

Status Code

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

Response Headers

Request Header	Description
x-ms-request-id	A unique identifier for the current operation.

Response Body

In this example, the response body does not show the change of the password.

{
   "name":"Cred_IVargas",
   "properties":{
      "userName":"IVargs@litware.com",
      "description":"Isadora Vargas credential",
      "creationTime":"2015-03-30T15:32:42.22+00:00",
      "lastModifiedTime":"2015-03-30T15:32:42.22+00:00"
   }
}

Element	Description
name	The name of the credential.
userName	The name of the user associated with the credential.
description	Description of the credential.
creationTime	The date and time the credential was created.
lastModifiedTime	The date and time the credential was last changed.