Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.Tenantmanagercontrolplane.getSenderInvitations

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testSenderInvitations = oci.Tenantmanagercontrolplane.getSenderInvitations({
    compartmentId: compartmentId,
    displayName: senderInvitationDisplayName,
    recipientTenancyId: testTenancy.id,
    state: senderInvitationState,
    status: senderInvitationStatus,
});

import pulumi
import pulumi_oci as oci

test_sender_invitations = oci.Tenantmanagercontrolplane.get_sender_invitations(compartment_id=compartment_id,
    display_name=sender_invitation_display_name,
    recipient_tenancy_id=test_tenancy["id"],
    state=sender_invitation_state,
    status=sender_invitation_status)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tenantmanagercontrolplane.GetSenderInvitations(ctx, &tenantmanagercontrolplane.GetSenderInvitationsArgs{
			CompartmentId:      compartmentId,
			DisplayName:        pulumi.StringRef(senderInvitationDisplayName),
			RecipientTenancyId: pulumi.StringRef(testTenancy.Id),
			State:              pulumi.StringRef(senderInvitationState),
			Status:             pulumi.StringRef(senderInvitationStatus),
		}, 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 testSenderInvitations = Oci.Tenantmanagercontrolplane.GetSenderInvitations.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = senderInvitationDisplayName,
        RecipientTenancyId = testTenancy.Id,
        State = senderInvitationState,
        Status = senderInvitationStatus,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Tenantmanagercontrolplane.TenantmanagercontrolplaneFunctions;
import com.pulumi.oci.Tenantmanagercontrolplane.inputs.GetSenderInvitationsArgs;
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 testSenderInvitations = TenantmanagercontrolplaneFunctions.getSenderInvitations(GetSenderInvitationsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(senderInvitationDisplayName)
            .recipientTenancyId(testTenancy.id())
            .state(senderInvitationState)
            .status(senderInvitationStatus)
            .build());

    }
}

variables:
  testSenderInvitations:
    fn::invoke:
      function: oci:Tenantmanagercontrolplane:getSenderInvitations
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${senderInvitationDisplayName}
        recipientTenancyId: ${testTenancy.id}
        state: ${senderInvitationState}
        status: ${senderInvitationStatus}

Using getSenderInvitations

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 getSenderInvitations(args: GetSenderInvitationsArgs, opts?: InvokeOptions): Promise<GetSenderInvitationsResult>
function getSenderInvitationsOutput(args: GetSenderInvitationsOutputArgs, opts?: InvokeOptions): Output<GetSenderInvitationsResult>

def get_sender_invitations(compartment_id: Optional[str] = None,
                           display_name: Optional[str] = None,
                           filters: Optional[Sequence[GetSenderInvitationsFilter]] = None,
                           recipient_tenancy_id: Optional[str] = None,
                           state: Optional[str] = None,
                           status: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSenderInvitationsResult
def get_sender_invitations_output(compartment_id: Optional[pulumi.Input[str]] = None,
                           display_name: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetSenderInvitationsFilterArgs]]]] = None,
                           recipient_tenancy_id: Optional[pulumi.Input[str]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           status: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSenderInvitationsResult]

func GetSenderInvitations(ctx *Context, args *GetSenderInvitationsArgs, opts ...InvokeOption) (*GetSenderInvitationsResult, error)
func GetSenderInvitationsOutput(ctx *Context, args *GetSenderInvitationsOutputArgs, opts ...InvokeOption) GetSenderInvitationsResultOutput

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

