Automations - Validate

Sprawdza poprawność modelu automatyzacji zabezpieczeń przed utworzeniem lub zaktualizowaniem. Wszystkie błędy walidacji są zwracane do klienta.

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

Parametry identyfikatora URI

Name In Required Type Description
automationName
path True
  • string

Nazwa automatyzacji zabezpieczeń.

resourceGroupName
path True
  • string

Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

Identyfikator subskrypcji platformy Azure

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True
  • string

Wersja interfejsu API dla operacji

Treść żądania

Name Type Description
etag
  • string

Tag jednostki jest używany do porównywania dwóch lub większej liczby jednostek z tego samego żądanego zasobu.

kind
  • string

Rodzaj zasobu

location
  • string

Lokalizacja, w której jest przechowywany zasób

properties.actions AutomationAction[]:

Kolekcja akcji, które są wyzwalane, jeśli wszystkie wartości oceny skonfigurowanych reguł w ramach co najmniej jednego zestawu reguł są spełnione.

properties.description
  • string

Opis automatyzacji zabezpieczeń.

properties.isEnabled
  • boolean

Wskazuje, czy Automatyzacja zabezpieczeń jest włączona.

properties.scopes

Kolekcja zakresów, na których jest stosowana logika automatyzacji zabezpieczeń. Obsługiwane zakresy to sama subskrypcja lub Grupa zasobów w ramach tej subskrypcji. Automatyzacja będzie obowiązywać tylko dla zdefiniowanych zakresów.

properties.sources

Kolekcja typów zdarzeń źródłowych, które szacują zestaw zasad automatyzacji zabezpieczeń.

tags
  • object

Lista par klucz-wartość, które opisują zasób.

Odpowiedzi

Name Type Description
200 OK

OK

Other Status Codes

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation Personifikuj konto użytkownika

Przykłady

Validate the security automation model before create or update

Sample Request

POST https://management.azure.com/subscriptions/a5caac9c-5c04-49af-b3d0-e204f40345d5/resourceGroups/exampleResourceGroup/providers/Microsoft.Security/automations/exampleAutomation/validate?api-version=2019-01-01-preview
{
  "location": "Central US",
  "tags": {},
  "properties": {
    "description": "An example of a security automation that triggers one LogicApp resource (myTest1) on any security assessment of type customAssessment",
    "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": [
          {
            "rules": [
              {
                "propertyJPath": "$.Entity.AssessmentType",
                "propertyType": "String",
                "expectedValue": "customAssessment",
                "operator": "Equals"
              }
            ]
          }
        ]
      }
    ],
    "actions": [
      {
        "logicAppResourceId": "/subscriptions/e54a4a18-5b94-4f90-9471-bd3decad8a2e/resourceGroups/sample/providers/Microsoft.Logic/workflows/MyTest1",
        "actionType": "LogicApp",
        "uri": "https://exampleTriggerUri1.com"
      }
    ]
  }
}

Sample Response

{
  "isValid": true,
  "message": "Validation Successful"
}

Definicje

Automation

Zasób automatyzacji zabezpieczeń.

AutomationActionEventHub

Docelowy centrum zdarzeń, do którego zostaną wyeksportowane dane zdarzeń. Aby dowiedzieć się więcej na temat możliwości funkcji eksportu ciągłego Security Center, 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 Security Center, odwiedź stronę https://aka.ms/ASCWorkflowAutomationLearnMore

AutomationActionWorkspace

Obszar roboczy Log Analytics, do którego zostaną wyeksportowane dane zdarzeń. Dane alertów zabezpieczeń będą znajdować się w tabeli "SecurityAlert", a dane oceny będą znajdować się w tabeli "SecurityRecommendation" (w ramach rozwiązań "Security"/"SecurityCenterFree"). Należy pamiętać, że w celu wyświetlenia danych w obszarze roboczym należy włączyć Security Center Log Analytics rozwiązanie bezpłatne/standardowe w tym obszarze roboczym. Aby dowiedzieć się więcej na temat możliwości funkcji eksportu ciągłego Security Center, odwiedź stronę https://aka.ms/ASCExportLearnMore

AutomationRuleSet

Zestaw reguł, który oblicza wszystkie jego reguły przy przechwyceniu zdarzenia. Tylko wtedy, gdy wszystkie uwzględnione reguły w zestawie reguł zostaną ocenione jako "true", to zdarzenie wyzwala zdefiniowane akcje.

AutomationScope

Pojedynczy zakres automatyzacji.

AutomationSource

