Automations - Update

Usługa:: Defender for Cloud

Wersja API:: 2023-12-01-preview

Aktualizuje automatyzację zabezpieczeń

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/automations/{automationName}?api-version=2023-12-01-preview

Parametry URI

Nazwa	W	Wymagane	Typ	Opis
automationName	path	True	string	Nazwa automatyzacji zabezpieczeń.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+$	Nazwa grupy zasobów w ramach subskrypcji użytkownika. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$	Identyfikator subskrypcji platformy Azure
api-version	query	True	string	Wersja interfejsu API dla operacji

Ciało żądania

Nazwa	Typ	Opis
properties.actions	AutomationAction[]: AutomationActionLogicApp[] AutomationActionEventHub[] AutomationActionWorkspace[]	Kolekcja akcji, które są wyzwalane, jeśli wszystkie skonfigurowane reguły oceny, w co najmniej jednym zestawie reguł, są prawdziwe.
properties.description	string	Opis automatyzacji zabezpieczeń.
properties.isEnabled	boolean	Wskazuje, czy automatyzacja zabezpieczeń jest włączona.
properties.scopes	AutomationScope[]	Kolekcja zakresów, w których jest stosowana logika automatyzacji zabezpieczeń. Obsługiwane zakresy to sama subskrypcja lub grupa zasobów w ramach tej subskrypcji. Automatyzacja będzie stosowana tylko w zdefiniowanych zakresach.
properties.sources	AutomationSource[]	Kolekcja typów zdarzeń źródłowych, które oceniają zestaw reguł automatyzacji zabezpieczeń.
tags	object	Lista par klucz-wartość, które opisują zasób.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Automation	OK
Other Status Codes	CloudError	Odpowiedź na błąd, która opisuje, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresów

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Update a security automation

Przykładowa prośba

HTTP

PATCH https://management.azure.com/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation?api-version=2023-12-01-preview

{
  "tags": {
    "Example": "exampleTag"
  },
  "properties": {
    "description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment",
    "scopes": [
      {
        "description": "A description that helps to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription a5caac9c-5c04-49af-b3d0-e204f40345d5",
        "scopePath": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup"
      }
    ],
    "sources": [
      {
        "eventSource": "Assessments"
      }
    ],
    "actions": [
      {
        "logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
        "actionType": "LogicApp",
        "uri": "https://exampleTriggerUri1.com"
      }
    ]
  }
}

Przykładowa odpowiedź

Kod statusu:: 200

{
  "id": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation",
  "name": "exampleAutomation",
  "type": "Microsoft.Security/automations",
  "location": "Central US",
  "etag": "new etag value",
  "tags": {},
  "properties": {
    "description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment",
    "isEnabled": true,
    "scopes": [
      {
        "description": "A description that helps to identify this scope - for example: security assessments that relate to the resource group myResourceGroup within the subscription a5caac9c-5c04-49af-b3d0-e204f40345d5",
        "scopePath": "/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/myResourceGroup"
      }
    ],
    "sources": [
      {
        "eventSource": "Assessments",
        "ruleSets": []
      }
    ],
    "actions": [
      {
        "logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
        "actionType": "LogicApp"
      }
    ]
  }
}

Definicje

