Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. DeviceSettingsPolicy
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.DeviceSettingsPolicy

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
pulumi/pulumi-cloudflare

    Provides a Cloudflare Device Settings Policy resource. Device policies configure settings applied to WARP devices.

    Example Usage

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

const developerWarpPolicy = new cloudflare.DeviceSettingsPolicy("developer_warp_policy", {
    accountId: "f037e56e89293a057740de681ac9abbe",
    name: "Developers WARP settings policy",
    description: "Developers WARP settings policy description",
    precedence: 10,
    match: "any(identity.groups.name[*] in {\"Developers\"})",
    "default": false,
    enabled: true,
    allowModeSwitch: true,
    allowUpdates: true,
    allowedToLeave: true,
    autoConnect: 0,
    captivePortal: 5,
    disableAutoFallback: true,
    supportUrl: "https://cloudflare.com",
    switchLocked: true,
    serviceModeV2Mode: "warp",
    serviceModeV2Port: 3000,
    excludeOfficeIps: false,
    tunnelProtocol: "wireguard",
});

    import pulumi
import pulumi_cloudflare as cloudflare

developer_warp_policy = cloudflare.DeviceSettingsPolicy("developer_warp_policy",
    account_id="f037e56e89293a057740de681ac9abbe",
    name="Developers WARP settings policy",
    description="Developers WARP settings policy description",
    precedence=10,
    match="any(identity.groups.name[*] in {\"Developers\"})",
    default=False,
    enabled=True,
    allow_mode_switch=True,
    allow_updates=True,
    allowed_to_leave=True,
    auto_connect=0,
    captive_portal=5,
    disable_auto_fallback=True,
    support_url="https://cloudflare.com",
    switch_locked=True,
    service_mode_v2_mode="warp",
    service_mode_v2_port=3000,
    exclude_office_ips=False,
    tunnel_protocol="wireguard")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.NewDeviceSettingsPolicy(ctx, "developer_warp_policy", &cloudflare.DeviceSettingsPolicyArgs{
			AccountId:           pulumi.String("f037e56e89293a057740de681ac9abbe"),
			Name:                pulumi.String("Developers WARP settings policy"),
			Description:         pulumi.String("Developers WARP settings policy description"),
			Precedence:          pulumi.Int(10),
			Match:               pulumi.String("any(identity.groups.name[*] in {\"Developers\"})"),
			Default:             pulumi.Bool(false),
			Enabled:             pulumi.Bool(true),
			AllowModeSwitch:     pulumi.Bool(true),
			AllowUpdates:        pulumi.Bool(true),
			AllowedToLeave:      pulumi.Bool(true),
			AutoConnect:         pulumi.Int(0),
			CaptivePortal:       pulumi.Int(5),
			DisableAutoFallback: pulumi.Bool(true),
			SupportUrl:          pulumi.String("https://cloudflare.com"),
			SwitchLocked:        pulumi.Bool(true),
			ServiceModeV2Mode:   pulumi.String("warp"),
			ServiceModeV2Port:   pulumi.Int(3000),
			ExcludeOfficeIps:    pulumi.Bool(false),
			TunnelProtocol:      pulumi.String("wireguard"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var developerWarpPolicy = new Cloudflare.DeviceSettingsPolicy("developer_warp_policy", new()
    {
        AccountId = "f037e56e89293a057740de681ac9abbe",
        Name = "Developers WARP settings policy",
        Description = "Developers WARP settings policy description",
        Precedence = 10,
        Match = "any(identity.groups.name[*] in {\"Developers\"})",
        Default = false,
        Enabled = true,
        AllowModeSwitch = true,
        AllowUpdates = true,
        AllowedToLeave = true,
        AutoConnect = 0,
        CaptivePortal = 5,
        DisableAutoFallback = true,
        SupportUrl = "https://cloudflare.com",
        SwitchLocked = true,
        ServiceModeV2Mode = "warp",
        ServiceModeV2Port = 3000,
        ExcludeOfficeIps = false,
        TunnelProtocol = "wireguard",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.DeviceSettingsPolicy;
import com.pulumi.cloudflare.DeviceSettingsPolicyArgs;
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) {
        var developerWarpPolicy = new DeviceSettingsPolicy("developerWarpPolicy", DeviceSettingsPolicyArgs.builder()
            .accountId("f037e56e89293a057740de681ac9abbe")
            .name("Developers WARP settings policy")
            .description("Developers WARP settings policy description")
            .precedence(10)
            .match("any(identity.groups.name[*] in {\"Developers\"})")
            .default_(false)
            .enabled(true)
            .allowModeSwitch(true)
            .allowUpdates(true)
            .allowedToLeave(true)
            .autoConnect(0)
            .captivePortal(5)
            .disableAutoFallback(true)
            .supportUrl("https://cloudflare.com")
            .switchLocked(true)
            .serviceModeV2Mode("warp")
            .serviceModeV2Port(3000)
            .excludeOfficeIps(false)
            .tunnelProtocol("wireguard")
            .build());

    }
}

    resources:
  developerWarpPolicy:
    type: cloudflare:DeviceSettingsPolicy
    name: developer_warp_policy
    properties:
      accountId: f037e56e89293a057740de681ac9abbe
      name: Developers WARP settings policy
      description: Developers WARP settings policy description
      precedence: 10
      match: any(identity.groups.name[*] in {"Developers"})
      default: false
      enabled: true
      allowModeSwitch: true
      allowUpdates: true
      allowedToLeave: true
      autoConnect: 0
      captivePortal: 5
      disableAutoFallback: true
      supportUrl: https://cloudflare.com
      switchLocked: true
      serviceModeV2Mode: warp
      serviceModeV2Port: 3000
      excludeOfficeIps: false
      tunnelProtocol: wireguard

    Create DeviceSettingsPolicy Resource

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

    Constructor syntax

    new DeviceSettingsPolicy(name: string, args: DeviceSettingsPolicyArgs, opts?: CustomResourceOptions);
    @overload
def DeviceSettingsPolicy(resource_name: str,
                         args: DeviceSettingsPolicyArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def DeviceSettingsPolicy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         account_id: Optional[str] = None,
                         name: Optional[str] = None,
                         description: Optional[str] = None,
                         auto_connect: Optional[int] = None,
                         exclude_office_ips: Optional[bool] = None,
                         captive_portal: Optional[int] = None,
                         default: Optional[bool] = None,
                         allow_updates: Optional[bool] = None,
                         disable_auto_fallback: Optional[bool] = None,
                         enabled: Optional[bool] = None,
                         allowed_to_leave: Optional[bool] = None,
                         match: Optional[str] = None,
                         allow_mode_switch: Optional[bool] = None,
                         precedence: Optional[int] = None,
                         service_mode_v2_mode: Optional[str] = None,
                         service_mode_v2_port: Optional[int] = None,
                         support_url: Optional[str] = None,
                         switch_locked: Optional[bool] = None,
                         tunnel_protocol: Optional[str] = None)
    func NewDeviceSettingsPolicy(ctx *Context, name string, args DeviceSettingsPolicyArgs, opts ...ResourceOption) (*DeviceSettingsPolicy, error)
    public DeviceSettingsPolicy(string name, DeviceSettingsPolicyArgs args, CustomResourceOptions? opts = null)
    public DeviceSettingsPolicy(String name, DeviceSettingsPolicyArgs args)
public DeviceSettingsPolicy(String name, DeviceSettingsPolicyArgs args, CustomResourceOptions options)

    type: cloudflare:DeviceSettingsPolicy
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 DeviceSettingsPolicyArgs
    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 DeviceSettingsPolicyArgs
    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 DeviceSettingsPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DeviceSettingsPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DeviceSettingsPolicyArgs
    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 deviceSettingsPolicyResource = new Cloudflare.DeviceSettingsPolicy("deviceSettingsPolicyResource", new()
{
    AccountId = "string",
    Name = "string",
    Description = "string",
    AutoConnect = 0,
    ExcludeOfficeIps = false,
    CaptivePortal = 0,
    Default = false,
    AllowUpdates = false,
    DisableAutoFallback = false,
    Enabled = false,
    AllowedToLeave = false,
    Match = "string",
    AllowModeSwitch = false,
    Precedence = 0,
    ServiceModeV2Mode = "string",
    ServiceModeV2Port = 0,
    SupportUrl = "string",
    SwitchLocked = false,
    TunnelProtocol = "string",
});

    example, err := cloudflare.NewDeviceSettingsPolicy(ctx, "deviceSettingsPolicyResource", &cloudflare.DeviceSettingsPolicyArgs{
	AccountId:           pulumi.String("string"),
	Name:                pulumi.String("string"),
	Description:         pulumi.String("string"),
	AutoConnect:         pulumi.Int(0),
	ExcludeOfficeIps:    pulumi.Bool(false),
	CaptivePortal:       pulumi.Int(0),
	Default:             pulumi.Bool(false),
	AllowUpdates:        pulumi.Bool(false),
	DisableAutoFallback: pulumi.Bool(false),
	Enabled:             pulumi.Bool(false),
	AllowedToLeave:      pulumi.Bool(false),
	Match:               pulumi.String("string"),
	AllowModeSwitch:     pulumi.Bool(false),
	Precedence:          pulumi.Int(0),
	ServiceModeV2Mode:   pulumi.String("string"),
	ServiceModeV2Port:   pulumi.Int(0),
	SupportUrl:          pulumi.String("string"),
	SwitchLocked:        pulumi.Bool(false),
	TunnelProtocol:      pulumi.String("string"),
})

    var deviceSettingsPolicyResource = new DeviceSettingsPolicy("deviceSettingsPolicyResource", DeviceSettingsPolicyArgs.builder()
    .accountId("string")
    .name("string")
    .description("string")
    .autoConnect(0)
    .excludeOfficeIps(false)
    .captivePortal(0)
    .default_(false)
    .allowUpdates(false)
    .disableAutoFallback(false)
    .enabled(false)
    .allowedToLeave(false)
    .match("string")
    .allowModeSwitch(false)
    .precedence(0)
    .serviceModeV2Mode("string")
    .serviceModeV2Port(0)
    .supportUrl("string")
    .switchLocked(false)
    .tunnelProtocol("string")
    .build());

    device_settings_policy_resource = cloudflare.DeviceSettingsPolicy("deviceSettingsPolicyResource",
    account_id="string",
    name="string",
    description="string",
    auto_connect=0,
    exclude_office_ips=False,
    captive_portal=0,
    default=False,
    allow_updates=False,
    disable_auto_fallback=False,
    enabled=False,
    allowed_to_leave=False,
    match="string",
    allow_mode_switch=False,
    precedence=0,
    service_mode_v2_mode="string",
    service_mode_v2_port=0,
    support_url="string",
    switch_locked=False,
    tunnel_protocol="string")

    const deviceSettingsPolicyResource = new cloudflare.DeviceSettingsPolicy("deviceSettingsPolicyResource", {
    accountId: "string",
    name: "string",
    description: "string",
    autoConnect: 0,
    excludeOfficeIps: false,
    captivePortal: 0,
    "default": false,
    allowUpdates: false,
    disableAutoFallback: false,
    enabled: false,
    allowedToLeave: false,
    match: "string",
    allowModeSwitch: false,
    precedence: 0,
    serviceModeV2Mode: "string",
    serviceModeV2Port: 0,
    supportUrl: "string",
    switchLocked: false,
    tunnelProtocol: "string",
});

    type: cloudflare:DeviceSettingsPolicy
properties:
    accountId: string
    allowModeSwitch: false
    allowUpdates: false
    allowedToLeave: false
    autoConnect: 0
    captivePortal: 0
    default: false
    description: string
    disableAutoFallback: false
    enabled: false
    excludeOfficeIps: false
    match: string
    name: string
    precedence: 0
    serviceModeV2Mode: string
    serviceModeV2Port: 0
    supportUrl: string
    switchLocked: false
    tunnelProtocol: string

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

    AccountId string
    The account identifier to target for the resource.
    Description string
    Description of Policy.
    Name string
    Name of the policy.
    AllowModeSwitch bool
    Whether to allow mode switch for this policy.
    AllowUpdates bool
    Whether to allow updates under this policy.
    AllowedToLeave bool
    Whether to allow devices to leave the organization. Defaults to true.
    AutoConnect int
    The amount of time in seconds to reconnect after having been disabled.
    CaptivePortal int
    The captive portal value for this policy. Defaults to 180.
    Default bool
    Whether the policy refers to the default account policy.
    DisableAutoFallback bool
    Whether to disable auto fallback for this policy.
    Enabled bool
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    ExcludeOfficeIps bool
    Whether to add Microsoft IPs to split tunnel exclusions.
    Match string
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    Precedence int
    The precedence of the policy. Lower values indicate higher precedence.
    ServiceModeV2Mode string
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    ServiceModeV2Port int
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    SupportUrl string
    The support URL that will be opened when sending feedback.
    SwitchLocked bool
    Enablement of the ZT client switch lock.
    TunnelProtocol string
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    AccountId string
    The account identifier to target for the resource.
    Description string
    Description of Policy.
    Name string
    Name of the policy.
    AllowModeSwitch bool
    Whether to allow mode switch for this policy.
    AllowUpdates bool
    Whether to allow updates under this policy.
    AllowedToLeave bool
    Whether to allow devices to leave the organization. Defaults to true.
    AutoConnect int
    The amount of time in seconds to reconnect after having been disabled.
    CaptivePortal int
    The captive portal value for this policy. Defaults to 180.
    Default bool
    Whether the policy refers to the default account policy.
    DisableAutoFallback bool
    Whether to disable auto fallback for this policy.
    Enabled bool
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    ExcludeOfficeIps bool
    Whether to add Microsoft IPs to split tunnel exclusions.
    Match string
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    Precedence int
    The precedence of the policy. Lower values indicate higher precedence.
    ServiceModeV2Mode string
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    ServiceModeV2Port int
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    SupportUrl string
    The support URL that will be opened when sending feedback.
    SwitchLocked bool
    Enablement of the ZT client switch lock.
    TunnelProtocol string
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    accountId String
    The account identifier to target for the resource.
    description String
    Description of Policy.
    name String
    Name of the policy.
    allowModeSwitch Boolean
    Whether to allow mode switch for this policy.
    allowUpdates Boolean
    Whether to allow updates under this policy.
    allowedToLeave Boolean
    Whether to allow devices to leave the organization. Defaults to true.
    autoConnect Integer
    The amount of time in seconds to reconnect after having been disabled.
    captivePortal Integer
    The captive portal value for this policy. Defaults to 180.
    default_ Boolean
    Whether the policy refers to the default account policy.
    disableAutoFallback Boolean
    Whether to disable auto fallback for this policy.
    enabled Boolean
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    excludeOfficeIps Boolean
    Whether to add Microsoft IPs to split tunnel exclusions.
    match String
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    precedence Integer
    The precedence of the policy. Lower values indicate higher precedence.
    serviceModeV2Mode String
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    serviceModeV2Port Integer
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    supportUrl String
    The support URL that will be opened when sending feedback.
    switchLocked Boolean
    Enablement of the ZT client switch lock.
    tunnelProtocol String
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    accountId string
    The account identifier to target for the resource.
    description string
    Description of Policy.
    name string
    Name of the policy.
    allowModeSwitch boolean
    Whether to allow mode switch for this policy.
    allowUpdates boolean
    Whether to allow updates under this policy.
    allowedToLeave boolean
    Whether to allow devices to leave the organization. Defaults to true.
    autoConnect number
    The amount of time in seconds to reconnect after having been disabled.
    captivePortal number
    The captive portal value for this policy. Defaults to 180.
    default boolean
    Whether the policy refers to the default account policy.
    disableAutoFallback boolean
    Whether to disable auto fallback for this policy.
    enabled boolean
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    excludeOfficeIps boolean
    Whether to add Microsoft IPs to split tunnel exclusions.
    match string
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    precedence number
    The precedence of the policy. Lower values indicate higher precedence.
    serviceModeV2Mode string
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    serviceModeV2Port number
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    supportUrl string
    The support URL that will be opened when sending feedback.
    switchLocked boolean
    Enablement of the ZT client switch lock.
    tunnelProtocol string
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    account_id str
    The account identifier to target for the resource.
    description str
    Description of Policy.
    name str
    Name of the policy.
    allow_mode_switch bool
    Whether to allow mode switch for this policy.
    allow_updates bool
    Whether to allow updates under this policy.
    allowed_to_leave bool
    Whether to allow devices to leave the organization. Defaults to true.
    auto_connect int
    The amount of time in seconds to reconnect after having been disabled.
    captive_portal int
    The captive portal value for this policy. Defaults to 180.
    default bool
    Whether the policy refers to the default account policy.
    disable_auto_fallback bool
    Whether to disable auto fallback for this policy.
    enabled bool
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    exclude_office_ips bool
    Whether to add Microsoft IPs to split tunnel exclusions.
    match str
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    precedence int
    The precedence of the policy. Lower values indicate higher precedence.
    service_mode_v2_mode str
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    service_mode_v2_port int
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    support_url str
    The support URL that will be opened when sending feedback.
    switch_locked bool
    Enablement of the ZT client switch lock.
    tunnel_protocol str
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    accountId String
    The account identifier to target for the resource.
    description String
    Description of Policy.
    name String
    Name of the policy.
    allowModeSwitch Boolean
    Whether to allow mode switch for this policy.
    allowUpdates Boolean
    Whether to allow updates under this policy.
    allowedToLeave Boolean
    Whether to allow devices to leave the organization. Defaults to true.
    autoConnect Number
    The amount of time in seconds to reconnect after having been disabled.
    captivePortal Number
    The captive portal value for this policy. Defaults to 180.
    default Boolean
    Whether the policy refers to the default account policy.
    disableAutoFallback Boolean
    Whether to disable auto fallback for this policy.
    enabled Boolean
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    excludeOfficeIps Boolean
    Whether to add Microsoft IPs to split tunnel exclusions.
    match String
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    precedence Number
    The precedence of the policy. Lower values indicate higher precedence.
    serviceModeV2Mode String
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    serviceModeV2Port Number
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    supportUrl String
    The support URL that will be opened when sending feedback.
    switchLocked Boolean
    Enablement of the ZT client switch lock.
    tunnelProtocol String
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.

    Outputs

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

    Get an existing DeviceSettingsPolicy 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?: DeviceSettingsPolicyState, opts?: CustomResourceOptions): DeviceSettingsPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        allow_mode_switch: Optional[bool] = None,
        allow_updates: Optional[bool] = None,
        allowed_to_leave: Optional[bool] = None,
        auto_connect: Optional[int] = None,
        captive_portal: Optional[int] = None,
        default: Optional[bool] = None,
        description: Optional[str] = None,
        disable_auto_fallback: Optional[bool] = None,
        enabled: Optional[bool] = None,
        exclude_office_ips: Optional[bool] = None,
        match: Optional[str] = None,
        name: Optional[str] = None,
        precedence: Optional[int] = None,
        service_mode_v2_mode: Optional[str] = None,
        service_mode_v2_port: Optional[int] = None,
        support_url: Optional[str] = None,
        switch_locked: Optional[bool] = None,
        tunnel_protocol: Optional[str] = None) -> DeviceSettingsPolicy
    func GetDeviceSettingsPolicy(ctx *Context, name string, id IDInput, state *DeviceSettingsPolicyState, opts ...ResourceOption) (*DeviceSettingsPolicy, error)
    public static DeviceSettingsPolicy Get(string name, Input<string> id, DeviceSettingsPolicyState? state, CustomResourceOptions? opts = null)
    public static DeviceSettingsPolicy get(String name, Output<String> id, DeviceSettingsPolicyState 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:
    AccountId string
    The account identifier to target for the resource.
    AllowModeSwitch bool
    Whether to allow mode switch for this policy.
    AllowUpdates bool
    Whether to allow updates under this policy.
    AllowedToLeave bool
    Whether to allow devices to leave the organization. Defaults to true.
    AutoConnect int
    The amount of time in seconds to reconnect after having been disabled.
    CaptivePortal int
    The captive portal value for this policy. Defaults to 180.
    Default bool
    Whether the policy refers to the default account policy.
    Description string
    Description of Policy.
    DisableAutoFallback bool
    Whether to disable auto fallback for this policy.
    Enabled bool
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    ExcludeOfficeIps bool
    Whether to add Microsoft IPs to split tunnel exclusions.
    Match string
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    Name string
    Name of the policy.
    Precedence int
    The precedence of the policy. Lower values indicate higher precedence.
    ServiceModeV2Mode string
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    ServiceModeV2Port int
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    SupportUrl string
    The support URL that will be opened when sending feedback.
    SwitchLocked bool
    Enablement of the ZT client switch lock.
    TunnelProtocol string
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    AccountId string
    The account identifier to target for the resource.
    AllowModeSwitch bool
    Whether to allow mode switch for this policy.
    AllowUpdates bool
    Whether to allow updates under this policy.
    AllowedToLeave bool
    Whether to allow devices to leave the organization. Defaults to true.
    AutoConnect int
    The amount of time in seconds to reconnect after having been disabled.
    CaptivePortal int
    The captive portal value for this policy. Defaults to 180.
    Default bool
    Whether the policy refers to the default account policy.
    Description string
    Description of Policy.
    DisableAutoFallback bool
    Whether to disable auto fallback for this policy.
    Enabled bool
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    ExcludeOfficeIps bool
    Whether to add Microsoft IPs to split tunnel exclusions.
    Match string
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    Name string
    Name of the policy.
    Precedence int
    The precedence of the policy. Lower values indicate higher precedence.
    ServiceModeV2Mode string
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    ServiceModeV2Port int
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    SupportUrl string
    The support URL that will be opened when sending feedback.
    SwitchLocked bool
    Enablement of the ZT client switch lock.
    TunnelProtocol string
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    accountId String
    The account identifier to target for the resource.
    allowModeSwitch Boolean
    Whether to allow mode switch for this policy.
    allowUpdates Boolean
    Whether to allow updates under this policy.
    allowedToLeave Boolean
    Whether to allow devices to leave the organization. Defaults to true.
    autoConnect Integer
    The amount of time in seconds to reconnect after having been disabled.
    captivePortal Integer
    The captive portal value for this policy. Defaults to 180.
    default_ Boolean
    Whether the policy refers to the default account policy.
    description String
    Description of Policy.
    disableAutoFallback Boolean
    Whether to disable auto fallback for this policy.
    enabled Boolean
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    excludeOfficeIps Boolean
    Whether to add Microsoft IPs to split tunnel exclusions.
    match String
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    name String
    Name of the policy.
    precedence Integer
    The precedence of the policy. Lower values indicate higher precedence.
    serviceModeV2Mode String
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    serviceModeV2Port Integer
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    supportUrl String
    The support URL that will be opened when sending feedback.
    switchLocked Boolean
    Enablement of the ZT client switch lock.
    tunnelProtocol String
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    accountId string
    The account identifier to target for the resource.
    allowModeSwitch boolean
    Whether to allow mode switch for this policy.
    allowUpdates boolean
    Whether to allow updates under this policy.
    allowedToLeave boolean
    Whether to allow devices to leave the organization. Defaults to true.
    autoConnect number
    The amount of time in seconds to reconnect after having been disabled.
    captivePortal number
    The captive portal value for this policy. Defaults to 180.
    default boolean
    Whether the policy refers to the default account policy.
    description string
    Description of Policy.
    disableAutoFallback boolean
    Whether to disable auto fallback for this policy.
    enabled boolean
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    excludeOfficeIps boolean
    Whether to add Microsoft IPs to split tunnel exclusions.
    match string
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    name string
    Name of the policy.
    precedence number
    The precedence of the policy. Lower values indicate higher precedence.
    serviceModeV2Mode string
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    serviceModeV2Port number
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    supportUrl string
    The support URL that will be opened when sending feedback.
    switchLocked boolean
    Enablement of the ZT client switch lock.
    tunnelProtocol string
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    account_id str
    The account identifier to target for the resource.
    allow_mode_switch bool
    Whether to allow mode switch for this policy.
    allow_updates bool
    Whether to allow updates under this policy.
    allowed_to_leave bool
    Whether to allow devices to leave the organization. Defaults to true.
    auto_connect int
    The amount of time in seconds to reconnect after having been disabled.
    captive_portal int
    The captive portal value for this policy. Defaults to 180.
    default bool
    Whether the policy refers to the default account policy.
    description str
    Description of Policy.
    disable_auto_fallback bool
    Whether to disable auto fallback for this policy.
    enabled bool
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    exclude_office_ips bool
    Whether to add Microsoft IPs to split tunnel exclusions.
    match str
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    name str
    Name of the policy.
    precedence int
    The precedence of the policy. Lower values indicate higher precedence.
    service_mode_v2_mode str
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    service_mode_v2_port int
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    support_url str
    The support URL that will be opened when sending feedback.
    switch_locked bool
    Enablement of the ZT client switch lock.
    tunnel_protocol str
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.
    accountId String
    The account identifier to target for the resource.
    allowModeSwitch Boolean
    Whether to allow mode switch for this policy.
    allowUpdates Boolean
    Whether to allow updates under this policy.
    allowedToLeave Boolean
    Whether to allow devices to leave the organization. Defaults to true.
    autoConnect Number
    The amount of time in seconds to reconnect after having been disabled.
    captivePortal Number
    The captive portal value for this policy. Defaults to 180.
    default Boolean
    Whether the policy refers to the default account policy.
    description String
    Description of Policy.
    disableAutoFallback Boolean
    Whether to disable auto fallback for this policy.
    enabled Boolean
    Whether the policy is enabled (cannot be set for default policies). Defaults to true.
    excludeOfficeIps Boolean
    Whether to add Microsoft IPs to split tunnel exclusions.
    match String
    Wirefilter expression to match a device against when evaluating whether this policy should take effect for that device.
    name String
    Name of the policy.
    precedence Number
    The precedence of the policy. Lower values indicate higher precedence.
    serviceModeV2Mode String
    The service mode. Available values: 1dot1, warp, proxy, posture_only, warp_tunnel_only. Defaults to warp.
    serviceModeV2Port Number
    The port to use for the proxy service mode. Required when using service_mode_v2_mode.
    supportUrl String
    The support URL that will be opened when sending feedback.
    switchLocked Boolean
    Enablement of the ZT client switch lock.
    tunnelProtocol String
    Determines which tunnel protocol to use. Available values: "", wireguard, masque. Defaults to wireguard.

    Import

    For default device settings policies you must use “default” as the policy ID.

    $ pulumi import cloudflare:index/deviceSettingsPolicy:DeviceSettingsPolicy example <account_id>/<device_policy_id>

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

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v5.43.0 published on Wednesday, Nov 13, 2024 by Pulumi
    pulumi/pulumi-cloudflare