Assets - Get Assets Export

Serviço:

Defender EASM (preview)

Versão da API:

2024-10-01-preview

Exporte uma lista de ativos para os parâmetros de pesquisa fornecidos.

POST {endpoint}/assets:export?api-version=2024-10-01-preview

Com parâmetros opcionais:

POST {endpoint}/assets:export?api-version=2024-10-01-preview&filter={filter}&orderby={orderby}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	O ponto de extremidade que hospeda o recurso solicitado. Por exemplo, https://{region}.easm.defender.microsoft.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/workspaces/{workspaceName}
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
filter	query		string	Filtre a lista de resultados usando a expressão fornecida.
orderby	query		string	Uma lista de expressões que especificam a ordem dos recursos retornados.

Corpo do Pedido

Name	Necessário	Tipo	Description
columns	True	string[]	As colunas a serem exportadas.
fileName	True	string	O nome do arquivo a ser exportado.

Respostas

Name	Tipo	Description
200 OK	Task	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Segurança

OAuth2Auth

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

Âmbitos

Name	Description
https://easm.defender.microsoft.com/.default

Exemplos

Assets_GetAssetsExport

Pedido de amostra

HTTP

POST {endpoint}/assets:export?api-version=2024-10-01-preview&filter=state%20%3D%20%22confirmed%22

{
  "fileName": "ThisisaFileName",
  "columns": [
    "asset",
    "name"
  ]
}

Resposta da amostra

Código de estado:

200

{
  "id": "ThisisaTaskId",
  "startedAt": "2022-05-02T19:30:14.432+00:00",
  "completedAt": "2022-05-02T19:30:54.432+00:00",
  "lastPolledAt": "2022-05-02T19:30:19.432+00:00",
  "state": "complete",
  "phase": "complete",
  "reason": "This is a Task id"
}

Definições

Name	Description
AssetsExportRequest	Um corpo de solicitação usado para exportar um ativo.
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Task
TaskPhase	A fase em que a tarefa se encontra.
TaskState	O estado em que a tarefa se encontra.

AssetsExportRequest

Object

Um corpo de solicitação usado para exportar um ativo.

Name	Tipo	Description
columns	string[]	As colunas a serem exportadas.
fileName	string	O nome do arquivo a ser exportado.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API REST do Azure - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

Task

Object

Name	Tipo	Description
completedAt	string (date-time)	A hora em que a tarefa foi concluída.
id	string	O identificador exclusivo da tarefa.
lastPolledAt	string (date-time)	A última vez que o status da tarefa foi atualizado.
metadata		Atributos exclusivos para a tarefa. Isso difere de acordo com o tipo de tarefa.
phase	TaskPhase	A fase em que a tarefa se encontra.
reason	string	O motivo pelo qual a tarefa foi movida para seu estado atual, se a tarefa não foi concluída.
startedAt	string (date-time)	A hora em que a tarefa começou.
state	TaskState	O estado em que a tarefa se encontra.

TaskPhase

Enumeração

A fase em que a tarefa se encontra.

Valor	Description
running
polling
complete

TaskState

Enumeração

O estado em que a tarefa se encontra.

Valor	Description
pending
running
paused
complete
incomplete
failed
warning