Update Key

PUT 
/projects/:projectId/providers/Aruba.Security/kms/:id/keys/:keyId

Update Key

Request

Path Parameters

projectId stringrequired
id stringrequired
keyId stringrequired

Query Parameters

api-version string
The requested API version
Default value: 1

application/json

Body

namestring

Kms key name

text/json

Body

namestring

Kms key name

application/*+json

Body

namestring

Kms key name

Responses

200

OK

text/plain

Schema

Schema

keyIdstringnullable

Kms key id

privateKeyIdstringnullable

Kms Private key id

namestringnullable

Kms key name

algorithmKeyAlgorithms (string)

Possible values: [Aes, Rsa]

creationSourceKeyCreationSource (string)

Possible values: [Cmp, Other]

typeKeyTypes (string)

Possible values: [Symmetric, Asymmetric]

statusKeyStatuses (string)

Possible values: [Active, InCreation, Deleting, Deleted, Failed]

Example (from schema)

{
  "keyId": "string",
  "privateKeyId": "string",
  "name": "string",
  "algorithm": "Aes",
  "creationSource": "Cmp",
  "type": "Symmetric",
  "status": "Active"
}

application/json

Schema

Schema

keyIdstringnullable

Kms key id

privateKeyIdstringnullable

Kms Private key id

namestringnullable

Kms key name

algorithmKeyAlgorithms (string)

Possible values: [Aes, Rsa]

creationSourceKeyCreationSource (string)

Possible values: [Cmp, Other]

typeKeyTypes (string)

Possible values: [Symmetric, Asymmetric]

statusKeyStatuses (string)

Possible values: [Active, InCreation, Deleting, Deleted, Failed]

Example (from schema)

{
  "keyId": "string",
  "privateKeyId": "string",
  "name": "string",
  "algorithm": "Aes",
  "creationSource": "Cmp",
  "type": "Symmetric",
  "status": "Active"
}

text/json

Schema

Schema

keyIdstringnullable

Kms key id

privateKeyIdstringnullable

Kms Private key id

namestringnullable

Kms key name

algorithmKeyAlgorithms (string)

Possible values: [Aes, Rsa]

creationSourceKeyCreationSource (string)

Possible values: [Cmp, Other]

typeKeyTypes (string)

Possible values: [Symmetric, Asymmetric]

statusKeyStatuses (string)

Possible values: [Active, InCreation, Deleting, Deleted, Failed]

Example (from schema)

{
  "keyId": "string",
  "privateKeyId": "string",
  "name": "string",
  "algorithm": "Aes",
  "creationSource": "Cmp",
  "type": "Symmetric",
  "status": "Active"
}

400

Bad Request

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

404

Not Found

text/plain

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

application/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

text/json

Schema

Schema

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Internal Server Error