orgPolicy

import { orgPolicy } from "https://googleapis.deno.dev/v1/orgpolicy:v2.ts";

The Organization Policy API allows users to configure governance rules on their Google Cloud resources across the resource hierarchy.

class orgPolicy {

constructor(client?: CredentialsClient, baseUrl?: string);

async foldersConstraintsList(parent: string, opts?: FoldersConstraintsListOptions): Promise<GoogleCloudOrgpolicyV2ListConstraintsResponse>;

async foldersPoliciesCreate(parent: string, req: GoogleCloudOrgpolicyV2Policy): Promise<GoogleCloudOrgpolicyV2Policy>;

async foldersPoliciesDelete(name: string, opts?: FoldersPoliciesDeleteOptions): Promise<GoogleProtobufEmpty>;

async foldersPoliciesGet(name: string): Promise<GoogleCloudOrgpolicyV2Policy>;

async foldersPoliciesGetEffectivePolicy(name: string): Promise<GoogleCloudOrgpolicyV2Policy>;

async foldersPoliciesList(parent: string, opts?: FoldersPoliciesListOptions): Promise<GoogleCloudOrgpolicyV2ListPoliciesResponse>;

async foldersPoliciesPatch(

req: GoogleCloudOrgpolicyV2Policy,

opts?: FoldersPoliciesPatchOptions,

): Promise<GoogleCloudOrgpolicyV2Policy>;

async organizationsConstraintsList(parent: string, opts?: OrganizationsConstraintsListOptions): Promise<GoogleCloudOrgpolicyV2ListConstraintsResponse>;

async organizationsCustomConstraintsCreate(parent: string, req: GoogleCloudOrgpolicyV2CustomConstraint): Promise<GoogleCloudOrgpolicyV2CustomConstraint>;

async organizationsCustomConstraintsDelete(name: string): Promise<GoogleProtobufEmpty>;

async organizationsCustomConstraintsGet(name: string): Promise<GoogleCloudOrgpolicyV2CustomConstraint>;

async organizationsCustomConstraintsList(parent: string, opts?: OrganizationsCustomConstraintsListOptions): Promise<GoogleCloudOrgpolicyV2ListCustomConstraintsResponse>;

async organizationsCustomConstraintsPatch(name: string, req: GoogleCloudOrgpolicyV2CustomConstraint): Promise<GoogleCloudOrgpolicyV2CustomConstraint>;

async organizationsPoliciesCreate(parent: string, req: GoogleCloudOrgpolicyV2Policy): Promise<GoogleCloudOrgpolicyV2Policy>;

async organizationsPoliciesDelete(name: string, opts?: OrganizationsPoliciesDeleteOptions): Promise<GoogleProtobufEmpty>;

async organizationsPoliciesGet(name: string): Promise<GoogleCloudOrgpolicyV2Policy>;

async organizationsPoliciesGetEffectivePolicy(name: string): Promise<GoogleCloudOrgpolicyV2Policy>;

async organizationsPoliciesList(parent: string, opts?: OrganizationsPoliciesListOptions): Promise<GoogleCloudOrgpolicyV2ListPoliciesResponse>;

async organizationsPoliciesPatch(

req: GoogleCloudOrgpolicyV2Policy,

opts?: OrganizationsPoliciesPatchOptions,

): Promise<GoogleCloudOrgpolicyV2Policy>;

async projectsConstraintsList(parent: string, opts?: ProjectsConstraintsListOptions): Promise<GoogleCloudOrgpolicyV2ListConstraintsResponse>;

async projectsPoliciesCreate(parent: string, req: GoogleCloudOrgpolicyV2Policy): Promise<GoogleCloudOrgpolicyV2Policy>;

async projectsPoliciesDelete(name: string, opts?: ProjectsPoliciesDeleteOptions): Promise<GoogleProtobufEmpty>;

async projectsPoliciesGet(name: string): Promise<GoogleCloudOrgpolicyV2Policy>;

async projectsPoliciesGetEffectivePolicy(name: string): Promise<GoogleCloudOrgpolicyV2Policy>;

async projectsPoliciesList(parent: string, opts?: ProjectsPoliciesListOptions): Promise<GoogleCloudOrgpolicyV2ListPoliciesResponse>;

async projectsPoliciesPatch(

req: GoogleCloudOrgpolicyV2Policy,

opts?: ProjectsPoliciesPatchOptions,

): Promise<GoogleCloudOrgpolicyV2Policy>;

}

