1. Packages
  2. Cloudflare
  3. API Docs
  4. TeamsProxyEndpoint
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

cloudflare.TeamsProxyEndpoint

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

    Provides a Cloudflare Teams Proxy Endpoint resource. Teams Proxy Endpoints are used for pointing proxy clients at Cloudflare Secure Gateway.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const example = new cloudflare.TeamsProxyEndpoint("example", {
        accountId: "f037e56e89293a057740de681ac9abbe",
        name: "office",
        ips: ["192.0.2.0/24"],
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example = cloudflare.TeamsProxyEndpoint("example",
        account_id="f037e56e89293a057740de681ac9abbe",
        name="office",
        ips=["192.0.2.0/24"])
    
    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.NewTeamsProxyEndpoint(ctx, "example", &cloudflare.TeamsProxyEndpointArgs{
    			AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
    			Name:      pulumi.String("office"),
    			Ips: pulumi.StringArray{
    				pulumi.String("192.0.2.0/24"),
    			},
    		})
    		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 example = new Cloudflare.TeamsProxyEndpoint("example", new()
        {
            AccountId = "f037e56e89293a057740de681ac9abbe",
            Name = "office",
            Ips = new[]
            {
                "192.0.2.0/24",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.TeamsProxyEndpoint;
    import com.pulumi.cloudflare.TeamsProxyEndpointArgs;
    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 example = new TeamsProxyEndpoint("example", TeamsProxyEndpointArgs.builder()
                .accountId("f037e56e89293a057740de681ac9abbe")
                .name("office")
                .ips("192.0.2.0/24")
                .build());
    
        }
    }
    
    resources:
      example:
        type: cloudflare:TeamsProxyEndpoint
        properties:
          accountId: f037e56e89293a057740de681ac9abbe
          name: office
          ips:
            - 192.0.2.0/24
    

    Create TeamsProxyEndpoint Resource

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

    Constructor syntax

    new TeamsProxyEndpoint(name: string, args: TeamsProxyEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def TeamsProxyEndpoint(resource_name: str,
                           args: TeamsProxyEndpointArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def TeamsProxyEndpoint(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           account_id: Optional[str] = None,
                           ips: Optional[Sequence[str]] = None,
                           name: Optional[str] = None)
    func NewTeamsProxyEndpoint(ctx *Context, name string, args TeamsProxyEndpointArgs, opts ...ResourceOption) (*TeamsProxyEndpoint, error)
    public TeamsProxyEndpoint(string name, TeamsProxyEndpointArgs args, CustomResourceOptions? opts = null)
    public TeamsProxyEndpoint(String name, TeamsProxyEndpointArgs args)
    public TeamsProxyEndpoint(String name, TeamsProxyEndpointArgs args, CustomResourceOptions options)
    
    type: cloudflare:TeamsProxyEndpoint
    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 TeamsProxyEndpointArgs
    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 TeamsProxyEndpointArgs
    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 TeamsProxyEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TeamsProxyEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TeamsProxyEndpointArgs
    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 teamsProxyEndpointResource = new Cloudflare.TeamsProxyEndpoint("teamsProxyEndpointResource", new()
    {
        AccountId = "string",
        Ips = new[]
        {
            "string",
        },
        Name = "string",
    });
    
    example, err := cloudflare.NewTeamsProxyEndpoint(ctx, "teamsProxyEndpointResource", &cloudflare.TeamsProxyEndpointArgs{
    	AccountId: pulumi.String("string"),
    	Ips: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var teamsProxyEndpointResource = new TeamsProxyEndpoint("teamsProxyEndpointResource", TeamsProxyEndpointArgs.builder()
        .accountId("string")
        .ips("string")
        .name("string")
        .build());
    
    teams_proxy_endpoint_resource = cloudflare.TeamsProxyEndpoint("teamsProxyEndpointResource",
        account_id="string",
        ips=["string"],
        name="string")
    
    const teamsProxyEndpointResource = new cloudflare.TeamsProxyEndpoint("teamsProxyEndpointResource", {
        accountId: "string",
        ips: ["string"],
        name: "string",
    });
    
    type: cloudflare:TeamsProxyEndpoint
    properties:
        accountId: string
        ips:
            - string
        name: string
    

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

    AccountId string
    The account identifier to target for the resource.
    Ips List<string>
    The networks CIDRs that will be allowed to initiate proxy connections.
    Name string
    Name of the teams proxy endpoint.
    AccountId string
    The account identifier to target for the resource.
    Ips []string
    The networks CIDRs that will be allowed to initiate proxy connections.
    Name string
    Name of the teams proxy endpoint.
    accountId String
    The account identifier to target for the resource.
    ips List<String>
    The networks CIDRs that will be allowed to initiate proxy connections.
    name String
    Name of the teams proxy endpoint.
    accountId string
    The account identifier to target for the resource.
    ips string[]
    The networks CIDRs that will be allowed to initiate proxy connections.
    name string
    Name of the teams proxy endpoint.
    account_id str
    The account identifier to target for the resource.
    ips Sequence[str]
    The networks CIDRs that will be allowed to initiate proxy connections.
    name str
    Name of the teams proxy endpoint.
    accountId String
    The account identifier to target for the resource.
    ips List<String>
    The networks CIDRs that will be allowed to initiate proxy connections.
    name String
    Name of the teams proxy endpoint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TeamsProxyEndpoint resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Subdomain string
    The FQDN that proxy clients should be pointed at.
    Id string
    The provider-assigned unique ID for this managed resource.
    Subdomain string
    The FQDN that proxy clients should be pointed at.
    id String
    The provider-assigned unique ID for this managed resource.
    subdomain String
    The FQDN that proxy clients should be pointed at.
    id string
    The provider-assigned unique ID for this managed resource.
    subdomain string
    The FQDN that proxy clients should be pointed at.
    id str
    The provider-assigned unique ID for this managed resource.
    subdomain str
    The FQDN that proxy clients should be pointed at.
    id String
    The provider-assigned unique ID for this managed resource.
    subdomain String
    The FQDN that proxy clients should be pointed at.

    Look up Existing TeamsProxyEndpoint Resource

    Get an existing TeamsProxyEndpoint 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?: TeamsProxyEndpointState, opts?: CustomResourceOptions): TeamsProxyEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            ips: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            subdomain: Optional[str] = None) -> TeamsProxyEndpoint
    func GetTeamsProxyEndpoint(ctx *Context, name string, id IDInput, state *TeamsProxyEndpointState, opts ...ResourceOption) (*TeamsProxyEndpoint, error)
    public static TeamsProxyEndpoint Get(string name, Input<string> id, TeamsProxyEndpointState? state, CustomResourceOptions? opts = null)
    public static TeamsProxyEndpoint get(String name, Output<String> id, TeamsProxyEndpointState 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.
    Ips List<string>
    The networks CIDRs that will be allowed to initiate proxy connections.
    Name string
    Name of the teams proxy endpoint.
    Subdomain string
    The FQDN that proxy clients should be pointed at.
    AccountId string
    The account identifier to target for the resource.
    Ips []string
    The networks CIDRs that will be allowed to initiate proxy connections.
    Name string
    Name of the teams proxy endpoint.
    Subdomain string
    The FQDN that proxy clients should be pointed at.
    accountId String
    The account identifier to target for the resource.
    ips List<String>
    The networks CIDRs that will be allowed to initiate proxy connections.
    name String
    Name of the teams proxy endpoint.
    subdomain String
    The FQDN that proxy clients should be pointed at.
    accountId string
    The account identifier to target for the resource.
    ips string[]
    The networks CIDRs that will be allowed to initiate proxy connections.
    name string
    Name of the teams proxy endpoint.
    subdomain string
    The FQDN that proxy clients should be pointed at.
    account_id str
    The account identifier to target for the resource.
    ips Sequence[str]
    The networks CIDRs that will be allowed to initiate proxy connections.
    name str
    Name of the teams proxy endpoint.
    subdomain str
    The FQDN that proxy clients should be pointed at.
    accountId String
    The account identifier to target for the resource.
    ips List<String>
    The networks CIDRs that will be allowed to initiate proxy connections.
    name String
    Name of the teams proxy endpoint.
    subdomain String
    The FQDN that proxy clients should be pointed at.

    Import

    $ pulumi import cloudflare:index/teamsProxyEndpoint:TeamsProxyEndpoint example <account_id>/<proxy_endpoint_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.34.0 published on Friday, Jul 12, 2024 by Pulumi