Źródłowe typy zdarzeń, które szacują zestaw reguł automatyzacji zabezpieczeń. Na przykład alerty zabezpieczeń i oceny zabezpieczeń. Aby dowiedzieć się więcej na temat obsługiwanych schematów modeli danych zdarzeń zabezpieczeń, odwiedź stronę https://aka.ms/ASCAutomationSchemas .

AutomationTriggeringRule

Reguła, która jest szacowana po przechwyceniu zdarzenia. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzenia do oczekiwanej wartości. To porównanie odbywa się przy użyciu jednego z obsługiwanych zestawów operatorów.

AutomationValidationStatus

Zbiór właściwości stanu modelu automatyzacji zabezpieczeń.

CloudError

Wspólna odpowiedź na błędy dla wszystkich interfejsów API Azure Resource Manager, aby zwrócić szczegóły błędu dla operacji zakończonych niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błędy OData).

CloudErrorBody

Szczegóły błędu.

ErrorAdditionalInfo

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

EventSource

Prawidłowy typ źródła zdarzenia.

Operator

Prawidłowy operator porównania do użycia. Porównywanie bez uwzględniania wielkości liter zostanie zastosowane dla właściwości StringType.

PropertyType

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

Automation

Zasób automatyzacji zabezpieczeń.

Name Type Description
etag
  • string

Tag jednostki jest używany do porównywania dwóch lub większej liczby 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[]:

Kolekcja akcji, które są wyzwalane, jeśli wszystkie wartości oceny skonfigurowanych reguł w ramach co najmniej jednego zestawu reguł są spełnione.

properties.description
  • string

Opis automatyzacji zabezpieczeń.

properties.isEnabled
  • boolean

Wskazuje, czy Automatyzacja zabezpieczeń jest włączona.

properties.scopes

Kolekcja zakresów, na których jest stosowana logika automatyzacji zabezpieczeń. Obsługiwane zakresy to sama subskrypcja lub Grupa zasobów w ramach tej subskrypcji. Automatyzacja będzie obowiązywać tylko dla zdefiniowanych zakresów.

properties.sources

Kolekcja typów zdarzeń źródłowych, które szacują zestaw zasad automatyzacji zabezpieczeń.

tags
  • object

Lista par klucz-wartość, które opisują zasób.

type
  • string

Typ zasobu

AutomationActionEventHub

Docelowy centrum zdarzeń, do którego zostaną wyeksportowane dane zdarzeń. Aby dowiedzieć się więcej na temat możliwości funkcji eksportu ciągłego Security Center, odwiedź stronę https://aka.ms/ASCExportLearnMore

Name Type Description
actionType string:
  • EventHub

Typ akcji, który zostanie wyzwolony przez automatyzację

connectionString
  • string

Docelowe parametry połączenia centrum zdarzeń (nie zostaną uwzględnione w żadnej odpowiedzi).

eventHubResourceId
  • string

Docelowy identyfikator zasobu platformy Azure dla centrum zdarzeń.

sasPolicyName
  • string

Docelowa Nazwa zasad SAS centrum zdarzeń.

AutomationActionLogicApp

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

Name Type Description
actionType string:
  • LogicApp

Typ akcji, który zostanie wyzwolony przez automatyzację

logicAppResourceId
  • string

Identyfikator zasobu platformy Azure wyzwalanej aplikacji logiki. Może również znajdować się w innych subskrypcjach, z uwzględnieniem uprawnień do wyzwalania aplikacji logiki

uri
  • string

Punkt końcowy identyfikatora URI wyzwalacza aplikacji logiki (nie zostanie uwzględniony w żadnej odpowiedzi).

AutomationActionWorkspace

Obszar roboczy Log Analytics, do którego zostaną wyeksportowane dane zdarzeń. Dane alertów zabezpieczeń będą znajdować się w tabeli "SecurityAlert", a dane oceny będą znajdować się w tabeli "SecurityRecommendation" (w ramach rozwiązań "Security"/"SecurityCenterFree"). Należy pamiętać, że w celu wyświetlenia danych w obszarze roboczym należy włączyć Security Center Log Analytics rozwiązanie bezpłatne/standardowe w tym obszarze roboczym. Aby dowiedzieć się więcej na temat możliwości funkcji eksportu ciągłego Security Center, odwiedź stronę https://aka.ms/ASCExportLearnMore

Name Type Description
actionType string:
  • Workspace

Typ akcji, który zostanie wyzwolony przez automatyzację

workspaceResourceId
  • string

W pełni kwalifikowany Log Analytics identyfikator zasobu platformy Azure w obszarze roboczym.

AutomationRuleSet

Zestaw reguł, który oblicza wszystkie jego reguły przy przechwyceniu zdarzenia. Tylko wtedy, gdy wszystkie uwzględnione reguły w zestawie reguł zostaną ocenione jako "true", to zdarzenie wyzwala zdefiniowane akcje.

