< Back
Set-AzureBatchComputeNodeUser
Post
NAME Set-AzureBatchComputeNodeUser
SYNOPSIS
Modifies properties of an account on a Batch compute node.
SYNTAX
Set-AzureBatchComputeNodeUser [-PoolId] <String> [-ComputeNodeId] <String> [-Name] <String> [-Password] <SecureString> -BatchContext
<BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-ExpiryTime <DateTime>] [<CommonParameters>]
DESCRIPTION
The Set-AzureBatchComputeNodeUser cmdlet modifies properties of a user account on an Azure Batch compute node.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys
populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the
BatchAccountContext.KeyInUse property.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ComputeNodeId <String>
Specifies the ID of the compute node on which this cmdlet operates.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpiryTime <DateTime>
Specifies the expiry time for the user account.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the user account that this cmdlet modifies.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Password <SecureString>
Specifies the password for the user account.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PoolId <String>
Specifies the ID of the pool that contains the compute node on which this cmdlet operates.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
OUTPUTS
NOTES
Example 1: Update a user account
PS C:\\>Set-AzureBatchComputeNodeUser -PoolId "ContosoPool" -ComputeNodeId "tvm-3257026573_1-20150904t230807z" -Name "PFuller" -BatchContext
$Context -Password "Password" -ExpiryTime ([DateTime]::Now.AddDays(14))
This command modifies user account named PFuller on the compute node that has the specified ID in the pool named ContosoPool. The command changes
the account password and expiry time.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tenodeuser
Get-AzureRmBatchAccountKeys
New-AzureBatchComputeNodeUser
Remove-AzureBatchComputeNodeUser
Azure Batch Cmdlets
SYNOPSIS
Modifies properties of an account on a Batch compute node.
SYNTAX
Set-AzureBatchComputeNodeUser [-PoolId] <String> [-ComputeNodeId] <String> [-Name] <String> [-Password] <SecureString> -BatchContext
<BatchAccountContext> [-DefaultProfile <IAzureContextContainer>] [-ExpiryTime <DateTime>] [<CommonParameters>]
DESCRIPTION
The Set-AzureBatchComputeNodeUser cmdlet modifies properties of a user account on an Azure Batch compute node.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. If you use the Get-AzureRmBatchAccount
cmdlet to get your BatchAccountContext, then Azure Active Directory authentication will be used when interacting with the Batch service. To
use shared key authentication instead, use the Get-AzureRmBatchAccountKeys cmdlet to get a BatchAccountContext object with its access keys
populated. When using shared key authentication, the primary access key is used by default. To change the key to use, set the
BatchAccountContext.KeyInUse property.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ComputeNodeId <String>
Specifies the ID of the compute node on which this cmdlet operates.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpiryTime <DateTime>
Specifies the expiry time for the user account.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name of the user account that this cmdlet modifies.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Password <SecureString>
Specifies the password for the user account.
Required? true
Position? 3
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-PoolId <String>
Specifies the ID of the pool that contains the compute node on which this cmdlet operates.
Required? true
Position? 0
Default value None
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
BatchAccountContext
Parameter 'BatchContext' accepts value of type 'BatchAccountContext' from the pipeline
OUTPUTS
NOTES
Example 1: Update a user account
PS C:\\>Set-AzureBatchComputeNodeUser -PoolId "ContosoPool" -ComputeNodeId "tvm-3257026573_1-20150904t230807z" -Name "PFuller" -BatchContext
$Context -Password "Password" -ExpiryTime ([DateTime]::Now.AddDays(14))
This command modifies user account named PFuller on the compute node that has the specified ID in the pool named ContosoPool. The command changes
the account password and expiry time.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... tenodeuser
Get-AzureRmBatchAccountKeys
New-AzureBatchComputeNodeUser
Remove-AzureBatchComputeNodeUser
Azure Batch Cmdlets