Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/osconfig:v2.ts";

§Classes

GoogleAuth
OSConfig

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

§Variables

auth

§Interfaces

CancelOperationRequest

The request message for Operations.CancelOperation.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

Empty

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

FixedOrPercent

Message encapsulating a value that can be either absolute ("fixed") or relative ("percent") to a value.

FoldersLocationsGlobalPolicyOrchestratorsCreateOptions

Additional options for OSConfig#foldersLocationsGlobalPolicyOrchestratorsCreate.

FoldersLocationsGlobalPolicyOrchestratorsDeleteOptions

Additional options for OSConfig#foldersLocationsGlobalPolicyOrchestratorsDelete.

FoldersLocationsGlobalPolicyOrchestratorsListOptions

Additional options for OSConfig#foldersLocationsGlobalPolicyOrchestratorsList.

FoldersLocationsGlobalPolicyOrchestratorsPatchOptions

Additional options for OSConfig#foldersLocationsGlobalPolicyOrchestratorsPatch.

FoldersLocationsOperationsListOptions

Additional options for OSConfig#foldersLocationsOperationsList.

GoogleCloudOsconfigV1__OSPolicyAssignmentOperationMetadata

OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.

GoogleCloudOsconfigV2__ListPolicyOrchestratorsResponse

Response for the list policy orchestrator resources.

GoogleCloudOsconfigV2__OperationMetadata

Represents the metadata of the long-running operation.

GoogleCloudOsconfigV2__OrchestratedResource

Represents a resource that is being orchestrated by the policy orchestrator.

GoogleCloudOsconfigV2__OrchestrationScope

Defines a set of selectors which drive which resources are in scope of policy orchestration.

GoogleCloudOsconfigV2__PolicyOrchestrator

PolicyOrchestrator helps managing project+zone level policy resources (e.g. OS Policy Assignments), by providing tools to create, update and delete them across projects and locations, at scale. Policy orchestrator functions as an endless loop. Each iteration orchestrator computes a set of resources that should be affected, then progressively applies changes to them. If for some reason this set of resources changes over time (e.g. new projects are added), the future loop iterations will address that. Orchestrator can either upsert or delete policy resources. For more details, see the description of the action, and orchestrated_resource fields. Note that policy orchestrator do not "manage" the resources it creates. Every iteration is independent and only minimal history of past actions is retained (apart from Cloud Logging). If orchestrator gets deleted, it does not affect the resources it created in the past. Those will remain where they were. Same applies if projects are removed from the orchestrator's scope.

GoogleCloudOsconfigV2_OrchestrationScope_LocationSelector

Selector containing locations in scope.

GoogleCloudOsconfigV2_OrchestrationScope_ResourceHierarchySelector

Selector containing Cloud Resource Manager resource hierarchy nodes.

GoogleCloudOsconfigV2_OrchestrationScope_Selector

Selector for the resources in scope of orchestration.

GoogleCloudOsconfigV2_PolicyOrchestrator_IterationState

Describes the state of a single iteration of the orchestrator.

GoogleCloudOsconfigV2_PolicyOrchestrator_OrchestrationState

Describes the state of the orchestration process.

GoogleCloudOsconfigV2beta__OperationMetadata

Represents the metadata of the long-running operation.

ListOperationsResponse

The response message for Operations.ListOperations.

Operation

This resource represents a long-running operation that is the result of a network API call.

OrganizationsLocationsGlobalPolicyOrchestratorsCreateOptions

Additional options for OSConfig#organizationsLocationsGlobalPolicyOrchestratorsCreate.

OrganizationsLocationsGlobalPolicyOrchestratorsDeleteOptions

Additional options for OSConfig#organizationsLocationsGlobalPolicyOrchestratorsDelete.

OrganizationsLocationsGlobalPolicyOrchestratorsListOptions

Additional options for OSConfig#organizationsLocationsGlobalPolicyOrchestratorsList.

OrganizationsLocationsGlobalPolicyOrchestratorsPatchOptions

Additional options for OSConfig#organizationsLocationsGlobalPolicyOrchestratorsPatch.

OrganizationsLocationsOperationsListOptions

Additional options for OSConfig#organizationsLocationsOperationsList.

OSPolicy

An OS policy defines the desired state configuration for a VM.

OSPolicyAssignment

OS policy assignment is an API resource that is used to apply a set of OS policies to a dynamically targeted group of Compute Engine VM instances. An OS policy is used to define the desired state configuration for a Compute Engine VM instance through a set of configuration resources that provide capabilities such as installing or removing software packages, or executing a script. For more information about the OS policy resource definitions and examples, see OS policy and OS policy assignment.

OSPolicyAssignmentInstanceFilter

Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them.

OSPolicyAssignmentInstanceFilterInventory

VM inventory details.

OSPolicyAssignmentLabelSet

