Microsoft Azure MonitoredSubscriptions API

swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector MonitoredSubscriptions API
schemes:
- https
tags:
- name: MonitoredSubscriptions
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions/{configurationName}
  : patch:
      tags:
      - MonitoredSubscriptions
      summary: Microsoft Azure Updates The Subscriptions That Are Being Monitored By The Newrelic Monitor Resource
      operationId: microsoftAzureMonitoredsubscriptionsUpdate
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: monitorName
        in: path
        required: true
        description: Name of the Monitors resource
        pattern: ^.*$
        type: string
      - description: The configuration name. Only 'default' value is supported.
        in: path
        name: configurationName
        pattern: ^.*$
        required: true
        type: string
        enum:
        - default
        x-ms-enum:
          name: configurationName
          modelAsString: true
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        schema:
          $ref: '#/definitions/MonitoredSubscriptionProperties'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MonitoredSubscriptionProperties'
        '202':
          headers:
            Location:
              type: string
          description: Success
        default:
          description: Default error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        Monitors_UpdateMonitoredSubscriptions:
          $ref: ./examples/MonitoredSubscriptions_Update.json
      description: Needs a more full description created.
    delete:
      tags:
      - MonitoredSubscriptions
      summary: Microsoft Azure Updates The Subscriptions That Are Being Monitored By The Newrelic Monitor Resource
      operationId: microsoftAzureMonitoredsubscriptionsDelete
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: monitorName
        in: path
        required: true
        description: Name of the Monitors resource
        pattern: ^.*$
        type: string
      - description: The configuration name. Only 'default' value is supported.
        in: path
        name: configurationName
        pattern: ^.*$
        required: true
        type: string
        enum:
        - default
        x-ms-enum:
          name: configurationName
          modelAsString: true
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '202':
          headers:
            Location:
              type: string
          description: Success
        '204':
          description: Success
        default:
          description: Default error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        Monitors_DeleteMonitoredSubscriptions:
          $ref: ./examples/MonitoredSubscriptions_Delete.json
      description: Needs a more full description created.
    get:
      tags:
      - MonitoredSubscriptions
      summary: Microsoft Azure List The Subscriptions Currently Being Monitored By The Newrelic Monitor Resource
      operationId: microsoftAzureMonitoredsubscriptionsGet
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: monitorName
        in: path
        required: true
        pattern: ^.*$
        description: Name of the Monitors resource
        type: string
      - description: The configuration name. Only 'default' value is supported.
        in: path
        name: configurationName
        pattern: ^.*$
        required: true
        type: string
        enum:
        - default
        x-ms-enum:
          name: configurationName
          modelAsString: true
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MonitoredSubscriptionProperties'
        default:
          description: Default error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-examples:
        Monitors_GetMonitoredSubscriptions:
          $ref: ./examples/MonitoredSubscriptions_Get.json
      description: Needs a more full description created.
    put:
      tags:
      - MonitoredSubscriptions
      summary: Microsoft Azure Add The Subscriptions That Should Be Monitored By The Newrelic Monitor Resource
      operationId: microsoftAzureMonitoredsubscriptionsCreateorupdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: monitorName
        in: path
        required: true
        description: Name of the Monitors resource
        pattern: ^.*$
        type: string
      - description: The configuration name. Only 'default' value is supported.
        in: path
        name: configurationName
        pattern: ^.*$
        required: true
        type: string
        enum:
        - default
        x-ms-enum:
          name: configurationName
          modelAsString: true
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      - in: body
        name: body
        schema:
          $ref: '#/definitions/MonitoredSubscriptionProperties'
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MonitoredSubscriptionProperties'
        '201':
          description: Success
          schema:
            $ref: '#/definitions/MonitoredSubscriptionProperties'
        default:
          description: Default error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        Monitors_AddMonitoredSubscriptions:
          $ref: ./examples/MonitoredSubscriptions_CreateorUpdate.json
      description: Needs a more full description created.
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/NewRelic.Observability/monitors/{monitorName}/monitoredSubscriptions
  : get:
      tags:
      - MonitoredSubscriptions
      summary: Microsoft Azure List The Subscriptions Currently Being Monitored By The Newrelic Monitor Resource
      operationId: microsoftAzureMonitoredsubscriptionsList
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter
      - name: monitorName
        in: path
        required: true
        pattern: ^.*$
        description: Name of the Monitors resource
        type: string
      - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/MonitoredSubscriptionPropertiesList'
        default:
          description: Default error response.
          schema:
            $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        Monitors_GetMonitoredSubscriptions:
          $ref: ./examples/MonitoredSubscriptions_List.json
      description: Needs a more full description created.
