1. Packages
  2. Netbox Provider
  3. API Docs
  4. getTag
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

netbox.getTag

Explore with Pulumi AI

netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger

Example Usage

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

const dmz = netbox.getTag({
    name: "DMZ",
});
Copy
import pulumi
import pulumi_netbox as netbox

dmz = netbox.get_tag(name="DMZ")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/netbox/v3/netbox"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netbox.LookupTag(ctx, &netbox.LookupTagArgs{
			Name: "DMZ",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Netbox = Pulumi.Netbox;

return await Deployment.RunAsync(() => 
{
    var dmz = Netbox.GetTag.Invoke(new()
    {
        Name = "DMZ",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.netbox.NetboxFunctions;
import com.pulumi.netbox.inputs.GetTagArgs;
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 dmz = NetboxFunctions.getTag(GetTagArgs.builder()
            .name("DMZ")
            .build());

    }
}
Copy
variables:
  dmz:
    fn::invoke:
      function: netbox:getTag
      arguments:
        name: DMZ
Copy

Using getTag

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 getTag(args: GetTagArgs, opts?: InvokeOptions): Promise<GetTagResult>
function getTagOutput(args: GetTagOutputArgs, opts?: InvokeOptions): Output<GetTagResult>
Copy
def get_tag(description: Optional[str] = None,
            id: Optional[str] = None,
            name: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetTagResult
def get_tag_output(description: Optional[pulumi.Input[str]] = None,
            id: Optional[pulumi.Input[str]] = None,
            name: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetTagResult]
Copy
func LookupTag(ctx *Context, args *LookupTagArgs, opts ...InvokeOption) (*LookupTagResult, error)
func LookupTagOutput(ctx *Context, args *LookupTagOutputArgs, opts ...InvokeOption) LookupTagResultOutput
Copy

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

public static class GetTag 
{
    public static Task<GetTagResult> InvokeAsync(GetTagArgs args, InvokeOptions? opts = null)
    public static Output<GetTagResult> Invoke(GetTagInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTagResult> getTag(GetTagArgs args, InvokeOptions options)
public static Output<GetTagResult> getTag(GetTagArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: netbox:index/getTag:getTag
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Description string
Id string
The ID of this resource.
Name This property is required. string
Description string
Id string
The ID of this resource.
name This property is required. String
description String
id String
The ID of this resource.
name This property is required. string
description string
id string
The ID of this resource.
name This property is required. str
description str
id str
The ID of this resource.
name This property is required. String
description String
id String
The ID of this resource.

getTag Result

The following output properties are available:

Id string
The ID of this resource.
Name string
Slug string
Description string
Id string
The ID of this resource.
Name string
Slug string
Description string
id String
The ID of this resource.
name String
slug String
description String
id string
The ID of this resource.
name string
slug string
description string
id str
The ID of this resource.
name str
slug str
description str
id String
The ID of this resource.
name String
slug String
description String

Package Details

Repository
netbox e-breuninger/terraform-provider-netbox
License
Notes
This Pulumi package is based on the netbox Terraform Provider.
netbox 3.10.0 published on Monday, Apr 14, 2025 by e-breuninger