public static class GetSenderInvitations 
{
    public static Task<GetSenderInvitationsResult> InvokeAsync(GetSenderInvitationsArgs args, InvokeOptions? opts = null)
    public static Output<GetSenderInvitationsResult> Invoke(GetSenderInvitationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSenderInvitationsResult> getSenderInvitations(GetSenderInvitationsArgs args, InvokeOptions options)
public static Output<GetSenderInvitationsResult> getSenderInvitations(GetSenderInvitationsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:Tenantmanagercontrolplane/getSenderInvitations:getSenderInvitations
  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<GetSenderInvitationsFilter>
RecipientTenancyId string: The tenancy that the invitation is addressed to.
State string: The lifecycle state of the resource.
Status string: The status of the sender invitation.

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 []GetSenderInvitationsFilter
RecipientTenancyId string: The tenancy that the invitation is addressed to.
State string: The lifecycle state of the resource.
Status string: The status of the sender invitation.

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<GetSenderInvitationsFilter>
recipientTenancyId String: The tenancy that the invitation is addressed to.
state String: The lifecycle state of the resource.
status String: The status of the sender invitation.

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 GetSenderInvitationsFilter[]
recipientTenancyId string: The tenancy that the invitation is addressed to.
state string: The lifecycle state of the resource.
status string: The status of the sender invitation.

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[GetSenderInvitationsFilter]
recipient_tenancy_id str: The tenancy that the invitation is addressed to.
state str: The lifecycle state of the resource.
status str: The status of the sender invitation.

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>
recipientTenancyId String: The tenancy that the invitation is addressed to.
state String: The lifecycle state of the resource.
status String: The status of the sender invitation.

getSenderInvitations Result

The following output properties are available:

CompartmentId string: OCID of the sender tenancy.
Id string: The provider-assigned unique ID for this managed resource.
SenderInvitationCollections List<GetSenderInvitationsSenderInvitationCollection>: The list of sender_invitation_collection.
DisplayName string: A user-created name to describe the invitation. Avoid entering confidential information.
Filters List<GetSenderInvitationsFilter>
RecipientTenancyId string: OCID of the recipient tenancy.
State string: Lifecycle state of the sender invitation.
Status string: Status of the sender invitation.

CompartmentId string: OCID of the sender tenancy.
Id string: The provider-assigned unique ID for this managed resource.
SenderInvitationCollections []GetSenderInvitationsSenderInvitationCollection: The list of sender_invitation_collection.
DisplayName string: A user-created name to describe the invitation. Avoid entering confidential information.
Filters []GetSenderInvitationsFilter
RecipientTenancyId string: OCID of the recipient tenancy.
State string: Lifecycle state of the sender invitation.
Status string: Status of the sender invitation.

compartmentId String: OCID of the sender tenancy.
id String: The provider-assigned unique ID for this managed resource.
senderInvitationCollections List<GetSenderInvitationsSenderInvitationCollection>: The list of sender_invitation_collection.
displayName String: A user-created name to describe the invitation. Avoid entering confidential information.
filters List<GetSenderInvitationsFilter>
recipientTenancyId String: OCID of the recipient tenancy.
state String: Lifecycle state of the sender invitation.
status String: Status of the sender invitation.

compartmentId string: OCID of the sender tenancy.
id string: The provider-assigned unique ID for this managed resource.
senderInvitationCollections GetSenderInvitationsSenderInvitationCollection[]: The list of sender_invitation_collection.
displayName string: A user-created name to describe the invitation. Avoid entering confidential information.
filters GetSenderInvitationsFilter[]
recipientTenancyId string: OCID of the recipient tenancy.
state string: Lifecycle state of the sender invitation.
status string: Status of the sender invitation.

compartment_id str: OCID of the sender tenancy.
id str: The provider-assigned unique ID for this managed resource.
sender_invitation_collections Sequence[GetSenderInvitationsSenderInvitationCollection]: The list of sender_invitation_collection.
display_name str: A user-created name to describe the invitation. Avoid entering confidential information.
filters Sequence[GetSenderInvitationsFilter]
recipient_tenancy_id str: OCID of the recipient tenancy.
state str: Lifecycle state of the sender invitation.
status str: Status of the sender invitation.

compartmentId String: OCID of the sender tenancy.
id String: The provider-assigned unique ID for this managed resource.
senderInvitationCollections List<Property Map>: The list of sender_invitation_collection.
displayName String: A user-created name to describe the invitation. Avoid entering confidential information.
filters List<Property Map>
recipientTenancyId String: OCID of the recipient tenancy.
state String: Lifecycle state of the sender invitation.
status String: Status of the sender invitation.

Supporting Types

GetSenderInvitationsFilter

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

GetSenderInvitationsSenderInvitationCollection

Items List<GetSenderInvitationsSenderInvitationCollectionItem>

Items []GetSenderInvitationsSenderInvitationCollectionItem

items List<GetSenderInvitationsSenderInvitationCollectionItem>

items GetSenderInvitationsSenderInvitationCollectionItem[]

items Sequence[GetSenderInvitationsSenderInvitationCollectionItem]

items List<Property Map>

GetSenderInvitationsSenderInvitationCollectionItem

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: OCID of the sender invitation.
RecipientEmailAddress string: Email address of the recipient.
RecipientInvitationId string: OCID of the corresponding recipient invitation.
RecipientTenancyId string: The tenancy that the invitation is addressed to.
State string: The lifecycle state of the resource.
Status string: The status of the sender invitation.
Subjects List<string>: The list of subjects the invitation contains.
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: Date and time when the sender invitation was created.
TimeUpdated string: Date and time when the sender invitation was last updated.

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: OCID of the sender invitation.
RecipientEmailAddress string: Email address of the recipient.
RecipientInvitationId string: OCID of the corresponding recipient invitation.
RecipientTenancyId string: The tenancy that the invitation is addressed to.
State string: The lifecycle state of the resource.
Status string: The status of the sender invitation.
Subjects []string: The list of subjects the invitation contains.
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: Date and time when the sender invitation was created.
TimeUpdated string: Date and time when the sender invitation was last updated.

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: OCID of the sender invitation.
recipientEmailAddress String: Email address of the recipient.
recipientInvitationId String: OCID of the corresponding recipient invitation.
recipientTenancyId String: The tenancy that the invitation is addressed to.
state String: The lifecycle state of the resource.
status String: The status of the sender invitation.
subjects List<String>: The list of subjects the invitation contains.
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: Date and time when the sender invitation was created.
timeUpdated String: Date and time when the sender invitation was last updated.

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: OCID of the sender invitation.
recipientEmailAddress string: Email address of the recipient.
recipientInvitationId string: OCID of the corresponding recipient invitation.
recipientTenancyId string: The tenancy that the invitation is addressed to.
state string: The lifecycle state of the resource.
status string: The status of the sender invitation.
subjects string[]: The list of subjects the invitation contains.
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: Date and time when the sender invitation was created.
timeUpdated string: Date and time when the sender invitation was last updated.

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: OCID of the sender invitation.
recipient_email_address str: Email address of the recipient.
recipient_invitation_id str: OCID of the corresponding recipient invitation.
recipient_tenancy_id str: The tenancy that the invitation is addressed to.
state str: The lifecycle state of the resource.
status str: The status of the sender invitation.
subjects Sequence[str]: The list of subjects the invitation contains.
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: Date and time when the sender invitation was created.
time_updated str: Date and time when the sender invitation was last updated.

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: OCID of the sender invitation.
recipientEmailAddress String: Email address of the recipient.
recipientInvitationId String: OCID of the corresponding recipient invitation.
recipientTenancyId String: The tenancy that the invitation is addressed to.
state String: The lifecycle state of the resource.
status String: The status of the sender invitation.
subjects List<String>: The list of subjects the invitation contains.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: Date and time when the sender invitation was created.
timeUpdated String: Date and time when the sender invitation was last updated.

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.33.0 published on Thursday, May 1, 2025 by Pulumi

pulumi/pulumi-oci

oci.Tenantmanagercontrolplane.getSenderInvitations

On this page

On this page

Example Usage

Using getSenderInvitations

getSenderInvitations Result

Supporting Types

GetSenderInvitationsFilter

GetSenderInvitationsSenderInvitationCollection

GetSenderInvitationsSenderInvitationCollectionItem

Package Details

On this page

On this page