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

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

Represents a user who has access to one or more shares on the Data Box Edge/Gateway device. Azure REST API version: 2022-03-01. Prior API version in Azure Native 1.x: 2020-12-01.

Other available API versions: 2021-02-01-preview, 2023-01-01-preview, 2023-07-01, 2023-12-01.

Example Usage

UserPut

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var user = new AzureNative.DataBoxEdge.User("user", new()
    {
        DeviceName = "testedgedevice",
        EncryptedPassword = new AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecretArgs
        {
            EncryptionAlgorithm = AzureNative.DataBoxEdge.EncryptionAlgorithm.None,
            EncryptionCertThumbprint = "blah",
            Value = "<value>",
        },
        Name = "user1",
        ResourceGroupName = "GroupForEdgeAutomation",
        UserType = AzureNative.DataBoxEdge.UserType.Share,
    });

});
Copy
package main

import (
	databoxedge "github.com/pulumi/pulumi-azure-native-sdk/databoxedge/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := databoxedge.NewUser(ctx, "user", &databoxedge.UserArgs{
			DeviceName: pulumi.String("testedgedevice"),
			EncryptedPassword: &databoxedge.AsymmetricEncryptedSecretArgs{
				EncryptionAlgorithm:      pulumi.String(databoxedge.EncryptionAlgorithmNone),
				EncryptionCertThumbprint: pulumi.String("blah"),
				Value:                    pulumi.String("<value>"),
			},
			Name:              pulumi.String("user1"),
			ResourceGroupName: pulumi.String("GroupForEdgeAutomation"),
			UserType:          pulumi.String(databoxedge.UserTypeShare),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.databoxedge.User;
import com.pulumi.azurenative.databoxedge.UserArgs;
import com.pulumi.azurenative.databoxedge.inputs.AsymmetricEncryptedSecretArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var user = new User("user", UserArgs.builder()
            .deviceName("testedgedevice")
            .encryptedPassword(AsymmetricEncryptedSecretArgs.builder()
                .encryptionAlgorithm("None")
                .encryptionCertThumbprint("blah")
                .value("<value>")
                .build())
            .name("user1")
            .resourceGroupName("GroupForEdgeAutomation")
            .userType("Share")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const user = new azure_native.databoxedge.User("user", {
    deviceName: "testedgedevice",
    encryptedPassword: {
        encryptionAlgorithm: azure_native.databoxedge.EncryptionAlgorithm.None,
        encryptionCertThumbprint: "blah",
        value: "<value>",
    },
    name: "user1",
    resourceGroupName: "GroupForEdgeAutomation",
    userType: azure_native.databoxedge.UserType.Share,
});
Copy
import pulumi
import pulumi_azure_native as azure_native

user = azure_native.databoxedge.User("user",
    device_name="testedgedevice",
    encrypted_password={
        "encryption_algorithm": azure_native.databoxedge.EncryptionAlgorithm.NONE,
        "encryption_cert_thumbprint": "blah",
        "value": "<value>",
    },
    name="user1",
    resource_group_name="GroupForEdgeAutomation",
    user_type=azure_native.databoxedge.UserType.SHARE)
Copy
resources:
  user:
    type: azure-native:databoxedge:User
    properties:
      deviceName: testedgedevice
      encryptedPassword:
        encryptionAlgorithm: None
        encryptionCertThumbprint: blah
        value: <value>
      name: user1
      resourceGroupName: GroupForEdgeAutomation
      userType: Share
Copy

Create User Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new User(name: string, args: UserArgs, opts?: CustomResourceOptions);
@overload
def User(resource_name: str,
         args: UserArgs,
         opts: Optional[ResourceOptions] = None)

@overload
def User(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         device_name: Optional[str] = None,
         resource_group_name: Optional[str] = None,
         user_type: Optional[Union[str, UserType]] = None,
         encrypted_password: Optional[AsymmetricEncryptedSecretArgs] = None,
         name: Optional[str] = None)
func NewUser(ctx *Context, name string, args UserArgs, opts ...ResourceOption) (*User, error)
public User(string name, UserArgs args, CustomResourceOptions? opts = null)
public User(String name, UserArgs args)
public User(String name, UserArgs args, CustomResourceOptions options)

type: azure-native:databoxedge:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. UserArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var azure_nativeUserResource = new AzureNative.Databoxedge.User("azure-nativeUserResource", new()
{
    DeviceName = "string",
    ResourceGroupName = "string",
    UserType = "string",
    EncryptedPassword = 
    {
        { "encryptionAlgorithm", "string" },
        { "value", "string" },
        { "encryptionCertThumbprint", "string" },
    },
    Name = "string",
});
Copy
example, err := databoxedge.NewUser(ctx, "azure-nativeUserResource", &databoxedge.UserArgs{
	DeviceName:        "string",
	ResourceGroupName: "string",
	UserType:          "string",
	EncryptedPassword: map[string]interface{}{
		"encryptionAlgorithm":      "string",
		"value":                    "string",
		"encryptionCertThumbprint": "string",
	},
	Name: "string",
})
Copy
var azure_nativeUserResource = new User("azure-nativeUserResource", UserArgs.builder()
    .deviceName("string")
    .resourceGroupName("string")
    .userType("string")
    .encryptedPassword(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .name("string")
    .build());
Copy
azure_native_user_resource = azure_native.databoxedge.User("azure-nativeUserResource",
    device_name=string,
    resource_group_name=string,
    user_type=string,
    encrypted_password={
        encryptionAlgorithm: string,
        value: string,
        encryptionCertThumbprint: string,
    },
    name=string)
Copy
const azure_nativeUserResource = new azure_native.databoxedge.User("azure-nativeUserResource", {
    deviceName: "string",
    resourceGroupName: "string",
    userType: "string",
    encryptedPassword: {
        encryptionAlgorithm: "string",
        value: "string",
        encryptionCertThumbprint: "string",
    },
    name: "string",
});
Copy
type: azure-native:databoxedge:User
properties:
    deviceName: string
    encryptedPassword:
        encryptionAlgorithm: string
        encryptionCertThumbprint: string
        value: string
    name: string
    resourceGroupName: string
    userType: string
Copy

User Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The User resource accepts the following input properties:

DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
UserType This property is required. string | Pulumi.AzureNative.DataBoxEdge.UserType
Type of the user.
EncryptedPassword Pulumi.AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecret
The password details.
Name Changes to this property will trigger replacement. string
The user name.
DeviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
UserType This property is required. string | UserType
Type of the user.
EncryptedPassword AsymmetricEncryptedSecretArgs
The password details.
Name Changes to this property will trigger replacement. string
The user name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
userType This property is required. String | UserType
Type of the user.
encryptedPassword AsymmetricEncryptedSecret
The password details.
name Changes to this property will trigger replacement. String
The user name.
deviceName
This property is required.
Changes to this property will trigger replacement.
string
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The resource group name.
userType This property is required. string | UserType
Type of the user.
encryptedPassword AsymmetricEncryptedSecret
The password details.
name Changes to this property will trigger replacement. string
The user name.
device_name
This property is required.
Changes to this property will trigger replacement.
str
The device name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The resource group name.
user_type This property is required. str | UserType
Type of the user.
encrypted_password AsymmetricEncryptedSecretArgs
The password details.
name Changes to this property will trigger replacement. str
The user name.
deviceName
This property is required.
Changes to this property will trigger replacement.
String
The device name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The resource group name.
userType This property is required. String | "Share" | "LocalManagement" | "ARM"
Type of the user.
encryptedPassword Property Map
The password details.
name Changes to this property will trigger replacement. String
The user name.

Outputs

All input properties are implicitly available as output properties. Additionally, the User resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
ShareAccessRights List<Pulumi.AzureNative.DataBoxEdge.Outputs.ShareAccessRightResponse>
List of shares that the user has rights on. This field should not be specified during user creation.
SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of User
Type string
The hierarchical type of the object.
Id string
The provider-assigned unique ID for this managed resource.
ShareAccessRights []ShareAccessRightResponse
List of shares that the user has rights on. This field should not be specified during user creation.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of User
Type string
The hierarchical type of the object.
id String
The provider-assigned unique ID for this managed resource.
shareAccessRights List<ShareAccessRightResponse>
List of shares that the user has rights on. This field should not be specified during user creation.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of User
type String
The hierarchical type of the object.
id string
The provider-assigned unique ID for this managed resource.
shareAccessRights ShareAccessRightResponse[]
List of shares that the user has rights on. This field should not be specified during user creation.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of User
type string
The hierarchical type of the object.
id str
The provider-assigned unique ID for this managed resource.
share_access_rights Sequence[ShareAccessRightResponse]
List of shares that the user has rights on. This field should not be specified during user creation.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of User
type str
The hierarchical type of the object.
id String
The provider-assigned unique ID for this managed resource.
shareAccessRights List<Property Map>
List of shares that the user has rights on. This field should not be specified during user creation.
systemData Property Map
Metadata pertaining to creation and last modification of User
type String
The hierarchical type of the object.

Supporting Types

AsymmetricEncryptedSecret
, AsymmetricEncryptedSecretArgs

EncryptionAlgorithm This property is required. string | Pulumi.AzureNative.DataBoxEdge.EncryptionAlgorithm
The algorithm used to encrypt "Value".
Value This property is required. string
The value of the secret.
EncryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
EncryptionAlgorithm This property is required. string | EncryptionAlgorithm
The algorithm used to encrypt "Value".
Value This property is required. string
The value of the secret.
EncryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. String | EncryptionAlgorithm
The algorithm used to encrypt "Value".
value This property is required. String
The value of the secret.
encryptionCertThumbprint String
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. string | EncryptionAlgorithm
The algorithm used to encrypt "Value".
value This property is required. string
The value of the secret.
encryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryption_algorithm This property is required. str | EncryptionAlgorithm
The algorithm used to encrypt "Value".
value This property is required. str
The value of the secret.
encryption_cert_thumbprint str
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. String | "None" | "AES256" | "RSAES_PKCS1_v_1_5"
The algorithm used to encrypt "Value".
value This property is required. String
The value of the secret.
encryptionCertThumbprint String
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

AsymmetricEncryptedSecretResponse
, AsymmetricEncryptedSecretResponseArgs

EncryptionAlgorithm This property is required. string
The algorithm used to encrypt "Value".
Value This property is required. string
The value of the secret.
EncryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
EncryptionAlgorithm This property is required. string
The algorithm used to encrypt "Value".
Value This property is required. string
The value of the secret.
EncryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. String
The algorithm used to encrypt "Value".
value This property is required. String
The value of the secret.
encryptionCertThumbprint String
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. string
The algorithm used to encrypt "Value".
value This property is required. string
The value of the secret.
encryptionCertThumbprint string
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryption_algorithm This property is required. str
The algorithm used to encrypt "Value".
value This property is required. str
The value of the secret.
encryption_cert_thumbprint str
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
encryptionAlgorithm This property is required. String
The algorithm used to encrypt "Value".
value This property is required. String
The value of the secret.
encryptionCertThumbprint String
Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.

EncryptionAlgorithm
, EncryptionAlgorithmArgs

None
None
AES256
AES256
RSAES_PKCS1_v_1_5
RSAES_PKCS1_v_1_5
EncryptionAlgorithmNone
None
EncryptionAlgorithmAES256
AES256
EncryptionAlgorithm_RSAES_PKCS1_v_1_5
RSAES_PKCS1_v_1_5
None
None
AES256
AES256
RSAES_PKCS1_v_1_5
RSAES_PKCS1_v_1_5
None
None
AES256
AES256
RSAES_PKCS1_v_1_5
RSAES_PKCS1_v_1_5
NONE
None
AES256
AES256
RSAE_S_PKCS1_V_1_5
RSAES_PKCS1_v_1_5
"None"
None
"AES256"
AES256
"RSAES_PKCS1_v_1_5"
RSAES_PKCS1_v_1_5

ShareAccessRightResponse
, ShareAccessRightResponseArgs

AccessType This property is required. string
Type of access to be allowed on the share for this user.
ShareId This property is required. string
The share ID.
AccessType This property is required. string
Type of access to be allowed on the share for this user.
ShareId This property is required. string
The share ID.
accessType This property is required. String
Type of access to be allowed on the share for this user.
shareId This property is required. String
The share ID.
accessType This property is required. string
Type of access to be allowed on the share for this user.
shareId This property is required. string
The share ID.
access_type This property is required. str
Type of access to be allowed on the share for this user.
share_id This property is required. str
The share ID.
accessType This property is required. String
Type of access to be allowed on the share for this user.
shareId This property is required. String
The share ID.

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
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.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
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.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
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.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
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_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
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.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserType
, UserTypeArgs

Share
Share
LocalManagement
LocalManagement
ARM
ARM
UserTypeShare
Share
UserTypeLocalManagement
LocalManagement
UserTypeARM
ARM
Share
Share
LocalManagement
LocalManagement
ARM
ARM
Share
Share
LocalManagement
LocalManagement
ARM
ARM
SHARE
Share
LOCAL_MANAGEMENT
LocalManagement
ARM
ARM
"Share"
Share
"LocalManagement"
LocalManagement
"ARM"
ARM

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:databoxedge:User user1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}
Copy

To learn more about importing existing cloud resources, see Importing resources.

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