@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 7.31 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* A pool of Virtual Machines.
*
* Uses Azure REST API version 2024-02-01. In version 2.x of the Azure Native provider, it used API version 2023-04-01.
*
* Other available API versions: 2023-04-01, 2023-08-01-preview, 2023-10-01-preview, 2024-05-01-preview, 2024-06-01-preview, 2024-07-01-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-02-01, 2025-04-01-preview, 2025-07-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native devcenter [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Pool extends pulumi.CustomResource {
/**
* Get an existing Pool 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Pool;
/**
* Returns true if the given object is an instance of Pool. 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 Pool;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Indicates the number of provisioned Dev Boxes in this pool.
*/
readonly devBoxCount: pulumi.Output<number>;
/**
* Name of a Dev Box definition in parent Project of this Pool
*/
readonly devBoxDefinitionName: pulumi.Output<string>;
/**
* The display name of the pool.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.
*/
readonly healthStatus: pulumi.Output<string>;
/**
* Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state
*/
readonly healthStatusDetails: pulumi.Output<outputs.devcenter.HealthStatusDetailResponse[]>;
/**
* Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
*/
readonly licenseType: pulumi.Output<string>;
/**
* Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
*/
readonly localAdministrator: pulumi.Output<string>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The regions of the managed virtual network (required when managedNetworkType is Managed).
*/
readonly managedVirtualNetworkRegions: pulumi.Output<string[] | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Name of a Network Connection in parent Project of this Pool
*/
readonly networkConnectionName: pulumi.Output<string>;
/**
* The provisioning state of the resource.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
*/
readonly singleSignOnStatus: pulumi.Output<string | undefined>;
/**
* Stop on disconnect configuration settings for Dev Boxes created in this pool.
*/
readonly stopOnDisconnect: pulumi.Output<outputs.devcenter.StopOnDisconnectConfigurationResponse | undefined>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.devcenter.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
*/
readonly virtualNetworkType: pulumi.Output<string | undefined>;
/**
* Create a Pool 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: PoolArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Pool resource.
*/
export interface PoolArgs {
/**
* Name of a Dev Box definition in parent Project of this Pool
*/
devBoxDefinitionName: pulumi.Input<string>;
/**
* The display name of the pool.
*/
displayName?: pulumi.Input<string>;
/**
* Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.
*/
licenseType: pulumi.Input<string | enums.devcenter.LicenseType>;
/**
* Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.
*/
localAdministrator: pulumi.Input<string | enums.devcenter.LocalAdminStatus>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* The regions of the managed virtual network (required when managedNetworkType is Managed).
*/
managedVirtualNetworkRegions?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Name of a Network Connection in parent Project of this Pool
*/
networkConnectionName: pulumi.Input<string>;
/**
* Name of the pool.
*/
poolName?: pulumi.Input<string>;
/**
* The name of the project.
*/
projectName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Indicates whether Dev Boxes in this pool are created with single sign on enabled. The also requires that single sign on be enabled on the tenant.
*/
singleSignOnStatus?: pulumi.Input<string | enums.devcenter.SingleSignOnStatus>;
/**
* Stop on disconnect configuration settings for Dev Boxes created in this pool.
*/
stopOnDisconnect?: pulumi.Input<inputs.devcenter.StopOnDisconnectConfigurationArgs>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.
*/
virtualNetworkType?: pulumi.Input<string | enums.devcenter.VirtualNetworkType>;
}