SshPublicKeyConfiguration 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.
Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed.
public class SshPublicKeyConfiguration : Azure.Provisioning.Primitives.ProvisionableConstructtype SshPublicKeyConfiguration = class
inherit ProvisionableConstructPublic Class SshPublicKeyConfiguration
Inherits ProvisionableConstruct- Inheritance
Constructors
| Name | Description |
|---|---|
| SshPublicKeyConfiguration() |
Creates a new SshPublicKeyConfiguration. |
Properties
| Name | Description |
|---|---|
| KeyData |
SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format. For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed). |
| Path |
Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys. |
Methods
Explicit Interface Implementations
| Name | Description |
|---|---|
| IBicepValue.Assign(IBicepValue) |
Assign a value to this property. (Inherited from ProvisionableConstruct) |
| IBicepValue.Compile() |
Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct) |
| IBicepValue.Expression |
Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsEmpty |
Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsOutput |
Tracks whether this is an output only property. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsRequired |
Tracks whether this property is required. (Inherited from ProvisionableConstruct) |
| IBicepValue.IsSecure |
Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct) |
| IBicepValue.Kind |
Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct) |
| IBicepValue.LiteralValue |
Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct) |
| IBicepValue.Self |
Gets information about where this value was defined. (Inherited from ProvisionableConstruct) |
| IBicepValue.SetReadOnly() |
Make this value readonly. (Inherited from ProvisionableConstruct) |
| IBicepValue.Source |
Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct) |
Extension Methods
| Name | Description |
|---|---|
| ToBicepExpression(IBicepValue) |
Convert a IBicepValue into a BicepExpression by its reference to represent its hierarchy. |
