swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector AssetEndpointProfiles API
schemes:
- https
tags:
- name: AssetEndpointProfiles
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles:
    get:
      operationId: microsoftAzureAssetendpointprofilesListbysubscription
      tags:
      - AssetEndpointProfiles
      description: List AssetEndpointProfile resources by subscription ID
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AssetEndpointProfileListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Asset Endpoint Profiles in a Subscription.:
          $ref: ./examples/List_AssetEndpointProfiles_Subscription.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Deviceregistry Assetendpointprofiles
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles
  : get:
      operationId: microsoftAzureAssetendpointprofilesListbyresourcegroup
      tags:
      - AssetEndpointProfiles
      description: List AssetEndpointProfile resources by resource group
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AssetEndpointProfileListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        List Asset Endpoint Profiles in a Resource Group.:
          $ref: ./examples/List_AssetEndpointProfiles_ResourceGroup.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assetendpointprofiles
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeviceRegistry/assetEndpointProfiles/{assetEndpointProfileName}
  : get:
      operationId: microsoftAzureAssetendpointprofilesGet
      tags:
      - AssetEndpointProfiles
      description: Get a AssetEndpointProfile
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: assetEndpointProfileName
        in: path
        description: Asset Endpoint Profile name parameter.
        required: true
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AssetEndpointProfile'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Get an Asset Endpoint Profile.:
          $ref: ./examples/Get_AssetEndpointProfile.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assetendpointprofiles Assetendpointprofilename
    put:
      operationId: microsoftAzureAssetendpointprofilesCreateorreplace
      tags:
      - AssetEndpointProfiles
      description: Create a AssetEndpointProfile
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: assetEndpointProfileName
        in: path
        description: Asset Endpoint Profile name parameter.
        required: true
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/AssetEndpointProfile'
      responses:
        '200':
          description: Resource 'AssetEndpointProfile' update operation succeeded
          schema:
            $ref: '#/definitions/AssetEndpointProfile'
        '201':
          description: Resource 'AssetEndpointProfile' create operation succeeded
          schema:
            $ref: '#/definitions/AssetEndpointProfile'
          headers:
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Create an Asset Endpoint Profile.:
          $ref: ./examples/Create_AssetEndpointProfile.json
      x-ms-long-running-operation-options:
        final-state-via: azure-async-operation
      x-ms-long-running-operation: true
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assetendpointprofiles Assetendpointprofilename
    patch:
      operationId: microsoftAzureAssetendpointprofilesUpdate
      tags:
      - AssetEndpointProfiles
      description: Update a AssetEndpointProfile
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: assetEndpointProfileName
        in: path
        description: Asset Endpoint Profile name parameter.
        required: true
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/AssetEndpointProfileUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/AssetEndpointProfile'
        '202':
          description: Resource update request accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Patch an Asset Endpoint Profile.:
          $ref: ./examples/Update_AssetEndpointProfile.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assetendpointprofiles Assetendpointprofilename
    delete:
      operationId: microsoftAzureAssetendpointprofilesDelete
      tags:
      - AssetEndpointProfiles
      description: Delete a AssetEndpointProfile
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: assetEndpointProfileName
        in: path
        description: Asset Endpoint Profile name parameter.
        required: true
        type: string
        minLength: 3
        maxLength: 63
        pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
      responses:
        '202':
          description: Resource deletion accepted.
          headers:
            Location:
              type: string
              description: The Location header contains the URL where the status of the long running operation can be checked.
            Retry-After:
              type: integer
              format: int32
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
        '204':
          description: Resource does not exist.
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Delete an Asset Endpoint Profile.:
          $ref: ./examples/Delete_AssetEndpointProfile.json
      x-ms-long-running-operation-options:
        final-state-via: location
      x-ms-long-running-operation: true
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Deviceregistry Assetendpointprofiles Assetendpointprofilename
definitions:
  AssetEndpointProfileProperties:
    type: object
    description: Defines the Asset Endpoint Profile properties.
    properties:
      uuid:
        type: string
        description: Globally unique, immutable, non-reusable id.
        readOnly: true
      targetAddress:
        type: string
        format: uri
        description: The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
      userAuthentication:
        $ref: '#/definitions/UserAuthentication'
        description: Defines the client authentication mechanism to the server.
      transportAuthentication:
        $ref: '#/definitions/TransportAuthentication'
        description: Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.
      additionalConfiguration:
        type: string
        description: Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Provisioning state of the resource.
        readOnly: true
    required:
    - targetAddress
  AssetEndpointProfileListResult:
    type: object
    description: The response of a AssetEndpointProfile list operation.
    properties:
      value:
        type: array
        description: The AssetEndpointProfile items on this page
        items:
          $ref: '#/definitions/AssetEndpointProfile'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  TransportAuthenticationUpdate:
    type: object
    description: Definition of the authentication mechanism for the southbound connector.
    properties:
      ownCertificates:
        type: array
        description: Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.
        items:
          $ref: '#/definitions/OwnCertificate'
        x-ms-identifiers: []
  X509CredentialsUpdate:
    type: object
    description: The x509 certificate for authentication mode Certificate.
    properties:
      certificateReference:
        type: string
        description: A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
  UsernamePasswordCredentials:
    type: object
    description: The credentials for authentication mode UsernamePassword.
    properties:
      usernameReference:
        type: string
        description: A reference to secret containing the username.
      passwordReference:
        type: string
        description: A reference to secret containing the password.
    required:
    - usernameReference
    - passwordReference
  UsernamePasswordCredentialsUpdate:
    type: object
    description: The credentials for authentication mode UsernamePassword.
    properties:
      usernameReference:
        type: string
        description: A reference to secret containing the username.
      passwordReference:
        type: string
        description: A reference to secret containing the password.
  ProvisioningState:
    type: string
    description: The provisioning status of the resource.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Accepted
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Succeeded
        value: Succeeded
        description: Resource has been created.
      - name: Failed
        value: Failed
        description: Resource creation failed.
      - name: Canceled
        value: Canceled
        description: Resource creation was canceled.
      - name: Accepted
        value: Accepted
        description: Resource has been accepted by the server.
    readOnly: true
  TransportAuthentication:
    type: object
    description: Definition of the authentication mechanism for the southbound connector.
    properties:
      ownCertificates:
        type: array
        description: Defines a reference to a secret which contains all certificates and private keys that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.
        items:
          $ref: '#/definitions/OwnCertificate'
        x-ms-identifiers: []
    required:
    - ownCertificates
  X509Credentials:
    type: object
    description: The x509 certificate for authentication mode Certificate.
    properties:
      certificateReference:
        type: string
        description: A reference to secret containing the certificate and private key (e.g. stored as .der/.pem or .der/.pfx).
    required:
    - certificateReference
  OwnCertificate:
    type: object
    description: Certificate or private key that can be used by the southbound connector connecting to the shop floor/OT device. The accepted extensions are .der for certificates and .pfx/.pem for private keys.
    properties:
      certThumbprint:
        type: string
        description: Certificate thumbprint.
      certSecretReference:
        type: string
        description: Secret Reference name (cert and private key).
      certPasswordReference:
        type: string
        description: Secret Reference Name (Pfx or Pem password).
  UserAuthenticationUpdate:
    type: object
    description: Definition of the client authentication mechanism to the server.
    properties:
      mode:
        type: string
        description: Defines the mode to authenticate the user of the client at the server.
        default: Certificate
        enum:
        - Anonymous
        - Certificate
        - UsernamePassword
        x-ms-enum:
          name: UserAuthenticationMode
          modelAsString: true
          values:
          - name: Anonymous
            value: Anonymous
            description: The user authentication mode is anonymous.
          - name: Certificate
            value: Certificate
            description: The user authentication mode is an x509 certificate.
          - name: UsernamePassword
            value: UsernamePassword
            description: The user authentication mode is a username and password.
      usernamePasswordCredentials:
        $ref: '#/definitions/UsernamePasswordCredentialsUpdate'
        description: Defines the username and password references when UsernamePassword user authentication mode is selected.
      x509Credentials:
        $ref: '#/definitions/X509CredentialsUpdate'
        description: Defines the certificate reference when Certificate user authentication mode is selected.
  ExtendedLocation:
    type: object
    description: The extended location.
    properties:
      type:
        type: string
        description: The extended location type.
      name:
        type: string
        description: The extended location name.
    required:
    - type
    - name
  AssetEndpointProfileUpdate:
    type: object
    description: The type used for update operations of the AssetEndpointProfile.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/AssetEndpointProfileUpdateProperties'
        x-ms-client-flatten: true
  AssetEndpointProfile:
    type: object
    description: Asset Endpoint Profile definition.
    properties:
      properties:
        $ref: '#/definitions/AssetEndpointProfileProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
      extendedLocation:
        $ref: '#/definitions/ExtendedLocation'
        description: The extended location.
        x-ms-mutability:
        - read
        - create
    required:
    - extendedLocation
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  AssetEndpointProfileUpdateProperties:
    type: object
    description: The updatable properties of the AssetEndpointProfile.
    properties:
      targetAddress:
        type: string
        format: uri
        description: The local valid URI specifying the network address/DNS name of a southbound device. The scheme part of the targetAddress URI specifies the type of the device. The additionalConfiguration field holds further connector type specific configuration.
      userAuthentication:
        $ref: '#/definitions/UserAuthenticationUpdate'
        description: Defines the client authentication mechanism to the server.
      transportAuthentication:
        $ref: '#/definitions/TransportAuthenticationUpdate'
        description: Defines the authentication mechanism for the southbound connector connecting to the shop floor/OT device.
      additionalConfiguration:
        type: string
        description: Contains connectivity type specific further configuration (e.g. OPC UA, Modbus, ONVIF).
  UserAuthentication:
    type: object
    description: Definition of the client authentication mechanism to the server.
    properties:
      mode:
        type: string
        description: Defines the mode to authenticate the user of the client at the server.
        default: Certificate
        enum:
        - Anonymous
        - Certificate
        - UsernamePassword
        x-ms-enum:
          name: UserAuthenticationMode
          modelAsString: true
          values:
          - name: Anonymous
            value: Anonymous
            description: The user authentication mode is anonymous.
          - name: Certificate
            value: Certificate
            description: The user authentication mode is an x509 certificate.
          - name: UsernamePassword
            value: UsernamePassword
            description: The user authentication mode is a username and password.
      usernamePasswordCredentials:
        $ref: '#/definitions/UsernamePasswordCredentials'
        description: Defines the username and password references when UsernamePassword user authentication mode is selected.
      x509Credentials:
        $ref: '#/definitions/X509Credentials'
        description: Defines the certificate reference when Certificate user authentication mode is selected.
    required:
    - mode
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'