1. Packages
  2. Equinix
  3. API Docs
  4. metal
  5. Organization
Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix

equinix.metal.Organization

Explore with Pulumi AI

equinix logo
Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix

    Provides a resource to manage organization resource in Equinix Metal.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Equinix = Pulumi.Equinix;
    
    return await Deployment.RunAsync(() => 
    {
        var orgResource = new Equinix.Metal.Organization("org", new()
        {
            Name = "Foo Organization",
            Address = new Equinix.Metal.Inputs.OrganizationAddressArgs
            {
                Address = "org street",
                City = "london",
                Country = "GB",
                ZipCode = "12345",
            },
            Description = "An organization",
        });
    
        return new Dictionary<string, object?>
        {
            ["org"] = orgResource.Id,
        };
    });
    
    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 {
    		orgResource, err := metal.NewOrganization(ctx, "org", &metal.OrganizationArgs{
    			Name: pulumi.String("Foo Organization"),
    			Address: &metal.OrganizationAddressArgs{
    				Address: pulumi.String("org street"),
    				City:    pulumi.String("london"),
    				Country: pulumi.String("GB"),
    				ZipCode: pulumi.String("12345"),
    			},
    			Description: pulumi.String("An organization"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("org", orgResource.ID())
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.equinix.pulumi.metal.Organization;
    import com.equinix.pulumi.metal.OrganizationArgs;
    import com.equinix.pulumi.metal.inputs.OrganizationAddressArgs;
    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) {
            var orgResource = new Organization("orgResource", OrganizationArgs.builder()        
                .name("Foo Organization")
                .address(OrganizationAddressArgs.builder()
                    .address("org street")
                    .city("london")
                    .country("GB")
                    .zipCode("12345")
                    .build())
                .description("An organization")
                .build());
    
            ctx.export("org", orgResource.id());
        }
    }
    
    import pulumi
    import pulumi_equinix as equinix
    
    org_resource = equinix.metal.Organization("org",
        name="Foo Organization",
        address=equinix.metal.OrganizationAddressArgs(
            address="org street",
            city="london",
            country="GB",
            zip_code="12345",
        ),
        description="An organization")
    pulumi.export("org", org_resource.id)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as equinix from "@equinix-labs/pulumi-equinix";
    
    const orgResource = new equinix.metal.Organization("org", {
        name: "Foo Organization",
        address: {
            address: "org street",
            city: "london",
            country: "GB",
            zipCode: "12345",
        },
        description: "An organization",
    });
    export const org = orgResource.id;
    
    resources:
      org:
        type: equinix:metal:Organization
        properties:
          name: Foo Organization
          address:
            address: org street
            city: london
            country: GB
            zipCode: "12345"
          description: An organization
    outputs:
      org: ${org.id}
    

    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,
                     address: Optional[OrganizationAddressArgs] = 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 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 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 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 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 String
    The unique name of the resource.
    args OrganizationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var organizationResource = new Equinix.Metal.Organization("organizationResource", new()
    {
        Address = new Equinix.Metal.Inputs.OrganizationAddressArgs
        {
            Address = "string",
            City = "string",
            Country = "string",
            ZipCode = "string",
            State = "string",
        },
        Description = "string",
        Logo = "string",
        Name = "string",
        Twitter = "string",
        Website = "string",
    });
    
    example, err := metal.NewOrganization(ctx, "organizationResource", &metal.OrganizationArgs{
    	Address: &metal.OrganizationAddressArgs{
    		Address: pulumi.String("string"),
    		City:    pulumi.String("string"),
    		Country: pulumi.String("string"),
    		ZipCode: pulumi.String("string"),
    		State:   pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Logo:        pulumi.String("string"),
    	Name:        pulumi.String("string"),
    	Twitter:     pulumi.String("string"),
    	Website:     pulumi.String("string"),
    })
    
    var organizationResource = new Organization("organizationResource", OrganizationArgs.builder()        
        .address(OrganizationAddressArgs.builder()
            .address("string")
            .city("string")
            .country("string")
            .zipCode("string")
            .state("string")
            .build())
        .description("string")
        .logo("string")
        .name("string")
        .twitter("string")
        .website("string")
        .build());
    
    organization_resource = equinix.metal.Organization("organizationResource",
        address=equinix.metal.OrganizationAddressArgs(
            address="string",
            city="string",
            country="string",
            zip_code="string",
            state="string",
        ),
        description="string",
        logo="string",
        name="string",
        twitter="string",
        website="string")
    
    const organizationResource = new equinix.metal.Organization("organizationResource", {
        address: {
            address: "string",
            city: "string",
            country: "string",
            zipCode: "string",
            state: "string",
        },
        description: "string",
        logo: "string",
        name: "string",
        twitter: "string",
        website: "string",
    });
    
    type: equinix:metal:Organization
    properties:
        address:
            address: string
            city: string
            country: string
            state: string
            zipCode: string
        description: string
        logo: string
        name: string
        twitter: string
        website: string
    

    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

    The Organization resource accepts the following input properties:

    Address OrganizationAddress
    An object that has the address information. See Address below for more details.
    Description string
    Description string.
    Logo string
    Logo URL.
    Name string
    The name of the Organization.
    Twitter string
    Twitter handle.
    Website string
    Website link.
    Address OrganizationAddressArgs
    An object that has the address information. See Address below for more details.
    Description string
    Description string.
    Logo string
    Logo URL.
    Name string
    The name of the Organization.
    Twitter string
    Twitter handle.
    Website string
    Website link.
    address OrganizationAddress
    An object that has the address information. See Address below for more details.
    description String
    Description string.
    logo String
    Logo URL.
    name String
    The name of the Organization.
    twitter String
    Twitter handle.
    website String
    Website link.
    address OrganizationAddress
    An object that has the address information. See Address below for more details.
    description string
    Description string.
    logo string
    Logo URL.
    name string
    The name of the Organization.
    twitter string
    Twitter handle.
    website string
    Website link.
    address OrganizationAddressArgs
    An object that has the address information. See Address below for more details.
    description str
    Description string.
    logo str
    Logo URL.
    name str
    The name of the Organization.
    twitter str
    Twitter handle.
    website str
    Website link.
    address Property Map
    An object that has the address information. See Address below for more details.
    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
    The timestamp for when the organization was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated string
    The timestamp for the last time the organization was updated.
    Created string
    The timestamp for when the organization was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    Updated string
    The timestamp for the last time the organization was updated.
    created String
    The timestamp for when the organization was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updated String
    The timestamp for the last time the organization was updated.
    created string
    The timestamp for when the organization was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updated string
    The timestamp for the last time the organization was updated.
    created str
    The timestamp for when the organization was created.
    id str
    The provider-assigned unique ID for this managed resource.
    updated str
    The timestamp for the last time the organization was updated.
    created String
    The timestamp for when the organization was created.
    id String
    The provider-assigned unique ID for this managed resource.
    updated String
    The timestamp for the last time the organization was updated.

    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,
            address: Optional[OrganizationAddressArgs] = 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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Address OrganizationAddress
    An object that has the address information. See Address below for more details.
    Created string
    The timestamp for when the organization was created.
    Description string
    Description string.
    Logo string
    Logo URL.
    Name string
    The name of the Organization.
    Twitter string
    Twitter handle.
    Updated string
    The timestamp for the last time the organization was updated.
    Website string
    Website link.
    Address OrganizationAddressArgs
    An object that has the address information. See Address below for more details.
    Created string
    The timestamp for when the organization was created.
    Description string
    Description string.
    Logo string
    Logo URL.
    Name string
    The name of the Organization.
    Twitter string
    Twitter handle.
    Updated string
    The timestamp for the last time the organization was updated.
    Website string
    Website link.
    address OrganizationAddress
    An object that has the address information. See Address below for more details.
    created String
    The timestamp for when the organization was created.
    description String
    Description string.
    logo String
    Logo URL.
    name String
    The name of the Organization.
    twitter String
    Twitter handle.
    updated String
    The timestamp for the last time the organization was updated.
    website String
    Website link.
    address OrganizationAddress
    An object that has the address information. See Address below for more details.
    created string
    The timestamp for when the organization was created.
    description string
    Description string.
    logo string
    Logo URL.
    name string
    The name of the Organization.
    twitter string
    Twitter handle.
    updated string
    The timestamp for the last time the organization was updated.
    website string
    Website link.
    address OrganizationAddressArgs
    An object that has the address information. See Address below for more details.
    created str
    The timestamp for when the organization was created.
    description str
    Description string.
    logo str
    Logo URL.
    name str
    The name of the Organization.
    twitter str
    Twitter handle.
    updated str
    The timestamp for the last time the organization was updated.
    website str
    Website link.
    address Property Map
    An object that has the address information. See Address below for more details.
    created String
    The timestamp for when the organization was created.
    description String
    Description string.
    logo String
    Logo URL.
    name String
    The name of the Organization.
    twitter String
    Twitter handle.
    updated String
    The timestamp for the last time the organization was updated.
    website String
    Website link.

    Supporting Types

    OrganizationAddress, OrganizationAddressArgs

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

    Package Details

    Repository
    equinix equinix/pulumi-equinix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the equinix Terraform Provider.
    equinix logo
    Equinix v0.10.0 published on Wednesday, May 22, 2024 by Equinix