Microsoft Azure DataMaskingRules API

openapi: 3.2.0
info:
  title: Microsoft Azure Azure SQL Database Datamasking Policies and…
  description: Provides create, read, update and delete functionality for Azure SQL Database datamasking policies and rules.
  version: '2014-04-01'
servers:
- url: https://management.azure.com
tags:
- name: DataMaskingRules
paths:
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}/rules/{dataMaskingRuleName}
  : put:
      tags:
      - DataMaskingRules
      operationId: microsoftAzureDatamaskingrulesCreateorupdate
      description: Creates or updates a database data masking rule.
      x-ms-examples:
        Create/Update data masking rule for text:
          $ref: ./examples/DataMaskingRuleCreateOrUpdateText.json
        Create/Update data masking rule for numbers:
          $ref: ./examples/DataMaskingRuleCreateOrUpdateNumber.json
        Create/Update data masking rule for default min:
          $ref: ./examples/DataMaskingRuleCreateOrUpdateDefaultMin.json
        Create/Update data masking rule for default max:
          $ref: ./examples/DataMaskingRuleCreateOrUpdateDefaultMax.json
      parameters:
      - $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
      - $ref: '#/components/parameters/ServerNameParameter'
      - $ref: '#/components/parameters/DatabaseNameParameter'
      - $ref: '#/components/parameters/DataMaskingPolicyNameParameter'
      - name: dataMaskingRuleName
        in: path
        required: true
        description: The name of the data masking rule.
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMaskingRule'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMaskingRule'
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups…
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DataMaskingRule'
        description: The required parameters for creating or updating a data masking rule.
        required: true
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}/rules
  : get:
      tags:
      - DataMaskingRules
      operationId: microsoftAzureDatamaskingrulesListbydatabase
      description: Gets a list of database data masking rules.
      x-ms-examples:
        List data masking rules:
          $ref: ./examples/DataMaskingRuleList.json
      parameters:
      - $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter
      - $ref: '#/components/parameters/ServerNameParameter'
      - $ref: '#/components/parameters/DatabaseNameParameter'
      - $ref: '#/components/parameters/DataMaskingPolicyNameParameter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DataMaskingRuleListResult'
      x-ms-pageable:
        nextLinkName: null
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups…
components:
  parameters:
    DataMaskingPolicyNameParameter:
      name: dataMaskingPolicyName
      in: path
      required: true
      x-ms-enum:
        modelAsString: false
        name: DataMaskingPolicyName
      description: The name of the database for which the data masking rule applies.
      x-ms-parameter-location: method
      schema:
        type: string
        enum:
        - Default
    ServerNameParameter:
      name: serverName
      in: path
      required: true
      description: The name of the server.
      x-ms-parameter-location: method
      schema:
        type: string
    DatabaseNameParameter:
      name: databaseName
      in: path
      required: true
      description: The name of the database.
      x-ms-parameter-location: method
      schema:
        type: string
  schemas:
    DataMaskingRuleProperties:
      properties:
        id:
          type: string
          description: The rule Id.
          readOnly: true
        aliasName:
          type: string
          description: The alias name. This is a legacy parameter and is no longer used.
        ruleState:
          type: string
          description: The rule state. Used to delete a rule. To delete an existing rule, specify the schemaName, tableName, columnName, maskingFunction, and specify ruleState as disabled. However, if the rule doesn't already exist, the rule will be created with ruleState set to enabled, regardless of the provided value of ruleState.
          enum:
          - Disabled
          - Enabled
          x-ms-enum:
            modelAsString: false
            name: DataMaskingRuleState
        schemaName:
          type: string
          description: The schema name on which the data masking rule is applied.
        tableName:
          type: string
          description: The table name on which the data masking rule is applied.
        columnName:
          type: string
          description: The column name on which the data masking rule is applied.
        maskingFunction:
          type: string
          description: The masking function that is used for the data masking rule.
          enum:
          - Default
          - CCN
          - Email
          - Number
          - SSN
          - Text
          x-ms-enum:
            modelAsString: false
            name: DataMaskingFunction
        numberFrom:
          type: string
          description: The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
        numberTo:
          type: string
          description: The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.
        prefixSize:
          type: string
          description: If maskingFunction is set to Text, the number of characters to show unmasked in the beginning of the string. Otherwise, this parameter will be ignored.
        suffixSize:
          type: string
          description: If maskingFunction is set to Text, the number of characters to show unmasked at the end of the string. Otherwise, this parameter will be ignored.
        replacementString:
          type: string
          description: If maskingFunction is set to Text, the character to use for masking the unexposed part of the string. Otherwise, this parameter will be ignored.
      required:
      - maskingFunction
      - schemaName
      - tableName
      - columnName
      description: The properties of a database data masking rule.
    DataMaskingRule:
      properties:
        properties:
          x-ms-client-flatten: true
          $ref: '#/components/schemas/DataMaskingRuleProperties'
          description: The properties of the resource.
        location:
          type: string
          readOnly: true
          description: The location of the data masking rule.
        kind:
          type: string
          readOnly: true
          description: The kind of Data Masking Rule. Metadata, used for Azure portal.
      allOf:
      - $ref: ../../../common/v1/types.json#/definitions/ProxyResource
      description: Represents a database data masking rule.
    DataMaskingRuleListResult:
      properties:
        value:
          type: array
          items:
            $ref: '#/components/schemas/DataMaskingRule'
          description: The list of database data masking rules.
      description: The response to a list data masking rules request.
  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