Sdílet prostřednictvím


Governance Rules - List

Získání seznamu všech relevantních pravidel zásad správného řízení v rámci oboru

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
scope
path True

string

Rozsah pravidel zásad správného řízení. Platné obory jsou: skupina pro správu (formát: providers/Microsoft.Management/managementGroups/{managementGroup}), předplatné (formát: subscriptions/{subscriptionId}) nebo konektor zabezpečení (formát: subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})"

api-version
query True

string

Verze rozhraní API pro operaci

Odpovědi

Name Typ Description
200 OK

GovernanceRuleList

OK

Other Status Codes

CloudError

Chybová odpověď popisující, proč operace selhala

Zabezpečení

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Ukázkový požadavek

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

Ukázková odpověď

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

Definice

Name Description
CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

CloudErrorBody

Podrobnosti o chybě.

Condition

Podmínka pravidla správného řízení

ErrorAdditionalInfo

Další informace o chybě správy prostředků

GovernanceRule

Pravidlo zásad správného řízení nad daným oborem

GovernanceRuleConditionOperator

Operátor podmínky zásad správného řízení, například Rovná se závažnosti nebo In pro seznam posouzení, najdete v příkladech.

GovernanceRuleEmailNotification

Konfigurace týdenního oznámení e-mailu zásad správného řízení

GovernanceRuleList

Stránka seznamu pravidel zásad správného řízení

GovernanceRuleMetadata

Metadata pravidel správného řízení

GovernanceRuleOwnerSource

Popis zdroje vlastníka pravidla zásad správného řízení

GovernanceRuleOwnerSourceType

Typ vlastníka zdroje pravidla zásad správného řízení

GovernanceRuleSourceResourceType

Zdroj pravidel zásad správného řízení, jaký pravidlo ovlivňuje, například posouzení

GovernanceRuleType

Typ pravidla zásad správného řízení definuje zdroj pravidla, například integrované pravidlo.

CloudError

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Name Typ Description
error.additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

error.code

string

Kód chyby.

error.details

CloudErrorBody[]

Podrobnosti o chybě.

error.message

string

Chybová zpráva.

error.target

string

Cíl chyby.

CloudErrorBody

Podrobnosti o chybě.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Další informace o chybě.

code

string

Kód chyby.

details

CloudErrorBody[]

Podrobnosti o chybě.

message

string

Chybová zpráva.

target

string

Cíl chyby.

Condition

Podmínka pravidla správného řízení

Name Typ Description
operator

GovernanceRuleConditionOperator

Operátor podmínky zásad správného řízení, například Rovná se závažnosti nebo In pro seznam posouzení, najdete v příkladech.

property

string

Vlastnost podmínky zásad správného řízení, například Závažnost nebo AssessmentKey, najdete v příkladech.

value

string

Hodnota podmínky zásad správného řízení, jako je závažnost Nízká, Vysoká nebo klíče posouzení, najdete v příkladech.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

Name Typ Description
info

object

Další informace.

type

string

Další typ informací.

GovernanceRule

Pravidlo zásad správného řízení nad daným oborem

Name Typ Description
id

string

ID prostředku

name

string

Název prostředku

properties.conditionSets

Condition[]

Sady podmínek pravidel správného řízení – viz příklady

properties.description

string

Popis pravidla zásad správného řízení

properties.displayName

string

Zobrazovaný název pravidla zásad správného řízení

properties.excludedScopes

string[]

Vyloučené obory, vyfiltrujte potomky oboru (v oborech správy).

properties.governanceEmailNotification

GovernanceRuleEmailNotification

Nastavení e-mailových oznámení pro pravidlo zásad správného řízení uvádí, jestli se mají zakázat oznámení pro správce a vlastníky.

properties.includeMemberScopes

boolean

Definuje, jestli se jedná o pravidlo oboru správy (hlavní konektor jako jeden obor nebo obor správy).

properties.isDisabled

boolean

