GCP.OSConfig reference

FoldersLocationsGlobalPolicyOrchestrator

Source: src/GCP/OSConfig/FoldersLocationsGlobalPolicyOrchestrator.ts

A folder-scoped OS Config policy orchestrator.

Policy orchestrators upsert or delete OS policy assignments across descendant projects and zones. folderId and policyOrchestratorId are identity. Action, state, description, labels, the orchestrated payload, and scope update in place.

FoldersLocationsGlobalPolicyOrchestrator: Creating a Policy Orchestrator

Generated name on the project’s parent folder

const orch = yield* GCP.OSConfig.FoldersLocationsGlobalPolicyOrchestrator(
  "Debian",
  { labels: { env: "test" } },
);

Explicit folder and id

const orch = yield* GCP.OSConfig.FoldersLocationsGlobalPolicyOrchestrator(
  "Debian",
  {
    folderId: "123456",
    policyOrchestratorId: "debian-noop",
    state: "STOPPED",
  },
);

OrganizationsLocationsGlobalPolicyOrchestrator

Source: src/GCP/OSConfig/OrganizationsLocationsGlobalPolicyOrchestrator.ts

An organization-scoped OS Config policy orchestrator.

Policy orchestrators upsert or delete OS policy assignments across descendant projects and zones. organizationId and policyOrchestratorId are identity. Action, state, description, labels, the orchestrated payload, and scope update in place.

OrganizationsLocationsGlobalPolicyOrchestrator: Creating a Policy Orchestrator

Generated name on the project’s organization

const orch = yield* GCP.OSConfig.OrganizationsLocationsGlobalPolicyOrchestrator(
  "Debian",
  { labels: { env: "test" } },
);

Explicit organization and id

const orch = yield* GCP.OSConfig.OrganizationsLocationsGlobalPolicyOrchestrator(
  "Debian",
  {
    organizationId: "123456",
    policyOrchestratorId: "debian-noop",
    state: "STOPPED",
  },
);

ProjectsLocationsGlobalPolicyOrchestrator

Source: src/GCP/OSConfig/ProjectsLocationsGlobalPolicyOrchestrator.ts

A project-scoped OS Config policy orchestrator.

Policy orchestrators upsert or delete OS policy assignments across zones in a project. Id is identity — changing policyOrchestratorId replaces the resource. Action, state, description, labels, the orchestrated payload, and scope update in place.

ProjectsLocationsGlobalPolicyOrchestrator: Creating a Policy Orchestrator

Generated name, stopped

const orch = yield* GCP.OSConfig.ProjectsLocationsGlobalPolicyOrchestrator(
  "Debian",
  { labels: { env: "test" } },
);

Explicit id and description

const orch = yield* GCP.OSConfig.ProjectsLocationsGlobalPolicyOrchestrator(
  "Debian",
  {
    policyOrchestratorId: "debian-noop",
    description: "validation only",
    state: "STOPPED",
  },
);

ProjectsLocationsGlobalPolicyOrchestrator: Updating a Policy Orchestrator

const orch = yield* GCP.OSConfig.ProjectsLocationsGlobalPolicyOrchestrator(
  "Debian",
  {
    description: "updated",
    labels: { env: "prod" },
  },
);