azure.defender.easm.aio.operations package¶

class azure.defender.easm.aio.operations.AssetsOperations(*args, **kwargs)[source]¶

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EasmClient’s assets attribute.

async get(asset_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Retrieve an asset by assetId.

Parameters: asset_id (str) – The unique identifier for the asset. Ids are formatted as ‘<kind>`$$:code:`<name>’ and can optionally be Base64 encoded if they contain special characters. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

list(*, filter: Optional[str] = None, orderby: Optional[str] = None, skip: int = 0, mark: Optional[str] = None, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]][source]¶

Retrieve a list of assets for the provided search parameters.

Keyword Arguments

filter (str) – An expression on the resource type that selects the resources to be returned. Default value is None.
orderby (str) – A list of expressions that specify the order of the returned resources. Default value is None.
skip (int) – An offset into the collection of the first item to be returned. Default value is 0.
mark (str) – Specify this value instead of ‘skip’ to use cursor-based searching. Initial value is ‘*’ and subsequent values are returned in the response. Default value is None.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

async update(body: JSON, *, filter: Optional[str] = 'None', content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶

async update(body: IO, *, filter: Optional[str] = 'None', content_type: str = "'application/json'", **kwargs: Any) → JSON

Update labels on assets matching the provided filter.

Parameters

body (JSON or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

filter (str) – An expression on the resource type that selects the resources to be returned. Default value is None.
content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "completedAt": "2020-02-20 00:00:00",  # Optional. The time the task
      completed.
    "id": "str",  # Optional. The unique identifier of the task.
    "lastPolledAt": "2020-02-20 00:00:00",  # Optional. The last time the status
      of the task was updated.
    "metadata": {
        "str": {}  # Optional. Attributes unique to the task.  This differs
          by task type.
    },
    "phase": "str",  # Optional. The phase the task is in. Known values are:
      "running", "polling", and "complete".
    "reason": "str",  # Optional. The reason the task was moved into its current
      state, if the task wasn't completed.
    "startedAt": "2020-02-20 00:00:00",  # Optional. The time the task started.
    "state": "str"  # Optional. The state the task is in. Known values are:
      "pending", "running", "paused", "complete", "incomplete", "failed", and
      "warning".
}

class azure.defender.easm.aio.operations.DiscoveryGroupsOperations(*args, **kwargs)[source]¶

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EasmClient’s discovery_groups attribute.

async delete(group_name: str, **kwargs: Any) → None [source]¶

Delete a discovery group with a given groupName.

Parameters: group_name (str) – The unique identifier for the discovery group. Required.
Returns: None
Return type: None
Raises: HttpResponseError –

async get(group_name: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Retrieve a discovery group with a given groupName.

Parameters: group_name (str) – The unique identifier for the discovery group. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "createdDate": "2020-02-20 00:00:00",  # Optional. The date for the disco
      group was created.
    "description": "str",  # Optional. The description for a disco group.
    "displayName": "str",  # Optional. The name that can be used for display
      purposes.
    "excludes": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "frequencyMilliseconds": 0,  # Optional. The frequency at which the disco
      group is supposed to be rerun in milliseconds.
    "id": "str",  # Optional. The system generated unique id for the resource.
    "latestRun": {
        "completedDate": "2020-02-20 00:00:00",  # Optional. The date for
          when the disco run was completed by the system.
        "excludes": [
            {
                "kind": "str",  # Optional. The kind of disco source.
                  Known values are: "as", "attribute", "contact", "domain", "host", and
                  "ipBlock".
                "name": "str"  # Optional. The name for the disco
                  source.
            }
        ],
        "names": [
            "str"  # Optional. The list of names used for the disco run.
        ],
        "seeds": [
            {
                "kind": "str",  # Optional. The kind of disco source.
                  Known values are: "as", "attribute", "contact", "domain", "host", and
                  "ipBlock".
                "name": "str"  # Optional. The name for the disco
                  source.
            }
        ],
        "startedDate": "2020-02-20 00:00:00",  # Optional. The date for when
          the disco run was actually started by the system.
        "state": "str",  # Optional. The State of the disco run. Known values
          are: "pending", "running", "completed", and "failed".
        "submittedDate": "2020-02-20 00:00:00",  # Optional. The date for
          when the disco run was created in the system.
        "tier": "str",  # Optional. The tier which will affect the algorithm
          used for the disco run.
        "totalAssetsFoundCount": 0  # Optional. The total count of assets
          that were found this disco run.
    },
    "name": "str",  # Optional. The caller provided unique name for the resource.
    "names": [
        "str"  # Optional. The list of names used for the disco group runs.
    ],
    "seeds": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "templateId": "str",  # Optional. The unique identifier for the disco
      template used for the disco group creation.
    "tier": "str"  # Optional. The tier for the disco group which will affect the
      algorithm used for the disco runs in this group.
}

list(*, filter: Optional[str] = None, skip: int = 0, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]][source]¶

