Class: Azure::Security::Mgmt::V2020_08_06_preview::IotSensors

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb

Overview

API spec for Microsoft.Security (Azure Security Center) resource provider

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ IotSensors

Creates and initializes a new instance of the IotSensors class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SecurityCenter (readonly)

Returns reference to the SecurityCenter.

Returns:



22
23
24
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(scope, iot_sensor_name, custom_headers: nil) ⇒ IotSensor

Create or update IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (IotSensor) —

    operation results.



224
225
226
227
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 224

def create_or_update(scope, iot_sensor_name, custom_headers:nil)
  response = create_or_update_async(scope, iot_sensor_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(scope, iot_sensor_name, custom_headers: nil) ⇒ Concurrent::Promise

Create or update IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 255

def create_or_update_async(scope, iot_sensor_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'iot_sensor_name is nil' if iot_sensor_name.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'iotSensorName' => iot_sensor_name},
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:put, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 201
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Security::Mgmt::V2020_08_06_preview::Models::IotSensor.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Security::Mgmt::V2020_08_06_preview::Models::IotSensor.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#create_or_update_with_http_info(scope, iot_sensor_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create or update IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



240
241
242
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 240

def create_or_update_with_http_info(scope, iot_sensor_name, custom_headers:nil)
  create_or_update_async(scope, iot_sensor_name, custom_headers:custom_headers).value!
end

#delete(scope, iot_sensor_name, custom_headers: nil) ⇒ Object

Delete IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that



330
331
332
333
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 330

def delete(scope, iot_sensor_name, custom_headers:nil)
  response = delete_async(scope, iot_sensor_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(scope, iot_sensor_name, custom_headers: nil) ⇒ Concurrent::Promise

Delete IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 361

def delete_async(scope, iot_sensor_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'iot_sensor_name is nil' if iot_sensor_name.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'iotSensorName' => iot_sensor_name},
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200 || status_code == 204
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

#delete_with_http_info(scope, iot_sensor_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



346
347
348
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 346

def delete_with_http_info(scope, iot_sensor_name, custom_headers:nil)
  delete_async(scope, iot_sensor_name, custom_headers:custom_headers).value!
end

#download_activation(scope, iot_sensor_name, custom_headers: nil) ⇒ NOT_IMPLEMENTED

Download sensor activation file

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (NOT_IMPLEMENTED) —

    operation results.



417
418
419
420
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 417

def download_activation(scope, iot_sensor_name, custom_headers:nil)
  response = download_activation_async(scope, iot_sensor_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#download_activation_async(scope, iot_sensor_name, custom_headers: nil) ⇒ Concurrent::Promise

Download sensor activation file

/providers/Microsoft.Devices/iotHubs/myHub) to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 448

def download_activation_async(scope, iot_sensor_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'iot_sensor_name is nil' if iot_sensor_name.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}/downloadActivation'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'iotSensorName' => iot_sensor_name},
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Stream'
          }
        }
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#download_activation_with_http_info(scope, iot_sensor_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Download sensor activation file

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



433
434
435
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 433

def download_activation_with_http_info(scope, iot_sensor_name, custom_headers:nil)
  download_activation_async(scope, iot_sensor_name, custom_headers:custom_headers).value!
end

#get(scope, iot_sensor_name, custom_headers: nil) ⇒ IotSensor

Get IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (IotSensor) —

    operation results.



127
128
129
130
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 127

def get(scope, iot_sensor_name, custom_headers:nil)
  response = get_async(scope, iot_sensor_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(scope, iot_sensor_name, custom_headers: nil) ⇒ Concurrent::Promise

Get IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 158

def get_async(scope, iot_sensor_name, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.nil?
  fail ArgumentError, 'iot_sensor_name is nil' if iot_sensor_name.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{scope}/providers/Microsoft.Security/iotSensors/{iotSensorName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'iotSensorName' => iot_sensor_name},
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Security::Mgmt::V2020_08_06_preview::Models::IotSensor.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#get_with_http_info(scope, iot_sensor_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get IoT sensor

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • iot_sensor_name (String) —

    Name of the IoT sensor

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



143
144
145
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 143

def get_with_http_info(scope, iot_sensor_name, custom_headers:nil)
  get_async(scope, iot_sensor_name, custom_headers:custom_headers).value!
end

#list(scope, custom_headers: nil) ⇒ IotSensorsList

List IoT sensors

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (IotSensorsList) —

    operation results.



34
35
36
37
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 34

def list(scope, custom_headers:nil)
  response = list_async(scope, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_async(scope, custom_headers: nil) ⇒ Concurrent::Promise

List IoT sensors

/providers/Microsoft.Devices/iotHubs/myHub) to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • A (Hash{String => String}) —

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 63

def list_async(scope, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'scope is nil' if scope.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = '{scope}/providers/Microsoft.Security/iotSensors'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'scope' => scope},
      query_params: {'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:get, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail MsRestAzure::AzureOperationError.new(result.request, http_response, error_model)
    end

    result.request_id = http_response['x-ms-request-id'] unless http_response['x-ms-request-id'].nil?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Security::Mgmt::V2020_08_06_preview::Models::IotSensorsList.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_with_http_info(scope, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

List IoT sensors

/providers/Microsoft.Devices/iotHubs/myHub) will be added to the HTTP request.

Parameters:

  • scope (String) —

    Scope of the query (IoT Hub,

  • custom_headers (Hash{String => String}) (defaults to: nil) —

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



49
50
51
 
# File 'lib/2020-08-06-preview/generated/azure_mgmt_security/iot_sensors.rb', line 49

def list_with_http_info(scope, custom_headers:nil)
  list_async(scope, custom_headers:custom_headers).value!
end