Governance Rules - List

Reference

Service:: Defender for Cloud

API Version:: 2022-01-01-preview

Get a list of all relevant governance rules over a scope

GET https://management.azure.com/{scope}/providers/Microsoft.Security/governanceRules?api-version=2022-01-01-preview

URI Parameters

Name	In	Required	Type	Description
scope	path	True	string	The scope of the Governance rules. Valid scopes are: management group (format: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), subscription (format: 'subscriptions/{subscriptionId}'), or security connector (format: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'
api-version	query	True	string	API version for the operation

Responses

Name	Type	Description
200 OK	GovernanceRuleList	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

List governance rules by management group scope

List governance rules by security connector scope

List governance rules by subscription scope

List governance rules by management group scope

Sample request

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/governanceRules?api-version=2022-01-01-preview


/**
 * Samples for GovernanceRules List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceRules/
     * ListByManagementGroupGovernanceRules_example.json
     */
    /**
     * Sample code: List governance rules by management group scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        listGovernanceRulesByManagementGroupScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.governanceRules().list("providers/Microsoft.Management/managementGroups/contoso",
            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/2022-01-01-preview/examples/GovernanceRules/ListByManagementGroupGovernanceRules_example.json
func ExampleGovernanceRulesClient_NewListPager_listGovernanceRulesByManagementGroupScope() {
	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.NewGovernanceRulesClient().NewListPager("providers/Microsoft.Management/managementGroups/contoso", 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.GovernanceRuleList = armsecurity.GovernanceRuleList{
		// 	Value: []*armsecurity.GovernanceRule{
		// 		{
		// 			Name: to.Ptr("ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
		// 			Type: to.Ptr("Microsoft.Security/governanceRules"),
		// 			ID: to.Ptr("providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/governanceRules/ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
		// 			Properties: &armsecurity.GovernanceRuleProperties{
		// 				Description: to.Ptr("A rule for a management group"),
		// 				ConditionSets: []any{
		// 					map[string]any{
		// 						"conditions":[]any{
		// 							map[string]any{
		// 								"operator": "In",
		// 								"property": "$.AssessmentKey",
		// 								"value": "[\"b1cd27e0-4ecc-4246-939f-49c426d9d72f\", \"fe83f80b-073d-4ccf-93d9-6797eb870201\"]",
		// 							},
		// 						},
		// 				}},
		// 				DisplayName: to.Ptr("Management group rule"),
		// 				GovernanceEmailNotification: &armsecurity.GovernanceRuleEmailNotification{
		// 					DisableManagerEmailNotification: to.Ptr(false),
		// 					DisableOwnerEmailNotification: to.Ptr(false),
		// 				},
		// 				IsDisabled: to.Ptr(false),
		// 				IsGracePeriod: to.Ptr(true),
		// 				Metadata: &armsecurity.GovernanceRuleMetadata{
		// 					CreatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 					UpdatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					UpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 				},
		// 				OwnerSource: &armsecurity.GovernanceRuleOwnerSource{
		// 					Type: to.Ptr(armsecurity.GovernanceRuleOwnerSourceTypeManually),
		// 					Value: to.Ptr("user@contoso.com"),
		// 				},
		// 				RemediationTimeframe: to.Ptr("7.00:00:00"),
		// 				RulePriority: to.Ptr[int32](100),
		// 				RuleType: to.Ptr(armsecurity.GovernanceRuleTypeIntegrated),
		// 				SourceResourceType: to.Ptr(armsecurity.GovernanceRuleSourceResourceTypeAssessments),
		// 				TenantID: to.Ptr("f0b6d37b-e4bc-4719-9291-c066c3194f23"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("4106f43c-6d82-4fc8-a92c-dcfe50799d1d"),
		// 			Type: to.Ptr("Microsoft.Security/governanceRules"),
		// 			ID: to.Ptr("providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/governanceRules/4106f43c-6d82-4fc8-a92c-dcfe50799d1d"),
		// 			Properties: &armsecurity.GovernanceRuleProperties{
		// 				Description: to.Ptr("A rule for a management group"),
		// 				ConditionSets: []any{
		// 					map[string]any{
		// 						"conditions":[]any{
		// 							map[string]any{
		// 								"operator": "Equals",
		// 								"property": "$.Metadata.Severity",
		// 								"value": "Low",
		// 							},
		// 						},
		// 				}},
		// 				DisplayName: to.Ptr("Management group rule 2"),
		// 				ExcludedScopes: []*string{
		// 					to.Ptr("/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23")},
		// 					GovernanceEmailNotification: &armsecurity.GovernanceRuleEmailNotification{
		// 						DisableManagerEmailNotification: to.Ptr(false),
		// 						DisableOwnerEmailNotification: to.Ptr(false),
		// 					},
		// 					IncludeMemberScopes: to.Ptr(false),
		// 					IsDisabled: to.Ptr(false),
		// 					IsGracePeriod: to.Ptr(true),
		// 					Metadata: &armsecurity.GovernanceRuleMetadata{
		// 						CreatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 						CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 						UpdatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 						UpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 					},
		// 					OwnerSource: &armsecurity.GovernanceRuleOwnerSource{
		// 						Type: to.Ptr(armsecurity.GovernanceRuleOwnerSourceTypeManually),
		// 						Value: to.Ptr("user@contoso.com"),
		// 					},
		// 					RemediationTimeframe: to.Ptr("7.00:00:00"),
		// 					RulePriority: to.Ptr[int32](200),
		// 					RuleType: to.Ptr(armsecurity.GovernanceRuleTypeIntegrated),
		// 					SourceResourceType: to.Ptr(armsecurity.GovernanceRuleSourceResourceTypeAssessments),
		// 					TenantID: to.Ptr("f0b6d37b-e4bc-4719-9291-c066c3194f23"),
		// 				},
		// 		}},
		// 	}
	}
}

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 Get a list of all relevant governance rules over a scope
 *
 * @summary Get a list of all relevant governance rules over a scope
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceRules/ListByManagementGroupGovernanceRules_example.json
 */
async function listGovernanceRulesByManagementGroupScope() {
  const scope = "providers/Microsoft.Management/managementGroups/contoso";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const resArray = new Array();
  for await (let item of client.governanceRules.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.Collections.Generic;
using System.Threading.Tasks;
using Azure;
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/2022-01-01-preview/examples/GovernanceRules/ListByManagementGroupGovernanceRules_example.json
// this example is just showing the usage of "GovernanceRules_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 GovernanceRuleResource
string scope = "providers/Microsoft.Management/managementGroups/contoso";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
GovernanceRuleCollection collection = client.GetGovernanceRules(scopeId);

// invoke the operation and iterate over the result
await foreach (GovernanceRuleResource 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
    GovernanceRuleData 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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/governanceRules/ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
      "name": "ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
      "type": "Microsoft.Security/governanceRules",
      "properties": {
        "tenantId": "f0b6d37b-e4bc-4719-9291-c066c3194f23",
        "displayName": "Management group rule",
        "description": "A rule for a management group",
        "remediationTimeframe": "7.00:00:00",
        "isGracePeriod": true,
        "rulePriority": 100,
        "isDisabled": false,
        "ruleType": "Integrated",
        "sourceResourceType": "Assessments",
        "conditionSets": [
          {
            "conditions": [
              {
                "property": "$.AssessmentKey",
                "value": "[\"b1cd27e0-4ecc-4246-939f-49c426d9d72f\", \"fe83f80b-073d-4ccf-93d9-6797eb870201\"]",
                "operator": "In"
              }
            ]
          }
        ],
        "ownerSource": {
          "type": "Manually",
          "value": "user@contoso.com"
        },
        "governanceEmailNotification": {
          "disableManagerEmailNotification": false,
          "disableOwnerEmailNotification": false
        },
        "metadata": {
          "createdBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "createdOn": "2022-11-10T08:31:26.7993124Z",
          "updatedBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "updatedOn": "2022-11-10T08:31:26.7993124Z"
        }
      }
    },
    {
      "id": "providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/governanceRules/4106f43c-6d82-4fc8-a92c-dcfe50799d1d",
      "name": "4106f43c-6d82-4fc8-a92c-dcfe50799d1d",
      "type": "Microsoft.Security/governanceRules",
      "properties": {
        "tenantId": "f0b6d37b-e4bc-4719-9291-c066c3194f23",
        "displayName": "Management group rule 2",
        "description": "A rule for a management group",
        "remediationTimeframe": "7.00:00:00",
        "isGracePeriod": true,
        "rulePriority": 200,
        "isDisabled": false,
        "ruleType": "Integrated",
        "sourceResourceType": "Assessments",
        "conditionSets": [
          {
            "conditions": [
              {
                "property": "$.Metadata.Severity",
                "value": "Low",
                "operator": "Equals"
              }
            ]
          }
        ],
        "ownerSource": {
          "type": "Manually",
          "value": "user@contoso.com"
        },
        "governanceEmailNotification": {
          "disableManagerEmailNotification": false,
          "disableOwnerEmailNotification": false
        },
        "excludedScopes": [
          "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23"
        ],
        "includeMemberScopes": false,
        "metadata": {
          "createdBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "createdOn": "2022-11-10T08:31:26.7993124Z",
          "updatedBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "updatedOn": "2022-11-10T08:31:26.7993124Z"
        }
      }
    }
  ]
}

List governance rules by security connector scope

Sample request

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/governanceRules?api-version=2022-01-01-preview


/**
 * Samples for GovernanceRules List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceRules/
     * ListBySecurityConnectorGovernanceRules_example.json
     */
    /**
     * Sample code: List governance rules by security connector scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        listGovernanceRulesBySecurityConnectorScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.governanceRules().list(
            "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector",
            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/2022-01-01-preview/examples/GovernanceRules/ListBySecurityConnectorGovernanceRules_example.json
func ExampleGovernanceRulesClient_NewListPager_listGovernanceRulesBySecurityConnectorScope() {
	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.NewGovernanceRulesClient().NewListPager("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector", 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.GovernanceRuleList = armsecurity.GovernanceRuleList{
		// 	Value: []*armsecurity.GovernanceRule{
		// 		{
		// 			Name: to.Ptr("ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
		// 			Type: to.Ptr("Microsoft.Security/governanceRules"),
		// 			ID: to.Ptr("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/governanceRules/ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
		// 			Properties: &armsecurity.GovernanceRuleProperties{
		// 				Description: to.Ptr("A rule on critical GCP recommendations"),
		// 				ConditionSets: []any{
		// 					map[string]any{
		// 						"conditions":[]any{
		// 							map[string]any{
		// 								"operator": "In",
		// 								"property": "$.AssessmentKey",
		// 								"value": "[\"b1cd27e0-4ecc-4246-939f-49c426d9d72f\", \"fe83f80b-073d-4ccf-93d9-6797eb870201\"]",
		// 							},
		// 						},
		// 				}},
		// 				DisplayName: to.Ptr("Admin's GCP rule"),
		// 				ExcludedScopes: []*string{
		// 				},
		// 				GovernanceEmailNotification: &armsecurity.GovernanceRuleEmailNotification{
		// 					DisableManagerEmailNotification: to.Ptr(false),
		// 					DisableOwnerEmailNotification: to.Ptr(false),
		// 				},
		// 				IncludeMemberScopes: to.Ptr(false),
		// 				IsDisabled: to.Ptr(false),
		// 				IsGracePeriod: to.Ptr(true),
		// 				Metadata: &armsecurity.GovernanceRuleMetadata{
		// 					CreatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 					UpdatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					UpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 				},
		// 				OwnerSource: &armsecurity.GovernanceRuleOwnerSource{
		// 					Type: to.Ptr(armsecurity.GovernanceRuleOwnerSourceTypeManually),
		// 					Value: to.Ptr("user@contoso.com"),
		// 				},
		// 				RemediationTimeframe: to.Ptr("7.00:00:00"),
		// 				RulePriority: to.Ptr[int32](100),
		// 				RuleType: to.Ptr(armsecurity.GovernanceRuleTypeIntegrated),
		// 				SourceResourceType: to.Ptr(armsecurity.GovernanceRuleSourceResourceTypeAssessments),
		// 				TenantID: to.Ptr("f0b6d37b-e4bc-4719-9291-c066c3194f23"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("4106f43c-6d82-4fc8-a92c-dcfe50799d1d"),
		// 			Type: to.Ptr("Microsoft.Security/governanceRules"),
		// 			ID: to.Ptr("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/governanceRules/4106f43c-6d82-4fc8-a92c-dcfe50799d1d"),
		// 			Properties: &armsecurity.GovernanceRuleProperties{
		// 				Description: to.Ptr("A rule on critical GCP recommendations"),
		// 				ConditionSets: []any{
		// 					map[string]any{
		// 						"conditions":[]any{
		// 							map[string]any{
		// 								"operator": "Equals",
		// 								"property": "$.Metadata.Severity",
		// 								"value": "Low",
		// 							},
		// 						},
		// 				}},
		// 				DisplayName: to.Ptr("GCP Admin's rule"),
		// 				ExcludedScopes: []*string{
		// 				},
		// 				GovernanceEmailNotification: &armsecurity.GovernanceRuleEmailNotification{
		// 					DisableManagerEmailNotification: to.Ptr(false),
		// 					DisableOwnerEmailNotification: to.Ptr(false),
		// 				},
		// 				IncludeMemberScopes: to.Ptr(false),
		// 				IsDisabled: to.Ptr(false),
		// 				IsGracePeriod: to.Ptr(true),
		// 				Metadata: &armsecurity.GovernanceRuleMetadata{
		// 					CreatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 					UpdatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					UpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 				},
		// 				OwnerSource: &armsecurity.GovernanceRuleOwnerSource{
		// 					Type: to.Ptr(armsecurity.GovernanceRuleOwnerSourceTypeManually),
		// 					Value: to.Ptr("user@contoso.com"),
		// 				},
		// 				RemediationTimeframe: to.Ptr("7.00:00:00"),
		// 				RulePriority: to.Ptr[int32](200),
		// 				RuleType: to.Ptr(armsecurity.GovernanceRuleTypeIntegrated),
		// 				SourceResourceType: to.Ptr(armsecurity.GovernanceRuleSourceResourceTypeAssessments),
		// 				TenantID: to.Ptr("f0b6d37b-e4bc-4719-9291-c066c3194f23"),
		// 			},
		// 	}},
		// }
	}
}

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 Get a list of all relevant governance rules over a scope
 *
 * @summary Get a list of all relevant governance rules over a scope
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceRules/ListBySecurityConnectorGovernanceRules_example.json
 */
async function listGovernanceRulesBySecurityConnectorScope() {
  const scope =
    "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector";
  const credential = new DefaultAzureCredential();
  const client = new SecurityCenter(credential);
  const resArray = new Array();
  for await (let item of client.governanceRules.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.Collections.Generic;
using System.Threading.Tasks;
using Azure;
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/2022-01-01-preview/examples/GovernanceRules/ListBySecurityConnectorGovernanceRules_example.json
// this example is just showing the usage of "GovernanceRules_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 GovernanceRuleResource
string scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
GovernanceRuleCollection collection = client.GetGovernanceRules(scopeId);

// invoke the operation and iterate over the result
await foreach (GovernanceRuleResource 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
    GovernanceRuleData 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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/governanceRules/ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
      "name": "ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
      "type": "Microsoft.Security/governanceRules",
      "properties": {
        "tenantId": "f0b6d37b-e4bc-4719-9291-c066c3194f23",
        "displayName": "Admin's GCP rule",
        "description": "A rule on critical GCP recommendations",
        "remediationTimeframe": "7.00:00:00",
        "isGracePeriod": true,
        "rulePriority": 100,
        "isDisabled": false,
        "ruleType": "Integrated",
        "sourceResourceType": "Assessments",
        "conditionSets": [
          {
            "conditions": [
              {
                "property": "$.AssessmentKey",
                "value": "[\"b1cd27e0-4ecc-4246-939f-49c426d9d72f\", \"fe83f80b-073d-4ccf-93d9-6797eb870201\"]",
                "operator": "In"
              }
            ]
          }
        ],
        "ownerSource": {
          "type": "Manually",
          "value": "user@contoso.com"
        },
        "governanceEmailNotification": {
          "disableManagerEmailNotification": false,
          "disableOwnerEmailNotification": false
        },
        "excludedScopes": [],
        "includeMemberScopes": false,
        "metadata": {
          "createdBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "createdOn": "2022-11-10T08:31:26.7993124Z",
          "updatedBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "updatedOn": "2022-11-10T08:31:26.7993124Z"
        }
      }
    },
    {
      "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourcegroups/gcpResourceGroup/providers/Microsoft.Security/securityConnectors/gcpconnector/providers/Microsoft.Security/governanceRules/4106f43c-6d82-4fc8-a92c-dcfe50799d1d",
      "name": "4106f43c-6d82-4fc8-a92c-dcfe50799d1d",
      "type": "Microsoft.Security/governanceRules",
      "properties": {
        "tenantId": "f0b6d37b-e4bc-4719-9291-c066c3194f23",
        "displayName": "GCP Admin's rule",
        "description": "A rule on critical GCP recommendations",
        "remediationTimeframe": "7.00:00:00",
        "isGracePeriod": true,
        "rulePriority": 200,
        "isDisabled": false,
        "ruleType": "Integrated",
        "sourceResourceType": "Assessments",
        "conditionSets": [
          {
            "conditions": [
              {
                "property": "$.Metadata.Severity",
                "value": "Low",
                "operator": "Equals"
              }
            ]
          }
        ],
        "ownerSource": {
          "type": "Manually",
          "value": "user@contoso.com"
        },
        "governanceEmailNotification": {
          "disableManagerEmailNotification": false,
          "disableOwnerEmailNotification": false
        },
        "excludedScopes": [],
        "includeMemberScopes": false,
        "metadata": {
          "createdBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "createdOn": "2022-11-10T08:31:26.7993124Z",
          "updatedBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "updatedOn": "2022-11-10T08:31:26.7993124Z"
        }
      }
    }
  ]
}

List governance rules by subscription scope

Sample request

GET https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/governanceRules?api-version=2022-01-01-preview


/**
 * Samples for GovernanceRules List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceRules/
     * ListBySubscriptionGovernanceRules_example.json
     */
    /**
     * Sample code: List governance rules by subscription scope.
     * 
     * @param manager Entry point to SecurityManager.
     */
    public static void
        listGovernanceRulesBySubscriptionScope(com.azure.resourcemanager.security.SecurityManager manager) {
        manager.governanceRules().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/2022-01-01-preview/examples/GovernanceRules/ListBySubscriptionGovernanceRules_example.json
func ExampleGovernanceRulesClient_NewListPager_listGovernanceRulesBySubscriptionScope() {
	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.NewGovernanceRulesClient().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.GovernanceRuleList = armsecurity.GovernanceRuleList{
		// 	Value: []*armsecurity.GovernanceRule{
		// 		{
		// 			Name: to.Ptr("ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
		// 			Type: to.Ptr("Microsoft.Security/governanceRules"),
		// 			ID: to.Ptr("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/governanceRules/ad9a8e26-29d9-4829-bb30-e597a58cdbb8"),
		// 			Properties: &armsecurity.GovernanceRuleProperties{
		// 				Description: to.Ptr("A rule for critical recommendations"),
		// 				ConditionSets: []any{
		// 					map[string]any{
		// 						"conditions":[]any{
		// 							map[string]any{
		// 								"operator": "In",
		// 								"property": "$.AssessmentKey",
		// 								"value": "[\"b1cd27e0-4ecc-4246-939f-49c426d9d72f\", \"fe83f80b-073d-4ccf-93d9-6797eb870201\"]",
		// 							},
		// 						},
		// 				}},
		// 				DisplayName: to.Ptr("Admin's rule"),
		// 				ExcludedScopes: []*string{
		// 				},
		// 				GovernanceEmailNotification: &armsecurity.GovernanceRuleEmailNotification{
		// 					DisableManagerEmailNotification: to.Ptr(false),
		// 					DisableOwnerEmailNotification: to.Ptr(false),
		// 				},
		// 				IncludeMemberScopes: to.Ptr(false),
		// 				IsDisabled: to.Ptr(false),
		// 				IsGracePeriod: to.Ptr(true),
		// 				Metadata: &armsecurity.GovernanceRuleMetadata{
		// 					CreatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 					UpdatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					UpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 				},
		// 				OwnerSource: &armsecurity.GovernanceRuleOwnerSource{
		// 					Type: to.Ptr(armsecurity.GovernanceRuleOwnerSourceTypeManually),
		// 					Value: to.Ptr("user@contoso.com"),
		// 				},
		// 				RemediationTimeframe: to.Ptr("7.00:00:00"),
		// 				RulePriority: to.Ptr[int32](100),
		// 				RuleType: to.Ptr(armsecurity.GovernanceRuleTypeIntegrated),
		// 				SourceResourceType: to.Ptr(armsecurity.GovernanceRuleSourceResourceTypeAssessments),
		// 				TenantID: to.Ptr("f0b6d37b-e4bc-4719-9291-c066c3194f23"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("4106f43c-6d82-4fc8-a92c-dcfe50799d1d"),
		// 			Type: to.Ptr("Microsoft.Security/governanceRules"),
		// 			ID: to.Ptr("subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/governanceRules/4106f43c-6d82-4fc8-a92c-dcfe50799d1d"),
		// 			Properties: &armsecurity.GovernanceRuleProperties{
		// 				Description: to.Ptr("A rule for critical recommendations"),
		// 				ConditionSets: []any{
		// 					map[string]any{
		// 						"conditions":[]any{
		// 							map[string]any{
		// 								"operator": "Equals",
		// 								"property": "$.Metadata.Severity",
		// 								"value": "Low",
		// 							},
		// 						},
		// 				}},
		// 				DisplayName: to.Ptr("Admin's rule"),
		// 				ExcludedScopes: []*string{
		// 				},
		// 				GovernanceEmailNotification: &armsecurity.GovernanceRuleEmailNotification{
		// 					DisableManagerEmailNotification: to.Ptr(true),
		// 					DisableOwnerEmailNotification: to.Ptr(true),
		// 				},
		// 				IncludeMemberScopes: to.Ptr(false),
		// 				IsDisabled: to.Ptr(false),
		// 				IsGracePeriod: to.Ptr(true),
		// 				Metadata: &armsecurity.GovernanceRuleMetadata{
		// 					CreatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					CreatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 					UpdatedBy: to.Ptr("c23b5354-ff0a-4b2a-9f92-6f144effd936"),
		// 					UpdatedOn: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2022-11-10T08:31:26.799Z"); return t}()),
		// 				},
		// 				OwnerSource: &armsecurity.GovernanceRuleOwnerSource{
		// 					Type: to.Ptr(armsecurity.GovernanceRuleOwnerSourceTypeManually),
		// 					Value: to.Ptr("user@contoso.com"),
		// 				},
		// 				RemediationTimeframe: to.Ptr("7.00:00:00"),
		// 				RulePriority: to.Ptr[int32](200),
		// 				RuleType: to.Ptr(armsecurity.GovernanceRuleTypeIntegrated),
		// 				SourceResourceType: to.Ptr(armsecurity.GovernanceRuleSourceResourceTypeAssessments),
		// 				TenantID: to.Ptr("f0b6d37b-e4bc-4719-9291-c066c3194f23"),
		// 			},
		// 	}},
		// }
	}
}

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 Get a list of all relevant governance rules over a scope
 *
 * @summary Get a list of all relevant governance rules over a scope
 * x-ms-original-file: specification/security/resource-manager/Microsoft.Security/preview/2022-01-01-preview/examples/GovernanceRules/ListBySubscriptionGovernanceRules_example.json
 */
async function listGovernanceRulesBySubscriptionScope() {
  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.governanceRules.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.Collections.Generic;
using System.Threading.Tasks;
using Azure;
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/2022-01-01-preview/examples/GovernanceRules/ListBySubscriptionGovernanceRules_example.json
// this example is just showing the usage of "GovernanceRules_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 GovernanceRuleResource
string scope = "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23";
ResourceIdentifier scopeId = new ResourceIdentifier(string.Format("/{0}", scope));
GovernanceRuleCollection collection = client.GetGovernanceRules(scopeId);

// invoke the operation and iterate over the result
await foreach (GovernanceRuleResource 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
    GovernanceRuleData 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

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/governanceRules/ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
      "name": "ad9a8e26-29d9-4829-bb30-e597a58cdbb8",
      "type": "Microsoft.Security/governanceRules",
      "properties": {
        "tenantId": "f0b6d37b-e4bc-4719-9291-c066c3194f23",
        "displayName": "Admin's rule",
        "description": "A rule for critical recommendations",
        "remediationTimeframe": "7.00:00:00",
        "isGracePeriod": true,
        "rulePriority": 100,
        "isDisabled": false,
        "ruleType": "Integrated",
        "sourceResourceType": "Assessments",
        "conditionSets": [
          {
            "conditions": [
              {
                "property": "$.AssessmentKey",
                "value": "[\"b1cd27e0-4ecc-4246-939f-49c426d9d72f\", \"fe83f80b-073d-4ccf-93d9-6797eb870201\"]",
                "operator": "In"
              }
            ]
          }
        ],
        "ownerSource": {
          "type": "Manually",
          "value": "user@contoso.com"
        },
        "governanceEmailNotification": {
          "disableManagerEmailNotification": false,
          "disableOwnerEmailNotification": false
        },
        "excludedScopes": [],
        "includeMemberScopes": false,
        "metadata": {
          "createdBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "createdOn": "2022-11-10T08:31:26.7993124Z",
          "updatedBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "updatedOn": "2022-11-10T08:31:26.7993124Z"
        }
      }
    },
    {
      "id": "subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/governanceRules/4106f43c-6d82-4fc8-a92c-dcfe50799d1d",
      "name": "4106f43c-6d82-4fc8-a92c-dcfe50799d1d",
      "type": "Microsoft.Security/governanceRules",
      "properties": {
        "tenantId": "f0b6d37b-e4bc-4719-9291-c066c3194f23",
        "displayName": "Admin's rule",
        "description": "A rule for critical recommendations",
        "remediationTimeframe": "7.00:00:00",
        "isGracePeriod": true,
        "rulePriority": 200,
        "isDisabled": false,
        "ruleType": "Integrated",
        "sourceResourceType": "Assessments",
        "conditionSets": [
          {
            "conditions": [
              {
                "property": "$.Metadata.Severity",
                "value": "Low",
                "operator": "Equals"
              }
            ]
          }
        ],
        "ownerSource": {
          "type": "Manually",
          "value": "user@contoso.com"
        },
        "governanceEmailNotification": {
          "disableManagerEmailNotification": true,
          "disableOwnerEmailNotification": true
        },
        "excludedScopes": [],
        "includeMemberScopes": false,
        "metadata": {
          "createdBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "createdOn": "2022-11-10T08:31:26.7993124Z",
          "updatedBy": "c23b5354-ff0a-4b2a-9f92-6f144effd936",
          "updatedOn": "2022-11-10T08:31:26.7993124Z"
        }
      }
    }
  ]
}

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.
Condition	Governance rule's condition
ErrorAdditionalInfo	The resource management error additional info.
GovernanceRule	Governance rule over a given scope
GovernanceRuleConditionOperator	The governance rule Condition's Operator, for example Equals for severity or In for list of assessments, see examples
GovernanceRuleEmailNotification	The governance email weekly notification configuration
GovernanceRuleList	Page of a governance rules list
GovernanceRuleMetadata	The governance rule metadata
GovernanceRuleOwnerSource	Describe the owner source of governance rule
GovernanceRuleOwnerSourceType	The owner type for the governance rule owner source
GovernanceRuleSourceResourceType	The governance rule source, what the rule affects, e.g. Assessments
GovernanceRuleType	The rule type of the governance rule, defines the source of the rule e.g. Integrated

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.

Condition

Governance rule's condition

Name	Type	Description
operator	GovernanceRuleConditionOperator	The governance rule Condition's Operator, for example Equals for severity or In for list of assessments, see examples
property	string	The governance rule Condition's Property, e.g. Severity or AssessmentKey, see examples
value	string	The governance rule Condition's Value like severity Low, High or assessments keys, see examples

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

GovernanceRule

Governance rule over a given scope

Name	Type	Description
id	string	Resource Id
name	string	Resource name
properties.conditionSets	Condition[]	The governance rule conditionSets - see examples
properties.description	string	Description of the governance rule
properties.displayName	string	Display name of the governance rule
properties.excludedScopes	string[]	Excluded scopes, filter out the descendants of the scope (on management scopes)
properties.governanceEmailNotification	GovernanceRuleEmailNotification	The email notifications settings for the governance rule, states whether to disable notifications for mangers and owners
properties.includeMemberScopes	boolean	Defines whether the rule is management scope rule (master connector as a single scope or management scope)
properties.isDisabled	boolean	Defines whether the rule is active/inactive
properties.isGracePeriod	boolean	Defines whether there is a grace period on the governance rule
properties.metadata	GovernanceRuleMetadata	The governance rule metadata
properties.ownerSource	GovernanceRuleOwnerSource	The owner source for the governance rule - e.g. Manually by user@contoso.com - see example
properties.remediationTimeframe	string	Governance rule remediation timeframe - this is the time that will affect on the grace-period duration e.g. 7.00:00:00 - means 7 days
properties.rulePriority	integer	The governance rule priority, priority to the lower number. Rules with the same priority on the same scope will not be allowed
properties.ruleType	GovernanceRuleType	The rule type of the governance rule, defines the source of the rule e.g. Integrated
properties.sourceResourceType	GovernanceRuleSourceResourceType	The governance rule source, what the rule affects, e.g. Assessments
properties.tenantId	string	The tenantId (GUID)
type	string	Resource type

GovernanceRuleConditionOperator

The governance rule Condition's Operator, for example Equals for severity or In for list of assessments, see examples

Name	Type	Description
Equals	string	Checks that the string value of the data defined in Property equals the given value - exact fit
In	string	Checks that the string value of the data defined in Property equals any of the given values (exact fit)

GovernanceRuleEmailNotification

The governance email weekly notification configuration

Name	Type	Description
disableManagerEmailNotification	boolean	Defines whether manager email notifications are disabled
disableOwnerEmailNotification	boolean	Defines whether owner email notifications are disabled

GovernanceRuleList

Page of a governance rules list

Name	Type	Description
nextLink	string	The URI to fetch the next page
value	GovernanceRule[]	Collection of governance rules in this page

GovernanceRuleMetadata

The governance rule metadata

Name	Type	Description
createdBy	string	Governance rule Created by object id (GUID)
createdOn	string	Governance rule creation date
updatedBy	string	Governance rule last updated by object id (GUID)
updatedOn	string	Governance rule last update date

GovernanceRuleOwnerSource

Describe the owner source of governance rule

Name	Type	Description
type	GovernanceRuleOwnerSourceType	The owner type for the governance rule owner source
value	string	The source value e.g. tag key like owner name or email address

GovernanceRuleOwnerSourceType

The owner type for the governance rule owner source

Name	Type	Description
ByTag	string	The rule source type defined using resource tag
Manually	string	The rule source type defined manually

GovernanceRuleSourceResourceType

The governance rule source, what the rule affects, e.g. Assessments

Name	Type	Description
Assessments	string	The source of the governance rule is assessments

GovernanceRuleType

The rule type of the governance rule, defines the source of the rule e.g. Integrated

Name	Type	Description
Integrated	string	The source of the rule type definition is integrated
ServiceNow	string	The source of the rule type definition is ServiceNow

Share via

Governance Rules - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List governance rules by management group scope

Sample request

Sample response

List governance rules by security connector scope

Sample request

Sample response

List governance rules by subscription scope

Sample request

Sample response

Definitions

CloudError

CloudErrorBody

Condition

ErrorAdditionalInfo

GovernanceRule

GovernanceRuleConditionOperator

GovernanceRuleEmailNotification

GovernanceRuleList

GovernanceRuleMetadata

GovernanceRuleOwnerSource

GovernanceRuleOwnerSourceType

GovernanceRuleSourceResourceType

GovernanceRuleType

Additional resources