Microsoft Azure Rules API

openapi: 3.2.0
info:
  title: Microsoft Azure Rules API
  version: '1.0'
  description: 'Operations tagged Rules across 2 of this provider''s published API definitions: microsoftdatadog-openapi-original.yml, microsoftelastic-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
tags:
- name: Rules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/tagRules
  : get:
      tags:
      - Rules
      summary: Microsoft Azure List The Tag Rules For A Given Monitor Resource
      operationId: microsoftAzureTagrulesList
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringTagRulesListResponse'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        TagRules_List:
          $ref: ./examples/TagRules_List.json
      description: Needs a more full description created.
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}/tagRules/{ruleSetName}
  : put:
      tags:
      - Rules
      summary: Microsoft Azure Create Or Update A Tag Rule Set For A Given Monitor Resource
      operationId: microsoftAzureTagrulesCreateorupdate
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/MonitorNameParameter'
      - description: Rule set name
        in: path
        name: ruleSetName
        required: true
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringTagRules'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse'
      x-ms-examples:
        TagRules_CreateOrUpdate:
          $ref: ./examples/TagRules_CreateOrUpdate.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringTagRules'
    get:
      tags:
      - Rules
      summary: Microsoft Azure Get A Tag Rule Set For A Given Monitor Resource
      operationId: microsoftAzureTagrulesGet
      parameters:
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ResourceGroupNameParameter'
      - $ref: '#/components/parameters/MonitorNameParameter'
      - description: Rule set name
        in: path
        name: ruleSetName
        required: true
        schema:
          type: string
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringTagRules'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse'
      x-ms-examples:
        TagRules_Get:
          $ref: ./examples/TagRules_Get.json
      description: Needs a more full description created.
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules
  : get:
      tags:
      - Rules
      summary: Microsoft Azure List The Tag Rules For A Given Monitor Resource
      operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftElasticMonitorsByMonitorNameTagRules
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringTagRulesListResponse_2'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse_2'
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        TagRules_List:
          $ref: ./examples/TagRules_List.json
      description: Needs a more full description created.
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureTagrulesList
    servers:
    - url: https://management.azure.com
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Elastic/monitors/{monitorName}/tagRules/{ruleSetName}
  : put:
      tags:
      - Rules
      summary: Microsoft Azure Create Or Update A Tag Rule Set For A Given Monitor Resource
      operationId: putSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftElasticMonitorsByMonitorNameTagRulesByRuleSetName
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: '#/components/parameters/RuleSetNameParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringTagRules_2'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse_2'
      x-ms-examples:
        TagRules_CreateOrUpdate:
          $ref: ./examples/TagRules_CreateOrUpdate.json
      description: Needs a more full description created.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MonitoringTagRules_2'
        description: request body of MonitoringTagRules
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureTagrulesCreateorupdate
    get:
      tags:
      - Rules
      summary: Microsoft Azure Get A Tag Rule Set For A Given Monitor Resource
      operationId: getSubscriptionsBySubscriptionIdResourceGroupsByResourceGroupNameProvidersMicrosoftElasticMonitorsByMonitorNameTagRulesByRuleSetName
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: '#/components/parameters/RuleSetNameParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringTagRules_2'
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse_2'
      x-ms-examples:
        TagRules_Get:
          $ref: ./examples/TagRules_Get.json
      description: Needs a more full description created.
      x-operation-id-source: normalized
      x-operation-id-original: microsoftAzureTagrulesGet
    delete:
      tags:
      - Rules
      summary: Microsoft Azure Delete A Tag Rule Set For A Given Monitor Resource
      operationId: microsoftAzureTagrulesDelete
      parameters:
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/components/parameters/MonitorNameParameter'
      - $ref: '#/components/parameters/RuleSetNameParameter'
      responses:
        '200':
          description: Success
        '202':
          description: Success
        '204':
          description: Success
        default:
          description: Default error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceProviderDefaultErrorResponse_2'
      x-ms-long-running-operation: true
      x-ms-examples:
        TagRules_Delete:
          $ref: ./examples/TagRules_Delete.json
      description: Needs a more full description created.
    servers:
    - url: https://management.azure.com
