SshBaseCmdlet Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
public abstract class SshBaseCmdlet : Microsoft.Azure.Commands.ResourceManager.Common.AzureRMCmdlettype SshBaseCmdlet = class
inherit AzureRMCmdletPublic 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
Extension Methods
| DisableDataCollection(AzurePSCmdlet) | |
| EnableDataCollection(AzurePSCmdlet) |