swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DedicatedCloudNodes API
  description: dedicated cloud nodes operations
schemes:
- https
tags:
- description: dedicated cloud nodes operations
  name: DedicatedCloudNodes
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes:
    get:
      description: Returns list of dedicate cloud nodes within subscription
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - DedicatedCloudNodes
      summary: Microsoft Azure Implements List Of Dedicated Cloud Nodes Within Subscription Method
      operationId: microsoftAzureDedicatedcloudnodesListbysubscription
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/api-version'
      - type: string
        description: The filter to apply on the list operation
        name: $filter
        in: query
      - type: integer
        format: int32
        description: The maximum number of record sets to return
        name: $top
        in: query
      - type: string
        description: to be used by nextLink implementation
        name: $skipToken
        in: query
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DedicatedCloudNodeListResponse'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        ListDedicatedCloudNodes:
          $ref: ./examples/ListDedicatedCloudNodes.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes
  : get:
      description: Returns list of dedicate cloud nodes within resource group
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - DedicatedCloudNodes
      summary: Microsoft Azure Implements List Of Dedicated Cloud Nodes Within Rg Method
      operationId: microsoftAzureDedicatedcloudnodesListbyresourcegroup
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/api-version'
      - type: string
        description: The filter to apply on the list operation
        name: $filter
        in: query
      - type: integer
        format: int32
        description: The maximum number of record sets to return
        name: $top
        in: query
      - type: string
        description: to be used by nextLink implementation
        name: $skipToken
        in: query
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DedicatedCloudNodeListResponse'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        ListRGDedicatedCloudNodes:
          $ref: ./examples/ListRGDedicatedCloudNodes.json
      x-ms-pageable:
        nextLinkName: nextLink
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes/{dedicatedCloudNodeName}
  : get:
      description: Returns dedicated cloud node
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - DedicatedCloudNodes
      summary: Microsoft Azure Implements Dedicated Cloud Node Get Method
      operationId: microsoftAzureDedicatedcloudnodesGet
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - pattern: ^[a-zA-Z0-9]([-_.a-zA-Z0-9]*[a-zA-Z0-9])?$
        type: string
        description: dedicated cloud node name
        name: dedicatedCloudNodeName
        in: path
        required: true
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/DedicatedCloudNode'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        GetDedicatedCloudNode:
          $ref: ./examples/GetDedicatedCloudNode.json
    put:
      description: Returns dedicated cloud node by its name
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - DedicatedCloudNodes
      summary: Microsoft Azure Implements Dedicated Cloud Node Put Method
      operationId: microsoftAzureDedicatedcloudnodesCreateorupdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - $ref: '#/parameters/referer'
      - pattern: ^[a-zA-Z0-9]([-_.a-zA-Z0-9]*[a-zA-Z0-9])?$
        type: string
        description: dedicated cloud node name
        name: dedicatedCloudNodeName
        in: path
        required: true
      - description: Create Dedicated Cloud Node request
        name: dedicatedCloudNodeRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/DedicatedCloudNode'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: If resource is created or updated successfully, 200 should be returned
          schema:
            $ref: '#/definitions/DedicatedCloudNode'
          headers:
            Azure-AsyncOperation:
              type: string
            Location:
              type: string
            Retry-After:
              type: integer
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        CreateDedicatedCloudNode:
          $ref: ./examples/CreateDedicatedCloudNode.json
      x-ms-long-running-operation: true
    delete:
      description: Delete dedicated cloud node
      consumes:
      - application/json
      tags:
      - DedicatedCloudNodes
      summary: Microsoft Azure Implements Dedicated Cloud Node Delete Method
      operationId: microsoftAzureDedicatedcloudnodesDelete
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - pattern: ^[a-zA-Z0-9]([-_.a-zA-Z0-9]*[a-zA-Z0-9])?$
        type: string
        description: dedicated cloud node name
        name: dedicatedCloudNodeName
        in: path
        required: true
      - $ref: '#/parameters/api-version'
      responses:
        '204':
          description: no content. resource does not exist and the request is well formed
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
          headers:
            Content-Type:
              type: string
              default: application/json
      x-ms-examples:
        DeleteDedicatedCloudNode:
          $ref: ./examples/DeleteDedicatedCloudNode.json
    patch:
      description: Patches dedicated node properties
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - DedicatedCloudNodes
      summary: Microsoft Azure Implements Dedicated Cloud Node Patch Method
      operationId: microsoftAzureDedicatedcloudnodesUpdate
      parameters:
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      - pattern: ^[a-zA-Z0-9]([-_.a-zA-Z0-9]*[a-zA-Z0-9])?$
        type: string
        description: dedicated cloud node name
        name: dedicatedCloudNodeName
        in: path
        required: true
      - description: Patch Dedicated Cloud Node request
        name: dedicatedCloudNodeRequest
        in: body
        required: true
        schema:
          $ref: '#/definitions/PatchPayload'
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: If resource is created or updated successfully, 200 should be returned
          schema:
            $ref: '#/definitions/DedicatedCloudNode'
        default:
          description: General Error
          schema:
            $ref: '#/definitions/CSRPError'
      x-ms-examples:
        PatchDedicatedCloudNode:
          $ref: ./examples/PatchDedicatedCloudNode.json
