Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. storage
  5. listLocalUserKeys
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.listLocalUserKeys

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

List SSH authorized keys and shared key of the local user. Azure REST API version: 2022-09-01.

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

Using listLocalUserKeys

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 listLocalUserKeys(args: ListLocalUserKeysArgs, opts?: InvokeOptions): Promise<ListLocalUserKeysResult>
function listLocalUserKeysOutput(args: ListLocalUserKeysOutputArgs, opts?: InvokeOptions): Output<ListLocalUserKeysResult>
Copy
def list_local_user_keys(account_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         username: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> ListLocalUserKeysResult
def list_local_user_keys_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[ListLocalUserKeysResult]
Copy
func ListLocalUserKeys(ctx *Context, args *ListLocalUserKeysArgs, opts ...InvokeOption) (*ListLocalUserKeysResult, error)
func ListLocalUserKeysOutput(ctx *Context, args *ListLocalUserKeysOutputArgs, opts ...InvokeOption) ListLocalUserKeysResultOutput
Copy

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

public static class ListLocalUserKeys 
{
    public static Task<ListLocalUserKeysResult> InvokeAsync(ListLocalUserKeysArgs args, InvokeOptions? opts = null)
    public static Output<ListLocalUserKeysResult> Invoke(ListLocalUserKeysInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListLocalUserKeysResult> listLocalUserKeys(ListLocalUserKeysArgs args, InvokeOptions options)
public static Output<ListLocalUserKeysResult> listLocalUserKeys(ListLocalUserKeysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:storage:listLocalUserKeys
  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.

listLocalUserKeys Result

The following output properties are available:

SharedKey string
Auto generated by the server for SMB authentication.
SshAuthorizedKeys List<Pulumi.AzureNative.Storage.Outputs.SshPublicKeyResponse>
Optional, local user ssh authorized keys for SFTP.
SharedKey string
Auto generated by the server for SMB authentication.
SshAuthorizedKeys []SshPublicKeyResponse
Optional, local user ssh authorized keys for SFTP.
sharedKey String
Auto generated by the server for SMB authentication.
sshAuthorizedKeys List<SshPublicKeyResponse>
Optional, local user ssh authorized keys for SFTP.
sharedKey string
Auto generated by the server for SMB authentication.
sshAuthorizedKeys SshPublicKeyResponse[]
Optional, local user ssh authorized keys for SFTP.
shared_key str
Auto generated by the server for SMB authentication.
ssh_authorized_keys Sequence[SshPublicKeyResponse]
Optional, local user ssh authorized keys for SFTP.
sharedKey String
Auto generated by the server for SMB authentication.
sshAuthorizedKeys List<Property Map>
Optional, local user ssh authorized keys for SFTP.

Supporting Types

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

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