Incident Relations - List

Service:

Sentinel

API Version:

2024-03-01

Pobiera wszystkie relacje dla danego incydentu.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations?api-version=2024-03-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations?api-version=2024-03-01&$filter={$filter}&$orderby={$orderby}&$top={$top}&$skipToken={$skipToken}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
incidentId	path	True	string	Identyfikator zdarzenia
resourceGroupName	path	True	string	Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
subscriptionId	path	True	string uuid	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
workspaceName	path	True	string	Nazwa obszaru roboczego. Regex pattern: ^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$
api-version	query	True	string	Wersja interfejsu API do użycia dla tej operacji.
$filter	query		string	Filtruje wyniki na podstawie warunku logicznego. Opcjonalny.
$orderby	query		string	Sortuje wyniki. Opcjonalny.
$skipToken	query		string	Skiptoken jest używany tylko wtedy, gdy poprzednia operacja zwróciła częściowy wynik. Jeśli poprzednia odpowiedź zawiera element nextLink, wartość elementu nextLink będzie zawierać parametr skiptoken, który określa punkt wyjścia do użycia dla kolejnych wywołań. Opcjonalny.
$top	query		integer int32	Zwraca tylko pierwsze n wyników. Opcjonalny.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	RelationList	OK
Other Status Codes	CloudError	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory

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

Scopes

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Get all incident relations.

Sample Request

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations?api-version=2024-03-01

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
      "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014",
      "type": "Microsoft.SecurityInsights/incidents/relations",
      "etag": "190057d0-0000-0d00-0000-5c6f5adb0000",
      "properties": {
        "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096",
        "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096",
        "relatedResourceType": "Microsoft.SecurityInsights/bookmarks"
      }
    },
    {
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/9673a17d-8bc7-4ca6-88ee-38a4f3efc032",
      "name": "9673a17d-8bc7-4ca6-88ee-38a4f3efc032",
      "type": "Microsoft.SecurityInsights/incidents/relations",
      "etag": "6f714025-dd7c-46aa-b5d0-b9857488d060",
      "properties": {
        "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/1dd267cd-8a1f-4f6f-b92c-da43ac8819af",
        "relatedResourceName": "1dd267cd-8a1f-4f6f-b92c-da43ac8819af",
        "relatedResourceType": "Microsoft.SecurityInsights/entities",
        "relatedResourceKind": "SecurityAlert"
      }
    }
  ]
}

Definicje

Nazwa	Opis
CloudError	Struktura odpowiedzi na błędy.
CloudErrorBody	Szczegóły błędu.
createdByType	Typ tożsamości, która utworzyła zasób.
Relation	Reprezentuje relację między dwoma zasobami
RelationList	Lista relacji.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

CloudError

Struktura odpowiedzi na błędy.

Nazwa	Typ	Opis
error	CloudErrorBody	Dane o błędach

CloudErrorBody

Szczegóły błędu.

Nazwa	Typ	Opis
code	string	Identyfikator błędu. Kody są niezmienne i mają być używane programowo.
message	string	Komunikat opisujący błąd, który ma być odpowiedni do wyświetlania w interfejsie użytkownika.

createdByType

Typ tożsamości, która utworzyła zasób.

Nazwa	Typ	Opis
Application	string
Key	string
ManagedIdentity	string
User	string

Relation

Reprezentuje relację między dwoma zasobami

Nazwa	Typ	Opis
etag	string	Etag zasobu platformy Azure
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.relatedResourceId	string	Identyfikator zasobu powiązanego zasobu
properties.relatedResourceKind	string	Rodzaj zasobu powiązanego zasobu
properties.relatedResourceName	string	Nazwa powiązanego zasobu
properties.relatedResourceType	string	Typ zasobu powiązanego zasobu
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje createdBy i modifiedBy.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

RelationList

Lista relacji.

Nazwa	Typ	Opis
nextLink	string	Adres URL umożliwiający pobranie następnego zestawu relacji.
value	Relation[]	Tablica relacji.

systemData

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string	Sygnatura czasowa tworzenia zasobów (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string	Sygnatura czasowa ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.