Microsoft Azure VM_Host API

openapi: 3.2.0
info:
  title: Microsoft Azure Microsoft.Logz VM Host API
  version: 2020-10-01-preview
servers:
- url: https://management.azure.com
tags:
- name: VM_Host
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/vmHostPayload
  : post:
      tags:
      - VM_Host
      summary: Microsoft Azure Returns The Payload That Needs To Be Passed As A Request For…
      operationId: microsoftAzureSubaccountVmhostpayload
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: '#/components/parameters/SubAccountNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMExtensionPayload'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        SubAccount_VMHosts_Payload:
          $ref: ./examples/SubAccount_VMHosts_Payload.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/vmHostUpdate
  : post:
      tags:
      - VM_Host
      summary: Microsoft Azure Sending Request To Update The Collection When Logz Io Agent Has…
      operationId: microsoftAzureSubaccountListvmhostupdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: '#/components/parameters/SubAccountNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMResourcesListResponse'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SubAccount_VMHosts_Update:
          $ref: ./examples/SubAccount_VMHosts_Update.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VMHostUpdateRequest'
        description: Request body to update the collection for agent installed in the given monitor.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/accounts/{subAccountName}/listVMHosts
  : post:
      tags:
      - VM_Host
      summary: Microsoft Azure List The Compute Resources Currently Being Monitored By The…
      operationId: microsoftAzureSubaccountListvmhosts
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: '#/components/parameters/SubAccountNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMResourcesListResponse'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        SubAccount_VMHosts_List:
          $ref: ./examples/SubAccount_VMHosts_List.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/vmHostPayload
  : post:
      tags:
      - VM_Host
      summary: Microsoft Azure Returns The Payload That Needs To Be Passed In The Request Body…
      operationId: microsoftAzureMonitorVmhostpayload
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMExtensionPayload'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        MainAccount_VMHosts_Payload:
          $ref: ./examples/MainAccount_VMHosts_Payload.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/vmHostUpdate
  : post:
      tags:
      - VM_Host
      summary: Microsoft Azure Sending Request To Update The Collection When Logz Io Agent Has…
      operationId: microsoftAzureMonitorListvmhostupdate
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMResourcesListResponse'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        MainAccount_VMHosts_Update:
          $ref: ./examples/MainAccount_VMHosts_Update.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VMHostUpdateRequest'
        description: Request body to update the collection for agent installed in the given monitor.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logz/monitors/{monitorName}/listVMHosts
  : post:
      tags:
      - VM_Host
      summary: Microsoft Azure List The Compute Resources Currently Being Monitored By The…
      operationId: microsoftAzureMonitorListvmhosts
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VMResourcesListResponse'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        MainAccount_VMHosts_List:
          $ref: ./examples/MainAccount_VMHosts_List.json
      description: Needs a more full description created.
components:
  schemas:
    VMHostUpdateRequest:
      description: Request of a list VM Host Update Operation.
      type: object
      properties:
        vmResourceIds:
          description: Request of a list vm host update operation.
          type: array
          items:
            $ref: '#/components/schemas/VMResources'
        state:
          description: Specifies the state of the operation - install/ delete.
          $ref: '#/components/schemas/VMHostUpdateState'
    VMHostUpdateState:
      description: Various states of the updating vm extension on resource
      enum:
      - Install
      - Delete
      type: string
      x-ms-enum:
        modelAsString: true
        name: VMHostUpdateStates
    VMResources:
      description: VM Resource Ids
      type: object
      properties:
        id:
          description: Request of a list vm host update operation.
          type: string
        agentVersion:
          description: Version of the Logz agent installed on the VM.
          type: string
    VMExtensionPayload:
      description: Response of payload to be passed while installing VM agent.
      type: object
      properties:
        apiKey:
          description: API Key corresponding to the resource.
          type: string
          x-ms-secret: true
        region:
          description: Logz.io region where the resource has been created.
          type: string
    VMResourcesListResponse:
      description: Response of a list VM Host Update Operation.
      type: object
      properties:
        value:
          description: Response of a list vm host update operation.
          type: array
          items:
            $ref: '#/components/schemas/VMResources'
        nextLink:
          description: Link to the next set of results, if any.
          type: string
  parameters:
    MonitorNameParameter:
      in: path
      name: monitorName
      description: Monitor resource name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    SubAccountNameParameter:
      in: path
      name: subAccountName
      description: Sub Account resource name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Microsoft Entra ID OAuth2 Flow