Message representing label set. * A label is a key value pair set for a VM.

  • A LabelSet is a set of labels. * Labels within a LabelSet are ANDed. In other words, a LabelSet is applicable for a VM only if it matches all the labels in the LabelSet. * Example: A LabelSet with 2 labels: env=prod and type=webserver will only be applicable for those VMs with both labels present.
OSPolicyAssignmentOperationMetadata

OS policy assignment operation metadata provided by OS policy assignment API methods that return long running operations.

OSPolicyAssignmentRollout

Message to configure the rollout at the zonal level for the OS policy assignment.

OSPolicyInventoryFilter

Filtering criteria to select VMs based on inventory details.

OSPolicyResource

An OS policy resource is used to define the desired state configuration and provides a specific functionality like installing/removing packages, executing a script etc. The system ensures that resources are always in their desired state by taking necessary actions if they have drifted from their desired state.

OSPolicyResourceExecResource

A resource that allows executing scripts on the VM. The ExecResource has 2 stages: validate and enforce and both stages accept a script as an argument to execute. When the ExecResource is applied by the agent, it first executes the script in the validate stage. The validate stage can signal that the ExecResource is already in the desired state by returning an exit code of 100. If the ExecResource is not in the desired state, it should return an exit code of 101. Any other exit code returned by this stage is considered an error. If the ExecResource is not in the desired state based on the exit code from the validate stage, the agent proceeds to execute the script from the enforce stage. If the ExecResource is already in the desired state, the enforce stage will not be run. Similar to validate stage, the enforce stage should return an exit code of 100 to indicate that the resource in now in its desired state. Any other exit code is considered an error. NOTE: An exit code of 100 was chosen over 0 (and 101 vs 1) to have an explicit indicator of in desired state, not in desired state and errors. Because, for example, Powershell will always return an exit code of 0 unless an exit statement is provided in the script. So, for reasons of consistency and being explicit, exit codes 100 and 101 were chosen.

OSPolicyResourceExecResourceExec

A file or script to execute.

OSPolicyResourceFile

A remote or local file.

OSPolicyResourceFileGcs

Specifies a file available as a Cloud Storage Object.

OSPolicyResourceFileRemote

Specifies a file available via some URI.

OSPolicyResourceFileResource

A resource that manages the state of a file.

OSPolicyResourceGroup

Resource groups provide a mechanism to group OS policy resources. Resource groups enable OS policy authors to create a single OS policy to be applied to VMs running different operating Systems. When the OS policy is applied to a target VM, the appropriate resource group within the OS policy is selected based on the OSFilter specified within the resource group.

OSPolicyResourcePackageResource

A resource that manages a system package.

OSPolicyResourcePackageResourceAPT

A package managed by APT. - install: apt-get update && apt-get -y install [name] - remove: apt-get -y remove [name]

OSPolicyResourcePackageResourceDeb

A deb package file. dpkg packages only support INSTALLED state.

OSPolicyResourcePackageResourceGooGet

A package managed by GooGet. - install: googet -noconfirm install package

  • remove: googet -noconfirm remove package
OSPolicyResourcePackageResourceMSI

An MSI package. MSI packages only support INSTALLED state.

OSPolicyResourcePackageResourceRPM

An RPM package file. RPM packages only support INSTALLED state.

OSPolicyResourcePackageResourceYUM

A package managed by YUM. - install: yum -y install package - remove: yum -y remove package

OSPolicyResourcePackageResourceZypper

A package managed by Zypper. - install: zypper -y install package - remove: zypper -y rm package

OSPolicyResourceRepositoryResource

A resource that manages a package repository.

OSPolicyResourceRepositoryResourceAptRepository

Represents a single apt package repository. These will be added to a repo file that will be managed at /etc/apt/sources.list.d/google_osconfig.list.

OSPolicyResourceRepositoryResourceGooRepository

Represents a Goo package repository. These are added to a repo file that is managed at C:/ProgramData/GooGet/repos/google_osconfig.repo.

OSPolicyResourceRepositoryResourceYumRepository

Represents a single yum package repository. These are added to a repo file that is managed at /etc/yum.repos.d/google_osconfig.repo.

OSPolicyResourceRepositoryResourceZypperRepository

Represents a single zypper package repository. These are added to a repo file that is managed at /etc/zypp/repos.d/google_osconfig.repo.

ProjectsLocationsGlobalPolicyOrchestratorsCreateOptions

Additional options for OSConfig#projectsLocationsGlobalPolicyOrchestratorsCreate.

ProjectsLocationsGlobalPolicyOrchestratorsDeleteOptions

Additional options for OSConfig#projectsLocationsGlobalPolicyOrchestratorsDelete.

ProjectsLocationsGlobalPolicyOrchestratorsListOptions

Additional options for OSConfig#projectsLocationsGlobalPolicyOrchestratorsList.

ProjectsLocationsGlobalPolicyOrchestratorsPatchOptions

Additional options for OSConfig#projectsLocationsGlobalPolicyOrchestratorsPatch.

ProjectsLocationsOperationsListOptions

Additional options for OSConfig#projectsLocationsOperationsList.

Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.