swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector GuestConfigurationHCRPAssignments API
schemes:
- https
tags:
- name: GuestConfigurationHCRPAssignments
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}
  : put:
      tags:
      - GuestConfigurationHCRPAssignments
      operationId: microsoftAzureGuestconfigurationhcrpassignmentsCreateorupdate
      description: Creates an association between a ARC machine and guest configuration
      x-ms-examples:
        Create or update guest configuration assignment:
          $ref: ./examples/createOrUpdateGuestConfigurationHCRPAssignment.json
      parameters:
      - name: guestConfigurationAssignmentName
        in: path
        required: true
        type: string
        description: Name of the guest configuration assignment.
      - name: parameters
        in: body
        required: true
        schema:
          $ref: '#/definitions/GuestConfigurationAssignment'
        description: Parameters supplied to the create or update guest configuration assignment.
      - $ref: ../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/v1/definitions.json#/parameters/MachineNameParameter
      - $ref: ../../common/v1/definitions.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The guest configuration assignment for the ARC machine was updated successfully.
          schema:
            $ref: '#/definitions/GuestConfigurationAssignment'
        '201':
          description: Created. The guest configuration assignment for the ARC machine was created successfully.
          schema:
            $ref: '#/definitions/GuestConfigurationAssignment'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../common/v1/definitions.json#/definitions/ErrorResponse
      produces:
      - application/json
      consumes:
      - application/json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Machines Machinename Providers Microsoft Guestconfiguration Guestconfigurationassignments Guestconfigurationassignmentname
    get:
      tags:
      - GuestConfigurationHCRPAssignments
      operationId: microsoftAzureGuestconfigurationhcrpassignmentsGet
      description: Get information about a guest configuration assignment
      x-ms-examples:
        Get a guest configuration assignment:
          $ref: ./examples/getGuestConfigurationHCRPAssignment.json
      parameters:
      - $ref: ../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - name: guestConfigurationAssignmentName
        in: path
        required: true
        type: string
        description: The guest configuration assignment name.
      - $ref: ../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ../../common/v1/definitions.json#/parameters/MachineNameParameter
      - $ref: ../../common/v1/definitions.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The guest configuration assignment was returned successfully.
          schema:
            $ref: '#/definitions/GuestConfigurationAssignment'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../common/v1/definitions.json#/definitions/ErrorResponse
      produces:
      - application/json
      consumes:
      - application/json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Machines Machinename Providers Microsoft Guestconfiguration Guestconfigurationassignments Guestconfigurationassignmentname
    delete:
      tags:
      - GuestConfigurationHCRPAssignments
      operationId: microsoftAzureGuestconfigurationhcrpassignmentsDelete
      description: Delete a guest configuration assignment
      x-ms-examples:
        Delete an guest configuration assignment:
          $ref: ./examples/deleteGuestConfigurationHCRPAssignment.json
      parameters:
      - $ref: ../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - name: guestConfigurationAssignmentName
        in: path
        required: true
        type: string
        description: Name of the guest configuration assignment
      - $ref: ../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ../../common/v1/definitions.json#/parameters/MachineNameParameter
      - $ref: ../../common/v1/definitions.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../common/v1/definitions.json#/definitions/ErrorResponse
      produces:
      - application/json
      consumes:
      - application/json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Machines Machinename Providers Microsoft Guestconfiguration Guestconfigurationassignments Guestconfigurationassignmentname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments
  : get:
      tags:
      - GuestConfigurationHCRPAssignments
      operationId: microsoftAzureGuestconfigurationhcrpassignmentsList
      description: List all guest configuration assignments for an ARC machine.
      x-ms-examples:
        List all guest configuration assignments for a virtual machine:
          $ref: ./examples/listGuestConfigurationHCRPAssignments.json
      parameters:
      - $ref: ../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../common/v1/definitions.json#/parameters/SubscriptionIdParameter
      - $ref: ../../common/v1/definitions.json#/parameters/MachineNameParameter
      - $ref: ../../common/v1/definitions.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/GuestConfigurationAssignmentList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../common/v1/definitions.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: null
      produces:
      - application/json
      consumes:
      - application/json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Hybridcompute Machines Machinename Providers Microsoft Guestconfiguration Guestconfigurationassignments
