Stay organized with collections Save and categorize content based on your preferences.

Google Cloud Resource Manager API: Node.js Client

release level npm version

Cloud Resource Manager Client Library for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

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.
  2. Enable billing for your project.
  3. Enable the Google Cloud Resource Manager API 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 @google-cloud/resource-manager

Using the client library

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

// Creates a client
const client = new ProjectsClient();

async function quickstart() {
  // Lists current projects
  const projects = client.searchProjectsAsync();
  console.log('Projects:');
  for await (const project of projects) {
    console.info(project);
  }
}
quickstart();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Folders.create_foldersource codeOpen in Cloud Shell
Folders.delete_foldersource codeOpen in Cloud Shell
Folders.get_foldersource codeOpen in Cloud Shell
Folders.get_iam_policysource codeOpen in Cloud Shell
Folders.list_folderssource codeOpen in Cloud Shell
Folders.move_foldersource codeOpen in Cloud Shell
Folders.search_folderssource codeOpen in Cloud Shell
Folders.set_iam_policysource codeOpen in Cloud Shell
Folders.test_iam_permissionssource codeOpen in Cloud Shell
Folders.undelete_foldersource codeOpen in Cloud Shell
Folders.update_foldersource codeOpen in Cloud Shell
Organizations.get_iam_policysource codeOpen in Cloud Shell
Organizations.get_organizationsource codeOpen in Cloud Shell
Organizations.search_organizationssource codeOpen in Cloud Shell
Organizations.set_iam_policysource codeOpen in Cloud Shell
Organizations.test_iam_permissionssource codeOpen in Cloud Shell
Projects.create_projectsource codeOpen in Cloud Shell
Projects.delete_projectsource codeOpen in Cloud Shell
Projects.get_iam_policysource codeOpen in Cloud Shell
Projects.get_projectsource codeOpen in Cloud Shell
Projects.list_projectssource codeOpen in Cloud Shell
Projects.move_projectsource codeOpen in Cloud Shell
Projects.search_projectssource codeOpen in Cloud Shell
Projects.set_iam_policysource codeOpen in Cloud Shell
Projects.test_iam_permissionssource codeOpen in Cloud Shell
Projects.undelete_projectsource codeOpen in Cloud Shell
Projects.update_projectsource codeOpen in Cloud Shell
Tag_bindings.create_tag_bindingsource codeOpen in Cloud Shell
Tag_bindings.delete_tag_bindingsource codeOpen in Cloud Shell
Tag_bindings.list_tag_bindingssource codeOpen in Cloud Shell
Tag_keys.create_tag_keysource codeOpen in Cloud Shell
Tag_keys.delete_tag_keysource codeOpen in Cloud Shell
Tag_keys.get_iam_policysource codeOpen in Cloud Shell
Tag_keys.get_tag_keysource codeOpen in Cloud Shell
Tag_keys.list_tag_keyssource codeOpen in Cloud Shell
Tag_keys.set_iam_policysource codeOpen in Cloud Shell
Tag_keys.test_iam_permissionssource codeOpen in Cloud Shell
Tag_keys.update_tag_keysource codeOpen in Cloud Shell
Tag_values.create_tag_valuesource codeOpen in Cloud Shell
Tag_values.delete_tag_valuesource codeOpen in Cloud Shell
Tag_values.get_iam_policysource codeOpen in Cloud Shell
Tag_values.get_tag_valuesource codeOpen in Cloud Shell
Tag_values.list_tag_valuessource codeOpen in Cloud Shell
Tag_values.set_iam_policysource codeOpen in Cloud Shell
Tag_values.test_iam_permissionssource codeOpen in Cloud Shell
Tag_values.update_tag_valuesource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Sample.testsource codeOpen in Cloud Shell

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

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/resource-manager@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE