pulumi-azure-native-kotlin/com.pulumi.azurenative.netapp.kotlin/VolumeArgs

VolumeArgs

data class VolumeArgs(val accountName: Output<String>? = null, val avsDataStore: Output<Either<String, AvsDataStore>>? = null, val backupId: Output<String>? = null, val capacityPoolResourceId: Output<String>? = null, val coolAccess: Output<Boolean>? = null, val coolnessPeriod: Output<Int>? = null, val creationToken: Output<String>? = null, val dataProtection: Output<VolumePropertiesDataProtectionArgs>? = null, val defaultGroupQuotaInKiBs: Output<Double>? = null, val defaultUserQuotaInKiBs: Output<Double>? = null, val deleteBaseSnapshot: Output<Boolean>? = null, val enableSubvolumes: Output<Either<String, EnableSubvolumes>>? = null, val encryptionKeySource: Output<Either<String, EncryptionKeySource>>? = null, val exportPolicy: Output<VolumePropertiesExportPolicyArgs>? = null, val isDefaultQuotaEnabled: Output<Boolean>? = null, val isLargeVolume: Output<Boolean>? = null, val isRestoring: Output<Boolean>? = null, val kerberosEnabled: Output<Boolean>? = null, val keyVaultPrivateEndpointResourceId: Output<String>? = null, val ldapEnabled: Output<Boolean>? = null, val location: Output<String>? = null, val networkFeatures: Output<Either<String, NetworkFeatures>>? = null, val placementRules: Output<List<PlacementKeyValuePairsArgs>>? = null, val poolName: Output<String>? = null, val protocolTypes: Output<List<String>>? = null, val proximityPlacementGroup: Output<String>? = null, val resourceGroupName: Output<String>? = null, val securityStyle: Output<Either<String, SecurityStyle>>? = null, val serviceLevel: Output<Either<String, ServiceLevel>>? = null, val smbAccessBasedEnumeration: Output<Either<String, SmbAccessBasedEnumeration>>? = null, val smbContinuouslyAvailable: Output<Boolean>? = null, val smbEncryption: Output<Boolean>? = null, val smbNonBrowsable: Output<Either<String, SmbNonBrowsable>>? = null, val snapshotDirectoryVisible: Output<Boolean>? = null, val snapshotId: Output<String>? = null, val subnetId: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val throughputMibps: Output<Double>? = null, val unixPermissions: Output<String>? = null, val usageThreshold: Output<Double>? = null, val volumeName: Output<String>? = null, val volumeSpecName: Output<String>? = null, val volumeType: Output<String>? = null, val zones: Output<List<String>>? = null) : ConvertibleToJava<VolumeArgs>

Volume resource Azure REST API version: 2022-11-01. Prior API version in Azure Native 1.x: 2020-12-01

Example Usage

