HuntRelationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:hunt_relations> attribute.

Constructor

HuntRelationsOperations(*args, **kwargs)

Methods

create_or_update	Creates or updates a hunt relation.
delete	Delete a hunt relation.
get	Gets a hunt relation.
list	Gets all hunt relations.

create_or_update

Creates or updates a hunt relation.

create_or_update(resource_group_name: str, workspace_name: str, hunt_id: str, hunt_relation_id: str, hunt_relation: _models.HuntRelation, *, content_type: str = 'application/json', **kwargs: Any) -> _models.HuntRelation

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
workspace_name Required	str The name of the workspace. Required.
hunt_id Required	str The hunt id (GUID). Required.
hunt_relation_id Required	str The hunt relation id (GUID). Required.
hunt_relation Required	HuntRelation or <xref:JSON> or IO[bytes] The hunt relation. Is one of the following types: HuntRelation, JSON, IO[bytes] Required.

Returns

Type	Description
HuntRelation	HuntRelation. The HuntRelation is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

delete

Delete a hunt relation.

delete(resource_group_name: str, workspace_name: str, hunt_id: str, hunt_relation_id: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
workspace_name Required	str The name of the workspace. Required.
hunt_id Required	str The hunt id (GUID). Required.
hunt_relation_id Required	str The hunt relation id (GUID). Required.

Returns

Type	Description
None	None

Exceptions

Type	Description
HttpResponseError

get

Gets a hunt relation.

get(resource_group_name: str, workspace_name: str, hunt_id: str, hunt_relation_id: str, **kwargs: Any) -> HuntRelation

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
workspace_name Required	str The name of the workspace. Required.
hunt_id Required	str The hunt id (GUID). Required.
hunt_relation_id Required	str The hunt relation id (GUID). Required.

Returns

Type	Description
HuntRelation	HuntRelation. The HuntRelation is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

Gets all hunt relations.

list(resource_group_name: str, workspace_name: str, hunt_id: str, *, filter: str | None = None, orderby: str | None = None, top: int | None = None, skip_token: str | None = None, **kwargs: Any) -> ItemPaged[HuntRelation]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
workspace_name Required	str The name of the workspace. Required.
hunt_id Required	str The hunt id (GUID). Required.

Keyword-Only Parameters

Name	Description
filter	str Filters the results, based on a Boolean condition. Optional. Default value is None. Default value: None
orderby	str Sorts the results. Optional. Default value is None. Default value: None
top	int Returns only the first n results. Optional. Default value is None. Default value: None
skip_token	str Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional. Default value is None. Default value: None

Returns

Type	Description
ItemPaged[HuntRelation]	An iterator like instance of HuntRelation

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?