@pulumi/digitalocean
Version:
A Pulumi package for creating and managing DigitalOcean cloud resources.
128 lines • 3.93 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getProjectsOutput = exports.getProjects = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
* Retrieve information about all DigitalOcean projects associated with an account, with
* the ability to filter and sort the results. If no filters are specified, all projects
* will be returned.
*
* Note: You can use the `digitalocean.Project` data source to
* obtain metadata about a single project if you already know the `id` to retrieve or the unique
* `name` of the project.
*
* ## Example Usage
*
* Use the `filter` block with a `key` string and `values` list to filter projects.
*
* For example to find all staging environment projects:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const staging = digitalocean.getProjects({
* filters: [{
* key: "environment",
* values: ["Staging"],
* }],
* });
* ```
*
* You can filter on multiple fields and sort the results as well:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const non_default_production = digitalocean.getProjects({
* filters: [
* {
* key: "environment",
* values: ["Production"],
* },
* {
* key: "is_default",
* values: ["false"],
* },
* ],
* sorts: [{
* key: "name",
* direction: "asc",
* }],
* });
* ```
*/
function getProjects(args, opts) {
args = args || {};
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("digitalocean:index/getProjects:getProjects", {
"filters": args.filters,
"sorts": args.sorts,
}, opts);
}
exports.getProjects = getProjects;
/**
* Retrieve information about all DigitalOcean projects associated with an account, with
* the ability to filter and sort the results. If no filters are specified, all projects
* will be returned.
*
* Note: You can use the `digitalocean.Project` data source to
* obtain metadata about a single project if you already know the `id` to retrieve or the unique
* `name` of the project.
*
* ## Example Usage
*
* Use the `filter` block with a `key` string and `values` list to filter projects.
*
* For example to find all staging environment projects:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const staging = digitalocean.getProjects({
* filters: [{
* key: "environment",
* values: ["Staging"],
* }],
* });
* ```
*
* You can filter on multiple fields and sort the results as well:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as digitalocean from "@pulumi/digitalocean";
*
* const non_default_production = digitalocean.getProjects({
* filters: [
* {
* key: "environment",
* values: ["Production"],
* },
* {
* key: "is_default",
* values: ["false"],
* },
* ],
* sorts: [{
* key: "name",
* direction: "asc",
* }],
* });
* ```
*/
function getProjectsOutput(args, opts) {
args = args || {};
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("digitalocean:index/getProjects:getProjects", {
"filters": args.filters,
"sorts": args.sorts,
}, opts);
}
exports.getProjectsOutput = getProjectsOutput;
//# sourceMappingURL=getProjects.js.map