@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
79 lines (78 loc) • 1.92 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@pulumi/netbox";
*
* const getByName = netbox.dcim.getSite({
* name: "Example Site 1",
* });
* const getBySlug = netbox.dcim.getSite({
* slug: "example-site-1",
* });
* ```
*/
export declare function getSite(args?: GetSiteArgs, opts?: pulumi.InvokeOptions): Promise<GetSiteResult>;
/**
* A collection of arguments for invoking getSite.
*/
export interface GetSiteArgs {
facility?: string;
/**
* The ID of this resource.
*/
id?: string;
name?: string;
slug?: string;
}
/**
* A collection of values returned by getSite.
*/
export interface GetSiteResult {
readonly asnIds: number[];
readonly comments: string;
readonly description: string;
readonly facility: string;
readonly groupId: number;
/**
* The ID of this resource.
*/
readonly id: string;
readonly name: string;
readonly regionId: number;
readonly siteId: number;
readonly slug: string;
readonly status: string;
readonly tenantId: number;
readonly timeZone: string;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@pulumi/netbox";
*
* const getByName = netbox.dcim.getSite({
* name: "Example Site 1",
* });
* const getBySlug = netbox.dcim.getSite({
* slug: "example-site-1",
* });
* ```
*/
export declare function getSiteOutput(args?: GetSiteOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSiteResult>;
/**
* A collection of arguments for invoking getSite.
*/
export interface GetSiteOutputArgs {
facility?: pulumi.Input<string>;
/**
* The ID of this resource.
*/
id?: pulumi.Input<string>;
name?: pulumi.Input<string>;
slug?: pulumi.Input<string>;
}