@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
80 lines (79 loc) • 2.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@pulumi/netbox";
*
* // Assumes the corresponding site groups exist
* const getByName = netbox.dcim.getSiteGroup({
* name: "example-sitegroup-1",
* });
* const getBySlug = netbox.dcim.getSiteGroup({
* slug: "sitegrp",
* });
* ```
*/
export declare function getSiteGroup(args?: GetSiteGroupArgs, opts?: pulumi.InvokeOptions): Promise<GetSiteGroupResult>;
/**
* A collection of arguments for invoking getSiteGroup.
*/
export interface GetSiteGroupArgs {
/**
* At least one of `name` or `slug` must be given.
*/
name?: string;
/**
* At least one of `name` or `slug` must be given.
*/
slug?: string;
}
/**
* A collection of values returned by getSiteGroup.
*/
export interface GetSiteGroupResult {
readonly description: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* At least one of `name` or `slug` must be given.
*/
readonly name: string;
/**
* At least one of `name` or `slug` must be given.
*/
readonly slug: string;
}
/**
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@pulumi/netbox";
*
* // Assumes the corresponding site groups exist
* const getByName = netbox.dcim.getSiteGroup({
* name: "example-sitegroup-1",
* });
* const getBySlug = netbox.dcim.getSiteGroup({
* slug: "sitegrp",
* });
* ```
*/
export declare function getSiteGroupOutput(args?: GetSiteGroupOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSiteGroupResult>;
/**
* A collection of arguments for invoking getSiteGroup.
*/
export interface GetSiteGroupOutputArgs {
/**
* At least one of `name` or `slug` must be given.
*/
name?: pulumi.Input<string>;
/**
* At least one of `name` or `slug` must be given.
*/
slug?: pulumi.Input<string>;
}