Skip to content

az sshkey: Migrate command to aaz-based implementation #1104

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.

Sign up for GitHub

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

Open
William (william051200) wants to merge 2 commits into
base: main
Choose a base branch
from
Open

az sshkey: Migrate command to aaz-based implementation #1104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b18be05
Export sshkey from typespec entry
william051200 Sep 23, 2026
75cecc6
Update sshkey create aaz
william051200 Oct 6, 2026
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
15 changes: 15 additions & 0 deletions Commands/sshkey/_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,18 @@ Create a new SSH public key resource.
```bash
sshkey create --resource-group myResourceGroup --ssh-public-key-name mySshPublicKeyName --location westus --public-key {ssh-rsa public key}
```

- Create a new SSH public key resource using public key in a file.
```bash
sshkey create --location "westus" --public-key "@filename" --resource-group "myResourceGroup" --name "mySshPublicKeyName"
```

- Create a new SSH public key resource with auto-generated value.
```bash
sshkey create --location "westus" --resource-group "myResourceGroup" --name "mySshPublicKeyName"
```

- Create a new SSH public key resource with Ed25519 encryption.
```bash
sshkey create --location "westus" --resource-group "myResourceGroup" --name "mySshPublicKeyName" --encryption-type "Ed25519"
```
16 changes: 16 additions & 0 deletions Commands/sshkey/_generate-key-pair.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _sshkey generate-key-pair_

Generate an SSH public/private key pair for an SSH public key resource.

## Versions

### [2025-04-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3NzaHB1YmxpY2tleXMve30vZ2VuZXJhdGVrZXlwYWly/2025-04-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/sshpublickeys/{}/generatekeypair 2025-04-01 -->

#### examples

- Generate an RSA SSH key pair.
```bash
sshkey generate-key-pair --resource-group myResourceGroup --ssh-public-key-name mySshPublicKeyName --encryption-type RSA
```
3 changes: 3 additions & 0 deletions Commands/sshkey/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Manage Ssh Public Key
- [delete](/Commands/sshkey/_delete.md)
: Delete a SSH public key.

- [generate-key-pair](/Commands/sshkey/_generate-key-pair.md)
: Generate an SSH public/private key pair for an SSH public key resource.

- [list](/Commands/sshkey/_list.md)
: List all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.

Expand Down
2 changes: 1 addition & 1 deletion ...ncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3NzaHB1YmxpY2tleXMve30=/2025-04-01.json
View file
Open in desktop

Large diffs are not rendered by default.

