1. Packages
  2. Okta Provider
  3. API Docs
  4. getNetworkZone
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi

okta.getNetworkZone

Explore with Pulumi AI

okta logo
Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi

    Gets Okta Network Zone.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.getNetworkZone({
        name: "Block Antarctica",
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.get_network_zone(name="Block Antarctica")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.GetNetworkZone(ctx, &okta.GetNetworkZoneArgs{
    			Name: pulumi.StringRef("Block Antarctica"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Okta.GetNetworkZone.Invoke(new()
        {
            Name = "Block Antarctica",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    import com.pulumi.okta.inputs.GetNetworkZoneArgs;
    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) {
            final var example = OktaFunctions.getNetworkZone(GetNetworkZoneArgs.builder()
                .name("Block Antarctica")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: okta:getNetworkZone
          Arguments:
            name: Block Antarctica
    

    Using getNetworkZone

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNetworkZone(args: GetNetworkZoneArgs, opts?: InvokeOptions): Promise<GetNetworkZoneResult>
    function getNetworkZoneOutput(args: GetNetworkZoneOutputArgs, opts?: InvokeOptions): Output<GetNetworkZoneResult>
    def get_network_zone(dynamic_locations_excludes: Optional[Sequence[str]] = None,
                         id: Optional[str] = None,
                         ip_service_categories_excludes: Optional[Sequence[str]] = None,
                         ip_service_categories_includes: Optional[Sequence[str]] = None,
                         name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNetworkZoneResult
    def get_network_zone_output(dynamic_locations_excludes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         ip_service_categories_excludes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         ip_service_categories_includes: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetNetworkZoneResult]
    func GetNetworkZone(ctx *Context, args *GetNetworkZoneArgs, opts ...InvokeOption) (*GetNetworkZoneResult, error)
    func GetNetworkZoneOutput(ctx *Context, args *GetNetworkZoneOutputArgs, opts ...InvokeOption) GetNetworkZoneResultOutput

    > Note: This function is named GetNetworkZone in the Go SDK.

    public static class GetNetworkZone 
    {
        public static Task<GetNetworkZoneResult> InvokeAsync(GetNetworkZoneArgs args, InvokeOptions? opts = null)
        public static Output<GetNetworkZoneResult> Invoke(GetNetworkZoneInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNetworkZoneResult> getNetworkZone(GetNetworkZoneArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: okta:index/getNetworkZone:getNetworkZone
      arguments:
        # arguments dictionary

    The following arguments are supported:

    DynamicLocationsExcludes List<string>
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    Id string
    ID of the network zone to retrieve, conflicts with name.
    IpServiceCategoriesExcludes List<string>
    List of ip service excluded. Use with type DYNAMIC_V2
    IpServiceCategoriesIncludes List<string>
    List of ip service included. Use with type DYNAMIC_V2
    Name string
    Name of the network zone to retrieve, conflicts with id.
    DynamicLocationsExcludes []string
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    Id string
    ID of the network zone to retrieve, conflicts with name.
    IpServiceCategoriesExcludes []string
    List of ip service excluded. Use with type DYNAMIC_V2
    IpServiceCategoriesIncludes []string
    List of ip service included. Use with type DYNAMIC_V2
    Name string
    Name of the network zone to retrieve, conflicts with id.
    dynamicLocationsExcludes List<String>
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    id String
    ID of the network zone to retrieve, conflicts with name.
    ipServiceCategoriesExcludes List<String>
    List of ip service excluded. Use with type DYNAMIC_V2
    ipServiceCategoriesIncludes List<String>
    List of ip service included. Use with type DYNAMIC_V2
    name String
    Name of the network zone to retrieve, conflicts with id.
    dynamicLocationsExcludes string[]
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    id string
    ID of the network zone to retrieve, conflicts with name.
    ipServiceCategoriesExcludes string[]
    List of ip service excluded. Use with type DYNAMIC_V2
    ipServiceCategoriesIncludes string[]
    List of ip service included. Use with type DYNAMIC_V2
    name string
    Name of the network zone to retrieve, conflicts with id.
    dynamic_locations_excludes Sequence[str]
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    id str
    ID of the network zone to retrieve, conflicts with name.
    ip_service_categories_excludes Sequence[str]
    List of ip service excluded. Use with type DYNAMIC_V2
    ip_service_categories_includes Sequence[str]
    List of ip service included. Use with type DYNAMIC_V2
    name str
    Name of the network zone to retrieve, conflicts with id.
    dynamicLocationsExcludes List<String>
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    id String
    ID of the network zone to retrieve, conflicts with name.
    ipServiceCategoriesExcludes List<String>
    List of ip service excluded. Use with type DYNAMIC_V2
    ipServiceCategoriesIncludes List<String>
    List of ip service included. Use with type DYNAMIC_V2
    name String
    Name of the network zone to retrieve, conflicts with id.

    getNetworkZone Result

    The following output properties are available:

    Asns List<string>
    List of asns included. Format of each array value: a string representation of an ASN numeric value. Use with type DYNAMIC or DYNAMIC_V2
    DynamicLocations List<string>
    Array of locations ISO-3166-1(2) included. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC or DYNAMIC_V2
    DynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer. Use with type DYNAMIC
    Gateways List<string>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Use with type IP
    Proxies List<string>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST. Use with type IP
    Status string
    Network Status - can either be ACTIVE or INACTIVE only
    Type string
    Type of the Network Zone - can be IP, DYNAMIC or DYNAMIC_V2 only
    Usage string
    Zone's purpose: POLICY or BLOCKLIST
    DynamicLocationsExcludes List<string>
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    Id string
    ID of the network zone to retrieve, conflicts with name.
    IpServiceCategoriesExcludes List<string>
    List of ip service excluded. Use with type DYNAMIC_V2
    IpServiceCategoriesIncludes List<string>
    List of ip service included. Use with type DYNAMIC_V2
    Name string
    Name of the network zone to retrieve, conflicts with id.
    Asns []string
    List of asns included. Format of each array value: a string representation of an ASN numeric value. Use with type DYNAMIC or DYNAMIC_V2
    DynamicLocations []string
    Array of locations ISO-3166-1(2) included. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC or DYNAMIC_V2
    DynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer. Use with type DYNAMIC
    Gateways []string
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Use with type IP
    Proxies []string
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST. Use with type IP
    Status string
    Network Status - can either be ACTIVE or INACTIVE only
    Type string
    Type of the Network Zone - can be IP, DYNAMIC or DYNAMIC_V2 only
    Usage string
    Zone's purpose: POLICY or BLOCKLIST
    DynamicLocationsExcludes []string
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    Id string
    ID of the network zone to retrieve, conflicts with name.
    IpServiceCategoriesExcludes []string
    List of ip service excluded. Use with type DYNAMIC_V2
    IpServiceCategoriesIncludes []string
    List of ip service included. Use with type DYNAMIC_V2
    Name string
    Name of the network zone to retrieve, conflicts with id.
    asns List<String>
    List of asns included. Format of each array value: a string representation of an ASN numeric value. Use with type DYNAMIC or DYNAMIC_V2
    dynamicLocations List<String>
    Array of locations ISO-3166-1(2) included. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC or DYNAMIC_V2
    dynamicProxyType String
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer. Use with type DYNAMIC
    gateways List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Use with type IP
    proxies List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST. Use with type IP
    status String
    Network Status - can either be ACTIVE or INACTIVE only
    type String
    Type of the Network Zone - can be IP, DYNAMIC or DYNAMIC_V2 only
    usage String
    Zone's purpose: POLICY or BLOCKLIST
    dynamicLocationsExcludes List<String>
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    id String
    ID of the network zone to retrieve, conflicts with name.
    ipServiceCategoriesExcludes List<String>
    List of ip service excluded. Use with type DYNAMIC_V2
    ipServiceCategoriesIncludes List<String>
    List of ip service included. Use with type DYNAMIC_V2
    name String
    Name of the network zone to retrieve, conflicts with id.
    asns string[]
    List of asns included. Format of each array value: a string representation of an ASN numeric value. Use with type DYNAMIC or DYNAMIC_V2
    dynamicLocations string[]
    Array of locations ISO-3166-1(2) included. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC or DYNAMIC_V2
    dynamicProxyType string
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer. Use with type DYNAMIC
    gateways string[]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Use with type IP
    proxies string[]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST. Use with type IP
    status string
    Network Status - can either be ACTIVE or INACTIVE only
    type string
    Type of the Network Zone - can be IP, DYNAMIC or DYNAMIC_V2 only
    usage string
    Zone's purpose: POLICY or BLOCKLIST
    dynamicLocationsExcludes string[]
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    id string
    ID of the network zone to retrieve, conflicts with name.
    ipServiceCategoriesExcludes string[]
    List of ip service excluded. Use with type DYNAMIC_V2
    ipServiceCategoriesIncludes string[]
    List of ip service included. Use with type DYNAMIC_V2
    name string
    Name of the network zone to retrieve, conflicts with id.
    asns Sequence[str]
    List of asns included. Format of each array value: a string representation of an ASN numeric value. Use with type DYNAMIC or DYNAMIC_V2
    dynamic_locations Sequence[str]
    Array of locations ISO-3166-1(2) included. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC or DYNAMIC_V2
    dynamic_proxy_type str
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer. Use with type DYNAMIC
    gateways Sequence[str]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Use with type IP
    proxies Sequence[str]
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST. Use with type IP
    status str
    Network Status - can either be ACTIVE or INACTIVE only
    type str
    Type of the Network Zone - can be IP, DYNAMIC or DYNAMIC_V2 only
    usage str
    Zone's purpose: POLICY or BLOCKLIST
    dynamic_locations_excludes Sequence[str]
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    id str
    ID of the network zone to retrieve, conflicts with name.
    ip_service_categories_excludes Sequence[str]
    List of ip service excluded. Use with type DYNAMIC_V2
    ip_service_categories_includes Sequence[str]
    List of ip service included. Use with type DYNAMIC_V2
    name str
    Name of the network zone to retrieve, conflicts with id.
    asns List<String>
    List of asns included. Format of each array value: a string representation of an ASN numeric value. Use with type DYNAMIC or DYNAMIC_V2
    dynamicLocations List<String>
    Array of locations ISO-3166-1(2) included. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC or DYNAMIC_V2
    dynamicProxyType String
    Type of proxy being controlled by this dynamic network zone - can be one of Any, TorAnonymizer or NotTorAnonymizer. Use with type DYNAMIC
    gateways List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Use with type IP
    proxies List<String>
    Array of values in CIDR/range form depending on the way it's been declared (i.e. CIDR will contain /suffix). Please check API docs for examples. Can not be set if usage is set to BLOCKLIST. Use with type IP
    status String
    Network Status - can either be ACTIVE or INACTIVE only
    type String
    Type of the Network Zone - can be IP, DYNAMIC or DYNAMIC_V2 only
    usage String
    Zone's purpose: POLICY or BLOCKLIST
    dynamicLocationsExcludes List<String>
    Array of locations ISO-3166-1(2) excluded. Format code: countryCode OR countryCode-regionCode. Use with type DYNAMIC_V2
    id String
    ID of the network zone to retrieve, conflicts with name.
    ipServiceCategoriesExcludes List<String>
    List of ip service excluded. Use with type DYNAMIC_V2
    ipServiceCategoriesIncludes List<String>
    List of ip service included. Use with type DYNAMIC_V2
    name String
    Name of the network zone to retrieve, conflicts with id.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Okta v4.11.3 published on Monday, Oct 21, 2024 by Pulumi