1. Packages
  2. Azure Classic
  3. API Docs
  4. storage
  5. LocalUser

We recommend using Azure Native.

Azure v6.21.0 published on Friday, Mar 7, 2025 by Pulumi

azure.storage.LocalUser

Explore with Pulumi AI

Manages a Storage Account Local User.

Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg",
    location: "WestEurope",
});
const exampleAccount = new azure.storage.Account("example", {
    name: "example-account",
    resourceGroupName: example.name,
    location: example.location,
    accountKind: "StorageV2",
    accountTier: "Standard",
    accountReplicationType: "LRS",
    isHnsEnabled: true,
});
const exampleContainer = new azure.storage.Container("example", {
    name: "example-container",
    storageAccountName: exampleAccount.name,
});
const exampleLocalUser = new azure.storage.LocalUser("example", {
    name: "user1",
    storageAccountId: exampleAccount.id,
    sshKeyEnabled: true,
    sshPasswordEnabled: true,
    homeDirectory: "example_path",
    sshAuthorizedKeys: [
        {
            description: "key1",
            key: firstPublicKey,
        },
        {
            description: "key2",
            key: secondPublicKey,
        },
    ],
    permissionScopes: [{
        permissions: {
            read: true,
            create: true,
        },
        service: "blob",
        resourceName: exampleContainer.name,
    }],
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg",
    location="WestEurope")
example_account = azure.storage.Account("example",
    name="example-account",
    resource_group_name=example.name,
    location=example.location,
    account_kind="StorageV2",
    account_tier="Standard",
    account_replication_type="LRS",
    is_hns_enabled=True)
example_container = azure.storage.Container("example",
    name="example-container",
    storage_account_name=example_account.name)
example_local_user = azure.storage.LocalUser("example",
    name="user1",
    storage_account_id=example_account.id,
    ssh_key_enabled=True,
    ssh_password_enabled=True,
    home_directory="example_path",
    ssh_authorized_keys=[
        {
            "description": "key1",
            "key": first_public_key,
        },
        {
            "description": "key2",
            "key": second_public_key,
        },
    ],
    permission_scopes=[{
        "permissions": {
            "read": True,
            "create": True,
        },
        "service": "blob",
        "resource_name": example_container.name,
    }])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-rg"),
			Location: pulumi.String("WestEurope"),
		})
		if err != nil {
			return err
		}
		exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
			Name:                   pulumi.String("example-account"),
			ResourceGroupName:      example.Name,
			Location:               example.Location,
			AccountKind:            pulumi.String("StorageV2"),
			AccountTier:            pulumi.String("Standard"),
			AccountReplicationType: pulumi.String("LRS"),
			IsHnsEnabled:           pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		exampleContainer, err := storage.NewContainer(ctx, "example", &storage.ContainerArgs{
			Name:               pulumi.String("example-container"),
			StorageAccountName: exampleAccount.Name,
		})
		if err != nil {
			return err
		}
		_, err = storage.NewLocalUser(ctx, "example", &storage.LocalUserArgs{
			Name:               pulumi.String("user1"),
			StorageAccountId:   exampleAccount.ID(),
			SshKeyEnabled:      pulumi.Bool(true),
			SshPasswordEnabled: pulumi.Bool(true),
			HomeDirectory:      pulumi.String("example_path"),
			SshAuthorizedKeys: storage.LocalUserSshAuthorizedKeyArray{
				&storage.LocalUserSshAuthorizedKeyArgs{
					Description: pulumi.String("key1"),
					Key:         pulumi.Any(firstPublicKey),
				},
				&storage.LocalUserSshAuthorizedKeyArgs{
					Description: pulumi.String("key2"),
					Key:         pulumi.Any(secondPublicKey),
				},
			},
			PermissionScopes: storage.LocalUserPermissionScopeArray{
				&storage.LocalUserPermissionScopeArgs{
					Permissions: &storage.LocalUserPermissionScopePermissionsArgs{
						Read:   pulumi.Bool(true),
						Create: pulumi.Bool(true),
					},
					Service:      pulumi.String("blob"),
					ResourceName: exampleContainer.Name,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-rg",
        Location = "WestEurope",
    });

    var exampleAccount = new Azure.Storage.Account("example", new()
    {
        Name = "example-account",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AccountKind = "StorageV2",
        AccountTier = "Standard",
        AccountReplicationType = "LRS",
        IsHnsEnabled = true,
    });

    var exampleContainer = new Azure.Storage.Container("example", new()
    {
        Name = "example-container",
        StorageAccountName = exampleAccount.Name,
    });

    var exampleLocalUser = new Azure.Storage.LocalUser("example", new()
    {
        Name = "user1",
        StorageAccountId = exampleAccount.Id,
        SshKeyEnabled = true,
        SshPasswordEnabled = true,
        HomeDirectory = "example_path",
        SshAuthorizedKeys = new[]
        {
            new Azure.Storage.Inputs.LocalUserSshAuthorizedKeyArgs
            {
                Description = "key1",
                Key = firstPublicKey,
            },
            new Azure.Storage.Inputs.LocalUserSshAuthorizedKeyArgs
            {
                Description = "key2",
                Key = secondPublicKey,
            },
        },
        PermissionScopes = new[]
        {
            new Azure.Storage.Inputs.LocalUserPermissionScopeArgs
            {
                Permissions = new Azure.Storage.Inputs.LocalUserPermissionScopePermissionsArgs
                {
                    Read = true,
                    Create = true,
                },
                Service = "blob",
                ResourceName = exampleContainer.Name,
            },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.storage.Container;
import com.pulumi.azure.storage.ContainerArgs;
import com.pulumi.azure.storage.LocalUser;
import com.pulumi.azure.storage.LocalUserArgs;
import com.pulumi.azure.storage.inputs.LocalUserSshAuthorizedKeyArgs;
import com.pulumi.azure.storage.inputs.LocalUserPermissionScopeArgs;
import com.pulumi.azure.storage.inputs.LocalUserPermissionScopePermissionsArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-rg")
            .location("WestEurope")
            .build());

        var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
            .name("example-account")
            .resourceGroupName(example.name())
            .location(example.location())
            .accountKind("StorageV2")
            .accountTier("Standard")
            .accountReplicationType("LRS")
            .isHnsEnabled(true)
            .build());

        var exampleContainer = new Container("exampleContainer", ContainerArgs.builder()
            .name("example-container")
            .storageAccountName(exampleAccount.name())
            .build());

        var exampleLocalUser = new LocalUser("exampleLocalUser", LocalUserArgs.builder()
            .name("user1")
            .storageAccountId(exampleAccount.id())
            .sshKeyEnabled(true)
            .sshPasswordEnabled(true)
            .homeDirectory("example_path")
            .sshAuthorizedKeys(            
                LocalUserSshAuthorizedKeyArgs.builder()
                    .description("key1")
                    .key(firstPublicKey)
                    .build(),
                LocalUserSshAuthorizedKeyArgs.builder()
                    .description("key2")
                    .key(secondPublicKey)
                    .build())
            .permissionScopes(LocalUserPermissionScopeArgs.builder()
                .permissions(LocalUserPermissionScopePermissionsArgs.builder()
                    .read(true)
                    .create(true)
                    .build())
                .service("blob")
                .resourceName(exampleContainer.name())
                .build())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg
      location: WestEurope
  exampleAccount:
    type: azure:storage:Account
    name: example
    properties:
      name: example-account
      resourceGroupName: ${example.name}
      location: ${example.location}
      accountKind: StorageV2
      accountTier: Standard
      accountReplicationType: LRS
      isHnsEnabled: true
  exampleContainer:
    type: azure:storage:Container
    name: example
    properties:
      name: example-container
      storageAccountName: ${exampleAccount.name}
  exampleLocalUser:
    type: azure:storage:LocalUser
    name: example
    properties:
      name: user1
      storageAccountId: ${exampleAccount.id}
      sshKeyEnabled: true
      sshPasswordEnabled: true
      homeDirectory: example_path
      sshAuthorizedKeys:
        - description: key1
          key: ${firstPublicKey}
        - description: key2
          key: ${secondPublicKey}
      permissionScopes:
        - permissions:
            read: true
            create: true
          service: blob
          resourceName: ${exampleContainer.name}
Copy

Create LocalUser Resource

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

Constructor syntax

new LocalUser(name: string, args: LocalUserArgs, opts?: CustomResourceOptions);
@overload
def LocalUser(resource_name: str,
              args: LocalUserArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def LocalUser(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              storage_account_id: Optional[str] = None,
              home_directory: Optional[str] = None,
              name: Optional[str] = None,
              permission_scopes: Optional[Sequence[LocalUserPermissionScopeArgs]] = None,
              ssh_authorized_keys: Optional[Sequence[LocalUserSshAuthorizedKeyArgs]] = None,
              ssh_key_enabled: Optional[bool] = None,
              ssh_password_enabled: Optional[bool] = None)
func NewLocalUser(ctx *Context, name string, args LocalUserArgs, opts ...ResourceOption) (*LocalUser, error)
public LocalUser(string name, LocalUserArgs args, CustomResourceOptions? opts = null)
public LocalUser(String name, LocalUserArgs args)
public LocalUser(String name, LocalUserArgs args, CustomResourceOptions options)
type: azure:storage:LocalUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. LocalUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. LocalUserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. LocalUserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. LocalUserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. LocalUserArgs
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 localUserResource = new Azure.Storage.LocalUser("localUserResource", new()
{
    StorageAccountId = "string",
    HomeDirectory = "string",
    Name = "string",
    PermissionScopes = new[]
    {
        new Azure.Storage.Inputs.LocalUserPermissionScopeArgs
        {
            Permissions = new Azure.Storage.Inputs.LocalUserPermissionScopePermissionsArgs
            {
                Create = false,
                Delete = false,
                List = false,
                Read = false,
                Write = false,
            },
            ResourceName = "string",
            Service = "string",
        },
    },
    SshAuthorizedKeys = new[]
    {
        new Azure.Storage.Inputs.LocalUserSshAuthorizedKeyArgs
        {
            Key = "string",
            Description = "string",
        },
    },
    SshKeyEnabled = false,
    SshPasswordEnabled = false,
});
Copy
example, err := storage.NewLocalUser(ctx, "localUserResource", &storage.LocalUserArgs{
	StorageAccountId: pulumi.String("string"),
	HomeDirectory:    pulumi.String("string"),
	Name:             pulumi.String("string"),
	PermissionScopes: storage.LocalUserPermissionScopeArray{
		&storage.LocalUserPermissionScopeArgs{
			Permissions: &storage.LocalUserPermissionScopePermissionsArgs{
				Create: pulumi.Bool(false),
				Delete: pulumi.Bool(false),
				List:   pulumi.Bool(false),
				Read:   pulumi.Bool(false),
				Write:  pulumi.Bool(false),
			},
			ResourceName: pulumi.String("string"),
			Service:      pulumi.String("string"),
		},
	},
	SshAuthorizedKeys: storage.LocalUserSshAuthorizedKeyArray{
		&storage.LocalUserSshAuthorizedKeyArgs{
			Key:         pulumi.String("string"),
			Description: pulumi.String("string"),
		},
	},
	SshKeyEnabled:      pulumi.Bool(false),
	SshPasswordEnabled: pulumi.Bool(false),
})
Copy
var localUserResource = new LocalUser("localUserResource", LocalUserArgs.builder()
    .storageAccountId("string")
    .homeDirectory("string")
    .name("string")
    .permissionScopes(LocalUserPermissionScopeArgs.builder()
        .permissions(LocalUserPermissionScopePermissionsArgs.builder()
            .create(false)
            .delete(false)
            .list(false)
            .read(false)
            .write(false)
            .build())
        .resourceName("string")
        .service("string")
        .build())
    .sshAuthorizedKeys(LocalUserSshAuthorizedKeyArgs.builder()
        .key("string")
        .description("string")
        .build())
    .sshKeyEnabled(false)
    .sshPasswordEnabled(false)
    .build());
Copy
local_user_resource = azure.storage.LocalUser("localUserResource",
    storage_account_id="string",
    home_directory="string",
    name="string",
    permission_scopes=[{
        "permissions": {
            "create": False,
            "delete": False,
            "list": False,
            "read": False,
            "write": False,
        },
        "resource_name": "string",
        "service": "string",
    }],
    ssh_authorized_keys=[{
        "key": "string",
        "description": "string",
    }],
    ssh_key_enabled=False,
    ssh_password_enabled=False)
Copy
const localUserResource = new azure.storage.LocalUser("localUserResource", {
    storageAccountId: "string",
    homeDirectory: "string",
    name: "string",
    permissionScopes: [{
        permissions: {
            create: false,
            "delete": false,
            list: false,
            read: false,
            write: false,
        },
        resourceName: "string",
        service: "string",
    }],
    sshAuthorizedKeys: [{
        key: "string",
        description: "string",
    }],
    sshKeyEnabled: false,
    sshPasswordEnabled: false,
});
Copy
type: azure:storage:LocalUser
properties:
    homeDirectory: string
    name: string
    permissionScopes:
        - permissions:
            create: false
            delete: false
            list: false
            read: false
            write: false
          resourceName: string
          service: string
    sshAuthorizedKeys:
        - description: string
          key: string
    sshKeyEnabled: false
    sshPasswordEnabled: false
    storageAccountId: string
Copy

LocalUser 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 LocalUser resource accepts the following input properties:

StorageAccountId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
HomeDirectory string
The home directory of the Storage Account Local User.
Name Changes to this property will trigger replacement. string
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
PermissionScopes List<LocalUserPermissionScope>
One or more permission_scope blocks as defined below.
SshAuthorizedKeys List<LocalUserSshAuthorizedKey>
One or more ssh_authorized_key blocks as defined below.
SshKeyEnabled bool
Specifies whether SSH Key Authentication is enabled. Defaults to false.
SshPasswordEnabled bool
Specifies whether SSH Password Authentication is enabled. Defaults to false.
StorageAccountId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
HomeDirectory string
The home directory of the Storage Account Local User.
Name Changes to this property will trigger replacement. string
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
PermissionScopes []LocalUserPermissionScopeArgs
One or more permission_scope blocks as defined below.
SshAuthorizedKeys []LocalUserSshAuthorizedKeyArgs
One or more ssh_authorized_key blocks as defined below.
SshKeyEnabled bool
Specifies whether SSH Key Authentication is enabled. Defaults to false.
SshPasswordEnabled bool
Specifies whether SSH Password Authentication is enabled. Defaults to false.
storageAccountId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
homeDirectory String
The home directory of the Storage Account Local User.
name Changes to this property will trigger replacement. String
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
permissionScopes List<LocalUserPermissionScope>
One or more permission_scope blocks as defined below.
sshAuthorizedKeys List<LocalUserSshAuthorizedKey>
One or more ssh_authorized_key blocks as defined below.
sshKeyEnabled Boolean
Specifies whether SSH Key Authentication is enabled. Defaults to false.
sshPasswordEnabled Boolean
Specifies whether SSH Password Authentication is enabled. Defaults to false.
storageAccountId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
homeDirectory string
The home directory of the Storage Account Local User.
name Changes to this property will trigger replacement. string
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
permissionScopes LocalUserPermissionScope[]
One or more permission_scope blocks as defined below.
sshAuthorizedKeys LocalUserSshAuthorizedKey[]
One or more ssh_authorized_key blocks as defined below.
sshKeyEnabled boolean
Specifies whether SSH Key Authentication is enabled. Defaults to false.
sshPasswordEnabled boolean
Specifies whether SSH Password Authentication is enabled. Defaults to false.
storage_account_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
home_directory str
The home directory of the Storage Account Local User.
name Changes to this property will trigger replacement. str
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
permission_scopes Sequence[LocalUserPermissionScopeArgs]
One or more permission_scope blocks as defined below.
ssh_authorized_keys Sequence[LocalUserSshAuthorizedKeyArgs]
One or more ssh_authorized_key blocks as defined below.
ssh_key_enabled bool
Specifies whether SSH Key Authentication is enabled. Defaults to false.
ssh_password_enabled bool
Specifies whether SSH Password Authentication is enabled. Defaults to false.
storageAccountId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
homeDirectory String
The home directory of the Storage Account Local User.
name Changes to this property will trigger replacement. String
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
permissionScopes List<Property Map>
One or more permission_scope blocks as defined below.
sshAuthorizedKeys List<Property Map>
One or more ssh_authorized_key blocks as defined below.
sshKeyEnabled Boolean
Specifies whether SSH Key Authentication is enabled. Defaults to false.
sshPasswordEnabled Boolean
Specifies whether SSH Password Authentication is enabled. Defaults to false.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Password string
The value of the password, which is only available when ssh_password_enabled is set to true.
Sid string
The unique Security Identifier of this Storage Account Local User.
Id string
The provider-assigned unique ID for this managed resource.
Password string
The value of the password, which is only available when ssh_password_enabled is set to true.
Sid string
The unique Security Identifier of this Storage Account Local User.
id String
The provider-assigned unique ID for this managed resource.
password String
The value of the password, which is only available when ssh_password_enabled is set to true.
sid String
The unique Security Identifier of this Storage Account Local User.
id string
The provider-assigned unique ID for this managed resource.
password string
The value of the password, which is only available when ssh_password_enabled is set to true.
sid string
The unique Security Identifier of this Storage Account Local User.
id str
The provider-assigned unique ID for this managed resource.
password str
The value of the password, which is only available when ssh_password_enabled is set to true.
sid str
The unique Security Identifier of this Storage Account Local User.
id String
The provider-assigned unique ID for this managed resource.
password String
The value of the password, which is only available when ssh_password_enabled is set to true.
sid String
The unique Security Identifier of this Storage Account Local User.

Look up Existing LocalUser Resource

Get an existing LocalUser 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?: LocalUserState, opts?: CustomResourceOptions): LocalUser
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        home_directory: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        permission_scopes: Optional[Sequence[LocalUserPermissionScopeArgs]] = None,
        sid: Optional[str] = None,
        ssh_authorized_keys: Optional[Sequence[LocalUserSshAuthorizedKeyArgs]] = None,
        ssh_key_enabled: Optional[bool] = None,
        ssh_password_enabled: Optional[bool] = None,
        storage_account_id: Optional[str] = None) -> LocalUser
func GetLocalUser(ctx *Context, name string, id IDInput, state *LocalUserState, opts ...ResourceOption) (*LocalUser, error)
public static LocalUser Get(string name, Input<string> id, LocalUserState? state, CustomResourceOptions? opts = null)
public static LocalUser get(String name, Output<String> id, LocalUserState state, CustomResourceOptions options)
resources:  _:    type: azure:storage:LocalUser    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
HomeDirectory string
The home directory of the Storage Account Local User.
Name Changes to this property will trigger replacement. string
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
Password string
The value of the password, which is only available when ssh_password_enabled is set to true.
PermissionScopes List<LocalUserPermissionScope>
One or more permission_scope blocks as defined below.
Sid string
The unique Security Identifier of this Storage Account Local User.
SshAuthorizedKeys List<LocalUserSshAuthorizedKey>
One or more ssh_authorized_key blocks as defined below.
SshKeyEnabled bool
Specifies whether SSH Key Authentication is enabled. Defaults to false.
SshPasswordEnabled bool
Specifies whether SSH Password Authentication is enabled. Defaults to false.
StorageAccountId Changes to this property will trigger replacement. string
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
HomeDirectory string
The home directory of the Storage Account Local User.
Name Changes to this property will trigger replacement. string
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
Password string
The value of the password, which is only available when ssh_password_enabled is set to true.
PermissionScopes []LocalUserPermissionScopeArgs
One or more permission_scope blocks as defined below.
Sid string
The unique Security Identifier of this Storage Account Local User.
SshAuthorizedKeys []LocalUserSshAuthorizedKeyArgs
One or more ssh_authorized_key blocks as defined below.
SshKeyEnabled bool
Specifies whether SSH Key Authentication is enabled. Defaults to false.
SshPasswordEnabled bool
Specifies whether SSH Password Authentication is enabled. Defaults to false.
StorageAccountId Changes to this property will trigger replacement. string
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
homeDirectory String
The home directory of the Storage Account Local User.
name Changes to this property will trigger replacement. String
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
password String
The value of the password, which is only available when ssh_password_enabled is set to true.
permissionScopes List<LocalUserPermissionScope>
One or more permission_scope blocks as defined below.
sid String
The unique Security Identifier of this Storage Account Local User.
sshAuthorizedKeys List<LocalUserSshAuthorizedKey>
One or more ssh_authorized_key blocks as defined below.
sshKeyEnabled Boolean
Specifies whether SSH Key Authentication is enabled. Defaults to false.
sshPasswordEnabled Boolean
Specifies whether SSH Password Authentication is enabled. Defaults to false.
storageAccountId Changes to this property will trigger replacement. String
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
homeDirectory string
The home directory of the Storage Account Local User.
name Changes to this property will trigger replacement. string
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
password string
The value of the password, which is only available when ssh_password_enabled is set to true.
permissionScopes LocalUserPermissionScope[]
One or more permission_scope blocks as defined below.
sid string
The unique Security Identifier of this Storage Account Local User.
sshAuthorizedKeys LocalUserSshAuthorizedKey[]
One or more ssh_authorized_key blocks as defined below.
sshKeyEnabled boolean
Specifies whether SSH Key Authentication is enabled. Defaults to false.
sshPasswordEnabled boolean
Specifies whether SSH Password Authentication is enabled. Defaults to false.
storageAccountId Changes to this property will trigger replacement. string
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
home_directory str
The home directory of the Storage Account Local User.
name Changes to this property will trigger replacement. str
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
password str
The value of the password, which is only available when ssh_password_enabled is set to true.
permission_scopes Sequence[LocalUserPermissionScopeArgs]
One or more permission_scope blocks as defined below.
sid str
The unique Security Identifier of this Storage Account Local User.
ssh_authorized_keys Sequence[LocalUserSshAuthorizedKeyArgs]
One or more ssh_authorized_key blocks as defined below.
ssh_key_enabled bool
Specifies whether SSH Key Authentication is enabled. Defaults to false.
ssh_password_enabled bool
Specifies whether SSH Password Authentication is enabled. Defaults to false.
storage_account_id Changes to this property will trigger replacement. str
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.
homeDirectory String
The home directory of the Storage Account Local User.
name Changes to this property will trigger replacement. String
The name which should be used for this Storage Account Local User. Changing this forces a new Storage Account Local User to be created.
password String
The value of the password, which is only available when ssh_password_enabled is set to true.
permissionScopes List<Property Map>
One or more permission_scope blocks as defined below.
sid String
The unique Security Identifier of this Storage Account Local User.
sshAuthorizedKeys List<Property Map>
One or more ssh_authorized_key blocks as defined below.
sshKeyEnabled Boolean
Specifies whether SSH Key Authentication is enabled. Defaults to false.
sshPasswordEnabled Boolean
Specifies whether SSH Password Authentication is enabled. Defaults to false.
storageAccountId Changes to this property will trigger replacement. String
The ID of the Storage Account that this Storage Account Local User resides in. Changing this forces a new Storage Account Local User to be created.

Supporting Types

LocalUserPermissionScope
, LocalUserPermissionScopeArgs

Permissions This property is required. LocalUserPermissionScopePermissions
A permissions block as defined below.
ResourceName This property is required. string
The container name (when service is set to blob) or the file share name (when service is set to file), used by the Storage Account Local User.
Service This property is required. string
The storage service used by this Storage Account Local User. Possible values are blob and file.
Permissions This property is required. LocalUserPermissionScopePermissions
A permissions block as defined below.
ResourceName This property is required. string
The container name (when service is set to blob) or the file share name (when service is set to file), used by the Storage Account Local User.
Service This property is required. string
The storage service used by this Storage Account Local User. Possible values are blob and file.
permissions This property is required. LocalUserPermissionScopePermissions
A permissions block as defined below.
resourceName This property is required. String
The container name (when service is set to blob) or the file share name (when service is set to file), used by the Storage Account Local User.
service This property is required. String
The storage service used by this Storage Account Local User. Possible values are blob and file.
permissions This property is required. LocalUserPermissionScopePermissions
A permissions block as defined below.
resourceName This property is required. string
The container name (when service is set to blob) or the file share name (when service is set to file), used by the Storage Account Local User.
service This property is required. string
The storage service used by this Storage Account Local User. Possible values are blob and file.
permissions This property is required. LocalUserPermissionScopePermissions
A permissions block as defined below.
resource_name This property is required. str
The container name (when service is set to blob) or the file share name (when service is set to file), used by the Storage Account Local User.
service This property is required. str
The storage service used by this Storage Account Local User. Possible values are blob and file.
permissions This property is required. Property Map
A permissions block as defined below.
resourceName This property is required. String
The container name (when service is set to blob) or the file share name (when service is set to file), used by the Storage Account Local User.
service This property is required. String
The storage service used by this Storage Account Local User. Possible values are blob and file.

LocalUserPermissionScopePermissions
, LocalUserPermissionScopePermissionsArgs

Create bool
Specifies if the Local User has the create permission for this scope. Defaults to false.
Delete bool
Specifies if the Local User has the delete permission for this scope. Defaults to false.
List bool
Specifies if the Local User has the list permission for this scope. Defaults to false.
Read bool
Specifies if the Local User has the read permission for this scope. Defaults to false.
Write bool
Specifies if the Local User has the write permission for this scope. Defaults to false.
Create bool
Specifies if the Local User has the create permission for this scope. Defaults to false.
Delete bool
Specifies if the Local User has the delete permission for this scope. Defaults to false.
List bool
Specifies if the Local User has the list permission for this scope. Defaults to false.
Read bool
Specifies if the Local User has the read permission for this scope. Defaults to false.
Write bool
Specifies if the Local User has the write permission for this scope. Defaults to false.
create Boolean
Specifies if the Local User has the create permission for this scope. Defaults to false.
delete Boolean
Specifies if the Local User has the delete permission for this scope. Defaults to false.
list Boolean
Specifies if the Local User has the list permission for this scope. Defaults to false.
read Boolean
Specifies if the Local User has the read permission for this scope. Defaults to false.
write Boolean
Specifies if the Local User has the write permission for this scope. Defaults to false.
create boolean
Specifies if the Local User has the create permission for this scope. Defaults to false.
delete boolean
Specifies if the Local User has the delete permission for this scope. Defaults to false.
list boolean
Specifies if the Local User has the list permission for this scope. Defaults to false.
read boolean
Specifies if the Local User has the read permission for this scope. Defaults to false.
write boolean
Specifies if the Local User has the write permission for this scope. Defaults to false.
create bool
Specifies if the Local User has the create permission for this scope. Defaults to false.
delete bool
Specifies if the Local User has the delete permission for this scope. Defaults to false.
list bool
Specifies if the Local User has the list permission for this scope. Defaults to false.
read bool
Specifies if the Local User has the read permission for this scope. Defaults to false.
write bool
Specifies if the Local User has the write permission for this scope. Defaults to false.
create Boolean
Specifies if the Local User has the create permission for this scope. Defaults to false.
delete Boolean
Specifies if the Local User has the delete permission for this scope. Defaults to false.
list Boolean
Specifies if the Local User has the list permission for this scope. Defaults to false.
read Boolean
Specifies if the Local User has the read permission for this scope. Defaults to false.
write Boolean
Specifies if the Local User has the write permission for this scope. Defaults to false.

LocalUserSshAuthorizedKey
, LocalUserSshAuthorizedKeyArgs

Key This property is required. string
The public key value of this SSH authorized key.
Description string
The description of this SSH authorized key.
Key This property is required. string
The public key value of this SSH authorized key.
Description string
The description of this SSH authorized key.
key This property is required. String
The public key value of this SSH authorized key.
description String
The description of this SSH authorized key.
key This property is required. string
The public key value of this SSH authorized key.
description string
The description of this SSH authorized key.
key This property is required. str
The public key value of this SSH authorized key.
description str
The description of this SSH authorized key.
key This property is required. String
The public key value of this SSH authorized key.
description String
The description of this SSH authorized key.

Import

Storage Account Local Users can be imported using the resource id, e.g.

$ pulumi import azure:storage/localUser:LocalUser example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Storage/storageAccounts/storageAccount1/localUsers/user1
Copy

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.