Class: Azure::Security::Mgmt::V2020_07_01_preview::SqlVulnerabilityAssessmentScans

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ SqlVulnerabilityAssessmentScans

Creates and initializes a new instance of the SqlVulnerabilityAssessmentScans class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get(scan_id, workspace_id, api_version, resource_id, custom_headers: nil) ⇒ Scan

Gets the scan details of a single scan record.

the latest scan. will be added to the HTTP request.

Parameters:

  • scan_id (String) —

    The scan Id. Type ‘latest’ to get the scan record for

  • workspace_id (String) —

    The workspace Id.

  • api_version (String) —

    The api version.

  • resource_id (String) —

    The identifier of the resource.

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

    A hash of custom headers that

Returns:

  • (Scan) —

    operation results.



37
38
39
40
 
# File 'lib/2020-07-01-preview/generated/azure_mgmt_security/sql_vulnerability_assessment_scans.rb', line 37

def get(scan_id, workspace_id, api_version, resource_id, custom_headers:nil)
  response = get_async(scan_id, workspace_id, api_version, resource_id, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(scan_id, workspace_id, api_version, resource_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets the scan details of a single scan record.

the latest scan. to the HTTP request.

Parameters:

  • scan_id (String) —

    The scan Id. Type ‘latest’ to get the scan record for

  • workspace_id (String) —

    The workspace Id.

  • api_version (String) —

    The api version.

  • resource_id (String) —

    The identifier of the resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2020-07-01-preview/generated/azure_mgmt_security/sql_vulnerability_assessment_scans.rb', line 72

def get_async(scan_id, workspace_id, api_version, resource_id, custom_headers:nil)
  fail ArgumentError, 'scan_id is nil' if scan_id.nil?
  fail ArgumentError, 'workspace_id is nil' if workspace_id.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'resource_id is nil' if resource_id.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 = '{resourceId}/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans/{scanId}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'scanId' => scan_id},
      skip_encoding_path_params: {'resourceId' => resource_id},
      query_params: {'workspaceId' => workspace_id,'api-version' => 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_07_01_preview::Models::Scan.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(scan_id, workspace_id, api_version, resource_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the scan details of a single scan record.

the latest scan. will be added to the HTTP request.

Parameters:

  • scan_id (String) —

    The scan Id. Type ‘latest’ to get the scan record for

  • workspace_id (String) —

    The workspace Id.

  • api_version (String) —

    The api version.

  • resource_id (String) —

    The identifier of the resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2020-07-01-preview/generated/azure_mgmt_security/sql_vulnerability_assessment_scans.rb', line 55

def get_with_http_info(scan_id, workspace_id, api_version, resource_id, custom_headers:nil)
  get_async(scan_id, workspace_id, api_version, resource_id, custom_headers:custom_headers).value!
end

#list(workspace_id, api_version, resource_id, custom_headers: nil) ⇒ Scans

Gets a list of scan records.

will be added to the HTTP request.

Parameters:

  • workspace_id (String) —

    The workspace Id.

  • api_version (String) —

    The api version.

  • resource_id (String) —

    The identifier of the resource.

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

    A hash of custom headers that

Returns:

  • (Scans) —

    operation results.



139
140
141
142
 
# File 'lib/2020-07-01-preview/generated/azure_mgmt_security/sql_vulnerability_assessment_scans.rb', line 139

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

#list_async(workspace_id, api_version, resource_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets a list of scan records.

to the HTTP request.

Parameters:

  • workspace_id (String) —

    The workspace Id.

  • api_version (String) —

    The api version.

  • resource_id (String) —

    The identifier of the resource.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
222
 
# File 'lib/2020-07-01-preview/generated/azure_mgmt_security/sql_vulnerability_assessment_scans.rb', line 170

def list_async(workspace_id, api_version, resource_id, custom_headers:nil)
  fail ArgumentError, 'workspace_id is nil' if workspace_id.nil?
  fail ArgumentError, 'api_version is nil' if api_version.nil?
  fail ArgumentError, 'resource_id is nil' if resource_id.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 = '{resourceId}/providers/Microsoft.Security/sqlVulnerabilityAssessments/default/scans'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      skip_encoding_path_params: {'resourceId' => resource_id},
      query_params: {'workspaceId' => workspace_id,'api-version' => 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_07_01_preview::Models::Scans.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(workspace_id, api_version, resource_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a list of scan records.

will be added to the HTTP request.

Parameters:

  • workspace_id (String) —

    The workspace Id.

  • api_version (String) —

    The api version.

  • resource_id (String) —

    The identifier of the resource.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



155
156
157
 
# File 'lib/2020-07-01-preview/generated/azure_mgmt_security/sql_vulnerability_assessment_scans.rb', line 155

def list_with_http_info(workspace_id, api_version, resource_id, custom_headers:nil)
  list_async(workspace_id, api_version, resource_id, custom_headers:custom_headers).value!
end