Azure Automation Dsc Node API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Dsc Node API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged DscNode 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: DscNode
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes
  : get:
      operationId: DscNode_ListByAutomationAccount
      tags:
      - DscNode
      description: Retrieve a list of dsc nodes.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodeoperations
      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: $filter
        in: query
        description: The filter to apply on the operation.
        required: false
        schema:
          type: string
      - name: $skip
        in: query
        description: The number of rows to skip.
        required: false
        schema:
          type: integer
          format: int32
      - name: $top
        in: query
        description: The number of rows to take.
        required: false
        schema:
          type: integer
          format: int32
      - name: $inlinecount
        in: query
        description: Return total rows.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscNodeListResult'
        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 nodes by Automation Account:
          $ref: ./examples/listAllDscNodesByAutomationAccount.json
        List Paged DSC nodes by Automation Account where Node Configurations are not assigned filter:
          $ref: ./examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationNotAssignedFilter.json
        List Paged DSC nodes by Automation Account with Node Configuration Custom filter:
          $ref: ./examples/listPagedDscNodesByAutomationAccountWithNodeConfigurationCustomFilter.json
        List Paged DSC nodes by Automation Account with name filter:
          $ref: ./examples/listPagedDscNodesByAutomationAccountWithNameFilter.json
        List Paged DSC nodes by Automation Account with no filters:
          $ref: ./examples/listPagedDscNodesByAutomationAccountWithNoFilter.json
        List Paged DSC nodes by Automation Account with node status filter:
          $ref: ./examples/listPagedDscNodesByAutomationAccountWithStatusFilter.json
        List Paged DSC nodes by Automation Account with version filter:
          $ref: ./examples/listPagedDscNodesByAutomationAccountWithVersionFilter.json
        List Paged DSC nodes with filters separated by 'and':
          $ref: ./examples/listPagedDscNodesByAutomationAccountWithCompositeFilter.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Dsc node list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}
  : get:
      operationId: DscNode_Get
      tags:
      - DscNode
      description: Retrieve the dsc node identified by node id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodeoperations
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscNode'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get a node:
          $ref: ./examples/getDscNode.json
      summary: Dsc node get
      x-summary-source: derived
    patch:
      operationId: DscNode_Update
      tags:
      - DscNode
      description: Update the dsc node.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodeoperations
      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
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscNode'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Update a node:
          $ref: ./examples/updateDscNode.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DscNodeUpdateParameters'
        description: Parameters supplied to the update dsc node.
        required: true
      summary: Dsc node update
      x-summary-source: derived
    delete:
      operationId: DscNode_Delete
      tags:
      - DscNode
      description: Delete the dsc node identified by node id.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodeoperations
      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
      responses:
        '200':
          description: Resource deleted successfully.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete a DSC Node:
          $ref: ./examples/deleteDscNode.json
      summary: Dsc node delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    DscNodeListResult:
      type: object
      description: The response model for the list dsc nodes operation.
      properties:
        value:
          type: array
          description: Gets or sets a list of dsc nodes.
          items:
            $ref: '#/components/schemas/DscNode'
        nextLink:
          type: string
          description: Gets or sets the next link.
        totalCount:
          type: integer
          format: int32
          description: Gets the total number of nodes matching filter criteria.
    DscNodeUpdateParametersProperties:
      type: object
      properties:
        nodeConfiguration:
          $ref: '#/components/schemas/DscNodeConfigurationAssociationProperty'
          description: Gets or sets the configuration of the node.
          x-ms-client-flatten: true
    DscNodeUpdateParameters:
      type: object
      description: The parameters supplied to the update dsc node operation.
      properties:
        nodeId:
          type: string
          description: Gets or sets the id of the dsc node.
        properties:
          $ref: '#/components/schemas/DscNodeUpdateParametersProperties'
    DscNodeProperties:
      type: object
      description: The properties of a DscNode
      properties:
        lastSeen:
          type: string
          format: date-time
          description: Gets or sets the last seen time of the node.
        registrationTime:
          type: string
          format: date-time
          description: Gets or sets the registration time of the node.
        ip:
          type: string
          description: Gets or sets the ip of the node.
        accountId:
          type: string
          description: Gets or sets the account id of the node.
        nodeConfiguration:
          $ref: '#/components/schemas/DscNodeConfigurationAssociationProperty'
          description: Gets or sets the configuration of the node.
          x-ms-client-flatten: true
        status:
          type: string
          description: Gets or sets the status of the node.
        nodeId:
          type: string
          description: Gets or sets the node id.
        etag:
          type: string
          description: Gets or sets the etag of the resource.
        totalCount:
          type: integer
          format: int32
          description: Gets the total number of records matching filter criteria.
        extensionHandler:
          type: array
          description: Gets or sets the list of extensionHandler properties for a Node.
          items:
            $ref: '#/components/schemas/DscNodeExtensionHandlerAssociationProperty'
          x-ms-identifiers:
          - name
    DscNodeExtensionHandlerAssociationProperty:
      type: object
      description: The dsc extensionHandler property associated with the node
      properties:
        name:
          type: string
          description: Gets or sets the name of the extension handler.
        version:
          type: string
          description: Gets or sets the version of the extension handler.
    DscNode:
      type: object
      description: Definition of a DscNode
      properties:
        properties:
          $ref: '#/components/schemas/DscNodeProperties'
          description: The properties of a DscNode.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    DscNodeConfigurationAssociationProperty:
      type: object
      description: The dsc node configuration property associated with the entity.
      properties:
        name:
          type: string
          description: Gets or sets the name of the dsc node 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