This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
azure-native.storage.getLocalUser
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi
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, 2024-01-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>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 dictionaryThe 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.
- ResourceGroup stringName 
- 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.
- ResourceGroup stringName 
- 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.
- resourceGroup StringName 
- 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.
- resourceGroup stringName 
- 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_ strname 
- 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.
- resourceGroup StringName 
- 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:
- 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.Azure Native. Storage. Outputs. System Data Response 
- 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"
- bool
- Indicates whether shared key exists. Set it to false to remove existing shared key.
- HasSsh boolKey 
- Indicates whether ssh key exists. Set it to false to remove existing SSH key.
- HasSsh boolPassword 
- Indicates whether ssh password exists. Set it to false to remove existing SSH password.
- HomeDirectory string
- Optional, local user home directory.
- PermissionScopes List<Pulumi.Azure Native. Storage. Outputs. Permission Scope Response> 
- The permission scopes of the local user.
- 
List<Pulumi.Azure Native. Storage. Outputs. Ssh Public Key Response> 
- 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 SystemData Response 
- 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"
- bool
- Indicates whether shared key exists. Set it to false to remove existing shared key.
- HasSsh boolKey 
- Indicates whether ssh key exists. Set it to false to remove existing SSH key.
- HasSsh boolPassword 
- Indicates whether ssh password exists. Set it to false to remove existing SSH password.
- HomeDirectory string
- Optional, local user home directory.
- PermissionScopes []PermissionScope Response 
- The permission scopes of the local user.
- 
[]SshPublic Key Response 
- 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 SystemData Response 
- 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"
- Boolean
- Indicates whether shared key exists. Set it to false to remove existing shared key.
- hasSsh BooleanKey 
- Indicates whether ssh key exists. Set it to false to remove existing SSH key.
- hasSsh BooleanPassword 
- Indicates whether ssh password exists. Set it to false to remove existing SSH password.
- homeDirectory String
- Optional, local user home directory.
- permissionScopes List<PermissionScope Response> 
- The permission scopes of the local user.
- 
List<SshPublic Key Response> 
- 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 SystemData Response 
- 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"
- boolean
- Indicates whether shared key exists. Set it to false to remove existing shared key.
- hasSsh booleanKey 
- Indicates whether ssh key exists. Set it to false to remove existing SSH key.
- hasSsh booleanPassword 
- Indicates whether ssh password exists. Set it to false to remove existing SSH password.
- homeDirectory string
- Optional, local user home directory.
- permissionScopes PermissionScope Response[] 
- The permission scopes of the local user.
- 
SshPublic Key Response[] 
- 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 SystemData Response 
- 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"
- bool
- Indicates whether shared key exists. Set it to false to remove existing shared key.
- has_ssh_ boolkey 
- Indicates whether ssh key exists. Set it to false to remove existing SSH key.
- has_ssh_ boolpassword 
- 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[PermissionScope Response] 
- The permission scopes of the local user.
- 
Sequence[SshPublic Key Response] 
- 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"
- Boolean
- Indicates whether shared key exists. Set it to false to remove existing shared key.
- hasSsh BooleanKey 
- Indicates whether ssh key exists. Set it to false to remove existing SSH key.
- hasSsh BooleanPassword 
- 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.
- 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), and Create (c).
- 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), and Create (c).
- 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), and Create (c).
- 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), and Create (c).
- 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), and Create (c).
- 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), and Create (c).
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- CreatedBy stringType 
- The type of identity that created the resource.
- LastModified stringAt 
- The timestamp of resource last modification (UTC)
- LastModified stringBy 
- The identity that last modified the resource.
- LastModified stringBy Type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- 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.
- createdBy stringType 
- The type of identity that created the resource.
- lastModified stringAt 
- The timestamp of resource last modification (UTC)
- lastModified stringBy 
- The identity that last modified the resource.
- lastModified stringBy Type 
- 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_ strtype 
- The type of identity that created the resource.
- last_modified_ strat 
- The timestamp of resource last modification (UTC)
- last_modified_ strby 
- The identity that last modified the resource.
- last_modified_ strby_ type 
- 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.
- createdBy StringType 
- The type of identity that created the resource.
- lastModified StringAt 
- The timestamp of resource last modification (UTC)
- lastModified StringBy 
- The identity that last modified the resource.
- lastModified StringBy Type 
- The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.1 published on Sunday, Mar 2, 2025 by Pulumi