Azure Automation Node Reports API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Node Reports API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged NodeReports across 2 of this provider''s published API definitions: microsoft-azure-automation-openapi.json, microsoft-azure-automation-management-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: NodeReports
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports
  : get:
      operationId: NodeReports_ListByNode
      tags:
      - NodeReports
      description: Retrieve the Dsc node report list by node id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodereportoperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: nodeId
        in: path
        description: The node id.
        required: true
        schema:
          type: string
      - name: $filter
        in: query
        description: The filter to apply on the operation.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscNodeReportListResult'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List DSC reports by node id.:
          $ref: ./examples/listDscNodeReportsByNode.json
        List Paged DSC reports by node id.:
          $ref: ./examples/listPagedDscNodeReportsByNode.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Node reports list by node
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}
  : get:
      operationId: NodeReports_Get
      tags:
      - NodeReports
      description: Retrieve the Dsc node report data by node id and report id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodereportoperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: nodeId
        in: path
        description: The node id.
        required: true
        schema:
          type: string
      - name: reportId
        in: path
        description: The report id.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscNodeReport'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        'Get Dsc node report data by node id and report id. ':
          $ref: ./examples/getDscNodeReport.json
      summary: Node reports get
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}/reports/{reportId}/content
  : get:
      operationId: NodeReports_GetContent
      tags:
      - NodeReports
      description: Retrieve the Dsc node reports by node id and report id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodereportoperations
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - name: automationAccountName
        in: path
        description: The name of the automation account.
        required: true
        schema:
          type: string
      - name: nodeId
        in: path
        description: The node id.
        required: true
        schema:
          type: string
      - name: reportId
        in: path
        description: The report id.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            text/plain:
              schema:
                type: string
            application/json:
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            text/plain:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get content of node:
          $ref: ./examples/getDscNodeReportContent.json
      summary: Node reports get content
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    DscReportResourceNavigation:
      type: object
      description: Navigation for DSC Report Resource.
      properties:
        resourceId:
          type: string
          description: Gets or sets the ID of the resource to navigate to.
    DscNodeReportListResult:
      type: object
      description: The response model for the list dsc nodes operation.
      properties:
        value:
          type: array
          description: The DscNodeReport items on this page
          items:
            $ref: '#/components/schemas/DscNodeReport'
        nextLink:
          type: string
          format: uri
          description: The link to the next page of items
      required:
      - value
    DscNodeReport:
      type: object
      description: Definition of the dsc node report type.
      properties:
        endTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the end time of the node report.
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets or sets the lastModifiedTime of the node report.
        startTime:
          type:
          - string
          - 'null'
          format: date-time
          description: Gets or sets the start time of the node report.
        type:
          type: string
          description: Gets or sets the type of the node report.
        reportId:
          type: string
          description: Gets or sets the id of the node report.
        status:
          type: string
          description: Gets or sets the status of the node report.
        refreshMode:
          type: string
          description: Gets or sets the refreshMode of the node report.
        rebootRequested:
          type: string
          description: Gets or sets the rebootRequested of the node report.
        reportFormatVersion:
          type: string
          description: Gets or sets the reportFormatVersion of the node report.
        configurationVersion:
          type: string
          description: Gets or sets the configurationVersion of the node report.
        id:
          type: string
          description: Gets or sets the id.
        errors:
          type: array
          description: Gets or sets the errors for the node report.
          items:
            $ref: '#/components/schemas/DscReportError'
          x-ms-identifiers:
          - errorMessage
          - resourceId
        resources:
          type: array
          description: Gets or sets the resource for the node report.
          items:
            $ref: '#/components/schemas/DscReportResource'
          x-ms-identifiers:
          - resourceId
        metaConfiguration:
          $ref: '#/components/schemas/DscMetaConfiguration'
          description: Gets or sets the metaConfiguration of the node at the time of the report.
        hostName:
          type: string
          description: Gets or sets the hostname of the node that sent the report.
        iPV4Addresses:
          type: array
          description: Gets or sets the IPv4 address of the node that sent the report.
          items:
            type: string
        iPV6Addresses:
          type: array
          description: Gets or sets the IPv6 address of the node that sent the report.
          items:
            type: string
        numberOfResources:
          type: integer
          format: int32
          description: Gets or sets the number of resource in the node report.
        rawErrors:
          type: string
          description: Gets or sets the unparsed errors for the node report.
    DscReportResource:
      type: object
      description: Definition of the DSC Report Resource.
      properties:
        resourceId:
          type: string
          description: Gets or sets the ID of the resource.
        sourceInfo:
          type: string
          description: Gets or sets the source info of the resource.
        dependsOn:
          type: array
          description: Gets or sets the Resource Navigation values for resources the resource depends on.
          items:
            $ref: '#/components/schemas/DscReportResourceNavigation'
          x-ms-identifiers:
          - resourceId
        moduleName:
          type: string
          description: Gets or sets the module name of the resource.
        moduleVersion:
          type: string
          description: Gets or sets the module version of the resource.
        resourceName:
          type: string
          description: Gets or sets the name of the resource.
        error:
          type: string
          description: Gets or sets the error of the resource.
        status:
          type: string
          description: Gets or sets the status of the resource.
        durationInSeconds:
          type: number
          format: double
          description: Gets or sets the duration in seconds for the resource.
        startDate:
          type: string
          format: date-time
          description: Gets or sets the start date of the resource.
    DscReportError:
      type: object
      description: Definition of the dsc node report error type.
      properties:
        errorSource:
          type: string
          description: Gets or sets the source of the error.
        resourceId:
          type: string
          description: Gets or sets the resource ID which generated the error.
        errorCode:
          type: string
          description: Gets or sets the error code.
        errorMessage:
          type: string
          description: Gets or sets the error message.
        locale:
          type: string
          description: Gets or sets the locale of the error.
        errorDetails:
          type: string
          description: Gets or sets the error details.
    DscMetaConfiguration:
      type: object
      description: Definition of the DSC Meta Configuration.
      properties:
        configurationModeFrequencyMins:
          type: integer
          format: int32
          description: Gets or sets the ConfigurationModeFrequencyMins value of the meta configuration.
        rebootNodeIfNeeded:
          type: boolean
          description: Gets or sets the RebootNodeIfNeeded value of the meta configuration.
        configurationMode:
          type: string
          description: Gets or sets the ConfigurationMode value of the meta configuration.
        actionAfterReboot:
          type: string
          description: Gets or sets the ActionAfterReboot value of the meta configuration.
        certificateId:
          type: string
          description: Gets or sets the CertificateId value of the meta configuration.
        refreshFrequencyMins:
          type: integer
          format: int32
          description: Gets or sets the RefreshFrequencyMins value of the meta configuration.
        allowModuleOverwrite:
          type: boolean
          description: Gets or sets the AllowModuleOverwrite value of the meta configuration.
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-automation-openapi.json
- microsoft-azure-automation-management-openapi.yml