github.com/nathanielks/terraform@v0.6.1-0.20170509030759-13e1a62319dc/website/source/docs/providers/circonus/d/account.html.markdown (about)

     1  ---
     2  layout: "circonus"
     3  page_title: "Circonus: account"
     4  sidebar_current: "docs-circonus-datasource-account"
     5  description: |-
     6      Provides details about a specific Circonus Account.
     7  ---
     8  
     9  # circonus_account
    10  
    11  `circonus_account` provides
    12  [details](https://login.circonus.com/resources/api/calls/account) about a specific
    13  [Circonus Account](https://login.circonus.com/user/docs/Administration/Account).
    14  
    15  The `circonus_account` data source can be used for pulling various attributes
    16  about a specific Circonus Account.
    17  
    18  ## Example Usage
    19  
    20  The following example shows how the resource might be used to obtain the metrics
    21  usage and limit of a given Circonus Account.
    22  
    23  ```hcl
    24  data "circonus_account" "current" {
    25    current = true
    26  }
    27  ```
    28  
    29  ## Argument Reference
    30  
    31  The arguments of this data source act as filters for querying the available
    32  regions. The given filters must match exactly one region whose data will be
    33  exported as attributes.
    34  
    35  * `id` - (Optional) The Circonus ID of a given account.
    36  * `current` - (Optional) Automatically use the current Circonus Account attached
    37    to the API token making the request.
    38  
    39  At least one of the above attributes should be provided when searching for a
    40  account.
    41  
    42  ## Attributes Reference
    43  
    44  The following attributes are exported:
    45  
    46  * `address1` - The first line of the address associated with the account.
    47  
    48  * `address2` - The second line of the address associated with the account.
    49  
    50  * `cc_email` - An optionally specified email address used in the CC line of invoices.
    51  
    52  * `id` - The Circonus ID of the selected Account.
    53  
    54  * `city` - The city part of the address associated with the account.
    55  
    56  * `contact_groups` - A list of IDs for each contact group in the account.
    57  
    58  * `country` - The country of the user's address.
    59  
    60  * `description` - Description of the account.
    61  
    62  * `invites` - An list of users invited to use the platform.  Each element in the
    63    list has both an `email` and `role` attribute.
    64  
    65  * `name` - The name of the account.
    66  
    67  * `owner` - The Circonus ID of the user who owns this account.
    68  
    69  * `state_prov` - The state or province of the address associated with the account.
    70  
    71  * `timezone` - The timezone that events will be displayed in the web interface
    72    for this account.
    73  
    74  * `ui_base_url` - The base URL of this account.
    75  
    76  * `usage` - A list of account usage limits.  Each element in the list will have
    77    a `limit` attribute, a limit `type`, and a `used` attribute.
    78  
    79  * `users` - A list of users who have access to this account.  Each element in
    80    the list has both an `id` and a `role`.  The `id` is a Circonus ID referencing
    81    the user.