mongodbatlas.getOrganizations

Explore with Pulumi AI

MongoDB Atlas v3.15.0 published on Tuesday, Apr 30, 2024 by Pulumi

Example Usage

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

const test = mongodbatlas.getOrganizations({
    pageNum: 1,
    itemsPerPage: 5,
});

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.get_organizations(page_num=1,
    items_per_page=5)

package main

import (
	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mongodbatlas.LookupOrganizations(ctx, &mongodbatlas.LookupOrganizationsArgs{
			PageNum:      pulumi.IntRef(1),
			ItemsPerPage: pulumi.IntRef(5),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var test = Mongodbatlas.GetOrganizations.Invoke(new()
    {
        PageNum = 1,
        ItemsPerPage = 5,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetOrganizationsArgs;
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 test = MongodbatlasFunctions.getOrganizations(GetOrganizationsArgs.builder()
            .pageNum(1)
            .itemsPerPage(5)
            .build());

    }
}

variables:
  test:
    fn::invoke:
      Function: mongodbatlas:getOrganizations
      Arguments:
        pageNum: 1
        itemsPerPage: 5

Using getOrganizations

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 getOrganizations(args: GetOrganizationsArgs, opts?: InvokeOptions): Promise<GetOrganizationsResult>
function getOrganizationsOutput(args: GetOrganizationsOutputArgs, opts?: InvokeOptions): Output<GetOrganizationsResult>

def get_organizations(items_per_page: Optional[int] = None,
                      name: Optional[str] = None,
                      page_num: Optional[int] = None,
                      opts: Optional[InvokeOptions] = None) -> GetOrganizationsResult
def get_organizations_output(items_per_page: Optional[pulumi.Input[int]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      page_num: Optional[pulumi.Input[int]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationsResult]

func LookupOrganizations(ctx *Context, args *LookupOrganizationsArgs, opts ...InvokeOption) (*LookupOrganizationsResult, error)
func LookupOrganizationsOutput(ctx *Context, args *LookupOrganizationsOutputArgs, opts ...InvokeOption) LookupOrganizationsResultOutput

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

public static class GetOrganizations 
{
    public static Task<GetOrganizationsResult> InvokeAsync(GetOrganizationsArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationsResult> Invoke(GetOrganizationsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrganizationsResult> getOrganizations(GetOrganizationsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: mongodbatlas:index/getOrganizations:getOrganizations
  arguments:
    # arguments dictionary

The following arguments are supported:

ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
Name string
PageNum int: The page to return. Defaults to 1.

ItemsPerPage int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
Name string
PageNum int: The page to return. Defaults to 1.

itemsPerPage Integer: Number of items to return per page, up to a maximum of 500. Defaults to 100.
name String
pageNum Integer: The page to return. Defaults to 1.

itemsPerPage number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
name string
pageNum number: The page to return. Defaults to 1.

items_per_page int: Number of items to return per page, up to a maximum of 500. Defaults to 100.
name str
page_num int: The page to return. Defaults to 1.

itemsPerPage Number: Number of items to return per page, up to a maximum of 500. Defaults to 100.
name String
pageNum Number: The page to return. Defaults to 1.