< Back
Get-AzureBatchRemoteLoginSettings
Post
NAME Get-AzureBatchRemoteLoginSettings
SYNOPSIS
Gets remote logon settings for a compute node.
SYNTAX
Get-AzureBatchRemoteLoginSettings [[-ComputeNode] <PSComputeNode>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureBatchRemoteLoginSettings [-PoolId] <String> [-ComputeNodeId] <String> -BatchContext <BatchAccountContext> [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureBatchRemoteLoginSettings cmdlet gets remote logon settings for a compute node in a virtual machines infrastructure-based pool.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext that
contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ComputeNode <PSComputeNode>
Specifies a compute node, as a PSComputeNode object, for which this cmdlet gets remote logon settings. To obtain a compute node object, use
the Get-AzureBatchComputeNode cmdlet.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ComputeNodeId <String>
Specifies the ID of the compute node for which to get the remote logon settings. for which this cmdlet gets remote logon settings.
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
-PoolId <String>
Specifies the ID of the pool that contains the virtual machine.
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
PSComputeNode
Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline
OUTPUTS
PSRemoteLoginSettings
NOTES
Example 1: Get remote logon settings for all nodes in a pool
PS C:\\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount"
PS C:\\> Get-AzureBatchComputeNode -PoolId "ContosoPool" -BatchContext $Context | Get-AzureBatchRemoteLoginSettings -BatchContext $Context
IPAddress Port
--------- ----
10.214.75.221 50002
10.214.75.221 50001
10.214.75.221 50000
The first command gets a batch account context that contains access keys for your subscription by using Get-AzureRmBatchAccountKeys . The command
stores the context in the $Context variable to use in the next command.
The second command gets each compute node in the pool that has the ID ContosoPool by using Get-AzureBatchComputeNode . The command passes each
computer node to the current cmdlet by using the pipeline operator. The command gets the remote logon settings for each compute node.
Example 2: Get remote logon settings for a node
PS C:\\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount"
PS C:\\> Get-AzureBatchRemoteLoginSettings -PoolId "ContosoPool" -ComputeNodeId "tvm-1900272697_1-20150330t205553z" -BatchContext $Context
IPAddress Port
--------- ----
10.214.75.221 50000
The first command gets a batch account context that contains access keys for your subscription, and then stores it in the $Context variable.
The second command gets the remote logon settings for the compute node that has the specified ID in the pool that has the ID ContosoPool.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... insettings
Get-AzureRmBatchAccountKeys
Get-AzureBatchComputeNode
Get-AzureBatchRemoteDesktopProtocolFile
Azure Batch Cmdlets
SYNOPSIS
Gets remote logon settings for a compute node.
SYNTAX
Get-AzureBatchRemoteLoginSettings [[-ComputeNode] <PSComputeNode>] -BatchContext <BatchAccountContext> [-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Get-AzureBatchRemoteLoginSettings [-PoolId] <String> [-ComputeNodeId] <String> -BatchContext <BatchAccountContext> [-DefaultProfile
<IAzureContextContainer>] [<CommonParameters>]
DESCRIPTION
The Get-AzureBatchRemoteLoginSettings cmdlet gets remote logon settings for a compute node in a virtual machines infrastructure-based pool.
PARAMETERS
-BatchContext <BatchAccountContext>
Specifies the BatchAccountContext instance that this cmdlet uses to interact with the Batch service. To obtain a BatchAccountContext that
contains access keys for your subscription, use the Get-AzureRmBatchAccountKeys cmdlet.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ComputeNode <PSComputeNode>
Specifies a compute node, as a PSComputeNode object, for which this cmdlet gets remote logon settings. To obtain a compute node object, use
the Get-AzureBatchComputeNode cmdlet.
Required? false
Position? 0
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-ComputeNodeId <String>
Specifies the ID of the compute node for which to get the remote logon settings. for which this cmdlet gets remote logon settings.
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
-PoolId <String>
Specifies the ID of the pool that contains the virtual machine.
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
PSComputeNode
Parameter 'ComputeNode' accepts value of type 'PSComputeNode' from the pipeline
OUTPUTS
PSRemoteLoginSettings
NOTES
Example 1: Get remote logon settings for all nodes in a pool
PS C:\\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount"
PS C:\\> Get-AzureBatchComputeNode -PoolId "ContosoPool" -BatchContext $Context | Get-AzureBatchRemoteLoginSettings -BatchContext $Context
IPAddress Port
--------- ----
10.214.75.221 50002
10.214.75.221 50001
10.214.75.221 50000
The first command gets a batch account context that contains access keys for your subscription by using Get-AzureRmBatchAccountKeys . The command
stores the context in the $Context variable to use in the next command.
The second command gets each compute node in the pool that has the ID ContosoPool by using Get-AzureBatchComputeNode . The command passes each
computer node to the current cmdlet by using the pipeline operator. The command gets the remote logon settings for each compute node.
Example 2: Get remote logon settings for a node
PS C:\\>$Context = Get-AzureRmBatchAccountKeys -AccountName "ContosoBatchAccount"
PS C:\\> Get-AzureBatchRemoteLoginSettings -PoolId "ContosoPool" -ComputeNodeId "tvm-1900272697_1-20150330t205553z" -BatchContext $Context
IPAddress Port
--------- ----
10.214.75.221 50000
The first command gets a batch account context that contains access keys for your subscription, and then stores it in the $Context variable.
The second command gets the remote logon settings for the compute node that has the specified ID in the pool that has the ID ContosoPool.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... insettings
Get-AzureRmBatchAccountKeys
Get-AzureBatchComputeNode
Get-AzureBatchRemoteDesktopProtocolFile
Azure Batch Cmdlets