Class CreateKeyDetails
The details of the key that you want to create.
Inherited Members
Namespace: Oci.KeymanagementService.Models
Assembly: OCI.DotNetSDK.Keymanagement.dll
Syntax
public class CreateKeyDetails
Properties
AutoKeyRotationDetails
Declaration
[JsonProperty(PropertyName = "autoKeyRotationDetails")]
public AutoKeyRotationDetails AutoKeyRotationDetails { get; set; }
Property Value
Type | Description |
---|---|
AutoKeyRotationDetails |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the compartment where you want to create the master encryption key. |
Remarks
Required
DefinedTags
Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations": {"CostCenter": "42"}} |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly name for the key. It does not have to be unique, and it is changeable. Avoid entering confidential information. |
Remarks
Required
ExternalKeyReference
Declaration
[JsonProperty(PropertyName = "externalKeyReference")]
public ExternalKeyReference ExternalKeyReference { get; set; }
Property Value
Type | Description |
---|---|
ExternalKeyReference |
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, string> | Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"} |
IsAutoRotationEnabled
Declaration
[JsonProperty(PropertyName = "isAutoRotationEnabled")]
public bool? IsAutoRotationEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | A parameter specifying whether the auto key rotation is enabled or not. |
KeyShape
Declaration
[Required(ErrorMessage = "KeyShape is required.")]
[JsonProperty(PropertyName = "keyShape")]
public KeyShape KeyShape { get; set; }
Property Value
Type | Description |
---|---|
KeyShape |
Remarks
Required
ProtectionMode
Declaration
[JsonProperty(PropertyName = "protectionMode")]
[JsonConverter(typeof(StringEnumConverter))]
public CreateKeyDetails.ProtectionModeEnum? ProtectionMode { get; set; }
Property Value
Type | Description |
---|---|
CreateKeyDetails.ProtectionModeEnum? | The key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed.
A protection mode of |