Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. storage
  5. getLocalUser
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.storage.getLocalUser

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the local user of the storage account by username. Azure REST API version: 2022-09-01.

Other available API versions: 2023-01-01, 2023-04-01, 2023-05-01.

Using getLocalUser

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLocalUser(args: GetLocalUserArgs, opts?: InvokeOptions): Promise<GetLocalUserResult>
function getLocalUserOutput(args: GetLocalUserOutputArgs, opts?: InvokeOptions): Output<GetLocalUserResult>
Copy
def get_local_user(account_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   username: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetLocalUserResult
def get_local_user_output(account_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   username: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetLocalUserResult]
Copy
func LookupLocalUser(ctx *Context, args *LookupLocalUserArgs, opts ...InvokeOption) (*LookupLocalUserResult, error)
func LookupLocalUserOutput(ctx *Context, args *LookupLocalUserOutputArgs, opts ...InvokeOption) LookupLocalUserResultOutput
Copy

> Note: This function is named LookupLocalUser in the Go SDK.

public static class GetLocalUser 
{
    public static Task<GetLocalUserResult> InvokeAsync(GetLocalUserArgs args, InvokeOptions? opts = null)
    public static Output<GetLocalUserResult> Invoke(GetLocalUserInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLocalUserResult> getLocalUser(GetLocalUserArgs args, InvokeOptions options)
public static Output<GetLocalUserResult> getLocalUser(GetLocalUserArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storage:getLocalUser
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
Username
This property is required.
Changes to this property will trigger replacement.
string
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
AccountName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
Username
This property is required.
Changes to this property will trigger replacement.
string
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
accountName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
username
This property is required.
Changes to this property will trigger replacement.
String
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
accountName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group within the user's subscription. The name is case insensitive.
username
This property is required.
Changes to this property will trigger replacement.
string
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
account_name
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group within the user's subscription. The name is case insensitive.
username
This property is required.
Changes to this property will trigger replacement.
str
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
accountName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group within the user's subscription. The name is case insensitive.
username
This property is required.
Changes to this property will trigger replacement.
String
The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.

getLocalUser Result

The following output properties are available:

Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Sid string
A unique Security Identifier that is generated by the server.
SystemData Pulumi.AzureNative.Storage.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
HasSharedKey bool
Indicates whether shared key exists. Set it to false to remove existing shared key.
HasSshKey bool
Indicates whether ssh key exists. Set it to false to remove existing SSH key.
HasSshPassword bool
Indicates whether ssh password exists. Set it to false to remove existing SSH password.
HomeDirectory string
Optional, local user home directory.
PermissionScopes List<Pulumi.AzureNative.Storage.Outputs.PermissionScopeResponse>
The permission scopes of the local user.
SshAuthorizedKeys List<Pulumi.AzureNative.Storage.Outputs.SshPublicKeyResponse>
Optional, local user ssh authorized keys for SFTP.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Sid string
A unique Security Identifier that is generated by the server.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
HasSharedKey bool
Indicates whether shared key exists. Set it to false to remove existing shared key.
HasSshKey bool
Indicates whether ssh key exists. Set it to false to remove existing SSH key.
HasSshPassword bool
Indicates whether ssh password exists. Set it to false to remove existing SSH password.
HomeDirectory string
Optional, local user home directory.
PermissionScopes []PermissionScopeResponse
The permission scopes of the local user.
SshAuthorizedKeys []SshPublicKeyResponse
Optional, local user ssh authorized keys for SFTP.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
sid String
A unique Security Identifier that is generated by the server.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
hasSharedKey Boolean
Indicates whether shared key exists. Set it to false to remove existing shared key.
hasSshKey Boolean
Indicates whether ssh key exists. Set it to false to remove existing SSH key.
hasSshPassword Boolean
Indicates whether ssh password exists. Set it to false to remove existing SSH password.
homeDirectory String
Optional, local user home directory.
permissionScopes List<PermissionScopeResponse>
The permission scopes of the local user.
sshAuthorizedKeys List<SshPublicKeyResponse>
Optional, local user ssh authorized keys for SFTP.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
sid string
A unique Security Identifier that is generated by the server.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
hasSharedKey boolean
Indicates whether shared key exists. Set it to false to remove existing shared key.
hasSshKey boolean
Indicates whether ssh key exists. Set it to false to remove existing SSH key.
hasSshPassword boolean
Indicates whether ssh password exists. Set it to false to remove existing SSH password.
homeDirectory string
Optional, local user home directory.
permissionScopes PermissionScopeResponse[]
The permission scopes of the local user.
sshAuthorizedKeys SshPublicKeyResponse[]
Optional, local user ssh authorized keys for SFTP.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
sid str
A unique Security Identifier that is generated by the server.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
has_shared_key bool
Indicates whether shared key exists. Set it to false to remove existing shared key.
has_ssh_key bool
Indicates whether ssh key exists. Set it to false to remove existing SSH key.
has_ssh_password bool
Indicates whether ssh password exists. Set it to false to remove existing SSH password.
home_directory str
Optional, local user home directory.
permission_scopes Sequence[PermissionScopeResponse]
The permission scopes of the local user.
ssh_authorized_keys Sequence[SshPublicKeyResponse]
Optional, local user ssh authorized keys for SFTP.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
sid String
A unique Security Identifier that is generated by the server.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
hasSharedKey Boolean
Indicates whether shared key exists. Set it to false to remove existing shared key.
hasSshKey Boolean
Indicates whether ssh key exists. Set it to false to remove existing SSH key.
hasSshPassword Boolean
Indicates whether ssh password exists. Set it to false to remove existing SSH password.
homeDirectory String
Optional, local user home directory.
permissionScopes List<Property Map>
The permission scopes of the local user.
sshAuthorizedKeys List<Property Map>
Optional, local user ssh authorized keys for SFTP.

Supporting Types

PermissionScopeResponse

Permissions This property is required. string
The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c).
ResourceName This property is required. string
The name of resource, normally the container name or the file share name, used by the local user.
Service This property is required. string
The service used by the local user, e.g. blob, file.
Permissions This property is required. string
The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c).
ResourceName This property is required. string
The name of resource, normally the container name or the file share name, used by the local user.
Service This property is required. string
The service used by the local user, e.g. blob, file.
permissions This property is required. String
The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c).
resourceName This property is required. String
The name of resource, normally the container name or the file share name, used by the local user.
service This property is required. String
The service used by the local user, e.g. blob, file.
permissions This property is required. string
The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c).
resourceName This property is required. string
The name of resource, normally the container name or the file share name, used by the local user.
service This property is required. string
The service used by the local user, e.g. blob, file.
permissions This property is required. str
The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c).
resource_name This property is required. str
The name of resource, normally the container name or the file share name, used by the local user.
service This property is required. str
The service used by the local user, e.g. blob, file.
permissions This property is required. String
The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), and Create (c).
resourceName This property is required. String
The name of resource, normally the container name or the file share name, used by the local user.
service This property is required. String
The service used by the local user, e.g. blob, file.

SshPublicKeyResponse

Description string
Optional. It is used to store the function/usage of the key
Key string
Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB
Description string
Optional. It is used to store the function/usage of the key
Key string
Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB
description String
Optional. It is used to store the function/usage of the key
key String
Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB
description string
Optional. It is used to store the function/usage of the key
key string
Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB
description str
Optional. It is used to store the function/usage of the key
key str
Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB
description String
Optional. It is used to store the function/usage of the key
key String
Ssh public key base64 encoded. The format should be: ' ', e.g. ssh-rsa AAAABBBB

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native