OSConfig

import { OSConfig } from "https://googleapis.deno.dev/v1/osconfig:v1.ts";

OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

class OSConfig {

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

patchDeployments;

patchJobs;

async projectsLocationsGlobalGetProjectFeatureSettings(name: string): Promise<ProjectFeatureSettings>;

async projectsLocationsGlobalUpdateProjectFeatureSettings(

req: ProjectFeatureSettings,

opts?: ProjectsLocationsGlobalUpdateProjectFeatureSettingsOptions,

): Promise<ProjectFeatureSettings>;

async projectsLocationsInstancesInventoriesGet(name: string, opts?: ProjectsLocationsInstancesInventoriesGetOptions): Promise<Inventory>;

async projectsLocationsInstancesInventoriesList(parent: string, opts?: ProjectsLocationsInstancesInventoriesListOptions): Promise<ListInventoriesResponse>;

async projectsLocationsInstancesOsPolicyAssignmentsReportsGet(name: string): Promise<OSPolicyAssignmentReport>;

async projectsLocationsInstancesOsPolicyAssignmentsReportsList(parent: string, opts?: ProjectsLocationsInstancesOsPolicyAssignmentsReportsListOptions): Promise<ListOSPolicyAssignmentReportsResponse>;

async projectsLocationsInstancesVulnerabilityReportsGet(name: string): Promise<VulnerabilityReport>;

async projectsLocationsInstancesVulnerabilityReportsList(parent: string, opts?: ProjectsLocationsInstancesVulnerabilityReportsListOptions): Promise<ListVulnerabilityReportsResponse>;

async projectsLocationsOsPolicyAssignmentsCreate(

parent: string,

req: OSPolicyAssignment,

opts?: ProjectsLocationsOsPolicyAssignmentsCreateOptions,

): Promise<Operation>;

async projectsLocationsOsPolicyAssignmentsDelete(name: string): Promise<Operation>;

async projectsLocationsOsPolicyAssignmentsGet(name: string): Promise<OSPolicyAssignment>;

async projectsLocationsOsPolicyAssignmentsList(parent: string, opts?: ProjectsLocationsOsPolicyAssignmentsListOptions): Promise<ListOSPolicyAssignmentsResponse>;

async projectsLocationsOsPolicyAssignmentsListRevisions(name: string, opts?: ProjectsLocationsOsPolicyAssignmentsListRevisionsOptions): Promise<ListOSPolicyAssignmentRevisionsResponse>;

async projectsLocationsOsPolicyAssignmentsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOsPolicyAssignmentsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOsPolicyAssignmentsPatch(

req: OSPolicyAssignment,

opts?: ProjectsLocationsOsPolicyAssignmentsPatchOptions,

): Promise<Operation>;

async projectsPatchDeploymentsCreate(

parent: string,

req: PatchDeployment,

opts?: ProjectsPatchDeploymentsCreateOptions,

): Promise<PatchDeployment>;

async projectsPatchDeploymentsDelete(name: string): Promise<Empty>;

async projectsPatchDeploymentsGet(name: string): Promise<PatchDeployment>;

async projectsPatchDeploymentsList(parent: string, opts?: ProjectsPatchDeploymentsListOptions): Promise<ListPatchDeploymentsResponse>;

async projectsPatchDeploymentsPatch(

req: PatchDeployment,

opts?: ProjectsPatchDeploymentsPatchOptions,

): Promise<PatchDeployment>;

async projectsPatchDeploymentsPause(name: string, req: PausePatchDeploymentRequest): Promise<PatchDeployment>;

async projectsPatchDeploymentsResume(name: string, req: ResumePatchDeploymentRequest): Promise<PatchDeployment>;

async projectsPatchJobsCancel(name: string, req: CancelPatchJobRequest): Promise<PatchJob>;

async projectsPatchJobsExecute(parent: string, req: ExecutePatchJobRequest): Promise<PatchJob>;

async projectsPatchJobsGet(name: string): Promise<PatchJob>;

async projectsPatchJobsInstanceDetailsList(parent: string, opts?: ProjectsPatchJobsInstanceDetailsListOptions): Promise<ListPatchJobInstanceDetailsResponse>;

async projectsPatchJobsList(parent: string, opts?: ProjectsPatchJobsListOptions): Promise<ListPatchJobsResponse>;

}

§Constructors

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

[src]

§Properties

patchDeployments

[src]

Delete an OS Config patch deployment.

patchDeployments

[src]

Get an OS Config patch deployment.

patchDeployments

[src]

