Google Cloud v8.23.0, Mar 24 25

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi

gcp.projects.getOrganizationPolicy

Explore with Pulumi AI

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const policy = gcp.projects.getOrganizationPolicy({
    project: "project-id",
    constraint: "constraints/serviceuser.services",
});
export const version = policy.then(policy => policy.version);

import pulumi
import pulumi_gcp as gcp

policy = gcp.projects.get_organization_policy(project="project-id",
    constraint="constraints/serviceuser.services")
pulumi.export("version", policy.version)

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/projects"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		policy, err := projects.LookupOrganizationPolicy(ctx, &projects.LookupOrganizationPolicyArgs{
			Project:    "project-id",
			Constraint: "constraints/serviceuser.services",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("version", policy.Version)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var policy = Gcp.Projects.GetOrganizationPolicy.Invoke(new()
    {
        Project = "project-id",
        Constraint = "constraints/serviceuser.services",
    });

    return new Dictionary<string, object?>
    {
        ["version"] = policy.Apply(getOrganizationPolicyResult => getOrganizationPolicyResult.Version),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.projects.ProjectsFunctions;
import com.pulumi.gcp.projects.inputs.GetOrganizationPolicyArgs;
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 policy = ProjectsFunctions.getOrganizationPolicy(GetOrganizationPolicyArgs.builder()
            .project("project-id")
            .constraint("constraints/serviceuser.services")
            .build());

        ctx.export("version", policy.applyValue(getOrganizationPolicyResult -> getOrganizationPolicyResult.version()));
    }
}

variables:
  policy:
    fn::invoke:
      function: gcp:projects:getOrganizationPolicy
      arguments:
        project: project-id
        constraint: constraints/serviceuser.services
outputs:
  version: ${policy.version}

Using getOrganizationPolicy

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.

TypeScript
Python
Go
C#
Java
YAML

function getOrganizationPolicy(args: GetOrganizationPolicyArgs, opts?: InvokeOptions): Promise<GetOrganizationPolicyResult>
function getOrganizationPolicyOutput(args: GetOrganizationPolicyOutputArgs, opts?: InvokeOptions): Output<GetOrganizationPolicyResult>

