Skip to content

ark_uap_sia_vm_service

ArkUAPSIAVMService

Bases: ArkUAPBaseService

Source code in ark_sdk_python/services/uap/sia/vm/ark_uap_sia_vm_service.py 
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
class ArkUAPSIAVMService(ArkUAPBaseService):
    def add_policy(self, add_policy: ArkUAPSIAVMAccessPolicy) -> ArkUAPSIAVMAccessPolicy:
        """
        Adds a new SIA VM policy with the given information.

        Args:
            add_policy (ArkUAPSIAVMAccessPolicy): The policy to be added.

        Raises:
            ArkServiceException: _description_

        Returns:
            ArkUAPResponse: _description_
        """
        add_policy_response: ArkUAPResponse = self._base_add_policy(
            add_policy=add_policy.serialize_model(by_alias=True, exclude_none=True),
            policy_name=add_policy.metadata.name,
        )
        return self.policy(ArkUAPGetPolicyRequest(policy_id=add_policy_response.policy_id))

    def policy(self, policy_request: ArkUAPGetPolicyRequest) -> ArkUAPSIAVMAccessPolicy:
        """
        Gets a SIA VM policy by id.

        Args:
            policy_request (ArkUAPGetPolicyRequest): _description_

        Raises:
            ArkServiceException: _description_


        Returns:
            ArkUAPSIAVMAccessPolicy: the request policy.
        """
        return ArkUAPSIAVMAccessPolicy.deserialize_model(self._base_policy(policy_request=policy_request))

    def update_policy(self, update_policy: ArkUAPSIAVMAccessPolicy) -> ArkUAPSIAVMAccessPolicy:
        """
        Edits an existing SIA VM policy with the given information.

        Args:
            update_policy (ArkUAPSIAVMAccessPolicy): The policy to be edited.

        Raises:
            ArkServiceException: _description_

        """
        self._base_update_policy(
            update_policy=update_policy.serialize_model(by_alias=True, exclude_none=True),
            policy_id=update_policy.metadata.policy_id,
        )

        return self.policy(ArkUAPGetPolicyRequest(policy_id=update_policy.metadata.policy_id))

    def list_policies(self) -> ArkUAPPolicyResultsResponse:
        """
         Retrieves all SIA VM policies.

        Raises:
         ArkServiceException: If failed to get all policies.

         Returns:
             ArkUAPPolicyResultsResponse: The response containing all SIA VM policies.
        """
        return self._base_list_policies(ArkUAPFilters(target_category=[ArkCategoryType.VM]))

    def list_policies_by(self, policies_filter: ArkUAPSIAVMFilters) -> ArkUAPPolicyResultsResponse:
        """
        Retrieves SIA VM policies based on the provided filters.

        Args:
            policies_filter (ArkUAPSIAVMFilters): The filters to apply when retrieving policies.

        Raises:
            ArkServiceException: _description_

        Returns:
            ArkUAPPolicyResultsResponse: The response containing the filtered policies.
        """
        return self._base_list_policies(ark_uap_filter=policies_filter)

    def policies_stats(self) -> ArkUAPPoliciesStats:
        """
        Calculates SIA VM policies statistics

        Raises:
            ArkServiceException: _description_

        Returns:
            ArkUAPPoliciesStats: Summary of SIA VM policies by status and provider.
        """
        return self._base_policies_stats(ArkUAPSIAVMFilters(target_category=[ArkCategoryType.VM]))

    @staticmethod
    def service_config() -> ArkServiceConfig:
        return SERVICE_CONFIG

add_policy(add_policy)

Adds a new SIA VM policy with the given information.

Parameters:

Name Type Description Default
add_policy ArkUAPSIAVMAccessPolicy

The policy to be added.

 required

Raises:

Type Description
ArkServiceException

description

Returns:

Name Type Description
ArkUAPResponse ArkUAPSIAVMAccessPolicy

description
Source code in ark_sdk_python/services/uap/sia/vm/ark_uap_sia_vm_service.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def add_policy(self, add_policy: ArkUAPSIAVMAccessPolicy) -> ArkUAPSIAVMAccessPolicy:
    """
    Adds a new SIA VM policy with the given information.

    Args:
        add_policy (ArkUAPSIAVMAccessPolicy): The policy to be added.

    Raises:
        ArkServiceException: _description_

    Returns:
        ArkUAPResponse: _description_
    """
    add_policy_response: ArkUAPResponse = self._base_add_policy(
        add_policy=add_policy.serialize_model(by_alias=True, exclude_none=True),
        policy_name=add_policy.metadata.name,
    )
    return self.policy(ArkUAPGetPolicyRequest(policy_id=add_policy_response.policy_id))

