Class: Azure::Security::Mgmt::V2019_01_01_preview::RegulatoryComplianceAssessments

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RegulatoryComplianceAssessments

Creates and initializes a new instance of the RegulatoryComplianceAssessments class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, custom_headers: nil) ⇒ RegulatoryComplianceAssessment

Supported regulatory compliance details and state for selected assessment

compliance standard object compliance control object compliance assessment object will be added to the HTTP request.

Parameters:

  • regulatory_compliance_standard_name (String) —

    Name of the regulatory

  • regulatory_compliance_control_name (String) —

    Name of the regulatory

  • regulatory_compliance_assessment_name (String) —

    Name of the regulatory

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

    A hash of custom headers that

Returns:

  • (RegulatoryComplianceAssessment) —

    operation results.



145
146
147
148
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 145

def get(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, custom_headers:nil)
  response = get_async(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, custom_headers: nil) ⇒ Concurrent::Promise

Supported regulatory compliance details and state for selected assessment

compliance standard object compliance control object compliance assessment object to the HTTP request.

Parameters:

  • regulatory_compliance_standard_name (String) —

    Name of the regulatory

  • regulatory_compliance_control_name (String) —

    Name of the regulatory

  • regulatory_compliance_assessment_name (String) —

    Name of the regulatory

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 182

def get_async(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, 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, 'regulatory_compliance_standard_name is nil' if regulatory_compliance_standard_name.nil?
  fail ArgumentError, 'regulatory_compliance_control_name is nil' if regulatory_compliance_control_name.nil?
  fail ArgumentError, 'regulatory_compliance_assessment_name is nil' if regulatory_compliance_assessment_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/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}/regulatoryComplianceAssessments/{regulatoryComplianceAssessmentName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'regulatoryComplianceStandardName' => regulatory_compliance_standard_name,'regulatoryComplianceControlName' => regulatory_compliance_control_name,'regulatoryComplianceAssessmentName' => regulatory_compliance_assessment_name},
      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::V2019_01_01_preview::Models::RegulatoryComplianceAssessment.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(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Supported regulatory compliance details and state for selected assessment

compliance standard object compliance control object compliance assessment object will be added to the HTTP request.

Parameters:

  • regulatory_compliance_standard_name (String) —

    Name of the regulatory

  • regulatory_compliance_control_name (String) —

    Name of the regulatory

  • regulatory_compliance_assessment_name (String) —

    Name of the regulatory

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



164
165
166
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 164

def get_with_http_info(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, custom_headers:nil)
  get_async(regulatory_compliance_standard_name, regulatory_compliance_control_name, regulatory_compliance_assessment_name, custom_headers:custom_headers).value!
end

#list(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter: nil, custom_headers: nil) ⇒ Array<RegulatoryComplianceAssessment>

Details and state of assessments mapped to selected regulatory compliance control

compliance standard object compliance control object will be added to the HTTP request.

Parameters:

  • regulatory_compliance_standard_name (String) —

    Name of the regulatory

  • regulatory_compliance_control_name (String) —

    Name of the regulatory

  • filter (String) (defaults to: nil) —

    OData filter. Optional.

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

    A hash of custom headers that

Returns:

  • (Array<RegulatoryComplianceAssessment>) —

    operation results.



38
39
40
41
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 38

def list(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter:nil, custom_headers:nil)
  first_page = list_as_lazy(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter:filter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter: nil, custom_headers: nil) ⇒ RegulatoryComplianceAssessmentList

Details and state of assessments mapped to selected regulatory compliance control

compliance standard object compliance control object will be added to the HTTP request.

pages of the response.

Parameters:

  • regulatory_compliance_standard_name (String) —

    Name of the regulatory

  • regulatory_compliance_control_name (String) —

    Name of the regulatory

  • filter (String) (defaults to: nil) —

    OData filter. Optional.

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

    A hash of custom headers that

Returns:

  • (RegulatoryComplianceAssessmentList) —

    which provide lazy access to



347
348
349
350
351
352
353
354
355
356
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 347

def list_as_lazy(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter:nil, custom_headers:nil)
  response = list_async(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter:filter, 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(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Details and state of assessments mapped to selected regulatory compliance control

compliance standard object compliance control object to the HTTP request.

Parameters:

  • regulatory_compliance_standard_name (String) —

    Name of the regulatory

  • regulatory_compliance_control_name (String) —

    Name of the regulatory

  • filter (String) (defaults to: nil) —

    OData filter. Optional.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 75

def list_async(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter: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, 'regulatory_compliance_standard_name is nil' if regulatory_compliance_standard_name.nil?
  fail ArgumentError, 'regulatory_compliance_control_name is nil' if regulatory_compliance_control_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/regulatoryComplianceStandards/{regulatoryComplianceStandardName}/regulatoryComplianceControls/{regulatoryComplianceControlName}/regulatoryComplianceAssessments'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'regulatoryComplianceStandardName' => regulatory_compliance_standard_name,'regulatoryComplianceControlName' => regulatory_compliance_control_name},
      query_params: {'api-version' => @client.api_version,'$filter' => filter},
      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::V2019_01_01_preview::Models::RegulatoryComplianceAssessmentList.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(next_page_link, custom_headers: nil) ⇒ RegulatoryComplianceAssessmentList

Details and state of assessments mapped to selected regulatory compliance control

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:

  • (RegulatoryComplianceAssessmentList) —

    operation results.



250
251
252
253
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 250

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

Details and state of assessments mapped to selected regulatory compliance control

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.



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
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 281

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::V2019_01_01_preview::Models::RegulatoryComplianceAssessmentList.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

Details and state of assessments mapped to selected regulatory compliance control

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.



266
267
268
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 266

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(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Details and state of assessments mapped to selected regulatory compliance control

compliance standard object compliance control object will be added to the HTTP request.

Parameters:

  • regulatory_compliance_standard_name (String) —

    Name of the regulatory

  • regulatory_compliance_control_name (String) —

    Name of the regulatory

  • filter (String) (defaults to: nil) —

    OData filter. Optional.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



57
58
59
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security/regulatory_compliance_assessments.rb', line 57

def list_with_http_info(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter:nil, custom_headers:nil)
  list_async(regulatory_compliance_standard_name, regulatory_compliance_control_name, filter:filter, custom_headers:custom_headers).value!
end