Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.FleetAppsManagement.getProperties

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Example Usage

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

const testProperties = oci.FleetAppsManagement.getProperties({
    compartmentId: compartmentId,
    displayName: propertyDisplayName,
    id: propertyId,
    scope: propertyScope,
    state: propertyState,
});

import pulumi
import pulumi_oci as oci

test_properties = oci.FleetAppsManagement.get_properties(compartment_id=compartment_id,
    display_name=property_display_name,
    id=property_id,
    scope=property_scope,
    state=property_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := FleetAppsManagement.GetProperties(ctx, &fleetappsmanagement.GetPropertiesArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(propertyDisplayName),
			Id:            pulumi.StringRef(propertyId),
			Scope:         pulumi.StringRef(propertyScope),
			State:         pulumi.StringRef(propertyState),
		}, 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 testProperties = Oci.FleetAppsManagement.GetProperties.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = propertyDisplayName,
        Id = propertyId,
        Scope = propertyScope,
        State = propertyState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.FleetAppsManagement.FleetAppsManagementFunctions;
import com.pulumi.oci.FleetAppsManagement.inputs.GetPropertiesArgs;
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 testProperties = FleetAppsManagementFunctions.getProperties(GetPropertiesArgs.builder()
            .compartmentId(compartmentId)
            .displayName(propertyDisplayName)
            .id(propertyId)
            .scope(propertyScope)
            .state(propertyState)
            .build());

    }
}

variables:
  testProperties:
    fn::invoke:
      Function: oci:FleetAppsManagement:getProperties
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${propertyDisplayName}
        id: ${propertyId}
        scope: ${propertyScope}
        state: ${propertyState}

Using getProperties

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 getProperties(args: GetPropertiesArgs, opts?: InvokeOptions): Promise<GetPropertiesResult>
function getPropertiesOutput(args: GetPropertiesOutputArgs, opts?: InvokeOptions): Output<GetPropertiesResult>

