Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. storage
  5. getLocalUser
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.storage.getLocalUser

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get the local user of the storage account by username.

    Uses Azure REST API version 2024-01-01.

    Other available API versions: 2022-09-01, 2023-01-01, 2023-04-01, 2023-05-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native storage [ApiVersion]. See the version guide for details.

    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>
    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]
    func LookupLocalUser(ctx *Context, args *LookupLocalUserArgs, opts ...InvokeOption) (*LookupLocalUserResult, error)
func LookupLocalUserOutput(ctx *Context, args *LookupLocalUserOutputArgs, opts ...InvokeOption) LookupLocalUserResultOutput

    > 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)
}
    public static CompletableFuture<GetLocalUserResult> getLocalUser(GetLocalUserArgs args, InvokeOptions options)
public static Output<GetLocalUserResult> getLocalUser(GetLocalUserArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:storage:getLocalUser
  arguments:
    # arguments dictionary

    The following arguments are supported:

    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.
    Username 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 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.
    Username 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 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.
    username 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 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.
    username 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 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.
    username 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 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.
    username 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:

    AzureApiVersion string
    The Azure API version of the resource.
    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"
    UserId int
    A unique Identifier that is generated by the server.
    AllowAclAuthorization bool
    Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
    ExtendedGroups List<int>
    Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
    GroupId int
    An identifier for associating a group of users.
    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.
    IsNFSv3Enabled bool
    Indicates if the local user is enabled for access with NFSv3 protocol.
    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.
    AzureApiVersion string
    The Azure API version of the resource.
    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"
    UserId int
    A unique Identifier that is generated by the server.
    AllowAclAuthorization bool
    Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
    ExtendedGroups []int
    Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
    GroupId int
    An identifier for associating a group of users.
    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.
    IsNFSv3Enabled bool
    Indicates if the local user is enabled for access with NFSv3 protocol.
    PermissionScopes []PermissionScopeResponse
    The permission scopes of the local user.
    SshAuthorizedKeys []SshPublicKeyResponse
    Optional, local user ssh authorized keys for SFTP.
    azureApiVersion String
    The Azure API version of the resource.
    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"
    userId Integer
    A unique Identifier that is generated by the server.
    allowAclAuthorization Boolean
    Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
    extendedGroups List<Integer>
    Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
    groupId Integer
    An identifier for associating a group of users.
    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.
    isNFSv3Enabled Boolean
    Indicates if the local user is enabled for access with NFSv3 protocol.
    permissionScopes List<PermissionScopeResponse>
    The permission scopes of the local user.
    sshAuthorizedKeys List<SshPublicKeyResponse>
    Optional, local user ssh authorized keys for SFTP.
    azureApiVersion string
    The Azure API version of the resource.
    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"
    userId number
    A unique Identifier that is generated by the server.
    allowAclAuthorization boolean
    Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
    extendedGroups number[]
    Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
    groupId number
    An identifier for associating a group of users.
    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.
    isNFSv3Enabled boolean
    Indicates if the local user is enabled for access with NFSv3 protocol.
    permissionScopes PermissionScopeResponse[]
    The permission scopes of the local user.
    sshAuthorizedKeys SshPublicKeyResponse[]
    Optional, local user ssh authorized keys for SFTP.
    azure_api_version str
    The Azure API version of the resource.
    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"
    user_id int
    A unique Identifier that is generated by the server.
    allow_acl_authorization bool
    Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
    extended_groups Sequence[int]
    Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
    group_id int
    An identifier for associating a group of users.
    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.
    is_nf_sv3_enabled bool
    Indicates if the local user is enabled for access with NFSv3 protocol.
    permission_scopes Sequence[PermissionScopeResponse]
    The permission scopes of the local user.
    ssh_authorized_keys Sequence[SshPublicKeyResponse]
    Optional, local user ssh authorized keys for SFTP.
    azureApiVersion String
    The Azure API version of the resource.
    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"
    userId Number
    A unique Identifier that is generated by the server.
    allowAclAuthorization Boolean
    Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
    extendedGroups List<Number>
    Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
    groupId Number
    An identifier for associating a group of users.
    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.
    isNFSv3Enabled Boolean
    Indicates if the local user is enabled for access with NFSv3 protocol.
    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 string
    The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p).
    ResourceName string
    The name of resource, normally the container name or the file share name, used by the local user.
    Service string
    The service used by the local user, e.g. blob, file.
    Permissions string
    The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p).
    ResourceName string
    The name of resource, normally the container name or the file share name, used by the local user.
    Service string
    The service used by the local user, e.g. blob, file.
    permissions String
    The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p).
    resourceName String
    The name of resource, normally the container name or the file share name, used by the local user.
    service String
    The service used by the local user, e.g. blob, file.
    permissions string
    The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p).
    resourceName string
    The name of resource, normally the container name or the file share name, used by the local user.
    service string
    The service used by the local user, e.g. blob, file.
    permissions str
    The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p).
    resource_name str
    The name of resource, normally the container name or the file share name, used by the local user.
    service str
    The service used by the local user, e.g. blob, file.
    permissions String
    The permissions for the local user. Possible values include: Read (r), Write (w), Delete (d), List (l), Create (c), Modify Ownership (o), and Modify Permissions (p).
    resourceName String
    The name of resource, normally the container name or the file share name, used by the local user.
    service 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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.4.0 published on Wednesday, May 7, 2025 by Pulumi
    pulumi/pulumi-azure-native