Condividi tramite


Governance Rules - Get

Ottenere una regola di governance specifica per l'ambito richiesto da ruleId

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
ruleId
path True

string

Chiave della regola di governance- chiave univoca per la regola di governance standard (GUID)

scope
path True

string

Ambito delle regole di governance. Gli ambiti validi sono: gruppo di gestione (formato: 'providers/Microsoft.Management/managementGroups/{managementGroup}'), sottoscrizione (formato: 'subscriptions/{subscriptionId}') o connettore di sicurezza (formato: 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/securityConnectors/{securityConnectorName})'

api-version
query True

string

Versione dell'API per l'operazione

Risposte

Nome Tipo Descrizione
200 OK

GovernanceRule

OK

Other Status Codes

CloudError

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

Get a governance rule over management group scope
Get a governance rule over security connector scope
Get a governance rule over subscription scope

Get a governance rule over management group scope

Esempio di richiesta

GET https://management.azure.com/providers/Microsoft.Management/managementGroups/contoso/providers/Microsoft.Security/governanceRules/ad9a8e26-29d9-4829-bb30-e597a58cdbb8?api-version=2022-01-01-preview

Risposta di esempio

{
  "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": 200,
    "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": [
      "/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"
    }
  }
}

Get a governance rule over security connector scope

Esempio di richiesta

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

Risposta di esempio

{
  "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": "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": "$.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"
    }
  }
}

Get a governance rule over subscription scope

Esempio di richiesta

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

Risposta di esempio

{
  "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": 200,
    "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"
    }
  }
}

Definizioni

Nome Descrizione
CloudError

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

CloudErrorBody

Dettagli dell'errore.

Condition

Condizione della regola di governance

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

GovernanceRule

Regola di governance su un determinato ambito

GovernanceRuleConditionOperator

Operatore della regola di governance Condizione, ad esempio Uguale a per gravità o In per l'elenco delle valutazioni, vedere esempi

GovernanceRuleEmailNotification

Configurazione settimanale della posta elettronica di governance

GovernanceRuleMetadata

Metadati delle regole di governance

GovernanceRuleOwnerSource

Descrivere l'origine proprietaria della regola di governance

GovernanceRuleOwnerSourceType

Tipo di proprietario per l'origine del proprietario della regola di governance

GovernanceRuleSourceResourceType

Origine della regola di governance, che cosa influisce la regola, ad esempio valutazioni

GovernanceRuleType

Il tipo di regola della regola di governance definisce l'origine della regola, ad esempio Integrato

CloudError

Risposta di errore comune per tutte le API di Azure Resource Manager per restituire i dettagli dell'errore per le operazioni non riuscite. Questo segue anche il formato di risposta di errore OData.

Nome Tipo Descrizione
error.additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

error.code

string

Codice di errore.

error.details

CloudErrorBody[]

Dettagli dell'errore.

error.message

string

Messaggio di errore.

error.target

string

Destinazione dell'errore.

CloudErrorBody

Dettagli dell'errore.

Nome Tipo Descrizione
additionalInfo

ErrorAdditionalInfo[]

Informazioni aggiuntive sull'errore.

code

string

Codice di errore.

details

CloudErrorBody[]

Dettagli dell'errore.

message

string

Messaggio di errore.

target

string

Destinazione dell'errore.

Condition

Condizione della regola di governance

Nome Tipo Descrizione
operator

GovernanceRuleConditionOperator

Operatore della regola di governance Condizione, ad esempio Uguale a per gravità o In per l'elenco delle valutazioni, vedere esempi

property

string

Proprietà della regola di governance, ad esempio Gravità o AssessmentKey, vedere esempi

value

string

Il valore della regola di governance Condizione come le chiavi di gravità bassa, alta o di valutazione, vedere esempi

ErrorAdditionalInfo

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome Tipo Descrizione
info

object

Informazioni aggiuntive.

type

string

Tipo di informazioni aggiuntive.

GovernanceRule

Regola di governance su un determinato ambito

Nome Tipo Descrizione
id

string

ID risorsa

name

string

Nome risorsa

properties.conditionSets

Condition[]

