Microsoft Azure VmwareHostController API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure Migrate Discovery Service Vmware Host…
  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: VmwareHostController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts
  : get:
      operationId: microsoftAzureVmwarehostcontrollerListbyvmwaresite
      tags:
      - VmwareHostController
      description: List VmwareHost resources by VmwareSite
      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}$
      responses:
        '200':
          description: ARM operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VmwareHostListResult'
        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:
        VmwareHostController_ListByVmwareSite_MaximumSet_Gen:
          $ref: ./examples/VmwareHostController_ListByVmwareSite_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/vmwareSites/{siteName}/hosts/{hostName}
  : get:
      operationId: microsoftAzureVmwarehostcontrollerGet
      tags:
      - VmwareHostController
      description: Get a VmwareHost
      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: hostName
        in: path
        description: ' Hosts 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/VmwareHost'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        VmwareHostController_Get_MaximumSet_Gen:
          $ref: ./examples/VmwareHostController_Get_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.
    VmwareHost:
      type: object
      description: A host resource belonging to a site resource.
      properties:
        properties:
          $ref: '#/components/schemas/VmwareHostProperties'
          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
    VmwareDatastore:
      type: object
      description: Second level object returned as part of VMware host REST resource.
      properties:
        uuid:
          type: string
          description: Data store UUID.
          readOnly: true
        capacityInGb:
          type: number
          format: float
          description: Capacity of the data store.
          readOnly: true
        freeSpaceInGb:
          type: number
          format: float
          description: Free space of the data store.
          readOnly: true
        type:
          $ref: '#/components/schemas/VMwareDatastoreType'
          description: Type of the data store.
          readOnly: true
        symbolicName:
          type: string
          description: Symbolic name of the data store.
          readOnly: true
    VMwareDatastoreType:
      type: string
      description: vmware datastore type
      enum:
      - Unknown
      - CIFS
      - NFS
      - NFS41
      - PMEM
      - VFFS
      - VMFS
      - VSAN
      - VVOL
      x-ms-enum:
        name: VMwareDatastoreType
        modelAsString: true
        values:
        - name: Unknown
          value: Unknown
          description: Unknown value.
        - name: Cifs
          value: CIFS
          description: CIFS value.
        - name: NFS
          value: NFS
          description: NFS value.
        - name: NFS41
          value: NFS41
          description: NFS41 value.
        - name: Pmem
          value: PMEM
          description: PMEM value.
        - name: Vffs
          value: VFFS
          description: VFFS value.
        - name: Vmfs
          value: VMFS
          description: VMFS value.
        - name: Vsan
          value: VSAN
          description: VSAN value.
        - name: Vvol
          value: VVOL
          description: VVOL value.
    VmwareHostListResult:
      type: object
      description: The response of a VmwareHost list operation.
      properties:
        value:
          type: array
          description: The VmwareHost items on this page
          items:
            $ref: '#/components/schemas/VmwareHost'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    VmwareHostProperties:
      type: object
      description: Class for host properties.
      properties:
        createdTimestamp:
          type: string
          description: Gets the timestamp marking VMware host creation.
          readOnly: true
        updatedTimestamp:
          type: string
          description: Gets the timestamp marking last updated on the VMware host.
          readOnly: true
        datastores:
          type: array
          description: Gets the data stores.
          items:
            $ref: '#/components/schemas/VmwareDatastore'
          readOnly: true
          x-ms-identifiers: []
        vcenterId:
          type: string
          description: Gets the V-center ID.
          readOnly: true
        uuid:
          type: string
          description: Gets the instance UUID of the vmware host.
          readOnly: true
        applianceNames:
          type: array
          description: Gets the appliance names.
          items:
            type: string
          readOnly: true
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          description: provisioning state enum
          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.