pulumi-azure-native-kotlin/com.pulumi.azurenative.devcenter.kotlin/Pool

Pool

class Pool : KotlinCustomResource

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. 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/#accessing-any-api-version-via-local-packages for details.

Example Usage

Pools_CreateOrUpdate

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var pool = new AzureNative.DevCenter.Pool("pool", new()
    {
        DevBoxDefinitionName = "WebDevBox",
        DisplayName = "Developer Pool",
        LicenseType = AzureNative.DevCenter.LicenseType.Windows_Client,
        LocalAdministrator = AzureNative.DevCenter.LocalAdminStatus.Enabled,
        Location = "centralus",
        NetworkConnectionName = "Network1-westus2",
        PoolName = "DevPool",
        ProjectName = "DevProject",
        ResourceGroupName = "rg1",
        SingleSignOnStatus = AzureNative.DevCenter.SingleSignOnStatus.Disabled,
        StopOnDisconnect = new AzureNative.DevCenter.Inputs.StopOnDisconnectConfigurationArgs
        {
            GracePeriodMinutes = 60,
            Status = AzureNative.DevCenter.StopOnDisconnectEnableStatus.Enabled,
        },
        VirtualNetworkType = AzureNative.DevCenter.VirtualNetworkType.Unmanaged,
    });
});
Content copied to clipboard
package main
import (
	devcenter "github.com/pulumi/pulumi-azure-native-sdk/devcenter/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := devcenter.NewPool(ctx, "pool", &devcenter.PoolArgs{
			DevBoxDefinitionName:  pulumi.String("WebDevBox"),
			DisplayName:           pulumi.String("Developer Pool"),
			LicenseType:           pulumi.String(devcenter.LicenseType_Windows_Client),
			LocalAdministrator:    pulumi.String(devcenter.LocalAdminStatusEnabled),
			Location:              pulumi.String("centralus"),
			NetworkConnectionName: pulumi.String("Network1-westus2"),
			PoolName:              pulumi.String("DevPool"),
			ProjectName:           pulumi.String("DevProject"),
			ResourceGroupName:     pulumi.String("rg1"),
			SingleSignOnStatus:    pulumi.String(devcenter.SingleSignOnStatusDisabled),
			StopOnDisconnect: &devcenter.StopOnDisconnectConfigurationArgs{
				GracePeriodMinutes: pulumi.Int(60),
				Status:             pulumi.String(devcenter.StopOnDisconnectEnableStatusEnabled),
			},
			VirtualNetworkType: pulumi.String(devcenter.VirtualNetworkTypeUnmanaged),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.devcenter.Pool;
import com.pulumi.azurenative.devcenter.PoolArgs;
import com.pulumi.azurenative.devcenter.inputs.StopOnDisconnectConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var pool = new Pool("pool", PoolArgs.builder()
            .devBoxDefinitionName("WebDevBox")
            .displayName("Developer Pool")
            .licenseType("Windows_Client")
            .localAdministrator("Enabled")
            .location("centralus")
            .networkConnectionName("Network1-westus2")
            .poolName("DevPool")
            .projectName("DevProject")
            .resourceGroupName("rg1")
            .singleSignOnStatus("Disabled")
            .stopOnDisconnect(StopOnDisconnectConfigurationArgs.builder()
                .gracePeriodMinutes(60)
                .status("Enabled")
                .build())
            .virtualNetworkType("Unmanaged")
            .build());
    }
}
Content copied to clipboard