definitions:
  GuestConfigurationAssignmentProperties:
    properties:
      targetResourceId:
        type: string
        readOnly: true
        description: VM resource Id.
        x-nullable: true
      guestConfiguration:
        $ref: '#/definitions/GuestConfigurationNavigation'
        description: The guest configuration to assign.
      complianceStatus:
        type: string
        readOnly: true
        description: A value indicating compliance status of the machine for the assigned guest configuration.
        x-ms-enum:
          name: complianceStatus
          modelAsString: true
        enum:
        - Compliant
        - NonCompliant
        - Pending
      lastComplianceStatusChecked:
        type: string
        format: date-time
        readOnly: true
        description: Date and time when last compliance status was checked.
        x-nullable: true
      latestReportId:
        type: string
        readOnly: true
        description: 'Id of the latest report for the guest configuration assignment. '
        x-nullable: true
      parameterHash:
        type: string
        readOnly: true
        description: 'parameter hash for the guest configuration assignment. '
        x-nullable: true
      latestAssignmentReport:
        $ref: '#/definitions/AssignmentReport'
        description: Last reported guest configuration assignment report.
      context:
        type: string
        description: 'The source which initiated the guest configuration assignment. Ex: Azure Policy'
      assignmentHash:
        type: string
        readOnly: true
        description: Combined hash of the configuration package and parameters.
        x-nullable: true
      provisioningState:
        readOnly: true
        type: string
        description: The provisioning state, which only appears in the response.
        x-nullable: true
        x-ms-enum:
          name: provisioningState
          modelAsString: true
        enum:
        - Succeeded
        - Failed
        - Canceled
        - Created
      resourceType:
        type: string
        readOnly: true
        description: Type of the resource - VMSS / VM
        x-nullable: true
      vmssVMList:
        type: array
        items:
          $ref: '#/definitions/VMSSVMInfo'
        x-ms-identifiers:
        - vmId
        description: The list of VM Compliance data for VMSS
    description: Guest configuration assignment properties.
  GuestConfigurationNavigation:
    description: Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules.
    properties:
      kind:
        type: string
        description: Kind of the guest configuration. For example:DSC
        x-ms-enum:
          name: kind
          modelAsString: true
        enum:
        - DSC
      name:
        type: string
        description: Name of the guest configuration.
      version:
        type: string
        description: Version of the guest configuration.
      contentUri:
        type: string
        description: Uri of the storage where guest configuration package is uploaded.
      contentHash:
        type: string
        description: Combined hash of the guest configuration package and configuration parameters.
      assignmentType:
        type: string
        description: Specifies the assignment type and execution of the configuration. Possible values are Audit, DeployAndAutoCorrect, ApplyAndAutoCorrect and ApplyAndMonitor.
        x-ms-enum:
          name: assignmentType
          modelAsString: true
        enum:
        - Audit
        - DeployAndAutoCorrect
        - ApplyAndAutoCorrect
        - ApplyAndMonitor
      assignmentSource:
        type: string
        readOnly: true
        description: Specifies the origin of the configuration.
        x-nullable: true
      contentType:
        type: string
        readOnly: true
        description: Specifies the content type of the configuration. Possible values could be Builtin or Custom.
        x-nullable: true
      configurationParameter:
        type: array
        items:
          $ref: '#/definitions/ConfigurationParameter'
        x-ms-identifiers:
        - name
        description: The configuration parameters for the guest configuration.
      configurationProtectedParameter:
        type: array
        items:
          $ref: '#/definitions/ConfigurationParameter'
        x-ms-identifiers:
        - name
        description: The protected configuration parameters for the guest configuration.
      configurationSetting:
        $ref: '#/definitions/ConfigurationSetting'
        readOnly: true
        description: The configuration setting for the guest configuration.
  ConfigurationSetting:
    properties:
      configurationMode:
        type: string
        readOnly: true
        description: Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.
        x-ms-enum:
          name: configurationMode
          modelAsString: true
        enum:
        - ApplyOnly
        - ApplyAndMonitor
        - ApplyAndAutoCorrect
      allowModuleOverwrite:
        type: boolean
        readOnly: true
        description: If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false
      actionAfterReboot:
        type: string
        readOnly: true
        description: Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration
        x-ms-enum:
          name: actionAfterReboot
          modelAsString: true
        enum:
        - ContinueConfiguration
        - StopConfiguration
      refreshFrequencyMins:
        type: number
        readOnly: true
        default: 30
        description: The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30.
      rebootIfNeeded:
        type: boolean
        readOnly: true
        description: Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module.
      configurationModeFrequencyMins:
        type: number
        readOnly: true
        default: 15
        description: How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15.
    description: Configuration setting of LCM (Local Configuration Manager).
  AssignmentReportResourceComplianceReason:
    properties:
      phrase:
        type: string
        readOnly: true
        description: Reason for the compliance of the guest configuration assignment resource.
      code:
        type: string
        readOnly: true
        description: Code for the compliance of the guest configuration assignment resource.
    description: Reason and code for the compliance of the guest configuration assignment resource.
  ConfigurationInfo:
    properties:
      name:
        type: string
        readOnly: true
        description: Name of the configuration.
      version:
        type: string
        readOnly: true
        description: Version of the configuration.
    description: Information about the configuration.
  ConfigurationParameter:
    properties:
      name:
        type: string
        readOnly: false
        description: Name of the configuration parameter.
      value:
        type: string
        readOnly: false
        description: Value of the configuration parameter.
    description: Represents a configuration parameter.
  GuestConfigurationAssignment:
    properties:
      properties:
        x-ms-client-flatten: false
        $ref: '#/definitions/GuestConfigurationAssignmentProperties'
        description: Properties of the Guest configuration assignment.
      systemData:
        readOnly: true
        type: object
        description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
    allOf:
    - $ref: ../../common/v1/definitions.json#/definitions/ProxyResource
    description: Guest configuration assignment is an association between a machine and guest configuration.
  GuestConfigurationAssignmentList:
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/GuestConfigurationAssignment'
        description: Result of the list guest configuration assignment operation.
    description: The response of the list guest configuration assignment operation.
  VMSSVMInfo:
    properties:
      vmId:
        type: string
        readOnly: true
        description: UUID of the VM.
      vmResourceId:
        type: string
        readOnly: true
        description: Azure resource Id of the VM.
      complianceStatus:
        type: string
        readOnly: true
        description: A value indicating compliance status of the machine for the assigned guest configuration.
        x-ms-enum:
          name: complianceStatus
          modelAsString: true
        enum:
        - Compliant
        - NonCompliant
        - Pending
      latestReportId:
        type: string
        readOnly: true
        description: 'Id of the latest report for the guest configuration assignment. '
        x-nullable: true
      lastComplianceChecked:
        type: string
        format: date-time
        readOnly: true
        description: Date and time when last compliance status was checked.
        x-nullable: true
    description: Information about VMSS VM
  AssignmentInfo:
    properties:
      name:
        type: string
        readOnly: true
        description: Name of the guest configuration assignment.
      configuration:
        $ref: '#/definitions/ConfigurationInfo'
        description: Information about the configuration.
    description: Information about the guest configuration assignment.
  AssignmentReportResource:
    properties:
      complianceStatus:
        type: string
        readOnly: true
        description: A value indicating compliance status of the machine for the assigned guest configuration.
        x-ms-enum:
          name: complianceStatus
          modelAsString: true
        enum:
        - Compliant
        - NonCompliant
        - Pending
      resourceId:
        type: string
        readOnly: true
        description: Name of the guest configuration assignment resource setting.
      reasons:
        type: array
        items:
          $ref: '#/definitions/AssignmentReportResourceComplianceReason'
        x-ms-identifiers:
        - phrase
        - code
        description: Compliance reason and reason code for a resource.
      properties:
        type: object
        readOnly: true
        description: Properties of a guest configuration assignment resource.
    description: The guest configuration assignment resource.
  AssignmentReport:
    properties:
      id:
        type: string
        readOnly: true
        description: ARM resource id of the report for the guest configuration assignment.
      reportId:
        type: string
        readOnly: true
        description: GUID that identifies the guest configuration assignment report under a subscription, resource group.
      assignment:
        $ref: '#/definitions/AssignmentInfo'
        description: Configuration details of the guest configuration assignment.
      vm:
        $ref: '#/definitions/VMInfo'
        description: Information about the VM.
      startTime:
        type: string
        format: date-time
        readOnly: true
        description: Start date and time of the guest configuration assignment compliance status check.
      endTime:
        type: string
        format: date-time
        readOnly: true
        description: End date and time of the guest configuration assignment compliance status check.
      complianceStatus:
        type: string
        readOnly: true
        description: A value indicating compliance status of the machine for the assigned guest configuration.
        x-ms-enum:
          name: complianceStatus
          modelAsString: true
        enum:
        - Compliant
        - NonCompliant
        - Pending
      operationType:
        type: string
        readOnly: true
        description: Type of report, Consistency or Initial
        x-ms-enum:
          name: type
          modelAsString: true
        enum:
        - Consistency
        - Initial
      resources:
        type: array
        items:
          $ref: '#/definitions/AssignmentReportResource'
        x-ms-identifiers: []
        description: The list of resources for which guest configuration assignment compliance is checked.
  VMInfo:
    properties:
      id:
        type: string
        readOnly: true
        description: Azure resource Id of the VM.
      uuid:
        type: string
        readOnly: true
        description: UUID(Universally Unique Identifier) of the VM.
    description: Information about the VM.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'