openapi-directory/api/azure.com/sql-dataMasking.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Provides create, read, update and delete functionality for Azure SQL Database datamasking policies and rules.","title":"Azure SQL Database Datamasking Policies and Rules","version":"2014-04-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/dataMasking.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-dataMasking","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}":{"get":{"description":"Gets a database data masking policy.","operationId":"DataMaskingPolicies_Get","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get data masking policy":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Get data masking policy":{"value":"00000000-1111-2222-3333-444444444444"}}},{"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.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get data masking policy":{"value":"sqlcrudtest-6852"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"$ref":"#/components/parameters/DataMaskingPolicyNameParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMaskingPolicy"},"examples":{"Get data masking policy":{"$ref":"#/components/examples/Get_data_masking_policy"}}}}}},"tags":["DataMaskingPolicies"]},"put":{"description":"Creates or updates a database data masking policy","operationId":"DataMaskingPolicies_CreateOrUpdate","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Create or update data masking policy max":{"value":"2014-04-01"},"Create or update data masking policy min":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Create or update data masking policy max":{"value":"00000000-1111-2222-3333-444444444444"},"Create or update data masking policy min":{"value":"00000000-1111-2222-3333-444444444444"}}},{"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.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create or update data masking policy max":{"value":"sqlcrudtest-6852"},"Create or update data masking policy min":{"value":"sqlcrudtest-6852"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"$ref":"#/components/parameters/DataMaskingPolicyNameParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMaskingPolicy"}}},"description":"Parameters for creating or updating a data masking policy.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMaskingPolicy"},"examples":{"Create or update data masking policy max":{"$ref":"#/components/examples/Create_or_update_data_masking_policy_max"},"Create or update data masking policy min":{"$ref":"#/components/examples/Create_or_update_data_masking_policy_min"}}}}}},"tags":["DataMaskingPolicies"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}/rules":{"get":{"description":"Gets a list of database data masking rules.","operationId":"DataMaskingRules_ListByDatabase","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"List data masking rules":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"List data masking rules":{"value":"00000000-1111-2222-3333-444444444444"}}},{"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.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List data masking rules":{"value":"sqlcrudtest-6852"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"$ref":"#/components/parameters/DataMaskingPolicyNameParameter"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMaskingRuleListResult"},"examples":{"List data masking rules":{"$ref":"#/components/examples/List_data_masking_rules"}}}}}},"tags":["DataMaskingRules"],"x-ms-pageable":{}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/{dataMaskingPolicyName}/rules/{dataMaskingRuleName}":{"put":{"description":"Creates or updates a database data masking rule.","operationId":"DataMaskingRules_CreateOrUpdate","parameters":[{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Create/Update data masking rule for default max":{"value":"2014-04-01"},"Create/Update data masking rule for default min":{"value":"2014-04-01"},"Create/Update data masking rule for numbers":{"value":"2014-04-01"},"Create/Update data masking rule for text":{"value":"2014-04-01"}}},{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Create/Update data masking rule for default max":{"value":"00000000-1111-2222-3333-444444444444"},"Create/Update data masking rule for default min":{"value":"00000000-1111-2222-3333-444444444444"},"Create/Update data masking rule for numbers":{"value":"00000000-1111-2222-3333-444444444444"},"Create/Update data masking rule for text":{"value":"00000000-1111-2222-3333-444444444444"}}},{"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.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Create/Update data masking rule for default max":{"value":"sqlcrudtest-6852"},"Create/Update data masking rule for default min":{"value":"sqlcrudtest-6852"},"Create/Update data masking rule for numbers":{"value":"sqlcrudtest-6852"},"Create/Update data masking rule for text":{"value":"sqlcrudtest-6852"}}},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/DatabaseNameParameter"},{"$ref":"#/components/parameters/DataMaskingPolicyNameParameter"},{"description":"The name of the data masking rule.","in":"path","name":"dataMaskingRuleName","required":true,"schema":{"type":"string"},"examples":{"Create/Update data masking rule for default max":{"value":"rule1"},"Create/Update data masking rule for default min":{"value":"rule1"},"Create/Update data masking rule for numbers":{"value":"rule1"},"Create/Update data masking rule for text":{"value":"rule1"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMaskingRule"}}},"description":"The required parameters for creating or updating a data masking rule.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMaskingRule"},"examples":{"Create/Update data masking rule for default max":{"$ref":"#/components/examples/Create_Update_data_masking_rule_for_default_max"},"Create/Update data masking rule for default min":{"$ref":"#/components/examples/Create_Update_data_masking_rule_for_default_min"},"Create/Update data masking rule for numbers":{"$ref":"#/components/examples/Create_Update_data_masking_rule_for_numbers"},"Create/Update data masking rule for text":{"$ref":"#/components/examples/Create_Update_data_masking_rule_for_text"}}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataMaskingRule"},"examples":{"Create/Update data masking rule for default max":{"$ref":"#/components/examples/Create_Update_data_masking_rule_for_default_max"},"Create/Update data masking rule for default min":{"$ref":"#/components/examples/Create_Update_data_masking_rule_for_default_min"},"Create/Update data masking rule for numbers":{"$ref":"#/components/examples/Create_Update_data_masking_rule_for_numbers"},"Create/Update data masking rule for text":{"$ref":"#/components/examples/Create_Update_data_masking_rule_for_text"}}}}}},"tags":["DataMaskingRules"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Get_data_masking_policy":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default","location":"Central US","name":"Default","properties":{"applicationPrincipals":"","dataMaskingState":"Enabled","exemptPrincipals":"","maskingLevel":""},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies"}},"Create_or_update_data_masking_policy_max":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default","location":"Central US","name":"Default","properties":{"applicationPrincipals":"","dataMaskingState":"Enabled","exemptPrincipals":"testuser;","maskingLevel":""},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies"}},"Create_or_update_data_masking_policy_min":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default","location":"Central US","name":"Default","properties":{"applicationPrincipals":"","dataMaskingState":"Enabled","exemptPrincipals":"","maskingLevel":""},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies"}},"List_data_masking_rules":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/","location":"Central US","properties":{"columnName":"test1","id":"dbo_Table_1_test1","maskingFunction":"Text","prefixSize":"1","replacementString":"asdf","ruleState":"Enabled","schemaName":"dbo","suffixSize":"0","tableName":"Table_1"},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/","location":"Central US","properties":{"columnName":"test1","id":"dbo_Table_1_test1","maskingFunction":"Number","numberFrom":"0","numberTo":"2","ruleState":"Enabled","schemaName":"dbo","tableName":"Table_1"},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"}]}},"Create_Update_data_masking_rule_for_default_max":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/","location":"Central US","properties":{"aliasName":"nickname","columnName":"test1","id":"dbo_Table_1_test1","maskingFunction":"Default","ruleState":"Enabled","schemaName":"dbo","tableName":"Table_1"},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"}},"Create_Update_data_masking_rule_for_default_min":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/","location":"Central US","properties":{"columnName":"test1","id":"dbo_Table_1_test1","maskingFunction":"Default","ruleState":"Enabled","schemaName":"dbo","tableName":"Table_1"},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"}},"Create_Update_data_masking_rule_for_numbers":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/","location":"Central US","properties":{"columnName":"test1","id":"dbo_Table_1_test1","maskingFunction":"Number","numberFrom":"0","numberTo":"2","ruleState":"Enabled","schemaName":"dbo","tableName":"Table_1"},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"}},"Create_Update_data_masking_rule_for_text":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-6852/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/","location":"Central US","properties":{"columnName":"test1","id":"dbo_Table_1_test1","maskingFunction":"Text","prefixSize":"1","replacementString":"asdf","ruleState":"Enabled","schemaName":"dbo","suffixSize":"0","tableName":"Table_1"},"type":"Microsoft.Sql/servers/databases/dataMaskingPolicies/rules"}}},"parameters":{"DataMaskingPolicyNameParameter":{"description":"The name of the database for which the data masking rule applies.","in":"path","name":"dataMaskingPolicyName","required":true,"x-ms-enum":{"modelAsString":false,"name":"DataMaskingPolicyName"},"x-ms-parameter-location":"method","schema":{"type":"string","enum":["Default"]},"examples":{"Get data masking policy":{"value":"Default"},"Create or update data masking policy max":{"value":"Default"},"Create or update data masking policy min":{"value":"Default"},"List data masking rules":{"value":"Default"},"Create/Update data masking rule for default max":{"value":"Default"},"Create/Update data masking rule for default min":{"value":"Default"},"Create/Update data masking rule for numbers":{"value":"Default"},"Create/Update data masking rule for text":{"value":"Default"}}},"DatabaseNameParameter":{"description":"The name of the database.","in":"path","name":"databaseName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get data masking policy":{"value":"sqlcrudtest-331"},"Create or update data masking policy max":{"value":"sqlcrudtest-331"},"Create or update data masking policy min":{"value":"sqlcrudtest-331"},"List data masking rules":{"value":"sqlcrudtest-331"},"Create/Update data masking rule for default max":{"value":"sqlcrudtest-331"},"Create/Update data masking rule for default min":{"value":"sqlcrudtest-331"},"Create/Update data masking rule for numbers":{"value":"sqlcrudtest-331"},"Create/Update data masking rule for text":{"value":"sqlcrudtest-331"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get data masking policy":{"value":"sqlcrudtest-2080"},"Create or update data masking policy max":{"value":"sqlcrudtest-2080"},"Create or update data masking policy min":{"value":"sqlcrudtest-2080"},"List data masking rules":{"value":"sqlcrudtest-2080"},"Create/Update data masking rule for default max":{"value":"sqlcrudtest-2080"},"Create/Update data masking rule for default min":{"value":"sqlcrudtest-2080"},"Create/Update data masking rule for numbers":{"value":"sqlcrudtest-2080"},"Create/Update data masking rule for text":{"value":"sqlcrudtest-2080"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"DataMaskingPolicy":{"allOf":[{"allOf":[{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"Represents a database data masking policy.","properties":{"kind":{"description":"The kind of data masking policy. Metadata, used for Azure portal.","readOnly":true,"type":"string"},"location":{"description":"The location of the data masking policy.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/DataMaskingPolicyProperties"}}},"DataMaskingPolicyProperties":{"description":"The properties of a database data masking policy.","properties":{"applicationPrincipals":{"description":"The list of the application principals. This is a legacy parameter and is no longer used.","readOnly":true,"type":"string"},"dataMaskingState":{"description":"The state of the data masking policy.","enum":["Disabled","Enabled"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"DataMaskingState"}},"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"},"maskingLevel":{"description":"The masking level. This is a legacy parameter and is no longer used.","readOnly":true,"type":"string"}},"required":["dataMaskingState"]},"DataMaskingRule":{"allOf":[{"allOf":[{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"Represents a database data masking rule.","properties":{"kind":{"description":"The kind of Data Masking Rule. Metadata, used for Azure portal.","readOnly":true,"type":"string"},"location":{"description":"The location of the data masking rule.","readOnly":true,"type":"string"},"properties":{"$ref":"#/components/schemas/DataMaskingRuleProperties"}}},"DataMaskingRuleListResult":{"description":"The response to a list data masking rules request.","properties":{"value":{"description":"The list of database data masking rules.","items":{"$ref":"#/components/schemas/DataMaskingRule"},"type":"array"}}},"DataMaskingRuleProperties":{"description":"The properties of a database data masking rule.","properties":{"aliasName":{"description":"The alias name. This is a legacy parameter and is no longer used.","type":"string"},"columnName":{"description":"The column name on which the data masking rule is applied.","type":"string"},"id":{"description":"The rule Id.","readOnly":true,"type":"string"},"maskingFunction":{"description":"The masking function that is used for the data masking rule.","enum":["Default","CCN","Email","Number","SSN","Text"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"DataMaskingFunction"}},"numberFrom":{"description":"The numberFrom property of the masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.","type":"string"},"numberTo":{"description":"The numberTo property of the data masking rule. Required if maskingFunction is set to Number, otherwise this parameter will be ignored.","type":"string"},"prefixSize":{"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.","type":"string"},"replacementString":{"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.","type":"string"},"ruleState":{"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"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"DataMaskingRuleState"}},"schemaName":{"description":"The schema name on which the data masking rule is applied.","type":"string"},"suffixSize":{"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.","type":"string"},"tableName":{"description":"The table name on which the data masking rule is applied.","type":"string"}},"required":["maskingFunction","schemaName","tableName","columnName"]}}}}