Class: Azure::ADHybridHealthService::Mgmt::V2014_01_01::AlertsOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb

Overview

REST APIs for Azure Active Directory Connect Health

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AlertsOperations

Creates and initializes a new instance of the AlertsOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ ADHybridHealthService (readonly)

Returns reference to the ADHybridHealthService.

Returns:



22
23
24
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 22

def client
  @client
end

Instance Method Details

#list_adds_alerts(service_name, filter: nil, state: nil, from: nil, to: nil, custom_headers: nil) ⇒ Array<Alert>

Gets the alerts for a given Active Directory Domain Service.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The alert property filter to apply.

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

    The alert state to query for.

  • from (DateTime) (defaults to: nil) —

    The start date to query for.

  • to (DateTime) (defaults to: nil) —

    The end date till when to query for.

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

    A hash of custom headers that

Returns:

  • (Array<Alert>) —

    operation results.



37
38
39
40
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 37

def list_adds_alerts(service_name, filter:nil, state:nil, from:nil, to:nil, custom_headers:nil)
  first_page = list_adds_alerts_as_lazy(service_name, filter:filter, state:state, from:from, to:to, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_adds_alerts_as_lazy(service_name, filter: nil, state: nil, from: nil, to: nil, custom_headers: nil) ⇒ Alerts

Gets the alerts for a given Active Directory Domain Service.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The alert property filter to apply.

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

    The alert state to query for.

  • from (DateTime) (defaults to: nil) —

    The start date to query for.

  • to (DateTime) (defaults to: nil) —

    The end date till when to query for.

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

    A hash of custom headers that

Returns:

  • (Alerts) —

    which provide lazy access to pages of the response.



228
229
230
231
232
233
234
235
236
237
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 228

def list_adds_alerts_as_lazy(service_name, filter:nil, state:nil, from:nil, to:nil, custom_headers:nil)
  response = list_adds_alerts_async(service_name, filter:filter, state:state, from:from, to:to, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_adds_alerts_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_adds_alerts_async(service_name, filter: nil, state: nil, from: nil, to: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets the alerts for a given Active Directory Domain Service.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The alert property filter to apply.

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

    The alert state to query for.

  • from (DateTime) (defaults to: nil) —

    The start date to query for.

  • to (DateTime) (defaults to: nil) —

    The end date till when to query for.

  • 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
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 72

def list_adds_alerts_async(service_name, filter:nil, state:nil, from:nil, to:nil, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.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 = 'providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/alerts'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name},
      query_params: {'$filter' => filter,'state' => state,'from' => from,'to' => to,'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::ADHybridHealthService::Mgmt::V2014_01_01::Models::Alerts.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_adds_alerts_next(next_page_link, custom_headers: nil) ⇒ Alerts

Gets the alerts for a given Active Directory Domain Service.

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:

  • (Alerts) —

    operation results.



135
136
137
138
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 135

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

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

Gets the alerts for a given Active Directory Domain Service.

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.



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
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 164

def list_adds_alerts_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::ADHybridHealthService::Mgmt::V2014_01_01::Models::Alerts.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_adds_alerts_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the alerts for a given Active Directory Domain Service.

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.



150
151
152
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 150

def list_adds_alerts_next_with_http_info(next_page_link, custom_headers:nil)
  list_adds_alerts_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_adds_alerts_with_http_info(service_name, filter: nil, state: nil, from: nil, to: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the alerts for a given Active Directory Domain Service.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The alert property filter to apply.

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

    The alert state to query for.

  • from (DateTime) (defaults to: nil) —

    The start date to query for.

  • to (DateTime) (defaults to: nil) —

    The end date till when to query for.

  • 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/2014-01-01/generated/azure_mgmt_adhybridhealth_service/alerts_operations.rb', line 55

def list_adds_alerts_with_http_info(service_name, filter:nil, state:nil, from:nil, to:nil, custom_headers:nil)
  list_adds_alerts_async(service_name, filter:filter, state:state, from:from, to:to, custom_headers:custom_headers).value!
end