Skip to content

New-AzWvdSessionHost.md

Latest commit

 

History

History
267 lines (209 loc) · 5.93 KB

New-AzWvdSessionHost.md

File metadata and controls

267 lines (209 loc) · 5.93 KB
Raw
external help file
Module Name Az.DesktopVirtualization
online version https://learn.microsoft.com/powershell/module/az.desktopvirtualization/new-azwvdsessionhost
schema 2.0.0

New-AzWvdSessionHost

SYNOPSIS

Create a sessionHost.

SYNTAX

CreateExpanded (Default)

New-AzWvdSessionHost -HostPoolName <String> -Name <String> -ResourceGroupName <String>
 [-SubscriptionId <String>] [-AllowNewSession] [-AssignedUser <String>] [-FriendlyName <String>]
 [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

CreateViaJsonFilePath

New-AzWvdSessionHost -HostPoolName <String> -Name <String> -ResourceGroupName <String> -JsonFilePath <String>
 [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

CreateViaJsonString

New-AzWvdSessionHost -HostPoolName <String> -Name <String> -ResourceGroupName <String> -JsonString <String>
 [-SubscriptionId <String>] [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

DESCRIPTION

Create a sessionHost.

EXAMPLES

Example 1: Create an Azure Virtual Desktop SessionHost

New-AzWvdSessionHost -ResourceGroupName resourceGroup1 -HostPoolName hostPool1 -Name sessionHost1.microsoft.com
Name                                          Type
----                                          ----
hostPool1/sessionHost1.microsoft.com          Microsoft.DesktopVirtualization/hostpools/sessionhosts

This command creates a new Azure Virtual Desktop SessionHost in a Host Pool.

Example 2: Create an Azure Virtual Desktop SessionHost with friendly name

New-AzWvdSessionHost -ResourceGroupName resourceGroup1 `
                     -HostPoolName hostPool1 `
                     -Name sessionHost1.microsoft.com `
                     -FriendlyName 'Friendly Name' `
                     -AllowNewSession
Name                                          Type
----                                          ----
hostPool1/sessionHost1.microsoft.com          Microsoft.DesktopVirtualization/hostpools/sessionhosts

This command creates a new Azure Virtual Desktop SessionHost in a Host Pool with a friendly name and allows new sessions.

PARAMETERS

-AllowNewSession

Allow a new session.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AssignedUser

User assigned to SessionHost.

Type: System.String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-FriendlyName

Friendly name of SessionHost

Type: System.String
Parameter Sets: CreateExpanded
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostPoolName

The name of the host pool within the specified resource group

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-JsonFilePath

Path of Json file supplied to the Create operation

Type: System.String
Parameter Sets: CreateViaJsonFilePath
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-JsonString

Json string supplied to the Create operation

Type: System.String
Parameter Sets: CreateViaJsonString
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the session host within the specified host pool

Type: System.String
Parameter Sets: (All)
Aliases: SessionHostName

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ResourceGroupName

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

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type: System.String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: (Get-AzContext).Subscription.Id
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.ISessionHost

NOTES

RELATED LINKS