Skip to content

Node.js client for Google Cloud Resource Manager: Hierarchically manage resources by project, folder, and organization.

License

Notifications You must be signed in to change notification settings

praveenqlogic/nodejs-resource

 
 

Repository files navigation

Google Cloud Platform logo

release level CircleCI AppVeyor codecov

Node.js idiomatic client for Cloud Resource Manager API.

Google Cloud Platform provides container resources such as Organizations and Projects, that allow you to group and hierarchically organize other Cloud Platform resources. This hierarchical organization lets you easily manage common aspects of your resources such as access control and configuration settings. The Cloud Resource Manager API enables you to programmatically manage these container resources.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.

    Go to the projects page

  2. Enable billing for your project.

    Enable billing

  3. Enable the Google Cloud Resource Manager API API.

    Enable the API

  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install --save @google-cloud/resource

Using the client library

// Imports the Google Cloud client library
const {Resource} = require('@google-cloud/resource');

// Your Google Cloud Platform project ID
const projectId = 'YOUR_PROJECT_ID';

// Creates a client
const resourceClient = new Resource({
  projectId: projectId,
});

// Lists current projects
resourceClient
  .getProjects()
  .then(results => {
    const projects = results[0];

    console.log('Projects:');
    projects.forEach(project => console.log(project.id));
  })
  .catch(err => {
    console.error('ERROR:', err);
  });

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Sample Source Code Try it
Projects source code Open in Cloud Shell

The Cloud Resource Manager API Node.js Client API Reference documentation also contains samples.

Versioning

This library follows Semantic Versioning.

This library is considered to be in alpha. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

License

Apache Version 2.0

See LICENSE

About

Node.js client for Google Cloud Resource Manager: Hierarchically manage resources by project, folder, and organization.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 83.8%
  • Shell 9.3%
  • JavaScript 4.9%
  • Batchfile 1.5%
  • Python 0.5%