Skip to main content
REST API reference
A newer release of this product is available.

Update the AKV configuration

PDFs

PATCH /security/azure-key-vaults/{uuid}

Introduced In: 9.8

Updates the AKV configuration.

Required properties

  • client_secret - New password used to prove the application's identity to the AKV.

  • security key-manager external azure modify

Parameters

Name Type In Required Description

uuid

string

path

True

AKV UUID

Request Body

Name Type Description

client_id

string

Application client ID of the deployed Azure application with appropriate access to an AKV.

client_secret

string

Password used by the application to prove its identity to AKV.

key_id

string

Key Identifier of AKV key encryption key.

name

string

Name of the deployed AKV that will be used by ONTAP for storing keys.

svm

svm

tenant_id

string

Directory (tenant) ID of the deployed Azure application with appropriate access to an AKV.

uuid

string

A unique identifier for the Azure Key Vault (AKV).
Example request 
{
  "client_id": "aaaaaaaa-bbbb-aaaa-bbbb-aaaaaaaaaaaa",
  "client_secret": "abcdef",
  "key_id": "https://keyvault1.vault.azure.net/keys/key1/a8e619fd8f234db3b0b95c59540e2a74",
  "name": "https://kmip-akv-keyvault.vault.azure.net/",
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "tenant_id": "zzzzzzzz-yyyy-zzzz-yyyy-zzzzzzzzzzzz",
  "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}

Response

Status: 200, Ok

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65537503

Passwords do not match.

65537504

Internal error. Failed to store configuration in internal database.

65537511

AKV is not configured for the given SVM.

65537517

The field "new_client_secret" must be specified.

Definitions

See Definitions

href

Name Type Description

href

string

_links

state

Indicates whether the AKV key protection is available cluster wide.

Name Type Description

cluster_state

boolean

Set to true when AKV key protection is available on all nodes of the cluster.

code

integer

Code corresponding to the status message. Returns a 0 if AKV key protection is available in all nodes of the cluster.

message

string

Error message set when cluster availability is false.

svm

Name Type Description

name

string

The name of the SVM.

uuid

string

The unique identifier of the SVM.

azure_key_vault

Name Type Description

client_id

string

Application client ID of the deployed Azure application with appropriate access to an AKV.

client_secret

string

Password used by the application to prove its identity to AKV.

key_id

string

Key Identifier of AKV key encryption key.

name

string

Name of the deployed AKV that will be used by ONTAP for storing keys.

svm

svm

tenant_id

string

Directory (tenant) ID of the deployed Azure application with appropriate access to an AKV.

uuid

string

A unique identifier for the Azure Key Vault (AKV).

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.