1. Packages
  2. DigitalOcean
  3. API Docs
  4. getAccount
DigitalOcean v4.27.0 published on Wednesday, Mar 13, 2024 by Pulumi

digitalocean.getAccount

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.27.0 published on Wednesday, Mar 13, 2024 by Pulumi

    Get information on your DigitalOcean account.

    Example Usage

    Get the account:

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const example = digitalocean.getAccount({});
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    example = digitalocean.get_account()
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := digitalocean.GetAccount(ctx, nil, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var example = DigitalOcean.GetAccount.Invoke();
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.DigitaloceanFunctions;
    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 = DigitaloceanFunctions.getAccount();
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: digitalocean:getAccount
          Arguments: {}
    

    Using getAccount

    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 getAccount(opts?: InvokeOptions): Promise<GetAccountResult>
    function getAccountOutput(opts?: InvokeOptions): Output<GetAccountResult>
    def get_account(opts: Optional[InvokeOptions] = None) -> GetAccountResult
    def get_account_output(opts: Optional[InvokeOptions] = None) -> Output[GetAccountResult]
    func GetAccount(ctx *Context, opts ...InvokeOption) (*GetAccountResult, error)
    func GetAccountOutput(ctx *Context, opts ...InvokeOption) GetAccountResultOutput

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

    public static class GetAccount 
    {
        public static Task<GetAccountResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetAccountResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAccountResult> getAccount(InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: digitalocean:index/getAccount:getAccount
      arguments:
        # arguments dictionary

    getAccount Result

    The following output properties are available:

    DropletLimit int
    The total number of droplets current user or team may have active at one time.
    Email string
    The email address used by the current user to register for DigitalOcean.
    EmailVerified bool
    If true, the user has verified their account via email. False otherwise.
    FloatingIpLimit int
    The total number of floating IPs the current user or team may have.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    This value is one of "active", "warning" or "locked".
    StatusMessage string
    A human-readable message giving more details about the status of the account.
    Uuid string
    The unique universal identifier for the current user.
    DropletLimit int
    The total number of droplets current user or team may have active at one time.
    Email string
    The email address used by the current user to register for DigitalOcean.
    EmailVerified bool
    If true, the user has verified their account via email. False otherwise.
    FloatingIpLimit int
    The total number of floating IPs the current user or team may have.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    This value is one of "active", "warning" or "locked".
    StatusMessage string
    A human-readable message giving more details about the status of the account.
    Uuid string
    The unique universal identifier for the current user.
    dropletLimit Integer
    The total number of droplets current user or team may have active at one time.
    email String
    The email address used by the current user to register for DigitalOcean.
    emailVerified Boolean
    If true, the user has verified their account via email. False otherwise.
    floatingIpLimit Integer
    The total number of floating IPs the current user or team may have.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    This value is one of "active", "warning" or "locked".
    statusMessage String
    A human-readable message giving more details about the status of the account.
    uuid String
    The unique universal identifier for the current user.
    dropletLimit number
    The total number of droplets current user or team may have active at one time.
    email string
    The email address used by the current user to register for DigitalOcean.
    emailVerified boolean
    If true, the user has verified their account via email. False otherwise.
    floatingIpLimit number
    The total number of floating IPs the current user or team may have.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    This value is one of "active", "warning" or "locked".
    statusMessage string
    A human-readable message giving more details about the status of the account.
    uuid string
    The unique universal identifier for the current user.
    droplet_limit int
    The total number of droplets current user or team may have active at one time.
    email str
    The email address used by the current user to register for DigitalOcean.
    email_verified bool
    If true, the user has verified their account via email. False otherwise.
    floating_ip_limit int
    The total number of floating IPs the current user or team may have.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    This value is one of "active", "warning" or "locked".
    status_message str
    A human-readable message giving more details about the status of the account.
    uuid str
    The unique universal identifier for the current user.
    dropletLimit Number
    The total number of droplets current user or team may have active at one time.
    email String
    The email address used by the current user to register for DigitalOcean.
    emailVerified Boolean
    If true, the user has verified their account via email. False otherwise.
    floatingIpLimit Number
    The total number of floating IPs the current user or team may have.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    This value is one of "active", "warning" or "locked".
    statusMessage String
    A human-readable message giving more details about the status of the account.
    uuid String
    The unique universal identifier for the current user.

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.27.0 published on Wednesday, Mar 13, 2024 by Pulumi