Retrieve a list of discovery group for the provided search parameters.

Keyword Arguments

filter (str) – An expression on the resource type that selects the resources to be returned. Default value is None.
skip (int) – An offset into the collection of the first item to be returned. Default value is 0.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "createdDate": "2020-02-20 00:00:00",  # Optional. The date for the disco
      group was created.
    "description": "str",  # Optional. The description for a disco group.
    "displayName": "str",  # Optional. The name that can be used for display
      purposes.
    "excludes": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "frequencyMilliseconds": 0,  # Optional. The frequency at which the disco
      group is supposed to be rerun in milliseconds.
    "id": "str",  # Optional. The system generated unique id for the resource.
    "latestRun": {
        "completedDate": "2020-02-20 00:00:00",  # Optional. The date for
          when the disco run was completed by the system.
        "excludes": [
            {
                "kind": "str",  # Optional. The kind of disco source.
                  Known values are: "as", "attribute", "contact", "domain", "host", and
                  "ipBlock".
                "name": "str"  # Optional. The name for the disco
                  source.
            }
        ],
        "names": [
            "str"  # Optional. The list of names used for the disco run.
        ],
        "seeds": [
            {
                "kind": "str",  # Optional. The kind of disco source.
                  Known values are: "as", "attribute", "contact", "domain", "host", and
                  "ipBlock".
                "name": "str"  # Optional. The name for the disco
                  source.
            }
        ],
        "startedDate": "2020-02-20 00:00:00",  # Optional. The date for when
          the disco run was actually started by the system.
        "state": "str",  # Optional. The State of the disco run. Known values
          are: "pending", "running", "completed", and "failed".
        "submittedDate": "2020-02-20 00:00:00",  # Optional. The date for
          when the disco run was created in the system.
        "tier": "str",  # Optional. The tier which will affect the algorithm
          used for the disco run.
        "totalAssetsFoundCount": 0  # Optional. The total count of assets
          that were found this disco run.
    },
    "name": "str",  # Optional. The caller provided unique name for the resource.
    "names": [
        "str"  # Optional. The list of names used for the disco group runs.
    ],
    "seeds": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "templateId": "str",  # Optional. The unique identifier for the disco
      template used for the disco group creation.
    "tier": "str"  # Optional. The tier for the disco group which will affect the
      algorithm used for the disco runs in this group.
}

list_runs(group_name: str, *, filter: Optional[str] = None, skip: int = 0, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]][source]¶

Retrieve a collection of discovery run results for a discovery group with a given groupName.

Parameters

group_name (str) – The unique identifier for the discovery group. Required.

Keyword Arguments

filter (str) – An expression on the resource type that selects the resources to be returned. Default value is None.
skip (int) – An offset into the collection of the first item to be returned. Default value is 0.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "completedDate": "2020-02-20 00:00:00",  # Optional. The date for when the
      disco run was completed by the system.
    "excludes": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "names": [
        "str"  # Optional. The list of names used for the disco run.
    ],
    "seeds": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "startedDate": "2020-02-20 00:00:00",  # Optional. The date for when the
      disco run was actually started by the system.
    "state": "str",  # Optional. The State of the disco run. Known values are:
      "pending", "running", "completed", and "failed".
    "submittedDate": "2020-02-20 00:00:00",  # Optional. The date for when the
      disco run was created in the system.
    "tier": "str",  # Optional. The tier which will affect the algorithm used for
      the disco run.
    "totalAssetsFoundCount": 0  # Optional. The total count of assets that were
      found this disco run.
}

