Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding Query Parameter to GenerateSshKeyPair API #26090

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"api-version": "2023-09-01",
"sshPublicKeyName": "mySshPublicKeyName",
"parameters": {
"encryptionType": "RSA"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This example is for ED25519, but i think the example is for RSA . content is probably switched ?

}
},
"responses": {
"200": {
"body": {
"privateKey": "{ssh private key}",
"publicKey": "{ssh-rsa public key}",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"parameters": {
"subscriptionId": "{subscription-id}",
"resourceGroupName": "myResourceGroup",
"api-version": "2023-09-01",
"sshPublicKeyName": "mySshPublicKeyName",
"parameters": {
"encryptionType": "RSA"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Encryption Type should be Ed25519?

}
},
"responses": {
"200": {
"body": {
"privateKey": "{ed25519 private key}",
"publicKey": "{ed25519 public key}",
"id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName"
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,15 @@
"type": "string",
"description": "The name of the SSH public key."
},
{
"name": "parameters",
"in": "body",
"required": false,
"schema": {
"$ref": "#/definitions/SshGenerateKeyPairInputParameters"
},
"description": "Parameters supplied to generate the SSH public key."
},
{
"$ref": "../../../common-types/v1/common.json#/parameters/ApiVersionParameter"
},
Expand All @@ -395,6 +404,12 @@
"x-ms-examples": {
"Generate an SSH key pair.": {
"$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair.json"
},
"Generate an SSH key pair with RSA encryption.": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Generate a instead of an

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please update this occurrence in other places in this file

"$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithRSA.json"
},
"Generate an SSH key pair with Ed25519 encryption.": {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above Generate a instead of an

"$ref": "./examples/sshPublicKeyExamples/SshPublicKey_GenerateKeyPair_EncryptionWithEd25519.json"
}
}
}
Expand Down Expand Up @@ -480,6 +495,24 @@
"value"
],
"description": "The list SSH public keys operation response."
},
"SshGenerateKeyPairInputParameters": {
"type": "object",
"properties": {
"encryptionType": {
"type": "string",
"description": "The encryption type of the SSH keys to be generated. See SshEncryptionTypes for possible set of values. If not provided, will default to RSA",
"enum": [
"RSA",
"Ed25519"
],
"x-ms-enum": {
"name": "SshEncryptionTypes",
"modelAsString": true
}
}
},
"description": "Parameters for GenerateSshKeyPair."
}
}
}