Show / Hide Table of Contents

Class OrganizationsResource

The "organizations" collection of methods.

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

Constructors

OrganizationsResource(IClientService)

Constructs a new resource.

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

Methods

ClearOrgPolicy(ClearOrgPolicyRequest, string)

Clears a Policy from a resource.

Declaration
public virtual OrganizationsResource.ClearOrgPolicyRequest ClearOrgPolicy(ClearOrgPolicyRequest body, string resource)
Parameters
Type Name Description
ClearOrgPolicyRequest body

The body of the request.

string resource

Name of the resource for the Policy to clear.

Returns
Type Description
OrganizationsResource.ClearOrgPolicyRequest

Get(string)

Fetches an Organization resource identified by the specified resource name.

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

The resource name of the Organization to fetch. This is the organization's relative path in the API, formatted as "organizations/[organizationId]". For example, "organizations/1234".

Returns
Type Description
OrganizationsResource.GetRequest

GetEffectiveOrgPolicy(GetEffectiveOrgPolicyRequest, string)

Gets the effective Policy on a resource. This is the result of merging Policies in the resource hierarchy. The returned Policy will not have an etagset because it is a computed Policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

Declaration
public virtual OrganizationsResource.GetEffectiveOrgPolicyRequest GetEffectiveOrgPolicy(GetEffectiveOrgPolicyRequest body, string resource)
Parameters
Type Name Description
GetEffectiveOrgPolicyRequest body

The body of the request.

string resource

The name of the resource to start computing the effective Policy.

Returns
Type Description
OrganizationsResource.GetEffectiveOrgPolicyRequest

GetIamPolicy(GetIamPolicyRequest, string)

Gets the access control policy for an Organization resource. May be empty if no such policy or resource exists. The resource field should be the organization's resource name, e.g. "organizations/123". Authorization requires the Google IAM permission resourcemanager.organizations.getIamPolicy on the specified organization

Declaration
public virtual OrganizationsResource.GetIamPolicyRequest GetIamPolicy(GetIamPolicyRequest body, string resource)
Parameters
Type Name Description
GetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
OrganizationsResource.GetIamPolicyRequest

GetOrgPolicy(GetOrgPolicyRequest, string)

Gets a Policy on a resource. If no Policy is set on the resource, a Policy is returned with default values including POLICY_TYPE_NOT_SET for the policy_type oneof. The etag value can be used with SetOrgPolicy() to create or update a Policy during read-modify-write.

Declaration
public virtual OrganizationsResource.GetOrgPolicyRequest GetOrgPolicy(GetOrgPolicyRequest body, string resource)
Parameters
Type Name Description
GetOrgPolicyRequest body

The body of the request.

string resource

Name of the resource the Policy is set on.

Returns
Type Description
OrganizationsResource.GetOrgPolicyRequest

ListAvailableOrgPolicyConstraints(ListAvailableOrgPolicyConstraintsRequest, string)

Lists Constraints that could be applied on the specified resource.

Declaration
public virtual OrganizationsResource.ListAvailableOrgPolicyConstraintsRequest ListAvailableOrgPolicyConstraints(ListAvailableOrgPolicyConstraintsRequest body, string resource)
Parameters
Type Name Description
ListAvailableOrgPolicyConstraintsRequest body

The body of the request.

string resource

Name of the resource to list Constraints for.

Returns
Type Description
OrganizationsResource.ListAvailableOrgPolicyConstraintsRequest

ListOrgPolicies(ListOrgPoliciesRequest, string)

Lists all the Policies set for a particular resource.

Declaration
public virtual OrganizationsResource.ListOrgPoliciesRequest ListOrgPolicies(ListOrgPoliciesRequest body, string resource)
Parameters
Type Name Description
ListOrgPoliciesRequest body

The body of the request.

string resource

Name of the resource to list Policies for.

Returns
Type Description
OrganizationsResource.ListOrgPoliciesRequest

Search(SearchOrganizationsRequest)

Searches Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the results. Search will only return organizations on which the user has the permission resourcemanager.organizations.get or has super admin privileges.

Declaration
public virtual OrganizationsResource.SearchRequest Search(SearchOrganizationsRequest body)
Parameters
Type Name Description
SearchOrganizationsRequest body

The body of the request.

Returns
Type Description
OrganizationsResource.SearchRequest

SetIamPolicy(SetIamPolicyRequest, string)

Sets the access control policy on an Organization resource. Replaces any existing policy. The resource field should be the organization's resource name, e.g. "organizations/123". Authorization requires the Google IAM permission resourcemanager.organizations.setIamPolicy on the specified organization

Declaration
public virtual OrganizationsResource.SetIamPolicyRequest SetIamPolicy(SetIamPolicyRequest body, string resource)
Parameters
Type Name Description
SetIamPolicyRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

Returns
Type Description
OrganizationsResource.SetIamPolicyRequest

SetOrgPolicy(SetOrgPolicyRequest, string)

Updates the specified Policy on the resource. Creates a new Policy for that Constraint on the resource if one does not exist. Not supplying an etag on the request Policy results in an unconditional write of the Policy.

Declaration
public virtual OrganizationsResource.SetOrgPolicyRequest SetOrgPolicy(SetOrgPolicyRequest body, string resource)
Parameters
Type Name Description
SetOrgPolicyRequest body

The body of the request.

string resource

Resource name of the resource to attach the Policy.

Returns
Type Description
OrganizationsResource.SetOrgPolicyRequest

TestIamPermissions(TestIamPermissionsRequest, string)

Returns permissions that a caller has on the specified Organization. The resource field should be the organization's resource name, e.g. "organizations/123". There are no permissions required for making this API call.

Declaration
public virtual OrganizationsResource.TestIamPermissionsRequest TestIamPermissions(TestIamPermissionsRequest body, string resource)
Parameters
Type Name Description
TestIamPermissionsRequest body

The body of the request.

string resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

Returns
Type Description
OrganizationsResource.TestIamPermissionsRequest
In this article
Back to top Generated by DocFX