@google-cloud/resource-manager

What is @google-cloud/resource-manager?

@google-cloud/resource-manager is a Node.js client library for Google Cloud Resource Manager. It allows you to programmatically manage Google Cloud resources such as projects, folders, and organizations. This package provides a way to create, update, delete, and retrieve metadata about these resources.

What are @google-cloud/resource-manager's main functionalities?

Create a Project

This feature allows you to create a new Google Cloud project programmatically. The code sample demonstrates how to use the ResourceManagerClient to create a project with a specified name and project ID.

const {ResourceManagerClient} = require('@google-cloud/resource-manager');
const client = new ResourceManagerClient();

async function createProject() {
  const [operation] = await client.createProject({
    project: {
      name: 'my-new-project',
      projectId: 'my-new-project-id'
    }
  });
  const [response] = await operation.promise();
  console.log('Project created:', response);
}

createProject().catch(console.error);

List Projects

This feature allows you to list all the projects under your Google Cloud account. The code sample demonstrates how to use the ResourceManagerClient to retrieve and print a list of projects.

const {ResourceManagerClient} = require('@google-cloud/resource-manager');
const client = new ResourceManagerClient();

async function listProjects() {
  const [projects] = await client.listProjects();
  projects.forEach(project => console.log(project));
}

listProjects().catch(console.error);

Get Project Details

This feature allows you to retrieve details of a specific project by its project ID. The code sample demonstrates how to use the ResourceManagerClient to get and print the details of a specified project.

const {ResourceManagerClient} = require('@google-cloud/resource-manager');
const client = new ResourceManagerClient();

async function getProjectDetails(projectId) {
  const [project] = await client.getProject({projectId});
  console.log('Project details:', project);
}

getProjectDetails('my-project-id').catch(console.error);

Delete a Project

This feature allows you to delete a specific project by its project ID. The code sample demonstrates how to use the ResourceManagerClient to delete a specified project.

const {ResourceManagerClient} = require('@google-cloud/resource-manager');
const client = new ResourceManagerClient();

async function deleteProject(projectId) {
  const [operation] = await client.deleteProject({projectId});
  await operation.promise();
  console.log('Project deleted:', projectId);
}

deleteProject('my-project-id').catch(console.error);

Other packages similar to @google-cloud/resource-manager

aws-sdk

The aws-sdk package is the official AWS SDK for JavaScript, which allows you to interact with various AWS services including resource management. It provides similar functionalities for managing AWS resources such as creating, listing, and deleting projects, but it is specific to AWS rather than Google Cloud.

azure-arm-resource

The azure-arm-resource package is the Azure SDK for managing Azure resources. It provides functionalities similar to @google-cloud/resource-manager but for Azure, allowing you to create, update, delete, and list Azure resources such as resource groups and deployments.

gcloud

The gcloud package is a comprehensive client library for Google Cloud Platform services. While it includes resource management functionalities, it also covers a wide range of other Google Cloud services, making it a more general-purpose library compared to the more focused @google-cloud/resource-manager.

README

Google Cloud Resource Manager API: Node.js Client

Cloud Resource Manager Client Library for Node.js

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

• Google Cloud Resource Manager API Node.js Client API Reference
• Google Cloud Resource Manager API Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-resourcemanager

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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.

Sample	Source Code	Try it
Folders.create_folder	source code
Folders.delete_folder	source code
Folders.get_folder	source code
Folders.get_iam_policy	source code
Folders.list_folders	source code
Folders.move_folder	source code
Folders.search_folders	source code
Folders.set_iam_policy	source code
Folders.test_iam_permissions	source code
Folders.undelete_folder	source code
Folders.update_folder	source code
Organizations.get_iam_policy	source code
Organizations.get_organization	source code
Organizations.search_organizations	source code
Organizations.set_iam_policy	source code
Organizations.test_iam_permissions	source code
Projects.create_project	source code
Projects.delete_project	source code
Projects.get_iam_policy	source code
Projects.get_project	source code
Projects.list_projects	source code
Projects.move_project	source code
Projects.search_projects	source code
Projects.set_iam_policy	source code
Projects.test_iam_permissions	source code
Projects.undelete_project	source code
Projects.update_project	source code
Tag_bindings.create_tag_binding	source code
Tag_bindings.delete_tag_binding	source code
Tag_bindings.list_effective_tags	source code
Tag_bindings.list_tag_bindings	source code
Tag_holds.create_tag_hold	source code
Tag_holds.delete_tag_hold	source code
Tag_holds.list_tag_holds	source code
Tag_keys.create_tag_key	source code
Tag_keys.delete_tag_key	source code
Tag_keys.get_iam_policy	source code
Tag_keys.get_namespaced_tag_key	source code
Tag_keys.get_tag_key	source code
Tag_keys.list_tag_keys	source code
Tag_keys.set_iam_policy	source code
Tag_keys.test_iam_permissions	source code
Tag_keys.update_tag_key	source code
Tag_values.create_tag_value	source code
Tag_values.delete_tag_value	source code
Tag_values.get_iam_policy	source code
Tag_values.get_namespaced_tag_value	source code
Tag_values.get_tag_value	source code
Tag_values.list_tag_values	source code
Tag_values.set_iam_policy	source code
Tag_values.test_iam_permissions	source code
Tag_values.update_tag_value	source code
Quickstart	source code

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