customers

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

Overview

Name	customers
Type	Resource
Id	google.sasportal.customers

Fields

The following fields are returned by SELECT queries:

customers_get

Name	Datatype	Description
name	string	Output only. Resource name of the customer.
displayName	string	Required. Name of the organization that the customer entity represents.
sasUserIds	array	User IDs used by the devices belonging to this customer.

customers_list

Name	Datatype	Description
name	string	Output only. Resource name of the customer.
displayName	string	Required. Name of the organization that the customer entity represents.
sasUserIds	array	User IDs used by the devices belonging to this customer.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
customers_get	select	customersId		Returns a requested customer.
customers_list	select		pageSize, pageToken	Returns a list of requested customers.
customers_patch	update	customersId	updateMask	Updates an existing customer.
customers_migrate_organization	exec			Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration
customers_provision_deployment	exec			Creates a new SAS deployment through the GCP workflow. Creates a SAS organization if an organization match is not found.
customers_setup_sas_analytics	exec			Setups the a GCP Project to receive SAS Analytics messages via GCP Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and BigQuery tables are created automatically as part of this service.

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
customersId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

customers_get

Returns a requested customer.

SELECT
name,
displayName,
sasUserIds
FROM google.sasportal.customers
WHERE customersId = '{{ customersId }}' -- required
;

customers_list

Returns a list of requested customers.

SELECT
name,
displayName,
sasUserIds
FROM google.sasportal.customers
WHERE pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

UPDATE examples

customers_patch

Updates an existing customer.

UPDATE google.sasportal.customers
SET 
data__displayName = '{{ displayName }}',
data__name = '{{ name }}',
data__sasUserIds = '{{ sasUserIds }}'
WHERE 
customersId = '{{ customersId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
displayName,
sasUserIds;

Lifecycle Methods

customers_migrate_organization

Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration

EXEC google.sasportal.customers.customers_migrate_organization 
@@json=
'{
"organizationId": "{{ organizationId }}"
}'
;

customers_provision_deployment

Creates a new SAS deployment through the GCP workflow. Creates a SAS organization if an organization match is not found.

EXEC google.sasportal.customers.customers_provision_deployment 
@@json=
'{
"newDeploymentDisplayName": "{{ newDeploymentDisplayName }}", 
"newOrganizationDisplayName": "{{ newOrganizationDisplayName }}", 
"organizationId": "{{ organizationId }}"
}'
;

customers_setup_sas_analytics

Setups the a GCP Project to receive SAS Analytics messages via GCP Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and BigQuery tables are created automatically as part of this service.

EXEC google.sasportal.customers.customers_setup_sas_analytics 
@@json=
'{
"userId": "{{ userId }}"
}'
;