Class: Azure::SecurityInsights::Mgmt::V2019_01_01_preview::Actions

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

Overview

API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Actions

Creates and initializes a new instance of the Actions class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/actions.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ SecurityInsights (readonly)

Returns reference to the SecurityInsights.

Returns:



23
24
25
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/actions.rb', line 23

def client
  @client
end

Instance Method Details

#list_by_alert_rule(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers: nil) ⇒ Array<ActionResponse>

Gets all actions of alert rule.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • rule_id (String) —

    Alert rule ID

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

    A hash of custom headers that

Returns:

  • (Array<ActionResponse>) —

    operation results.



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

def list_by_alert_rule(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers:nil)
  first_page = list_by_alert_rule_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_alert_rule_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers: nil) ⇒ ActionsList

Gets all actions of alert rule.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • rule_id (String) —

    Alert rule ID

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

    A hash of custom headers that

Returns:

  • (ActionsList) —

    which provide lazy access to pages of the response.



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/actions.rb', line 243

def list_by_alert_rule_as_lazy(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers:nil)
  response = list_by_alert_rule_async(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_alert_rule_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_alert_rule_async(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers: nil) ⇒ Concurrent::Promise

Gets all actions of alert rule.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • rule_id (String) —

    Alert rule ID

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/actions.rb', line 76

def list_by_alert_rule_async(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers:nil)
  @client.api_version = '2019-01-01-preview'
  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, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'operational_insights_resource_provider is nil' if operational_insights_resource_provider.nil?
  fail ArgumentError, 'workspace_name is nil' if workspace_name.nil?
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MaxLength': '90'" if !workspace_name.nil? && workspace_name.length > 90
  fail ArgumentError, "'workspace_name' should satisfy the constraint - 'MinLength': '1'" if !workspace_name.nil? && workspace_name.length < 1
  fail ArgumentError, 'rule_id is nil' if rule_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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{operationalInsightsResourceProvider}/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'operationalInsightsResourceProvider' => operational_insights_resource_provider,'workspaceName' => workspace_name,'ruleId' => rule_id},
      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::SecurityInsights::Mgmt::V2019_01_01_preview::Models::ActionsList.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_alert_rule_next(next_page_link, custom_headers: nil) ⇒ ActionsList

Gets all actions of alert rule.

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:

  • (ActionsList) —

    operation results.



149
150
151
152
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/actions.rb', line 149

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

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

Gets all actions of alert rule.

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.



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
223
224
225
226
227
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/actions.rb', line 178

def list_by_alert_rule_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::SecurityInsights::Mgmt::V2019_01_01_preview::Models::ActionsList.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_alert_rule_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all actions of alert rule.

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.



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

def list_by_alert_rule_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_alert_rule_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_alert_rule_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets all actions of alert rule.

user’s subscription. The name is case insensitive. workspaces resource provider- Microsoft.OperationalInsights. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group within the

  • operational_insights_resource_provider (String) —

    The namespace of

  • workspace_name (String) —

    The name of the workspace.

  • rule_id (String) —

    Alert rule ID

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



58
59
60
 
# File 'lib/2019-01-01-preview/generated/azure_mgmt_security_insights/actions.rb', line 58

def list_by_alert_rule_with_http_info(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers:nil)
  list_by_alert_rule_async(resource_group_name, operational_insights_resource_provider, workspace_name, rule_id, custom_headers:custom_headers).value!
end