Azure Native v3.0.1, Apr 7 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.networkcloud.getAgentPool

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

Using getAgentPool

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.

TypeScript
Python
Go
C#
Java
YAML

function getAgentPool(args: GetAgentPoolArgs, opts?: InvokeOptions): Promise<GetAgentPoolResult>
function getAgentPoolOutput(args: GetAgentPoolOutputArgs, opts?: InvokeOptions): Output<GetAgentPoolResult>

def get_agent_pool(agent_pool_name: Optional[str] = None,
                   kubernetes_cluster_name: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetAgentPoolResult
def get_agent_pool_output(agent_pool_name: Optional[pulumi.Input[str]] = None,
                   kubernetes_cluster_name: Optional[pulumi.Input[str]] = None,
                   resource_group_name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetAgentPoolResult]

func LookupAgentPool(ctx *Context, args *LookupAgentPoolArgs, opts ...InvokeOption) (*LookupAgentPoolResult, error)
func LookupAgentPoolOutput(ctx *Context, args *LookupAgentPoolOutputArgs, opts ...InvokeOption) LookupAgentPoolResultOutput

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

public static class GetAgentPool 
{
    public static Task<GetAgentPoolResult> InvokeAsync(GetAgentPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentPoolResult> Invoke(GetAgentPoolInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAgentPoolResult> getAgentPool(GetAgentPoolArgs args, InvokeOptions options)
public static Output<GetAgentPoolResult> getAgentPool(GetAgentPoolArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:networkcloud:getAgentPool
  arguments:
    # arguments dictionary

The following arguments are supported:

AgentPoolName string: The name of the Kubernetes cluster agent pool.
KubernetesClusterName string: The name of the Kubernetes cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

AgentPoolName string: The name of the Kubernetes cluster agent pool.
KubernetesClusterName string: The name of the Kubernetes cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

agentPoolName String: The name of the Kubernetes cluster agent pool.
kubernetesClusterName String: The name of the Kubernetes cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.

agentPoolName string: The name of the Kubernetes cluster agent pool.
kubernetesClusterName string: The name of the Kubernetes cluster.
resourceGroupName string: The name of the resource group. The name is case insensitive.

agent_pool_name str: The name of the Kubernetes cluster agent pool.
kubernetes_cluster_name str: The name of the Kubernetes cluster.
resource_group_name str: The name of the resource group. The name is case insensitive.

agentPoolName String: The name of the Kubernetes cluster agent pool.
kubernetesClusterName String: The name of the Kubernetes cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getAgentPool Result

The following output properties are available:

AzureApiVersion string: The Azure API version of the resource.
Count double: The number of virtual machines that use this configuration.
DetailedStatus string: The current status of the agent pool.
DetailedStatusMessage string: The descriptive message about the current detailed status.
Etag string: Resource ETag.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
KubernetesVersion string: The Kubernetes version running in this agent pool.
Location string: The geo-location where the resource lives
Mode string: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
Name string: The name of the resource
ProvisioningState string: The provisioning state of the agent pool.
SystemData Pulumi.AzureNative.NetworkCloud.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"
VmSkuName string: The name of the VM SKU that determines the size of resources allocated for node VMs.
AdministratorConfiguration Pulumi.AzureNative.NetworkCloud.Outputs.AdministratorConfigurationResponse: The administrator credentials to be used for the nodes in this agent pool.
AgentOptions Pulumi.AzureNative.NetworkCloud.Outputs.AgentOptionsResponse: The configurations that will be applied to each agent in this agent pool.
AttachedNetworkConfiguration Pulumi.AzureNative.NetworkCloud.Outputs.AttachedNetworkConfigurationResponse: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
AvailabilityZones List<string>: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
ExtendedLocation Pulumi.AzureNative.NetworkCloud.Outputs.ExtendedLocationResponse: The extended location of the cluster associated with the resource.
Labels List<Pulumi.AzureNative.NetworkCloud.Outputs.KubernetesLabelResponse>: The labels applied to the nodes in this agent pool.
Tags Dictionary<string, string>: Resource tags.
Taints List<Pulumi.AzureNative.NetworkCloud.Outputs.KubernetesLabelResponse>: The taints applied to the nodes in this agent pool.
UpgradeSettings Pulumi.AzureNative.NetworkCloud.Outputs.AgentPoolUpgradeSettingsResponse: The configuration of the agent pool.

AzureApiVersion string: The Azure API version of the resource.
Count float64: The number of virtual machines that use this configuration.
DetailedStatus string: The current status of the agent pool.
DetailedStatusMessage string: The descriptive message about the current detailed status.
Etag string: Resource ETag.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
KubernetesVersion string: The Kubernetes version running in this agent pool.
Location string: The geo-location where the resource lives
Mode string: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
Name string: The name of the resource
ProvisioningState string: The provisioning state of the agent pool.
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"
VmSkuName string: The name of the VM SKU that determines the size of resources allocated for node VMs.
AdministratorConfiguration AdministratorConfigurationResponse: The administrator credentials to be used for the nodes in this agent pool.
AgentOptions AgentOptionsResponse: The configurations that will be applied to each agent in this agent pool.
AttachedNetworkConfiguration AttachedNetworkConfigurationResponse: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
AvailabilityZones []string: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
ExtendedLocation ExtendedLocationResponse: The extended location of the cluster associated with the resource.
Labels []KubernetesLabelResponse: The labels applied to the nodes in this agent pool.
Tags map[string]string: Resource tags.
Taints []KubernetesLabelResponse: The taints applied to the nodes in this agent pool.
UpgradeSettings AgentPoolUpgradeSettingsResponse: The configuration of the agent pool.

azureApiVersion String: The Azure API version of the resource.
count Double: The number of virtual machines that use this configuration.
detailedStatus String: The current status of the agent pool.
detailedStatusMessage String: The descriptive message about the current detailed status.
etag String: Resource ETag.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kubernetesVersion String: The Kubernetes version running in this agent pool.
location String: The geo-location where the resource lives
mode String: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
name String: The name of the resource
provisioningState String: The provisioning state of the agent pool.
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"
vmSkuName String: The name of the VM SKU that determines the size of resources allocated for node VMs.
administratorConfiguration AdministratorConfigurationResponse: The administrator credentials to be used for the nodes in this agent pool.
agentOptions AgentOptionsResponse: The configurations that will be applied to each agent in this agent pool.
attachedNetworkConfiguration AttachedNetworkConfigurationResponse: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
availabilityZones List<String>: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
extendedLocation ExtendedLocationResponse: The extended location of the cluster associated with the resource.
labels List<KubernetesLabelResponse>: The labels applied to the nodes in this agent pool.
tags Map<String,String>: Resource tags.
taints List<KubernetesLabelResponse>: The taints applied to the nodes in this agent pool.
upgradeSettings AgentPoolUpgradeSettingsResponse: The configuration of the agent pool.

azureApiVersion string: The Azure API version of the resource.
count number: The number of virtual machines that use this configuration.
detailedStatus string: The current status of the agent pool.
detailedStatusMessage string: The descriptive message about the current detailed status.
etag string: Resource ETag.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kubernetesVersion string: The Kubernetes version running in this agent pool.
location string: The geo-location where the resource lives
mode string: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
name string: The name of the resource
provisioningState string: The provisioning state of the agent pool.
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"
vmSkuName string: The name of the VM SKU that determines the size of resources allocated for node VMs.
administratorConfiguration AdministratorConfigurationResponse: The administrator credentials to be used for the nodes in this agent pool.
agentOptions AgentOptionsResponse: The configurations that will be applied to each agent in this agent pool.
attachedNetworkConfiguration AttachedNetworkConfigurationResponse: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
availabilityZones string[]: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
extendedLocation ExtendedLocationResponse: The extended location of the cluster associated with the resource.
labels KubernetesLabelResponse[]: The labels applied to the nodes in this agent pool.
tags {[key: string]: string}: Resource tags.
taints KubernetesLabelResponse[]: The taints applied to the nodes in this agent pool.
upgradeSettings AgentPoolUpgradeSettingsResponse: The configuration of the agent pool.

azure_api_version str: The Azure API version of the resource.
count float: The number of virtual machines that use this configuration.
detailed_status str: The current status of the agent pool.
detailed_status_message str: The descriptive message about the current detailed status.
etag str: Resource ETag.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kubernetes_version str: The Kubernetes version running in this agent pool.
location str: The geo-location where the resource lives
mode str: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
name str: The name of the resource
provisioning_state str: The provisioning state of the agent pool.
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"
vm_sku_name str: The name of the VM SKU that determines the size of resources allocated for node VMs.
administrator_configuration AdministratorConfigurationResponse: The administrator credentials to be used for the nodes in this agent pool.
agent_options AgentOptionsResponse: The configurations that will be applied to each agent in this agent pool.
attached_network_configuration AttachedNetworkConfigurationResponse: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
availability_zones Sequence[str]: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
extended_location ExtendedLocationResponse: The extended location of the cluster associated with the resource.
labels Sequence[KubernetesLabelResponse]: The labels applied to the nodes in this agent pool.
tags Mapping[str, str]: Resource tags.
taints Sequence[KubernetesLabelResponse]: The taints applied to the nodes in this agent pool.
upgrade_settings AgentPoolUpgradeSettingsResponse: The configuration of the agent pool.

azureApiVersion String: The Azure API version of the resource.
count Number: The number of virtual machines that use this configuration.
detailedStatus String: The current status of the agent pool.
detailedStatusMessage String: The descriptive message about the current detailed status.
etag String: Resource ETag.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
kubernetesVersion String: The Kubernetes version running in this agent pool.
location String: The geo-location where the resource lives
mode String: The selection of how this agent pool is utilized, either as a system pool or a user pool. System pools run the features and critical services for the Kubernetes Cluster, while user pools are dedicated to user workloads. Every Kubernetes cluster must contain at least one system node pool with at least one node.
name String: The name of the resource
provisioningState String: The provisioning state of the agent pool.
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"
vmSkuName String: The name of the VM SKU that determines the size of resources allocated for node VMs.
administratorConfiguration Property Map: The administrator credentials to be used for the nodes in this agent pool.
agentOptions Property Map: The configurations that will be applied to each agent in this agent pool.
attachedNetworkConfiguration Property Map: The configuration of networks being attached to the agent pool for use by the workloads that run on this Kubernetes cluster.
availabilityZones List<String>: The list of availability zones of the Network Cloud cluster used for the provisioning of nodes in this agent pool. If not specified, all availability zones will be used.
extendedLocation Property Map: The extended location of the cluster associated with the resource.
labels List<Property Map>: The labels applied to the nodes in this agent pool.
tags Map<String>: Resource tags.
taints List<Property Map>: The taints applied to the nodes in this agent pool.
upgradeSettings Property Map: The configuration of the agent pool.

Supporting Types

AdministratorConfigurationResponse

AdminUsername string: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
SshPublicKeys List<Pulumi.AzureNative.NetworkCloud.Inputs.SshPublicKeyResponse>: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.

AdminUsername string: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
SshPublicKeys []SshPublicKeyResponse: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.

adminUsername String: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
sshPublicKeys List<SshPublicKeyResponse>: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.

adminUsername string: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
sshPublicKeys SshPublicKeyResponse[]: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.

admin_username str: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
ssh_public_keys Sequence[SshPublicKeyResponse]: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.

adminUsername String: The user name for the administrator that will be applied to the operating systems that run Kubernetes nodes. If not supplied, a user name will be chosen by the service.
sshPublicKeys List<Property Map>: The SSH configuration for the operating systems that run the nodes in the Kubernetes cluster. In some cases, specification of public keys may be required to produce a working environment.

AgentOptionsResponse

HugepagesCount double: The number of hugepages to allocate.
HugepagesSize string: The size of the hugepages to allocate.

HugepagesCount float64: The number of hugepages to allocate.
HugepagesSize string: The size of the hugepages to allocate.

hugepagesCount Double: The number of hugepages to allocate.
hugepagesSize String: The size of the hugepages to allocate.

hugepagesCount number: The number of hugepages to allocate.
hugepagesSize string: The size of the hugepages to allocate.

hugepages_count float: The number of hugepages to allocate.
hugepages_size str: The size of the hugepages to allocate.

hugepagesCount Number: The number of hugepages to allocate.
hugepagesSize String: The size of the hugepages to allocate.

AgentPoolUpgradeSettingsResponse

DrainTimeout double: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.
MaxSurge string: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.
MaxUnavailable string: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.

DrainTimeout float64: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.
MaxSurge string: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.
MaxUnavailable string: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.

drainTimeout Double: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.
maxSurge String: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.
maxUnavailable String: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.

drainTimeout number: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.
maxSurge string: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.
maxUnavailable string: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.

drain_timeout float: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.
max_surge str: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.
max_unavailable str: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.

drainTimeout Number: The maximum time in seconds that is allowed for a node drain to complete before proceeding with the upgrade of the agent pool. If not specified during creation, a value of 1800 seconds is used.
maxSurge String: The maximum number or percentage of nodes that are surged during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 1 is used. One of MaxSurge and MaxUnavailable must be greater than 0.
maxUnavailable String: The maximum number or percentage of nodes that can be unavailable during upgrade. This can either be set to an integer (e.g. '5') or a percentage (e.g. '50%'). If a percentage is specified, it is the percentage of the total agent pool size at the time of the upgrade. For percentages, fractional nodes are rounded up. If not specified during creation, a value of 0 is used. One of MaxSurge and MaxUnavailable must be greater than 0.

AttachedNetworkConfigurationResponse

L2Networks List<Pulumi.AzureNative.NetworkCloud.Inputs.L2NetworkAttachmentConfigurationResponse>: The list of Layer 2 Networks and related configuration for attachment.
L3Networks List<Pulumi.AzureNative.NetworkCloud.Inputs.L3NetworkAttachmentConfigurationResponse>: The list of Layer 3 Networks and related configuration for attachment.
TrunkedNetworks List<Pulumi.AzureNative.NetworkCloud.Inputs.TrunkedNetworkAttachmentConfigurationResponse>: The list of Trunked Networks and related configuration for attachment.

L2Networks []L2NetworkAttachmentConfigurationResponse: The list of Layer 2 Networks and related configuration for attachment.
L3Networks []L3NetworkAttachmentConfigurationResponse: The list of Layer 3 Networks and related configuration for attachment.
TrunkedNetworks []TrunkedNetworkAttachmentConfigurationResponse: The list of Trunked Networks and related configuration for attachment.

l2Networks List<L2NetworkAttachmentConfigurationResponse>: The list of Layer 2 Networks and related configuration for attachment.
l3Networks List<L3NetworkAttachmentConfigurationResponse>: The list of Layer 3 Networks and related configuration for attachment.
trunkedNetworks List<TrunkedNetworkAttachmentConfigurationResponse>: The list of Trunked Networks and related configuration for attachment.

l2Networks L2NetworkAttachmentConfigurationResponse[]: The list of Layer 2 Networks and related configuration for attachment.
l3Networks L3NetworkAttachmentConfigurationResponse[]: The list of Layer 3 Networks and related configuration for attachment.
trunkedNetworks TrunkedNetworkAttachmentConfigurationResponse[]: The list of Trunked Networks and related configuration for attachment.

l2_networks Sequence[L2NetworkAttachmentConfigurationResponse]: The list of Layer 2 Networks and related configuration for attachment.
l3_networks Sequence[L3NetworkAttachmentConfigurationResponse]: The list of Layer 3 Networks and related configuration for attachment.
trunked_networks Sequence[TrunkedNetworkAttachmentConfigurationResponse]: The list of Trunked Networks and related configuration for attachment.

l2Networks List<Property Map>: The list of Layer 2 Networks and related configuration for attachment.
l3Networks List<Property Map>: The list of Layer 3 Networks and related configuration for attachment.
trunkedNetworks List<Property Map>: The list of Trunked Networks and related configuration for attachment.

ExtendedLocationResponse

Name string: The resource ID of the extended location on which the resource will be created.
Type string: The extended location type, for example, CustomLocation.

Name string: The resource ID of the extended location on which the resource will be created.
Type string: The extended location type, for example, CustomLocation.

name String: The resource ID of the extended location on which the resource will be created.
type String: The extended location type, for example, CustomLocation.

name string: The resource ID of the extended location on which the resource will be created.
type string: The extended location type, for example, CustomLocation.

name str: The resource ID of the extended location on which the resource will be created.
type str: The extended location type, for example, CustomLocation.

name String: The resource ID of the extended location on which the resource will be created.
type String: The extended location type, for example, CustomLocation.

KubernetesLabelResponse

Key string: The name of the label or taint.
Value string: The value of the label or taint.

Key string: The name of the label or taint.
Value string: The value of the label or taint.

key String: The name of the label or taint.
value String: The value of the label or taint.

key string: The name of the label or taint.
value string: The value of the label or taint.

key str: The name of the label or taint.
value str: The value of the label or taint.

key String: The name of the label or taint.
value String: The value of the label or taint.

L2NetworkAttachmentConfigurationResponse

NetworkId string: The resource ID of the network that is being configured for attachment.
PluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

NetworkId string: The resource ID of the network that is being configured for attachment.
PluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId String: The resource ID of the network that is being configured for attachment.
pluginType String: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId string: The resource ID of the network that is being configured for attachment.
pluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

network_id str: The resource ID of the network that is being configured for attachment.
plugin_type str: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId String: The resource ID of the network that is being configured for attachment.
pluginType String: The indicator of how this network will be utilized by the Kubernetes cluster.

L3NetworkAttachmentConfigurationResponse

NetworkId string: The resource ID of the network that is being configured for attachment.
IpamEnabled string: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
PluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

NetworkId string: The resource ID of the network that is being configured for attachment.
IpamEnabled string: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
PluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId String: The resource ID of the network that is being configured for attachment.
ipamEnabled String: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
pluginType String: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId string: The resource ID of the network that is being configured for attachment.
ipamEnabled string: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
pluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

network_id str: The resource ID of the network that is being configured for attachment.
ipam_enabled str: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
plugin_type str: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId String: The resource ID of the network that is being configured for attachment.
ipamEnabled String: The indication of whether this network will or will not perform IP address management and allocate IP addresses when attached.
pluginType String: The indicator of how this network will be utilized by the Kubernetes cluster.

SshPublicKeyResponse

KeyData string: The SSH public key data.

KeyData string: The SSH public key data.

keyData String: The SSH public key data.

keyData string: The SSH public key data.

key_data str: The SSH public key data.

keyData String: The SSH public key data.

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.

TrunkedNetworkAttachmentConfigurationResponse

NetworkId string: The resource ID of the network that is being configured for attachment.
PluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

NetworkId string: The resource ID of the network that is being configured for attachment.
PluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId String: The resource ID of the network that is being configured for attachment.
pluginType String: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId string: The resource ID of the network that is being configured for attachment.
pluginType string: The indicator of how this network will be utilized by the Kubernetes cluster.

network_id str: The resource ID of the network that is being configured for attachment.
plugin_type str: The indicator of how this network will be utilized by the Kubernetes cluster.

networkId String: The resource ID of the network that is being configured for attachment.
pluginType String: The indicator of how this network will be utilized by the Kubernetes cluster.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.networkcloud.getAgentPool

On this page

On this page

Using getAgentPool

getAgentPool Result

Supporting Types

AdministratorConfigurationResponse

AgentOptionsResponse

AgentPoolUpgradeSettingsResponse

AttachedNetworkConfigurationResponse

ExtendedLocationResponse

KubernetesLabelResponse

L2NetworkAttachmentConfigurationResponse

L3NetworkAttachmentConfigurationResponse

SshPublicKeyResponse

SystemDataResponse

TrunkedNetworkAttachmentConfigurationResponse

Package Details

On this page

On this page