swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Associations API
schemes:
- https
tags:
- name: Associations
paths:
  /{scope}/providers/Microsoft.CustomProviders/associations/{associationName}:
    put:
      tags:
      - Associations
      operationId: microsoftAzureAssociationsCreateorupdate
      x-ms-long-running-operation: true
      description: Create or update an association.
      x-ms-examples:
        Create or update an association:
          $ref: examples/createOrUpdateAssociation.json
      parameters:
      - name: scope
        in: path
        required: true
        type: string
        description: The scope of the association. The scope can be any valid REST resource instance. For example, use '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.Compute/virtualMachines/{vm-name}' for a virtual machine resource.
        x-ms-skip-url-encoding: true
      - name: associationName
        in: path
        required: true
        type: string
        description: The name of the association.
      - name: association
        in: body
        required: true
        schema:
          $ref: '#/definitions/Association'
        description: The parameters required to create or update an association.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. Association already exists and the changes have been accepted.
          schema:
            $ref: '#/definitions/Association'
        '201':
          description: Created. Association has been created.
          schema:
            $ref: '#/definitions/Association'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      consumes:
      - application/json
      summary: Microsoft Azure Put Scope Providers Microsoft Customproviders Associations Associationname
    delete:
      tags:
      - Associations
      operationId: microsoftAzureAssociationsDelete
      x-ms-long-running-operation: true
      description: Delete an association.
      x-ms-examples:
        Delete an association:
          $ref: examples/deleteAssociation.json
      parameters:
      - name: scope
        in: path
        required: true
        type: string
        description: The scope of the association.
        x-ms-skip-url-encoding: true
      - name: associationName
        in: path
        required: true
        type: string
        description: The name of the association.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. Association deleted.
        '202':
          description: Accepted. Association delete has been accepted.
        '204':
          description: No Content. Association was not found.
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      summary: Microsoft Azure Delete Scope Providers Microsoft Customproviders Associations Associationname
    get:
      tags:
      - Associations
      operationId: microsoftAzureAssociationsGet
      description: Get an association.
      x-ms-examples:
        Get an association:
          $ref: examples/getAssociation.json
      parameters:
      - name: scope
        in: path
        required: true
        type: string
        description: The scope of the association.
        x-ms-skip-url-encoding: true
      - name: associationName
        in: path
        required: true
        type: string
        description: The name of the association.
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. Returns association.
          schema:
            $ref: '#/definitions/Association'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      summary: Microsoft Azure Get Scope Providers Microsoft Customproviders Associations Associationname
  /{scope}/providers/Microsoft.CustomProviders/associations:
    get:
      tags:
      - Associations
      operationId: microsoftAzureAssociationsListall
      description: Gets all association for the given scope.
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Get all associations:
          $ref: examples/getAllAssociations.json
      parameters:
      - name: scope
        in: path
        required: true
        type: string
        description: The scope of the association.
        x-ms-skip-url-encoding: true
      - $ref: '#/parameters/ApiVersionParameter'
      responses:
        '200':
          description: OK. Returns all associations for the given scope.
          schema:
            $ref: '#/definitions/AssociationsList'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      produces:
      - application/json
      summary: Microsoft Azure Get Scope Providers Microsoft Customproviders Associations
definitions:
  ErrorDefinition:
    description: Error definition.
    properties:
      code:
        description: Service specific error code which serves as the substatus for the HTTP error code.
        type: string
        readOnly: true
      message:
        description: Description of the error.
        type: string
        readOnly: true
      details:
        description: Internal error details.
        type: array
        items:
          $ref: '#/definitions/ErrorDefinition'
        x-ms-identifiers: []
        readOnly: true
  ErrorResponse:
    description: Error response.
    properties:
      error:
        $ref: '#/definitions/ErrorDefinition'
        description: The error details.
  AssociationsList:
    description: List of associations.
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/Association'
        description: The array of associations.
      nextLink:
        type: string
        description: The URL to use for getting the next set of results.
  Association:
    x-ms-azure-resource: true
    x-ms-client-flatten: true
    description: The resource definition of this association.
    properties:
      id:
        type: string
        readOnly: true
        description: The association id.
      name:
        type: string
        readOnly: true
        description: The association name.
      type:
        type: string
        readOnly: true
        description: The association type.
      properties:
        type: object
        description: The properties of the association.
        x-ms-client-flatten: true
        properties:
          targetResourceId:
            type: string
            description: The REST resource instance of the target resource for this association.
          provisioningState:
            type: string
            description: The provisioning state of the association.
            readOnly: true
            x-ms-enum:
              modelAsString: true
              name: ProvisioningState
            enum:
            - Accepted
            - Deleting
            - Running
            - Succeeded
            - Failed
parameters:
  ApiVersionParameter:
    name: api-version
    in: query
    required: true
    type: string
    description: The API version to be used with the HTTP request.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'