swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BrokerAuthentication API
schemes:
- https
tags:
- name: BrokerAuthentication
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authentication
  : get:
      operationId: microsoftAzureBrokerauthenticationListbybrokerresource
      tags:
      - BrokerAuthentication
      description: List BrokerAuthenticationResource resources by BrokerResource
      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: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/BrokerAuthenticationResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BrokerAuthentication_ListByBrokerResource:
          $ref: ./examples/BrokerAuthentication_ListByBrokerResource_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authentication
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authentication/{authenticationName}
  : get:
      operationId: microsoftAzureBrokerauthenticationGet
      tags:
      - BrokerAuthentication
      description: Get a BrokerAuthenticationResource
      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: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: authenticationName
        in: path
        description: Name of MQ broker/authentication resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/BrokerAuthenticationResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BrokerAuthentication_Get:
          $ref: ./examples/BrokerAuthentication_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authentication Authenticationname
    put:
      operationId: microsoftAzureBrokerauthenticationCreateorupdate
      tags:
      - BrokerAuthentication
      description: Create a BrokerAuthenticationResource
      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: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: authenticationName
        in: path
        description: Name of MQ broker/authentication resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: resource
        in: body
        description: Resource create parameters.
        required: true
        schema:
          $ref: '#/definitions/BrokerAuthenticationResource'
      responses:
        '200':
          description: Resource 'BrokerAuthenticationResource' update operation succeeded
          schema:
            $ref: '#/definitions/BrokerAuthenticationResource'
        '201':
          description: Resource 'BrokerAuthenticationResource' create operation succeeded
          schema:
            $ref: '#/definitions/BrokerAuthenticationResource'
          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:
        BrokerAuthentication_CreateOrUpdate:
          $ref: ./examples/BrokerAuthentication_CreateOrUpdate_MaximumSet_Gen.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 Iotoperationsmq Mq Mqname Broker Brokername Authentication Authenticationname
    patch:
      operationId: microsoftAzureBrokerauthenticationUpdate
      tags:
      - BrokerAuthentication
      description: Update a BrokerAuthenticationResource
      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: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: authenticationName
        in: path
        description: Name of MQ broker/authentication resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: properties
        in: body
        description: The resource properties to be updated.
        required: true
        schema:
          $ref: '#/definitions/BrokerAuthenticationResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/BrokerAuthenticationResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BrokerAuthentication_Update:
          $ref: ./examples/BrokerAuthentication_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authentication Authenticationname
    delete:
      operationId: microsoftAzureBrokerauthenticationDelete
      tags:
      - BrokerAuthentication
      description: Delete a BrokerAuthenticationResource
      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: mqName
        in: path
        description: Name of MQ resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: brokerName
        in: path
        description: Name of MQ broker resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      - name: authenticationName
        in: path
        description: Name of MQ broker/authentication resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      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:
        BrokerAuthentication_Delete:
          $ref: ./examples/BrokerAuthentication_Delete_MaximumSet_Gen.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 Iotoperationsmq Mq Mqname Broker Brokername Authentication Authenticationname
