Show / Hide Table of Contents

Class VirtualService

This resource represents a customer-managed service in the Service Mesh. Each virtual service declares multiple running versions of the service and maps to a group of instances/pods running a specific version of the actual service.

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

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.

Remarks

Required

DefaultRoutingPolicy

Declaration
[JsonProperty(PropertyName = "defaultRoutingPolicy")]
public DefaultVirtualServiceRoutingPolicy DefaultRoutingPolicy { get; set; }
Property Value
Type Description
DefaultVirtualServiceRoutingPolicy

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. Example: {"foo-namespace": {"bar-key": "value"}}

Description

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

Description of the resource. It can be changed after creation. Avoid entering confidential information.
Example: This is my new resource

FreeformTags

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

Hosts

Declaration
[JsonProperty(PropertyName = "hosts")]
public List<string> Hosts { get; set; }
Property Value
Type Description
List<string>

The DNS hostnames of the virtual service that is used by its callers. Wildcard hostnames are supported in the prefix form. Examples of valid hostnames are "www.example.com", ".example.com", ".com". Can be omitted if the virtual service will only have TCP virtual deployments.

Id

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

Unique identifier that is immutable on creation.

Remarks

Required

LifecycleDetails

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

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

LifecycleState

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

The current state of the Resource.

Remarks

Required

MeshId

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

The OCID of the service mesh in which this virtual service is created.

Remarks

Required

Mtls

Declaration
[JsonProperty(PropertyName = "mtls")]
public MutualTransportLayerSecurity Mtls { get; set; }
Property Value
Type Description
MutualTransportLayerSecurity

Name

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

A user-friendly name. The name has to be unique within the same service mesh and cannot be changed after creation. Avoid entering confidential information.
Example: My unique resource name

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
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

The time when this resource was created in an RFC3339 formatted datetime string.

Remarks

Required

TimeUpdated

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

The time when this resource was updated in an RFC3339 formatted datetime string.

Remarks

Required

In this article
Back to top