getAgentPoolUpdate

Okta v6.2.2, Jan 16 26

Okta v6.2.2 published on Friday, Jan 16, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-okta

Okta v6.2.2 published on Friday, Jan 16, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-okta

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = okta.getAgentPoolUpdate({
    id: "<update_id>",
    poolId: "<pool_id>",
});

import pulumi
import pulumi_okta as okta

example = okta.get_agent_pool_update(id="<update_id>",
    pool_id="<pool_id>")

package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := okta.LookupAgentPoolUpdate(ctx, &okta.LookupAgentPoolUpdateArgs{
			Id:     "<update_id>",
			PoolId: "<pool_id>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Okta = Pulumi.Okta;

return await Deployment.RunAsync(() => 
{
    var example = Okta.GetAgentPoolUpdate.Invoke(new()
    {
        Id = "<update_id>",
        PoolId = "<pool_id>",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.OktaFunctions;
import com.pulumi.okta.inputs.GetAgentPoolUpdateArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = OktaFunctions.getAgentPoolUpdate(GetAgentPoolUpdateArgs.builder()
            .id("<update_id>")
            .poolId("<pool_id>")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: okta:getAgentPoolUpdate
      arguments:
        id: <update_id>
        poolId: <pool_id>

Using getAgentPoolUpdate

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 getAgentPoolUpdate(args: GetAgentPoolUpdateArgs, opts?: InvokeOptions): Promise<GetAgentPoolUpdateResult>
function getAgentPoolUpdateOutput(args: GetAgentPoolUpdateOutputArgs, opts?: InvokeOptions): Output<GetAgentPoolUpdateResult>

def get_agent_pool_update(agents: Optional[Sequence[GetAgentPoolUpdateAgent]] = None,
                          id: Optional[str] = None,
                          pool_id: Optional[str] = None,
                          schedule: Optional[GetAgentPoolUpdateSchedule] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAgentPoolUpdateResult
def get_agent_pool_update_output(agents: Optional[pulumi.Input[Sequence[pulumi.Input[GetAgentPoolUpdateAgentArgs]]]] = None,
                          id: Optional[pulumi.Input[str]] = None,
                          pool_id: Optional[pulumi.Input[str]] = None,
                          schedule: Optional[pulumi.Input[GetAgentPoolUpdateScheduleArgs]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetAgentPoolUpdateResult]

func LookupAgentPoolUpdate(ctx *Context, args *LookupAgentPoolUpdateArgs, opts ...InvokeOption) (*LookupAgentPoolUpdateResult, error)
func LookupAgentPoolUpdateOutput(ctx *Context, args *LookupAgentPoolUpdateOutputArgs, opts ...InvokeOption) LookupAgentPoolUpdateResultOutput

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

public static class GetAgentPoolUpdate 
{
    public static Task<GetAgentPoolUpdateResult> InvokeAsync(GetAgentPoolUpdateArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentPoolUpdateResult> Invoke(GetAgentPoolUpdateInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAgentPoolUpdateResult> getAgentPoolUpdate(GetAgentPoolUpdateArgs args, InvokeOptions options)
public static Output<GetAgentPoolUpdateResult> getAgentPoolUpdate(GetAgentPoolUpdateArgs args, InvokeOptions options)

fn::invoke:
  function: okta:index/getAgentPoolUpdate:getAgentPoolUpdate
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: The unique identifier of the agent pool update.
PoolId string: The unique identifier of the agent pool.
Agents List<GetAgentPoolUpdateAgent>: The agents associated with the agent pool update.
Schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

Id string: The unique identifier of the agent pool update.
PoolId string: The unique identifier of the agent pool.
Agents []GetAgentPoolUpdateAgent: The agents associated with the agent pool update.
Schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

id String: The unique identifier of the agent pool update.
poolId String: The unique identifier of the agent pool.
agents List<GetAgentPoolUpdateAgent>: The agents associated with the agent pool update.
schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

id string: The unique identifier of the agent pool update.
poolId string: The unique identifier of the agent pool.
agents GetAgentPoolUpdateAgent[]: The agents associated with the agent pool update.
schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

id str: The unique identifier of the agent pool update.
pool_id str: The unique identifier of the agent pool.
agents Sequence[GetAgentPoolUpdateAgent]: The agents associated with the agent pool update.
schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

id String: The unique identifier of the agent pool update.
poolId String: The unique identifier of the agent pool.
agents List<Property Map>: The agents associated with the agent pool update.
schedule Property Map: The schedule configuration for the agent pool update.

getAgentPoolUpdate Result

The following output properties are available:

AgentType string: Agent types that are being monitored (e.g. AD, LDAP, IWA, RADIUS, MFA, OPP, RUM, Radius).
Enabled bool: Indicates if auto-update is enabled for the agent pool.
Id string: The unique identifier of the agent pool update.
Name string: The name of the agent pool update.
NotifyAdmin bool: Indicates if the admin is notified about the update.
PoolId string: The unique identifier of the agent pool.
Reason string: Reason for the update.
SortOrder int: Specifies the sort order.
Status string: Overall state for the auto-update job from the admin perspective (e.g., Cancelled, Failed, InProgress, Paused, Scheduled, Success).
TargetVersion string: The agent version to update to.
Agents List<GetAgentPoolUpdateAgent>: The agents associated with the agent pool update.
Schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

AgentType string: Agent types that are being monitored (e.g. AD, LDAP, IWA, RADIUS, MFA, OPP, RUM, Radius).
Enabled bool: Indicates if auto-update is enabled for the agent pool.
Id string: The unique identifier of the agent pool update.
Name string: The name of the agent pool update.
NotifyAdmin bool: Indicates if the admin is notified about the update.
PoolId string: The unique identifier of the agent pool.
Reason string: Reason for the update.
SortOrder int: Specifies the sort order.
Status string: Overall state for the auto-update job from the admin perspective (e.g., Cancelled, Failed, InProgress, Paused, Scheduled, Success).
TargetVersion string: The agent version to update to.
Agents []GetAgentPoolUpdateAgent: The agents associated with the agent pool update.
Schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

agentType String: Agent types that are being monitored (e.g. AD, LDAP, IWA, RADIUS, MFA, OPP, RUM, Radius).
enabled Boolean: Indicates if auto-update is enabled for the agent pool.
id String: The unique identifier of the agent pool update.
name String: The name of the agent pool update.
notifyAdmin Boolean: Indicates if the admin is notified about the update.
poolId String: The unique identifier of the agent pool.
reason String: Reason for the update.
sortOrder Integer: Specifies the sort order.
status String: Overall state for the auto-update job from the admin perspective (e.g., Cancelled, Failed, InProgress, Paused, Scheduled, Success).
targetVersion String: The agent version to update to.
agents List<GetAgentPoolUpdateAgent>: The agents associated with the agent pool update.
schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

agentType string: Agent types that are being monitored (e.g. AD, LDAP, IWA, RADIUS, MFA, OPP, RUM, Radius).
enabled boolean: Indicates if auto-update is enabled for the agent pool.
id string: The unique identifier of the agent pool update.
name string: The name of the agent pool update.
notifyAdmin boolean: Indicates if the admin is notified about the update.
poolId string: The unique identifier of the agent pool.
reason string: Reason for the update.
sortOrder number: Specifies the sort order.
status string: Overall state for the auto-update job from the admin perspective (e.g., Cancelled, Failed, InProgress, Paused, Scheduled, Success).
targetVersion string: The agent version to update to.
agents GetAgentPoolUpdateAgent[]: The agents associated with the agent pool update.
schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

agent_type str: Agent types that are being monitored (e.g. AD, LDAP, IWA, RADIUS, MFA, OPP, RUM, Radius).
enabled bool: Indicates if auto-update is enabled for the agent pool.
id str: The unique identifier of the agent pool update.
name str: The name of the agent pool update.
notify_admin bool: Indicates if the admin is notified about the update.
pool_id str: The unique identifier of the agent pool.
reason str: Reason for the update.
sort_order int: Specifies the sort order.
status str: Overall state for the auto-update job from the admin perspective (e.g., Cancelled, Failed, InProgress, Paused, Scheduled, Success).
target_version str: The agent version to update to.
agents Sequence[GetAgentPoolUpdateAgent]: The agents associated with the agent pool update.
schedule GetAgentPoolUpdateSchedule: The schedule configuration for the agent pool update.

agentType String: Agent types that are being monitored (e.g. AD, LDAP, IWA, RADIUS, MFA, OPP, RUM, Radius).
enabled Boolean: Indicates if auto-update is enabled for the agent pool.
id String: The unique identifier of the agent pool update.
name String: The name of the agent pool update.
notifyAdmin Boolean: Indicates if the admin is notified about the update.
poolId String: The unique identifier of the agent pool.
reason String: Reason for the update.
sortOrder Number: Specifies the sort order.
status String: Overall state for the auto-update job from the admin perspective (e.g., Cancelled, Failed, InProgress, Paused, Scheduled, Success).
targetVersion String: The agent version to update to.
agents List<Property Map>: The agents associated with the agent pool update.
schedule Property Map: The schedule configuration for the agent pool update.

Supporting Types

GetAgentPoolUpdateAgent

Id string: The unique identifier of the agent.
IsHidden bool: Determines if an agent is hidden from the Admin Console.
IsLatestGaedVersion bool: Determines if the agent is on the latest generally available version.
LastConnection int: Timestamp when the agent last connected to Okta.
Name string: The name of the agent.
OperationalStatus string: Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
PoolId string: Pool ID.
Type string: Agent types that are being monitored.
UpdateMessage string: Status message of the agent.
UpdateStatus string: Status for one agent regarding the status to auto-update that agent.
Version string: Agent version number.

Id string: The unique identifier of the agent.
IsHidden bool: Determines if an agent is hidden from the Admin Console.
IsLatestGaedVersion bool: Determines if the agent is on the latest generally available version.
LastConnection int: Timestamp when the agent last connected to Okta.
Name string: The name of the agent.
OperationalStatus string: Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
PoolId string: Pool ID.
Type string: Agent types that are being monitored.
UpdateMessage string: Status message of the agent.
UpdateStatus string: Status for one agent regarding the status to auto-update that agent.
Version string: Agent version number.

id String: The unique identifier of the agent.
isHidden Boolean: Determines if an agent is hidden from the Admin Console.
isLatestGaedVersion Boolean: Determines if the agent is on the latest generally available version.
lastConnection Integer: Timestamp when the agent last connected to Okta.
name String: The name of the agent.
operationalStatus String: Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
poolId String: Pool ID.
type String: Agent types that are being monitored.
updateMessage String: Status message of the agent.
updateStatus String: Status for one agent regarding the status to auto-update that agent.
version String: Agent version number.

id string: The unique identifier of the agent.
isHidden boolean: Determines if an agent is hidden from the Admin Console.
isLatestGaedVersion boolean: Determines if the agent is on the latest generally available version.
lastConnection number: Timestamp when the agent last connected to Okta.
name string: The name of the agent.
operationalStatus string: Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
poolId string: Pool ID.
type string: Agent types that are being monitored.
updateMessage string: Status message of the agent.
updateStatus string: Status for one agent regarding the status to auto-update that agent.
version string: Agent version number.

id str: The unique identifier of the agent.
is_hidden bool: Determines if an agent is hidden from the Admin Console.
is_latest_gaed_version bool: Determines if the agent is on the latest generally available version.
last_connection int: Timestamp when the agent last connected to Okta.
name str: The name of the agent.
operational_status str: Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
pool_id str: Pool ID.
type str: Agent types that are being monitored.
update_message str: Status message of the agent.
update_status str: Status for one agent regarding the status to auto-update that agent.
version str: Agent version number.

id String: The unique identifier of the agent.
isHidden Boolean: Determines if an agent is hidden from the Admin Console.
isLatestGaedVersion Boolean: Determines if the agent is on the latest generally available version.
lastConnection Number: Timestamp when the agent last connected to Okta.
name String: The name of the agent.
operationalStatus String: Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
poolId String: Pool ID.
type String: Agent types that are being monitored.
updateMessage String: Status message of the agent.
updateStatus String: Status for one agent regarding the status to auto-update that agent.
version String: Agent version number.

GetAgentPoolUpdateSchedule

Cron string: The schedule of the update in cron format.
Delay int: Delay in days.
Duration int: Duration in minutes.
LastUpdated string: Timestamp when the update finished.
Timezone string: Timezone of where the scheduled job takes place.

Cron string: The schedule of the update in cron format.
Delay int: Delay in days.
Duration int: Duration in minutes.
LastUpdated string: Timestamp when the update finished.
Timezone string: Timezone of where the scheduled job takes place.

cron String: The schedule of the update in cron format.
delay Integer: Delay in days.
duration Integer: Duration in minutes.
lastUpdated String: Timestamp when the update finished.
timezone String: Timezone of where the scheduled job takes place.

cron string: The schedule of the update in cron format.
delay number: Delay in days.
duration number: Duration in minutes.
lastUpdated string: Timestamp when the update finished.
timezone string: Timezone of where the scheduled job takes place.

cron str: The schedule of the update in cron format.
delay int: Delay in days.
duration int: Duration in minutes.
last_updated str: Timestamp when the update finished.
timezone str: Timezone of where the scheduled job takes place.

cron String: The schedule of the update in cron format.
delay Number: Delay in days.
duration Number: Duration in minutes.
lastUpdated String: Timestamp when the update finished.
timezone String: Timezone of where the scheduled job takes place.

Package Details

Repository: Okta pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

Okta v6.2.2 published on Friday, Jan 16, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-okta

okta.getAgentPoolUpdate

On this page

On this page

Example Usage

Using getAgentPoolUpdate

getAgentPoolUpdate Result

Supporting Types

GetAgentPoolUpdateAgent

GetAgentPoolUpdateSchedule

Package Details

On this page

On this page