Change state of patch deployment to "PAUSED". Patch deployment in paused state doesn't generate patch jobs.

patchDeployments

[src]

Change state of patch deployment back to "ACTIVE". Patch deployment in active state continues to generate patch jobs.

patchJobs

[src]

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

patchJobs

[src]

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

patchJobs

[src]

Get a list of instance details for a given patch job.

§Methods

projectsLocationsGlobalGetProjectFeatureSettings(name: string): Promise<ProjectFeatureSettings>

[src]

GetProjectFeatureSettings returns the VM Manager feature settings for a project.

@param name

Required. Name specifies the URL for the ProjectFeatureSettings resource: projects/project_id/locations/global/projectFeatureSettings.

projectsLocationsGlobalUpdateProjectFeatureSettings(name: string, req: ProjectFeatureSettings, opts?: ProjectsLocationsGlobalUpdateProjectFeatureSettingsOptions): Promise<ProjectFeatureSettings>

[src]

UpdateProjectFeatureSettings sets the VM Manager features for a project.

@param name

Required. Immutable. Name specifies the URL for the ProjectFeatureSettings resource: projects/project_id/locations/global/projectFeatureSettings.

projectsLocationsInstancesInventoriesGet(name: string, opts?: ProjectsLocationsInstancesInventoriesGetOptions): Promise<Inventory>

[src]

Get inventory data for the specified VM instance. If the VM has no associated inventory, the message NOT_FOUND is returned.

@param name

Required. API resource name for inventory resource. Format: projects/{project}/locations/{location}/instances/{instance}/inventory For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

projectsLocationsInstancesInventoriesList(parent: string, opts?: ProjectsLocationsInstancesInventoriesListOptions): Promise<ListInventoriesResponse>

[src]

List inventory data for all VM instances in the specified zone.

@param parent

Required. The parent resource name. Format: projects/{project}/locations/{location}/instances/- For {project}, either project-number or project-id can be provided.

projectsLocationsInstancesOsPolicyAssignmentsReportsGet(name: string): Promise<OSPolicyAssignmentReport>

[src]

Get the OS policy assignment report for the specified Compute Engine VM instance.

@param name

Required. API resource name for OS policy assignment report. Format: /projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report For {project}, either project-number or project-id can be provided. For {instance_id}, either Compute Engine instance-id or instance-name can be provided. For {assignment_id}, the OSPolicyAssignment id must be provided.

projectsLocationsInstancesOsPolicyAssignmentsReportsList(parent: string, opts?: ProjectsLocationsInstancesOsPolicyAssignmentsReportsListOptions): Promise<ListOSPolicyAssignmentReportsResponse>

[src]

List OS policy assignment reports for all Compute Engine VM instances in the specified zone.

@param parent

Required. The parent resource name. Format: projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/reports For {project}, either project-number or project-id can be provided. For {instance}, either instance-name, instance-id, or - can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all instances in the project/location. For {assignment}, either assignment-id or - can be provided. If '-' is provided, the response will include OSPolicyAssignmentReports for all OSPolicyAssignments in the project/location. Either {instance} or {assignment} must be -. For example: projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/-/reports returns all reports for the instance projects/{project}/locations/{location}/instances/-/osPolicyAssignments/{assignment-id}/reports returns all the reports for the given assignment across all instances. projects/{project}/locations/{location}/instances/-/osPolicyAssignments/-/reports returns all the reports for all assignments across all instances.

projectsLocationsInstancesVulnerabilityReportsGet(name: string): Promise<VulnerabilityReport>

[src]

Gets the vulnerability report for the specified VM instance. Only VMs with inventory data have vulnerability reports associated with them.

@param name

Required. API resource name for vulnerability resource. Format: projects/{project}/locations/{location}/instances/{instance}/vulnerabilityReport For {project}, either project-number or project-id can be provided. For {instance}, either Compute Engine instance-id or instance-name can be provided.

projectsLocationsInstancesVulnerabilityReportsList(parent: string, opts?: ProjectsLocationsInstancesVulnerabilityReportsListOptions): Promise<ListVulnerabilityReportsResponse>

[src]

List vulnerability reports for all VM instances in the specified zone.

@param parent

Required. The parent resource name. Format: projects/{project}/locations/{location}/instances/- For {project}, either project-number or project-id can be provided.

projectsLocationsOsPolicyAssignmentsCreate(parent: string, req: OSPolicyAssignment, opts?: ProjectsLocationsOsPolicyAssignmentsCreateOptions): Promise<Operation>

