Details of a specific Compliance.
GET https://management.azure.com/{scope}/providers/Microsoft.Security/compliances/{complianceName}?api-version=2017-08-01-preview
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
complianceName
|
path |
True
|
string
|
name of the Compliance
|
|
scope
|
path |
True
|
string
|
Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).
|
|
api-version
|
query |
True
|
string
|
API version for the operation
|
Responses
| Name |
Type |
Description |
|
200 OK
|
Compliance
|
OK
|
|
Other Status Codes
|
CloudError
|
Error response describing why the operation failed.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
Get security compliance data for a day
Sample request
GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/compliances/2018-01-01Z?api-version=2017-08-01-preview
/**
* Samples for Compliances Get.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/
* GetCompliance_example.json
*/
/**
* Sample code: Get security compliance data for a day.
*
* @param manager Entry point to SecurityManager.
*/
public static void getSecurityComplianceDataForADay(com.azure.resourcemanager.security.SecurityManager manager) {
manager.compliances().getWithResponse("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", "2018-01-01Z",
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/GetCompliance_example.json
func ExampleCompliancesClient_Get() {
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.NewCompliancesClient().Get(ctx, "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23", "2018-01-01Z", 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.Compliance = 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),
// },
// }
}
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 Details of a specific Compliance.
*
* @summary Details of a specific Compliance.
* x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json
*/
async function getSecurityComplianceDataForADay() {
const scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
const complianceName = "2018-01-01Z";
const credential = new DefaultAzureCredential();
const client = new SecurityCenter(credential);
const result = await client.compliances.get(scope, complianceName);
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;
// Generated from example definition: specification/security/resource-manager/Microsoft.Security/preview/2017-08-01-preview/examples/Compliances/GetCompliance_example.json
// this example is just showing the usage of "Compliances_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 SecurityComplianceResource created on azure
// for more information of creating SecurityComplianceResource, please refer to the document of SecurityComplianceResource
string scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
string complianceName = "2018-01-01Z";
ResourceIdentifier securityComplianceResourceId = SecurityComplianceResource.CreateResourceIdentifier(scope, complianceName);
SecurityComplianceResource securityCompliance = client.GetSecurityComplianceResource(securityComplianceResourceId);
// invoke the operation
SecurityComplianceResource result = await securityCompliance.GetAsync();
// 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
SecurityComplianceData 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
Sample response
{
"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"
}
}
Definitions
| Name |
Description |
|
CloudError
|
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
|
|
CloudErrorBody
|
The error detail.
|
|
Compliance
|
Compliance of a scope
|
|
ComplianceSegment
|
A segment of a compliance assessment.
|
|
ErrorAdditionalInfo
|
The resource management error additional info.
|
CloudError
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
| Name |
Type |
Description |
|
error.additionalInfo
|
ErrorAdditionalInfo[]
|
The error additional info.
|
|
error.code
|
string
|
The error code.
|
|
error.details
|
CloudErrorBody[]
|
The error details.
|
|
error.message
|
string
|
The error message.
|
|
error.target
|
string
|
The error target.
|
CloudErrorBody
The error detail.
| Name |
Type |
Description |
|
additionalInfo
|
ErrorAdditionalInfo[]
|
The error additional info.
|
|
code
|
string
|
The error code.
|
|
details
|
CloudErrorBody[]
|
The error details.
|
|
message
|
string
|
The error message.
|
|
target
|
string
|
The error target.
|
Compliance
Compliance of a scope
| Name |
Type |
Description |
|
id
|
string
|
Resource Id
|
|
name
|
string
|
Resource name
|
|
properties.assessmentResult
|
ComplianceSegment[]
|
An array of segment, which is the actually the compliance assessment.
|
|
properties.assessmentTimestampUtcDate
|
string
|
The timestamp when the Compliance calculation was conducted.
|
|
properties.resourceCount
|
integer
|
The resource count of the given subscription for which the Compliance calculation was conducted (needed for Management Group Compliance calculation).
|
|
type
|
string
|
Resource type
|
ComplianceSegment
A segment of a compliance assessment.
| Name |
Type |
Description |
|
percentage
|
number
|
The size (%) of the segment.
|
|
segmentType
|
string
|
The segment type, e.g. compliant, non-compliance, insufficient coverage, N/A, etc.
|
ErrorAdditionalInfo
The resource management error additional info.
| Name |
Type |
Description |
|
info
|
object
|
The additional info.
|
|
type
|
string
|
The additional info type.
|