1. Packages
  2. Azure Native
  3. API Docs
  4. discovery
  5. getNodePool
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

    Get a NodePool

    Uses Azure REST API version 2026-02-01-preview.

    Using getNodePool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNodePool(args: GetNodePoolArgs, opts?: InvokeOptions): Promise<GetNodePoolResult>
    function getNodePoolOutput(args: GetNodePoolOutputArgs, opts?: InvokeOptions): Output<GetNodePoolResult>
    def get_node_pool(node_pool_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      supercomputer_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetNodePoolResult
    def get_node_pool_output(node_pool_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      supercomputer_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetNodePoolResult]
    func LookupNodePool(ctx *Context, args *LookupNodePoolArgs, opts ...InvokeOption) (*LookupNodePoolResult, error)
    func LookupNodePoolOutput(ctx *Context, args *LookupNodePoolOutputArgs, opts ...InvokeOption) LookupNodePoolResultOutput

    > Note: This function is named LookupNodePool in the Go SDK.

    public static class GetNodePool 
    {
        public static Task<GetNodePoolResult> InvokeAsync(GetNodePoolArgs args, InvokeOptions? opts = null)
        public static Output<GetNodePoolResult> Invoke(GetNodePoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNodePoolResult> getNodePool(GetNodePoolArgs args, InvokeOptions options)
    public static Output<GetNodePoolResult> getNodePool(GetNodePoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:discovery:getNodePool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    NodePoolName string
    The name of the NodePool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SupercomputerName string
    The name of the Supercomputer
    NodePoolName string
    The name of the NodePool
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    SupercomputerName string
    The name of the Supercomputer
    nodePoolName String
    The name of the NodePool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    supercomputerName String
    The name of the Supercomputer
    nodePoolName string
    The name of the NodePool
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    supercomputerName string
    The name of the Supercomputer
    node_pool_name str
    The name of the NodePool
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    supercomputer_name str
    The name of the Supercomputer
    nodePoolName String
    The name of the NodePool
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    supercomputerName String
    The name of the Supercomputer

    getNodePool Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties Pulumi.AzureNative.Discovery.Outputs.NodePoolPropertiesResponse
    The resource-specific properties for this resource.
    SystemData Pulumi.AzureNative.Discovery.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    Properties NodePoolPropertiesResponse
    The resource-specific properties for this resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties NodePoolPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    properties NodePoolPropertiesResponse
    The resource-specific properties for this resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    properties NodePoolPropertiesResponse
    The resource-specific properties for this resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    properties Property Map
    The resource-specific properties for this resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    tags Map<String>
    Resource tags.

    Supporting Types

    NodePoolPropertiesResponse

    MaxNodeCount int
    The maximum number of nodes.
    ProvisioningState string
    The status of the last operation.
    SubnetId string
    The node pool subnet.
    VmSize string
    The size of the underlying Azure VM.
    MinNodeCount int
    The minimum number of nodes.
    ScaleSetPriority string
    The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
    MaxNodeCount int
    The maximum number of nodes.
    ProvisioningState string
    The status of the last operation.
    SubnetId string
    The node pool subnet.
    VmSize string
    The size of the underlying Azure VM.
    MinNodeCount int
    The minimum number of nodes.
    ScaleSetPriority string
    The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
    maxNodeCount Integer
    The maximum number of nodes.
    provisioningState String
    The status of the last operation.
    subnetId String
    The node pool subnet.
    vmSize String
    The size of the underlying Azure VM.
    minNodeCount Integer
    The minimum number of nodes.
    scaleSetPriority String
    The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
    maxNodeCount number
    The maximum number of nodes.
    provisioningState string
    The status of the last operation.
    subnetId string
    The node pool subnet.
    vmSize string
    The size of the underlying Azure VM.
    minNodeCount number
    The minimum number of nodes.
    scaleSetPriority string
    The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
    max_node_count int
    The maximum number of nodes.
    provisioning_state str
    The status of the last operation.
    subnet_id str
    The node pool subnet.
    vm_size str
    The size of the underlying Azure VM.
    min_node_count int
    The minimum number of nodes.
    scale_set_priority str
    The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.
    maxNodeCount Number
    The maximum number of nodes.
    provisioningState String
    The status of the last operation.
    subnetId String
    The node pool subnet.
    vmSize String
    The size of the underlying Azure VM.
    minNodeCount Number
    The minimum number of nodes.
    scaleSetPriority String
    The Virtual Machine Scale Set priority. If not specified, the default is 'Regular'.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.16.0
    published on Friday, Mar 20, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.