local_users_keys

Creates, updates, deletes, gets or lists a local_users_keys resource.

Overview

Name	local_users_keys
Type	Resource
Id	azure.storage.local_users_keys

Fields

The following fields are returned by SELECT queries:

list

OK -- Get the local user keys successfully.

Name	Datatype	Description
sharedKey	string	Auto generated by the server for SMB authentication.
sshAuthorizedKeys	array	Optional, local user ssh authorized keys for SFTP.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	resourceGroupName, accountName, subscriptionId, username		List SSH authorized keys and shared key of the local user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
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.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
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.

SELECT examples

list

List SSH authorized keys and shared key of the local user.

SELECT
sharedKey,
sshAuthorizedKeys
FROM azure.storage.local_users_keys
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND accountName = '{{ accountName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND username = '{{ username }}' -- required
;