pulumi-incus/sdk/nodejs/getNetworkPeer.ts

// *** 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.NetworkPeer
 *
 * Provides information about an Incus network peer.
 * See Incus network peer [configuration reference](https://linuxcontainers.org/incus/docs/main/howto/network_peers/https://linuxcontainers.org/incus/docs/main/howto/network_ovn_peers/) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as incus from "@kiterun/incus";
 *
 * const _this = incus.getNetworkPeer({
 *     name: "default",
 *     network: "parent",
 * });
 * export const networkPeerName = _this.then(_this => _this.name);
 * ```
 */
export function getNetworkPeer(args: GetNetworkPeerArgs, opts?: pulumi.InvokeOptions): Promise<GetNetworkPeerResult> {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("incus:index/getNetworkPeer:getNetworkPeer", {
        "description": args.description,
        "name": args.name,
        "network": args.network,
        "project": args.project,
        "remote": args.remote,
        "status": args.status,
        "targetIntegration": args.targetIntegration,
        "targetNetwork": args.targetNetwork,
        "targetProject": args.targetProject,
        "type": args.type,
    }, opts);
}

/**
 * A collection of arguments for invoking getNetworkPeer.
 */
export interface GetNetworkPeerArgs {
    /**
     * Description of the network peer.
     */
    description?: string;
    /**
     * **Required** - Name of the network peer.
     */
    name: string;
    /**
     * **Required** - Name of the parent network.
     */
    network: string;
    /**
     * *Optional* - Name of the project where the network peer is be stored.
     */
    project?: 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 network peer.
     */
    status?: string;
    /**
     * Target integration for the network peer.
     */
    targetIntegration?: string;
    /**
     * Target network for the network peer.
     */
    targetNetwork?: string;
    /**
     * Target project for the network peer.
     */
    targetProject?: string;
    /**
     * Network peer type.
     */
    type?: string;
}

/**
 * A collection of values returned by getNetworkPeer.
 */
export interface GetNetworkPeerResult {
    /**
     * Map of key/value pairs of config settings.
     */
    readonly config: {[key: string]: string};
    /**
     * Description of the network peer.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name: string;
    readonly network: string;
    readonly project?: string;
    readonly remote?: string;
    /**
     * Status of the network peer.
     */
    readonly status: string;
    /**
     * Target integration for the network peer.
     */
    readonly targetIntegration: string;
    /**
     * Target network for the network peer.
     */
    readonly targetNetwork: string;
    /**
     * Target project for the network peer.
     */
    readonly targetProject: string;
    /**
     * Network peer type.
     */
    readonly type: string;
}
/**
 * ## # incus.NetworkPeer
 *
 * Provides information about an Incus network peer.
 * See Incus network peer [configuration reference](https://linuxcontainers.org/incus/docs/main/howto/network_peers/https://linuxcontainers.org/incus/docs/main/howto/network_ovn_peers/) for more details.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as incus from "@kiterun/incus";
 *
 * const _this = incus.getNetworkPeer({
 *     name: "default",
 *     network: "parent",
 * });
 * export const networkPeerName = _this.then(_this => _this.name);
 * ```
 */
export function getNetworkPeerOutput(args: GetNetworkPeerOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetNetworkPeerResult> {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("incus:index/getNetworkPeer:getNetworkPeer", {
        "description": args.description,
        "name": args.name,
        "network": args.network,
        "project": args.project,
        "remote": args.remote,
        "status": args.status,
        "targetIntegration": args.targetIntegration,
        "targetNetwork": args.targetNetwork,
        "targetProject": args.targetProject,
        "type": args.type,
    }, opts);
}

/**
 * A collection of arguments for invoking getNetworkPeer.
 */
export interface GetNetworkPeerOutputArgs {
    /**
     * Description of the network peer.
     */
    description?: pulumi.Input<string>;
    /**
     * **Required** - Name of the network peer.
     */
    name: pulumi.Input<string>;
    /**
     * **Required** - Name of the parent network.
     */
    network: pulumi.Input<string>;
    /**
     * *Optional* - Name of the project where the network peer is be stored.
     */
    project?: 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 network peer.
     */
    status?: pulumi.Input<string>;
    /**
     * Target integration for the network peer.
     */
    targetIntegration?: pulumi.Input<string>;
    /**
     * Target network for the network peer.
     */
    targetNetwork?: pulumi.Input<string>;
    /**
     * Target project for the network peer.
     */
    targetProject?: pulumi.Input<string>;
    /**
     * Network peer type.
     */
    type?: pulumi.Input<string>;
}