Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ManagementAgent
  5. getManagementAgentInstallKey
Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

oci.ManagementAgent.getManagementAgentInstallKey

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci

This data source provides details about a specific Management Agent Install Key resource in Oracle Cloud Infrastructure Management Agent service.

Gets complete details of the Agent install Key for a given key id

Example Usage

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

const testManagementAgentInstallKey = oci.ManagementAgent.getManagementAgentInstallKey({
    managementAgentInstallKeyId: testManagementAgentInstallKeyOciManagementAgentManagementAgentInstallKey.id,
});
Copy
import pulumi
import pulumi_oci as oci

test_management_agent_install_key = oci.ManagementAgent.get_management_agent_install_key(management_agent_install_key_id=test_management_agent_install_key_oci_management_agent_management_agent_install_key["id"])
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := managementagent.GetManagementAgentInstallKey(ctx, &managementagent.GetManagementAgentInstallKeyArgs{
			ManagementAgentInstallKeyId: testManagementAgentInstallKeyOciManagementAgentManagementAgentInstallKey.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testManagementAgentInstallKey = Oci.ManagementAgent.GetManagementAgentInstallKey.Invoke(new()
    {
        ManagementAgentInstallKeyId = testManagementAgentInstallKeyOciManagementAgentManagementAgentInstallKey.Id,
    });

});
Copy
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.GetManagementAgentInstallKeyArgs;
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 testManagementAgentInstallKey = ManagementAgentFunctions.getManagementAgentInstallKey(GetManagementAgentInstallKeyArgs.builder()
            .managementAgentInstallKeyId(testManagementAgentInstallKeyOciManagementAgentManagementAgentInstallKey.id())
            .build());

    }
}
Copy
variables:
  testManagementAgentInstallKey:
    fn::invoke:
      function: oci:ManagementAgent:getManagementAgentInstallKey
      arguments:
        managementAgentInstallKeyId: ${testManagementAgentInstallKeyOciManagementAgentManagementAgentInstallKey.id}
Copy

Using getManagementAgentInstallKey

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 getManagementAgentInstallKey(args: GetManagementAgentInstallKeyArgs, opts?: InvokeOptions): Promise<GetManagementAgentInstallKeyResult>
function getManagementAgentInstallKeyOutput(args: GetManagementAgentInstallKeyOutputArgs, opts?: InvokeOptions): Output<GetManagementAgentInstallKeyResult>
Copy
def get_management_agent_install_key(management_agent_install_key_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetManagementAgentInstallKeyResult
def get_management_agent_install_key_output(management_agent_install_key_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetManagementAgentInstallKeyResult]
Copy
func GetManagementAgentInstallKey(ctx *Context, args *GetManagementAgentInstallKeyArgs, opts ...InvokeOption) (*GetManagementAgentInstallKeyResult, error)
func GetManagementAgentInstallKeyOutput(ctx *Context, args *GetManagementAgentInstallKeyOutputArgs, opts ...InvokeOption) GetManagementAgentInstallKeyResultOutput
Copy

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

public static class GetManagementAgentInstallKey 
{
    public static Task<GetManagementAgentInstallKeyResult> InvokeAsync(GetManagementAgentInstallKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetManagementAgentInstallKeyResult> Invoke(GetManagementAgentInstallKeyInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetManagementAgentInstallKeyResult> getManagementAgentInstallKey(GetManagementAgentInstallKeyArgs args, InvokeOptions options)
public static Output<GetManagementAgentInstallKeyResult> getManagementAgentInstallKey(GetManagementAgentInstallKeyArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:ManagementAgent/getManagementAgentInstallKey:getManagementAgentInstallKey
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ManagementAgentInstallKeyId This property is required. string
Unique Management Agent Install Key identifier
ManagementAgentInstallKeyId This property is required. string
Unique Management Agent Install Key identifier
managementAgentInstallKeyId This property is required. String
Unique Management Agent Install Key identifier
managementAgentInstallKeyId This property is required. string
Unique Management Agent Install Key identifier
management_agent_install_key_id This property is required. str
Unique Management Agent Install Key identifier
managementAgentInstallKeyId This property is required. String
Unique Management Agent Install Key identifier

getManagementAgentInstallKey Result

The following output properties are available:

AllowedKeyInstallCount int
Total number of install for this keys
CompartmentId string
Compartment Identifier
CreatedByPrincipalId string
Principal id of user who created the Agent Install key
CurrentKeyInstallCount int
Total number of install for this keys
DisplayName string
Management Agent Install Key Name
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.
ManagementAgentInstallKeyId string
State string
Status of Key
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
Compartment Identifier
CreatedByPrincipalId string
Principal id of user who created the Agent Install key
CurrentKeyInstallCount int
Total number of install for this keys
DisplayName string
Management Agent Install Key Name
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.
ManagementAgentInstallKeyId string
State string
Status of Key
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
Compartment Identifier
createdByPrincipalId String
Principal id of user who created the Agent Install key
currentKeyInstallCount Integer
Total number of install for this keys
displayName String
Management Agent Install Key Name
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.
managementAgentInstallKeyId String
state String
Status of Key
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
Compartment Identifier
createdByPrincipalId string
Principal id of user who created the Agent Install key
currentKeyInstallCount number
Total number of install for this keys
displayName string
Management Agent Install Key Name
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.
managementAgentInstallKeyId string
state string
Status of Key
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
Compartment Identifier
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
display_name str
Management Agent Install Key Name
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.
management_agent_install_key_id str
state str
Status of Key
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
Compartment Identifier
createdByPrincipalId String
Principal id of user who created the Agent Install key
currentKeyInstallCount Number
Total number of install for this keys
displayName String
Management Agent Install Key Name
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.
managementAgentInstallKeyId String
state String
Status of Key
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 v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-oci