Skip to content
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
9 changes: 9 additions & 0 deletions Commands/vmss/instance-view/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _vmss instance-view show_

Get the status of a VM scale set instance.

## Versions

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

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/instanceview 2024-11-01 -->
8 changes: 8 additions & 0 deletions Commands/vmss/instance-view/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _vmss instance-view_

Manage Instance View

## Commands

- [show](/Commands/vmss/instance-view/_show.md)
: Get the status of a VM scale set instance.
3 changes: 3 additions & 0 deletions Commands/vmss/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,9 @@ Manage groupings of virtual machines in an Azure Virtual Machine Scale Set (VMSS
- [identity](/Commands/vmss/identity/readme.md)
: Manage identities of a VMSS.

- [instance-view](/Commands/vmss/instance-view/readme.md)
: Manage Instance View

- [nic](/Commands/vmss/nic/readme.md)
: Manage network interfaces of a VMSS.

Expand Down
9 changes: 9 additions & 0 deletions Commands/vmss/vms/instance-view/_show.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# [Command] _vmss vms instance-view show_

Get the status of a virtual machine from a VM scale set.

## Versions

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

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/virtualmachines/{}/instanceview 2024-11-01 -->
8 changes: 8 additions & 0 deletions Commands/vmss/vms/instance-view/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# [Group] _vmss vms instance-view_

Manage Instance View

## Commands

- [show](/Commands/vmss/vms/instance-view/_show.md)
: Get the status of a virtual machine from a VM scale set.
3 changes: 3 additions & 0 deletions Commands/vmss/vms/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Manage Virtual Machine
- [identity](/Commands/vmss/vms/identity/readme.md)
: Manage Identity

- [instance-view](/Commands/vmss/vms/instance-view/readme.md)
: Manage Instance View

## Commands

- [create](/Commands/vmss/vms/_create.md)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/instanceview", "version": "2024-11-01", "swagger": "mgmt-plane/compute/ResourceProviders/Microsoft.Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS92aXJ0dWFsTWFjaGluZVNjYWxlU2V0cy97dm1TY2FsZVNldE5hbWV9L2luc3RhbmNlVmlldw==/V/MjAyNC0xMS0wMQ=="}], "commandGroups": [{"name": "vmss instance-view", "commands": [{"name": "show", "version": "2024-11-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/instanceview", "version": "2024-11-01", "swagger": "mgmt-plane/compute/ResourceProviders/Microsoft.Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS92aXJ0dWFsTWFjaGluZVNjYWxlU2V0cy97dm1TY2FsZVNldE5hbWV9L2luc3RhbmNlVmlldw==/V/MjAyNC0xMS0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}, {"type": "string", "var": "$Path.vmScaleSetName", "options": ["vm-scale-set-name"], "required": true, "idPart": "name", "help": {"short": "The name of the VM scale set."}}]}], "operations": [{"operationId": "VirtualMachineScaleSets_GetInstanceView", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true, "format": {"minLength": 1}}, {"type": "string", "name": "vmScaleSetName", "arg": "$Path.vmScaleSetName", "required": true}]}, "query": {"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": "object", "props": [{"readOnly": true, "type": "array<object>", "name": "extensions", "item": {"type": "object", "props": [{"readOnly": true, "type": "string", "name": "name"}, {"readOnly": true, "type": "array<@VirtualMachineStatusCodeCount_read>", "name": "statusesSummary", "item": {"type": "@VirtualMachineStatusCodeCount_read"}}]}, "identifiers": ["name"]}, {"readOnly": true, "type": "array<object>", "name": "orchestrationServices", "item": {"type": "object", "props": [{"readOnly": true, "type": "string", "name": "serviceName", "enum": {"items": [{"value": "AutomaticRepairs"}]}}, {"readOnly": true, "type": "string", "name": "serviceState", "enum": {"items": [{"value": "NotRunning"}, {"value": "Running"}, {"value": "Suspended"}]}}]}, "identifiers": ["serviceName"]}, {"type": "array<object>", "name": "statuses", "item": {"type": "object", "props": [{"type": "string", "name": "code"}, {"type": "string", "name": "displayStatus"}, {"type": "string", "name": "level", "enum": {"items": [{"value": "Error"}, {"value": "Info"}, {"value": "Warning"}]}}, {"type": "string", "name": "message"}, {"type": "dateTime", "name": "time", "format": {"protocol": "iso"}}]}}, {"readOnly": true, "type": "object", "name": "virtualMachine", "props": [{"readOnly": true, "type": "array<object>", "name": "statusesSummary", "item": {"type": "object", "props": [{"readOnly": true, "type": "string", "name": "code"}, {"readOnly": true, "type": "integer32", "name": "count"}], "cls": "VirtualMachineStatusCodeCount_read"}}]}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@ODataV4Format"}}}}]}}], "outputs": [{"type": "object", "ref": "$Instance", "clientFlatten": true}]}]}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<?xml version='1.0' encoding='utf-8'?>
<CodeGen plane="mgmt-plane">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/instanceview" version="2024-11-01" swagger="mgmt-plane/compute/ResourceProviders/Microsoft.Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS92aXJ0dWFsTWFjaGluZVNjYWxlU2V0cy97dm1TY2FsZVNldE5hbWV9L2luc3RhbmNlVmlldw==/V/MjAyNC0xMS0wMQ=="/>
<commandGroup name="vmss instance-view">
<command name="show" version="2024-11-01">
<resource id="/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/instanceview" version="2024-11-01" swagger="mgmt-plane/compute/ResourceProviders/Microsoft.Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS92aXJ0dWFsTWFjaGluZVNjYWxlU2V0cy97dm1TY2FsZVNldE5hbWV9L2luc3RhbmNlVmlldw==/V/MjAyNC0xMS0wMQ=="/>
<argGroup name="">
<arg type="ResourceGroupName" var="$Path.resourceGroupName" options="resource-group g" required="True" idPart="resource_group"/>
<arg type="SubscriptionId" var="$Path.subscriptionId" options="subscription" required="True" idPart="subscription"/>
<arg type="string" var="$Path.vmScaleSetName" options="vm-scale-set-name" required="True" idPart="name">
<help short="The name of the VM scale set."/>
</arg>
</argGroup>
<operation operationId="VirtualMachineScaleSets_GetInstanceView">
<http path="/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView">
<request method="get">
<path>
<param type="string" name="resourceGroupName" arg="$Path.resourceGroupName" required="True">
<format maxLength="90" minLength="1"/>
</param>
<param type="string" name="subscriptionId" arg="$Path.subscriptionId" required="True">
<format minLength="1"/>
</param>
<param type="string" name="vmScaleSetName" arg="$Path.vmScaleSetName" required="True"/>
</path>
<query>
<const readOnly="True" const="True" type="string" name="api-version" required="True">
<default value="&quot;2024-11-01&quot;"/>
<format minLength="1"/>
</const>
</query>
</request>
<response statusCode="200">
<body>
<json var="$Instance">
<schema type="object">
<prop readOnly="True" type="array<object>" name="extensions" identifiers="name">
<item type="object">
<prop readOnly="True" type="string" name="name"/>
<prop readOnly="True" type="array<@VirtualMachineStatusCodeCount_read>" name="statusesSummary">
<item type="@VirtualMachineStatusCodeCount_read"/>
</prop>
</item>
</prop>
<prop readOnly="True" type="array<object>" name="orchestrationServices" identifiers="serviceName">
<item type="object">
<prop readOnly="True" type="string" name="serviceName">
<enum>
<item value="&quot;AutomaticRepairs&quot;"/>
</enum>
</prop>
<prop readOnly="True" type="string" name="serviceState">
<enum>
<item value="&quot;NotRunning&quot;"/>
<item value="&quot;Running&quot;"/>
<item value="&quot;Suspended&quot;"/>
</enum>
</prop>
</item>
</prop>
<prop type="array<object>" name="statuses">
<item type="object">
<prop type="string" name="code"/>
<prop type="string" name="displayStatus"/>
<prop type="string" name="level">
<enum>
<item value="&quot;Error&quot;"/>
<item value="&quot;Info&quot;"/>
<item value="&quot;Warning&quot;"/>
</enum>
</prop>
<prop type="string" name="message"/>
<prop type="dateTime" name="time">
<format protocol="iso"/>
</prop>
</item>
</prop>
<prop readOnly="True" type="object" name="virtualMachine">
<prop readOnly="True" type="array<object>" name="statusesSummary">
<item type="object" cls="VirtualMachineStatusCodeCount_read">
<prop readOnly="True" type="string" name="code"/>
<prop readOnly="True" type="integer32" name="count"/>
</item>
</prop>
</prop>
</schema>
</json>
</body>
</response>
<response isError="True">
<body>
<json>
<schema type="@ODataV4Format"/>
</json>
</body>
</response>
</http>
</operation>
<output type="object" ref="$Instance" clientFlatten="True"/>
</command>
</commandGroup>
</CodeGen>
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"plane": "mgmt-plane", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/virtualmachines/{}/instanceview", "version": "2024-11-01", "swagger": "mgmt-plane/compute/ResourceProviders/Microsoft.Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS92aXJ0dWFsTWFjaGluZVNjYWxlU2V0cy97dm1TY2FsZVNldE5hbWV9L3ZpcnR1YWxNYWNoaW5lcy97aW5zdGFuY2VJZH0vaW5zdGFuY2VWaWV3/V/MjAyNC0xMS0wMQ=="}], "commandGroups": [{"name": "vmss vms instance-view", "commands": [{"name": "show", "version": "2024-11-01", "resources": [{"id": "/subscriptions/{}/resourcegroups/{}/providers/microsoft.compute/virtualmachinescalesets/{}/virtualmachines/{}/instanceview", "version": "2024-11-01", "swagger": "mgmt-plane/compute/ResourceProviders/Microsoft.Compute/Paths/L3N1YnNjcmlwdGlvbnMve3N1YnNjcmlwdGlvbklkfS9yZXNvdXJjZUdyb3Vwcy97cmVzb3VyY2VHcm91cE5hbWV9L3Byb3ZpZGVycy9NaWNyb3NvZnQuQ29tcHV0ZS92aXJ0dWFsTWFjaGluZVNjYWxlU2V0cy97dm1TY2FsZVNldE5hbWV9L3ZpcnR1YWxNYWNoaW5lcy97aW5zdGFuY2VJZH0vaW5zdGFuY2VWaWV3/V/MjAyNC0xMS0wMQ=="}], "argGroups": [{"name": "", "args": [{"type": "string", "var": "$Path.instanceId", "options": ["instance-id"], "required": true, "idPart": "child_name_1", "help": {"short": "The instance ID of the virtual machine."}}, {"type": "ResourceGroupName", "var": "$Path.resourceGroupName", "options": ["g", "resource-group"], "required": true, "idPart": "resource_group"}, {"type": "SubscriptionId", "var": "$Path.subscriptionId", "options": ["subscription"], "required": true, "idPart": "subscription"}, {"type": "string", "var": "$Path.vmScaleSetName", "options": ["vm-scale-set-name"], "required": true, "idPart": "name", "help": {"short": "The name of the VM scale set."}}]}], "operations": [{"operationId": "VirtualMachineScaleSetVMs_GetInstanceView", "http": {"path": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/instanceView", "request": {"method": "get", "path": {"params": [{"type": "string", "name": "instanceId", "arg": "$Path.instanceId", "required": true}, {"type": "string", "name": "resourceGroupName", "arg": "$Path.resourceGroupName", "required": true, "format": {"maxLength": 90, "minLength": 1}}, {"type": "string", "name": "subscriptionId", "arg": "$Path.subscriptionId", "required": true, "format": {"minLength": 1}}, {"type": "string", "name": "vmScaleSetName", "arg": "$Path.vmScaleSetName", "required": true}]}, "query": {"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": "object", "props": [{"readOnly": true, "type": "string", "name": "assignedHost"}, {"type": "object", "name": "bootDiagnostics", "props": [{"readOnly": true, "type": "string", "name": "consoleScreenshotBlobUri"}, {"readOnly": true, "type": "string", "name": "serialConsoleLogBlobUri"}, {"readOnly": true, "type": "@InstanceViewStatus_read", "name": "status"}]}, {"type": "string", "name": "computerName"}, {"type": "array<object>", "name": "disks", "item": {"type": "object", "props": [{"type": "array<object>", "name": "encryptionSettings", "item": {"type": "object", "props": [{"type": "object", "name": "diskEncryptionKey", "props": [{"type": "string", "name": "secretUrl", "required": true}, {"type": "object", "name": "sourceVault", "required": true, "props": [{"type": "ResourceId", "name": "id"}], "cls": "SubResource_read"}]}, {"type": "boolean", "name": "enabled"}, {"type": "object", "name": "keyEncryptionKey", "props": [{"type": "string", "name": "keyUrl", "required": true}, {"type": "@SubResource_read", "name": "sourceVault", "required": true}]}]}}, {"type": "string", "name": "name"}, {"type": "array<@InstanceViewStatus_read>", "name": "statuses", "item": {"type": "@InstanceViewStatus_read"}}]}, "identifiers": ["name"]}, {"type": "array<object>", "name": "extensions", "item": {"type": "object", "props": [{"type": "string", "name": "name"}, {"type": "array<@InstanceViewStatus_read>", "name": "statuses", "item": {"type": "@InstanceViewStatus_read"}}, {"type": "array<@InstanceViewStatus_read>", "name": "substatuses", "item": {"type": "@InstanceViewStatus_read"}}, {"type": "string", "name": "type"}, {"type": "string", "name": "typeHandlerVersion"}]}, "identifiers": ["name", "type"]}, {"type": "string", "name": "hyperVGeneration", "enum": {"items": [{"value": "V1"}, {"value": "V2"}]}}, {"type": "object", "name": "maintenanceRedeployStatus", "props": [{"type": "boolean", "name": "isCustomerInitiatedMaintenanceAllowed"}, {"type": "string", "name": "lastOperationMessage"}, {"type": "string", "name": "lastOperationResultCode", "enum": {"items": [{"value": "MaintenanceAborted"}, {"value": "MaintenanceCompleted"}, {"value": "None"}, {"value": "RetryLater"}]}}, {"type": "dateTime", "name": "maintenanceWindowEndTime", "format": {"protocol": "iso"}}, {"type": "dateTime", "name": "maintenanceWindowStartTime", "format": {"protocol": "iso"}}, {"type": "dateTime", "name": "preMaintenanceWindowEndTime", "format": {"protocol": "iso"}}, {"type": "dateTime", "name": "preMaintenanceWindowStartTime", "format": {"protocol": "iso"}}]}, {"type": "string", "name": "osName"}, {"type": "string", "name": "osVersion"}, {"type": "string", "name": "placementGroupId"}, {"type": "integer32", "name": "platformFaultDomain"}, {"type": "integer32", "name": "platformUpdateDomain"}, {"type": "string", "name": "rdpThumbPrint"}, {"type": "array<@InstanceViewStatus_read>", "name": "statuses", "item": {"type": "@InstanceViewStatus_read"}}, {"type": "object", "name": "vmAgent", "props": [{"type": "array<object>", "name": "extensionHandlers", "item": {"type": "object", "props": [{"type": "object", "name": "status", "props": [{"type": "string", "name": "code"}, {"type": "string", "name": "displayStatus"}, {"type": "string", "name": "level", "enum": {"items": [{"value": "Error"}, {"value": "Info"}, {"value": "Warning"}]}}, {"type": "string", "name": "message"}, {"type": "dateTime", "name": "time", "format": {"protocol": "iso"}}], "cls": "InstanceViewStatus_read"}, {"type": "string", "name": "type"}, {"type": "string", "name": "typeHandlerVersion"}]}}, {"type": "array<@InstanceViewStatus_read>", "name": "statuses", "item": {"type": "@InstanceViewStatus_read"}}, {"type": "string", "name": "vmAgentVersion"}]}, {"readOnly": true, "type": "object", "name": "vmHealth", "props": [{"readOnly": true, "type": "@InstanceViewStatus_read", "name": "status"}]}]}}}}, {"isError": true, "body": {"json": {"schema": {"type": "@ODataV4Format"}}}}]}}], "outputs": [{"type": "object", "ref": "$Instance", "clientFlatten": true}]}]}]}
Loading