Skip to content
Merged
16 changes: 16 additions & 0 deletions Commands/image/_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,19 @@ Create a custom Virtual Machine Image from managed disks or snapshots.
```bash
image create -g MyResourceGroup -n image1 --source MyVm1
```

### [2024-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2ltYWdlcy97fQ==/2024-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/images/{} 2024-11-01 -->

#### examples

- Create an image from an existing disk.
```bash
image create -g MyResourceGroup -n image1 --os-type Linux --source /subscriptions/db5eb68e-73e2-4fa8-b18a-0123456789999/resourceGroups/rg1/providers/Microsoft.Compute/snapshots/s1
```

- Create an image by capturing an existing generalized virtual machine in the same resource group.
```bash
image create -g MyResourceGroup -n image1 --source MyVm1
```
11 changes: 11 additions & 0 deletions Commands/image/_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,14 @@ Delete an Image.
### [2024-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2ltYWdlcy97fQ==/2024-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/images/{} 2024-07-01 -->

### [2024-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2ltYWdlcy97fQ==/2024-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/images/{} 2024-11-01 -->

#### examples

- Image_Delete_MaximumSet_Gen
```bash
image delete --resource-group rgcompute --image-name aaaaaaaaaaaaaaaaaaaaaaaaaaa
```
11 changes: 11 additions & 0 deletions Commands/image/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,14 @@ Get an image.
### [2024-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2ltYWdlcy97fQ==/2024-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/images/{} 2024-07-01 -->

### [2024-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2ltYWdlcy97fQ==/2024-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/images/{} 2024-11-01 -->

#### examples

- Get information about a virtual machine image.
```bash
image show --resource-group myResourceGroup --image-name myImage
```
16 changes: 16 additions & 0 deletions Commands/image/_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,19 @@ Update custom VM images.
```bash
image update -n ImageName -g resourceGroup --tags
```

### [2024-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2ltYWdlcy97fQ==/2024-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/images/{} 2024-11-01 -->

#### examples

- Add or update tags.
```bash
image update -n ImageName -g ResourceGroup --tags tag1=val1 tag2=val2
```

- Remove all tags.
```bash
image update -n ImageName -g resourceGroup --tags
```
3 changes: 3 additions & 0 deletions Commands/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,6 +341,9 @@
- [sql](/Commands/sql/readme.md)
: Manage Azure SQL Databases and Data Warehouses.

- [sshkey](/Commands/sshkey/readme.md)
: Manage Ssh Public Key

- [stack-hci](/Commands/stack-hci/readme.md)
: Manage Azure Stack HCI.

Expand Down
16 changes: 16 additions & 0 deletions Commands/sshkey/_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _sshkey create_

Create a new SSH public key resource.

## Versions

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

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

#### examples

