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

PoolArgs

data class PoolArgs(val devBoxDefinitionName: Output<String>? = null, val displayName: Output<String>? = null, val licenseType: Output<Either<String, LicenseType>>? = null, val localAdministrator: Output<Either<String, LocalAdminStatus>>? = null, val location: Output<String>? = null, val managedVirtualNetworkRegions: Output<List<String>>? = null, val networkConnectionName: Output<String>? = null, val poolName: Output<String>? = null, val projectName: Output<String>? = null, val resourceGroupName: Output<String>? = null, val singleSignOnStatus: Output<Either<String, SingleSignOnStatus>>? = null, val stopOnDisconnect: Output<StopOnDisconnectConfigurationArgs>? = null, val tags: Output<Map<String, String>>? = null, val virtualNetworkType: Output<Either<String, VirtualNetworkType>>? = null) : ConvertibleToJava<PoolArgs>

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

Constructors

Link copied to clipboard
constructor(devBoxDefinitionName: Output<String>? = null, displayName: Output<String>? = null, licenseType: Output<Either<String, LicenseType>>? = null, localAdministrator: Output<Either<String, LocalAdminStatus>>? = null, location: Output<String>? = null, managedVirtualNetworkRegions: Output<List<String>>? = null, networkConnectionName: Output<String>? = null, poolName: Output<String>? = null, projectName: Output<String>? = null, resourceGroupName: Output<String>? = null, singleSignOnStatus: Output<Either<String, SingleSignOnStatus>>? = null, stopOnDisconnect: Output<StopOnDisconnectConfigurationArgs>? = null, tags: Output<Map<String, String>>? = null, virtualNetworkType: Output<Either<String, VirtualNetworkType>>? = null)

Properties

Link copied to clipboard
val devBoxDefinitionName: Output<String>? = null

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

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

The display name of the pool.

Link copied to clipboard
val licenseType: Output<Either<String, LicenseType>>? = null

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<Either<String, LocalAdminStatus>>? = null

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>? = null

The geo-location where the resource lives

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

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

Link copied to clipboard
val networkConnectionName: Output<String>? = null

Name of a Network Connection in parent Project of this Pool

Link copied to clipboard
val poolName: Output<String>? = null

Name of the pool.

Link copied to clipboard
val projectName: Output<String>? = null

The name of the project.

Link copied to clipboard
val resourceGroupName: Output<String>? = null

The name of the resource group. The name is case insensitive.

Link copied to clipboard
val singleSignOnStatus: Output<Either<String, SingleSignOnStatus>>? = null

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<StopOnDisconnectConfigurationArgs>? = null

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

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

Resource tags.

Link copied to clipboard
val virtualNetworkType: Output<Either<String, VirtualNetworkType>>? = null

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

Functions

Link copied to clipboard
open override fun toJava(): PoolArgs