Skip to main content

status

Creates, updates, deletes, gets or lists a status resource.

Overview​

Namestatus
TypeResource
Idsumologic.account.status

Fields​

The following fields are returned by SELECT queries:

Overview of the account.

NameDatatypeDescription
account_activatedbooleanIf the account is activated or not (wire: accountActivated)
application_usestringThe current usage of the application. (pattern: <code>^(ALLOWED|ALLOWED_WITH_WARNING|THROTTLED|RESTRICTED)$</code>, example: ALLOWED) (wire: applicationUse)
can_update_planbooleanIf the plan can be updated by the given user (wire: canUpdatePlan)
is_subscription_v2booleanIndicates whether the account has v2 subscription enabled. (wire: isSubscriptionV2)
log_modelstringThe log model of the account (pattern: <code>^(Flex|Tiered|FlexPlusTiered)$</code>, example: Flex) (wire: logModel)
plan_expiration_daysintegerThe number of days in which the plan will expire (wire: planExpirationDays)
plan_typestringWhether the account is Free/Trial/Paid (pattern: <code>^(Free|Trial|Paid)$</code>, example: Free) (wire: planType)
pricing_modelstringWhether the account is cloudflex or credits (pattern: <code>^(credits|cloudflex)$</code>, example: credits) (wire: pricingModel)
total_creditsintegerTotal amount of credits assigned to the account (wire: totalCredits)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectregionGet information related to the account's plan, pricing model, expiration and payment status.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringSumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)

SELECT examples​

Get information related to the account's plan, pricing model, expiration and payment status.

SELECT
account_activated,
application_use,
can_update_plan,
is_subscription_v2,
log_model,
plan_expiration_days,
plan_type,
pricing_model,
total_credits
FROM sumologic.account.status
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;