@pulumi/vsphere
Version:
A Pulumi package for creating vsphere resources
122 lines (121 loc) • 3.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides a VMware vSphere license resource. This can be used to add and remove license keys.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as vsphere from "@pulumi/vsphere";
*
* const licenseKey = new vsphere.License("licenseKey", {
* licenseKey: "00000-00000-00000-00000-00000",
* labels: {
* VpxClientLicenseLabel: "example",
* },
* });
* ```
*/
export declare class License extends pulumi.CustomResource {
/**
* Get an existing License 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?: LicenseState, opts?: pulumi.CustomResourceOptions): License;
/**
* Returns true if the given object is an instance of License. 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 License;
/**
* The product edition of the license key.
*/
readonly editionKey: pulumi.Output<string>;
/**
* A map of labels to be applied to the license key.
*
* > **NOTE:** Labels are not allowed for unmanaged ESX hosts.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The license key value.
*/
readonly licenseKey: pulumi.Output<string>;
/**
* The display name for the license key.
*/
readonly name: pulumi.Output<string>;
/**
* The total number of units contained in the license key.
*/
readonly total: pulumi.Output<number>;
/**
* The number of units assigned to this license key.
*/
readonly used: pulumi.Output<number>;
/**
* Create a License 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: LicenseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering License resources.
*/
export interface LicenseState {
/**
* The product edition of the license key.
*/
editionKey?: pulumi.Input<string>;
/**
* A map of labels to be applied to the license key.
*
* > **NOTE:** Labels are not allowed for unmanaged ESX hosts.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The license key value.
*/
licenseKey?: pulumi.Input<string>;
/**
* The display name for the license key.
*/
name?: pulumi.Input<string>;
/**
* The total number of units contained in the license key.
*/
total?: pulumi.Input<number>;
/**
* The number of units assigned to this license key.
*/
used?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a License resource.
*/
export interface LicenseArgs {
/**
* A map of labels to be applied to the license key.
*
* > **NOTE:** Labels are not allowed for unmanaged ESX hosts.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The license key value.
*/
licenseKey: pulumi.Input<string>;
}