swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector HypervClusterController API
schemes:
- https
tags:
- name: HypervClusterController
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters
  : get:
      operationId: microsoftAzureHypervclustercontrollerListbyhypervsite
      tags:
      - HypervClusterController
      description: List HypervCluster resources by HypervSite
      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: filter
        in: query
        description: filter query
        required: false
        type: string
      - 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/HypervClusterListResult'
        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:
        HypervClusterController_ListByHypervSite_MaximumSet_Gen:
          $ref: ./examples/HypervClusterController_ListByHypervSite_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Clusters
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OffAzure/hypervSites/{siteName}/clusters/{clusterName}
  : get:
      operationId: microsoftAzureHypervclustercontrollerGetcluster
      tags:
      - HypervClusterController
      description: Method to get a Hyper-V cluster.
      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: clusterName
        in: path
        description: ' Cluster ARM name'
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: ARM operation completed successfully.
          schema:
            $ref: '#/definitions/HypervCluster'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        HypervClusterController_GetCluster_MaximumSet_Gen:
          $ref: ./examples/HypervClusterController_GetCluster_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Clusters Clustername
    put:
      operationId: microsoftAzureHypervclustercontrollerCreatecluster
      tags:
      - HypervClusterController
      description: Method to create or update a Hyper-V cluster.
      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: clusterName
        in: path
        description: ' Cluster ARM name'
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: body
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/HypervCluster'
      responses:
        '200':
          description: ARM update operation completed successfully.
          schema:
            $ref: '#/definitions/HypervCluster'
        '201':
          description: ARM create operation completed successfully.
          schema:
            $ref: '#/definitions/HypervCluster'
          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.
        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:
        HypervClusterController_CreateCluster_MaximumSet_Gen:
          $ref: ./examples/HypervClusterController_CreateCluster_MaximumSet_Gen.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Clusters Clustername
    delete:
      operationId: microsoftAzureHypervclustercontrollerDelete
      tags:
      - HypervClusterController
      description: Delete a HypervCluster
      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: clusterName
        in: path
        description: ' Cluster ARM name'
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        HypervClusterController_Delete_MaximumSet_Gen:
          $ref: ./examples/HypervClusterController_Delete_MaximumSet_Gen.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Offazure Hypervsites Sitename Clusters Clustername
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
  HypervClusterProperties:
    type: object
    description: The properties of Hyperv Cluster
    properties:
      createdTimestamp:
        type: string
        description: Gets the timestamp marking Hyper-V cluster creation.
        readOnly: true
      updatedTimestamp:
        type: string
        description: Gets the timestamp marking last updated on the Hyper-V cluster.
        readOnly: true
      fqdn:
        type: string
        description: Gets or sets the FQDN/IPAddress of the Hyper-V cluster.
      functionalLevel:
        type: integer
        format: int32
        description: Gets the functional level of the Hyper-V cluster.
        readOnly: true
      status:
        type: string
        description: Gets the status of the Hyper-V cluster.
        readOnly: true
      runAsAccountId:
        type: string
        description: Gets or sets Run as account ID of the Hyper-V cluster.
      hostFqdnList:
        type: array
        description: Gets or sets list of hosts (FQDN) currently being tracked by the cluster.
        items:
          type: string
      errors:
        type: array
        description: Gets the errors.
        items:
          $ref: '#/definitions/HealthErrorDetails'
        readOnly: true
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
  HypervCluster:
    type: object
    description: A cluster resource belonging to a site resource.
    properties:
      properties:
        $ref: '#/definitions/HypervClusterProperties'
        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
  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.
  HypervClusterListResult:
    type: object
    description: The response of a HypervCluster list operation.
    properties:
      value:
        type: array
        description: The HypervCluster items on this page
        items:
          $ref: '#/definitions/HypervCluster'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  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.
  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.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'