swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector BrokerAuthorization API
schemes:
- https
tags:
- name: BrokerAuthorization
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authorization
  : get:
      operationId: microsoftAzureBrokerauthorizationListbybrokerresource
      tags:
      - BrokerAuthorization
      description: List BrokerAuthorizationResource 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/BrokerAuthorizationResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BrokerAuthorization_ListByBrokerResource:
          $ref: ./examples/BrokerAuthorization_ListByBrokerResource_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authorization
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/broker/{brokerName}/authorization/{authorizationName}
  : get:
      operationId: microsoftAzureBrokerauthorizationGet
      tags:
      - BrokerAuthorization
      description: Get a BrokerAuthorizationResource
      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: authorizationName
        in: path
        description: Name of MQ broker/authorization resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/BrokerAuthorizationResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BrokerAuthorization_Get:
          $ref: ./examples/BrokerAuthorization_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authorization Authorizationname
    put:
      operationId: microsoftAzureBrokerauthorizationCreateorupdate
      tags:
      - BrokerAuthorization
      description: Create a BrokerAuthorizationResource
      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: authorizationName
        in: path
        description: Name of MQ broker/authorization 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/BrokerAuthorizationResource'
      responses:
        '200':
          description: Resource 'BrokerAuthorizationResource' update operation succeeded
          schema:
            $ref: '#/definitions/BrokerAuthorizationResource'
        '201':
          description: Resource 'BrokerAuthorizationResource' create operation succeeded
          schema:
            $ref: '#/definitions/BrokerAuthorizationResource'
          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:
        BrokerAuthorization_CreateOrUpdate:
          $ref: ./examples/BrokerAuthorization_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 Authorization Authorizationname
    patch:
      operationId: microsoftAzureBrokerauthorizationUpdate
      tags:
      - BrokerAuthorization
      description: Update a BrokerAuthorizationResource
      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: authorizationName
        in: path
        description: Name of MQ broker/authorization 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/BrokerAuthorizationResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/BrokerAuthorizationResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        BrokerAuthorization_Update:
          $ref: ./examples/BrokerAuthorization_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Broker Brokername Authorization Authorizationname
    delete:
      operationId: microsoftAzureBrokerauthorizationDelete
      tags:
      - BrokerAuthorization
      description: Delete a BrokerAuthorizationResource
      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: authorizationName
        in: path
        description: Name of MQ broker/authorization 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:
        BrokerAuthorization_Delete:
          $ref: ./examples/BrokerAuthorization_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 Authorization Authorizationname
definitions:
  BrokerAuthorizationResourceUpdateProperties:
    type: object
    description: The updatable properties of the BrokerAuthorizationResource.
    properties:
      authorizationPolicies:
        $ref: '#/definitions/AuthorizationConfig'
        description: The list of authorization policies supported by the Authorization Resource.
      listenerRef:
        type: array
        description: The array of listener Resources it supports.
        items:
          type: string
  BrokerAuthorizationResourceUpdate:
    type: object
    description: The type used for update operations of the BrokerAuthorizationResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/BrokerAuthorizationResourceUpdateProperties'
        x-ms-client-flatten: true
  AuthorizationBasicRule:
    type: object
    description: BasicRules of AuthorizationConfig Polar rules are not supported
    properties:
      brokerResources:
        type: array
        description: This subfield defines the broker resources that the Basic Rule is applied on.
        items:
          $ref: '#/definitions/ResourceInfoDefinition'
        x-ms-identifiers: []
      principals:
        $ref: '#/definitions/PrincipalDefinition'
        description: This subfield defines the identities that represent the clients.
    required:
    - brokerResources
    - principals
  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.
  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
  ResourceInfoDefinitionMethods:
    type: string
    description: ResourceInfoDefinition methods allowed
    enum:
    - Connect
    - Publish
    - Subscribe
    x-ms-enum:
      name: ResourceInfoDefinitionMethods
      modelAsString: true
      values:
      - name: Connect
        value: Connect
        description: Allowed Connecting to Broker
      - name: Publish
        value: Publish
        description: Allowed Publishing to Broker
      - name: Subscribe
        value: Subscribe
        description: Allowed Subscribing to Broker
  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
  ResourceInfoDefinition:
    type: object
    description: ResourceInfoDefinition properties of Basic Rule. This defines the objects that represent the actions or topics, such as - method.Connect, method.Publish, etc.
    properties:
      method:
        $ref: '#/definitions/ResourceInfoDefinitionMethods'
        description: 'The type of action that the clients can perform on the broker: Connect, Publish or Subscribe.'
      topics:
        type: array
        description: A list of topics or topic patterns that match the topics that the clients can publish or subscribe to. This subfield is required if the method is Publish or Subscribe.
        items:
          type: string
    required:
    - method
  BrokerAuthorizationProperties:
    type: object
    description: Broker Resource properties
    properties:
      authorizationPolicies:
        $ref: '#/definitions/AuthorizationConfig'
        description: The list of authorization policies supported by the Authorization Resource.
      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:
    - authorizationPolicies
    - listenerRef
  AuthorizationConfig:
    type: object
    description: Broker AuthorizationConfig properties
    properties:
      enableCache:
        type: boolean
        description: Enable caching of the authorization rules.
        default: true
      rules:
        type: array
        description: Authorization Rules to be used. If no rule is set, but Authorization Resource is used that would mean DenyAll.
        items:
          $ref: '#/definitions/AuthorizationBasicRule'
        x-ms-identifiers: []
  PrincipalDefinition:
    type: object
    description: PrincipalDefinition properties of Basic Rule
    properties:
      attributes:
        type: array
        description: A list of key-value pairs that match the attributes of the clients. The attributes are case-sensitive and must match the attributes provided by the clients during authentication.
        default: []
        items:
          type: object
          additionalProperties:
            type: string
        x-ms-identifiers: []
      clientids:
        type: array
        description: A list of client IDs that match the clients. The client IDs are case-sensitive and must match the client IDs provided by the clients during connection.
        items:
          type: string
      usernames:
        type: array
        description: A list of usernames that match the clients. The usernames are case-sensitive and must match the usernames provided by the clients during authentication.
        items:
          type: string
  BrokerAuthorizationResource:
    type: object
    description: MQ broker/authorization resource
    properties:
      properties:
        $ref: '#/definitions/BrokerAuthorizationProperties'
        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
  BrokerAuthorizationResourceListResult:
    type: object
    description: The response of a BrokerAuthorizationResource list operation.
    properties:
      value:
        type: array
        description: The BrokerAuthorizationResource items on this page
        items:
          $ref: '#/definitions/BrokerAuthorizationResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'