definitions:
  BrokerAuthenticationResource:
    type: object
    description: MQ broker/authentication resource
    properties:
      properties:
        $ref: '#/definitions/BrokerAuthenticationProperties'
        description: The resource-specific properties for this resource.
        x-ms-client-flatten: true
        x-ms-mutability:
        - read
        - create
      extendedLocation:
        $ref: '#/definitions/ExtendedLocationProperty'
        description: Extended Location
        x-ms-mutability:
        - read
        - create
    required:
    - extendedLocation
    allOf:
    - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource
  KeyVaultCertificateProperties:
    type: object
    description: KeyVault certificate properties
    properties:
      vault:
        $ref: '#/definitions/KeyVaultConnectionProperties'
        description: KeyVault properties.
      vaultCaChainSecret:
        $ref: '#/definitions/KeyVaultSecretObject'
        description: KeyVault CA chain secret details.
      vaultCert:
        $ref: '#/definitions/KeyVaultSecretObject'
        description: KeyVault Cert secret details.
    required:
    - vault
    - vaultCert
  BrokerAuthenticatorCustomAuthX509:
    type: object
    description: X509 Custom Authentication properties. NOTE - Enum only authenticator type supported at a time.
    properties:
      keyVault:
        $ref: '#/definitions/KeyVaultCertificateProperties'
        description: Keyvault X509 secret properties.
      secretName:
        type: string
        description: Secret where cert details are stored.
  BrokerAuthenticatorMethodSvid:
    type: object
    description: SVID for BrokerAuthentication
    properties:
      agentSocketPath:
        type: string
        description: Mounted socket path for spiffe agent.
      identityMaxRetry:
        type: integer
        format: int64
        description: Maximum number of re-tries to fetch identity.
        default: 3
        minimum: 0
        maximum: 4294967295
      identityWaitRetryMs:
        type: integer
        format: int64
        description: Maximum time to wait before fetching identity again.
        default: 5000
        minimum: 0
        maximum: 9223372036854000000
    required:
    - agentSocketPath
  BrokerAuthenticationResourceUpdate:
    type: object
    description: The type used for update operations of the BrokerAuthenticationResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/BrokerAuthenticationResourceUpdateProperties'
        x-ms-client-flatten: true
  BrokerAuthenticationProperties:
    type: object
    description: Broker Resource properties
    properties:
      authenticationMethods:
        type: array
        description: The list of authentication methods supported by the Authentication Resource. For each array element, NOTE - Enum only authenticator type supported.
        items:
          $ref: '#/definitions/BrokerAuthenticatorMethods'
        x-ms-identifiers: []
      listenerRef:
        type: array
        description: The array of listener Resources it supports.
        items:
          type: string
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
    required:
    - authenticationMethods
    - listenerRef
  BrokerAuthenticatorCustomAuth:
    type: object
    description: Custom Authentication properties
    properties:
      x509:
        $ref: '#/definitions/BrokerAuthenticatorCustomAuthX509'
        description: X509 Custom Auth type details.
    required:
    - x509
  BrokerAuthenticatorMethodUsernamePassword:
    type: object
    description: UsernamePassword for BrokerAuthentication
    properties:
      keyVault:
        $ref: '#/definitions/KeyVaultSecretProperties'
        description: Keyvault username password secret properties.
      secretName:
        type: string
        description: Secret where username and password are stored.
  KeyVaultSecretProperties:
    type: object
    description: KeyVault secret properties
    properties:
      vault:
        $ref: '#/definitions/KeyVaultConnectionProperties'
        description: KeyVault properties.
      vaultSecret:
        $ref: '#/definitions/KeyVaultSecretObject'
        description: KeyVault secret details.
    required:
    - vault
    - vaultSecret
  BrokerAuthenticationResourceListResult:
    type: object
    description: The response of a BrokerAuthenticationResource list operation.
    properties:
      value:
        type: array
        description: The BrokerAuthenticationResource items on this page
        items:
          $ref: '#/definitions/BrokerAuthenticationResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  BrokerAuthenticatorMethodSat:
    type: object
    description: Service Account Token for BrokerAuthentication
    properties:
      audiences:
        type: array
        description: List of allowed audience.
        items:
          type: string
    required:
    - audiences
  ExtendedLocationProperty:
    type: object
    description: ExtendedLocation properties
    properties:
      name:
        type: string
        description: The name of the extended location.
      type:
        $ref: '#/definitions/ExtendedLocationType'
        description: Type of ExtendedLocation.
    required:
    - name
    - type
  KeyVaultCredentialsProperties:
    type: object
    description: KeyVault credentials properties. NOTE - Future this will be ENUM.
    properties:
      servicePrincipalLocalSecretName:
        type: string
        description: KeyVault service principal local secret name.
    required:
    - servicePrincipalLocalSecretName
  BrokerAuthenticationResourceUpdateProperties:
    type: object
    description: The updatable properties of the BrokerAuthenticationResource.
    properties:
      authenticationMethods:
        type: array
        description: The list of authentication methods supported by the Authentication Resource. For each array element, NOTE - Enum only authenticator type supported.
        items:
          $ref: '#/definitions/BrokerAuthenticatorMethods'
        x-ms-identifiers: []
      listenerRef:
        type: array
        description: The array of listener Resources it supports.
        items:
          type: string
  BrokerAuthenticatorMethodCustom:
    type: object
    description: Custom method for BrokerAuthentication
    properties:
      auth:
        $ref: '#/definitions/BrokerAuthenticatorCustomAuth'
        description: Custom Broker Authentication Method.
      caCertConfigMap:
        type: string
        description: CA cert config map to use.
      endpoint:
        type: string
        description: Endpoint to connect to.
      headers:
        type: object
        description: Configuration Headers to use.
        additionalProperties:
          type: string
    required:
    - endpoint
  BrokerAuthenticatorMethodX509:
    type: object
    description: X509 for BrokerAuthentication.
    properties:
      attributes:
        $ref: '#/definitions/BrokerAuthenticatorMethodX509Attributes'
        description: K8S Secret name to mount for username and password.
      trustedClientCaCertConfigMap:
        type: string
        description: Trusted client ca cert config map.
        default: client-ca
  KeyVaultConnectionProperties:
    type: object
    description: KeyVault properties
    properties:
      credentials:
        $ref: '#/definitions/KeyVaultCredentialsProperties'
        description: KeyVault credentials.
      directoryId:
        type: string
        description: KeyVault directoryId.
      name:
        type: string
        description: KeyVault name.
    required:
    - credentials
    - directoryId
    - name
  BrokerAuthenticatorMethodX509Attributes:
    type: object
    description: BrokerAuthenticatorMethodX509Attributes properties. NOTE - Enum only type supported at a time.
    properties:
      keyVault:
        $ref: '#/definitions/KeyVaultSecretProperties'
        description: Keyvault x509 attributes secret properties.
      secretName:
        type: string
        description: Secret where x509 attributes are stored.
  KeyVaultSecretObject:
    type: object
    description: KeyVault secret object properties
    properties:
      name:
        type: string
        description: KeyVault secret name.
      version:
        type: string
        description: KeyVault secret version.
    required:
    - name
  ProvisioningState:
    type: string
    description: The enum defining status of resource.
    enum:
    - Succeeded
    - Failed
    - Canceled
    - Provisioning
    - Updating
    - Deleting
    - 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: Provisioning
        value: Provisioning
        description: Resource is getting provisioned.
      - name: Updating
        value: Updating
        description: Resource is Updating.
      - name: Deleting
        value: Deleting
        description: Resource is Deleting.
      - name: Accepted
        value: Accepted
        description: Resource has been Accepted.
  ExtendedLocationType:
    type: string
    description: The enum defining type of ExtendedLocation accepted.
    enum:
    - CustomLocation
    x-ms-enum:
      name: ExtendedLocationType
      modelAsString: true
      values:
      - name: CustomLocation
        value: CustomLocation
        description: CustomLocation type
  BrokerAuthenticatorMethods:
    type: object
    description: Collection of different CrdAuthenticator methods of Broker Resource. NOTE Enum - Only one method is supported for each entry.
    properties:
      custom:
        $ref: '#/definitions/BrokerAuthenticatorMethodCustom'
        description: Custom Authentication Method.
      sat:
        $ref: '#/definitions/BrokerAuthenticatorMethodSat'
        description: Service Account Token Method.
      svid:
        $ref: '#/definitions/BrokerAuthenticatorMethodSvid'
        description: Service Account Token Method.
      usernamePassword:
        $ref: '#/definitions/BrokerAuthenticatorMethodUsernamePassword'
        description: UsernamePassword Method.
      x509:
        $ref: '#/definitions/BrokerAuthenticatorMethodX509'
        description: X509 Method.
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'