azurermSshPublicKey
Manages a SSH Public Key.
Example Usage
/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as azurerm from "./.gen/providers/azurerm";
/*The following providers are missing schema information and might need manual adjustments to synthesize correctly: azurerm.
For a more precise conversion please use the --provider flag in convert.*/
new azurerm.sshPublicKey.SshPublicKey(this, "example", {
location: "West Europe",
name: "example",
public_key: '${file("~/.ssh/id_rsa.pub")}',
resource_group_name: "example",
});
Arguments Reference
The following arguments are supported:
-
location- (Required) The Azure Region where the SSH Public Key should exist. Changing this forces a new SSH Public Key to be created. -
name- (Required) The name which should be used for this SSH Public Key. Changing this forces a new SSH Public Key to be created. -
publicKey- (Required) SSH public key used to authenticate to a virtual machine through ssh. the provided public key needs to be at least 2048-bit and in ssh-rsa format. -
resourceGroupName- (Required) The name of the Resource Group where the SSH Public Key should exist. Changing this forces a new SSH Public Key to be created.
tags- (Optional) A mapping of tags which should be assigned to the SSH Public Key.
Attributes Reference
In addition to the Arguments listed above - the following Attributes are exported:
id- The ID of the SSH Public Key.
Timeouts
The timeouts block allows you to specify timeouts for certain actions:
create- (Defaults to 45 minutes) Used when creating the SSH Public Key.read- (Defaults to 5 minutes) Used when retrieving the SSH Public Key.update- (Defaults to 45 minutes) Used when updating the SSH Public Key.delete- (Defaults to 45 minutes) Used when deleting the SSH Public Key.
Import
SSH Public Keys can be imported using the resourceId, e.g.