Azure Automation Dsc Configuration API

openapi: 3.2.0
info:
  title: Microsoft Azure Automation Dsc Configuration API
  version: '2024-10-23'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged DscConfiguration 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: DscConfiguration
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations
  : get:
      operationId: DscConfiguration_ListByAutomationAccount
      tags:
      - DscConfiguration
      description: Retrieve a list of configurations.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/configurationoperations
      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/DscConfigurationListResult'
        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 Configuration:
          $ref: ./examples/getAllDscConfigurations.json
        List Paged DSC Configurations with name filter:
          $ref: ./examples/getPagedlDscConfigurationsWithNameFilter.json
        List Paged DSC Configurations with no filter:
          $ref: ./examples/getPagedDscConfigurationsWithNoFilter.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Dsc configuration list by automation account
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}
  : get:
      operationId: DscConfiguration_Get
      tags:
      - DscConfiguration
      description: Retrieve the configuration identified by configuration name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/configurationoperations
      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: configurationName
        in: path
        description: The configuration name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscConfiguration'
        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 Configuration:
          $ref: ./examples/getDscConfiguration.json
      summary: Dsc configuration get
      x-summary-source: derived
    put:
      operationId: DscConfiguration_CreateOrUpdate
      tags:
      - DscConfiguration
      description: Create the configuration identified by configuration name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/configurationoperations
      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: configurationName
        in: path
        description: The configuration name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource 'DscConfiguration' update operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscConfiguration'
        '201':
          description: Resource 'DscConfiguration' create operation succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscConfiguration'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create or Update Configuration:
          $ref: ./examples/createOrUpdateDscConfiguration.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DscConfigurationCreateOrUpdateParameters'
        description: The create or update parameters for configuration.
        required: true
      summary: Dsc configuration create or update
      x-summary-source: derived
    patch:
      operationId: DscConfiguration_Update
      tags:
      - DscConfiguration
      description: Create the configuration identified by configuration name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/configurationoperations
      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: configurationName
        in: path
        description: The configuration name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DscConfiguration'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create or Update Configuration:
          $ref: ./examples/updateDscConfiguration.json
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DscConfigurationUpdateParameters'
        description: The create or update parameters for configuration.
      summary: Dsc configuration update
      x-summary-source: derived
    delete:
      operationId: DscConfiguration_Delete
      tags:
      - DscConfiguration
      description: Delete the dsc configuration identified by configuration name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/configurationoperations
      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: configurationName
        in: path
        description: The configuration name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Resource deleted successfully.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete DSC Configuration:
          $ref: ./examples/deleteDscConfiguration.json
      summary: Dsc configuration delete
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/configurations/{configurationName}/content
  : get:
      operationId: DscConfiguration_GetContent
      tags:
      - DscConfiguration
      description: Retrieve the configuration script identified by configuration name.
      externalDocs:
        url: http://aka.ms/azureautomationsdk/configurationoperations
      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: configurationName
        in: path
        description: The configuration name.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            text/powershell:
              schema:
                type: string
            application/json:
              schema:
                type: string
        default:
          description: An unexpected error response.
          content:
            text/powershell:
              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 DSC Configuration content:
          $ref: ./examples/getDscConfigurationContent.json
      summary: Dsc configuration get content
      x-summary-source: derived
    servers:
    - url: https://management.azure.com
components:
  schemas:
    DscConfigurationProperties:
      type: object
      description: Definition of the configuration property type.
      properties:
        provisioningState:
          type: string
          description: Gets or sets the provisioning state of the configuration.
          enum:
          - Succeeded
          x-ms-enum:
            modelAsString: false
        jobCount:
          type: integer
          format: int32
          description: Gets or sets the job count of the configuration.
        parameters:
          type: object
          description: Gets or sets the configuration parameters.
          additionalProperties:
            $ref: '#/components/schemas/DscConfigurationParameter'
        source:
          $ref: '#/components/schemas/ContentSource'
          description: Gets or sets the source.
        state:
          $ref: '#/components/schemas/DscConfigurationState'
          description: Gets or sets the state of the configuration.
        logVerbose:
          type: boolean
          description: Gets or sets verbose log option.
        creationTime:
          type: string
          format: date-time
          description: Gets or sets the creation time.
        lastModifiedTime:
          type: string
          format: date-time
          description: Gets or sets the last modified time.
        nodeConfigurationCount:
          type: integer
          format: int32
          description: Gets the number of compiled node configurations.
        description:
          type: string
          description: Gets or sets the description.
    DscConfigurationListResult:
      type: object
      description: The response model for the list configuration operation.
      properties:
        value:
          type: array
          description: Gets or sets a list of configurations.
          items:
            $ref: '#/components/schemas/DscConfiguration'
        nextLink:
          type: string
          description: Gets or sets the next link.
        totalCount:
          type: integer
          format: int32
          description: Gets the total number of configurations matching filter criteria.
    DscConfigurationParameter:
      type: object
      description: Definition of the configuration parameter type.
      properties:
        type:
          type: string
          description: Gets or sets the type of the parameter.
        isMandatory:
          type: boolean
          description: Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.
        position:
          type: integer
          format: int32
          description: Get or sets the position of the parameter.
        defaultValue:
          type: string
          description: Gets or sets the default value of parameter.
    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.
    DscConfigurationUpdateParameters:
      type: object
      description: The parameters supplied to the create or update configuration operation.
      properties:
        properties:
          $ref: '#/components/schemas/DscConfigurationCreateOrUpdateProperties'
          description: Gets or sets configuration create or update properties.
          x-ms-client-flatten: true
        name:
          type: string
          description: Gets or sets name of the resource.
        tags:
          type: object
          description: Gets or sets the tags attached to the resource.
          additionalProperties:
            type: string
    DscConfigurationCreateOrUpdateProperties:
      type: object
      description: The properties to create or update configuration.
      properties:
        logVerbose:
          type: boolean
          description: Gets or sets verbose log option.
        logProgress:
          type: boolean
          description: Gets or sets progress log option.
        source:
          $ref: '#/components/schemas/ContentSource'
          description: Gets or sets the source.
        parameters:
          type: object
          description: Gets or sets the configuration parameters.
          additionalProperties:
            $ref: '#/components/schemas/DscConfigurationParameter'
        description:
          type: string
          description: Gets or sets the description of the configuration.
      required:
      - source
    DscConfigurationState:
      type: string
      description: Gets or sets the state of the configuration.
      enum:
      - New
      - Edit
      - Published
      x-ms-enum:
        name: DscConfigurationState
        modelAsString: true
        values:
        - name: New
          value: New
          description: New
        - name: Edit
          value: Edit
          description: Edit
        - name: Published
          value: Published
          description: Published
    DscConfigurationCreateOrUpdateParameters:
      type: object
      description: The parameters supplied to the create or update configuration operation.
      properties:
        properties:
          $ref: '#/components/schemas/DscConfigurationCreateOrUpdateProperties'
          description: Gets or sets configuration create or update properties.
          x-ms-client-flatten: true
        name:
          type: string
          description: Gets or sets name of the resource.
        location:
          type: string
          description: Gets or sets the location of the resource.
        tags:
          type: object
          description: Gets or sets the tags attached to the resource.
          additionalProperties:
            type: string
      required:
      - properties
    DscConfiguration:
      type: object
      description: Definition of the configuration type.
      properties:
        properties:
          $ref: '#/components/schemas/DscConfigurationProperties'
          description: Gets or sets the configuration properties.
          x-ms-client-flatten: true
        etag:
          type: string
          description: Gets or sets the etag of the resource.
      allOf:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource
    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
    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