@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.47 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* The local user associated with the storage accounts.
*
* Uses Azure REST API version 2024-01-01. In version 2.x of the Azure Native provider, it used API version 2022-09-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 class LocalUser extends pulumi.CustomResource {
/**
* Get an existing LocalUser resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): LocalUser;
/**
* Returns true if the given object is an instance of LocalUser. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is LocalUser;
/**
* Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
*/
readonly allowAclAuthorization: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
*/
readonly extendedGroups: pulumi.Output<number[] | undefined>;
/**
* An identifier for associating a group of users.
*/
readonly groupId: pulumi.Output<number | undefined>;
/**
* Indicates whether shared key exists. Set it to false to remove existing shared key.
*/
readonly hasSharedKey: pulumi.Output<boolean | undefined>;
/**
* Indicates whether ssh key exists. Set it to false to remove existing SSH key.
*/
readonly hasSshKey: pulumi.Output<boolean | undefined>;
/**
* Indicates whether ssh password exists. Set it to false to remove existing SSH password.
*/
readonly hasSshPassword: pulumi.Output<boolean | undefined>;
/**
* Optional, local user home directory.
*/
readonly homeDirectory: pulumi.Output<string | undefined>;
/**
* Indicates if the local user is enabled for access with NFSv3 protocol.
*/
readonly isNFSv3Enabled: pulumi.Output<boolean | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The permission scopes of the local user.
*/
readonly permissionScopes: pulumi.Output<outputs.storage.PermissionScopeResponse[] | undefined>;
/**
* A unique Security Identifier that is generated by the server.
*/
readonly sid: pulumi.Output<string>;
/**
* Optional, local user ssh authorized keys for SFTP.
*/
readonly sshAuthorizedKeys: pulumi.Output<outputs.storage.SshPublicKeyResponse[] | undefined>;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: pulumi.Output<outputs.storage.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* A unique Identifier that is generated by the server.
*/
readonly userId: pulumi.Output<number>;
/**
* Create a LocalUser resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: LocalUserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a LocalUser resource.
*/
export interface LocalUserArgs {
/**
* 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>;
/**
* Indicates whether ACL authorization is allowed for this user. Set it to false to disallow using ACL authorization.
*/
allowAclAuthorization?: pulumi.Input<boolean>;
/**
* Supplementary group membership. Only applicable for local users enabled for NFSv3 access.
*/
extendedGroups?: pulumi.Input<pulumi.Input<number>[]>;
/**
* An identifier for associating a group of users.
*/
groupId?: pulumi.Input<number>;
/**
* Indicates whether shared key exists. Set it to false to remove existing shared key.
*/
hasSharedKey?: pulumi.Input<boolean>;
/**
* Indicates whether ssh key exists. Set it to false to remove existing SSH key.
*/
hasSshKey?: pulumi.Input<boolean>;
/**
* Indicates whether ssh password exists. Set it to false to remove existing SSH password.
*/
hasSshPassword?: pulumi.Input<boolean>;
/**
* Optional, local user home directory.
*/
homeDirectory?: pulumi.Input<string>;
/**
* Indicates if the local user is enabled for access with NFSv3 protocol.
*/
isNFSv3Enabled?: pulumi.Input<boolean>;
/**
* The permission scopes of the local user.
*/
permissionScopes?: pulumi.Input<pulumi.Input<inputs.storage.PermissionScopeArgs>[]>;
/**
* The name of the resource group within the user's subscription. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Optional, local user ssh authorized keys for SFTP.
*/
sshAuthorizedKeys?: pulumi.Input<pulumi.Input<inputs.storage.SshPublicKeyArgs>[]>;
/**
* 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>;
}