Microsoft Azure ConfigurationProfileAssignments API

openapi: 3.2.0
info:
  version: 2021-04-30-preview
  title: Microsoft Azure Automanage Configuration Profile…
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ConfigurationProfileAssignments
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Automanage/configurationProfileAssignments/{configurationProfileAssignmentName}
  : put:
      tags:
      - ConfigurationProfileAssignments
      operationId: microsoftAzureConfigurationprofileassignmentsCreateorupdate
      description: Creates an association between a VM and Automanage configuration profile
      x-ms-examples:
        Create or update configuration profile assignment:
          $ref: ./examples/createOrUpdateConfigurationProfileAssignment.json
      parameters:
      - name: configurationProfileAssignmentName
        in: path
        required: true
        description: Name of the configuration profile assignment. Only default is supported.
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/VmNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The configuration profile assignment for the VM was updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfileAssignment'
        '201':
          description: Created. The Automanage configuration profile assignment for the VM was created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfileAssignment'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: false
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigurationProfileAssignment'
        description: Parameters supplied to the create or update configuration profile assignment.
        required: true
    get:
      tags:
      - ConfigurationProfileAssignments
      operationId: microsoftAzureConfigurationprofileassignmentsGet
      description: Get information about a configuration profile assignment
      x-ms-examples:
        Get a configuration profile assignment:
          $ref: ./examples/getConfigurationProfileAssignment.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - name: configurationProfileAssignmentName
        in: path
        required: true
        description: The configuration profile assignment name.
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/VmNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The configuration profile assignment was returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfileAssignment'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    delete:
      tags:
      - ConfigurationProfileAssignments
      operationId: microsoftAzureConfigurationprofileassignmentsDelete
      description: Delete a configuration profile assignment
      x-ms-examples:
        Delete an configuration profile assignment:
          $ref: ./examples/deleteConfigurationProfileAssignment.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - name: configurationProfileAssignmentName
        in: path
        required: true
        description: Name of the configuration profile assignment
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: '#/components/parameters/VmNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK
        '204':
          description: OK
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: false
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.Automanage/configurationProfileAssignments
  : get:
      tags:
      - ConfigurationProfileAssignments
      operationId: microsoftAzureConfigurationprofileassignmentsListbyvirtualmachines
      description: Get list of configuration profile assignments
      x-ms-examples:
        List configuration profile assignments by resourceGroup and virtual machine:
          $ref: ./examples/listConfigurationProfileAssignmentsByVirtualMachines.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/VmNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The list of configuration profile assignments were returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfileAssignmentList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automanage/configurationProfileAssignments
  : get:
      tags:
      - ConfigurationProfileAssignments
      operationId: microsoftAzureConfigurationprofileassignmentsList
      description: Get list of configuration profile assignments
      x-ms-examples:
        List configuration profile assignments by resourceGroup:
          $ref: ./examples/listConfigurationProfileAssignmentsByResourceGroup.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The list of configuration profile assignments were returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfileAssignmentList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  /subscriptions/{subscriptionId}/providers/Microsoft.Automanage/configurationProfileAssignments:
    get:
      tags:
      - ConfigurationProfileAssignments
      operationId: microsoftAzureConfigurationprofileassignmentsListbysubscription
      description: Get list of configuration profile assignments under a given subscription
      x-ms-examples:
        List configuration profile assignments by subscription:
          $ref: ./examples/listConfigurationProfileAssignmentsBySubscription.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The list of configuration profile assignments were returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfileAssignmentList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Automanage…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.Automanage/configurationProfileAssignments
  : get:
      tags:
      - ConfigurationProfileAssignments
      operationId: microsoftAzureConfigurationprofileassignmentsListbymachinename
      description: Get list of configuration profile assignments
      x-ms-examples:
        List configuration profile assignments by resourceGroup and machine:
          $ref: ./examples/listConfigurationProfileAssignmentsByMachineName.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MachineNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The list of configuration profile assignments were returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfileAssignmentList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHci/clusters/{clusterName}/providers/Microsoft.Automanage/configurationProfileAssignments
  : get:
      tags:
      - ConfigurationProfileAssignments
      operationId: microsoftAzureConfigurationprofileassignmentsListbyclustername
      description: Get list of configuration profile assignments
      x-ms-examples:
        List configuration profile assignments by resourceGroup and cluster:
          $ref: ./examples/listConfigurationProfileAssignmentsByClusterName.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/ClusterNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: OK. The list of configuration profile assignments were returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigurationProfileAssignmentList'
        default:
          description: Error response describing why the operation failed.
          content:
            application/json:
              schema:
                $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: null
      summary: Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers…
components:
  parameters:
    ClusterNameParameter:
      name: clusterName
      in: path
      required: true
      description: The name of the Arc machine.
      x-ms-parameter-location: method
      schema:
        type: string
    VmNameParameter:
      name: vmName
      in: path
      required: true
      description: The name of the virtual machine.
      x-ms-parameter-location: method
      schema:
        type: string
    MachineNameParameter:
      name: machineName
      in: path
      required: true
      description: The name of the Arc machine.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    ConfigurationProfileAssignmentProperties:
      description: Automanage configuration profile assignment properties.
      type: object
      properties:
        configurationProfile:
          type: string
          description: The Automanage configurationProfile ARM Resource URI.
        targetId:
          type: string
          description: The target VM resource URI
          readOnly: true
        status:
          type: string
          readOnly: true
          description: The status of onboarding, which only appears in the response.
        profileOverrides:
          $ref: '#/components/schemas/ConfigurationProfileAssignmentProfileOverrides'
          description: The profileOverrides setting for the configuration profile assignment.
    ConfigurationProfileAssignment:
      description: Configuration profile assignment is an association between a VM and automanage profile configuration.
      type: object
      properties:
        properties:
          x-ms-client-flatten: false
          $ref: '#/components/schemas/ConfigurationProfileAssignmentProperties'
          description: Properties of the configuration profile assignment.
        systemData:
          $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
          readOnly: true
          description: Azure Resource Manager metadata containing createdBy and modifiedBy information.
      allOf:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource
    ConfigurationProfileAssignmentProfileOverrides:
      description: Data related to configuration profile assignment profile overrides.
      type: object
      additionalProperties:
        type: object
    ConfigurationProfileAssignmentList:
      description: The response of the list configuration profile assignment operation.
      type: object
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationProfileAssignment'
          description: Result of the list configuration profile assignment operation.
  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