Share via

Microsoft.Compute sshPublicKeys 2024-03-01

  • Article

Bicep resource definition

The sshPublicKeys resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/sshPublicKeys resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Compute/sshPublicKeys@2024-03-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    publicKey: 'string'
  }
}

Property values

sshPublicKeys

Name Description Value
name The resource name string (required)
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
properties Properties of the SSH public key. SshPublicKeyResourceProperties

SshPublicKeyResourceProperties

Name Description Value
publicKey SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. string

ARM template resource definition

The sshPublicKeys resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/sshPublicKeys resource, add the following JSON to your template.

{
  "type": "Microsoft.Compute/sshPublicKeys",
  "apiVersion": "2024-03-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "publicKey": "string"
  }
}

Property values

sshPublicKeys

Name Description Value
type The resource type 'Microsoft.Compute/sshPublicKeys'
apiVersion The resource api version '2024-03-01'
name The resource name string (required)
location Resource location string (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
properties Properties of the SSH public key. SshPublicKeyResourceProperties

SshPublicKeyResourceProperties

Name Description Value
publicKey SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. string

Terraform (AzAPI provider) resource definition

The sshPublicKeys resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Compute/sshPublicKeys resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Compute/sshPublicKeys@2024-03-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      publicKey = "string"
    }
  })
}

Property values

sshPublicKeys

Name Description Value
type The resource type "Microsoft.Compute/sshPublicKeys@2024-03-01"
name The resource name string (required)
location Resource location string (required)
parent_id To deploy to a resource group, use the ID of that resource group. string (required)
tags Resource tags Dictionary of tag names and values.
properties Properties of the SSH public key. SshPublicKeyResourceProperties

SshPublicKeyResourceProperties

Name Description Value
publicKey SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format. string