Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. desktopvirtualization
  5. GetHostPoolRegistrationInfo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

azure.desktopvirtualization.GetHostPoolRegistrationInfo

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-azure

    Manages the Registration Info for a Virtual Desktop Host Pool.

    Example Usage

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

const example = new azure.core.ResourceGroup("example", {
    name: "example-hostpool",
    location: "westeurope",
});
const exampleHostPool = new azure.desktopvirtualization.HostPool("example", {
    name: "example-HP",
    location: example.location,
    resourceGroupName: example.name,
    type: "Pooled",
    validateEnvironment: true,
    loadBalancerType: "BreadthFirst",
});
const exampleGetHostPoolRegistrationInfo = new azure.desktopvirtualization.GetHostPoolRegistrationInfo("example", {
    hostpoolId: exampleHostPool.id,
    expirationDate: "2022-01-01T23:40:52Z",
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-hostpool",
    location="westeurope")
example_host_pool = azure.desktopvirtualization.HostPool("example",
    name="example-HP",
    location=example.location,
    resource_group_name=example.name,
    type="Pooled",
    validate_environment=True,
    load_balancer_type="BreadthFirst")
example_get_host_pool_registration_info = azure.desktopvirtualization.GetHostPoolRegistrationInfo("example",
    hostpool_id=example_host_pool.id,
    expiration_date="2022-01-01T23:40:52Z")

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/desktopvirtualization"
	"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-hostpool"),
			Location: pulumi.String("westeurope"),
		})
		if err != nil {
			return err
		}
		exampleHostPool, err := desktopvirtualization.NewHostPool(ctx, "example", &desktopvirtualization.HostPoolArgs{
			Name:                pulumi.String("example-HP"),
			Location:            example.Location,
			ResourceGroupName:   example.Name,
			Type:                pulumi.String("Pooled"),
			ValidateEnvironment: pulumi.Bool(true),
			LoadBalancerType:    pulumi.String("BreadthFirst"),
		})
		if err != nil {
			return err
		}
		_, err = desktopvirtualization.NewgetHostPoolRegistrationInfo(ctx, "example", &desktopvirtualization.getHostPoolRegistrationInfoArgs{
			HostpoolId:     exampleHostPool.ID(),
			ExpirationDate: pulumi.String("2022-01-01T23:40:52Z"),
		})
		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-hostpool",
        Location = "westeurope",
    });

    var exampleHostPool = new Azure.DesktopVirtualization.HostPool("example", new()
    {
        Name = "example-HP",
        Location = example.Location,
        ResourceGroupName = example.Name,
        Type = "Pooled",
        ValidateEnvironment = true,
        LoadBalancerType = "BreadthFirst",
    });

    var exampleGetHostPoolRegistrationInfo = new Azure.DesktopVirtualization.GetHostPoolRegistrationInfo("example", new()
    {
        HostpoolId = exampleHostPool.Id,
        ExpirationDate = "2022-01-01T23:40:52Z",
    });

});

    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.desktopvirtualization.HostPool;
