tailscale.DeviceAuthorization
Explore with Pulumi AI
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
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("sample_authorization", {
deviceId: sampleDevice.then(sampleDevice => sampleDevice.id),
authorized: true,
});
import pulumi
import pulumi_tailscale as tailscale
sample_device = tailscale.get_device(name="device.example.com")
sample_authorization = tailscale.DeviceAuthorization("sample_authorization",
device_id=sample_device.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, &tailscale.GetDeviceArgs{
Name: pulumi.StringRef("device.example.com"),
}, nil)
if err != nil {
return err
}
_, err = tailscale.NewDeviceAuthorization(ctx, "sample_authorization", &tailscale.DeviceAuthorizationArgs{
DeviceId: pulumi.String(sampleDevice.Id),
Authorized: 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 sampleDevice = Tailscale.GetDevice.Invoke(new()
{
Name = "device.example.com",
});
var sampleAuthorization = new Tailscale.DeviceAuthorization("sample_authorization", new()
{
DeviceId = sampleDevice.Apply(getDeviceResult => getDeviceResult.Id),
Authorized = 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.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());
}
}
resources:
sampleAuthorization:
type: tailscale:DeviceAuthorization
name: sample_authorization
properties:
deviceId: ${sampleDevice.id}
authorized: true
variables:
sampleDevice:
fn::invoke:
Function: tailscale:getDevice
Arguments:
name: device.example.com
Create DeviceAuthorization Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DeviceAuthorization(name: string, args: DeviceAuthorizationArgs, opts?: CustomResourceOptions);
@overload
def DeviceAuthorization(resource_name: str,
args: DeviceAuthorizationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DeviceAuthorization(resource_name: str,
opts: Optional[ResourceOptions] = None,
authorized: Optional[bool] = None,
device_id: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var deviceAuthorizationResource = new Tailscale.DeviceAuthorization("deviceAuthorizationResource", new()
{
Authorized = false,
DeviceId = "string",
});
example, err := tailscale.NewDeviceAuthorization(ctx, "deviceAuthorizationResource", &tailscale.DeviceAuthorizationArgs{
Authorized: pulumi.Bool(false),
DeviceId: pulumi.String("string"),
})
var deviceAuthorizationResource = new DeviceAuthorization("deviceAuthorizationResource", DeviceAuthorizationArgs.builder()
.authorized(false)
.deviceId("string")
.build());
device_authorization_resource = tailscale.DeviceAuthorization("deviceAuthorizationResource",
authorized=False,
device_id="string")
const deviceAuthorizationResource = new tailscale.DeviceAuthorization("deviceAuthorizationResource", {
authorized: false,
deviceId: "string",
});
type: tailscale:DeviceAuthorization
properties:
authorized: false
deviceId: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DeviceAuthorization resource accepts the following input properties:
- bool
- Whether or not the device is authorized
- Device
Id string - The device to set as authorized
- bool
- Whether or not the device is authorized
- Device
Id string - The device to set as authorized
- Boolean
- Whether or not the device is authorized
- device
Id String - The device to set as authorized
- boolean
- Whether or not the device is authorized
- device
Id string - The device to set as authorized
- bool
- Whether or not the device is authorized
- device_
id str - The device to set as authorized
- Boolean
- Whether or not the device is authorized
- device
Id 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 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.
- bool
- Whether or not the device is authorized
- Device
Id string - The device to set as authorized
- bool
- Whether or not the device is authorized
- Device
Id string - The device to set as authorized
- Boolean
- Whether or not the device is authorized
- device
Id String - The device to set as authorized
- boolean
- Whether or not the device is authorized
- device
Id string - The device to set as authorized
- bool
- Whether or not the device is authorized
- device_
id str - The device to set as authorized
- Boolean
- Whether or not the device is authorized
- device
Id String - The device to set as authorized
Import
Device authorization can be imported using the device id, e.g.,
$ pulumi import tailscale:index/deviceAuthorization:DeviceAuthorization sample_authorization 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.