1. Packages
  2. NS1
  3. API Docs
  4. getMonitoringRegions
NS1 v3.3.0 published on Monday, Jun 24, 2024 by Pulumi

ns1.getMonitoringRegions

Explore with Pulumi AI

ns1 logo
NS1 v3.3.0 published on Monday, Jun 24, 2024 by Pulumi

    Provides details of all available monitoring regions.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ns1 from "@pulumi/ns1";
    
    // Get details of all available monitoring regions.
    const example = ns1.getMonitoringRegions({});
    
    import pulumi
    import pulumi_ns1 as ns1
    
    # Get details of all available monitoring regions.
    example = ns1.get_monitoring_regions()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-ns1/sdk/v3/go/ns1"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Get details of all available monitoring regions.
    		_, err := ns1.GetMonitoringRegions(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ns1 = Pulumi.Ns1;
    
    return await Deployment.RunAsync(() => 
    {
        // Get details of all available monitoring regions.
        var example = Ns1.GetMonitoringRegions.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ns1.Ns1Functions;
    import com.pulumi.ns1.inputs.GetMonitoringRegionsArgs;
    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) {
            // Get details of all available monitoring regions.
            final var example = Ns1Functions.getMonitoringRegions();
    
        }
    }
    
    variables:
      # Get details of all available monitoring regions.
      example:
        fn::invoke:
          Function: ns1:getMonitoringRegions
          Arguments: {}
    

    Using getMonitoringRegions

    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 getMonitoringRegions(args: GetMonitoringRegionsArgs, opts?: InvokeOptions): Promise<GetMonitoringRegionsResult>
    function getMonitoringRegionsOutput(args: GetMonitoringRegionsOutputArgs, opts?: InvokeOptions): Output<GetMonitoringRegionsResult>
    def get_monitoring_regions(regions: Optional[Sequence[GetMonitoringRegionsRegion]] = None,
                               opts: Optional[InvokeOptions] = None) -> GetMonitoringRegionsResult
    def get_monitoring_regions_output(regions: Optional[pulumi.Input[Sequence[pulumi.Input[GetMonitoringRegionsRegionArgs]]]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetMonitoringRegionsResult]
    func GetMonitoringRegions(ctx *Context, args *GetMonitoringRegionsArgs, opts ...InvokeOption) (*GetMonitoringRegionsResult, error)
    func GetMonitoringRegionsOutput(ctx *Context, args *GetMonitoringRegionsOutputArgs, opts ...InvokeOption) GetMonitoringRegionsResultOutput

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

    public static class GetMonitoringRegions 
    {
        public static Task<GetMonitoringRegionsResult> InvokeAsync(GetMonitoringRegionsArgs args, InvokeOptions? opts = null)
        public static Output<GetMonitoringRegionsResult> Invoke(GetMonitoringRegionsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetMonitoringRegionsResult> getMonitoringRegions(GetMonitoringRegionsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: ns1:index/getMonitoringRegions:getMonitoringRegions
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Regions List<GetMonitoringRegionsRegion>
    A set of the available monitoring regions. Regions is documented below.
    Regions []GetMonitoringRegionsRegion
    A set of the available monitoring regions. Regions is documented below.
    regions List<GetMonitoringRegionsRegion>
    A set of the available monitoring regions. Regions is documented below.
    regions GetMonitoringRegionsRegion[]
    A set of the available monitoring regions. Regions is documented below.
    regions Sequence[GetMonitoringRegionsRegion]
    A set of the available monitoring regions. Regions is documented below.
    regions List<Property Map>
    A set of the available monitoring regions. Regions is documented below.

    getMonitoringRegions Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Regions List<GetMonitoringRegionsRegion>
    A set of the available monitoring regions. Regions is documented below.
    Id string
    The provider-assigned unique ID for this managed resource.
    Regions []GetMonitoringRegionsRegion
    A set of the available monitoring regions. Regions is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    regions List<GetMonitoringRegionsRegion>
    A set of the available monitoring regions. Regions is documented below.
    id string
    The provider-assigned unique ID for this managed resource.
    regions GetMonitoringRegionsRegion[]
    A set of the available monitoring regions. Regions is documented below.
    id str
    The provider-assigned unique ID for this managed resource.
    regions Sequence[GetMonitoringRegionsRegion]
    A set of the available monitoring regions. Regions is documented below.
    id String
    The provider-assigned unique ID for this managed resource.
    regions List<Property Map>
    A set of the available monitoring regions. Regions is documented below.

    Supporting Types

    GetMonitoringRegionsRegion

    Code string
    3-letter city code identifying the location of the monitor.
    Name string
    City name identifying the location of the monitor.
    Subnets List<string>
    A list of IPv4 and IPv6 subnets the monitor sources requests from.
    Code string
    3-letter city code identifying the location of the monitor.
    Name string
    City name identifying the location of the monitor.
    Subnets []string
    A list of IPv4 and IPv6 subnets the monitor sources requests from.
    code String
    3-letter city code identifying the location of the monitor.
    name String
    City name identifying the location of the monitor.
    subnets List<String>
    A list of IPv4 and IPv6 subnets the monitor sources requests from.
    code string
    3-letter city code identifying the location of the monitor.
    name string
    City name identifying the location of the monitor.
    subnets string[]
    A list of IPv4 and IPv6 subnets the monitor sources requests from.
    code str
    3-letter city code identifying the location of the monitor.
    name str
    City name identifying the location of the monitor.
    subnets Sequence[str]
    A list of IPv4 and IPv6 subnets the monitor sources requests from.
    code String
    3-letter city code identifying the location of the monitor.
    name String
    City name identifying the location of the monitor.
    subnets List<String>
    A list of IPv4 and IPv6 subnets the monitor sources requests from.

    Package Details

    Repository
    NS1 pulumi/pulumi-ns1
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the ns1 Terraform Provider.
    ns1 logo
    NS1 v3.3.0 published on Monday, Jun 24, 2024 by Pulumi