Partager via

Data Masking Rules - Create Or Update

Service:
SQL Database
Version d'API:
2025-01-01

Crée ou met à jour une règle de masquage des données de base de données.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/dataMaskingPolicies/Default/rules/{dataMaskingRuleName}?api-version=2025-01-01

Paramètres URI

Nom Dans Obligatoire Type Description
databaseName
 path True

string

Nom de la base de données.
dataMaskingPolicyName
 path True

DataMaskingPolicyName

Le nom de la base de données pour laquelle s’applique la politique de masquage des données.
dataMaskingRuleName
 path True

string

Le nom de la règle de masquage des données.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nom du groupe de ressources. Le nom ne respecte pas la casse.
serverName
 path True

string

Le nom du serveur
subscriptionId
 path True

string (uuid)

ID de l’abonnement cible. La valeur doit être un UUID.
api-version
 query True

string

minLength: 1

Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom Obligatoire Type Description
properties.columnName True

string

Nom de colonne sur lequel la règle de masquage des données est appliquée.
properties.maskingFunction True

DataMaskingFunction

Fonction de masquage utilisée pour la règle de masquage des données.
properties.schemaName True

string

Nom du schéma sur lequel la règle de masquage des données est appliquée.
properties.tableName True

string

Nom de table sur lequel la règle de masquage des données est appliquée.
properties.aliasName

string

Nom de l’alias. Il s’agit d’un paramètre hérité et n’est plus utilisé.
properties.numberFrom

string

Propriété numberFrom de la règle de masquage. Obligatoire si maskingFunction est défini sur Number, sinon ce paramètre est ignoré.
properties.numberTo

string

Propriété numberTo de la règle de masquage des données. Obligatoire si maskingFunction est défini sur Number, sinon ce paramètre est ignoré.
properties.prefixSize

string

Si maskingFunction est défini sur Text, le nombre de caractères à afficher non masqués au début de la chaîne. Dans le cas contraire, ce paramètre sera ignoré.
properties.replacementString

string

Si maskingFunction est défini sur Text, le caractère à utiliser pour masquer la partie non exposée de la chaîne. Dans le cas contraire, ce paramètre sera ignoré.
properties.ruleState

DataMaskingRuleState

État de la règle. Utilisé pour supprimer une règle. Pour supprimer une règle existante, spécifiez schemaName, tableName, columnName, maskingFunction et spécifiez ruleState comme désactivé. Toutefois, si la règle n’existe pas déjà, la règle est créée avec ruleState défini sur activé, quelle que soit la valeur fournie de ruleState.
properties.suffixSize

string

Si maskingFunction est défini sur Text, le nombre de caractères à afficher non masqués à la fin de la chaîne. Dans le cas contraire, ce paramètre sera ignoré.

Réponses

Nom Type Description
200 OK

DataMaskingRule

Opération Azure terminée avec succès.
201 Created

DataMaskingRule

Ressource 'DataMaskingRule' créer une opération réussie
Other Status Codes

ErrorResponse

Réponse d’erreur inattendue.

Sécurité

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom Description
user_impersonation emprunter l’identité de votre compte d’utilisateur

Exemples

Create/Update data masking rule for default max.
Create/Update data masking rule for default min.
Create/Update data masking rule for numbers.
Create/Update data masking rule for text.

Create/Update data masking rule for default max.

Exemple de requête

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "maskingFunction": "Default",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

Exemple de réponse

