Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ManagementAgent
  5. ManagementAgentInstallKey
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.ManagementAgent.ManagementAgentInstallKey

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Management Agent Install Key resource in Oracle Cloud Infrastructure Management Agent service.

    User creates a new install key as part of this API.

    Example Usage

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

const testManagementAgentInstallKey = new oci.managementagent.ManagementAgentInstallKey("test_management_agent_install_key", {
    compartmentId: compartmentId,
    displayName: managementAgentInstallKeyDisplayName,
    allowedKeyInstallCount: managementAgentInstallKeyAllowedKeyInstallCount,
    isUnlimited: managementAgentInstallKeyIsUnlimited,
    timeExpires: managementAgentInstallKeyTimeExpires,
});

    import pulumi
import pulumi_oci as oci

test_management_agent_install_key = oci.management_agent.ManagementAgentInstallKey("test_management_agent_install_key",
    compartment_id=compartment_id,
    display_name=management_agent_install_key_display_name,
    allowed_key_install_count=management_agent_install_key_allowed_key_install_count,
    is_unlimited=management_agent_install_key_is_unlimited,
    time_expires=management_agent_install_key_time_expires)

    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.NewManagementAgentInstallKey(ctx, "test_management_agent_install_key", &managementagent.ManagementAgentInstallKeyArgs{
			CompartmentId:          pulumi.Any(compartmentId),
			DisplayName:            pulumi.Any(managementAgentInstallKeyDisplayName),
			AllowedKeyInstallCount: pulumi.Any(managementAgentInstallKeyAllowedKeyInstallCount),
			IsUnlimited:            pulumi.Any(managementAgentInstallKeyIsUnlimited),
			TimeExpires:            pulumi.Any(managementAgentInstallKeyTimeExpires),
		})
		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 testManagementAgentInstallKey = new Oci.ManagementAgent.ManagementAgentInstallKey("test_management_agent_install_key", new()
    {
        CompartmentId = compartmentId,
        DisplayName = managementAgentInstallKeyDisplayName,
        AllowedKeyInstallCount = managementAgentInstallKeyAllowedKeyInstallCount,
        IsUnlimited = managementAgentInstallKeyIsUnlimited,
        TimeExpires = managementAgentInstallKeyTimeExpires,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ManagementAgent.ManagementAgentInstallKey;
import com.pulumi.oci.ManagementAgent.ManagementAgentInstallKeyArgs;
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) {
        var testManagementAgentInstallKey = new ManagementAgentInstallKey("testManagementAgentInstallKey", ManagementAgentInstallKeyArgs.builder()
            .compartmentId(compartmentId)
            .displayName(managementAgentInstallKeyDisplayName)
            .allowedKeyInstallCount(managementAgentInstallKeyAllowedKeyInstallCount)
            .isUnlimited(managementAgentInstallKeyIsUnlimited)
            .timeExpires(managementAgentInstallKeyTimeExpires)
            .build());

    }
}

    resources:
  testManagementAgentInstallKey:
    type: oci:ManagementAgent:ManagementAgentInstallKey
    name: test_management_agent_install_key
    properties:
      compartmentId: ${compartmentId}
      displayName: ${managementAgentInstallKeyDisplayName}
      allowedKeyInstallCount: ${managementAgentInstallKeyAllowedKeyInstallCount}
      isUnlimited: ${managementAgentInstallKeyIsUnlimited}
      timeExpires: ${managementAgentInstallKeyTimeExpires}

    Create ManagementAgentInstallKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ManagementAgentInstallKey(name: string, args: ManagementAgentInstallKeyArgs, opts?: CustomResourceOptions);
    @overload
def ManagementAgentInstallKey(resource_name: str,
                              args: ManagementAgentInstallKeyArgs,
                              opts: Optional[ResourceOptions] = None)

@overload
def ManagementAgentInstallKey(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              compartment_id: Optional[str] = None,
                              display_name: Optional[str] = None,
                              allowed_key_install_count: Optional[int] = None,
                              is_unlimited: Optional[bool] = None,
                              time_expires: Optional[str] = None)
    func NewManagementAgentInstallKey(ctx *Context, name string, args ManagementAgentInstallKeyArgs, opts ...ResourceOption) (*ManagementAgentInstallKey, error)
    public ManagementAgentInstallKey(string name, ManagementAgentInstallKeyArgs args, CustomResourceOptions? opts = null)
    public ManagementAgentInstallKey(String name, ManagementAgentInstallKeyArgs args)
