@pulumi/hcloud/getStorageBoxSubaccount.d.ts

A Pulumi package for creating and managing hcloud cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Provides details about a Hetzner Storage Box Subaccount.
 *
 * See the [Storage Box Subaccounts API documentation](https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccounts) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as hcloud from "@pulumi/hcloud";
 *
 * const config = new pulumi.Config();
 * const storageBoxId = config.requireObject<any>("storageBoxId");
 * const byId = hcloud.getStorageBoxSubaccount({
 *     storageBoxId: Number(storageBoxId),
 *     id: 2,
 * });
 * const byName = hcloud.getStorageBoxSubaccount({
 *     storageBoxId: Number(storageBoxId),
 *     name: "badger",
 * });
 * const byUsername = hcloud.getStorageBoxSubaccount({
 *     storageBoxId: Number(storageBoxId),
 *     username: "u507137-sub1",
 * });
 * const byLabelSelector = hcloud.getStorageBoxSubaccount({
 *     storageBoxId: Number(storageBoxId),
 *     withSelector: "team=billing",
 * });
 * ```
 */
export declare function getStorageBoxSubaccount(args: GetStorageBoxSubaccountArgs, opts?: pulumi.InvokeOptions): Promise<GetStorageBoxSubaccountResult>;
/**
 * A collection of arguments for invoking getStorageBoxSubaccount.
 */
export interface GetStorageBoxSubaccountArgs {
    /**
     * ID of the Storage Box Subaccount.
     */
    id?: number;
    /**
     * Name of the Storage Box Subaccount.
     */
    name?: string;
    /**
     * ID of the Storage Box.
     */
    storageBoxId: number;
    /**
     * Username of the Storage Box Subaccount.
     */
    username?: string;
    /**
     * Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/hetzner#label-selector).
     */
    withSelector?: string;
}
/**
 * A collection of values returned by getStorageBoxSubaccount.
 */
export interface GetStorageBoxSubaccountResult {
    /**
     * Access settings for the Subaccount.
     */
    readonly accessSettings: outputs.GetStorageBoxSubaccountAccessSettings;
    /**
     * Description of the Storage Box Subaccount.
     */
    readonly description: string;
    /**
     * Home directory of the Storage Box Subaccount.
     */
    readonly homeDirectory: string;
    /**
     * ID of the Storage Box Subaccount.
     */
    readonly id: number;
    /**
     * User-defined [labels](https://docs.hetzner.cloud/reference/cloud#labels) (key-value pairs) for the resource.
     */
    readonly labels: {
        [key: string]: string;
    };
    /**
     * Name of the Storage Box Subaccount.
     */
    readonly name: string;
    /**
     * FQDN of the Storage Box Subaccount.
     */
    readonly server: string;
    /**
     * ID of the Storage Box.
     */
    readonly storageBoxId: number;
    /**
     * Username of the Storage Box Subaccount.
     */
    readonly username: string;
    /**
     * Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/hetzner#label-selector).
     */
    readonly withSelector?: string;
}
/**
 * Provides details about a Hetzner Storage Box Subaccount.
 *
 * See the [Storage Box Subaccounts API documentation](https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccounts) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as hcloud from "@pulumi/hcloud";
 *
 * const config = new pulumi.Config();
 * const storageBoxId = config.requireObject<any>("storageBoxId");
 * const byId = hcloud.getStorageBoxSubaccount({
 *     storageBoxId: Number(storageBoxId),
 *     id: 2,
 * });
 * const byName = hcloud.getStorageBoxSubaccount({
 *     storageBoxId: Number(storageBoxId),
 *     name: "badger",
 * });
 * const byUsername = hcloud.getStorageBoxSubaccount({
 *     storageBoxId: Number(storageBoxId),
 *     username: "u507137-sub1",
 * });
 * const byLabelSelector = hcloud.getStorageBoxSubaccount({
 *     storageBoxId: Number(storageBoxId),
 *     withSelector: "team=billing",
 * });
 * ```
 */
export declare function getStorageBoxSubaccountOutput(args: GetStorageBoxSubaccountOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetStorageBoxSubaccountResult>;
/**
 * A collection of arguments for invoking getStorageBoxSubaccount.
 */
export interface GetStorageBoxSubaccountOutputArgs {
    /**
     * ID of the Storage Box Subaccount.
     */
    id?: pulumi.Input<number | undefined>;
    /**
     * Name of the Storage Box Subaccount.
     */
    name?: pulumi.Input<string | undefined>;
    /**
     * ID of the Storage Box.
     */
    storageBoxId: pulumi.Input<number>;
    /**
     * Username of the Storage Box Subaccount.
     */
    username?: pulumi.Input<string | undefined>;
    /**
     * Filter results using a [Label Selector](https://docs.hetzner.cloud/reference/hetzner#label-selector).
     */
    withSelector?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=getStorageBoxSubaccount.d.ts.map