Set di condizioni della regola di governance: vedere gli esempi

properties.description

string

Descrizione della regola di governance

properties.displayName

string

Nome visualizzato della regola di governance

properties.excludedScopes

string[]

Ambiti esclusi, filtrare i discendenti dell'ambito (negli ambiti di gestione)

properties.governanceEmailNotification

GovernanceRuleEmailNotification

Le impostazioni delle notifiche tramite posta elettronica per la regola di governance indicano se disabilitare le notifiche per i mangers e i proprietari

properties.includeMemberScopes

boolean

Definisce se la regola è regola di ambito di gestione (connettore master come ambito singolo o ambito di gestione)

properties.isDisabled

boolean

Definisce se la regola è attiva/inattiva

properties.isGracePeriod

boolean

Definisce se esiste un periodo di tolleranza per la regola di governance

properties.metadata

GovernanceRuleMetadata

Metadati delle regole di governance

properties.ownerSource

GovernanceRuleOwnerSource

Origine del proprietario per la regola di governance, ad esempio manualmente da user@contoso.com, vedere l'esempio

properties.remediationTimeframe

string

Intervallo di tempo di correzione delle regole di governance: questo è il tempo che influirà sulla durata del periodo di tolleranza, ad esempio 7.00:00:00- significa 7 giorni

properties.rulePriority

integer

Priorità della regola di governance, priorità al numero inferiore. Le regole con la stessa priorità nello stesso ambito non saranno consentite

properties.ruleType

GovernanceRuleType

Il tipo di regola della regola di governance definisce l'origine della regola, ad esempio Integrato

properties.sourceResourceType

GovernanceRuleSourceResourceType

Origine della regola di governance, che cosa influisce la regola, ad esempio valutazioni

properties.tenantId

string

TenantId (GUID)

type

string

Tipo di risorsa

GovernanceRuleConditionOperator

Operatore della regola di governance Condizione, ad esempio Uguale a per gravità o In per l'elenco delle valutazioni, vedere esempi

Nome Tipo Descrizione
Equals

string

Verifica che il valore stringa dei dati definiti in Property sia uguale al valore specificato.

In

string

Verifica che il valore stringa dei dati definiti in Property sia uguale a uno dei valori specificati (adattamento esatto)

GovernanceRuleEmailNotification

Configurazione settimanale della posta elettronica di governance

Nome Tipo Descrizione
disableManagerEmailNotification

boolean

Definisce se le notifiche di posta elettronica del manager sono disabilitate

disableOwnerEmailNotification

boolean

Definisce se le notifiche tramite posta elettronica del proprietario sono disabilitate

GovernanceRuleMetadata

Metadati delle regole di governance

Nome Tipo Descrizione
createdBy

string

Regola di governance creata dall'ID oggetto (GUID)

createdOn

string

Data di creazione delle regole di governance

updatedBy

string

Regola di governance aggiornata per ultimo id oggetto (GUID)

updatedOn

string

Data dell'ultimo aggiornamento della regola di governance

GovernanceRuleOwnerSource

Descrivere l'origine proprietaria della regola di governance

Nome Tipo Descrizione
type

GovernanceRuleOwnerSourceType

Tipo di proprietario per l'origine del proprietario della regola di governance

value

string

Il valore di origine, ad esempio la chiave del tag, ad esempio il nome del proprietario o l'indirizzo di posta elettronica

GovernanceRuleOwnerSourceType

Tipo di proprietario per l'origine del proprietario della regola di governance

Nome Tipo Descrizione
ByTag

string

Tipo di origine della regola definito tramite tag di risorsa

Manually

string

Tipo di origine della regola definito manualmente

GovernanceRuleSourceResourceType

Origine della regola di governance, che cosa influisce la regola, ad esempio valutazioni

Nome Tipo Descrizione
Assessments

string

L'origine della regola di governance è la valutazione

GovernanceRuleType

Il tipo di regola della regola di governance definisce l'origine della regola, ad esempio Integrato

Nome Tipo Descrizione
Integrated

string

L'origine della definizione del tipo di regola è integrata

ServiceNow

string

L'origine della definizione del tipo di regola è ServiceNow