Class: Azure::Security::Mgmt::V2020_01_01::SecureScoreControls

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SecureScoreControls

Creates and initializes a new instance of the SecureScoreControls class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.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-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 22

def client
  @client
end

Instance Method Details

#list(expand: nil, custom_headers: nil) ⇒ Array<SecureScoreControlDetails>

Get all security controls within a scope

include: ‘definition’ will be added to the HTTP request.

Parameters:

  • expand (ExpandControlsEnum) (defaults to: nil) —

    OData expand. Optional. Possible values

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

    A hash of custom headers that

Returns:

  • (Array<SecureScoreControlDetails>) —

    operation results.



134
135
136
137
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 134

def list(expand:nil, custom_headers:nil)
  first_page = list_as_lazy(expand:expand, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(expand: nil, custom_headers: nil) ⇒ SecureScoreControlList

Get all security controls within a scope

include: ‘definition’ will be added to the HTTP request.

response.

Parameters:

  • expand (ExpandControlsEnum) (defaults to: nil) —

    OData expand. Optional. Possible values

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

    A hash of custom headers that

Returns:

  • (SecureScoreControlList) —

    which provide lazy access to pages of the



432
433
434
435
436
437
438
439
440
441
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 432

def list_as_lazy(expand:nil, custom_headers:nil)
  response = list_async(expand:expand, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Get all security controls within a scope

include: ‘definition’ to the HTTP request.

Parameters:

  • expand (ExpandControlsEnum) (defaults to: nil) —

    OData expand. Optional. Possible values

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 163

def list_async(expand:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).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 = 'subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScoreControls'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id},
      query_params: {'api-version' => @client.api_version,'$expand' => expand},
      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_01_01::Models::SecureScoreControlList.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_by_secure_score(secure_score_name, expand: nil, custom_headers: nil) ⇒ Array<SecureScoreControlDetails>

Get all security controls for a specific initiative within a scope

initiative, use ‘ascScore’ as in the sample request below. include: ‘definition’ will be added to the HTTP request.

Parameters:

  • secure_score_name (String) —

    The initiative name. For the ASC Default

  • expand (ExpandControlsEnum) (defaults to: nil) —

    OData expand. Optional. Possible values

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

    A hash of custom headers that

Returns:

  • (Array<SecureScoreControlDetails>) —

    operation results.



36
37
38
39
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 36

def list_by_secure_score(secure_score_name, expand:nil, custom_headers:nil)
  first_page = list_by_secure_score_as_lazy(secure_score_name, expand:expand, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_secure_score_as_lazy(secure_score_name, expand: nil, custom_headers: nil) ⇒ SecureScoreControlList

Get all security controls for a specific initiative within a scope

initiative, use ‘ascScore’ as in the sample request below. include: ‘definition’ will be added to the HTTP request.

response.

Parameters:

  • secure_score_name (String) —

    The initiative name. For the ASC Default

  • expand (ExpandControlsEnum) (defaults to: nil) —

    OData expand. Optional. Possible values

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

    A hash of custom headers that

Returns:

  • (SecureScoreControlList) —

    which provide lazy access to pages of the



410
411
412
413
414
415
416
417
418
419
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 410

def list_by_secure_score_as_lazy(secure_score_name, expand:nil, custom_headers:nil)
  response = list_by_secure_score_async(secure_score_name, expand:expand, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_secure_score_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_secure_score_async(secure_score_name, expand: nil, custom_headers: nil) ⇒ Concurrent::Promise

Get all security controls for a specific initiative within a scope

initiative, use ‘ascScore’ as in the sample request below. include: ‘definition’ to the HTTP request.

Parameters:

  • secure_score_name (String) —

    The initiative name. For the ASC Default

  • expand (ExpandControlsEnum) (defaults to: nil) —

    OData expand. Optional. Possible values

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 69

def list_by_secure_score_async(secure_score_name, expand:nil, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, "'@client.subscription_id' should satisfy the constraint - 'Pattern': '^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$'" if !@client.subscription_id.nil? && @client.subscription_id.match(Regexp.new('^^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$$')).nil?
  fail ArgumentError, 'secure_score_name is nil' if secure_score_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 = 'subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScores/{secureScoreName}/secureScoreControls'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'secureScoreName' => secure_score_name},
      query_params: {'api-version' => @client.api_version,'$expand' => expand},
      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_01_01::Models::SecureScoreControlList.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_by_secure_score_next(next_page_link, custom_headers: nil) ⇒ SecureScoreControlList

Get all security controls for a specific initiative within a scope

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (SecureScoreControlList) —

    operation results.



227
228
229
230
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 227

def list_by_secure_score_next(next_page_link, custom_headers:nil)
  response = list_by_secure_score_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_by_secure_score_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Get all security controls for a specific initiative within a scope

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 256

def list_by_secure_score_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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_01_01::Models::SecureScoreControlList.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_by_secure_score_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get all security controls for a specific initiative within a scope

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



242
243
244
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 242

def list_by_secure_score_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_secure_score_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_secure_score_with_http_info(secure_score_name, expand: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get all security controls for a specific initiative within a scope

initiative, use ‘ascScore’ as in the sample request below. include: ‘definition’ will be added to the HTTP request.

Parameters:

  • secure_score_name (String) —

    The initiative name. For the ASC Default

  • expand (ExpandControlsEnum) (defaults to: nil) —

    OData expand. Optional. Possible values

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



53
54
55
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 53

def list_by_secure_score_with_http_info(secure_score_name, expand:nil, custom_headers:nil)
  list_by_secure_score_async(secure_score_name, expand:expand, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ SecureScoreControlList

Get all security controls within a scope

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (SecureScoreControlList) —

    operation results.



317
318
319
320
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 317

def list_next(next_page_link, custom_headers:nil)
  response = list_next_async(next_page_link, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_next_async(next_page_link, custom_headers: nil) ⇒ Concurrent::Promise

Get all security controls within a scope

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
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
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 346

def list_next_async(next_page_link, custom_headers:nil)
  fail ArgumentError, 'next_page_link is nil' if next_page_link.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 = '{nextLink}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'nextLink' => next_page_link},
      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_01_01::Models::SecureScoreControlList.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_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Get all security controls within a scope

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



332
333
334
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 332

def list_next_with_http_info(next_page_link, custom_headers:nil)
  list_next_async(next_page_link, custom_headers:custom_headers).value!
end

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

Get all security controls within a scope

include: ‘definition’ will be added to the HTTP request.

Parameters:

  • expand (ExpandControlsEnum) (defaults to: nil) —

    OData expand. Optional. Possible values

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



149
150
151
 
# File 'lib/2020-01-01/generated/azure_mgmt_security/secure_score_controls.rb', line 149

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