pulumi-azure-native-kotlin/com.pulumi.azurenative.storage.kotlin/FileShare

FileShare

class FileShare : KotlinCustomResource

Properties of the file share, including Id, resource name, resource type, Etag. Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01. Other available API versions: 2022-09-01, 2023-01-01, 2023-04-01, 2023-05-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storage [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create NFS Shares

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

package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"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(storage.EnabledProtocolsNFS),
			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());
    }
}

PutShares

using System.Collections.Generic;
using System.Linq;
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/storage/v2"
	"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());
    }
}

PutShares with Access Tier

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

package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"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(storage.ShareAccessTierHot),
			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());
    }
}

PutShares with Paid Bursting

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var fileShare = new AzureNative.Storage.FileShare("fileShare", new()
    {
        AccountName = "sto666",
        FileSharePaidBursting = new AzureNative.Storage.Inputs.FileSharePropertiesFileSharePaidBurstingArgs
        {
            PaidBurstingEnabled = true,
            PaidBurstingMaxBandwidthMibps = 10340,
            PaidBurstingMaxIops = 102400,
        },
        ResourceGroupName = "res346",
        ShareName = "share1235",
    });
});

package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"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"),
			FileSharePaidBursting: &storage.FileSharePropertiesFileSharePaidBurstingArgs{
				PaidBurstingEnabled:           pulumi.Bool(true),
				PaidBurstingMaxBandwidthMibps: pulumi.Int(10340),
				PaidBurstingMaxIops:           pulumi.Int(102400),
			},
			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 com.pulumi.azurenative.storage.inputs.FileSharePropertiesFileSharePaidBurstingArgs;
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")
            .fileSharePaidBursting(FileSharePropertiesFileSharePaidBurstingArgs.builder()
                .paidBurstingEnabled(true)
                .paidBurstingMaxBandwidthMibps(10340)
                .paidBurstingMaxIops(102400)
                .build())
            .resourceGroupName("res346")
            .shareName("share1235")
            .build());
    }
}

PutSharesProvisionedV2

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var fileShare = new AzureNative.Storage.FileShare("fileShare", new()
    {
        AccountName = "sto666",
        ProvisionedBandwidthMibps = 200,
        ProvisionedIops = 5000,
        ResourceGroupName = "res346",
        ShareName = "share1235",
        ShareQuota = 100,
    });
});

package main
import (
	storage "github.com/pulumi/pulumi-azure-native-sdk/storage/v2"
	"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"),
			ProvisionedBandwidthMibps: pulumi.Int(200),
			ProvisionedIops:           pulumi.Int(5000),
			ResourceGroupName:         pulumi.String("res346"),
			ShareName:                 pulumi.String("share1235"),
			ShareQuota:                pulumi.Int(100),
		})
		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")
            .provisionedBandwidthMibps(200)
            .provisionedIops(5000)
            .resourceGroupName("res346")
            .shareName("share1235")
            .shareQuota(100)
            .build());
    }
}

Import

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

$ pulumi import azure-native:storage:FileShare share1235 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/fileServices/default/shares/{shareName}

Properties

accessTier

val accessTier: Output<String>?

Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.

accessTierChangeTime

val accessTierChangeTime: Output<String>

Indicates the last modification time for share access tier.

accessTierStatus

val accessTierStatus: Output<String>

Indicates if there is a pending transition for access tier.

azureApiVersion

val azureApiVersion: Output<String>

The Azure API version of the resource.

deleted

val deleted: Output<Boolean>

Indicates whether the share was deleted.

deletedTime

val deletedTime: Output<String>

The deleted time if the share was deleted.

enabledProtocols

val enabledProtocols: Output<String>?

The authentication protocol that is used for the file share. Can only be specified when creating a share.

etag

val etag: Output<String>

Resource Etag.

fileSharePaidBursting

val fileSharePaidBursting: Output<FileSharePropertiesResponseFileSharePaidBursting>?

File Share Paid Bursting properties.

val id: Output<String>

includedBurstIops

val includedBurstIops: Output<Int>

The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.

lastModifiedTime

val lastModifiedTime: Output<String>

Returns the date and time the share was last modified.

leaseDuration

val leaseDuration: Output<String>

Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.

leaseState

val leaseState: Output<String>

Lease state of the share.

leaseStatus

val leaseStatus: Output<String>

The lease status of the share.

maxBurstCreditsForIops

val maxBurstCreditsForIops: Output<Double>

The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.

metadata

val metadata: Output<Map<String, String>>?

A name-value pair to associate with the share as metadata.

name

val name: Output<String>

The name of the resource

nextAllowedProvisionedBandwidthDowngradeTime

val nextAllowedProvisionedBandwidthDowngradeTime: Output<String>

Returns the next allowed provisioned bandwidth downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.

nextAllowedProvisionedIopsDowngradeTime

val nextAllowedProvisionedIopsDowngradeTime: Output<String>

Returns the next allowed provisioned IOPS downgrade time for the share. This property is only for file shares created under Files Provisioned v2 account type.

nextAllowedQuotaDowngradeTime

val nextAllowedQuotaDowngradeTime: Output<String>

Returns the next allowed provisioned storage size downgrade time for the share. This property is only for file shares created under Files Provisioned v1 SSD and Files Provisioned v2 account type

provisionedBandwidthMibps

val provisionedBandwidthMibps: Output<Int>?

The provisioned bandwidth of the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned bandwidth.

provisionedIops

val provisionedIops: Output<Int>?

The provisioned IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type. Please refer to the GetFileServiceUsage API response for the minimum and maximum allowed value for provisioned IOPS.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

remainingRetentionDays

val remainingRetentionDays: Output<Int>

Remaining retention days for share that was soft deleted.

rootSquash

val rootSquash: Output<String>?

The property is for NFS share only. The default is NoRootSquash.

shareQuota

val shareQuota: Output<Int>?

The provisioned size of the share, in gibibytes. Must be greater than 0, and less than or equal to 5TB (5120). For Large File Shares, the maximum size is 102400. For file shares created under Files Provisioned v2 account type, please refer to the GetFileServiceUsage API response for the minimum and maximum allowed provisioned storage size.

shareUsageBytes

val shareUsageBytes: Output<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.

signedIdentifiers

val signedIdentifiers: Output<List<SignedIdentifierResponse>>?

List of stored access policies specified on the share.

snapshotTime

val snapshotTime: Output<String>

Creation time of share snapshot returned in the response of list shares with expand param "snapshots".

type

val type: Output<String>

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

urn

val urn: Output<String>

version

val version: Output<String>

The version of the share.