swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector HcxEnterpriseSites API
schemes:
- https
tags:
- name: HcxEnterpriseSites
  description: ''
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites
  : get:
      operationId: microsoftAzureHcxenterprisesitesList
      x-ms-pageable:
        nextLinkName: nextLink
      tags:
      - HcxEnterpriseSites
      summary: Microsoft Azure List Hcx Enterprise Sites In A Private Cloud
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/privateCloudName'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/HcxEnterpriseSiteList'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        HcxEnterpriseSites_List:
          $ref: ./examples/HcxEnterpriseSites_List.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}
  : get:
      operationId: microsoftAzureHcxenterprisesitesGet
      tags:
      - HcxEnterpriseSites
      summary: Microsoft Azure Get An Hcx Enterprise Site By Name In A Private Cloud
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/privateCloudName'
      - $ref: '#/parameters/hcxEnterpriseSiteName'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/HcxEnterpriseSite'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        HcxEnterpriseSites_Get:
          $ref: ./examples/HcxEnterpriseSites_Get.json
      description: Needs a more full description created.
    put:
      operationId: microsoftAzureHcxenterprisesitesCreateorupdate
      tags:
      - HcxEnterpriseSites
      summary: Microsoft Azure Create Or Update An Hcx Enterprise Site In A Private Cloud
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - name: privateCloudName
        in: path
        required: true
        type: string
        description: The name of the private cloud.
      - $ref: '#/parameters/hcxEnterpriseSiteName'
      - name: hcxEnterpriseSite
        description: The HCX Enterprise Site
        in: body
        required: true
        schema:
          $ref: '#/definitions/HcxEnterpriseSite'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: successful update
          schema:
            $ref: '#/definitions/HcxEnterpriseSite'
        '201':
          description: successful create
          schema:
            $ref: '#/definitions/HcxEnterpriseSite'
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        HcxEnterpriseSites_CreateOrUpdate:
          $ref: ./examples/HcxEnterpriseSites_CreateOrUpdate.json
      description: Needs a more full description created.
    delete:
      operationId: microsoftAzureHcxenterprisesitesDelete
      tags:
      - HcxEnterpriseSites
      summary: Microsoft Azure Delete An Hcx Enterprise Site In A Private Cloud
      parameters:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/privateCloudName'
      - $ref: '#/parameters/hcxEnterpriseSiteName'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The delete has succeeded
        '204':
          description: No Content. No HCX Enterprise Site to delete
        default:
          description: Error response describing why the operation failed
          schema:
            $ref: '#/definitions/CloudError'
      x-ms-examples:
        HcxEnterpriseSites_Delete:
          $ref: ./examples/HcxEnterpriseSites_Delete.json
      description: Needs a more full description created.
definitions:
  Resource:
    description: The core properties of ARM resources
    properties:
      id:
        description: Resource ID.
        readOnly: true
        type: string
      name:
        description: Resource name.
        readOnly: true
        type: string
      type:
        description: Resource type.
        readOnly: true
        type: string
    x-ms-azure-resource: true
  CloudError:
    x-ms-external: true
    properties:
      error:
        description: An error returned by the API
        $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse
    description: API error response
  HcxEnterpriseSiteProperties:
    description: The properties of an HCX Enterprise Site
    properties:
      activationKey:
        description: The activation key
        type: string
        readOnly: true
      status:
        description: The status of the HCX Enterprise Site
        type: string
        readOnly: true
        enum:
        - Available
        - Consumed
        - Deactivated
        - Deleted
        x-ms-enum:
          name: HcxEnterpriseSiteStatus
          modelAsString: true
  HcxEnterpriseSite:
    description: An HCX Enterprise Site resource
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        description: The properties of an HCX Enterprise Site resource
        $ref: '#/definitions/HcxEnterpriseSiteProperties'
        x-ms-client-flatten: true
        readOnly: true
  HcxEnterpriseSiteList:
    description: A paged list of HCX Enterprise Sites
    properties:
      value:
        description: The items on a page
        type: array
        readOnly: true
        items:
          $ref: '#/definitions/HcxEnterpriseSite'
      nextLink:
        description: URL to get the next page if any
        type: string
        readOnly: true
parameters:
  hcxEnterpriseSiteName:
    name: hcxEnterpriseSiteName
    in: path
    required: true
    type: string
    description: Name of the HCX Enterprise Site in the private cloud
    x-ms-parameter-location: method
  privateCloudName:
    name: privateCloudName
    in: path
    required: true
    type: string
    description: Name of the private cloud
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'