Oracle Cloud Infrastructure v3.10.0, Nov 5 25

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.ManagementAgent.getManagementAgentInstallKeys

Start a Neo task

Explain and create an oci.ManagementAgent.getManagementAgentInstallKeys resource

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

Example Usage

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

const testManagementAgentInstallKeys = oci.ManagementAgent.getManagementAgentInstallKeys({
    compartmentId: compartmentId,
    accessLevel: managementAgentInstallKeyAccessLevel,
    compartmentIdInSubtree: managementAgentInstallKeyCompartmentIdInSubtree,
    displayName: managementAgentInstallKeyDisplayName,
    state: managementAgentInstallKeyState,
});

import pulumi
import pulumi_oci as oci

test_management_agent_install_keys = oci.ManagementAgent.get_management_agent_install_keys(compartment_id=compartment_id,
    access_level=management_agent_install_key_access_level,
    compartment_id_in_subtree=management_agent_install_key_compartment_id_in_subtree,
    display_name=management_agent_install_key_display_name,
    state=management_agent_install_key_state)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/managementagent"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := managementagent.GetManagementAgentInstallKeys(ctx, &managementagent.GetManagementAgentInstallKeysArgs{
			CompartmentId:          compartmentId,
			AccessLevel:            pulumi.StringRef(managementAgentInstallKeyAccessLevel),
			CompartmentIdInSubtree: pulumi.BoolRef(managementAgentInstallKeyCompartmentIdInSubtree),
			DisplayName:            pulumi.StringRef(managementAgentInstallKeyDisplayName),
			State:                  pulumi.StringRef(managementAgentInstallKeyState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testManagementAgentInstallKeys = Oci.ManagementAgent.GetManagementAgentInstallKeys.Invoke(new()
    {
        CompartmentId = compartmentId,
        AccessLevel = managementAgentInstallKeyAccessLevel,
        CompartmentIdInSubtree = managementAgentInstallKeyCompartmentIdInSubtree,
        DisplayName = managementAgentInstallKeyDisplayName,
        State = managementAgentInstallKeyState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ManagementAgent.ManagementAgentFunctions;
import com.pulumi.oci.ManagementAgent.inputs.GetManagementAgentInstallKeysArgs;
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 testManagementAgentInstallKeys = ManagementAgentFunctions.getManagementAgentInstallKeys(GetManagementAgentInstallKeysArgs.builder()
            .compartmentId(compartmentId)
            .accessLevel(managementAgentInstallKeyAccessLevel)
            .compartmentIdInSubtree(managementAgentInstallKeyCompartmentIdInSubtree)
            .displayName(managementAgentInstallKeyDisplayName)
            .state(managementAgentInstallKeyState)
            .build());

    }
}

variables:
  testManagementAgentInstallKeys:
    fn::invoke:
      function: oci:ManagementAgent:getManagementAgentInstallKeys
      arguments:
        compartmentId: ${compartmentId}
        accessLevel: ${managementAgentInstallKeyAccessLevel}
        compartmentIdInSubtree: ${managementAgentInstallKeyCompartmentIdInSubtree}
        displayName: ${managementAgentInstallKeyDisplayName}
        state: ${managementAgentInstallKeyState}

Using getManagementAgentInstallKeys

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 getManagementAgentInstallKeys(args: GetManagementAgentInstallKeysArgs, opts?: InvokeOptions): Promise<GetManagementAgentInstallKeysResult>
function getManagementAgentInstallKeysOutput(args: GetManagementAgentInstallKeysOutputArgs, opts?: InvokeOptions): Output<GetManagementAgentInstallKeysResult>

def get_management_agent_install_keys(access_level: Optional[str] = None,
                                      compartment_id: Optional[str] = None,
                                      compartment_id_in_subtree: Optional[bool] = None,
                                      display_name: Optional[str] = None,
                                      filters: Optional[Sequence[GetManagementAgentInstallKeysFilter]] = None,
                                      state: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetManagementAgentInstallKeysResult
def get_management_agent_install_keys_output(access_level: Optional[pulumi.Input[str]] = None,
                                      compartment_id: Optional[pulumi.Input[str]] = None,
                                      compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
                                      display_name: Optional[pulumi.Input[str]] = None,
                                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetManagementAgentInstallKeysFilterArgs]]]] = None,
                                      state: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetManagementAgentInstallKeysResult]

func GetManagementAgentInstallKeys(ctx *Context, args *GetManagementAgentInstallKeysArgs, opts ...InvokeOption) (*GetManagementAgentInstallKeysResult, error)
func GetManagementAgentInstallKeysOutput(ctx *Context, args *GetManagementAgentInstallKeysOutputArgs, opts ...InvokeOption) GetManagementAgentInstallKeysResultOutput

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

