1. Packages
  2. Vercel Provider
  3. API Docs
  4. getAccessGroup
Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse

vercel.getAccessGroup

Explore with Pulumi AI

vercel logo
Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse

    Provides information about an existing Access Group.

    For more detailed information, please see the Vercel documentation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vercel from "@pulumi/vercel";
    
    const example = vercel.getAccessGroup({
        id: "ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    });
    
    import pulumi
    import pulumi_vercel as vercel
    
    example = vercel.get_access_group(id="ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-vercel/sdk/v3/go/vercel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vercel.LookupAccessGroup(ctx, &vercel.LookupAccessGroupArgs{
    			Id: "ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vercel = Pulumi.Vercel;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Vercel.GetAccessGroup.Invoke(new()
        {
            Id = "ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vercel.VercelFunctions;
    import com.pulumi.vercel.inputs.GetAccessGroupArgs;
    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 example = VercelFunctions.getAccessGroup(GetAccessGroupArgs.builder()
                .id("ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: vercel:getAccessGroup
          Arguments:
            id: ag_xxxxxxxxxxxxxxxxxxxxxxxxxxxx
    

    Using getAccessGroup

    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 getAccessGroup(args: GetAccessGroupArgs, opts?: InvokeOptions): Promise<GetAccessGroupResult>
    function getAccessGroupOutput(args: GetAccessGroupOutputArgs, opts?: InvokeOptions): Output<GetAccessGroupResult>
    def get_access_group(id: Optional[str] = None,
                         team_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetAccessGroupResult
    def get_access_group_output(id: Optional[pulumi.Input[str]] = None,
                         team_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetAccessGroupResult]
    func LookupAccessGroup(ctx *Context, args *LookupAccessGroupArgs, opts ...InvokeOption) (*LookupAccessGroupResult, error)
    func LookupAccessGroupOutput(ctx *Context, args *LookupAccessGroupOutputArgs, opts ...InvokeOption) LookupAccessGroupResultOutput

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

    public static class GetAccessGroup 
    {
        public static Task<GetAccessGroupResult> InvokeAsync(GetAccessGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetAccessGroupResult> Invoke(GetAccessGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAccessGroupResult> getAccessGroup(GetAccessGroupArgs args, InvokeOptions options)
    public static Output<GetAccessGroupResult> getAccessGroup(GetAccessGroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vercel:index/getAccessGroup:getAccessGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The Access Group ID to be retrieved.
    TeamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Id string
    The Access Group ID to be retrieved.
    TeamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    id String
    The Access Group ID to be retrieved.
    teamId String
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    id string
    The Access Group ID to be retrieved.
    teamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    id str
    The Access Group ID to be retrieved.
    team_id str
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    id String
    The Access Group ID to be retrieved.
    teamId String
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.

    getAccessGroup Result

    The following output properties are available:

    Id string
    The Access Group ID to be retrieved.
    Name string
    The name of the Access Group.
    TeamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Id string
    The Access Group ID to be retrieved.
    Name string
    The name of the Access Group.
    TeamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    id String
    The Access Group ID to be retrieved.
    name String
    The name of the Access Group.
    teamId String
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    id string
    The Access Group ID to be retrieved.
    name string
    The name of the Access Group.
    teamId string
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    id str
    The Access Group ID to be retrieved.
    name str
    The name of the Access Group.
    team_id str
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.
    id String
    The Access Group ID to be retrieved.
    name String
    The name of the Access Group.
    teamId String
    The ID of the team the Access Group should exist under. Required when configuring a team resource if a default team has not been set in the provider.

    Package Details

    Repository
    vercel pulumiverse/pulumi-vercel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vercel Terraform Provider.
    vercel logo
    Vercel v3.1.2 published on Tuesday, May 13, 2025 by Pulumiverse