Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Equinix
  4. API Docs
  5. metal
  6. getOrganization
Viewing docs for Equinix v0.30.0
published on Thursday, May 14, 2026 by Equinix
Schema (JSON)
equinix/pulumi-equinix

equinix.metal.getOrganization

equinix logo
Viewing docs for Equinix v0.30.0
published on Thursday, May 14, 2026 by Equinix
Schema (JSON)
equinix/pulumi-equinix

    Deprecation Notice Equinix Metal will reach end of life on June 30, 2026. All Metal data sources will be removed in version 5.0.0 of this provider. Use version 4.x of this provider for continued use through sunset. See https://docs.equinix.com/metal/ for more information.

    Provides an Equinix Metal organization datasource.

    Example Usage

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

const test = equinix.metal.getOrganization({
    organizationId: local.org_id,
});
export const projectsInTheOrg = test.then(test => test.projectIds);

    import pulumi
import pulumi_equinix as equinix

test = equinix.metal.get_organization(organization_id=local["org_id"])
pulumi.export("projectsInTheOrg", test.project_ids)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := metal.LookupOrganization(ctx, &metal.LookupOrganizationArgs{
			OrganizationId: pulumi.StringRef(local.Org_id),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("projectsInTheOrg", test.ProjectIds)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = Equinix.Metal.GetOrganization.Invoke(new()
    {
        OrganizationId = local.Org_id,
    });

    return new Dictionary<string, object?>
    {
        ["projectsInTheOrg"] = test.Apply(getOrganizationResult => getOrganizationResult.ProjectIds),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.metal.MetalFunctions;
import com.pulumi.equinix.metal.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 test = MetalFunctions.getOrganization(GetOrganizationArgs.builder()
            .organizationId(local.org_id())
            .build());

        ctx.export("projectsInTheOrg", test.applyValue(getOrganizationResult -> getOrganizationResult.projectIds()));
    }
}

    variables:
  test:
    fn::invoke:
      function: equinix:metal:getOrganization
      arguments:
        organizationId: ${local.org_id}
outputs:
  projectsInTheOrg: ${test.projectIds}

    Example coming soon!

    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.

    function getOrganization(args: GetOrganizationArgs, opts?: InvokeOptions): Promise<GetOrganizationResult>
function getOrganizationOutput(args: GetOrganizationOutputArgs, opts?: InvokeOptions): Output<GetOrganizationResult>
    def get_organization(description: Optional[str] = None,
                     name: Optional[str] = None,
                     organization_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOrganizationResult
def get_organization_output(description: pulumi.Input[Optional[str]] = None,
                     name: pulumi.Input[Optional[str]] = None,
                     organization_id: pulumi.Input[Optional[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationResult]
    func LookupOrganization(ctx *Context, args *LookupOrganizationArgs, opts ...InvokeOption) (*LookupOrganizationResult, error)
func LookupOrganizationOutput(ctx *Context, args *LookupOrganizationOutputArgs, opts ...InvokeOption) LookupOrganizationResultOutput

    > Note: This function is named LookupOrganization 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: equinix:metal/getOrganization:getOrganization
  arguments:
    # arguments dictionary
    data "equinix_metal_getorganization" "name" {
    # arguments
}

    The following arguments are supported:

    Description string
    Description string.
    Name string
    The organization name.
    OrganizationId string

    The UUID of the organization resource.

    Exactly one of name or organization_id must be given.

    Description string
    Description string.
    Name string
    The organization name.
    OrganizationId string

    The UUID of the organization resource.

    Exactly one of name or organization_id must be given.

    description string
    Description string.
    name string
    The organization name.
    organization_id string

    The UUID of the organization resource.

    Exactly one of name or organization_id must be given.

    description String
    Description string.
    name String
    The organization name.
    organizationId String

    The UUID of the organization resource.

    Exactly one of name or organization_id must be given.

    description string
    Description string.
    name string
    The organization name.
    organizationId string

    The UUID of the organization resource.

    Exactly one of name or organization_id must be given.

    description str
    Description string.
    name str
    The organization name.
    organization_id str

    The UUID of the organization resource.

    Exactly one of name or organization_id must be given.

    description String
    Description string.
    name String
    The organization name.
    organizationId String

    The UUID of the organization resource.

    Exactly one of name or organization_id must be given.

    getOrganization Result

    The following output properties are available:

    Address GetOrganizationAddress
    Postal address.
    Id string
    Logo string
    (Deprecated) Logo URL.

    Deprecated: Empty string is the only valid value. Support for this field has been removed from the API

    Name string
    OrganizationId string
    ProjectIds List<string>
    UUIDs of project resources which belong to this organization.
    Twitter string
    Twitter handle.
    Website string
    Website link.
    Description string
    Description string.
    Address GetOrganizationAddress
    Postal address.
    Id string
    Logo string
    (Deprecated) Logo URL.

    Deprecated: Empty string is the only valid value. Support for this field has been removed from the API

    Name string
    OrganizationId string
    ProjectIds []string
    UUIDs of project resources which belong to this organization.
    Twitter string
    Twitter handle.
    Website string
    Website link.
    Description string
    Description string.
    address object
    Postal address.
    id string
    logo string
    (Deprecated) Logo URL.

    Deprecated: Empty string is the only valid value. Support for this field has been removed from the API

    name string
    organization_id string
    project_ids list(string)
    UUIDs of project resources which belong to this organization.
    twitter string
    Twitter handle.
    website string
    Website link.
    description string
    Description string.
    address GetOrganizationAddress
    Postal address.
    id String
    logo String
    (Deprecated) Logo URL.

    Deprecated: Empty string is the only valid value. Support for this field has been removed from the API

    name String
    organizationId String
    projectIds List<String>
    UUIDs of project resources which belong to this organization.
    twitter String
    Twitter handle.
    website String
    Website link.
    description String
    Description string.
    address GetOrganizationAddress
    Postal address.
    id string
    logo string
    (Deprecated) Logo URL.

    Deprecated: Empty string is the only valid value. Support for this field has been removed from the API

    name string
    organizationId string
    projectIds string[]
    UUIDs of project resources which belong to this organization.
    twitter string
    Twitter handle.
    website string
    Website link.
    description string
    Description string.
    address GetOrganizationAddress
    Postal address.
    id str
    logo str
    (Deprecated) Logo URL.

    Deprecated: Empty string is the only valid value. Support for this field has been removed from the API

    name str
    organization_id str
    project_ids Sequence[str]
    UUIDs of project resources which belong to this organization.
    twitter str
    Twitter handle.
    website str
    Website link.
    description str
    Description string.
    address Property Map
    Postal address.
    id String
    logo String
    (Deprecated) Logo URL.

    Deprecated: Empty string is the only valid value. Support for this field has been removed from the API

    name String
    organizationId String
    projectIds List<String>
    UUIDs of project resources which belong to this organization.
    twitter String
    Twitter handle.
    website String
    Website link.
    description String
    Description string.

    Supporting Types

    GetOrganizationAddress

    Address string
    Postal address.
    City string
    City name.
    Country string
    Two letter country code (ISO 3166-1 alpha-2), e.g. US.
    State string
    State name.
    ZipCode string
    Zip Code.
    Address string
    Postal address.
    City string
    City name.
    Country string
    Two letter country code (ISO 3166-1 alpha-2), e.g. US.
    State string
    State name.
    ZipCode string
    Zip Code.
    address string
    Postal address.
    city string
    City name.
    country string
    Two letter country code (ISO 3166-1 alpha-2), e.g. US.
    state string
    State name.
    zip_code string
    Zip Code.
    address String
    Postal address.
    city String
    City name.
    country String
    Two letter country code (ISO 3166-1 alpha-2), e.g. US.
    state String
    State name.
    zipCode String
    Zip Code.
    address string
    Postal address.
    city string
    City name.
    country string
    Two letter country code (ISO 3166-1 alpha-2), e.g. US.
    state string
    State name.
    zipCode string
    Zip Code.
    address str
    Postal address.
    city str
    City name.
    country str
    Two letter country code (ISO 3166-1 alpha-2), e.g. US.
    state str
    State name.
    zip_code str
    Zip Code.
    address String
    Postal address.
    city String
    City name.
    country String
    Two letter country code (ISO 3166-1 alpha-2), e.g. US.
    state String
    State name.
    zipCode String
    Zip Code.

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Viewing docs for Equinix v0.30.0
    published on Thursday, May 14, 2026 by Equinix
    Schema (JSON)
    equinix/pulumi-equinix

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial