azure-native.databoxedge.User
Explore with Pulumi AI
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: 2019-07-01, 2019-08-01, 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,
});
});
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
})
}
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());
}
}
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)
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,
});
resources:
user:
type: azure-native:databoxedge:User
properties:
deviceName: testedgedevice
encryptedPassword:
encryptionAlgorithm: None
encryptionCertThumbprint: blah
value: <value>
name: user1
resourceGroupName: GroupForEdgeAutomation
userType: Share
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)
type: azure-native:databoxedge:User
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args UserArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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 = new AzureNative.DataBoxEdge.Inputs.AsymmetricEncryptedSecretArgs
{
EncryptionAlgorithm = "string",
Value = "string",
EncryptionCertThumbprint = "string",
},
Name = "string",
});
example, err := databoxedge.NewUser(ctx, "azure-nativeUserResource", &databoxedge.UserArgs{
DeviceName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
UserType: pulumi.String("string"),
EncryptedPassword: &databoxedge.AsymmetricEncryptedSecretArgs{
EncryptionAlgorithm: pulumi.String("string"),
Value: pulumi.String("string"),
EncryptionCertThumbprint: pulumi.String("string"),
},
Name: pulumi.String("string"),
})
var azure_nativeUserResource = new User("azure-nativeUserResource", UserArgs.builder()
.deviceName("string")
.resourceGroupName("string")
.userType("string")
.encryptedPassword(AsymmetricEncryptedSecretArgs.builder()
.encryptionAlgorithm("string")
.value("string")
.encryptionCertThumbprint("string")
.build())
.name("string")
.build());
azure_native_user_resource = azure_native.databoxedge.User("azure-nativeUserResource",
device_name="string",
resource_group_name="string",
user_type="string",
encrypted_password={
"encryption_algorithm": "string",
"value": "string",
"encryption_cert_thumbprint": "string",
},
name="string")
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",
});
type: azure-native:databoxedge:User
properties:
deviceName: string
encryptedPassword:
encryptionAlgorithm: string
encryptionCertThumbprint: string
value: string
name: string
resourceGroupName: string
userType: string
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:
- Device
Name string - The device name.
- Resource
Group stringName - The resource group name.
- User
Type string | Pulumi.Azure Native. Data Box Edge. User Type - Type of the user.
- Encrypted
Password Pulumi.Azure Native. Data Box Edge. Inputs. Asymmetric Encrypted Secret - The password details.
- Name string
- The user name.
- Device
Name string - The device name.
- Resource
Group stringName - The resource group name.
- User
Type string | UserType - Type of the user.
- Encrypted
Password AsymmetricEncrypted Secret Args - The password details.
- Name string
- The user name.
- device
Name String - The device name.
- resource
Group StringName - The resource group name.
- user
Type String | UserType - Type of the user.
- encrypted
Password AsymmetricEncrypted Secret - The password details.
- name String
- The user name.
- device
Name string - The device name.
- resource
Group stringName - The resource group name.
- user
Type string | UserType - Type of the user.
- encrypted
Password AsymmetricEncrypted Secret - The password details.
- name string
- The user name.
- device_
name str - The device name.
- resource_
group_ strname - The resource group name.
- user_
type str | UserType - Type of the user.
- encrypted_
password AsymmetricEncrypted Secret Args - The password details.
- name str
- The user name.
- device
Name String - The device name.
- resource
Group StringName - The resource group name.
- user
Type String | "Share" | "LocalManagement" | "ARM" - Type of the user.
- encrypted
Password Property Map - The password details.
- name 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.
- List<Pulumi.
Azure Native. Data Box Edge. Outputs. Share Access Right Response> - List of shares that the user has rights on. This field should not be specified during user creation.
- System
Data Pulumi.Azure Native. Data Box Edge. Outputs. System Data Response - 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.
- []Share
Access Right Response - List of shares that the user has rights on. This field should not be specified during user creation.
- System
Data SystemData Response - 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.
- List<Share
Access Right Response> - List of shares that the user has rights on. This field should not be specified during user creation.
- system
Data SystemData Response - 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.
- Share
Access Right Response[] - List of shares that the user has rights on. This field should not be specified during user creation.
- system
Data SystemData Response - 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.
- Sequence[Share
Access Right Response] - List of shares that the user has rights on. This field should not be specified during user creation.
- system_
data SystemData Response - 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.
- List<Property Map>
- List of shares that the user has rights on. This field should not be specified during user creation.
- system
Data Property Map - Metadata pertaining to creation and last modification of User
- type String
- The hierarchical type of the object.
Supporting Types
AsymmetricEncryptedSecret, AsymmetricEncryptedSecretArgs
- Encryption
Algorithm string | Pulumi.Azure Native. Data Box Edge. Encryption Algorithm - The algorithm used to encrypt "Value".
- Value string
- The value of the secret.
- Encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- Encryption
Algorithm string | EncryptionAlgorithm - The algorithm used to encrypt "Value".
- Value string
- The value of the secret.
- Encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm String | EncryptionAlgorithm - The algorithm used to encrypt "Value".
- value String
- The value of the secret.
- encryption
Cert StringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm string | EncryptionAlgorithm - The algorithm used to encrypt "Value".
- value string
- The value of the secret.
- encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption_
algorithm str | EncryptionAlgorithm - The algorithm used to encrypt "Value".
- value str
- The value of the secret.
- encryption_
cert_ strthumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm String | "None" | "AES256" | "RSAES_PKCS1_v_1_5" - The algorithm used to encrypt "Value".
- value String
- The value of the secret.
- encryption
Cert StringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
AsymmetricEncryptedSecretResponse, AsymmetricEncryptedSecretResponseArgs
- Encryption
Algorithm string - The algorithm used to encrypt "Value".
- Value string
- The value of the secret.
- Encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- Encryption
Algorithm string - The algorithm used to encrypt "Value".
- Value string
- The value of the secret.
- Encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm String - The algorithm used to encrypt "Value".
- value String
- The value of the secret.
- encryption
Cert StringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm string - The algorithm used to encrypt "Value".
- value string
- The value of the secret.
- encryption
Cert stringThumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption_
algorithm str - The algorithm used to encrypt "Value".
- value str
- The value of the secret.
- encryption_
cert_ strthumbprint - Thumbprint certificate used to encrypt "Value". If the value is unencrypted, it will be null.
- encryption
Algorithm String - The algorithm used to encrypt "Value".
- value String
- The value of the secret.
- encryption
Cert StringThumbprint - 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
- Encryption
Algorithm None - None
- Encryption
Algorithm AES256 - AES256
- Encryption
Algorithm_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
- Access
Type string - Type of access to be allowed on the share for this user.
- string
- The share ID.
- Access
Type string - Type of access to be allowed on the share for this user.
- string
- The share ID.
- access
Type String - Type of access to be allowed on the share for this user.
- String
- The share ID.
- access
Type string - Type of access to be allowed on the share for this user.
- string
- The share ID.
- access_
type str - Type of access to be allowed on the share for this user.
- str
- The share ID.
- access
Type String - Type of access to be allowed on the share for this user.
- String
- The share ID.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UserType, UserTypeArgs
- Share
- Share
- Local
Management - LocalManagement
- ARM
- ARM
- User
Type Share - Share
- User
Type Local Management - LocalManagement
- User
Type ARM - ARM
- Share
- Share
- Local
Management - LocalManagement
- ARM
- ARM
- Share
- Share
- Local
Management - LocalManagement
- ARM
- ARM
- SHARE
- Share
- LOCAL_MANAGEMENT
- LocalManagement
- ARM
- ARM
- "Share"
- Share
- "Local
Management" - 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}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0