swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ApplyUpdates API
schemes:
- https
tags:
- name: ApplyUpdates
paths:
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}
  : get:
      tags:
      - ApplyUpdates
      summary: Microsoft Azure Track Updates To Resource With Parent
      description: Track maintenance updates to resource with parent
      operationId: microsoftAzureApplyupdatesGetparent
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Resource group name
        required: true
        type: string
      - name: providerName
        in: path
        description: Resource provider name
        required: true
        type: string
      - name: resourceParentType
        in: path
        description: Resource parent type
        required: true
        type: string
      - name: resourceParentName
        in: path
        description: Resource parent identifier
        required: true
        type: string
      - name: resourceType
        in: path
        description: Resource type
        required: true
        type: string
      - name: resourceName
        in: path
        description: Resource identifier
        required: true
        type: string
      - name: applyUpdateName
        in: path
        description: applyUpdate Id
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ApplyUpdate'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/MaintenanceError'
      x-ms-examples:
        ApplyUpdates_GetParent:
          $ref: ./examples/ApplyUpdates_GetParent.json
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}
  : get:
      tags:
      - ApplyUpdates
      summary: Microsoft Azure Track Updates To Resource
      description: Track maintenance updates to resource
      operationId: microsoftAzureApplyupdatesGet
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Resource group name
        required: true
        type: string
      - name: providerName
        in: path
        description: Resource provider name
        required: true
        type: string
      - name: resourceType
        in: path
        description: Resource type
        required: true
        type: string
      - name: resourceName
        in: path
        description: Resource identifier
        required: true
        type: string
      - name: applyUpdateName
        in: path
        description: applyUpdate Id
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/ApplyUpdate'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/MaintenanceError'
      x-ms-examples:
        ApplyUpdates_Get:
          $ref: ./examples/ApplyUpdates_Get.json
    put:
      tags:
      - ApplyUpdates
      summary: Microsoft Azure Apply Updates To Resource
      description: Apply maintenance updates to resource
      operationId: microsoftAzureApplyupdatesCreateorupdateorcancel
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Resource group name
        required: true
        type: string
      - name: providerName
        in: path
        description: Resource provider name
        required: true
        type: string
      - name: resourceType
        in: path
        description: Resource type
        required: true
        type: string
      - name: resourceName
        in: path
        description: Resource identifier
        required: true
        type: string
      - name: applyUpdateName
        in: path
        description: ApplyUpdate name
        required: true
        type: string
      - name: applyUpdate
        in: body
        description: The ApplyUpdate
        required: true
        schema:
          $ref: '#/definitions/ApplyUpdate'
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: ApplyUpdate update request accepted
          schema:
            $ref: '#/definitions/ApplyUpdate'
        '201':
          description: ApplyUpdate create request accepted
          schema:
            $ref: '#/definitions/ApplyUpdate'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/MaintenanceError'
      x-ms-examples:
        ApplyUpdates_CreateOrUpdateOrCancel:
          $ref: ./examples/ApplyUpdates_CreateOrUpdate_CancelMaintenance.json
        ApplyUpdates_CreateOrUpdateOnly_NoCancellation:
          $ref: ./examples/ApplyUpdates_CreateOrUpdateOnly_NoCancellation.json
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default
  : put:
      tags:
      - ApplyUpdates
      summary: Microsoft Azure Apply Updates To Resource With Parent
      description: Apply maintenance updates to resource with parent
      operationId: microsoftAzureApplyupdatesCreateorupdateparent
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Resource group name
        required: true
        type: string
      - name: providerName
        in: path
        description: Resource provider name
        required: true
        type: string
      - name: resourceParentType
        in: path
        description: Resource parent type
        required: true
        type: string
      - name: resourceParentName
        in: path
        description: Resource parent identifier
        required: true
        type: string
      - name: resourceType
        in: path
        description: Resource type
        required: true
        type: string
      - name: resourceName
        in: path
        description: Resource identifier
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Apply-update update request accepted
          schema:
            $ref: '#/definitions/ApplyUpdate'
        '201':
          description: Apply-update create request accepted
          schema:
            $ref: '#/definitions/ApplyUpdate'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/MaintenanceError'
      x-ms-examples:
        ApplyUpdates_CreateOrUpdateParent:
          $ref: ./examples/ApplyUpdates_CreateOrUpdateParent.json
  ? /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default
  : put:
      tags:
      - ApplyUpdates
      summary: Microsoft Azure Apply Updates To Resource
      description: Apply maintenance updates to resource
      operationId: microsoftAzureApplyupdatesCreateorupdate
      consumes: []
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/SubscriptionIdParameter'
      - name: resourceGroupName
        in: path
        description: Resource group name
        required: true
        type: string
      - name: providerName
        in: path
        description: Resource provider name
        required: true
        type: string
      - name: resourceType
        in: path
        description: Resource type
        required: true
        type: string
      - name: resourceName
        in: path
        description: Resource identifier
        required: true
        type: string
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: ApplyUpdate update request accepted
          schema:
            $ref: '#/definitions/ApplyUpdate'
        '201':
          description: ApplyUpdate create request accepted
          schema:
            $ref: '#/definitions/ApplyUpdate'
        default:
          description: BadRequest
          schema:
            $ref: '#/definitions/MaintenanceError'
      x-ms-examples:
        ApplyUpdates_CreateOrUpdate:
          $ref: ./examples/ApplyUpdates_CreateOrUpdate.json
