Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::Models::HostEntity

Inherits:
Entity
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb

Overview

Represents a host entity.

Instance Attribute Summary collapse

Attributes inherited from Entity

#id, #name, #type

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ HostEntity

Returns a new instance of HostEntity.



16
17
18
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 16

def initialize
  @kind = "Host"
end

Instance Attribute Details

#additional_data ⇒ Object

will be presented to the user.

Returns:

  • A bag of custom fields that should be part of the entity and



24
25
26
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 24

def additional_data
  @additional_data
end

#azure_id ⇒ String

Returns The azure resource id of the VM.

Returns:

  • (String) —

    The azure resource id of the VM.



32
33
34
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 32

def azure_id
  @azure_id
end

#dns_domain ⇒ String

contain the compete DNS suffix for the domain

Returns:

  • (String) —

    The DNS domain that this host belongs to. Should



36
37
38
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 36

def dns_domain
  @dns_domain
end

#friendly_name ⇒ String

readable description of the graph item instance. This property is optional and might be system generated.

Returns:

  • (String) —

    The graph item display name which is a short humanly



29
30
31
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 29

def friendly_name
  @friendly_name
end

#host_name ⇒ String

Returns The hostname without the domain suffix.

Returns:

  • (String) —

    The hostname without the domain suffix.



39
40
41
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 39

def host_name
  @host_name
end

#is_domain_joined ⇒ Boolean

Returns Determines whether this host belongs to a domain.

Returns:

  • (Boolean) —

    Determines whether this host belongs to a domain.



42
43
44
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 42

def is_domain_joined
  @is_domain_joined
end

#kind ⇒ Object

Returns the value of attribute kind.



20
21
22
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 20

def kind
  @kind
end

#net_bios_name ⇒ String

Returns The host name (pre-windows2000).

Returns:

  • (String) —

    The host name (pre-windows2000).



45
46
47
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 45

def net_bios_name
  @net_bios_name
end

#nt_domain ⇒ String

Returns The NT domain that this host belongs to.

Returns:

  • (String) —

    The NT domain that this host belongs to.



48
49
50
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 48

def nt_domain
  @nt_domain
end

#oms_agent_id ⇒ String

Returns The OMS agent id, if the host has OMS agent installed.

Returns:

  • (String) —

    The OMS agent id, if the host has OMS agent installed.



51
52
53
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 51

def oms_agent_id
  @oms_agent_id
end

#os_family ⇒ OSFamily

‘Linux’, ‘Windows’, ‘Android’, ‘IOS’

Returns:

  • (OSFamily) —

    The operating system type. Possible values include:



55
56
57
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 55

def os_family
  @os_family
end

#os_version ⇒ String

This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration

Returns:

  • (String) —

    A free text representation of the operating system.



60
61
62
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 60

def os_version
  @os_version
end

Class Method Details

.mapper ⇒ Object

Mapper for HostEntity class as Ruby Hash. This will be used for serialization/deserialization.



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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/models/host_entity.rb', line 67

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Host',
    type: {
      name: 'Composite',
      class_name: 'HostEntity',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        kind: {
          client_side_validation: true,
          required: true,
          serialized_name: 'kind',
          type: {
            name: 'String'
          }
        },
        additional_data: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.additionalData',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ObjectElementType',
                type: {
                  name: 'Object'
                }
            }
          }
        },
        friendly_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.friendlyName',
          type: {
            name: 'String'
          }
        },
        azure_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.azureID',
          type: {
            name: 'String'
          }
        },
        dns_domain: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.dnsDomain',
          type: {
            name: 'String'
          }
        },
        host_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.hostName',
          type: {
            name: 'String'
          }
        },
        is_domain_joined: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.isDomainJoined',
          type: {
            name: 'Boolean'
          }
        },
        net_bios_name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.netBiosName',
          type: {
            name: 'String'
          }
        },
        nt_domain: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.ntDomain',
          type: {
            name: 'String'
          }
        },
        oms_agent_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.omsAgentID',
          type: {
            name: 'String'
          }
        },
        os_family: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.osFamily',
          type: {
            name: 'Enum',
            module: 'OSFamily'
          }
        },
        os_version: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.osVersion',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end