Microsoft Azure VmwareSoftwareInventoriesController API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Migrate Discovery Service Vmware…
  version: 2023-10-01-preview
  description: Azure OffAzure Resource Provider management API.
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: VmwareSoftwareInventoriesController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareInventories/{default}
  : get:
      operationId: microsoftAzureVmwaresoftwareinventoriescontrollerGetmachinesoftwareinventory
      tags:
      - VmwareSoftwareInventoriesController
      description: Method to get a machines software inventory like applications and roles.
      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
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: machineName
        in: path
        description: Machine name
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: default
        in: path
        description: Default value.
        required: true
        x-ms-enum:
          name: Default
          modelAsString: true
          values:
          - name: default
            value: default
            description: default value.
        schema:
          type: string
          enum:
          - default
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VmwareMachineSoftwareInventory'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen:
          $ref: ./examples/VmwareSoftwareInventoriesController_GetMachineSoftwareInventory_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/machines/{machineName}/softwareinventories
  : get:
      operationId: microsoftAzureVmwaresoftwareinventoriescontrollerListbymachineresource
      tags:
      - VmwareSoftwareInventoriesController
      description: List VmwareMachineSoftwareInventory resources by 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
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: machineName
        in: path
        description: Machine name
        required: true
        schema:
          type: string
          pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VmwareMachineSoftwareInventoryListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen:
          $ref: ./examples/VmwareSoftwareInventoriesController_ListByMachineResource_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  schemas:
    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.
    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
    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
    VmwareMachineSoftwareInventory:
      type: object
      description: An software inventory resource belonging to a machine resource.
      properties:
        properties:
          $ref: '#/components/schemas/MachineSoftwareInventoryProperties'
          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
    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
    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
    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
    VmwareMachineSoftwareInventoryListResult:
      type: object
      description: The response of a VmwareMachineSoftwareInventory list operation.
      properties:
        value:
          type: array
          description: The VmwareMachineSoftwareInventory items on this page
          items:
            $ref: '#/components/schemas/VmwareMachineSoftwareInventory'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    MachineSoftwareInventoryProperties:
      type: object
      description: Class for machine software inventory properties.
      properties:
        appsAndRoles:
          $ref: '#/components/schemas/AppsAndRoles'
          description: Apps And Roles of the machine entity.
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: provisioning state enum
          readOnly: true
    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
    AppsAndRoles:
      type: object
      description: AppsAndRoles in the guest virtual machine.
      properties:
        applications:
          type: array
          description: Gets or sets Applications of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/Application'
          readOnly: true
          x-ms-identifiers: []
        webApplications:
          type: array
          description: Gets or sets WebApplications of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/WebApplicationAppsAndRolesModel'
          readOnly: true
          x-ms-identifiers: []
        features:
          type: array
          description: Gets or sets Features of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/Feature'
          readOnly: true
          x-ms-identifiers: []
        sqlServers:
          type: array
          description: Gets or sets SQLServers of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/SqlServerApplication'
          readOnly: true
          x-ms-identifiers: []
        sharePointServers:
          type: array
          description: Gets or sets SharePointServers of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/SharePointServer'
          readOnly: true
          x-ms-identifiers: []
        systemCenters:
          type: array
          description: Gets or sets SystemCenters of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/SystemCenter'
          readOnly: true
          x-ms-identifiers: []
        bizTalkServers:
          type: array
          description: Gets or sets BizTalkServers of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/BizTalkServer'
          readOnly: true
          x-ms-identifiers: []
        exchangeServers:
          type: array
          description: Gets or sets ExchangeServers of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/ExchangeServer'
          readOnly: true
          x-ms-identifiers: []
        otherDatabases:
          type: array
          description: Gets or sets OtherDatabaseServers of the AppsAndRoles.
          items:
            $ref: '#/components/schemas/OtherDatabase'
          readOnly: true
          x-ms-identifiers: []
    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
    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
    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
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.