azure.storage.ShareDirectory (v4)

Azure v4.42.0 (4.x), Mar 9 26

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
            AccountTier = "Standard",
            AccountReplicationType = "LRS",
        });
        var exampleShare = new Azure.Storage.Share("exampleShare", new Azure.Storage.ShareArgs
        {
            StorageAccountName = exampleAccount.Name,
            Quota = 50,
        });
        var exampleShareDirectory = new Azure.Storage.ShareDirectory("exampleShareDirectory", new Azure.Storage.ShareDirectoryArgs
        {
            ShareName = exampleShare.Name,
            StorageAccountName = exampleAccount.Name,
        });
    }

}

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v4/go/azure/storage"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "exampleAccount", &storage.AccountArgs{
			ResourceGroupName:      exampleResourceGroup.Name,
			Location:               exampleResourceGroup.Location,
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
		})
		if err != nil {
			return err
		}
		exampleShare, err := storage.NewShare(ctx, "exampleShare", &storage.ShareArgs{
			StorageAccountName: exampleAccount.Name,
			Quota:              pulumi.Int(50),
		})
		if err != nil {
			return err
		}
		_, err = storage.NewShareDirectory(ctx, "exampleShareDirectory", &storage.ShareDirectoryArgs{
			ShareName:          exampleShare.Name,
			StorageAccountName: exampleAccount.Name,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Example coming soon!

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleAccount = new azure.storage.Account("exampleAccount", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
    accountTier: "Standard",
    accountReplicationType: "LRS",
});
const exampleShare = new azure.storage.Share("exampleShare", {
    storageAccountName: exampleAccount.name,
    quota: 50,
});
const exampleShareDirectory = new azure.storage.ShareDirectory("exampleShareDirectory", {
    shareName: exampleShare.name,
    storageAccountName: exampleAccount.name,
});

import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_account = azure.storage.Account("exampleAccount",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location,
    account_tier="Standard",
    account_replication_type="LRS")
example_share = azure.storage.Share("exampleShare",
    storage_account_name=example_account.name,
    quota=50)
example_share_directory = azure.storage.ShareDirectory("exampleShareDirectory",
    share_name=example_share.name,
    storage_account_name=example_account.name)

Example coming soon!

Create ShareDirectory Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ShareDirectory(name: string, args: ShareDirectoryArgs, opts?: CustomResourceOptions);

@overload
def ShareDirectory(resource_name: str,
                   args: ShareDirectoryArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ShareDirectory(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   share_name: Optional[str] = None,
                   storage_account_name: Optional[str] = None,
                   metadata: Optional[Mapping[str, str]] = None,
                   name: Optional[str] = None)

func NewShareDirectory(ctx *Context, name string, args ShareDirectoryArgs, opts ...ResourceOption) (*ShareDirectory, error)

public ShareDirectory(string name, ShareDirectoryArgs args, CustomResourceOptions? opts = null)

public ShareDirectory(String name, ShareDirectoryArgs args)
public ShareDirectory(String name, ShareDirectoryArgs args, CustomResourceOptions options)

type: azure:storage:ShareDirectory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ShareDirectoryArgs: 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 ShareDirectoryArgs: 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 ShareDirectoryArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args ShareDirectoryArgs: 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 shareDirectoryResource = new Azure.Storage.ShareDirectory("shareDirectoryResource", new()
{
    ShareName = "string",
    StorageAccountName = "string",
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
});

example, err := storage.NewShareDirectory(ctx, "shareDirectoryResource", &storage.ShareDirectoryArgs{
	ShareName:          pulumi.String("string"),
	StorageAccountName: pulumi.String("string"),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

var shareDirectoryResource = new ShareDirectory("shareDirectoryResource", ShareDirectoryArgs.builder()
    .shareName("string")
    .storageAccountName("string")
    .metadata(Map.of("string", "string"))
    .name("string")
    .build());

share_directory_resource = azure.storage.ShareDirectory("shareDirectoryResource",
    share_name="string",
    storage_account_name="string",
    metadata={
        "string": "string",
    },
    name="string")

const shareDirectoryResource = new azure.storage.ShareDirectory("shareDirectoryResource", {
    shareName: "string",
    storageAccountName: "string",
    metadata: {
        string: "string",
    },
    name: "string",
});

type: azure:storage:ShareDirectory
properties:
    metadata:
        string: string
    name: string
    shareName: string
    storageAccountName: string

ShareDirectory Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ShareDirectory resource accepts the following input properties:

ShareName string: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
StorageAccountName string: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.
Metadata Dictionary<string, string>: A mapping of metadata to assign to this Directory.
Name string: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

ShareName string: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
StorageAccountName string: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.
Metadata map[string]string: A mapping of metadata to assign to this Directory.
Name string: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

shareName String: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
storageAccountName String: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.
metadata Map<String,String>: A mapping of metadata to assign to this Directory.
name String: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

shareName string: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
storageAccountName string: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.
metadata {[key: string]: string}: A mapping of metadata to assign to this Directory.
name string: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

share_name str: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
storage_account_name str: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.
metadata Mapping[str, str]: A mapping of metadata to assign to this Directory.
name str: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

shareName String: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
storageAccountName String: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.
metadata Map<String>: A mapping of metadata to assign to this Directory.
name String: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing ShareDirectory Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        share_name: Optional[str] = None,
        storage_account_name: Optional[str] = None) -> ShareDirectory

func GetShareDirectory(ctx *Context, name string, id IDInput, state *ShareDirectoryState, opts ...ResourceOption) (*ShareDirectory, error)

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

public static ShareDirectory get(String name, Output<String> id, ShareDirectoryState state, CustomResourceOptions options)

resources:  _:    type: azure:storage:ShareDirectory    get:      id: ${id}

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

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

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

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

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

The following state arguments are supported:

Metadata Dictionary<string, string>: A mapping of metadata to assign to this Directory.
Name string: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.
ShareName string: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
StorageAccountName string: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.

Metadata map[string]string: A mapping of metadata to assign to this Directory.
Name string: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.
ShareName string: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
StorageAccountName string: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.

metadata Map<String,String>: A mapping of metadata to assign to this Directory.
name String: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.
shareName String: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
storageAccountName String: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.

metadata {[key: string]: string}: A mapping of metadata to assign to this Directory.
name string: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.
shareName string: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
storageAccountName string: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.

metadata Mapping[str, str]: A mapping of metadata to assign to this Directory.
name str: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.
share_name str: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
storage_account_name str: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.

metadata Map<String>: A mapping of metadata to assign to this Directory.
name String: The name (or path) of the Directory that should be created within this File Share. Changing this forces a new resource to be created.
shareName String: The name of the File Share where this Directory should be created. Changing this forces a new resource to be created.
storageAccountName String: The name of the Storage Account within which the File Share is located. Changing this forces a new resource to be created.

Import

Directories within an Azure Storage File Share can be imported using the resource id, e.g.

 $ pulumi import azure:storage/shareDirectory:ShareDirectory example https://tomdevsa20.file.core.windows.net/share1/directory1

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Viewing docs for Azure v4.42.0 (Older version)
published on Monday, Mar 9, 2026 by Pulumi

Go to latest version

Schema (JSON)

pulumi/pulumi-azure

azure.storage.ShareDirectory

On this page

On this page

Example Usage

Create ShareDirectory Resource

Constructor syntax

Parameters

Constructor example

ShareDirectory Resource Properties

Inputs

Outputs

Look up Existing ShareDirectory Resource

Import

Package Details

On this page

On this page