< Back

Add-AzureRmVmssWinRMListener

Tue Jan 29, 2019 9:37 pm

NAME Add-AzureRmVmssWinRMListener



SYNOPSIS

Adds a WinRM listener to the VMSS.





SYNTAX

Add-AzureRmVmssWinRMListener [-VirtualMachineScaleSet] <PSVirtualMachineScaleSet> [[-Protocol] {Http | Https}] [[-CertificateUrl] <String>]

[-DefaultProfile <IAzureContextContainer>] [-Confirm] [-WhatIf] [<CommonParameters>]





DESCRIPTION

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





PARAMETERS

-CertificateUrl <String>

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



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-DefaultProfile <IAzureContextContainer>

The credentials, account, tenant, and subscription used for communication with azure.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Protocol <ProtocolTypes>

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



- Http



- Https



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-VirtualMachineScaleSet <PSVirtualMachineScaleSet>

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



Required? true

Position? 0

Default value None

Accept pipeline input? True (ByPropertyName, ByValue)

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

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



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

VirtualMachineScaleSet

Parameter 'VirtualMachineScaleSet' accepts value of type 'VirtualMachineScaleSet' from the pipeline





OUTPUTS

This cmdlet does not generate any output.







NOTES









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/s ... retVersion"



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.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... rmlistener

New-AzureRmVmssConfig