Show / Hide Table of Contents

Class VaultSummary

The details of the Vault.

Inheritance
object
VaultSummary
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.KeymanagementService.Models
Assembly: OCI.DotNetSDK.Keymanagement.dll
Syntax
public class VaultSummary

Properties

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 that contains a particular vault.

Remarks

Required

CryptoEndpoint

Declaration
[Required(ErrorMessage = "CryptoEndpoint is required.")]
[JsonProperty(PropertyName = "cryptoEndpoint")]
public string CryptoEndpoint { get; set; }
Property Value
Type Description
string

The service endpoint to perform cryptographic operations against. Cryptographic operations include Encrypt, Decrypt, and GenerateDataEncryptionKey operations.

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 a vault. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Remarks

Required

ExternalKeyManagerMetadataSummary

Declaration
[JsonProperty(PropertyName = "externalKeyManagerMetadataSummary")]
public ExternalKeyManagerMetadataSummary ExternalKeyManagerMetadataSummary { get; set; }
Property Value
Type Description
ExternalKeyManagerMetadataSummary

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"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

The OCID of a vault.

Remarks

Required

LifecycleState

Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VaultSummary.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
VaultSummary.LifecycleStateEnum?

A vault's current lifecycle state.
Example: ACTIVE

Remarks

Required

ManagementEndpoint

Declaration
[Required(ErrorMessage = "ManagementEndpoint is required.")]
[JsonProperty(PropertyName = "managementEndpoint")]
public string ManagementEndpoint { get; set; }
Property Value
Type Description
string

The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.

Remarks

Required

TimeCreated

Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The date and time a vault was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-03T21:10:29.600Z

Remarks

Required

VaultType

Declaration
[Required(ErrorMessage = "VaultType is required.")]
[JsonProperty(PropertyName = "vaultType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public VaultSummary.VaultTypeEnum? VaultType { get; set; }
Property Value
Type Description
VaultSummary.VaultTypeEnum?

The type of vault. Each type of vault stores keys with different degrees of isolation and has different options and pricing.

Remarks

Required

In this article
Back to top