Tailscale

v0.11.0 published on Tuesday, Aug 30, 2022 by Pulumi

DeviceTags

The device_tags resource is used to apply tags to Tailscale devices. See https://tailscale.com/kb/1068/acl-tags/ for more details.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Tailscale = Pulumi.Tailscale;

return await Deployment.RunAsync(() => 
{
    var sampleDevice = Tailscale.GetDevice.Invoke(new()
    {
        Name = "device.example.com",
    });

    var sampleTags = new Tailscale.DeviceTags("sampleTags", new()
    {
        DeviceId = sampleDevice.Apply(getDeviceResult => getDeviceResult.Id),
        Tags = new[]
        {
            "room:bedroom",
        },
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sampleDevice, err := tailscale.GetDevice(ctx, &GetDeviceArgs{
			Name: "device.example.com",
		}, nil)
		if err != nil {
			return err
		}
		_, err = tailscale.NewDeviceTags(ctx, "sampleTags", &tailscale.DeviceTagsArgs{
			DeviceId: pulumi.String(sampleDevice.Id),
			Tags: pulumi.StringArray{
				pulumi.String("room:bedroom"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tailscale.TailscaleFunctions;
import com.pulumi.tailscale.inputs.GetDeviceArgs;
import com.pulumi.tailscale.DeviceTags;
import com.pulumi.tailscale.DeviceTagsArgs;
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 sampleDevice = TailscaleFunctions.getDevice(GetDeviceArgs.builder()
            .name("device.example.com")
            .build());

        var sampleTags = new DeviceTags("sampleTags", DeviceTagsArgs.builder()        
            .deviceId(sampleDevice.applyValue(getDeviceResult -> getDeviceResult.id()))
            .tags("room:bedroom")
            .build());

    }
}
import pulumi
import pulumi_tailscale as tailscale

sample_device = tailscale.get_device(name="device.example.com")
sample_tags = tailscale.DeviceTags("sampleTags",
    device_id=sample_device.id,
    tags=["room:bedroom"])
import * as pulumi from "@pulumi/pulumi";
import * as tailscale from "@pulumi/tailscale";

const sampleDevice = tailscale.getDevice({
    name: "device.example.com",
});
const sampleTags = new tailscale.DeviceTags("sampleTags", {
    deviceId: sampleDevice.then(sampleDevice => sampleDevice.id),
    tags: ["room:bedroom"],
});
resources:
  sampleTags:
    type: tailscale:DeviceTags
    properties:
      deviceId: ${sampleDevice.id}
      tags:
        - room:bedroom
variables:
  sampleDevice:
    Fn::Invoke:
      Function: tailscale:getDevice
      Arguments:
        name: device.example.com

Create a DeviceTags Resource

new DeviceTags(name: string, args: DeviceTagsArgs, opts?: CustomResourceOptions);
@overload
def DeviceTags(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               device_id: Optional[str] = None,
               tags: Optional[Sequence[str]] = None)
@overload
def DeviceTags(resource_name: str,
               args: DeviceTagsArgs,
               opts: Optional[ResourceOptions] = None)
func NewDeviceTags(ctx *Context, name string, args DeviceTagsArgs, opts ...ResourceOption) (*DeviceTags, error)
public DeviceTags(string name, DeviceTagsArgs args, CustomResourceOptions? opts = null)
public DeviceTags(String name, DeviceTagsArgs args)
public DeviceTags(String name, DeviceTagsArgs args, CustomResourceOptions options)
type: tailscale:DeviceTags
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args DeviceTagsArgs
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 DeviceTagsArgs
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 DeviceTagsArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args DeviceTagsArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args DeviceTagsArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

DeviceTags 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 DeviceTags resource accepts the following input properties:

DeviceId string

The device to set tags for

Tags List<string>

The tags to apply to the device

DeviceId string

The device to set tags for

Tags []string

The tags to apply to the device

deviceId String

The device to set tags for

tags List<String>

The tags to apply to the device

deviceId string

The device to set tags for

tags string[]

The tags to apply to the device

device_id str

The device to set tags for

tags Sequence[str]

The tags to apply to the device

deviceId String

The device to set tags for

tags List<String>

The tags to apply to the device

Outputs

All input properties are implicitly available as output properties. Additionally, the DeviceTags resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing DeviceTags Resource

Get an existing DeviceTags 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?: DeviceTagsState, opts?: CustomResourceOptions): DeviceTags
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_id: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> DeviceTags
func GetDeviceTags(ctx *Context, name string, id IDInput, state *DeviceTagsState, opts ...ResourceOption) (*DeviceTags, error)
public static DeviceTags Get(string name, Input<string> id, DeviceTagsState? state, CustomResourceOptions? opts = null)
public static DeviceTags get(String name, Output<String> id, DeviceTagsState 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:
DeviceId string

The device to set tags for

Tags List<string>

The tags to apply to the device

DeviceId string

The device to set tags for

Tags []string

The tags to apply to the device

deviceId String

The device to set tags for

tags List<String>

The tags to apply to the device

deviceId string

The device to set tags for

tags string[]

The tags to apply to the device

device_id str

The device to set tags for

tags Sequence[str]

The tags to apply to the device

deviceId String

The device to set tags for

tags List<String>

The tags to apply to the device

Package Details

Repository
https://github.com/pulumi/pulumi-tailscale
License
Apache-2.0
Notes

This Pulumi package is based on the tailscale Terraform Provider.