UpdateSecret Method

Updates a secret's information.

Syntax

• C++
• Objective-C
• C

ANSI (Cross Platform)
int UpdateSecret(const char* lpszSecretName, const char* lpszContentType, int bUpdateTags);

Unicode (Windows)
INT UpdateSecret(LPCWSTR lpszSecretName, LPCWSTR lpszContentType, BOOL bUpdateTags);

- (void)updateSecret:(NSString*)secretName :(NSString*)contentType :(BOOL)updateTags;

#define MID_AZURESECRETS_UPDATESECRET 19

CLOUDKEYS_EXTERNAL int CLOUDKEYS_CALL CloudKeys_AzureSecrets_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);

Remarks

This method updates the information for the secret specified by SecretName. The VersionId configuration setting can be used to target a specific secret version.

The ContentType parameter, if non-empty, can be any string value. If empty, the secret's current content type is left unchanged. (To explicitly clear the secret's content type, pass %CLEAR%).

The UpdateTags parameter determines whether the class replaces the secret's current tags with the items in the Tag* properties (which may be empty). Secrets may have up to 15 tags.

The ExpiryDate and NotBeforeDate configuration settings may also be used to send additional values, refer to their documentation for more information.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)