[src]

Create an OS policy assignment. This method also creates the first revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

@param parent

Required. The parent resource name in the form: projects/{project}/locations/{location}. Note: Specify the zone of your VMs as the location.

projectsLocationsOsPolicyAssignmentsDelete(name: string): Promise<Operation>

[src]

Delete the OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. If the LRO completes and is not cancelled, all revisions associated with the OS policy assignment are deleted. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

@param name

Required. The name of the OS policy assignment to be deleted

projectsLocationsOsPolicyAssignmentsGet(name: string): Promise<OSPolicyAssignment>

[src]

Retrieve an existing OS policy assignment. This method always returns the latest revision. In order to retrieve a previous revision of the assignment, also provide the revision ID in the name parameter.

@param name

Required. The resource name of OS policy assignment. Format: projects/{project}/locations/{location}/osPolicyAssignments/{os_policy_assignment}@{revisionId}

projectsLocationsOsPolicyAssignmentsList(parent: string, opts?: ProjectsLocationsOsPolicyAssignmentsListOptions): Promise<ListOSPolicyAssignmentsResponse>

[src]

List the OS policy assignments under the parent resource. For each OS policy assignment, the latest revision is returned.

@param parent

Required. The parent resource name.

projectsLocationsOsPolicyAssignmentsListRevisions(name: string, opts?: ProjectsLocationsOsPolicyAssignmentsListRevisionsOptions): Promise<ListOSPolicyAssignmentRevisionsResponse>

[src]

List the OS policy assignment revisions for a given OS policy assignment.

@param name

Required. The name of the OS policy assignment to list revisions for.

projectsLocationsOsPolicyAssignmentsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOsPolicyAssignmentsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOsPolicyAssignmentsPatch(name: string, req: OSPolicyAssignment, opts?: ProjectsLocationsOsPolicyAssignmentsPatchOptions): Promise<Operation>

[src]

Update an existing OS policy assignment. This method creates a new revision of the OS policy assignment. This method returns a long running operation (LRO) that contains the rollout details. The rollout can be cancelled by cancelling the LRO. For more information, see Method: projects.locations.osPolicyAssignments.operations.cancel.

@param name

Resource name. Format: projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id} This field is ignored when you create an OS policy assignment.

projectsPatchDeploymentsCreate(parent: string, req: PatchDeployment, opts?: ProjectsPatchDeploymentsCreateOptions): Promise<PatchDeployment>

[src]

Create an OS Config patch deployment.

@param parent

Required. The project to apply this patch deployment to in the form projects/*.

projectsPatchDeploymentsDelete(name: string): Promise<Empty>

[src]

projectsPatchDeploymentsGet(name: string): Promise<PatchDeployment>

[src]

projectsPatchDeploymentsList(parent: string, opts?: ProjectsPatchDeploymentsListOptions): Promise<ListPatchDeploymentsResponse>

[src]

Get a page of OS Config patch deployments.

@param parent

Required. The resource name of the parent in the form projects/*.

projectsPatchDeploymentsPatch(name: string, req: PatchDeployment, opts?: ProjectsPatchDeploymentsPatchOptions): Promise<PatchDeployment>

[src]

Update an OS Config patch deployment.

@param name

Unique name for the patch deployment resource in a project. The patch deployment name is in the form: projects/{project_id}/patchDeployments/{patch_deployment_id}. This field is ignored when you create a new patch deployment.

projectsPatchDeploymentsPause(name: string, req: PausePatchDeploymentRequest): Promise<PatchDeployment>

[src]

projectsPatchDeploymentsResume(name: string, req: ResumePatchDeploymentRequest): Promise<PatchDeployment>

[src]

projectsPatchJobsCancel(name: string, req: CancelPatchJobRequest): Promise<PatchJob>

[src]

projectsPatchJobsExecute(parent: string, req: ExecutePatchJobRequest): Promise<PatchJob>

[src]

Patch VM instances by creating and running a patch job.

@param parent

Required. The project in which to run this patch in the form projects/*

projectsPatchJobsGet(name: string): Promise<PatchJob>

[src]

projectsPatchJobsInstanceDetailsList(parent: string, opts?: ProjectsPatchJobsInstanceDetailsListOptions): Promise<ListPatchJobInstanceDetailsResponse>

[src]

projectsPatchJobsList(parent: string, opts?: ProjectsPatchJobsListOptions): Promise<ListPatchJobsResponse>

[src]

Get a list of patch jobs.

@param parent

Required. In the form of projects/*