Files
pulumi-incus/sdk/nodejs/getProject.ts
2025-12-08 10:47:09 -05:00

116 lines
3.1 KiB
TypeScript
Generated

// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as utilities from "./utilities";
/**
* ## # incus.Project
*
* Provides information about an Incus project.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as incus from "@kiterun/incus";
*
* const _this = incus.getProject({
* name: "default",
* });
* export const projectName = _this.then(_this => _this.name);
* ```
*/
export function getProject(args: GetProjectArgs, opts?: pulumi.InvokeOptions): Promise<GetProjectResult> {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("incus:index/getProject:getProject", {
"description": args.description,
"name": args.name,
"remote": args.remote,
}, opts);
}
/**
* A collection of arguments for invoking getProject.
*/
export interface GetProjectArgs {
/**
* Description of the project.
*/
description?: string;
/**
* **Required** - Name of the project.
*/
name: string;
/**
* *Optional* - The remote in which the resource was created. If
* not provided, the provider's default remote will be used.
*/
remote?: string;
}
/**
* A collection of values returned by getProject.
*/
export interface GetProjectResult {
/**
* Map of key/value pairs of config settings.
* [instance config settings](https://linuxcontainers.org/incus/docs/main/reference/instance_options/)
*/
readonly config: {[key: string]: string};
/**
* Description of the project.
*/
readonly description: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name: string;
readonly remote?: string;
}
/**
* ## # incus.Project
*
* Provides information about an Incus project.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as incus from "@kiterun/incus";
*
* const _this = incus.getProject({
* name: "default",
* });
* export const projectName = _this.then(_this => _this.name);
* ```
*/
export function getProjectOutput(args: GetProjectOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetProjectResult> {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("incus:index/getProject:getProject", {
"description": args.description,
"name": args.name,
"remote": args.remote,
}, opts);
}
/**
* A collection of arguments for invoking getProject.
*/
export interface GetProjectOutputArgs {
/**
* Description of the project.
*/
description?: pulumi.Input<string>;
/**
* **Required** - Name of the project.
*/
name: pulumi.Input<string>;
/**
* *Optional* - The remote in which the resource was created. If
* not provided, the provider's default remote will be used.
*/
remote?: pulumi.Input<string>;
}