- 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}
```
16 changes: 16 additions & 0 deletions Commands/sshkey/_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _sshkey delete_

Delete a SSH public key.

## Versions

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

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

#### examples

- SshPublicKey_Delete_MaximumSet_Gen
```bash
sshkey delete --resource-group rgcompute --ssh-public-key-name aaaaaaaaaa
```
17 changes: 17 additions & 0 deletions Commands/sshkey/_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# [Command] _sshkey list_

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.

## Versions

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

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

#### examples

- SshPublicKey_ListBySubscription_MaximumSet_Gen
```bash
sshkey list
```
16 changes: 16 additions & 0 deletions Commands/sshkey/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _sshkey show_

Get information about a SSH public key.

## Versions

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

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

#### examples

- Get a ssh public key.
```bash
sshkey show --resource-group myResourceGroup --ssh-public-key-name mySshPublicKeyName
```
16 changes: 16 additions & 0 deletions Commands/sshkey/_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _sshkey update_

Update a SSH public key resource.

## Versions

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

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

#### examples

- Update a SSH public key resource.
```bash
sshkey update --resource-group myResourceGroup --ssh-public-key-name mySshPublicKeyName --public-key {ssh-rsa public key}
```
20 changes: 20 additions & 0 deletions Commands/sshkey/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# [Group] _sshkey_

Manage Ssh Public Key

## Commands

- [create](/Commands/sshkey/_create.md)
: Create a new SSH public key resource.

- [delete](/Commands/sshkey/_delete.md)
: Delete a SSH public key.

- [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.

- [show](/Commands/sshkey/_show.md)
: Get information about a SSH public key.

- [update](/Commands/sshkey/_update.md)
: Update a SSH public key resource.
4 changes: 4 additions & 0 deletions Commands/vm/image/_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,7 @@ List a list of all virtual machine image versions for the specified location, pu
### [2024-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2xvY2F0aW9ucy97fS9wdWJsaXNoZXJzL3t9L2FydGlmYWN0dHlwZXMvdm1pbWFnZS9vZmZlcnMve30vc2t1cy97fS92ZXJzaW9ucw==/2024-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.compute/locations/{}/publishers/{}/artifacttypes/vmimage/offers/{}/skus/{}/versions 2024-07-01 -->

### [2024-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2xvY2F0aW9ucy97fS9wdWJsaXNoZXJzL3t9L2FydGlmYWN0dHlwZXMvdm1pbWFnZS9vZmZlcnMve30vc2t1cy97fS92ZXJzaW9ucw==/2024-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.compute/locations/{}/publishers/{}/artifacttypes/vmimage/offers/{}/skus/{}/versions 2024-11-01 -->
11 changes: 11 additions & 0 deletions Commands/vm/image/_show.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,14 @@ Get a virtual machine image.
### [2024-07-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2xvY2F0aW9ucy97fS9wdWJsaXNoZXJzL3t9L2FydGlmYWN0dHlwZXMvdm1pbWFnZS9vZmZlcnMve30vc2t1cy97fS92ZXJzaW9ucy97fQ==/2024-07-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.compute/locations/{}/publishers/{}/artifacttypes/vmimage/offers/{}/skus/{}/versions/{} 2024-07-01 -->

### [2024-11-01](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5jb21wdXRlL2xvY2F0aW9ucy97fS9wdWJsaXNoZXJzL3t9L2FydGlmYWN0dHlwZXMvdm1pbWFnZS9vZmZlcnMve30vc2t1cy97fS92ZXJzaW9ucy97fQ==/2024-11-01.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/providers/microsoft.compute/locations/{}/publishers/{}/artifacttypes/vmimage/offers/{}/skus/{}/versions/{} 2024-11-01 -->

#### examples

- VirtualMachineImage_Get_MaximumSet_Gen
```bash
vm image show --location aaaaaa --publisher aaa --offer aaaaaaaaaaaaaaaaaaaaaaaaaaaaa --sku aaaaaaaaaaaaaaaaaaaaaaaaaaa --version aaaaaaaaaaaaaaaaaaa
```
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/providers/microsoft.compute/locations/{}/publishers/{}/artifacttypes/vmimage/offers/{}/skus/{}/versions", "version": "2024-11-01", "swagger": "mgmt-plane/compute/ResourceProviders/Microsoft.Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvbG9jYXRpb25zL3tsb2NhdGlvbn0vcHVibGlzaGVycy97cHVibGlzaGVyTmFtZX0vYXJ0aWZhY3R0eXBlcy92bWltYWdlL29mZmVycy97b2ZmZXJ9L3NrdXMve3NrdXN9L3ZlcnNpb25z/V/MjAyNC0xMS0wMQ=="}], "commandGroups": [{"name": "vm image", "commands": [{"name": "list", "version": "2024-11-01", "resources": [{"id": "/subscriptions/{}/providers/microsoft.compute/locations/{}/publishers/{}/artifacttypes/vmimage/offers/{}/skus/{}/versions", "version": "2024-11-01", "swagger": "mgmt-plane/compute/ResourceProviders/Microsoft.Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9wcm92aWRlcnMvTWljcm9zb2Z0LkNvbXB1dGUvbG9jYXRpb25zL3tsb2NhdGlvbn0vcHVibGlzaGVycy97cHVibGlzaGVyTmFtZX0vYXJ0aWZhY3R0eXBlcy92bWltYWdlL29mZmVycy97b2ZmZXJ9L3NrdXMve3NrdXN9L3ZlcnNpb25z/V/MjAyNC0xMS0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "ResourceLocation", "var": "$Path.location", "options": ["l", "location"], "required": true, "idPart": "name"}, {"type": "string", "var": "$Path.offer", "options": ["f", "offer"], "required": true, "group": "", "idPart": "child_name_3", "help": {"short": "A valid image publisher offer."}}, {"type": "string", "var": "$Path.publisherName", "options": ["p", "publisher"], "required": true, "group": "", "idPart": "child_name_1", "help": {"short": "A valid image publisher."}}, {"type": "string", "var": "$Path.skus", "options": ["s", "sku"], "required": true, "group": "", "idPart": "child_name_4", "help": {"short": "A valid image SKU."}}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}, {"type": "string", "var": "$Query.expand", "options": ["expand"], "required": true, "group": "", "help": {"short": "The expand expression to apply on the operation."}, "default": {"value": "properties"}}, {"type": "string", "var": "$Query.orderby", "options": ["orderby"]}, {"type": "integer32", "var": "$Query.top", "options": ["top"]}]}], "operations": [{"operationId": "VirtualMachineImages_ListWithProperties", "http": {"path": "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "location", "arg": "$Path.location", "required": true, "format": {"minLength": 1}}, {"type": "string", "name": "offer", "arg": "$Path.offer", "required": true}, {"type": "string", "name": "publisherName", "arg": "$Path.publisherName", "required": true}, {"type": "string", "name": "skus", "arg": "$Path.skus", "required": true}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true, "format": {"minLength": 1}}]}, "query": {"params": [{"type": "string", "name": "$expand", "arg": "$Query.expand", "required": true}, {"type": "string", "name": "$orderby", "arg": "$Query.orderby"}, {"type": "integer32", "name": "$top", "arg": "$Query.top"}], "consts": [{"readOnly": true, "const": true, "default": {"value": "2024-11-01"}, "type": "string", "name": "api-version", "required": true, "format": {"minLength": 1}}]}}, "responses": [{"statusCode": [200], "body": {"json": {"var": "$Instance", "schema": {"type": "array<object>", "item": {"type": "object", "props": [{"type": "object", "name": "extendedLocation", "props": [{"type": "string", "name": "name"}, {"type": "string", "name": "type", "enum": {"items": [{"value": "EdgeZone"}]}}]}, {"type": "string", "name": "id"}, {"type": "string", "name": "location", "required": true}, {"type": "string", "name": "name", "required": true}, {"type": "object", "name": "properties", "props": [{"type": "string", "name": "architecture", "enum": {"items": [{"value": "Arm64"}, {"value": "x64"}]}}, {"type": "object", "name": "automaticOSUpgradeProperties", "props": [{"type": "boolean", "name": "automaticOSUpgradeSupported", "required": true}]}, {"type": "array<object>", "name": "dataDiskImages", "item": {"type": "object", "props": [{"readOnly": true, "type": "integer32", "name": "lun"}]}, "identifiers": ["lun"]}, {"type": "object", "name": "disallowed", "props": [{"type": "string", "name": "vmDiskType", "enum": {"items": [{"value": "None"}, {"value": "Unmanaged"}]}}]}, {"type": "array<object>", "name": "features", "item": {"type": "object", "props": [{"type": "string", "name": "name"}, {"type": "string", "name": "value"}]}, "identifiers": ["name"]}, {"type": "string", "name": "hyperVGeneration", "enum": {"items": [{"value": "V1"}, {"value": "V2"}]}}, {"type": "object", "name": "imageDeprecationStatus", "props": [{"type": "object", "name": "alternativeOption", "props": [{"type": "string", "name": "type", "enum": {"items": [{"value": "None"}, {"value": "Offer"}, {"value": "Plan"}]}}, {"type": "string", "name": "value"}]}, {"type": "string", "name": "imageState", "enum": {"items": [{"value": "Active"}, {"value": "Deprecated"}, {"value": "ScheduledForDeprecation"}]}}, {"type": "dateTime", "name": "scheduledDeprecationTime", "format": {"protocol": "iso"}}]}, {"type": "object", "name": "osDiskImage", "props": [{"type": "string", "name": "operatingSystem", "required": true, "enum": {"items": [{"value": "Linux"}, {"value": "Windows"}]}}]}, {"type": "object", "name": "plan", "props": [{"type": "string", "name": "name", "required": true}, {"type": "string", "name": "product", "required": true}, {"type": "string", "name": "publisher", "required": true}]}], "clientFlatten": true}, {"type": "object", "name": "tags", "additionalProps": {"item": {"type": "string"}}}]}}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@ODataV4Format"}}}}]}}], "outputs": [{"type": "array", "ref": "$Instance", "clientFlatten": true}], "confirmation": ""}]}]}
Loading