Set-AzDataBoxEdgeRole
Updates a Role for a device
Syntax
Set-AzDataBoxEdgeRole
[-ResourceGroupName] <String>
[-DeviceName] <String>
[-Name] <String>
-ShareName <String[]>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzDataBoxEdgeRole
-ResourceId <String>
-ShareName <String[]>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Set-AzDataBoxEdgeRole
-ShareName <String[]>
[-DefaultProfile <IAzureContextContainer>]
-InputObject <PSDataBoxEdgeRole>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Set-AzDataBoxEdgeRole cmdlet updates an IoT role for a Data Box Edge device. The old mounted shares will be replaced with the newly provided ones in the ShareName parameter.
Examples
Example 1
Set-AzDataBoxEdgeRole -ResourceGroupName resourceGroupName -DeviceName deviceName -Name IotRole -ShareName sharename1,sharename2,sharename3
Name IoTHostHub Platform Status IotEdgeDeviceId IotDeviceId ResourceGroupName
---- ---------- -------- ------ --------------- ----------- -----------------
IotRole ehub.azure-devices.net Linux Enabled iotEdgeDeviceUd iotDevice resourceGroupName
Share Names will replace the old mounted shares with the newly provided ones
Example 2
Set-AzDataBoxEdgeRole -ResourceGroupName resourceGroupName -DeviceName deviceName -Name IotRole -ShareName @()
Name IoTHostHub Platform Status IotEdgeDeviceId IotDeviceId ResourceGroupName
---- ---------- -------- ------ --------------- ----------- -----------------
IotRole ehub.azure-devices.net Linux Enabled iotEdgeDeviceUd iotDevice resourceGroupName
To unmount all shares
Parameters
-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: | True |
Accept wildcard characters: | False |
-InputObject
Please provide corresponding device object
Type: | PSDataBoxEdgeRole |
Aliases: | Role |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Name of the Role
Type: | String |
Position: | 2 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceGroupName
Resource Group Name
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ResourceId
Azure ResourceId
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ShareName
Share(s) in a role
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | True |
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 |