planetscale.getOrganization

Explore with Pulumi AI

planetscale 0.6.0 published on Sunday, Apr 27, 2025 by planetscale

planetscale/terraform-provider-planetscale

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = planetscale.getOrganization({
    name: "example",
});
export const org = example;

import pulumi
import pulumi_planetscale as planetscale

example = planetscale.get_organization(name="example")
pulumi.export("org", example)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/planetscale/planetscale"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.GetOrganization(ctx, &planetscale.GetOrganizationArgs{
			Name: "example",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("org", example)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Planetscale.GetOrganization.Invoke(new()
    {
        Name = "example",
    });

    return new Dictionary<string, object?>
    {
        ["org"] = example,
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetOrganizationArgs;
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 example = PlanetscaleFunctions.getOrganization(GetOrganizationArgs.builder()
            .name("example")
            .build());

        ctx.export("org", example.applyValue(getOrganizationResult -> getOrganizationResult));
    }
}

variables:
  example:
    fn::invoke:
      function: planetscale:getOrganization
      arguments:
        name: example
outputs:
  org: ${example}

Using getOrganization

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.

TypeScript
Python
Go
C#
Java
YAML

function getOrganization(args: GetOrganizationArgs, opts?: InvokeOptions): Promise<GetOrganizationResult>
function getOrganizationOutput(args: GetOrganizationOutputArgs, opts?: InvokeOptions): Output<GetOrganizationResult>

def get_organization(name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOrganizationResult
def get_organization_output(name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationResult]

func GetOrganization(ctx *Context, args *GetOrganizationArgs, opts ...InvokeOption) (*GetOrganizationResult, error)
func GetOrganizationOutput(ctx *Context, args *GetOrganizationOutputArgs, opts ...InvokeOption) GetOrganizationResultOutput

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

public static class GetOrganization 
{
    public static Task<GetOrganizationResult> InvokeAsync(GetOrganizationArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationResult> Invoke(GetOrganizationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)
public static Output<GetOrganizationResult> getOrganization(GetOrganizationArgs args, InvokeOptions options)

fn::invoke:
  function: planetscale:index/getOrganization:getOrganization
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name of the organization.

Name string: The name of the organization.

name String: The name of the organization.

name string: The name of the organization.

name str: The name of the organization.

name String: The name of the organization.

getOrganization Result

The following output properties are available:

BillingEmail string: The billing email of the organization.
CreatedAt string: When the organization was created.
DatabaseCount double: The number of databases in the organization.
Features GetOrganizationFeatures: Features that are enabled on the organization.
Flags GetOrganizationFlags: .
HasPastDueInvoices bool: Whether or not the organization has past due billing invoices.
Id string: The ID for the organization.
IdpManagedRoles bool: Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
Name string: The name of the organization.
Plan string: The billing plan of the organization.
SingleTenancy bool: Whether or not the organization has single tenancy enabled.
Sso bool: Whether or not SSO is enabled on the organization.
SsoDirectory bool: Whether or not the organization uses a WorkOS directory.
SsoPortalUrl string: The URL of the organization's SSO portal.
UpdatedAt string: When the organization was last updated.
ValidBillingInfo bool: Whether or not the organization's billing information is valid.

BillingEmail string: The billing email of the organization.
CreatedAt string: When the organization was created.
DatabaseCount float64: The number of databases in the organization.
Features GetOrganizationFeatures: Features that are enabled on the organization.
Flags GetOrganizationFlags: .
HasPastDueInvoices bool: Whether or not the organization has past due billing invoices.
Id string: The ID for the organization.
IdpManagedRoles bool: Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
Name string: The name of the organization.
Plan string: The billing plan of the organization.
SingleTenancy bool: Whether or not the organization has single tenancy enabled.
Sso bool: Whether or not SSO is enabled on the organization.
SsoDirectory bool: Whether or not the organization uses a WorkOS directory.
SsoPortalUrl string: The URL of the organization's SSO portal.
UpdatedAt string: When the organization was last updated.
ValidBillingInfo bool: Whether or not the organization's billing information is valid.

billingEmail String: The billing email of the organization.
createdAt String: When the organization was created.
databaseCount Double: The number of databases in the organization.
features GetOrganizationFeatures: Features that are enabled on the organization.
flags GetOrganizationFlags: .
hasPastDueInvoices Boolean: Whether or not the organization has past due billing invoices.
id String: The ID for the organization.
idpManagedRoles Boolean: Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
name String: The name of the organization.
plan String: The billing plan of the organization.
singleTenancy Boolean: Whether or not the organization has single tenancy enabled.
sso Boolean: Whether or not SSO is enabled on the organization.
ssoDirectory Boolean: Whether or not the organization uses a WorkOS directory.
ssoPortalUrl String: The URL of the organization's SSO portal.
updatedAt String: When the organization was last updated.
validBillingInfo Boolean: Whether or not the organization's billing information is valid.

billingEmail string: The billing email of the organization.
createdAt string: When the organization was created.
databaseCount number: The number of databases in the organization.
features GetOrganizationFeatures: Features that are enabled on the organization.
flags GetOrganizationFlags: .
hasPastDueInvoices boolean: Whether or not the organization has past due billing invoices.
id string: The ID for the organization.
idpManagedRoles boolean: Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
name string: The name of the organization.
plan string: The billing plan of the organization.
singleTenancy boolean: Whether or not the organization has single tenancy enabled.
sso boolean: Whether or not SSO is enabled on the organization.
ssoDirectory boolean: Whether or not the organization uses a WorkOS directory.
ssoPortalUrl string: The URL of the organization's SSO portal.
updatedAt string: When the organization was last updated.
validBillingInfo boolean: Whether or not the organization's billing information is valid.

billing_email str: The billing email of the organization.
created_at str: When the organization was created.
database_count float: The number of databases in the organization.
features GetOrganizationFeatures: Features that are enabled on the organization.
flags GetOrganizationFlags: .
has_past_due_invoices bool: Whether or not the organization has past due billing invoices.
id str: The ID for the organization.
idp_managed_roles bool: Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
name str: The name of the organization.
plan str: The billing plan of the organization.
single_tenancy bool: Whether or not the organization has single tenancy enabled.
sso bool: Whether or not SSO is enabled on the organization.
sso_directory bool: Whether or not the organization uses a WorkOS directory.
sso_portal_url str: The URL of the organization's SSO portal.
updated_at str: When the organization was last updated.
valid_billing_info bool: Whether or not the organization's billing information is valid.

billingEmail String: The billing email of the organization.
createdAt String: When the organization was created.
databaseCount Number: The number of databases in the organization.
features Property Map: Features that are enabled on the organization.
flags Property Map: .
hasPastDueInvoices Boolean: Whether or not the organization has past due billing invoices.
id String: The ID for the organization.
idpManagedRoles Boolean: Whether or not the IdP provider is be responsible for managing roles in PlanetScale.
name String: The name of the organization.
plan String: The billing plan of the organization.
singleTenancy Boolean: Whether or not the organization has single tenancy enabled.
sso Boolean: Whether or not SSO is enabled on the organization.
ssoDirectory Boolean: Whether or not the organization uses a WorkOS directory.
ssoPortalUrl String: The URL of the organization's SSO portal.
updatedAt String: When the organization was last updated.
validBillingInfo Boolean: Whether or not the organization's billing information is valid.