Share via


SshBaseCmdlet Class

Definition

public abstract class SshBaseCmdlet : Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlet
type SshBaseCmdlet = class
    inherit AzureRMCmdlet
Public MustInherit Class SshBaseCmdlet
Inherits AzureRMCmdlet
Inheritance

Constructors

SshBaseCmdlet()

Fields

_adalListener (Inherited from AzurePSCmdlet)
_clientRequestId (Inherited from AzurePSCmdlet)
_fileTimeStampSuffixFormat (Inherited from AzurePSCmdlet)
_metricHelper (Inherited from AzurePSCmdlet)
_qosEvent (Inherited from AzurePSCmdlet)
_serviceClientTracingInterceptor (Inherited from AzureRMCmdlet)
AUX_HEADER_NAME (Inherited from AzureRMCmdlet)
AUX_TOKEN_APPEND_CHAR (Inherited from AzureRMCmdlet)
AUX_TOKEN_PREFIX (Inherited from AzureRMCmdlet)
createdServiceConfig
deleteCert
deleteKeys
EnqueueDebugKey (Inherited from AzureRMCmdlet)
InteractiveParameterSet
IpAddressParameterSet
MAX_NUMBER_OF_TOKENS_ALLOWED_IN_AUX_HEADER (Inherited from AzureRMCmdlet)
proxyPath
record
ResourceIdParameterSet
supportedResourceTypes
WriteDebugKey (Inherited from AzureRMCmdlet)
WriteInformationKey (Inherited from AzureRMCmdlet)
WriteVerboseKey (Inherited from AzureRMCmdlet)
WriteWarningKey (Inherited from AzureRMCmdlet)

Properties

_dataCollectionProfile (Inherited from AzurePSCmdlet)
_matchers (Inherited from AzurePSCmdlet)
AsJobDynamicParameters (Inherited from AzurePSCmdlet)
CertificateFile

Certificate File for authentication when connecting to a Local User account.

ConfigFilePath

Path to the generated config file.

DataCollectionWarning (Inherited from AzureRMCmdlet)
DebugMessages (Inherited from AzurePSCmdlet)
DefaultContext (Inherited from AzureRMCmdlet)
DefaultProfile (Inherited from AzureRMCmdlet)
Force
ImplementationBackgroundJobDescription (Inherited from AzurePSCmdlet)
Ip

The IP address of the target Azure Virtual Machine.

IsErrorMetricEnabled (Inherited from AzurePSCmdlet)
IsUsageMetricEnabled (Inherited from AzurePSCmdlet)
KeysDestinationFolder

Folder where generated keys will be saved.

LocalUser

Name of a local user in the target machine to connect to. To connect using AAD certificates, don't use this argument.

ModuleName (Inherited from AzurePSCmdlet)
ModuleVersion (Inherited from AzurePSCmdlet)
Name

The name of the target Azure Virtual Machine or Arc Server.

Overwrite

Overwrite existing ConfigFile

PassThru
Port

Port number to connect to on the remote target host.

PrivateKeyFile

Path to a Private Key File. Can be used for key based authentication when connecting to a LocalUser or it can be used in conjuction with a signed public key for AAD Login.

PSVersion
Obsolete.
(Inherited from AzurePSCmdlet)
PublicKeyFile

Path to a Public Key File that will be signed by AAD to create certificate for AAD login.

Rdp

RDP over SSH

ResourceGroupName

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

ResourceId

Id of the target Azure Virtual Machine or Arc Server.

ResourceType

The Type of the target Azure Resource. Either Microsoft.Compute/virtualMachines, Microsoft.HybridCompute/machines, Microsoft.ConnectedVMwarevSphere/virtualMachines, Microsoft.ScVmm/virtualMachines, Microsoft.AzureStackHCI/virtualMachines.

SessionState (Inherited from AzurePSCmdlet)
SshArgument

Additional SSH arguments.

UsePrivateIp

Gets or sets a flag that uses a Private Ip when connecting to an Azure Virtual Machine. User must have a line of sight to the Private Ip. Will fail if no private ip can be found.

Methods

