Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. lab
  5. ServicePlan

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

azure.lab.ServicePlan

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

    Manages a Lab Service Plan.

    Note: Before using this resource, it’s required to submit the request of registering the provider with Azure CLI az provider register --namespace Microsoft.LabServices.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleServicePlan = new azure.lab.ServicePlan("example", {
    name: "example-lp",
    resourceGroupName: example.name,
    location: example.location,
    allowedRegions: [example.location],
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_service_plan = azure.lab.ServicePlan("example",
    name="example-lp",
    resource_group_name=example.name,
    location=example.location,
    allowed_regions=[example.location])

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/lab"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = lab.NewServicePlan(ctx, "example", &lab.ServicePlanArgs{
			Name:              pulumi.String("example-lp"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			AllowedRegions: pulumi.StringArray{
				example.Location,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleServicePlan = new Azure.Lab.ServicePlan("example", new()
    {
        Name = "example-lp",
        ResourceGroupName = example.Name,
        Location = example.Location,
        AllowedRegions = new[]
        {
            example.Location,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.lab.ServicePlan;
import com.pulumi.azure.lab.ServicePlanArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleServicePlan = new ServicePlan("exampleServicePlan", ServicePlanArgs.builder()
            .name("example-lp")
            .resourceGroupName(example.name())
            .location(example.location())
            .allowedRegions(example.location())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleServicePlan:
    type: azure:lab:ServicePlan
    name: example
    properties:
      name: example-lp
      resourceGroupName: ${example.name}
      location: ${example.location}
      allowedRegions:
        - ${example.location}

    Create ServicePlan Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServicePlan(name: string, args: ServicePlanArgs, opts?: CustomResourceOptions);
    @overload
def ServicePlan(resource_name: str,
                args: ServicePlanArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def ServicePlan(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                allowed_regions: Optional[Sequence[str]] = None,
                resource_group_name: Optional[str] = None,
                default_auto_shutdown: Optional[ServicePlanDefaultAutoShutdownArgs] = None,
                default_connection: Optional[ServicePlanDefaultConnectionArgs] = None,
                default_network_subnet_id: Optional[str] = None,
                location: Optional[str] = None,
                name: Optional[str] = None,
                shared_gallery_id: Optional[str] = None,
                support: Optional[ServicePlanSupportArgs] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewServicePlan(ctx *Context, name string, args ServicePlanArgs, opts ...ResourceOption) (*ServicePlan, error)
    public ServicePlan(string name, ServicePlanArgs args, CustomResourceOptions? opts = null)
    public ServicePlan(String name, ServicePlanArgs args)
public ServicePlan(String name, ServicePlanArgs args, CustomResourceOptions options)

    type: azure:lab:ServicePlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServicePlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServicePlanArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServicePlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServicePlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServicePlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var azureServicePlanResource = new Azure.Lab.ServicePlan("azureServicePlanResource", new()
{
    AllowedRegions = new[]
    {
        "string",
    },
    ResourceGroupName = "string",
    DefaultAutoShutdown = new Azure.Lab.Inputs.ServicePlanDefaultAutoShutdownArgs
    {
        DisconnectDelay = "string",
        IdleDelay = "string",
        NoConnectDelay = "string",
        ShutdownOnIdle = "string",
    },
    DefaultConnection = new Azure.Lab.Inputs.ServicePlanDefaultConnectionArgs
    {
        ClientRdpAccess = "string",
        ClientSshAccess = "string",
        WebRdpAccess = "string",
        WebSshAccess = "string",
    },
    DefaultNetworkSubnetId = "string",
    Location = "string",
    Name = "string",
    SharedGalleryId = "string",
    Support = new Azure.Lab.Inputs.ServicePlanSupportArgs
    {
        Email = "string",
        Instructions = "string",
        Phone = "string",
        Url = "string",
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := lab.NewServicePlan(ctx, "azureServicePlanResource", &lab.ServicePlanArgs{
	AllowedRegions: pulumi.StringArray{
		pulumi.String("string"),
	},
	ResourceGroupName: pulumi.String("string"),
	DefaultAutoShutdown: &lab.ServicePlanDefaultAutoShutdownArgs{
		DisconnectDelay: pulumi.String("string"),
		IdleDelay:       pulumi.String("string"),
		NoConnectDelay:  pulumi.String("string"),
		ShutdownOnIdle:  pulumi.String("string"),
	},
	DefaultConnection: &lab.ServicePlanDefaultConnectionArgs{
		ClientRdpAccess: pulumi.String("string"),
		ClientSshAccess: pulumi.String("string"),
		WebRdpAccess:    pulumi.String("string"),
		WebSshAccess:    pulumi.String("string"),
	},
	DefaultNetworkSubnetId: pulumi.String("string"),
	Location:               pulumi.String("string"),
	Name:                   pulumi.String("string"),
	SharedGalleryId:        pulumi.String("string"),
	Support: &lab.ServicePlanSupportArgs{
		Email:        pulumi.String("string"),
		Instructions: pulumi.String("string"),
		Phone:        pulumi.String("string"),
		Url:          pulumi.String("string"),
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var azureServicePlanResource = new ServicePlan("azureServicePlanResource", ServicePlanArgs.builder()
    .allowedRegions("string")
    .resourceGroupName("string")
    .defaultAutoShutdown(ServicePlanDefaultAutoShutdownArgs.builder()
        .disconnectDelay("string")
        .idleDelay("string")
        .noConnectDelay("string")
        .shutdownOnIdle("string")
        .build())
    .defaultConnection(ServicePlanDefaultConnectionArgs.builder()
        .clientRdpAccess("string")
        .clientSshAccess("string")
        .webRdpAccess("string")
        .webSshAccess("string")
        .build())
    .defaultNetworkSubnetId("string")
    .location("string")
    .name("string")
    .sharedGalleryId("string")
    .support(ServicePlanSupportArgs.builder()
        .email("string")
        .instructions("string")
        .phone("string")
        .url("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    azure_service_plan_resource = azure.lab.ServicePlan("azureServicePlanResource",
    allowed_regions=["string"],
    resource_group_name="string",
    default_auto_shutdown=azure.lab.ServicePlanDefaultAutoShutdownArgs(
        disconnect_delay="string",
        idle_delay="string",
        no_connect_delay="string",
        shutdown_on_idle="string",
    ),
    default_connection=azure.lab.ServicePlanDefaultConnectionArgs(
        client_rdp_access="string",
        client_ssh_access="string",
        web_rdp_access="string",
        web_ssh_access="string",
    ),
    default_network_subnet_id="string",
    location="string",
    name="string",
    shared_gallery_id="string",
    support=azure.lab.ServicePlanSupportArgs(
        email="string",
        instructions="string",
        phone="string",
        url="string",
    ),
    tags={
        "string": "string",
    })

    const azureServicePlanResource = new azure.lab.ServicePlan("azureServicePlanResource", {
    allowedRegions: ["string"],
    resourceGroupName: "string",
    defaultAutoShutdown: {
        disconnectDelay: "string",
        idleDelay: "string",
        noConnectDelay: "string",
        shutdownOnIdle: "string",
    },
    defaultConnection: {
        clientRdpAccess: "string",
        clientSshAccess: "string",
        webRdpAccess: "string",
        webSshAccess: "string",
    },
    defaultNetworkSubnetId: "string",
    location: "string",
    name: "string",
    sharedGalleryId: "string",
    support: {
        email: "string",
        instructions: "string",
        phone: "string",
        url: "string",
    },
    tags: {
        string: "string",
    },
});

    type: azure:lab:ServicePlan
properties:
    allowedRegions:
        - string
    defaultAutoShutdown:
        disconnectDelay: string
        idleDelay: string
        noConnectDelay: string
        shutdownOnIdle: string
    defaultConnection:
        clientRdpAccess: string
        clientSshAccess: string
        webRdpAccess: string
        webSshAccess: string
    defaultNetworkSubnetId: string
    location: string
    name: string
    resourceGroupName: string
    sharedGalleryId: string
    support:
        email: string
        instructions: string
        phone: string
        url: string
    tags:
        string: string

    ServicePlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ServicePlan resource accepts the following input properties:

    AllowedRegions List<string>
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    ResourceGroupName string
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    DefaultAutoShutdown ServicePlanDefaultAutoShutdown
    A default_auto_shutdown block as defined below.
    DefaultConnection ServicePlanDefaultConnection
    A default_connection block as defined below.
    DefaultNetworkSubnetId string
    The resource ID of the Subnet for the Lab Service Plan network profile.
    Location string
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    Name string
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    SharedGalleryId string

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    Support ServicePlanSupport
    A support block as defined below.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Lab Service Plan.
    AllowedRegions []string
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    ResourceGroupName string
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    DefaultAutoShutdown ServicePlanDefaultAutoShutdownArgs
    A default_auto_shutdown block as defined below.
    DefaultConnection ServicePlanDefaultConnectionArgs
    A default_connection block as defined below.
    DefaultNetworkSubnetId string
    The resource ID of the Subnet for the Lab Service Plan network profile.
    Location string
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    Name string
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    SharedGalleryId string

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    Support ServicePlanSupportArgs
    A support block as defined below.
    Tags map[string]string
    A mapping of tags which should be assigned to the Lab Service Plan.
    allowedRegions List<String>
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    resourceGroupName String
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    defaultAutoShutdown ServicePlanDefaultAutoShutdown
    A default_auto_shutdown block as defined below.
    defaultConnection ServicePlanDefaultConnection
    A default_connection block as defined below.
    defaultNetworkSubnetId String
    The resource ID of the Subnet for the Lab Service Plan network profile.
    location String
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    name String
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    sharedGalleryId String

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    support ServicePlanSupport
    A support block as defined below.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Lab Service Plan.
    allowedRegions string[]
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    resourceGroupName string
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    defaultAutoShutdown ServicePlanDefaultAutoShutdown
    A default_auto_shutdown block as defined below.
    defaultConnection ServicePlanDefaultConnection
    A default_connection block as defined below.
    defaultNetworkSubnetId string
    The resource ID of the Subnet for the Lab Service Plan network profile.
    location string
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    name string
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    sharedGalleryId string

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    support ServicePlanSupport
    A support block as defined below.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Lab Service Plan.
    allowed_regions Sequence[str]
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    resource_group_name str
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    default_auto_shutdown ServicePlanDefaultAutoShutdownArgs
    A default_auto_shutdown block as defined below.
    default_connection ServicePlanDefaultConnectionArgs
    A default_connection block as defined below.
    default_network_subnet_id str
    The resource ID of the Subnet for the Lab Service Plan network profile.
    location str
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    name str
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    shared_gallery_id str

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    support ServicePlanSupportArgs
    A support block as defined below.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Lab Service Plan.
    allowedRegions List<String>
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    resourceGroupName String
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    defaultAutoShutdown Property Map
    A default_auto_shutdown block as defined below.
    defaultConnection Property Map
    A default_connection block as defined below.
    defaultNetworkSubnetId String
    The resource ID of the Subnet for the Lab Service Plan network profile.
    location String
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    name String
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    sharedGalleryId String

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    support Property Map
    A support block as defined below.
    tags Map<String>
    A mapping of tags which should be assigned to the Lab Service Plan.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServicePlan resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ServicePlan Resource

    Get an existing ServicePlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServicePlanState, opts?: CustomResourceOptions): ServicePlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allowed_regions: Optional[Sequence[str]] = None,
        default_auto_shutdown: Optional[ServicePlanDefaultAutoShutdownArgs] = None,
        default_connection: Optional[ServicePlanDefaultConnectionArgs] = None,
        default_network_subnet_id: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        shared_gallery_id: Optional[str] = None,
        support: Optional[ServicePlanSupportArgs] = None,
        tags: Optional[Mapping[str, str]] = None) -> ServicePlan
    func GetServicePlan(ctx *Context, name string, id IDInput, state *ServicePlanState, opts ...ResourceOption) (*ServicePlan, error)
    public static ServicePlan Get(string name, Input<string> id, ServicePlanState? state, CustomResourceOptions? opts = null)
    public static ServicePlan get(String name, Output<String> id, ServicePlanState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllowedRegions List<string>
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    DefaultAutoShutdown ServicePlanDefaultAutoShutdown
    A default_auto_shutdown block as defined below.
    DefaultConnection ServicePlanDefaultConnection
    A default_connection block as defined below.
    DefaultNetworkSubnetId string
    The resource ID of the Subnet for the Lab Service Plan network profile.
    Location string
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    Name string
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    SharedGalleryId string

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    Support ServicePlanSupport
    A support block as defined below.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Lab Service Plan.
    AllowedRegions []string
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    DefaultAutoShutdown ServicePlanDefaultAutoShutdownArgs
    A default_auto_shutdown block as defined below.
    DefaultConnection ServicePlanDefaultConnectionArgs
    A default_connection block as defined below.
    DefaultNetworkSubnetId string
    The resource ID of the Subnet for the Lab Service Plan network profile.
    Location string
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    Name string
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    SharedGalleryId string

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    Support ServicePlanSupportArgs
    A support block as defined below.
    Tags map[string]string
    A mapping of tags which should be assigned to the Lab Service Plan.
    allowedRegions List<String>
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    defaultAutoShutdown ServicePlanDefaultAutoShutdown
    A default_auto_shutdown block as defined below.
    defaultConnection ServicePlanDefaultConnection
    A default_connection block as defined below.
    defaultNetworkSubnetId String
    The resource ID of the Subnet for the Lab Service Plan network profile.
    location String
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    name String
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    sharedGalleryId String

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    support ServicePlanSupport
    A support block as defined below.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Lab Service Plan.
    allowedRegions string[]
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    defaultAutoShutdown ServicePlanDefaultAutoShutdown
    A default_auto_shutdown block as defined below.
    defaultConnection ServicePlanDefaultConnection
    A default_connection block as defined below.
    defaultNetworkSubnetId string
    The resource ID of the Subnet for the Lab Service Plan network profile.
    location string
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    name string
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    sharedGalleryId string

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    support ServicePlanSupport
    A support block as defined below.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Lab Service Plan.
    allowed_regions Sequence[str]
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    default_auto_shutdown ServicePlanDefaultAutoShutdownArgs
    A default_auto_shutdown block as defined below.
    default_connection ServicePlanDefaultConnectionArgs
    A default_connection block as defined below.
    default_network_subnet_id str
    The resource ID of the Subnet for the Lab Service Plan network profile.
    location str
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    name str
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    shared_gallery_id str

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    support ServicePlanSupportArgs
    A support block as defined below.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Lab Service Plan.
    allowedRegions List<String>
    The allowed regions for the lab creator to use when creating labs using this Lab Service Plan. The allowed region's count must be between 1 and 28.
    defaultAutoShutdown Property Map
    A default_auto_shutdown block as defined below.
    defaultConnection Property Map
    A default_connection block as defined below.
    defaultNetworkSubnetId String
    The resource ID of the Subnet for the Lab Service Plan network profile.
    location String
    The Azure Region where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    name String
    The name of the Lab Service Plan. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group where the Lab Service Plan should exist. Changing this forces a new resource to be created.
    sharedGalleryId String

    The resource ID of the Shared Image Gallery attached to this Lab Service Plan. When saving a lab template virtual machine image it will be persisted in this gallery. The shared images from the gallery can be made available to use when creating new labs.

    NOTE: The built-in Azure Lab Services Service Principal with role needs to be assigned to the Shared Image Gallery while using this property.

    support Property Map
    A support block as defined below.
    tags Map<String>
    A mapping of tags which should be assigned to the Lab Service Plan.

    Supporting Types

    ServicePlanDefaultAutoShutdown, ServicePlanDefaultAutoShutdownArgs

    DisconnectDelay string
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    IdleDelay string
    The amount of time a VM will idle before it is shutdown if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    NoConnectDelay string
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. This value must be formatted as an ISO 8601 string.
    ShutdownOnIdle string

    Will a VM get shutdown when it has idled for a period of time? Possible values are LowUsage and UserAbsence.

    NOTE: This property is None when it isn't specified. No need to set idle_delay when shutdown_on_idle isn't specified.

    DisconnectDelay string
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    IdleDelay string
    The amount of time a VM will idle before it is shutdown if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    NoConnectDelay string
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. This value must be formatted as an ISO 8601 string.
    ShutdownOnIdle string

    Will a VM get shutdown when it has idled for a period of time? Possible values are LowUsage and UserAbsence.

    NOTE: This property is None when it isn't specified. No need to set idle_delay when shutdown_on_idle isn't specified.

    disconnectDelay String
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    idleDelay String
    The amount of time a VM will idle before it is shutdown if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    noConnectDelay String
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. This value must be formatted as an ISO 8601 string.
    shutdownOnIdle String

    Will a VM get shutdown when it has idled for a period of time? Possible values are LowUsage and UserAbsence.

    NOTE: This property is None when it isn't specified. No need to set idle_delay when shutdown_on_idle isn't specified.

    disconnectDelay string
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    idleDelay string
    The amount of time a VM will idle before it is shutdown if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    noConnectDelay string
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. This value must be formatted as an ISO 8601 string.
    shutdownOnIdle string

    Will a VM get shutdown when it has idled for a period of time? Possible values are LowUsage and UserAbsence.

    NOTE: This property is None when it isn't specified. No need to set idle_delay when shutdown_on_idle isn't specified.

    disconnect_delay str
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    idle_delay str
    The amount of time a VM will idle before it is shutdown if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    no_connect_delay str
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. This value must be formatted as an ISO 8601 string.
    shutdown_on_idle str

    Will a VM get shutdown when it has idled for a period of time? Possible values are LowUsage and UserAbsence.

    NOTE: This property is None when it isn't specified. No need to set idle_delay when shutdown_on_idle isn't specified.

    disconnectDelay String
    The amount of time a VM will stay running after a user disconnects if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    idleDelay String
    The amount of time a VM will idle before it is shutdown if this behavior is enabled. This value must be formatted as an ISO 8601 string.
    noConnectDelay String
    The amount of time a VM will stay running before it is shutdown if no connection is made and this behavior is enabled. This value must be formatted as an ISO 8601 string.
    shutdownOnIdle String

    Will a VM get shutdown when it has idled for a period of time? Possible values are LowUsage and UserAbsence.

    NOTE: This property is None when it isn't specified. No need to set idle_delay when shutdown_on_idle isn't specified.

    ServicePlanDefaultConnection, ServicePlanDefaultConnectionArgs

    ClientRdpAccess string

    The enabled access level for Client Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    ClientSshAccess string

    The enabled access level for Client Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    WebRdpAccess string

    The enabled access level for Web Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    WebSshAccess string

    The enabled access level for Web Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    ClientRdpAccess string

    The enabled access level for Client Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    ClientSshAccess string

    The enabled access level for Client Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    WebRdpAccess string

    The enabled access level for Web Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    WebSshAccess string

    The enabled access level for Web Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    clientRdpAccess String

    The enabled access level for Client Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    clientSshAccess String

    The enabled access level for Client Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    webRdpAccess String

    The enabled access level for Web Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    webSshAccess String

    The enabled access level for Web Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    clientRdpAccess string

    The enabled access level for Client Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    clientSshAccess string

    The enabled access level for Client Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    webRdpAccess string

    The enabled access level for Web Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    webSshAccess string

    The enabled access level for Web Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    client_rdp_access str

    The enabled access level for Client Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    client_ssh_access str

    The enabled access level for Client Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    web_rdp_access str

    The enabled access level for Web Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    web_ssh_access str

    The enabled access level for Web Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    clientRdpAccess String

    The enabled access level for Client Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    clientSshAccess String

    The enabled access level for Client Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    webRdpAccess String

    The enabled access level for Web Access over RDP. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    webSshAccess String

    The enabled access level for Web Access over SSH. Possible values are Private and Public.

    NOTE: This property is None when it isn't specified.

    ServicePlanSupport, ServicePlanSupportArgs

    Email string
    The email address for the support contact.
    Instructions string
    The instructions for users of the Lab Service Plan.
    Phone string
    The phone number for the support contact.
    Url string
    The web address for users of the Lab Service Plan.
    Email string
    The email address for the support contact.
    Instructions string
    The instructions for users of the Lab Service Plan.
    Phone string
    The phone number for the support contact.
    Url string
    The web address for users of the Lab Service Plan.
    email String
    The email address for the support contact.
    instructions String
    The instructions for users of the Lab Service Plan.
    phone String
    The phone number for the support contact.
    url String
    The web address for users of the Lab Service Plan.
    email string
    The email address for the support contact.
    instructions string
    The instructions for users of the Lab Service Plan.
    phone string
    The phone number for the support contact.
    url string
    The web address for users of the Lab Service Plan.
    email str
    The email address for the support contact.
    instructions str
    The instructions for users of the Lab Service Plan.
    phone str
    The phone number for the support contact.
    url str
    The web address for users of the Lab Service Plan.
    email String
    The email address for the support contact.
    instructions String
    The instructions for users of the Lab Service Plan.
    phone String
    The phone number for the support contact.
    url String
    The web address for users of the Lab Service Plan.

    Import

    Lab Service Plans can be imported using the resource id, e.g.

    $ pulumi import azure:lab/servicePlan:ServicePlan example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.LabServices/labPlans/labPlan1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure