Show / Hide Table of Contents

Class OrganizationsResource.LocationsResource.WorkloadsResource

The "workloads" collection of methods.

Inheritance
object
OrganizationsResource.LocationsResource.WorkloadsResource
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Assuredworkloads.v1beta1
Assembly: Google.Apis.Assuredworkloads.v1beta1.dll
Syntax
public class OrganizationsResource.LocationsResource.WorkloadsResource

Constructors

WorkloadsResource(IClientService)

Constructs a new resource.

Declaration
public WorkloadsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

Updates

Gets the Updates resource.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.UpdatesResource Updates { get; }
Property Value
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.UpdatesResource

Violations

Gets the Violations resource.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.ViolationsResource Violations { get; }
Property Value
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.ViolationsResource

Methods

AnalyzeWorkloadMove(string)

Analyzes a hypothetical move of a source resource to a target workload to surface compliance risks. The analysis is best effort and is not guaranteed to be exhaustive.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.AnalyzeWorkloadMoveRequest AnalyzeWorkloadMove(string target)
Parameters
Type Name Description
string target

Required. The resource ID of the folder-based destination workload. This workload is where the source resource will hypothetically be moved to. Specify the workload's relative resource name, formatted as: "organizations/{ORGANIZATION_ID}/locations/{LOCATION_ID}/workloads/{WORKLOAD_ID}" For example: "organizations/123/locations/us-east1/workloads/assured-workload-2"

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.AnalyzeWorkloadMoveRequest

Create(GoogleCloudAssuredworkloadsV1beta1Workload, string)

Creates Assured Workload.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.CreateRequest Create(GoogleCloudAssuredworkloadsV1beta1Workload body, string parent)
Parameters
Type Name Description
GoogleCloudAssuredworkloadsV1beta1Workload body

The body of the request.

string parent

Required. The resource name of the new Workload's parent. Must be of the form organizations/{org_id}/locations/{location_id}.

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.CreateRequest

Delete(string)

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.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.DeleteRequest

EnableComplianceUpdates(string)

This endpoint enables Assured Workloads service to offer compliance updates for the folder based assured workload. It sets up an Assured Workloads Service Agent, having permissions to read compliance controls (for example: Org Policies) applied on the workload. The caller must have resourcemanager.folders.getIamPolicy and resourcemanager.folders.setIamPolicy permissions on the assured workload folder.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.EnableComplianceUpdatesRequest EnableComplianceUpdates(string name)
Parameters
Type Name Description
string name

Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.EnableComplianceUpdatesRequest

EnableResourceMonitoring(string)

Enable resource violation monitoring for a workload.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.EnableResourceMonitoringRequest EnableResourceMonitoring(string name)
Parameters
Type Name Description
string name

Required. The name field is used to identify the workload. Format: organizations/{org_id}/locations/{location_id}/workloads/{workload_id}

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.EnableResourceMonitoringRequest

Get(string)

Gets Assured Workload associated with a CRM Node

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The resource name of the Workload to fetch. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1".

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.GetRequest

List(string)

Lists Assured Workloads under a CRM Node.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.ListRequest List(string parent)
Parameters
Type Name Description
string parent

Required. Parent Resource to list workloads from. Must be of the form organizations/{org_id}/locations/{location}.

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.ListRequest

Patch(GoogleCloudAssuredworkloadsV1beta1Workload, string)

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.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.PatchRequest Patch(GoogleCloudAssuredworkloadsV1beta1Workload body, string name)
Parameters
Type Name Description
GoogleCloudAssuredworkloadsV1beta1Workload body

The body of the request.

string name

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

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.PatchRequest

RestrictAllowedResources(GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest, string)

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.

Declaration
public virtual OrganizationsResource.LocationsResource.WorkloadsResource.RestrictAllowedResourcesRequest RestrictAllowedResources(GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest body, string name)
Parameters
Type Name Description
GoogleCloudAssuredworkloadsV1beta1RestrictAllowedResourcesRequest body

The body of the request.

string name

Required. The resource name of the Workload. This is the workloads's relative path in the API, formatted as "organizations/{organization_id}/locations/{location_id}/workloads/{workload_id}". For example, "organizations/123/locations/us-east1/workloads/assured-workload-1".

Returns
Type Description
OrganizationsResource.LocationsResource.WorkloadsResource.RestrictAllowedResourcesRequest
In this article
Back to top Generated by DocFX