Get-AzBatchComputeNodeExtension
Gets Batch compute node extensions from a compute node.
Syntax
Id (Default)
Get-AzBatchComputeNodeExtension
[-PoolId] <String>
[-ComputeNodeId] <String>
[[-Name] <String>]
-BatchContext <BatchAccountContext>
[-Select <String>]
[-MaxCount <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
ParentObject
Get-AzBatchComputeNodeExtension
[-Pool] <PSCloudPool>
[-ComputeNodeId] <String>
[[-Name] <String>]
-BatchContext <BatchAccountContext>
[-Select <String>]
[-MaxCount <Int32>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
If an extension name is provided, a single extension with a matching name is returned from the provided compute node (if found). Otherwise, all extensions on teh compute node is returned. Further extension details can be found on the extension's VmExtension Property.
Examples
Example 1 Get all extensions from a compute node.
Get-AzBatchComputeNodeExtension "testPool" "testNode" -BatchContext $context
InstanceView ProvisioningState VmExtension
------------ ----------------- -----------
Microsoft.Azure.Commands.Batch.Models.PSVMExtensionInstanceView Succeeded Microsoft.Azure.Commands.Batch.Models.PSVMExtension
Microsoft.Azure.Commands.Batch.Models.PSVMExtensionInstanceView Failed Microsoft.Azure.Commands.Batch.Models.PSVMExtension
Example 2 Get a specific extension from a compute node.
Get-AzBatchComputeNodeExtension "testPool" "testNode" "secretext" -BatchContext $context
InstanceView ProvisioningState VmExtension
------------ ----------------- -----------
Microsoft.Azure.Commands.Batch.Models.PSVMExtensionInstanceView Failed Microsoft.Azure.Commands.Batch.Models.PSVMExtension
Parameters
-BatchContext
The BatchAccountContext instance to use when interacting with the Batch service.
If you use the Get-AzBatchAccount cmdlet to get your BatchAccountContext, then Microsoft Entra authentication will be used when interacting with the Batch service.
To use shared key authentication instead, use the Get-AzBatchAccountKeys 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.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ComputeNodeId
The id of the compute node to which the extension belongs.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 1 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MaxCount
Specifies the maximum number of compute node extensions to return.
Parameter properties
Type: Int32
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the extension to get.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: 2 Mandatory: False Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Pool
The pool to which the extension's compute node belongs.
Parameter properties
Type: PSCloudPool
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ParentObject
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-PoolId
The id of the pool to which the extension's compute node belongs.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
Id
Position: 0 Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Select
Specifies an OData select clause.
Specify a value for this parameter to get specific properties rather than all object properties.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
