Show / Hide Table of Contents

Class NamedCredential

A representation of a named credential in the Management Agent.

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

Properties

DefinedTags

Declaration
[Required(ErrorMessage = "DefinedTags is required.")]
[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. Example: {"foo-namespace": {"bar-key": "value"}}

Remarks

Required

Description

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

Description of the Named Credential.

FreeformTags

Declaration
[Required(ErrorMessage = "FreeformTags is required.")]
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Remarks

Required

Id

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

Identifier for Named Credential.

Remarks

Required

LifecycleState

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

The current state of the named credential

ManagementAgentId

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

The Management Agent parent resource to associated with this named credential. This is the ManagementAgent resource OCID.

Remarks

Required

Name

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

Name for Named Credential. This is unique for the Management Agent.

Remarks

Required

Properties

Declaration
[Required(ErrorMessage = "Properties is required.")]
[JsonProperty(PropertyName = "properties")]
public List<NamedCredentialProperty> Properties { get; set; }
Property Value
Type Description
List<NamedCredentialProperty>

Properties for the named credential

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { "orcl-cloud": { "free-tier-retained": "true" } }

TimeCreated

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

The time the Named Credential was created. An RFC3339 formatted datetime string

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

The time the Named Credential data was last updated. An RFC3339 formatted datetime string

Type

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

The type of the Named Credential.

Remarks

Required

In this article
Back to top