definitions:
  Tags:
    description: Tags model
    additionalProperties:
      type: string
  DedicatedCloudNodeProperties:
    description: Properties of dedicated cloud node
    required:
    - placementGroupId
    - availabilityZoneId
    - purchaseId
    - nodesCount
    properties:
      availabilityZoneId:
        description: Availability Zone id, e.g. "az1"
        type: string
      availabilityZoneName:
        description: Availability Zone name, e.g. "Availability Zone 1"
        type: string
        readOnly: true
      cloudRackName:
        description: VMWare Cloud Rack Name
        type: string
        readOnly: true
      created:
        description: date time the resource was created
        format: date-time
        readOnly: true
        type: string
      nodesCount:
        description: count of nodes to create
        type: integer
      placementGroupId:
        description: Placement Group id, e.g. "n1"
        type: string
      placementGroupName:
        description: Placement Name, e.g. "Placement Group 1"
        type: string
        readOnly: true
      privateCloudId:
        description: Private Cloud Id
        type: string
        readOnly: true
      privateCloudName:
        description: Resource Pool Name
        type: string
        readOnly: true
      provisioningState:
        description: The provisioning status of the resource
        type: string
        readOnly: true
      purchaseId:
        description: purchase id
        type: string
        format: uuid
      skuDescription:
        description: Dedicated Cloud Nodes SKU's description
        x-ms-client-flatten: true
        $ref: '#/definitions/SkuDescription'
      status:
        description: Node status, indicates is private cloud set up on this node or not
        type: string
        enum:
        - unused
        - used
        x-ms-enum:
          modelAsString: false
          name: NodeStatus
        readOnly: true
      vmwareClusterName:
        description: VMWare Cluster Name
        type: string
        readOnly: true
  DedicatedCloudNode:
    description: Dedicated cloud node model
    required:
    - location
    properties:
      id:
        description: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/dedicatedCloudNodes/{dedicatedCloudNodeName}
        type: string
        readOnly: true
      location:
        description: Azure region
        type: string
        x-ms-mutability:
        - read
        - create
      name:
        description: '{dedicatedCloudNodeName}'
        type: string
        pattern: ^[a-zA-Z0-9]([-_.a-zA-Z0-9]*[a-zA-Z0-9])?$
        readOnly: true
      properties:
        description: Dedicated Cloud Nodes properties
        x-ms-client-flatten: true
        $ref: '#/definitions/DedicatedCloudNodeProperties'
      sku:
        description: Dedicated Cloud Nodes SKU
        $ref: '#/definitions/Sku'
      tags:
        description: Dedicated Cloud Nodes tags
        $ref: '#/definitions/Tags'
      type:
        description: '{resourceProviderNamespace}/{resourceType}'
        type: string
        readOnly: true
    x-ms-azure-resource: true
  Sku:
    description: The purchase SKU for CloudSimple paid resources
    required:
    - name
    properties:
      capacity:
        description: The capacity of the SKU
        type: string
      description:
        description: 'dedicatedCloudNode example: 8 x Ten-Core Intel® Xeon® Processor E5-2640 v4 2.40GHz 25MB Cache (90W); 12 x 64GB PC4-19200 2400MHz DDR4 ECC Registered DIMM, ...'
        type: string
      family:
        description: If the service has different generations of hardware, for the same SKU, then that can be captured here
        type: string
      name:
        description: The name of the SKU for VMWare CloudSimple Node
        type: string
      tier:
        description: The tier of the SKU
        type: string
  CSRPError:
    description: General error model
    properties:
      error:
        description: Error's body
        $ref: '#/definitions/CSRPErrorBody'
  PatchPayload:
    description: General patch payload modal
    properties:
      tags:
        description: The tags key:value pairs
        $ref: '#/definitions/Tags'
  DedicatedCloudNodeListResponse:
    description: List of dedicated nodes response model
    properties:
      nextLink:
        description: Link for next list of DedicatedCloudNode
        type: string
      value:
        description: Results of the DedicatedCloudNode list
        type: array
        items:
          $ref: '#/definitions/DedicatedCloudNode'
  CSRPErrorBody:
    description: Error properties
    properties:
      code:
        description: Error's code
        type: string
        readOnly: true
      details:
        description: Error's details
        type: array
        items:
          $ref: '#/definitions/CSRPErrorBody'
        x-ms-identifiers: []
        readOnly: true
      message:
        description: Error's message
        type: string
        readOnly: true
      target:
        description: Error's target
        type: string
  SkuDescription:
    description: The purchase SKU for CloudSimple paid resources
    required:
    - name
    - id
    properties:
      id:
        description: SKU's id
        type: string
      name:
        description: SKU's name
        type: string
parameters:
  referer:
    type: string
    x-ms-parameter-location: method
    description: referer url
    name: Referer
    in: header
    required: true
  resourceGroupName:
    type: string
    x-ms-parameter-location: method
    description: The name of the resource group
    name: resourceGroupName
    in: path
    required: true
  subscriptionId:
    type: string
    description: The subscription ID.
    name: subscriptionId
    in: path
    required: true
  api-version:
    type: string
    description: Client API version.
    name: api-version
    in: query
    required: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'