New-AzDataBoxEdgeUser
Creates a new user for the device.
Syntax
New-AzDataBoxEdgeUser
[-ResourceGroupName] <String>
[-DeviceName] <String>
[-Name] <String>
-Password <SecureString>
-EncryptionKey <SecureString>
[-AsJob]
[-DefaultProfile <IAzureContextContainer>]
[[-Type] <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzDataBoxEdgeUser cmdlet creates a new user for the Data Box Edge device. Creation of only users of type Share
is supported.
Examples
Example 1
New-AzDataBoxEdgeUser -ResourceGroupName resourceGroupName -DeviceName deviceName -Name username `
-Password password-secured-string -EncryptionKey encryption-key
User name Type ResourceGroupName DeviceName
--------- ---- ----------------- ----------
username Share resourceGroupName deviceName
New-AzDataBoxEdgeUser -ResourceGroupName resourceGroupName -DeviceName deviceName -Name username `
-Password password-secured-string -EncryptionKey encryption-key -Type Share
User name Type ResourceGroupName DeviceName
--------- ---- ----------------- ----------
username Share resourceGroupName deviceName
Parameters
-AsJob
Run cmdlet in the background
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeviceName
Device Name
Type: | String |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-EncryptionKey
Encryption key of the Edge device
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Username
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Password
Password, provide as a secure string
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ResourceGroupName
Resource Group Name
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Type
Select UserType
Type: | String |
Position: | 2 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None