Volumes_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var volume = new AzureNative.NetApp.Volume("volume", new()
    {
        AccountName = "account1",
        CreationToken = "my-unique-file-path",
        Location = "eastus",
        PoolName = "pool1",
        ResourceGroupName = "myRG",
        ServiceLevel = "Premium",
        SubnetId = "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
        UsageThreshold = 107374182400,
        VolumeName = "volume1",
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-azure-native-sdk/netapp/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netapp.NewVolume(ctx, "volume", &netapp.VolumeArgs{
			AccountName:       pulumi.String("account1"),
			CreationToken:     pulumi.String("my-unique-file-path"),
			Location:          pulumi.String("eastus"),
			PoolName:          pulumi.String("pool1"),
			ResourceGroupName: pulumi.String("myRG"),
			ServiceLevel:      pulumi.String("Premium"),
			SubnetId:          pulumi.String("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
			UsageThreshold:    pulumi.Float64(107374182400),
			VolumeName:        pulumi.String("volume1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.netapp.Volume;
import com.pulumi.azurenative.netapp.VolumeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var volume = new Volume("volume", VolumeArgs.builder()
            .accountName("account1")
            .creationToken("my-unique-file-path")
            .location("eastus")
            .poolName("pool1")
            .resourceGroupName("myRG")
            .serviceLevel("Premium")
            .subnetId("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3")
            .usageThreshold(107374182400)
            .volumeName("volume1")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:netapp:Volume account1/pool1/volume1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}
Content copied to clipboard

Constructors

Link copied to clipboard
fun VolumeArgs(accountName: Output<String>? = null, avsDataStore: Output<Either<String, AvsDataStore>>? = null, backupId: Output<String>? = null, capacityPoolResourceId: Output<String>? = null, coolAccess: Output<Boolean>? = null, coolnessPeriod: Output<Int>? = null, creationToken: Output<String>? = null, dataProtection: Output<VolumePropertiesDataProtectionArgs>? = null, defaultGroupQuotaInKiBs: Output<Double>? = null, defaultUserQuotaInKiBs: Output<Double>? = null, deleteBaseSnapshot: Output<Boolean>? = null, enableSubvolumes: Output<Either<String, EnableSubvolumes>>? = null, encryptionKeySource: Output<Either<String, EncryptionKeySource>>? = null, exportPolicy: Output<VolumePropertiesExportPolicyArgs>? = null, isDefaultQuotaEnabled: Output<Boolean>? = null, isLargeVolume: Output<Boolean>? = null, isRestoring: Output<Boolean>? = null, kerberosEnabled: Output<Boolean>? = null, keyVaultPrivateEndpointResourceId: Output<String>? = null, ldapEnabled: Output<Boolean>? = null, location: Output<String>? = null, networkFeatures: Output<Either<String, NetworkFeatures>>? = null, placementRules: Output<List<PlacementKeyValuePairsArgs>>? = null, poolName: Output<String>? = null, protocolTypes: Output<List<String>>? = null, proximityPlacementGroup: Output<String>? = null, resourceGroupName: Output<String>? = null, securityStyle: Output<Either<String, SecurityStyle>>? = null, serviceLevel: Output<Either<String, ServiceLevel>>? = null, smbAccessBasedEnumeration: Output<Either<String, SmbAccessBasedEnumeration>>? = null, smbContinuouslyAvailable: Output<Boolean>? = null, smbEncryption: Output<Boolean>? = null, smbNonBrowsable: Output<Either<String, SmbNonBrowsable>>? = null, snapshotDirectoryVisible: Output<Boolean>? = null, snapshotId: Output<String>? = null, subnetId: Output<String>? = null, tags: Output<Map<String, String>>? = null, throughputMibps: Output<Double>? = null, unixPermissions: Output<String>? = null, usageThreshold: Output<Double>? = null, volumeName: Output<String>? = null, volumeSpecName: Output<String>? = null, volumeType: Output<String>? = null, zones: Output<List<String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): VolumeArgs

Properties

Link copied to clipboard
val accountName: Output<String>? = null

The name of the NetApp account

Link copied to clipboard
val avsDataStore: Output<Either<String, AvsDataStore>>? = null

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose

Link copied to clipboard
val backupId: Output<String>? = null

UUID v4 or resource identifier used to identify the Backup.

Link copied to clipboard
val capacityPoolResourceId: Output<String>? = null

Pool Resource Id used in case of creating a volume through volume group

Link copied to clipboard
val coolAccess: Output<Boolean>? = null

Specifies whether Cool Access(tiering) is enabled for the volume.

Link copied to clipboard
val coolnessPeriod: Output<Int>? = null

Specifies the number of days after which data that is not accessed by clients will be tiered.

Link copied to clipboard
val creationToken: Output<String>? = null

A unique file path for the volume. Used when creating mount targets

Link copied to clipboard
val dataProtection: Output<VolumePropertiesDataProtectionArgs>? = null

DataProtection type volumes include an object containing details of the replication

Link copied to clipboard
val defaultGroupQuotaInKiBs: Output<Double>? = null

Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

Link copied to clipboard
val defaultUserQuotaInKiBs: Output<Double>? = null

Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .

Link copied to clipboard
val deleteBaseSnapshot: Output<Boolean>? = null

If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false

Link copied to clipboard
val enableSubvolumes: Output<Either<String, EnableSubvolumes>>? = null

Flag indicating whether subvolume operations are enabled on the volume

Link copied to clipboard
val encryptionKeySource: Output<Either<String, EncryptionKeySource>>? = null

Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'

Link copied to clipboard
val exportPolicy: Output<VolumePropertiesExportPolicyArgs>? = null

Set of export policy rules

Link copied to clipboard
val isDefaultQuotaEnabled: Output<Boolean>? = null

Specifies if default quota is enabled for the volume.

Link copied to clipboard
val isLargeVolume: Output<Boolean>? = null

Specifies whether volume is a Large Volume or Regular Volume.

Link copied to clipboard
val isRestoring: Output<Boolean>? = null

Restoring

Link copied to clipboard
val kerberosEnabled: Output<Boolean>? = null

Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later

Link copied to clipboard
val keyVaultPrivateEndpointResourceId: Output<String>? = null

The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

Link copied to clipboard
val ldapEnabled: Output<Boolean>? = null

Specifies whether LDAP is enabled or not for a given NFS volume.

Link copied to clipboard
val location: Output<String>? = null

The geo-location where the resource lives

Link copied to clipboard
val networkFeatures: Output<Either<String, NetworkFeatures>>? = null

Basic network, or Standard features available to the volume.

Link copied to clipboard
val placementRules: Output<List<PlacementKeyValuePairsArgs>>? = null

Application specific placement rules for the particular volume

Link copied to clipboard
val poolName: Output<String>? = null

The name of the capacity pool

Link copied to clipboard
val protocolTypes: Output<List<String>>? = null

Set of protocol types, default NFSv3, CIFS for SMB protocol

Link copied to clipboard
val proximityPlacementGroup: Output<String>? = null

Proximity placement group associated with the volume

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val securityStyle: Output<Either<String, SecurityStyle>>? = null

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol

Link copied to clipboard
val serviceLevel: Output<Either<String, ServiceLevel>>? = null

The service level of the file system

Link copied to clipboard
val smbAccessBasedEnumeration: Output<Either<String, SmbAccessBasedEnumeration>>? = null

Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume

Link copied to clipboard
val smbContinuouslyAvailable: Output<Boolean>? = null

Enables continuously available share property for smb volume. Only applicable for SMB volume

Link copied to clipboard
val smbEncryption: Output<Boolean>? = null

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later

Link copied to clipboard
val smbNonBrowsable: Output<Either<String, SmbNonBrowsable>>? = null

Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume

Link copied to clipboard
val snapshotDirectoryVisible: Output<Boolean>? = null

If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).

Link copied to clipboard
val snapshotId: Output<String>? = null

UUID v4 or resource identifier used to identify the Snapshot.

Link copied to clipboard
val subnetId: Output<String>? = null

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Resource tags.

Link copied to clipboard
val throughputMibps: Output<Double>? = null
Link copied to clipboard
val unixPermissions: Output<String>? = null

UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.

Link copied to clipboard
val usageThreshold: Output<Double>? = null

Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB, 500Tib for LargeVolume. Specified in bytes.

Link copied to clipboard
val volumeName: Output<String>? = null

The name of the volume

Link copied to clipboard
val volumeSpecName: Output<String>? = null

Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log

Link copied to clipboard
val volumeType: Output<String>? = null

What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection

Link copied to clipboard
val zones: Output<List<String>>? = null

Availability Zone