Class AuditProfile
The resource represents audit profile settings and audit configurations for the database target, and helps evaluate the initial audit data volume for configuring collection in Data Safe. The resource is also responsible for auto-discovery of audit trails in the database target during target's registration.
Inherited Members
Namespace: Oci.DatasafeService.Models
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class AuditProfile
Properties
AuditCollectedVolume
Declaration
[JsonProperty(PropertyName = "auditCollectedVolume")]
public long? AuditCollectedVolume { get; set; }
Property Value
Type | Description |
---|---|
long? | Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit. |
AuditTrails
Declaration
[JsonProperty(PropertyName = "auditTrails")]
public List<AuditTrail> AuditTrails { get; set; }
Property Value
Type | Description |
---|---|
List<AuditTrail> | Indicates the list of available audit trails on the target. |
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 the audit. |
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
|
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | The description of the audit profile. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The display name of the audit profile. |
Remarks
Required
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
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the audit profile. |
Remarks
Required
IsOverrideGlobalRetentionSetting
Declaration
[Required(ErrorMessage = "IsOverrideGlobalRetentionSetting is required.")]
[JsonProperty(PropertyName = "isOverrideGlobalRetentionSetting")]
public bool? IsOverrideGlobalRetentionSetting { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings. |
Remarks
Required
IsPaidUsageEnabled
Declaration
[Required(ErrorMessage = "IsPaidUsageEnabled is required.")]
[JsonProperty(PropertyName = "isPaidUsageEnabled")]
public bool? IsPaidUsageEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level. |
Remarks
Required
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
string | Details about the current state of the audit profile in Data Safe. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public AuditProfileLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
AuditProfileLifecycleState? | The current state of the audit profile. |
Remarks
Required
OfflineMonths
Declaration
[Required(ErrorMessage = "OfflineMonths is required.")]
[JsonProperty(PropertyName = "offlineMonths")]
public int? OfflineMonths { get; set; }
Property Value
Type | Description |
---|---|
int? | Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support. |
Remarks
Required
OnlineMonths
Declaration
[Required(ErrorMessage = "OnlineMonths is required.")]
[JsonProperty(PropertyName = "onlineMonths")]
public int? OnlineMonths { get; set; }
Property Value
Type | Description |
---|---|
int? | Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months |
Remarks
Required
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }
Property Value
Type | Description |
---|---|
Dictionary<string, Dictionary<string, object>> | System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
TargetId
Declaration
[Required(ErrorMessage = "TargetId is required.")]
[JsonProperty(PropertyName = "targetId")]
public string TargetId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Data Safe target for which the audit profile is created. |
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 the audit profile was created, in the format defined by RFC3339. |
Remarks
Required
TimeUpdated
Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The date and time the audit profile was updated, in the format defined by RFC3339. |
Remarks
Required