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

157 lines
4.3 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.StoragePool
*
* Provides information about an Incus storage pool.
* See Incus storage pool [configuration reference](https://linuxcontainers.org/incus/docs/main/howto/storage_pools/) for more details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as incus from "@kiterun/incus";
*
* const _this = incus.getStoragePool({
* name: "default",
* });
* export const storagePoolName = _this.then(_this => _this.name);
* ```
*/
export function getStoragePool(args: GetStoragePoolArgs, opts?: pulumi.InvokeOptions): Promise<GetStoragePoolResult> {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invoke("incus:index/getStoragePool:getStoragePool", {
"description": args.description,
"driver": args.driver,
"name": args.name,
"remote": args.remote,
"status": args.status,
"target": args.target,
}, opts);
}
/**
* A collection of arguments for invoking getStoragePool.
*/
export interface GetStoragePoolArgs {
/**
* Description of the storage pool.
*/
description?: string;
/**
* Storage Pool driver.
*/
driver?: string;
/**
* **Required** - Name of the storage pool.
*/
name: string;
/**
* *Optional* - The remote in which the resource was created. If
* not provided, the provider's default remote will be used.
*/
remote?: string;
/**
* Status of the storage pool.
*/
status?: string;
/**
* *Optional* - Specify a target node in a cluster.
*/
target?: string;
}
/**
* A collection of values returned by getStoragePool.
*/
export interface GetStoragePoolResult {
/**
* Map of key/value pairs of config settings.
* [storage pool config settings](https://linuxcontainers.org/incus/docs/main/reference/storage_drivers/)
*/
readonly config: {[key: string]: string};
/**
* Description of the storage pool.
*/
readonly description: string;
/**
* Storage Pool driver.
*/
readonly driver: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly name: string;
readonly remote?: string;
/**
* Status of the storage pool.
*/
readonly status: string;
readonly target?: string;
}
/**
* ## # incus.StoragePool
*
* Provides information about an Incus storage pool.
* See Incus storage pool [configuration reference](https://linuxcontainers.org/incus/docs/main/howto/storage_pools/) for more details.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as incus from "@kiterun/incus";
*
* const _this = incus.getStoragePool({
* name: "default",
* });
* export const storagePoolName = _this.then(_this => _this.name);
* ```
*/
export function getStoragePoolOutput(args: GetStoragePoolOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStoragePoolResult> {
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
return pulumi.runtime.invokeOutput("incus:index/getStoragePool:getStoragePool", {
"description": args.description,
"driver": args.driver,
"name": args.name,
"remote": args.remote,
"status": args.status,
"target": args.target,
}, opts);
}
/**
* A collection of arguments for invoking getStoragePool.
*/
export interface GetStoragePoolOutputArgs {
/**
* Description of the storage pool.
*/
description?: pulumi.Input<string>;
/**
* Storage Pool driver.
*/
driver?: pulumi.Input<string>;
/**
* **Required** - Name of the storage pool.
*/
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>;
/**
* Status of the storage pool.
*/
status?: pulumi.Input<string>;
/**
* *Optional* - Specify a target node in a cluster.
*/
target?: pulumi.Input<string>;
}