1. Packages
  2. Nomad Provider
  3. API Docs
  4. getDeployments
Nomad v2.5.0 published on Thursday, Apr 17, 2025 by Pulumi

nomad.getDeployments

Explore with Pulumi AI

Nomad v2.5.0 published on Thursday, Apr 17, 2025 by Pulumi

Retrieve a list of deployments in Nomad.

Example Usage

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

const example = nomad.getDeployments({});
Copy
import pulumi
import pulumi_nomad as nomad

example = nomad.get_deployments()
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nomad.GetDeployments(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nomad = Pulumi.Nomad;

return await Deployment.RunAsync(() => 
{
    var example = Nomad.GetDeployments.Invoke();

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nomad.NomadFunctions;
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 example = NomadFunctions.getDeployments(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference);

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: nomad:getDeployments
      arguments: {}
Copy

Using getDeployments

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 getDeployments(opts?: InvokeOptions): Promise<GetDeploymentsResult>
function getDeploymentsOutput(opts?: InvokeOptions): Output<GetDeploymentsResult>
Copy
def get_deployments(opts: Optional[InvokeOptions] = None) -> GetDeploymentsResult
def get_deployments_output(opts: Optional[InvokeOptions] = None) -> Output[GetDeploymentsResult]
Copy
func GetDeployments(ctx *Context, opts ...InvokeOption) (*GetDeploymentsResult, error)
func GetDeploymentsOutput(ctx *Context, opts ...InvokeOption) GetDeploymentsResultOutput
Copy

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

public static class GetDeployments 
{
    public static Task<GetDeploymentsResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetDeploymentsResult> Invoke(InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeploymentsResult> getDeployments(InvokeOptions options)
public static Output<GetDeploymentsResult> getDeployments(InvokeOptions options)
Copy
fn::invoke:
  function: nomad:index/getDeployments:getDeployments
  arguments:
    # arguments dictionary
Copy

getDeployments Result

The following output properties are available:

Deployments List<ImmutableDictionary<string, string>>
list of maps a list of deployments in the cluster.

  • ID: string Deployment ID.
  • JobID: string Job ID associated with the deployment.
  • JobVersion: string Job version.
  • Status: string Deployment status.
  • StatusDescription: string Detailed description of the deployment's status.
Id string
The provider-assigned unique ID for this managed resource.
Deployments []map[string]string
list of maps a list of deployments in the cluster.

  • ID: string Deployment ID.
  • JobID: string Job ID associated with the deployment.
  • JobVersion: string Job version.
  • Status: string Deployment status.
  • StatusDescription: string Detailed description of the deployment's status.
Id string
The provider-assigned unique ID for this managed resource.
deployments List<Map<String,String>>
list of maps a list of deployments in the cluster.

  • ID: string Deployment ID.
  • JobID: string Job ID associated with the deployment.
  • JobVersion: string Job version.
  • Status: string Deployment status.
  • StatusDescription: string Detailed description of the deployment's status.
id String
The provider-assigned unique ID for this managed resource.
deployments {[key: string]: string}[]
list of maps a list of deployments in the cluster.

  • ID: string Deployment ID.
  • JobID: string Job ID associated with the deployment.
  • JobVersion: string Job version.
  • Status: string Deployment status.
  • StatusDescription: string Detailed description of the deployment's status.
id string
The provider-assigned unique ID for this managed resource.
deployments Sequence[Mapping[str, str]]
list of maps a list of deployments in the cluster.

  • ID: string Deployment ID.
  • JobID: string Job ID associated with the deployment.
  • JobVersion: string Job version.
  • Status: string Deployment status.
  • StatusDescription: string Detailed description of the deployment's status.
id str
The provider-assigned unique ID for this managed resource.
deployments List<Map<String>>
list of maps a list of deployments in the cluster.

  • ID: string Deployment ID.
  • JobID: string Job ID associated with the deployment.
  • JobVersion: string Job version.
  • Status: string Deployment status.
  • StatusDescription: string Detailed description of the deployment's status.
id String
The provider-assigned unique ID for this managed resource.

Package Details

Repository
HashiCorp Nomad pulumi/pulumi-nomad
License
Apache-2.0
Notes
This Pulumi package is based on the nomad Terraform Provider.
Nomad v2.5.0 published on Thursday, Apr 17, 2025 by Pulumi