Code d’état:
200 
{
  "name": null,
  "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/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
Code d’état:
201 
{
  "name": null,
  "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/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": "nickname",
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for default min.

Exemple de requête

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Default",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

Exemple de réponse

Code d’état:
200 
{
  "name": null,
  "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/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
Code d’état:
201 
{
  "name": null,
  "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/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Default",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for numbers.

Exemple de requête

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "schemaName": "dbo",
    "tableName": "Table_1"
  }
}

Exemple de réponse

Code d’état:
200 
{
  "name": null,
  "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/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}
Code d’état:
201 
{
  "name": null,
  "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/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Number",
    "numberFrom": "0",
    "numberTo": "2",
    "prefixSize": null,
    "replacementString": null,
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": null,
    "tableName": "Table_1"
  }
}

Create/Update data masking rule for text.

Exemple de requête

PUT https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-6852/providers/Microsoft.Sql/servers/sqlcrudtest-2080/databases/sqlcrudtest-331/dataMaskingPolicies/Default/rules/rule1?api-version=2025-01-01

{
  "properties": {
    "columnName": "test1",
    "maskingFunction": "Text",
    "prefixSize": "1",
    "replacementString": "asdf",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}

Exemple de réponse

Code d’état:
200 
{
  "name": null,
  "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/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "replacementString": "asdf",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}
Code d’état:
201 
{
  "name": null,
  "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/rule1",
  "kind": null,
  "location": "Central US",
  "properties": {
    "aliasName": null,
    "columnName": "test1",
    "id": "dbo_Table_1_test1",
    "maskingFunction": "Text",
    "numberFrom": null,
    "numberTo": null,
    "prefixSize": "1",
    "replacementString": "asdf",
    "ruleState": "Enabled",
    "schemaName": "dbo",
    "suffixSize": "0",
    "tableName": "Table_1"
  }
}

Définitions

Nom Description
createdByType

Type d’identité qui a créé la ressource.
DataMaskingFunction

Fonction de masquage utilisée pour la règle de masquage des données.
DataMaskingPolicyName
DataMaskingRule

Une règle de masquage des données de base de données.
DataMaskingRuleState

État de la règle. Utilisé pour supprimer une règle. Pour supprimer une règle existante, spécifiez schemaName, tableName, columnName, maskingFunction et spécifiez ruleState comme désactivé. Toutefois, si la règle n’existe pas déjà, la règle est créée avec ruleState défini sur activé, quelle que soit la valeur fournie de ruleState.
ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail

Détail de l’erreur.
ErrorResponse

Réponse d’erreur
systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

createdByType

Énumération

Type d’identité qui a créé la ressource.

Valeur Description
User
Application
ManagedIdentity
Key

DataMaskingFunction

Énumération

Fonction de masquage utilisée pour la règle de masquage des données.

Valeur Description
Default

Par défaut
CCN

CCN
Email

Courrier électronique
Number

Numéro
SSN

Numéro de sécurité sociale
Text

Texte

DataMaskingPolicyName

Énumération
Valeur Description
Default

Par défaut

DataMaskingRule

Objet

Une règle de masquage des données de base de données.

Nom Type Description
id

string (arm-id)

ID de ressource complet pour la ressource. Par exemple, « /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} »
kind

string

Le genre de règle du masquage des données. Métadonnées, utilisées pour le portail Azure.
location

string

L’emplacement de la règle de masquage des données.
name

string

Nom de la ressource
properties.aliasName

string

Nom de l’alias. Il s’agit d’un paramètre hérité et n’est plus utilisé.
properties.columnName

string

Nom de colonne sur lequel la règle de masquage des données est appliquée.
properties.id

string

La règle ID.
properties.maskingFunction

DataMaskingFunction

Fonction de masquage utilisée pour la règle de masquage des données.
properties.numberFrom

string

Propriété numberFrom de la règle de masquage. Obligatoire si maskingFunction est défini sur Number, sinon ce paramètre est ignoré.
properties.numberTo

string

Propriété numberTo de la règle de masquage des données. Obligatoire si maskingFunction est défini sur Number, sinon ce paramètre est ignoré.
properties.prefixSize

string

Si maskingFunction est défini sur Text, le nombre de caractères à afficher non masqués au début de la chaîne. Dans le cas contraire, ce paramètre sera ignoré.
properties.replacementString

string

Si maskingFunction est défini sur Text, le caractère à utiliser pour masquer la partie non exposée de la chaîne. Dans le cas contraire, ce paramètre sera ignoré.
properties.ruleState

DataMaskingRuleState

État de la règle. Utilisé pour supprimer une règle. Pour supprimer une règle existante, spécifiez schemaName, tableName, columnName, maskingFunction et spécifiez ruleState comme désactivé. Toutefois, si la règle n’existe pas déjà, la règle est créée avec ruleState défini sur activé, quelle que soit la valeur fournie de ruleState.
properties.schemaName

string

Nom du schéma sur lequel la règle de masquage des données est appliquée.
properties.suffixSize

string

Si maskingFunction est défini sur Text, le nombre de caractères à afficher non masqués à la fin de la chaîne. Dans le cas contraire, ce paramètre sera ignoré.
properties.tableName

string

Nom de table sur lequel la règle de masquage des données est appliquée.
systemData

systemData

Azure Resource Manager : métadonnées contenant des informations createdBy et modifiedBy.
type

string

Type de la ressource. Par exemple : « Microsoft. Calcul/virtualMachines » ou « Microsoft. StorageAccounts"

DataMaskingRuleState

Énumération

État de la règle. Utilisé pour supprimer une règle. Pour supprimer une règle existante, spécifiez schemaName, tableName, columnName, maskingFunction et spécifiez ruleState comme désactivé. Toutefois, si la règle n’existe pas déjà, la règle est créée avec ruleState défini sur activé, quelle que soit la valeur fournie de ruleState.

Valeur Description
Enabled

Activé
Disabled

Désactivé

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom Type Description
info

object

Informations supplémentaires.
type

string

Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom Type Description
additionalInfo

ErrorAdditionalInfo[]

Informations supplémentaires sur l’erreur.
code

string

Code d’erreur.
details

ErrorDetail[]

Détails de l’erreur.
message

string

Message d’erreur.
target

string

Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom Type Description
error

ErrorDetail

Objet d’erreur.

systemData

Objet

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom Type Description
createdAt

string (date-time)

Horodatage de la création de ressources (UTC).
createdBy

string

Identité qui a créé la ressource.
createdByType

createdByType

Type d’identité qui a créé la ressource.
lastModifiedAt

string (date-time)

Horodatage de la dernière modification de ressource (UTC)
lastModifiedBy

string

Identité qui a modifié la ressource pour la dernière fois.
lastModifiedByType

createdByType

Type d’identité qui a modifié la ressource pour la dernière fois.