Keys - Set Tenant Protection Key

Sets the tenant protection (encryption) key.
For a list of region-specific service URLs, see Service URL

POST {ServiceUrl}/api/v1.2/Keys/{keyName}/SetTenantProtectionKey

URI Parameters

Name In Required Type Description
keyName
path True
  • string

The name of the key being set

Responses

Name Type Description
202 Accepted

Set Tenant Protection Key operation started

Media Types: "application/json", "text/json"

400 Bad Request

There was an issue with either validating or setting the tenant protection key

Media Types: "application/json", "text/json"

Definitions

ItemDescription

Set of values to define an error or information item

OperationContext

The operation context object

OperationState

State of the operation

OperationStatus

Status of the operation

ItemDescription

Set of values to define an error or information item

Name Type Description
Code
  • string

Code of the item

Description
  • string

Description of the item

Subject
  • string

Subject of the item

OperationContext

The operation context object

Name Type Description
Items
  • object

The item object

OperationState

State of the operation

Name Type Description
Aborted
  • string
Aborting
  • string
Cancelled
  • string
Cancelling
  • string
Conflict
  • string
Deleted
  • string
Deleting
  • string
Failed
  • string
FailedToCreate
  • string
None
  • string
NotFound
  • string
NotStarted
  • string
Pending
  • string
Ready
  • string
Running
  • string
Succeeded
  • string
Tombstone
  • string

OperationStatus

Status of the operation

Name Type Description
Context

The operation context object

Errors

Set of values to display errors during an operation

Information

Set of values to display information during an operation

OperationId
  • string

ID of the operation

OperationLocation
  • string

Location of the operation

ResourceLocation
  • string

Location of the resource

Status

State of the operation