Tailscale v0.19.0, Apr 10 25

Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi

tailscale.DeviceKey

Explore with Pulumi AI

Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi

Example Usage

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

const exampleDevice = tailscale.getDevice({
    name: "device.example.com",
});
const exampleKey = new tailscale.DeviceKey("example_key", {
    deviceId: exampleDevice.then(exampleDevice => exampleDevice.id),
    keyExpiryDisabled: true,
});

import pulumi
import pulumi_tailscale as tailscale

example_device = tailscale.get_device(name="device.example.com")
example_key = tailscale.DeviceKey("example_key",
    device_id=example_device.id,
    key_expiry_disabled=True)

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 {
		exampleDevice, err := tailscale.GetDevice(ctx, &tailscale.GetDeviceArgs{
			Name: pulumi.StringRef("device.example.com"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = tailscale.NewDeviceKey(ctx, "example_key", &tailscale.DeviceKeyArgs{
			DeviceId:          pulumi.String(exampleDevice.Id),
			KeyExpiryDisabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

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

    var exampleKey = new Tailscale.DeviceKey("example_key", new()
    {
        DeviceId = exampleDevice.Apply(getDeviceResult => getDeviceResult.Id),
        KeyExpiryDisabled = true,
    });

});

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.DeviceKey;
import com.pulumi.tailscale.DeviceKeyArgs;
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 exampleDevice = TailscaleFunctions.getDevice(GetDeviceArgs.builder()
            .name("device.example.com")
            .build());

        var exampleKey = new DeviceKey("exampleKey", DeviceKeyArgs.builder()
            .deviceId(exampleDevice.id())
            .keyExpiryDisabled(true)
            .build());

    }
}

resources:
  exampleKey:
    type: tailscale:DeviceKey
    name: example_key
    properties:
      deviceId: ${exampleDevice.id}
      keyExpiryDisabled: true
variables:
  exampleDevice:
    fn::invoke:
      function: tailscale:getDevice
      arguments:
        name: device.example.com

Create DeviceKey Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new DeviceKey(name: string, args: DeviceKeyArgs, opts?: CustomResourceOptions);

@overload
def DeviceKey(resource_name: str,
              args: DeviceKeyArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def DeviceKey(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              device_id: Optional[str] = None,
              key_expiry_disabled: Optional[bool] = None)

func NewDeviceKey(ctx *Context, name string, args DeviceKeyArgs, opts ...ResourceOption) (*DeviceKey, error)

public DeviceKey(string name, DeviceKeyArgs args, CustomResourceOptions? opts = null)

public DeviceKey(String name, DeviceKeyArgs args)
public DeviceKey(String name, DeviceKeyArgs args, CustomResourceOptions options)

type: tailscale:DeviceKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

name string: The unique name of the resource.
args DeviceKeyArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DeviceKeyArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var deviceKeyResource = new Tailscale.DeviceKey("deviceKeyResource", new()
{
    DeviceId = "string",
    KeyExpiryDisabled = false,
});

example, err := tailscale.NewDeviceKey(ctx, "deviceKeyResource", &tailscale.DeviceKeyArgs{
	DeviceId:          pulumi.String("string"),
	KeyExpiryDisabled: pulumi.Bool(false),
})

var deviceKeyResource = new DeviceKey("deviceKeyResource", DeviceKeyArgs.builder()
    .deviceId("string")
    .keyExpiryDisabled(false)
    .build());

device_key_resource = tailscale.DeviceKey("deviceKeyResource",
    device_id="string",
    key_expiry_disabled=False)

const deviceKeyResource = new tailscale.DeviceKey("deviceKeyResource", {
    deviceId: "string",
    keyExpiryDisabled: false,
});

type: tailscale:DeviceKey
properties:
    deviceId: string
    keyExpiryDisabled: false

DeviceKey Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The DeviceKey resource accepts the following input properties:

DeviceId string: The device to update the key properties of
KeyExpiryDisabled bool: Determines whether or not the device's key will expire. Defaults to false.

DeviceId string: The device to update the key properties of
KeyExpiryDisabled bool: Determines whether or not the device's key will expire. Defaults to false.

deviceId String: The device to update the key properties of
keyExpiryDisabled Boolean: Determines whether or not the device's key will expire. Defaults to false.

deviceId string: The device to update the key properties of
keyExpiryDisabled boolean: Determines whether or not the device's key will expire. Defaults to false.

device_id str: The device to update the key properties of
key_expiry_disabled bool: Determines whether or not the device's key will expire. Defaults to false.

deviceId String: The device to update the key properties of
keyExpiryDisabled Boolean: Determines whether or not the device's key will expire. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the DeviceKey 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 Existing DeviceKey Resource

Get an existing DeviceKey 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?: DeviceKeyState, opts?: CustomResourceOptions): DeviceKey

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        device_id: Optional[str] = None,
        key_expiry_disabled: Optional[bool] = None) -> DeviceKey

func GetDeviceKey(ctx *Context, name string, id IDInput, state *DeviceKeyState, opts ...ResourceOption) (*DeviceKey, error)

public static DeviceKey Get(string name, Input<string> id, DeviceKeyState? state, CustomResourceOptions? opts = null)

public static DeviceKey get(String name, Output<String> id, DeviceKeyState state, CustomResourceOptions options)

resources:  _:    type: tailscale:DeviceKey    get:      id: ${id}

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 update the key properties of
KeyExpiryDisabled bool: Determines whether or not the device's key will expire. Defaults to false.

DeviceId string: The device to update the key properties of
KeyExpiryDisabled bool: Determines whether or not the device's key will expire. Defaults to false.

deviceId String: The device to update the key properties of
keyExpiryDisabled Boolean: Determines whether or not the device's key will expire. Defaults to false.

deviceId string: The device to update the key properties of
keyExpiryDisabled boolean: Determines whether or not the device's key will expire. Defaults to false.

device_id str: The device to update the key properties of
key_expiry_disabled bool: Determines whether or not the device's key will expire. Defaults to false.

deviceId String: The device to update the key properties of
keyExpiryDisabled Boolean: Determines whether or not the device's key will expire. Defaults to false.

Import

Device key can be imported using the device id, e.g.,

$ pulumi import tailscale:index/deviceKey:DeviceKey sample 123456789

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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

Tailscale v0.19.0 published on Thursday, Apr 10, 2025 by Pulumi

pulumi/pulumi-tailscale

tailscale.DeviceKey

On this page

On this page

Example Usage

Create DeviceKey Resource

Constructor syntax

Parameters

Constructor example

DeviceKey Resource Properties

Inputs

Outputs

Look up Existing DeviceKey Resource

Import

Package Details

On this page

On this page