Azure Native v1.97.0, Mar 13 23

azure-native.storage.FileShare

Properties of the file share, including Id, resource name, resource type, Etag. API Version: 2021-02-01.

Example Usage

Create NFS Shares

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var fileShare = new AzureNative.Storage.FileShare("fileShare", new()
    {
        AccountName = "sto666",
        EnabledProtocols = "NFS",
        ResourceGroupName = "res346",
        ShareName = "share1235",
    });

});

package main

import (
	storage "github.com/pulumi/pulumi-azure-native/sdk/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storage.FileShare;
import com.pulumi.azurenative.storage.FileShareArgs;
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 fileShare = new FileShare("fileShare", FileShareArgs.builder()        
            .accountName("sto666")
            .enabledProtocols("NFS")
            .resourceGroupName("res346")
            .shareName("share1235")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

file_share = azure_native.storage.FileShare("fileShare",
    account_name="sto666",
    enabled_protocols="NFS",
    resource_group_name="res346",
    share_name="share1235")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

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

resources:
  fileShare:
    type: azure-native:storage:FileShare
    properties:
      accountName: sto666
      enabledProtocols: NFS
      resourceGroupName: res346
      shareName: share1235

PutShares

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var fileShare = new AzureNative.Storage.FileShare("fileShare", new()
    {
        AccountName = "sto328",
        ResourceGroupName = "res3376",
        ShareName = "share6185",
    });

});

package main

import (
	storage "github.com/pulumi/pulumi-azure-native/sdk/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storage.FileShare;
import com.pulumi.azurenative.storage.FileShareArgs;
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 fileShare = new FileShare("fileShare", FileShareArgs.builder()        
            .accountName("sto328")
            .resourceGroupName("res3376")
            .shareName("share6185")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

file_share = azure_native.storage.FileShare("fileShare",
    account_name="sto328",
    resource_group_name="res3376",
    share_name="share6185")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

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

resources:
  fileShare:
    type: azure-native:storage:FileShare
    properties:
      accountName: sto328
      resourceGroupName: res3376
      shareName: share6185

PutShares with Access Tier

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var fileShare = new AzureNative.Storage.FileShare("fileShare", new()
    {
        AccessTier = "Hot",
        AccountName = "sto666",
        ResourceGroupName = "res346",
        ShareName = "share1235",
    });

});

package main

import (
	storage "github.com/pulumi/pulumi-azure-native/sdk/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/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
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.storage.FileShare;
import com.pulumi.azurenative.storage.FileShareArgs;
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 fileShare = new FileShare("fileShare", FileShareArgs.builder()        
            .accessTier("Hot")
            .accountName("sto666")
            .resourceGroupName("res346")
            .shareName("share1235")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

file_share = azure_native.storage.FileShare("fileShare",
    access_tier="Hot",
    account_name="sto666",
    resource_group_name="res346",
    share_name="share1235")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

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

resources:
  fileShare:
    type: azure-native:storage:FileShare
    properties:
      accessTier: Hot
      accountName: sto666
      resourceGroupName: res346
      shareName: share1235

Create FileShare Resource

new FileShare(name: string, args: FileShareArgs, opts?: CustomResourceOptions);

@overload
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,
              expand: Optional[str] = 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)
@overload
def FileShare(resource_name: str,
              args: FileShareArgs,
              opts: Optional[ResourceOptions] = None)

func NewFileShare(ctx *Context, name string, args FileShareArgs, opts ...ResourceOption) (*FileShare, error)

public FileShare(string name, FileShareArgs args, CustomResourceOptions? opts = null)

public FileShare(String name, FileShareArgs args)
public FileShare(String name, FileShareArgs args, CustomResourceOptions options)

type: azure-native:storage:FileShare
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args FileShareArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control 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.

name String: The unique name of the resource.
args FileShareArgs: The arguments to resource properties.
options 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 Architecture and Concepts 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.
AccessTier string | Pulumi.AzureNative.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.AzureNative.Storage.EnabledProtocols: The authentication protocol that is used for the file share. Can only be specified when creating a share.
Expand string: Optional, used to create a snapshot.
Metadata Dictionary<string, string>: A name-value pair to associate with the share as metadata.
RootSquash string | Pulumi.AzureNative.Storage.RootSquashType: The property is for NFS share only. The default is NoRootSquash.
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.
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.
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.
Expand string: Optional, used to create a snapshot.
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.
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.
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.
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.
expand String: Optional, used to create a snapshot.
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.
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.
shareQuota Integer: 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.
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.
expand string: Optional, used to create a snapshot.
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.
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.
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.
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.
expand str: Optional, used to create a snapshot.
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_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.
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.

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.
accessTier String | "TransactionOptimized" | "Hot" | "Cool" | "Premium": Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
enabledProtocols String | "SMB" | "NFS": The authentication protocol that is used for the file share. Can only be specified when creating a share.
expand String: Optional, used to create a snapshot.
metadata Map<String>: A name-value pair to associate with the share as metadata.
rootSquash String | "NoRootSquash" | "RootSquash" | "AllSquash": The property is for NFS share only. The default is NoRootSquash.
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.
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.

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.
SnapshotTime string: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
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.
SnapshotTime string: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
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 Integer: 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.
snapshotTime String: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
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.
snapshotTime string: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
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.
snapshot_time str: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
version str: 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.
snapshotTime String: Creation time of share snapshot returned in the response of list shares with expand param "snapshots".
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
version String: The version of the share.

Supporting Types

EnabledProtocols

SMB: SMB
NFS: NFS

EnabledProtocolsSMB: SMB
EnabledProtocolsNFS: NFS

SMB: SMB
NFS: NFS

SMB: SMB
NFS: 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

NoRootSquash: NoRootSquash
RootSquash: RootSquash
AllSquash: AllSquash

NO_ROOT_SQUASH: NoRootSquash
ROOT_SQUASH: RootSquash
ALL_SQUASH: AllSquash

"NoRootSquash": NoRootSquash
"RootSquash": RootSquash
"AllSquash": 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

TransactionOptimized: TransactionOptimized
Hot: Hot
Cool: Cool
Premium: Premium

TRANSACTION_OPTIMIZED: TransactionOptimized
HOT: Hot
COOL: Cool
PREMIUM: Premium

"TransactionOptimized": 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-native:storage:FileShare share1235 /subscriptions/{subscription-id}/resourceGroups/res346/providers/Microsoft.Storage/storageAccounts/sto666/fileServices/default/shares/share1235

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0