Class Volume
A detachable block volume device that allows you to dynamically expand
the storage capacity of an instance. For more information, see
Overview of Cloud Volume Storage.
To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,
talk to an administrator. If you're an administrator who needs to write policies to give users access, see
Getting Started with Policies.
Warning: Oracle recommends that you avoid using any confidential information when you
supply string values using the API.
Inherited Members
Namespace: Oci.CoreService.Models
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class Volume
Properties
AutoTunedVpusPerGB
Declaration
[JsonProperty(PropertyName = "autoTunedVpusPerGB")]
public long? AutoTunedVpusPerGB { get; set; }
Property Value
Type | Description |
---|---|
long? | The number of Volume Performance Units per GB that this volume is effectively tuned to. |
AutotunePolicies
Declaration
[JsonProperty(PropertyName = "autotunePolicies")]
public List<AutotunePolicy> AutotunePolicies { get; set; }
Property Value
Type | Description |
---|---|
List<AutotunePolicy> | The list of autotune policies enabled for this volume. |
AvailabilityDomain
Declaration
[Required(ErrorMessage = "AvailabilityDomain is required.")]
[JsonProperty(PropertyName = "availabilityDomain")]
public string AvailabilityDomain { get; set; }
Property Value
Type | Description |
---|---|
string | The availability domain of the volume.
|
Remarks
Required
BlockVolumeReplicas
Declaration
[JsonProperty(PropertyName = "blockVolumeReplicas")]
public List<BlockVolumeReplicaInfo> BlockVolumeReplicas { get; set; }
Property Value
Type | Description |
---|---|
List<BlockVolumeReplicaInfo> | The list of block volume replicas of this volume. |
ClusterPlacementGroupId
Declaration
[JsonProperty(PropertyName = "clusterPlacementGroupId")]
public string ClusterPlacementGroupId { get; set; }
Property Value
Type | Description |
---|---|
string | The clusterPlacementGroup Id of the volume for volume placement. |
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 volume. |
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.
|
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
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 volume. |
Remarks
Required
IsAutoTuneEnabled
Declaration
[JsonProperty(PropertyName = "isAutoTuneEnabled")]
public bool? IsAutoTuneEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Specifies whether the auto-tune performance is enabled for this volume. This field is deprecated.
Use the |
IsHydrated
Declaration
[JsonProperty(PropertyName = "isHydrated")]
public bool? IsHydrated { get; set; }
Property Value
Type | Description |
---|---|
bool? | Specifies whether the cloned volume's data has finished copying from the source volume or backup. |
KmsKeyId
Declaration
[JsonProperty(PropertyName = "kmsKeyId")]
public string KmsKeyId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the Vault service key which is the master encryption key for the volume. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Volume.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
Volume.LifecycleStateEnum? | The current state of a volume. |
Remarks
Required
SizeInGBs
Declaration
[JsonProperty(PropertyName = "sizeInGBs")]
public long? SizeInGBs { get; set; }
Property Value
Type | Description |
---|---|
long? | The size of the volume in GBs. |
SizeInMBs
Declaration
[Required(ErrorMessage = "SizeInMBs is required.")]
[JsonProperty(PropertyName = "sizeInMBs")]
public long? SizeInMBs { get; set; }
Property Value
Type | Description |
---|---|
long? | The size of the volume in MBs. This field is deprecated. Use sizeInGBs instead. |
Remarks
Required
SourceDetails
Declaration
[JsonProperty(PropertyName = "sourceDetails")]
public VolumeSourceDetails SourceDetails { get; set; }
Property Value
Type | Description |
---|---|
VolumeSourceDetails |
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. Example: {"foo-namespace": {"bar-key": "value"}} |
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 volume was created. Format defined by RFC3339. |
Remarks
Required
VolumeGroupId
Declaration
[JsonProperty(PropertyName = "volumeGroupId")]
public string VolumeGroupId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the source volume group. |
VpusPerGB
Declaration
[JsonProperty(PropertyName = "vpusPerGB")]
public long? VpusPerGB { get; set; }
Property Value
Type | Description |
---|---|
long? | The number of volume performance units (VPUs) that will be applied to this volume per GB,
representing the Block Volume service's elastic performance options.
See Block Volume Performance Levels for more information.
|