Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Github Provider
  3. API Docs
  4. getOrganizationIpAllowList
GitHub v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
pulumi/pulumi-github

github.getOrganizationIpAllowList

Explore with Pulumi AI

GitHub v6.7.0 published on Friday, Feb 28, 2025 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({});
Copy
import pulumi
import pulumi_github as github

all = github.get_organization_ip_allow_list()
Copy
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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Github = Pulumi.Github;

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

});
Copy
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();

    }
}
Copy
variables:
  all:
    fn::invoke:
      function: github:getOrganizationIpAllowList
      arguments: {}
Copy

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

> 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)
}
Copy
public static CompletableFuture<GetOrganizationIpAllowListResult> getOrganizationIpAllowList(InvokeOptions options)
public static Output<GetOrganizationIpAllowListResult> getOrganizationIpAllowList(InvokeOptions options)
Copy
fn::invoke:
  function: github:index/getOrganizationIpAllowList:getOrganizationIpAllowList
  arguments:
    # arguments dictionary
Copy

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 This property is required. string
A single IP address or range of IP addresses in CIDR notation.
CreatedAt This property is required. string
Identifies the date and time when the object was created.
Id This property is required. string
The ID of the IP allow list entry.
IsActive This property is required. bool
Whether the entry is currently active.
Name This property is required. string
The name of the IP allow list entry.
UpdatedAt This property is required. string
Identifies the date and time when the object was last updated.
AllowListValue This property is required. string
A single IP address or range of IP addresses in CIDR notation.
CreatedAt This property is required. string
Identifies the date and time when the object was created.
Id This property is required. string
The ID of the IP allow list entry.
IsActive This property is required. bool
Whether the entry is currently active.
Name This property is required. string
The name of the IP allow list entry.
UpdatedAt This property is required. string
Identifies the date and time when the object was last updated.
allowListValue This property is required. String
A single IP address or range of IP addresses in CIDR notation.
createdAt This property is required. String
Identifies the date and time when the object was created.
id This property is required. String
The ID of the IP allow list entry.
isActive This property is required. Boolean
Whether the entry is currently active.
name This property is required. String
The name of the IP allow list entry.
updatedAt This property is required. String
Identifies the date and time when the object was last updated.
allowListValue This property is required. string
A single IP address or range of IP addresses in CIDR notation.
createdAt This property is required. string
Identifies the date and time when the object was created.
id This property is required. string
The ID of the IP allow list entry.
isActive This property is required. boolean
Whether the entry is currently active.
name This property is required. string
The name of the IP allow list entry.
updatedAt This property is required. string
Identifies the date and time when the object was last updated.
allow_list_value This property is required. str
A single IP address or range of IP addresses in CIDR notation.
created_at This property is required. str
Identifies the date and time when the object was created.
id This property is required. str
The ID of the IP allow list entry.
is_active This property is required. bool
Whether the entry is currently active.
name This property is required. str
The name of the IP allow list entry.
updated_at This property is required. str
Identifies the date and time when the object was last updated.
allowListValue This property is required. String
A single IP address or range of IP addresses in CIDR notation.
createdAt This property is required. String
Identifies the date and time when the object was created.
id This property is required. String
The ID of the IP allow list entry.
isActive This property is required. Boolean
Whether the entry is currently active.
name This property is required. String
The name of the IP allow list entry.
updatedAt This property is required. 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 v6.7.0 published on Friday, Feb 28, 2025 by Pulumi
pulumi/pulumi-github