Skip to content

ark_uap_sia_vm_behavior

ArkUAPSSIAVMBehavior

Bases: ArkCamelizedModel

Defines the behavior of a virtual machine access policy, including SSH and RDP profiles.

Source code in ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_behavior.py 
54
55
56
57
58
59
60
61
62
63
64
class ArkUAPSSIAVMBehavior(ArkCamelizedModel):
    """
    Defines the behavior of a virtual machine access policy, including SSH and RDP profiles.
    """

    ssh_profile: Annotated[
        Optional[ArkUAPSSIAVMSSHProfile], Field(description='The SSH profile for this virtual machine access policy')
    ] = None
    rdp_profile: Annotated[
        Optional[ArkUAPSSIAVMRDPProfile], Field(description='The RDP profile for this virtual machine access policy')
    ] = None

ArkUAPSSIAVMDomainEphemeralUser

Bases: ArkUAPSSIAVMEphemeralUser

Defines the domain ephemeral user method related data for this virtual machine access policy.

Source code in ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_behavior.py 
26
27
28
29
30
31
class ArkUAPSSIAVMDomainEphemeralUser(ArkUAPSSIAVMEphemeralUser):
    """
    Defines the domain ephemeral user method related data for this virtual machine access policy.
    """

    assign_domain_groups: List[str] = Field(description='Predefined assigned domain groups of the user', default_factory=list)

ArkUAPSSIAVMEphemeralUser

Bases: ArkCamelizedModel

Defines the ephemeral user method related data for this virtual machine access policy.

Source code in ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_behavior.py 
17
18
19
20
21
22
23
class ArkUAPSSIAVMEphemeralUser(ArkCamelizedModel):
    """
    Defines the ephemeral user method related data for this virtual machine access policy.
    """

    assign_groups: List[str] = Field(description='Predefined assigned local groups of the user', default_factory=list)
    enable_ephemeral_user_reconnect: bool = Field(description='Whether the ephemeral user can reconnect', default=False)

ArkUAPSSIAVMRDPProfile

Bases: ArkCamelizedModel

Defines the RDP profile for this virtual machine access policy. This profile is used to connect to the VM via RDP.

Source code in ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_behavior.py 
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
class ArkUAPSSIAVMRDPProfile(ArkCamelizedModel):
    """
    Defines the RDP profile for this virtual machine access policy. This profile is used to connect to the VM via RDP.
    """

    local_ephemeral_user: Optional[ArkUAPSSIAVMEphemeralUser] = Field(description='Local ephemeral user method related data', default=None)
    domain_ephemeral_user: Optional[ArkUAPSSIAVMDomainEphemeralUser] = Field(
        description='Domain ephemeral user method related data', default=None
    )

    @model_validator(mode='after')
    @classmethod
    def validate_data(cls, values):
        if not values.domain_ephemeral_user and not values.local_ephemeral_user:
            raise ValueError('At least one of domainEphemeralUser or localEphemeralUser must be provided')
        if values.domain_ephemeral_user and values.local_ephemeral_user:
            raise ValueError('Only one of domainEphemeralUser or localEphemeralUser can be provided')
        return values

ArkUAPSSIAVMSSHProfile

Bases: ArkCamelizedModel

Defines the SSH profile for this virtual machine access policy. This profile is used to connect to the VM via SSH.

Source code in ark_sdk_python/models/services/uap/sia/vm/ark_uap_sia_vm_behavior.py 
 9
10
11
12
13
14
class ArkUAPSSIAVMSSHProfile(ArkCamelizedModel):
    """
    Defines the SSH profile for this virtual machine access policy. This profile is used to connect to the VM via SSH.
    """

    username: str = Field(description='Username which the user will connect with on the certificate')