swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector ConfigurationNames API
schemes:
- https
tags:
- name: ConfigurationNames
paths:
  /providers/Microsoft.ServiceLinker/configurationNames:
    get:
      tags:
      - ConfigurationNames
      operationId: microsoftAzureConfigurationnamesList
      description: Lists the configuration names generated by Service Connector for all target, client types, auth types.
      x-ms-examples:
        GetConfigurationNames:
          $ref: ./examples/ConfigurationNamesList.json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - name: $filter
        in: query
        required: false
        type: string
        description: OData filter options.
      - name: $skipToken
        in: query
        required: false
        type: string
        description: OData skipToken option for pagination.
      responses:
        '200':
          description: OK. The request has succeeded.
          schema:
            $ref: '#/definitions/ConfigurationNameResult'
        default:
          description: Error response describing why the operation failed.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Providers Microsoft Servicelinker Configurationnames
definitions:
  ConfigurationNames:
    type: object
    description: The configuration names which will be set based on specific target resource, client type, auth type.
    properties:
      targetService:
        type: string
        description: The target service provider name and resource name.
      clientType:
        $ref: '#/definitions/ClientType'
        description: The client type for configuration names.
      authType:
        $ref: '#/definitions/AuthType'
        description: The auth type.
      secretType:
        $ref: '#/definitions/SecretSourceType'
        description: Indicates where the secrets in configuration from. Used when secrets are from Keyvault.
      daprProperties:
        description: 'Deprecated, please use #/definitions/DaprConfigurationList instead'
        $ref: '#/definitions/DaprProperties'
      names:
        type: array
        description: The configuration names to be set in compute service environment.
        items:
          $ref: '#/definitions/ConfigurationName'
  ClientType:
    description: The application client type
    type: string
    enum:
    - none
    - dotnet
    - java
    - python
    - go
    - php
    - ruby
    - django
    - nodejs
    - springBoot
    - kafka-springBoot
    - jms-springBoot
    - dapr
    x-ms-enum:
      name: clientType
      modelAsString: true
  ConfigurationNameResult:
    description: Configuration Name list which will be set based on different target resource, client type, auth type.
    type: object
    properties:
      value:
        description: Expected configuration names for each target service.
        type: array
        items:
          $ref: '#/definitions/ConfigurationNameItem'
        x-ms-identifiers: []
      nextLink:
        description: Link to next page of resources.
        type: string
        readOnly: true
  ConfigurationNameItem:
    type: object
    properties:
      properties:
        x-nullable: true
        description: The result detail.
        x-ms-client-flatten: true
        $ref: '#/definitions/ConfigurationNames'
  AuthType:
    description: The authentication type.
    type: string
    enum:
    - systemAssignedIdentity
    - userAssignedIdentity
    - servicePrincipalSecret
    - servicePrincipalCertificate
    - secret
    - accessKey
    - userAccount
    - easyAuthMicrosoftEntraID
    x-ms-enum:
      name: AuthType
      modelAsString: true
  DaprProperties:
    type: object
    description: Indicates some additional properties for dapr client type
    properties:
      version:
        x-nullable: true
        type: string
        description: The dapr component version
      componentType:
        x-nullable: true
        type: string
        description: The dapr component type
      secretStoreComponent:
        x-nullable: true
        type: string
        description: The name of a secret store dapr to retrieve secret
      metadata:
        description: Additional dapr metadata
        type: array
        items:
          $ref: '#/definitions/DaprMetadata'
        x-ms-identifiers:
        - name
      scopes:
        description: The dapr component scopes
        type: array
        items:
          type: string
      runtimeVersion:
        x-nullable: true
        type: string
        readOnly: true
        description: The runtime version supported by the properties
      bindingComponentDirection:
        x-nullable: true
        type: string
        enum:
        - input
        - output
        x-ms-enum:
          name: DaprBindingComponentDirection
          modelAsString: true
        readOnly: true
        description: The direction supported by the dapr binding component
  SecretSourceType:
    description: The type of secret source.
    type: string
    enum:
    - rawValue
    - keyVaultSecret
    x-ms-enum:
      name: SecretSourceType
      modelAsString: true
  ConfigurationName:
    type: object
    description: The configuration names.
    properties:
      value:
        type: string
      description:
        type: string
        description: Description for the configuration name.
      required:
        type: boolean
        description: Represent the configuration is required or not
  DaprMetadata:
    description: The dapr component metadata.
    type: object
    properties:
      name:
        description: Metadata property name.
        type: string
      value:
        description: Metadata property value.
        type: string
      secretRef:
        description: The secret name where dapr could get value
        type: string
      description:
        description: The description of the metadata, returned from configuration api
        type: string
      required:
        description: The value indicating whether the metadata is required or not
        type: string
        enum:
        - 'true'
        - 'false'
        x-ms-enum:
          name: DaprMetadataRequired
          modelAsString: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'