182 changes: 68 additions & 114 deletions ...Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL3NzaHB1YmxpY2tleXMve30=/2025-04-01.xml
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions ...kZXJzL21pY3Jvc29mdC5jb21wdXRlL3NzaHB1YmxpY2tleXMve30vZ2VuZXJhdGVrZXlwYWly/2025-04-01.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/sshpublickeys/{}/generatekeypair", "version": "2025-04-01", "swagger": "mgmt-plane/compute/ResourceProviders/Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS9zc2hQdWJsaWNLZXlzL3tzc2hQdWJsaWNLZXlOYW1lfS9nZW5lcmF0ZUtleVBhaXI=/V/MjAyNS0wNC0wMQ=="}], "commandGroups": [{"name": "sshkey", "commands": [{"name": "generate-key-pair", "version": "2025-04-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/sshpublickeys/{}/generatekeypair", "version": "2025-04-01", "swagger": "mgmt-plane/compute/ResourceProviders/Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS9zc2hQdWJsaWNLZXlzL3tzc2hQdWJsaWNLZXlOYW1lfS9nZW5lcmF0ZUtleVBhaXI=/V/MjAyNS0wNC0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "string", "var": "$Path.sshPublicKeyName", "options": ["ssh-public-key-name"], "required": true, "idPart": "name", "help": {"short": "The name of the SSH public key."}, "format": {"pattern": ""}}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}]}, {"name": "Parameters", "args": [{"type": "string", "var": "$body.encryptionType", "options": ["encryption-type"], "group": "Parameters", "help": {"short": "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": {"items": [{"name": "Ed25519", "value": "Ed25519"}, {"name": "RSA", "value": "RSA"}]}}]}], "operations": [{"operationId": "SshPublicKeys_GenerateKeyPair", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}/generateKeyPair", "request": {"method": "post", "path": {"params": [{"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"pattern": "^[-\\w\\._\\(\\)]+$", "maxLength": 90, "minLength": 1}}, {"type": "string", "name": "sshPublicKeyName", "arg": "$Path.sshPublicKeyName", "required": true, "format": {"pattern": ""}}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true, "format": {"minLength": 1}}]}, "query": {"consts": [{"readOnly": true, "const": true, "default": {"value": "2025-04-01"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}, "body": {"json": {"schema": {"type": "object", "name": "body", "props": [{"type": "string", "name": "encryptionType", "arg": "$body.encryptionType", "enum": {"items": [{"value": "Ed25519"}, {"value": "RSA"}]}}], "clientFlatten": true}}}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "object", "props": [{"type": "string", "name": "id", "required": true}, {"type": "string", "name": "privateKey", "required": true}, {"type": "string", "name": "publicKey", "required": true}]}}}}, {"isError": true, "body": {"json": {"schema": {"readOnly": true, "type": "@ODataV4Format"}}}}]}}], "outputs": [{"type": "object", "ref": "$Instance", "clientFlatten": true}]}]}]}
80 changes: 80 additions & 0 deletions ...lkZXJzL21pY3Jvc29mdC5jb21wdXRlL3NzaHB1YmxpY2tleXMve30vZ2VuZXJhdGVrZXlwYWly/2025-04-01.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/sshpublickeys/{}/generatekeypair" version="2025-04-01" swagger="mgmt-plane/compute/ResourceProviders/Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS9zc2hQdWJsaWNLZXlzL3tzc2hQdWJsaWNLZXlOYW1lfS9nZW5lcmF0ZUtleVBhaXI=/V/MjAyNS0wNC0wMQ=="/>
<commandGroup name="sshkey">
<command name="generate-key-pair" version="2025-04-01">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/sshpublickeys/{}/generatekeypair" version="2025-04-01" swagger="mgmt-plane/compute/ResourceProviders/Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS9zc2hQdWJsaWNLZXlzL3tzc2hQdWJsaWNLZXlOYW1lfS9nZW5lcmF0ZUtleVBhaXI=/V/MjAyNS0wNC0wMQ=="/>
<argGroup name="">
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="string" var="$Path.sshPublicKeyName" options="ssh-public-key-name" required="True" idPart="name">
<help short="The name of the SSH public key."/>
<format pattern=""/>
</arg>
<arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/>
</argGroup>
<argGroup name="Parameters">
<arg type="string" var="$body.encryptionType" options="encryption-type" group="Parameters">
<help short="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>
<item name="Ed25519" value="&quot;Ed25519&quot;"/>
<item name="RSA" value="&quot;RSA&quot;"/>
</enum>
</arg>
</argGroup>
<operation operationId="SshPublicKeys_GenerateKeyPair">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}/generateKeyPair">
<request method="post">
<path>
<param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True">
<format pattern="^[-\w\._\(\)]+$" maxLength="90" minLength="1"/>
</param>
<param type="string" name="sshPublicKeyName" arg="$Path.sshPublicKeyName" required="True">
<format pattern=""/>
</param>
<param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True">
<format minLength="1"/>
</param>
</path>
<query>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="&quot;2025-04-01&quot;"/>
<format minLength="1"/>
</const>
</query>
<body>
<json>
<schema type="object" name="body" clientFlatten="True">
<prop type="string" name="encryptionType" arg="$body.encryptionType">
<enum>
<item value="&quot;Ed25519&quot;"/>
<item value="&quot;RSA&quot;"/>
</enum>
</prop>
</schema>
</json>
</body>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="object">
<prop type="string" name="id" required="True"/>
<prop type="string" name="privateKey" required="True"/>
<prop type="string" name="publicKey" required="True"/>
</schema>
</json>
</body>
</response>
<response isError="True">
<body>
<json>
<schema readOnly="True" type="@ODataV4Format"/>
</json>
</body>
</response>
</http>
</operation>
<output type="object" ref="$Instance" clientFlatten="True"/>
</command>
</commandGroup>
</CodeGen>
Loading