subdomain

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

Overview

Name	subdomain
Type	Resource
Id	sumologic.account.subdomain

Fields

The following fields are returned by SELECT queries:

getSubdomain

The subdomain's definition.

Name	Datatype	Description
createdAt	string (date-time)	Creation timestamp in UTC in RFC3339 format.
createdBy	string	Identifier of the user who created the resource.
modifiedAt	string (date-time)	Last modification timestamp in UTC.
modifiedBy	string	Identifier of the user who last modified the resource.
subdomain	string	The new subdomain. (example: my-company)
url	string	Login URL corresponding to the subdomain. (example: https://your-company.sumologic.com)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getSubdomain	select	region		Get the configured subdomain.
createSubdomain	insert	region, data__subdomain		Create a subdomain. Only the Account Owner can create a subdomain.
deleteSubdomain	delete	region		Delete the configured subdomain.
updateSubdomain	exec	region, subdomain		Update a subdomain. Only the Account Owner can update the subdomain.

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	SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2)

SELECT examples

getSubdomain

Get the configured subdomain.

SELECT
createdAt,
createdBy,
modifiedAt,
modifiedBy,
subdomain,
url
FROM sumologic.account.subdomain
WHERE region = '{{ region }}' -- required
;

INSERT examples

createSubdomain

Create a subdomain. Only the Account Owner can create a subdomain.

INSERT INTO sumologic.account.subdomain (
data__subdomain,
region
)
SELECT 
'{{ subdomain }}' /* required */,
'{{ region }}'
RETURNING
createdAt,
createdBy,
modifiedAt,
modifiedBy,
subdomain,
url
;

Manifest

# Description fields are for documentation purposes
- name: subdomain
  props:
    - name: region
      value: string
      description: Required parameter for the subdomain resource.
    - name: subdomain
      value: string
      description: |
        The new subdomain.

DELETE examples

deleteSubdomain

Delete the configured subdomain.

DELETE FROM sumologic.account.subdomain
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

updateSubdomain

Update a subdomain. Only the Account Owner can update the subdomain.

EXEC sumologic.account.subdomain.updateSubdomain 
@region='{{ region }}' --required 
@@json=
'{
"subdomain": "{{ subdomain }}"
}'
;