@pulumi/vsphere
Version:
A Pulumi package for creating vsphere resources
124 lines (123 loc) • 3.65 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The `vsphere.getDynamic` data source can be used to get the
* [managed object reference ID][docs-about-morefs] of any tagged managed object in
* vCenter Server by providing a list of tag IDs and an optional regular expression
* to filter objects by name.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vsphere from "@pulumi/vsphere";
*
* const category = vsphere.getTagCategory({
* name: "SomeCategory",
* });
* const tag1 = vsphere.getTag({
* name: "FirstTag",
* categoryId: cat.id,
* });
* const tag2 = vsphere.getTag({
* name: "SecondTag",
* categoryId: cat.id,
* });
* const dyn = Promise.all([tag1, tag1]).then(([tag1, tag11]) => vsphere.getDynamic({
* filters: [
* tag1.id,
* tag11.id,
* ],
* nameRegex: "ubuntu",
* type: "Datacenter",
* }));
* ```
*/
export declare function getDynamic(args: GetDynamicArgs, opts?: pulumi.InvokeOptions): Promise<GetDynamicResult>;
/**
* A collection of arguments for invoking getDynamic.
*/
export interface GetDynamicArgs {
/**
* A list of tag IDs that must be present on an object to
* be a match.
*/
filters: string[];
/**
* A regular expression that will be used to match the
* object's name.
*/
nameRegex?: string;
/**
* The managed object type the returned object must match.
* The managed object types can be found in the managed object type section
* [here](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/).
*/
type?: string;
}
/**
* A collection of values returned by getDynamic.
*/
export interface GetDynamicResult {
readonly filters: string[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
readonly nameRegex?: string;
readonly type?: string;
}
/**
* The `vsphere.getDynamic` data source can be used to get the
* [managed object reference ID][docs-about-morefs] of any tagged managed object in
* vCenter Server by providing a list of tag IDs and an optional regular expression
* to filter objects by name.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vsphere from "@pulumi/vsphere";
*
* const category = vsphere.getTagCategory({
* name: "SomeCategory",
* });
* const tag1 = vsphere.getTag({
* name: "FirstTag",
* categoryId: cat.id,
* });
* const tag2 = vsphere.getTag({
* name: "SecondTag",
* categoryId: cat.id,
* });
* const dyn = Promise.all([tag1, tag1]).then(([tag1, tag11]) => vsphere.getDynamic({
* filters: [
* tag1.id,
* tag11.id,
* ],
* nameRegex: "ubuntu",
* type: "Datacenter",
* }));
* ```
*/
export declare function getDynamicOutput(args: GetDynamicOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDynamicResult>;
/**
* A collection of arguments for invoking getDynamic.
*/
export interface GetDynamicOutputArgs {
/**
* A list of tag IDs that must be present on an object to
* be a match.
*/
filters: pulumi.Input<pulumi.Input<string>[]>;
/**
* A regular expression that will be used to match the
* object's name.
*/
nameRegex?: pulumi.Input<string>;
/**
* The managed object type the returned object must match.
* The managed object types can be found in the managed object type section
* [here](https://developer.broadcom.com/xapis/vsphere-web-services-api/latest/).
*/
type?: pulumi.Input<string>;
}