DataMaskingPolicies.json

{
  "swagger": "2.0",
  "info": {
    "version": "2022-05-01-preview",
    "title": "SqlManagementClient",
    "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities."
  },
  "host": "management.azure.com",
  "schemes": [
    "https"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}": {
      "get": {
        "tags": [
          "DataMaskingPolicies"
        ],
        "description": "Gets the database data masking policy.",
        "operationId": "DataMaskingPolicies_Get",
        "parameters": [
          {
            "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
          },
          {
            "$ref": "#/parameters/ServerNameParameter"
          },
          {
            "$ref": "#/parameters/DatabaseNameParameter"
          },
          {
            "name": "dataMaskingPolicyName",
            "in": "path",
            "description": "The name of the database for which the data masking policy applies.",
            "required": true,
            "type": "string",
            "enum": [
              "Default"
            ],
            "x-ms-enum": {
              "name": "DataMaskingPolicyName",
              "modelAsString": true
            }
          },
          {
            "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully retrieved the database data masking policies.",
            "schema": {
              "$ref": "#/definitions/DataMaskingPolicy"
            }
          },
          "default": {
            "description": "*** Error Responses: ***"
          }
        },
        "x-ms-examples": {
          "Gets the database data masking policies.": {
            "$ref": "./examples/DataMaskingPolicyGet.json"
          }
        }
      },
      "put": {
        "tags": [
          "DataMaskingPolicies"
        ],
        "description": "Creates or updates a database data masking policy.",
        "operationId": "DataMaskingPolicies_CreateOrUpdate",
        "parameters": [
          {
            "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter"
          },
          {
            "$ref": "#/parameters/ServerNameParameter"
          },
          {
            "$ref": "#/parameters/DatabaseNameParameter"
          },
          {
            "name": "dataMaskingPolicyName",
            "in": "path",
            "description": "The name of the database for which the data masking policy applies.",
            "required": true,
            "type": "string",
            "enum": [
              "Default"
            ],
            "x-ms-enum": {
              "name": "DataMaskingPolicyName",
              "modelAsString": true
            }
          },
          {
            "name": "parameters",
            "in": "body",
            "description": "Parameters for creating or updating a data masking policy.",
            "required": true,
            "schema": {
              "$ref": "#/definitions/DataMaskingPolicy"
            }
          },
          {
            "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter"
          }
        ],
        "responses": {
          "200": {
            "description": "Successfully created database data masking policy.",
            "schema": {
              "$ref": "#/definitions/DataMaskingPolicy"
            }
          },
          "default": {
            "description": "*** Error Responses: ***"
          },
          "201": {
            "description": "Successfully created database data masking policy..",
            "schema": {
              "$ref": "#/definitions/DataMaskingPolicy"
            }
          }
        },
        "x-ms-examples": {
          "Create or update data masking policy max": {
            "$ref": "./examples/DataMaskingPolicyCreateOrUpdateMax.json"
          },
          "Create or update data masking policy min.": {
            "$ref": "./examples/DataMaskingPolicyCreateOrUpdateMin.json"
          }
        }
      }
    }
  },
  "definitions": {
    "DataMaskingPolicy": {
      "description": "A database data masking policy.",
      "type": "object",
      "allOf": [
        {
          "$ref": "../../../common/v1/types.json#/definitions/ProxyResource"
        }
      ],
      "properties": {
        "location": {
          "description": "The location of the data masking policy.",
          "type": "string",
          "readOnly": true
        },
        "kind": {
          "description": "The kind of Data Masking Policy. Metadata, used for Azure portal.",
          "type": "string",
          "readOnly": true
        },
        "properties": {
          "$ref": "#/definitions/DataMaskingPolicyProperties",
          "description": "Resource properties.",
          "x-ms-client-flatten": true
        }
      }
    },
    "DataMaskingPolicyProperties": {
      "description": "The properties of a database data masking policy.",
      "required": [
        "dataMaskingState"
      ],
      "type": "object",
      "properties": {
        "dataMaskingState": {
          "description": "The state of the data masking policy.",
          "enum": [
            "Enabled",
            "Disabled"
          ],
          "type": "string",
          "x-ms-enum": {
            "name": "DataMaskingState",
            "modelAsString": false
          }
        },
        "exemptPrincipals": {
          "description": "The list of the exempt principals. Specifies the semicolon-separated list of database users for which the data masking policy does not apply. The specified users receive data results without masking for all of the database queries.",
          "type": "string"
        },
        "applicationPrincipals": {
          "description": "The list of the application principals. This is a legacy parameter and is no longer used.",
          "type": "string",
          "readOnly": true
        },
        "maskingLevel": {
          "description": "The masking level. This is a legacy parameter and is no longer used.",
          "type": "string",
          "readOnly": true
        }
      }
    }
  },
  "parameters": {
    "DatabaseNameParameter": {
      "name": "databaseName",
      "in": "path",
      "description": "The name of the database.",
      "required": true,
      "type": "string",
      "x-ms-parameter-location": "method"
    },
    "ServerNameParameter": {
      "name": "serverName",
      "in": "path",
      "description": "The name of the server.",
      "required": true,
      "type": "string",
      "x-ms-parameter-location": "method"
    }
  },
  "securityDefinitions": {
    "azure_auth": {
      "type": "oauth2",
      "description": "Azure Active Directory OAuth2 Flow",
      "flow": "implicit",
      "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
      "scopes": {
        "user_impersonation": "impersonate your user account"
      }
    }
  }
}