Definuje, jestli je pravidlo aktivní nebo neaktivní.

properties.isGracePeriod

boolean

Definuje, jestli existuje období odkladu pro pravidlo zásad správného řízení.

properties.metadata

GovernanceRuleMetadata

Metadata pravidel správného řízení

properties.ownerSource

GovernanceRuleOwnerSource

Zdroj vlastníka pravidla zásad správného řízení – například ručně podle user@contoso.com – viz příklad

properties.remediationTimeframe

string

Časový rámec nápravy pravidel zásad správného řízení – doba, která ovlivní dobu trvání odkladu, například 7.00:00:00 – znamená 7 dnů.

properties.rulePriority

integer

Priorita pravidla správného řízení, priorita nižšího čísla. Pravidla se stejnou prioritou ve stejném oboru nebudou povolena.

properties.ruleType

GovernanceRuleType

Typ pravidla zásad správného řízení definuje zdroj pravidla, například integrované pravidlo.

properties.sourceResourceType

GovernanceRuleSourceResourceType

Zdroj pravidel zásad správného řízení, jaký pravidlo ovlivňuje, například posouzení

properties.tenantId

string

ID tenanta (GUID)

type

string

Typ prostředku

GovernanceRuleConditionOperator

Operátor podmínky zásad správného řízení, například Rovná se závažnosti nebo In pro seznam posouzení, najdete v příkladech.

Name Typ Description
Equals

string

Zkontroluje, zda se řetězcová hodnota dat definovaných ve vlastnosti rovná dané hodnotě – přesná shoda.

In

string

Zkontroluje, jestli se řetězcová hodnota dat definovaných ve vlastnosti rovná některé z daných hodnot (přesné přizpůsobení).

GovernanceRuleEmailNotification

Konfigurace týdenního oznámení e-mailu zásad správného řízení

Name Typ Description
disableManagerEmailNotification

boolean

Definuje, jestli jsou e-mailová oznámení manažera zakázaná.

disableOwnerEmailNotification

boolean

Definuje, jestli jsou e-mailová oznámení vlastníka zakázaná.

GovernanceRuleList

Stránka seznamu pravidel zásad správného řízení

Name Typ Description
nextLink

string

Identifikátor URI pro načtení další stránky

value

GovernanceRule[]

Kolekce pravidel zásad správného řízení na této stránce

GovernanceRuleMetadata

Metadata pravidel správného řízení

Name Typ Description
createdBy

string

Pravidlo zásad správného řízení vytvořené podle ID objektu (GUID)

createdOn

string

Datum vytvoření pravidla správného řízení

updatedBy

string

Pravidlo zásad správného řízení naposledy aktualizováno podle ID objektu (GUID)

updatedOn

string

Datum poslední aktualizace pravidla zásad správného řízení

GovernanceRuleOwnerSource

Popis zdroje vlastníka pravidla zásad správného řízení

Name Typ Description
type

GovernanceRuleOwnerSourceType

Typ vlastníka zdroje pravidla zásad správného řízení

value

string

Zdrojová hodnota, například klíč značky, například jméno vlastníka nebo e-mailová adresa

GovernanceRuleOwnerSourceType

Typ vlastníka zdroje pravidla zásad správného řízení

Name Typ Description
ByTag

string

Typ zdroje pravidla definovaný pomocí značky prostředku

Manually

string

Typ zdroje pravidla definovaný ručně

GovernanceRuleSourceResourceType

Zdroj pravidel zásad správného řízení, jaký pravidlo ovlivňuje, například posouzení

Name Typ Description
Assessments

string

Zdrojem pravidla zásad správného řízení jsou posouzení.

GovernanceRuleType

Typ pravidla zásad správného řízení definuje zdroj pravidla, například integrované pravidlo.

Name Typ Description
Integrated

string

Zdroj definice typu pravidla je integrovaný.

ServiceNow

string

Zdrojem definice typu pravidla je ServiceNow.