Oracle Cloud Infrastructure v2.17.0, Nov 15 24

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

oci.Identity.getTagNamespaces

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 testTagNamespaces = oci.Identity.getTagNamespaces({
    compartmentId: compartmentId,
    includeSubcompartments: tagNamespaceIncludeSubcompartments,
    state: tagNamespaceState,
});

import pulumi
import pulumi_oci as oci

test_tag_namespaces = oci.Identity.get_tag_namespaces(compartment_id=compartment_id,
    include_subcompartments=tag_namespace_include_subcompartments,
    state=tag_namespace_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Identity.GetTagNamespaces(ctx, &identity.GetTagNamespacesArgs{
			CompartmentId:          compartmentId,
			IncludeSubcompartments: pulumi.BoolRef(tagNamespaceIncludeSubcompartments),
			State:                  pulumi.StringRef(tagNamespaceState),
		}, 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 testTagNamespaces = Oci.Identity.GetTagNamespaces.Invoke(new()
    {
        CompartmentId = compartmentId,
        IncludeSubcompartments = tagNamespaceIncludeSubcompartments,
        State = tagNamespaceState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Identity.IdentityFunctions;
import com.pulumi.oci.Identity.inputs.GetTagNamespacesArgs;
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 testTagNamespaces = IdentityFunctions.getTagNamespaces(GetTagNamespacesArgs.builder()
            .compartmentId(compartmentId)
            .includeSubcompartments(tagNamespaceIncludeSubcompartments)
            .state(tagNamespaceState)
            .build());

    }
}

variables:
  testTagNamespaces:
    fn::invoke:
      Function: oci:Identity:getTagNamespaces
      Arguments:
        compartmentId: ${compartmentId}
        includeSubcompartments: ${tagNamespaceIncludeSubcompartments}
        state: ${tagNamespaceState}

Using getTagNamespaces

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 getTagNamespaces(args: GetTagNamespacesArgs, opts?: InvokeOptions): Promise<GetTagNamespacesResult>
function getTagNamespacesOutput(args: GetTagNamespacesOutputArgs, opts?: InvokeOptions): Output<GetTagNamespacesResult>

def get_tag_namespaces(compartment_id: Optional[str] = None,
                       filters: Optional[Sequence[_identity.GetTagNamespacesFilter]] = None,
                       include_subcompartments: Optional[bool] = None,
                       state: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetTagNamespacesResult
def get_tag_namespaces_output(compartment_id: Optional[pulumi.Input[str]] = None,
                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[_identity.GetTagNamespacesFilterArgs]]]] = None,
                       include_subcompartments: Optional[pulumi.Input[bool]] = None,
                       state: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetTagNamespacesResult]

func GetTagNamespaces(ctx *Context, args *GetTagNamespacesArgs, opts ...InvokeOption) (*GetTagNamespacesResult, error)
func GetTagNamespacesOutput(ctx *Context, args *GetTagNamespacesOutputArgs, opts ...InvokeOption) GetTagNamespacesResultOutput

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