public ManagementAgentInstallKey(String name, ManagementAgentInstallKeyArgs args, CustomResourceOptions options)

    type: oci:ManagementAgent:ManagementAgentInstallKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ManagementAgentInstallKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ManagementAgentInstallKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ManagementAgentInstallKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ManagementAgentInstallKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ManagementAgentInstallKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var managementAgentInstallKeyResource = new Oci.ManagementAgent.ManagementAgentInstallKey("managementAgentInstallKeyResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    AllowedKeyInstallCount = 0,
    IsUnlimited = false,
    TimeExpires = "string",
});

    example, err := ManagementAgent.NewManagementAgentInstallKey(ctx, "managementAgentInstallKeyResource", &ManagementAgent.ManagementAgentInstallKeyArgs{
	CompartmentId:          pulumi.String("string"),
	DisplayName:            pulumi.String("string"),
	AllowedKeyInstallCount: pulumi.Int(0),
	IsUnlimited:            pulumi.Bool(false),
	TimeExpires:            pulumi.String("string"),
})

    var managementAgentInstallKeyResource = new ManagementAgentInstallKey("managementAgentInstallKeyResource", ManagementAgentInstallKeyArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .allowedKeyInstallCount(0)
    .isUnlimited(false)
    .timeExpires("string")
    .build());

    management_agent_install_key_resource = oci.management_agent.ManagementAgentInstallKey("managementAgentInstallKeyResource",
    compartment_id="string",
    display_name="string",
    allowed_key_install_count=0,
    is_unlimited=False,
    time_expires="string")

    const managementAgentInstallKeyResource = new oci.managementagent.ManagementAgentInstallKey("managementAgentInstallKeyResource", {
    compartmentId: "string",
    displayName: "string",
    allowedKeyInstallCount: 0,
    isUnlimited: false,
    timeExpires: "string",
});

    type: oci:ManagementAgent:ManagementAgentInstallKey
