Cloudflare v6.1.0, Apr 18 25

Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi

cloudflare.getResourceGroups

Explore with Pulumi AI

Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const exampleResourceGroups = cloudflare.getResourceGroups({
    accountId: "eb78d65290b24279ba6f44721b3ea3c4",
    id: "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
    name: "NameOfTheResourceGroup",
});

import pulumi
import pulumi_cloudflare as cloudflare

example_resource_groups = cloudflare.get_resource_groups(account_id="eb78d65290b24279ba6f44721b3ea3c4",
    id="6d7f2f5f5b1d4a0e9081fdc98d432fd1",
    name="NameOfTheResourceGroup")

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupResourceGroups(ctx, &cloudflare.LookupResourceGroupsArgs{
			AccountId: "eb78d65290b24279ba6f44721b3ea3c4",
			Id:        pulumi.StringRef("6d7f2f5f5b1d4a0e9081fdc98d432fd1"),
			Name:      pulumi.StringRef("NameOfTheResourceGroup"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleResourceGroups = Cloudflare.GetResourceGroups.Invoke(new()
    {
        AccountId = "eb78d65290b24279ba6f44721b3ea3c4",
        Id = "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
        Name = "NameOfTheResourceGroup",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetResourceGroupsArgs;
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 exampleResourceGroups = CloudflareFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .accountId("eb78d65290b24279ba6f44721b3ea3c4")
            .id("6d7f2f5f5b1d4a0e9081fdc98d432fd1")
            .name("NameOfTheResourceGroup")
            .build());

    }
}

variables:
  exampleResourceGroups:
    fn::invoke:
      function: cloudflare:getResourceGroups
      arguments:
        accountId: eb78d65290b24279ba6f44721b3ea3c4
        id: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
        name: NameOfTheResourceGroup

Using getResourceGroups

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 getResourceGroups(args: GetResourceGroupsArgs, opts?: InvokeOptions): Promise<GetResourceGroupsResult>
function getResourceGroupsOutput(args: GetResourceGroupsOutputArgs, opts?: InvokeOptions): Output<GetResourceGroupsResult>

def get_resource_groups(account_id: Optional[str] = None,
                        id: Optional[str] = None,
                        max_items: Optional[int] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetResourceGroupsResult
def get_resource_groups_output(account_id: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        max_items: Optional[pulumi.Input[int]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetResourceGroupsResult]

func LookupResourceGroups(ctx *Context, args *LookupResourceGroupsArgs, opts ...InvokeOption) (*LookupResourceGroupsResult, error)
func LookupResourceGroupsOutput(ctx *Context, args *LookupResourceGroupsOutputArgs, opts ...InvokeOption) LookupResourceGroupsResultOutput

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

public static class GetResourceGroups 
{
    public static Task<GetResourceGroupsResult> InvokeAsync(GetResourceGroupsArgs args, InvokeOptions? opts = null)
    public static Output<GetResourceGroupsResult> Invoke(GetResourceGroupsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetResourceGroupsResult> getResourceGroups(GetResourceGroupsArgs args, InvokeOptions options)
public static Output<GetResourceGroupsResult> getResourceGroups(GetResourceGroupsArgs args, InvokeOptions options)

fn::invoke:
  function: cloudflare:index/getResourceGroups:getResourceGroups
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountId string: Account identifier tag.
Id string: ID of the resource group to be fetched.
MaxItems int: Max items to fetch, default: 1000
Name string: Name of the resource group to be fetched.

AccountId string: Account identifier tag.
Id string: ID of the resource group to be fetched.
MaxItems int: Max items to fetch, default: 1000
Name string: Name of the resource group to be fetched.

accountId String: Account identifier tag.
id String: ID of the resource group to be fetched.
maxItems Integer: Max items to fetch, default: 1000
name String: Name of the resource group to be fetched.

accountId string: Account identifier tag.
id string: ID of the resource group to be fetched.
maxItems number: Max items to fetch, default: 1000
name string: Name of the resource group to be fetched.

account_id str: Account identifier tag.
id str: ID of the resource group to be fetched.
max_items int: Max items to fetch, default: 1000
name str: Name of the resource group to be fetched.

accountId String: Account identifier tag.
id String: ID of the resource group to be fetched.
maxItems Number: Max items to fetch, default: 1000
name String: Name of the resource group to be fetched.

getResourceGroups Result

The following output properties are available:

AccountId string: Account identifier tag.
Results List<GetResourceGroupsResult>: The items returned by the data source
Id string: ID of the resource group to be fetched.
MaxItems int: Max items to fetch, default: 1000
Name string: Name of the resource group to be fetched.

AccountId string: Account identifier tag.
Results []GetResourceGroupsResult: The items returned by the data source
Id string: ID of the resource group to be fetched.
MaxItems int: Max items to fetch, default: 1000
Name string: Name of the resource group to be fetched.

accountId String: Account identifier tag.
results List<GetResourceGroupsResult>: The items returned by the data source
id String: ID of the resource group to be fetched.
maxItems Integer: Max items to fetch, default: 1000
name String: Name of the resource group to be fetched.

accountId string: Account identifier tag.
results GetResourceGroupsResult[]: The items returned by the data source
id string: ID of the resource group to be fetched.
maxItems number: Max items to fetch, default: 1000
name string: Name of the resource group to be fetched.

account_id str: Account identifier tag.
results Sequence[GetResourceGroupsResult]: The items returned by the data source
id str: ID of the resource group to be fetched.
max_items int: Max items to fetch, default: 1000
name str: Name of the resource group to be fetched.

accountId String: Account identifier tag.
results List<Property Map>: The items returned by the data source
id String: ID of the resource group to be fetched.
maxItems Number: Max items to fetch, default: 1000
name String: Name of the resource group to be fetched.

Supporting Types

GetResourceGroupsResult

Id string: Identifier of the group.
Meta GetResourceGroupsResultMeta: Attributes associated to the resource group.
Name string: Name of the resource group.
Scopes List<GetResourceGroupsResultScope>: The scope associated to the resource group

Id string: Identifier of the group.
Meta GetResourceGroupsResultMeta: Attributes associated to the resource group.
Name string: Name of the resource group.
Scopes []GetResourceGroupsResultScope: The scope associated to the resource group

id String: Identifier of the group.
meta GetResourceGroupsResultMeta: Attributes associated to the resource group.
name String: Name of the resource group.
scopes List<GetResourceGroupsResultScope>: The scope associated to the resource group

id string: Identifier of the group.
meta GetResourceGroupsResultMeta: Attributes associated to the resource group.
name string: Name of the resource group.
scopes GetResourceGroupsResultScope[]: The scope associated to the resource group

id str: Identifier of the group.
meta GetResourceGroupsResultMeta: Attributes associated to the resource group.
name str: Name of the resource group.
scopes Sequence[GetResourceGroupsResultScope]: The scope associated to the resource group

id String: Identifier of the group.
meta Property Map: Attributes associated to the resource group.
name String: Name of the resource group.
scopes List<Property Map>: The scope associated to the resource group

GetResourceGroupsResultMeta

Key string
Value string

Key string
Value string

key String
value String

key string
value string

key str
value str

key String
value String

GetResourceGroupsResultScope

Key string: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
Objects List<GetResourceGroupsResultScopeObject>: A list of scope objects for additional context.

Key string: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
Objects []GetResourceGroupsResultScopeObject: A list of scope objects for additional context.

key String: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
objects List<GetResourceGroupsResultScopeObject>: A list of scope objects for additional context.

key string: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
objects GetResourceGroupsResultScopeObject[]: A list of scope objects for additional context.

key str: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
objects Sequence[GetResourceGroupsResultScopeObject]: A list of scope objects for additional context.

key String: This is a combination of pre-defined resource name and identifier (like Account ID etc.)
objects List<Property Map>: A list of scope objects for additional context.

GetResourceGroupsResultScopeObject

Key string: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

Key string: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

key String: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

key string: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

key str: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

key String: This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

Package Details

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

Cloudflare v6.1.0 published on Friday, Apr 18, 2025 by Pulumi

pulumi/pulumi-cloudflare

cloudflare.getResourceGroups

On this page

On this page

Example Usage

Using getResourceGroups

getResourceGroups Result

Supporting Types

GetResourceGroupsResult

GetResourceGroupsResultMeta

GetResourceGroupsResultScope

GetResourceGroupsResultScopeObject

Package Details

On this page

On this page