Skip to main content

addresses

Creates, updates, deletes, gets or lists an addresses resource.

Overview​

Nameaddresses
TypeResource
Idsumologic.service_allowlist.addresses

Fields​

The following fields are returned by SELECT queries:

List of all allowlisted CIDR notations and/or IP addresses for the organization.

NameDatatypeDescription
cidrstringThe string representation of the CIDR notation or IP address. (pattern: <code>^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(/([0-9]|[1-2][0-9]|3[0-2]))?$</code>, example: 192.35.24.1, x-pattern-message: Invalid CIDR/IP)
descriptionstringDescription of the CIDR notation or IP address. (example: Accountant)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectregionGet a list of all allowlisted CIDR notations and/or IP addresses for the organization.
addexecregion, dataAdd CIDR notations and/or IP addresses to the allowlist of the organization if not already there. When service allowlisting functionality is enabled, CIDRs/IP addresses that are allowlisted will have access to Sumo Logic and/or content sharing.
removeexecregion, dataRemove allowlisted CIDR notations and/or IP addresses from the organization. Removed CIDRs/IPs will immediately lose access to Sumo Logic and content sharing.

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 a list of all allowlisted CIDR notations and/or IP addresses for the organization.

SELECT
cidr,
description
FROM sumologic.service_allowlist.addresses
WHERE region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

Lifecycle Methods​

EXEC variables use wire (API) names.

Add CIDR notations and/or IP addresses to the allowlist of the organization if not already there. When service allowlisting functionality is enabled, CIDRs/IP addresses that are allowlisted will have access to Sumo Logic and/or content sharing.

EXEC sumologic.service_allowlist.addresses.add
@region='{{ region }}' --required unless SUMOLOGIC_ENVIRONMENT is set
@@json=
'{
"data": "{{ data }}"
}'
;