§Constructors

new orgPolicy(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

foldersConstraintsList(parent: string, opts?: FoldersConstraintsListOptions): Promise<GoogleCloudOrgpolicyV2ListConstraintsResponse>

[src]

Lists constraints that could be applied on the specified resource.

@param parent

Required. The Google Cloud resource that parents the constraint. Must be in one of the following forms: * projects/{project_number} * projects/{project_id} * folders/{folder_id} * organizations/{organization_id}

foldersPoliciesCreate(parent: string, req: GoogleCloudOrgpolicyV2Policy): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

Creates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the policy already exists on the given Google Cloud resource.

@param parent

Required. The Google Cloud resource that will parent the new policy. Must be in one of the following forms: * projects/{project_number} * projects/{project_id} * folders/{folder_id} * organizations/{organization_id}

foldersPoliciesDelete(name: string, opts?: FoldersPoliciesDeleteOptions): Promise<GoogleProtobufEmpty>

[src]

Deletes a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist.

@param name

Required. Name of the policy to delete. See the policy entry for naming rules.

foldersPoliciesGet(name: string): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write.

@param name

Required. Resource name of the policy. See Policy for naming requirements.

foldersPoliciesGetEffectivePolicy(name: string): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

Gets the effective policy on a resource. This is the result of merging policies in the resource hierarchy and evaluating conditions. The returned policy will not have an etag or condition set because it is an evaluated policy across multiple resources. Subtrees of Resource Manager resource hierarchy with 'under:' prefix will not be expanded.

@param name

Required. The effective policy to compute. See Policy for naming requirements.

foldersPoliciesList(parent: string, opts?: FoldersPoliciesListOptions): Promise<GoogleCloudOrgpolicyV2ListPoliciesResponse>

[src]

Retrieves all of the policies that exist on a particular resource.

@param parent

Required. The target Google Cloud resource that parents the set of constraints and policies that will be returned from this call. Must be in one of the following forms: * projects/{project_number} * projects/{project_id} * folders/{folder_id} * organizations/{organization_id}

foldersPoliciesPatch(name: string, req: GoogleCloudOrgpolicyV2Policy, opts?: FoldersPoliciesPatchOptions): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

Updates a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or the policy do not exist. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the policy Note: the supplied policy will perform a full overwrite of all fields.

@param name

Immutable. The resource name of the policy. Must be one of the following forms, where constraint_name is the name of the constraint which this policy configures: * projects/{project_number}/policies/{constraint_name} * folders/{folder_id}/policies/{constraint_name} * organizations/{organization_id}/policies/{constraint_name} For example, projects/123/policies/compute.disableSerialPortAccess. Note: projects/{project_id}/policies/{constraint_name} is also an acceptable name for API requests, but responses will return the name using the equivalent project number.

organizationsConstraintsList(parent: string, opts?: OrganizationsConstraintsListOptions): Promise<GoogleCloudOrgpolicyV2ListConstraintsResponse>

[src]

Lists constraints that could be applied on the specified resource.

@param parent

organizationsCustomConstraintsCreate(parent: string, req: GoogleCloudOrgpolicyV2CustomConstraint): Promise<GoogleCloudOrgpolicyV2CustomConstraint>

[src]

Creates a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the organization does not exist. Returns a google.rpc.Status with google.rpc.Code.ALREADY_EXISTS if the constraint already exists on the given organization.

@param parent

Required. Must be in the following form: * organizations/{organization_id}

organizationsCustomConstraintsDelete(name: string): Promise<GoogleProtobufEmpty>

[src]

Deletes a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist.

@param name

Required. Name of the custom constraint to delete. See the custom constraint entry for naming rules.

organizationsCustomConstraintsGet(name: string): Promise<GoogleCloudOrgpolicyV2CustomConstraint>

[src]

Gets a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the custom constraint does not exist.

@param name

Required. Resource name of the custom constraint. See the custom constraint entry for naming requirements.

organizationsCustomConstraintsList(parent: string, opts?: OrganizationsCustomConstraintsListOptions): Promise<GoogleCloudOrgpolicyV2ListCustomConstraintsResponse>

[src]

Retrieves all of the custom constraints that exist on a particular organization resource.

@param parent

Required. The target Google Cloud resource that parents the set of custom constraints that will be returned from this call. Must be in one of the following forms: * organizations/{organization_id}

organizationsCustomConstraintsPatch(name: string, req: GoogleCloudOrgpolicyV2CustomConstraint): Promise<GoogleCloudOrgpolicyV2CustomConstraint>

[src]

Updates a custom constraint. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint does not exist. Note: the supplied policy will perform a full overwrite of all fields.

@param name

Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * organizations/{organization_id}/customConstraints/{custom_constraint_id} Example: organizations/123/customConstraints/custom.createOnlyE2TypeVms The max length is 70 characters and the minimum length is 1. Note that the prefix organizations/{organization_id}/customConstraints/ is not counted.

organizationsPoliciesCreate(parent: string, req: GoogleCloudOrgpolicyV2Policy): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

@param parent

organizationsPoliciesDelete(name: string, opts?: OrganizationsPoliciesDeleteOptions): Promise<GoogleProtobufEmpty>

[src]

Deletes a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist.

@param name

Required. Name of the policy to delete. See the policy entry for naming rules.

organizationsPoliciesGet(name: string): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write.

@param name

Required. Resource name of the policy. See Policy for naming requirements.

organizationsPoliciesGetEffectivePolicy(name: string): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

@param name

Required. The effective policy to compute. See Policy for naming requirements.

organizationsPoliciesList(parent: string, opts?: OrganizationsPoliciesListOptions): Promise<GoogleCloudOrgpolicyV2ListPoliciesResponse>

[src]

Retrieves all of the policies that exist on a particular resource.

@param parent

organizationsPoliciesPatch(name: string, req: GoogleCloudOrgpolicyV2Policy, opts?: OrganizationsPoliciesPatchOptions): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

@param name

projectsConstraintsList(parent: string, opts?: ProjectsConstraintsListOptions): Promise<GoogleCloudOrgpolicyV2ListConstraintsResponse>

[src]

Lists constraints that could be applied on the specified resource.

@param parent

projectsPoliciesCreate(parent: string, req: GoogleCloudOrgpolicyV2Policy): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

@param parent

projectsPoliciesDelete(name: string, opts?: ProjectsPoliciesDeleteOptions): Promise<GoogleProtobufEmpty>

[src]

Deletes a policy. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the constraint or organization policy does not exist.

@param name

Required. Name of the policy to delete. See the policy entry for naming rules.

projectsPoliciesGet(name: string): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

Gets a policy on a resource. If no policy is set on the resource, NOT_FOUND is returned. The etag value can be used with UpdatePolicy() to update a policy during read-modify-write.

@param name

Required. Resource name of the policy. See Policy for naming requirements.

projectsPoliciesGetEffectivePolicy(name: string): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

@param name

Required. The effective policy to compute. See Policy for naming requirements.

projectsPoliciesList(parent: string, opts?: ProjectsPoliciesListOptions): Promise<GoogleCloudOrgpolicyV2ListPoliciesResponse>

[src]

Retrieves all of the policies that exist on a particular resource.

@param parent

projectsPoliciesPatch(name: string, req: GoogleCloudOrgpolicyV2Policy, opts?: ProjectsPoliciesPatchOptions): Promise<GoogleCloudOrgpolicyV2Policy>

[src]

@param name