Equinix v0.19.0, Oct 24 24

Equinix v0.19.0 published on Thursday, Oct 24, 2024 by Equinix

equinix.fabric.getNetwork

Explore with Pulumi AI

Equinix v0.19.0 published on Thursday, Oct 24, 2024 by Equinix

Example Usage

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

const networkDataName = equinix.fabric.getNetwork({
    uuid: "<uuid_of_network>",
});
export const id = networkDataName.then(networkDataName => networkDataName.id);
export const name = networkDataName.then(networkDataName => networkDataName.name);
export const scope = networkDataName.then(networkDataName => networkDataName.scope);
export const type = networkDataName.then(networkDataName => networkDataName.type);
export const region = networkDataName.then(networkDataName => networkDataName.locations?.[0]?.region);

import pulumi
import pulumi_equinix as equinix

network_data_name = equinix.fabric.get_network(uuid="<uuid_of_network>")
pulumi.export("id", network_data_name.id)
pulumi.export("name", network_data_name.name)
pulumi.export("scope", network_data_name.scope)
pulumi.export("type", network_data_name.type)
pulumi.export("region", network_data_name.locations[0].region)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		networkDataName, err := fabric.LookupNetwork(ctx, &fabric.LookupNetworkArgs{
			Uuid: "<uuid_of_network>",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", networkDataName.Id)
		ctx.Export("name", networkDataName.Name)
		ctx.Export("scope", networkDataName.Scope)
		ctx.Export("type", networkDataName.Type)
		ctx.Export("region", networkDataName.Locations[0].Region)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var networkDataName = Equinix.Fabric.GetNetwork.Invoke(new()
    {
        Uuid = "<uuid_of_network>",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = networkDataName.Apply(getNetworkResult => getNetworkResult.Id),
        ["name"] = networkDataName.Apply(getNetworkResult => getNetworkResult.Name),
        ["scope"] = networkDataName.Apply(getNetworkResult => getNetworkResult.Scope),
        ["type"] = networkDataName.Apply(getNetworkResult => getNetworkResult.Type),
        ["region"] = networkDataName.Apply(getNetworkResult => getNetworkResult.Locations[0]?.Region),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.equinix.fabric.FabricFunctions;
import com.pulumi.equinix.fabric.inputs.GetNetworkArgs;
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 networkDataName = FabricFunctions.getNetwork(GetNetworkArgs.builder()
            .uuid("<uuid_of_network>")
            .build());

        ctx.export("id", networkDataName.applyValue(getNetworkResult -> getNetworkResult.id()));
        ctx.export("name", networkDataName.applyValue(getNetworkResult -> getNetworkResult.name()));
        ctx.export("scope", networkDataName.applyValue(getNetworkResult -> getNetworkResult.scope()));
        ctx.export("type", networkDataName.applyValue(getNetworkResult -> getNetworkResult.type()));
        ctx.export("region", networkDataName.applyValue(getNetworkResult -> getNetworkResult.locations()[0].region()));
    }
}

variables:
  networkDataName:
    fn::invoke:
      Function: equinix:fabric:getNetwork
      Arguments:
        uuid: <uuid_of_network>
outputs:
  id: ${networkDataName.id}
  name: ${networkDataName.name}
  scope: ${networkDataName.scope}
  type: ${networkDataName.type}
  region: ${networkDataName.locations[0].region}

Using getNetwork

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 getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>
function getNetworkOutput(args: GetNetworkOutputArgs, opts?: InvokeOptions): Output<GetNetworkResult>

def get_network(uuid: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetNetworkResult
def get_network_output(uuid: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetNetworkResult]

func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput

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

public static class GetNetwork 
{
    public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkResult> Invoke(GetNetworkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: equinix:fabric/getNetwork:getNetwork
  arguments:
    # arguments dictionary

The following arguments are supported:

Uuid string: Equinix-assigned network identifier

Uuid string: Equinix-assigned network identifier

uuid String: Equinix-assigned network identifier

uuid string: Equinix-assigned network identifier

uuid str: Equinix-assigned network identifier

uuid String: Equinix-assigned network identifier

getNetwork Result

The following output properties are available:

Change GetNetworkChange: Information on asset change operation
ChangeLog GetNetworkChangeLog: A permanent record of asset creation, modification, or deletion
ConnectionsCount int: Number of connections associated with this network
Href string: Fabric Network URI information
Id string: The provider-assigned unique ID for this managed resource.
Locations List<GetNetworkLocation>: Fabric Network location
Name string: Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
Notifications List<GetNetworkNotification>: Preferences for notifications on Fabric Network configuration or status changes
Operation GetNetworkOperation: Network operation information that is associated with this Fabric Network
Project GetNetworkProject: Fabric Network project
Scope string: Fabric Network scope
State string: Fabric Network overall state
Type string: Supported Network types - EVPLAN, EPLAN, IPWAN
Uuid string: Equinix-assigned network identifier

Change GetNetworkChange: Information on asset change operation
ChangeLog GetNetworkChangeLog: A permanent record of asset creation, modification, or deletion
ConnectionsCount int: Number of connections associated with this network
Href string: Fabric Network URI information
Id string: The provider-assigned unique ID for this managed resource.
Locations []GetNetworkLocation: Fabric Network location
Name string: Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
Notifications []GetNetworkNotification: Preferences for notifications on Fabric Network configuration or status changes
Operation GetNetworkOperation: Network operation information that is associated with this Fabric Network
Project GetNetworkProject: Fabric Network project
Scope string: Fabric Network scope
State string: Fabric Network overall state
Type string: Supported Network types - EVPLAN, EPLAN, IPWAN
Uuid string: Equinix-assigned network identifier

change GetNetworkChange: Information on asset change operation
changeLog GetNetworkChangeLog: A permanent record of asset creation, modification, or deletion
connectionsCount Integer: Number of connections associated with this network
href String: Fabric Network URI information
id String: The provider-assigned unique ID for this managed resource.
locations List<GetNetworkLocation>: Fabric Network location
name String: Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
notifications List<GetNetworkNotification>: Preferences for notifications on Fabric Network configuration or status changes
operation GetNetworkOperation: Network operation information that is associated with this Fabric Network
project GetNetworkProject: Fabric Network project
scope String: Fabric Network scope
state String: Fabric Network overall state
type String: Supported Network types - EVPLAN, EPLAN, IPWAN
uuid String: Equinix-assigned network identifier

change GetNetworkChange: Information on asset change operation
changeLog GetNetworkChangeLog: A permanent record of asset creation, modification, or deletion
connectionsCount number: Number of connections associated with this network
href string: Fabric Network URI information
id string: The provider-assigned unique ID for this managed resource.
locations GetNetworkLocation[]: Fabric Network location
name string: Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
notifications GetNetworkNotification[]: Preferences for notifications on Fabric Network configuration or status changes
operation GetNetworkOperation: Network operation information that is associated with this Fabric Network
project GetNetworkProject: Fabric Network project
scope string: Fabric Network scope
state string: Fabric Network overall state
type string: Supported Network types - EVPLAN, EPLAN, IPWAN
uuid string: Equinix-assigned network identifier

change GetNetworkChange: Information on asset change operation
change_log GetNetworkChangeLog: A permanent record of asset creation, modification, or deletion
connections_count int: Number of connections associated with this network
href str: Fabric Network URI information
id str: The provider-assigned unique ID for this managed resource.
locations Sequence[GetNetworkLocation]: Fabric Network location
name str: Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
notifications Sequence[GetNetworkNotification]: Preferences for notifications on Fabric Network configuration or status changes
operation GetNetworkOperation: Network operation information that is associated with this Fabric Network
project GetNetworkProject: Fabric Network project
scope str: Fabric Network scope
state str: Fabric Network overall state
type str: Supported Network types - EVPLAN, EPLAN, IPWAN
uuid str: Equinix-assigned network identifier

change Property Map: Information on asset change operation
changeLog Property Map: A permanent record of asset creation, modification, or deletion
connectionsCount Number: Number of connections associated with this network
href String: Fabric Network URI information
id String: The provider-assigned unique ID for this managed resource.
locations List<Property Map>: Fabric Network location
name String: Fabric Network name. An alpha-numeric 24 characters string which can include only hyphens and underscores
notifications List<Property Map>: Preferences for notifications on Fabric Network configuration or status changes
operation Property Map: Network operation information that is associated with this Fabric Network
project Property Map: Fabric Network project
scope String: Fabric Network scope
state String: Fabric Network overall state
type String: Supported Network types - EVPLAN, EPLAN, IPWAN
uuid String: Equinix-assigned network identifier

Supporting Types

GetNetworkChange

Href string: Absolute URL that returns the details of the given change. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
Type string: Asset instance change request type.: NETWORK_CREATION, NETWORK_UPDATE, NETWORK_DELETION
Uuid string: Asset change request identifier.

Href string: Absolute URL that returns the details of the given change. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
Type string: Asset instance change request type.: NETWORK_CREATION, NETWORK_UPDATE, NETWORK_DELETION
Uuid string: Asset change request identifier.

href String: Absolute URL that returns the details of the given change. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type String: Asset instance change request type.: NETWORK_CREATION, NETWORK_UPDATE, NETWORK_DELETION
uuid String: Asset change request identifier.

href string: Absolute URL that returns the details of the given change. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type string: Asset instance change request type.: NETWORK_CREATION, NETWORK_UPDATE, NETWORK_DELETION
uuid string: Asset change request identifier.

href str: Absolute URL that returns the details of the given change. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type str: Asset instance change request type.: NETWORK_CREATION, NETWORK_UPDATE, NETWORK_DELETION
uuid str: Asset change request identifier.

href String: Absolute URL that returns the details of the given change. Example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784
type String: Asset instance change request type.: NETWORK_CREATION, NETWORK_UPDATE, NETWORK_DELETION
uuid String: Asset change request identifier.

GetNetworkChangeLog

CreatedBy string: Created by User Key
CreatedByEmail string: Created by User Email Address
CreatedByFullName string: Created by User Full Name
CreatedDateTime string: Created by Date and Time
DeletedBy string: Deleted by User Key
DeletedByEmail string: Deleted by User Email Address
DeletedByFullName string: Deleted by User Full Name
DeletedDateTime string: Deleted by Date and Time
UpdatedBy string: Updated by User Key
UpdatedByEmail string: Updated by User Email Address
UpdatedByFullName string: Updated by User Full Name
UpdatedDateTime string: Updated by Date and Time

CreatedBy string: Created by User Key
CreatedByEmail string: Created by User Email Address
CreatedByFullName string: Created by User Full Name
CreatedDateTime string: Created by Date and Time
DeletedBy string: Deleted by User Key
DeletedByEmail string: Deleted by User Email Address
DeletedByFullName string: Deleted by User Full Name
DeletedDateTime string: Deleted by Date and Time
UpdatedBy string: Updated by User Key
UpdatedByEmail string: Updated by User Email Address
UpdatedByFullName string: Updated by User Full Name
UpdatedDateTime string: Updated by Date and Time

createdBy String: Created by User Key
createdByEmail String: Created by User Email Address
createdByFullName String: Created by User Full Name
createdDateTime String: Created by Date and Time
deletedBy String: Deleted by User Key
deletedByEmail String: Deleted by User Email Address
deletedByFullName String: Deleted by User Full Name
deletedDateTime String: Deleted by Date and Time
updatedBy String: Updated by User Key
updatedByEmail String: Updated by User Email Address
updatedByFullName String: Updated by User Full Name
updatedDateTime String: Updated by Date and Time

createdBy string: Created by User Key
createdByEmail string: Created by User Email Address
createdByFullName string: Created by User Full Name
createdDateTime string: Created by Date and Time
deletedBy string: Deleted by User Key
deletedByEmail string: Deleted by User Email Address
deletedByFullName string: Deleted by User Full Name
deletedDateTime string: Deleted by Date and Time
updatedBy string: Updated by User Key
updatedByEmail string: Updated by User Email Address
updatedByFullName string: Updated by User Full Name
updatedDateTime string: Updated by Date and Time

created_by str: Created by User Key
created_by_email str: Created by User Email Address
created_by_full_name str: Created by User Full Name
created_date_time str: Created by Date and Time
deleted_by str: Deleted by User Key
deleted_by_email str: Deleted by User Email Address
deleted_by_full_name str: Deleted by User Full Name
deleted_date_time str: Deleted by Date and Time
updated_by str: Updated by User Key
updated_by_email str: Updated by User Email Address
updated_by_full_name str: Updated by User Full Name
updated_date_time str: Updated by Date and Time

createdBy String: Created by User Key
createdByEmail String: Created by User Email Address
createdByFullName String: Created by User Full Name
createdDateTime String: Created by Date and Time
deletedBy String: Deleted by User Key
deletedByEmail String: Deleted by User Email Address
deletedByFullName String: Deleted by User Full Name
deletedDateTime String: Deleted by Date and Time
updatedBy String: Updated by User Key
updatedByEmail String: Updated by User Email Address
updatedByFullName String: Updated by User Full Name
updatedDateTime String: Updated by Date and Time

GetNetworkLocation

Ibx string: IBX Code
MetroCode string: Access point metro code
MetroName string: Access point metro name
Region string: Access point region

Ibx string: IBX Code
MetroCode string: Access point metro code
MetroName string: Access point metro name
Region string: Access point region

ibx String: IBX Code
metroCode String: Access point metro code
metroName String: Access point metro name
region String: Access point region

ibx string: IBX Code
metroCode string: Access point metro code
metroName string: Access point metro name
region string: Access point region

ibx str: IBX Code
metro_code str: Access point metro code
metro_name str: Access point metro name
region str: Access point region

ibx String: IBX Code
metroCode String: Access point metro code
metroName String: Access point metro name
region String: Access point region

GetNetworkNotification

Emails List<string>: Array of contact emails
Type string: Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
SendInterval string: Send interval

Emails []string: Array of contact emails
Type string: Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
SendInterval string: Send interval

emails List<String>: Array of contact emails
type String: Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
sendInterval String: Send interval

emails string[]: Array of contact emails
type string: Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
sendInterval string: Send interval

emails Sequence[str]: Array of contact emails
type str: Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
send_interval str: Send interval

emails List<String>: Array of contact emails
type String: Notification Type - ALL,CONNECTION_APPROVAL,SALES_REP_NOTIFICATIONS, NOTIFICATIONS
sendInterval String: Send interval

GetNetworkOperation

EquinixStatus string: Progress towards provisioning a given asset.

EquinixStatus string: Progress towards provisioning a given asset.

equinixStatus String: Progress towards provisioning a given asset.

equinixStatus string: Progress towards provisioning a given asset.

equinix_status str: Progress towards provisioning a given asset.

equinixStatus String: Progress towards provisioning a given asset.

GetNetworkProject

ProjectId string: Customer project identifier

ProjectId string: Customer project identifier

projectId String: Customer project identifier

projectId string: Customer project identifier

project_id str: Customer project identifier

projectId String: Customer project identifier

Package Details

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

Equinix v0.19.0 published on Thursday, Oct 24, 2024 by Equinix

equinix/pulumi-equinix

equinix.fabric.getNetwork

On this page

On this page

Example Usage

Using getNetwork

getNetwork Result

Supporting Types

GetNetworkChange

GetNetworkChangeLog

GetNetworkLocation

GetNetworkNotification

GetNetworkOperation

GetNetworkProject

Package Details

On this page

On this page