async put(group_name: str, body: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶

async put(group_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → JSON

Create a discovery group with a given groupName.

Parameters

group_name (str) – The unique identifier for the discovery group. Required.
body (JSON or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "createdDate": "2020-02-20 00:00:00",  # Optional. The date for the disco
      group was created.
    "description": "str",  # Optional. The description for a disco group.
    "displayName": "str",  # Optional. The name that can be used for display
      purposes.
    "excludes": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "frequencyMilliseconds": 0,  # Optional. The frequency at which the disco
      group is supposed to be rerun in milliseconds.
    "id": "str",  # Optional. The system generated unique id for the resource.
    "latestRun": {
        "completedDate": "2020-02-20 00:00:00",  # Optional. The date for
          when the disco run was completed by the system.
        "excludes": [
            {
                "kind": "str",  # Optional. The kind of disco source.
                  Known values are: "as", "attribute", "contact", "domain", "host", and
                  "ipBlock".
                "name": "str"  # Optional. The name for the disco
                  source.
            }
        ],
        "names": [
            "str"  # Optional. The list of names used for the disco run.
        ],
        "seeds": [
            {
                "kind": "str",  # Optional. The kind of disco source.
                  Known values are: "as", "attribute", "contact", "domain", "host", and
                  "ipBlock".
                "name": "str"  # Optional. The name for the disco
                  source.
            }
        ],
        "startedDate": "2020-02-20 00:00:00",  # Optional. The date for when
          the disco run was actually started by the system.
        "state": "str",  # Optional. The State of the disco run. Known values
          are: "pending", "running", "completed", and "failed".
        "submittedDate": "2020-02-20 00:00:00",  # Optional. The date for
          when the disco run was created in the system.
        "tier": "str",  # Optional. The tier which will affect the algorithm
          used for the disco run.
        "totalAssetsFoundCount": 0  # Optional. The total count of assets
          that were found this disco run.
    },
    "name": "str",  # Optional. The caller provided unique name for the resource.
    "names": [
        "str"  # Optional. The list of names used for the disco group runs.
    ],
    "seeds": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "templateId": "str",  # Optional. The unique identifier for the disco
      template used for the disco group creation.
    "tier": "str"  # Optional. The tier for the disco group which will affect the
      algorithm used for the disco runs in this group.
}

async run(group_name: str, **kwargs: Any) → None [source]¶

Run a discovery group with a given groupName.

Parameters: group_name (str) – The unique identifier for the discovery group. Required.
Returns: None
Return type: None
Raises: HttpResponseError –

async validate(group_name: str, body: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶

async validate(group_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → JSON

Validate a discovery group with a given groupName.

Parameters

group_name (str) – The unique identifier for the discovery group. Required.
body (JSON or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "error": {
        "code": "str",  # This is one of a server-defined set of error codes.
          Required.
        "message": "str",  # This is a human-readable representation of the
          error. Required.
        "details": [
            ...
        ],
        "innererror": {
            "code": "str",  # Optional. This is a more specific error
              code than was provided by the containing error.
            "value": {}  # Optional. This is an additional field
              representing the value that caused the error to help with debugging.
        },
        "target": "str"  # Optional. This is the error target.
    }
}

class azure.defender.easm.aio.operations.DiscoveryTemplatesOperations(*args, **kwargs)[source]¶

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EasmClient’s discovery_templates attribute.

async get(template_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Retrieve a disco template with a given templateId.

Parameters: template_id (str) – The unique identifier for the disco template. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "city": "str",  # Optional. The name of the city.
    "countryCode": "str",  # Optional. The country code.
    "displayName": "str",  # Optional. The name that can be used for display
      purposes.
    "id": "str",  # Optional. The system generated unique id for the resource.
    "industry": "str",  # Optional. The name of the industry.
    "name": "str",  # Optional. The caller provided unique name for the resource.
    "names": [
        "str"  # Optional. The list of disco template names.
    ],
    "region": "str",  # Optional. The name of the region.
    "seeds": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "stateCode": "str"  # Optional. The state code.
}

list(*, filter: Optional[str] = None, skip: int = 0, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]][source]¶

Retrieve a list of disco templates for the provided search parameters.

Keyword Arguments

filter (str) – An expression on the resource type that selects the resources to be returned. Default value is None.
skip (int) – An offset into the collection of the first item to be returned. Default value is 0.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "city": "str",  # Optional. The name of the city.
    "countryCode": "str",  # Optional. The country code.
    "displayName": "str",  # Optional. The name that can be used for display
      purposes.
    "id": "str",  # Optional. The system generated unique id for the resource.
    "industry": "str",  # Optional. The name of the industry.
    "name": "str",  # Optional. The caller provided unique name for the resource.
    "names": [
        "str"  # Optional. The list of disco template names.
    ],
    "region": "str",  # Optional. The name of the region.
    "seeds": [
        {
            "kind": "str",  # Optional. The kind of disco source. Known
              values are: "as", "attribute", "contact", "domain", "host", and
              "ipBlock".
            "name": "str"  # Optional. The name for the disco source.
        }
    ],
    "stateCode": "str"  # Optional. The state code.
}

class azure.defender.easm.aio.operations.ReportsOperations(*args, **kwargs)[source]¶

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EasmClient’s reports attribute.

async billable(**kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Get billable assets summary for the workspace.

Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "assetSummaries": [
        {
            "assetBreakdown": [
                {
                    "count": 0,  # Optional. The number of assets
                      of this type.
                    "kind": "str"  # Optional. The kind of
                      billable asset. Known values are: "domain", "host", and
                      "ipAddress".
                }
            ],
            "date": "2020-02-20",  # Optional. The date these assets were
              billed on.
            "total": 0  # Optional. The total number of billable assets
              for this date.
        }
    ]
}

async snapshot(body: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶

async snapshot(body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → JSON

Get the most recent snapshot of asset summary values for the snapshot request.

Parameters: body (JSON or IO) – Is either a model type or a IO type. Required.
Keyword Arguments: content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "assets": {
        "content": [
            asset_response
        ],
        "first": bool,  # Optional. Whether or not this is the first page of
          results.
        "last": bool,  # Optional. Whether or not this is the last page of
          results.
        "mark": "str",  # Optional. The cursor mark to be used on the next
          request.  Not set if using paging.
        "nextLink": "str",  # Optional. The link to access the next page of
          results.  Not set if at the end of the result set.
        "number": 0,  # Optional. The page number requested.  Set to -1 if
          using a cursor.
        "numberOfElements": 0,  # Optional. The number of items in the
          current page of results.
        "size": 0,  # Optional. The page size requested.
        "totalElements": 0,  # Optional. The total number of items available
          in the full result set.
        "totalPages": 0  # Optional. The total number of pages available in
          the full result set.
    },
    "description": "str",  # Optional. A description of what the metric
      represents.
    "displayName": "str",  # Optional. The name of the metric.
    "labelName": "str",  # Optional. The customer label that was filtered on, if
      one was provided.
    "metric": "str",  # Optional. The unique metric name.
    "updatedAt": "2020-02-20 00:00:00"  # Optional. The last time this asset data
      was updated on this metric.
}

async summary(body: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶

async summary(body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → JSON

Get asset summary details for the summary request.

Parameters: body (JSON or IO) – Is either a model type or a IO type. Required.
Keyword Arguments: content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "assetSummaries": [
        {
            "children": [
                ...
            ],
            "count": 0,  # Optional. The count of assets matching the
              request parameters.
            "description": "str",  # Optional. The description of the
              summary response.  Filters don't have a description.
            "displayName": "str",  # Optional. The name of the summary
              response.  Depending on the request time this will either be the asset
              filter, risk category, or risk metric.
            "filter": "str",  # Optional. If the request is for an asset
              filter, this will contain the corresponding filter.
            "labelName": "str",  # Optional. An optional label used to
              filter requests results.
            "link": "str",  # Optional. The link to the corresponding
              asset details.
            "metric": "str",  # Optional. If the request is for a metric,
              this will contain the requested unique metric name.
            "metricCategory": "str",  # Optional. If the request is for a
              metric category, this will contain the requested unique category name.
            "updatedAt": "2020-02-20 00:00:00"  # Optional. The last time
              risk categories or risk metrics were captured. Set to the current time
              for asset filter requests, which always pull the live asset data.
        }
    ]
}

class azure.defender.easm.aio.operations.SavedFiltersOperations(*args, **kwargs)[source]¶

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EasmClient’s saved_filters attribute.

async delete(filter_name: str, **kwargs: Any) → None [source]¶

Delete a saved filter with a given filterName.

Parameters: filter_name (str) – The unique identifier for the saved filter. Required.
Returns: None
Return type: None
Raises: HttpResponseError –

async get(filter_name: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Retrieve a saved filter by filterName.

Parameters: filter_name (str) – The unique identifier for the saved filter. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "description": "str",  # Optional.
    "displayName": "str",  # Optional. The name that can be used for display
      purposes.
    "filter": "str",  # Optional.
    "id": "str",  # Optional. The system generated unique id for the resource.
    "name": "str"  # Optional. The caller provided unique name for the resource.
}

list(*, filter: Optional[str] = None, skip: int = 0, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]][source]¶

Retrieve a list of saved filters for the provided search parameters.

Keyword Arguments

filter (str) – An expression on the resource type that selects the resources to be returned. Default value is None.
skip (int) – An offset into the collection of the first item to be returned. Default value is 0.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "description": "str",  # Optional.
    "displayName": "str",  # Optional. The name that can be used for display
      purposes.
    "filter": "str",  # Optional.
    "id": "str",  # Optional. The system generated unique id for the resource.
    "name": "str"  # Optional. The caller provided unique name for the resource.
}

async put(filter_name: str, body: JSON, *, content_type: str = "'application/json'", **kwargs: Any) → JSON[source]¶

async put(filter_name: str, body: IO, *, content_type: str = "'application/json'", **kwargs: Any) → JSON

Create or update a saved filter with a given filterName.

Parameters

filter_name (str) – The unique identifier for the saved filter. Required.
body (JSON or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

Returns

JSON object

Return type

JSON

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "description": "str",  # Optional.
    "displayName": "str",  # Optional. The name that can be used for display
      purposes.
    "filter": "str",  # Optional.
    "id": "str",  # Optional. The system generated unique id for the resource.
    "name": "str"  # Optional. The caller provided unique name for the resource.
}

class azure.defender.easm.aio.operations.TasksOperations(*args, **kwargs)[source]¶

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through EasmClient’s tasks attribute.

async cancel(task_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Cancel a task by taskId.

Parameters: task_id (str) – The unique identifier for the task. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "completedAt": "2020-02-20 00:00:00",  # Optional. The time the task
      completed.
    "id": "str",  # Optional. The unique identifier of the task.
    "lastPolledAt": "2020-02-20 00:00:00",  # Optional. The last time the status
      of the task was updated.
    "metadata": {
        "str": {}  # Optional. Attributes unique to the task.  This differs
          by task type.
    },
    "phase": "str",  # Optional. The phase the task is in. Known values are:
      "running", "polling", and "complete".
    "reason": "str",  # Optional. The reason the task was moved into its current
      state, if the task wasn't completed.
    "startedAt": "2020-02-20 00:00:00",  # Optional. The time the task started.
    "state": "str"  # Optional. The state the task is in. Known values are:
      "pending", "running", "paused", "complete", "incomplete", "failed", and
      "warning".
}

async get(task_id: str, **kwargs: Any) → collections.abc.MutableMapping[str, Any][source]¶

Retrieve a task by taskId.

Parameters: task_id (str) – The unique identifier for the task. Required.
Returns: JSON object
Return type: JSON
Raises: HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "completedAt": "2020-02-20 00:00:00",  # Optional. The time the task
      completed.
    "id": "str",  # Optional. The unique identifier of the task.
    "lastPolledAt": "2020-02-20 00:00:00",  # Optional. The last time the status
      of the task was updated.
    "metadata": {
        "str": {}  # Optional. Attributes unique to the task.  This differs
          by task type.
    },
    "phase": "str",  # Optional. The phase the task is in. Known values are:
      "running", "polling", and "complete".
    "reason": "str",  # Optional. The reason the task was moved into its current
      state, if the task wasn't completed.
    "startedAt": "2020-02-20 00:00:00",  # Optional. The time the task started.
    "state": "str"  # Optional. The state the task is in. Known values are:
      "pending", "running", "paused", "complete", "incomplete", "failed", and
      "warning".
}

list(*, filter: Optional[str] = None, skip: int = 0, **kwargs: Any) → AsyncIterable[collections.abc.MutableMapping[str, Any]][source]¶

Retrieve a list of tasks for the provided search parameters.

Keyword Arguments

filter (str) – An expression on the resource type that selects the resources to be returned. Default value is None.
skip (int) – An offset into the collection of the first item to be returned. Default value is 0.

Returns

An iterator like instance of JSON object

Return type

AsyncItemPaged[JSON]

Raises

HttpResponseError –

Example

# response body for status code(s): 200
response == {
    "completedAt": "2020-02-20 00:00:00",  # Optional. The time the task
      completed.
    "id": "str",  # Optional. The unique identifier of the task.
    "lastPolledAt": "2020-02-20 00:00:00",  # Optional. The last time the status
      of the task was updated.
    "metadata": {
        "str": {}  # Optional. Attributes unique to the task.  This differs
          by task type.
    },
    "phase": "str",  # Optional. The phase the task is in. Known values are:
      "running", "polling", and "complete".
    "reason": "str",  # Optional. The reason the task was moved into its current
      state, if the task wasn't completed.
    "startedAt": "2020-02-20 00:00:00",  # Optional. The time the task started.
    "state": "str"  # Optional. The state the task is in. Known values are:
      "pending", "running", "paused", "complete", "incomplete", "failed", and
      "warning".
}