Volume

Manages a NetApp Volume.

Create a Volume Resource

new Volume(name: string, args: VolumeArgs, opts?: CustomResourceOptions);

def Volume(resource_name, opts=None, account_name=None, export_policy_rules=None, location=None, name=None, pool_name=None, protocols=None, resource_group_name=None, service_level=None, storage_quota_in_gb=None, subnet_id=None, tags=None, volume_path=None, __props__=None);

func NewVolume(ctx *Context, name string, args VolumeArgs, opts ...ResourceOption) (*Volume, error)

public Volume(string name, VolumeArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args VolumeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args VolumeArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args VolumeArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Volume Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Volume resource accepts the following input properties:

AccountName string: The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
PoolName string: The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
ServiceLevel string: The target performance of the file system. Valid values include Premium, Standard, or Ultra.
StorageQuotaInGb int: The maximum Storage Quota allowed for a file system in Gigabytes.
SubnetId string: The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
VolumePath string: A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
ExportPolicyRules List<VolumeExportPolicyRuleArgs>: One or more export_policy_rule block defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the NetApp Volume. Changing this forces a new resource to be created.
Protocols List<string>: The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.

AccountName string: The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
PoolName string: The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
ResourceGroupName string: The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
ServiceLevel string: The target performance of the file system. Valid values include Premium, Standard, or Ultra.
StorageQuotaInGb int: The maximum Storage Quota allowed for a file system in Gigabytes.
SubnetId string: The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
VolumePath string: A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
ExportPolicyRules []VolumeExportPolicyRule: One or more export_policy_rule block defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Name string: The name of the NetApp Volume. Changing this forces a new resource to be created.
Protocols []string: The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost.
Tags map[string]string: A mapping of tags to assign to the resource.

accountName string: The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
poolName string: The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
resourceGroupName string: The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
serviceLevel string: The target performance of the file system. Valid values include Premium, Standard, or Ultra.
storageQuotaInGb number: The maximum Storage Quota allowed for a file system in Gigabytes.
subnetId string: The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
volumePath string: A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
exportPolicyRules VolumeExportPolicyRule[]: One or more export_policy_rule block defined below.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name string: The name of the NetApp Volume. Changing this forces a new resource to be created.
protocols string[]: The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost.
tags {[key: string]: string}: A mapping of tags to assign to the resource.

account_name str: The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
pool_name str: The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
resource_group_name str: The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
service_level str: The target performance of the file system. Valid values include Premium, Standard, or Ultra.
storage_quota_in_gb float: The maximum Storage Quota allowed for a file system in Gigabytes.
subnet_id str: The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
volume_path str: A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.
export_policy_rules List[VolumeExportPolicyRule]: One or more export_policy_rule block defined below.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
name str: The name of the NetApp Volume. Changing this forces a new resource to be created.
protocols List[str]: The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost.
tags Dict[str, str]: A mapping of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Volume resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
MountIpAddresses List<string>: A list of IPv4 Addresses which should be used to mount the volume.

Id string: The provider-assigned unique ID for this managed resource.
MountIpAddresses []string: A list of IPv4 Addresses which should be used to mount the volume.

id string: The provider-assigned unique ID for this managed resource.
mountIpAddresses string[]: A list of IPv4 Addresses which should be used to mount the volume.

id str: The provider-assigned unique ID for this managed resource.
mount_ip_addresses List[str]: A list of IPv4 Addresses which should be used to mount the volume.

Look up an Existing Volume Resource

Get an existing Volume resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: VolumeState, opts?: CustomResourceOptions): Volume

static get(resource_name, id, opts=None, account_name=None, export_policy_rules=None, location=None, mount_ip_addresses=None, name=None, pool_name=None, protocols=None, resource_group_name=None, service_level=None, storage_quota_in_gb=None, subnet_id=None, tags=None, volume_path=None, __props__=None);

func GetVolume(ctx *Context, name string, id IDInput, state *VolumeState, opts ...ResourceOption) (*Volume, error)

