swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector DiagnosticService API
schemes:
- https
tags:
- name: DiagnosticService
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/diagnosticService
  : get:
      operationId: microsoftAzureDiagnosticserviceListbymqresource
      tags:
      - DiagnosticService
      description: List DiagnosticServiceResource resources by MqResource
      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}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DiagnosticServiceResourceListResult'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DiagnosticService_ListByMqResource:
          $ref: ./examples/DiagnosticService_ListByMqResource_MaximumSet_Gen.json
      x-ms-pageable:
        nextLinkName: nextLink
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Diagnosticservice
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.IoTOperationsMQ/mq/{mqName}/diagnosticService/{diagnosticServiceName}
  : get:
      operationId: microsoftAzureDiagnosticserviceGet
      tags:
      - DiagnosticService
      description: Get a DiagnosticServiceResource
      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: diagnosticServiceName
        in: path
        description: Name of MQ diagnostic resource
        required: true
        type: string
        pattern: ^[a-zA-Z0-9-]{3,24}$
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DiagnosticServiceResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DiagnosticService_Get:
          $ref: ./examples/DiagnosticService_Get_MaximumSet_Gen.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Diagnosticservice Diagnosticservicename
    put:
      operationId: microsoftAzureDiagnosticserviceCreateorupdate
      tags:
      - DiagnosticService
      description: Create a DiagnosticServiceResource
      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: diagnosticServiceName
        in: path
        description: Name of MQ diagnostic 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/DiagnosticServiceResource'
      responses:
        '200':
          description: Resource 'DiagnosticServiceResource' update operation succeeded
          schema:
            $ref: '#/definitions/DiagnosticServiceResource'
        '201':
          description: Resource 'DiagnosticServiceResource' create operation succeeded
          schema:
            $ref: '#/definitions/DiagnosticServiceResource'
          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:
        DiagnosticService_CreateOrUpdate:
          $ref: ./examples/DiagnosticService_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 Diagnosticservice Diagnosticservicename
    patch:
      operationId: microsoftAzureDiagnosticserviceUpdate
      tags:
      - DiagnosticService
      description: Update a DiagnosticServiceResource
      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: diagnosticServiceName
        in: path
        description: Name of MQ diagnostic 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/DiagnosticServiceResourceUpdate'
      responses:
        '200':
          description: Azure operation completed successfully.
          schema:
            $ref: '#/definitions/DiagnosticServiceResource'
        default:
          description: An unexpected error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        DiagnosticService_Update:
          $ref: ./examples/DiagnosticService_Update_MaximumSet_Gen.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Iotoperationsmq Mq Mqname Diagnosticservice Diagnosticservicename
    delete:
      operationId: microsoftAzureDiagnosticserviceDelete
      tags:
      - DiagnosticService
      description: Delete a DiagnosticServiceResource
      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: diagnosticServiceName
        in: path
        description: Name of MQ diagnostic 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:
        DiagnosticService_Delete:
          $ref: ./examples/DiagnosticService_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 Diagnosticservice Diagnosticservicename
definitions:
  ContainerImage:
    type: object
    description: Defines the Docker image details
    properties:
      pullPolicy:
        type: string
        description: Image pull policy.
      pullSecrets:
        type: string
        description: Image pull secrets.
      repository:
        type: string
        description: The Docker image name.
      tag:
        type: string
        description: The Docker  image tag.
    required:
    - repository
    - tag
  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
  DiagnosticServiceResource:
    type: object
    description: MQ diagnostic services resource
    properties:
      properties:
        $ref: '#/definitions/DiagnosticServiceProperties'
        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
  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.
  DiagnosticServiceProperties:
    type: object
    description: MQ Diagnostic Services Resource properties
    properties:
      dataExportFrequencySeconds:
        type: integer
        format: int32
        description: The frequency at which the data will be exported.
        default: 10
        minimum: 0
        maximum: 65535
      image:
        $ref: '#/definitions/ContainerImage'
        description: The details of Diagnostic Service Docker Image.
      logFormat:
        type: string
        description: The format for the logs generated.
        default: json
      logLevel:
        type: string
        description: The format for the logs generated.
        default: info
      maxDataStorageSize:
        type: integer
        format: int64
        description: The maximum data stored in MiB.
        default: 16
        minimum: 0
        maximum: 4294967295
      metricsPort:
        type: integer
        format: int32
        description: The port at which metrics is exposed.
        default: 9600
        minimum: 0
        maximum: 65535
      openTelemetryTracesCollectorAddr:
        type: string
        description: The destination to collect traces. Diagnostic service will push traces to this endpoint
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: The status of the last operation.
        readOnly: true
      staleDataTimeoutSeconds:
        type: integer
        format: int32
        description: Metric inactivity timeout.
        default: 600
        minimum: 0
        maximum: 65535
    required:
    - image
  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
  DiagnosticServiceResourceUpdateProperties:
    type: object
    description: The updatable properties of the DiagnosticServiceResource.
    properties:
      dataExportFrequencySeconds:
        type: integer
        format: int32
        description: The frequency at which the data will be exported.
        default: 10
        minimum: 0
        maximum: 65535
      image:
        $ref: '#/definitions/ContainerImageUpdate'
        description: The details of Diagnostic Service Docker Image.
      logFormat:
        type: string
        description: The format for the logs generated.
        default: json
      logLevel:
        type: string
        description: The format for the logs generated.
        default: info
      maxDataStorageSize:
        type: integer
        format: int64
        description: The maximum data stored in MiB.
        default: 16
        minimum: 0
        maximum: 4294967295
      metricsPort:
        type: integer
        format: int32
        description: The port at which metrics is exposed.
        default: 9600
        minimum: 0
        maximum: 65535
      openTelemetryTracesCollectorAddr:
        type: string
        description: The destination to collect traces. Diagnostic service will push traces to this endpoint
      staleDataTimeoutSeconds:
        type: integer
        format: int32
        description: Metric inactivity timeout.
        default: 600
        minimum: 0
        maximum: 65535
  DiagnosticServiceResourceListResult:
    type: object
    description: The response of a DiagnosticServiceResource list operation.
    properties:
      value:
        type: array
        description: The DiagnosticServiceResource items on this page
        items:
          $ref: '#/definitions/DiagnosticServiceResource'
      nextLink:
        type: string
        format: uri
        description: The link to the next page of items
    required:
    - value
  ContainerImageUpdate:
    type: object
    description: Defines the Docker image details
    properties:
      pullPolicy:
        type: string
        description: Image pull policy.
      pullSecrets:
        type: string
        description: Image pull secrets.
      repository:
        type: string
        description: The Docker image name.
      tag:
        type: string
        description: The Docker  image tag.
  DiagnosticServiceResourceUpdate:
    type: object
    description: The type used for update operations of the DiagnosticServiceResource.
    properties:
      tags:
        type: object
        description: Resource tags.
        additionalProperties:
          type: string
      properties:
        $ref: '#/definitions/DiagnosticServiceResourceUpdateProperties'
        x-ms-client-flatten: true
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'