swagger: '2.0' info: title: Microsoft Azure SCVMM description: The Microsoft.ScVmm Rest API spec. version: 2022-05-21-preview host: management.azure.com schemes: - https consumes: - application/json produces: - application/json security: - azure_auth: - user_impersonation securityDefinitions: azure_auth: type: oauth2 authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize flow: implicit description: Azure Active Directory OAuth2 Flow. scopes: user_impersonation: impersonate your user account paths: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}: get: tags: - VmmServers operationId: microsoftAzureVmmserversGet summary: 'Microsoft Azure Gets A Vmmserver' description: Implements VMMServer GET method. x-ms-examples: GetVMMServer: $ref: ./examples/GetVMMServer.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: vmmServerName required: true type: string description: Name of the VMMServer. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Retrieves the VmmServers resource. schema: $ref: '#/definitions/VMMServer' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' put: tags: - VmmServers operationId: microsoftAzureVmmserversCreateorupdate description: Onboards the SCVMM fabric as an Azure VmmServer resource. summary: 'Microsoft Azure Implements Vmmservers Put Method' x-ms-examples: CreateVMMServer: $ref: ./examples/CreateVMMServer.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: vmmServerName required: true type: string description: Name of the VMMServer. - $ref: '#/parameters/ApiVersionParameter' - name: body description: Request payload. in: body required: true schema: $ref: '#/definitions/VMMServer' responses: '200': description: Creates or Updates the VmmServers resource. schema: $ref: '#/definitions/VMMServer' '201': description: Creates or Updates the VmmServers resource. schema: $ref: '#/definitions/VMMServer' 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: azure-async-operation delete: tags: - VmmServers operationId: microsoftAzureVmmserversDelete description: Deboards the SCVMM fabric from Azure. summary: 'Microsoft Azure Implements Vmmservers Delete Method' x-ms-examples: DeleteVMMServer: $ref: ./examples/DeleteVMMServer.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: vmmServerName required: true type: string description: Name of the VMMServer. - $ref: '#/parameters/ApiVersionParameter' - 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 responses: '200': description: Deletes the VmmServers resource. '202': description: Accepted '204': description: No Content 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: azure-async-operation patch: tags: - VmmServers operationId: microsoftAzureVmmserversUpdate summary: 'Microsoft Azure Implements Vmmservers Patch Method' description: Updates the VmmServers resource. x-ms-examples: UpdateVMMServer: $ref: ./examples/UpdateVMMServer.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - in: path name: vmmServerName required: true type: string description: Name of the VMMServer. - name: body description: VmmServers patch payload. in: body required: true schema: $ref: '#/definitions/ResourcePatch' responses: '200': description: Successful. schema: $ref: '#/definitions/VMMServer' '201': description: Created schema: $ref: '#/definitions/VMMServer' '202': description: Accepted 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: azure-async-operation /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers: get: tags: - VmmServers operationId: microsoftAzureVmmserversListbyresourcegroup summary: 'Microsoft Azure Implements Get Vmmservers In A Resource Group' description: List of VmmServers in a resource group. x-ms-examples: ListVmmServersByResourceGroup: $ref: ./examples/ListVMMServersByResourceGroup.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all VmmServers under the resource group. schema: $ref: '#/definitions/VMMServerListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/vmmServers: get: tags: - VmmServers operationId: microsoftAzureVmmserversListbysubscription summary: 'Microsoft Azure Implements Get Vmmservers In A Subscription' description: List of VmmServers in a subscription. x-ms-examples: ListVmmServersBySubscription: $ref: ./examples/ListVMMServersBySubscription.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all VmmServers under the subscription. schema: $ref: '#/definitions/VMMServerListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink /providers/Microsoft.ScVmm/operations: get: tags: - Operations operationId: microsoftAzureOperationsList description: Returns list of all operations. x-ms-examples: ListOperations: $ref: ./examples/ListOperations.json parameters: - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Describe the result of a successful operation. schema: $ref: '#/definitions/ResourceProviderOperationList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Scvmm Operations /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds/{cloudName}: get: tags: - Clouds operationId: microsoftAzureCloudsGet summary: 'Microsoft Azure Gets A Cloud' description: Implements Cloud GET method. x-ms-examples: GetCloud: $ref: ./examples/GetCloud.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: cloudName required: true type: string description: Name of the Cloud. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Retrieves the Clouds resource. schema: $ref: '#/definitions/Cloud' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' put: tags: - Clouds operationId: microsoftAzureCloudsCreateorupdate description: Onboards the ScVmm fabric cloud as an Azure cloud resource. summary: 'Microsoft Azure Implements Clouds Put Method' x-ms-examples: CreateCloud: $ref: ./examples/CreateCloud.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: cloudName required: true type: string description: Name of the Cloud. - $ref: '#/parameters/ApiVersionParameter' - name: body description: Request payload. in: body required: true schema: $ref: '#/definitions/Cloud' responses: '200': description: Creates or Updates the Clouds resource. schema: $ref: '#/definitions/Cloud' '201': description: Creates or Updates the Clouds resource. schema: $ref: '#/definitions/Cloud' 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: azure-async-operation delete: tags: - Clouds operationId: microsoftAzureCloudsDelete description: Deregisters the ScVmm fabric cloud from Azure. summary: 'Microsoft Azure Implements Cloud Resource Delete Method' x-ms-examples: DeleteCloud: $ref: ./examples/DeleteCloud.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: cloudName required: true type: string description: Name of the Cloud. - $ref: '#/parameters/ApiVersionParameter' - 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 responses: '200': description: Deletes the Clouds resource. '202': description: Accepted '204': description: No Content 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: azure-async-operation patch: tags: - Clouds operationId: microsoftAzureCloudsUpdate summary: 'Microsoft Azure Implements The Clouds Patch Method' description: Updates the Clouds resource. x-ms-examples: UpdateCloud: $ref: ./examples/UpdateCloud.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - in: path name: cloudName required: true type: string description: Name of the Cloud. - name: body description: Clouds patch payload. in: body required: true schema: $ref: '#/definitions/ResourcePatch' responses: '200': description: Successful. schema: $ref: '#/definitions/Cloud' '201': description: Created schema: $ref: '#/definitions/Cloud' '202': description: Accepted 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: azure-async-operation /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/clouds: get: tags: - Clouds operationId: microsoftAzureCloudsListbyresourcegroup summary: 'Microsoft Azure Implements Get Clouds In A Resource Group' description: List of Clouds in a resource group. x-ms-examples: ListCloudsByResourceGroup: $ref: ./examples/ListCloudsByResourceGroup.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all Clouds under the resource group. schema: $ref: '#/definitions/CloudListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/clouds: get: tags: - Clouds operationId: microsoftAzureCloudsListbysubscription summary: 'Microsoft Azure Implements Get Clouds In A Subscription' description: List of Clouds in a subscription. x-ms-examples: ListCloudsBySubscription: $ref: ./examples/ListCloudsBySubscription.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all Clouds under the subscription. schema: $ref: '#/definitions/CloudListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks/{virtualNetworkName} : get: tags: - VirtualNetworks operationId: microsoftAzureVirtualnetworksGet summary: 'Microsoft Azure Gets A Virtualnetwork' description: Implements VirtualNetwork GET method. x-ms-examples: GetVirtualNetwork: $ref: ./examples/GetVirtualNetwork.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualNetworkName required: true type: string description: Name of the VirtualNetwork. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Retrieves the VirtualNetworks resource. schema: $ref: '#/definitions/VirtualNetwork' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' put: tags: - VirtualNetworks operationId: microsoftAzureVirtualnetworksCreateorupdate description: Onboards the ScVmm virtual network as an Azure virtual network resource. summary: 'Microsoft Azure Implements Virtualnetworks Put Method' x-ms-examples: CreateVirtualNetwork: $ref: ./examples/CreateVirtualNetwork.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualNetworkName required: true type: string description: Name of the VirtualNetwork. - $ref: '#/parameters/ApiVersionParameter' - name: body description: Request payload. in: body required: true schema: $ref: '#/definitions/VirtualNetwork' responses: '200': description: Creates or Updates the VirtualNetworks resource. schema: $ref: '#/definitions/VirtualNetwork' '201': description: Creates or Updates the VirtualNetworks resource. schema: $ref: '#/definitions/VirtualNetwork' 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: azure-async-operation delete: tags: - VirtualNetworks operationId: microsoftAzureVirtualnetworksDelete description: Deregisters the ScVmm virtual network from Azure. summary: 'Microsoft Azure Implements Virtualnetwork Delete Method' x-ms-examples: DeleteVirtualNetwork: $ref: ./examples/DeleteVirtualNetwork.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualNetworkName required: true type: string description: Name of the VirtualNetwork. - $ref: '#/parameters/ApiVersionParameter' - 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 responses: '200': description: Deletes the VirtualNetworks resource. '202': description: Accepted '204': description: No Content 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: azure-async-operation patch: tags: - VirtualNetworks operationId: microsoftAzureVirtualnetworksUpdate summary: 'Microsoft Azure Implements The Virtualnetworks Patch Method' description: Updates the VirtualNetworks resource. x-ms-examples: UpdateVirtualNetwork: $ref: ./examples/UpdateVirtualNetwork.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - in: path name: virtualNetworkName required: true type: string description: Name of the VirtualNetwork. - name: body description: VirtualNetworks patch payload. in: body required: true schema: $ref: '#/definitions/ResourcePatch' responses: '200': description: Successful. schema: $ref: '#/definitions/VirtualNetwork' '201': description: Created schema: $ref: '#/definitions/VirtualNetwork' '202': description: Accepted 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: azure-async-operation /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualNetworks: get: tags: - VirtualNetworks operationId: microsoftAzureVirtualnetworksListbyresourcegroup summary: 'Microsoft Azure Implements Get Virtualnetworks In A Resource Group' description: List of VirtualNetworks in a resource group. x-ms-examples: ListVirtualNetworksByResourceGroup: $ref: ./examples/ListVirtualNetworksByResourceGroup.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all VirtualNetworks under the resource group. schema: $ref: '#/definitions/VirtualNetworkListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualNetworks: get: tags: - VirtualNetworks operationId: microsoftAzureVirtualnetworksListbysubscription summary: 'Microsoft Azure Implements Get Virtualnetworks In A Subscription' description: List of VirtualNetworks in a subscription. x-ms-examples: ListVirtualNetworksBySubscription: $ref: ./examples/ListVirtualNetworksBySubscription.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all VirtualNetworks under the subscription. schema: $ref: '#/definitions/VirtualNetworkListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /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' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Retrieves the VirtualMachines resource. schema: $ref: '#/definitions/VirtualMachine' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' 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' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - $ref: '#/parameters/ApiVersionParameter' - name: body description: Request payload. in: body required: true schema: $ref: '#/definitions/VirtualMachine' responses: '200': description: Creates or Updates the VirtualMachines resource. schema: $ref: '#/definitions/VirtualMachine' '201': description: Creates or Updates the VirtualMachines resource. schema: $ref: '#/definitions/VirtualMachine' 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: 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' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the VirtualMachine. - $ref: '#/parameters/ApiVersionParameter' - 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' 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' - $ref: '#/parameters/SubscriptionIdParameter' - 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' responses: '200': description: Successful. schema: $ref: '#/definitions/VirtualMachine' '201': description: Creates or Updates the VirtualMachines resource. schema: $ref: '#/definitions/VirtualMachine' '202': description: Accepted 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: 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' - $ref: '#/parameters/SubscriptionIdParameter' - 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' 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' - $ref: '#/parameters/SubscriptionIdParameter' - 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' 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' - $ref: '#/parameters/SubscriptionIdParameter' - 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' 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' - $ref: '#/parameters/SubscriptionIdParameter' - 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' 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' - $ref: '#/parameters/SubscriptionIdParameter' - 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' 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' - $ref: '#/parameters/SubscriptionIdParameter' - 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' 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' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' 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' 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' - $ref: '#/parameters/ApiVersionParameter' 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' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName} : get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesGet summary: 'Microsoft Azure Gets A Virtualmachinetemplate' description: Implements VirtualMachineTemplate GET method. x-ms-examples: GetVirtualMachineTemplate: $ref: ./examples/GetVirtualMachineTemplate.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the VirtualMachineTemplate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Retrieves the VirtualMachineTemplates resource. schema: $ref: '#/definitions/VirtualMachineTemplate' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' put: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesCreateorupdate description: Onboards the ScVmm VM Template as an Azure VM Template resource. summary: 'Microsoft Azure Implements Virtualmachinetemplates Put Method' x-ms-examples: CreateVirtualMachineTemplate: $ref: ./examples/CreateVirtualMachineTemplate.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the VirtualMachineTemplate. - $ref: '#/parameters/ApiVersionParameter' - name: body description: Request payload. in: body required: true schema: $ref: '#/definitions/VirtualMachineTemplate' responses: '200': description: Creates or Updates the VirtualMachineTemplates resource. schema: $ref: '#/definitions/VirtualMachineTemplate' '201': description: Creates or Updates the VirtualMachineTemplates resource. schema: $ref: '#/definitions/VirtualMachineTemplate' 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: azure-async-operation delete: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesDelete description: Deregisters the ScVmm VM Template from Azure. summary: 'Microsoft Azure Implements Virtualmachinetemplate Delete Method' x-ms-examples: DeleteVirtualMachineTemplate: $ref: ./examples/DeleteVirtualMachineTemplate.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the VirtualMachineTemplate. - $ref: '#/parameters/ApiVersionParameter' - 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 responses: '200': description: Deletes the VirtualMachineTemplates resource. '202': description: Accepted '204': description: No Content 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: azure-async-operation patch: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesUpdate summary: 'Microsoft Azure Implements The Virtualmachinetemplate Patch Method' description: Updates the VirtualMachineTemplate resource. x-ms-examples: UpdateVirtualMachineTemplate: $ref: ./examples/UpdateVirtualMachineTemplate.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the VirtualMachineTemplate. - name: body description: VirtualMachineTemplates patch details. in: body required: true schema: $ref: '#/definitions/ResourcePatch' responses: '200': description: Successful. schema: $ref: '#/definitions/VirtualMachineTemplate' '201': description: Created schema: $ref: '#/definitions/VirtualMachineTemplate' '202': description: Accepted 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: azure-async-operation /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates: get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesListbyresourcegroup summary: 'Microsoft Azure Implements Get Virtualmachinetemplates In A Resource Group' description: List of VirtualMachineTemplates in a resource group. x-ms-examples: ListVirtualMachineTemplatesByResourceGroup: $ref: ./examples/ListVirtualMachineTemplatesByResourceGroup.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all VirtualMachineTemplates under the resource group. schema: $ref: '#/definitions/VirtualMachineTemplateListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualMachineTemplates: get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesListbysubscription summary: 'Microsoft Azure Implements Get Virtualmachinetemplates In A Subscription' description: List of VirtualMachineTemplates in a subscription. x-ms-examples: ListVirtualMachineTemplatesBySubscription: $ref: ./examples/ListVirtualMachineTemplatesBySubscription.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all VirtualMachineTemplates under the subscription. schema: $ref: '#/definitions/VirtualMachineTemplateListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets/{availabilitySetName} : get: tags: - AvailabilitySets operationId: microsoftAzureAvailabilitysetsGet summary: 'Microsoft Azure Gets An Availabilityset' description: Implements AvailabilitySet GET method. x-ms-examples: GetAvailabilitySet: $ref: ./examples/GetAvailabilitySet.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: availabilitySetName required: true type: string description: Name of the AvailabilitySet. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Retrieves the AvailabilitySet resource. schema: $ref: '#/definitions/AvailabilitySet' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' put: tags: - AvailabilitySets operationId: microsoftAzureAvailabilitysetsCreateorupdate description: Onboards the ScVmm availability set as an Azure resource. summary: 'Microsoft Azure Implements Availabilitysets Put Method' x-ms-examples: CreateAvailabilitySet: $ref: ./examples/CreateAvailabilitySet.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: availabilitySetName required: true type: string description: Name of the AvailabilitySet. - $ref: '#/parameters/ApiVersionParameter' - name: body description: Request payload. in: body required: true schema: $ref: '#/definitions/AvailabilitySet' responses: '200': description: Creates or Updates the AvailabilitySets resource. schema: $ref: '#/definitions/AvailabilitySet' '201': description: Creates or Updates the AvailabilitySets resource. schema: $ref: '#/definitions/AvailabilitySet' headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string 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: azure-async-operation delete: tags: - AvailabilitySets operationId: microsoftAzureAvailabilitysetsDelete description: Deregisters the ScVmm availability set from Azure. summary: 'Microsoft Azure Implements Availabilityset Delete Method' x-ms-examples: DeleteAvailabilitySet: $ref: ./examples/DeleteAvailabilitySet.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: availabilitySetName required: true type: string description: Name of the AvailabilitySet. - $ref: '#/parameters/ApiVersionParameter' - 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 responses: '200': description: Deletes the AvailabilitySets resource. '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true patch: tags: - AvailabilitySets operationId: microsoftAzureAvailabilitysetsUpdate summary: 'Microsoft Azure Implements The Availabilitysets Patch Method' description: Updates the AvailabilitySets resource. x-ms-examples: UpdateAvailabilitySet: $ref: ./examples/UpdateAvailabilitySet.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - in: path name: availabilitySetName required: true type: string description: Name of the AvailabilitySet. - name: body description: AvailabilitySets patch payload. in: body required: true schema: $ref: '#/definitions/ResourcePatch' responses: '200': description: Successful. schema: $ref: '#/definitions/AvailabilitySet' '201': description: Created schema: $ref: '#/definitions/AvailabilitySet' '202': description: Accepted 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: azure-async-operation /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/availabilitySets: get: tags: - AvailabilitySets operationId: microsoftAzureAvailabilitysetsListbyresourcegroup summary: 'Microsoft Azure Implements Get Availabilitysets In A Resource Group' description: List of AvailabilitySets in a resource group. x-ms-examples: ListAvailabilitySetsByResourceGroup: $ref: ./examples/ListAvailabilitySetsByResourceGroup.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all AvailabilitySets under the resource group. schema: $ref: '#/definitions/AvailabilitySetListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/availabilitySets: get: tags: - AvailabilitySets operationId: microsoftAzureAvailabilitysetsListbysubscription summary: 'Microsoft Azure Implements Get Availabilitysets In A Subscription' description: List of AvailabilitySets in a subscription. x-ms-examples: ListAvailabilitySetsBySubscription: $ref: ./examples/ListAvailabilitySetsBySubscription.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all AvailabilitySets under the subscription. schema: $ref: '#/definitions/AvailabilitySetListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems/{inventoryItemName} : put: tags: - InventoryItems operationId: microsoftAzureInventoryitemsCreate summary: 'Microsoft Azure Implements Inventoryitem Put Method' description: Create Or Update InventoryItem. x-ms-examples: CreateInventoryItem: $ref: ./examples/CreateInventoryItem.json consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: vmmServerName required: true type: string description: Name of the VMMServer. - in: path name: inventoryItemName required: true type: string description: Name of the inventoryItem. - $ref: '#/parameters/ApiVersionParameter' - in: body name: body description: Request payload. schema: $ref: '#/definitions/InventoryItem' responses: '200': description: Success schema: $ref: '#/definitions/InventoryItem' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' get: tags: - InventoryItems operationId: microsoftAzureInventoryitemsGet summary: 'Microsoft Azure Implements Get Inventoryitem Method' description: Shows an inventory item. x-ms-examples: GetInventoryItem: $ref: ./examples/GetInventoryItem.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: vmmServerName required: true type: string description: Name of the VMMServer. - in: path name: inventoryItemName required: true type: string description: Name of the inventoryItem. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success schema: $ref: '#/definitions/InventoryItem' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' delete: tags: - InventoryItems operationId: microsoftAzureInventoryitemsDelete summary: 'Microsoft Azure Implements Inventoryitem Delete Method' description: Deletes an inventoryItem. x-ms-examples: DeleteInventoryItem: $ref: ./examples/DeleteInventoryItem.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: vmmServerName required: true type: string description: Name of the VMMServer. - in: path name: inventoryItemName required: true type: string description: Name of the inventoryItem. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}/inventoryItems : get: tags: - InventoryItems operationId: microsoftAzureInventoryitemsListbyvmmserver summary: 'Microsoft Azure Implements Get For The List Of Inventory Items In The Vmmserver' description: Returns the list of inventoryItems in the given VMMServer. x-ms-examples: InventoryItemsListByVMMServer: $ref: ./examples/ListInventoryItemsByVMMServer.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: vmmServerName required: true type: string description: Name of the VMMServer. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success schema: $ref: '#/definitions/InventoryItemsList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/hybridIdentityMetadata/{metadataName} : put: tags: - HybridIdentityMetadata operationId: microsoftAzureHybrididentitymetadatasCreate description: Create Or Update HybridIdentityMetadata. summary: 'Microsoft Azure Implements Hybrididentitymetadata Put Method' x-ms-examples: CreateHybridIdentityMetadata: $ref: ./examples/CreateHybridIdentityMetadata.json consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the vm. - in: path name: metadataName required: true type: string description: Name of the hybridIdentityMetadata. - $ref: '#/parameters/ApiVersionParameter' - in: body name: body description: Request payload. schema: $ref: '#/definitions/HybridIdentityMetadata' responses: '200': description: Success schema: $ref: '#/definitions/HybridIdentityMetadata' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' get: tags: - HybridIdentityMetadata operationId: microsoftAzureHybrididentitymetadatasGet summary: 'Microsoft Azure Gets Hybrididentitymetadata' description: Implements HybridIdentityMetadata GET method. x-ms-examples: GetHybridIdentityMetadata: $ref: ./examples/GetHybridIdentityMetadata.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the vm. - in: path name: metadataName required: true type: string description: Name of the HybridIdentityMetadata. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success schema: $ref: '#/definitions/HybridIdentityMetadata' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' delete: tags: - HybridIdentityMetadata operationId: microsoftAzureHybrididentitymetadatasDelete summary: 'Microsoft Azure Deletes An Hybrididentitymetadata' description: Implements HybridIdentityMetadata DELETE method. x-ms-examples: DeleteHybridIdentityMetadata: $ref: ./examples/DeleteHybridIdentityMetadata.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the vm. - in: path name: metadataName required: true type: string description: Name of the HybridIdentityMetadata. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/hybridIdentityMetadata : get: tags: - HybridIdentityMetadata operationId: microsoftAzureHybrididentitymetadatasListbyvm summary: 'Microsoft Azure Implements Get Hybrididentitymetadata In A Vm' description: Returns the list of HybridIdentityMetadata of the given vm. x-ms-examples: HybridIdentityMetadataListByVm: $ref: ./examples/HybridIdentityMetadata_ListByVm.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the vm. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success schema: $ref: '#/definitions/HybridIdentityMetadataList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/extensions/{extensionName} : put: tags: - MachineExtensions operationId: microsoftAzureMachineextensionsCreateorupdate description: The operation to create or update the extension. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - in: path name: virtualMachineName required: true type: string description: >- The name of the machine where the extension should be created or updated. - name: extensionName in: path required: true type: string description: The name of the machine extension. - name: extensionParameters in: body required: true schema: $ref: '#/definitions/MachineExtension' description: Parameters supplied to the Create Machine Extension operation. responses: '200': description: OK schema: $ref: '#/definitions/MachineExtension' '201': description: >- HTTP 201 (Created) if the operation was successfully started and will complete asynchronously. schema: $ref: '#/definitions/MachineExtension' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Create or Update a Machine Extension (PUT): $ref: ./examples/PUTExtension.json x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation summary: >- Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scvmm Virtualmachines Virtualmachinename Extensions Extensionname patch: tags: - MachineExtensions operationId: microsoftAzureMachineextensionsUpdate description: The operation to update the extension. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - in: path name: virtualMachineName required: true type: string description: >- The name of the machine where the extension should be created or updated. - name: extensionName in: path required: true type: string description: The name of the machine extension. - name: extensionParameters in: body required: true schema: $ref: '#/definitions/MachineExtensionUpdate' description: Parameters supplied to the Create Machine Extension operation. responses: '200': description: OK schema: $ref: '#/definitions/MachineExtension' '202': description: Accepted headers: Azure-AsyncOperation: description: Tracking URL for long running operation. type: string default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Create or Update a Machine Extension (PATCH): $ref: ./examples/UpdateExtension.json x-ms-long-running-operation: true summary: >- Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scvmm Virtualmachines Virtualmachinename Extensions Extensionname delete: tags: - MachineExtensions operationId: microsoftAzureMachineextensionsDelete description: The operation to delete the extension. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - in: path name: virtualMachineName required: true type: string description: >- The name of the machine where the extension should be created or updated. - name: extensionName in: path required: true type: string description: The name of the machine extension. responses: '200': description: OK '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-examples: Delete a Machine Extension: $ref: ./examples/DeleteExtension.json summary: >- Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scvmm Virtualmachines Virtualmachinename Extensions Extensionname get: tags: - MachineExtensions operationId: microsoftAzureMachineextensionsGet description: The operation to get the extension. parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - in: path name: virtualMachineName required: true type: string description: >- The name of the machine where the extension should be created or updated. - name: extensionName in: path required: true type: string description: The name of the machine extension. responses: '200': description: OK schema: $ref: '#/definitions/MachineExtension' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get Machine Extension: $ref: ./examples/GETExtension.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scvmm Virtualmachines Virtualmachinename Extensions Extensionname ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/extensions : get: tags: - MachineExtensions operationId: microsoftAzureMachineextensionsList description: The operation to get all extensions of a non-Azure machine parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - in: path name: virtualMachineName required: true type: string description: >- The name of the machine where the extension should be created or updated. - name: $expand in: query required: false type: string description: The expand expression to apply on the operation. responses: '200': description: OK schema: $ref: '#/definitions/MachineExtensionsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get all Machine Extensions: $ref: ./examples/ListExtension.json summary: >- Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Scvmm Virtualmachines Virtualmachinename Extensions ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/guestAgents/{guestAgentName} : put: tags: - GuestAgents operationId: microsoftAzureGuestagentsCreate description: Create Or Update GuestAgent. summary: 'Microsoft Azure Implements Guestagent Put Method' x-ms-examples: CreateGuestAgent: $ref: ./examples/CreateGuestAgent.json consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the vm. - in: path name: guestAgentName required: true type: string description: Name of the guestAgents. - $ref: '#/parameters/ApiVersionParameter' - in: body name: body description: Request payload. schema: $ref: '#/definitions/GuestAgent' responses: '200': description: Success schema: $ref: '#/definitions/GuestAgent' '201': description: Created schema: $ref: '#/definitions/GuestAgent' 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: azure-async-operation get: tags: - GuestAgents operationId: microsoftAzureGuestagentsGet summary: 'Microsoft Azure Gets Guestagent' description: Implements GuestAgent GET method. x-ms-examples: GetGuestAgent: $ref: ./examples/GetGuestAgent.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the vm. - in: path name: guestAgentName required: true type: string description: Name of the GuestAgent. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success schema: $ref: '#/definitions/GuestAgent' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' delete: tags: - GuestAgents operationId: microsoftAzureGuestagentsDelete summary: 'Microsoft Azure Deletes An Guestagent' description: Implements GuestAgent DELETE method. x-ms-examples: DeleteGuestAgent: $ref: ./examples/DeleteGuestAgent.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the vm. - in: path name: guestAgentName required: true type: string description: Name of the GuestAgent. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/guestAgents : get: tags: - GuestAgents operationId: microsoftAzureGuestagentsListbyvm summary: 'Microsoft Azure Implements Get Guestagent In A Vm' description: Returns the list of GuestAgent of the given vm. x-ms-examples: GuestAgentListByVm: $ref: ./examples/GuestAgent_ListByVm.json produces: - application/json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineName required: true type: string description: Name of the vm. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Success schema: $ref: '#/definitions/GuestAgentList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink definitions: VMMServerProperties: description: Defines the resource properties. required: - fqdn type: object properties: credentials: type: object description: Credentials to connect to VMMServer. properties: username: type: string description: Username to use to connect to VMMServer. password: type: string description: Credentials to use to connect to VMMServer. x-ms-mutability: - create - update x-ms-secret: true fqdn: type: string description: Fqdn is the hostname/ip of the vmmServer. minLength: 1 port: type: integer format: int32 description: Port is the port on which the vmmServer is listening. maximum: 65535 minimum: 1 connectionStatus: type: string description: Gets or sets the connection status to the vmmServer. readOnly: true errorMessage: type: string description: >- Gets or sets any error message if connection to vmmServer is having any issue. readOnly: true uuid: type: string description: Unique ID of vmmServer. readOnly: true version: type: string description: Version is the version of the vmmSever. readOnly: true provisioningState: description: Gets or sets the provisioning state. type: string readOnly: true ExtendedLocation: type: object description: The extended location. properties: type: type: string description: The extended location type. name: type: string description: The extended location name. VMMServer: type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VMMServerProperties' 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. required: - location - properties - extendedLocation description: The VmmServers resource definition. VMMServerListResult: type: object description: List of VmmServers. properties: value: type: array description: List of VmmServers. items: $ref: '#/definitions/VMMServer' nextLink: description: Url to follow for getting next page of resources. type: string ResourceProviderOperationList: type: object description: Results of the request to list operations. properties: value: type: array description: List of Operations. items: $ref: '#/definitions/ResourceProviderOperation' x-ms-identifiers: - name nextLink: type: string description: Url to follow for getting next page of resources. CloudProperties: description: Defines the resource properties. type: object properties: inventoryItemId: description: Gets or sets the inventory Item ID for the resource. type: string uuid: type: string description: Unique ID of the cloud. minLength: 1 vmmServerId: type: string description: ARM Id of the vmmServer resource in which this resource resides. cloudName: type: string description: Name of the cloud in VMMServer. readOnly: true cloudCapacity: $ref: '#/definitions/CloudCapacity' description: Capacity of the cloud. readOnly: true storageQoSPolicies: description: List of QoS policies available for the cloud. type: array items: $ref: '#/definitions/StorageQoSPolicy' readOnly: true provisioningState: type: string description: Gets or sets the provisioning state. readOnly: true Cloud: type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/CloudProperties' 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. required: - location - properties - extendedLocation description: The Clouds resource definition. CloudListResult: type: object description: List of Clouds. properties: value: type: array description: List of Clouds. items: $ref: '#/definitions/Cloud' nextLink: type: string description: Url to follow for getting next page of resources. VirtualNetworkProperties: description: Defines the resource properties. type: object properties: inventoryItemId: description: Gets or sets the inventory Item ID for the resource. type: string uuid: type: string description: Unique ID of the virtual network. minLength: 1 vmmServerId: type: string description: ARM Id of the vmmServer resource in which this resource resides. networkName: type: string description: Name of the virtual network in vmmServer. readOnly: true provisioningState: type: string description: Gets or sets the provisioning state. readOnly: true VirtualNetwork: type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VirtualNetworkProperties' 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. required: - location - properties - extendedLocation description: The VirtualNetworks resource definition. VirtualNetworkListResult: type: object description: List of VirtualNetworks. properties: value: type: array description: List of VirtualNetworks. items: $ref: '#/definitions/VirtualNetwork' nextLink: type: string description: Url to follow for getting next page of resources. AvailabilitySetProperties: description: Defines the resource properties. type: object properties: availabilitySetName: type: string description: Name of the availability set. minLength: 1 vmmServerId: type: string description: ARM Id of the vmmServer resource in which this resource resides. provisioningState: type: string description: Gets or sets the provisioning state. readOnly: true AvailabilitySet: type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/AvailabilitySetProperties' 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. description: The AvailabilitySets resource definition. AvailabilitySetListResult: type: object description: List of AvailabilitySets. properties: value: type: array description: List of AvailabilitySets. items: $ref: '#/definitions/AvailabilitySet' nextLink: type: string description: Url to follow for getting next page of resources. 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 VirtualMachineProperties: 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' hardwareProfile: description: Hardware properties. $ref: '#/definitions/HardwareProfile' networkProfile: description: Network properties. $ref: '#/definitions/NetworkProfile' storageProfile: description: Storage properties. $ref: '#/definitions/StorageProfile' 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' provisioningState: description: Gets or sets the provisioning state. type: string readOnly: true OsType: 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 OsProfile: 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' readOnly: true osName: description: Gets or sets os name. type: string readOnly: true HardwareProfile: 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 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. 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 NetworkProfileUpdate: 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 NetworkProfile: 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 AllocationMethod: description: Allocation method. enum: - Dynamic - Static x-ms-enum: modelAsString: true name: AllocationMethod type: string 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 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 CloudCapacity: description: Cloud Capacity model type: object properties: cpuCount: type: integer format: int64 description: >- CPUCount specifies the maximum number of CPUs that can be allocated in the cloud. memoryMB: type: integer format: int64 description: MemoryMB specifies a memory usage limit in megabytes. vmCount: type: integer format: int64 description: VMCount gives the max number of VMs that can be deployed in the cloud. readOnly: true 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 VirtualDisk: 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 VirtualDiskUpdate: 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' StorageProfileUpdate: 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' x-ms-identifiers: - name - diskId StorageProfile: 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' x-ms-identifiers: - name - diskId 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 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 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 VirtualMachine: type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VirtualMachineProperties' 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. VirtualMachineListResult: type: object description: List of VirtualMachines. properties: value: type: array description: List of VirtualMachines. items: $ref: '#/definitions/VirtualMachine' nextLink: type: string description: Url to follow for getting next page of resources. VirtualMachineUpdateProperties: description: Defines the resource properties. type: object properties: hardwareProfile: $ref: '#/definitions/HardwareProfileUpdate' storageProfile: $ref: '#/definitions/StorageProfileUpdate' networkProfile: $ref: '#/definitions/NetworkProfileUpdate' availabilitySets: $ref: '#/definitions/AvailabilitySetList' checkpointType: type: string description: Type of checkpoint supported for the vm. VirtualMachineUpdate: description: Defines the virtualMachineUpdate. type: object properties: 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. VirtualMachineTemplateProperties: description: Defines the resource properties. type: object properties: inventoryItemId: description: Gets or sets the inventory Item ID for the resource. type: string uuid: type: string description: Unique ID of the virtual machine template. minLength: 1 vmmServerId: type: string description: ARM Id of the vmmServer resource in which this resource resides. osType: description: Gets or sets the type of the os. $ref: '#/definitions/OsType' readOnly: true osName: description: Gets or sets os name. type: string readOnly: true computerName: description: Gets or sets computer name. type: string readOnly: true memoryMB: type: integer format: int32 description: MemoryMB is the desired size of a virtual machine's memory, in MB. readOnly: true cpuCount: type: integer description: Gets or sets the desired number of vCPUs for the vm. format: int32 readOnly: true 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 readOnly: true 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 readOnly: true isCustomizable: type: string description: >- Gets or sets a value indicating whether the vm template is customizable or not. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: IsCustomizable readOnly: true dynamicMemoryMaxMB: type: integer format: int32 description: Gets or sets the max dynamic memory for the vm. readOnly: true dynamicMemoryMinMB: type: integer format: int32 description: Gets or sets the min dynamic memory for the vm. readOnly: true isHighlyAvailable: description: Gets highly available property. type: string readOnly: true generation: type: integer format: int32 description: Gets or sets the generation for the vm. readOnly: true networkInterfaces: description: Gets or sets the network interfaces of the template. type: array items: $ref: '#/definitions/NetworkInterfaces' x-ms-identifiers: - name - nicId readOnly: true disks: description: Gets or sets the disks of the template. type: array items: $ref: '#/definitions/VirtualDisk' x-ms-identifiers: - name - diskId readOnly: true provisioningState: description: Gets or sets the provisioning state. type: string readOnly: true VirtualMachineTemplate: type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VirtualMachineTemplateProperties' 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. required: - location - properties - extendedLocation description: The VirtualMachineTemplates resource definition. VirtualMachineTemplateListResult: type: object description: List of VirtualMachineTemplates. properties: value: description: List of VirtualMachineTemplates. type: array items: $ref: '#/definitions/VirtualMachineTemplate' nextLink: type: string description: Url to follow for getting next page of resources. InventoryItemsList: description: List of InventoryItems. type: object properties: nextLink: description: Url to follow for getting next page of InventoryItems. type: string value: description: Array of InventoryItems type: array items: $ref: '#/definitions/InventoryItem' required: - value InventoryItem: description: Defines the inventory item. required: - properties type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource description: >- The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags. properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/InventoryItemProperties' 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. x-ms-azure-resource: true InventoryItemProperties: description: Defines the resource properties. required: - inventoryType discriminator: inventoryType type: object properties: inventoryType: description: They inventory type. $ref: '#/definitions/InventoryType' managedResourceId: description: Gets the tracked resource id corresponding to the inventory resource. type: string readOnly: true uuid: description: Gets the UUID (which is assigned by VMM) for the inventory item. type: string readOnly: true inventoryItemName: description: Gets the Managed Object name in VMM for the inventory item. type: string readOnly: true provisioningState: description: Gets the provisioning state. type: string readOnly: true InventoryType: type: string description: The inventory type. enum: - Cloud - VirtualNetwork - VirtualMachineTemplate - VirtualMachine x-ms-enum: name: InventoryType modelAsString: true InventoryItemDetails: description: Defines the resource properties. type: object properties: inventoryItemId: description: Gets or sets the inventory Item ID for the resource. type: string inventoryItemName: description: Gets or sets the Managed Object name in VMM for the resource. type: string CloudInventoryItem: description: The Cloud inventory item. type: object allOf: - $ref: '#/definitions/InventoryItemProperties' x-ms-discriminator-value: Cloud VirtualNetworkInventoryItem: description: The Virtual network inventory item. type: object allOf: - $ref: '#/definitions/InventoryItemProperties' x-ms-discriminator-value: VirtualNetwork VirtualMachineTemplateInventoryItem: description: The Virtual machine template inventory item. type: object allOf: - $ref: '#/definitions/InventoryItemProperties' properties: cpuCount: type: integer description: Gets or sets the desired number of vCPUs for the vm. format: int32 readOnly: true memoryMB: type: integer format: int32 description: MemoryMB is the desired size of a virtual machine's memory, in MB. readOnly: true osType: description: Gets or sets the type of the os. $ref: '#/definitions/OsType' readOnly: true osName: description: Gets or sets os name. type: string readOnly: true x-ms-discriminator-value: VirtualMachineTemplate VirtualMachineInventoryItem: description: The Virtual machine inventory item. type: object allOf: - $ref: '#/definitions/InventoryItemProperties' properties: osType: description: Gets or sets the type of the os. $ref: '#/definitions/OsType' readOnly: true osName: description: Gets or sets os name. type: string readOnly: true powerState: description: Gets the power state of the virtual machine. type: string readOnly: true ipAddresses: description: Gets or sets the nic ip addresses. type: array items: type: string cloud: description: Cloud inventory resource details where the VM is present. $ref: '#/definitions/InventoryItemDetails' x-ms-discriminator-value: VirtualMachine GuestAgentProfile: 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: [] HybridIdentityMetadataList: description: List of HybridIdentityMetadata. type: object properties: nextLink: description: Url to follow for getting next page of HybridIdentityMetadata. type: string value: description: Array of HybridIdentityMetadata type: array items: $ref: '#/definitions/HybridIdentityMetadata' required: - value HybridIdentityMetadata: description: Defines the HybridIdentityMetadata. required: - properties type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource description: >- The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags. properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/HybridIdentityMetadataProperties' x-ms-azure-resource: true HybridIdentityMetadataProperties: description: Defines the resource properties. type: object properties: resourceUid: description: Gets or sets the Vm Id. type: string publicKey: description: Gets or sets the Public Key. type: string identity: $ref: '#/definitions/Identity' description: The identity of the resource. readOnly: true provisioningState: description: Gets or sets the provisioning state. type: string readOnly: true 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. MachineExtension: x-ms-azure-resource: true type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/MachineExtensionProperties' description: Describes Machine Extension Properties. allOf: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource description: Describes a Machine Extension. MachineExtensionUpdate: type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/MachineExtensionUpdateProperties' description: Describes Machine Extension Update Properties. allOf: - $ref: '#/definitions/ResourcePatch' description: Describes a Machine Extension Update. MachineExtensionProperties: type: object properties: forceUpdateTag: type: string description: >- How the extension handler should be forced to update even if the extension configuration has not changed. publisher: type: string description: The name of the extension handler publisher. type: type: string description: >- Specifies the type of the extension; an example is "CustomScriptExtension". typeHandlerVersion: type: string description: Specifies the version of the script handler. enableAutomaticUpgrade: type: boolean description: >- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. autoUpgradeMinorVersion: type: boolean description: >- Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. settings: type: object description: Json formatted public settings for the extension. protectedSettings: type: object description: >- The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. x-ms-secret: true provisioningState: readOnly: true type: string description: The provisioning state, which only appears in the response. instanceView: allOf: - $ref: '#/definitions/MachineExtensionInstanceView' description: The machine extension instance view. description: Describes the properties of a Machine Extension. MachineExtensionUpdateProperties: type: object properties: forceUpdateTag: type: string description: >- How the extension handler should be forced to update even if the extension configuration has not changed. publisher: type: string description: The name of the extension handler publisher. type: type: string description: >- Specifies the type of the extension; an example is "CustomScriptExtension". typeHandlerVersion: type: string description: Specifies the version of the script handler. enableAutomaticUpgrade: type: boolean description: >- Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available. autoUpgradeMinorVersion: type: boolean description: >- Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true. settings: type: object description: Json formatted public settings for the extension. protectedSettings: type: object description: >- The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. x-ms-secret: true description: Describes the properties of a Machine Extension. MachineExtensionInstanceView: type: object properties: name: type: string readOnly: true description: The machine extension name. type: type: string readOnly: true description: >- Specifies the type of the extension; an example is "CustomScriptExtension". typeHandlerVersion: type: string readOnly: true description: Specifies the version of the script handler. status: type: object properties: code: type: string readOnly: true description: The status code. level: type: string readOnly: true description: The level code. enum: - Info - Warning - Error x-ms-enum: name: StatusLevelTypes modelAsString: true displayStatus: type: string readOnly: true description: The short localizable label for the status. message: type: string readOnly: true description: >- The detailed status message, including for alerts and error messages. time: type: string readOnly: true format: date-time description: The time of the status. description: Instance view status. description: Describes the Machine Extension Instance View. MachineExtensionsListResult: type: object properties: value: type: array items: $ref: '#/definitions/MachineExtension' description: The list of extensions nextLink: type: string description: >- The uri to fetch the next page of machine extensions. Call ListNext() with this to fetch the next page of extensions. description: Describes the Machine Extensions List Result. ProvisioningAction: description: Defines the different types of operations for guest agent. enum: - install - uninstall - repair type: string x-ms-enum: modelAsString: true name: ProvisioningAction GuestCredential: description: Username / Password Credentials to connect to guest. type: object properties: username: description: Gets or sets username to connect with the guest. type: string password: description: Gets or sets the password to connect with the guest. type: string x-ms-mutability: - create - update x-ms-secret: true HttpProxyConfiguration: description: HTTP Proxy configuration for the VM. type: object properties: httpsProxy: description: Gets or sets httpsProxy url. type: string GuestAgentList: description: List of GuestAgent. type: object properties: nextLink: description: Url to follow for getting next page of GuestAgent. type: string value: description: Array of GuestAgent type: array items: $ref: '#/definitions/GuestAgent' required: - value GuestAgent: description: Defines the GuestAgent. required: - properties type: object allOf: - $ref: >- ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource description: >- The resource model definition for an Azure Resource Manager proxy resource. It will have everything other than required location and tags. properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/GuestAgentProperties' x-ms-azure-resource: true GuestAgentProperties: description: Defines the resource properties. type: object properties: uuid: description: Gets or sets a unique identifier for this resource. type: string readOnly: true credentials: description: Username / Password Credentials to provision guest agent. $ref: '#/definitions/GuestCredential' httpProxyConfig: description: HTTP Proxy configuration for the VM. $ref: '#/definitions/HttpProxyConfiguration' provisioningAction: description: Gets or sets the guest agent provisioning action. $ref: '#/definitions/ProvisioningAction' type: string status: description: Gets or sets the guest agent status. type: string readOnly: true customResourceName: description: Gets the name of the corresponding resource in Kubernetes. type: string readOnly: true provisioningState: description: Gets or sets the provisioning state. type: string readOnly: true ResourceProviderOperation: type: object properties: isDataAction: type: string description: Indicates whether the operation applies to data-plane. name: type: string description: Operation name, in format of {provider}/{resource}/{operation}. display: type: object properties: provider: type: string description: The resource provider. resource: type: string description: Resource on which the operation is performed. operation: type: string description: 'Type of operation: read, write, delete, etc.' description: type: string description: Description of this operation. description: Display metadata associated with the operation. description: Results of the request to list operations. ErrorResponse: description: Error response. type: object properties: error: $ref: '#/definitions/ErrorDefinition' description: The error details. 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 StorageQoSPolicy: description: The StorageQoSPolicy definition. type: object properties: name: description: The name of the policy. type: string id: description: The ID of the QoS policy. type: string iopsMaximum: description: The maximum IO operations per second. type: integer format: int64 iopsMinimum: description: The minimum IO operations per second. type: integer format: int64 bandwidthLimit: description: The Bandwidth Limit for internet traffic. type: integer format: int64 policyId: description: The underlying policy. type: string ResourcePatch: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags. description: Object containing tags updates for patch operations. parameters: SubscriptionIdParameter: 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). ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string description: The name of the resource group. x-ms-parameter-location: method ApiVersionParameter: 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). tags: - name: AvailabilitySets - name: Clouds - name: GuestAgents - name: HybridIdentityMetadata - name: InventoryItems - name: MachineExtensions - name: Operations - name: VirtualMachines - name: VirtualMachineTemplates - name: VirtualNetworks - name: VmmServers