swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector Collection API
schemes:
- https
tags:
- name: Collection
paths:
  /collections/{collectionName}:
    get:
      tags:
      - Collection
      description: Get a collection
      operationId: microsoftAzureCollectionsGetcollection
      produces:
      - application/json
      parameters:
      - in: path
        name: collectionName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Collection'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Collections_GetCollection:
          $ref: ./examples/Collections_GetCollection.json
      summary: Microsoft Azure Get Collections Collectionname
    put:
      tags:
      - Collection
      description: Creates or updates a collection entity.
      operationId: microsoftAzureCollectionsCreateorupdatecollection
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - in: path
        name: collectionName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/Collection'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/Collection'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Collections_CreateOrUpdateCollection:
          $ref: ./examples/Collections_CreateOrUpdateCollection.json
      summary: Microsoft Azure Put Collections Collectionname
    delete:
      tags:
      - Collection
      description: Deletes a Collection entity.
      operationId: microsoftAzureCollectionsDeletecollection
      produces:
      - application/json
      parameters:
      - in: path
        name: collectionName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '204':
          description: No Content
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Collections_DeleteCollection:
          $ref: ./examples/Collections_DeleteCollection.json
      summary: Microsoft Azure Delete Collections Collectionname
  /collections:
    get:
      tags:
      - Collection
      description: List the collections in the account.
      operationId: microsoftAzureCollectionsListcollections
      produces:
      - application/json
      parameters:
      - $ref: '#/parameters/api-version'
      - in: query
        name: $skipToken
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CollectionList'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Collections_ListCollections:
          $ref: ./examples/Collections_ListCollections.json
      summary: Microsoft Azure Get Collections
  /collections/{collectionName}/getChildCollectionNames:
    get:
      tags:
      - Collection
      description: Lists the child collections names in the collection.
      operationId: microsoftAzureCollectionsListchildcollectionnames
      produces:
      - application/json
      parameters:
      - in: path
        name: collectionName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: query
        name: $skipToken
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CollectionNameResponseList'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Collections_ListChildCollectionNames:
          $ref: ./examples/Collections_ListChildCollectionNames.json
      summary: Microsoft Azure Get Collections Collectionname Getchildcollectionnames
  /collections/{collectionName}/getCollectionPath:
    get:
      tags:
      - Collection
      description: Gets the parent name and parent friendly name chains that represent the collection path.
      operationId: microsoftAzureCollectionsGetcollectionpath
      produces:
      - application/json
      parameters:
      - in: path
        name: collectionName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      - in: query
        name: $skipToken
        type: string
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/CollectionPathResponse'
        default:
          description: An error response received from the provider.
          schema:
            $ref: '#/definitions/ErrorResponseModel'
      x-ms-examples:
        Collections_GetCollectionPath:
          $ref: ./examples/Collections_GetCollectionPath.json
      summary: Microsoft Azure Get Collections Collectionname Getcollectionpath
  /subscriptions/{subscriptionId}/providers/Microsoft.HealthcareApis/services:
    get:
      tags:
      - Collection
      description: Get all the service instances in a subscription.
      operationId: microsoftAzureServicesList
      x-ms-examples:
        ServiceList:
          $ref: ./examples/ServiceList.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/api-version_2'
      - $ref: '#/parameters/subscriptionId'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the subscription.
          schema:
            $ref: '#/definitions/ServicesDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Healthcareapis Services
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/services:
    get:
      tags:
      - Collection
      description: Get all the service instances in a resource group.
      operationId: microsoftAzureServicesListbyresourcegroup
      x-ms-examples:
        ServiceListByResourceGroup:
          $ref: ./examples/ServiceListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: '#/parameters/api-version_2'
      - $ref: '#/parameters/subscriptionId'
      - $ref: '#/parameters/resourceGroupName'
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the service instances in the resource group.
          schema:
            $ref: '#/definitions/ServicesDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: '#/definitions/ErrorDetails'
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Healthcareapis Services
  /subscriptions/{subscriptionId}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell:
    get:
      tags:
      - Collection
      description: Get all the privateLinkServicesForSCCPowershell instances in a subscription.
      operationId: microsoftAzurePrivatelinkservicesforsccpowershellList
      x-ms-examples:
        List all services in subscription:
          $ref: ./examples/SCCPowershellServiceList.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: ./common-types.json#/parameters/ApiVersionParameter
      - $ref: ./common-types.json#/parameters/subscriptionId
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the privateLinkServicesForSCCPowershell instances in the subscription.
          schema:
            $ref: '#/definitions/PrivateLinkServicesForSCCPowershellDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: ./common-types.json#/definitions/ErrorDetails
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft M365securityandcompliance Privatelinkservicesforsccpowershell
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.M365SecurityAndCompliance/privateLinkServicesForSCCPowershell
  : get:
      tags:
      - Collection
      description: Get all the service instances in a resource group.
      operationId: microsoftAzurePrivatelinkservicesforsccpowershellListbyresourcegroup
      x-ms-examples:
        List all services in resource group:
          $ref: ./examples/SCCPowershellServiceListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: ./common-types.json#/parameters/ApiVersionParameter
      - $ref: ./common-types.json#/parameters/subscriptionId
      - $ref: ./common-types.json#/parameters/resourceGroupName
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the privateLinkServicesForSCCPowershell instances in the resource group.
          schema:
            $ref: '#/definitions/PrivateLinkServicesForSCCPowershellDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: ./common-types.json#/definitions/ErrorDetails
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft M365securityandcompliance Privatelinkservicesforsccpowershell
  /collections/{collectionName}/scans:
    get:
      tags:
      - Collection
      description: List scans of the collection
      operationId: microsoftAzureScansListbycollection
      produces:
      - application/json
      parameters:
      - in: path
        name: collectionName
        required: true
        type: string
      - $ref: '#/parameters/api-version'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/ScanByCollectionList'
        default:
          description: An error response received from the Scanning Service
          schema:
            $ref: '#/definitions/ErrorResponseModel_2'
      x-ms-examples:
        Scans_ListByCollection:
          $ref: ./examples/Scans_ListByCollection.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Collections Collectionname Scans
  /collections/{collection}/entity:
    post:
      tags:
      - Collection
      description: 'Creates or updates an entity to a collection.<br>Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.<br>Map and array of collections are not well supported. E.g., array>, array>.'
      operationId: microsoftAzureCollectionCreateorupdate
      x-ms-examples:
        Collection_CreateOrUpdate:
          $ref: ./examples/Collection_CreateOrUpdate.json
      parameters:
      - $ref: '#/parameters/collection'
      - $ref: '#/parameters/purviewAPIVersion'
      - in: body
        name: entity
        description: Atlas entity with extended information.
        required: true
        schema:
          $ref: '#/definitions/AtlasEntityWithExtInfo'
      responses:
        '200':
          description: Created with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Collections Collection Entity
  /collections/{collection}/entity/bulk:
    post:
      tags:
      - Collection
      description: 'Creates or updates entities in bulk to a collection.<br>Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName.<br>Map and array of collections are not well supported. E.g., array>, array>.'
      operationId: microsoftAzureCollectionCreateorupdatebulk
      x-ms-examples:
        Collection_CreateOrUpdateBulk:
          $ref: ./examples/Collection_CreateOrUpdateBulk.json
      parameters:
      - $ref: '#/parameters/collection'
      - $ref: '#/parameters/purviewAPIVersion'
      - in: body
        name: entities
        description: Atlas entities with extended information.
        required: true
        schema:
          $ref: '#/definitions/AtlasEntitiesWithExtInfo'
      responses:
        '200':
          description: Created with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Collections Collection Entity Bulk
  /collections/{collection}/entity/moveHere:
    post:
      tags:
      - Collection
      description: Move existing entities to the target collection.
      operationId: microsoftAzureCollectionMoveentitiestocollection
      x-ms-examples:
        Collection_MoveEntitiesToCollection:
          $ref: ./examples/Collection_MoveEntitiesToCollection.json
      parameters:
      - $ref: '#/parameters/collection'
      - $ref: '#/parameters/purviewAPIVersion'
      - in: body
        name: moveEntitiesRequest
        description: Entity guids to be moved to target collection.
        required: true
        schema:
          $ref: '#/definitions/MoveEntitiesRequest'
      responses:
        '200':
          description: Created with EntityMutationResponse.
          schema:
            $ref: '#/definitions/EntityMutationResponse'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: '#/definitions/ErrorResponse'
      summary: Microsoft Azure Post Collections Collection Entity Movehere
  /subscriptions/{subscriptionId}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell:
    get:
      tags:
      - Collection
      description: Get all the privateLinkServicesForSCCPowershell instances in a subscription.
      operationId: microsoftAzurePrivatelinkservicesforsccpowershellList
      x-ms-examples:
        List all services in subscription:
          $ref: ./examples/SCCPowershellServiceList.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: ./common-types.json#/parameters/ApiVersionParameter
      - $ref: ./common-types.json#/parameters/subscriptionId
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the privateLinkServicesForSCCPowershell instances in the subscription.
          schema:
            $ref: '#/definitions/PrivateLinkServicesForSCCPowershellDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: ./common-types.json#/definitions/ErrorDetails
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Securityandcompliance Privatelinkservicesforsccpowershell
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityAndCompliance/privateLinkServicesForSCCPowershell
  : get:
      tags:
      - Collection
      description: Get all the service instances in a resource group.
      operationId: microsoftAzurePrivatelinkservicesforsccpowershellListbyresourcegroup
      x-ms-examples:
        List all services in resource group:
          $ref: ./examples/SCCPowershellServiceListByResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      parameters:
      - $ref: ./common-types.json#/parameters/ApiVersionParameter
      - $ref: ./common-types.json#/parameters/subscriptionId
      - $ref: ./common-types.json#/parameters/resourceGroupName
      responses:
        '200':
          description: This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the privateLinkServicesForSCCPowershell instances in the resource group.
          schema:
            $ref: '#/definitions/PrivateLinkServicesForSCCPowershellDescriptionListResult'
        default:
          description: DefaultErrorResponse
          schema:
            $ref: ./common-types.json#/definitions/ErrorDetails
      deprecated: false
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Securityandcompliance Privatelinkservicesforsccpowershell
definitions:
  LastModifiedTS:
    type: string
    title: lastModifiedTS
    description: ETag for concurrency control.
  ServiceCorsConfigurationOriginEntry:
    description: An origin for CORS.
    type: string
    pattern: ^(?:(?:(?:[hH][tT][tT][pP](?:[sS]|))\:\/\/(?:[a-zA-Z0-9-]+[.]?)+(?:\:[0-9]{1,5})?|[*]))$
  ServiceAccessPolicyEntry:
    description: An access policy entry.
    properties:
      objectId:
        description: An object ID that is allowed access to the FHIR service.
        type: string
        pattern: ^(([0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}){1})+$
    required:
    - objectId
  PrivateLinkServicesForSCCPowershellDescriptionListResult:
    description: A list of service description objects with a next link.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of service description objects.
        type: string
        readOnly: true
      value:
        description: A list of service description objects.
        type: array
        items:
          $ref: '#/definitions/PrivateLinkServicesForSCCPowershellDescription'
  AtlasEntityHeader:
    type: object
    title: AtlasEntityHeader
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        classificationNames:
          type: array
          description: An array of classification names.
          items:
            type: string
        classifications:
          type: array
          description: An array of classifications.
          items:
            $ref: '#/definitions/AtlasClassification'
        displayText:
          type: string
          description: The display text.
        guid:
          type: string
          description: The GUID of the record.
        isIncomplete:
          readOnly: false
          description: Whether it is a shell entity
          type: boolean
        labels:
          readOnly: false
          description: labels
          type: array
          items:
            type: string
        meaningNames:
          type: array
          description: An array of meanings.
          items:
            type: string
        meanings:
          type: array
          description: An array of term assignment headers.
          items:
            $ref: '#/definitions/AtlasTermAssignmentHeader'
        status:
          $ref: '#/definitions/Status'
    description: An instance of an entity - like hive_table, hive_database.
  ErrorDetails:
    description: Error details.
    type: object
    properties:
      error:
        description: Object containing error details.
        $ref: '#/definitions/ErrorDetailsInternal'
  ErrorModel:
    description: Default error model
    type: object
    properties:
      code:
        description: Gets or sets the code.
        type: string
        readOnly: true
      details:
        description: Gets or sets the details.
        type: array
        items:
          $ref: '#/definitions/ErrorModel'
        readOnly: true
      message:
        description: Gets or sets the messages.
        type: string
        readOnly: true
      target:
        description: Gets or sets the target.
        type: string
        readOnly: true
  ServicesDescriptionListResult:
    description: A list of service description objects with a next link.
    type: object
    properties:
      nextLink:
        description: The link used to get the next page of service description objects.
        type: string
      value:
        description: A list of service description objects.
        type: array
        items:
          $ref: '#/definitions/ServicesDescription'
  CollectionReference:
    description: Reference to a Collection.
    type: object
    properties:
      referenceName:
        description: Gets or sets the reference name.
        type: string
      type:
        description: Gets or sets the reference type property.
        type: string
  CollectionNameResponseList:
    description: Paged list of collections.
    required:
    - value
    type: object
    properties:
      count:
        format: int64
        description: Total item count.
        type: integer
      nextLink:
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type results.
        type: array
        items:
          $ref: '#/definitions/CollectionNameResponse'
  ScanByCollectionList:
    required:
    - value
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/ScanByCollection'
      nextLink:
        type: string
      count:
        format: int64
        type: integer
  AtlasTermAssignmentHeader:
    type: object
    properties:
      confidence:
        type: integer
        format: int32
        description: The confidence of the term assignment.
      createdBy:
        type: string
        description: The user who created the record.
      description:
        type: string
        description: The description of the term assignment.
      displayText:
        type: string
        description: The display text.
      expression:
        type: string
        description: The expression of the term assignment.
      relationGuid:
        type: string
        description: The GUID of the relationship.
      source:
        type: string
        description: The source of the term.
      status:
        $ref: '#/definitions/AtlasTermAssignmentStatus'
      steward:
        type: string
        description: The steward of the term.
      termGuid:
        type: string
        description: The GUID of the term.
    title: AtlasTermAssignmentHeader
    description: The header for term assignment.
  Resource:
    description: The common properties of a service.
    properties:
      id:
        readOnly: true
        type: string
        description: The resource identifier.
      name:
        readOnly: true
        type: string
        description: The resource name.
        pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$
      type:
        readOnly: true
        type: string
        description: The resource type.
      kind:
        readOnly: false
        type: string
        description: 'The kind of the service. Valid values are: fhir, fhir-Stu3 and fhir-R4.'
        enum:
        - fhir
        - fhir-Stu3
        - fhir-R4
        x-ms-enum:
          name: kind
          modelAsString: false
      location:
        type: string
        description: The resource location.
        x-ms-mutability:
        - create
        - read
      tags:
        type: object
        additionalProperties:
          type: string
        description: The resource tags.
      etag:
        description: An etag associated with the resource, used for optimistic concurrency when editing it.
        type: string
      identity:
        type: object
        description: Setting indicating whether the service has a managed identity associated with it.
        properties:
          principalId:
            readOnly: true
            type: string
            description: The principal ID of the resource identity.
          tenantId:
            readOnly: true
            type: string
            description: The tenant ID of the resource.
          type:
            description: Type of identity being specified, currently SystemAssigned and None are allowed.
            type: string
            enum:
            - SystemAssigned
            - None
            x-ms-enum:
              name: ManagedServiceIdentityType
              modelAsString: true
    x-ms-azure-resource: true
    required:
    - location
    - kind
  AtlasEntitiesWithExtInfo:
    type: object
    title: AtlasEntitiesWithExtInfo
    allOf:
    - $ref: '#/definitions/AtlasEntityExtInfo'
    - properties:
        entities:
          type: array
          description: An array of entities.
          items:
            $ref: '#/definitions/AtlasEntity'
    description: An instance of an entity along with extended info - like hive_table, hive_database.
  AtlasTermAssignmentStatus:
    type: string
    title: AtlasTermAssignmentStatus
    description: The status of terms assignment.
    enum:
    - DISCOVERED
    - PROPOSED
    - IMPORTED
    - VALIDATED
    - DEPRECATED
    - OBSOLETE
    - OTHER
    x-ms-enum:
      name: AtlasTermAssignmentStatus
      modelAsString: true
  ErrorDetailsInternal:
    description: Error details.
    type: object
    properties:
      code:
        description: The error code.
        type: string
        readOnly: true
      message:
        description: The error message.
        type: string
        readOnly: true
      target:
        description: The target of the particular error.
        type: string
        readOnly: true
  AtlasStruct:
    type: object
    properties:
      attributes:
        type: object
        description: The attributes of the struct.
        additionalProperties: {}
      typeName:
        type: string
        description: The name of the type.
      lastModifiedTS:
        $ref: '#/definitions/LastModifiedTS'
    title: AtlasStruct
    description: Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
  ContactBasic:
    title: ContactBasic
    type: object
    properties:
      id:
        type: string
        description: Azure Active Directory object Id.
      info:
        type: string
        description: additional information to describe this contact.
  ServicesProperties:
    description: The properties of a service instance.
    type: object
    properties:
      provisioningState:
        description: The provisioning state.
        enum:
        - Deleting
        - Succeeded
        - Creating
        - Accepted
        - Verifying
        - Updating
        - Failed
        - Canceled
        - Deprovisioned
        type: string
        readOnly: true
        x-ms-enum:
          name: provisioningState
          modelAsString: true
      accessPolicies:
        $ref: '#/definitions/ServiceAccessPoliciesInfo'
        description: The access policies of the service instance.
      cosmosDbConfiguration:
        $ref: '#/definitions/ServiceCosmosDbConfigurationInfo'
        description: The settings for the Cosmos DB database backing the service.
      authenticationConfiguration:
        $ref: '#/definitions/ServiceAuthenticationConfigurationInfo'
        description: The authentication configuration for the service instance.
      corsConfiguration:
        $ref: '#/definitions/ServiceCorsConfigurationInfo'
        description: The settings for the CORS configuration of the service instance.
  CollectionList:
    description: Paged list of collections.
    required:
    - value
    type: object
    properties:
      count:
        format: int64
        description: Total item count.
        type: integer
      nextLink:
        description: The Url of next result page.
        type: string
      value:
        description: Collection of items of type results.
        type: array
        items:
          $ref: '#/definitions/Collection'
  CollectionNameResponse:
    description: Collection resource.
    type: object
    properties:
      friendlyName:
        description: Gets or sets the friendly name of the collection.
        type: string
        readOnly: true
      name:
        description: Gets the name.
        type: string
        readOnly: true
  ErrorModel_2:
    type: object
    properties:
      code:
        type: string
      message:
        type: string
      target:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/ErrorModel_2'
  AtlasEntityExtInfo:
    type: object
    properties:
      referredEntities:
        type: object
        description: The referred entities.
        additionalProperties:
          $ref: '#/definitions/AtlasEntity'
    title: AtlasEntityExtInfo
    description: An instance of an entity along with extended info - like hive_table, hive_database.
  ErrorResponseModel_2:
    type: object
    properties:
      error:
        allOf:
        - $ref: '#/definitions/ErrorModel_2'
  ServiceAccessPoliciesInfo:
    description: The access policies of the service instance.
    type: array
    items:
      $ref: '#/definitions/ServiceAccessPolicyEntry'
  Status:
    type: string
    title: Status
    description: Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.
    enum:
    - ACTIVE
    - DELETED
    x-ms-enum:
      name: Status
      modelAsString: true
  ServiceAuthenticationConfigurationInfo:
    description: Authentication configuration information
    type: object
    properties:
      authority:
        type: string
        description: The authority url for the service
        readOnly: false
      audience:
        type: string
        description: The audience url for the service
        readOnly: false
      smartProxyEnabled:
        type: boolean
        description: If the SMART on FHIR proxy is enabled
        readOnly: false
  MoveEntitiesRequest:
    type: object
    properties:
      entityGuids:
        type: array
        description: An array of entity guids to be moved to target collection.
        items:
          type: string
  AtlasClassification:
    type: object
    title: AtlasClassification
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        entityGuid:
          type: string
          description: The GUID of the entity.
        entityStatus:
          $ref: '#/definitions/Status'
        removePropagationsOnEntityDelete:
          type: boolean
          description: Determines if propagations will be removed on entity deletion.
        validityPeriods:
          type: array
          description: An array of time boundaries indicating validity periods.
          items:
            $ref: '#/definitions/TimeBoundary'
        source:
          type: string
          description: indicate the source who create the classification detail
        sourceDetails:
          type: object
          additionalProperties:
            type: object
            properties: {}
          description: more detail on source information
    description: An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
  ServiceCorsConfigurationInfo:
    description: The settings for the CORS configuration of the service instance.
    type: object
    properties:
      origins:
        type: array
        description: The origins to be allowed via CORS.
        readOnly: false
        items:
          $ref: '#/definitions/ServiceCorsConfigurationOriginEntry'
      headers:
        type: array
        description: The headers to be allowed via CORS.
        readOnly: false
        items:
          $ref: '#/definitions/ServiceCorsConfigurationHeaderEntry'
      methods:
        type: array
        description: The methods to be allowed via CORS.
        readOnly: false
        items:
          $ref: '#/definitions/ServiceCorsConfigurationMethodEntry'
      maxAge:
        type: integer
        description: The max age to be allowed via CORS.
        readOnly: false
        minimum: 0
        maximum: 99999
      allowCredentials:
        type: boolean
        description: If credentials are allowed via CORS.
        readOnly: false
  ServiceCorsConfigurationMethodEntry:
    description: A method for CORS.
    type: string
  AtlasEntity:
    type: object
    title: AtlasEntity
    allOf:
    - $ref: '#/definitions/AtlasStruct'
    - properties:
        businessAttributes:
          readOnly: false
          description: Business Attributes
          type: object
          additionalProperties:
            type: object
        classifications:
          type: array
          description: An array of classifications.
          items:
            $ref: '#/definitions/AtlasClassification'
        createTime:
          type: integer
          format: int64
          description: The created time of the record.
        createdBy:
          type: string
          description: The user who created the record.
        customAttributes:
          readOnly: false
          description: Custom Attribute
          type: object
          additionalProperties:
            type: string
        guid:
          type: string
          description: The GUID of the entity.
        homeId:
          type: string
          description: The home ID of the entity.
        collectionId:
          type: string
          description: The collection ID of the entity.
        isIncomplete:
          readOnly: false
          description: Whether it is a shell entity
          type: boolean
        labels:
          readOnly: false
          description: labels
          type: array
          items:
            type: string
        meanings:
          type: array
          description: An array of term assignment headers indicating the meanings of the entity.
          items:
            $ref: '#/definitions/AtlasTermAssignmentHeader'
        provenanceType:
          readOnly: false
          description: Used to record the provenance of an instance of an entity or relationship.
          type: number
        proxy:
          type: boolean
          description: Determines if there's a proxy.
        relationshipAttributes:
          type: object
          description: The attributes of relationship.
          additionalProperties: {}
        status:
          $ref: '#/definitions/Status'
        updateTime:
          type: integer
          format: int64
          description: The update time of the record.
        updatedBy:
          type: string
          description: The user who updated the record.
        version:
          type: number
          description: The version of the entity.
        source:
          type: string
          description: indicate the source who create the classification detail
        sourceDetails:
          type: object
          additionalProperties:
            type: object
            properties: {}
          description: more detail on source information
        contacts:
          type: object
          description: The dictionary of contacts for entities. Key could be Expert or Owner.
          additionalProperties:
            type: array
            items:
              $ref: '#/definitions/ContactBasic'
    description: An instance of an entity - like hive_table, hive_database.
  PrivateLinkServicesForSCCPowershellDescription:
    description: The description of the service.
    type: object
    properties:
      properties:
        x-ms-client-flatten: false
        description: The common properties of a service.
        $ref: ./common-types.json#/definitions/ServicesProperties
    allOf:
    - $ref: ./common-types.json#/definitions/ServicesResource
  ErrorResponse:
    description: An error response from the service
    type: object
    properties:
      requestId:
        type: string
        description: The request ID.
      errorCode:
        type: string
        description: The error code.
      errorMessage:
        type: string
        description: The error message.
  TimeBoundary:
    type: object
    properties:
      endTime:
        type: string
        description: The end of the time boundary.
      startTime:
        type: string
        description: The start of the time boundary.
      timeZone:
        type: string
        description: The timezone of the time boundary.
    title: TimeBoundary
    description: Captures time-boundary details
  ServiceCorsConfigurationHeaderEntry:
    description: A header for CORS.
    type: string
  EntityMutationResponse:
    type: object
    properties:
      guidAssignments:
        type: object
        description: A map of GUID assignments with entities.
        additionalProperties:
          type: string
      mutatedEntities:
        type: object
        description: The entity headers of mutated entities.
        additionalProperties:
          type: array
          items:
            $ref: '#/definitions/AtlasEntityHeader'
      partialUpdatedEntities:
        type: array
        description: An array of entity headers that partially updated.
        items:
          $ref: '#/definitions/AtlasEntityHeader'
    title: EntityMutationResponse
    description: The mutation response of entity.
  AtlasEntityWithExtInfo:
    type: object
    title: AtlasEntityWithExtInfo
    allOf:
    - $ref: '#/definitions/AtlasEntityExtInfo'
    - properties:
        entity:
          $ref: '#/definitions/AtlasEntity'
    description: An instance of an entity along with extended info - like hive_table, hive_database.
  ErrorResponseModel:
    description: Default error response model
    type: object
    properties:
      error:
        $ref: '#/definitions/ErrorModel'
  ServicesDescription:
    description: The description of the service.
    type: object
    properties:
      properties:
        x-ms-client-flatten: false
        description: The common properties of a service.
        $ref: '#/definitions/ServicesProperties'
    allOf:
    - $ref: '#/definitions/Resource'
  ServiceCosmosDbConfigurationInfo:
    description: The settings for the Cosmos DB database backing the service.
    type: object
    properties:
      offerThroughput:
        type: integer
        description: The provisioned throughput for the backing database.
        readOnly: false
        minimum: 400
        maximum: 10000
  ScanByCollection:
    type: object
    properties:
      collectionName:
        type: string
      dataSourceName:
        type: string
      dataSourceType:
        enum:
        - None
        - AzureSubscription
        - AzureResourceGroup
        - AzureSynapseWorkspace
        - AzureSynapse
        - AdlsGen1
        - AdlsGen2
        - AmazonAccount
        - AmazonS3
        - AmazonSql
        - AzureCosmosDb
        - AzureDataExplorer
        - AzureFileService
        - AzureSqlDatabase
        - AmazonPostgreSql
        - AzurePostgreSql
        - SqlServerDatabase
        - AzureSqlDatabaseManagedInstance
        - AzureSqlDataWarehouse
        - AzureMySql
        - AzureStorage
        - Teradata
        - Oracle
        - SapS4Hana
        - SapEcc
        - PowerBI
        type: string
        x-ms-enum:
          name: DataSourceType
          modelAsString: true
      scanName:
        type: string
  CollectionPathResponse:
    description: Collection resource.
    type: object
    properties:
      parentFriendlyNameChain:
        description: The friendly names of ancestors starting from the default (root) collection and ending with the immediate parent.
        type: array
        items:
          type: string
        readOnly: true
      parentNameChain:
        description: The names of ancestors starting from the default (root) collection and ending with the immediate parent.
        type: array
        items:
          type: string
        readOnly: true
  Collection:
    description: Collection resource.
    type: object
    properties:
      collectionProvisioningState:
        description: Gets the state of the provisioning.
        enum:
        - Unknown
        - Creating
        - Moving
        - Deleting
        - Failed
        - Succeeded
        type: string
        readOnly: true
        x-ms-enum:
          name: CollectionProvisioningState
          modelAsString: true
      description:
        description: Gets or sets the description.
        type: string
      domain:
        description: Gets the domain.
        type: string
        readOnly: true
      friendlyName:
        description: Gets or sets the friendly name of the collection.
        type: string
      name:
        description: Gets the name.
        type: string
        readOnly: true
      parentCollection:
        $ref: '#/definitions/CollectionReference'
      systemData:
        $ref: '#/definitions/SystemData'
  SystemData:
    description: Metadata pertaining to creation and last modification of the resource.
    type: object
    properties:
      createdAt:
        format: date-time
        description: The timestamp of resource creation (UTC).
        type: string
        readOnly: true
      createdBy:
        description: The identity that created the resource.
        type: string
        readOnly: true
      createdByType:
        description: The type of identity that created the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        type: string
        readOnly: true
        x-ms-enum:
          name: IdentityType
          modelAsString: true
      lastModifiedAt:
        format: date-time
        description: The timestamp of the last modification the resource (UTC).
        type: string
        readOnly: true
      lastModifiedBy:
        description: The identity that last modified the resource.
        type: string
        readOnly: true
      lastModifiedByType:
        description: The type of identity that last modified the resource.
        enum:
        - User
        - Application
        - ManagedIdentity
        - Key
        type: string
        readOnly: true
        x-ms-enum:
          name: IdentityType
          modelAsString: true
parameters:
  resourceGroupName:
    name: resourceGroupName
    in: path
    description: The name of the resource group that contains the service instance.
    required: true
    type: string
    x-ms-parameter-location: method
    pattern: ^[-\w\._\(\)]+$
    minLength: 1
    maxLength: 90
  api-version:
    in: query
    name: api-version
    description: The api version to use.
    required: true
    type: string
    x-ms-client-name: ApiVersion
  subscriptionId:
    name: subscriptionId
    in: path
    description: The subscription identifier.
    required: true
    type: string
  collection:
    name: collection
    description: the collection unique name
    in: path
    required: true
    type: string
    x-ms-parameter-location: method
  api-version_2:
    name: api-version
    enum:
    - 2018-08-20-preview
    in: query
    description: The version of the API.
    required: true
    type: string
    minLength: 10
  purviewAPIVersion:
    name: api-version
    description: Version of Purview APIs
    in: query
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'