Skip to main content

Create a new volume

POST /azure/vsa/volumes

Creates a new volume. If the aggregateName and maxNumOfDisksApprovedToAdd properties are not populated, the response fails with a suggested aggregate name and the number of disks that will need to be created in order to fulfill the request.

Parameters

Name Type In Required Description

createAggregateIfNotFound

boolean

query

False

Request Body

Name Type Required Description

aggregateName

string

True

Aggregate in which the volume will be created

capacityTier

string

False

Capacity tier

comment

string

False

Volume Comment

enableCompression

boolean

True

Enable compression on the volume

enableDeduplication

boolean

True

Enable deduplication on the volume

enableThinProvisioning

boolean

True

Enable thin provisioning on the volume

evCapacityApprovedToAdd

ElasticVolumeQuoteInfo

False

exportPolicyInfo

ExportPolicyInfo

False

flexGroupVolumeInfo

FlexGroupVolumeInfo

False

initialSize

Capacity

False

iops

integer

False

Provisioned IOPS

iscsiInfo

CreateIscsiInfoRequest

False

junctionPath

string

False

Junction path

maxNumOfDisksApprovedToAdd

integer

True

Maximum number of disks approved to allocate

minimumCoolingDays

minimumCoolingDays

False

Cooling Days

name

string

False

Volume name, unique within the SVM

providerVolumeType

string

False

Provider volume type

qualityOfService

VolumeQualityOfService

False

shareInfo

CreateCifsShareInfoRequest

False

size

PositiveCapacity

True

snapshotPolicyName

string

True

Snapshot policy name

svmName

string

True

SVM name

syncToS3

boolean

True

Add a cloud sync relationship

throughput

integer

False

Provisioned throughput

tieringPolicy

string

False

Tiering policy

volumeTags

array[VolumeTags]

True

Optionally, provide key-value pairs with which to tag the ONTAP volume using the App Template service.

workingEnvironmentId

string

True

Cloud Volumes ONTAP system ID

Error

Status: Default, Default response

Definitions

See Definitions

Capacity

Name Type Required Description

size

number

True

Size

unit

string

True

Unit

RaidInfoForEvAggregate

Name Type Required Description

diskSize

Capacity

True

numOfDisks

integer

True

Number of new disks needed for the RAID group

ElasticVolumeQuoteInfo

Name Type Required Description

addedCapacityToExistingEvDisks

Capacity

False

newRaidForEvInfo

array[RaidInfoForEvAggregate]

False

New RAID information

totalCapacityToAdd

Capacity

False

totalEvDisks

integer

False

index

Export policy rule index

ExportPolicyRule

Name Type Required Description

index

index

False

Export policy rule index

ips

array[string]

True

Export policy rule list of IPs

nfsVersion

array[string]

False

Export policy rule protocol

ruleAccessControl

string

True

Export policy rule access control

superUser

boolean

True

Export policy rule super user access

ExportPolicyInfo

Name Type Required Description

ips

array[string]

False

Custom export policy list of IPs

nfsVersion

array[string]

False

Export policy protocol

policyType

string

False

Export policy type

rules

array[ExportPolicyRule]

False

Export policy rules

FlexGroupVolumeInfo

Name Type Required Description

aggregateList

array[string]

False

Names of aggregates for the FlexGroup volume

numberOfConstituents

integer

False

Number of constituents for the flexgroup volume

IgroupCreationRequest

Name Type Required Description

igroupName

string

False

Igroup name

initiators

array[string]

False

Initiators

CreateIscsiInfoRequest

Name Type Required Description

igroupCreationRequest

IgroupCreationRequest

False

igroups

array[string]

False

Igroups

osName

string

False

Operating system

minimumCoolingDays

Cooling Days

VolumeQualityOfService

Name Type Required Description

maxDataRate

Capacity

False

maxIops

integer

False

CifsShareUserPermissions

Name Type Required Description

permission

string

False

CIFS share permission type

users

array[string]

True

List of users with the permission

CreateCifsShareInfoRequest

Name Type Required Description

accessControl

CifsShareUserPermissions

False

shareName

string

False

Share name

PositiveCapacity

Name Type Required Description

size

number

True

Size

unit

string

True

Unit

VolumeTags

Name Type Required Description

tagKey

string

False

tagValue

string

False