Equinix Metal v3.2.1, Dec 30 21

equinix-metal.getProject

Explore with Pulumi AI

Use this datasource to retrieve attributes of the Project API resource.

Example Usage

using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;

class MyStack : Stack
{
    public MyStack()
    {
        var tfProject1 = Output.Create(EquinixMetal.GetProject.InvokeAsync(new EquinixMetal.GetProjectArgs
        {
            Name = "Terraform Fun",
        }));
        this.UsersOfTerraformFun = tfProject1.Apply(tfProject1 => tfProject1.UserIds);
    }

    [Output("usersOfTerraformFun")]
    public Output<string> UsersOfTerraformFun { get; set; }
}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		opt0 := "Terraform Fun"
		tfProject1, err := equinix - metal.LookupProject(ctx, &GetProjectArgs{
			Name: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("usersOfTerraformFun", tfProject1.UserIds)
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_equinix_metal as equinix_metal

tf_project1 = equinix_metal.get_project(name="Terraform Fun")
pulumi.export("usersOfTerraformFun", tf_project1.user_ids)

import * as pulumi from "@pulumi/pulumi";
import * as equinix_metal from "@pulumi/equinix-metal";

const tfProject1 = equinix_metal.getProject({
    name: "Terraform Fun",
});
export const usersOfTerraformFun = tfProject1.then(tfProject1 => tfProject1.userIds);

Coming soon!

Using getProject

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 getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>

def get_project(name: Optional[str] = None,
                project_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(name: Optional[pulumi.Input[str]] = None,
                project_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]

func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput

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

public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: equinix-metal:index/getProject:getProject
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: The name which is used to look up the project
ProjectId string: The UUID by which to look up the project

Name string: The name which is used to look up the project
ProjectId string: The UUID by which to look up the project

name String: The name which is used to look up the project
projectId String: The UUID by which to look up the project

name string: The name which is used to look up the project
projectId string: The UUID by which to look up the project

name str: The name which is used to look up the project
project_id str: The UUID by which to look up the project

name String: The name which is used to look up the project
projectId String: The UUID by which to look up the project

getProject Result

The following output properties are available:

BackendTransfer bool: Whether Backend Transfer is enabled for this project
BgpConfigs List<Pulumi.EquinixMetal.Outputs.GetProjectBgpConfig>: Optional BGP settings. Refer to Equinix Metal guide for BGP.
Created string: The timestamp for when the project was created
Id string: The provider-assigned unique ID for this managed resource.
Name string
OrganizationId string: The UUID of this project's parent organization
PaymentMethodId string: The UUID of payment method for this project
ProjectId string
Updated string: The timestamp for the last time the project was updated
UserIds List<string>: List of UUIDs of user accounts which belong to this project

BackendTransfer bool: Whether Backend Transfer is enabled for this project
BgpConfigs []GetProjectBgpConfig: Optional BGP settings. Refer to Equinix Metal guide for BGP.
Created string: The timestamp for when the project was created
Id string: The provider-assigned unique ID for this managed resource.
Name string
OrganizationId string: The UUID of this project's parent organization
PaymentMethodId string: The UUID of payment method for this project
ProjectId string
Updated string: The timestamp for the last time the project was updated
UserIds []string: List of UUIDs of user accounts which belong to this project

backendTransfer Boolean: Whether Backend Transfer is enabled for this project
bgpConfigs List<GetProjectBgpConfig>: Optional BGP settings. Refer to Equinix Metal guide for BGP.
created String: The timestamp for when the project was created
id String: The provider-assigned unique ID for this managed resource.
name String
organizationId String: The UUID of this project's parent organization
paymentMethodId String: The UUID of payment method for this project
projectId String
updated String: The timestamp for the last time the project was updated
userIds List<String>: List of UUIDs of user accounts which belong to this project

backendTransfer boolean: Whether Backend Transfer is enabled for this project
bgpConfigs GetProjectBgpConfig[]: Optional BGP settings. Refer to Equinix Metal guide for BGP.
created string: The timestamp for when the project was created
id string: The provider-assigned unique ID for this managed resource.
name string
organizationId string: The UUID of this project's parent organization
paymentMethodId string: The UUID of payment method for this project
projectId string
updated string: The timestamp for the last time the project was updated
userIds string[]: List of UUIDs of user accounts which belong to this project

backend_transfer bool: Whether Backend Transfer is enabled for this project
bgp_configs Sequence[GetProjectBgpConfig]: Optional BGP settings. Refer to Equinix Metal guide for BGP.
created str: The timestamp for when the project was created
id str: The provider-assigned unique ID for this managed resource.
name str
organization_id str: The UUID of this project's parent organization
payment_method_id str: The UUID of payment method for this project
project_id str
updated str: The timestamp for the last time the project was updated
user_ids Sequence[str]: List of UUIDs of user accounts which belong to this project

backendTransfer Boolean: Whether Backend Transfer is enabled for this project
bgpConfigs List<Property Map>: Optional BGP settings. Refer to Equinix Metal guide for BGP.
created String: The timestamp for when the project was created
id String: The provider-assigned unique ID for this managed resource.
name String
organizationId String: The UUID of this project's parent organization
paymentMethodId String: The UUID of payment method for this project
projectId String
updated String: The timestamp for the last time the project was updated
userIds List<String>: List of UUIDs of user accounts which belong to this project

Supporting Types

GetProjectBgpConfig

Asn int: Autonomous System Number for local BGP deployment
DeploymentType string: private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers
MaxPrefix int: The maximum number of route filters allowed per server
Status string: status of BGP configuration in the project
Md5 string: Password for BGP session in plaintext (not a checksum)

Asn int: Autonomous System Number for local BGP deployment
DeploymentType string: private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers
MaxPrefix int: The maximum number of route filters allowed per server
Status string: status of BGP configuration in the project
Md5 string: Password for BGP session in plaintext (not a checksum)

asn Integer: Autonomous System Number for local BGP deployment
deploymentType String: private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers
maxPrefix Integer: The maximum number of route filters allowed per server
status String: status of BGP configuration in the project
md5 String: Password for BGP session in plaintext (not a checksum)

asn number: Autonomous System Number for local BGP deployment
deploymentType string: private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers
maxPrefix number: The maximum number of route filters allowed per server
status string: status of BGP configuration in the project
md5 string: Password for BGP session in plaintext (not a checksum)

asn int: Autonomous System Number for local BGP deployment
deployment_type str: private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers
max_prefix int: The maximum number of route filters allowed per server
status str: status of BGP configuration in the project
md5 str: Password for BGP session in plaintext (not a checksum)

asn Number: Autonomous System Number for local BGP deployment
deploymentType String: private or public, the private is likely to be usable immediately, the public will need to be review by Equinix Metal engineers
maxPrefix Number: The maximum number of route filters allowed per server
status String: status of BGP configuration in the project
md5 String: Password for BGP session in plaintext (not a checksum)

Package Details

Repository: Equinix Metal pulumi/pulumi-equinix-metal
License: Apache-2.0
Notes: This Pulumi package is based on the metal Terraform Provider.