Docs
PackagesWe recommend using Azure Native.
Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
azure.desktopvirtualization.GetHostPoolRegistrationInfo
Explore with Pulumi AI
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/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/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.
Example
The following reference example uses placeholder values for all input properties.
var getHostPoolRegistrationInfoResource = new Azure.DesktopVirtualization.GetHostPoolRegistrationInfo("getHostPoolRegistrationInfoResource", new()
{
ExpirationDate = "string",
HostpoolId = "string",
});
example, err := desktopvirtualization.NewgetHostPoolRegistrationInfo(ctx, "getHostPoolRegistrationInfoResource", &desktopvirtualization.getHostPoolRegistrationInfoArgs{
ExpirationDate: pulumi.String("string"),
HostpoolId: pulumi.String("string"),
})
var getHostPoolRegistrationInfoResource = new GetHostPoolRegistrationInfo("getHostPoolRegistrationInfoResource", GetHostPoolRegistrationInfoArgs.builder()
.expirationDate("string")
.hostpoolId("string")
.build());
get_host_pool_registration_info_resource = azure.desktopvirtualization.GetHostPoolRegistrationInfo("getHostPoolRegistrationInfoResource",
expiration_date="string",
hostpool_id="string")
const getHostPoolRegistrationInfoResource = new azure.desktopvirtualization.GetHostPoolRegistrationInfo("getHostPoolRegistrationInfoResource", {
expirationDate: "string",
hostpoolId: "string",
});
Coming soon!
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
The GetHostPoolRegistrationInfo resource accepts the following input properties:
- Expiration
Date string - A valid
RFC3339Timefor the expiration of the token.. - Hostpool
Id 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 string - A valid
RFC3339Timefor the expiration of the token.. - Hostpool
Id 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 String - A valid
RFC3339Timefor the expiration of the token.. - hostpool
Id 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 string - A valid
RFC3339Timefor the expiration of the token.. - hostpool
Id 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
RFC3339Timefor 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.
- expiration
Date String - A valid
RFC3339Timefor the expiration of the token.. - hostpool
Id 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:
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) -> GetHostPoolRegistrationInfofunc 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.
- Expiration
Date string - A valid
RFC3339Timefor the expiration of the token.. - Hostpool
Id 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 string - A valid
RFC3339Timefor the expiration of the token.. - Hostpool
Id 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 String - A valid
RFC3339Timefor the expiration of the token.. - hostpool
Id 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 string - A valid
RFC3339Timefor the expiration of the token.. - hostpool
Id 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
RFC3339Timefor 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.
- expiration
Date String - A valid
RFC3339Timefor the expiration of the token.. - hostpool
Id 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
azurermTerraform Provider.