Microsoft Azure ServerSecurityAlertPolicies API

openapi: 3.2.0
info:
  title: Microsoft Azure MariaDBManagementClient Server Security…
  description: The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MariaDB resources including servers, databases, firewall rules, VNET rules, log files and configurations with new business model.
  version: '2018-06-01'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: ServerSecurityAlertPolicies
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}
  : get:
      tags:
      - ServerSecurityAlertPolicies
      description: Get a server's security alert policy.
      operationId: microsoftAzureServersecurityalertpoliciesGet
      parameters:
      - $ref: '#/components/parameters/ResourceGroupParameter'
      - $ref: '#/components/parameters/ServerNameParameter'
      - name: securityAlertPolicyName
        in: path
        description: The name of the security alert policy.
        required: true
        x-ms-enum:
          name: SecurityAlertPolicyName
          modelAsString: true
        schema:
          type: string
          enum:
          - Default
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully retrieved the server threat detection policy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSecurityAlertPolicy'
        default:
          description: Error response describing why the operation of getting security alert policies failed.
      x-ms-examples:
        Get a server's threat detection policy:
          $ref: ./examples/ServerSecurityAlertsGet.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
    put:
      tags:
      - ServerSecurityAlertPolicies
      description: Creates or updates a threat detection policy.
      operationId: microsoftAzureServersecurityalertpoliciesCreateorupdate
      parameters:
      - $ref: '#/components/parameters/ResourceGroupParameter'
      - $ref: '#/components/parameters/ServerNameParameter'
      - name: securityAlertPolicyName
        in: path
        description: The name of the threat detection policy.
        required: true
        x-ms-enum:
          name: SecurityAlertPolicyName
          modelAsString: true
        schema:
          type: string
          enum:
          - Default
      - $ref: '#/components/parameters/SubscriptionIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully updated the threat detection policy.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServerSecurityAlertPolicy'
        '202':
          description: Created request to set the server threat detection policy.
        default:
          description: Error response describing why the operation of setting security alert policies failed.
      x-ms-long-running-operation: true
      x-ms-examples:
        Update a server's threat detection policy with all parameters:
          $ref: ./examples/ServerSecurityAlertsCreateMax.json
        Update a server's threat detection policy with minimal parameters:
          $ref: ./examples/ServerSecurityAlertsCreateMin.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ServerSecurityAlertPolicy'
        description: The server security alert policy.
        required: true
components:
  parameters:
    ResourceGroupParameter:
      name: resourceGroupName
      in: path
      required: true
      description: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
      x-ms-parameter-location: method
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for the request.
      schema:
        type: string
    SubscriptionIdParameter:
      name: subscriptionId
      in: path
      required: true
      description: The subscription ID that identifies an Azure subscription.
      schema:
        type: string
    ServerNameParameter:
      name: serverName
      in: path
      required: true
      description: The name of the server.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    ServerSecurityAlertPolicy:
      description: A server security alert policy.
      type: object
      allOf:
      - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource
      properties:
        properties:
          $ref: '#/components/schemas/SecurityAlertPolicyProperties'
          description: Resource properties.
          x-ms-client-flatten: true
    SecurityAlertPolicyProperties:
      description: Properties of a security alert policy.
      required:
      - state
      type: object
      properties:
        state:
          description: Specifies the state of the policy, whether it is enabled or disabled.
          enum:
          - Enabled
          - Disabled
          type: string
          x-ms-enum:
            name: ServerSecurityAlertPolicyState
            modelAsString: false
        disabledAlerts:
          description: 'Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly'
          type: array
          items:
            type: string
        emailAddresses:
          description: Specifies an array of e-mail addresses to which the alert is sent.
          type: array
          items:
            type: string
        emailAccountAdmins:
          description: Specifies that the alert is sent to the account administrators.
          type: boolean
        storageEndpoint:
          description: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.
          type: string
        storageAccountAccessKey:
          description: Specifies the identifier key of the Threat Detection audit storage account.
          type: string
        retentionDays:
          format: int32
          description: Specifies the number of days to keep in the Threat Detection audit logs.
          type: integer
  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