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

Volume

class Volume : KotlinCustomResource

Volume resource Azure REST API version: 2022-11-01. Prior API version in Azure Native 1.x: 2020-12-01. Other available API versions: 2017-08-15, 2019-05-01, 2019-07-01, 2019-08-01, 2020-02-01, 2021-10-01, 2022-11-01-preview, 2023-05-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

Properties

Link copied to clipboard
val actualThroughputMibps: Output<Double>

Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel

Link copied to clipboard
val avsDataStore: Output<String>?

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

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

UUID v4 or resource identifier used to identify the Backup.

Link copied to clipboard
val baremetalTenantId: Output<String>

Unique Baremetal Tenant Identifier.

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

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

Link copied to clipboard
val cloneProgress: Output<Int>

When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.

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

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

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

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>

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

Link copied to clipboard
val dataProtection: Output<VolumePropertiesResponseDataProtection>?

DataProtection type volumes include an object containing details of the replication

Link copied to clipboard
val dataStoreResourceId: Output<List<String>>

Data store resource unique identifier

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

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

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

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

Flag indicating whether subvolume operations are enabled on the volume

Link copied to clipboard
val encrypted: Output<Boolean>

Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.

Link copied to clipboard
val encryptionKeySource: Output<String>?

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 etag: Output<String>

A unique read-only string that changes whenever the resource is updated.

Link copied to clipboard
val exportPolicy: Output<VolumePropertiesResponseExportPolicy>?

Set of export policy rules

Link copied to clipboard
val fileAccessLogs: Output<String>

Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.

Link copied to clipboard
val fileSystemId: Output<String>

Unique FileSystem Identifier.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val isDefaultQuotaEnabled: Output<Boolean>?

Specifies if default quota is enabled for the volume.

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

Specifies whether volume is a Large Volume or Regular Volume.

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

Restoring

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

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

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

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

Link copied to clipboard
val location: Output<String>

The geo-location where the resource lives

Link copied to clipboard
val maximumNumberOfFiles: Output<Double>

Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.

Link copied to clipboard
val mountTargets: Output<List<MountTargetPropertiesResponse>>

List of mount targets

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val networkFeatures: Output<String>?

Basic network, or Standard features available to the volume.

Link copied to clipboard
val networkSiblingSetId: Output<String>

Network Sibling Set ID for the the group of volumes sharing networking resources.

Link copied to clipboard
val originatingResourceId: Output<String>

Id of the snapshot or backup that the volume is restored from.

Link copied to clipboard
val placementRules: Output<List<PlacementKeyValuePairsResponse>>?

Application specific placement rules for the particular volume

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

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

Link copied to clipboard
val provisionedAvailabilityZone: Output<String>

The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.

Link copied to clipboard
val provisioningState: Output<String>

Azure lifecycle management

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

Proximity placement group associated with the volume

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val securityStyle: Output<String>?

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

Link copied to clipboard
val serviceLevel: Output<String>?

The service level of the file system

Link copied to clipboard
val smbAccessBasedEnumeration: Output<String>?

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

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

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

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

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

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

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

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

UUID v4 or resource identifier used to identify the Snapshot.

Link copied to clipboard
val storageToNetworkProximity: Output<String>

Provides storage to network proximity information for the volume.

Link copied to clipboard
val subnetId: Output<String>

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

Link copied to clipboard
val systemData: Output<SystemDataResponse>

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val t2Network: Output<String>

T2 network information

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

Resource tags.

Link copied to clipboard
val throughputMibps: Output<Double>?
Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val unixPermissions: Output<String>?

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 urn: Output<String>
Link copied to clipboard
val usageThreshold: Output<Double>

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 volumeGroupName: Output<String>

Volume Group Name

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

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

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

Availability Zone