Use the zia_extranet resource Adds a new extranet for the organization in the Zscaler Internet Access cloud. Extranets are configured as part of Zscaler Extranet Application Support which allows an organization to connect its internal network with another organization’s network (e.g., partners, third-party vendors, etc.) that does not use the Zscaler service. Extranet Application Support enables Zscaler-managed organization users to securely access extranet resources through an IPSec VPN tunnel established between the Zscaler data center and the external organization’s data center, without requiring additional hardware or software installations.
NOTE: This an Early Access feature.
Example Usage
Retrieve By Name
resource "zia_extranet" "this" {
name = "Extranet01"
description = "Extranet01"
extranet_dns_list {
name = "DNS01"
primary_dns_server = "8.8.8.8"
secondary_dns_server = "4.4.4.4"
use_as_default = true
}
extranet_dns_list {
name = "DNS02"
primary_dns_server = "192.168.1.1"
secondary_dns_server = "192.168.1.2"
use_as_default = false
}
extranet_ip_pool_list {
name = "TFS01"
ip_start = "10.0.0.1"
ip_end = "10.0.0.21"
use_as_default = true
}
extranet_ip_pool_list {
name = "TFS02"
ip_start = "10.0.0.22"
ip_end = "10.0.0.43"
use_as_default = false
}
}
Create Extranet Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Extranet(name: string, args?: ExtranetArgs, opts?: CustomResourceOptions);@overload
def Extranet(resource_name: str,
args: Optional[ExtranetArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Extranet(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
extranet_dns_lists: Optional[Sequence[ExtranetExtranetDnsListArgs]] = None,
extranet_ip_pool_lists: Optional[Sequence[ExtranetExtranetIpPoolListArgs]] = None,
name: Optional[str] = None)func NewExtranet(ctx *Context, name string, args *ExtranetArgs, opts ...ResourceOption) (*Extranet, error)public Extranet(string name, ExtranetArgs? args = null, CustomResourceOptions? opts = null)
public Extranet(String name, ExtranetArgs args)
public Extranet(String name, ExtranetArgs args, CustomResourceOptions options)
type: zia:Extranet
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 ExtranetArgs
- 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 ExtranetArgs
- 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 ExtranetArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ExtranetArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ExtranetArgs
- 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 extranetResource = new Zia.Extranet("extranetResource", new()
{
Description = "string",
ExtranetDnsLists = new[]
{
new Zia.Inputs.ExtranetExtranetDnsListArgs
{
Name = "string",
PrimaryDnsServer = "string",
Id = 0,
SecondaryDnsServer = "string",
UseAsDefault = false,
},
},
ExtranetIpPoolLists = new[]
{
new Zia.Inputs.ExtranetExtranetIpPoolListArgs
{
IpEnd = "string",
IpStart = "string",
Name = "string",
Id = 0,
UseAsDefault = false,
},
},
Name = "string",
});
example, err := zia.NewExtranet(ctx, "extranetResource", &zia.ExtranetArgs{
Description: pulumi.String("string"),
ExtranetDnsLists: zia.ExtranetExtranetDnsListArray{
&zia.ExtranetExtranetDnsListArgs{
Name: pulumi.String("string"),
PrimaryDnsServer: pulumi.String("string"),
Id: pulumi.Int(0),
SecondaryDnsServer: pulumi.String("string"),
UseAsDefault: pulumi.Bool(false),
},
},
ExtranetIpPoolLists: zia.ExtranetExtranetIpPoolListArray{
&zia.ExtranetExtranetIpPoolListArgs{
IpEnd: pulumi.String("string"),
IpStart: pulumi.String("string"),
Name: pulumi.String("string"),
Id: pulumi.Int(0),
UseAsDefault: pulumi.Bool(false),
},
},
Name: pulumi.String("string"),
})
var extranetResource = new Extranet("extranetResource", ExtranetArgs.builder()
.description("string")
.extranetDnsLists(ExtranetExtranetDnsListArgs.builder()
.name("string")
.primaryDnsServer("string")
.id(0)
.secondaryDnsServer("string")
.useAsDefault(false)
.build())
.extranetIpPoolLists(ExtranetExtranetIpPoolListArgs.builder()
.ipEnd("string")
.ipStart("string")
.name("string")
.id(0)
.useAsDefault(false)
.build())
.name("string")
.build());
extranet_resource = zia.Extranet("extranetResource",
description="string",
extranet_dns_lists=[{
"name": "string",
"primary_dns_server": "string",
"id": 0,
"secondary_dns_server": "string",
"use_as_default": False,
}],
extranet_ip_pool_lists=[{
"ip_end": "string",
"ip_start": "string",
"name": "string",
"id": 0,
"use_as_default": False,
}],
name="string")
const extranetResource = new zia.Extranet("extranetResource", {
description: "string",
extranetDnsLists: [{
name: "string",
primaryDnsServer: "string",
id: 0,
secondaryDnsServer: "string",
useAsDefault: false,
}],
extranetIpPoolLists: [{
ipEnd: "string",
ipStart: "string",
name: "string",
id: 0,
useAsDefault: false,
}],
name: "string",
});
type: zia:Extranet
properties:
description: string
extranetDnsLists:
- id: 0
name: string
primaryDnsServer: string
secondaryDnsServer: string
useAsDefault: false
extranetIpPoolLists:
- id: 0
ipEnd: string
ipStart: string
name: string
useAsDefault: false
name: string
Extranet 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 Extranet resource accepts the following input properties:
- Description string
- (String) The description of the extranet.
- Extranet
Dns List<zscaler.Lists Pulumi Package. Zia. Inputs. Extranet Extranet Dns List> - (List) Information about the DNS servers specified for the extranet.
- Extranet
Ip List<zscaler.Pool Lists Pulumi Package. Zia. Inputs. Extranet Extranet Ip Pool List> - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- Name string
- (String) The name of the IP pool.
- Description string
- (String) The description of the extranet.
- Extranet
Dns []ExtranetLists Extranet Dns List Args - (List) Information about the DNS servers specified for the extranet.
- Extranet
Ip []ExtranetPool Lists Extranet Ip Pool List Args - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- Name string
- (String) The name of the IP pool.
- description String
- (String) The description of the extranet.
- extranet
Dns List<ExtranetLists Extranet Dns List> - (List) Information about the DNS servers specified for the extranet.
- extranet
Ip List<ExtranetPool Lists Extranet Ip Pool List> - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- name String
- (String) The name of the IP pool.
- description string
- (String) The description of the extranet.
- extranet
Dns ExtranetLists Extranet Dns List[] - (List) Information about the DNS servers specified for the extranet.
- extranet
Ip ExtranetPool Lists Extranet Ip Pool List[] - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- name string
- (String) The name of the IP pool.
- description str
- (String) The description of the extranet.
- extranet_
dns_ Sequence[Extranetlists Extranet Dns List Args] - (List) Information about the DNS servers specified for the extranet.
- extranet_
ip_ Sequence[Extranetpool_ lists Extranet Ip Pool List Args] - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- name str
- (String) The name of the IP pool.
- description String
- (String) The description of the extranet.
- extranet
Dns List<Property Map>Lists - (List) Information about the DNS servers specified for the extranet.
- extranet
Ip List<Property Map>Pool Lists - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- name String
- (String) The name of the IP pool.
Outputs
All input properties are implicitly available as output properties. Additionally, the Extranet resource produces the following output properties:
- Extranet
Id int - Id string
- The provider-assigned unique ID for this managed resource.
- Extranet
Id int - Id string
- The provider-assigned unique ID for this managed resource.
- extranet
Id Integer - id String
- The provider-assigned unique ID for this managed resource.
- extranet
Id number - id string
- The provider-assigned unique ID for this managed resource.
- extranet_
id int - id str
- The provider-assigned unique ID for this managed resource.
- extranet
Id Number - id String
- The provider-assigned unique ID for this managed resource.
Look up Existing Extranet Resource
Get an existing Extranet 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?: ExtranetState, opts?: CustomResourceOptions): Extranet@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
extranet_dns_lists: Optional[Sequence[ExtranetExtranetDnsListArgs]] = None,
extranet_id: Optional[int] = None,
extranet_ip_pool_lists: Optional[Sequence[ExtranetExtranetIpPoolListArgs]] = None,
name: Optional[str] = None) -> Extranetfunc GetExtranet(ctx *Context, name string, id IDInput, state *ExtranetState, opts ...ResourceOption) (*Extranet, error)public static Extranet Get(string name, Input<string> id, ExtranetState? state, CustomResourceOptions? opts = null)public static Extranet get(String name, Output<String> id, ExtranetState state, CustomResourceOptions options)resources: _: type: zia:Extranet get: id: ${id}- 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.
- Description string
- (String) The description of the extranet.
- Extranet
Dns List<zscaler.Lists Pulumi Package. Zia. Inputs. Extranet Extranet Dns List> - (List) Information about the DNS servers specified for the extranet.
- Extranet
Id int - Extranet
Ip List<zscaler.Pool Lists Pulumi Package. Zia. Inputs. Extranet Extranet Ip Pool List> - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- Name string
- (String) The name of the IP pool.
- Description string
- (String) The description of the extranet.
- Extranet
Dns []ExtranetLists Extranet Dns List Args - (List) Information about the DNS servers specified for the extranet.
- Extranet
Id int - Extranet
Ip []ExtranetPool Lists Extranet Ip Pool List Args - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- Name string
- (String) The name of the IP pool.
- description String
- (String) The description of the extranet.
- extranet
Dns List<ExtranetLists Extranet Dns List> - (List) Information about the DNS servers specified for the extranet.
- extranet
Id Integer - extranet
Ip List<ExtranetPool Lists Extranet Ip Pool List> - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- name String
- (String) The name of the IP pool.
- description string
- (String) The description of the extranet.
- extranet
Dns ExtranetLists Extranet Dns List[] - (List) Information about the DNS servers specified for the extranet.
- extranet
Id number - extranet
Ip ExtranetPool Lists Extranet Ip Pool List[] - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- name string
- (String) The name of the IP pool.
- description str
- (String) The description of the extranet.
- extranet_
dns_ Sequence[Extranetlists Extranet Dns List Args] - (List) Information about the DNS servers specified for the extranet.
- extranet_
id int - extranet_
ip_ Sequence[Extranetpool_ lists Extranet Ip Pool List Args] - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- name str
- (String) The name of the IP pool.
- description String
- (String) The description of the extranet.
- extranet
Dns List<Property Map>Lists - (List) Information about the DNS servers specified for the extranet.
- extranet
Id Number - extranet
Ip List<Property Map>Pool Lists - (List) Information about the traffic selectors (IP pools) specified for the extranet.
- name String
- (String) The name of the IP pool.
Supporting Types
ExtranetExtranetDnsList, ExtranetExtranetDnsListArgs
- Name string
- (String) The name of the IP pool.
- Primary
Dns stringServer - (String) The IP address of the primary DNS server.
- Id int
- (Integer) The unique identifier for the extranet.
- Secondary
Dns stringServer - (String) The IP address of the secondary DNS server.
- Use
As boolDefault - (Boolean) Whether this IP pool is the designated default.
- Name string
- (String) The name of the IP pool.
- Primary
Dns stringServer - (String) The IP address of the primary DNS server.
- Id int
- (Integer) The unique identifier for the extranet.
- Secondary
Dns stringServer - (String) The IP address of the secondary DNS server.
- Use
As boolDefault - (Boolean) Whether this IP pool is the designated default.
- name String
- (String) The name of the IP pool.
- primary
Dns StringServer - (String) The IP address of the primary DNS server.
- id Integer
- (Integer) The unique identifier for the extranet.
- secondary
Dns StringServer - (String) The IP address of the secondary DNS server.
- use
As BooleanDefault - (Boolean) Whether this IP pool is the designated default.
- name string
- (String) The name of the IP pool.
- primary
Dns stringServer - (String) The IP address of the primary DNS server.
- id number
- (Integer) The unique identifier for the extranet.
- secondary
Dns stringServer - (String) The IP address of the secondary DNS server.
- use
As booleanDefault - (Boolean) Whether this IP pool is the designated default.
- name str
- (String) The name of the IP pool.
- primary_
dns_ strserver - (String) The IP address of the primary DNS server.
- id int
- (Integer) The unique identifier for the extranet.
- secondary_
dns_ strserver - (String) The IP address of the secondary DNS server.
- use_
as_ booldefault - (Boolean) Whether this IP pool is the designated default.
- name String
- (String) The name of the IP pool.
- primary
Dns StringServer - (String) The IP address of the primary DNS server.
- id Number
- (Integer) The unique identifier for the extranet.
- secondary
Dns StringServer - (String) The IP address of the secondary DNS server.
- use
As BooleanDefault - (Boolean) Whether this IP pool is the designated default.
ExtranetExtranetIpPoolList, ExtranetExtranetIpPoolListArgs
- Ip
End string - (String) The ending IP address of the pool.
- Ip
Start string - (String) The starting IP address of the pool.
- Name string
- (String) The name of the IP pool.
- Id int
- (Integer) The unique identifier for the extranet.
- Use
As boolDefault - (Boolean) Whether this IP pool is the designated default.
- Ip
End string - (String) The ending IP address of the pool.
- Ip
Start string - (String) The starting IP address of the pool.
- Name string
- (String) The name of the IP pool.
- Id int
- (Integer) The unique identifier for the extranet.
- Use
As boolDefault - (Boolean) Whether this IP pool is the designated default.
- ip
End String - (String) The ending IP address of the pool.
- ip
Start String - (String) The starting IP address of the pool.
- name String
- (String) The name of the IP pool.
- id Integer
- (Integer) The unique identifier for the extranet.
- use
As BooleanDefault - (Boolean) Whether this IP pool is the designated default.
- ip
End string - (String) The ending IP address of the pool.
- ip
Start string - (String) The starting IP address of the pool.
- name string
- (String) The name of the IP pool.
- id number
- (Integer) The unique identifier for the extranet.
- use
As booleanDefault - (Boolean) Whether this IP pool is the designated default.
- ip_
end str - (String) The ending IP address of the pool.
- ip_
start str - (String) The starting IP address of the pool.
- name str
- (String) The name of the IP pool.
- id int
- (Integer) The unique identifier for the extranet.
- use_
as_ booldefault - (Boolean) Whether this IP pool is the designated default.
- ip
End String - (String) The ending IP address of the pool.
- ip
Start String - (String) The starting IP address of the pool.
- name String
- (String) The name of the IP pool.
- id Number
- (Integer) The unique identifier for the extranet.
- use
As BooleanDefault - (Boolean) Whether this IP pool is the designated default.
Import
Zscaler offers a dedicated tool called Zscaler-Terraformer to allow the automated import of ZIA configurations into Terraform-compliant HashiCorp Configuration Language. Visit
zia_extranet can be imported by using <EXTRANET ID> or <EXTRANET NAME> as the import ID.
For example:
$ pulumi import zia:index/extranet:Extranet example <extranet_id>
or
$ pulumi import zia:index/extranet:Extranet example <extranet_name>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- zia zscaler/pulumi-zia
- License
- MIT
- Notes
- This Pulumi package is based on the
ziaTerraform Provider.
