swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector MachinesController API schemes: - https tags: - name: MachinesController paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines : get: operationId: microsoftAzureMachinescontrollerListbyvmwaresite tags: - MachinesController description: List MachineResource resources by VmwareSite parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: filter in: query description: filter query required: false type: string - name: top in: query description: page size query required: false type: integer format: int32 - name: continuationToken in: query description: Optional parameter for continuation token. required: false type: string - name: totalRecordCount in: query description: Total count of machines in the given site. required: false type: integer format: int32 - name: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/MachineResourceListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: MachinesController_ListByVmwareSite_MaximumSet_Gen: $ref: ./examples/MachinesController_ListByVmwareSite_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Machines ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName} : get: operationId: microsoftAzureMachinescontrollerGet tags: - MachinesController description: Get a MachineResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: machineName in: path description: Machine name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/MachineResource' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: MachinesController_Get_MaximumSet_Gen: $ref: ./examples/MachinesController_Get_MaximumSet_Gen.json summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Machines Machinename patch: operationId: microsoftAzureMachinescontrollerUpdate tags: - MachinesController description: Update a MachineResource parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: machineName in: path description: Machine name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: body in: body description: The resource properties to be updated. required: true schema: $ref: '#/definitions/MachineResourceUpdate' responses: '200': description: ARM operation completed successfully. schema: $ref: '#/definitions/MachineResource' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: MachinesController_Update_MaximumSet_Gen: $ref: ./examples/MachinesController_Update_MaximumSet_Gen.json summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Machines Machinename ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/start : post: operationId: microsoftAzureMachinescontrollerStart tags: - MachinesController description: Method to start a machine. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: machineName in: path description: Machine name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: type: object '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true x-ms-examples: MachinesController_Start_MaximumSet_Gen: $ref: ./examples/MachinesController_Start_MaximumSet_Gen.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Machines Machinename Start ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/stop : post: operationId: microsoftAzureMachinescontrollerStop tags: - MachinesController description: Method to stop a machine. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - name: siteName in: path description: Site name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ - name: machineName in: path description: Machine name required: true type: string pattern: ^[a-zA-Z0-9-]{3,24}$ responses: '200': description: ARM operation completed successfully. schema: type: object '202': description: The request has been accepted for processing, but processing has not yet completed. headers: Retry-After: type: integer format: int32 description: The Retry-After header can indicate how long the client should wait before polling the operation status. location: type: string description: The Location header contains the URL where the status of the long running operation can be checked. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation-options: final-state-via: location x-ms-long-running-operation: true x-ms-examples: MachinesController_Stop_MaximumSet_Gen: $ref: ./examples/MachinesController_Stop_MaximumSet_Gen.json summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Vmwaresites Sitename Machines Machinename Stop ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/machines : get: tags: - MachinesController summary: Microsoft Azure Gets A List Of Machines In The Migrate Project operationId: microsoftAzureMachinescontrollerListmachines parameters: - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/migrateProjectName' - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/continuationToken' - $ref: '#/parameters/pageSize' responses: '200': description: OK schema: $ref: '#/definitions/MachineCollection' default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse deprecated: false x-ms-pageable: nextLinkName: nextLink x-ms-examples: MachinesController_ListMachines_MaximumSet_Gen: $ref: ./examples/MachinesController_ListMachines_MaximumSet_Gen.json MachinesController_ListMachines_MinimumSet_Gen: $ref: ./examples/MachinesController_ListMachines_MinimumSet_Gen.json description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Migrate/migrateProjects/{migrateProjectName}/machines/{machineName} : get: tags: - MachinesController summary: Microsoft Azure Gets A Machine In The Migrate Project operationId: microsoftAzureMachinescontrollerGetmachine parameters: - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/migrateProjectName' - $ref: '#/parameters/machineName' - $ref: ../../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/Machine' default: description: An unexpected error response. schema: $ref: ../../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse deprecated: false x-ms-examples: MachinesController_GetMachine_MaximumSet_Gen: $ref: ./examples/MachinesController_GetMachine_MaximumSet_Gen.json MachinesController_GetMachine_MinimumSet_Gen: $ref: ./examples/MachinesController_GetMachine_MinimumSet_Gen.json description: Needs a more full description created. definitions: HealthErrorDetails: type: object description: Error contract returned when some exception occurs in Rest API. properties: message: type: string description: Gets the error message. readOnly: true messageParameters: type: object description: Gets the message parameters. additionalProperties: type: string readOnly: true applianceName: type: string description: Gets the appliance name. readOnly: true id: type: integer format: int64 description: Gets the error ID. readOnly: true code: type: string description: Gets the error name. readOnly: true possibleCauses: type: string description: Gets the possible causes of error. readOnly: true recommendedAction: type: string description: Gets the recommended action to resolve error. readOnly: true severity: type: string description: Gets the error severity. readOnly: true summaryMessage: type: string description: Gets the error summary message. readOnly: true source: $ref: '#/definitions/HealthErrorDetailsSource' description: Gets the error source. readOnly: true updatedTimeStamp: type: string format: date-time description: Gets the time stamp when the error was updated. readOnly: true runAsAccountId: type: string description: Gets run as account id used while performing discovery of entity. readOnly: true discoveryScope: $ref: '#/definitions/HealthErrorDetailsDiscoveryScope' description: Gets discovery scope for which error is encountered. readOnly: true DependencyMapDiscovery: type: object description: Contains data related dependency map discovery scope. properties: discoveryScopeStatus: $ref: '#/definitions/DependencyMapDiscoveryScopeStatus' description: Gets discovery scope status. readOnly: true errors: type: array description: Gets errors for discovery scope. items: $ref: '#/definitions/HealthErrorDetails' readOnly: true hydratedRunAsAccountId: type: string description: "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials." readOnly: true SharePointServer: type: object description: SharePointServer in the guest virtual machine. properties: productName: type: string description: Gets or sets ProductName of the SharePointServer. readOnly: true isEnterprise: type: boolean description: Gets or sets a value indicating whether the SharePointServer is Enterprise. readOnly: true status: type: string description: Gets or sets Status of the SharePointServer. readOnly: true version: type: string description: Gets or sets Version of the SharePointServer. readOnly: true Machine: description: Machine REST resource. type: object properties: id: description: Gets or sets the relative URL to get to this REST resource. type: string name: description: Gets or sets the name of this REST resource. type: string type: description: Gets the type of this REST resource. type: string readOnly: true properties: $ref: '#/definitions/MachineProperties' description: Gets or sets the properties of the machine. WebApplicationAppsAndRolesModel: type: object description: WebApplication in the guest virtual machine. properties: name: type: string description: Gets or sets Name of the WebApplication. readOnly: true status: type: string description: Gets or sets Status of the WebApplication. readOnly: true platform: type: string description: Gets or sets Platform of the WebApplication. readOnly: true groupName: type: string description: Gets or sets GroupName of the WebApplication. readOnly: true webServer: type: string description: Gets or sets WebServer of the WebApplication. readOnly: true applicationPool: type: string description: Gets or sets ApplicationPool of the WebApplication. readOnly: true SpringBootDiscovery: type: object description: Data related to a machine's spring boot discovery. properties: totalInstanceCount: type: integer format: int64 description: Gets or sets number of successfully discovered instances. totalApplicationCount: type: integer format: int64 description: Gets or sets number of successfully discovered applications. shallowDiscoveryStatus: $ref: '#/definitions/ShallowDiscoveryStatus' description: Gets or sets status of partner shallow discovery. discoveryScopeStatus: $ref: '#/definitions/DiscoveryScopeStatus' description: Gets or sets status of partner discovery. ApplicationDiscovery: type: object description: Contains data related application and roles discovery scope. properties: discoveryScopeStatus: $ref: '#/definitions/ApplicationDiscoveryScopeStatus' description: Gets discovery scope status. readOnly: true errors: type: array description: Gets errors for discovery scope. items: $ref: '#/definitions/HealthErrorDetails' readOnly: true hydratedRunAsAccountId: type: string description: "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials." readOnly: true VmwareNetworkAdapter: type: object description: Second level object represented in responses as part of Machine REST resource. properties: label: type: string description: Label of the NIC. readOnly: true adapterType: type: string description: Gets or sets the adapter type. readOnly: true nicId: type: string description: Gets or sets the NIC Id. macAddress: type: string description: Gets or sets Mac address of the NIC. ipAddressList: type: array description: Gets IP addresses for the machine. items: type: string readOnly: true networkName: type: string description: Gets or sets Network Name. ipAddressType: type: string description: Gets or sets Type of the IP address. esuStatus: type: string description: esu Status enum: - Unknown - Active - InActive x-ms-enum: name: esuStatus modelAsString: true values: - name: Unknown value: Unknown description: Unknown value. - name: Active value: Active description: Active value. - name: InActive value: InActive description: InActive value. Feature: type: object description: Feature in the guest virtual machine. properties: name: type: string description: Gets or sets Name of the Feature. readOnly: true featureType: type: string description: Gets or sets FeatureType of the Feature. readOnly: true parent: type: string description: Gets or sets Parent of the Feature. readOnly: true status: type: string description: Gets or sets Status of the Feature. readOnly: true AppsAndRoles: type: object description: AppsAndRoles in the guest virtual machine. properties: applications: type: array description: Gets or sets Applications of the AppsAndRoles. items: $ref: '#/definitions/Application' readOnly: true x-ms-identifiers: [] webApplications: type: array description: Gets or sets WebApplications of the AppsAndRoles. items: $ref: '#/definitions/WebApplicationAppsAndRolesModel' readOnly: true x-ms-identifiers: [] features: type: array description: Gets or sets Features of the AppsAndRoles. items: $ref: '#/definitions/Feature' readOnly: true x-ms-identifiers: [] sqlServers: type: array description: Gets or sets SQLServers of the AppsAndRoles. items: $ref: '#/definitions/SqlServerApplication' readOnly: true x-ms-identifiers: [] sharePointServers: type: array description: Gets or sets SharePointServers of the AppsAndRoles. items: $ref: '#/definitions/SharePointServer' readOnly: true x-ms-identifiers: [] systemCenters: type: array description: Gets or sets SystemCenters of the AppsAndRoles. items: $ref: '#/definitions/SystemCenter' readOnly: true x-ms-identifiers: [] bizTalkServers: type: array description: Gets or sets BizTalkServers of the AppsAndRoles. items: $ref: '#/definitions/BizTalkServer' readOnly: true x-ms-identifiers: [] exchangeServers: type: array description: Gets or sets ExchangeServers of the AppsAndRoles. items: $ref: '#/definitions/ExchangeServer' readOnly: true x-ms-identifiers: [] otherDatabases: type: array description: Gets or sets OtherDatabaseServers of the AppsAndRoles. items: $ref: '#/definitions/OtherDatabase' readOnly: true x-ms-identifiers: [] HealthErrorDetailsSource: type: string description: HealthError Details Source enum: - RefreshFabricLayout - RefreshFabricLayoutGuest - RefreshFabricLayoutDependencyMap x-ms-enum: name: HealthErrorDetailsSource modelAsString: true values: - name: RefreshFabricLayout value: RefreshFabricLayout description: RefreshFabricLayout value. - name: RefreshFabricLayoutGuest value: RefreshFabricLayoutGuest description: RefreshFabricLayoutGuest value. - name: RefreshFabricLayoutDependencyMap value: RefreshFabricLayoutDependencyMap description: RefreshFabricLayoutDependencyMap value. DiscoveryDetails: description: Discovery properties that can be published by various ISVs. type: object properties: id: description: Gets the relative URL to get to this DiscoveryDetails resource. type: string osType: description: Gets or sets the OS type. type: string osName: description: Gets or sets the OS name. type: string osVersion: description: Gets or sets the OS version. type: string enqueueTime: description: Gets or sets the time the message was enqueued. type: string solutionName: description: Gets or sets the name of the solution that sent the data. type: string machineId: description: Gets or sets the unique identifier of the machine. type: string machineManagerId: description: Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM). type: string fabricType: description: Gets or sets the fabric type. type: string lastUpdatedTime: format: date-time description: Gets or sets the time of the last modification of the machine details. type: string machineName: description: Gets or sets the name of the machine. type: string ipAddresses: description: Gets or sets the list of IP addresses of the machine. IP addresses could be IP V4 or IP V6. type: array items: type: string fqdn: description: Gets or sets the FQDN of the machine. type: string biosId: description: Gets or sets the BIOS ID of the machine. type: string macAddresses: description: Gets or sets the list of MAC addresses of the machine. type: array items: type: string extendedInfo: description: Gets or sets the ISV specific extended information. type: object additionalProperties: type: string OperatingSystem: type: object description: Second level object returned as part of Machine REST resource. properties: osType: type: string description: Gets or sets the type of the operating system. osName: type: string description: Gets or sets the Name of the operating system. osVersion: type: string description: Gets or sets the Version of the operating system. osArchitecture: type: string description: Gets or sets the Architecture of the operating system. ExchangeServer: type: object description: ExchangeServer in the guest virtual machine. properties: productName: type: string description: Gets or sets ProductName of the ExchangeServer. readOnly: true edition: type: string description: Gets or sets Edition of the ExchangeServer. readOnly: true roles: type: string description: Gets or sets Roles of the ExchangeServer. readOnly: true servicePack: type: string description: Gets or sets ServicePack of the ExchangeServer. readOnly: true version: type: string description: Gets or sets Version of the ExchangeServer. readOnly: true ProductSupportStatus: type: object description: product support status. properties: currentVersion: type: string description: current version. esuStatus: $ref: '#/definitions/esuStatus' description: esu status. supportStatus: $ref: '#/definitions/supportStatus' description: support status. supportEndDate: type: string format: date-time description: support end date. esuYear: $ref: '#/definitions/esuYear' description: esu year. DiscoveryScopeStatus: type: string description: Discovery Scope. enum: - DiscoverySucceededAtleastOnce - DiscoveryFailed - RunAsAccountNotAssociated - DiscoveryNotStarted - DiscoveryInProgress - Disabled - DiscoveryPartiallySucceded - DiscoverySucceeded x-ms-enum: name: DiscoveryScopeStatus modelAsString: true values: - name: DiscoverySucceededAtleastOnce value: DiscoverySucceededAtleastOnce description: DiscoverySucceededAtleastOnce value. - name: DiscoveryFailed value: DiscoveryFailed description: DiscoveryFailed value. - name: RunAsAccountNotAssociated value: RunAsAccountNotAssociated description: RunAsAccountNotAssociated value. - name: DiscoveryNotStarted value: DiscoveryNotStarted description: DiscoveryNotStarted value. - name: DiscoveryInProgress value: DiscoveryInProgress description: DiscoveryInProgress value. - name: Disabled value: Disabled description: Disabled value. - name: DiscoveryPartiallySucceded value: DiscoveryPartiallySucceded description: DiscoveryPartiallySucceded value. - name: DiscoverySucceeded value: DiscoverySucceeded description: DiscoverySucceeded value. WebAppDiscovery: type: object description: Data related to a machine's WebApps discovery. properties: totalWebServerCount: type: integer format: int64 description: Gets or sets number of successfully discovered web servers.. totalWebApplicationCount: type: integer format: int64 description: Gets or sets number of successfully discovered web applications. discoveryScopeStatus: $ref: '#/definitions/DiscoveryScopeStatus' description: Gets or sets status of partner discovery. AssessmentDetails: description: Assessment properties that can be shared by various publishers. type: object properties: id: description: Gets the relative URL to get to this AssessmentDetails resource. type: string assessmentId: description: Gets or sets the id of the assessment done on the machine. type: string targetVMSize: description: Gets or sets the target VM size. type: string targetVMLocation: description: Gets or sets the target VM location. type: string targetStorageType: description: Gets or sets the target storage type. type: object additionalProperties: type: string enqueueTime: description: Gets or sets the time the message was enqueued. type: string solutionName: description: Gets or sets the name of the solution that sent the data. type: string machineId: description: Gets or sets the unique identifier of the machine. type: string machineManagerId: description: Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM). type: string fabricType: description: Gets or sets the fabric type. type: string lastUpdatedTime: format: date-time description: Gets or sets the time of the last modification of the machine details. type: string machineName: description: Gets or sets the name of the machine. type: string ipAddresses: description: Gets or sets the list of IP addresses of the machine. IP addresses could be IP V4 or IP V6. type: array items: type: string fqdn: description: Gets or sets the FQDN of the machine. type: string biosId: description: Gets or sets the BIOS ID of the machine. type: string macAddresses: description: Gets or sets the list of MAC addresses of the machine. type: array items: type: string extendedInfo: description: Gets or sets the ISV specific extended information. type: object additionalProperties: type: string Application: type: object description: Application in the guest virtual machine. properties: name: type: string description: Gets or sets Name of the Application. readOnly: true version: type: string description: Gets or sets Version of the Application. readOnly: true provider: type: string description: Gets or sets Provider of the Application. readOnly: true MigrationDetails: description: Migration properties that can be shared by various publishers. type: object properties: id: description: Gets the relative URL to get to this MigrationDetails resource. type: string migrationPhase: description: Gets or sets the phase of migration of the machine. type: string migrationTested: description: Gets or sets a value indicating whether migration was tested on the machine. type: boolean replicationProgressPercentage: format: int32 description: Gets or sets the progress percentage of migration on the machine. type: integer targetVMArmId: description: Gets or sets the ARM id the migrated VM. type: string enqueueTime: description: Gets or sets the time the message was enqueued. type: string solutionName: description: Gets or sets the name of the solution that sent the data. type: string machineId: description: Gets or sets the unique identifier of the machine. type: string machineManagerId: description: Gets or sets the unique identifier of the virtual machine manager(vCenter/VMM). type: string fabricType: description: Gets or sets the fabric type. type: string lastUpdatedTime: format: date-time description: Gets or sets the time of the last modification of the machine details. type: string machineName: description: Gets or sets the name of the machine. type: string ipAddresses: description: Gets or sets the list of IP addresses of the machine. IP addresses could be IP V4 or IP V6. type: array items: type: string fqdn: description: Gets or sets the FQDN of the machine. type: string biosId: description: Gets or sets the BIOS ID of the machine. type: string macAddresses: description: Gets or sets the list of MAC addresses of the machine. type: array items: type: string extendedInfo: description: Gets or sets the ISV specific extended information. type: object additionalProperties: type: string MachineProperties: description: Properties of the machine resource. type: object properties: discoveryData: description: Gets or sets the discovery details of the machine published by various sources. type: array items: $ref: '#/definitions/DiscoveryDetails' x-ms-identifiers: - machineId assessmentData: description: Gets or sets the assessment details of the machine published by various sources. type: array items: $ref: '#/definitions/AssessmentDetails' x-ms-identifiers: - assessmentId migrationData: description: Gets or sets the migration details of the machine published by various sources. type: array items: $ref: '#/definitions/MigrationDetails' x-ms-identifiers: [] lastUpdatedTime: format: date-time description: Gets or sets the time of the last modification of the machine. type: string VmwareDisk: type: object description: Second level object returned as part of Machine REST resource. properties: uuid: type: string description: Disk UUID. readOnly: true label: type: string description: Label of the disk. readOnly: true diskProvisioningPolicy: type: string description: "The provisioning policy of the disk.\n It is Thin or Thick or\nUnknown for the VMWare VMDK." readOnly: true diskScrubbingPolicy: type: string description: "The scrubbing policy of disks which can be\n eagerly zeroed or\nlazily zeroed." readOnly: true diskMode: type: string description: Disk mode property used for identifying independent disks. readOnly: true controllerType: type: string description: Gets or sets a value indicating the type of the disk controller type. readOnly: true maxSizeInBytes: type: integer format: int64 description: Gets or sets Bytes allocated for the disk. name: type: string description: Gets or sets Name of the disk. diskType: type: string description: Gets or sets Type of the disk. lun: type: integer format: int32 description: Gets or sets LUN of the disk. path: type: string description: Gets or sets Path of the disk. MachineResource: type: object description: An machine resource belonging to a site resource. properties: properties: $ref: '#/definitions/VmwareMachineProperties' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource ShallowDiscoveryStatus: type: string description: Shallow Discovery Status. enum: - DiscoverySucceededAtleastOnce - DiscoveryFailed - RunAsAccountNotAssociated - DiscoveryNotStarted - DiscoveryInProgress - Disabled - DiscoveryPartiallySucceded - DiscoverySucceeded x-ms-enum: name: ShallowDiscoveryStatus modelAsString: true values: - name: DiscoverySucceededAtleastOnce value: DiscoverySucceededAtleastOnce description: DiscoverySucceededAtleastOnce value. - name: DiscoveryFailed value: DiscoveryFailed description: DiscoveryFailed value. - name: RunAsAccountNotAssociated value: RunAsAccountNotAssociated description: RunAsAccountNotAssociated value. - name: DiscoveryNotStarted value: DiscoveryNotStarted description: DiscoveryNotStarted value. - name: DiscoveryInProgress value: DiscoveryInProgress description: DiscoveryInProgress value. - name: Disabled value: Disabled description: Disabled value. - name: DiscoveryPartiallySucceded value: DiscoveryPartiallySucceded description: DiscoveryPartiallySucceded value. - name: DiscoverySucceeded value: DiscoverySucceeded description: DiscoverySucceeded value. OtherDatabase: type: object description: OtherDatabase in the guest virtual machine. properties: databaseType: type: string description: Gets or sets DatabaseType of the OtherDatabase. readOnly: true instance: type: string description: Gets or sets Instance of the OtherDatabase. readOnly: true version: type: string description: Gets or sets Version of the OtherDatabase. readOnly: true esuYear: type: string description: esu year enum: - Unknown - FirstYear - SecondYear - ThirdYear - UpgradeYear x-ms-enum: name: esuYear modelAsString: true values: - name: Unknown value: Unknown description: Unknown value. - name: FirstYear value: FirstYear description: FirstYear value. - name: SecondYear value: SecondYear description: SecondYear value. - name: ThirdYear value: ThirdYear description: ThirdYear value. - name: UpgradeYear value: UpgradeYear description: UpgradeYear value. SqlDiscovery: type: object description: Contains data related SQL discovery. properties: successfullyDiscoveredServerCount: type: integer format: int32 description: ' successfully Discovered ServerCount' totalServerCount: type: integer format: int32 description: total Server Count sqlMetadataHydratedRunAsAccountId: type: string description: sql Metadata Hydrated RunAsAccountId sqlMetadataDiscoveryPipe: $ref: '#/definitions/SqlMetadataDiscoveryPipe' description: sql Metadata DiscoveryPipe discoveryScopeStatus: $ref: '#/definitions/SQLDiscoveryScopeStatus' description: discovery Scope Status OracleDiscovery: type: object description: Data related to a machine's Oracle discovery. properties: totalInstanceCount: type: integer format: int64 description: Gets or sets number of successfully discovered instances. totalDatabaseCount: type: integer format: int64 description: Gets or sets number of successfully discovered databases. shallowDiscoveryStatus: $ref: '#/definitions/ShallowDiscoveryStatus' description: Gets or sets status of partner shallow discovery. discoveryScopeStatus: $ref: '#/definitions/DiscoveryScopeStatus' description: Gets or sets status of partner discovery. SqlServerApplication: type: object description: SQLServer in the guest virtual machine. properties: name: type: string description: Gets or sets Name of the SQLServer. readOnly: true edition: type: string description: Gets or sets Edition of the SQLServer. readOnly: true servicePack: type: string description: Gets or sets ServicePack of the SQLServer. readOnly: true version: type: string description: Gets or sets Version of the SQLServer. readOnly: true clustered: type: string description: Gets or sets Clustered of the SQLServer. readOnly: true clusterName: type: string description: Gets or sets ClusterName of the SQLServer. readOnly: true dnsHostName: type: string description: Gets or sets the DNS host name of SQLServer. readOnly: true port: type: string description: Gets or sets the port of the SQLServer. readOnly: true commaSeparatedIps: type: string description: Gets or sets the comma separated IPs of the SQLServer. readOnly: true status: type: string description: Gets the status. readOnly: true isNamedPipeEnabled: type: boolean description: Gets or sets the value which reflects if Named Pipe is enabled or not. readOnly: true isTcpIpEnabled: type: boolean description: Gets or sets the value which reflects if Named Pipe is enabled or not. readOnly: true namedPipeName: type: string description: Gets the status. readOnly: true StaticDiscoveryScopeStatus: type: string description: Static DiscoveryScopeStatus enum: - DiscoverySucceededAtleastOnce - DiscoveryFailed - RunAsAccountNotAssociated - DiscoveryNotStarted - DiscoveryInProgress - Disabled - DiscoveryPartiallySucceded - DiscoverySucceeded x-ms-enum: name: StaticDiscoveryScopeStatus modelAsString: true values: - name: DiscoverySucceededAtleastOnce value: DiscoverySucceededAtleastOnce description: DiscoverySucceededAtleastOnce value. - name: DiscoveryFailed value: DiscoveryFailed description: DiscoveryFailed value. - name: RunAsAccountNotAssociated value: RunAsAccountNotAssociated description: RunAsAccountNotAssociated value. - name: DiscoveryNotStarted value: DiscoveryNotStarted description: DiscoveryNotStarted value. - name: DiscoveryInProgress value: DiscoveryInProgress description: DiscoveryInProgress value. - name: Disabled value: Disabled description: Disabled value. - name: DiscoveryPartiallySucceded value: DiscoveryPartiallySucceded description: DiscoveryPartiallySucceded value. - name: DiscoverySucceeded value: DiscoverySucceeded description: DiscoverySucceeded value. MachineResourceUpdateProperties: type: object description: The updatable properties of the MachineResource. properties: firmware: type: string description: Gets or sets the firmware. runAsAccountId: type: string description: Gets or sets the run as account ID of the machine. productSupportStatus: $ref: '#/definitions/ProductSupportStatus' description: product support status. numberOfProcessorCore: type: integer format: int32 description: "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." allocatedMemoryInMb: type: number format: double description: Gets or sets the allocated Memory in MB. operatingSystemDetails: $ref: '#/definitions/OperatingSystem' description: Gets or sets the Operating System Details installed on the machine. biosSerialNumber: type: string description: Gets or sets the Machine BIOS serial number. biosGuid: type: string description: Gets or sets the BIOS GUID. tags: type: object description: Gets or sets tags on the VMware machine. additionalProperties: type: string MachineResourceListResult: type: object description: The response of a MachineResource list operation. properties: value: type: array description: The MachineResource items on this page items: $ref: '#/definitions/MachineResource' nextLink: type: string format: uri description: The link to the next page of items required: - value SystemCenter: type: object description: SystemCenter in the guest virtual machine. properties: productName: type: string description: Gets or sets ProductName of the SystemCenter. readOnly: true status: type: string description: Gets or sets Status of the SystemCenter. readOnly: true version: type: string description: Gets or sets Version of the SystemCenter. readOnly: true MachineCollection: description: Collection of machines. type: object properties: value: description: Gets or sets the machines. type: array items: $ref: '#/definitions/Machine' nextLink: description: Gets or sets the value of nextLink. type: string BizTalkServer: type: object description: BizTalkServer in the guest virtual machine. properties: productName: type: string description: Gets or sets ProductName of the BizTalkServer. readOnly: true status: type: string description: Gets or sets Status of the BizTalkServer. readOnly: true HealthErrorDetailsDiscoveryScope: type: string description: Gets discovery scope for which error is encountered. enum: - AppsAndRoles - DependencyMap - StaticData - SQLServerConnectionInfo - DiscoveryTargets x-ms-enum: name: HealthErrorDetailsDiscoveryScope modelAsString: true values: - name: AppsAndRoles value: AppsAndRoles description: AppsAndRoles value. - name: DependencyMap value: DependencyMap description: DependencyMap value. - name: StaticData value: StaticData description: StaticData value. - name: SQLServerConnectionInfo value: SQLServerConnectionInfo description: SQLServerConnectionInfo value. - name: DiscoveryTargets value: DiscoveryTargets description: DiscoveryTargets value. StaticDiscovery: type: object description: Contains data related static data discovery scope. properties: discoveryScopeStatus: $ref: '#/definitions/StaticDiscoveryScopeStatus' description: Gets discovery scope status. readOnly: true errors: type: array description: Gets errors for discovery scope. items: $ref: '#/definitions/HealthErrorDetails' readOnly: true hydratedRunAsAccountId: type: string description: "Gets the run as account ID with which feature worked successfully.\n \nIt is discovered by the agent from the list of credentials." readOnly: true ProvisioningState: type: string description: The status of the current operation. enum: - Created - Updated - Running - Completed - Failed - Succeeded - Canceled x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Created value: Created description: Created value. - name: Updated value: Updated description: Updated value. - name: Running value: Running description: Running value. - name: Completed value: Completed description: Completed value. - name: Failed value: Failed description: Failed value. - name: Succeeded value: Succeeded description: Succeeded value. - name: Canceled value: Canceled description: Canceled value. GuestOsDetails: type: object description: 'Second level object. Data related to a machine''s operating system. Serialized and stored as part of Machine Rest object. ' properties: osType: type: string description: Gets or sets the type of the operating system. osName: type: string description: Gets or sets the Name of the operating system. osVersion: type: string description: Gets or sets the Version of the operating system. osArchitecture: type: string description: Gets or sets the Architecture of the operating system. SqlMetadataDiscoveryPipe: type: string description: SQL metadata discovery pipe enum: - Unknown - VMware - PowerShell - SSH - CIM - Other x-ms-enum: name: SqlMetadataDiscoveryPipe modelAsString: true values: - name: Unknown value: Unknown description: Unknown value. - name: VMware value: VMware description: VMware value. - name: PowerShell value: PowerShell description: PowerShell value. - name: SSH value: SSH description: SSH value. - name: CIM value: CIM description: CIM value. - name: Other value: Other description: Other value. VmwareMachineProperties: type: object description: Class for machine properties. properties: vCenterFqdn: type: string description: VCenter FQDN/IPAddress. readOnly: true vCenterId: type: string description: VCenter ARM ID. readOnly: true instanceUuid: type: string description: On-premise Instance UUID of the machine. readOnly: true dataCenterScope: type: string description: Scope of the data center. readOnly: true description: type: string description: User description of the machine. readOnly: true disks: type: array description: Disks attached to the machine. items: $ref: '#/definitions/VmwareDisk' readOnly: true x-ms-identifiers: [] hostInMaintenanceMode: type: boolean description: Indicates whether the host is in maintenance mode. readOnly: true hostName: type: string description: The host name. readOnly: true hostPowerState: type: string description: The host power state. readOnly: true hostVersion: type: string description: The host version. readOnly: true networkAdapters: type: array description: Network adapters attached to the machine. items: $ref: '#/definitions/VmwareNetworkAdapter' readOnly: true x-ms-identifiers: [] vMwareToolsStatus: type: string description: VMware tools status. readOnly: true vMwareToolsVersion: type: string description: VMware tools version. readOnly: true changeTrackingSupported: type: boolean description: Value indicating whether change tracking is supported. readOnly: true changeTrackingEnabled: type: boolean description: Value indicating whether change tracking is enabled. readOnly: true maxSnapshots: type: integer format: int32 description: Maximum number of snapshots for the VM. Default value is -1. readOnly: true diskEnabledUuid: type: string description: Gets or sets whether Disk Enabled UUID is set or not. readOnly: true numberOfSnapshots: type: integer format: int32 description: Number of snapshots for the VM. Default value is -1. readOnly: true altGuestName: type: string description: Gets or sets the machine alt guest name. readOnly: true powerStatus: type: string description: Gets the Machine power status. readOnly: true vmFqdn: type: string description: Gets the VM FQDN. readOnly: true vmConfigurationFileLocation: type: string description: Gets the Root location of the VM configuration file. readOnly: true firmware: type: string description: Gets or sets the firmware. guestOsDetails: $ref: '#/definitions/GuestOsDetails' description: "Operating System Details extracted from the guest\n bu executing\nscript inside the guest VM." readOnly: true numberOfApplications: type: integer format: int32 description: Number of applications installed in the guest VM. readOnly: true guestDetailsDiscoveryTimestamp: type: string format: date-time description: "The last time at which the Guest Details was discovered\n or the\nerror while discovering guest details based discovery\n of the\nmachine." readOnly: true isGuestDetailsDiscoveryInProgress: type: boolean description: "Whether Refresh Fabric Layout Guest Details has been completed once.\n \n Portal will show discovery in progress, if this value is true." readOnly: true dependencyMapping: type: string description: "Gets or sets if dependency mapping feature is enabled or not\n for\nthe VM." readOnly: true dependencyMappingStartTime: type: string format: date-time description: Gets or sets when dependency mapping collection is last started. readOnly: true dependencyMappingEndTime: type: string description: Gets or sets when dependency mapping collection was last disabled. readOnly: true runAsAccountId: type: string description: Gets or sets the run as account ID of the machine. applianceNames: type: array description: Gets the appliance names. items: type: string readOnly: true errors: type: array description: Errors for machine. items: $ref: '#/definitions/HealthErrorDetails' readOnly: true applicationDiscovery: $ref: '#/definitions/ApplicationDiscovery' description: Gets the data related to application discovery. readOnly: true dependencyMapDiscovery: $ref: '#/definitions/DependencyMapDiscovery' description: Gets the data related to dependency map discovery. readOnly: true staticDiscovery: $ref: '#/definitions/StaticDiscovery' description: Gets the data related to static discovery. readOnly: true sqlDiscovery: $ref: '#/definitions/SqlDiscovery' description: Gets the data related to SQL discovery. readOnly: true webAppDiscovery: $ref: '#/definitions/WebAppDiscovery' description: Gets the data related to Web application discovery. readOnly: true oracleDiscovery: $ref: '#/definitions/OracleDiscovery' description: Gets the data related to Oracle discovery. readOnly: true springBootDiscovery: $ref: '#/definitions/SpringBootDiscovery' description: Gets the data related to SpringBoot discovery. readOnly: true iisDiscovery: $ref: '#/definitions/WebAppDiscovery' description: Gets the data related to iis discovery. readOnly: true tomcatDiscovery: $ref: '#/definitions/WebAppDiscovery' description: Gets the data related to tomcat discovery. readOnly: true appsAndRoles: $ref: '#/definitions/AppsAndRoles' description: Apps And Roles of the Server. readOnly: true productSupportStatus: $ref: '#/definitions/ProductSupportStatus' description: product support status. numberOfProcessorCore: type: integer format: int32 description: "Gets or sets the Number of Processor Cores \n allocated for the\nmachine." allocatedMemoryInMb: type: number format: double description: Gets or sets the allocated Memory in MB. operatingSystemDetails: $ref: '#/definitions/OperatingSystem' description: Gets or sets the Operating System Details installed on the machine. biosSerialNumber: type: string description: Gets or sets the Machine BIOS serial number. biosGuid: type: string description: Gets or sets the BIOS GUID. displayName: type: string description: Gets the Display name of the machine. readOnly: true isDeleted: type: boolean description: Value indicating whether VM is deleted. readOnly: true createdTimestamp: type: string description: Gets the marking machine creation. readOnly: true tags: type: object description: Gets or sets tags on the VMware machine. additionalProperties: type: string updatedTimestamp: type: string description: Gets the timestamp marking last updated on the machine. readOnly: true provisioningState: $ref: '#/definitions/ProvisioningState' description: The status of the last operation. readOnly: true ApplicationDiscoveryScopeStatus: type: string description: Application Discovery Scope Status enum: - DiscoverySucceededAtleastOnce - DiscoveryFailed - RunAsAccountNotAssociated - DiscoveryNotStarted - DiscoveryInProgress - Disabled - DiscoveryPartiallySucceded - DiscoverySucceeded x-ms-enum: name: ApplicationDiscoveryScopeStatus modelAsString: true values: - name: DiscoverySucceededAtleastOnce value: DiscoverySucceededAtleastOnce description: DiscoverySucceededAtleastOnce value. - name: DiscoveryFailed value: DiscoveryFailed description: DiscoveryFailed value. - name: RunAsAccountNotAssociated value: RunAsAccountNotAssociated description: RunAsAccountNotAssociated value. - name: DiscoveryNotStarted value: DiscoveryNotStarted description: DiscoveryNotStarted value. - name: DiscoveryInProgress value: DiscoveryInProgress description: DiscoveryInProgress value. - name: Disabled value: Disabled description: Disabled value. - name: DiscoveryPartiallySucceded value: DiscoveryPartiallySucceded description: DiscoveryPartiallySucceded value. - name: DiscoverySucceeded value: DiscoverySucceeded description: DiscoverySucceeded value. DependencyMapDiscoveryScopeStatus: type: string description: DependencyMap DiscoveryScope Status enum: - DiscoverySucceededAtleastOnce - DiscoveryFailed - RunAsAccountNotAssociated - DiscoveryNotStarted - DiscoveryInProgress - Disabled - DiscoveryPartiallySucceded - DiscoverySucceeded x-ms-enum: name: DependencyMapDiscoveryScopeStatus modelAsString: true values: - name: DiscoverySucceededAtleastOnce value: DiscoverySucceededAtleastOnce description: DiscoverySucceededAtleastOnce value. - name: DiscoveryFailed value: DiscoveryFailed description: DiscoveryFailed value. - name: RunAsAccountNotAssociated value: RunAsAccountNotAssociated description: RunAsAccountNotAssociated value. - name: DiscoveryNotStarted value: DiscoveryNotStarted description: DiscoveryNotStarted value. - name: DiscoveryInProgress value: DiscoveryInProgress description: DiscoveryInProgress value. - name: Disabled value: Disabled description: Disabled value. - name: DiscoveryPartiallySucceded value: DiscoveryPartiallySucceded description: DiscoveryPartiallySucceded value. - name: DiscoverySucceeded value: DiscoverySucceeded description: DiscoverySucceeded value. MachineResourceUpdate: type: object description: The type used for update operations of the MachineResource. properties: properties: $ref: '#/definitions/MachineResourceUpdateProperties' x-ms-client-flatten: true supportStatus: type: string description: support status enum: - Unknown - Mainstream - Extended x-ms-enum: name: supportStatus modelAsString: true values: - name: Unknown value: Unknown description: Unknown value. - name: Mainstream value: Mainstream description: Mainstream value. - name: Extended value: Extended description: Extended value. SQLDiscoveryScopeStatus: type: string description: SQLDiscoveryScope Status enum: - DiscoverySucceededAtleastOnce - DiscoveryFailed - RunAsAccountNotAssociated - DiscoveryNotStarted - DiscoveryInProgress - Disabled - DiscoveryPartiallySucceded - DiscoverySucceeded x-ms-enum: name: SQLDiscoveryScopeStatus modelAsString: true values: - name: DiscoverySucceededAtleastOnce value: DiscoverySucceededAtleastOnce description: DiscoverySucceededAtleastOnce value. - name: DiscoveryFailed value: DiscoveryFailed description: DiscoveryFailed value. - name: RunAsAccountNotAssociated value: RunAsAccountNotAssociated description: RunAsAccountNotAssociated value. - name: DiscoveryNotStarted value: DiscoveryNotStarted description: DiscoveryNotStarted value. - name: DiscoveryInProgress value: DiscoveryInProgress description: DiscoveryInProgress value. - name: Disabled value: Disabled description: Disabled value. - name: DiscoveryPartiallySucceded value: DiscoveryPartiallySucceded description: DiscoveryPartiallySucceded value. - name: DiscoverySucceeded value: DiscoverySucceeded description: DiscoverySucceeded value. parameters: migrateProjectName: name: migrateProjectName description: Name of the Azure Migrate project. type: string in: path x-ms-parameter-location: method required: true pattern: ^[a-zA-Z0-9-]{3,24}$ continuationToken: name: continuationToken description: The continuation token. type: string in: query required: false x-ms-parameter-location: method machineName: name: machineName description: Unique name of a machine in Azure migration hub. type: string in: path x-ms-parameter-location: method required: true pattern: ^[a-zA-Z0-9-]{3,24}$ pageSize: name: pageSize description: The number of items to be returned in a single page. This value is honored only if it is less than the 100. type: integer format: int32 in: query required: false x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'