components:
  schemas:
    ProvisioningState:
      enum:
      - Accepted
      - Creating
      - Updating
      - Deleting
      - Succeeded
      - Failed
      - Canceled
      - Deleted
      - NotSpecified
      type: string
      x-ms-enum:
        modelAsString: true
        name: ProvisioningState
      readOnly: true
    ErrorResponseBody:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        target:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseBody'
    MonitoringTagRulesListResponse:
      description: Response of a list operation.
      type: object
      properties:
        value:
          description: Results of a list operation.
          type: array
          items:
            $ref: '#/components/schemas/MonitoringTagRules'
        nextLink:
          description: Link to the next set of results, if any.
          type: string
    MetricRules:
      description: Set of rules for sending metrics for the Monitor resource.
      type: object
      properties:
        filteringTags:
          description: List of filtering tags to be used for capturing metrics. 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.
          type: array
          items:
            $ref: '#/components/schemas/FilteringTag'
    TagAction:
      description: Valid actions for a filtering tag. Exclusion takes priority over inclusion.
      enum:
      - Include
      - Exclude
      type: string
      x-ms-enum:
        modelAsString: true
        name: TagAction
    MonitoringTagRulesProperties:
      description: Definition of the properties for a TagRules resource.
      type: object
      properties:
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
        logRules:
          $ref: '#/components/schemas/LogRules'
        metricRules:
          $ref: '#/components/schemas/MetricRules'
    MonitoringTagRules:
      description: Capture logs and metrics of Azure resources based on ARM tags.
      type: object
      x-ms-azure-resource: true
      properties:
        name:
          description: Name of the rule set.
          type: string
          readOnly: true
        id:
          description: The id of the rule set.
          type: string
          readOnly: true
        type:
          description: The type of the rule set.
          type: string
          readOnly: true
        properties:
          $ref: '#/components/schemas/MonitoringTagRulesProperties'
    ResourceProviderDefaultErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorResponseBody'
    LogRules:
      description: Set of rules for sending logs for the Monitor resource.
      type: object
      properties:
        sendAadLogs:
          description: Flag specifying if AAD logs should be sent for the Monitor resource.
          type: boolean
        sendSubscriptionLogs:
          description: Flag specifying if Azure subscription logs should be sent for the Monitor resource.
          type: boolean
        sendResourceLogs:
          description: Flag specifying if Azure resource logs should be sent for the Monitor resource.
          type: boolean
        filteringTags:
          description: List of filtering tags to be used for capturing logs. This only takes effect if SendResourceLogs 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.
          type: array
          items:
            $ref: '#/components/schemas/FilteringTag'
    FilteringTag:
      description: The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.
      type: object
      properties:
        name:
          description: The name (also known as the key) of the tag.
          type: string
        value:
          description: The value of the tag.
          type: string
        action:
          $ref: '#/components/schemas/TagAction'
    ProvisioningState_2:
      enum:
      - Accepted
      - Creating
      - Updating
      - Deleting
      - Succeeded
      - Failed
      - Canceled
      - Deleted
      - NotSpecified
      type: string
      description: Provisioning state of Elastic resource.
      title: ProvisioningState
      x-ms-enum:
        modelAsString: true
        name: ProvisioningState
    ErrorResponseBody_2:
      description: Error response body.
      title: ErrorResponseBody
      type: object
      properties:
        code:
          description: Error code.
          type: string
        message:
          description: Error message.
          type: string
        target:
          description: Error target.
          type: string
        details:
          description: Error details.
          type: array
          x-ms-identifiers: []
          items:
            $ref: '#/components/schemas/ErrorResponseBody_2'
    MonitoringTagRulesListResponse_2:
      description: Response of a list operation.
      type: object
      properties:
        value:
          description: Results of a list operation.
          type: array
          x-ms-identifiers: []
          items:
            $ref: '#/components/schemas/MonitoringTagRules_2'
        nextLink:
          description: Link to the next set of results, if any.
          type: string
    MonitoringTagRulesProperties_2:
      description: Definition of the properties for a TagRules resource.
      type: object
      properties:
        provisioningState:
          description: Provisioning state of the monitoring tag rules.
          $ref: '#/components/schemas/ProvisioningState_2'
        logRules:
          description: Rules for sending logs.
          $ref: '#/components/schemas/LogRules_2'
    MonitoringTagRules_2:
      description: Capture logs and metrics of Azure resources based on ARM tags.
      type: object
      x-ms-azure-resource: true
      properties:
        name:
          description: Name of the rule set.
          type: string
          readOnly: true
        id:
          description: The id of the rule set.
          type: string
          readOnly: true
        type:
          description: The type of the rule set.
          type: string
          readOnly: true
        properties:
          description: Properties of the monitoring tag rules.
          $ref: '#/components/schemas/MonitoringTagRulesProperties_2'
          x-ms-client-flatten: false
        systemData:
          readOnly: true
          description: The system metadata relating to this resource
          $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/systemData
    ResourceProviderDefaultErrorResponse_2:
      description: RP default error response.
      type: object
      properties:
        error:
          description: Response body of Error
          readOnly: true
          $ref: '#/components/schemas/ErrorResponseBody_2'
    LogRules_2:
      description: Set of rules for sending logs for the Monitor resource.
      type: object
      properties:
        sendAadLogs:
          description: Flag specifying if AAD logs should be sent for the Monitor resource.
          type: boolean
        sendSubscriptionLogs:
          description: Flag specifying if subscription logs should be sent for the Monitor resource.
          type: boolean
        sendActivityLogs:
          description: Flag specifying if activity logs from Azure resources should be sent for the Monitor resource.
          type: boolean
        filteringTags:
          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.
          type: array
          x-ms-identifiers: []
          items:
            $ref: '#/components/schemas/FilteringTag_2'
    FilteringTag_2:
      description: The definition of a filtering tag. Filtering tags are used for capturing resources and include/exclude them from being monitored.
      type: object
      properties:
        name:
          description: The name (also known as the key) of the tag.
          type: string
        value:
          description: The value of the tag.
          type: string
        action:
          description: Valid actions for a filtering tag.
          $ref: '#/components/schemas/TagAction'
  parameters:
    MonitorNameParameter:
      in: path
      name: monitorName
      description: Monitor resource name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      description: The Microsoft Azure subscription ID.
      required: true
      schema:
        type: string
    ResourceGroupNameParameter:
      name: resourceGroupName
      in: path
      description: The name of the resource group to which the Datadog resource belongs.
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
    RuleSetNameParameter:
      in: path
      name: ruleSetName
      description: Tag Rule Set resource name
      required: true
      x-ms-parameter-location: method
      schema:
        type: string
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow
x-refined-from:
- microsoftdatadog-openapi-original.yml
- microsoftelastic-openapi-original.yml
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/components/parameters/Endpoint'