definitions:
  Resource:
    description: Definition of a Resource
    type: object
    properties:
      id:
        description: Fully qualified identifier of the resource
        type: string
        readOnly: true
      name:
        description: Name of the resource
        type: string
        readOnly: true
      type:
        description: Type of the resource
        type: string
        readOnly: true
      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
    x-ms-azure-resource: true
  ErrorDetails:
    description: An error response details received from the Azure Maintenance service.
    type: object
    properties:
      code:
        description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
        type: string
      message:
        description: Human-readable representation of the error.
        type: string
  ApplyUpdate:
    description: Apply Update request
    type: object
    allOf:
    - $ref: '#/definitions/Resource'
    properties:
      properties:
        $ref: '#/definitions/ApplyUpdateProperties'
        description: Properties of the apply update
        x-ms-client-flatten: true
  MaintenanceError:
    description: An error response received from the Azure Maintenance service.
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorDetails'
        description: Details of the error
  ApplyUpdateProperties:
    description: Properties for apply update
    type: object
    properties:
      status:
        description: The status
        enum:
        - Pending
        - InProgress
        - Completed
        - RetryNow
        - RetryLater
        - NoUpdatesPending
        - Cancel
        - Cancelled
        type: string
        x-ms-enum:
          name: UpdateStatus
          modelAsString: true
          values:
          - value: Pending
            description: There are pending updates to be installed.
          - value: InProgress
            description: Updates installation are in progress.
          - value: Completed
            description: All updates are successfully applied.
          - value: RetryNow
            description: Updates installation failed but are ready to retry again.
          - value: RetryLater
            description: Updates installation failed and should be retried later.
          - value: NoUpdatesPending
            description: No updates are pending.
          - value: Cancel
            description: Cancel the schedule and stop creating PMR for resources part of it. Applicable to Maintenance Configuration resource type only.
          - value: Cancelled
            description: Send the Cancelled response to the user if request came to cancel the schedule. Applicable to Maintenance Configuration resource type only.
      resourceId:
        description: The resourceId
        type: string
      lastUpdateTime:
        format: date-time
        description: Last Update time
        type: string
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    description: Version of the API to be used with the client request.
    required: true
    type: string
    x-ms-parameter-location: client
  SubscriptionIdParameter:
    name: subscriptionId
    in: path
    description: Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
    required: true
    type: string
    x-ms-parameter-location: client
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'