Nazwa	Opis
Automation	Zasób automatyzacji zabezpieczeń.
AutomationActionEventHub	Docelowe centrum zdarzeń, do którego zostaną wyeksportowane dane zdarzenia. Aby dowiedzieć się więcej o możliwościach ciągłego eksportowania w usłudze Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCExportLearnMore
AutomationActionLogicApp	Akcja aplikacji logiki, która powinna zostać wyzwolona. Aby dowiedzieć się więcej o możliwościach automatyzacji przepływu pracy usługi Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCWorkflowAutomationLearnMore
AutomationActionWorkspace	Obszar roboczy usługi Log Analytics, do którego zostaną wyeksportowane dane zdarzenia. Dane alertów zabezpieczeń będą znajdować się w tabeli "SecurityAlert", a dane oceny będą znajdować się w tabeli "SecurityRecommendation" (w obszarze rozwiązań "Security"/"SecurityCenterFree"). Należy pamiętać, że aby wyświetlić dane w obszarze roboczym, należy włączyć bezpłatne/standardowe rozwiązanie usługi Security Center Log Analytics w tym obszarze roboczym. Aby dowiedzieć się więcej o możliwościach ciągłego eksportowania w usłudze Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCExportLearnMore
AutomationRuleSet	Zestaw reguł, który ocenia wszystkie jego reguły podczas przechwytywania zdarzeń. Tylko wtedy, gdy wszystkie dołączone reguły w zestawie reguł zostaną ocenione jako "true", zdarzenie wyzwoli zdefiniowane akcje.
AutomationScope	Pojedynczy zakres automatyzacji.
AutomationSource	Typy zdarzeń źródłowych, które oceniają zestaw reguł automatyzacji zabezpieczeń. Na przykład — alerty zabezpieczeń i oceny zabezpieczeń. Aby dowiedzieć się więcej o obsługiwanych schematach modeli danych zdarzeń zabezpieczeń — odwiedź https://aka.ms/ASCAutomationSchemas.
AutomationTriggeringRule	Reguła oceniana podczas przechwytywania zdarzeń. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzeń z oczekiwaną wartością. To porównanie odbywa się przy użyciu jednego z obsługiwanych operatorów ustawionych.
AutomationUpdateModel	Model aktualizacji zasobu automatyzacji zabezpieczeń.
CloudError	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
CloudErrorBody	Szczegóły błędu.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
EventSource	Prawidłowy typ źródła zdarzeń.
Operator	Prawidłowy operator porównania do użycia. Dla właściwości String PropertyType zostanie zastosowane porównanie bez uwzględniania wielkości liter.
PropertyType	Typ danych porównywanych operandów (ciąg, liczba całkowita, liczba zmiennoprzecinkowa lub wartość logiczna [true/false]]

Automation

Sprzeciwiać się

Zasób automatyzacji zabezpieczeń.

Nazwa	Typ	Opis
etag	string	Tag jednostki służy do porównywania co najmniej dwóch jednostek z tego samego żądanego zasobu.
id	string	Identyfikator zasobu
kind	string	Rodzaj zasobu
location	string	Lokalizacja, w której jest przechowywany zasób
name	string	Nazwa zasobu
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Kolekcja akcji, które są wyzwalane, jeśli wszystkie skonfigurowane reguły oceny, w co najmniej jednym zestawie reguł, są prawdziwe.
properties.description	string	Opis automatyzacji zabezpieczeń.
properties.isEnabled	boolean	Wskazuje, czy automatyzacja zabezpieczeń jest włączona.
properties.scopes	AutomationScope[]	Kolekcja zakresów, w których jest stosowana logika automatyzacji zabezpieczeń. Obsługiwane zakresy to sama subskrypcja lub grupa zasobów w ramach tej subskrypcji. Automatyzacja będzie stosowana tylko w zdefiniowanych zakresach.
properties.sources	AutomationSource[]	Kolekcja typów zdarzeń źródłowych, które oceniają zestaw reguł automatyzacji zabezpieczeń.
tags	object	Lista par klucz-wartość, które opisują zasób.
type	string	Typ zasobu

AutomationActionEventHub

Sprzeciwiać się

Docelowe centrum zdarzeń, do którego zostaną wyeksportowane dane zdarzenia. Aby dowiedzieć się więcej o możliwościach ciągłego eksportowania w usłudze Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCExportLearnMore

Nazwa	Typ	Opis
actionType	string: EventHub	Typ akcji, która zostanie wyzwolona przez usługę Automation
connectionString	string	Docelowe parametry połączenia centrum zdarzeń (nie zostaną uwzględnione w żadnej odpowiedzi).
eventHubResourceId	string	Docelowy identyfikator zasobu platformy Azure centrum zdarzeń.
isTrustedServiceEnabled	boolean	Wskazuje, czy zaufana usługa jest włączona, czy nie.
sasPolicyName	string	Docelowa nazwa zasad sygnatury dostępu współdzielonego centrum zdarzeń.

