Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
published on Thursday, Mar 12, 2026 by Pulumi
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
published on Thursday, Mar 12, 2026 by Pulumi
Retrieves an Okta Agent Pool Update. Agent pool updates allow you to schedule and manage updates for agent pools.
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 dictionaryThe following arguments are supported:
- Id string
- The unique identifier of the agent pool update.
- Pool
Id string - The unique identifier of the agent pool.
- Agents
List<Get
Agent Pool Update Agent> - The agents associated with the agent pool update.
- Schedule
Get
Agent Pool Update Schedule - The schedule configuration for the agent pool update.
- Id string
- The unique identifier of the agent pool update.
- Pool
Id string - The unique identifier of the agent pool.
- Agents
[]Get
Agent Pool Update Agent - The agents associated with the agent pool update.
- Schedule
Get
Agent Pool Update Schedule - The schedule configuration for the agent pool update.
- id String
- The unique identifier of the agent pool update.
- pool
Id String - The unique identifier of the agent pool.
- agents
List<Get
Agent Pool Update Agent> - The agents associated with the agent pool update.
- schedule
Get
Agent Pool Update Schedule - The schedule configuration for the agent pool update.
- id string
- The unique identifier of the agent pool update.
- pool
Id string - The unique identifier of the agent pool.
- agents
Get
Agent Pool Update Agent[] - The agents associated with the agent pool update.
- schedule
Get
Agent Pool Update Schedule - 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[Get
Agent Pool Update Agent] - The agents associated with the agent pool update.
- schedule
Get
Agent Pool Update Schedule - The schedule configuration for the agent pool update.
- id String
- The unique identifier of the agent pool update.
- pool
Id 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:
- Agent
Type 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.
- Notify
Admin bool - Indicates if the admin is notified about the update.
- Pool
Id string - The unique identifier of the agent pool.
- Reason string
- Reason for the update.
- Sort
Order 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).
- Target
Version string - The agent version to update to.
- Agents
List<Get
Agent Pool Update Agent> - The agents associated with the agent pool update.
- Schedule
Get
Agent Pool Update Schedule - The schedule configuration for the agent pool update.
- Agent
Type 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.
- Notify
Admin bool - Indicates if the admin is notified about the update.
- Pool
Id string - The unique identifier of the agent pool.
- Reason string
- Reason for the update.
- Sort
Order 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).
- Target
Version string - The agent version to update to.
- Agents
[]Get
Agent Pool Update Agent - The agents associated with the agent pool update.
- Schedule
Get
Agent Pool Update Schedule - The schedule configuration for the agent pool update.
- agent
Type 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.
- notify
Admin Boolean - Indicates if the admin is notified about the update.
- pool
Id String - The unique identifier of the agent pool.
- reason String
- Reason for the update.
- sort
Order 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).
- target
Version String - The agent version to update to.
- agents
List<Get
Agent Pool Update Agent> - The agents associated with the agent pool update.
- schedule
Get
Agent Pool Update Schedule - The schedule configuration for the agent pool update.
- agent
Type 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.
- notify
Admin boolean - Indicates if the admin is notified about the update.
- pool
Id string - The unique identifier of the agent pool.
- reason string
- Reason for the update.
- sort
Order 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).
- target
Version string - The agent version to update to.
- agents
Get
Agent Pool Update Agent[] - The agents associated with the agent pool update.
- schedule
Get
Agent Pool Update Schedule - 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[Get
Agent Pool Update Agent] - The agents associated with the agent pool update.
- schedule
Get
Agent Pool Update Schedule - The schedule configuration for the agent pool update.
- agent
Type 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.
- notify
Admin Boolean - Indicates if the admin is notified about the update.
- pool
Id String - The unique identifier of the agent pool.
- reason String
- Reason for the update.
- sort
Order 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).
- target
Version 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.
- bool
- Determines if an agent is hidden from the Admin Console.
- Is
Latest boolGaed Version - Determines if the agent is on the latest generally available version.
- Last
Connection int - Timestamp when the agent last connected to Okta.
- Name string
- The name of the agent.
- Operational
Status string - Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
- Pool
Id string - Pool ID.
- Type string
- Agent types that are being monitored.
- Update
Message string - Status message of the agent.
- Update
Status 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.
- bool
- Determines if an agent is hidden from the Admin Console.
- Is
Latest boolGaed Version - Determines if the agent is on the latest generally available version.
- Last
Connection int - Timestamp when the agent last connected to Okta.
- Name string
- The name of the agent.
- Operational
Status string - Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
- Pool
Id string - Pool ID.
- Type string
- Agent types that are being monitored.
- Update
Message string - Status message of the agent.
- Update
Status 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.
- Boolean
- Determines if an agent is hidden from the Admin Console.
- is
Latest BooleanGaed Version - Determines if the agent is on the latest generally available version.
- last
Connection Integer - Timestamp when the agent last connected to Okta.
- name String
- The name of the agent.
- operational
Status String - Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
- pool
Id String - Pool ID.
- type String
- Agent types that are being monitored.
- update
Message String - Status message of the agent.
- update
Status 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.
- boolean
- Determines if an agent is hidden from the Admin Console.
- is
Latest booleanGaed Version - Determines if the agent is on the latest generally available version.
- last
Connection number - Timestamp when the agent last connected to Okta.
- name string
- The name of the agent.
- operational
Status string - Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
- pool
Id string - Pool ID.
- type string
- Agent types that are being monitored.
- update
Message string - Status message of the agent.
- update
Status 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.
- bool
- Determines if an agent is hidden from the Admin Console.
- is_
latest_ boolgaed_ version - 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.
- Boolean
- Determines if an agent is hidden from the Admin Console.
- is
Latest BooleanGaed Version - Determines if the agent is on the latest generally available version.
- last
Connection Number - Timestamp when the agent last connected to Okta.
- name String
- The name of the agent.
- operational
Status String - Operational status of a given agent (e.g., DEGRADED, DISRUPTED, INACTIVE, OPERATIONAL).
- pool
Id String - Pool ID.
- type String
- Agent types that are being monitored.
- update
Message String - Status message of the agent.
- update
Status 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.
- Last
Updated 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.
- Last
Updated 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.
- last
Updated 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.
- last
Updated 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.
- last
Updated 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
oktaTerraform Provider.
Viewing docs for Okta v6.3.1
published on Thursday, Mar 12, 2026 by Pulumi
published on Thursday, Mar 12, 2026 by Pulumi