public static Volume Get(string name, Input<string> id, VolumeState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccountName string: The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
ExportPolicyRules List<VolumeExportPolicyRuleArgs>: One or more export_policy_rule block defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MountIpAddresses List<string>: A list of IPv4 Addresses which should be used to mount the volume.
Name string: The name of the NetApp Volume. Changing this forces a new resource to be created.
PoolName string: The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
Protocols List<string>: The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost.
ResourceGroupName string: The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
ServiceLevel string: The target performance of the file system. Valid values include Premium, Standard, or Ultra.
StorageQuotaInGb int: The maximum Storage Quota allowed for a file system in Gigabytes.
SubnetId string: The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
Tags Dictionary<string, string>: A mapping of tags to assign to the resource.
VolumePath string: A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.

AccountName string: The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
ExportPolicyRules []VolumeExportPolicyRule: One or more export_policy_rule block defined below.
Location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
MountIpAddresses []string: A list of IPv4 Addresses which should be used to mount the volume.
Name string: The name of the NetApp Volume. Changing this forces a new resource to be created.
PoolName string: The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
Protocols []string: The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost.
ResourceGroupName string: The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
ServiceLevel string: The target performance of the file system. Valid values include Premium, Standard, or Ultra.
StorageQuotaInGb int: The maximum Storage Quota allowed for a file system in Gigabytes.
SubnetId string: The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
Tags map[string]string: A mapping of tags to assign to the resource.
VolumePath string: A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.

accountName string: The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
exportPolicyRules VolumeExportPolicyRule[]: One or more export_policy_rule block defined below.
location string: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
mountIpAddresses string[]: A list of IPv4 Addresses which should be used to mount the volume.
name string: The name of the NetApp Volume. Changing this forces a new resource to be created.
poolName string: The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
protocols string[]: The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost.
resourceGroupName string: The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
serviceLevel string: The target performance of the file system. Valid values include Premium, Standard, or Ultra.
storageQuotaInGb number: The maximum Storage Quota allowed for a file system in Gigabytes.
subnetId string: The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
tags {[key: string]: string}: A mapping of tags to assign to the resource.
volumePath string: A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.

account_name str: The name of the NetApp account in which the NetApp Pool should be created. Changing this forces a new resource to be created.
export_policy_rules List[VolumeExportPolicyRule]: One or more export_policy_rule block defined below.
location str: Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
mount_ip_addresses List[str]: A list of IPv4 Addresses which should be used to mount the volume.
name str: The name of the NetApp Volume. Changing this forces a new resource to be created.
pool_name str: The name of the NetApp pool in which the NetApp Volume should be created. Changing this forces a new resource to be created.
protocols List[str]: The target volume protocol expressed as a list. Supported single value include CIFS, NFSv3, or NFSv4.1. If argument is not defined it will default to NFSv3. Changing this forces a new resource to be created and data will be lost.
resource_group_name str: The name of the resource group where the NetApp Volume should be created. Changing this forces a new resource to be created.
service_level str: The target performance of the file system. Valid values include Premium, Standard, or Ultra.
storage_quota_in_gb float: The maximum Storage Quota allowed for a file system in Gigabytes.
subnet_id str: The ID of the Subnet the NetApp Volume resides in, which must have the Microsoft.NetApp/volumes delegation. Changing this forces a new resource to be created.
tags Dict[str, str]: A mapping of tags to assign to the resource.
volume_path str: A unique file path for the volume. Used when creating mount targets. Changing this forces a new resource to be created.

Supporting Types

VolumeExportPolicyRule

See the input and output API doc for this type.

AllowedClients List<string>

A list of allowed clients IPv4 addresses.

RuleIndex int

The index number of the rule.

CifsEnabled bool

Is the CIFS protocol allowed?

Deprecated: Deprecated in favour of protocols_enabled

Nfsv3Enabled bool

Is the NFSv3 protocol allowed?

Deprecated: Deprecated in favour of protocols_enabled

Nfsv4Enabled bool

Is the NFSv4 protocol allowed?

Deprecated: Deprecated in favour of protocols_enabled

ProtocolsEnabled string

A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifs_enabled, nfsv3_enabled and nfsv4_enabled.

UnixReadOnly bool