1. Packages
  2. Harness
  3. API Docs
  4. platform
  5. getResourceGroup
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

harness.platform.getResourceGroup

Explore with Pulumi AI

harness logo
Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const test = harness.platform.getResourceGroup({
        identifier: "identifier",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    test = harness.platform.get_resource_group(identifier="identifier")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.LookupResourceGroup(ctx, &platform.LookupResourceGroupArgs{
    			Identifier: "identifier",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Harness.Platform.GetResourceGroup.Invoke(new()
        {
            Identifier = "identifier",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetResourceGroupArgs;
    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 test = PlatformFunctions.getResourceGroup(GetResourceGroupArgs.builder()
                .identifier("identifier")
                .build());
    
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: harness:platform:getResourceGroup
          Arguments:
            identifier: identifier
    

    Using getResourceGroup

    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 getResourceGroup(args: GetResourceGroupArgs, opts?: InvokeOptions): Promise<GetResourceGroupResult>
    function getResourceGroupOutput(args: GetResourceGroupOutputArgs, opts?: InvokeOptions): Output<GetResourceGroupResult>
    def get_resource_group(identifier: Optional[str] = None,
                           name: Optional[str] = None,
                           org_id: Optional[str] = None,
                           project_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetResourceGroupResult
    def get_resource_group_output(identifier: Optional[pulumi.Input[str]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           org_id: Optional[pulumi.Input[str]] = None,
                           project_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetResourceGroupResult]
    func LookupResourceGroup(ctx *Context, args *LookupResourceGroupArgs, opts ...InvokeOption) (*LookupResourceGroupResult, error)
    func LookupResourceGroupOutput(ctx *Context, args *LookupResourceGroupOutputArgs, opts ...InvokeOption) LookupResourceGroupResultOutput

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

    public static class GetResourceGroup 
    {
        public static Task<GetResourceGroupResult> InvokeAsync(GetResourceGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetResourceGroupResult> Invoke(GetResourceGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetResourceGroupResult> getResourceGroup(GetResourceGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: harness:platform/getResourceGroup:getResourceGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    Identifier string
    Unique identifier of the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    identifier string
    Unique identifier of the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    identifier str
    Unique identifier of the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    identifier String
    Unique identifier of the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    getResourceGroup Result

    The following output properties are available:

    AccountId string
    Account Identifier of the account
    AllowedScopeLevels List<string>
    The scope levels at which this resource group can be used
    Color string
    Color of the environment.
    Description string
    Description of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    IncludedScopes List<GetResourceGroupIncludedScope>
    Included scopes
    ResourceFilters List<GetResourceGroupResourceFilter>
    Contains resource filter for a resource group
    Tags List<string>
    Tags to associate with the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    AccountId string
    Account Identifier of the account
    AllowedScopeLevels []string
    The scope levels at which this resource group can be used
    Color string
    Color of the environment.
    Description string
    Description of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    Unique identifier of the resource.
    IncludedScopes []GetResourceGroupIncludedScope
    Included scopes
    ResourceFilters []GetResourceGroupResourceFilter
    Contains resource filter for a resource group
    Tags []string
    Tags to associate with the resource.
    Name string
    Name of the resource.
    OrgId string
    Unique identifier of the organization.
    ProjectId string
    Unique identifier of the project.
    accountId String
    Account Identifier of the account
    allowedScopeLevels List<String>
    The scope levels at which this resource group can be used
    color String
    Color of the environment.
    description String
    Description of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    includedScopes List<GetResourceGroupIncludedScope>
    Included scopes
    resourceFilters List<GetResourceGroupResourceFilter>
    Contains resource filter for a resource group
    tags List<String>
    Tags to associate with the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.
    accountId string
    Account Identifier of the account
    allowedScopeLevels string[]
    The scope levels at which this resource group can be used
    color string
    Color of the environment.
    description string
    Description of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    Unique identifier of the resource.
    includedScopes GetResourceGroupIncludedScope[]
    Included scopes
    resourceFilters GetResourceGroupResourceFilter[]
    Contains resource filter for a resource group
    tags string[]
    Tags to associate with the resource.
    name string
    Name of the resource.
    orgId string
    Unique identifier of the organization.
    projectId string
    Unique identifier of the project.
    account_id str
    Account Identifier of the account
    allowed_scope_levels Sequence[str]
    The scope levels at which this resource group can be used
    color str
    Color of the environment.
    description str
    Description of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    Unique identifier of the resource.
    included_scopes Sequence[GetResourceGroupIncludedScope]
    Included scopes
    resource_filters Sequence[GetResourceGroupResourceFilter]
    Contains resource filter for a resource group
    tags Sequence[str]
    Tags to associate with the resource.
    name str
    Name of the resource.
    org_id str
    Unique identifier of the organization.
    project_id str
    Unique identifier of the project.
    accountId String
    Account Identifier of the account
    allowedScopeLevels List<String>
    The scope levels at which this resource group can be used
    color String
    Color of the environment.
    description String
    Description of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    Unique identifier of the resource.
    includedScopes List<Property Map>
    Included scopes
    resourceFilters List<Property Map>
    Contains resource filter for a resource group
    tags List<String>
    Tags to associate with the resource.
    name String
    Name of the resource.
    orgId String
    Unique identifier of the organization.
    projectId String
    Unique identifier of the project.

    Supporting Types

    GetResourceGroupIncludedScope

    AccountId string
    Account Identifier of the account
    Filter string
    Can be one of these 2 EXCLUDING_CHILD_SCOPES or INCLUDING_CHILD_SCOPES
    OrgId string
    Organization Identifier
    ProjectId string
    Project Identifier
    AccountId string
    Account Identifier of the account
    Filter string
    Can be one of these 2 EXCLUDING_CHILD_SCOPES or INCLUDING_CHILD_SCOPES
    OrgId string
    Organization Identifier
    ProjectId string
    Project Identifier
    accountId String
    Account Identifier of the account
    filter String
    Can be one of these 2 EXCLUDING_CHILD_SCOPES or INCLUDING_CHILD_SCOPES
    orgId String
    Organization Identifier
    projectId String
    Project Identifier
    accountId string
    Account Identifier of the account
    filter string
    Can be one of these 2 EXCLUDING_CHILD_SCOPES or INCLUDING_CHILD_SCOPES
    orgId string
    Organization Identifier
    projectId string
    Project Identifier
    account_id str
    Account Identifier of the account
    filter str
    Can be one of these 2 EXCLUDING_CHILD_SCOPES or INCLUDING_CHILD_SCOPES
    org_id str
    Organization Identifier
    project_id str
    Project Identifier
    accountId String
    Account Identifier of the account
    filter String
    Can be one of these 2 EXCLUDING_CHILD_SCOPES or INCLUDING_CHILD_SCOPES
    orgId String
    Organization Identifier
    projectId String
    Project Identifier

    GetResourceGroupResourceFilter

    IncludeAllResources bool
    Include all resource or not
    Resources List<GetResourceGroupResourceFilterResource>
    Resources for a resource group
    IncludeAllResources bool
    Include all resource or not
    Resources []GetResourceGroupResourceFilterResource
    Resources for a resource group
    includeAllResources Boolean
    Include all resource or not
    resources List<GetResourceGroupResourceFilterResource>
    Resources for a resource group
    includeAllResources boolean
    Include all resource or not
    resources GetResourceGroupResourceFilterResource[]
    Resources for a resource group
    include_all_resources bool
    Include all resource or not
    resources Sequence[GetResourceGroupResourceFilterResource]
    Resources for a resource group
    includeAllResources Boolean
    Include all resource or not
    resources List<Property Map>
    Resources for a resource group

    GetResourceGroupResourceFilterResource

    AttributeFilters List<GetResourceGroupResourceFilterResourceAttributeFilter>
    Used to filter resources on their attributes
    Identifiers List<string>
    List of the identifiers
    ResourceType string
    Type of the resource
    AttributeFilters []GetResourceGroupResourceFilterResourceAttributeFilter
    Used to filter resources on their attributes
    Identifiers []string
    List of the identifiers
    ResourceType string
    Type of the resource
    attributeFilters List<GetResourceGroupResourceFilterResourceAttributeFilter>
    Used to filter resources on their attributes
    identifiers List<String>
    List of the identifiers
    resourceType String
    Type of the resource
    attributeFilters GetResourceGroupResourceFilterResourceAttributeFilter[]
    Used to filter resources on their attributes
    identifiers string[]
    List of the identifiers
    resourceType string
    Type of the resource
    attribute_filters Sequence[GetResourceGroupResourceFilterResourceAttributeFilter]
    Used to filter resources on their attributes
    identifiers Sequence[str]
    List of the identifiers
    resource_type str
    Type of the resource
    attributeFilters List<Property Map>
    Used to filter resources on their attributes
    identifiers List<String>
    List of the identifiers
    resourceType String
    Type of the resource

    GetResourceGroupResourceFilterResourceAttributeFilter

    AttributeName string
    Name of the attribute
    AttributeValues List<string>
    Value of the attributes
    AttributeName string
    Name of the attribute
    AttributeValues []string
    Value of the attributes
    attributeName String
    Name of the attribute
    attributeValues List<String>
    Value of the attributes
    attributeName string
    Name of the attribute
    attributeValues string[]
    Value of the attributes
    attribute_name str
    Name of the attribute
    attribute_values Sequence[str]
    Value of the attributes
    attributeName String
    Name of the attribute
    attributeValues List<String>
    Value of the attributes

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Harness v0.1.2 published on Friday, Jul 19, 2024 by Pulumi