list_policies()

Retrieves all SIA VM policies.

Raises:

Type Description
ArkServiceException

If failed to get all policies.
Returns

ArkUAPPolicyResultsResponse: The response containing all SIA VM policies.
Source code in ark_sdk_python/services/uap/sia/vm/ark_uap_sia_vm_service.py 
75
76
77
78
79
80
81
82
83
84
85
def list_policies(self) -> ArkUAPPolicyResultsResponse:
    """
     Retrieves all SIA VM policies.

    Raises:
     ArkServiceException: If failed to get all policies.

     Returns:
         ArkUAPPolicyResultsResponse: The response containing all SIA VM policies.
    """
    return self._base_list_policies(ArkUAPFilters(target_category=[ArkCategoryType.VM]))

list_policies_by(policies_filter)

Retrieves SIA VM policies based on the provided filters.

Parameters:

Name Type Description Default
policies_filter ArkUAPSIAVMFilters

The filters to apply when retrieving policies.

 required

Raises:

Type Description
ArkServiceException

description

Returns:

Name Type Description
ArkUAPPolicyResultsResponse ArkUAPPolicyResultsResponse

The response containing the filtered policies.
Source code in ark_sdk_python/services/uap/sia/vm/ark_uap_sia_vm_service.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
def list_policies_by(self, policies_filter: ArkUAPSIAVMFilters) -> ArkUAPPolicyResultsResponse:
    """
    Retrieves SIA VM policies based on the provided filters.

    Args:
        policies_filter (ArkUAPSIAVMFilters): The filters to apply when retrieving policies.

    Raises:
        ArkServiceException: _description_

    Returns:
        ArkUAPPolicyResultsResponse: The response containing the filtered policies.
    """
    return self._base_list_policies(ark_uap_filter=policies_filter)

policies_stats()

Calculates SIA VM policies statistics

Raises:

Type Description
ArkServiceException

description

Returns:

Name Type Description
ArkUAPPoliciesStats ArkUAPPoliciesStats

Summary of SIA VM policies by status and provider.
Source code in ark_sdk_python/services/uap/sia/vm/ark_uap_sia_vm_service.py 
102
103
104
105
106
107
108
109
110
111
112
def policies_stats(self) -> ArkUAPPoliciesStats:
    """
    Calculates SIA VM policies statistics

    Raises:
        ArkServiceException: _description_

    Returns:
        ArkUAPPoliciesStats: Summary of SIA VM policies by status and provider.
    """
    return self._base_policies_stats(ArkUAPSIAVMFilters(target_category=[ArkCategoryType.VM]))

policy(policy_request)

Gets a SIA VM policy by id.

Parameters:

Name Type Description Default
policy_request ArkUAPGetPolicyRequest

description

 required

Raises:

Type Description
ArkServiceException

description

Returns:

Name Type Description
ArkUAPSIAVMAccessPolicy ArkUAPSIAVMAccessPolicy

the request policy.
Source code in ark_sdk_python/services/uap/sia/vm/ark_uap_sia_vm_service.py 
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
def policy(self, policy_request: ArkUAPGetPolicyRequest) -> ArkUAPSIAVMAccessPolicy:
    """
    Gets a SIA VM policy by id.

    Args:
        policy_request (ArkUAPGetPolicyRequest): _description_

    Raises:
        ArkServiceException: _description_


    Returns:
        ArkUAPSIAVMAccessPolicy: the request policy.
    """
    return ArkUAPSIAVMAccessPolicy.deserialize_model(self._base_policy(policy_request=policy_request))

update_policy(update_policy)

Edits an existing SIA VM policy with the given information.

Parameters:

Name Type Description Default
update_policy ArkUAPSIAVMAccessPolicy

The policy to be edited.

 required

Raises:

Type Description
ArkServiceException

description
Source code in ark_sdk_python/services/uap/sia/vm/ark_uap_sia_vm_service.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
def update_policy(self, update_policy: ArkUAPSIAVMAccessPolicy) -> ArkUAPSIAVMAccessPolicy:
    """
    Edits an existing SIA VM policy with the given information.

    Args:
        update_policy (ArkUAPSIAVMAccessPolicy): The policy to be edited.

    Raises:
        ArkServiceException: _description_

    """
    self._base_update_policy(
        update_policy=update_policy.serialize_model(by_alias=True, exclude_none=True),
        policy_id=update_policy.metadata.policy_id,
    )

    return self.policy(ArkUAPGetPolicyRequest(policy_id=update_policy.metadata.policy_id))