AutomationActionLogicApp

Sprzeciwiać się

Akcja aplikacji logiki, która powinna zostać wyzwolona. Aby dowiedzieć się więcej o możliwościach automatyzacji przepływu pracy usługi Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCWorkflowAutomationLearnMore

Nazwa	Typ	Opis
actionType	string: LogicApp	Typ akcji, która zostanie wyzwolona przez usługę Automation
logicAppResourceId	string	Wyzwolony identyfikator zasobu platformy Azure aplikacji logiki. Może to również znajdować się w innych subskrypcjach, ponieważ masz uprawnienia do wyzwalania aplikacji logiki
uri	string (uri)	Punkt końcowy identyfikatora URI wyzwalacza aplikacji logiki (nie zostanie on uwzględniony w żadnej odpowiedzi).

AutomationActionWorkspace

Sprzeciwiać się

Obszar roboczy usługi Log Analytics, do którego zostaną wyeksportowane dane zdarzenia. Dane alertów zabezpieczeń będą znajdować się w tabeli "SecurityAlert", a dane oceny będą znajdować się w tabeli "SecurityRecommendation" (w obszarze rozwiązań "Security"/"SecurityCenterFree"). Należy pamiętać, że aby wyświetlić dane w obszarze roboczym, należy włączyć bezpłatne/standardowe rozwiązanie usługi Security Center Log Analytics w tym obszarze roboczym. Aby dowiedzieć się więcej o możliwościach ciągłego eksportowania w usłudze Microsoft Defender for Cloud, odwiedź stronę https://aka.ms/ASCExportLearnMore

Nazwa	Typ	Opis
actionType	string: Workspace	Typ akcji, która zostanie wyzwolona przez usługę Automation
workspaceResourceId	string	W pełni kwalifikowany identyfikator zasobu platformy Azure obszaru roboczego usługi Log Analytics.

AutomationRuleSet

Sprzeciwiać się

Zestaw reguł, który ocenia wszystkie jego reguły podczas przechwytywania zdarzeń. Tylko wtedy, gdy wszystkie dołączone reguły w zestawie reguł zostaną ocenione jako "true", zdarzenie wyzwoli zdefiniowane akcje.

Nazwa	Typ	Opis
rules	AutomationTriggeringRule[]	Reguła oceniana podczas przechwytywania zdarzeń. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzeń z oczekiwaną wartością. To porównanie odbywa się przy użyciu jednego z obsługiwanych operatorów ustawionych.

AutomationScope

Sprzeciwiać się

Pojedynczy zakres automatyzacji.

Nazwa	Typ	Opis
description	string	Opis zakresu zasobów.
scopePath	string	Ścieżka zakresu zasobów. Może to być subskrypcja, w której zdefiniowano automatyzację w ramach tej subskrypcji lub grupę zasobów (w pełni kwalifikowane identyfikatory zasobów platformy Azure).

AutomationSource

Sprzeciwiać się

Typy zdarzeń źródłowych, które oceniają zestaw reguł automatyzacji zabezpieczeń. Na przykład — alerty zabezpieczeń i oceny zabezpieczeń. Aby dowiedzieć się więcej o obsługiwanych schematach modeli danych zdarzeń zabezpieczeń — odwiedź https://aka.ms/ASCAutomationSchemas.

Nazwa	Typ	Opis
eventSource	EventSource	Prawidłowy typ źródła zdarzeń.
ruleSets	AutomationRuleSet[]	Zestaw reguł, które oceniają przechwycenie zdarzeń. Logiczny podział jest stosowany między zdefiniowanymi zestawami reguł (logicznymi "lub").

AutomationTriggeringRule

Sprzeciwiać się

Reguła oceniana podczas przechwytywania zdarzeń. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzeń z oczekiwaną wartością. To porównanie odbywa się przy użyciu jednego z obsługiwanych operatorów ustawionych.