AddDebuggingFilter(Regex) (Inherited from AzurePSCmdlet)
BeginProcessing() (Inherited from AzureRMCmdlet)
CheckIfAgentIsUpToDate()
CheckIfInteractive() (Inherited from AzurePSCmdlet)
ConfirmAction(Boolean, String, String, String, Action, Func<Boolean>) (Inherited from AzurePSCmdlet)
ConfirmAction(Boolean, String, String, String, Action) (Inherited from AzureRMCmdlet)
ConfirmAction(String, String, Action) (Inherited from AzurePSCmdlet)
ConfirmResourceAction(String, Boolean, String, String, Action, Func<Boolean>) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, Action) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, String, Boolean, String, String, Action, Func<Boolean>) (Inherited from AzureRMCmdlet)
ConfirmResourceAction(String, String, String, String, Action) (Inherited from AzureRMCmdlet)
ConstructPSObject(String, Object[]) (Inherited from AzurePSCmdlet)
ConvertEndpointAccessToBase64String(EndpointAccessResource)
CurrentPath() (Inherited from AzurePSCmdlet)
DeleteDirectory(String, String)
DeleteFile(String, String)
Dispose() (Inherited from AzurePSCmdlet)
Dispose(Boolean) (Inherited from AzureRMCmdlet)
EndProcessing() (Inherited from AzureRMCmdlet)
ExecuteCmdlet() (Inherited from AzurePSCmdlet)
FlushInitializationWarnings() (Inherited from AzurePSCmdlet)
GetAuxilaryAuthHeaderFromResourceIds(List<String>) (Inherited from AzureRMCmdlet)
GetAuxiliaryAuthHeaderFromTenantIds(IEnumerable<String>) (Inherited from AzureRMCmdlet)
GetCertificateExpirationTimes()
GetClientApplicationPath(String)
GetDynamicParameters() (Inherited from AzureRMCmdlet)
GetProxyPath()
GetRelayInformation()
GetVmIpAddress()
InitDebuggingFilter() (Inherited from AzurePSCmdlet)
InitializeQosEvent() (Inherited from AzureRMCmdlet)
IsArc()
IsDataCollectionAllowed() (Inherited from AzurePSCmdlet)
IsTerminatingError(Exception) (Inherited from AzurePSCmdlet)
IsVerbose() (Inherited from AzurePSCmdlet)
LoadModuleVersion(String, Boolean) (Inherited from AzurePSCmdlet)
LogCmdletEndInvocationInfo() (Inherited from AzureRMCmdlet)
LogCmdletStartInvocationInfo() (Inherited from AzureRMCmdlet)
LogQosEvent() (Inherited from AzurePSCmdlet)
PrepareAadCredentials(String)
ProcessRecord() (Inherited from AzurePSCmdlet)
RegisterDynamicParameters(RuntimeDefinedParameterDictionary) (Inherited from AzurePSCmdlet)
RequireDefaultContext() (Inherited from AzureRMCmdlet)
ResolveUserPath(String) (Inherited from AzurePSCmdlet)
ResolveUserPath(String[]) (Inherited from AzurePSCmdlet)
SafeWriteOutputPSObject(String, Object[]) (Inherited from AzurePSCmdlet)
SetBackgroundJobDescription(String) (Inherited from AzurePSCmdlet)
SetExecutePermissionForProxyOnLinux(String)
SetResourceType()
SetupDebuggingTraces() (Inherited from AzureRMCmdlet)
SetupHttpClientPipeline() (Inherited from AzurePSCmdlet)
ShouldGetByName(String, String) (Inherited from AzureRMCmdlet)
ShouldListByResourceGroup(String, String) (Inherited from AzureRMCmdlet)
ShouldListBySubscription(String, String) (Inherited from AzureRMCmdlet)
SubResourceWildcardFilter<T>(String, IEnumerable<T>) (Inherited from AzureRMCmdlet)
TearDownDebuggingTraces() (Inherited from AzureRMCmdlet)
TearDownHttpClientPipeline() (Inherited from AzurePSCmdlet)
ThrowTerminatingError(ErrorRecord) (Inherited from AzurePSCmdlet)
TopLevelWildcardFilter<T>(String, String, IEnumerable<T>) (Inherited from AzureRMCmdlet)
TryGetDefaultContext(IAzureContext) (Inherited from AzureRMCmdlet)
UpdateProgressBar(ProgressRecord, String, Int32)
ValidateParameters()
WriteCommandDetail(String) (Inherited from AzurePSCmdlet)
WriteDebug(String) (Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String, Object[]) (Inherited from AzurePSCmdlet)
WriteDebugWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteError(ErrorRecord) (Inherited from AzurePSCmdlet)
WriteErrorWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteExceptionError(Exception) (Inherited from AzurePSCmdlet)
WriteInformation(Object, String[]) (Inherited from AzurePSCmdlet)
WriteInformation(String, Nullable<Boolean>) (Inherited from AzurePSCmdlet)
WriteInformationWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteInitializationWarnings(String) (Inherited from AzurePSCmdlet)
WriteObject(Object, Boolean) (Inherited from AzurePSCmdlet)
WriteObject(Object) (Inherited from AzurePSCmdlet)
WriteProgress(ProgressRecord) (Inherited from AzurePSCmdlet)
WriteSurvey() (Inherited from AzurePSCmdlet)
WriteVerbose(String) (Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String, Object[]) (Inherited from AzurePSCmdlet)
WriteVerboseWithTimestamp(String) (Inherited from AzurePSCmdlet)
WriteWarning(String) (Inherited from AzurePSCmdlet)
WriteWarningWithTimestamp(String) (Inherited from AzurePSCmdlet)

Extension Methods

DisableDataCollection(AzurePSCmdlet)
EnableDataCollection(AzurePSCmdlet)

Applies to