1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. Extranet
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler

    The zia.Extranet resource manages extranet configurations in the Zscaler Internet Access (ZIA) cloud. Extranets define DNS and IP pool settings for traffic forwarding.

    Example Usage

    Basic Extranet

    Example coming soon!

    Example coming soon!

    Example coming soon!

    import * as zia from "@bdzscaler/pulumi-zia";
    
    const example = new zia.Extranet("example", {
        name: "Example Extranet",
        description: "Managed by Pulumi",
        extranetDnsList: [{
            name: "Primary DNS",
            primaryDnsServer: "8.8.8.8",
            secondaryDnsServer: "8.8.4.4",
        }],
        extranetIpPoolList: [{
            name: "IP Pool 1",
            ipStart: "10.0.0.1",
            ipEnd: "10.0.0.254",
        }],
    });
    
    import zscaler_pulumi_zia as zia
    
    example = zia.Extranet("example",
        name="Example Extranet",
        description="Managed by Pulumi",
        extranet_dns_list=[{
            "name": "Primary DNS",
            "primary_dns_server": "8.8.8.8",
            "secondary_dns_server": "8.8.4.4",
        }],
        extranet_ip_pool_list=[{
            "name": "IP Pool 1",
            "ip_start": "10.0.0.1",
            "ip_end": "10.0.0.254",
        }],
    )
    
    resources:
      example:
        type: zia:Extranet
        properties:
          name: Example Extranet
          description: Managed by Pulumi
          extranetDnsList:
            - name: Primary DNS
              primaryDnsServer: "8.8.8.8"
              secondaryDnsServer: "8.8.4.4"
          extranetIpPoolList:
            - name: IP Pool 1
              ipStart: "10.0.0.1"
              ipEnd: "10.0.0.254"
    

    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_list: Optional[Sequence[ExtranetDnsListInputArgs]] = None,
                 extranet_ip_pool_list: Optional[Sequence[ExtranetIpPoolListInputArgs]] = 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",
        ExtranetDnsList = new[]
        {
            new Zia.Inputs.ExtranetDnsListInputArgs
            {
                Id = 0,
                Name = "string",
                PrimaryDnsServer = "string",
                SecondaryDnsServer = "string",
                UseAsDefault = false,
            },
        },
        ExtranetIpPoolList = new[]
        {
            new Zia.Inputs.ExtranetIpPoolListInputArgs
            {
                Id = 0,
                IpEnd = "string",
                IpStart = "string",
                Name = "string",
                UseAsDefault = false,
            },
        },
        Name = "string",
    });
    
    example, err := zia.NewExtranet(ctx, "extranetResource", &zia.ExtranetArgs{
    	Description: pulumi.String("string"),
    	ExtranetDnsList: pulumizia.ExtranetDnsListInputArray{
    		&pulumizia.ExtranetDnsListInputArgs{
    			Id:                 pulumi.Int(0),
    			Name:               pulumi.String("string"),
    			PrimaryDnsServer:   pulumi.String("string"),
    			SecondaryDnsServer: pulumi.String("string"),
    			UseAsDefault:       pulumi.Bool(false),
    		},
    	},
    	ExtranetIpPoolList: pulumizia.ExtranetIpPoolListInputArray{
    		&pulumizia.ExtranetIpPoolListInputArgs{
    			Id:           pulumi.Int(0),
    			IpEnd:        pulumi.String("string"),
    			IpStart:      pulumi.String("string"),
    			Name:         pulumi.String("string"),
    			UseAsDefault: pulumi.Bool(false),
    		},
    	},
    	Name: pulumi.String("string"),
    })
    
    var extranetResource = new Extranet("extranetResource", ExtranetArgs.builder()
        .description("string")
        .extranetDnsList(ExtranetDnsListInputArgs.builder()
            .id(0)
            .name("string")
            .primaryDnsServer("string")
            .secondaryDnsServer("string")
            .useAsDefault(false)
            .build())
        .extranetIpPoolList(ExtranetIpPoolListInputArgs.builder()
            .id(0)
            .ipEnd("string")
            .ipStart("string")
            .name("string")
            .useAsDefault(false)
            .build())
        .name("string")
        .build());
    
    extranet_resource = zia.Extranet("extranetResource",
        description="string",
        extranet_dns_list=[{
            "id": 0,
            "name": "string",
            "primary_dns_server": "string",
            "secondary_dns_server": "string",
            "use_as_default": False,
        }],
        extranet_ip_pool_list=[{
            "id": 0,
            "ip_end": "string",
            "ip_start": "string",
            "name": "string",
            "use_as_default": False,
        }],
        name="string")
    
    const extranetResource = new zia.Extranet("extranetResource", {
        description: "string",
        extranetDnsList: [{
            id: 0,
            name: "string",
            primaryDnsServer: "string",
            secondaryDnsServer: "string",
            useAsDefault: false,
        }],
        extranetIpPoolList: [{
            id: 0,
            ipEnd: "string",
            ipStart: "string",
            name: "string",
            useAsDefault: false,
        }],
        name: "string",
    });
    
    type: zia:Extranet
    properties:
        description: string
        extranetDnsList:
            - id: 0
              name: string
              primaryDnsServer: string
              secondaryDnsServer: string
              useAsDefault: false
        extranetIpPoolList:
            - 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
    Description of the extranet.
    ExtranetDnsList List<zscaler.PulumiPackage.Zia.Inputs.ExtranetDnsListInput>
    List of DNS server entries for the extranet.
    ExtranetIpPoolList List<zscaler.PulumiPackage.Zia.Inputs.ExtranetIpPoolListInput>
    List of IP pool entries for the extranet.
    Name string
    Name of the extranet.
    Description string
    Description of the extranet.
    ExtranetDnsList []ExtranetDnsListInputArgs
    List of DNS server entries for the extranet.
    ExtranetIpPoolList []ExtranetIpPoolListInputArgs
    List of IP pool entries for the extranet.
    Name string
    Name of the extranet.
    description String
    Description of the extranet.
    extranetDnsList List<ExtranetDnsListInput>
    List of DNS server entries for the extranet.
    extranetIpPoolList List<ExtranetIpPoolListInput>
    List of IP pool entries for the extranet.
    name String
    Name of the extranet.
    description string
    Description of the extranet.
    extranetDnsList ExtranetDnsListInput[]
    List of DNS server entries for the extranet.
    extranetIpPoolList ExtranetIpPoolListInput[]
    List of IP pool entries for the extranet.
    name string
    Name of the extranet.
    description str
    Description of the extranet.
    extranet_dns_list Sequence[ExtranetDnsListInputArgs]
    List of DNS server entries for the extranet.
    extranet_ip_pool_list Sequence[ExtranetIpPoolListInputArgs]
    List of IP pool entries for the extranet.
    name str
    Name of the extranet.
    description String
    Description of the extranet.
    extranetDnsList List<Property Map>
    List of DNS server entries for the extranet.
    extranetIpPoolList List<Property Map>
    List of IP pool entries for the extranet.
    name String
    Name of the extranet.

    Outputs

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

    ExtranetId int
    The unique identifier for the extranet assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    ExtranetId int
    The unique identifier for the extranet assigned by the ZIA cloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    extranetId Integer
    The unique identifier for the extranet assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.
    extranetId number
    The unique identifier for the extranet assigned by the ZIA cloud.
    id string
    The provider-assigned unique ID for this managed resource.
    extranet_id int
    The unique identifier for the extranet assigned by the ZIA cloud.
    id str
    The provider-assigned unique ID for this managed resource.
    extranetId Number
    The unique identifier for the extranet assigned by the ZIA cloud.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ExtranetDnsListInput, ExtranetDnsListInputArgs

    id Integer
    name String
    primaryDnsServer String
    secondaryDnsServer String
    useAsDefault Boolean
    id number
    name string
    primaryDnsServer string
    secondaryDnsServer string
    useAsDefault boolean
    id Number
    name String
    primaryDnsServer String
    secondaryDnsServer String
    useAsDefault Boolean

    ExtranetIpPoolListInput, ExtranetIpPoolListInputArgs

    Id int
    IpEnd string
    IpStart string
    Name string
    UseAsDefault bool
    Id int
    IpEnd string
    IpStart string
    Name string
    UseAsDefault bool
    id Integer
    ipEnd String
    ipStart String
    name String
    useAsDefault Boolean
    id number
    ipEnd string
    ipStart string
    name string
    useAsDefault boolean
    id Number
    ipEnd String
    ipStart String
    name String
    useAsDefault Boolean

    Import

    An existing extranet can be imported using its ID, e.g.

    $ pulumi import zia:index:Extranet example 12345
    

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

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
      Try Pulumi Cloud free. Your team will thank you.