github.getOrganizationCustomProperties

GitHub v6.8.0 published on Thursday, Oct 23, 2025 by Pulumi

Example Usage

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

const environment = github.getOrganizationCustomProperties({
    propertyName: "environment",
});

import pulumi
import pulumi_github as github

environment = github.get_organization_custom_properties(property_name="environment")

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.LookupOrganizationCustomProperties(ctx, &github.LookupOrganizationCustomPropertiesArgs{
			PropertyName: "environment",
		}, 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 environment = Github.GetOrganizationCustomProperties.Invoke(new()
    {
        PropertyName = "environment",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.github.GithubFunctions;
import com.pulumi.github.inputs.GetOrganizationCustomPropertiesArgs;
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 environment = GithubFunctions.getOrganizationCustomProperties(GetOrganizationCustomPropertiesArgs.builder()
            .propertyName("environment")
            .build());

    }
}

variables:
  environment:
    fn::invoke:
      function: github:getOrganizationCustomProperties
      arguments:
        propertyName: environment

Using getOrganizationCustomProperties

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 getOrganizationCustomProperties(args: GetOrganizationCustomPropertiesArgs, opts?: InvokeOptions): Promise<GetOrganizationCustomPropertiesResult>
function getOrganizationCustomPropertiesOutput(args: GetOrganizationCustomPropertiesOutputArgs, opts?: InvokeOptions): Output<GetOrganizationCustomPropertiesResult>

def get_organization_custom_properties(allowed_values: Optional[Sequence[str]] = None,
                                       default_value: Optional[str] = None,
                                       description: Optional[str] = None,
                                       property_name: Optional[str] = None,
                                       required: Optional[bool] = None,
                                       value_type: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetOrganizationCustomPropertiesResult
def get_organization_custom_properties_output(allowed_values: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                       default_value: Optional[pulumi.Input[str]] = None,
                                       description: Optional[pulumi.Input[str]] = None,
                                       property_name: Optional[pulumi.Input[str]] = None,
                                       required: Optional[pulumi.Input[bool]] = None,
                                       value_type: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationCustomPropertiesResult]

func LookupOrganizationCustomProperties(ctx *Context, args *LookupOrganizationCustomPropertiesArgs, opts ...InvokeOption) (*LookupOrganizationCustomPropertiesResult, error)
func LookupOrganizationCustomPropertiesOutput(ctx *Context, args *LookupOrganizationCustomPropertiesOutputArgs, opts ...InvokeOption) LookupOrganizationCustomPropertiesResultOutput

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

public static class GetOrganizationCustomProperties 
{
    public static Task<GetOrganizationCustomPropertiesResult> InvokeAsync(GetOrganizationCustomPropertiesArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationCustomPropertiesResult> Invoke(GetOrganizationCustomPropertiesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrganizationCustomPropertiesResult> getOrganizationCustomProperties(GetOrganizationCustomPropertiesArgs args, InvokeOptions options)
public static Output<GetOrganizationCustomPropertiesResult> getOrganizationCustomProperties(GetOrganizationCustomPropertiesArgs args, InvokeOptions options)

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

The following arguments are supported:

PropertyName string: The name of the custom property to retrieve.
AllowedValues List<string>: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
DefaultValue string: The default value of the custom property.
Description string: The description of the custom property.
Required bool: Whether the custom property is required.
ValueType string: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

PropertyName string: The name of the custom property to retrieve.
AllowedValues []string: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
DefaultValue string: The default value of the custom property.
Description string: The description of the custom property.
Required bool: Whether the custom property is required.
ValueType string: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

propertyName String: The name of the custom property to retrieve.
allowedValues List<String>: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
defaultValue String: The default value of the custom property.
description String: The description of the custom property.
required Boolean: Whether the custom property is required.
valueType String: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

propertyName string: The name of the custom property to retrieve.
allowedValues string[]: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
defaultValue string: The default value of the custom property.
description string: The description of the custom property.
required boolean: Whether the custom property is required.
valueType string: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

property_name str: The name of the custom property to retrieve.
allowed_values Sequence[str]: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
default_value str: The default value of the custom property.
description str: The description of the custom property.
required bool: Whether the custom property is required.
value_type str: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

propertyName String: The name of the custom property to retrieve.
allowedValues List<String>: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
defaultValue String: The default value of the custom property.
description String: The description of the custom property.
required Boolean: Whether the custom property is required.
valueType String: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

getOrganizationCustomProperties Result

The following output properties are available:

AllowedValues List<string>: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
DefaultValue string: The default value of the custom property.
Description string: The description of the custom property.
Id string: The provider-assigned unique ID for this managed resource.
PropertyName string: The name of the custom property.
Required bool: Whether the custom property is required.
ValueType string: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

AllowedValues []string: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
DefaultValue string: The default value of the custom property.
Description string: The description of the custom property.
Id string: The provider-assigned unique ID for this managed resource.
PropertyName string: The name of the custom property.
Required bool: Whether the custom property is required.
ValueType string: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

allowedValues List<String>: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
defaultValue String: The default value of the custom property.
description String: The description of the custom property.
id String: The provider-assigned unique ID for this managed resource.
propertyName String: The name of the custom property.
required Boolean: Whether the custom property is required.
valueType String: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

allowedValues string[]: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
defaultValue string: The default value of the custom property.
description string: The description of the custom property.
id string: The provider-assigned unique ID for this managed resource.
propertyName string: The name of the custom property.
required boolean: Whether the custom property is required.
valueType string: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

allowed_values Sequence[str]: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
default_value str: The default value of the custom property.
description str: The description of the custom property.
id str: The provider-assigned unique ID for this managed resource.
property_name str: The name of the custom property.
required bool: Whether the custom property is required.
value_type str: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

allowedValues List<String>: List of allowed values for the custom property. Only populated when value_type is single_select or multi_select.
defaultValue String: The default value of the custom property.
description String: The description of the custom property.
id String: The provider-assigned unique ID for this managed resource.
propertyName String: The name of the custom property.
required Boolean: Whether the custom property is required.
valueType String: The type of the custom property. Can be one of string, single_select, multi_select, or true_false.

Package Details

Repository: GitHub pulumi/pulumi-github
License: Apache-2.0
Notes: This Pulumi package is based on the github Terraform Provider.

GitHub v6.8.0 published on Thursday, Oct 23, 2025 by Pulumi

pulumi/pulumi-github

github.getOrganizationCustomProperties

On this page

On this page

Example Usage

Using getOrganizationCustomProperties

getOrganizationCustomProperties Result

Package Details

On this page

On this page