getNetworkSegments

Consul v3.14.0, Jan 30 26

Viewing docs for Consul v3.14.0
published on Friday, Jan 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-consul

Viewing docs for Consul v3.14.0
published on Friday, Jan 30, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-consul

Example Usage

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

export = async () => {
    const segments = await consul.getNetworkSegments({});
    return {
        segments: segments.segments,
    };
}

import pulumi
import pulumi_consul as consul

segments = consul.get_network_segments()
pulumi.export("segments", segments.segments)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		segments, err := consul.GetNetworkSegments(ctx, &consul.GetNetworkSegmentsArgs{}, nil)
		if err != nil {
			return err
		}
		ctx.Export("segments", segments.Segments)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var segments = Consul.GetNetworkSegments.Invoke();

    return new Dictionary<string, object?>
    {
        ["segments"] = segments.Apply(getNetworkSegmentsResult => getNetworkSegmentsResult.Segments),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.consul.ConsulFunctions;
import com.pulumi.consul.inputs.GetNetworkSegmentsArgs;
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 segments = ConsulFunctions.getNetworkSegments(GetNetworkSegmentsArgs.builder()
            .build());

        ctx.export("segments", segments.segments());
    }
}

variables:
  segments:
    fn::invoke:
      function: consul:getNetworkSegments
      arguments: {}
outputs:
  segments: ${segments.segments}

Using getNetworkSegments

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 getNetworkSegments(args: GetNetworkSegmentsArgs, opts?: InvokeOptions): Promise<GetNetworkSegmentsResult>
function getNetworkSegmentsOutput(args: GetNetworkSegmentsOutputArgs, opts?: InvokeOptions): Output<GetNetworkSegmentsResult>

def get_network_segments(datacenter: Optional[str] = None,
                         token: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNetworkSegmentsResult
def get_network_segments_output(datacenter: Optional[pulumi.Input[str]] = None,
                         token: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetNetworkSegmentsResult]

func GetNetworkSegments(ctx *Context, args *GetNetworkSegmentsArgs, opts ...InvokeOption) (*GetNetworkSegmentsResult, error)
func GetNetworkSegmentsOutput(ctx *Context, args *GetNetworkSegmentsOutputArgs, opts ...InvokeOption) GetNetworkSegmentsResultOutput

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

public static class GetNetworkSegments 
{
    public static Task<GetNetworkSegmentsResult> InvokeAsync(GetNetworkSegmentsArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkSegmentsResult> Invoke(GetNetworkSegmentsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNetworkSegmentsResult> getNetworkSegments(GetNetworkSegmentsArgs args, InvokeOptions options)
public static Output<GetNetworkSegmentsResult> getNetworkSegments(GetNetworkSegmentsArgs args, InvokeOptions options)

fn::invoke:
  function: consul:index/getNetworkSegments:getNetworkSegments
  arguments:
    # arguments dictionary

The following arguments are supported:

Datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
Token string: The ACL token to use. This overrides the token that the agent provides by default.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

Datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
Token string: The ACL token to use. This overrides the token that the agent provides by default.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

datacenter String: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
token String: The ACL token to use. This overrides the token that the agent provides by default.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

datacenter string: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
token string: The ACL token to use. This overrides the token that the agent provides by default.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

datacenter str: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
token str: The ACL token to use. This overrides the token that the agent provides by default.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration

datacenter String: The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.
token String: The ACL token to use. This overrides the token that the agent provides by default.
Deprecated: The token argument has been deprecated and will be removed in a future release. Please use the token argument in the provider configuration