Delen via


Governance Rules - List

Een lijst met alle relevante governanceregels voor een bereik ophalen

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

URI-parameters

Name In Vereist Type Description
scope
path True

string

Het bereik van de governanceregels. Geldige bereiken zijn: beheergroep (indeling: providers/Microsoft.Management/managementGroups/{managementGroup}), abonnement (indeling: 'subscriptions/{subscriptionId}'), of beveiligingsconnector (indeling: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

api-version
query True

string

API-versie voor de bewerking

Antwoorden

Name Type Description
200 OK

GovernanceRuleList

OK

Other Status Codes

CloudError

Foutbericht waarin wordt beschreven waarom de bewerking is mislukt

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

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

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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

Voorbeeldaanvraag

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

Voorbeeldrespons

{
  "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"
        }
      }
    }
  ]
}

Definities

Name Description
CloudError

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

CloudErrorBody

De foutdetails.

Condition

Voorwaarde van governanceregel

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

GovernanceRule

Governanceregel voor een bepaald bereik

GovernanceRuleConditionOperator

De operator van de governanceregelvoorwaarde, bijvoorbeeld gelijk aan ernst of In voor een lijst met evaluaties, zie voorbeelden

GovernanceRuleEmailNotification

De wekelijkse meldingsconfiguratie voor governance-e-mail

GovernanceRuleList

Pagina van een lijst met governanceregels

GovernanceRuleMetadata

De metagegevens van de governanceregel

GovernanceRuleOwnerSource

De bron van de beheerregel van de eigenaar beschrijven

GovernanceRuleOwnerSourceType

Het type eigenaar van de beheerregel

GovernanceRuleSourceResourceType

De bron van de governanceregel, wat de regel beïnvloedt, bijvoorbeeld Evaluaties

GovernanceRuleType

Het regeltype van de governanceregel definieert de bron van de regel, bijvoorbeeld Geïntegreerd

CloudError

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Name Type Description
error.additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

error.code

string

De foutcode.

error.details

CloudErrorBody[]

De foutdetails.

error.message

string

Het foutbericht.

error.target

string

Het foutdoel.

CloudErrorBody

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.

code

string

De foutcode.

details

CloudErrorBody[]

De foutdetails.

message

string

Het foutbericht.

target

string

Het foutdoel.

Condition

Voorwaarde van governanceregel

Name Type Description
operator

GovernanceRuleConditionOperator

De operator van de governanceregelvoorwaarde, bijvoorbeeld gelijk aan ernst of In voor een lijst met evaluaties, zie voorbeelden

property

string

De eigenschap van de governanceregelvoorwaarde, bijvoorbeeld Ernst of AssessmentKey, zie voorbeelden

value

string

De waarde van de governanceregelvoorwaarde, zoals de sleutels ernst Laag, Hoog of Evaluaties, zie voorbeelden

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.

type

string

Het extra informatietype.

GovernanceRule

Governanceregel voor een bepaald bereik

Name Type Description
id

string

Resource-id

name

string

Resourcenaam

properties.conditionSets

Condition[]

De conditionSets voor governanceregels - zie voorbeelden

properties.description

string

Beschrijving van de governanceregel

properties.displayName

string

Weergavenaam van de governanceregel

properties.excludedScopes

string[]

Uitgesloten bereiken, de afstammelingen van het bereik filteren (op beheerbereiken)

properties.governanceEmailNotification

GovernanceRuleEmailNotification

Met de instellingen voor e-mailmeldingen voor de beheerregel wordt aangegeven of meldingen voor beheerders en eigenaren moeten worden uitgeschakeld

properties.includeMemberScopes

boolean

Definieert of de regel een beheerbereikregel is (hoofdconnector als één bereik of beheerbereik)

properties.isDisabled

boolean

Hiermee definieert u of de regel actief/inactief is

properties.isGracePeriod

boolean

Definieert of er een respijtperiode is voor de governanceregel

properties.metadata

GovernanceRuleMetadata

De metagegevens van de governanceregel

properties.ownerSource

GovernanceRuleOwnerSource

De bron van de eigenaar voor de beheerregel , bijvoorbeeld handmatig door user@contoso.com - zie het voorbeeld

properties.remediationTimeframe

string

Herstelperiode voor governanceregels: dit is de tijd die van invloed is op de respijtperiode, bijvoorbeeld 7.00:00:00 - betekent 7 dagen

properties.rulePriority

integer

De prioriteit van de governanceregel, prioriteit aan het lagere getal. Regels met dezelfde prioriteit voor hetzelfde bereik zijn niet toegestaan

properties.ruleType

GovernanceRuleType

Het regeltype van de governanceregel definieert de bron van de regel, bijvoorbeeld Geïntegreerd

properties.sourceResourceType

GovernanceRuleSourceResourceType

De bron van de governanceregel, wat de regel beïnvloedt, bijvoorbeeld Evaluaties

properties.tenantId

string

De tenantId (GUID)

type

string

Resourcetype

GovernanceRuleConditionOperator

De operator van de governanceregelvoorwaarde, bijvoorbeeld gelijk aan ernst of In voor een lijst met evaluaties, zie voorbeelden

Name Type Description
Equals

string

Hiermee wordt gecontroleerd of de tekenreekswaarde van de gegevens die zijn gedefinieerd in eigenschap gelijk is aan de opgegeven waarde - exact passend

In

string

Controleert of de tekenreekswaarde van de gegevens die zijn gedefinieerd in eigenschap gelijk is aan een van de opgegeven waarden (exact passend)

GovernanceRuleEmailNotification

De wekelijkse meldingsconfiguratie voor governance-e-mail

Name Type Description
disableManagerEmailNotification

boolean

Hiermee definieert u of e-mailmeldingen voor beheerders zijn uitgeschakeld

disableOwnerEmailNotification

boolean

Hiermee definieert u of e-mailmeldingen van eigenaars zijn uitgeschakeld

GovernanceRuleList

Pagina van een lijst met governanceregels

Name Type Description
nextLink

string

De URI voor het ophalen van de volgende pagina

value

GovernanceRule[]

Verzameling governanceregels op deze pagina

GovernanceRuleMetadata

De metagegevens van de governanceregel

Name Type Description
createdBy

string

Governanceregel gemaakt door object-id (GUID)

createdOn

string

Aanmaakdatum voor governanceregels

updatedBy

string

Governanceregel laatst bijgewerkt door object-id (GUID)

updatedOn

string

Laatste updatedatum voor governanceregel

GovernanceRuleOwnerSource

De bron van de beheerregel van de eigenaar beschrijven

Name Type Description
type

GovernanceRuleOwnerSourceType

Het type eigenaar van de beheerregel

value

string

De bronwaarde, bijvoorbeeld tagsleutel, zoals de naam van de eigenaar of het e-mailadres

GovernanceRuleOwnerSourceType

Het type eigenaar van de beheerregel

Name Type Description
ByTag

string

Het brontype van de regel dat is gedefinieerd met resourcetag

Manually

string

Het type regelbron dat handmatig is gedefinieerd

GovernanceRuleSourceResourceType

De bron van de governanceregel, wat de regel beïnvloedt, bijvoorbeeld Evaluaties

Name Type Description
Assessments

string

De bron van de governanceregel is evaluaties

GovernanceRuleType

Het regeltype van de governanceregel definieert de bron van de regel, bijvoorbeeld Geïntegreerd

Name Type Description
Integrated

string

De bron van de definitie van het regeltype is geïntegreerd

ServiceNow

string

De bron van de definitie van het regeltype is ServiceNow