workloads

Overview

Name	workloads
Type	Resource
Id	google.assuredworkloads.workloads

Fields

Name	Datatype	Description
name	string	Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.
partner	string	Optional. Partner regime associated with this workload.
kajEnrollmentState	string	Output only. Represents the KAJ enrollment state of the given workload.
enableSovereignControls	boolean	Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.
billingAccount	string	Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form billingAccounts/{billing_account_id}. For example, billingAccounts/012345-567890-ABCDEF.
partnerPermissions	object	Permissions granted to the AW Partner SA account for the customer workload
kmsSettings	object	Settings specific to the Key Management Service.
resourceSettings	array	Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional.
displayName	string	Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload
saaEnrollmentResponse	object	Signed Access Approvals (SAA) enrollment response.
labels	object	Optional. Labels applied to the workload.
provisionedResourcesParent	string	Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id}
complianceStatus	object	Represents the Compliance Status of this workload
createTime	string	Output only. Immutable. The Workload creation timestamp.
violationNotificationsEnabled	boolean	Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload.
compliantButDisallowedServices	array	Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment."
complianceRegime	string	Required. Immutable. Compliance Regime associated with this workload.
resources	array	Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only.
ekmProvisioningResponse	object	External key management systems(EKM) Provisioning response
etag	string	Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, organizationsId, workloadsId	Gets Assured Workload associated with a CRM Node
list	SELECT	locationsId, organizationsId	Lists Assured Workloads under a CRM Node.
create	INSERT	locationsId, organizationsId	Creates Assured Workload.
delete	DELETE	locationsId, organizationsId, workloadsId	Deletes the workload. Make sure that workload's direct children are already in a deleted state, otherwise the request will fail with a FAILED_PRECONDITION error. In addition to assuredworkloads.workload.delete permission, the user should also have orgpolicy.policy.set permission on the deleted folder to remove Assured Workloads OrgPolicies.
_list	EXEC	locationsId, organizationsId	Lists Assured Workloads under a CRM Node.
mutate_partner_permissions	EXEC	locationsId, organizationsId, workloadsId	Update the permissions settings for an existing partner workload. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
patch	EXEC	locationsId, organizationsId, workloadsId	Updates an existing workload. Currently allows updating of workload display_name and labels. For force updates don't set etag field in the Workload. Only one update operation per workload can be in progress.
restrict_allowed_resources	EXEC	locationsId, organizationsId, workloadsId	Restrict the list of resources allowed in the Workload environment. The current list of allowed products can be found at https://cloud.google.com/assured-workloads/docs/supported-products In addition to assuredworkloads.workload.update permission, the user should also have orgpolicy.policy.set permission on the folder resource to use this functionality.