import com.pulumi.azure.desktopvirtualization.HostPoolArgs;
import com.pulumi.azure.desktopvirtualization.getHostPoolRegistrationInfo;
import com.pulumi.azure.desktopvirtualization.GetHostPoolRegistrationInfoArgs;
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-hostpool")
            .location("westeurope")
            .build());

        var exampleHostPool = new HostPool("exampleHostPool", HostPoolArgs.builder()
            .name("example-HP")
            .location(example.location())
            .resourceGroupName(example.name())
            .type("Pooled")
            .validateEnvironment(true)
            .loadBalancerType("BreadthFirst")
            .build());

        var exampleGetHostPoolRegistrationInfo = new GetHostPoolRegistrationInfo("exampleGetHostPoolRegistrationInfo", GetHostPoolRegistrationInfoArgs.builder()
            .hostpoolId(exampleHostPool.id())
            .expirationDate("2022-01-01T23:40:52Z")
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-hostpool
      location: westeurope
  exampleHostPool:
    type: azure:desktopvirtualization:HostPool
    name: example
    properties:
      name: example-HP
      location: ${example.location}
      resourceGroupName: ${example.name}
      type: Pooled
      validateEnvironment: true
      loadBalancerType: BreadthFirst
  exampleGetHostPoolRegistrationInfo:
    type: azure:desktopvirtualization:getHostPoolRegistrationInfo
    name: example
    properties:
      hostpoolId: ${exampleHostPool.id}
      expirationDate: 2022-01-01T23:40:52Z

    Create GetHostPoolRegistrationInfo Resource

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

    Constructor syntax

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

@overload
def GetHostPoolRegistrationInfo(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                expiration_date: Optional[str] = None,
                                hostpool_id: Optional[str] = None)
    func NewGetHostPoolRegistrationInfo(ctx *Context, name string, args GetHostPoolRegistrationInfoArgs, opts ...ResourceOption) (*GetHostPoolRegistrationInfo, error)
    public GetHostPoolRegistrationInfo(string name, GetHostPoolRegistrationInfoArgs args, CustomResourceOptions? opts = null)
    public GetHostPoolRegistrationInfo(String name, GetHostPoolRegistrationInfoArgs args)
public GetHostPoolRegistrationInfo(String name, GetHostPoolRegistrationInfoArgs args, CustomResourceOptions options)

    type: azure:desktopvirtualization/getHostPoolRegistrationInfo:getHostPoolRegistrationInfo
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 GetHostPoolRegistrationInfoArgs
    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 GetHostPoolRegistrationInfoArgs
    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 GetHostPoolRegistrationInfoArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GetHostPoolRegistrationInfoArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GetHostPoolRegistrationInfoArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    GetHostPoolRegistrationInfo Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GetHostPoolRegistrationInfo resource accepts the following input properties:

    ExpirationDate string
    A valid RFC3339Time for the expiration of the token..
    HostpoolId string
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    ExpirationDate string
    A valid RFC3339Time for the expiration of the token..
    HostpoolId string
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    expirationDate String
    A valid RFC3339Time for the expiration of the token..
    hostpoolId String
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    expirationDate string
    A valid RFC3339Time for the expiration of the token..
    hostpoolId string
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    expiration_date str
    A valid RFC3339Time for the expiration of the token..
    hostpool_id str
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    expirationDate String
    A valid RFC3339Time for the expiration of the token..
    hostpoolId String
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    Id string
    The provider-assigned unique ID for this managed resource.
    Token string
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    id string
    The provider-assigned unique ID for this managed resource.
    token string
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    id str
    The provider-assigned unique ID for this managed resource.
    token str
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    id String
    The provider-assigned unique ID for this managed resource.
    token String
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.

    Look up Existing GetHostPoolRegistrationInfo Resource

    Get an existing GetHostPoolRegistrationInfo 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?: GetHostPoolRegistrationInfoState, opts?: CustomResourceOptions): GetHostPoolRegistrationInfo
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        expiration_date: Optional[str] = None,
        hostpool_id: Optional[str] = None,
        token: Optional[str] = None) -> GetHostPoolRegistrationInfo
    func GetGetHostPoolRegistrationInfo(ctx *Context, name string, id IDInput, state *GetHostPoolRegistrationInfoState, opts ...ResourceOption) (*GetHostPoolRegistrationInfo, error)
    public static GetHostPoolRegistrationInfo Get(string name, Input<string> id, GetHostPoolRegistrationInfoState? state, CustomResourceOptions? opts = null)
    public static GetHostPoolRegistrationInfo get(String name, Output<String> id, GetHostPoolRegistrationInfoState 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:
    ExpirationDate string
    A valid RFC3339Time for the expiration of the token..
    HostpoolId string
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    Token string
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    ExpirationDate string
    A valid RFC3339Time for the expiration of the token..
    HostpoolId string
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    Token string
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    expirationDate String
    A valid RFC3339Time for the expiration of the token..
    hostpoolId String
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    token String
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    expirationDate string
    A valid RFC3339Time for the expiration of the token..
    hostpoolId string
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    token string
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    expiration_date str
    A valid RFC3339Time for the expiration of the token..
    hostpool_id str
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    token str
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.
    expirationDate String
    A valid RFC3339Time for the expiration of the token..
    hostpoolId String
    The ID of the Virtual Desktop Host Pool to link the Registration Info to. Changing this forces a new Registration Info resource to be created. Only a single virtual_desktop_host_pool_registration_info resource should be associated with a given hostpool. Assigning multiple resources will produce inconsistent results.
    token String
    The registration token generated by the Virtual Desktop Host Pool for registration of session hosts.

    Import

    AVD Registration Infos can be imported using the resource id, e.g.

    $ pulumi import azure:desktopvirtualization/getHostPoolRegistrationInfo:getHostPoolRegistrationInfo example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.DesktopVirtualization/hostPools/pool1/registrationInfo/default

    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 v6.10.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-azure