Compute Engine v1 API - Class OrganizationSecurityPolicies.OrganizationSecurityPoliciesBase (3.22.0)

[BindServiceMethod(typeof(OrganizationSecurityPolicies), "BindService")]
public abstract class OrganizationSecurityPolicies.OrganizationSecurityPoliciesBase

Reference documentation and code samples for the Compute Engine v1 API class OrganizationSecurityPolicies.OrganizationSecurityPoliciesBase.

Base class for server-side implementations of OrganizationSecurityPolicies

Inheritance

object > OrganizationSecurityPolicies.OrganizationSecurityPoliciesBase

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

AddAssociation(AddAssociationOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> AddAssociation(AddAssociationOrganizationSecurityPolicyRequest request, ServerCallContext context)

Inserts an association for the specified security policy.

This has billing implications. Projects in the hierarchy with effective hierarchical security policies will be automatically enrolled into Cloud Armor Enterprise if not already enrolled.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.addAssociation instead.

Parameters
Name Description
request AddAssociationOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

AddRule(AddRuleOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> AddRule(AddRuleOrganizationSecurityPolicyRequest request, ServerCallContext context)

Inserts a rule into a security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.addRule instead.

Parameters
Name Description
request AddRuleOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

CopyRules(CopyRulesOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> CopyRules(CopyRulesOrganizationSecurityPolicyRequest request, ServerCallContext context)

Copies rules to the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.cloneRules instead.

Parameters
Name Description
request CopyRulesOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

Delete(DeleteOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> Delete(DeleteOrganizationSecurityPolicyRequest request, ServerCallContext context)

Deletes the specified policy.

Use this API to remove Cloud Armor policies. Previously, alpha and beta versions of this API were used to remove firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.delete instead.

Parameters
Name Description
request DeleteOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

Get(GetOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<SecurityPolicy> Get(GetOrganizationSecurityPolicyRequest request, ServerCallContext context)

List all of the ordered rules present in a single specified policy.

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.get instead.

Parameters
Name Description
request GetOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSecurityPolicy

The response to send back to the client (wrapped by a task).

GetAssociation(GetAssociationOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<SecurityPolicyAssociation> GetAssociation(GetAssociationOrganizationSecurityPolicyRequest request, ServerCallContext context)

Gets an association with the specified name.

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.getAssociation instead.

Parameters
Name Description
request GetAssociationOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSecurityPolicyAssociation

The response to send back to the client (wrapped by a task).

GetRule(GetRuleOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<SecurityPolicyRule> GetRule(GetRuleOrganizationSecurityPolicyRequest request, ServerCallContext context)

Gets a rule at the specified priority.

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.getRule instead.

Parameters
Name Description
request GetRuleOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSecurityPolicyRule

The response to send back to the client (wrapped by a task).

Insert(InsertOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> Insert(InsertOrganizationSecurityPolicyRequest request, ServerCallContext context)

Creates a new policy in the specified organization using the data included in the request.

Use this API to add Cloud Armor policies. Previously, alpha and beta versions of this API were used to add firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.insert instead.

Parameters
Name Description
request InsertOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

List(ListOrganizationSecurityPoliciesRequest, ServerCallContext)

public virtual Task<SecurityPolicyList> List(ListOrganizationSecurityPoliciesRequest request, ServerCallContext context)

List all the policies that have been configured for the specified organization.

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.list instead.

Parameters
Name Description
request ListOrganizationSecurityPoliciesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSecurityPolicyList

The response to send back to the client (wrapped by a task).

ListAssociations(ListAssociationsOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<OrganizationSecurityPoliciesListAssociationsResponse> ListAssociations(ListAssociationsOrganizationSecurityPolicyRequest request, ServerCallContext context)

Lists associations of a specified target, i.e., organization or folder.

Use this API to read Cloud Armor policies. Previously, alpha and beta versions of this API were used to read firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.listAssociations instead.

Parameters
Name Description
request ListAssociationsOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOrganizationSecurityPoliciesListAssociationsResponse

The response to send back to the client (wrapped by a task).

ListPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest, ServerCallContext)

public virtual Task<SecurityPoliciesListPreconfiguredExpressionSetsResponse> ListPreconfiguredExpressionSets(ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest request, ServerCallContext context)

Gets the current list of preconfigured Web Application Firewall (WAF) expressions.

Parameters
Name Description
request ListPreconfiguredExpressionSetsOrganizationSecurityPoliciesRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskSecurityPoliciesListPreconfiguredExpressionSetsResponse

The response to send back to the client (wrapped by a task).

Move(MoveOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> Move(MoveOrganizationSecurityPolicyRequest request, ServerCallContext context)

Moves the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.move instead.

Parameters
Name Description
request MoveOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

Patch(PatchOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> Patch(PatchOrganizationSecurityPolicyRequest request, ServerCallContext context)

Patches the specified policy with the data included in the request.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.patch instead.

Parameters
Name Description
request PatchOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

PatchRule(PatchRuleOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> PatchRule(PatchRuleOrganizationSecurityPolicyRequest request, ServerCallContext context)

Patches a rule at the specified priority.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.patchRule instead.

Parameters
Name Description
request PatchRuleOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

RemoveAssociation(RemoveAssociationOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> RemoveAssociation(RemoveAssociationOrganizationSecurityPolicyRequest request, ServerCallContext context)

Removes an association for the specified security policy.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.removeAssociation instead.

Parameters
Name Description
request RemoveAssociationOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).

RemoveRule(RemoveRuleOrganizationSecurityPolicyRequest, ServerCallContext)

public virtual Task<Operation> RemoveRule(RemoveRuleOrganizationSecurityPolicyRequest request, ServerCallContext context)

Deletes a rule at the specified priority.

Use this API to modify Cloud Armor policies. Previously, alpha and beta versions of this API were used to modify firewall policies. This usage is now disabled for most organizations. Use firewallPolicies.removeRule instead.

Parameters
Name Description
request RemoveRuleOrganizationSecurityPolicyRequest

The request received from the client.

context ServerCallContext

The context of the server-side call handler being invoked.

Returns
Type Description
TaskOperation

The response to send back to the client (wrapped by a task).