public static class GetTagNamespaces 
{
    public static Task<GetTagNamespacesResult> InvokeAsync(GetTagNamespacesArgs args, InvokeOptions? opts = null)
    public static Output<GetTagNamespacesResult> Invoke(GetTagNamespacesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTagNamespacesResult> getTagNamespaces(GetTagNamespacesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Identity/getTagNamespaces:getTagNamespaces
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
Filters List<GetTagNamespacesFilter>
IncludeSubcompartments bool: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
Filters []GetTagNamespacesFilter
IncludeSubcompartments bool: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
filters List<GetTagNamespacesFilter>
includeSubcompartments Boolean: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
filters GetTagNamespacesFilter[]
includeSubcompartments boolean: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
state string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartment_id str: The OCID of the compartment (remember that the tenancy is simply the root compartment).
filters Sequence[identity.GetTagNamespacesFilter]
include_subcompartments bool: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
state str: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
filters List<Property Map>
includeSubcompartments Boolean: An optional boolean parameter indicating whether to retrieve all tag namespaces in subcompartments. If this parameter is not specified, only the tag namespaces defined in the specified compartment are retrieved.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

getTagNamespaces Result

The following output properties are available:

CompartmentId string: The OCID of the compartment that contains the tag namespace.
Id string: The provider-assigned unique ID for this managed resource.
TagNamespaces List<GetTagNamespacesTagNamespace>: The list of tag_namespaces.
Filters List<GetTagNamespacesFilter>
IncludeSubcompartments bool
State string: The tagnamespace's current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it.

CompartmentId string: The OCID of the compartment that contains the tag namespace.
Id string: The provider-assigned unique ID for this managed resource.
TagNamespaces []GetTagNamespacesTagNamespace: The list of tag_namespaces.
Filters []GetTagNamespacesFilter
IncludeSubcompartments bool
State string: The tagnamespace's current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it.

compartmentId String: The OCID of the compartment that contains the tag namespace.
id String: The provider-assigned unique ID for this managed resource.
tagNamespaces List<GetTagNamespacesTagNamespace>: The list of tag_namespaces.
filters List<GetTagNamespacesFilter>
includeSubcompartments Boolean
state String: The tagnamespace's current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it.

compartmentId string: The OCID of the compartment that contains the tag namespace.
id string: The provider-assigned unique ID for this managed resource.
tagNamespaces GetTagNamespacesTagNamespace[]: The list of tag_namespaces.
filters GetTagNamespacesFilter[]
includeSubcompartments boolean
state string: The tagnamespace's current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it.

compartment_id str: The OCID of the compartment that contains the tag namespace.
id str: The provider-assigned unique ID for this managed resource.
tag_namespaces Sequence[identity.GetTagNamespacesTagNamespace]: The list of tag_namespaces.
filters Sequence[identity.GetTagNamespacesFilter]
include_subcompartments bool
state str: The tagnamespace's current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it.

compartmentId String: The OCID of the compartment that contains the tag namespace.
id String: The provider-assigned unique ID for this managed resource.
tagNamespaces List<Property Map>: The list of tag_namespaces.
filters List<Property Map>
includeSubcompartments Boolean
state String: The tagnamespace's current state. After creating a tagnamespace, make sure its lifecycleState is ACTIVE before using it. After retiring a tagnamespace, make sure its lifecycleState is INACTIVE before using it.

Supporting Types

GetTagNamespacesFilter

Name string: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
Values List<string>
Regex bool

Name string: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
Values []string
Regex bool

name String: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
values List<String>
regex Boolean

name string: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
values string[]
regex boolean

name str: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
values Sequence[str]
regex bool

name String: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
values List<String>
regex Boolean

GetTagNamespacesTagNamespace

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: The description you assign to the tag namespace.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the tag namespace.
IsRetired bool: Whether the tag namespace is retired. For more information, see Retiring Key Definitions and Namespace Definitions.
Name string: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
TimeCreated string: Date and time the tag namespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: The description you assign to the tag namespace.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the tag namespace.
IsRetired bool: Whether the tag namespace is retired. For more information, see Retiring Key Definitions and Namespace Definitions.
Name string: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
TimeCreated string: Date and time the tag namespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: The description you assign to the tag namespace.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the tag namespace.
isRetired Boolean: Whether the tag namespace is retired. For more information, see Retiring Key Definitions and Namespace Definitions.
name String: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated String: Date and time the tag namespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: The description you assign to the tag namespace.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of the tag namespace.
isRetired boolean: Whether the tag namespace is retired. For more information, see Retiring Key Definitions and Namespace Definitions.
name string: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
state string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated string: Date and time the tag namespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartment_id str: The OCID of the compartment (remember that the tenancy is simply the root compartment).
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: The description you assign to the tag namespace.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of the tag namespace.
is_retired bool: Whether the tag namespace is retired. For more information, see Retiring Key Definitions and Namespace Definitions.
name str: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
state str: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
time_created str: Date and time the tag namespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: The description you assign to the tag namespace.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the tag namespace.
isRetired Boolean: Whether the tag namespace is retired. For more information, see Retiring Key Definitions and Namespace Definitions.
name String: The name of the tag namespace. It must be unique across all tag namespaces in the tenancy and cannot be changed.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated String: Date and time the tag namespace was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

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.Identity.getTagNamespaces

On this page

On this page

Example Usage

Using getTagNamespaces

getTagNamespaces Result

Supporting Types

GetTagNamespacesFilter

GetTagNamespacesTagNamespace

Package Details

On this page

On this page