Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Github Provider
  3. API Docs
  4. getOrganizationIpAllowList
GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-github

github.getOrganizationIpAllowList

Explore with Pulumi AI

github logo
GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi
pulumi/pulumi-github

    Use this data source to retrieve information about the IP allow list of an organization. The allow list for IP addresses will block access to private resources via the web, API, and Git from any IP addresses that are not on the allow list.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as github from "@pulumi/github";

const all = github.getOrganizationIpAllowList({});

    import pulumi
import pulumi_github as github

all = github.get_organization_ip_allow_list()

    package main

import (
	"github.com/pulumi/pulumi-github/sdk/v6/go/github"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := github.GetOrganizationIpAllowList(ctx, map[string]interface{}{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;

return await Deployment.RunAsync(() => 
{
    var all = Github.GetOrganizationIpAllowList.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
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 all = GithubFunctions.getOrganizationIpAllowList();

    }
}

    variables:
  all:
    fn::invoke:
      Function: github:getOrganizationIpAllowList
      Arguments: {}

    Using getOrganizationIpAllowList

    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 getOrganizationIpAllowList(opts?: InvokeOptions): Promise<GetOrganizationIpAllowListResult>
function getOrganizationIpAllowListOutput(opts?: InvokeOptions): Output<GetOrganizationIpAllowListResult>
    def get_organization_ip_allow_list(opts: Optional[InvokeOptions] = None) -> GetOrganizationIpAllowListResult
def get_organization_ip_allow_list_output(opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationIpAllowListResult]
    func GetOrganizationIpAllowList(ctx *Context, opts ...InvokeOption) (*GetOrganizationIpAllowListResult, error)
func GetOrganizationIpAllowListOutput(ctx *Context, opts ...InvokeOption) GetOrganizationIpAllowListResultOutput

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

    public static class GetOrganizationIpAllowList 
{
    public static Task<GetOrganizationIpAllowListResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetOrganizationIpAllowListResult> Invoke(InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOrganizationIpAllowListResult> getOrganizationIpAllowList(InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: github:index/getOrganizationIpAllowList:getOrganizationIpAllowList
  arguments:
    # arguments dictionary

    getOrganizationIpAllowList Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    IpAllowLists List<GetOrganizationIpAllowListIpAllowList>
    An Array of allowed IP addresses.

    Id string
    The provider-assigned unique ID for this managed resource.
    IpAllowLists []GetOrganizationIpAllowListIpAllowList
    An Array of allowed IP addresses.

    id String
    The provider-assigned unique ID for this managed resource.
    ipAllowLists List<GetOrganizationIpAllowListIpAllowList>
    An Array of allowed IP addresses.

    id string
    The provider-assigned unique ID for this managed resource.
    ipAllowLists GetOrganizationIpAllowListIpAllowList[]
    An Array of allowed IP addresses.

    id str
    The provider-assigned unique ID for this managed resource.
    ip_allow_lists Sequence[GetOrganizationIpAllowListIpAllowList]
    An Array of allowed IP addresses.

    id String
    The provider-assigned unique ID for this managed resource.
    ipAllowLists List<Property Map>
    An Array of allowed IP addresses.

    Supporting Types

    GetOrganizationIpAllowListIpAllowList

    AllowListValue string
    A single IP address or range of IP addresses in CIDR notation.
    CreatedAt string
    Identifies the date and time when the object was created.
    Id string
    The ID of the IP allow list entry.
    IsActive bool
    Whether the entry is currently active.
    Name string
    The name of the IP allow list entry.
    UpdatedAt string
    Identifies the date and time when the object was last updated.
    AllowListValue string
    A single IP address or range of IP addresses in CIDR notation.
    CreatedAt string
    Identifies the date and time when the object was created.
    Id string
    The ID of the IP allow list entry.
    IsActive bool
    Whether the entry is currently active.
    Name string
    The name of the IP allow list entry.
    UpdatedAt string
    Identifies the date and time when the object was last updated.
    allowListValue String
    A single IP address or range of IP addresses in CIDR notation.
    createdAt String
    Identifies the date and time when the object was created.
    id String
    The ID of the IP allow list entry.
    isActive Boolean
    Whether the entry is currently active.
    name String
    The name of the IP allow list entry.
    updatedAt String
    Identifies the date and time when the object was last updated.
    allowListValue string
    A single IP address or range of IP addresses in CIDR notation.
    createdAt string
    Identifies the date and time when the object was created.
    id string
    The ID of the IP allow list entry.
    isActive boolean
    Whether the entry is currently active.
    name string
    The name of the IP allow list entry.
    updatedAt string
    Identifies the date and time when the object was last updated.
    allow_list_value str
    A single IP address or range of IP addresses in CIDR notation.
    created_at str
    Identifies the date and time when the object was created.
    id str
    The ID of the IP allow list entry.
    is_active bool
    Whether the entry is currently active.
    name str
    The name of the IP allow list entry.
    updated_at str
    Identifies the date and time when the object was last updated.
    allowListValue String
    A single IP address or range of IP addresses in CIDR notation.
    createdAt String
    Identifies the date and time when the object was created.
    id String
    The ID of the IP allow list entry.
    isActive Boolean
    Whether the entry is currently active.
    name String
    The name of the IP allow list entry.
    updatedAt String
    Identifies the date and time when the object was last updated.

    Package Details

    Repository
    GitHub pulumi/pulumi-github
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the github Terraform Provider.
    github logo
    GitHub v6.3.2 published on Friday, Oct 11, 2024 by Pulumi
    pulumi/pulumi-github