Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Equinix Metal (Deprecated)
  3. API Docs
  4. Organization

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

equinix-metal.Organization

Explore with Pulumi AI

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal

Provides a resource to manage organization resource in Equinix Metal.

Example Usage

using Pulumi;
using EquinixMetal = Pulumi.EquinixMetal;

class MyStack : Stack
{
    public MyStack()
    {
        // Create a new Project
        var tfOrganization1 = new EquinixMetal.Organization("tfOrganization1", new EquinixMetal.OrganizationArgs
        {
            Description = "quux",
        });
    }

}
Copy
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 {
		_, err := equinix - metal.NewOrganization(ctx, "tfOrganization1", &equinix-metal.OrganizationArgs{
			Description: pulumi.String("quux"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy

Coming soon!

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

// Create a new Project
const tfOrganization1 = new metal.Organization("tf_organization_1", {
    description: "quux",
});
Copy
import pulumi
import pulumi_equinix_metal as equinix_metal

# Create a new Project
tf_organization1 = equinix_metal.Organization("tfOrganization1", description="quux")
Copy

Coming soon!

Create Organization Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Organization(name: string, args?: OrganizationArgs, opts?: CustomResourceOptions);
@overload
def Organization(resource_name: str,
                 args: Optional[OrganizationArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def Organization(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 description: Optional[str] = None,
                 logo: Optional[str] = None,
                 name: Optional[str] = None,
                 twitter: Optional[str] = None,
                 website: Optional[str] = None)
func NewOrganization(ctx *Context, name string, args *OrganizationArgs, opts ...ResourceOption) (*Organization, error)
public Organization(string name, OrganizationArgs? args = null, CustomResourceOptions? opts = null)
public Organization(String name, OrganizationArgs args)
public Organization(String name, OrganizationArgs args, CustomResourceOptions options)

type: equinix-metal:Organization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args OrganizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args OrganizationArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args OrganizationArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args OrganizationArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. OrganizationArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var organizationResource = new EquinixMetal.Organization("organizationResource", new()
{
    Description = "string",
    Logo = "string",
    Name = "string",
    Twitter = "string",
    Website = "string",
});
Copy
example, err := equinixmetal.NewOrganization(ctx, "organizationResource", &equinixmetal.OrganizationArgs{
	Description: pulumi.String("string"),
	Logo:        pulumi.String("string"),
	Name:        pulumi.String("string"),
	Twitter:     pulumi.String("string"),
	Website:     pulumi.String("string"),
})
Copy
var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()
    .description("string")
    .logo("string")
    .name("string")
    .twitter("string")
    .website("string")
    .build());
Copy
organization_resource = equinix_metal.Organization("organizationResource",
    description="string",
    logo="string",
    name="string",
    twitter="string",
    website="string")
Copy
const organizationResource = new equinix_metal.Organization("organizationResource", {
    description: "string",
    logo: "string",
    name: "string",
    twitter: "string",
    website: "string",
});
Copy
type: equinix-metal:Organization
properties:
    description: string
    logo: string
    name: string
    twitter: string
    website: string
Copy

Organization Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Organization resource accepts the following input properties:

Description string
Description string
Logo string
Logo URL
Name string
The name of the Organization
Twitter string
Twitter handle
Website string
Website link
Description string
Description string
Logo string
Logo URL
Name string
The name of the Organization
Twitter string
Twitter handle
Website string
Website link
description String
Description string
logo String
Logo URL
name String
The name of the Organization
twitter String
Twitter handle
website String
Website link
description string
Description string
logo string
Logo URL
name string
The name of the Organization
twitter string
Twitter handle
website string
Website link
description str
Description string
logo str
Logo URL
name str
The name of the Organization
twitter str
Twitter handle
website str
Website link
description String
Description string
logo String
Logo URL
name String
The name of the Organization
twitter String
Twitter handle
website String
Website link

Outputs

All input properties are implicitly available as output properties. Additionally, the Organization resource produces the following output properties:

Created string
Id string
The provider-assigned unique ID for this managed resource.
Updated string
Created string
Id string
The provider-assigned unique ID for this managed resource.
Updated string
created String
id String
The provider-assigned unique ID for this managed resource.
updated String
created string
id string
The provider-assigned unique ID for this managed resource.
updated string
created str
id str
The provider-assigned unique ID for this managed resource.
updated str
created String
id String
The provider-assigned unique ID for this managed resource.
updated String

Look up Existing Organization Resource

Get an existing Organization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OrganizationState, opts?: CustomResourceOptions): Organization
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created: Optional[str] = None,
        description: Optional[str] = None,
        logo: Optional[str] = None,
        name: Optional[str] = None,
        twitter: Optional[str] = None,
        updated: Optional[str] = None,
        website: Optional[str] = None) -> Organization
func GetOrganization(ctx *Context, name string, id IDInput, state *OrganizationState, opts ...ResourceOption) (*Organization, error)
public static Organization Get(string name, Input<string> id, OrganizationState? state, CustomResourceOptions? opts = null)
public static Organization get(String name, Output<String> id, OrganizationState state, CustomResourceOptions options)
resources:  _:    type: equinix-metal:Organization    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Created string
Description string
Description string
Logo string
Logo URL
Name string
The name of the Organization
Twitter string
Twitter handle
Updated string
Website string
Website link
Created string
Description string
Description string
Logo string
Logo URL
Name string
The name of the Organization
Twitter string
Twitter handle
Updated string
Website string
Website link
created String
description String
Description string
logo String
Logo URL
name String
The name of the Organization
twitter String
Twitter handle
updated String
website String
Website link
created string
description string
Description string
logo string
Logo URL
name string
The name of the Organization
twitter string
Twitter handle
updated string
website string
Website link
created str
description str
Description string
logo str
Logo URL
name str
The name of the Organization
twitter str
Twitter handle
updated str
website str
Website link
created String
description String
Description string
logo String
Logo URL
name String
The name of the Organization
twitter String
Twitter handle
updated String
website String
Website link

Import

This resource can be imported using an existing organization ID

 $ pulumi import equinix-metal:index/organization:Organization metal_organization {existing_organization_id}
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

This package is deprecated. We recommend using the new Equinix package.

Equinix Metal v3.2.1 published on Thursday, Dec 30, 2021 by DEPRECATED
pulumi/pulumi-equinix-metal