Name Type Description
rules

Reguła, która jest szacowana po przechwyceniu zdarzenia. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzenia do oczekiwanej wartości. To porównanie odbywa się przy użyciu jednego z obsługiwanych zestawów operatorów.

AutomationScope

Pojedynczy zakres automatyzacji.

Name Type Description
description
  • string

Opis zakresu zasobów.

scopePath
  • string

Ścieżka zakresu zasobów. Może to być subskrypcja, w której jest definiowana usługa Automation, lub Grupa zasobów w ramach tej subskrypcji (w pełni kwalifikowane identyfikatory zasobów platformy Azure).

AutomationSource

Źródłowe typy zdarzeń, które szacują zestaw reguł automatyzacji zabezpieczeń. Na przykład alerty zabezpieczeń i oceny zabezpieczeń. Aby dowiedzieć się więcej na temat obsługiwanych schematów modeli danych zdarzeń zabezpieczeń, odwiedź stronę https://aka.ms/ASCAutomationSchemas .

Name Type Description
eventSource

Prawidłowy typ źródła zdarzenia.

ruleSets

Zestaw reguł, który szacuje Po przechwyceniu zdarzenia. Między zdefiniowanymi zestawami reguł jest stosowane logiczne rozłączenie (logiczne "or").

AutomationTriggeringRule

Reguła, która jest szacowana po przechwyceniu zdarzenia. Reguła jest konfigurowana przez porównanie określonej wartości z modelu zdarzenia do oczekiwanej wartości. To porównanie odbywa się przy użyciu jednego z obsługiwanych zestawów operatorów.

Name Type Description
expectedValue
  • string

Oczekiwana wartość.

operator

Prawidłowy operator porównania do użycia. Porównywanie bez uwzględniania wielkości liter zostanie zastosowane dla właściwości StringType.

propertyJPath
  • string

JPath właściwości modelu jednostki, która powinna być sprawdzona.

propertyType

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

AutomationValidationStatus

Zbiór właściwości stanu modelu automatyzacji zabezpieczeń.

Name Type Description
isValid
  • boolean

Wskazuje, czy model jest prawidłowy, czy nie.

message
  • string

Komunikat weryfikacyjny.

CloudError

Wspólna odpowiedź na błędy dla wszystkich interfejsów API Azure Resource Manager, aby zwrócić szczegóły błędu dla operacji zakończonych niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błędy OData).

Name Type Description
error.additionalInfo

Dodatkowe informacje o błędzie.

error.code
  • string

Kod błędu.

error.details

Szczegóły błędu.

error.message
  • string

Komunikat o błędzie.

error.target
  • string

Obiekt docelowy błędu.

CloudErrorBody

Szczegóły błędu.

Name Type Description
additionalInfo

Dodatkowe informacje o błędzie.

code
  • string

Kod błędu.

details

Szczegóły błędu.

message
  • string

Komunikat o błędzie.

target
  • string

Obiekt docelowy błędu.

ErrorAdditionalInfo

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

Name Type Description
info
  • object

Dodatkowe informacje.

type
  • string

Typ informacji dodatkowych.

EventSource

Prawidłowy typ źródła zdarzenia.

Name Type Description
Alerts
  • string
Assessments
  • string
RegulatoryComplianceAssessment
  • string
RegulatoryComplianceAssessmentSnapshot
  • string
SecureScoreControls
  • string
SecureScoreControlsSnapshot
  • string
SecureScores
  • string
SecureScoresSnapshot
  • string
SubAssessments
  • string

Operator

Prawidłowy operator porównania do użycia. Porównywanie bez uwzględniania wielkości liter zostanie zastosowane dla właściwości StringType.

Name Type Description
Contains
  • string

Dotyczy tylko argumentów operacji innych niż dziesiętne

EndsWith
  • string

Dotyczy tylko argumentów operacji innych niż dziesiętne

Equals
  • string

Dotyczy operandów dziesiętnych i niedziesiętnych

GreaterThan
  • string

Dotyczy tylko argumentów operacji dziesiętnych

GreaterThanOrEqualTo
  • string

Dotyczy tylko argumentów operacji dziesiętnych

LesserThan
  • string

Dotyczy tylko argumentów operacji dziesiętnych

LesserThanOrEqualTo
  • string

Dotyczy tylko argumentów operacji dziesiętnych

NotEquals
  • string

Dotyczy operandów dziesiętnych i niedziesiętnych

StartsWith
  • string

Dotyczy tylko argumentów operacji innych niż dziesiętne

PropertyType

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

Name Type Description
Boolean
  • string
Integer
  • string
Number
  • string
String
  • string