Azure Automation Dsc Node Configuration API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Dsc Node Configuration API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged DscNodeConfiguration 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: DscNodeConfiguration
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations
  : get:
      operationId: DscNodeConfiguration_ListByAutomationAccount
      tags:
      - DscNodeConfiguration
      description: Retrieve a list of dsc node configurations.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodeconfigurations
      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/DscNodeConfigurationListResult'
        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 node configurations by Automation Account:
          $ref: ./examples/listDscNodeConfigurations.json
        List Paged DSC node configurations by Automation Account with name filter:
          $ref: ./examples/listPagedDscNodeConfigurationsWithNameFilter.json
        List Paged DSC node configurations by Automation Account with no filter:
          $ref: ./examples/listPagedDscNodeConfigurationsWithNoFilter.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Dsc node configuration list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodeConfigurations/{nodeConfigurationName}
  : get:
      operationId: DscNodeConfiguration_Get
      tags:
      - DscNodeConfiguration
      description: Retrieve the Dsc node configurations by node configuration.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodeconfigurations
      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: nodeConfigurationName
        in: path
        description: The Dsc node configuration name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscNodeConfiguration'
        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 DSC node configuration:
          $ref: ./examples/getDscNodeConfiguration.json
      summary: Dsc node configuration get
      x-summary-source: derived
    put:
      operationId: DscNodeConfiguration_CreateOrUpdate
      tags:
      - DscNodeConfiguration
      description: Create the node configuration identified by node configuration name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodeconfigurations
      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: nodeConfigurationName
        in: path
        description: The Dsc node configuration name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The request has succeeded.
        '201':
          description: Resource 'DscNodeConfiguration' create operation succeeded
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscNodeConfiguration'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create node configuration:
          $ref: ./examples/createOrUpdateDscNodeConfiguration.json
      x-ms-long-running-operation-options:
        final-state-via: location
        final-state-schema: '#/definitions/DscNodeConfiguration'
      x-ms-long-running-operation: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DscNodeConfigurationCreateOrUpdateParameters'
        description: The create or update parameters for configuration.
        required: true
      summary: Dsc node configuration create or update
      x-summary-source: derived
    delete:
      operationId: DscNodeConfiguration_Delete
      tags:
      - DscNodeConfiguration
      description: Delete the Dsc node configurations by node configuration.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/dscnodeconfigurations
      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: nodeConfigurationName
        in: path
        description: The Dsc node configuration name.
        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 configuration:
          $ref: ./examples/deleteDscNodeConfiguration.json
      summary: Dsc node configuration delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    DscNodeConfigurationCreateOrUpdateParametersProperties:
      type: object
      description: The parameter properties supplied to the create or update node configuration operation.
      properties:
        source:
          $ref: '#/components/schemas/ContentSource'
          description: Gets or sets the source.
        configuration:
          $ref: '#/components/schemas/DscConfigurationAssociationProperty'
          description: Gets or sets the configuration of the node.
        incrementNodeConfigurationBuild:
          type: boolean
          description: If a new build version of NodeConfiguration is required.
      required:
      - source
      - configuration
    DscNodeConfigurationListResult:
      type: object
      description: The response model for the list job operation.
      properties:
        value:
          type: array
          description: Gets or sets a list of Dsc node configurations.
          items:
            $ref: '#/components/schemas/DscNodeConfiguration'
        nextLink:
          type: string
          description: Gets or sets the next link.
        totalCount:
          type: integer
          format: int32
          description: Gets or sets the total rows in query.
    ContentSource:
      type: object
      description: Definition of the content source.
      properties:
        hash:
          $ref: '#/components/schemas/ContentHash'
          description: Gets or sets the hash.
        type:
          $ref: '#/components/schemas/ContentSourceType'
          description: Gets or sets the content source type.
        value:
          type: string
          description: Gets or sets the value of the content. This is based on the content source type.
        version:
          type: string
          description: Gets or sets the version of the content.
    ContentHash:
      type: object
      description: Definition of the runbook property type.
      properties:
        algorithm:
          type: string
          description: Gets or sets the content hash algorithm used to hash the content.
        value:
          type: string
          description: Gets or sets expected hash value of the content.
      required:
      - algorithm
      - value
    DscNodeConfigurationCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update node configuration operation.
      properties:
        properties:
          $ref: '#/components/schemas/DscNodeConfigurationCreateOrUpdateParametersProperties'
          description: Node configuration properties
          x-ms-client-flatten: true
        name:
          type: string
          description: Name of the node configuration.
        tags:
          type: object
          description: Gets or sets the tags attached to the resource.
          additionalProperties:
            type: string
    DscNodeConfigurationProperties:
      type: object
      description: Properties for the DscNodeConfiguration
      properties:
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets or sets the last modified time.
        creationTime:
          type: string
          format: date-time
          description: Gets or sets creation time.
        configuration:
          $ref: '#/components/schemas/DscConfigurationAssociationProperty'
          description: Gets or sets the configuration of the node.
        source:
          type: string
          description: Source of node configuration.
        nodeCount:
          type: integer
          format: int64
          description: Number of nodes with this node configuration assigned
        incrementNodeConfigurationBuild:
          type: boolean
          description: If a new build version of NodeConfiguration is required.
    DscConfigurationAssociationProperty:
      type: object
      description: The Dsc configuration property associated with the entity.
      properties:
        name:
          type: string
          description: Gets or sets the name of the Dsc configuration.
    DscNodeConfiguration:
      type: object
      description: Definition of the dsc node configuration.
      properties:
        properties:
          $ref: '#/components/schemas/DscNodeConfigurationProperties'
          description: Gets or sets the configuration properties.
          x-ms-client-flatten: true
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource
    ContentSourceType:
      type: string
      description: Gets or sets the content source type.
      enum:
      - embeddedContent
      - uri
      x-ms-enum:
        name: ContentSourceType
        modelAsString: true
        values:
        - name: embeddedContent
          value: embeddedContent
          description: embeddedContent
        - name: uri
          value: uri
          description: uri
  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