Classification Rules - Get

Serviço:

Purview

Versão da API:

2023-09-01

Obtém uma regra de classificação.

GET {endpoint}/scan/classificationrules/{classificationRuleName}?api-version=2023-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
classificationRuleName	path	True	string minLength: 3 maxLength: 63 pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$	O nome da regra de classificação.
endpoint	path	True	string (url)	O ponto de extremidade de verificação da sua conta do Purview. Exemplo: https://{accountName}.purview.azure.com.
api-version	query	True	string	A versão da API a ser usada.

Respostas

Nome	Tipo	Description
200 OK	ClassificationRule: SystemClassificationRule CustomClassificationRule	Êxito.
Other Status Codes	ErrorResponseModel	Uma resposta de erro recebida do Serviço de Verificação. Cabeçalhos x-ms-error-code: string

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

ClassificationRules_Get

Solicitação de exemplo

HTTP

GET {endpoint}/scan/classificationrules/ClassificationRule1?api-version=2023-09-01

Resposta de exemplo

Código de status:

200

x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888

{
  "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataCatalog/DataCatalogs/Catalog1/ClassificationRules/ClassificationRule1",
  "name": "ClassificationRule1",
  "kind": "Custom",
  "properties": {
    "minimumPercentageMatch": 80,
    "classificationAction": "Keep",
    "description": "second one",
    "version": 4,
    "classificationName": "CUSTOM.TEST.TWO",
    "ruleStatus": "Enabled",
    "createdAt": "2019-12-09T06:43:30.8478469Z",
    "lastModifiedAt": "2019-12-09T07:04:53.2807344Z",
    "dataPatterns": [
      {
        "kind": "Regex",
        "pattern": "^data1$"
      },
      {
        "kind": "Regex",
        "pattern": "^data2$"
      }
    ],
    "columnPatterns": [
      {
        "kind": "Regex",
        "pattern": "^column1$"
      }
    ]
  }
}

Definições

Nome	Description
ClassificationAction	A ação da regra de classificação.
ClassificationRuleStatus	O status da regra de classificação do sistema.
CustomClassificationRule	Regra de classificação personalizada.
CustomClassificationRuleProperties	As propriedades da regra de classificação personalizada.
ErrorModel	O modelo de erro.
ErrorResponseModel	O modelo de resposta de erro.
RegexClassificationRulePattern	Padrão da regra de classificação regex.
SystemClassificationRule	A regra de classificação do sistema.
SystemClassificationRuleProperties	As propriedades da regra de classificação do sistema.

ClassificationAction

Enumeração

A ação da regra de classificação.

Valor	Description
Keep
Delete

ClassificationRuleStatus

Enumeração

O status da regra de classificação do sistema.

Valor	Description
Enabled
Disabled

CustomClassificationRule

Objeto

Regra de classificação personalizada.

Nome	Tipo	Description
id	string	O identificador de recurso.
kind	string: Custom	O tipo de regra de classificação.
name	string	O nome do recurso.
properties	CustomClassificationRuleProperties	As propriedades da regra de classificação personalizada.

CustomClassificationRuleProperties

Objeto

As propriedades da regra de classificação personalizada.

Nome	Tipo	Description
classificationAction	ClassificationAction	A ação da regra de classificação.
classificationName	string	O nome de classificação da regra de classificação personalizada.
columnPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Os padrões de coluna da regra de classificação personalizada.
createdAt	string (date-time)	O tempo de criação da regra de classificação personalizada.
dataPatterns	ClassificationRulePattern[]: RegexClassificationRulePattern[]	Os padrões de dados da regra de classificação personalizada.
description	string	A descrição da regra de classificação personalizada.
lastModifiedAt	string (date-time)	A hora da última modificação da regra de classificação personalizada.
minimumPercentageMatch	number (double)
ruleStatus	ClassificationRuleStatus	O status da regra de classificação personalizada.
version	integer (int32)	A versão da regra de classificação personalizada.

ErrorModel

Objeto

O modelo de erro.

Nome	Tipo	Description
code	string	Um código de erro exclusivo que identifica o erro específico.
details	ErrorModel[]	Uma matriz de objetos ErrorModel aninhados que fornece detalhes adicionais de erro.
message	string	Uma mensagem de erro legível por humanos que fornece mais detalhes sobre o erro.
target	string	O componente específico ao qual o erro está associado.

ErrorResponseModel

Objeto

O modelo de resposta de erro.

Nome	Tipo	Description
error	ErrorModel	O modelo de erro.

RegexClassificationRulePattern

Objeto

Padrão da regra de classificação regex.

Nome	Tipo	Description
kind	string: Regex	As propriedades do padrão de regra de classificação.
pattern	string	O padrão do padrão de regra de classificação regex.

SystemClassificationRule

Objeto

A regra de classificação do sistema.

Nome	Tipo	Description
id	string	O identificador de recurso.
kind	string: System	O tipo de regra de classificação.
name	string	O nome do recurso.
properties	SystemClassificationRuleProperties	As propriedades da regra de classificação do sistema.

SystemClassificationRuleProperties

Objeto

As propriedades da regra de classificação do sistema.

Nome	Tipo	Description
classificationName	string	O nome de classificação da regra de classificação do sistema.
createdAt	string (date-time)	O tempo de criação da regra de classificação do sistema.
description	string
lastModifiedAt	string (date-time)	A hora da última modificação da regra de classificação do sistema.
ruleStatus	ClassificationRuleStatus	O status da regra de classificação do sistema.
version	integer (int32)	A versão da regra de classificação do sistema.