public static class GetManagementAgentInstallKeys 
{
    public static Task<GetManagementAgentInstallKeysResult> InvokeAsync(GetManagementAgentInstallKeysArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementAgentInstallKeysResult> Invoke(GetManagementAgentInstallKeysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetManagementAgentInstallKeysResult> getManagementAgentInstallKeys(GetManagementAgentInstallKeysArgs args, InvokeOptions options)
public static Output<GetManagementAgentInstallKeysResult> getManagementAgentInstallKeys(GetManagementAgentInstallKeysArgs args, InvokeOptions options)

fn::invoke:
  function: oci:ManagementAgent/getManagementAgentInstallKeys:getManagementAgentInstallKeys
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment to which a request will be scoped.
AccessLevel string: Value of this is always "ACCESSIBLE" and any other value is not supported.
CompartmentIdInSubtree bool: if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
DisplayName string: The display name for which the Key needs to be listed.
Filters List<GetManagementAgentInstallKeysFilter>
State string: Filter to return only Management Agents in the particular lifecycle state.

CompartmentId string: The OCID of the compartment to which a request will be scoped.
AccessLevel string: Value of this is always "ACCESSIBLE" and any other value is not supported.
CompartmentIdInSubtree bool: if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
DisplayName string: The display name for which the Key needs to be listed.
Filters []GetManagementAgentInstallKeysFilter
State string: Filter to return only Management Agents in the particular lifecycle state.

compartmentId String: The OCID of the compartment to which a request will be scoped.
accessLevel String: Value of this is always "ACCESSIBLE" and any other value is not supported.
compartmentIdInSubtree Boolean: if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
displayName String: The display name for which the Key needs to be listed.
filters List<GetInstallKeysFilter>
state String: Filter to return only Management Agents in the particular lifecycle state.

compartmentId string: The OCID of the compartment to which a request will be scoped.
accessLevel string: Value of this is always "ACCESSIBLE" and any other value is not supported.
compartmentIdInSubtree boolean: if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
displayName string: The display name for which the Key needs to be listed.
filters GetManagementAgentInstallKeysFilter[]
state string: Filter to return only Management Agents in the particular lifecycle state.

compartment_id str: The OCID of the compartment to which a request will be scoped.
access_level str: Value of this is always "ACCESSIBLE" and any other value is not supported.
compartment_id_in_subtree bool: if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
display_name str: The display name for which the Key needs to be listed.
filters Sequence[GetManagementAgentInstallKeysFilter]
state str: Filter to return only Management Agents in the particular lifecycle state.

compartmentId String: The OCID of the compartment to which a request will be scoped.
accessLevel String: Value of this is always "ACCESSIBLE" and any other value is not supported.
compartmentIdInSubtree Boolean: if set to true then it fetches resources for all compartments where user has access to else only on the compartment specified.
displayName String: The display name for which the Key needs to be listed.
filters List<Property Map>
state String: Filter to return only Management Agents in the particular lifecycle state.

getManagementAgentInstallKeys Result

The following output properties are available:

CompartmentId string: Compartment Identifier
Id string: The provider-assigned unique ID for this managed resource.
ManagementAgentInstallKeys List<GetManagementAgentInstallKeysManagementAgentInstallKey>: The list of management_agent_install_keys.
AccessLevel string
CompartmentIdInSubtree bool
DisplayName string: Management Agent Install Key Name
Filters List<GetManagementAgentInstallKeysFilter>
State string: Status of Key

CompartmentId string: Compartment Identifier
Id string: The provider-assigned unique ID for this managed resource.
ManagementAgentInstallKeys []GetManagementAgentInstallKeysManagementAgentInstallKey: The list of management_agent_install_keys.
AccessLevel string
CompartmentIdInSubtree bool
DisplayName string: Management Agent Install Key Name
Filters []GetManagementAgentInstallKeysFilter
State string: Status of Key

compartmentId String: Compartment Identifier
id String: The provider-assigned unique ID for this managed resource.
managementAgentInstallKeys List<GetInstallKeysInstallKey>: The list of management_agent_install_keys.
accessLevel String
compartmentIdInSubtree Boolean
displayName String: Management Agent Install Key Name
filters List<GetInstallKeysFilter>
state String: Status of Key

compartmentId string: Compartment Identifier
id string: The provider-assigned unique ID for this managed resource.
managementAgentInstallKeys GetManagementAgentInstallKeysManagementAgentInstallKey[]: The list of management_agent_install_keys.
accessLevel string
compartmentIdInSubtree boolean
displayName string: Management Agent Install Key Name
filters GetManagementAgentInstallKeysFilter[]
state string: Status of Key

compartment_id str: Compartment Identifier
id str: The provider-assigned unique ID for this managed resource.
management_agent_install_keys Sequence[GetManagementAgentInstallKeysManagementAgentInstallKey]: The list of management_agent_install_keys.
access_level str
compartment_id_in_subtree bool
display_name str: Management Agent Install Key Name
filters Sequence[GetManagementAgentInstallKeysFilter]
state str: Status of Key

compartmentId String: Compartment Identifier
id String: The provider-assigned unique ID for this managed resource.
managementAgentInstallKeys List<Property Map>: The list of management_agent_install_keys.
accessLevel String
compartmentIdInSubtree Boolean
displayName String: Management Agent Install Key Name
filters List<Property Map>
state String: Status of Key

Supporting Types

GetManagementAgentInstallKeysFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetManagementAgentInstallKeysManagementAgentInstallKey

AllowedKeyInstallCount int: Total number of install for this keys
CompartmentId string: The OCID of the compartment to which a request will be scoped.
CreatedByPrincipalId string: Principal id of user who created the Agent Install key
CurrentKeyInstallCount int: Total number of install for this keys
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: The display name for which the Key needs to be listed.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Agent install Key identifier
IsUnlimited bool: If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false.
Key string: Management Agent Install Key
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
State string: Filter to return only Management Agents in the particular lifecycle state.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time when Management Agent install Key was created. An RFC3339 formatted date time string
TimeExpires string: date after which key would expire after creation
TimeUpdated string: The time when Management Agent install Key was updated. An RFC3339 formatted date time string

AllowedKeyInstallCount int: Total number of install for this keys
CompartmentId string: The OCID of the compartment to which a request will be scoped.
CreatedByPrincipalId string: Principal id of user who created the Agent Install key
CurrentKeyInstallCount int: Total number of install for this keys
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: The display name for which the Key needs to be listed.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Agent install Key identifier
IsUnlimited bool: If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false.
Key string: Management Agent Install Key
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
State string: Filter to return only Management Agents in the particular lifecycle state.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time when Management Agent install Key was created. An RFC3339 formatted date time string
TimeExpires string: date after which key would expire after creation
TimeUpdated string: The time when Management Agent install Key was updated. An RFC3339 formatted date time string

allowedKeyInstallCount Integer: Total number of install for this keys
compartmentId String: The OCID of the compartment to which a request will be scoped.
createdByPrincipalId String: Principal id of user who created the Agent Install key
currentKeyInstallCount Integer: Total number of install for this keys
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: The display name for which the Key needs to be listed.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Agent install Key identifier
isUnlimited Boolean: If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false.
key String: Management Agent Install Key
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state String: Filter to return only Management Agents in the particular lifecycle state.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time when Management Agent install Key was created. An RFC3339 formatted date time string
timeExpires String: date after which key would expire after creation
timeUpdated String: The time when Management Agent install Key was updated. An RFC3339 formatted date time string

allowedKeyInstallCount number: Total number of install for this keys
compartmentId string: The OCID of the compartment to which a request will be scoped.
createdByPrincipalId string: Principal id of user who created the Agent Install key
currentKeyInstallCount number: Total number of install for this keys
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string: The display name for which the Key needs to be listed.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Agent install Key identifier
isUnlimited boolean: If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false.
key string: Management Agent Install Key
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state string: Filter to return only Management Agents in the particular lifecycle state.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time when Management Agent install Key was created. An RFC3339 formatted date time string
timeExpires string: date after which key would expire after creation
timeUpdated string: The time when Management Agent install Key was updated. An RFC3339 formatted date time string

allowed_key_install_count int: Total number of install for this keys
compartment_id str: The OCID of the compartment to which a request will be scoped.
created_by_principal_id str: Principal id of user who created the Agent Install key
current_key_install_count int: Total number of install for this keys
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str: The display name for which the Key needs to be listed.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Agent install Key identifier
is_unlimited bool: If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false.
key str: Management Agent Install Key
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state str: Filter to return only Management Agents in the particular lifecycle state.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time when Management Agent install Key was created. An RFC3339 formatted date time string
time_expires str: date after which key would expire after creation
time_updated str: The time when Management Agent install Key was updated. An RFC3339 formatted date time string

allowedKeyInstallCount Number: Total number of install for this keys
compartmentId String: The OCID of the compartment to which a request will be scoped.
createdByPrincipalId String: Principal id of user who created the Agent Install key
currentKeyInstallCount Number: Total number of install for this keys
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: The display name for which the Key needs to be listed.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Agent install Key identifier
isUnlimited Boolean: If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false.
key String: Management Agent Install Key
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
state String: Filter to return only Management Agents in the particular lifecycle state.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time when Management Agent install Key was created. An RFC3339 formatted date time string
timeExpires String: date after which key would expire after creation
timeUpdated String: The time when Management Agent install Key was updated. An RFC3339 formatted date time string

Package Details

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

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.ManagementAgent.getManagementAgentInstallKeys

On this page

On this page

Example Usage

Using getManagementAgentInstallKeys

getManagementAgentInstallKeys Result

Supporting Types

GetManagementAgentInstallKeysFilter

GetManagementAgentInstallKeysManagementAgentInstallKey

Package Details

On this page

On this page