@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.91 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* 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, 2025-01-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getLocalUser(args: GetLocalUserArgs, opts?: pulumi.InvokeOptions): Promise<GetLocalUserResult>;
export interface GetLocalUserArgs {
/**
* 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.
*/
accountName: string;
/**
* The name of the resource group within the user's subscription. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
*/
username: string;
}
/**
* The local user associated with the storage accounts.
*/
export interface GetLocalUserResult {
/**
* Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
*/
readonly allowAclAuthorization?: boolean;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
*/
readonly extendedGroups?: number[];
/**
* An identifier for associating a group of users.
*/
readonly groupId?: number;
/**
* Indicates whether shared key exists. Set it to false to remove existing shared key.
*/
readonly hasSharedKey?: boolean;
/**
* Indicates whether ssh key exists. Set it to false to remove existing SSH key.
*/
readonly hasSshKey?: boolean;
/**
* Indicates whether ssh password exists. Set it to false to remove existing SSH password.
*/
readonly hasSshPassword?: boolean;
/**
* Optional, local user home directory.
*/
readonly homeDirectory?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* Indicates if the local user is enabled for access with NFSv3 protocol.
*/
readonly isNFSv3Enabled?: boolean;
/**
* The name of the resource
*/
readonly name: string;
/**
* The permission scopes of the local user.
*/
readonly permissionScopes?: outputs.storage.PermissionScopeResponse[];
/**
* A unique Security Identifier that is generated by the server.
*/
readonly sid: string;
/**
* Optional, local user ssh authorized keys for SFTP.
*/
readonly sshAuthorizedKeys?: outputs.storage.SshPublicKeyResponse[];
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: outputs.storage.SystemDataResponse;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* A unique Identifier that is generated by the server.
*/
readonly userId: number;
}
/**
* 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, 2025-01-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](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getLocalUserOutput(args: GetLocalUserOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetLocalUserResult>;
export interface GetLocalUserOutputArgs {
/**
* 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.
*/
accountName: pulumi.Input<string>;
/**
* The name of the resource group within the user's subscription. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of local user. The username must contain lowercase letters and numbers only. It must be unique only within the storage account.
*/
username: pulumi.Input<string>;
}