获取单个扫描记录的扫描详细信息。
GET https://management.azure.com/{resourceId}/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/{scanId}?workspaceId={workspaceId}&api-version=2023-02-01-preview
URI 参数
| 名称 |
在 |
必需 |
类型 |
说明 |
|
resourceId
|
path |
True
|
string
|
资源的标识符。
|
|
scanId
|
path |
True
|
string
|
扫描 ID。键入“latest”以获取最新扫描的扫描记录。
|
|
api-version
|
query |
True
|
string
|
API 版本。
|
|
workspaceId
|
query |
True
|
string
|
工作区 ID。
|
响应
| 名称 |
类型 |
说明 |
|
200 OK
|
Scan
|
返回扫描记录详细信息。
|
|
Other Status Codes
|
CloudError
|
描述操作失败的原因的错误响应。
|
安全性
azure_auth
Azure Active Directory OAuth2 Flow
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
| 名称 |
说明 |
|
user_impersonation
|
模拟用户帐户
|
示例
Get scan details of a scan record
示例请求
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/Scheduled-20200623?workspaceId=55555555-6666-7777-8888-999999999999&api-version=2023-02-01-preview
/**
* Samples for SqlVulnerabilityAssessmentScans Get.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/
* sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_Get.json
*/
/**
* Sample code: Get scan details of a scan record.
*
* @param manager Entry point to SecurityManager.
*/
public static void getScanDetailsOfAScanRecord(com.azure.resourcemanager.security.SecurityManager manager) {
manager.sqlVulnerabilityAssessmentScans().getWithResponse("Scheduled-20200623",
"55555555-6666-7777-8888-999999999999",
"subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master",
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsecurity_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_Get.json
func ExampleSQLVulnerabilityAssessmentScansClient_Get_getScanDetailsOfAScanRecord() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSQLVulnerabilityAssessmentScansClient().Get(ctx, "Scheduled-20200623", "55555555-6666-7777-8888-999999999999", "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Scan = armsecurity.Scan{
// Name: to.Ptr("Scheduled-20200623"),
// Type: to.Ptr("Microsoft.Security/sqlVulnerabilityAssessments/scans"),
// ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/Scheduled-20200623"),
// Properties: &armsecurity.ScanProperties{
// Database: to.Ptr("master"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.723Z"); return t}()),
// HighSeverityFailedRulesCount: to.Ptr[int32](3),
// IsBaselineApplied: to.Ptr(false),
// LastScanTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.645Z"); return t}()),
// LowSeverityFailedRulesCount: to.Ptr[int32](1),
// MediumSeverityFailedRulesCount: to.Ptr[int32](2),
// Server: to.Ptr("server1"),
// SQLVersion: to.Ptr("15.0.2000"),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.645Z"); return t}()),
// State: to.Ptr(armsecurity.ScanStateFailed),
// TotalFailedRulesCount: to.Ptr[int32](6),
// TotalPassedRulesCount: to.Ptr[int32](20),
// TotalRulesCount: to.Ptr[int32](26),
// TriggerType: to.Ptr(armsecurity.ScanTriggerTypeRecurring),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the scan details of a single scan record.
*
* @summary Gets the scan details of a single scan record.
* x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_Get.json
*/
async function getScanDetailsOfAScanRecord() {
const scanId = "Scheduled-20200623";
const workspaceId = "55555555-6666-7777-8888-999999999999";
const resourceId =
"subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
const credential = new DefaultAzureCredential();
const client = new SecurityCenter(credential);
const result = await client.sqlVulnerabilityAssessmentScans.get(scanId, workspaceId, resourceId);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;
// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_Get.json
// this example is just showing the usage of "SqlVulnerabilityAssessmentScans_Get" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SqlVulnerabilityAssessmentScanResource created on azure
// for more information of creating SqlVulnerabilityAssessmentScanResource, please refer to the document of SqlVulnerabilityAssessmentScanResource
string resourceId = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
string scanId = "Scheduled-20200623";
ResourceIdentifier sqlVulnerabilityAssessmentScanResourceId = SqlVulnerabilityAssessmentScanResource.CreateResourceIdentifier(resourceId, scanId);
SqlVulnerabilityAssessmentScanResource sqlVulnerabilityAssessmentScan = client.GetSqlVulnerabilityAssessmentScanResource(sqlVulnerabilityAssessmentScanResourceId);
// invoke the operation
Guid workspaceId = Guid.Parse("55555555-6666-7777-8888-999999999999");
SqlVulnerabilityAssessmentScanResource result = await sqlVulnerabilityAssessmentScan.GetAsync(workspaceId);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlVulnerabilityAssessmentScanData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
示例响应
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/Scheduled-20200623",
"name": "Scheduled-20200623",
"type": "Microsoft.Security/sqlVulnerabilityAssessments/scans",
"properties": {
"triggerType": "Recurring",
"state": "Failed",
"server": "server1",
"database": "master",
"sqlVersion": "15.0.2000",
"startTime": "2020-06-23T06:49:00.6455136+00:00",
"endTime": "2020-06-23T06:49:00.7236217Z",
"highSeverityFailedRulesCount": 3,
"mediumSeverityFailedRulesCount": 2,
"lowSeverityFailedRulesCount": 1,
"totalPassedRulesCount": 20,
"totalFailedRulesCount": 6,
"totalRulesCount": 26,
"isBaselineApplied": false,
"lastScanTime": "2020-06-23T06:49:00.6455136+00:00"
}
}
Get scan details of the latest scan record
示例请求
GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/latest?workspaceId=55555555-6666-7777-8888-999999999999&api-version=2023-02-01-preview
/**
* Samples for SqlVulnerabilityAssessmentScans Get.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/
* sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_GetLatest.json
*/
/**
* Sample code: Get scan details of the latest scan record.
*
* @param manager Entry point to SecurityManager.
*/
public static void getScanDetailsOfTheLatestScanRecord(com.azure.resourcemanager.security.SecurityManager manager) {
manager.sqlVulnerabilityAssessmentScans().getWithResponse("latest", "55555555-6666-7777-8888-999999999999",
"subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master",
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armsecurity_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/security/armsecurity"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/9ac34f238dd6b9071f486b57e9f9f1a0c43ec6f6/specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_GetLatest.json
func ExampleSQLVulnerabilityAssessmentScansClient_Get_getScanDetailsOfTheLatestScanRecord() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armsecurity.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewSQLVulnerabilityAssessmentScansClient().Get(ctx, "latest", "55555555-6666-7777-8888-999999999999", "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master", nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.Scan = armsecurity.Scan{
// Name: to.Ptr("Scheduled-20200623"),
// Type: to.Ptr("Microsoft.Security/sqlVulnerabilityAssessments/scans"),
// ID: to.Ptr("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/Scheduled-20200623"),
// Properties: &armsecurity.ScanProperties{
// Database: to.Ptr("master"),
// EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.723Z"); return t}()),
// HighSeverityFailedRulesCount: to.Ptr[int32](3),
// IsBaselineApplied: to.Ptr(false),
// LastScanTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.645Z"); return t}()),
// LowSeverityFailedRulesCount: to.Ptr[int32](1),
// MediumSeverityFailedRulesCount: to.Ptr[int32](2),
// Server: to.Ptr("server1"),
// SQLVersion: to.Ptr("15.0.2000"),
// StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2020-06-23T06:49:00.645Z"); return t}()),
// State: to.Ptr(armsecurity.ScanStateFailed),
// TotalFailedRulesCount: to.Ptr[int32](6),
// TotalPassedRulesCount: to.Ptr[int32](20),
// TotalRulesCount: to.Ptr[int32](26),
// TriggerType: to.Ptr(armsecurity.ScanTriggerTypeRecurring),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { SecurityCenter } = require("@azure/arm-security");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the scan details of a single scan record.
*
* @summary Gets the scan details of a single scan record.
* x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_GetLatest.json
*/
async function getScanDetailsOfTheLatestScanRecord() {
const scanId = "latest";
const workspaceId = "55555555-6666-7777-8888-999999999999";
const resourceId =
"subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
const credential = new DefaultAzureCredential();
const client = new SecurityCenter(credential);
const result = await client.sqlVulnerabilityAssessmentScans.get(scanId, workspaceId, resourceId);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
using Azure.ResourceManager.SecurityCenter.Models;
// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2023-02-01-preview/examples/sqlVulnerabilityAssessmentScanOperations/ArcMachineScans_GetLatest.json
// this example is just showing the usage of "SqlVulnerabilityAssessmentScans_Get" operation, for the dependent resources, they will have to be created separately.
// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);
// this example assumes you already have this SqlVulnerabilityAssessmentScanResource created on azure
// for more information of creating SqlVulnerabilityAssessmentScanResource, please refer to the document of SqlVulnerabilityAssessmentScanResource
string resourceId = "subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master";
string scanId = "latest";
ResourceIdentifier sqlVulnerabilityAssessmentScanResourceId = SqlVulnerabilityAssessmentScanResource.CreateResourceIdentifier(resourceId, scanId);
SqlVulnerabilityAssessmentScanResource sqlVulnerabilityAssessmentScan = client.GetSqlVulnerabilityAssessmentScanResource(sqlVulnerabilityAssessmentScanResourceId);
// invoke the operation
Guid workspaceId = Guid.Parse("55555555-6666-7777-8888-999999999999");
SqlVulnerabilityAssessmentScanResource result = await sqlVulnerabilityAssessmentScan.GetAsync(workspaceId);
// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SqlVulnerabilityAssessmentScanData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
示例响应
{
"id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Rg/providers/Microsoft.HybridCompute/machines/MyMachine/sqlServers/server1/databases/master/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/Scheduled-20200623",
"name": "Scheduled-20200623",
"type": "Microsoft.Security/sqlVulnerabilityAssessments/scans",
"properties": {
"triggerType": "Recurring",
"state": "Failed",
"server": "server1",
"database": "master",
"sqlVersion": "15.0.2000",
"startTime": "2020-06-23T06:49:00.6455136+00:00",
"endTime": "2020-06-23T06:49:00.7236217Z",
"highSeverityFailedRulesCount": 3,
"mediumSeverityFailedRulesCount": 2,
"lowSeverityFailedRulesCount": 1,
"totalPassedRulesCount": 20,
"totalFailedRulesCount": 6,
"totalRulesCount": 26,
"isBaselineApplied": false,
"lastScanTime": "2020-06-23T06:49:00.6455136+00:00"
}
}
定义
CloudError
所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。 （这也遵循 OData 错误响应格式）。
| 名称 |
类型 |
说明 |
|
error.additionalInfo
|
ErrorAdditionalInfo[]
|
错误附加信息。
|
|
error.code
|
string
|
错误代码。
|
|
error.details
|
CloudErrorBody[]
|
错误详细信息。
|
|
error.message
|
string
|
错误消息。
|
|
error.target
|
string
|
错误目标。
|
CloudErrorBody
错误详细信息。
ErrorAdditionalInfo
资源管理错误附加信息。
| 名称 |
类型 |
说明 |
|
info
|
object
|
其他信息。
|
|
type
|
string
|
其他信息类型。
|
Scan
漏洞评估扫描记录。
| 名称 |
类型 |
说明 |
|
id
|
string
|
资源 ID
|
|
name
|
string
|
资源名称
|
|
properties
|
ScanProperties
|
漏洞评估扫描记录属性。
|
|
type
|
string
|
资源类型
|
ScanProperties
漏洞评估扫描记录属性。
| 名称 |
类型 |
说明 |
|
database
|
string
|
数据库名称。
|
|
endTime
|
string
|
扫描结果在结束时间（UTC）之前有效。
|
|
highSeverityFailedRulesCount
|
integer
|
严重性较高的失败规则数。
|
|
isBaselineApplied
|
boolean
|
为此数据库创建的基线，并具有一个或多个规则。
|
|
lastScanTime
|
string
|
上次扫描时间。
|
|
lowSeverityFailedRulesCount
|
integer
|
严重性较低的失败规则数。
|
|
mediumSeverityFailedRulesCount
|
integer
|
具有中等严重性的失败规则数。
|
|
server
|
string
|
服务器名称。
|
|
sqlVersion
|
string
|
SQL 版本。
|
|
startTime
|
string
|
扫描开始时间（UTC）。
|
|
state
|
ScanState
|
扫描状态。
|
|
totalFailedRulesCount
|
integer
|
失败规则总数。
|
|
totalPassedRulesCount
|
integer
|
已传递的规则总数。
|
|
totalRulesCount
|
integer
|
评估的规则总数。
|
|
triggerType
|
ScanTriggerType
|
扫描触发器类型。
|
ScanState
扫描状态。
| 名称 |
类型 |
说明 |
|
Failed
|
string
|
失败
|
|
FailedToRun
|
string
|
FailedToRun
|
|
InProgress
|
string
|
InProgress
|
|
Passed
|
string
|
通过
|
ScanTriggerType
扫描触发器类型。
| 名称 |
类型 |
说明 |
|
OnDemand
|
string
|
OnDemand
|
|
Recurring
|
string
|
经常性
|