Use Pulumi's new import command to generate code from existing cloud resources. Learn More

FileShare

Properties of the file share, including Id, resource name, resource type, Etag. Latest API Version: 2019-06-01.

Example Usage

Create NFS Shares

using Pulumi;
using AzureNextGen = Pulumi.AzureNextGen;

class MyStack : Stack
{
    public MyStack()
    {
        var fileShare = new AzureNextGen.Storage.Latest.FileShare("fileShare", new AzureNextGen.Storage.Latest.FileShareArgs
        {
            AccountName = "sto666",
            EnabledProtocols = "NFS",
            ResourceGroupName = "res346",
            ShareName = "share1235",
        });
    }

}
package main

import (
    storage "github.com/pulumi/pulumi-azure-nextgen/sdk/go/azure/storage/latest"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := storage.NewFileShare(ctx, "fileShare", &storage.FileShareArgs{
            AccountName:       pulumi.String("sto666"),
            EnabledProtocols:  pulumi.String("NFS"),
            ResourceGroupName: pulumi.String("res346"),
            ShareName:         pulumi.String("share1235"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure_nextgen as azure_nextgen

file_share = azure_nextgen.storage.latest.FileShare("fileShare",
    account_name="sto666",
    enabled_protocols="NFS",
    resource_group_name="res346",
    share_name="share1235")
import * as pulumi from "@pulumi/pulumi";
import * as azure_nextgen from "@pulumi/azure-nextgen";

const fileShare = new azure_nextgen.storage.latest.FileShare("fileShare", {
    accountName: "sto666",
    enabledProtocols: "NFS",
    resourceGroupName: "res346",
    shareName: "share1235",
});

PutShares

using Pulumi;
using AzureNextGen = Pulumi.AzureNextGen;

class MyStack : Stack
{
    public MyStack()
    {
        var fileShare = new AzureNextGen.Storage.Latest.FileShare("fileShare", new AzureNextGen.Storage.Latest.FileShareArgs
        {
            AccountName = "sto328",
            ResourceGroupName = "res3376",
            ShareName = "share6185",
        });
    }

}
package main

import (
    storage "github.com/pulumi/pulumi-azure-nextgen/sdk/go/azure/storage/latest"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := storage.NewFileShare(ctx, "fileShare", &storage.FileShareArgs{
            AccountName:       pulumi.String("sto328"),
            ResourceGroupName: pulumi.String("res3376"),
            ShareName:         pulumi.String("share6185"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure_nextgen as azure_nextgen

file_share = azure_nextgen.storage.latest.FileShare("fileShare",
    account_name="sto328",
    resource_group_name="res3376",
    share_name="share6185")
import * as pulumi from "@pulumi/pulumi";
import * as azure_nextgen from "@pulumi/azure-nextgen";

const fileShare = new azure_nextgen.storage.latest.FileShare("fileShare", {
    accountName: "sto328",
    resourceGroupName: "res3376",
    shareName: "share6185",
});

PutShares with Access Tier

using Pulumi;
using AzureNextGen = Pulumi.AzureNextGen;

class MyStack : Stack
{
    public MyStack()
    {
        var fileShare = new AzureNextGen.Storage.Latest.FileShare("fileShare", new AzureNextGen.Storage.Latest.FileShareArgs
        {
            AccessTier = "Hot",
            AccountName = "sto666",
            ResourceGroupName = "res346",
            ShareName = "share1235",
        });
    }

}
package main

import (
    storage "github.com/pulumi/pulumi-azure-nextgen/sdk/go/azure/storage/latest"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := storage.NewFileShare(ctx, "fileShare", &storage.FileShareArgs{
            AccessTier:        pulumi.String("Hot"),
            AccountName:       pulumi.String("sto666"),
            ResourceGroupName: pulumi.String("res346"),
            ShareName:         pulumi.String("share1235"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}
import pulumi
import pulumi_azure_nextgen as azure_nextgen

file_share = azure_nextgen.storage.latest.FileShare("fileShare",
    access_tier="Hot",
    account_name="sto666",
    resource_group_name="res346",
    share_name="share1235")
import * as pulumi from "@pulumi/pulumi";
import * as azure_nextgen from "@pulumi/azure-nextgen";

const fileShare = new azure_nextgen.storage.latest.FileShare("fileShare", {
    accessTier: "Hot",
    accountName: "sto666",
    resourceGroupName: "res346",
    shareName: "share1235",
});

Create a FileShare Resource

new FileShare(name: string, args: FileShareArgs, opts?: CustomResourceOptions);
def FileShare(resource_name: str, opts: Optional[ResourceOptions] = None, access_tier: Optional[Union[str, ShareAccessTier]] = None, account_name: Optional[str] = None, enabled_protocols: Optional[Union[str, EnabledProtocols]] = None, metadata: Optional[Mapping[str, str]] = None, resource_group_name: Optional[str] = None, root_squash: Optional[Union[str, RootSquashType]] = None, share_name: Optional[str] = None, share_quota: Optional[int] = None)
func NewFileShare(ctx *Context, name string, args FileShareArgs, opts ...ResourceOption) (*FileShare, error)
public FileShare(string name, FileShareArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args FileShareArgs
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 FileShareArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FileShareArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

FileShare Resource Properties

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

Inputs

The FileShare resource accepts the following input properties:

AccountName string
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
ResourceGroupName string
The name of the resource group within the user’s subscription. The name is case insensitive.
ShareName string
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
AccessTier string | Pulumi.AzureNextGen.Storage.ShareAccessTier
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
EnabledProtocols string | Pulumi.AzureNextGen.Storage.EnabledProtocols
The authentication protocol that is used for the file share. Can only be specified when creating a share.
Metadata Dictionary<string, string>
A name-value pair to associate with the share as metadata.
RootSquash string | Pulumi.AzureNextGen.Storage.RootSquashType
The property is for NFS share only. The default is NoRootSquash.
ShareQuota int
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
AccountName string
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
ResourceGroupName string
The name of the resource group within the user’s subscription. The name is case insensitive.
ShareName string
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
AccessTier string | ShareAccessTier
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
EnabledProtocols string | EnabledProtocols
The authentication protocol that is used for the file share. Can only be specified when creating a share.
Metadata map[string]string
A name-value pair to associate with the share as metadata.
RootSquash string | RootSquashType
The property is for NFS share only. The default is NoRootSquash.
ShareQuota int
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
accountName string
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
resourceGroupName string
The name of the resource group within the user’s subscription. The name is case insensitive.
shareName string
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
accessTier string | ShareAccessTier
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
enabledProtocols string | EnabledProtocols
The authentication protocol that is used for the file share. Can only be specified when creating a share.
metadata {[key: string]: string}
A name-value pair to associate with the share as metadata.
rootSquash string | RootSquashType
The property is for NFS share only. The default is NoRootSquash.
shareQuota number
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.
account_name str
The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
resource_group_name str
The name of the resource group within the user’s subscription. The name is case insensitive.
share_name str
The name of the file share within the specified storage account. File share names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number.
access_tier str | ShareAccessTier
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
enabled_protocols str | EnabledProtocols
The authentication protocol that is used for the file share. Can only be specified when creating a share.
metadata Mapping[str, str]
A name-value pair to associate with the share as metadata.
root_squash str | RootSquashType
The property is for NFS share only. The default is NoRootSquash.
share_quota int
The maximum size of the share, in gigabytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400.

Outputs

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

AccessTierChangeTime string
Indicates the last modification time for share access tier.
AccessTierStatus string
Indicates if there is a pending transition for access tier.
Deleted bool
Indicates whether the share was deleted.
DeletedTime string
The deleted time if the share was deleted.
Etag string
Resource Etag.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedTime string
Returns the date and time the share was last modified.
Name string
The name of the resource
RemainingRetentionDays int
Remaining retention days for share that was soft deleted.
ShareUsageBytes double
The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
Version string
The version of the share.
AccessTierChangeTime string
Indicates the last modification time for share access tier.
AccessTierStatus string
Indicates if there is a pending transition for access tier.
Deleted bool
Indicates whether the share was deleted.
DeletedTime string
The deleted time if the share was deleted.
Etag string
Resource Etag.
Id string
The provider-assigned unique ID for this managed resource.
LastModifiedTime string
Returns the date and time the share was last modified.
Name string
The name of the resource
RemainingRetentionDays int
Remaining retention days for share that was soft deleted.
ShareUsageBytes float64
The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
Type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
Version string
The version of the share.
accessTierChangeTime string
Indicates the last modification time for share access tier.
accessTierStatus string
Indicates if there is a pending transition for access tier.
deleted boolean
Indicates whether the share was deleted.
deletedTime string
The deleted time if the share was deleted.
etag string
Resource Etag.
id string
The provider-assigned unique ID for this managed resource.
lastModifiedTime string
Returns the date and time the share was last modified.
name string
The name of the resource
remainingRetentionDays number
Remaining retention days for share that was soft deleted.
shareUsageBytes number
The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
type string
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
version string
The version of the share.
access_tier_change_time str
Indicates the last modification time for share access tier.
access_tier_status str
Indicates if there is a pending transition for access tier.
deleted bool
Indicates whether the share was deleted.
deleted_time str
The deleted time if the share was deleted.
etag str
Resource Etag.
id str
The provider-assigned unique ID for this managed resource.
last_modified_time str
Returns the date and time the share was last modified.
name str
The name of the resource
remaining_retention_days int
Remaining retention days for share that was soft deleted.
share_usage_bytes float
The approximate size of the data stored on the share. Note that this value may not include all recently created or recently resized files.
type str
The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”
version str
The version of the share.

Supporting Types

EnabledProtocols

SMB
SMB
NFS
NFS
EnabledProtocolsSMB
SMB
EnabledProtocolsNFS
NFS
SMB
SMB
NFS
NFS
SMB
SMB
NFS
NFS

RootSquashType

NoRootSquash
NoRootSquash
RootSquash
RootSquash
AllSquash
AllSquash
RootSquashTypeNoRootSquash
NoRootSquash
RootSquashTypeRootSquash
RootSquash
RootSquashTypeAllSquash
AllSquash
NoRootSquash
NoRootSquash
RootSquash
RootSquash
AllSquash
AllSquash
NO_ROOT_SQUASH
NoRootSquash
ROOT_SQUASH
RootSquash
ALL_SQUASH
AllSquash

ShareAccessTier

TransactionOptimized
TransactionOptimized
Hot
Hot
Cool
Cool
Premium
Premium
ShareAccessTierTransactionOptimized
TransactionOptimized
ShareAccessTierHot
Hot
ShareAccessTierCool
Cool
ShareAccessTierPremium
Premium
TransactionOptimized
TransactionOptimized
Hot
Hot
Cool
Cool
Premium
Premium
TRANSACTION_OPTIMIZED
TransactionOptimized
HOT
Hot
COOL
Cool
PREMIUM
Premium

Import

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

$ pulumi import azure-nextgen:storage/latest:FileShare share1235 /subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-nextgen
License
Apache-2.0