Efterlevnadspoängen för den specifika hanteringsgruppen.
GET https://management.azure.com/{scope}/providers/Microsoft.Security/compliances?api-version=2017-08-01-preview
URI-parametrar
| Name |
I |
Obligatorisk |
Typ |
Description |
|
scope
|
path |
True
|
string
|
Frågans omfattning kan vara prenumeration (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) eller hanteringsgrupp (/providers/Microsoft.Management/managementGroups/mgName).
|
|
api-version
|
query |
True
|
string
|
API-version för åtgärden
|
Svar
| Name |
Typ |
Description |
|
200 OK
|
ComplianceList
|
OKEJ
|
|
Other Status Codes
|
CloudError
|
Felsvar som beskriver varför åtgärden misslyckades.
|
Säkerhet
azure_auth
Azure Active Directory OAuth2 Flow
Typ:
oauth2
Flow:
implicit
Auktoriseringswebbadress:
https://login.microsoftonline.com/common/oauth2/authorize
Omfattningar
| Name |
Description |
|
user_impersonation
|
personifiera ditt användarkonto
|
Exempel
Get security compliance data over time
Exempelbegäran
GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances?api-version=2017-08-01-preview
/**
* Samples for Compliances List.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/
* GetCompliances_example.json
*/
/**
* Sample code: Get security compliance data over time.
*
* @param manager Entry point to SecurityManager.
*/
public static void getSecurityComplianceDataOverTime(com.azure.resourcemanager.security.SecurityManager manager) {
manager.compliances().list("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23",
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/2017-08-01-preview/examples/Compliances/GetCompliances_example.json
func ExampleCompliancesClient_NewListPager() {
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)
}
pager := clientFactory.NewCompliancesClient().NewListPager("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", nil)
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.ComplianceList = armsecurity.ComplianceList{
// Value: []*armsecurity.Compliance{
// {
// Name: to.Ptr("2018-01-01Z"),
// Type: to.Ptr("Microsoft.Security/compliances"),
// ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z"),
// Properties: &armsecurity.ComplianceProperties{
// AssessmentResult: []*armsecurity.ComplianceSegment{
// {
// Percentage: to.Ptr[float64](77.77777777777779),
// SegmentType: to.Ptr("Compliant"),
// }},
// AssessmentTimestampUTCDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-01T00:00:00.000Z"); return t}()),
// ResourceCount: to.Ptr[int32](18),
// },
// },
// {
// Name: to.Ptr("2018-01-02Z"),
// Type: to.Ptr("Microsoft.Security/compliances"),
// ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-02Z"),
// Properties: &armsecurity.ComplianceProperties{
// AssessmentResult: []*armsecurity.ComplianceSegment{
// {
// Percentage: to.Ptr[float64](94.44444444444444),
// SegmentType: to.Ptr("Compliant"),
// }},
// AssessmentTimestampUTCDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-02T00:00:00.000Z"); return t}()),
// ResourceCount: to.Ptr[int32](18),
// },
// },
// {
// Name: to.Ptr("2018-01-03Z"),
// Type: to.Ptr("Microsoft.Security/compliances"),
// ID: to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-03Z"),
// Properties: &armsecurity.ComplianceProperties{
// AssessmentResult: []*armsecurity.ComplianceSegment{
// {
// Percentage: to.Ptr[float64](100),
// SegmentType: to.Ptr("Compliant"),
// }},
// AssessmentTimestampUTCDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-01-03T00:00:00.000Z"); return t}()),
// ResourceCount: to.Ptr[int32](18),
// },
// }},
// }
}
}
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 The Compliance scores of the specific management group.
*
* @summary The Compliance scores of the specific management group.
* x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json
*/
async function getSecurityComplianceDataOverTime() {
const scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
const credential = new DefaultAzureCredential();
const client = new SecurityCenter(credential);
const resArray = new Array();
for await (let item of client.compliances.list(scope)) {
resArray.push(item);
}
console.log(resArray);
}
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;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.SecurityCenter;
// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliances_example.json
// this example is just showing the usage of "Compliances_List" 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 ArmResource created on azure
// for more information of creating ArmResource, please refer to the document of ArmResource
// get the collection of this SecurityComplianceResource
string scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
SecurityComplianceCollection collection = client.GetSecurityCompliances(scopeId);
// invoke the operation and iterate over the result
await foreach (SecurityComplianceResource item in collection.GetAllAsync())
{
// the variable item 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
SecurityComplianceData resourceData = item.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}
Console.WriteLine($"Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Exempelsvar
{
"value": [
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z",
"name": "2018-01-01Z",
"type": "Microsoft.Security/compliances",
"properties": {
"assessmentResult": [
{
"segmentType": "Compliant",
"percentage": 77.77777777777779
}
],
"resourceCount": 18,
"assessmentTimestampUtcDate": "2018-01-01T00:00:00Z"
}
},
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-02Z",
"name": "2018-01-02Z",
"type": "Microsoft.Security/compliances",
"properties": {
"assessmentResult": [
{
"segmentType": "Compliant",
"percentage": 94.44444444444444
}
],
"resourceCount": 18,
"assessmentTimestampUtcDate": "2018-01-02T00:00:00Z"
}
},
{
"id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-03Z",
"name": "2018-01-03Z",
"type": "Microsoft.Security/compliances",
"properties": {
"assessmentResult": [
{
"segmentType": "Compliant",
"percentage": 100
}
],
"resourceCount": 18,
"assessmentTimestampUtcDate": "2018-01-03T00:00:00Z"
}
}
]
}
Definitioner
| Name |
Description |
|
CloudError
|
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
|
|
CloudErrorBody
|
Felinformationen.
|
|
Compliance
|
Efterlevnad av ett omfång
|
|
ComplianceList
|
Lista över svar på efterlevnadsobjekt
|
|
ComplianceSegment
|
Ett segment av en efterlevnadsbedömning.
|
|
ErrorAdditionalInfo
|
Ytterligare information om resurshanteringsfelet.
|
CloudError
Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
| Name |
Typ |
Description |
|
error.additionalInfo
|
ErrorAdditionalInfo[]
|
Ytterligare information om felet.
|
|
error.code
|
string
|
Felkoden.
|
|
error.details
|
CloudErrorBody[]
|
Felinformationen.
|
|
error.message
|
string
|
Felmeddelandet.
|
|
error.target
|
string
|
Felmålet.
|
CloudErrorBody
Felinformationen.
| Name |
Typ |
Description |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
Ytterligare information om felet.
|
|
code
|
string
|
Felkoden.
|
|
details
|
CloudErrorBody[]
|
Felinformationen.
|
|
message
|
string
|
Felmeddelandet.
|
|
target
|
string
|
Felmålet.
|
Compliance
Efterlevnad av ett omfång
| Name |
Typ |
Description |
|
id
|
string
|
Resurs-ID
|
|
name
|
string
|
Resursnamn
|
|
properties.assessmentResult
|
ComplianceSegment[]
|
En matris med segment, vilket faktiskt är kompatibilitetsbedömningen.
|
|
properties.assessmentTimestampUtcDate
|
string
|
Tidsstämpeln när beräkningen av efterlevnad utfördes.
|
|
properties.resourceCount
|
integer
|
Resursantalet för den angivna prenumeration som beräkningen av efterlevnaden utfördes för (behövs för beräkningen av hanteringsgruppens efterlevnad).
|
|
type
|
string
|
Resurstyp
|
ComplianceList
Lista över svar på efterlevnadsobjekt
| Name |
Typ |
Description |
|
nextLink
|
string
|
URI:n för att hämta nästa sida.
|
|
value
|
Compliance[]
|
Lista över efterlevnadsobjekt
|
ComplianceSegment
Ett segment av en efterlevnadsbedömning.
| Name |
Typ |
Description |
|
percentage
|
number
|
Segmentets storlek (%).
|
|
segmentType
|
string
|
Segmenttypen, t.ex. kompatibel, icke-efterlevnad, otillräcklig täckning, N/A osv.
|
ErrorAdditionalInfo
Ytterligare information om resurshanteringsfelet.
| Name |
Typ |
Description |
|
info
|
object
|
Ytterligare information.
|
|
type
|
string
|
Ytterligare informationstyp.
|