Tailscale

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

DeviceAuthorization

The device_authorization resource is used to approve new devices before they can join the tailnet. See https://tailscale.com/kb/1099/device-authorization/ 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 sampleAuthorization = new Tailscale.DeviceAuthorization("sampleAuthorization", new()
    {
        DeviceId = sampleDevice.Apply(getDeviceResult => getDeviceResult.Id),
        Authorized = 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 {
		sampleDevice, err := tailscale.GetDevice(ctx, &GetDeviceArgs{
			Name: "device.example.com",
		}, nil)
		if err != nil {
			return err
		}
		_, err = tailscale.NewDeviceAuthorization(ctx, "sampleAuthorization", &tailscale.DeviceAuthorizationArgs{
			DeviceId:   pulumi.String(sampleDevice.Id),
			Authorized: pulumi.Bool(true),
		})
		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.DeviceAuthorization;
import com.pulumi.tailscale.DeviceAuthorizationArgs;
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 sampleAuthorization = new DeviceAuthorization("sampleAuthorization", DeviceAuthorizationArgs.builder()        
            .deviceId(sampleDevice.applyValue(getDeviceResult -> getDeviceResult.id()))
            .authorized(true)
            .build());

    }
}
import pulumi
import pulumi_tailscale as tailscale

sample_device = tailscale.get_device(name="device.example.com")
sample_authorization = tailscale.DeviceAuthorization("sampleAuthorization",
    device_id=sample_device.id,
    authorized=True)
import * as pulumi from "@pulumi/pulumi";
import * as tailscale from "@pulumi/tailscale";

const sampleDevice = tailscale.getDevice({
    name: "device.example.com",
});
const sampleAuthorization = new tailscale.DeviceAuthorization("sampleAuthorization", {
    deviceId: sampleDevice.then(sampleDevice => sampleDevice.id),
    authorized: true,
});
resources:
  sampleAuthorization:
    type: tailscale:DeviceAuthorization
    properties:
      deviceId: ${sampleDevice.id}
      authorized: true
variables:
  sampleDevice:
    Fn::Invoke:
      Function: tailscale:getDevice
      Arguments:
        name: device.example.com

Create a DeviceAuthorization Resource

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

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

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

Authorized bool

Whether or not the device is authorized

DeviceId string

The device to set as authorized

Authorized bool

Whether or not the device is authorized

DeviceId string

The device to set as authorized

authorized Boolean

Whether or not the device is authorized

deviceId String

The device to set as authorized

authorized boolean

Whether or not the device is authorized

deviceId string

The device to set as authorized

authorized bool

Whether or not the device is authorized

device_id str

The device to set as authorized

authorized Boolean

Whether or not the device is authorized

deviceId String

The device to set as authorized

Outputs

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

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

Whether or not the device is authorized

DeviceId string

The device to set as authorized

Authorized bool

Whether or not the device is authorized

DeviceId string

The device to set as authorized

authorized Boolean

Whether or not the device is authorized

deviceId String

The device to set as authorized

authorized boolean

Whether or not the device is authorized

deviceId string

The device to set as authorized

authorized bool

Whether or not the device is authorized

device_id str

The device to set as authorized

authorized Boolean

Whether or not the device is authorized

deviceId String

The device to set as authorized

Package Details

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

This Pulumi package is based on the tailscale Terraform Provider.