Pools_CreateOrUpdateWithManagedNetwork

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
    var pool = new AzureNative.DevCenter.Pool("pool", new()
    {
        DevBoxDefinitionName = "WebDevBox",
        DisplayName = "Developer Pool",
        LicenseType = AzureNative.DevCenter.LicenseType.Windows_Client,
        LocalAdministrator = AzureNative.DevCenter.LocalAdminStatus.Enabled,
        Location = "centralus",
        ManagedVirtualNetworkRegions = new[]
        {
            "centralus",
        },
        NetworkConnectionName = "managedNetwork",
        PoolName = "DevPool",
        ProjectName = "DevProject",
        ResourceGroupName = "rg1",
        SingleSignOnStatus = AzureNative.DevCenter.SingleSignOnStatus.Disabled,
        StopOnDisconnect = new AzureNative.DevCenter.Inputs.StopOnDisconnectConfigurationArgs
        {
            GracePeriodMinutes = 60,
            Status = AzureNative.DevCenter.StopOnDisconnectEnableStatus.Enabled,
        },
        VirtualNetworkType = AzureNative.DevCenter.VirtualNetworkType.Managed,
    });
});
Content copied to clipboard
package main
import (
	devcenter "github.com/pulumi/pulumi-azure-native-sdk/devcenter/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := devcenter.NewPool(ctx, "pool", &devcenter.PoolArgs{
			DevBoxDefinitionName: pulumi.String("WebDevBox"),
			DisplayName:          pulumi.String("Developer Pool"),
			LicenseType:          pulumi.String(devcenter.LicenseType_Windows_Client),
			LocalAdministrator:   pulumi.String(devcenter.LocalAdminStatusEnabled),
			Location:             pulumi.String("centralus"),
			ManagedVirtualNetworkRegions: pulumi.StringArray{
				pulumi.String("centralus"),
			},
			NetworkConnectionName: pulumi.String("managedNetwork"),
			PoolName:              pulumi.String("DevPool"),
			ProjectName:           pulumi.String("DevProject"),
			ResourceGroupName:     pulumi.String("rg1"),
			SingleSignOnStatus:    pulumi.String(devcenter.SingleSignOnStatusDisabled),
			StopOnDisconnect: &devcenter.StopOnDisconnectConfigurationArgs{
				GracePeriodMinutes: pulumi.Int(60),
				Status:             pulumi.String(devcenter.StopOnDisconnectEnableStatusEnabled),
			},
			VirtualNetworkType: pulumi.String(devcenter.VirtualNetworkTypeManaged),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.devcenter.Pool;
import com.pulumi.azurenative.devcenter.PoolArgs;
import com.pulumi.azurenative.devcenter.inputs.StopOnDisconnectConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var pool = new Pool("pool", PoolArgs.builder()
            .devBoxDefinitionName("WebDevBox")
            .displayName("Developer Pool")
            .licenseType("Windows_Client")
            .localAdministrator("Enabled")
            .location("centralus")
            .managedVirtualNetworkRegions("centralus")
            .networkConnectionName("managedNetwork")
            .poolName("DevPool")
            .projectName("DevProject")
            .resourceGroupName("rg1")
            .singleSignOnStatus("Disabled")
            .stopOnDisconnect(StopOnDisconnectConfigurationArgs.builder()
                .gracePeriodMinutes(60)
                .status("Enabled")
                .build())
            .virtualNetworkType("Managed")
            .build());
    }
}
Content copied to clipboard

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:devcenter:Pool DevPool /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}
Content copied to clipboard

Properties

Link copied to clipboard
val azureApiVersion: Output<String>

The Azure API version of the resource.

Link copied to clipboard
val devBoxCount: Output<Int>

Indicates the number of provisioned Dev Boxes in this pool.

Link copied to clipboard
val devBoxDefinitionName: Output<String>

Name of a Dev Box definition in parent Project of this Pool

Link copied to clipboard
val displayName: Output<String>?

The display name of the pool.

Link copied to clipboard
val healthStatus: Output<String>

Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.

Link copied to clipboard
val healthStatusDetails: Output<List<HealthStatusDetailResponse>>

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

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val licenseType: Output<String>

Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.

Link copied to clipboard
val localAdministrator: Output<String>

Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.

Link copied to clipboard
val location: Output<String>

The geo-location where the resource lives

Link copied to clipboard
val managedVirtualNetworkRegions: Output<List<String>>?

The regions of the managed virtual network (required when managedNetworkType is Managed).

Link copied to clipboard
val name: Output<String>

The name of the resource

Link copied to clipboard
val networkConnectionName: Output<String>

Name of a Network Connection in parent Project of this Pool

Link copied to clipboard
val provisioningState: Output<String>

The provisioning state of the resource.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val singleSignOnStatus: 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.

Link copied to clipboard
val stopOnDisconnect: Output<StopOnDisconnectConfigurationResponse>?

Stop on disconnect configuration settings for Dev Boxes created in this pool.

Link copied to clipboard
val systemData: Output<SystemDataResponse>

Azure Resource Manager metadata containing createdBy and modifiedBy information.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Resource tags.

Link copied to clipboard
val type: Output<String>

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard
val virtualNetworkType: Output<String>?

Indicates whether the pool uses a Virtual Network managed by Microsoft or a customer provided network.