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, 2025-01-01, 2025-06-01, 2025-08-01, 2026-04-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 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/v3"
"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
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_storage_file_share" "fileShare" {
lifecycle {
create_before_destroy = true
}
account_name = "sto666"
enabled_protocols = "NFS"
resource_group_name = "res346"
share_name = "share1235"
}
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.ArrayList;
import java.util.Arrays;
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 * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const fileShare = new azure_native.storage.FileShare("fileShare", {
accountName: "sto666",
enabledProtocols: azure_native.storage.EnabledProtocols.NFS,
resourceGroupName: "res346",
shareName: "share1235",
});
import pulumi
import pulumi_azure_native as azure_native
file_share = azure_native.storage.FileShare("fileShare",
account_name="sto666",
enabled_protocols=azure_native.storage.EnabledProtocols.NFS,
resource_group_name="res346",
share_name="share1235")
resources:
fileShare:
type: azure-native:storage:FileShare
properties:
accountName: sto666
enabledProtocols: NFS
resourceGroupName: res346
shareName: share1235
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/v3"
"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
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_storage_file_share" "fileShare" {
lifecycle {
create_before_destroy = true
}
account_name = "sto328"
resource_group_name = "res3376"
share_name = "share6185"
}
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.ArrayList;
import java.util.Arrays;
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 * 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",
});
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")
resources:
fileShare:
type: azure-native:storage:FileShare
properties:
accountName: sto328
resourceGroupName: res3376
shareName: share6185
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/v3"
"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
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_storage_file_share" "fileShare" {
lifecycle {
create_before_destroy = true
}
access_tier = "Hot"
account_name = "sto666"
resource_group_name = "res346"
share_name = "share1235"
}
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.ArrayList;
import java.util.Arrays;
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 * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const fileShare = new azure_native.storage.FileShare("fileShare", {
accessTier: azure_native.storage.ShareAccessTier.Hot,
accountName: "sto666",
resourceGroupName: "res346",
shareName: "share1235",
});
import pulumi
import pulumi_azure_native as azure_native
file_share = azure_native.storage.FileShare("fileShare",
access_tier=azure_native.storage.ShareAccessTier.HOT,
account_name="sto666",
resource_group_name="res346",
share_name="share1235")
resources:
fileShare:
type: azure-native:storage:FileShare
properties:
accessTier: Hot
accountName: sto666
resourceGroupName: res346
shareName: share1235
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/v3"
"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
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_storage_file_share" "fileShare" {
lifecycle {
create_before_destroy = true
}
account_name = "sto666"
file_share_paid_bursting = {
paid_bursting_enabled = true
paid_bursting_max_bandwidth_mibps = 10340
paid_bursting_max_iops = 102400
}
resource_group_name = "res346"
share_name = "share1235"
}
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.ArrayList;
import java.util.Arrays;
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());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const fileShare = new azure_native.storage.FileShare("fileShare", {
accountName: "sto666",
fileSharePaidBursting: {
paidBurstingEnabled: true,
paidBurstingMaxBandwidthMibps: 10340,
paidBurstingMaxIops: 102400,
},
resourceGroupName: "res346",
shareName: "share1235",
});
import pulumi
import pulumi_azure_native as azure_native
file_share = azure_native.storage.FileShare("fileShare",
account_name="sto666",
file_share_paid_bursting={
"paid_bursting_enabled": True,
"paid_bursting_max_bandwidth_mibps": 10340,
"paid_bursting_max_iops": 102400,
},
resource_group_name="res346",
share_name="share1235")
resources:
fileShare:
type: azure-native:storage:FileShare
properties:
accountName: sto666
fileSharePaidBursting:
paidBurstingEnabled: true
paidBurstingMaxBandwidthMibps: 10340
paidBurstingMaxIops: 102400
resourceGroupName: res346
shareName: share1235
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/v3"
"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
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_storage_file_share" "fileShare" {
lifecycle {
create_before_destroy = true
}
account_name = "sto666"
provisioned_bandwidth_mibps = 200
provisioned_iops = 5000
resource_group_name = "res346"
share_name = "share1235"
share_quota = 100
}
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.ArrayList;
import java.util.Arrays;
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 * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const fileShare = new azure_native.storage.FileShare("fileShare", {
accountName: "sto666",
provisionedBandwidthMibps: 200,
provisionedIops: 5000,
resourceGroupName: "res346",
shareName: "share1235",
shareQuota: 100,
});
import pulumi
import pulumi_azure_native as azure_native
file_share = azure_native.storage.FileShare("fileShare",
account_name="sto666",
provisioned_bandwidth_mibps=200,
provisioned_iops=5000,
resource_group_name="res346",
share_name="share1235",
share_quota=100)
resources:
fileShare:
type: azure-native:storage:FileShare
properties:
accountName: sto666
provisionedBandwidthMibps: 200
provisionedIops: 5000
resourceGroupName: res346
shareName: share1235
shareQuota: 100
Create FileShare Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def FileShare(resource_name: str,
args: FileShareArgs,
opts: Optional[ResourceOptions] = None)
@overload
def FileShare(resource_name: str,
opts: Optional[ResourceOptions] = None,
resource_group_name: Optional[str] = None,
account_name: Optional[str] = None,
provisioned_bandwidth_mibps: Optional[int] = None,
expand: Optional[str] = None,
file_share_paid_bursting: Optional[FileSharePropertiesFileSharePaidBurstingArgs] = None,
metadata: Optional[Mapping[str, str]] = None,
access_tier: Optional[Union[str, ShareAccessTier]] = None,
provisioned_iops: Optional[int] = None,
enabled_protocols: Optional[Union[str, EnabledProtocols]] = None,
root_squash: Optional[Union[str, RootSquashType]] = None,
share_name: Optional[str] = None,
share_quota: Optional[int] = None,
signed_identifiers: Optional[Sequence[SignedIdentifierArgs]] = None)
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.
resource "azure-native_storage_file_share" "name" {
# resource properties
}
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeFileShareResource = new AzureNative.Storage.FileShare("azure-nativeFileShareResource", new()
{
ResourceGroupName = "string",
AccountName = "string",
ProvisionedBandwidthMibps = 0,
Expand = "string",
FileSharePaidBursting = new AzureNative.Storage.Inputs.FileSharePropertiesFileSharePaidBurstingArgs
{
PaidBurstingEnabled = false,
PaidBurstingMaxBandwidthMibps = 0,
PaidBurstingMaxIops = 0,
},
Metadata =
{
{ "string", "string" },
},
AccessTier = "string",
ProvisionedIops = 0,
EnabledProtocols = "string",
RootSquash = "string",
ShareName = "string",
ShareQuota = 0,
SignedIdentifiers = new[]
{
new AzureNative.Storage.Inputs.SignedIdentifierArgs
{
AccessPolicy = new AzureNative.Storage.Inputs.AccessPolicyArgs
{
ExpiryTime = "string",
Permission = "string",
StartTime = "string",
},
Id = "string",
},
},
});
example, err := storage.NewFileShare(ctx, "azure-nativeFileShareResource", &storage.FileShareArgs{
ResourceGroupName: pulumi.String("string"),
AccountName: pulumi.String("string"),
ProvisionedBandwidthMibps: pulumi.Int(0),
Expand: pulumi.String("string"),
FileSharePaidBursting: &storage.FileSharePropertiesFileSharePaidBurstingArgs{
PaidBurstingEnabled: pulumi.Bool(false),
PaidBurstingMaxBandwidthMibps: pulumi.Int(0),
PaidBurstingMaxIops: pulumi.Int(0),
},
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
AccessTier: pulumi.String("string"),
ProvisionedIops: pulumi.Int(0),
EnabledProtocols: pulumi.String("string"),
RootSquash: pulumi.String("string"),
ShareName: pulumi.String("string"),
ShareQuota: pulumi.Int(0),
SignedIdentifiers: storage.SignedIdentifierArray{
&storage.SignedIdentifierArgs{
AccessPolicy: &storage.AccessPolicyArgs{
ExpiryTime: pulumi.String("string"),
Permission: pulumi.String("string"),
StartTime: pulumi.String("string"),
},
Id: pulumi.String("string"),
},
},
})
resource "azure-native_storage_file_share" "azure-nativeFileShareResource" {
lifecycle {
create_before_destroy = true
}
resource_group_name = "string"
account_name = "string"
provisioned_bandwidth_mibps = 0
expand = "string"
file_share_paid_bursting = {
paid_bursting_enabled = false
paid_bursting_max_bandwidth_mibps = 0
paid_bursting_max_iops = 0
}
metadata = {
"string" = "string"
}
access_tier = "string"
provisioned_iops = 0
enabled_protocols = "string"
root_squash = "string"
share_name = "string"
share_quota = 0
signed_identifiers {
access_policy = {
expiry_time = "string"
permission = "string"
start_time = "string"
}
id = "string"
}
}
var azure_nativeFileShareResource = new com.pulumi.azurenative.storage.FileShare("azure-nativeFileShareResource", com.pulumi.azurenative.storage.FileShareArgs.builder()
.resourceGroupName("string")
.accountName("string")
.provisionedBandwidthMibps(0)
.expand("string")
.fileSharePaidBursting(FileSharePropertiesFileSharePaidBurstingArgs.builder()
.paidBurstingEnabled(false)
.paidBurstingMaxBandwidthMibps(0)
.paidBurstingMaxIops(0)
.build())
.metadata(Map.of("string", "string"))
.accessTier("string")
.provisionedIops(0)
.enabledProtocols("string")
.rootSquash("string")
.shareName("string")
.shareQuota(0)
.signedIdentifiers(SignedIdentifierArgs.builder()
.accessPolicy(com.pulumi.azurenative.storage.inputs.AccessPolicyArgs.builder()
.expiryTime("string")
.permission("string")
.startTime("string")
.build())
.id("string")
.build())
.build());
azure_native_file_share_resource = azure_native.storage.FileShare("azure-nativeFileShareResource",
resource_group_name="string",
account_name="string",
provisioned_bandwidth_mibps=0,
expand="string",
file_share_paid_bursting={
"paid_bursting_enabled": False,
"paid_bursting_max_bandwidth_mibps": 0,
"paid_bursting_max_iops": 0,
},
metadata={
"string": "string",
},
access_tier="string",
provisioned_iops=0,
enabled_protocols="string",
root_squash="string",
share_name="string",
share_quota=0,
signed_identifiers=[{
"access_policy": {
"expiry_time": "string",
"permission": "string",
"start_time": "string",
},
"id": "string",
}])
const azure_nativeFileShareResource = new azure_native.storage.FileShare("azure-nativeFileShareResource", {
resourceGroupName: "string",
accountName: "string",
provisionedBandwidthMibps: 0,
expand: "string",
fileSharePaidBursting: {
paidBurstingEnabled: false,
paidBurstingMaxBandwidthMibps: 0,
paidBurstingMaxIops: 0,
},
metadata: {
string: "string",
},
accessTier: "string",
provisionedIops: 0,
enabledProtocols: "string",
rootSquash: "string",
shareName: "string",
shareQuota: 0,
signedIdentifiers: [{
accessPolicy: {
expiryTime: "string",
permission: "string",
startTime: "string",
},
id: "string",
}],
});
type: azure-native:storage:FileShare
properties:
accessTier: string
accountName: string
enabledProtocols: string
expand: string
fileSharePaidBursting:
paidBurstingEnabled: false
paidBurstingMaxBandwidthMibps: 0
paidBurstingMaxIops: 0
metadata:
string: string
provisionedBandwidthMibps: 0
provisionedIops: 0
resourceGroupName: string
rootSquash: string
shareName: string
shareQuota: 0
signedIdentifiers:
- accessPolicy:
expiryTime: string
permission: string
startTime: string
id: string
FileShare Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
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 expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
- FileSharePaidBursting
Pulumi.AzureNative.Storage.Inputs.FileSharePropertiesFileSharePaidBursting
- File Share Paid Bursting properties.
- Metadata
Dictionary<string, string>
- A name-value pair to associate with the share as metadata.
- ProvisionedBandwidthMibps
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
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.
- 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 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.
- SignedIdentifiers
List<Pulumi.AzureNative.Storage.Inputs.SignedIdentifier>
- List of stored access policies specified on the share.
- 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 expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
- FileSharePaidBursting
FileSharePropertiesFileSharePaidBurstingArgs
- File Share Paid Bursting properties.
- Metadata
map[string]string
- A name-value pair to associate with the share as metadata.
- ProvisionedBandwidthMibps
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
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.
- 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 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.
- SignedIdentifiers
[]SignedIdentifierArgs
- List of stored access policies specified on the share.
- account_name
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.
- resource_group_name
string
- The name of the resource group within the user's subscription. The name is case insensitive.
- access_tier
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.
- enabled_protocols
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 expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
- file_share_paid_bursting
object
- File Share Paid Bursting properties.
- metadata
map(string)
- A name-value pair to associate with the share as metadata.
- provisioned_bandwidth_mibps
number
- 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.
- provisioned_iops
number
- 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.
- root_squash
string | "NoRootSquash" | "RootSquash" | "AllSquash"
- The property is for NFS share only. The default is NoRootSquash.
- share_name
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.
- share_quota
number
- 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.
- signed_identifiers
list(object)
- List of stored access policies specified on the share.
- 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 expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
- fileSharePaidBursting
FileSharePropertiesFileSharePaidBursting
- File Share Paid Bursting properties.
- metadata
Map<String,String>
- A name-value pair to associate with the share as metadata.
- provisionedBandwidthMibps
Integer
- 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
Integer
- 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.
- 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 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.
- signedIdentifiers
List<SignedIdentifier>
- List of stored access policies specified on the share.
- 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 expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
- fileSharePaidBursting
FileSharePropertiesFileSharePaidBursting
- File Share Paid Bursting properties.
- metadata
{[key: string]: string}
- A name-value pair to associate with the share as metadata.
- provisionedBandwidthMibps
number
- 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
number
- 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.
- 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 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.
- signedIdentifiers
SignedIdentifier[]
- List of stored access policies specified on the share.
- 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 expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
- file_share_paid_bursting
FileSharePropertiesFileSharePaidBurstingArgs
- File Share Paid Bursting properties.
- metadata
Mapping[str, str]
- A name-value pair to associate with the share as metadata.
- provisioned_bandwidth_mibps
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.
- provisioned_iops
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.
- 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 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.
- signed_identifiers
Sequence[SignedIdentifierArgs]
- List of stored access policies specified on the share.
- 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 expand the properties within share's properties. Valid values are: snapshots. Should be passed as a string with delimiter ','
- fileSharePaidBursting
Property Map
- File Share Paid Bursting properties.
- metadata
Map<String>
- A name-value pair to associate with the share as metadata.
- provisionedBandwidthMibps
Number
- 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
Number
- 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.
- 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 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.
- signedIdentifiers
List<Property Map>
- List of stored access policies specified on the share.
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.
- AzureApiVersion
string
- The Azure API version of the resource.
- 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.
- IncludedBurstIops
int
- The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
- LastModifiedTime
string
- Returns the date and time the share was last modified.
- LeaseDuration
string
- Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
- LeaseState
string
- Lease state of the share.
- LeaseStatus
string
- The lease status of the share.
- MaxBurstCreditsForIops
double
- The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
- Name
string
- The name of the resource
- NextAllowedProvisionedBandwidthDowngradeTime
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
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
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
- 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.
- AzureApiVersion
string
- The Azure API version of the resource.
- 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.
- IncludedBurstIops
int
- The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
- LastModifiedTime
string
- Returns the date and time the share was last modified.
- LeaseDuration
string
- Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
- LeaseState
string
- Lease state of the share.
- LeaseStatus
string
- The lease status of the share.
- MaxBurstCreditsForIops
float64
- The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
- Name
string
- The name of the resource
- NextAllowedProvisionedBandwidthDowngradeTime
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
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
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
- 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.
- access_tier_change_time
string
- Indicates the last modification time for share access tier.
- access_tier_status
string
- Indicates if there is a pending transition for access tier.
- azure_api_version
string
- The Azure API version of the resource.
- deleted
bool
- Indicates whether the share was deleted.
- deleted_time
string
- The deleted time if the share was deleted.
- etag
string
- Resource Etag.
- id
string
- The provider-assigned unique ID for this managed resource.
- included_burst_iops
number
- The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
- last_modified_time
string
- Returns the date and time the share was last modified.
- lease_duration
string
- Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
- lease_state
string
- Lease state of the share.
- lease_status
string
- The lease status of the share.
- max_burst_credits_for_iops
number
- The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
- name
string
- The name of the resource
- next_allowed_provisioned_bandwidth_downgrade_time
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.
- next_allowed_provisioned_iops_downgrade_time
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.
- next_allowed_quota_downgrade_time
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
- remaining_retention_days
number
- Remaining retention days for share that was soft deleted.
- share_usage_bytes
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.
- snapshot_time
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.
- azureApiVersion
String
- The Azure API version of the resource.
- 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.
- includedBurstIops
Integer
- The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
- lastModifiedTime
String
- Returns the date and time the share was last modified.
- leaseDuration
String
- Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
- leaseState
String
- Lease state of the share.
- leaseStatus
String
- The lease status of the share.
- maxBurstCreditsForIops
Double
- The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
- name
String
- The name of the resource
- nextAllowedProvisionedBandwidthDowngradeTime
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
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
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
- 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.
- azureApiVersion
string
- The Azure API version of the resource.
- 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.
- includedBurstIops
number
- The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
- lastModifiedTime
string
- Returns the date and time the share was last modified.
- leaseDuration
string
- Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
- leaseState
string
- Lease state of the share.
- leaseStatus
string
- The lease status of the share.
- maxBurstCreditsForIops
number
- The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
- name
string
- The name of the resource
- nextAllowedProvisionedBandwidthDowngradeTime
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
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
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
- 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.
- azure_api_version
str
- The Azure API version of the resource.
- 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.
- included_burst_iops
int
- The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
- last_modified_time
str
- Returns the date and time the share was last modified.
- lease_duration
str
- Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
- lease_state
str
- Lease state of the share.
- lease_status
str
- The lease status of the share.
- max_burst_credits_for_iops
float
- The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
- name
str
- The name of the resource
- next_allowed_provisioned_bandwidth_downgrade_time
str
- 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.
- next_allowed_provisioned_iops_downgrade_time
str
- 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.
- next_allowed_quota_downgrade_time
str
- 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
- 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.
- azureApiVersion
String
- The Azure API version of the resource.
- 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.
- includedBurstIops
Number
- The calculated burst IOPS of the share. This property is only for file shares created under Files Provisioned v2 account type.
- lastModifiedTime
String
- Returns the date and time the share was last modified.
- leaseDuration
String
- Specifies whether the lease on a share is of infinite or fixed duration, only when the share is leased.
- leaseState
String
- Lease state of the share.
- leaseStatus
String
- The lease status of the share.
- maxBurstCreditsForIops
Number
- The calculated maximum burst credits for the share. This property is only for file shares created under Files Provisioned v2 account type.
- name
String
- The name of the resource
- nextAllowedProvisionedBandwidthDowngradeTime
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
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
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
- 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.
Look up Existing FileShare Resource
Get an existing FileShare resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static FileShare get(String name, Output<String> id, CustomResourceOptions options)
resources: existingFileShare: type: azure-native:storage:FileShare get: id: ${id}
import {
to = azure-native_storage_file_share.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
FileShareState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
AccessPolicy, AccessPolicyArgs
- ExpiryTime
string
- Expiry time of the access policy
- Permission
string
- List of abbreviated permissions.
- StartTime
string
- Start time of the access policy
- ExpiryTime
string
- Expiry time of the access policy
- Permission
string
- List of abbreviated permissions.
- StartTime
string
- Start time of the access policy
- expiryTime
String
- Expiry time of the access policy
- permission
String
- List of abbreviated permissions.
- startTime
String
- Start time of the access policy
- expiryTime
string
- Expiry time of the access policy
- permission
string
- List of abbreviated permissions.
- startTime
string
- Start time of the access policy
- expiryTime
String
- Expiry time of the access policy
- permission
String
- List of abbreviated permissions.
- startTime
String
- Start time of the access policy
AccessPolicyResponse
- ExpiryTime
string
- Expiry time of the access policy
- Permission
string
- List of abbreviated permissions.
- StartTime
string
- Start time of the access policy
- ExpiryTime
string
- Expiry time of the access policy
- Permission
string
- List of abbreviated permissions.
- StartTime
string
- Start time of the access policy
- expiryTime
String
- Expiry time of the access policy
- permission
String
- List of abbreviated permissions.
- startTime
String
- Start time of the access policy
- expiryTime
string
- Expiry time of the access policy
- permission
string
- List of abbreviated permissions.
- startTime
string
- Start time of the access policy
- expiryTime
String
- Expiry time of the access policy
- permission
String
- List of abbreviated permissions.
- startTime
String
- Start time of the access policy
EnabledProtocols
The authentication protocol that is used for the file share. Can only be specified when creating a share.
| Name | Value |
|---|
| EnabledProtocolsSMB | SMB |
| EnabledProtocolsNFS | NFS |
FileSharePropertiesFileSharePaidBursting, FileSharePropertiesFileSharePaidBurstingArgs
File Share Paid Bursting properties.
- PaidBurstingEnabled
bool
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- PaidBurstingMaxBandwidthMibps
int
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- PaidBurstingMaxIops
int
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- PaidBurstingEnabled
bool
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- PaidBurstingMaxBandwidthMibps
int
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- PaidBurstingMaxIops
int
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paid_bursting_enabled
bool
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paid_bursting_max_bandwidth_mibps
number
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paid_bursting_max_iops
number
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paidBurstingEnabled
Boolean
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paidBurstingMaxBandwidthMibps
Integer
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paidBurstingMaxIops
Integer
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paidBurstingEnabled
boolean
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paidBurstingMaxBandwidthMibps
number
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paidBurstingMaxIops
number
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paid_bursting_enabled
bool
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paid_bursting_max_bandwidth_mibps
int
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paid_bursting_max_iops
int
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paidBurstingEnabled
Boolean
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paidBurstingMaxBandwidthMibps
Number
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paidBurstingMaxIops
Number
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
FileSharePropertiesResponseFileSharePaidBursting
File Share Paid Bursting properties.
- PaidBurstingEnabled
bool
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- PaidBurstingMaxBandwidthMibps
int
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- PaidBurstingMaxIops
int
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- PaidBurstingEnabled
bool
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- PaidBurstingMaxBandwidthMibps
int
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- PaidBurstingMaxIops
int
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paid_bursting_enabled
bool
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paid_bursting_max_bandwidth_mibps
number
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paid_bursting_max_iops
number
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paidBurstingEnabled
Boolean
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paidBurstingMaxBandwidthMibps
Integer
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paidBurstingMaxIops
Integer
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paidBurstingEnabled
boolean
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paidBurstingMaxBandwidthMibps
number
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paidBurstingMaxIops
number
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paid_bursting_enabled
bool
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paid_bursting_max_bandwidth_mibps
int
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paid_bursting_max_iops
int
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
- paidBurstingEnabled
Boolean
- Indicates whether paid bursting is enabled for the share. This property is only for file shares created under Files Provisioned v1 SSD account type.
- paidBurstingMaxBandwidthMibps
Number
- The maximum paid bursting bandwidth for the share, in mebibytes per second. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 10340 which is the maximum allowed bandwidth for a share.
- paidBurstingMaxIops
Number
- The maximum paid bursting IOPS for the share. This property is only for file shares created under Files Provisioned v1 SSD account type. The maximum allowed value is 102400 which is the maximum allowed IOPS for a share.
RootSquashType
The property is for NFS share only. The default is NoRootSquash.
| Name | Value |
|---|
| NoRootSquash | NoRootSquash |
| RootSquash | RootSquash |
| AllSquash | AllSquash |
| Name | Value |
|---|
| RootSquashTypeNoRootSquash | NoRootSquash |
| RootSquashTypeRootSquash | RootSquash |
| RootSquashTypeAllSquash | AllSquash |
| Value |
|---|
NoRootSquash |
RootSquash |
AllSquash |
| Name | Value |
|---|
| NoRootSquash | NoRootSquash |
| RootSquash | RootSquash |
| AllSquash | AllSquash |
| Name | Value |
|---|
| NoRootSquash | NoRootSquash |
| RootSquash | RootSquash |
| AllSquash | AllSquash |
| Name | Value |
|---|
| NO_ROOT_SQUASH | NoRootSquash |
| ROOT_SQUASH | RootSquash |
| ALL_SQUASH | AllSquash |
| Value |
|---|
NoRootSquash |
RootSquash |
AllSquash |
ShareAccessTier
Access tier for specific share. GpV2 account can choose between TransactionOptimized (default), Hot, and Cool. FileStorage account can choose Premium.
| Name | Value |
|---|
| TransactionOptimized | TransactionOptimized |
| Hot | Hot |
| Cool | Cool |
| Premium | Premium |
| Name | Value |
|---|
| ShareAccessTierTransactionOptimized | TransactionOptimized |
| ShareAccessTierHot | Hot |
| ShareAccessTierCool | Cool |
| ShareAccessTierPremium | Premium |
| Value |
|---|
TransactionOptimized |
Hot |
Cool |
Premium |
| Name | Value |
|---|
| TransactionOptimized | TransactionOptimized |
| Hot | Hot |
| Cool | Cool |
| Premium | Premium |
| Name | Value |
|---|
| TransactionOptimized | TransactionOptimized |
| Hot | Hot |
| Cool | Cool |
| Premium | Premium |
| Name | Value |
|---|
| TRANSACTION_OPTIMIZED | TransactionOptimized |
| HOT | Hot |
| COOL | Cool |
| PREMIUM | Premium |
| Value |
|---|
TransactionOptimized |
Hot |
Cool |
Premium |
SignedIdentifier, SignedIdentifierArgs
SignedIdentifierResponse
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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0