swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector VmmServers API
schemes:
- https
tags:
- name: VmmServers
paths:
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers/{vmmServerName}:
    get:
      tags:
      - VmmServers
      operationId: microsoftAzureVmmserversGet
      summary: Microsoft Azure Gets A Vmmserver
      description: Implements VMMServer GET method.
      x-ms-examples:
        GetVMMServer:
          $ref: ./examples/GetVMMServer.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - in: path
        name: vmmServerName
        required: true
        type: string
        description: Name of the VMMServer.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Retrieves the VmmServers resource.
          schema:
            $ref: '#/definitions/VMMServer'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
    put:
      tags:
      - VmmServers
      operationId: microsoftAzureVmmserversCreateorupdate
      description: Onboards the SCVMM fabric as an Azure VmmServer resource.
      summary: Microsoft Azure Implements Vmmservers Put Method
      x-ms-examples:
        CreateVMMServer:
          $ref: ./examples/CreateVMMServer.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - in: path
        name: vmmServerName
        required: true
        type: string
        description: Name of the VMMServer.
      - $ref: '#/parameters/ApiVersionParameter'
      - name: body
        description: Request payload.
        in: body
        required: true
        schema:
          $ref: '#/definitions/VMMServer'
      responses:
        '200':
          description: Creates or Updates the VmmServers resource.
          schema:
            $ref: '#/definitions/VMMServer'
        '201':
          description: Creates or Updates the VmmServers resource.
          schema:
            $ref: '#/definitions/VMMServer'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
    delete:
      tags:
      - VmmServers
      operationId: microsoftAzureVmmserversDelete
      description: Deboards the SCVMM fabric from Azure.
      summary: Microsoft Azure Implements Vmmservers Delete Method
      x-ms-examples:
        DeleteVMMServer:
          $ref: ./examples/DeleteVMMServer.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - in: path
        name: vmmServerName
        required: true
        type: string
        description: Name of the VMMServer.
      - $ref: '#/parameters/ApiVersionParameter'
      - in: query
        name: force
        description: Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too.
        required: false
        type: boolean
      responses:
        '200':
          description: Deletes the VmmServers resource.
        '202':
          description: Accepted
        '204':
          description: No Content
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
    patch:
      tags:
      - VmmServers
      operationId: microsoftAzureVmmserversUpdate
      summary: Microsoft Azure Implements Vmmservers Patch Method
      description: Updates the VmmServers resource.
      x-ms-examples:
        UpdateVMMServer:
          $ref: ./examples/UpdateVMMServer.json
      parameters:
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      - $ref: '#/parameters/SubscriptionIdParameter'
      - in: path
        name: vmmServerName
        required: true
        type: string
        description: Name of the VMMServer.
      - name: body
        description: VmmServers patch payload.
        in: body
        required: true
        schema:
          $ref: '#/definitions/ResourcePatch'
      responses:
        '200':
          description: Successful.
          schema:
            $ref: '#/definitions/VMMServer'
        '201':
          description: Created
          schema:
            $ref: '#/definitions/VMMServer'
        '202':
          description: Accepted
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-long-running-operation: true
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/vmmServers:
    get:
      tags:
      - VmmServers
      operationId: microsoftAzureVmmserversListbyresourcegroup
      summary: Microsoft Azure Implements Get Vmmservers In A Resource Group
      description: List of VmmServers in a resource group.
      x-ms-examples:
        ListVmmServersByResourceGroup:
          $ref: ./examples/ListVMMServersByResourceGroup.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ResourceGroupNameParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Lists all VmmServers under the resource group.
          schema:
            $ref: '#/definitions/VMMServerListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
  /subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/vmmServers:
    get:
      tags:
      - VmmServers
      operationId: microsoftAzureVmmserversListbysubscription
      summary: Microsoft Azure Implements Get Vmmservers In A Subscription
      description: List of VmmServers in a subscription.
      x-ms-examples:
        ListVmmServersBySubscription:
          $ref: ./examples/ListVMMServersBySubscription.json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Lists all VmmServers under the subscription.
          schema:
            $ref: '#/definitions/VMMServerListResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
definitions:
  ErrorDefinition:
    description: Error definition.
    type: object
    properties:
      code:
        description: Service specific error code which serves as the substatus for the HTTP error code.
        type: string
        readOnly: true
      message:
        description: Description of the error.
        type: string
        readOnly: true
      details:
        description: Internal error details.
        type: array
        items:
          $ref: '#/definitions/ErrorDefinition'
        x-ms-identifiers: []
        readOnly: true
  ResourcePatch:
    type: object
    properties:
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags.
    description: Object containing tags updates for patch operations.
  VMMServer:
    type: object
    x-ms-azure-resource: true
    properties:
      properties:
        x-ms-client-flatten: true
        description: Resource properties.
        $ref: '#/definitions/VMMServerProperties'
      id:
        type: string
        readOnly: true
        description: Resource Id
      name:
        type: string
        readOnly: true
        description: Resource Name
      type:
        type: string
        readOnly: true
        description: Resource Type
      location:
        description: Gets or sets the location.
        type: string
        x-ms-mutability:
        - read
        - create
      tags:
        type: object
        additionalProperties:
          type: string
        description: Resource tags
      systemData:
        $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData
        description: The system data.
      extendedLocation:
        $ref: '#/definitions/ExtendedLocation'
        description: The extended location.
    required:
    - location
    - properties
    - extendedLocation
    description: The VmmServers resource definition.
  ErrorResponse:
    description: Error response.
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorDefinition'
        description: The error details.
  VMMServerProperties:
    description: Defines the resource properties.
    required:
    - fqdn
    type: object
    properties:
      credentials:
        type: object
        description: Credentials to connect to VMMServer.
        properties:
          username:
            type: string
            description: Username to use to connect to VMMServer.
          password:
            type: string
            description: Credentials to use to connect to VMMServer.
            x-ms-mutability:
            - create
            - update
            x-ms-secret: true
      fqdn:
        type: string
        description: Fqdn is the hostname/ip of the vmmServer.
        minLength: 1
      port:
        type: integer
        format: int32
        description: Port is the port on which the vmmServer is listening.
        maximum: 65535
        minimum: 1
      connectionStatus:
        type: string
        description: Gets or sets the connection status to the vmmServer.
        readOnly: true
      errorMessage:
        type: string
        description: Gets or sets any error message if connection to vmmServer is having any issue.
        readOnly: true
      uuid:
        type: string
        description: Unique ID of vmmServer.
        readOnly: true
      version:
        type: string
        description: Version is the version of the vmmSever.
        readOnly: true
      provisioningState:
        description: Gets or sets the provisioning state.
        type: string
        readOnly: true
  VMMServerListResult:
    type: object
    description: List of VmmServers.
    properties:
      value:
        type: array
        description: List of VmmServers.
        items:
          $ref: '#/definitions/VMMServer'
      nextLink:
        description: Url to follow for getting next page of resources.
        type: string
  ExtendedLocation:
    type: object
    description: The extended location.
    properties:
      type:
        type: string
        description: The extended location type.
      name:
        type: string
        description: The extended location name.
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request (e.g. YYYY-MM-DD).
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    required: true
    type: string
    description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
  ResourceGroupNameParameter:
    name: resourceGroupName
    in: path
    required: true
    type: string
    description: The name of the resource group.
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'