app_subscriptions
Creates, updates, deletes, gets or lists an app_subscriptions resource.
Overview​
| Name | app_subscriptions |
| Type | Resource |
| Id | sumologic.apps.app_subscriptions |
Fields​
The following fields are returned by SELECT queries:
- get
Information about user's subscription status for the app.
| Name | Datatype | Description |
|---|---|---|
status | boolean | Show if the user has subscribed to the app or not. value is true, if the user has subscribed to the app |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | uuid, region | Get Subscription status for the user for a specific app. This will indicate whether the user has subscribed to the app or not. | |
delete | delete | uuid, region | Unsubscribe from an app. This will remove the user's subscription to notifications for the app. | |
subscribe | exec | uuid, region | Subscribe to an app upgrade notification. This will allow the user to receive notifications for the app updates. |
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.
| Name | Datatype | Description |
|---|---|---|
region | string | Sumo 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) |
uuid | string | UUID of the app to subscribe to. (example: ceb7fac5-1127-4a04-a5b8-2e49190be3d5) |
SELECT examples​
- get
Get Subscription status for the user for a specific app. This will indicate whether the user has subscribed to the app or not.
SELECT
status
FROM sumologic.apps.app_subscriptions
WHERE uuid = '{{ uuid }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;
DELETE examples​
- delete
Unsubscribe from an app. This will remove the user's subscription to notifications for the app.
DELETE FROM sumologic.apps.app_subscriptions
WHERE uuid = '{{ uuid }}' --required
AND region = '{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;
Lifecycle Methods​
EXEC variables use wire (API) names.
- subscribe
Subscribe to an app upgrade notification. This will allow the user to receive notifications for the app updates.
EXEC sumologic.apps.app_subscriptions.subscribe
@uuid='{{ uuid }}' --required,
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
;