1. Packages
  2. Vercel Provider
  3. API Docs
  4. getAlias
Vercel v3.15.1 published on Monday, Sep 8, 2025 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-vercel

vercel.getAlias

Get Started
vercel logo
Vercel v3.15.1 published on Monday, Sep 8, 2025 by Pulumiverse
Schema (JSON)
pulumiverse/pulumi-vercel

    Provides information about an existing Alias resource.

    An Alias allows a vercel.Deployment to be accessed through a different URL.

    Using getAlias

    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 getAlias(args: GetAliasArgs, opts?: InvokeOptions): Promise<GetAliasResult>
function getAliasOutput(args: GetAliasOutputArgs, opts?: InvokeOptions): Output<GetAliasResult>
    def get_alias(alias: Optional[str] = None,
              team_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAliasResult
def get_alias_output(alias: Optional[pulumi.Input[str]] = None,
              team_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAliasResult]
    func LookupAlias(ctx *Context, args *LookupAliasArgs, opts ...InvokeOption) (*LookupAliasResult, error)
func LookupAliasOutput(ctx *Context, args *LookupAliasOutputArgs, opts ...InvokeOption) LookupAliasResultOutput

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

    public static class GetAlias 
{
    public static Task<GetAliasResult> InvokeAsync(GetAliasArgs args, InvokeOptions? opts = null)
    public static Output<GetAliasResult> Invoke(GetAliasInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAliasResult> getAlias(GetAliasArgs args, InvokeOptions options)
public static Output<GetAliasResult> getAlias(GetAliasArgs args, InvokeOptions options)

    fn::invoke:
  function: vercel:index/getAlias:getAlias
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Alias string
    The Alias or Alias ID to be retrieved.
    TeamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Alias string
    The Alias or Alias ID to be retrieved.
    TeamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias String
    The Alias or Alias ID to be retrieved.
    teamId String
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias string
    The Alias or Alias ID to be retrieved.
    teamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias str
    The Alias or Alias ID to be retrieved.
    team_id str
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias String
    The Alias or Alias ID to be retrieved.
    teamId String
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.

    getAlias Result

    The following output properties are available:

    Alias string
    The Alias or Alias ID to be retrieved.
    DeploymentId string
    The ID of the Deployment the Alias is associated with.
    Id string
    The ID of this resource.
    TeamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    Alias string
    The Alias or Alias ID to be retrieved.
    DeploymentId string
    The ID of the Deployment the Alias is associated with.
    Id string
    The ID of this resource.
    TeamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias String
    The Alias or Alias ID to be retrieved.
    deploymentId String
    The ID of the Deployment the Alias is associated with.
    id String
    The ID of this resource.
    teamId String
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias string
    The Alias or Alias ID to be retrieved.
    deploymentId string
    The ID of the Deployment the Alias is associated with.
    id string
    The ID of this resource.
    teamId string
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias str
    The Alias or Alias ID to be retrieved.
    deployment_id str
    The ID of the Deployment the Alias is associated with.
    id str
    The ID of this resource.
    team_id str
    The ID of the team the Alias and Deployment exist under. Required when configuring a team resource if a default team has not been set in the provider.
    alias String
    The Alias or Alias ID to be retrieved.
    deploymentId String
    The ID of the Deployment the Alias is associated with.
    id String
    The ID of this resource.
    teamId String
    The ID of the team the Alias and Deployment 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.15.1 published on Monday, Sep 8, 2025 by Pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-vercel
      Meet Neo: Your AI Platform Teammate