Add-​Azure​Rm​Vmss​Win​RM​Listener

Adds a WinRM listener to the VMSS.

Syntax

Add-AzureRmVmssWinRMListener
   [-VirtualMachineScaleSet] <VirtualMachineScaleSet>
   [[-Protocol] <ProtocolTypes>]
   [[-CertificateUrl] <String>]
   [-Confirm]
   [-WhatIf]
   [<CommonParameters>]

Description

The Add-AzureRmVmssWinRMListener cmdlet adds a Windows Remote Management (WinRM) listener on the Virtual Machine Scale Set (VMSS).

Examples

Example 1: Add a WinRM listener to the VMSS

PS C:\>$VMSS = New-AzureRmVmssConfig
PS C:\> Add-AzureRmVmssWinRMListener -VirtualMachineScaleSet $VMSS -Protocol Https -CertificateUrl "http://keyVaultName.vault.contoso.net/secrets/secretName/secretVersion"

This example adds a WinRM listener to the VMSS.

The first command uses the New-AzureRmVmssConfig cmdlet to create a VMSS configuration object and stores the result in the variable named $VMSS. The second command adds an HTTP protocol WinRM listener with the certificate at the specified URL to the VMSS.

Required Parameters

-VirtualMachineScaleSet

Specifies the VMSS object. You can use the New-AzureRmVmssConfig cmdlet to create the object.

Type:VirtualMachineScaleSet
Position:1
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-CertificateUrl

Specifies a link, as a URL, of the certificate with which new virtual machines are provisioned.

Type:String
Position:3
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Protocol

Specifies the protocol of the WinRM listener. The acceptable values for this parameter are:- Http

  • Https
Type:ProtocolTypes
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False
-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

This cmdlet does not generate any output.