@natzka-oss/pulumi-netbox
Version:
A Pulumi package for creating and managing Netbox cloud resources.
85 lines (84 loc) • 4.01 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* From the [official documentation](https://docs.netbox.dev/en/stable/features/circuits/#circuits_1):
*
* > A communications circuit represents a single physical link connecting exactly two endpoints, commonly referred to as its A and Z terminations. A circuit in NetBox may have zero, one, or two terminations defined. It is common to have only one termination defined when you don't necessarily care about the details of the provider side of the circuit, e.g. for Internet access circuits. Both terminations would likely be modeled for circuits which connect one customer site to another.
* >
* > Each circuit is associated with a provider and a user-defined type. For example, you might have Internet access circuits delivered to each site by one provider, and private MPLS circuits delivered by another. Each circuit must be assigned a circuit ID, each of which must be unique per provider.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as netbox from "@natzka-oss/pulumi-netbox";
*
* const test = new netbox.tenancy.Tenant("test", {name: "test"});
* const testCircuitProvider = new netbox.circuit.CircuitProvider("test", {name: "test"});
* const testCircuitType = new netbox.circuit.CircuitType("test", {name: "test"});
* const testCircuit = new netbox.circuit.Circuit("test", {
* cid: "test",
* status: "active",
* providerId: testCircuitProvider.id,
* typeId: testCircuitType.id,
* });
* ```
*/
export declare class Circuit extends pulumi.CustomResource {
/**
* Get an existing Circuit resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: CircuitState, opts?: pulumi.CustomResourceOptions): Circuit;
/**
* Returns true if the given object is an instance of Circuit. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Circuit;
readonly cid: pulumi.Output<string>;
readonly providerId: pulumi.Output<number>;
/**
* Valid values are `planned`, `provisioning`, `active`, `offline`, `deprovisioning` and `decommissioning`.
*/
readonly status: pulumi.Output<string>;
readonly tenantId: pulumi.Output<number | undefined>;
readonly typeId: pulumi.Output<number>;
/**
* Create a Circuit resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: CircuitArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Circuit resources.
*/
export interface CircuitState {
cid?: pulumi.Input<string>;
providerId?: pulumi.Input<number>;
/**
* Valid values are `planned`, `provisioning`, `active`, `offline`, `deprovisioning` and `decommissioning`.
*/
status?: pulumi.Input<string>;
tenantId?: pulumi.Input<number>;
typeId?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a Circuit resource.
*/
export interface CircuitArgs {
cid: pulumi.Input<string>;
providerId: pulumi.Input<number>;
/**
* Valid values are `planned`, `provisioning`, `active`, `offline`, `deprovisioning` and `decommissioning`.
*/
status: pulumi.Input<string>;
tenantId?: pulumi.Input<number>;
typeId: pulumi.Input<number>;
}