Edit

Share via

Enable-AzStackHCIRemoteSupport

Module:
Az.StackHCI Module

Enables Remote Support.

Syntax

Default (Default) 

Enable-AzStackHCIRemoteSupport
    [-AccessLevel] <String>
    [[-ExpireInMinutes] <Int32>]
    [[-SasCredential] <String>]
    [-AgreeToRemoteSupportConsent]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Enables Remote Support allows authorized Microsoft Support users to remotely access the device for diagnostics or repair depending on the access level granted.

Examples

Example 1:

Enable-AzStackHCIRemoteSupport -AccessLevel Diagnostics -ExpireInMinutes 1440 -SasCredential "Sample SAS"

Proceed with enabling remote support?
[Y] Yes  [N] No: Y

Enabling Remote Support for 'Diagnostics' expiring in '1440' minutes.
Using provided SAS credential to make remote support connection.
Remote Support successfully Enabled.


State         : Active
CreatedAt     : 3/29/2022 10:29:19 AM +00:00
UpdatedAt     : 3/29/2022 10:29:19 AM +00:00
TargetService : PowerShell
AccessLevel   : Diagnostics
ExpiresAt     : 3/30/2022 10:29:18 AM +00:00
SasCredential :

Enable Remote Support on machine

Example 2:

Enable-AzStackHCIRemoteSupport -AccessLevel DiagnosticsRepair -ExpireInMinutes 1440 -SasCredential "Sample SAS" -AgreeToRemoteSupportConsent

Enabling Remote Support for 'Diagnostics' expiring in '1440' minutes.
Using provided SAS credential to make remote support connection.
Remote Support successfully Enabled.


State         : Active
CreatedAt     : 3/29/2022 10:29:19 AM +00:00
UpdatedAt     : 3/29/2022 10:29:53 AM +00:00
TargetService : PowerShell
AccessLevel   : Diagnostics
ExpiresAt     : 3/30/2022 10:29:53 AM +00:00
SasCredential :

Enable remote support by providing consent. In this case, user is not prompted for consent

Parameters

-AccessLevel

Controls the remote operations that can be performed. This can be either Diagnostics or DiagnosticsAndRepair.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AgreeToRemoteSupportConsent

Optional. If set to true then records user consent as provided and proceeds without prompt.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ExpireInMinutes

Enables Remote Support allows authorized Microsoft Support users to remotely access the device for diagnostics or repair depending on the access level granted.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:2
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SasCredential

Hybrid Connection SAS Credential.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

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

Outputs

Boolean