Watchlists - List

Referência

Serviço:: Sentinel

Versão da API:: 2024-03-01

Obtenha todas as listas de observação, sem itens da lista de observação.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não é sensível a maiúsculas e minúsculas.
subscriptionId	path	True	string	O ID da subscrição de destino.
workspaceName	path	True	string	O nome da área de trabalho. Padrão Regex: `^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$`
api-version	query	True	string	A versão da API a utilizar para esta operação.
$skipToken	query		string	O skiptoken só é utilizado se uma operação anterior devolver um resultado parcial. Se uma resposta anterior contiver um elemento nextLink, o valor do elemento nextLink incluirá um parâmetro skiptoken que especifica um ponto de partida a utilizar para chamadas subsequentes. Opcional.

Respostas

Name	Tipo	Description
200 OK	WatchlistList	OK
Other Status Codes	CloudError	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

Get all watchlists.

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists?api-version=2024-03-01

Resposta da amostra

Código de estado:: 200

{
  "value": [
    {
      "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset",
      "name": "highValueAsset",
      "type": "Microsoft.SecurityInsights/Watchlists",
      "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"",
      "properties": {
        "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017",
        "displayName": "High Value Assets Watchlist",
        "provider": "Microsoft",
        "source": "Local file",
        "created": "2020-09-28T00:26:54.7746089+00:00",
        "updated": "2020-09-28T00:26:57+00:00",
        "createdBy": {
          "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
          "email": "john@contoso.com",
          "name": "john doe"
        },
        "updatedBy": {
          "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70",
          "email": "john@contoso.com",
          "name": "john doe"
        },
        "description": "Watchlist from CSV content",
        "watchlistType": "watchlist",
        "watchlistAlias": "highValueAsset",
        "itemsSearchKey": "header1",
        "isDeleted": false,
        "labels": [
          "Tag1",
          "Tag2"
        ],
        "defaultDuration": "P1279DT12H30M5S",
        "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd"
      }
    }
  ]
}

Definições

Name	Description
CloudError	Estrutura de resposta a erros.
CloudErrorBody	Detalhes do erro.
createdByType	O tipo de identidade que criou o recurso.
systemData	Metadados relativos à criação e última modificação do recurso.
UserInfo	Informações do utilizador que efetuou alguma ação
Watchlist	Representa uma Lista de Observação nas Informações de Segurança do Azure.
WatchlistList	Listar todas as listas de observação.

CloudError

Estrutura de resposta a erros.

Name	Tipo	Description
error	CloudErrorBody	Dados de erro

CloudErrorBody

Detalhes do erro.

Name	Tipo	Description
code	string	Um identificador para o erro. Os códigos são invariantes e destinam-se a ser consumidos programaticamente.
message	string	Uma mensagem que descreve o erro, destinada a ser adequada para ser apresentada numa interface de utilizador.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UserInfo

Informações do utilizador que efetuou alguma ação

Name	Tipo	Description
email	string	O e-mail do utilizador.
name	string	O nome do utilizador.
objectId	string	O ID do objeto do utilizador.

Watchlist

Representa uma Lista de Observação nas Informações de Segurança do Azure.

Name	Tipo	Description
etag	string	Etag do recurso do azure
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.contentType	string	O tipo de conteúdo do conteúdo não processado. Por enquanto, apenas o texto/csv é válido
properties.created	string	A hora em que a lista de observação foi criada
properties.createdBy	UserInfo	Descreve um utilizador que criou a lista de observação
properties.defaultDuration	string	A duração predefinida de uma lista de observação (no formato de duração ISO 8601)
properties.description	string	Uma descrição da lista de observação
properties.displayName	string	O nome a apresentar da lista de observação
properties.isDeleted	boolean	Um sinalizador que indica se a lista de observação foi eliminada ou não
properties.itemsSearchKey	string	A chave de pesquisa é utilizada para otimizar o desempenho das consultas ao utilizar listas de observação para associações a outros dados. Por exemplo, ative uma coluna com endereços IP para ser o campo SearchKey designado e, em seguida, utilize este campo como o campo chave ao associar a outros dados de eventos por endereço IP.
properties.labels	string[]	Lista de etiquetas relevantes para esta lista de observação
properties.numberOfLinesToSkip	integer	O número de linhas num conteúdo csv a ignorar antes do cabeçalho
properties.provider	string	O fornecedor da lista de observação
properties.rawContent	string	O conteúdo não processado que representa os itens da lista de observação a criar. Exemplo: esta linha será ignorada cabeçalho1,cabeçalho2 valor1,valor2
properties.source	string	A origem da lista de observação. Só aceita "Ficheiro local" e "Armazenamento remoto". E tem de estar incluído no pedido.
properties.tenantId	string	O tenantId ao qual pertence a lista de observação
properties.updated	string	A última vez que a lista de observação foi atualizada
properties.updatedBy	UserInfo	Descreve um utilizador que atualizou a lista de observação
properties.uploadStatus	string	O estado do carregamento da Lista de Observação: Novo, InProgresso ou Concluído. Nota : quando um estado de carregamento da Lista de Observação é InProgress, a Lista de Observação não pode ser eliminada
properties.watchlistAlias	string	O alias da lista de observação
properties.watchlistId	string	O ID (um Guid) da lista de observação
properties.watchlistType	string	O tipo da lista de observação
systemData	systemData	O Azure Resource Manager metadados que contêm informações createdBy e modifiedBy.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WatchlistList

Listar todas as listas de observação.

Name	Tipo	Description
nextLink	string	URL para obter o próximo conjunto de listas de observação.
value	Watchlist[]	Matriz da lista de observação.

Partilhar via