def get_organization_policy(constraint: Optional[str] = None,
                            project: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetOrganizationPolicyResult
def get_organization_policy_output(constraint: Optional[pulumi.Input[str]] = None,
                            project: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationPolicyResult]

func LookupOrganizationPolicy(ctx *Context, args *LookupOrganizationPolicyArgs, opts ...InvokeOption) (*LookupOrganizationPolicyResult, error)
func LookupOrganizationPolicyOutput(ctx *Context, args *LookupOrganizationPolicyOutputArgs, opts ...InvokeOption) LookupOrganizationPolicyResultOutput

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

public static class GetOrganizationPolicy 
{
    public static Task<GetOrganizationPolicyResult> InvokeAsync(GetOrganizationPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationPolicyResult> Invoke(GetOrganizationPolicyInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOrganizationPolicyResult> getOrganizationPolicy(GetOrganizationPolicyArgs args, InvokeOptions options)
public static Output<GetOrganizationPolicyResult> getOrganizationPolicy(GetOrganizationPolicyArgs args, InvokeOptions options)

fn::invoke:
  function: gcp:projects/getOrganizationPolicy:getOrganizationPolicy
  arguments:
    # arguments dictionary

The following arguments are supported:

Constraint string: (Required) The name of the Constraint the Policy is configuring, for example, serviceuser.services. Check out the complete list of available constraints.
Project string: The project ID.

Constraint string: (Required) The name of the Constraint the Policy is configuring, for example, serviceuser.services. Check out the complete list of available constraints.
Project string: The project ID.

constraint String: (Required) The name of the Constraint the Policy is configuring, for example, serviceuser.services. Check out the complete list of available constraints.
project String: The project ID.

constraint string: (Required) The name of the Constraint the Policy is configuring, for example, serviceuser.services. Check out the complete list of available constraints.
project string: The project ID.

constraint str: (Required) The name of the Constraint the Policy is configuring, for example, serviceuser.services. Check out the complete list of available constraints.
project str: The project ID.

constraint String: (Required) The name of the Constraint the Policy is configuring, for example, serviceuser.services. Check out the complete list of available constraints.
project String: The project ID.

getOrganizationPolicy Result

The following output properties are available:

BooleanPolicies List<GetOrganizationPolicyBooleanPolicy>
Constraint string
Etag string
Id string: The provider-assigned unique ID for this managed resource.
ListPolicies List<GetOrganizationPolicyListPolicy>
Project string
RestorePolicies List<GetOrganizationPolicyRestorePolicy>
UpdateTime string
Version int

BooleanPolicies []GetOrganizationPolicyBooleanPolicy
Constraint string
Etag string
Id string: The provider-assigned unique ID for this managed resource.
ListPolicies []GetOrganizationPolicyListPolicy
Project string
RestorePolicies []GetOrganizationPolicyRestorePolicy
UpdateTime string
Version int

booleanPolicies List<GetOrganizationPolicyBooleanPolicy>
constraint String
etag String
id String: The provider-assigned unique ID for this managed resource.
listPolicies List<GetOrganizationPolicyListPolicy>
project String
restorePolicies List<GetOrganizationPolicyRestorePolicy>
updateTime String
version Integer

booleanPolicies GetOrganizationPolicyBooleanPolicy[]
constraint string
etag string
id string: The provider-assigned unique ID for this managed resource.
listPolicies GetOrganizationPolicyListPolicy[]
project string
restorePolicies GetOrganizationPolicyRestorePolicy[]
updateTime string
version number

boolean_policies Sequence[GetOrganizationPolicyBooleanPolicy]
constraint str
etag str
id str: The provider-assigned unique ID for this managed resource.
list_policies Sequence[GetOrganizationPolicyListPolicy]
project str
restore_policies Sequence[GetOrganizationPolicyRestorePolicy]
update_time str
version int

booleanPolicies List<Property Map>
constraint String
etag String
id String: The provider-assigned unique ID for this managed resource.
listPolicies List<Property Map>
project String
restorePolicies List<Property Map>
updateTime String
version Number

Supporting Types

GetOrganizationPolicyBooleanPolicy

Enforced bool: If true, then the Policy is enforced. If false, then any configuration is acceptable.

Enforced bool: If true, then the Policy is enforced. If false, then any configuration is acceptable.

enforced Boolean: If true, then the Policy is enforced. If false, then any configuration is acceptable.

enforced boolean: If true, then the Policy is enforced. If false, then any configuration is acceptable.

enforced bool: If true, then the Policy is enforced. If false, then any configuration is acceptable.

enforced Boolean: If true, then the Policy is enforced. If false, then any configuration is acceptable.

GetOrganizationPolicyListPolicy

Allows List<GetOrganizationPolicyListPolicyAllow>: One or the other must be set.
Denies List<GetOrganizationPolicyListPolicyDeny>: One or the other must be set.
InheritFromParent bool: If set to true, the values from the effective Policy of the parent resource are inherited, meaning the values set in this Policy are added to the values inherited up the hierarchy.
SuggestedValue string: The Google Cloud Console will try to default to a configuration that matches the value specified in this field.

Allows []GetOrganizationPolicyListPolicyAllow: One or the other must be set.
Denies []GetOrganizationPolicyListPolicyDeny: One or the other must be set.
InheritFromParent bool: If set to true, the values from the effective Policy of the parent resource are inherited, meaning the values set in this Policy are added to the values inherited up the hierarchy.
SuggestedValue string: The Google Cloud Console will try to default to a configuration that matches the value specified in this field.

allows List<GetOrganizationPolicyListPolicyAllow>: One or the other must be set.
denies List<GetOrganizationPolicyListPolicyDeny>: One or the other must be set.
inheritFromParent Boolean: If set to true, the values from the effective Policy of the parent resource are inherited, meaning the values set in this Policy are added to the values inherited up the hierarchy.
suggestedValue String: The Google Cloud Console will try to default to a configuration that matches the value specified in this field.

allows GetOrganizationPolicyListPolicyAllow[]: One or the other must be set.
denies GetOrganizationPolicyListPolicyDeny[]: One or the other must be set.
inheritFromParent boolean: If set to true, the values from the effective Policy of the parent resource are inherited, meaning the values set in this Policy are added to the values inherited up the hierarchy.
suggestedValue string: The Google Cloud Console will try to default to a configuration that matches the value specified in this field.

allows Sequence[GetOrganizationPolicyListPolicyAllow]: One or the other must be set.
denies Sequence[GetOrganizationPolicyListPolicyDeny]: One or the other must be set.
inherit_from_parent bool: If set to true, the values from the effective Policy of the parent resource are inherited, meaning the values set in this Policy are added to the values inherited up the hierarchy.
suggested_value str: The Google Cloud Console will try to default to a configuration that matches the value specified in this field.

allows List<Property Map>: One or the other must be set.
denies List<Property Map>: One or the other must be set.
inheritFromParent Boolean: If set to true, the values from the effective Policy of the parent resource are inherited, meaning the values set in this Policy are added to the values inherited up the hierarchy.
suggestedValue String: The Google Cloud Console will try to default to a configuration that matches the value specified in this field.

GetOrganizationPolicyListPolicyAllow

All bool: The policy allows or denies all values.
Values List<string>: The policy can define specific values that are allowed or denied.

All bool: The policy allows or denies all values.
Values []string: The policy can define specific values that are allowed or denied.

all Boolean: The policy allows or denies all values.
values List<String>: The policy can define specific values that are allowed or denied.

all boolean: The policy allows or denies all values.
values string[]: The policy can define specific values that are allowed or denied.

all bool: The policy allows or denies all values.
values Sequence[str]: The policy can define specific values that are allowed or denied.

all Boolean: The policy allows or denies all values.
values List<String>: The policy can define specific values that are allowed or denied.

GetOrganizationPolicyListPolicyDeny

All bool: The policy allows or denies all values.
Values List<string>: The policy can define specific values that are allowed or denied.

All bool: The policy allows or denies all values.
Values []string: The policy can define specific values that are allowed or denied.

all Boolean: The policy allows or denies all values.
values List<String>: The policy can define specific values that are allowed or denied.

all boolean: The policy allows or denies all values.
values string[]: The policy can define specific values that are allowed or denied.

all bool: The policy allows or denies all values.
values Sequence[str]: The policy can define specific values that are allowed or denied.

all Boolean: The policy allows or denies all values.
values List<String>: The policy can define specific values that are allowed or denied.

GetOrganizationPolicyRestorePolicy

Default bool: May only be set to true. If set, then the default Policy is restored.

Default bool: May only be set to true. If set, then the default Policy is restored.

default_ Boolean: May only be set to true. If set, then the default Policy is restored.

default boolean: May only be set to true. If set, then the default Policy is restored.

default bool: May only be set to true. If set, then the default Policy is restored.

default Boolean: May only be set to true. If set, then the default Policy is restored.

Package Details

Repository: Google Cloud (GCP) Classic pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

Google Cloud v8.23.0 published on Monday, Mar 24, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.projects.getOrganizationPolicy

On this page

On this page

Example Usage

Using getOrganizationPolicy

getOrganizationPolicy Result

Supporting Types

GetOrganizationPolicyBooleanPolicy

GetOrganizationPolicyListPolicy

GetOrganizationPolicyListPolicyAllow

GetOrganizationPolicyListPolicyDeny

GetOrganizationPolicyRestorePolicy

Package Details

On this page

On this page