{ "swagger": "2.0", "info": { "title": "MicrosoftScanningClient", "description": "Creates a Microsoft.Scanning management client.", "version": "2023-09-01" }, "host": "purview.azure.com", "basePath": "/scan", "schemes": [ "https" ], "produces": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" }, "description": "Azure Active Directory OAuth2 Flow." } }, "x-ms-parameterized-host": { "hostTemplate": "{endpoint}", "useSchemePrefix": false, "parameters": [ { "$ref": "#/parameters/endpoint" } ] }, "paths": { "/azureKeyVaults/{azureKeyVaultName}": { "get": { "tags": [ "AzureKeyVaults" ], "description": "Gets an Azure Key Vault connection.", "operationId": "KeyVaultConnections_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/azureKeyVaultName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/AzureKeyVault" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "KeyVaultConnections_Get": { "$ref": "./examples/KeyVaultConnections_Get.json" } } }, "put": { "tags": [ "AzureKeyVaults" ], "description": "Creates or replaces a connection to Azure Key Vault.", "operationId": "KeyVaultConnections_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/azureKeyVaultName" }, { "in": "body", "name": "body", "description": "The Azure Key Vault connection definition.", "required": true, "schema": { "$ref": "#/definitions/AzureKeyVault" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/AzureKeyVault" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/AzureKeyVault" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "KeyVaultConnections_CreateOrReplace": { "$ref": "./examples/KeyVaultConnections_CreateOrReplace.json" } } }, "delete": { "tags": [ "AzureKeyVaults" ], "description": "Deletes an Azure Key Vault connection associated with the account.", "operationId": "KeyVaultConnections_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/azureKeyVaultName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "KeyVaultConnections_Delete": { "$ref": "./examples/KeyVaultConnections_Delete.json" } } } }, "/azureKeyVaults": { "get": { "tags": [ "AzureKeyVaults" ], "description": "Lists Azure Key Vaults in an account.", "operationId": "KeyVaultConnections_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/AzureKeyVaultList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "KeyVaultConnections_List": { "$ref": "./examples/KeyVaultConnections_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/classificationrules/{classificationRuleName}": { "get": { "tags": [ "ClassificationRules" ], "description": "Gets a classification rule.", "operationId": "ClassificationRules_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/classificationRuleName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ClassificationRule" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ClassificationRules_Get": { "$ref": "./examples/ClassificationRules_Get.json" } } }, "put": { "tags": [ "ClassificationRules" ], "description": "Creates or replaces a classification rule.", "operationId": "ClassificationRules_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/classificationRuleName" }, { "in": "body", "name": "body", "required": true, "description": "The classification rule definition.", "schema": { "$ref": "#/definitions/ClassificationRule" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ClassificationRule" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/ClassificationRule" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ClassificationRules_CreateOrReplace": { "$ref": "./examples/ClassificationRules_CreateOrReplace.json" } } }, "delete": { "tags": [ "ClassificationRules" ], "description": "Deletes a classification rule.", "operationId": "ClassificationRules_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/classificationRuleName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ClassificationRules_Delete": { "$ref": "./examples/ClassificationRules_Delete.json" } } } }, "/classificationrules": { "get": { "tags": [ "ClassificationRules" ], "description": "Lists classification rules in Account.", "operationId": "ClassificationRules_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ClassificationRuleList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ClassificationRules_List": { "$ref": "./examples/ClassificationRules_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/classificationrules/{classificationRuleName}/versions": { "get": { "tags": [ "ClassificationRules" ], "description": "Lists the rule versions of a classification rule.", "operationId": "ClassificationRules_ListVersionsByRuleName", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/classificationRuleName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ClassificationRuleList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ClassificationRules_ListVersionsByRuleName": { "$ref": "./examples/ClassificationRules_ListVersionsByRuleName.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/classificationrules/{classificationRuleName}/versions/{classificationRuleVersion}:tag": { "post": { "tags": [ "ClassificationRules" ], "description": "Sets classification action on a specific classification rule version.", "operationId": "ClassificationRules_TagClassificationVersion", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/classificationRuleName" }, { "in": "path", "name": "classificationRuleVersion", "description": "The version of the classification rule.", "required": true, "type": "integer", "format": "int32" }, { "in": "query", "name": "action", "description": "The action of classification rule.", "required": true, "type": "string", "enum": [ "Keep", "Delete" ], "x-ms-enum": { "name": "ClassificationAction", "values": [ { "value": "Keep", "description": "the classification action is keep" }, { "value": "Delete", "description": "the classification action is delete" } ], "modelAsString": true } }, { "$ref": "#/parameters/api-version" } ], "responses": { "202": { "description": "Success.", "headers": { "Operation-Location": { "description": "Response header for long running operation.", "type": "string" } }, "schema": { "$ref": "#/definitions/OperationResponse" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "ClassificationRules_TagClassificationVersion": { "$ref": "./examples/ClassificationRules_TagClassificationVersion.json" } } } }, "/credentials/{credentialName}": { "get": { "tags": [ "Credential" ], "description": "Gets credential information.", "operationId": "Credential_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/credentialName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Credential" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Credential_Get": { "$ref": "./examples/Credential_Get.json" } } }, "put": { "tags": [ "Credential" ], "description": "Creates or replaces an instance of a credential.", "operationId": "Credential_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/credentialName" }, { "in": "body", "name": "body", "required": true, "description": "The credential definition.", "schema": { "$ref": "#/definitions/Credential" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Credential" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/Credential" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Credential_CreateOrReplace": { "$ref": "./examples/Credential_CreateOrReplace.json" } } }, "delete": { "tags": [ "Credential" ], "description": "Deletes a credential associated with the account.", "operationId": "Credential_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/credentialName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Credential_Delete": { "$ref": "./examples/Credential_Delete.json" } } } }, "/credentials": { "get": { "tags": [ "Credential" ], "description": "Lists credentials in account.", "operationId": "Credential_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/CredentialList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Credential_List": { "$ref": "./examples/Credential_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/datasources/{dataSourceName}": { "put": { "tags": [ "DataSources" ], "description": "Creates or replaces a data source.", "operationId": "DataSources_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "in": "body", "name": "body", "required": true, "description": "The data source definition.", "schema": { "$ref": "#/definitions/DataSource" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/DataSource" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/DataSource" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "DataSources_CreateOrReplace": { "$ref": "./examples/DataSources_CreateOrReplace.json" } } }, "get": { "tags": [ "DataSources" ], "description": "Gets a data source.", "operationId": "DataSources_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/DataSource" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "DataSources_Get": { "$ref": "./examples/DataSources_Get.json" } } }, "delete": { "tags": [ "DataSources" ], "description": "Deletes a data source.", "operationId": "DataSources_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "DataSources_Delete": { "$ref": "./examples/DataSources_Delete.json" } } } }, "/datasources": { "get": { "tags": [ "DataSources" ], "description": "Lists data sources in Data catalog.", "operationId": "DataSources_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/DataSourceList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "DataSources_List": { "$ref": "./examples/DataSources_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/datasources/{dataSourceName}/scans/{scanName}/filters/custom": { "get": { "tags": [ "Filters" ], "description": "Gets a filter.", "operationId": "Filters_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Filter" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Filters_Get": { "$ref": "./examples/Filters_Get.json" } } }, "put": { "tags": [ "Filters" ], "description": "Creates or replaces a filter.", "operationId": "Filters_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "in": "body", "name": "body", "required": true, "description": "The filter definition.", "schema": { "$ref": "#/definitions/Filter" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Filter" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/Filter" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Filters_CreateOrReplace": { "$ref": "./examples/Filters_CreateOrReplace.json" } } } }, "/integrationruntimes": { "get": { "tags": [ "IntegrationRuntimes" ], "description": "Lists integration runtimes in an account.", "operationId": "IntegrationRuntimes_ListByAccount", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/IntegrationRuntimeList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IntegrationRuntimes_ListByAccount": { "$ref": "./examples/IntegrationRuntimes_ListByAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/integrationruntimes/{integrationRuntimeName}": { "get": { "tags": [ "IntegrationRuntimes" ], "description": "Gets an integration runtime.", "operationId": "IntegrationRuntimes_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/IntegrationRuntime" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IntegrationRuntimes_Get": { "$ref": "./examples/IntegrationRuntimes_Get.json" } } }, "delete": { "tags": [ "IntegrationRuntimes" ], "description": "Deletes an integration runtime.", "operationId": "IntegrationRuntimes_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IntegrationRuntimes_Delete": { "$ref": "./examples/IntegrationRuntimes_Delete.json" } } }, "put": { "tags": [ "IntegrationRuntimes" ], "description": "Creates or replaces an instance of integration runtime.", "operationId": "IntegrationRuntimes_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/integrationRuntimeName" }, { "in": "body", "name": "body", "required": true, "description": "The integration runtime definition.", "schema": { "$ref": "#/definitions/IntegrationRuntime" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/IntegrationRuntime" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/IntegrationRuntime" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IntegrationRuntimes_CreateOrReplace": { "$ref": "./examples/IntegrationRuntimes_CreateOrReplace.json" } } } }, "/integrationruntimes/{integrationRuntimeName}/status": { "get": { "tags": [ "IntegrationRuntimes" ], "description": "Gets detailed status information for an integration runtime.", "operationId": "IntegrationRuntimes_Status", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/IntegrationRuntimeStatus" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IntegrationRuntimes_Status": { "$ref": "./examples/IntegrationRuntimes_Status.json" } } } }, "/integrationruntimes/{integrationRuntimeName}:listAuthKeys": { "post": { "tags": [ "IntegrationRuntimes" ], "description": "Retrieves the authentication keys for an integration runtime.", "operationId": "IntegrationRuntimes_ListAuthKeys", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/IntegrationRuntimeAuthKeys" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IntegrationRuntimes_ListAuthKeys": { "$ref": "./examples/IntegrationRuntimes_ListAuthKeys.json" } } } }, "/integrationruntimes/{integrationRuntimeName}:regenerateAuthKey": { "post": { "tags": [ "IntegrationRuntimes" ], "description": "Regenerates the authentication key for an integration runtime.", "operationId": "IntegrationRuntimes_RegenerateAuthKey", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/integrationRuntimeName" }, { "in": "body", "name": "body", "required": true, "description": "The request of regenerating authentication key of an integration runtime.", "schema": { "$ref": "#/definitions/IntegrationRuntimeRegenerateKeyParameters" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/IntegrationRuntimeAuthKeys" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "IntegrationRuntimes_RegenerateAuthKey": { "$ref": "./examples/IntegrationRuntimes_RegenerateAuthKey.json" } } } }, "/integrationruntimes/{integrationRuntimeName}:disableInteractiveQuery": { "post": { "tags": [ "IntegrationRuntimes" ], "description": "Disables interactive querying.", "operationId": "IntegrationRuntimes_DisableInteractiveQuery", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/integrationRuntimeName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "202": { "description": "Success.", "headers": { "Operation-Location": { "description": "Response header for long running operation.", "type": "string" } }, "schema": { "$ref": "#/definitions/OperationResponse" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "IntegrationRuntimes_DisableInteractiveQuery": { "$ref": "./examples/IntegrationRuntimes_DisableInteractiveQuery.json" } } } }, "/integrationruntimes/{integrationRuntimeName}:enableInteractiveQuery": { "post": { "tags": [ "IntegrationRuntimes" ], "description": "Enables interactive querying.", "operationId": "IntegrationRuntimes_EnableInteractiveQuery", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/integrationRuntimeName" }, { "in": "body", "name": "body", "description": "The request of enabling interactive query for integration runtime.", "required": true, "schema": { "$ref": "#/definitions/EnableInteractiveQueryForIntegrationRuntimeRequest" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "202": { "description": "Success.", "headers": { "Operation-Location": { "description": "Response header for long running operation.", "type": "string" } }, "schema": { "$ref": "#/definitions/OperationResponse" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "IntegrationRuntimes_EnableInteractiveQuery": { "$ref": "./examples/IntegrationRuntimes_EnableInteractiveQuery.json" } } } }, "/managedvirtualnetworks": { "get": { "tags": [ "ManagedVirtualNetworks" ], "description": "Lists managed virtual networks in an account.", "operationId": "ManagedVirtualNetworks_ListByAccount", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ManagedVirtualNetworkList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ManagedVirtualNetworks_ListByAccount": { "$ref": "./examples/ManagedVirtualNetworks_ListByAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/managedvirtualnetworks/{managedVirtualNetworkName}": { "get": { "tags": [ "ManagedVirtualNetworks" ], "description": "Gets a managed virtual network.", "operationId": "ManagedVirtualNetworks_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/managedVirtualNetworkName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ManagedVirtualNetwork" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ManagedVirtualNetworks_Get": { "$ref": "./examples/ManagedVirtualNetworks_Get.json" } } }, "put": { "tags": [ "ManagedVirtualNetworks" ], "description": "Creates or replaces a managed virtual network.", "operationId": "ManagedVirtualNetworks_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/managedVirtualNetworkName" }, { "in": "body", "name": "body", "description": "The managed virtual network resource definition.", "required": true, "schema": { "$ref": "#/definitions/ManagedVirtualNetwork" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ManagedVirtualNetwork" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/ManagedVirtualNetwork" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ManagedVirtualNetworks_CreateOrReplace": { "$ref": "./examples/ManagedVirtualNetworks_CreateOrReplace.json" } } } }, "/managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints": { "get": { "tags": [ "ManagedPrivateEndpoints" ], "description": "Lists managed private endpoints under a managed virtual network.", "operationId": "ManagedPrivateEndpoints_ListByAccount", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/managedVirtualNetworkName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpointList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ManagedPrivateEndpoints_ListByAccount": { "$ref": "./examples/ManagedPrivateEndpoints_ListByAccount.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/managedvirtualnetworks/{managedVirtualNetworkName}/managedprivateendpoints/{managedPrivateEndpointName}": { "get": { "tags": [ "ManagedPrivateEndpoints" ], "description": "Gets a managed private endpoint.", "operationId": "ManagedPrivateEndpoints_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/managedVirtualNetworkName" }, { "$ref": "#/parameters/managedPrivateEndpointName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ManagedPrivateEndpoints_Get": { "$ref": "./examples/ManagedPrivateEndpoints_Get.json" } } }, "delete": { "tags": [ "ManagedPrivateEndpoints" ], "description": "Deletes a managed private endpoint.", "operationId": "ManagedPrivateEndpoints_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/managedVirtualNetworkName" }, { "$ref": "#/parameters/managedPrivateEndpointName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ManagedPrivateEndpoints_Delete": { "$ref": "./examples/ManagedPrivateEndpoints_Delete.json" } } }, "put": { "tags": [ "ManagedPrivateEndpoints" ], "description": "Creates or replaces a managed private endpoint.", "operationId": "ManagedPrivateEndpoints_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/managedVirtualNetworkName" }, { "$ref": "#/parameters/managedPrivateEndpointName" }, { "in": "body", "name": "body", "description": "The managed private endpoint resource definition.", "required": true, "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ManagedPrivateEndpoints_CreateOrReplace": { "$ref": "./examples/ManagedPrivateEndpoints_CreateOrReplace.json" } } } }, "/datasources/{dataSourceName}/scans/{scanName}": { "put": { "tags": [ "Scan" ], "description": "Creates or replaces an instance of a scan.", "operationId": "Scans_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "in": "body", "name": "body", "description": "The scan definition.", "required": true, "schema": { "$ref": "#/definitions/Scan" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Scan" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/Scan" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Scans_CreateOrReplace": { "$ref": "./examples/Scans_CreateOrReplace.json" } } }, "get": { "tags": [ "Scan" ], "description": "Gets a scan information.", "operationId": "Scans_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Scan" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Scans_Get": { "$ref": "./examples/Scans_Get.json" } } }, "delete": { "tags": [ "Scan" ], "description": "Deletes the scan associated with the data source.", "operationId": "Scans_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Scans_Delete": { "$ref": "./examples/Scans_Delete.json" } } } }, "/datasources/{dataSourceName}/scans": { "get": { "tags": [ "Scan" ], "description": "Lists scans in data source.", "operationId": "Scans_ListByDataSource", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ScanList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Scans_ListByDataSource": { "$ref": "./examples/Scans_ListByDataSource.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}": { "get": { "tags": [ "ScanResult" ], "description": "Gets the status of the scan run with ingestion details.", "operationId": "ScanResult_GetScanStatus", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/runId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ScanResultWithIngestion" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ScanResult_GetScanStatus": { "$ref": "./examples/ScanResult_GetScanStatus.json" } } } }, "/datasources/{dataSourceName}/scans/{scanName}:run": { "post": { "tags": [ "ScanResult" ], "description": "Runs the scan", "operationId": "ScanResult_RunScan", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/runIdInQuery" }, { "in": "query", "name": "scanLevel", "type": "string", "description": "The scan level.", "default": "Incremental", "enum": [ "Full", "Incremental" ], "x-ms-enum": { "name": "ScanLevelType", "values": [ { "value": "Full", "description": "the scan is full scan" }, { "value": "Incremental", "description": "the scan is incremental scan" } ], "modelAsString": true } }, { "$ref": "#/parameters/api-version" } ], "responses": { "202": { "description": "Success", "headers": { "Operation-Location": { "description": "Response header for long running operation.", "type": "string" } }, "schema": { "$ref": "#/definitions/ScanResultWithIngestion" } }, "default": { "description": "An error response received from the Scanning Service", "schema": { "$ref": "#/definitions/ErrorResponseModel" } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "ScanResult_RunScan": { "$ref": "./examples/ScanResult_RunScan.json" } } } }, "/datasources/{dataSourceName}/scans/{scanName}/runs/{runId}:cancel": { "post": { "tags": [ "ScanResult" ], "description": "Cancels a scan.", "operationId": "ScanResult_CancelScan", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/runId" }, { "$ref": "#/parameters/api-version" } ], "responses": { "202": { "description": "Success.", "schema": { "$ref": "#/definitions/OperationResponse" }, "headers": { "Operation-Location": { "description": "Response header for long running operation.", "type": "string" } } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-long-running-operation": true, "x-ms-examples": { "ScanResult_CancelScan": { "$ref": "./examples/ScanResult_CancelScan.json" } } } }, "/datasources/{dataSourceName}/scans/{scanName}/runs": { "get": { "tags": [ "ScanResult" ], "description": "Lists the scan history of a scan.", "operationId": "ScanResult_ListScanHistory", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ScanHistoryListWithIngestion" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ScanResult_ListScanHistory": { "$ref": "./examples/ScanResult_ListScanHistory.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/scanrulesets/{scanRulesetName}": { "get": { "tags": [ "ScanRulesets" ], "description": "Gets a scan ruleset.", "operationId": "ScanRulesets_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/scanRulesetName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ScanRuleset" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ScanRulesets_Get": { "$ref": "./examples/ScanRulesets_Get.json" } } }, "put": { "tags": [ "ScanRulesets" ], "description": "Creates or replaces a scan ruleset.", "operationId": "ScanRulesets_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/scanRulesetName" }, { "in": "body", "name": "body", "required": true, "description": "The scan rule set definition.", "schema": { "$ref": "#/definitions/ScanRuleset" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ScanRuleset" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/ScanRuleset" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ScanRulesets_CreateOrReplace": { "$ref": "./examples/ScanRulesets_CreateOrReplace.json" } } }, "delete": { "tags": [ "ScanRulesets" ], "description": "Deletes a scan ruleset.", "operationId": "ScanRulesets_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/scanRulesetName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ScanRulesets_Delete": { "$ref": "./examples/ScanRulesets_Delete.json" } } } }, "/scanrulesets": { "get": { "tags": [ "ScanRulesets" ], "description": "Lists scan rulesets in data catalog.", "operationId": "ScanRulesets_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/ScanRulesetList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "ScanRulesets_List": { "$ref": "./examples/ScanRulesets_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/systemScanRulesets": { "get": { "tags": [ "SystemScanRulesets" ], "description": "Lists all system scan rulesets for an account.", "operationId": "SystemScanRulesets_List", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/SystemScanRulesetList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "SystemScanRulesets_List": { "$ref": "./examples/SystemScanRulesets_List.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/systemScanRulesets/datasources/{dataSourceType}": { "get": { "tags": [ "SystemScanRulesets" ], "description": "Gets a system scan ruleset for a data source.", "operationId": "SystemScanRulesets_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceTypeInPath" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/SystemScanRuleset" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "SystemScanRulesets_Get": { "$ref": "./examples/SystemScanRulesets_Get.json" } } } }, "/systemScanRulesets/versions/{version}": { "get": { "tags": [ "SystemScanRulesets" ], "description": "Gets a scan ruleset by version.", "operationId": "SystemScanRulesets_GetByVersion", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceTypeInQuery" }, { "in": "path", "name": "version", "required": true, "type": "integer", "description": "The version number.", "format": "int32" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/SystemScanRuleset" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "SystemScanRulesets_GetByVersion": { "$ref": "./examples/SystemScanRulesets_GetByVersion.json" } } } }, "/systemScanRulesets/versions/latest": { "get": { "tags": [ "SystemScanRulesets" ], "description": "Gets the latest version of a system scan ruleset.", "operationId": "SystemScanRulesets_GetLatest", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceTypeInQuery" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/SystemScanRuleset" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "SystemScanRulesets_GetLatest": { "$ref": "./examples/SystemScanRulesets_GetLatest.json" } } } }, "/systemScanRulesets/versions": { "get": { "tags": [ "SystemScanRulesets" ], "description": "Lists system scan ruleset versions in data catalog.", "operationId": "SystemScanRulesets_ListVersionsByDataSource", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceTypeInQuery" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/SystemScanRulesetList" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "SystemScanRulesets_ListVersionsByDataSource": { "$ref": "./examples/SystemScanRulesets_ListVersionsByDataSource.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/datasources/{dataSourceName}/scans/{scanName}/triggers/default": { "get": { "tags": [ "Triggers" ], "description": "Gets trigger information.", "operationId": "Triggers_Get", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Trigger" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Triggers_Get": { "$ref": "./examples/Triggers_Get.json" } } }, "put": { "tags": [ "Triggers" ], "description": "Creates or replaces an instance of a trigger.", "operationId": "Triggers_CreateOrReplace", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "in": "body", "name": "body", "required": true, "description": "The trigger definition.", "schema": { "$ref": "#/definitions/Trigger" } }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Trigger" } }, "201": { "description": "Success.", "schema": { "$ref": "#/definitions/Trigger" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Triggers_CreateOrReplace": { "$ref": "./examples/Triggers_CreateOrReplace.json" } } }, "delete": { "tags": [ "Triggers" ], "description": "Deletes the trigger associated with the scan.", "operationId": "Triggers_Delete", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "204": { "description": "Success." }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Triggers_Delete": { "$ref": "./examples/Triggers_Delete.json" } } } }, "/datasources/{dataSourceName}/scans/{scanName}/triggers/default:enable": { "post": { "tags": [ "Triggers" ], "description": "Enables a trigger.", "operationId": "Triggers_Enable", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Trigger" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Triggers_Enable": { "$ref": "./examples/Triggers_Enable.json" } } } }, "/datasources/{dataSourceName}/scans/{scanName}/triggers/default:disable": { "post": { "tags": [ "Triggers" ], "description": "Disables a trigger.", "operationId": "Triggers_Disable", "produces": [ "application/json" ], "parameters": [ { "$ref": "#/parameters/dataSourceName" }, { "$ref": "#/parameters/scanName" }, { "$ref": "#/parameters/api-version" } ], "responses": { "200": { "description": "Success.", "schema": { "$ref": "#/definitions/Trigger" } }, "default": { "description": "An error response received from the Scanning Service.", "schema": { "$ref": "#/definitions/ErrorResponseModel" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Triggers_Disable": { "$ref": "./examples/Triggers_Disable.json" } } } } }, "definitions": { "AzureKeyVaultProperties": { "description": "Azure Key Vault connection properties.", "type": "object", "properties": { "baseUrl": { "type": "string", "description": "The base URL of the Azure Key Vault." }, "description": { "type": "string", "description": "The description of the Azure Key Vault connection." } } }, "ProxyResource": { "description": "The proxy resource.", "type": "object", "properties": { "id": { "description": "The resource identifier.", "type": "string", "readOnly": true }, "name": { "description": "The resource name.", "type": "string", "readOnly": true } } }, "AzureKeyVault": { "description": "The Azure Key Vault connection.", "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureKeyVaultProperties" } } }, "ErrorModel": { "description": "The error model.", "type": "object", "properties": { "code": { "description": "A unique error code that identifies the specific error.", "type": "string" }, "message": { "description": "A human-readable error message that provides more details about the error.", "type": "string" }, "target": { "description": "The specific component that the error is associated with.", "type": "string" }, "details": { "description": "An array of nested ErrorModel objects that provides additional error details.", "type": "array", "items": { "$ref": "#/definitions/ErrorModel" } } }, "required": [ "code", "message" ] }, "ErrorResponseModel": { "description": "The error response model.", "type": "object", "properties": { "error": { "$ref": "#/definitions/ErrorModel" } }, "required": [ "error" ] }, "AzureKeyVaultList": { "description": "List of Azure Key Vault connections.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of Azure Key Vault connections.", "type": "array", "items": { "$ref": "#/definitions/AzureKeyVault" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string", "format": "uri" }, "count": { "description": "The number of Azure Key Vault connections.", "format": "int64", "type": "integer" } } }, "ClassificationRule": { "description": "The classification rule.", "required": [ "kind" ], "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "kind": { "enum": [ "System", "Custom" ], "type": "string", "description": "The kind of classification rule.", "x-ms-enum": { "name": "ClassificationRuleType", "values": [ { "value": "System", "description": "the classification rule is using system default" }, { "value": "Custom", "description": "the classification rule is custom rule" } ], "modelAsString": true } } }, "discriminator": "kind" }, "ClassificationRuleList": { "description": "List of classification rules.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of classification rules.", "type": "array", "items": { "$ref": "#/definitions/ClassificationRule" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of classification rules.", "format": "int64", "type": "integer" } } }, "ErrorInfo": { "description": "The error info.", "type": "object", "properties": { "code": { "type": "string", "description": "A unique error code that identifies the specific error." }, "message": { "type": "string", "description": "A human-readable error message that provides more details about the error." }, "target": { "type": "string", "description": "The specific component that the error is associated with." }, "details": { "type": "array", "description": "Error info detail.", "items": { "$ref": "#/definitions/ErrorInfo" } } } }, "OperationResponse": { "description": "The operation response.", "type": "object", "properties": { "scanResultId": { "format": "uuid", "type": "string", "description": "The scan result identifier." }, "startTime": { "format": "date-time", "type": "string", "description": "The start time of the operation." }, "endTime": { "format": "date-time", "type": "string", "description": "The end time of the operation." }, "status": { "enum": [ "Accepted", "InProgress", "TransientFailure", "Succeeded", "Failed", "Canceled" ], "type": "string", "description": "Scan operation status.", "x-ms-enum": { "name": "OperationStatus", "values": [ { "value": "Accepted", "description": "the scan is accepted" }, { "value": "InProgress", "description": "the scan is InProgress" }, { "value": "TransientFailure", "description": "the scan is in transient failure" }, { "value": "Succeeded", "description": "the scan is succeeded" }, { "value": "Failed", "description": "the scan is failed" }, { "value": "Canceled", "description": "the scan is canceled" } ], "modelAsString": true } }, "error": { "$ref": "#/definitions/ErrorInfo" } } }, "Credential": { "description": "The credential.", "required": [ "kind" ], "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "kind": { "enum": [ "AccountKey", "ServicePrincipal", "BasicAuth", "SqlAuth", "AmazonARN", "ConsumerKeyAuth", "DelegatedAuth", "ManagedIdentity" ], "type": "string", "description": "The kind of credential.", "x-ms-enum": { "name": "CredentialType", "values": [ { "value": "AccountKey", "description": "the credential type is account key" }, { "value": "ServicePrincipal", "description": "the credential type is service principal" }, { "value": "BasicAuth", "description": "the credential type is basic auth" }, { "value": "SqlAuth", "description": "the credential type is sql auth" }, { "value": "AmazonARN", "description": "the credential type is amazon ARN" }, { "value": "ConsumerKeyAuth", "description": "the credential type is Consumer Key Auth" }, { "value": "DelegatedAuth", "description": "the credential type is delegated auth" }, { "value": "ManagedIdentity", "description": "the credential type is managed identity" } ], "modelAsString": true } } }, "discriminator": "kind" }, "CredentialList": { "description": "List of credentials.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of credentials.", "type": "array", "items": { "$ref": "#/definitions/Credential" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of credentials.", "format": "int64", "type": "integer" } } }, "Notification": { "description": "The notification model.", "type": "object", "properties": { "message": { "type": "string", "description": "Notification message." }, "code": { "format": "int32", "type": "integer", "description": "Notification code." } } }, "ScanDiagnostics": { "description": "The scan diagnostics.", "type": "object", "properties": { "notifications": { "type": "array", "description": "Notifications.", "items": { "$ref": "#/definitions/Notification" } }, "exceptionCountMap": { "type": "object", "description": "Exception count map.", "additionalProperties": { "format": "int32", "type": "integer" }, "readOnly": true } } }, "DataSourceType": { "description": "The data source type.", "enum": [ "None", "Fabric", "AzureSubscription", "AzureResourceGroup", "AzureSynapseWorkspace", "AzureSynapse", "AdlsGen1", "AdlsGen2", "AmazonAccount", "AmazonS3", "AmazonSql", "AzureCosmosDb", "AzureDataExplorer", "AzureFileService", "AzureSqlDatabase", "ArcEnabledSqlServer", "AmazonPostgreSql", "AzurePostgreSql", "Databricks", "SqlServerDatabase", "AzureSqlDatabaseManagedInstance", "AzureSqlDataWarehouse", "AzureMySql", "Hdfs", "TableauServer", "AzureStorage", "Teradata", "Oracle", "PostgreSql", "AmazonRedShift", "DatabricksHms", "SapS4Hana", "SapEcc", "Snowflake", "PowerBI", "Trident", "Dataverse", "DatabricksUnityCatalog" ], "type": "string", "x-ms-enum": { "name": "DataSourceType", "modelAsString": true } }, "DiscoveryExecutionDetails": { "description": "The discovery execution details.", "type": "object", "properties": { "discoveryStartTime": { "format": "date-time", "type": "string", "description": "The discovery start time." }, "discoveryEndTime": { "format": "date-time", "type": "string", "description": "The discovery end time." }, "status": { "enum": [ "Queued", "Running", "Succeeded", "Failed", "Cancelled", "Delayed", "Throttled", "CompletedWithExceptions", "CompleteWithWarning" ], "type": "string", "description": "The discovery status.", "x-ms-enum": { "name": "ScanStatus", "modelAsString": true } }, "statistics": { "type": "object", "description": "The discovery statistics.", "additionalProperties": {} }, "isErrorLogAvailable": { "type": "boolean", "description": "Indicates whether the error log is available." } } }, "IngestionExecutionDetails": { "description": "The ingestion execution details.", "type": "object", "properties": { "ingestionStartTime": { "format": "date-time", "type": "string", "description": "The ingestion start time." }, "ingestionEndTime": { "format": "date-time", "type": "string", "description": "The ingestion end time." }, "status": { "enum": [ "None", "Succeeded", "Queued", "InProgress", "SourceUnknown", "PartialSucceeded", "Failed", "Canceled", "Canceling" ], "type": "string", "description": "The ingestion status.", "x-ms-enum": { "name": "IngestionPhaseStatus", "modelAsString": true } }, "statistics": { "type": "object", "description": "The ingestion statistics.", "additionalProperties": {} }, "estimatedTimeRemainingInSeconds": { "format": "int64", "description": "The estimated time remaining in seconds.", "type": "integer" }, "isErrorLogAvailable": { "type": "boolean", "description": "Indicates whether the error log is available." }, "lastUpdatedAt": { "format": "date-time", "type": "string", "description": "The last updated time." } } }, "ScanResultWithIngestion": { "description": "The scan result with ingestion.", "type": "object", "properties": { "discoveryExecutionDetails": { "$ref": "#/definitions/DiscoveryExecutionDetails", "readOnly": true, "description": "The discovery execution details." }, "ingestionExecutionDetails": { "$ref": "#/definitions/IngestionExecutionDetails", "readOnly": true, "description": "The ingestion execution details." }, "parentId": { "type": "string", "readOnly": true, "description": "The parent scan result identifier." }, "id": { "type": "string", "readOnly": true, "description": "The scan result identifier." }, "ingestionJobId": { "type": "string", "description": "The ingestion job identifier." }, "resourceId": { "type": "string", "readOnly": true, "description": "The resource identifier." }, "status": { "type": "string", "enum": [ "Accepted", "InProgress", "TransientFailure", "Succeeded", "Failed", "Canceled" ], "description": "The scan result status.", "x-ms-enum": { "name": "ScanRunStatus", "modelAsString": true, "values": [ { "value": "Accepted", "description": "the scan is accepted" }, { "value": "InProgress", "description": "the scan is InProgress" }, { "value": "TransientFailure", "description": "the scan is in transient failure" }, { "value": "Succeeded", "description": "the scan is succeeded" }, { "value": "Failed", "description": "the scan is failed" }, { "value": "Canceled", "description": "the scan is canceled" } ] } }, "diagnostics": { "$ref": "#/definitions/ScanDiagnostics", "readOnly": true, "description": "The scan diagnostics." }, "startTime": { "format": "date-time", "type": "string", "description": "The scan start time.", "readOnly": true }, "endTime": { "format": "date-time", "type": "string", "description": "The scan end time.", "readOnly": true }, "scanRulesetVersion": { "format": "int32", "type": "integer", "description": "The scan ruleset version.", "readOnly": true }, "scanRulesetType": { "enum": [ "Custom", "System" ], "type": "string", "description": "The scan ruleset type.", "readOnly": true, "x-ms-enum": { "name": "ScanRulesetType", "values": [ { "value": "Custom", "description": "the scan ruleset type is custom" }, { "value": "System", "description": "the scan ruleset type is system default" } ], "modelAsString": true } }, "scanLevelType": { "enum": [ "Full", "Incremental" ], "type": "string", "description": "Scan level type.", "readOnly": true, "x-ms-enum": { "name": "ScanLevelType", "values": [ { "value": "Full", "description": "the scan is full scan" }, { "value": "Incremental", "description": "the scan is incremental scan" } ], "modelAsString": true } }, "errorMessage": { "type": "string", "description": "The error message.", "readOnly": true }, "error": { "$ref": "#/definitions/ErrorModel", "readOnly": true, "description": "The error." }, "runType": { "type": "string", "readOnly": true, "description": "The run type." }, "dataSourceType": { "readOnly": true, "$ref": "#/definitions/DataSourceType" } } }, "ExtendedProperties": { "description": "The extended properties.", "type": "object", "properties": { "subscriptionId": { "type": "string", "description": "The subscription identifier." }, "resourceGroup": { "type": "string", "description": "The resource group." } } }, "ItemPath": { "description": "The item path.", "type": "object", "properties": { "path": { "type": "string", "description": "The path." }, "extendedProperties": { "description": "The extended properties.", "$ref": "#/definitions/ExtendedProperties" } } }, "QualifiedName": { "description": "The qualified name.", "type": "object", "properties": { "typeName": { "type": "string", "description": "The type name." }, "name": { "type": "string", "description": "The name." }, "extendedProperties": { "$ref": "#/definitions/ExtendedProperties" } } }, "DataSourceIdentifier": { "description": "The data source identifier.", "type": "object", "properties": { "itemPath": { "$ref": "#/definitions/ItemPath" }, "qualifiedName": { "$ref": "#/definitions/QualifiedName" }, "dataSourceName": { "type": "string", "description": "The data source name." }, "guid": { "type": "string", "description": "The guid." }, "resourceId": { "type": "string", "description": "The resource identifier." } } }, "Scan": { "description": "The scan.", "required": [ "kind" ], "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "kind": { "enum": [ "AzureSubscriptionCredential", "AzureSubscriptionMsi", "AzureResourceGroupCredential", "AzureResourceGroupMsi", "AzureSynapseWorkspaceCredential", "AzureSynapseWorkspaceMsi", "AzureSynapseCredential", "AzureSynapseMsi", "AdlsGen1Credential", "AdlsGen1Msi", "AdlsGen2Credential", "AdlsGen2Msi", "AmazonAccountCredential", "AmazonS3Credential", "AmazonS3RoleARN", "AmazonSqlCredential", "AzureCosmosDbCredential", "AzureDataExplorerCredential", "AzureDataExplorerMsi", "AzureFileServiceCredential", "AzureSqlDatabaseCredential", "AzureSqlDatabaseMsi", "AzureSqlDatabaseNativeAuth", "ArcEnabledSqlServerCredential", "ArcEnabledSqlServerNativeAuth", "AmazonPostgreSqlCredential", "AzurePostgreSqlCredential", "DatabricksCredential", "SqlServerDatabaseCredential", "AzureSqlDatabaseManagedInstanceCredential", "AzureSqlDatabaseManagedInstanceMsi", "AzureSqlDatabaseManagedInstanceNativeAuth", "AzureSqlDataWarehouseCredential", "AzureSqlDataWarehouseMsi", "AzureMySqlCredential", "HdfsCredential", "AzureStorageCredential", "AzureStorageMsi", "TeradataTeradataCredential", "TeradataTeradataUserPass", "TeradataUserPass", "OracleOracleCredential", "OracleOracleUserPass", "DatabricksHmsCredential", "SapS4HanaSapS4HanaCredential", "SapS4HanaSapS4HanaUserPass", "SapEccSapEccCredential", "SapEccSapEccUserPass", "SnowflakeCredential", "PowerBICredential", "PowerBIDelegated", "PowerBIFpa", "PowerBIMsi", "FabricCredential", "FabricDelegated", "FabricFpa", "FabricMsi", "TridentCredential", "TridentDelegated", "TridentMsi", "DataverseCredential", "DataverseMsi" ], "type": "string", "description": "The properties of scan, vary by datasource type.", "x-ms-enum": { "name": "ScanAuthorizationType", "modelAsString": true } }, "lastRunResult": { "$ref": "#/definitions/ScanResultWithIngestion", "readOnly": true }, "scanId": { "type": "string", "description": "The scan identifier." }, "dataSourceIdentifier": { "$ref": "#/definitions/DataSourceIdentifier" }, "dataSourceName": { "type": "string", "description": "The data source name." }, "creationType": { "enum": [ "Manual", "AutoNative", "AutoManaged" ], "type": "string", "description": "The creation type.", "x-ms-enum": { "name": "CreationType", "values": [ { "value": "Manual", "description": "the datasource creation type is Manual" }, { "value": "AutoNative", "description": "the datasource creation type is auto created, native" }, { "value": "AutoManaged", "description": "the datasource creation type is auto managed" } ], "modelAsString": true } } }, "discriminator": "kind" }, "DataSource": { "description": "The data source.", "required": [ "kind" ], "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "kind": { "$ref": "#/definitions/DataSourceType" }, "scans": { "type": "array", "description": "Scans of this data source.", "items": { "$ref": "#/definitions/Scan" }, "readOnly": true }, "creationType": { "enum": [ "Manual", "AutoNative", "AutoManaged" ], "type": "string", "description": "The creation type.", "x-ms-enum": { "name": "CreationType", "values": [ { "value": "Manual", "description": "the datasource creation type is Manual" }, { "value": "AutoNative", "description": "the datasource creation type is auto created, native" }, { "value": "AutoManaged", "description": "the datasource creation type is auto managed" } ], "modelAsString": true } } }, "discriminator": "kind" }, "DataSourceList": { "description": "List of data sources.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of data sources.", "type": "array", "items": { "$ref": "#/definitions/DataSource" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of data sources.", "format": "int64", "type": "integer" } } }, "FilterProperties": { "description": "The filter properties.", "required": [ "excludeUriPrefixes", "includeUriPrefixes" ], "type": "object", "properties": { "excludeUriPrefixes": { "uniqueItems": true, "type": "array", "description": "The exclude uri prefixes.", "items": { "type": "string" } }, "includeUriPrefixes": { "uniqueItems": true, "type": "array", "description": "The include uri prefixes.", "items": { "type": "string" } }, "excludeRegexes": { "uniqueItems": true, "type": "array", "description": "The exclude regexes.", "items": { "type": "string" } }, "includeRegexes": { "uniqueItems": true, "type": "array", "description": "The include regexes.", "items": { "type": "string" } } } }, "Filter": { "description": "The filter.", "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/FilterProperties" } } }, "IntegrationRuntimeList": { "description": "List of integration runtime resources.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of integration runtimes.", "type": "array", "items": { "$ref": "#/definitions/IntegrationRuntime" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of integration runtimes.", "format": "int64", "type": "integer" } } }, "IntegrationRuntime": { "description": "Purview nested object which serves as a compute resource for activities.", "required": [ "kind" ], "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "kind": { "$ref": "#/definitions/IntegrationRuntimeType" } }, "discriminator": "kind" }, "IntegrationRuntimeType": { "description": "The type of integration runtime.", "type": "string", "enum": [ "Managed", "SelfHosted" ], "x-ms-enum": { "name": "IntegrationRuntimeType", "modelAsString": true } }, "ManagedIntegrationRuntimeComputeProperties": { "description": "The compute resource properties for managed integration runtime.", "type": "object", "properties": { "location": { "description": "The location for managed integration runtime.", "type": "string" } } }, "ManagedIntegrationRuntimeTypeProperties": { "description": "Managed integration runtime type properties.", "type": "object", "properties": { "computeProperties": { "$ref": "#/definitions/ManagedIntegrationRuntimeComputeProperties" } } }, "ManagedVirtualNetworkReference": { "description": "The managed virtual network reference.", "type": "object", "properties": { "referenceName": { "description": "Reference ManagedVirtualNetwork name.", "type": "string" }, "type": { "description": "Managed virtual network reference type.", "type": "string" } } }, "ManagedIntegrationRuntimeProperties": { "description": "The managed integration runtime properties.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/ManagedIntegrationRuntimeTypeProperties" }, "managedVirtualNetworkReference": { "$ref": "#/definitions/ManagedVirtualNetworkReference" }, "description": { "description": "The managed integration runtime description.", "type": "string" } } }, "ManagedIntegrationRuntime": { "description": "The managed integration runtime.", "type": "object", "allOf": [ { "$ref": "#/definitions/IntegrationRuntime" } ], "properties": { "properties": { "$ref": "#/definitions/ManagedIntegrationRuntimeProperties" } }, "x-ms-discriminator-value": "Managed" }, "SelfHostedIntegrationRuntimeProperties": { "description": "The self-hosted integration runtime properties.", "type": "object", "properties": { "description": { "description": "The self-hosted integration runtime description.", "type": "string" } } }, "SelfHostedIntegrationRuntime": { "description": "Self-hosted integration runtime.", "type": "object", "allOf": [ { "$ref": "#/definitions/IntegrationRuntime" } ], "properties": { "properties": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeProperties" } }, "x-ms-discriminator-value": "SelfHosted" }, "SelfHostedIntegrationRuntimeNode": { "description": "Properties of Self-hosted integration runtime node.", "type": "object", "properties": { "nodeName": { "description": "Name of the integration runtime node.", "type": "string", "readOnly": true }, "machineName": { "description": "Machine name of the integration runtime node.", "type": "string", "readOnly": true }, "hostServiceUri": { "description": "URI for the host machine of the integration runtime.", "type": "string", "readOnly": true }, "status": { "description": "Status of the integration runtime node.", "type": "string", "readOnly": true }, "capabilities": { "description": "The integration runtime capabilities dictionary.", "type": "object", "additionalProperties": { "description": "The capability details of self-hosted integration runtime node.", "type": "string" }, "readOnly": true }, "versionStatus": { "description": "Status of the integration runtime node version.", "type": "string", "readOnly": true }, "version": { "description": "Version of the integration runtime node.", "type": "string", "readOnly": true }, "registerTime": { "description": "The time at which the integration runtime node was registered in ISO8601 format.", "format": "date-time", "type": "string", "readOnly": true }, "lastConnectTime": { "description": "The most recent time at which the integration runtime was connected in ISO8601 format.", "format": "date-time", "type": "string", "readOnly": true }, "expiryTime": { "description": "The time at which the integration runtime will expire in ISO8601 format.", "format": "date-time", "type": "string", "readOnly": true }, "lastStartTime": { "description": "The time the node last started up.", "format": "date-time", "type": "string", "readOnly": true }, "lastStopTime": { "description": "The integration runtime node last stop time.", "format": "date-time", "type": "string", "readOnly": true }, "lastUpdateResult": { "description": "The result of the last integration runtime node update.", "type": "string", "readOnly": true }, "lastStartUpdateTime": { "description": "The last time for the integration runtime node update start.", "format": "date-time", "type": "string", "readOnly": true }, "lastEndUpdateTime": { "description": "The last time for the integration runtime node update end.", "format": "date-time", "type": "string", "readOnly": true }, "isActiveDispatcher": { "description": "Indicates whether this node is the active dispatcher for integration runtime requests.", "type": "boolean", "readOnly": true }, "concurrentJobsLimit": { "description": "The concurrent jobs limit of self-hosted integration runtime node.", "format": "int32", "type": "integer", "readOnly": true }, "maxConcurrentJobs": { "description": "The max concurrent jobs of self-hosted integration runtime node.", "format": "int32", "type": "integer", "readOnly": true } } }, "SelfHostedIntegrationRuntimeStatusTypeProperties": { "description": "Self-hosted integration runtime status type properties.", "type": "object", "properties": { "createTime": { "description": "The time at which the integration runtime was created, in ISO8601 format.", "format": "date-time", "type": "string", "readOnly": true }, "taskQueueId": { "description": "The task queue id of the integration runtime.", "type": "string", "readOnly": true }, "internalChannelEncryption": { "description": "It is used to set the encryption mode for node-node communication channel (when more than 2 self-hosted integration runtime nodes exist).", "type": "string", "readOnly": true }, "version": { "description": "Version of the integration runtime.", "type": "string", "readOnly": true }, "nodes": { "description": "List of nodes for this integration runtime.", "type": "array", "items": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeNode" } }, "scheduledUpdateDate": { "description": "The date at which the integration runtime will be scheduled to update, in ISO8601 format.", "format": "date-time", "type": "string", "readOnly": true }, "updateDelayOffset": { "description": "The time in the date scheduled by service to update the integration runtime, e.g., PT03H is 3 hours.", "type": "string", "readOnly": true }, "localTimeZoneOffset": { "description": "The local time zone offset in hours.", "type": "string", "readOnly": true }, "capabilities": { "description": "Object with additional information about integration runtime capabilities.", "type": "object", "additionalProperties": { "type": "string" }, "readOnly": true }, "serviceUrls": { "description": "The URLs for the services used in integration runtime backend service.", "type": "array", "items": { "type": "string" }, "readOnly": true }, "autoUpdate": { "description": "Whether Self-hosted integration runtime auto update has been turned on.", "enum": [ "On", "Off" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "IntegrationRuntimeAutoUpdate", "modelAsString": true } }, "versionStatus": { "description": "Status of the integration runtime version.", "type": "string", "readOnly": true }, "pushedVersion": { "description": "The version that the integration runtime is going to update to.", "type": "string", "readOnly": true }, "latestVersion": { "description": "The latest version on download center.", "type": "string", "readOnly": true }, "autoUpdateETA": { "description": "The estimated time when the self-hosted integration runtime will be updated.", "format": "date-time", "type": "string", "readOnly": true } } }, "SelfHostedIntegrationRuntimeStatusProperties": { "description": "Self-hosted integration runtime status properties.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeStatusTypeProperties" }, "state": { "description": "Self-hosted integration runtime state.", "type": "string", "readOnly": true } } }, "SelfHostedIntegrationRuntimeStatus": { "description": "Self-hosted integration runtime status.", "type": "object", "allOf": [ { "$ref": "#/definitions/IntegrationRuntimeStatus" } ], "properties": { "properties": { "$ref": "#/definitions/SelfHostedIntegrationRuntimeStatusProperties" } }, "x-ms-discriminator-value": "SelfHosted" }, "InteractiveQuery": { "description": "Interactive query properties of managed integration runtime.", "type": "object", "properties": { "autoTerminationMinutes": { "description": "Auto termination minutes of interactive query.", "format": "int32", "type": "integer" }, "status": { "description": "Status of interactive query.", "type": "string" } } }, "ManagedIntegrationRuntimeStatusTypeProperties": { "description": "Managed integration runtime status type properties.", "type": "object", "properties": { "createTime": { "description": "The time at which the integration runtime was created, in ISO8601 format.", "format": "date-time", "type": "string" }, "interactiveQuery": { "$ref": "#/definitions/InteractiveQuery" } } }, "ManagedIntegrationRuntimeStatusProperties": { "description": "Managed integration runtime status properties.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/ManagedIntegrationRuntimeStatusTypeProperties" }, "state": { "description": "Managed integration runtime state.", "type": "string", "readOnly": true } } }, "ManagedIntegrationRuntimeStatus": { "description": "Managed integration runtime status.", "type": "object", "allOf": [ { "$ref": "#/definitions/IntegrationRuntimeStatus" } ], "properties": { "properties": { "$ref": "#/definitions/ManagedIntegrationRuntimeStatusProperties" } }, "x-ms-discriminator-value": "Managed" }, "IntegrationRuntimeStatus": { "description": "Integration runtime status.", "required": [ "kind" ], "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "kind": { "$ref": "#/definitions/IntegrationRuntimeType" } }, "discriminator": "kind" }, "IntegrationRuntimeAuthKeys": { "description": "The integration runtime authentication keys.", "type": "object", "properties": { "authKey1": { "type": "string", "description": "The primary integration runtime authentication key." }, "authKey2": { "type": "string", "description": "The secondary integration runtime authentication key." } } }, "IntegrationRuntimeRegenerateKeyParameters": { "description": "Parameters to regenerate the authentication key.", "type": "object", "properties": { "keyName": { "description": "The name of the authentication key to regenerate.", "type": "string", "enum": [ "authKey1", "authKey2" ], "x-ms-enum": { "name": "IntegrationRuntimeAuthKeyName", "modelAsString": true } } } }, "EnableInteractiveQueryForIntegrationRuntimeRequest": { "description": "The request of enabling interactive query for integration runtime.", "type": "object", "properties": { "autoTerminationMinutes": { "description": "The interactive querying auto termination time in minutes.", "format": "int32", "type": "integer" } } }, "ManagedVirtualNetworkList": { "description": "List of managed virtual network resources.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of managed virtual networks.", "type": "array", "items": { "$ref": "#/definitions/ManagedVirtualNetwork" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of managed virtual networks.", "format": "int64", "type": "integer" } } }, "ManagedVirtualNetwork": { "description": "The managed virtual network.", "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/ManagedVirtualNetworkProperties" } } }, "ManagedVirtualNetworkProperties": { "description": "The properties of managed virtual network.", "type": "object", "properties": { "vNetId": { "description": "The ID of the VNet that this integration runtime will join.", "type": "string", "readOnly": true }, "alias": { "description": "The alias of managed virtual network.", "type": "string", "readOnly": true } } }, "ManagedPrivateEndpointList": { "description": "List of managed private endpoint resources.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of managed private endpoints.", "type": "array", "items": { "$ref": "#/definitions/ManagedPrivateEndpoint" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of managed private endpoints.", "format": "int64", "type": "integer" } } }, "ManagedPrivateEndpoint": { "description": "The managed private endpoint.", "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/ManagedPrivateEndpointProperties" } } }, "ManagedPrivateEndpointProperties": { "description": "The properties of managed private endpoint.", "type": "object", "properties": { "connectionState": { "$ref": "#/definitions/ConnectionStateProperties" }, "fqdns": { "description": "The fqdns of managed private endpoint.", "type": "array", "items": { "description": "The fqdn items of managed private endpoint.", "type": "string" } }, "groupId": { "description": "The group identifier of managed private endpoint.", "type": "string" }, "privateLinkResourceId": { "description": "The private link resource identifier of managed private endpoint.", "type": "string" }, "provisioningState": { "description": "The provisioning state of managed private endpoint.", "type": "string" } } }, "ConnectionStateProperties": { "description": "The properties of connection state.", "type": "object", "properties": { "actionsRequired": { "description": "ActionsRequired for a private link connection.", "type": "string", "readOnly": true }, "description": { "description": "Description of a private link connection.", "type": "string", "readOnly": true }, "status": { "description": "Status of a private link connection.", "type": "string", "readOnly": true } } }, "ScanList": { "description": "List of scans.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of scans.", "type": "array", "items": { "$ref": "#/definitions/Scan" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of scans.", "format": "int64", "type": "integer" } } }, "ScanHistoryList": { "description": "List of scan history.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of scan history.", "type": "array", "items": { "$ref": "#/definitions/ScanResultWithIngestion" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of scan history.", "format": "int64", "type": "integer" } } }, "ScanHistoryListWithIngestion": { "description": "List of scan history with ingestion.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of scan history with ingestion.", "type": "array", "items": { "$ref": "#/definitions/ScanResultWithIngestion" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of scan history with ingestion.", "format": "int64", "type": "integer" } } }, "VersionedScanRuleset": { "description": "The versioned scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "scanRulesetType": { "enum": [ "Custom", "System" ], "type": "string", "description": "Versioned scan ruleset properties.", "x-ms-enum": { "name": "ScanRulesetType", "values": [ { "value": "Custom", "description": "the scan ruleset type is custom" }, { "value": "System", "description": "the scan ruleset type is system default" } ], "modelAsString": true } }, "status": { "enum": [ "Enabled", "Disabled" ], "type": "string", "description": "Status of versioned scan ruleset properties.", "readOnly": true, "x-ms-enum": { "name": "ScanRulesetStatus", "modelAsString": true } }, "version": { "format": "int32", "type": "integer", "description": "Version of versioned scan ruleset properties.", "readOnly": true } } }, "ScanRuleset": { "description": "The scan ruleset.", "required": [ "kind" ], "type": "object", "allOf": [ { "$ref": "#/definitions/VersionedScanRuleset" } ], "properties": { "kind": { "$ref": "#/definitions/DataSourceType" } }, "discriminator": "kind" }, "ScanRulesetList": { "description": "List of scan rulesets.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of scan rulesets.", "type": "array", "items": { "$ref": "#/definitions/ScanRuleset" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of scan rulesets.", "format": "int64", "type": "integer" } } }, "SystemScanRuleset": { "description": "The system scan ruleset.", "required": [ "kind" ], "type": "object", "allOf": [ { "$ref": "#/definitions/VersionedScanRuleset" } ], "properties": { "kind": { "$ref": "#/definitions/DataSourceType" } }, "discriminator": "kind" }, "SystemScanRulesetList": { "description": "List of system scan rulesets.", "required": [ "value" ], "type": "object", "properties": { "value": { "description": "List of system scan rulesets.", "type": "array", "items": { "$ref": "#/definitions/SystemScanRuleset" } }, "nextLink": { "description": "The link to the next page of results, if any remaining results exist.", "type": "string" }, "count": { "description": "The number of system scan rulesets.", "format": "int64", "type": "integer" } } }, "RecurrenceScheduleOccurrence": { "description": "The occurrence of recurrence schedule.", "type": "object", "properties": { "day": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "description": "The day of recurrence schedule occurrence.", "x-ms-enum": { "name": "DayOfWeek", "modelAsString": true } }, "occurrence": { "format": "int32", "type": "integer" } } }, "RecurrenceSchedule": { "description": "Schedule of recurrence.", "type": "object", "properties": { "minutes": { "type": "array", "description": "The minutes of recurrence schedule.", "items": { "format": "int32", "type": "integer" } }, "hours": { "type": "array", "description": "The hours of recurrence schedule.", "items": { "format": "int32", "type": "integer" } }, "weekDays": { "type": "array", "description": "The week days of recurrence schedule.", "items": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "type": "string", "x-ms-enum": { "name": "DaysOfWeek", "modelAsString": true } } }, "monthDays": { "type": "array", "description": "Month days of recurrence schedule.", "items": { "format": "int32", "type": "integer" } }, "monthlyOccurrences": { "type": "array", "description": "The monthly occurrences of recurrence schedule.", "items": { "$ref": "#/definitions/RecurrenceScheduleOccurrence" } } } }, "TriggerRecurrence": { "description": "The recurrence of trigger.", "type": "object", "properties": { "frequency": { "enum": [ "Week", "Month", "Day", "Hour" ], "type": "string", "description": "The frequency of trigger recurrence.", "x-ms-enum": { "name": "TriggerFrequency", "modelAsString": true } }, "interval": { "format": "int32", "type": "integer", "description": "The interval of trigger recurrence." }, "startTime": { "format": "date-time", "type": "string", "description": "The start time of trigger recurrence." }, "endTime": { "format": "date-time", "type": "string", "description": "The end time of trigger recurrence." }, "schedule": { "$ref": "#/definitions/RecurrenceSchedule", "description": "The schedule of trigger recurrence." }, "timeZone": { "type": "string", "description": "The time zone of trigger recurrence." } } }, "TriggerProperties": { "description": "Properties detail of trigger.", "type": "object", "properties": { "recurrence": { "$ref": "#/definitions/TriggerRecurrence", "description": "The recurrence of trigger." }, "recurrenceInterval": { "type": "string", "description": "The recurrence interval of trigger." }, "createdAt": { "format": "date-time", "type": "string", "description": "The create time of trigger.", "readOnly": true }, "lastModifiedAt": { "format": "date-time", "type": "string", "description": "The last modified time of trigger.", "readOnly": true }, "lastScheduled": { "format": "date-time", "type": "string", "description": "The last scheduled time of trigger.", "readOnly": true }, "state": { "default": "Enabled", "enum": [ "Enabled", "Disabled" ], "type": "string", "description": "The state of trigger.", "x-ms-enum": { "name": "TriggerState", "modelAsString": true } }, "scanLevel": { "enum": [ "Full", "Incremental" ], "type": "string", "description": "The scan level of trigger.", "x-ms-enum": { "name": "ScanLevelType", "values": [ { "value": "Full", "description": "the scan is full scan" }, { "value": "Incremental", "description": "the scan is incremental scan" } ], "modelAsString": true } }, "incrementalScanStartTime": { "format": "date-time", "type": "string", "description": "The incremental scan start time of trigger." } } }, "Trigger": { "description": "The trigger object.", "type": "object", "allOf": [ { "$ref": "#/definitions/ProxyResource" } ], "properties": { "properties": { "$ref": "#/definitions/TriggerProperties", "description": "The properties of trigger." }, "validationErrorInfo": { "type": "string", "description": "The validation error info of trigger." } } }, "CollectionReference": { "description": "The reference to collection.", "type": "object", "properties": { "lastModifiedAt": { "format": "date-time", "type": "string", "description": "The last modified time of collection reference.", "readOnly": true }, "referenceName": { "type": "string", "description": "The reference name of collection reference." }, "type": { "type": "string", "description": "The type of collection reference." } } }, "SystemClassificationRuleProperties": { "description": "The properties of system classification rule.", "type": "object", "properties": { "description": { "type": "string" }, "version": { "format": "int32", "type": "integer", "description": "The version of system classification rule.", "readOnly": true }, "classificationName": { "type": "string", "description": "The classification name of system classification rule." }, "ruleStatus": { "enum": [ "Enabled", "Disabled" ], "type": "string", "description": "The rule status of system classification rule.", "x-ms-enum": { "name": "ClassificationRuleStatus", "modelAsString": true } }, "createdAt": { "format": "date-time", "type": "string", "description": "The create time of system classification rule.", "readOnly": true }, "lastModifiedAt": { "format": "date-time", "type": "string", "description": "The last modified time of system classification rule.", "readOnly": true } } }, "SystemClassificationRule": { "description": "The rule of system classification.", "type": "object", "allOf": [ { "$ref": "#/definitions/ClassificationRule" } ], "properties": { "properties": { "$ref": "#/definitions/SystemClassificationRuleProperties" } }, "x-ms-discriminator-value": "System" }, "ClassificationRulePattern": { "description": "Pattern of classification rule.", "required": [ "kind" ], "type": "object", "properties": { "kind": { "enum": [ "Regex" ], "type": "string", "description": "The properties of classification rule pattern.", "x-ms-enum": { "name": "ClassificationRulePatternType", "modelAsString": true } } }, "discriminator": "kind" }, "CustomClassificationRuleProperties": { "description": "The properties of custom classification rule.", "type": "object", "properties": { "minimumPercentageMatch": { "format": "double", "type": "number" }, "classificationAction": { "description": "The action of classification rule.", "enum": [ "Keep", "Delete" ], "type": "string", "readOnly": true, "x-ms-enum": { "name": "ClassificationAction", "modelAsString": true } }, "dataPatterns": { "description": "The data patterns of custom classification rule.", "type": "array", "items": { "$ref": "#/definitions/ClassificationRulePattern" } }, "columnPatterns": { "description": "The column patterns of custom classification rule.", "type": "array", "items": { "$ref": "#/definitions/ClassificationRulePattern" } }, "description": { "description": "The description of custom classification rule.", "type": "string" }, "version": { "format": "int32", "type": "integer", "description": "The version of custom classification rule.", "readOnly": true }, "classificationName": { "type": "string", "description": "The classification name of custom classification rule." }, "ruleStatus": { "enum": [ "Enabled", "Disabled" ], "type": "string", "description": "The rule status of custom classification rule.", "x-ms-enum": { "name": "ClassificationRuleStatus", "modelAsString": true } }, "createdAt": { "format": "date-time", "type": "string", "description": "The create time of custom classification rule.", "readOnly": true }, "lastModifiedAt": { "format": "date-time", "type": "string", "description": "The last modified time of custom classification rule.", "readOnly": true } } }, "CustomClassificationRule": { "description": "Rule of custom classification.", "type": "object", "allOf": [ { "$ref": "#/definitions/ClassificationRule" } ], "properties": { "properties": { "$ref": "#/definitions/CustomClassificationRuleProperties" } }, "x-ms-discriminator-value": "Custom" }, "RegexClassificationRulePattern": { "description": "Pattern of regex classification rule.", "type": "object", "allOf": [ { "$ref": "#/definitions/ClassificationRulePattern" } ], "properties": { "pattern": { "type": "string", "description": "The pattern of regex classification rule pattern." } }, "x-ms-discriminator-value": "Regex" }, "Store": { "description": "The store.", "type": "object", "properties": { "referenceName": { "type": "string", "description": "The reference name of store." }, "type": { "type": "string", "description": "The type of store." } } }, "KeyVaultSecret": { "description": "The key vault secret.", "type": "object", "properties": { "type": { "type": "string", "description": "The type of key vault secret." }, "secretName": { "type": "string", "description": "The secret name of key vault secret." }, "secretVersion": { "type": "string", "description": "The secret version of key vault secret." }, "store": { "$ref": "#/definitions/Store" } } }, "KeyVaultSecretAccountKeyCredentialTypeProperties": { "description": "Properties of key vault secret account key credential type.", "type": "object", "properties": { "accountKey": { "$ref": "#/definitions/KeyVaultSecret", "description": "The account key of key vault secret account key credential type." } } }, "AccountKeyCredentialProperties": { "description": "Properties of account key credential.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/KeyVaultSecretAccountKeyCredentialTypeProperties", "description": "The type properties of account key credential." }, "description": { "type": "string" } } }, "AccountKeyAuthAzureKeyVaultCredential": { "description": "Credential type that uses Account Key for authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/Credential" } ], "properties": { "properties": { "$ref": "#/definitions/AccountKeyCredentialProperties", "description": "The properties of account key auth Azure Key Vault credential." } }, "x-ms-discriminator-value": "AccountKey" }, "KeyVaultSecretUserPassCredentialTypeProperties": { "description": "Properties of key vault secret user pass credential type.", "type": "object", "properties": { "user": { "type": "string", "description": "User name." }, "password": { "$ref": "#/definitions/KeyVaultSecret", "description": "The password of key vault secret user pass credential type." } } }, "UserPassCredentialProperties": { "description": "Properties of user pass credential.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/KeyVaultSecretUserPassCredentialTypeProperties" }, "description": { "type": "string" } } }, "BasicAuthAzureKeyVaultCredential": { "description": "Credential type that uses Basic authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/Credential" } ], "properties": { "properties": { "$ref": "#/definitions/UserPassCredentialProperties", "description": "The properties of basic auth Azure Key Vault credential." } }, "x-ms-discriminator-value": "BasicAuth" }, "RoleARNCredentialTypeProperties": { "description": "The type properties of role ARN credential.", "type": "object", "properties": { "roleARN": { "type": "string", "description": "The role ARN of role ARN credential type properties." } } }, "RoleARNCredentialProperties": { "description": "The properties of role ARN credential.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/RoleARNCredentialTypeProperties" }, "description": { "type": "string", "description": "The description of role ARN credential." } } }, "RoleARNCredential": { "description": "Credential type that uses Account ID, External ID and Role ARN for authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/Credential" } ], "properties": { "properties": { "$ref": "#/definitions/RoleARNCredentialProperties" } }, "x-ms-discriminator-value": "AmazonARN" }, "KeyVaultSecretServicePrinipalCredentialTypeProperties": { "description": "The type properties of key vault secret service principal credential.", "type": "object", "properties": { "servicePrincipalId": { "type": "string", "description": "The service principal ID of key vault secret service principal credential type properties." }, "servicePrincipalKey": { "$ref": "#/definitions/KeyVaultSecret" }, "tenant": { "type": "string" } } }, "ServicePrincipalAzureKeyVaultCredentialProperties": { "description": "The properties of service principal Azure Key Vault credential.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/KeyVaultSecretServicePrinipalCredentialTypeProperties" }, "description": { "type": "string" } } }, "ServicePrincipalAzureKeyVaultCredential": { "description": "Credential type that uses Tenant ID and Service principal ID for authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/Credential" } ], "properties": { "properties": { "$ref": "#/definitions/ServicePrincipalAzureKeyVaultCredentialProperties" } }, "x-ms-discriminator-value": "ServicePrincipal" }, "SqlAuthAzureKeyVaultCredential": { "description": "Credential type that uses Sql for authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/Credential" } ], "properties": { "properties": { "$ref": "#/definitions/UserPassCredentialProperties" } }, "x-ms-discriminator-value": "SqlAuth" }, "KeyVaultSecretConsumerKeyCredentialTypeProperties": { "description": "The type properties of key vault secret consumer key credential.", "type": "object", "properties": { "user": { "type": "string", "description": "User name." }, "password": { "$ref": "#/definitions/KeyVaultSecret", "description": "The password of key vault secret consumer key credential type properties." }, "consumerKey": { "type": "string", "description": "The consumer key of key vault secret consumer key credential type properties." }, "consumerSecret": { "$ref": "#/definitions/KeyVaultSecret", "description": "The consumer secret of key vault secret consumer key credential type properties." } } }, "ConsumerKeyCredentialProperties": { "description": "The properties of consumer key credential.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/KeyVaultSecretConsumerKeyCredentialTypeProperties" }, "description": { "type": "string", "description": "Description of credential properties." } } }, "ConsumerKeyAuthAzureKeyVaultCredential": { "description": "Credential type that uses consumer provided key and secret for authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/Credential" } ], "properties": { "properties": { "$ref": "#/definitions/ConsumerKeyCredentialProperties" } }, "x-ms-discriminator-value": "ConsumerKeyAuth" }, "KeyVaultSecretDelegatedAuthCredentialTypeProperties": { "description": "The type properties of key vault secret delegated auth credential.", "type": "object", "properties": { "clientId": { "type": "string", "description": "Credential type that uses Account ID, External ID and Role ARN for authentication." }, "user": { "type": "string", "description": "User name." }, "password": { "$ref": "#/definitions/KeyVaultSecret", "description": "Key vault secret." } } }, "DelegatedAuthCredentialProperties": { "description": "The properties of delegated auth credential.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/KeyVaultSecretDelegatedAuthCredentialTypeProperties" }, "description": { "type": "string" } } }, "DelegatedAuthAzureKeyVaultCredential": { "description": "Credential type that uses Client ID for authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/Credential" } ], "properties": { "properties": { "$ref": "#/definitions/DelegatedAuthCredentialProperties", "description": "The properties of delegated auth Azure Key Vault credential." } }, "x-ms-discriminator-value": "DelegatedAuth" }, "KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties": { "description": "The type properties of key vault secret managed identity Azure Key Vault credential.", "type": "object", "properties": { "principalId": { "type": "string", "description": "The principal ID of key vault secret managed identity Azure Key Vault credential type properties." }, "tenantId": { "type": "string", "description": "The tenant ID of key vault secret managed identity Azure Key Vault credential type properties." }, "resourceId": { "type": "string", "description": "The resource ID of key vault secret managed identity Azure Key Vault credential type properties." } } }, "ManagedIdentityAzureKeyVaultCredentialProperties": { "description": "The properties of managed identity Azure Key Vault credential.", "type": "object", "properties": { "typeProperties": { "$ref": "#/definitions/KeyVaultSecretManagedIdentityAzureKeyVaultCredentialTypeProperties", "description": "The type properties of managed identity Azure Key Vault credential." }, "description": { "type": "string" } } }, "ManagedIdentityAzureKeyVaultCredential": { "description": "Credential type that uses User assigned managed identities for authentication.", "type": "object", "allOf": [ { "$ref": "#/definitions/Credential" } ], "properties": { "properties": { "$ref": "#/definitions/ManagedIdentityAzureKeyVaultCredentialProperties", "description": "The properties of managed identity Azure Key Vault credential." } }, "x-ms-discriminator-value": "ManagedIdentity" }, "DataSourceProperties": { "description": "Properties of data source.", "type": "object", "properties": { "createdAt": { "format": "date-time", "type": "string", "description": "The create time of data source.", "readOnly": true }, "lastModifiedAt": { "format": "date-time", "type": "string", "description": "The last modified time of data source.", "readOnly": true }, "collection": { "$ref": "#/definitions/CollectionReference" }, "dataSourceCollectionMovingState": { "enum": [ "Active", "Moving", "Failed" ], "type": "string", "description": "Data source collection moving state.", "x-ms-enum": { "name": "DataSourceCollectionState", "modelAsString": true } } } }, "AzureSubscriptionProperties": { "description": "Properties of azure subscription.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "subscriptionId": { "type": "string", "description": "The subscription ID of azure subscription." }, "resourceId": { "type": "string", "description": "The resource ID of azure subscription." }, "dataUseGovernance": { "enum": [ "Disabled", "DisabledByAnotherAccount", "Enabled", "EnabledAtAncestorScope" ], "type": "string", "description": "The data use governance of azure subscription.", "x-ms-enum": { "name": "DataUseGovernanceState", "modelAsString": true } } } }, "AzureSubscriptionDataSource": { "description": "Azure subscription data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSubscriptionProperties", "description": "Azure subscription properties." } }, "x-ms-discriminator-value": "AzureSubscription" }, "AzureResourceGroupProperties": { "description": "Azure resource group properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "subscriptionId": { "type": "string", "description": "Subscription id." }, "resourceGroup": { "type": "string", "description": "Resource group." }, "resourceId": { "type": "string", "description": "Resource id." }, "dataUseGovernance": { "enum": [ "Disabled", "DisabledByAnotherAccount", "Enabled", "EnabledAtAncestorScope" ], "type": "string", "description": "Data use governance.", "x-ms-enum": { "name": "DataUseGovernanceState", "modelAsString": true } } } }, "AzureResourceGroupDataSource": { "description": "Azure resource group data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureResourceGroupProperties", "description": "Azure resource group properties." } }, "x-ms-discriminator-value": "AzureResourceGroup" }, "AzureDataSourceProperties": { "description": "Azure data source properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "resourceGroup": { "type": "string", "description": "Resource group." }, "subscriptionId": { "type": "string", "description": "Subscription id." }, "location": { "type": "string", "description": "Location." }, "resourceName": { "type": "string", "description": "Resource name." }, "resourceId": { "type": "string", "description": "Resource id." }, "dataUseGovernance": { "enum": [ "Disabled", "DisabledByAnotherAccount", "Enabled", "EnabledAtAncestorScope" ], "type": "string", "description": "Data use governance.", "x-ms-enum": { "name": "DataUseGovernanceState", "modelAsString": true } } } }, "AzureSynapseWorkspaceProperties": { "description": "Azure synapse workspace data source properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "dedicatedSqlEndpoint": { "type": "string", "description": "The dedicated SQL endpoint of azure synapse workspace." }, "serverlessSqlEndpoint": { "type": "string", "description": "The serverless SQL endpoint of azure synapse workspace." } } }, "AzureSynapseWorkspaceDataSource": { "description": "Azure synapse workspace data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseWorkspaceProperties", "description": "Azure synapse workspace properties." } }, "x-ms-discriminator-value": "AzureSynapseWorkspace" }, "AzureSynapseProperties": { "description": "Azure synapse data source properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "sqlEndpoint": { "type": "string", "description": "The SQL endpoint of azure synapse." }, "sqlOnDemandEndpoint": { "type": "string", "description": "The SQL on demand endpoint of azure synapse." } } }, "AzureSynapseDataSource": { "description": "Azure synapse data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseProperties", "description": "Azure synapse properties." } }, "x-ms-discriminator-value": "AzureSynapse" }, "AdlsGen1Properties": { "description": "The properties of ADLS Gen1.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "endpoint": { "type": "string", "description": "The endpoint of ADLS Gen1." } } }, "AdlsGen1DataSource": { "description": "The ADLS Gen1 data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen1Properties", "description": "The properties of ADLS Gen1." } }, "x-ms-discriminator-value": "AdlsGen1" }, "AdlsGen2Properties": { "description": "The properties of ADLS Gen2.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "endpoint": { "type": "string", "description": "The endpoint of ADLS Gen2." } } }, "AdlsGen2DataSource": { "description": "The ADLS Gen2 data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen2Properties", "description": "The properties of ADLS Gen2." } }, "x-ms-discriminator-value": "AdlsGen2" }, "AmazonAccountProperties": { "description": "The properties of Amazon account.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "awsAccountId": { "type": "string", "description": "AWS account id." }, "roleARN": { "type": "string", "description": "Role arn." } } }, "AmazonAccountDataSource": { "description": "The Amazon account data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonAccountProperties", "description": "The properties of Amazon account." } }, "x-ms-discriminator-value": "AmazonAccount" }, "AmazonS3Properties": { "description": "The properties of Amazon S3.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "serviceUrl": { "type": "string", "description": "Service URL." }, "roleARN": { "type": "string", "description": "Role ARN." } } }, "AmazonS3DataSource": { "description": "The Amazon S3 data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonS3Properties", "description": "Amazon S3 properties." } }, "x-ms-discriminator-value": "AmazonS3" }, "AmazonSqlProperties": { "description": "The properties of Amazon SQL.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "serverEndpoint": { "type": "string", "description": "Server Endpoint." }, "port": { "format": "int32", "type": "integer", "description": "Port." }, "vpcEndpointServiceName": { "type": "string", "description": "Vpc Endpoint Service Name." } } }, "AmazonSqlDataSource": { "description": "The Amazon SQL data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonSqlProperties", "description": "Amazon SQL properties." } }, "x-ms-discriminator-value": "AmazonSql" }, "AzureCosmosDbProperties": { "description": "The properties of Azure Cosmos DB.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "accountUri": { "type": "string", "description": "The account URI of Azure Cosmos DB." } } }, "AzureCosmosDbDataSource": { "description": "The Azure Cosmos DB data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureCosmosDbProperties", "description": "The properties of Azure Cosmos DB." } }, "x-ms-discriminator-value": "AzureCosmosDb" }, "AzureDataExplorerProperties": { "description": "The properties of azure data explorer.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "endpoint": { "type": "string" } } }, "AzureDataExplorerDataSource": { "description": "The azure data explorer data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureDataExplorerProperties", "description": "The properties of azure data explorer." } }, "x-ms-discriminator-value": "AzureDataExplorer" }, "AzureFileServiceProperties": { "description": "The properties of azure file service.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "endpoint": { "type": "string", "description": "The endpoint of azure file service." } } }, "AzureFileServiceDataSource": { "description": "The azure file service data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureFileServiceProperties", "description": "The properties of azure file service." } }, "x-ms-discriminator-value": "AzureFileService" }, "AzureSqlDatabaseProperties": { "description": "The properties of Azure SQL database.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "serverEndpoint": { "type": "string", "description": "The server endpoint of Azure SQL database." } } }, "AzureSqlDatabaseDataSource": { "description": "The Azure SQL database data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseProperties", "description": "The properties of Azure SQL database." } }, "x-ms-discriminator-value": "AzureSqlDatabase" }, "AmazonPostgreSqlProperties": { "description": "The properties of Amazon Postgre SQL.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "serverEndpoint": { "type": "string", "description": "The server endpoint of Amazon Postgre SQL." }, "port": { "format": "int32", "type": "integer", "description": "The port of Amazon Postgre SQL." }, "vpcEndpointServiceName": { "type": "string", "description": "The vpc endpoint service name of Amazon Postgre SQL." } } }, "AmazonPostgreSqlDataSource": { "description": "The Amazon Postgre SQL data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonPostgreSqlProperties", "description": "The properties of Amazon Postgre SQL." } }, "x-ms-discriminator-value": "AmazonPostgreSql" }, "AzurePostgreSqlProperties": { "description": "The properties of Azure Postgre SQL.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "serverEndpoint": { "type": "string", "description": "The server endpoint of Azure Postgre SQL." }, "port": { "format": "int32", "type": "integer" } } }, "AzurePostgreSqlDataSource": { "description": "The Azure Postgre SQL data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzurePostgreSqlProperties", "description": "The properties of Azure Postgre SQL." } }, "x-ms-discriminator-value": "AzurePostgreSql" }, "SqlServerDatabaseProperties": { "description": "The properties of sql server database.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "serverEndpoint": { "type": "string", "description": "The server endpoint of sql server database." } } }, "SqlServerDatabaseDataSource": { "description": "The sql server database data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/SqlServerDatabaseProperties" } }, "x-ms-discriminator-value": "SqlServerDatabase" }, "AzureSqlDatabaseManagedInstanceProperties": { "description": "The properties of Azure SQL database managed instance.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "serverEndpoint": { "type": "string" } } }, "AzureSqlDatabaseManagedInstanceDataSource": { "description": "The Azure SQL database managed instance data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstance" }, "AzureSqlDataWarehouseProperties": { "description": "The properties of Azure SQL data warehouse.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "serverEndpoint": { "type": "string" } } }, "AzureSqlDataWarehouseDataSource": { "description": "The Azure SQL data warehouse data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDataWarehouseProperties" } }, "x-ms-discriminator-value": "AzureSqlDataWarehouse" }, "AzureMySqlProperties": { "description": "Azure MySQL data source properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "serverEndpoint": { "type": "string", "description": "The server endpoint of azure my sql." }, "port": { "format": "int32", "type": "integer", "description": "The port of azure my sql." } } }, "AzureMySqlDataSource": { "description": "Azure MySQL data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureMySqlProperties", "description": "Azure MySQL properties." } }, "x-ms-discriminator-value": "AzureMySql" }, "AzureStorageProperties": { "description": "The properties of Azure Storage.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureDataSourceProperties" } ], "properties": { "endpoint": { "type": "string", "description": "The endpoint of Azure Storage." } } }, "AzureStorageDataSource": { "description": "The Azure Storage data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/AzureStorageProperties", "description": "The properties of Azure Storage." } }, "x-ms-discriminator-value": "AzureStorage" }, "TeradataProperties": { "description": "The properties of teradata.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "host": { "type": "string", "description": "The host of teradata." } } }, "TeradataDataSource": { "description": "The teradata data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/TeradataProperties" } }, "x-ms-discriminator-value": "Teradata" }, "OracleProperties": { "description": "The properties of oracle.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "host": { "description": "The host of Oracle server.", "type": "string" }, "port": { "description": "The port of Oracle server.", "type": "string" }, "service": { "description": "The service of Oracle server.", "type": "string" } } }, "OracleDataSource": { "description": "The oracle data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/OracleProperties" } }, "x-ms-discriminator-value": "Oracle" }, "SapS4HanaProperties": { "description": "SAP S/4HANA data source properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "applicationServer": { "type": "string", "description": "The application server of SAP S/4HANA." }, "systemNumber": { "type": "string", "description": "The system number of SAP S/4HANA." } } }, "SapS4HanaDataSource": { "description": "SAP S/4HANA data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/SapS4HanaProperties" } }, "x-ms-discriminator-value": "SapS4Hana" }, "SapEccProperties": { "description": "SAP ECC properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "applicationServer": { "description": "The application server of SAP ECC.", "type": "string" }, "systemNumber": { "description": "The system number of SAP ECC.", "type": "string" } } }, "SapEccDataSource": { "description": "SAP ECC data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/SapEccProperties" } }, "x-ms-discriminator-value": "SapEcc" }, "PowerBIProperties": { "description": "Power BI properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSourceProperties" } ], "properties": { "tenant": { "description": "The tenant of Power BI.", "type": "string" } } }, "PowerBIDataSource": { "description": "Power BI data source.", "type": "object", "allOf": [ { "$ref": "#/definitions/DataSource" } ], "properties": { "properties": { "$ref": "#/definitions/PowerBIProperties" } }, "x-ms-discriminator-value": "PowerBI" }, "ScanRulesetProperties": { "description": "Scan ruleset properties.", "type": "object", "properties": { "createdAt": { "description": "The time at which the scan ruleset was created.", "format": "date-time", "type": "string", "readOnly": true }, "description": { "type": "string" }, "excludedSystemClassifications": { "description": "The system classifications that are excluded from the scan ruleset.", "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "includedCustomClassificationRuleNames": { "description": "The custom classification rule names that are included in the scan ruleset.", "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "lastModifiedAt": { "format": "date-time", "type": "string", "description": "The time at which the scan ruleset was last modified.", "readOnly": true } } }, "AzureSubscriptionScanRulesetProperties": { "description": "Azure subscription scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureSubscriptionScanRuleset": { "description": "Azure subscription scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "description": "Azure subscription scan ruleset properties.", "$ref": "#/definitions/AzureSubscriptionScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSubscription" }, "AzureResourceGroupScanRulesetProperties": { "description": "Azure resource group scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureResourceGroupScanRuleset": { "description": "Azure resource group scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "description": "Azure resource group scan ruleset properties.", "$ref": "#/definitions/AzureResourceGroupScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureResourceGroup" }, "AzureSynapseWorkspaceScanRulesetProperties": { "description": "Azure synapse workspace scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureSynapseWorkspaceScanRuleset": { "description": "Azure synapse workspace scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseWorkspaceScanRulesetProperties", "description": "Azure synapse workspace scan ruleset properties." } }, "x-ms-discriminator-value": "AzureSynapseWorkspace" }, "AzureSynapseScanRulesetProperties": { "description": "Azure synapse scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureSynapseScanRuleset": { "description": "Azure synapse scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseScanRulesetProperties", "description": "Azure synapse scan ruleset properties." } }, "x-ms-discriminator-value": "AzureSynapse" }, "CustomFileType": { "description": "Custom file type.", "type": "object", "properties": { "builtInType": { "description": "The built-in file type of the custom file type.", "enum": [ "AVRO", "ORC", "PARQUET", "JSON", "TXT", "XML", "Documents", "CSV", "PSV", "SSV", "TSV", "GZ", "DOC", "DOCM", "DOCX", "DOT", "ODP", "ODS", "ODT", "PDF", "POT", "PPS", "PPSX", "PPT", "PPTM", "PPTX", "XLC", "XLS", "XLSB", "XLSM", "XLSX", "XLT" ], "type": "string", "x-ms-enum": { "name": "FileExtensionsType", "modelAsString": true } }, "customDelimiter": { "type": "string", "description": "The custom delimiter of the custom file type." } } }, "CustomFileExtension": { "description": "Custom file extension.", "type": "object", "properties": { "customFileType": { "description": "The custom file type of the custom file extension.", "$ref": "#/definitions/CustomFileType" }, "description": { "type": "string", "description": "The description of the custom file extension." }, "enabled": { "type": "boolean", "description": "The flag to indicate whether the custom file extension is enabled or not." }, "fileExtension": { "type": "string", "description": "The file extension of the custom file extension." } } }, "ScanningRule": { "description": "Scanning rule.", "type": "object", "properties": { "fileExtensions": { "uniqueItems": true, "type": "array", "items": { "description": "The file extensions of the scanning rule.", "enum": [ "AVRO", "ORC", "PARQUET", "JSON", "TXT", "XML", "Documents", "CSV", "PSV", "SSV", "TSV", "GZ", "DOC", "DOCM", "DOCX", "DOT", "ODP", "ODS", "ODT", "PDF", "POT", "PPS", "PPSX", "PPT", "PPTM", "PPTX", "XLC", "XLS", "XLSB", "XLSM", "XLSX", "XLT" ], "type": "string", "x-ms-enum": { "name": "FileExtensionsType", "modelAsString": true } } }, "customFileExtensions": { "description": "The custom file extensions of the scanning rule.", "uniqueItems": true, "type": "array", "items": { "$ref": "#/definitions/CustomFileExtension" } } } }, "ScanningRuleScanRulesetProperties": { "description": "Scanning rule scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ], "properties": { "scanningRule": { "$ref": "#/definitions/ScanningRule", "description": "The scanning rule of the scanning rule scan ruleset." } } }, "AdlsGen1ScanRulesetProperties": { "description": "ADLS Gen1 scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanningRuleScanRulesetProperties" } ] }, "AdlsGen1ScanRuleset": { "description": "ADLS Gen1 scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen1ScanRulesetProperties" } }, "x-ms-discriminator-value": "AdlsGen1" }, "AdlsGen2ScanRulesetProperties": { "description": "Adls gen 2 scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanningRuleScanRulesetProperties" } ] }, "AdlsGen2ScanRuleset": { "description": "Adls gen 2 scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen2ScanRulesetProperties" } }, "x-ms-discriminator-value": "AdlsGen2" }, "AmazonAccountScanRulesetProperties": { "description": "Amazon account scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AmazonAccountScanRuleset": { "description": "Amazon account scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonAccountScanRulesetProperties" } }, "x-ms-discriminator-value": "AmazonAccount" }, "AmazonS3ScanRulesetProperties": { "description": "Amazon S3 scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanningRuleScanRulesetProperties" } ] }, "AmazonS3ScanRuleset": { "description": "Amazon S3 scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonS3ScanRulesetProperties" } }, "x-ms-discriminator-value": "AmazonS3" }, "AmazonSqlScanRulesetProperties": { "description": "Amazon SQL scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AmazonSqlScanRuleset": { "description": "Amazon SQL scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonSqlScanRulesetProperties" } }, "x-ms-discriminator-value": "AmazonSql" }, "AzureCosmosDbScanRulesetProperties": { "description": "Azure Cosmos DB scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureCosmosDbScanRuleset": { "description": "Azure Cosmos DB scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureCosmosDbScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureCosmosDb" }, "AzureDataExplorerScanRulesetProperties": { "description": "Azure data explorer scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureDataExplorerScanRuleset": { "description": "Azure data explorer scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureDataExplorerScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureDataExplorer" }, "AzureFileServiceScanRulesetProperties": { "description": "Azure file service scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanningRuleScanRulesetProperties" } ] }, "AzureFileServiceScanRuleset": { "description": "Azure file service scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureFileServiceScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureFileService" }, "AzureSqlDatabaseScanRulesetProperties": { "description": "Azure SQL db scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureSqlDatabaseScanRuleset": { "description": "Azure SQL db scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabase" }, "AmazonPostgreSqlScanRulesetProperties": { "description": "Azure Postgre SQL scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AmazonPostgreSqlScanRuleset": { "description": "Azure Postgre SQL scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonPostgreSqlScanRulesetProperties" } }, "x-ms-discriminator-value": "AmazonPostgreSql" }, "AzurePostgreSqlScanRulesetProperties": { "description": "Azure Postgre SQL scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzurePostgreSqlScanRuleset": { "description": "Azure Postgre SQL scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzurePostgreSqlScanRulesetProperties" } }, "x-ms-discriminator-value": "AzurePostgreSql" }, "SqlServerDatabaseScanRulesetProperties": { "description": "Sql server database scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "SqlServerDatabaseScanRuleset": { "description": "Sql server database scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/SqlServerDatabaseScanRulesetProperties" } }, "x-ms-discriminator-value": "SqlServerDatabase" }, "AzureSqlDatabaseManagedInstanceScanRulesetProperties": { "description": "Azure SQL db managed instance scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureSqlDatabaseManagedInstanceScanRuleset": { "description": "Azure SQL db managed instance scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstance" }, "AzureSqlDataWarehouseScanRulesetProperties": { "description": "Azure SQL data warehouse scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureSqlDataWarehouseScanRuleset": { "description": "Azure SQL data warehouse scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDataWarehouseScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSqlDataWarehouse" }, "AzureMySqlScanRulesetProperties": { "description": "Azure MySQL scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "AzureMySqlScanRuleset": { "description": "Azure MySQL scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureMySqlScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureMySql" }, "AzureStorageScanRulesetProperties": { "description": "Azure Storage scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanningRuleScanRulesetProperties" } ] }, "AzureStorageScanRuleset": { "description": "Azure Storage scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureStorageScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureStorage" }, "TeradataScanRulesetProperties": { "description": "Teradata scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanningRuleScanRulesetProperties" } ] }, "TeradataScanRuleset": { "description": "Teradata scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/TeradataScanRulesetProperties" } }, "x-ms-discriminator-value": "Teradata" }, "OracleScanRulesetProperties": { "description": "Oracle scan rule set properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanningRuleScanRulesetProperties" } ] }, "OracleScanRuleset": { "description": "Oracle scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/OracleScanRulesetProperties" } }, "x-ms-discriminator-value": "Oracle" }, "SapS4HanaScanRulesetProperties": { "description": "SAP S/4HANA scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "SapS4HanaScanRuleset": { "description": "SAP S/4HANA scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/SapS4HanaScanRulesetProperties" } }, "x-ms-discriminator-value": "SapS4Hana" }, "SapEccScanRulesetProperties": { "description": "SAP ECC scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "SapEccScanRuleset": { "description": "SAP ECC scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/SapEccScanRulesetProperties" } }, "x-ms-discriminator-value": "SapEcc" }, "PowerBIScanRulesetProperties": { "description": "Power BI scan ruleset properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRulesetProperties" } ] }, "PowerBIScanRuleset": { "description": "Power BI scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/PowerBIScanRulesetProperties" } }, "x-ms-discriminator-value": "PowerBI" }, "ResourceNameFilter": { "type": "object", "description": "Resource name filter.", "properties": { "excludePrefixes": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "includePrefixes": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "resources": { "type": "array", "items": { "type": "string" } } } }, "CredentialReference": { "description": "The credential reference.", "type": "object", "properties": { "referenceName": { "description": "The reference name of the credential.", "type": "string" }, "credentialType": { "description": "The type of the credential.", "enum": [ "AccountKey", "ServicePrincipal", "BasicAuth", "SqlAuth", "AmazonARN", "ConsumerKeyAuth", "DelegatedAuth", "ManagedIdentity" ], "type": "string", "x-ms-enum": { "name": "CredentialType", "values": [ { "value": "AccountKey", "description": "the credential type is account key" }, { "value": "ServicePrincipal", "description": "the credential type is service principal" }, { "value": "BasicAuth", "description": "the credential type is basic auth" }, { "value": "SqlAuth", "description": "the credential type is sql auth" }, { "value": "AmazonARN", "description": "the credential type is amazon ARN" }, { "value": "ConsumerKeyAuth", "description": "the credential type is Consumer Key Auth" }, { "value": "DelegatedAuth", "description": "the credential type is delegated auth" }, { "value": "ManagedIdentity", "description": "the credential type is managed identity" } ], "modelAsString": true } } } }, "ResourceTypeFilter": { "description": "Resource type filter.", "type": "object", "properties": { "scanRulesetName": { "type": "string", "description": "The name of the scan ruleset." }, "scanRulesetType": { "enum": [ "Custom", "System" ], "type": "string", "description": "The type of the scan ruleset.", "x-ms-enum": { "name": "ScanRulesetType", "values": [ { "value": "Custom", "description": "the scan ruleset type is custom" }, { "value": "System", "description": "the scan ruleset type is system default" } ], "modelAsString": true } }, "resourceNameFilter": { "$ref": "#/definitions/ResourceNameFilter" }, "credential": { "$ref": "#/definitions/CredentialReference" } } }, "ConnectedVia": { "description": "The integration runtime reference.", "type": "object", "properties": { "referenceName": { "type": "string", "description": "The reference name of the integration runtime." }, "integrationRuntimeType": { "type": "string", "description": "The type of the integration runtime.", "readOnly": true } } }, "ScanProperties": { "description": "Scan properties.", "type": "object", "properties": { "scanRulesetName": { "type": "string", "description": "The name of the scan ruleset." }, "businessRuleSetName": { "type": "string", "description": "The name of the business rule set." }, "scanRulesetType": { "enum": [ "Custom", "System" ], "type": "string", "description": "The type of the scan ruleset.", "x-ms-enum": { "name": "ScanRulesetType", "values": [ { "value": "Custom", "description": "the scan ruleset type is custom" }, { "value": "System", "description": "the scan ruleset type is system default" } ], "modelAsString": true } }, "collection": { "$ref": "#/definitions/CollectionReference", "description": "The collection reference of the scan." }, "domain": { "type": "string", "description": "The domain of the scan." }, "workers": { "format": "int32", "type": "integer", "description": "The number of workers of the scan." }, "createdAt": { "format": "date-time", "type": "string", "description": "The creation time of the scan.", "readOnly": true }, "lastModifiedAt": { "format": "date-time", "type": "string", "description": "The last modified time of the scan.", "readOnly": true }, "connectedVia": { "$ref": "#/definitions/ConnectedVia", "description": "The integration runtime reference of the scan." }, "isPresetScan": { "type": "boolean", "description": "The flag to indicate whether the scan is a preset scan or not." }, "isLiveViewEnabled": { "type": "boolean", "description": "The flag to indicate whether the live view is enabled or not." }, "parallelScanCount": { "format": "int32", "type": "integer", "description": "The number of parallel scans." }, "logLevel": { "type": "string", "description": "The log level of the scan." } } }, "ExpandingResourceScanProperties": { "description": "Expanding resource scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "resourceTypes": { "$ref": "#/definitions/ExpandingResourceScanPropertiesResourceTypes" }, "credential": { "$ref": "#/definitions/CredentialReference" } } }, "ExpandingResourceScanPropertiesResourceTypes": { "description": "Resource types of scan properties in expanding resources.", "type": "object", "properties": { "none": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureSubscription": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureResourceGroup": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureSynapseWorkspace": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureSynapse": { "$ref": "#/definitions/ResourceTypeFilter" }, "adlsGen1": { "$ref": "#/definitions/ResourceTypeFilter" }, "adlsGen2": { "$ref": "#/definitions/ResourceTypeFilter" }, "amazonAccount": { "$ref": "#/definitions/ResourceTypeFilter" }, "amazonS3": { "$ref": "#/definitions/ResourceTypeFilter" }, "amazonSql": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureCosmosDb": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureDataExplorer": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureFileService": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureSqlDatabase": { "$ref": "#/definitions/ResourceTypeFilter" }, "amazonPostgreSql": { "$ref": "#/definitions/ResourceTypeFilter" }, "azurePostgreSql": { "$ref": "#/definitions/ResourceTypeFilter" }, "sqlServerDatabase": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureSqlDatabaseManagedInstance": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureSqlDataWarehouse": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureMySql": { "$ref": "#/definitions/ResourceTypeFilter" }, "azureStorage": { "$ref": "#/definitions/ResourceTypeFilter" }, "teradata": { "$ref": "#/definitions/ResourceTypeFilter" }, "oracle": { "$ref": "#/definitions/ResourceTypeFilter" }, "sapS4Hana": { "$ref": "#/definitions/ResourceTypeFilter" }, "sapEcc": { "$ref": "#/definitions/ResourceTypeFilter" }, "powerBI": { "$ref": "#/definitions/ResourceTypeFilter" } } }, "AzureSubscriptionCredentialScanProperties": { "description": "Azure subscription credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AzureSubscriptionCredentialScan": { "description": "Azure subscription credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSubscriptionCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureSubscriptionCredential" }, "AzureSubscriptionMsiScanProperties": { "description": "Azure subscription MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AzureSubscriptionMsiScan": { "description": "Azure subscription MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSubscriptionMsiScanProperties" } }, "x-ms-discriminator-value": "AzureSubscriptionMsi" }, "AzureResourceGroupCredentialScanProperties": { "description": "Azure resource group credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AzureResourceGroupCredentialScan": { "description": "Azure resource group credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureResourceGroupCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureResourceGroupCredential" }, "AzureResourceGroupMsiScanProperties": { "description": "Azure resource group MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AzureResourceGroupMsiScan": { "description": "Azure resource group MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureResourceGroupMsiScanProperties" } }, "x-ms-discriminator-value": "AzureResourceGroupMsi" }, "AzureSynapseWorkspaceCredentialScanProperties": { "description": "Azure synapse workspace credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AzureSynapseWorkspaceCredentialScan": { "description": "Azure synapse workspace credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseWorkspaceCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureSynapseWorkspaceCredential" }, "AzureSynapseWorkspaceMsiScanProperties": { "description": "Azure synapse workspace MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AzureSynapseWorkspaceMsiScan": { "description": "Azure synapse workspace MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseWorkspaceMsiScanProperties" } }, "x-ms-discriminator-value": "AzureSynapseWorkspaceMsi" }, "AzureSynapseCredentialScanProperties": { "description": "Azure synapse credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AzureSynapseCredentialScan": { "description": "Azure synapse credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureSynapseCredential" }, "AzureSynapseMsiScanProperties": { "description": "Azure synapse MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AzureSynapseMsiScan": { "description": "Azure synapse MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseMsiScanProperties" } }, "x-ms-discriminator-value": "AzureSynapseMsi" }, "AdlsGen1CredentialScanProperties": { "description": "ADLS Gen1 credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" } } }, "AdlsGen1CredentialScan": { "description": "ADLS Gen1 credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen1CredentialScanProperties" } }, "x-ms-discriminator-value": "AdlsGen1Credential" }, "AdlsGen1MsiScanProperties": { "description": "ADLS Gen1 MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ] }, "AdlsGen1MsiScan": { "description": "ADLS Gen1 MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen1MsiScanProperties" } }, "x-ms-discriminator-value": "AdlsGen1Msi" }, "AdlsGen2CredentialScanProperties": { "description": "ADLS Gen2 credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" } } }, "AdlsGen2CredentialScan": { "description": "ADLS Gen2 credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen2CredentialScanProperties" } }, "x-ms-discriminator-value": "AdlsGen2Credential" }, "AdlsGen2MsiScanProperties": { "description": "ADLS Gen2 MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ] }, "AdlsGen2MsiScan": { "description": "ADLS Gen2 MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen2MsiScanProperties" } }, "x-ms-discriminator-value": "AdlsGen2Msi" }, "AmazonAccountCredentialScanProperties": { "description": "Amazon account credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ExpandingResourceScanProperties" } ] }, "AmazonAccountCredentialScan": { "description": "Amazon account credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonAccountCredentialScanProperties" } }, "x-ms-discriminator-value": "AmazonAccountCredential" }, "AmazonS3CredentialScanProperties": { "description": "Amazon S3 credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "roleARN": { "type": "string" }, "isMauiScan": { "type": "boolean" } } }, "AmazonS3CredentialScan": { "description": "Amazon S3 credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonS3CredentialScanProperties" } }, "x-ms-discriminator-value": "AmazonS3Credential" }, "AmazonS3RoleARNScanProperties": { "description": "Amazon S3 role ARN scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "roleARN": { "type": "string", "description": "The role ARN of the scan." }, "isMauiScan": { "type": "boolean", "description": "The flag to indicate whether the scan is a Maui scan or not." } } }, "AmazonS3RoleARNScan": { "description": "Amazon S3 role ARN scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonS3RoleARNScanProperties" } }, "x-ms-discriminator-value": "AmazonS3RoleARN" }, "AmazonSqlCredentialScanProperties": { "description": "Amazon SQL credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "serverEndpoint": { "description": "The endpoint of Amazon SQL server.", "type": "string" }, "databaseName": { "description": "The database name.", "type": "string" }, "port": { "description": "The port of Amazon SQL server.", "format": "int32", "type": "integer" }, "vpcEndpointServiceName": { "type": "string", "description": "The VPC endpoint service name of Amazon SQL server." } } }, "AmazonSqlCredentialScan": { "description": "Amazon SQL credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonSqlCredentialScanProperties" } }, "x-ms-discriminator-value": "AmazonSqlCredential" }, "AzureCosmosDbCredentialScanProperties": { "description": "Azure Cosmos DB credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "databaseName": { "type": "string" } } }, "AzureCosmosDbCredentialScan": { "description": "Azure Cosmos DB credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureCosmosDbCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureCosmosDbCredential" }, "AzureDataExplorerCredentialScanProperties": { "description": "Azure data Explorer credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "database": { "type": "string" } } }, "AzureDataExplorerCredentialScan": { "description": "Azure data Explorer credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureDataExplorerCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureDataExplorerCredential" }, "AzureDataExplorerMsiScanProperties": { "description": "Azure data Explorer MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "database": { "type": "string" } } }, "AzureDataExplorerMsiScan": { "description": "Azure data Explorer MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureDataExplorerMsiScanProperties" } }, "x-ms-discriminator-value": "AzureDataExplorerMsi" }, "AzureFileServiceCredentialScanProperties": { "description": "Azure file service credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "shareName": { "type": "string" } } }, "AzureFileServiceCredentialScan": { "description": "Azure file service credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureFileServiceCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureFileServiceCredential" }, "AzureSqlScanProperties": { "description": "Azure SQL scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "serverEndpoint": { "description": "The endpoint of Azure SQL server.", "type": "string" }, "databaseName": { "description": "The database name.", "type": "string" } } }, "AzureSqlCredentialScanProperties": { "description": "Azure SQL credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" } } }, "AzureSqlDatabaseCredentialScanProperties": { "type": "object", "description": "Azure SQL database credential scan properties.", "allOf": [ { "$ref": "#/definitions/AzureSqlCredentialScanProperties" } ] }, "AzureSqlDatabaseCredentialScan": { "description": "Azure SQL database credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabaseCredential" }, "AzureSqlDatabaseMsiScanProperties": { "description": "Azure SQL database MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlScanProperties" } ] }, "AzureSqlDatabaseMsiScan": { "description": "Azure SQL database MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseMsiScanProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabaseMsi" }, "AmazonPostgreSqlCredentialScanProperties": { "description": "Amazon Postgre SQL credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "serverEndpoint": { "description": "The endpoint of Amazon Postgre SQL server.", "type": "string" }, "databaseName": { "description": "The database name.", "type": "string" }, "port": { "description": "The port of Amazon Postgre SQL server.", "format": "int32", "type": "integer" }, "vpcEndpointServiceName": { "description": "The vpc endpoint service name of Amazon Postgre SQL server.", "type": "string" } } }, "AmazonPostgreSqlCredentialScan": { "description": "Amazon Postgre SQL credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonPostgreSqlCredentialScanProperties" } }, "x-ms-discriminator-value": "AmazonPostgreSqlCredential" }, "AzurePostgreSqlCredentialScanProperties": { "description": "Azure Postgre SQL credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "serverEndpoint": { "description": "The endpoint of Azure Postgre SQL server.", "type": "string" }, "databaseName": { "description": "The database name.", "type": "string" }, "port": { "description": "The port of Azure Postgre SQL server.", "format": "int32", "type": "integer" }, "sslMode": { "description": "The SSL mode of Azure Postgre SQL server.", "format": "int32", "type": "integer" } } }, "AzurePostgreSqlCredentialScan": { "description": "Azure Postgre SQL credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzurePostgreSqlCredentialScanProperties" } }, "x-ms-discriminator-value": "AzurePostgreSqlCredential" }, "SqlServerDatabaseCredentialScanProperties": { "description": "SQL server database credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlCredentialScanProperties" } ] }, "SqlServerDatabaseCredentialScan": { "description": "SQL server database credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/SqlServerDatabaseCredentialScanProperties" } }, "x-ms-discriminator-value": "SqlServerDatabaseCredential" }, "AzureSqlDatabaseManagedInstanceCredentialScanProperties": { "description": "Azure SQL database managed instance credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlCredentialScanProperties" } ] }, "AzureSqlDatabaseManagedInstanceCredentialScan": { "description": "Azure SQL database managed instance credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstanceCredential" }, "AzureSqlDatabaseManagedInstanceMsiScanProperties": { "description": "Azure SQL database managed instance MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlScanProperties" } ] }, "AzureSqlDatabaseManagedInstanceMsiScan": { "description": "Azure SQL database managed instance MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceMsiScanProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstanceMsi" }, "AzureSqlDataWarehouseCredentialScanProperties": { "description": "Azure SQL data warehouse credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlCredentialScanProperties" } ] }, "AzureSqlDataWarehouseCredentialScan": { "description": "Azure SQL data warehouse credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDataWarehouseCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureSqlDataWarehouseCredential" }, "AzureSqlDataWarehouseMsiScanProperties": { "description": "Azure SQL data warehouse MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureSqlScanProperties" } ] }, "AzureSqlDataWarehouseMsiScan": { "description": "Azure SQL data warehouse MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDataWarehouseMsiScanProperties" } }, "x-ms-discriminator-value": "AzureSqlDataWarehouseMsi" }, "AzureMySqlScanProperties": { "description": "Azure MySQL scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "serverEndpoint": { "description": "The endpoint of the Azure MySQL server.", "type": "string" }, "port": { "description": "The port of the Azure MySQL server.", "format": "int32", "type": "integer" }, "databaseName": { "description": "The database name.", "type": "string" }, "credential": { "$ref": "#/definitions/CredentialReference" } } }, "AzureMySqlCredentialScanProperties": { "description": "Azure MySQL credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/AzureMySqlScanProperties" } ] }, "AzureMySqlCredentialScan": { "description": "Azure MySQL credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureMySqlCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureMySqlCredential" }, "MitiScanProperties": { "description": "Miti scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "maximumMemoryAllowedInGb": { "description": "The maximum memory allowed in GB.", "type": "string" }, "mitiCache": { "description": "The miti cache.", "type": "string" } } }, "AzureStorageCredentialScanProperties": { "description": "Azure Storage credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" } } }, "AzureStorageCredentialScan": { "description": "Azure Storage credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureStorageCredentialScanProperties" } }, "x-ms-discriminator-value": "AzureStorageCredential" }, "AzureStorageMsiScanProperties": { "description": "Azure Storage MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ] }, "AzureStorageMsiScan": { "description": "Azure Storage MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/AzureStorageMsiScanProperties" } }, "x-ms-discriminator-value": "AzureStorageMsi" }, "TeradataTeradataCredentialScanProperties": { "description": "Teradata credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/MitiScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "schema": { "type": "string" }, "driverLocation": { "type": "string" }, "storedProcedureDetails": { "type": "string" } } }, "TeradataTeradataCredentialScan": { "description": "Teradata credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/TeradataTeradataCredentialScanProperties" } }, "x-ms-discriminator-value": "TeradataTeradataCredential" }, "TeradataUserPassScanProperties": { "description": "Teradata user pass scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "username": { "type": "string" }, "password": { "type": "string" } } }, "TeradataUserPassScan": { "description": "Teradata user pass scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/TeradataUserPassScanProperties" } }, "x-ms-discriminator-value": "TeradataUserPass" }, "TeradataTeradataUserPassScanProperties": { "description": "Teradata user pass scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/MitiScanProperties" } ], "properties": { "username": { "description": "The username of Teradata server.", "type": "string" }, "password": { "description": "The password of Teradata server.", "type": "string" }, "schema": { "description": "The schema.", "type": "string" }, "driverLocation": { "description": "The driver location.", "type": "string" } } }, "TeradataTeradataUserPassScan": { "description": "Teradata user pass scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/TeradataTeradataUserPassScanProperties" } }, "x-ms-discriminator-value": "TeradataTeradataUserPass" }, "OracleOracleCredentialScanProperties": { "description": "Oracle credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/MitiScanProperties" } ], "properties": { "credential": { "$ref": "#/definitions/CredentialReference" }, "schema": { "type": "string" }, "driverLocation": { "type": "string" }, "storedProcedureDetails": { "type": "string" } } }, "OracleOracleCredentialScan": { "description": "Oracle credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/OracleOracleCredentialScanProperties" } }, "x-ms-discriminator-value": "OracleOracleCredential" }, "OracleOracleUserPassScanProperties": { "description": "Oracle user pass scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/MitiScanProperties" } ], "properties": { "username": { "description": "The username of Oracle server.", "type": "string" }, "password": { "description": "The password of Oracle server.", "type": "string" }, "schema": { "description": "The schema.", "type": "string" }, "driverLocation": { "description": "The driver location.", "type": "string" } } }, "OracleOracleUserPassScan": { "description": "Oracle user pass scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/OracleOracleUserPassScanProperties" } }, "x-ms-discriminator-value": "OracleOracleUserPass" }, "SapS4HanaSapS4HanaCredentialScanProperties": { "description": "SAP S/4HANA credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/MitiScanProperties" } ], "properties": { "clientId": { "description": "The client ID of SAP S/4HANA server.", "type": "string" }, "credential": { "$ref": "#/definitions/CredentialReference" }, "jCoLibraryPath": { "description": "The JCo library path.", "type": "string" } } }, "SapS4HanaSapS4HanaCredentialScan": { "description": "SAP S/4HANA credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/SapS4HanaSapS4HanaCredentialScanProperties" } }, "x-ms-discriminator-value": "SapS4HanaSapS4HanaCredential" }, "SapS4HanaSapS4HanaUserPassScanProperties": { "description": "SAP S/4HANA user pass scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/MitiScanProperties" } ], "properties": { "clientId": { "type": "string", "description": "The client ID of SAP S/4HANA server." }, "username": { "type": "string", "description": "The username of SAP S/4HANA server." }, "password": { "type": "string", "description": "The password of SAP S/4HANA server." }, "jCoLibraryPath": { "type": "string", "description": "The JCo library path." } } }, "SapS4HanaSapS4HanaUserPassScan": { "description": "SAP S/4HANA user pass scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/SapS4HanaSapS4HanaUserPassScanProperties" } }, "x-ms-discriminator-value": "SapS4HanaSapS4HanaUserPass" }, "SapEccSapEccCredentialScanProperties": { "description": "SAP ECC credential scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/MitiScanProperties" } ], "properties": { "clientId": { "type": "string" }, "credential": { "$ref": "#/definitions/CredentialReference" }, "jCoLibraryPath": { "type": "string" } } }, "SapEccSapEccCredentialScan": { "description": "SAP ECC credential scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/SapEccSapEccCredentialScanProperties" } }, "x-ms-discriminator-value": "SapEccSapEccCredential" }, "SapEccSapEccUserPassScanProperties": { "description": "SAP ECC user pass scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/MitiScanProperties" } ], "properties": { "clientId": { "type": "string" }, "username": { "type": "string" }, "password": { "type": "string" }, "jCoLibraryPath": { "type": "string" } } }, "SapEccSapEccUserPassScan": { "description": "SAP ECC user pass scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/SapEccSapEccUserPassScanProperties" } }, "x-ms-discriminator-value": "SapEccSapEccUserPass" }, "PowerBIDelegatedScanProperties": { "description": "Power BI delegated scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "tenant": { "type": "string" }, "authenticationType": { "type": "string" }, "clientId": { "type": "string" }, "userName": { "type": "string" }, "password": { "type": "string" }, "includePersonalWorkspaces": { "type": "boolean" } } }, "PowerBIDelegatedScan": { "description": "Power BI delegated scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/PowerBIDelegatedScanProperties" } }, "x-ms-discriminator-value": "PowerBIDelegated" }, "PowerBIMsiScanProperties": { "description": "Power BI MSI scan properties.", "type": "object", "allOf": [ { "$ref": "#/definitions/ScanProperties" } ], "properties": { "includePersonalWorkspaces": { "description": "Whether to include personal workspaces or not.", "type": "boolean" } } }, "PowerBIMsiScan": { "description": "Power BI MSI scan.", "type": "object", "allOf": [ { "$ref": "#/definitions/Scan" } ], "properties": { "properties": { "$ref": "#/definitions/PowerBIMsiScanProperties" } }, "x-ms-discriminator-value": "PowerBIMsi" }, "AzureSubscriptionSystemScanRuleset": { "description": "Azure subscription system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSubscriptionScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSubscription" }, "AzureResourceGroupSystemScanRuleset": { "description": "Azure resource group system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureResourceGroupScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureResourceGroup" }, "AzureSynapseWorkspaceSystemScanRuleset": { "description": "Azure synapse workspace system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseWorkspaceScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSynapseWorkspace" }, "AzureSynapseSystemScanRuleset": { "description": "Azure Synapse System scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSynapseScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSynapse" }, "AdlsGen1SystemScanRuleset": { "description": "ADLS Gen1 System scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen1ScanRulesetProperties" } }, "x-ms-discriminator-value": "AdlsGen1" }, "AdlsGen2SystemScanRuleset": { "description": "ADLS Gen2 system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AdlsGen2ScanRulesetProperties" } }, "x-ms-discriminator-value": "AdlsGen2" }, "AmazonAccountSystemScanRuleset": { "description": "Amazon account system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonAccountScanRulesetProperties" } }, "x-ms-discriminator-value": "AmazonAccount" }, "AmazonS3SystemScanRuleset": { "description": "Amazon S3 system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonS3ScanRulesetProperties" } }, "x-ms-discriminator-value": "AmazonS3" }, "AmazonSqlSystemScanRuleset": { "description": "Amazon SQL system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonSqlScanRulesetProperties" } }, "x-ms-discriminator-value": "AmazonSql" }, "AzureCosmosDbSystemScanRuleset": { "description": "Azure Cosmos DB system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureCosmosDbScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureCosmosDb" }, "AzureDataExplorerSystemScanRuleset": { "description": "Azure data explorer system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureDataExplorerScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureDataExplorer" }, "AzureFileServiceSystemScanRuleset": { "description": "Azure file service system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureFileServiceScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureFileService" }, "AzureSqlDatabaseSystemScanRuleset": { "description": "Azure SQL db system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabase" }, "AmazonPostgreSqlSystemScanRuleset": { "description": "Amazon Postgre SQL system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AmazonPostgreSqlScanRulesetProperties" } }, "x-ms-discriminator-value": "AmazonPostgreSql" }, "AzurePostgreSqlSystemScanRuleset": { "description": "Azure Postgre SQL system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzurePostgreSqlScanRulesetProperties" } }, "x-ms-discriminator-value": "AzurePostgreSql" }, "SqlServerDatabaseSystemScanRuleset": { "description": "Sql server database system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/SqlServerDatabaseScanRulesetProperties" } }, "x-ms-discriminator-value": "SqlServerDatabase" }, "AzureSqlDatabaseManagedInstanceSystemScanRuleset": { "description": "Azure SQL database managed instance system scan rule set.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDatabaseManagedInstanceScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSqlDatabaseManagedInstance" }, "AzureSqlDataWarehouseSystemScanRuleset": { "description": "Azure SQL data warehouse system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureSqlDataWarehouseScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureSqlDataWarehouse" }, "AzureMySqlSystemScanRuleset": { "description": "Azure MySQL system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureMySqlScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureMySql" }, "AzureStorageSystemScanRuleset": { "description": "Azure Storage system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/AzureStorageScanRulesetProperties" } }, "x-ms-discriminator-value": "AzureStorage" }, "TeradataSystemScanRuleset": { "description": "Teradata system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/TeradataScanRulesetProperties" } }, "x-ms-discriminator-value": "Teradata" }, "OracleSystemScanRuleset": { "description": "Oracle system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/OracleScanRulesetProperties" } }, "x-ms-discriminator-value": "Oracle" }, "SapS4HanaSystemScanRuleset": { "description": "SAP S/4HANA system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/SapS4HanaScanRulesetProperties" } }, "x-ms-discriminator-value": "SapS4Hana" }, "SapEccSystemScanRuleset": { "description": "SAP ECC system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/SapEccScanRulesetProperties" } }, "x-ms-discriminator-value": "SapEcc" }, "PowerBISystemScanRuleset": { "description": "Power BI system scan ruleset.", "type": "object", "allOf": [ { "$ref": "#/definitions/SystemScanRuleset" } ], "properties": { "properties": { "$ref": "#/definitions/PowerBIScanRulesetProperties" } }, "x-ms-discriminator-value": "PowerBI" } }, "parameters": { "api-version": { "in": "query", "name": "api-version", "description": "The api version to use.", "required": true, "type": "string", "x-ms-client-name": "ApiVersion", "x-ms-parameter-location": "client" }, "endpoint": { "in": "path", "name": "endpoint", "description": "The scanning endpoint of your purview account. Example: https://{accountName}.purview.azure.com.", "required": true, "type": "string", "format": "url", "x-ms-parameter-location": "client", "x-ms-skip-url-encoding": true }, "integrationRuntimeName": { "in": "path", "name": "integrationRuntimeName", "description": "The integration runtime name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "x-ms-parameter-location": "method" }, "managedVirtualNetworkName": { "in": "path", "name": "managedVirtualNetworkName", "description": "The managed virtual network name. It is restricted to the value 'defaultv2' for now.", "required": true, "type": "string", "enum": [ "defaultv2" ], "x-ms-enum": { "name": "ManagedVirtualNetworkName", "modelAsString": true }, "x-ms-parameter-location": "method" }, "managedPrivateEndpointName": { "in": "path", "name": "managedPrivateEndpointName", "description": "The managed private endpoint name.", "required": true, "type": "string", "minLength": 1, "maxLength": 127, "pattern": "^([_A-Za-z0-9]|([_A-Za-z0-9][-_A-Za-z0-9]{0,125}[_A-Za-z0-9]))$", "x-ms-parameter-location": "method" }, "azureKeyVaultName": { "in": "path", "name": "azureKeyVaultName", "description": "The Azure Key Vault name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "x-ms-parameter-location": "method" }, "classificationRuleName": { "in": "path", "name": "classificationRuleName", "description": "The classification rule name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "x-ms-parameter-location": "method" }, "credentialName": { "in": "path", "name": "credentialName", "description": "The credential name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "x-ms-parameter-location": "method" }, "dataSourceName": { "in": "path", "name": "dataSourceName", "description": "The dataSource name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "x-ms-parameter-location": "method" }, "dataSourceTypeInPath": { "in": "path", "name": "dataSourceType", "description": "The data source type.", "required": true, "enum": [ "None", "Fabric", "AzureSubscription", "AzureResourceGroup", "AzureSynapseWorkspace", "AzureSynapse", "AdlsGen1", "AdlsGen2", "AmazonAccount", "AmazonS3", "AmazonSql", "AzureCosmosDb", "AzureDataExplorer", "AzureFileService", "AzureSqlDatabase", "ArcEnabledSqlServer", "AmazonPostgreSql", "AzurePostgreSql", "Databricks", "SqlServerDatabase", "AzureSqlDatabaseManagedInstance", "AzureSqlDataWarehouse", "AzureMySql", "Hdfs", "TableauServer", "AzureStorage", "Teradata", "Oracle", "PostgreSql", "AmazonRedShift", "DatabricksHms", "SapS4Hana", "SapEcc", "Snowflake", "PowerBI", "Trident", "Dataverse", "DatabricksUnityCatalog" ], "type": "string", "x-ms-enum": { "name": "DataSourceType", "modelAsString": true }, "x-ms-parameter-location": "method" }, "dataSourceTypeInQuery": { "in": "query", "name": "dataSourceType", "description": "The data source type.", "enum": [ "None", "Fabric", "AzureSubscription", "AzureResourceGroup", "AzureSynapseWorkspace", "AzureSynapse", "AdlsGen1", "AdlsGen2", "AmazonAccount", "AmazonS3", "AmazonSql", "AzureCosmosDb", "AzureDataExplorer", "AzureFileService", "AzureSqlDatabase", "ArcEnabledSqlServer", "AmazonPostgreSql", "AzurePostgreSql", "Databricks", "SqlServerDatabase", "AzureSqlDatabaseManagedInstance", "AzureSqlDataWarehouse", "AzureMySql", "Hdfs", "TableauServer", "AzureStorage", "Teradata", "Oracle", "PostgreSql", "AmazonRedShift", "DatabricksHms", "SapS4Hana", "SapEcc", "Snowflake", "PowerBI", "Trident", "Dataverse", "DatabricksUnityCatalog" ], "type": "string", "x-ms-enum": { "name": "DataSourceType", "modelAsString": true }, "x-ms-parameter-location": "method" }, "scanName": { "in": "path", "name": "scanName", "description": "The scan name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "x-ms-parameter-location": "method" }, "runId": { "in": "path", "name": "runId", "description": "The scan run id.", "required": true, "type": "string", "minLength": 36, "maxLength": 36, "pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$", "x-ms-parameter-location": "method" }, "runIdInQuery": { "in": "query", "name": "runId", "description": "The scan run id.", "required": true, "type": "string", "minLength": 36, "maxLength": 36, "pattern": "^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$", "x-ms-parameter-location": "method" }, "scanRulesetName": { "in": "path", "name": "scanRulesetName", "description": "The scan ruleset name.", "required": true, "type": "string", "minLength": 3, "maxLength": 63, "pattern": "^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$", "x-ms-parameter-location": "method" } } }