def get_properties(compartment_id: Optional[str] = None,
                   display_name: Optional[str] = None,
                   filters: Optional[Sequence[_fleetappsmanagement.GetPropertiesFilter]] = None,
                   id: Optional[str] = None,
                   scope: Optional[str] = None,
                   state: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetPropertiesResult
def get_properties_output(compartment_id: Optional[pulumi.Input[str]] = None,
                   display_name: Optional[pulumi.Input[str]] = None,
                   filters: Optional[pulumi.Input[Sequence[pulumi.Input[_fleetappsmanagement.GetPropertiesFilterArgs]]]] = None,
                   id: Optional[pulumi.Input[str]] = None,
                   scope: Optional[pulumi.Input[str]] = None,
                   state: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetPropertiesResult]

func GetProperties(ctx *Context, args *GetPropertiesArgs, opts ...InvokeOption) (*GetPropertiesResult, error)
func GetPropertiesOutput(ctx *Context, args *GetPropertiesOutputArgs, opts ...InvokeOption) GetPropertiesResultOutput

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

public static class GetProperties 
{
    public static Task<GetPropertiesResult> InvokeAsync(GetPropertiesArgs args, InvokeOptions? opts = null)
    public static Output<GetPropertiesResult> Invoke(GetPropertiesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPropertiesResult> getProperties(GetPropertiesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:FleetAppsManagement/getProperties:getProperties
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters List<GetPropertiesFilter>
Id string: unique Property identifier
Scope string: A filter to return only resources their scope matches the given lifecycleState.
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.

CompartmentId string: The ID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters []GetPropertiesFilter
Id string: unique Property identifier
Scope string: A filter to return only resources their scope matches the given lifecycleState.
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<GetPropertiesFilter>
id String: unique Property identifier
scope String: A filter to return only resources their scope matches the given lifecycleState.
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.

compartmentId string: The ID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the entire display name given.
filters GetPropertiesFilter[]
id string: unique Property identifier
scope string: A filter to return only resources their scope matches the given lifecycleState.
state string: A filter to return only resources their lifecycleState matches the given lifecycleState.

compartment_id str: The ID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the entire display name given.
filters Sequence[fleetappsmanagement.GetPropertiesFilter]
id str: unique Property identifier
scope str: A filter to return only resources their scope matches the given lifecycleState.
state str: A filter to return only resources their lifecycleState matches the given lifecycleState.

compartmentId String: The ID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<Property Map>
id String: unique Property identifier
scope String: A filter to return only resources their scope matches the given lifecycleState.
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.

getProperties Result

The following output properties are available:

PropertyCollections List<GetPropertiesPropertyCollection>: The list of property_collection.
CompartmentId string: Tenancy OCID
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
Filters List<GetPropertiesFilter>
Id string: The OCID of the resource.
Scope string: The scope of the property
State string: The current state of the Property.

PropertyCollections []GetPropertiesPropertyCollection: The list of property_collection.
CompartmentId string: Tenancy OCID
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
Filters []GetPropertiesFilter
Id string: The OCID of the resource.
Scope string: The scope of the property
State string: The current state of the Property.

propertyCollections List<GetPropertiesPropertyCollection>: The list of property_collection.
compartmentId String: Tenancy OCID
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters List<GetPropertiesFilter>
id String: The OCID of the resource.
scope String: The scope of the property
state String: The current state of the Property.

propertyCollections GetPropertiesPropertyCollection[]: The list of property_collection.
compartmentId string: Tenancy OCID
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters GetPropertiesFilter[]
id string: The OCID of the resource.
scope string: The scope of the property
state string: The current state of the Property.

property_collections Sequence[fleetappsmanagement.GetPropertiesPropertyCollection]: The list of property_collection.
compartment_id str: Tenancy OCID
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters Sequence[fleetappsmanagement.GetPropertiesFilter]
id str: The OCID of the resource.
scope str: The scope of the property
state str: The current state of the Property.

propertyCollections List<Property Map>: The list of property_collection.
compartmentId String: Tenancy OCID
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. Example: My new resource
filters List<Property Map>
id String: The OCID of the resource.
scope String: The scope of the property
state String: The current state of the Property.

Supporting Types

GetPropertiesFilter

Name string
Values List<string>: Values of the property (must be a single value if selection = 'single choice')
Regex bool

Name string
Values []string: Values of the property (must be a single value if selection = 'single choice')
Regex bool

name String
values List<String>: Values of the property (must be a single value if selection = 'single choice')
regex Boolean

name string
values string[]: Values of the property (must be a single value if selection = 'single choice')
regex boolean

name str
values Sequence[str]: Values of the property (must be a single value if selection = 'single choice')
regex bool

name String
values List<String>: Values of the property (must be a single value if selection = 'single choice')
regex Boolean

GetPropertiesPropertyCollection

Items List<GetPropertiesPropertyCollectionItem>

Items []GetPropertiesPropertyCollectionItem

items List<GetPropertiesPropertyCollectionItem>

items GetPropertiesPropertyCollectionItem[]

items Sequence[fleetappsmanagement.GetPropertiesPropertyCollectionItem]

items List<Property Map>

GetPropertiesPropertyCollectionItem

CompartmentId string: The ID of the compartment in which to list resources.
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: A filter to return only resources that match the entire display name given.
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: unique Property identifier
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.
ResourceRegion string: Associated region
Scope string: A filter to return only resources their scope matches the given lifecycleState.
Selection string: Text selection of the category
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
Type string: The type of the property.
ValueType string: Format of the value
Values List<string>: Values of the property (must be a single value if selection = 'single choice')

CompartmentId string: The ID of the compartment in which to list resources.
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: A filter to return only resources that match the entire display name given.
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: unique Property identifier
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.
ResourceRegion string: Associated region
Scope string: A filter to return only resources their scope matches the given lifecycleState.
Selection string: Text selection of the category
State string: A filter to return only resources their lifecycleState matches the given lifecycleState.
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
Type string: The type of the property.
ValueType string: Format of the value
Values []string: Values of the property (must be a single value if selection = 'single choice')

compartmentId String: The ID of the compartment in which to list resources.
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: A filter to return only resources that match the entire display name given.
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: unique Property identifier
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.
resourceRegion String: Associated region
scope String: A filter to return only resources their scope matches the given lifecycleState.
selection String: Text selection of the category
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.
type String: The type of the property.
valueType String: Format of the value
values List<String>: Values of the property (must be a single value if selection = 'single choice')

compartmentId string: The ID of the compartment in which to list resources.
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: A filter to return only resources that match the entire display name given.
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: unique Property identifier
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.
resourceRegion string: Associated region
scope string: A filter to return only resources their scope matches the given lifecycleState.
selection string: Text selection of the category
state string: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated string: The time this resource was last updated. An RFC3339 formatted datetime string.
type string: The type of the property.
valueType string: Format of the value
values string[]: Values of the property (must be a single value if selection = 'single choice')

compartment_id str: The ID of the compartment in which to list resources.
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: A filter to return only resources that match the entire display name given.
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: unique Property identifier
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.
resource_region str: Associated region
scope str: A filter to return only resources their scope matches the given lifecycleState.
selection str: Text selection of the category
state str: A filter to return only resources their lifecycleState matches the given lifecycleState.
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time this resource was created. An RFC3339 formatted datetime string.
time_updated str: The time this resource was last updated. An RFC3339 formatted datetime string.
type str: The type of the property.
value_type str: Format of the value
values Sequence[str]: Values of the property (must be a single value if selection = 'single choice')

compartmentId String: The ID of the compartment in which to list resources.
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: A filter to return only resources that match the entire display name given.
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: unique Property identifier
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.
resourceRegion String: Associated region
scope String: A filter to return only resources their scope matches the given lifecycleState.
selection String: Text selection of the category
state String: A filter to return only resources their lifecycleState matches the given lifecycleState.
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time this resource was created. An RFC3339 formatted datetime string.
timeUpdated String: The time this resource was last updated. An RFC3339 formatted datetime string.
type String: The type of the property.
valueType String: Format of the value
values List<String>: Values of the property (must be a single value if selection = 'single choice')

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.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.FleetAppsManagement.getProperties

On this page

On this page

Example Usage

Using getProperties

getProperties Result

Supporting Types

GetPropertiesFilter

GetPropertiesPropertyCollection

GetPropertiesPropertyCollectionItem

Package Details

On this page

On this page