Tailscale

Pulumi Official

Package maintained by Pulumi

v0.7.1 published on Monday, Apr 25, 2022 by Pulumi

DeviceAuthorization

The device_authorization resource is used to approve new devices before they can join the tailnet. See the Tailscale device authorization documentation for more information.

The Tailscale API currently only supports authorizing devices, but not rejecting/removing them. Once a device is authorized by this provider it cannot be modified again afterwards. Modifying or deleting the resource will not affect the device’s authorization within the tailnet.

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: Indicates if the device is allowed to join the tailnet.
DeviceId string: The device to authorize.

Authorized bool: Indicates if the device is allowed to join the tailnet.
DeviceId string: The device to authorize.

authorized Boolean: Indicates if the device is allowed to join the tailnet.
deviceId String: The device to authorize.

authorized boolean: Indicates if the device is allowed to join the tailnet.
deviceId string: The device to authorize.

authorized bool: Indicates if the device is allowed to join the tailnet.
device_id str: The device to authorize.

authorized Boolean: Indicates if the device is allowed to join the tailnet.
deviceId String: The device to authorize.

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: Indicates if the device is allowed to join the tailnet.
DeviceId string: The device to authorize.

Authorized bool: Indicates if the device is allowed to join the tailnet.
DeviceId string: The device to authorize.

authorized Boolean: Indicates if the device is allowed to join the tailnet.
deviceId String: The device to authorize.

authorized boolean: Indicates if the device is allowed to join the tailnet.
deviceId string: The device to authorize.

authorized bool: Indicates if the device is allowed to join the tailnet.
device_id str: The device to authorize.

authorized Boolean: Indicates if the device is allowed to join the tailnet.
deviceId String: The device to authorize.

Package Details

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