definitions:
  MetricRules:
    type: object
    properties:
      sendMetrics:
        $ref: '#/definitions/SendMetricsStatus'
        description: Flag specifying if metrics should be sent for the Monitor resource.
      filteringTags:
        type: array
        items:
          $ref: '#/definitions/FilteringTag'
        x-ms-identifiers: []
        x-cadl-name: FilteringTag[]
        description: List of filtering tags to be used for capturing metrics.
      userEmail:
        $ref: '#/definitions/email'
        description: User Email
    description: Set of rules for sending metrics for the Monitor resource.
  SendSubscriptionLogsStatus:
    type: string
    description: Indicates whether subscription logs are being sent.
    enum:
    - Enabled
    - Disabled
    x-ms-enum:
      name: SendSubscriptionLogsStatus
      modelAsString: true
  LogRules:
    type: object
    properties:
      sendAadLogs:
        $ref: '#/definitions/SendAadLogsStatus'
        description: Flag specifying if AAD logs should be sent for the Monitor resource.
      sendSubscriptionLogs:
        $ref: '#/definitions/SendSubscriptionLogsStatus'
        description: Flag specifying if subscription logs should be sent for the Monitor resource.
      sendActivityLogs:
        $ref: '#/definitions/SendActivityLogsStatus'
        description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.
      filteringTags:
        type: array
        items:
          $ref: '#/definitions/FilteringTag'
        x-ms-identifiers: []
        x-cadl-name: FilteringTag[]
        description: 'List of filtering tags to be used for capturing logs. This only takes effect if SendActivityLogs flag is enabled. If empty, all resources will be captured.

          If only Exclude action is specified, the rules will apply to the list of all available resources. If Include actions are specified, the rules will only include resources with the associated tags.'
    description: Set of rules for sending logs for the Monitor resource.
  TagAction:
    type: string
    description: Valid actions for a filtering tag. Exclusion takes priority over inclusion.
    enum:
    - Include
    - Exclude
    x-ms-enum:
      name: TagAction
      modelAsString: true
  FilteringTag:
    type: object
    properties:
      name:
        type: string
        description: The name (also known as the key) of the tag.
      value:
        type: string
        description: The value of the tag.
      action:
        $ref: '#/definitions/TagAction'
        description: Valid actions for a filtering tag. Exclusion takes priority over inclusion.
    description: The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.
  MonitoredSubscriptionProperties:
    description: The request to update subscriptions needed to be monitored by the NewRelic monitor resource.
    type: object
    x-ms-azure-resource: true
    properties:
      name:
        description: Name of the monitored subscription resource.
        type: string
        readOnly: true
      id:
        description: The id of the monitored subscription resource.
        type: string
        readOnly: true
      type:
        description: The type of the monitored subscription resource.
        type: string
        readOnly: true
      properties:
        $ref: '#/definitions/SubscriptionList'
  MonitoringTagRulesProperties:
    type: object
    properties:
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Provisioning State of the resource
        readOnly: true
      logRules:
        $ref: '#/definitions/LogRules'
        description: Set of rules for sending logs for the Monitor resource.
      metricRules:
        $ref: '#/definitions/MetricRules'
        description: Set of rules for sending metrics for the Monitor resource.
    description: The resource-specific properties for this resource.
  SubscriptionList:
    description: The request to update subscriptions needed to be monitored by the NewRelic monitor resource.
    type: object
    properties:
      patchOperation:
        description: The operation for the patch on the resource.
        enum:
        - AddBegin
        - AddComplete
        - DeleteBegin
        - DeleteComplete
        - Active
        type: string
        x-ms-enum:
          modelAsString: true
          name: PatchOperation
        x-ms-mutability:
        - create
        - update
      monitoredSubscriptionList:
        description: List of subscriptions and the state of the monitoring.
        type: array
        items:
          $ref: '#/definitions/MonitoredSubscription'
        x-ms-identifiers: []
      provisioningState:
        $ref: '#/definitions/ProvisioningState'
        description: Provisioning State of the resource
        readOnly: true
  ProvisioningState:
    type: string
    description: Provisioning State of the Monitor resource
    enum:
    - Accepted
    - Creating
    - Updating
    - Deleting
    - Succeeded
    - Failed
    - Canceled
    - Deleted
    - NotSpecified
    x-ms-enum:
      name: ProvisioningState
      modelAsString: true
      values:
      - name: Accepted
        value: Accepted
        description: Monitor resource creation request accepted
      - name: Creating
        value: Creating
        description: Monitor resource creation started
      - name: Updating
        value: Updating
        description: Monitor resource is being updated
      - name: Deleting
        value: Deleting
        description: Monitor resource deletion started
      - name: Succeeded
        value: Succeeded
        description: Monitor resource creation successful
      - name: Failed
        value: Failed
        description: Monitor resource creation failed
      - name: Canceled
        value: Canceled
        description: Monitor resource creation canceled
      - name: Deleted
        value: Deleted
        description: Monitor resource is deleted
      - name: NotSpecified
        value: NotSpecified
        description: Monitor resource state is unknown
  SendActivityLogsStatus:
    type: string
    description: Indicates whether activity logs are being sent.
    enum:
    - Enabled
    - Disabled
    x-ms-enum:
      name: SendActivityLogsStatus
      modelAsString: true
  email:
    type: string
    description: Reusable representation of an email address
    pattern: ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$
  SendAadLogsStatus:
    type: string
    description: Indicates whether AAD logs are being sent.
    enum:
    - Enabled
    - Disabled
    x-ms-enum:
      name: SendAadLogsStatus
      modelAsString: true
  SendMetricsStatus:
    type: string
    description: Indicates whether metrics are being sent.
    enum:
    - Enabled
    - Disabled
    x-ms-enum:
      name: SendMetricsStatus
      modelAsString: true
  MonitoredSubscriptionPropertiesList:
    type: object
    properties:
      value:
        type: array
        items:
          $ref: '#/definitions/MonitoredSubscriptionProperties'
      nextLink:
        type: string
        description: The link to the next page of items
  MonitoredSubscription:
    description: The list of subscriptions and it's monitoring status by current NewRelic monitor.
    type: object
    properties:
      subscriptionId:
        description: The subscriptionId to be monitored.
        required:
        - subscriptionId
        type: string
      status:
        description: The state of monitoring.
        enum:
        - InProgress
        - Active
        - Failed
        - Deleting
        x-ms-enum:
          modelAsString: true
          name: Status
        type: string
      error:
        description: The reason of not monitoring the subscription.
        type: string
      tagRules:
        $ref: '#/definitions/MonitoringTagRulesProperties'
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'