Nazwa	Typ	Opis
expectedValue	string	Oczekiwana wartość.
operator	Operator	Prawidłowy operator porównania do użycia. Dla właściwości String PropertyType zostanie zastosowane porównanie bez uwzględniania wielkości liter.
propertyJPath	string	Ścieżka JPath właściwości modelu jednostki, która powinna być zaznaczona.
propertyType	PropertyType	Typ danych porównywanych operandów (ciąg, liczba całkowita, liczba zmiennoprzecinkowa lub wartość logiczna [true/false]]

AutomationUpdateModel

Sprzeciwiać się

Model aktualizacji zasobu automatyzacji zabezpieczeń.

Nazwa	Typ	Opis
properties.actions	AutomationAction[]: AutomationActionEventHub[] AutomationActionLogicApp[] AutomationActionWorkspace[]	Kolekcja akcji, które są wyzwalane, jeśli wszystkie skonfigurowane reguły oceny, w co najmniej jednym zestawie reguł, są prawdziwe.
properties.description	string	Opis automatyzacji zabezpieczeń.
properties.isEnabled	boolean	Wskazuje, czy automatyzacja zabezpieczeń jest włączona.
properties.scopes	AutomationScope[]	Kolekcja zakresów, w których jest stosowana logika automatyzacji zabezpieczeń. Obsługiwane zakresy to sama subskrypcja lub grupa zasobów w ramach tej subskrypcji. Automatyzacja będzie stosowana tylko w zdefiniowanych zakresach.
properties.sources	AutomationSource[]	Kolekcja typów zdarzeń źródłowych, które oceniają zestaw reguł automatyzacji zabezpieczeń.
tags	object	Lista par klucz-wartość, które opisują zasób.

CloudError

Sprzeciwiać się

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error.additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
error.code	string	Kod błędu.
error.details	CloudErrorBody[]	Szczegóły błędu.
error.message	string	Komunikat o błędzie.
error.target	string	Element docelowy błędu.

CloudErrorBody

Sprzeciwiać się

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	CloudErrorBody[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorAdditionalInfo

Sprzeciwiać się

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

EventSource

Wyliczenie

Prawidłowy typ źródła zdarzeń.

Wartość	Opis
Assessments
AssessmentsSnapshot
SubAssessments
SubAssessmentsSnapshot
Alerts
SecureScores
SecureScoresSnapshot
SecureScoreControls
SecureScoreControlsSnapshot
RegulatoryComplianceAssessment
RegulatoryComplianceAssessmentSnapshot
AttackPaths
AttackPathsSnapshot

Operator

Wyliczenie

Prawidłowy operator porównania do użycia. Dla właściwości String PropertyType zostanie zastosowane porównanie bez uwzględniania wielkości liter.

Wartość	Opis
Equals	Dotyczy operandów dziesiętnych i innych niż dziesiętne
GreaterThan	Dotyczy tylko operandów dziesiętnych
GreaterThanOrEqualTo	Dotyczy tylko operandów dziesiętnych
LesserThan	Dotyczy tylko operandów dziesiętnych
LesserThanOrEqualTo	Dotyczy tylko operandów dziesiętnych
NotEquals	Dotyczy operandów dziesiętnych i innych niż dziesiętne
Contains	Dotyczy tylko operandów innych niż dziesiętne
StartsWith	Dotyczy tylko operandów innych niż dziesiętne
EndsWith	Dotyczy tylko operandów innych niż dziesiętne

PropertyType

Wyliczenie

Typ danych porównywanych operandów (ciąg, liczba całkowita, liczba zmiennoprzecinkowa lub wartość logiczna [true/false]]

Wartość	Opis
String
Integer
Number
Boolean

Udostępnij za pośrednictwem

Automations - Update

Parametry URI

Ciało żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresów

Przykłady

Update a security automation

Przykładowa prośba

Przykładowa odpowiedź

Definicje

Automation

AutomationActionEventHub

AutomationActionLogicApp

AutomationActionWorkspace

AutomationRuleSet

AutomationScope

AutomationSource

AutomationTriggeringRule

AutomationUpdateModel

CloudError

CloudErrorBody

ErrorAdditionalInfo

EventSource

Operator

PropertyType