properties:
    allowedKeyInstallCount: 0
    compartmentId: string
    displayName: string
    isUnlimited: false
    timeExpires: string

    ManagementAgentInstallKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ManagementAgentInstallKey resource accepts the following input properties:

    CompartmentId string
    Compartment Identifier
    DisplayName string
    (Updatable) Management Agent install Key Name
    AllowedKeyInstallCount int
    Total number of install for this keys
    IsUnlimited bool
    If set to true, the install key has no expiration date or usage limit. Defaults to false
    TimeExpires string

    date after which key would expire after creation

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    CompartmentId string
    Compartment Identifier
    DisplayName string
    (Updatable) Management Agent install Key Name
    AllowedKeyInstallCount int
    Total number of install for this keys
    IsUnlimited bool
    If set to true, the install key has no expiration date or usage limit. Defaults to false
    TimeExpires string

    date after which key would expire after creation

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    Compartment Identifier
    displayName String
    (Updatable) Management Agent install Key Name
    allowedKeyInstallCount Integer
    Total number of install for this keys
    isUnlimited Boolean
    If set to true, the install key has no expiration date or usage limit. Defaults to false
    timeExpires String

    date after which key would expire after creation

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId string
    Compartment Identifier
    displayName string
    (Updatable) Management Agent install Key Name
    allowedKeyInstallCount number
    Total number of install for this keys
    isUnlimited boolean
    If set to true, the install key has no expiration date or usage limit. Defaults to false
    timeExpires string

    date after which key would expire after creation

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartment_id str
    Compartment Identifier
    display_name str
    (Updatable) Management Agent install Key Name
    allowed_key_install_count int
    Total number of install for this keys
    is_unlimited bool
    If set to true, the install key has no expiration date or usage limit. Defaults to false
    time_expires str

    date after which key would expire after creation

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    compartmentId String
    Compartment Identifier
    displayName String
    (Updatable) Management Agent install Key Name
    allowedKeyInstallCount Number
    Total number of install for this keys
    isUnlimited Boolean
    If set to true, the install key has no expiration date or usage limit. Defaults to false
    timeExpires String

    date after which key would expire after creation

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ManagementAgentInstallKey resource produces the following output properties:

    CreatedByPrincipalId string
    Principal id of user who created the Agent Install key
    CurrentKeyInstallCount int
    Total number of install for this keys
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    Status of Key
    TimeCreated string
    The time when Management Agent install Key was created. An RFC3339 formatted date time string
    TimeUpdated string
    The time when Management Agent install Key was updated. An RFC3339 formatted date time string
    CreatedByPrincipalId string
    Principal id of user who created the Agent Install key
    CurrentKeyInstallCount int
    Total number of install for this keys
    Id string
    The provider-assigned unique ID for this managed resource.
    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
    Status of Key
    TimeCreated string
    The time when Management Agent install Key was created. An RFC3339 formatted date time string
    TimeUpdated string
    The time when Management Agent install Key was updated. An RFC3339 formatted date time string
    createdByPrincipalId String
    Principal id of user who created the Agent Install key
    currentKeyInstallCount Integer
    Total number of install for this keys
    id String
    The provider-assigned unique ID for this managed resource.
    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
    Status of Key
    timeCreated String
    The time when Management Agent install Key was created. An RFC3339 formatted date time string
    timeUpdated String
    The time when Management Agent install Key was updated. An RFC3339 formatted date time string
    createdByPrincipalId string
    Principal id of user who created the Agent Install key
    currentKeyInstallCount number
    Total number of install for this keys
    id string
    The provider-assigned unique ID for this managed resource.
    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
    Status of Key
    timeCreated string
    The time when Management Agent install Key was created. An RFC3339 formatted date time string
    timeUpdated string
    The time when Management Agent install Key was updated. An RFC3339 formatted date time string
    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
    id str
    The provider-assigned unique ID for this managed resource.
    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
    Status of Key
    time_created str
    The time when Management Agent install Key was created. An RFC3339 formatted date time string
    time_updated str
    The time when Management Agent install Key was updated. An RFC3339 formatted date time string
    createdByPrincipalId String
    Principal id of user who created the Agent Install key
    currentKeyInstallCount Number
    Total number of install for this keys
    id String
    The provider-assigned unique ID for this managed resource.
    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
    Status of Key
    timeCreated String
    The time when Management Agent install Key was created. An RFC3339 formatted date time string
    timeUpdated String
    The time when Management Agent install Key was updated. An RFC3339 formatted date time string

    Look up Existing ManagementAgentInstallKey Resource

    Get an existing ManagementAgentInstallKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ManagementAgentInstallKeyState, opts?: CustomResourceOptions): ManagementAgentInstallKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_key_install_count: Optional[int] = None,
        compartment_id: Optional[str] = None,
        created_by_principal_id: Optional[str] = None,
        current_key_install_count: Optional[int] = None,
        display_name: Optional[str] = None,
        is_unlimited: Optional[bool] = None,
        key: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        state: Optional[str] = None,
        time_created: Optional[str] = None,
        time_expires: Optional[str] = None,
        time_updated: Optional[str] = None) -> ManagementAgentInstallKey
    func GetManagementAgentInstallKey(ctx *Context, name string, id IDInput, state *ManagementAgentInstallKeyState, opts ...ResourceOption) (*ManagementAgentInstallKey, error)
    public static ManagementAgentInstallKey Get(string name, Input<string> id, ManagementAgentInstallKeyState? state, CustomResourceOptions? opts = null)
    public static ManagementAgentInstallKey get(String name, Output<String> id, ManagementAgentInstallKeyState state, CustomResourceOptions options)
    resources:  _:    type: oci:ManagementAgent:ManagementAgentInstallKey    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    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
    (Updatable) Management Agent install Key Name
    IsUnlimited bool
    If set to true, the install key has no expiration date or usage limit. 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
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    (Updatable) Management Agent install Key Name
    IsUnlimited bool
    If set to true, the install key has no expiration date or usage limit. 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
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    (Updatable) Management Agent install Key Name
    isUnlimited Boolean
    If set to true, the install key has no expiration date or usage limit. 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
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    (Updatable) Management Agent install Key Name
    isUnlimited boolean
    If set to true, the install key has no expiration date or usage limit. 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
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    (Updatable) Management Agent install Key Name
    is_unlimited bool
    If set to true, the install key has no expiration date or usage limit. 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
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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
    (Updatable) Management Agent install Key Name
    isUnlimited Boolean
    If set to true, the install key has no expiration date or usage limit. 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
    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

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    timeUpdated String
    The time when Management Agent install Key was updated. An RFC3339 formatted date time string

    Import

    ManagementAgentInstallKeys can be imported using the id, e.g.

    $ pulumi import oci:ManagementAgent/managementAgentInstallKey:ManagementAgentInstallKey test_management_agent_install_key "id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci