swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector VirtualMachines API schemes: - https tags: - name: VirtualMachines paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/assessPatches : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesAssesspatches x-ms-examples: Assess patch state of a machine.: $ref: ./examples/VirtualMachineAssessPatches.json description: The operation to assess patches on a vSphere VMware machine identity in Azure. parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: virtualMachineName in: path required: true type: string description: The name of the vSphere VMware machine. responses: '200': description: OK schema: $ref: '#/definitions/VirtualMachineAssessPatchesResult' '202': description: HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously. headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Connectedvmwarevsphere Virtualmachines Virtualmachinename Assesspatches ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/installPatches : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesInstallpatches description: The operation to install patches on a vSphere VMware machine identity in Azure. x-ms-examples: Install patch state of a machine.: $ref: ./examples/VirtualMachineInstallPatches.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/subscriptionId' - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: virtualMachineName in: path required: true type: string description: The name of the vSphere VMware machine. - name: installPatchesInput in: body required: true schema: $ref: '#/definitions/VirtualMachineInstallPatchesParameters' description: Input for InstallPatches as directly received by the API responses: '200': description: OK schema: $ref: '#/definitions/VirtualMachineInstallPatchesResult' '202': description: HTTP 202 (Accepted) if the operation was successfully started and will complete asynchronously. headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Connectedvmwarevsphere Virtualmachines Virtualmachinename Installpatches ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName} : put: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesCreateorupdate description: Create Or Update virtual machine. summary: Microsoft Azure Implements Virtual Machine Put Method x-ms-examples: CreateVirtualMachine: $ref: ./examples/CreateVirtualMachine.json consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineName required: true type: string description: Name of the virtual machine resource. - $ref: '#/parameters/api-version' - in: body name: body description: Request payload. schema: $ref: '#/definitions/VirtualMachine' responses: '200': description: Arm resource update successful. schema: $ref: '#/definitions/VirtualMachine' '201': description: Created schema: $ref: '#/definitions/VirtualMachine' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation get: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesGet summary: Microsoft Azure Gets A Virtual Machine description: Implements virtual machine GET method. x-ms-examples: GetVirtualMachine: $ref: ./examples/GetVirtualMachine.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineName required: true type: string description: Name of the virtual machine resource. - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/VirtualMachine' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse patch: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesUpdate summary: Microsoft Azure Updates A Virtual Machine description: API to update certain properties of the virtual machine resource. x-ms-examples: UpdateVirtualMachine: $ref: ./examples/UpdateVirtualMachine.json consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineName required: true type: string description: Name of the virtual machine resource. - $ref: '#/parameters/api-version' - in: body name: body description: Resource properties to update. schema: $ref: '#/definitions/VirtualMachineUpdate' responses: '200': description: Arm resource update successful. schema: $ref: '#/definitions/VirtualMachine' '201': description: Created schema: $ref: '#/definitions/VirtualMachine' '202': description: Accepted headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true delete: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesDelete summary: Microsoft Azure Deletes An Virtual Machine description: Implements virtual machine DELETE method. x-ms-examples: DeleteVirtualMachine: $ref: ./examples/DeleteVirtualMachine.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineName description: Name of the virtual machine resource. required: true type: string - $ref: '#/parameters/api-version' - in: query name: deleteFromHost description: Whether to delete the VM from the vCenter. required: false type: boolean - in: query name: force description: Whether force delete was specified. required: false type: boolean responses: '200': description: Success '202': description: Accepted headers: Location: type: string '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/stop : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesStop description: Stop virtual machine. summary: Microsoft Azure Implements The Operation To Stop A Virtual Machine x-ms-examples: StopVirtualMachine: $ref: ./examples/StopVirtualMachine.json consumes: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineName description: Name of the virtual machine resource. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: Virtualmachine stop action payload. schema: $ref: '#/definitions/StopVirtualMachineOptions' responses: '200': description: Success '202': description: Accepted headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/start : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesStart description: Start virtual machine. summary: Microsoft Azure Implements The Operation To Start A Virtual Machine x-ms-examples: StartVirtualMachine: $ref: ./examples/StartVirtualMachine.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineName description: Name of the virtual machine resource. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success '202': description: Accepted headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/restart : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesRestart description: Restart virtual machine. summary: Microsoft Azure Implements The Operation To Restart A Virtual Machine x-ms-examples: RestartVirtualMachine: $ref: ./examples/RestartVirtualMachine.json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineName description: Name of the virtual machine resource. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success '202': description: Accepted headers: Location: type: string default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location /subscriptions/{subscriptionId}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines: get: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesListall summary: Microsoft Azure Implements Get Virtualmachines In A Subscription description: List of virtualMachines in a subscription. x-ms-examples: ListVirtualMachines: $ref: ./examples/ListVirtualMachines.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/VirtualMachinesList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines : get: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesList summary: Microsoft Azure Implements Get Virtualmachines In A Resource Group description: List of virtualMachines in a resource group. x-ms-examples: ListVirtualMachinesByResourceGroup: $ref: ./examples/ListVirtualMachinesByResourceGroup.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/VirtualMachinesList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines : get: tags: - VirtualMachines description: List virtual machines in a given lab. operationId: microsoftAzureVirtualmachinesList parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)''' type: string - name: $filter in: query description: 'The filter to apply to the operation. Example: ''$filter=contains(name,''myName'')' type: string - name: $top in: query description: 'The maximum number of resources to return from the operation. Example: ''$top=10''' type: integer format: int32 - name: $orderby in: query description: 'The ordering expression for the results, using OData notation. Example: ''$orderby=name desc''' type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/LabVirtualMachineList' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink x-ms-odata: '#/definitions/LabVirtualMachine' x-ms-examples: VirtualMachines_List: $ref: ./examples/VirtualMachines_List.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name} : get: tags: - VirtualMachines description: Get virtual machine. operationId: microsoftAzureVirtualmachinesGet parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - name: $expand in: query description: 'Specify the $expand query. Example: ''properties($expand=artifacts,computeVm,networkInterface,applicableSchedule)''' type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/LabVirtualMachine' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Get: $ref: ./examples/VirtualMachines_Get.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name put: tags: - VirtualMachines description: Create or replace an existing virtual machine. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesCreateorupdate parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - name: labVirtualMachine in: body description: A virtual machine. required: true schema: $ref: '#/definitions/LabVirtualMachine' - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/LabVirtualMachine' '201': description: Created schema: $ref: '#/definitions/LabVirtualMachine' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_CreateOrUpdate: $ref: ./examples/VirtualMachines_CreateOrUpdate.json x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name delete: tags: - VirtualMachines description: Delete virtual machine. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesDelete parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted '204': description: No Content default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Delete: $ref: ./examples/VirtualMachines_Delete.json x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name patch: tags: - VirtualMachines description: Allows modifying tags of virtual machines. All other properties will be ignored. operationId: microsoftAzureVirtualmachinesUpdate parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - name: labVirtualMachine in: body description: A virtual machine. required: true schema: $ref: '#/definitions/LabVirtualMachineFragment' - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/LabVirtualMachine' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Update: $ref: ./examples/VirtualMachines_Update.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/addDataDisk : post: tags: - VirtualMachines description: Attach a new or existing data disk to virtual machine. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesAdddatadisk parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - name: dataDiskProperties in: body description: Request body for adding a new or existing data disk to a virtual machine. required: true schema: $ref: '#/definitions/DataDiskProperties' - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_AddDataDisk: $ref: ./examples/VirtualMachines_AddDataDisk.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Adddatadisk ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/applyArtifacts : post: tags: - VirtualMachines description: Apply artifacts to virtual machine. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesApplyartifacts parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - name: applyArtifactsRequest in: body description: Request body for applying artifacts to a virtual machine. required: true schema: $ref: '#/definitions/ApplyArtifactsRequest' - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_ApplyArtifacts: $ref: ./examples/VirtualMachines_ApplyArtifacts.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Applyartifacts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/claim : post: tags: - VirtualMachines description: Take ownership of an existing virtual machine This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesClaim parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Claim: $ref: ./examples/VirtualMachines_Claim.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Claim ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/detachDataDisk : post: tags: - VirtualMachines description: Detach the specified disk from the virtual machine. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesDetachdatadisk parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - name: detachDataDiskProperties in: body description: Request body for detaching data disk from a virtual machine. required: true schema: $ref: '#/definitions/DetachDataDiskProperties' - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_DetachDataDisk: $ref: ./examples/VirtualMachines_DetachDataDisk.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Detachdatadisk ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/getRdpFileContents : post: tags: - VirtualMachines description: Gets a string that represents the contents of the RDP file for the virtual machine operationId: microsoftAzureVirtualmachinesGetrdpfilecontents parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/RdpConnection' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_GetRdpFileContents: $ref: ./examples/VirtualMachines_GetRdpFileContents.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Getrdpfilecontents ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/listApplicableSchedules : post: tags: - VirtualMachines description: Lists the applicable start/stop schedules, if any. operationId: microsoftAzureVirtualmachinesListapplicableschedules parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK schema: $ref: '#/definitions/ApplicableSchedule' default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_ListApplicableSchedules: $ref: ./examples/VirtualMachines_ListApplicableSchedules.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Listapplicableschedules ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/redeploy : post: tags: - VirtualMachines description: Redeploy a virtual machine This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesRedeploy parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Redeploy: $ref: ./examples/VirtualMachines_Redeploy.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Redeploy ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/resize : post: tags: - VirtualMachines description: Resize Virtual Machine. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesResize parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - name: resizeLabVirtualMachineProperties in: body description: Request body for resizing a virtual machine. required: true schema: $ref: '#/definitions/ResizeLabVirtualMachineProperties' - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Resize: $ref: ./examples/VirtualMachines_Resize.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Resize ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/restart : post: tags: - VirtualMachines description: Restart a virtual machine. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesRestart parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Restart: $ref: ./examples/VirtualMachines_Restart.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Restart ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/start : post: tags: - VirtualMachines description: Start a virtual machine. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesStart parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Start: $ref: ./examples/VirtualMachines_Start.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Start ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/stop : post: tags: - VirtualMachines description: Stop a virtual machine This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesStop parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_Stop: $ref: ./examples/VirtualMachines_Stop.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Stop ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/transferDisks : post: tags: - VirtualMachines description: Transfers all data disks attached to the virtual machine to be owned by the current user. This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesTransferdisks parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_TransferDisks: $ref: ./examples/VirtualMachines_TransferDisks.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Transferdisks ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevTestLab/labs/{labName}/virtualmachines/{name}/unClaim : post: tags: - VirtualMachines description: Release ownership of an existing virtual machine This operation can take a while to complete. operationId: microsoftAzureVirtualmachinesUnclaim parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/resourceGroupName_2' - name: labName in: path description: The name of the lab. required: true type: string - name: name in: path description: The name of the virtual machine. required: true type: string - $ref: '#/parameters/api-version_2' responses: '200': description: OK '202': description: Accepted default: description: BadRequest schema: $ref: '#/definitions/CloudError' x-ms-examples: VirtualMachines_UnClaim: $ref: ./examples/VirtualMachines_UnClaim.json x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Devtestlab Labs Labname Virtualmachines Name Unclaim ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/listHosts : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesListhosts description: Lists the HDInsight clusters hosts x-ms-examples: Get All hosts in the cluster: $ref: ./examples/GetClusterVirtualMachines.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: OK response definition. schema: $ref: '#/definitions/HostInfoListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusters Clustername Listhosts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesRestarthosts description: Restarts the specified HDInsight cluster hosts. x-ms-examples: Restarts the specified HDInsight cluster hosts.: $ref: ./examples/RestartVirtualMachinesOperation.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/ApiVersionParameter' - name: hosts in: body required: true schema: $ref: '#/definitions/RestartHostsParameters' description: The list of hosts to restart responses: '200': description: OK response definition. '202': description: Accepted response definition. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusters Clustername Restarthosts ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts/azureasyncoperations/{operationId} : get: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesGetasyncoperationstatus description: Gets the async operation status. x-ms-examples: Gets the async operation status of restarting host.: $ref: ./examples/GetRestartHostsAsyncOperationStatus.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/OperationIdParameter' responses: '200': description: OK response definition. schema: $ref: ./cluster.json#/definitions/AsyncOperationResult default: description: Error response describing why the operation failed. schema: $ref: ./operations.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hdinsight Clusters Clustername Restarthosts Azureasyncoperations Operationid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesRuncommand x-ms-examples: VirtualMachineRunCommand: $ref: ./examples/runCommandExamples/VirtualMachineRunCommand.json description: Run command on the VM. parameters: - name: resourceGroupName in: path required: true type: string description: The name of the resource group. - name: vmName in: path required: true type: string description: The name of the virtual machine. - name: parameters in: body required: true schema: $ref: '#/definitions/RunCommandInput' description: Parameters supplied to the Run command operation. - $ref: ../../../common-types/v1/common.json#/parameters/ApiVersionParameter - $ref: ../../../common-types/v1/common.json#/parameters/SubscriptionIdParameter responses: '200': description: OK schema: $ref: '#/definitions/RunCommandResult' '202': description: Accepted x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Compute Virtualmachines Vmname Runcommand ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName} : get: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesGet summary: Microsoft Azure Gets A Virtualmachine description: Implements VirtualMachine GET method. x-ms-examples: GetVirtualMachine: $ref: ./examples/GetVirtualMachine.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Retrieves the VirtualMachines resource. schema: $ref: '#/definitions/VirtualMachine_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' put: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesCreateorupdate description: Creates Or Updates virtual machines deployed on scvmm fabric. summary: Microsoft Azure Implements Virtualmachines Put Method x-ms-examples: CreateVirtualMachine: $ref: ./examples/CreateVirtualMachine.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - $ref: '#/parameters/ApiVersionParameter_2' - name: body description: Request payload. in: body required: true schema: $ref: '#/definitions/VirtualMachine_2' responses: '200': description: Creates or Updates the VirtualMachines resource. schema: $ref: '#/definitions/VirtualMachine_2' '201': description: Creates or Updates the VirtualMachines resource. schema: $ref: '#/definitions/VirtualMachine_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation delete: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesDelete summary: Microsoft Azure Implements Virtualmachine Delete Method description: Deletes a VirtualMachine deployed on ScVmm fabric. x-ms-examples: DeleteVirtualMachine: $ref: ./examples/DeleteVirtualMachine.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - $ref: '#/parameters/ApiVersionParameter_2' - in: query name: retain description: Whether to just disable the VM from azure and retain the VM in the VMM. required: false type: boolean - in: query name: force description: Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too. required: false type: boolean - in: query name: deleteFromHost description: Whether to disable the VM from azure and also delete it from VMM. required: false type: boolean responses: '200': description: Deletes the VirtualMachines resource. '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation patch: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesUpdate summary: Microsoft Azure Implements The Virtualmachines Patch Method description: Updates the VirtualMachines resource. x-ms-examples: UpdateVirtualMachine: $ref: ./examples/UpdateVirtualMachine.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - name: body description: VirtualMachines patch payload. in: body required: true schema: $ref: '#/definitions/VirtualMachineUpdate_2' responses: '200': description: Successful. schema: $ref: '#/definitions/VirtualMachine_2' '201': description: Creates or Updates the VirtualMachines resource. schema: $ref: '#/definitions/VirtualMachine_2' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/stop : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesStop description: Stop virtual machine. summary: Microsoft Azure Implements The Operation To Stop A Virtual Machine x-ms-examples: StopVirtualMachine: $ref: ./examples/StopVirtualMachine.json consumes: - application/json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - in: body name: body description: Virtualmachine stop action payload. schema: $ref: '#/definitions/StopVirtualMachineOptions' responses: '200': description: Success '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/start : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesStart description: Start virtual machine. summary: Microsoft Azure Implements The Operation To Start A Virtual Machine x-ms-examples: StartVirtualMachine: $ref: ./examples/StartVirtualMachine.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. responses: '200': description: Success '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/restart : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesRestart description: Restart virtual machine. summary: Microsoft Azure Implements The Operation To Restart A Virtual Machine x-ms-examples: RestartVirtualMachine: $ref: ./examples/RestartVirtualMachine.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. responses: '200': description: Success '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/createCheckpoint : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesCreatecheckpoint description: Creates a checkpoint in virtual machine. summary: Microsoft Azure Implements The Operation To Creates A Checkpoint In A Virtual Machine x-ms-examples: CreateCheckpointVirtualMachine: $ref: ./examples/CreateCheckpointVirtualMachine.json consumes: - application/json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - in: body name: body description: Virtualmachine create checkpoint action payload. schema: $ref: '#/definitions/VirtualMachineCreateCheckpoint' responses: '200': description: Success '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/deleteCheckpoint : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesDeletecheckpoint description: Deletes a checkpoint in virtual machine. summary: Microsoft Azure Implements The Operation To Delete A Checkpoint In A Virtual Machine x-ms-examples: DeleteCheckpointVirtualMachine: $ref: ./examples/DeleteCheckpointVirtualMachine.json consumes: - application/json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - in: body name: body description: Virtualmachine delete checkpoint action payload. schema: $ref: '#/definitions/VirtualMachineDeleteCheckpoint' responses: '200': description: Success '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/restoreCheckpoint : post: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesRestorecheckpoint description: Restores to a checkpoint in virtual machine. summary: Microsoft Azure Implements The Operation To Restores To A Checkpoint In A Virtual Machine x-ms-examples: RestoreCheckpointVirtualMachine: $ref: ./examples/RestoreCheckpointVirtualMachine.json consumes: - application/json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - in: body name: body description: Virtualmachine restore checkpoint action payload. schema: $ref: '#/definitions/VirtualMachineRestoreCheckpoint' responses: '200': description: Success '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-long-running-operation: true /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines: get: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesListbyresourcegroup summary: Microsoft Azure Implements Get Virtualmachines In A Resource Group description: List of VirtualMachines in a resource group. x-ms-examples: ListVirtualMachinesByResourceGroup: $ref: ./examples/ListVirtualMachinesByResourceGroup.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Lists all VirtualMachines under the resource group. schema: $ref: '#/definitions/VirtualMachineListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualMachines: get: tags: - VirtualMachines operationId: microsoftAzureVirtualmachinesListbysubscription summary: Microsoft Azure Implements Get Virtualmachines In A Subscription description: List of VirtualMachines in a subscription. x-ms-examples: ListVirtualMachinesBySubscription: $ref: ./examples/ListVirtualMachinesBySubscription.json parameters: - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Lists all VirtualMachines under the subscription. schema: $ref: '#/definitions/VirtualMachineListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/virtualMachines: get: description: Returns list virtual machine within subscription consumes: - application/json produces: - application/json tags: - VirtualMachines summary: Microsoft Azure Implements List Virtual Machine Within Subscription Method operationId: microsoftAzureVirtualmachinesListbysubscription parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/api-version_3' - type: string description: The filter to apply on the list operation name: $filter in: query - type: integer format: int32 description: The maximum number of record sets to return name: $top in: query - type: string description: to be used by nextLink implementation name: $skipToken in: query responses: '200': description: successful operation schema: $ref: '#/definitions/VirtualMachineListResponse' default: description: General Error schema: $ref: '#/definitions/CSRPError' x-ms-examples: ListVirtualMachines: $ref: ./examples/ListVirtualMachines.json x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines: get: description: Returns list of virtual machine within resource group consumes: - application/json produces: - application/json tags: - VirtualMachines summary: Microsoft Azure Implements List Virtual Machine Within Rg Method operationId: microsoftAzureVirtualmachinesListbyresourcegroup parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - $ref: '#/parameters/api-version_3' - type: string description: The filter to apply on the list operation name: $filter in: query - type: integer format: int32 description: The maximum number of record sets to return name: $top in: query - type: string description: to be used by nextLink implementation name: $skipToken in: query responses: '200': description: successful operation schema: $ref: '#/definitions/VirtualMachineListResponse' default: description: General Error schema: $ref: '#/definitions/CSRPError' x-ms-examples: ListRGVirtualMachines: $ref: ./examples/ListRGVirtualMachines.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName} : get: description: Get virtual machine consumes: - application/json produces: - application/json tags: - VirtualMachines summary: Microsoft Azure Implements Virtual Machine Get Method operationId: microsoftAzureVirtualmachinesGet parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - type: string description: virtual machine name name: virtualMachineName in: path required: true - $ref: '#/parameters/api-version_3' responses: '200': description: successful operation schema: $ref: '#/definitions/VirtualMachine_3' default: description: General Error schema: $ref: '#/definitions/CSRPError' x-ms-examples: GetVirtualMachine: $ref: ./examples/GetVirtualMachine.json put: description: Create Or Update Virtual Machine consumes: - application/json produces: - application/json tags: - VirtualMachines summary: Microsoft Azure Implements Virtual Machine Put Method operationId: microsoftAzureVirtualmachinesCreateorupdate parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - $ref: '#/parameters/referer' - pattern: ^[a-zA-Z0-9]([-_.a-zA-Z0-9]*[a-zA-Z0-9])?$ type: string description: virtual machine name name: virtualMachineName in: path required: true - description: Create or Update Virtual Machine request name: virtualMachineRequest in: body required: true schema: $ref: '#/definitions/VirtualMachine_3' - $ref: '#/parameters/api-version_3' responses: '200': description: If resource is created or updated successfully, 200 should be returned schema: $ref: '#/definitions/VirtualMachine_3' headers: Azure-AsyncOperation: type: string '201': description: If resource is created or updated successfully, 201 should be returned. provisionedState would of VirtualMachineProperties object would reflect the state of the resource schema: $ref: '#/definitions/VirtualMachine_3' headers: Azure-AsyncOperation: type: string default: description: General Error schema: $ref: '#/definitions/CSRPError' x-ms-examples: CreateVirtualMachine: $ref: ./examples/CreateVirtualMachine.json x-ms-long-running-operation: true delete: description: Delete virtual machine consumes: - application/json tags: - VirtualMachines summary: Microsoft Azure Implements Virtual Machine Delete Method operationId: microsoftAzureVirtualmachinesDelete parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - $ref: '#/parameters/referer' - type: string description: virtual machine name name: virtualMachineName in: path required: true - $ref: '#/parameters/api-version_3' responses: '202': description: accepted. the operation will complete asynchronously headers: Azure-AsyncOperation: type: string Location: type: string Retry-After: type: integer '204': description: no content. resource does not exist and the request is well formed default: description: General Error schema: $ref: '#/definitions/CSRPError' headers: Content-Type: type: string default: application/json x-ms-examples: DeleteVirtualMachine: $ref: ./examples/DeleteVirtualMachine.json x-ms-long-running-operation: true patch: description: Patch virtual machine properties consumes: - application/json produces: - application/json tags: - VirtualMachines summary: Microsoft Azure Implements Virtual Machine Patch Method operationId: microsoftAzureVirtualmachinesUpdate parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - type: string description: virtual machine name name: virtualMachineName in: path required: true - description: Patch virtual machine request name: virtualMachineRequest in: body required: true schema: $ref: '#/definitions/PatchPayload' - $ref: '#/parameters/api-version_3' responses: '200': description: If resource is created or updated successfully, 200 should be returned schema: $ref: '#/definitions/VirtualMachine_3' default: description: General Error schema: $ref: '#/definitions/CSRPError' x-ms-examples: PatchVirtualMachine: $ref: ./examples/PatchVirtualMachine.json x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/start : post: description: Power on virtual machine consumes: - application/json tags: - VirtualMachines summary: Microsoft Azure Implements A Start Method For A Virtual Machine operationId: microsoftAzureVirtualmachinesStart parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - $ref: '#/parameters/referer' - type: string description: virtual machine name name: virtualMachineName in: path required: true - $ref: '#/parameters/api-version_3' responses: '200': description: OK '202': description: Accepted. the operation will complete asynchronously headers: Azure-AsyncOperation: type: string Location: type: string Retry-After: type: integer default: description: General Error schema: $ref: '#/definitions/CSRPError' headers: Content-Type: type: string default: application/json x-ms-examples: StartVirtualMachine: $ref: ./examples/StartVirtualMachine.json x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/virtualMachines/{virtualMachineName}/stop : post: description: 'Power off virtual machine, options: shutdown, poweroff, and suspend' consumes: - application/json tags: - VirtualMachines summary: Microsoft Azure Implements Shutdown, Poweroff, And Suspend Method For A Virtual Machine operationId: microsoftAzureVirtualmachinesStop parameters: - $ref: '#/parameters/subscriptionId_3' - $ref: '#/parameters/resourceGroupName_3' - $ref: '#/parameters/referer' - type: string description: virtual machine name name: virtualMachineName in: path required: true - description: body stop mode parameter (reboot, shutdown, etc...) name: m in: body schema: $ref: '#/definitions/VirtualMachineStopMode' - enum: - reboot - suspend - shutdown - poweroff type: string x-ms-enum: modelAsString: false name: StopMode description: query stop mode parameter (reboot, shutdown, etc...) name: mode in: query - $ref: '#/parameters/api-version_3' responses: '200': description: OK '202': description: Accepted. the operation will complete asynchronously headers: Azure-AsyncOperation: type: string Location: type: string Retry-After: type: integer default: description: General Error schema: $ref: '#/definitions/CSRPError' headers: Content-Type: type: string default: application/json x-ms-examples: StopInBodyVirtualMachine: $ref: ./examples/StopInBodyVirtualMachine.json StopInQueryVirtualMachine: $ref: ./examples/StopInQueryVirtualMachine.json x-ms-long-running-operation: true definitions: SCSIControllerType: description: Defines the different types of SCSI controllers. enum: - lsilogic - buslogic - pvscsi - lsilogicsas type: string x-ms-enum: modelAsString: true name: SCSIControllerType UefiSettings: type: object properties: secureBootEnabled: type: boolean description: Specifies whether secure boot should be enabled on the virtual machine. description: Specifies the security settings like secure boot used while creating the virtual machine. ResourcePool: description: Resource pool model required: - id properties: id: description: resource pool id (privateCloudId:vsphereId) type: string location: description: Azure region type: string readOnly: true name: description: '{ResourcePoolName}' type: string readOnly: true privateCloudId: description: The Private Cloud Id type: string readOnly: true properties: description: Resource pool properties x-ms-client-flatten: true $ref: '#/definitions/ResourcePoolProperties' type: description: '{resourceProviderNamespace}/{resourceType}' type: string readOnly: true ScheduleProperties: description: Properties of a schedule. type: object properties: status: description: The status of the schedule (i.e. Enabled, Disabled) default: Disabled enum: - Enabled - Disabled type: string x-ms-enum: name: EnableStatus modelAsString: true taskType: description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). type: string weeklyRecurrence: $ref: '#/definitions/WeekDetails' description: If the schedule will occur only some days of the week, specify the weekly recurrence. dailyRecurrence: $ref: '#/definitions/DayDetails' description: If the schedule will occur once each day of the week, specify the daily recurrence. hourlyRecurrence: $ref: '#/definitions/HourDetails' description: If the schedule will occur multiple times a day, specify the hourly recurrence. timeZoneId: description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) type: string notificationSettings: $ref: '#/definitions/NotificationSettings' description: Notification settings. createdDate: format: date-time description: The creation date of the schedule. type: string readOnly: true targetResourceId: description: The resource ID to which the schedule belongs type: string provisioningState: description: The provisioning status of the resource. type: string readOnly: true uniqueIdentifier: description: The unique immutable identifier of a resource (Guid). type: string readOnly: true RestartHostsParameters: type: array items: type: string description: The list of hosts which need to be restarted. StorageProfile_2: description: Defines the resource properties. type: object properties: disks: description: Gets or sets the list of virtual disks associated with the virtual machine. type: array items: $ref: '#/definitions/VirtualDisk_2' x-ms-identifiers: - name - diskId NotificationSettings: description: Notification settings for a schedule. type: object properties: status: description: If notifications are enabled for this schedule (i.e. Enabled, Disabled). default: Disabled enum: - Enabled - Disabled type: string x-ms-enum: name: EnableStatus modelAsString: true timeInMinutes: format: int32 description: Time in minutes before event at which notification will be sent. type: integer webhookUrl: description: The webhook URL to which the notification will be sent. type: string emailRecipient: description: The email recipient to send notifications to (can be a list of semi-colon separated email addresses). type: string notificationLocale: description: The locale to use when sending a notification (fallback for unsupported languages is EN). type: string DayDetails: description: Properties of a daily schedule. type: object properties: time: description: The time of day the schedule will occur. type: string PlacementProfile: description: Specifies the compute and storage placement settings for the virtual machine. type: object properties: resourcePoolId: type: string description: Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will deploy. clusterId: type: string description: Gets or sets the ARM Id of the cluster resource on which this virtual machine will deploy. hostId: type: string description: Gets or sets the ARM Id of the host resource on which this virtual machine will deploy. datastoreId: type: string description: Gets or sets the ARM Id of the datastore resource on which the data for the virtual machine will be kept. CSRPErrorBody: description: Error properties properties: code: description: Error's code type: string readOnly: true details: description: Error's details type: array items: $ref: '#/definitions/CSRPErrorBody' x-ms-identifiers: [] readOnly: true message: description: Error's message type: string readOnly: true target: description: Error's target type: string RdpConnection: description: Represents a .rdp file type: object properties: contents: description: The contents of the .rdp file type: string AllocationMethod: description: Allocation method. enum: - Dynamic - Static x-ms-enum: modelAsString: true name: AllocationMethod type: string OsProfileUpdate: description: Specifies the operating system settings for the virtual machine. type: object properties: windowsConfiguration: type: object properties: patchSettings: x-ms-client-flatten: true $ref: '#/definitions/PatchSettings' description: Specifies the windows configuration for update management. linuxConfiguration: type: object properties: patchSettings: x-ms-client-flatten: true $ref: '#/definitions/PatchSettings' description: Specifies the linux configuration for update management. Tags: description: Tags model additionalProperties: type: string ComputeVmInstanceViewStatus: description: Status information about a virtual machine. type: object properties: code: description: Gets the status Code. type: string displayStatus: description: Gets the short localizable label for the status. type: string message: description: Gets the message associated with the status. type: string CSRPError: description: General error model properties: error: description: Error's body $ref: '#/definitions/CSRPErrorBody' InboundNatRule: description: A rule for NAT - exposing a VM's port (backendPort) on the public IP address using a load balancer. type: object properties: transportProtocol: description: The transport protocol for the endpoint. enum: - Tcp - Udp type: string x-ms-enum: name: TransportProtocol modelAsString: true frontendPort: format: int32 description: The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically. type: integer backendPort: format: int32 description: The port to which the external traffic will be redirected. type: integer RunCommandInputParameter: properties: name: type: string description: The run command parameter name. value: type: string description: The run command parameter value. required: - name - value type: object description: Describes the properties of a run command parameter. GuestAgentProfileUpdate: description: Specifies the guest agent settings for the virtual machine. type: object properties: clientPublicKey: description: Gets or sets the Public Key provided by the client for enabling guest management. type: string OsProfile: description: Specifies the operating system settings for the virtual machine. type: object properties: computerName: description: Gets or sets computer name. type: string adminUsername: description: Gets or sets administrator username. type: string adminPassword: description: Gets or sets administrator password. type: string x-ms-mutability: - create - update x-ms-secret: true guestId: description: Gets or sets the guestId. type: string allowExtensionOperations: description: Gets or sets a value indicating whether the VM is ready for extension operations. type: boolean readOnly: true osType: description: Gets or sets the type of the os. $ref: '#/definitions/OsType' osName: description: Gets or sets os name. type: string readOnly: true toolsRunningStatus: description: Gets or sets the current running status of VMware Tools running in the guest operating system. type: string readOnly: true toolsVersionStatus: description: Gets or sets the current version status of VMware Tools installed in the guest operating system. type: string readOnly: true toolsVersion: description: Gets or sets the current version of VMware Tools. type: string readOnly: true windowsConfiguration: type: object properties: patchSettings: x-ms-client-flatten: true $ref: '#/definitions/PatchSettings' description: Specifies the windows configuration for update management. linuxConfiguration: type: object properties: patchSettings: x-ms-client-flatten: true $ref: '#/definitions/PatchSettings' description: Specifies the linux configuration for update management. GuestAgentProfile: description: Specifies the guest agent settings for the virtual machine. type: object properties: vmUuid: readOnly: true type: string description: Specifies the VM's unique SMBIOS ID. status: readOnly: true type: string description: The status of the hybrid machine agent. enum: - Connected - Disconnected - Error x-ms-enum: name: StatusTypes modelAsString: true lastStatusChange: readOnly: true type: string format: date-time description: The time of the last status change. clientPublicKey: description: Gets or sets the Public Key provided by the client for enabling guest management. type: string mssqlDiscovered: readOnly: true type: string description: Specifies whether any MS SQL instance is discovered on the machine. agentVersion: readOnly: true type: string description: The hybrid machine agent full version. errorDetails: readOnly: true type: array items: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail description: Details about the error state. VirtualSCSIController: description: This data object type contains the properties of a SCSI controller device attached to a virtual machine that is reported by the controller. type: object properties: type: description: Gets or sets the controller type. $ref: '#/definitions/SCSIControllerType' controllerKey: format: int32 description: Gets or sets the key of the controller. type: integer busNumber: format: int32 description: Gets or sets the bus number of the controller. type: integer scsiCtlrUnitNumber: format: int32 description: Gets or sets the SCSI controller unit number. type: integer sharing: description: Gets or sets the sharing mode. $ref: '#/definitions/VirtualSCSISharing' StorageProfileUpdate_2: description: Defines the resource properties. type: object properties: disks: description: Gets or sets the list of virtual disks associated with the virtual machine. type: array items: $ref: '#/definitions/VirtualDiskUpdate_2' x-ms-identifiers: - name - diskId StorageQoSPolicyDetails: description: The StorageQoSPolicyDetails definition. type: object properties: name: description: The name of the policy. type: string id: description: The ID of the QoS policy. type: string IPV4Address: type: string pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])[.]){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ AttachNewDataDiskOptions: description: Properties to attach new disk to the Virtual Machine. type: object properties: diskSizeGiB: format: int32 description: Size of the disk to be attached in Gibibytes. type: integer diskName: description: The name of the disk to be attached. type: string diskType: description: The storage type for the disk (i.e. Standard, Premium). enum: - Standard - Premium - StandardSSD type: string x-ms-enum: name: StorageType modelAsString: true SecurityProfile: type: object properties: uefiSettings: $ref: '#/definitions/UefiSettings' description: Specifies the security settings like secure boot used while creating the virtual machine. description: Specifies the Security profile settings for the virtual machine. ResourcePoolProperties: description: Properties of resource pool properties: fullName: description: Hierarchical resource pool name type: string readOnly: true VirtualMachineUpdateProperties_2: description: Defines the resource properties. type: object properties: hardwareProfile: $ref: '#/definitions/HardwareProfileUpdate' storageProfile: $ref: '#/definitions/StorageProfileUpdate_2' networkProfile: $ref: '#/definitions/NetworkProfileUpdate_2' availabilitySets: $ref: '#/definitions/AvailabilitySetList' checkpointType: type: string description: Type of checkpoint supported for the vm. VirtualMachineCreateCheckpoint: description: Defines the create checkpoint action properties. type: object properties: name: description: Name of the checkpoint. type: string description: description: Description of the checkpoint. type: string VirtualDiskUpdate_2: description: Virtual disk model type: object properties: name: description: Gets or sets the name of the disk. type: string diskId: description: Gets or sets the disk id. type: string diskSizeGB: format: int32 description: Gets or sets the disk total size. type: integer bus: format: int32 description: Gets or sets the disk bus. type: integer lun: format: int32 description: Gets or sets the disk lun. type: integer busType: description: Gets or sets the disk bus type. type: string vhdType: description: Gets or sets the disk vhd type. type: string storageQoSPolicy: description: The QoS policy for the disk. $ref: '#/definitions/StorageQoSPolicyDetails' ApplicableScheduleProperties: description: Properties of a schedules applicable to a virtual machine. type: object properties: labVmsShutdown: $ref: '#/definitions/Schedule' description: The auto-shutdown schedule, if one has been set at the lab or lab resource level. labVmsStartup: $ref: '#/definitions/Schedule' description: The auto-startup schedule, if one has been set at the lab or lab resource level. ScheduleCreationParameter: description: Properties for creating a schedule. type: object properties: properties: $ref: '#/definitions/ScheduleCreationParameterProperties' description: The properties of the schedule. x-ms-client-flatten: true name: description: The name of the virtual machine or environment type: string location: description: The location of the new virtual machine or environment type: string readOnly: true tags: description: The tags of the resource. type: object additionalProperties: type: string OsProfile_2: description: Defines the resource properties. type: object properties: adminPassword: description: Admin password of the virtual machine. type: string x-ms-mutability: - create - update x-ms-secret: true computerName: description: Gets or sets computer name. type: string osType: description: Gets or sets the type of the os. $ref: '#/definitions/OsType_2' readOnly: true osName: description: Gets or sets os name. type: string readOnly: true ApplyArtifactsRequest: description: Request body for applying artifacts to a virtual machine. type: object properties: artifacts: description: The list of artifacts to apply. type: array items: $ref: '#/definitions/ArtifactInstallProperties' OsType: description: Defines the different types of VM guest operating systems. enum: - Windows - Linux - Other type: string x-ms-enum: modelAsString: true name: OsType CloudErrorBody: description: Body of an error from a REST request. type: object properties: code: description: The error code. type: string message: description: The error message. type: string target: description: The error target. type: string details: description: Inner errors. type: array items: $ref: '#/definitions/CloudErrorBody' x-ms-external: true VirtualNic: description: Virtual NIC model required: - nicType - network properties: customization: description: guest OS customization for nic $ref: '#/definitions/GuestOSNICCustomization' ipAddresses: description: NIC ip address type: array items: type: string macAddress: description: NIC MAC address type: string network: description: Virtual Network $ref: '#/definitions/VirtualNetwork' nicType: description: NIC type type: string enum: - E1000 - E1000E - PCNET32 - VMXNET - VMXNET2 - VMXNET3 x-ms-enum: modelAsString: false name: NICType powerOnBoot: description: Is NIC powered on/off on boot type: boolean virtualNicId: description: NIC id type: string virtualNicName: description: NIC name type: string readOnly: true ApplicableSchedule: description: Schedules applicable to a virtual machine. The schedules may have been defined on a VM or on lab level. required: - properties type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ApplicableScheduleProperties' description: The properties of the resource. x-ms-client-flatten: true VirtualMachineStopMode: description: List of virtual machine stop modes properties: mode: description: mode indicates a type of stop operation - reboot, suspend, shutdown or power-off type: string enum: - reboot - suspend - shutdown - poweroff x-ms-enum: modelAsString: false name: StopMode RunCommandInput: properties: commandId: type: string description: The run command id. script: type: array items: type: string description: Optional. The script to be executed. When this value is given, the given script will override the default script of the command. parameters: type: array items: $ref: '#/definitions/RunCommandInputParameter' x-ms-identifiers: - name description: The run command parameters. required: - commandId type: object description: Capture Virtual Machine parameters. HourDetails: description: Properties of an hourly schedule. type: object properties: minute: format: int32 description: Minutes of the hour the schedule will run. type: integer StorageProfileUpdate: description: Specifies the storage settings for the virtual machine disks. type: object properties: disks: description: Gets or sets the list of virtual disks associated with the virtual machine. type: array items: $ref: '#/definitions/VirtualDiskUpdate' HostInfoListResult: description: Result of the request to list cluster hosts type: array items: $ref: '#/definitions/HostInfo' readOnly: true LinuxParameters: type: object properties: classificationsToInclude: type: array description: The update classifications to select when installing patches for Linux. items: type: string enum: - Critical - Security - Other x-ms-enum: name: VMGuestPatchClassification_Linux modelAsString: true packageNameMasksToInclude: type: array description: 'packages to include in the patch operation. Format: packageName_packageVersion' items: type: string packageNameMasksToExclude: type: array description: 'packages to exclude in the patch operation. Format: packageName_packageVersion' items: type: string description: Input for InstallPatches on a Linux VM, as directly received by the API VirtualDiskController: description: Virtual disk controller model properties: id: description: Controller's id type: string readOnly: true name: description: The display name of Controller type: string readOnly: true subType: description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) type: string readOnly: true type: description: disk controller type (SCSI) type: string readOnly: true PatchPayload: description: General patch payload modal properties: tags: description: The tags key:value pairs $ref: '#/definitions/Tags' VirtualMachineProperties_3: description: Properties of virtual machine required: - numberOfCores - amountOfRam - privateCloudId properties: amountOfRam: description: The amount of memory type: integer controllers: description: The list of Virtual Disks' Controllers type: array items: $ref: '#/definitions/VirtualDiskController' readOnly: true customization: description: Virtual machine properties $ref: '#/definitions/GuestOSCustomization' disks: description: The list of Virtual Disks type: array items: $ref: '#/definitions/VirtualDisk_3' x-ms-identifiers: - virtualDiskId dnsname: description: The DNS name of Virtual Machine in VCenter type: string readOnly: true exposeToGuestVM: description: Expose Guest OS or not type: boolean folder: description: The path to virtual machine folder in VCenter type: string readOnly: true guestOS: description: The name of Guest OS type: string readOnly: true guestOSType: description: The Guest OS type type: string enum: - linux - windows - other x-ms-enum: modelAsString: false name: GuestOSType readOnly: true nics: description: The list of Virtual NICs type: array items: $ref: '#/definitions/VirtualNic' x-ms-identifiers: - virtualNicId numberOfCores: description: The number of CPU cores type: integer password: description: Password for login. Deprecated - use customization property type: string privateCloudId: description: Private Cloud Id type: string provisioningState: description: The provisioning status of the resource type: string readOnly: true publicIP: description: The public ip of Virtual Machine type: string readOnly: true resourcePool: description: Virtual Machines Resource Pool $ref: '#/definitions/ResourcePool' status: description: The status of Virtual machine type: string enum: - running - suspended - poweredoff - updating - deallocating - deleting x-ms-enum: modelAsString: false name: VirtualMachineStatus readOnly: true templateId: description: Virtual Machine Template Id type: string username: description: Username for login. Deprecated - use customization property type: string vSphereNetworks: description: The list of Virtual VSphere Networks type: array items: type: string vmId: description: The internal id of Virtual Machine in VCenter type: string readOnly: true vmwaretools: description: VMware tools version type: string readOnly: true LabVirtualMachineProperties: description: Properties of a virtual machine. type: object properties: notes: description: The notes of the virtual machine. type: string ownerObjectId: description: The object identifier of the owner of the virtual machine. default: dynamicValue type: string ownerUserPrincipalName: description: The user principal name of the virtual machine owner. type: string createdByUserId: description: The object identifier of the creator of the virtual machine. type: string readOnly: true createdByUser: description: The email address of creator of the virtual machine. type: string readOnly: true createdDate: format: date-time description: The creation date of the virtual machine. type: string computeId: description: The resource identifier (Microsoft.Compute) of the virtual machine. type: string readOnly: true customImageId: description: The custom image identifier of the virtual machine. type: string osType: description: The OS type of the virtual machine. type: string readOnly: true size: description: The size of the virtual machine. type: string userName: description: The user name of the virtual machine. type: string password: description: The password of the virtual machine administrator. type: string x-ms-secret: true sshKey: description: The SSH key of the virtual machine administrator. type: string x-ms-secret: true isAuthenticationWithSshKey: description: Indicates whether this virtual machine uses an SSH key for authentication. type: boolean fqdn: description: The fully-qualified domain name of the virtual machine. type: string readOnly: true labSubnetName: description: The lab subnet name of the virtual machine. type: string labVirtualNetworkId: description: The lab virtual network identifier of the virtual machine. type: string disallowPublicIpAddress: description: Indicates whether the virtual machine is to be created without a public IP address. default: false type: boolean artifacts: description: The artifacts to be installed on the virtual machine. type: array items: $ref: '#/definitions/ArtifactInstallProperties' artifactDeploymentStatus: $ref: '#/definitions/ArtifactDeploymentStatusProperties' description: The artifact deployment status for the virtual machine. readOnly: true galleryImageReference: $ref: '#/definitions/GalleryImageReference' description: The Microsoft Azure Marketplace image reference of the virtual machine. planId: description: The id of the plan associated with the virtual machine image type: string computeVm: $ref: '#/definitions/ComputeVmProperties' description: The compute virtual machine properties. readOnly: true networkInterface: $ref: '#/definitions/NetworkInterfaceProperties' description: The network interface properties. applicableSchedule: $ref: '#/definitions/ApplicableSchedule' description: The applicable schedule for the virtual machine. readOnly: true expirationDate: format: date-time description: The expiration date for VM. type: string allowClaim: description: Indicates whether another user can take ownership of the virtual machine default: false type: boolean storageType: description: Storage type to use for virtual machine (i.e. Standard, Premium). default: labStorageType type: string virtualMachineCreationSource: description: Tells source of creation of lab virtual machine. Output property only. enum: - FromCustomImage - FromGalleryImage - FromSharedGalleryImage type: string readOnly: true x-ms-enum: name: VirtualMachineCreationSource modelAsString: true environmentId: description: The resource ID of the environment that contains this virtual machine, if any. type: string dataDiskParameters: description: New or existing data disks to attach to the virtual machine after creation type: array items: $ref: '#/definitions/DataDiskProperties' scheduleParameters: description: Virtual Machine schedules to be created type: array items: $ref: '#/definitions/ScheduleCreationParameter' lastKnownPowerState: description: Last known compute power state captured in DTL type: string readOnly: true provisioningState: description: The provisioning status of the resource. type: string readOnly: true uniqueIdentifier: description: The unique immutable identifier of a resource (Guid). type: string readOnly: true VirtualMachineUpdateProperties: description: Describes the properties of a Virtual Machine. type: object properties: hardwareProfile: $ref: '#/definitions/HardwareProfile' osProfile: description: OS properties. $ref: '#/definitions/OsProfileUpdate' storageProfile: $ref: '#/definitions/StorageProfileUpdate' networkProfile: $ref: '#/definitions/NetworkProfileUpdate' guestAgentProfile: $ref: '#/definitions/GuestAgentProfileUpdate' NetworkInterfaces: description: Network Interface model type: object properties: name: description: Gets or sets the name of the network interface. type: string displayName: description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. type: string readOnly: true ipv4Addresses: description: Gets or sets the nic ipv4 addresses. type: array items: type: string readOnly: true ipv6Addresses: description: Gets or sets the nic ipv6 addresses. type: array items: type: string readOnly: true macAddress: description: Gets or sets the nic MAC address. type: string virtualNetworkId: description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. type: string networkName: description: Gets or sets the name of the virtual network in vmmServer that the nic is connected to. type: string readOnly: true ipv4AddressType: description: Gets or sets the ipv4 address type. $ref: '#/definitions/AllocationMethod' ipv6AddressType: description: Gets or sets the ipv6 address type. $ref: '#/definitions/AllocationMethod' macAddressType: description: Gets or sets the mac address type. $ref: '#/definitions/AllocationMethod' nicId: description: Gets or sets the nic id. type: string VirtualNetwork: description: Virtual network model required: - id properties: assignable: description: can be used in vm creation/deletion type: boolean readOnly: true id: description: virtual network id (privateCloudId:vsphereId) type: string location: description: Azure region type: string readOnly: true name: description: '{VirtualNetworkName}' type: string readOnly: true properties: description: Virtual Network properties x-ms-client-flatten: true $ref: '#/definitions/VirtualNetworkProperties' type: description: '{resourceProviderNamespace}/{resourceType}' type: string readOnly: true GalleryImageReference: description: The reference information for an Azure Marketplace image. type: object properties: offer: description: The offer of the gallery image. type: string publisher: description: The publisher of the gallery image. type: string sku: description: The SKU of the gallery image. type: string osType: description: The OS type of the gallery image. type: string version: description: The version of the gallery image. type: string StopVirtualMachineOptions: description: Defines the stop action properties. type: object properties: skipShutdown: description: Gets or sets a value indicating whether to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Defaults to false. type: boolean default: false DiskType: description: Defines the different types of disks. enum: - flat - pmem - rawphysical - rawvirtual - sparse - sesparse - unknown type: string x-ms-enum: modelAsString: true name: DiskType NICType: description: NIC type type: string enum: - vmxnet3 - vmxnet2 - vmxnet - e1000 - e1000e - pcnet32 x-ms-enum: modelAsString: true name: NICType FirmwareType: description: Firmware type type: string enum: - bios - efi x-ms-enum: modelAsString: true name: FirmwareType VirtualMachineListResponse: description: List of virtual machines properties: nextLink: description: Link for next list of VirtualMachines type: string value: description: Results of the VirtualMachine list type: array items: $ref: '#/definitions/VirtualMachine_3' NetworkInterfacesUpdate: description: Network Interface model type: object properties: name: description: Gets or sets the name of the network interface. type: string macAddress: description: Gets or sets the nic MAC address. type: string virtualNetworkId: description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. type: string ipv4AddressType: description: Gets or sets the ipv4 address type. $ref: '#/definitions/AllocationMethod' ipv6AddressType: description: Gets or sets the ipv6 address type. $ref: '#/definitions/AllocationMethod' macAddressType: description: Gets or sets the mac address type. $ref: '#/definitions/AllocationMethod' nicId: description: Gets or sets the nic id. type: string ErrorResponse: description: Describes the format of Error response. type: object properties: code: description: Error code type: string message: description: Error message indicating why the operation failed. type: string VirtualMachine_2: type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VirtualMachineProperties_2' id: type: string readOnly: true description: Resource Id name: type: string readOnly: true description: Resource Name type: type: string readOnly: true description: Resource Type location: description: Gets or sets the location. type: string x-ms-mutability: - read - create tags: type: object additionalProperties: type: string description: Resource tags systemData: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData description: The system data. extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location. identity: $ref: '#/definitions/Identity' description: The identity of the resource. required: - location - properties - extendedLocation description: The VirtualMachines resource definition. VirtualMachineUpdate: description: Defines the virtualMachineUpdate. type: object properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VirtualMachineUpdateProperties' tags: description: Gets or sets the Resource tags. type: object additionalProperties: type: string identity: $ref: '#/definitions/Identity' description: The identity of the resource. VirtualDiskUpdate: description: Defines the virtual disk update. type: object properties: name: description: Gets or sets the name of the virtual disk. type: string diskSizeGB: format: int32 description: Gets or sets the disk total size. type: integer deviceKey: format: int32 description: Gets or sets the device key value. type: integer diskMode: description: Gets or sets the disk mode. $ref: '#/definitions/DiskMode' controllerKey: description: Gets or sets the controller id. format: int32 type: integer unitNumber: description: Gets or sets the unit number of the disk on the controller. format: int32 type: integer deviceName: description: Gets or sets the device name. type: string diskType: description: Gets or sets the disk backing type. $ref: '#/definitions/DiskType' VirtualMachinesList: description: List of VirtualMachines. type: object properties: nextLink: description: Url to follow for getting next page of VirtualMachines. type: string value: description: Array of VirtualMachines type: array items: $ref: '#/definitions/VirtualMachine' required: - value ComputeDataDisk: description: A data disks attached to a virtual machine. type: object properties: name: description: Gets data disk name. type: string diskUri: description: When backed by a blob, the URI of underlying blob. type: string managedDiskId: description: When backed by managed disk, this is the ID of the compute disk resource. type: string diskSizeGiB: format: int32 description: Gets data disk size in GiB. type: integer LabVirtualMachine: description: A virtual machine. required: - properties type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/LabVirtualMachineProperties' description: The properties of the resource. x-ms-client-flatten: true HardwareProfile_2: description: Defines the resource properties. type: object properties: memoryMB: type: integer format: int32 description: MemoryMB is the size of a virtual machine's memory, in MB. cpuCount: type: integer description: Gets or sets the number of vCPUs for the vm. format: int32 limitCpuForMigration: type: string description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: LimitCpuForMigration dynamicMemoryEnabled: type: string description: Gets or sets a value indicating whether to enable dynamic memory or not. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: DynamicMemoryEnabled dynamicMemoryMaxMB: type: integer format: int32 description: Gets or sets the max dynamic memory for the vm. dynamicMemoryMinMB: type: integer format: int32 description: Gets or sets the min dynamic memory for the vm. isHighlyAvailable: description: Gets highly available property. type: string VirtualMachineProperties: description: Describes the properties of a Virtual Machine. type: object properties: resourcePoolId: description: "Gets or sets the ARM Id of the resourcePool resource on which this virtual machine will\r\ndeploy." type: string templateId: description: Gets or sets the ARM Id of the template resource to deploy the virtual machine. type: string vCenterId: description: Gets or sets the ARM Id of the vCenter resource in which this resource pool resides. type: string placementProfile: description: Placement properties. $ref: '#/definitions/PlacementProfile' osProfile: description: OS properties. $ref: '#/definitions/OsProfile' hardwareProfile: description: Hardware properties. $ref: '#/definitions/HardwareProfile' networkProfile: description: Network properties. $ref: '#/definitions/NetworkProfile' storageProfile: description: Storage properties. $ref: '#/definitions/StorageProfile' guestAgentProfile: description: Guest agent status properties. $ref: '#/definitions/GuestAgentProfile' securityProfile: $ref: '#/definitions/SecurityProfile' description: Gets the security profile. moRefId: description: Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine. type: string inventoryItemId: description: Gets or sets the inventory Item ID for the virtual machine. type: string moName: description: Gets or sets the vCenter Managed Object name for the virtual machine. type: string readOnly: true folderPath: description: Gets or sets the folder path of the vm. type: string readOnly: true instanceUuid: description: Gets or sets the instance uuid of the vm. type: string readOnly: true smbiosUuid: type: string description: Gets or sets the SMBIOS UUID of the vm. firmwareType: description: Firmware type $ref: '#/definitions/FirmwareType' powerState: description: Gets the power state of the virtual machine. type: string readOnly: true customResourceName: description: Gets the name of the corresponding resource in Kubernetes. type: string readOnly: true uuid: description: Gets or sets a unique identifier for this resource. type: string readOnly: true statuses: description: The resource status information. readOnly: true type: array items: $ref: '#/definitions/ResourceStatus' x-ms-identifiers: - type provisioningState: $ref: '#/definitions/ResourceProvisioningState' description: Gets the provisioning state. readOnly: true vmId: description: Gets or sets a unique identifier for the vm resource. type: string readOnly: true VirtualMachineDeleteCheckpoint: description: Defines the delete checkpoint action properties. type: object properties: id: description: ID of the checkpoint to be deleted. type: string VirtualMachineRestoreCheckpoint: description: Defines the restore checkpoint action properties. type: object properties: id: description: ID of the checkpoint to be restored to. type: string HostInfo: description: The cluster host information. properties: name: description: The host name type: string fqdn: description: The Fully Qualified Domain Name of host type: string effectiveDiskEncryptionKeyUrl: description: The effective disk encryption key URL used by the host type: string readOnly: true ArtifactDeploymentStatusProperties: description: Properties of an artifact deployment. type: object properties: deploymentStatus: description: The deployment status of the artifact. type: string artifactsApplied: format: int32 description: The total count of the artifacts that were successfully applied. type: integer totalArtifacts: format: int32 description: The total count of the artifacts that were tentatively applied. type: integer LabVirtualMachineFragment: description: A virtual machine. type: object allOf: - $ref: '#/definitions/UpdateResource' properties: {} Resource: description: An Azure resource. type: object properties: id: description: The identifier of the resource. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true location: description: The location of the resource. type: string tags: description: The tags of the resource. type: object additionalProperties: type: string x-ms-azure-resource: true NetworkInterface: description: Network Interface model type: object properties: name: description: Gets or sets the name of the network interface. type: string label: description: Gets or sets the label of the virtual network in vCenter that the nic is connected to. type: string readOnly: true ipAddresses: description: Gets or sets the nic ip addresses. type: array items: type: string readOnly: true macAddress: description: Gets or sets the NIC MAC address. type: string readOnly: true networkId: description: Gets or sets the ARM Id of the network resource to connect the virtual machine. type: string nicType: description: NIC type $ref: '#/definitions/NICType' powerOnBoot: description: Gets or sets the power on boot. $ref: '#/definitions/PowerOnBootOption' networkMoRefId: description: "Gets or sets the vCenter MoRef (Managed Object Reference) ID of the virtual network\r\nthat the nic is connected to." type: string readOnly: true networkMoName: description: Gets or sets the name of the virtual network in vCenter that the nic is connected to. type: string readOnly: true deviceKey: format: int32 description: Gets or sets the device key value. type: integer ipSettings: description: Gets or sets the ipsettings. $ref: '#/definitions/NicIPSettings' ResourceStatus: description: The resource status information. type: object properties: type: description: The type of the condition. type: string readOnly: true status: description: Status of the condition. type: string readOnly: true reason: description: The reason for the condition's status. type: string readOnly: true message: description: A human readable message indicating details about the status. type: string readOnly: true severity: description: Severity with which to treat failures of this type of condition. type: string readOnly: true lastUpdatedAt: description: The last update time for this condition. type: string format: date-time readOnly: true PowerOnBootOption: description: Defines the options for power on boot. enum: - enabled - disabled type: string x-ms-enum: modelAsString: true name: PowerOnBootOption VirtualDisk: description: Virtual disk model type: object properties: name: description: Gets or sets the name of the virtual disk. type: string label: description: Gets or sets the label of the virtual disk in vCenter. type: string readOnly: true diskObjectId: description: Gets or sets the disk object id. type: string readOnly: true diskSizeGB: format: int32 description: Gets or sets the disk total size. type: integer deviceKey: format: int32 description: Gets or sets the device key value. type: integer diskMode: description: Gets or sets the disk mode. $ref: '#/definitions/DiskMode' controllerKey: description: Gets or sets the controller id. format: int32 type: integer unitNumber: description: Gets or sets the unit number of the disk on the controller. format: int32 type: integer deviceName: description: Gets or sets the device name. type: string diskType: description: Gets or sets the disk backing type. $ref: '#/definitions/DiskType' ArtifactParameterProperties: description: Properties of an artifact parameter. type: object properties: name: description: The name of the artifact parameter. type: string value: description: The value of the artifact parameter. type: string ArtifactInstallProperties: description: Properties of an artifact. type: object properties: artifactId: description: The artifact's identifier. type: string artifactTitle: description: The artifact's title. type: string parameters: description: The parameters of the artifact. type: array items: $ref: '#/definitions/ArtifactParameterProperties' status: description: The status of the artifact. type: string deploymentStatusMessage: description: The status message from the deployment. type: string vmExtensionStatusMessage: description: The status message from the virtual machine extension. type: string installTime: format: date-time description: The time that the artifact starts to install on the virtual machine. type: string Identity: type: object required: - type properties: principalId: readOnly: true type: string description: The principal id of managed service identity. tenantId: readOnly: true type: string description: The tenant of managed service identity. type: type: string description: The type of managed service identity. enum: - None - SystemAssigned x-ms-enum: name: IdentityType modelAsString: true description: Managed service identity. NicIPAddressSettings: description: IP address information for a virtual network adapter reported by the fabric. type: object properties: allocationMethod: description: Gets the ip address allocation method. type: string readOnly: true ipAddress: description: Gets the ip address for the nic. type: string readOnly: true subnetMask: description: Gets the mask. type: string readOnly: true LabVirtualMachineList: description: The response of a list operation. type: object properties: value: description: Results of the list operation. type: array items: $ref: '#/definitions/LabVirtualMachine' nextLink: description: Link for next set of results. type: string HardwareProfile: description: Specifies the hardware settings for the virtual machine. type: object properties: memorySizeMB: format: int32 description: Gets or sets memory size in MBs for the vm. type: integer numCPUs: format: int32 description: Gets or sets the number of vCPUs for the vm. type: integer numCoresPerSocket: format: int32 description: Gets or sets the number of cores per socket for the vm. Defaults to 1 if unspecified. type: integer cpuHotAddEnabled: description: Gets or sets a value indicating whether virtual processors can be added while this virtual machine is running. type: boolean readOnly: true cpuHotRemoveEnabled: description: Gets or sets a value indicating whether virtual processors can be removed while this virtual machine is running. type: boolean readOnly: true memoryHotAddEnabled: description: Gets or sets a value indicating whether memory can be added while this virtual machine is running. type: boolean readOnly: true VirtualMachineProperties_2: description: Defines the resource properties. type: object properties: inventoryItemId: description: Gets or sets the inventory Item ID for the resource. type: string vmmServerId: type: string description: ARM Id of the vmmServer resource in which this resource resides. cloudId: type: string description: ARM Id of the cloud resource to use for deploying the vm. templateId: type: string description: ARM Id of the template resource to use for deploying the vm. checkpointType: type: string description: Type of checkpoint supported for the vm. lastRestoredVMCheckpoint: description: Last restored checkpoint in the vm. $ref: '#/definitions/Checkpoint' readOnly: true checkpoints: description: Checkpoints in the vm. type: array items: description: Checkpoint properties $ref: '#/definitions/Checkpoint' readOnly: true x-ms-identifiers: - checkpointID availabilitySets: $ref: '#/definitions/AvailabilitySetList' osProfile: description: OS properties. $ref: '#/definitions/OsProfile_2' hardwareProfile: description: Hardware properties. $ref: '#/definitions/HardwareProfile_2' networkProfile: description: Network properties. $ref: '#/definitions/NetworkProfile_2' storageProfile: description: Storage properties. $ref: '#/definitions/StorageProfile_2' vmName: type: string description: VMName is the name of VM on the SCVMM server. minLength: 1 uuid: type: string description: Unique ID of the virtual machine. generation: type: integer format: int32 description: Gets or sets the generation for the vm. powerState: description: Gets the power state of the virtual machine. type: string readOnly: true guestAgentProfile: description: Guest agent status properties. $ref: '#/definitions/GuestAgentProfile_2' provisioningState: description: Gets or sets the provisioning state. type: string readOnly: true WindowsParameters: type: object properties: classificationsToInclude: type: array description: The update classifications to select when installing patches for Windows. items: type: string enum: - Critical - Security - UpdateRollUp - FeaturePack - ServicePack - Definition - Tools - Updates x-ms-enum: name: VMGuestPatchClassification_Windows modelAsString: true kbNumbersToInclude: type: array description: Kbs to include in the patch operation items: type: string kbNumbersToExclude: type: array description: Kbs to exclude in the patch operation items: type: string excludeKbsRequiringReboot: type: boolean description: Filters out Kbs that don't have an InstallationRebootBehavior of 'NeverReboots' when this is set to true. maxPatchPublishDate: type: string format: date-time description: This is used to install patches that were published on or before this given max published date. description: Input for InstallPatches on a Windows VM, as directly received by the API Checkpoint: description: Defines the resource properties. type: object properties: parentCheckpointID: description: Gets ID of parent of the checkpoint. type: string checkpointID: description: Gets ID of the checkpoint. type: string name: description: Gets name of the checkpoint. type: string description: description: Gets description of the checkpoint. type: string ResizeLabVirtualMachineProperties: description: Request body for resizing a virtual machine. type: object properties: size: description: Specifies the size of the virtual machine. type: string DetachDataDiskProperties: description: Request body for detaching data disk from a virtual machine. type: object properties: existingLabDiskId: description: Specifies the disk resource ID to detach from virtual machine. type: string NetworkProfileUpdate_2: description: Defines the resource properties. type: object properties: networkInterfaces: description: Gets or sets the list of network interfaces associated with the virtual machine. type: array items: $ref: '#/definitions/NetworkInterfacesUpdate' x-ms-identifiers: - name - nicId NicIPSettings: description: Defines the network interface ip settings. type: object properties: allocationMethod: description: Gets or sets the nic allocation method. $ref: '#/definitions/IPAddressAllocationMethod' dnsServers: description: Gets or sets the dns servers. type: array items: type: string gateway: description: Gets or sets the gateway. type: array items: type: string ipAddress: description: Gets or sets the ip address for the nic. type: string subnetMask: description: Gets or sets the mask. type: string primaryWinsServer: description: Gets or sets the primary server. type: string readOnly: true secondaryWinsServer: description: Gets or sets the secondary server. type: string readOnly: true ipAddressInfo: description: Gets or sets the IP address information being reported for this NIC. This contains the same IPv4 information above plus IPV6 information. type: array items: $ref: '#/definitions/NicIPAddressSettings' readOnly: true VirtualSCSISharing: description: Defines the sharing mode for sharing the SCSI bus. enum: - noSharing - physicalSharing - virtualSharing type: string x-ms-enum: modelAsString: true name: VirtualSCSISharing VirtualMachine: description: Define the virtualMachine. required: - location - properties type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VirtualMachineProperties' location: description: Gets or sets the location. type: string x-ms-mutability: - read - create extendedLocation: $ref: '#/definitions/ExtendedLocation' description: Gets or sets the extended location. systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: The system data. tags: description: Gets or sets the Resource tags. type: object additionalProperties: type: string name: description: Gets or sets the name. type: string readOnly: true id: description: Gets or sets the Id. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true kind: type: string description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. identity: $ref: '#/definitions/Identity' description: The identity of the resource. NetworkInterfaceProperties: description: Properties of a network interface. type: object properties: virtualNetworkId: description: The resource ID of the virtual network. type: string subnetId: description: The resource ID of the sub net. type: string publicIpAddressId: description: The resource ID of the public IP address. type: string publicIpAddress: description: The public IP address. type: string privateIpAddress: description: The private IP address. type: string dnsName: description: The DNS name. type: string rdpAuthority: description: The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol). type: string sshAuthority: description: The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH. type: string sharedPublicIpAddressConfiguration: $ref: '#/definitions/SharedPublicIpAddressConfiguration' description: The configuration for sharing a public IP address across multiple virtual machines. UpdateResource: description: Represents an update resource type: object properties: tags: description: The tags of the resource. type: object additionalProperties: type: string Schedule: description: A schedule. required: - properties type: object allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/ScheduleProperties' description: The properties of the resource. x-ms-client-flatten: true PatchSettings: type: object properties: assessmentMode: type: string description: Specifies the assessment mode. patchMode: type: string description: Specifies the patch mode. description: Specifies the patch settings. DataDiskProperties: description: Request body for adding a new or existing data disk to a virtual machine. type: object properties: attachNewDataDiskOptions: $ref: '#/definitions/AttachNewDataDiskOptions' description: Specifies options to attach a new disk to the virtual machine. existingLabDiskId: description: Specifies the existing lab disk id to attach to virtual machine. type: string hostCaching: description: Caching option for a data disk (i.e. None, ReadOnly, ReadWrite). enum: - None - ReadOnly - ReadWrite type: string x-ms-enum: name: HostCachingOptions modelAsString: true NetworkProfile: description: Specifies the network interfaces of the virtual machine. type: object properties: networkInterfaces: description: Gets or sets the list of network interfaces associated with the virtual machine. type: array items: $ref: '#/definitions/NetworkInterface' WeekDetails: description: Properties of a weekly schedule. type: object properties: weekdays: description: The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.). type: array items: type: string time: description: The time of the day the schedule will occur. type: string AvailablePatchCountByClassification: type: object properties: security: readOnly: true type: integer format: int32 description: Number of security patches available for installation. critical: readOnly: true type: integer format: int32 description: Number of critical patches available for installation. definition: readOnly: true type: integer format: int32 description: Number of definition patches available for installation. updateRollup: readOnly: true type: integer format: int32 description: Number of update Rollup patches available for installation. featurePack: readOnly: true type: integer format: int32 description: Number of feature pack patches available for installation. servicePack: readOnly: true type: integer format: int32 description: Number of service pack patches available for installation. tools: readOnly: true type: integer format: int32 description: Number of tools patches available for installation. updates: readOnly: true type: integer format: int32 description: Number of updates category patches available for installation. other: readOnly: true type: integer format: int32 description: Number of other patches available for installation. description: Summarization of patches available for installation on the machine by classification. GuestOSNICCustomization: description: Guest OS nic customization properties: allocation: description: IP address allocation method type: string enum: - static - dynamic dnsServers: description: List of dns servers to use type: array items: $ref: '#/definitions/IPV4Address' gateway: description: Gateway addresses assigned to nic type: array items: $ref: '#/definitions/IPV4Address' ipAddress: description: Static ip address for nic $ref: '#/definitions/IPV4Address' mask: description: Network mask for nic $ref: '#/definitions/IPV4Address' primaryWinsServer: description: primary WINS server for Windows $ref: '#/definitions/IPV4Address' secondaryWinsServer: description: secondary WINS server for Windows $ref: '#/definitions/IPV4Address' ExtendedLocation: type: object description: The extended location. properties: type: type: string description: The extended location type. name: type: string description: The extended location name. GuestOSCustomization: description: Guest OS Customization properties properties: dnsServers: description: List of dns servers to use type: array items: $ref: '#/definitions/IPV4Address' hostName: description: Virtual Machine hostname type: string password: description: Password for login type: string policyId: description: id of customization policy type: string username: description: Username for login type: string VirtualNetworkProperties: description: Properties of virtual network properties: privateCloudId: description: The Private Cloud id type: string readOnly: true VirtualMachineInstallPatchesParameters: type: object properties: maximumDuration: type: string description: Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours) rebootSetting: type: string description: Defines when it is acceptable to reboot a VM during a software update operation. enum: - IfRequired - Never - Always x-ms-enum: name: VMGuestPatchRebootSetting modelAsString: true windowsParameters: $ref: '#/definitions/WindowsParameters' description: Input for InstallPatches on a Windows VM, as directly received by the API linuxParameters: $ref: '#/definitions/LinuxParameters' description: Input for InstallPatches on a Linux VM, as directly received by the API required: - maximumDuration - rebootSetting description: Input for InstallPatches as directly received by the API ResourceProvisioningState: type: string description: The current deployment state of resource. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted - Created x-ms-enum: name: ProvisioningState modelAsString: true ScheduleCreationParameterProperties: description: Properties for schedule creation. type: object properties: status: description: The status of the schedule (i.e. Enabled, Disabled) default: Disabled enum: - Enabled - Disabled type: string x-ms-enum: name: EnableStatus modelAsString: true taskType: description: The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart). type: string weeklyRecurrence: $ref: '#/definitions/WeekDetails' description: If the schedule will occur only some days of the week, specify the weekly recurrence. dailyRecurrence: $ref: '#/definitions/DayDetails' description: If the schedule will occur once each day of the week, specify the daily recurrence. hourlyRecurrence: $ref: '#/definitions/HourDetails' description: If the schedule will occur multiple times a day, specify the hourly recurrence. timeZoneId: description: The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in `IReadOnlyCollection TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds` (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md) type: string notificationSettings: $ref: '#/definitions/NotificationSettings' description: Notification settings. targetResourceId: description: The resource ID to which the schedule belongs type: string ErrorResponse_2: description: Error response. type: object properties: error: $ref: '#/definitions/ErrorDefinition' description: The error details. StorageProfile: description: Specifies the storage settings for the virtual machine disks. type: object properties: disks: description: Gets or sets the list of virtual disks associated with the virtual machine. type: array items: $ref: '#/definitions/VirtualDisk' scsiControllers: description: Gets or sets the list of virtual SCSI controllers associated with the virtual machine. type: array items: $ref: '#/definitions/VirtualSCSIController' readOnly: true SharedPublicIpAddressConfiguration: description: Properties of a virtual machine that determine how it is connected to a load balancer. type: object properties: inboundNatRules: description: The incoming NAT rules type: array items: $ref: '#/definitions/InboundNatRule' HardwareProfileUpdate: description: Defines the resource properties. type: object properties: memoryMB: type: integer format: int32 description: MemoryMB is the size of a virtual machine's memory, in MB. cpuCount: type: integer description: Gets or sets the number of vCPUs for the vm. format: int32 limitCpuForMigration: type: string description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: LimitCpuForMigration dynamicMemoryEnabled: type: string description: Gets or sets a value indicating whether to enable dynamic memory or not. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: DynamicMemoryEnabled dynamicMemoryMaxMB: type: integer format: int32 description: Gets or sets the max dynamic memory for the vm. dynamicMemoryMinMB: type: integer format: int32 description: Gets or sets the min dynamic memory for the vm. VirtualMachineUpdate_2: description: Defines the virtualMachineUpdate. type: object properties: properties: $ref: '#/definitions/VirtualMachineUpdateProperties_2' tags: description: Gets or sets the Resource tags. type: object additionalProperties: type: string identity: $ref: '#/definitions/Identity' description: The identity of the resource. VirtualMachine_3: description: Virtual machine model required: - location properties: id: description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/virtualMachines/{virtualMachineName} type: string readOnly: true location: description: Azure region type: string x-ms-mutability: - read - create name: description: '{virtualMachineName}' type: string pattern: ^[a-zA-Z0-9]([-_.a-zA-Z0-9]*[a-zA-Z0-9])?$ readOnly: true properties: description: Virtual machine properties x-ms-client-flatten: true $ref: '#/definitions/VirtualMachineProperties_3' tags: description: The list of tags $ref: '#/definitions/Tags' type: description: '{resourceProviderNamespace}/{resourceType}' type: string readOnly: true x-ms-azure-resource: true ErrorDefinition: description: Error definition. type: object properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true details: description: Internal error details. type: array items: $ref: '#/definitions/ErrorDefinition' x-ms-identifiers: [] readOnly: true VirtualMachineAssessPatchesResult: type: object properties: status: type: string readOnly: true description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." enum: - Unknown - InProgress - Failed - Succeeded - CompletedWithWarnings x-ms-enum: name: PatchOperationStatus modelAsString: true assessmentActivityId: type: string readOnly: true description: The activity ID of the operation that produced this result. rebootPending: type: boolean readOnly: true description: The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. availablePatchCountByClassification: $ref: '#/definitions/AvailablePatchCountByClassification' description: Summarization of patches available for installation on the machine by classification. startDateTime: type: string readOnly: true format: date-time description: The UTC timestamp when the operation began. lastModifiedDateTime: type: string readOnly: true format: date-time description: The UTC timestamp when the operation finished. startedBy: type: string readOnly: true enum: - User - Platform x-ms-enum: name: PatchOperationStartedBy modelAsString: true description: Indicates if operation was triggered by user or by platform. patchServiceUsed: type: string readOnly: true enum: - Unknown - WU - WU_WSUS - YUM - APT - Zypper x-ms-enum: name: PatchServiceUsed modelAsString: true description: Specifies the patch service used for the operation. osType: type: string readOnly: true enum: - Windows - Linux x-ms-enum: name: OsTypeUM modelAsString: true description: The operating system type of the machine. errorDetails: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail readOnly: true description: The errors that were encountered during execution of the operation. The details array contains the list of them. description: Describes the properties of an AssessPatches result. DiskMode: description: Defines the different types of disk modes. enum: - persistent - independent_persistent - independent_nonpersistent type: string x-ms-enum: modelAsString: true name: DiskMode VirtualDisk_2: description: Virtual disk model type: object properties: name: description: Gets or sets the name of the disk. type: string displayName: description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. type: string readOnly: true diskId: description: Gets or sets the disk id. type: string diskSizeGB: format: int32 description: Gets or sets the disk total size. type: integer maxDiskSizeGB: format: int32 description: Gets or sets the max disk size. type: integer readOnly: true bus: format: int32 description: Gets or sets the disk bus. type: integer lun: format: int32 description: Gets or sets the disk lun. type: integer busType: description: Gets or sets the disk bus type. type: string vhdType: description: Gets or sets the disk vhd type. type: string volumeType: description: Gets or sets the disk volume type. type: string readOnly: true vhdFormatType: description: Gets the disk vhd format type. type: string readOnly: true templateDiskId: description: Gets or sets the disk id in the template. type: string storageQoSPolicy: description: The QoS policy for the disk. $ref: '#/definitions/StorageQoSPolicyDetails' createDiffDisk: type: string description: Gets or sets a value indicating diff disk. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: CreateDiffDisk OsType_2: description: Defines the different types of VM guest operating systems. enum: - Windows - Linux - Other x-ms-enum: modelAsString: true name: OsType type: string readOnly: true ComputeVmProperties: description: Properties of a virtual machine returned by the Microsoft.Compute API. type: object properties: statuses: description: Gets the statuses of the virtual machine. type: array items: $ref: '#/definitions/ComputeVmInstanceViewStatus' osType: description: Gets the OS type of the virtual machine. type: string vmSize: description: Gets the size of the virtual machine. type: string networkInterfaceId: description: Gets the network interface ID of the virtual machine. type: string osDiskId: description: Gets OS disk blob uri for the virtual machine. type: string dataDiskIds: description: Gets data disks blob uri for the virtual machine. type: array items: type: string dataDisks: description: Gets all data disks attached to the virtual machine. type: array items: $ref: '#/definitions/ComputeDataDisk' RunCommandResult: properties: value: type: array items: $ref: ./computeRPCommon.json#/definitions/InstanceViewStatus x-ms-identifiers: [] description: Run command operation response. type: object VirtualMachineInstallPatchesResult: type: object properties: status: type: string readOnly: true description: The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings." enum: - Unknown - InProgress - Failed - Succeeded - CompletedWithWarnings x-ms-enum: name: PatchOperationStatus modelAsString: true installationActivityId: type: string readOnly: true description: The activity ID of the operation that produced this result. rebootStatus: type: string readOnly: true description: The reboot state of the VM following completion of the operation. enum: - Unknown - NotNeeded - Required - Started - Failed - Completed x-ms-enum: name: VMGuestPatchRebootStatus modelAsString: true maintenanceWindowExceeded: type: boolean readOnly: true description: Whether the operation ran out of time before it completed all its intended actions. excludedPatchCount: type: integer readOnly: true format: int32 description: The number of patches that were not installed due to the user blocking their installation. notSelectedPatchCount: type: integer readOnly: true format: int32 description: The number of patches that were detected as available for install, but did not meet the operation's criteria. pendingPatchCount: type: integer readOnly: true format: int32 description: The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true. installedPatchCount: type: integer readOnly: true format: int32 description: The number of patches successfully installed. failedPatchCount: type: integer readOnly: true format: int32 description: The number of patches that could not be installed due to some issue. See errors for details. startDateTime: type: string readOnly: true format: date-time description: The UTC timestamp when the operation began. lastModifiedDateTime: type: string readOnly: true format: date-time description: The UTC timestamp when the operation finished. startedBy: type: string readOnly: true enum: - User - Platform x-ms-enum: name: PatchOperationStartedBy modelAsString: true description: Indicates if operation was triggered by user or by platform. patchServiceUsed: type: string readOnly: true enum: - Unknown - WU - WU_WSUS - YUM - APT - Zypper x-ms-enum: name: PatchServiceUsed modelAsString: true description: Specifies the patch service used for the operation. osType: type: string readOnly: true enum: - Windows - Linux x-ms-enum: name: OsTypeUM modelAsString: true description: The operating system type of the machine. errorDetails: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorDetail readOnly: true description: The errors that were encountered during execution of the operation. The details array contains the list of them. description: The result summary of an installation operation. NetworkProfile_2: description: Defines the resource properties. type: object properties: networkInterfaces: description: Gets or sets the list of network interfaces associated with the virtual machine. type: array items: $ref: '#/definitions/NetworkInterfaces' x-ms-identifiers: - name - nicId GuestAgentProfile_2: description: Defines the resource properties. type: object properties: vmUuid: readOnly: true type: string description: Specifies the VM's unique SMBIOS ID. status: readOnly: true type: string description: The status of the hybrid machine agent. enum: - Connected - Disconnected - Error x-ms-enum: name: StatusTypes modelAsString: true lastStatusChange: readOnly: true type: string format: date-time description: The time of the last status change. clientPublicKey: description: Gets or sets the Public Key provided by the client for enabling guest management. type: string agentVersion: readOnly: true type: string description: The hybrid machine agent full version. errorDetails: readOnly: true type: array items: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail description: Details about the error state. x-ms-identifiers: [] VirtualDisk_3: description: Virtual disk model required: - totalSize - independenceMode - controllerId properties: controllerId: description: Disk's Controller id type: string independenceMode: description: Disk's independence mode type type: string enum: - persistent - independent_persistent - independent_nonpersistent x-ms-enum: modelAsString: false name: DiskIndependenceMode totalSize: description: Disk's total size type: integer virtualDiskId: description: Disk's id type: string virtualDiskName: description: Disk's display name type: string readOnly: true VirtualMachineListResult: type: object description: List of VirtualMachines. properties: value: type: array description: List of VirtualMachines. items: $ref: '#/definitions/VirtualMachine_2' nextLink: type: string description: Url to follow for getting next page of resources. CloudError: description: Error from a REST request. type: object properties: error: $ref: '#/definitions/CloudErrorBody' description: The cloud error that occurred x-ms-external: true AvailabilitySetList: description: Availability Sets in vm. type: array items: description: Availability Set model type: object properties: id: description: Gets the ARM Id of the microsoft.scvmm/availabilitySets resource. type: string name: description: Gets or sets the name of the availability set. type: string NetworkInterfaceUpdate: description: Defines the network interface update. type: object properties: name: description: Gets or sets the name of the network interface. type: string networkId: description: Gets or sets the ARM Id of the network resource to connect the virtual machine. type: string nicType: description: NIC type $ref: '#/definitions/NICType' powerOnBoot: description: Gets or sets the power on boot. $ref: '#/definitions/PowerOnBootOption' deviceKey: format: int32 description: Gets or sets the device key value. type: integer IPAddressAllocationMethod: description: IP address allocation method. enum: - unset - dynamic - static - linklayer - random - other type: string x-ms-enum: modelAsString: true name: IPAddressAllocationMethod NetworkProfileUpdate: description: Specifies the network interfaces of the virtual machine. type: object properties: networkInterfaces: description: Gets or sets the list of network interfaces associated with the virtual machine. type: array items: $ref: '#/definitions/NetworkInterfaceUpdate' parameters: ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string description: The name of the resource group. x-ms-parameter-location: method OperationIdParameter: name: operationId in: path required: true type: string description: The long running operation id. x-ms-parameter-location: method resourceGroupName_2: name: resourceGroupName in: path description: The name of the resource group. required: true type: string x-ms-parameter-location: method api-version_3: type: string description: Client API version. name: api-version in: query required: true api-version_2: name: api-version in: query description: Client API version. required: true type: string default: '2018-09-15' ClusterNameParameter: name: clusterName in: path required: true type: string description: The name of the cluster. x-ms-parameter-location: method referer: type: string x-ms-parameter-location: method description: referer url name: Referer in: header required: true subscriptionId_2: name: subscriptionId in: path description: The subscription ID. required: true type: string ApiVersionParameter_2: name: api-version in: query required: true type: string description: The API version to be used with the HTTP request (e.g. YYYY-MM-DD). api-version: in: query name: api-version description: Client Api Version. required: true type: string subscriptionId_3: type: string description: The subscription ID. name: subscriptionId in: path required: true SubscriptionIdParameter_2: name: subscriptionId in: path required: true type: string description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). ApiVersionParameter: name: api-version in: query required: true type: string description: The HDInsight client API Version. resourceGroupName: in: path name: resourceGroupName description: The Resource Group Name. required: true type: string x-ms-parameter-location: method SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. subscriptionId: in: path name: subscriptionId description: The Subscription ID. required: true type: string resourceGroupName_3: type: string x-ms-parameter-location: method description: The name of the resource group name: resourceGroupName in: path required: true x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'