Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13195274.7 KB
organizations

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.

patch/v1/{+name}

Path parameters

namestring required

Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.

Query parameters

updateMaskstring

Required. The list of fields to be updated.

Request body

partnerServicesBillingAccountstring

Optional. Billing account necessary for purchasing services from Sovereign Partners. This field is required for creating SIA/PSN/CNTXT/Telefonica partner workloads. The caller should have 'billing.resourceAssociations.create' IAM permission on this billing-account. The format of this string is billingAccounts/AAAAAA-BBBBBB-CCCCCC

labelsobject

Optional. Labels applied to the workload.

etagstring

Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations.

namestring

Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only.

kajEnrollmentState'KAJ_ENROLLMENT_STATE_UNSPECIFIED' | 'KAJ_ENROLLMENT_STATE_PENDING' | 'KAJ_ENROLLMENT_STATE_COMPLETE'

Output only. Represents the KAJ enrollment state of the given workload.

compliantButDisallowedServicesstring[]

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.

partner'PARTNER_UNSPECIFIED' | 'LOCAL_CONTROLS_BY_S3NS' | 'SOVEREIGN_CONTROLS_BY_T_SYSTEMS' | 'SOVEREIGN_CONTROLS_BY_SIA_MINSAIT' | 'SOVEREIGN_CONTROLS_BY_PSN' | 'SOVEREIGN_CONTROLS_BY_CNTXT' | 'SOVEREIGN_CONTROLS_BY_CNTXT_NO_EKM' | 'SPAIN_DATA_BOUNDARY_BY_TELEFONICA'

Optional. Partner regime associated with this workload.

violationNotificationsEnabledboolean

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.

complianceRegime'COMPLIANCE_REGIME_UNSPECIFIED' | 'ASSURED_WORKLOADS_FOR_PARTNERS' | 'AUSTRALIA_DATA_BOUNDARY_AND_SUPPORT' | 'CANADA_DATA_BOUNDARY_AND_SUPPORT' | 'DATA_BOUNDARY_FOR_CANADA_CONTROLLED_GOODS' | 'DATA_BOUNDARY_FOR_CANADA_PROTECTED_B' | 'DATA_BOUNDARY_FOR_CJIS' | 'DATA_BOUNDARY_FOR_FEDRAMP_HIGH' | 'DATA_BOUNDARY_FOR_FEDRAMP_MODERATE' | 'DATA_BOUNDARY_FOR_IL2' | 'DATA_BOUNDARY_FOR_IL4' | 'DATA_BOUNDARY_FOR_IL5' | 'DATA_BOUNDARY_FOR_IRS_PUBLICATION_1075' | 'DATA_BOUNDARY_FOR_ITAR' | 'EU_DATA_BOUNDARY_AND_SUPPORT' | 'ISRAEL_DATA_BOUNDARY_AND_SUPPORT' | 'JAPAN_DATA_BOUNDARY' | 'SWITZERLAND_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS' | 'KSA_DATA_BOUNDARY_WITH_ACCESS_JUSTIFICATIONS' | 'REGIONAL_DATA_BOUNDARY' | 'US_DATA_BOUNDARY_AND_SUPPORT' | 'US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES' | 'US_DATA_BOUNDARY_FOR_HEALTHCARE_AND_LIFE_SCIENCES_WITH_SUPPORT' | 'AU_REGIONS_AND_US_SUPPORT' | 'CA_PROTECTED_B' | 'CA_REGIONS_AND_SUPPORT' | 'CANADA_CONTROLLED_GOODS' | 'CJIS' | 'EU_REGIONS_AND_SUPPORT' | 'FEDRAMP_HIGH' | 'FEDRAMP_MODERATE' | 'HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS' | 'HEALTHCARE_AND_LIFE_SCIENCES_CONTROLS_US_SUPPORT' | 'HIPAA' | 'HITRUST' | 'IL2' | 'IL4' | 'IL5' | 'IRS_1075' | 'ISR_REGIONS' | 'ISR_REGIONS_AND_SUPPORT' | 'ITAR' | 'JP_REGIONS_AND_SUPPORT' | 'KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS' | 'REGIONAL_CONTROLS' | 'US_REGIONAL_ACCESS'

Required. Immutable. Compliance Regime associated with this workload.

displayNamestring

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

provisionedResourcesParentstring

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}

resourceMonitoringEnabledboolean

Output only. Indicates whether resource monitoring is enabled for workload or not. It is true when Resource feed is subscribed to AWM topic and AWM Service Agent Role is binded to AW Service Account for resource Assured workload.

createTimestring google-datetime

Output only. Immutable. The Workload creation timestamp.

billingAccountstring

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.

enableSovereignControlsboolean

Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers.

Response

Successful response