Class: Azure::ADHybridHealthService::Mgmt::V2014_01_01::AddsServices

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

Overview

REST APIs for Azure Active Directory Connect Health

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AddsServices

Creates and initializes a new instance of the AddsServices class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.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/adds_services.rb', line 22

def client
  @client
end

Instance Method Details

#add(service, custom_headers: nil) ⇒ ServiceProperties

Onboards a service for a given tenant in Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

  • service (ServiceProperties) —

    The service object.

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

    A hash of custom headers that

Returns:

  • (ServiceProperties) —

    operation results.



151
152
153
154
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 151

def add(service, custom_headers:nil)
  response = add_async(service, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#add_async(service, custom_headers: nil) ⇒ Concurrent::Promise

Onboards a service for a given tenant in Azure Active Directory Connect Health.

to the HTTP request.

Parameters:

  • service (ServiceProperties) —

    The service object.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 180

def add_async(service, custom_headers:nil)
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'service is nil' if service.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?

  # Serialize Request
  request_mapper = Azure::ADHybridHealthService::Mgmt::V2014_01_01::Models::ServiceProperties.mapper()
  request_content = @client.serialize(request_mapper,  service)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.ADHybridHealthService/addsservices'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:post, 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::ServiceProperties.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

#add_with_http_info(service, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Onboards a service for a given tenant in Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

  • service (ServiceProperties) —

    The service object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



166
167
168
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 166

def add_with_http_info(service, custom_headers:nil)
  add_async(service, custom_headers:custom_headers).value!
end

#delete(service_name, confirm: nil, custom_headers: nil) ⇒ Object

Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.

deleted. or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service which needs to be

  • confirm (Boolean) (defaults to: nil) —

    Indicates if the service will be permanently deleted

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

    A hash of custom headers that



348
349
350
351
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 348

def delete(service_name, confirm:nil, custom_headers:nil)
  response = delete_async(service_name, confirm:confirm, custom_headers:custom_headers).value!
  nil
end

#delete_async(service_name, confirm: nil, custom_headers: nil) ⇒ Concurrent::Promise

Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.

deleted. or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered. to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service which needs to be

  • confirm (Boolean) (defaults to: nil) —

    Indicates if the service will be permanently deleted

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 387

def delete_async(service_name, confirm: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}'

  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: {'confirm' => confirm,'api-version' => @client.api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:delete, 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 == 204
      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?

    result
  end

  promise.execute
end

#delete_with_http_info(service_name, confirm: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health.

deleted. or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service which needs to be

  • confirm (Boolean) (defaults to: nil) —

    Indicates if the service will be permanently deleted

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



368
369
370
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 368

def delete_with_http_info(service_name, confirm:nil, custom_headers:nil)
  delete_async(service_name, confirm:confirm, custom_headers:custom_headers).value!
end

#get(service_name, custom_headers: nil) ⇒ ServiceProperties

Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    A hash of custom headers that

Returns:

  • (ServiceProperties) —

    operation results.



250
251
252
253
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 250

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

#get_async(service_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • 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
331
332
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 281

def get_async(service_name, 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}'

  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: {'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::ServiceProperties.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_forest_summary(service_name, custom_headers: nil) ⇒ ForestSummary

Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    A hash of custom headers that

Returns:

  • (ForestSummary) —

    operation results.



546
547
548
549
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 546

def get_forest_summary(service_name, custom_headers:nil)
  response = get_forest_summary_async(service_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_forest_summary_async(service_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 575

def get_forest_summary_async(service_name, 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}/forestsummary'

  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: {'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::ForestSummary.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_forest_summary_with_http_info(service_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the forest summary for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



561
562
563
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 561

def get_forest_summary_with_http_info(service_name, custom_headers:nil)
  get_forest_summary_async(service_name, custom_headers:custom_headers).value!
end

#get_metric_metadata(service_name, metric_name, custom_headers: nil) ⇒ MetricMetadata

Gets the service related metric information.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

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

    A hash of custom headers that

Returns:

  • (MetricMetadata) —

    operation results.



933
934
935
936
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 933

def get_metric_metadata(service_name, metric_name, custom_headers:nil)
  response = get_metric_metadata_async(service_name, metric_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_metric_metadata_async(service_name, metric_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the service related metric information.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 962

def get_metric_metadata_async(service_name, metric_name, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'metric_name is nil' if metric_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}/metricmetadata/{metricName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name,'metricName' => metric_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::ADHybridHealthService::Mgmt::V2014_01_01::Models::MetricMetadata.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_metric_metadata_for_group(service_name, metric_name, group_name, group_key: nil, from_date: nil, to_date: nil, custom_headers: nil) ⇒ MetricSets

Gets the service related metrics for a given metric and group combination.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    The group key

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

    The start date.

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

    The end date.

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

    A hash of custom headers that

Returns:

  • (MetricSets) —

    operation results.



1030
1031
1032
1033
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1030

def get_metric_metadata_for_group(service_name, metric_name, group_name, group_key:nil, from_date:nil, to_date:nil, custom_headers:nil)
  response = get_metric_metadata_for_group_async(service_name, metric_name, group_name, group_key:group_key, from_date:from_date, to_date:to_date, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_metric_metadata_for_group_async(service_name, metric_name, group_name, group_key: nil, from_date: nil, to_date: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets the service related metrics for a given metric and group combination.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    The group key

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

    The start date.

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

    The end date.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1067

def get_metric_metadata_for_group_async(service_name, metric_name, group_name, group_key:nil, from_date:nil, to_date:nil, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'metric_name is nil' if metric_name.nil?
  fail ArgumentError, 'group_name is nil' if group_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}/metricmetadata/{metricName}/groups/{groupName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name,'metricName' => metric_name,'groupName' => group_name},
      query_params: {'groupKey' => group_key,'fromDate' => from_date,'toDate' => to_date,'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::MetricSets.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_metric_metadata_for_group_with_http_info(service_name, metric_name, group_name, group_key: nil, from_date: nil, to_date: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the service related metrics for a given metric and group combination.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    The group key

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

    The start date.

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

    The end date.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1049
1050
1051
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1049

def get_metric_metadata_for_group_with_http_info(service_name, metric_name, group_name, group_key:nil, from_date:nil, to_date:nil, custom_headers:nil)
  get_metric_metadata_for_group_async(service_name, metric_name, group_name, group_key:group_key, from_date:from_date, to_date:to_date, custom_headers:custom_headers).value!
end

#get_metric_metadata_with_http_info(service_name, metric_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the service related metric information.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



948
949
950
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 948

def get_metric_metadata_with_http_info(service_name, metric_name, custom_headers:nil)
  get_metric_metadata_async(service_name, metric_name, custom_headers:custom_headers).value!
end

#get_with_http_info(service_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

def get_with_http_info(service_name, custom_headers:nil)
  get_async(service_name, custom_headers:custom_headers).value!
end

#list(filter: nil, service_type: nil, skip_count: nil, take_count: nil, custom_headers: nil) ⇒ Array<ServiceProperties>

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. elements that can be bypassed from a sequence and then return the remaining elements. elements that can be returned from a sequence. will be added to the HTTP request.

Parameters:

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

    The service property filter to apply.

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

    The service type for the services onboarded to

  • skip_count (Integer) (defaults to: nil) —

    The skip count, which specifies the number of

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    A hash of custom headers that

Returns:

  • (Array<ServiceProperties>) —

    operation results.



43
44
45
46
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 43

def list(filter:nil, service_type:nil, skip_count:nil, take_count:nil, custom_headers:nil)
  first_page = list_as_lazy(filter:filter, service_type:service_type, skip_count:skip_count, take_count:take_count, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(filter: nil, service_type: nil, skip_count: nil, take_count: nil, custom_headers: nil) ⇒ Services

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. elements that can be bypassed from a sequence and then return the remaining elements. elements that can be returned from a sequence. will be added to the HTTP request.

Parameters:

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

    The service property filter to apply.

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

    The service type for the services onboarded to

  • skip_count (Integer) (defaults to: nil) —

    The skip count, which specifies the number of

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    A hash of custom headers that

Returns:

  • (Services) —

    which provide lazy access to pages of the response.



2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2148

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

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. elements that can be bypassed from a sequence and then return the remaining elements. elements that can be returned from a sequence. to the HTTP request.

Parameters:

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

    The service property filter to apply.

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

    The service type for the services onboarded to

  • skip_count (Integer) (defaults to: nil) —

    The skip count, which specifies the number of

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
138
139
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 90

def list_async(filter:nil, service_type:nil, skip_count:nil, take_count:nil, custom_headers: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'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'$filter' => filter,'serviceType' => service_type,'skipCount' => skip_count,'takeCount' => take_count,'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::Services.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_metric_metadata(service_name, filter: nil, perf_counter: nil, custom_headers: nil) ⇒ Array<MetricMetadata>

Gets the service related metrics information.

are requested. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The metric metadata property filter to apply.

  • perf_counter (Boolean) (defaults to: nil) —

    Indicates if only performance counter metrics

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

    A hash of custom headers that

Returns:

  • (Array<MetricMetadata>) —

    operation results.



837
838
839
840
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 837

def list_metric_metadata(service_name, filter:nil, perf_counter:nil, custom_headers:nil)
  first_page = list_metric_metadata_as_lazy(service_name, filter:filter, perf_counter:perf_counter, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_metric_metadata_as_lazy(service_name, filter: nil, perf_counter: nil, custom_headers: nil) ⇒ MetricMetadataList

Gets the service related metrics information.

are requested. will be added to the HTTP request.

response.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The metric metadata property filter to apply.

  • perf_counter (Boolean) (defaults to: nil) —

    Indicates if only performance counter metrics

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

    A hash of custom headers that

Returns:

  • (MetricMetadataList) —

    which provide lazy access to pages of the



2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2217

def list_metric_metadata_as_lazy(service_name, filter:nil, perf_counter:nil, custom_headers:nil)
  response = list_metric_metadata_async(service_name, filter:filter, perf_counter:perf_counter, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_metric_metadata_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_metric_metadata_async(service_name, filter: nil, perf_counter: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets the service related metrics information.

are requested. to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The metric metadata property filter to apply.

  • perf_counter (Boolean) (defaults to: nil) —

    Indicates if only performance counter metrics

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 870

def list_metric_metadata_async(service_name, filter:nil, perf_counter: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}/metricmetadata'

  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,'perfCounter' => perf_counter,'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::MetricMetadataList.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_metric_metadata_next(next_page_link, custom_headers: nil) ⇒ MetricMetadataList

Gets the service related metrics information.

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:

  • (MetricMetadataList) —

    operation results.



1860
1861
1862
1863
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1860

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

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

Gets the service related metrics information.

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.



1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1889

def list_metric_metadata_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::MetricMetadataList.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_metric_metadata_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the service related metrics information.

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.



1875
1876
1877
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1875

def list_metric_metadata_next_with_http_info(next_page_link, custom_headers:nil)
  list_metric_metadata_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_metric_metadata_with_http_info(service_name, filter: nil, perf_counter: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the service related metrics information.

are requested. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The metric metadata property filter to apply.

  • perf_counter (Boolean) (defaults to: nil) —

    Indicates if only performance counter metrics

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



854
855
856
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 854

def list_metric_metadata_with_http_info(service_name, filter:nil, perf_counter:nil, custom_headers:nil)
  list_metric_metadata_async(service_name, filter:filter, perf_counter:perf_counter, custom_headers:custom_headers).value!
end

#list_metrics_average(service_name, metric_name, group_name, custom_headers: nil) ⇒ Array<Item>

Gets the average of the metric values for a given metric and group combination.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    A hash of custom headers that

Returns:

  • (Array<Item>) —

    operation results.



640
641
642
643
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 640

def list_metrics_average(service_name, metric_name, group_name, custom_headers:nil)
  first_page = list_metrics_average_as_lazy(service_name, metric_name, group_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_metrics_average_as_lazy(service_name, metric_name, group_name, custom_headers: nil) ⇒ Metrics

Gets the average of the metric values for a given metric and group combination.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    A hash of custom headers that

Returns:

  • (Metrics) —

    which provide lazy access to pages of the response.



2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2171

def list_metrics_average_as_lazy(service_name, metric_name, group_name, custom_headers:nil)
  response = list_metrics_average_async(service_name, metric_name, group_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_metrics_average_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_metrics_average_async(service_name, metric_name, group_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the average of the metric values for a given metric and group combination.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 673

def list_metrics_average_async(service_name, metric_name, group_name, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'metric_name is nil' if metric_name.nil?
  fail ArgumentError, 'group_name is nil' if group_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}/metrics/{metricName}/groups/{groupName}/average'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name,'metricName' => metric_name,'groupName' => group_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::ADHybridHealthService::Mgmt::V2014_01_01::Models::Metrics.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_metrics_average_next(next_page_link, custom_headers: nil) ⇒ Metrics

Gets the average of the metric values for a given metric and group combination.

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:

  • (Metrics) —

    operation results.



1678
1679
1680
1681
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1678

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

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

Gets the average of the metric values for a given metric and group combination.

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.



1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1709

def list_metrics_average_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::Metrics.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_metrics_average_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the average of the metric values for a given metric and group combination.

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.



1694
1695
1696
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1694

def list_metrics_average_next_with_http_info(next_page_link, custom_headers:nil)
  list_metrics_average_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_metrics_average_with_http_info(service_name, metric_name, group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the average of the metric values for a given metric and group combination.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



657
658
659
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 657

def list_metrics_average_with_http_info(service_name, metric_name, group_name, custom_headers:nil)
  list_metrics_average_async(service_name, metric_name, group_name, custom_headers:custom_headers).value!
end

#list_metrics_sum(service_name, metric_name, group_name, custom_headers: nil) ⇒ Array<Item>

Gets the sum of the metric values for a given metric and group combination.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    A hash of custom headers that

Returns:

  • (Array<Item>) —

    operation results.



739
740
741
742
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 739

def list_metrics_sum(service_name, metric_name, group_name, custom_headers:nil)
  first_page = list_metrics_sum_as_lazy(service_name, metric_name, group_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_metrics_sum_as_lazy(service_name, metric_name, group_name, custom_headers: nil) ⇒ Metrics

Gets the sum of the metric values for a given metric and group combination.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    A hash of custom headers that

Returns:

  • (Metrics) —

    which provide lazy access to pages of the response.



2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2193

def list_metrics_sum_as_lazy(service_name, metric_name, group_name, custom_headers:nil)
  response = list_metrics_sum_async(service_name, metric_name, group_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_metrics_sum_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_metrics_sum_async(service_name, metric_name, group_name, custom_headers: nil) ⇒ Concurrent::Promise

Gets the sum of the metric values for a given metric and group combination.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 770

def list_metrics_sum_async(service_name, metric_name, group_name, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'metric_name is nil' if metric_name.nil?
  fail ArgumentError, 'group_name is nil' if group_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}/metrics/{metricName}/groups/{groupName}/sum'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceName' => service_name,'metricName' => metric_name,'groupName' => group_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::ADHybridHealthService::Mgmt::V2014_01_01::Models::Metrics.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_metrics_sum_next(next_page_link, custom_headers: nil) ⇒ Metrics

Gets the sum of the metric values for a given metric and group combination.

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:

  • (Metrics) —

    operation results.



1770
1771
1772
1773
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1770

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

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

Gets the sum of the metric values for a given metric and group combination.

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.



1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1799

def list_metrics_sum_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::Metrics.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_metrics_sum_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the sum of the metric values for a given metric and group combination.

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.



1785
1786
1787
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1785

def list_metrics_sum_next_with_http_info(next_page_link, custom_headers:nil)
  list_metrics_sum_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_metrics_sum_with_http_info(service_name, metric_name, group_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the sum of the metric values for a given metric and group combination.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • metric_name (String) —

    The metric name

  • group_name (String) —

    The group name

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



755
756
757
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 755

def list_metrics_sum_with_http_info(service_name, metric_name, group_name, custom_headers:nil)
  list_metrics_sum_async(service_name, metric_name, group_name, custom_headers:custom_headers).value!
end

#list_next(next_page_link, custom_headers: nil) ⇒ Services

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

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:

  • (Services) —

    operation results.



1585
1586
1587
1588
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1585

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

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

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.



1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1616

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::ADHybridHealthService::Mgmt::V2014_01_01::Models::Services.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

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

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.



1601
1602
1603
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1601

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_premium_services(filter: nil, service_type: nil, skip_count: nil, take_count: nil, custom_headers: nil) ⇒ Array<ServiceProperties>

Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. elements that can be bypassed from a sequence and then return the remaining elements. elements that can be returned from a sequence. will be added to the HTTP request.

Parameters:

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

    The service property filter to apply.

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

    The service type for the services onboarded to

  • skip_count (Integer) (defaults to: nil) —

    The skip count, which specifies the number of

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    A hash of custom headers that

Returns:

  • (Array<ServiceProperties>) —

    operation results.



1474
1475
1476
1477
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1474

def list_premium_services(filter:nil, service_type:nil, skip_count:nil, take_count:nil, custom_headers:nil)
  first_page = list_premium_services_as_lazy(filter:filter, service_type:service_type, skip_count:skip_count, take_count:take_count, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_premium_services_as_lazy(filter: nil, service_type: nil, skip_count: nil, take_count: nil, custom_headers: nil) ⇒ Services

Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. elements that can be bypassed from a sequence and then return the remaining elements. elements that can be returned from a sequence. will be added to the HTTP request.

Parameters:

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

    The service property filter to apply.

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

    The service type for the services onboarded to

  • skip_count (Integer) (defaults to: nil) —

    The skip count, which specifies the number of

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    A hash of custom headers that

Returns:

  • (Services) —

    which provide lazy access to pages of the response.



2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2275

def list_premium_services_as_lazy(filter:nil, service_type:nil, skip_count:nil, take_count:nil, custom_headers:nil)
  response = list_premium_services_async(filter:filter, service_type:service_type, skip_count:skip_count, take_count:take_count, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_premium_services_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_premium_services_async(filter: nil, service_type: nil, skip_count: nil, take_count: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. elements that can be bypassed from a sequence and then return the remaining elements. elements that can be returned from a sequence. to the HTTP request.

Parameters:

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

    The service property filter to apply.

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

    The service type for the services onboarded to

  • skip_count (Integer) (defaults to: nil) —

    The skip count, which specifies the number of

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1523

def list_premium_services_async(filter:nil, service_type:nil, skip_count:nil, take_count:nil, custom_headers: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/premiumCheck'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'$filter' => filter,'serviceType' => service_type,'skipCount' => skip_count,'takeCount' => take_count,'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::Services.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_premium_services_next(next_page_link, custom_headers: nil) ⇒ Services

Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

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:

  • (Services) —

    operation results.



2045
2046
2047
2048
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2045

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

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

Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

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.



2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2078

def list_premium_services_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::Services.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_premium_services_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

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.



2062
2063
2064
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2062

def list_premium_services_next_with_http_info(next_page_link, custom_headers:nil)
  list_premium_services_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_premium_services_with_http_info(filter: nil, service_type: nil, skip_count: nil, take_count: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health.

Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. elements that can be bypassed from a sequence and then return the remaining elements. elements that can be returned from a sequence. will be added to the HTTP request.

Parameters:

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

    The service property filter to apply.

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

    The service type for the services onboarded to

  • skip_count (Integer) (defaults to: nil) —

    The skip count, which specifies the number of

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1499
1500
1501
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1499

def list_premium_services_with_http_info(filter:nil, service_type:nil, skip_count:nil, take_count:nil, custom_headers:nil)
  list_premium_services_async(filter:filter, service_type:service_type, skip_count:skip_count, take_count:take_count, custom_headers:custom_headers).value!
end

#list_replication_details(service_name, filter: nil, with_details: nil, custom_headers: nil) ⇒ ReplicationDetailsList

Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

are required or not. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The server property filter to apply.

  • with_details (Boolean) (defaults to: nil) —

    Indicates if InboundReplicationNeighbor details

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

    A hash of custom headers that

Returns:

  • (ReplicationDetailsList) —

    operation results.



1136
1137
1138
1139
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1136

def list_replication_details(service_name, filter:nil, with_details:nil, custom_headers:nil)
  response = list_replication_details_async(service_name, filter:filter, with_details:with_details, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_replication_details_async(service_name, filter: nil, with_details: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

are required or not. to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The server property filter to apply.

  • with_details (Boolean) (defaults to: nil) —

    Indicates if InboundReplicationNeighbor details

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1173

def list_replication_details_async(service_name, filter:nil, with_details: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}/replicationdetails'

  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,'withDetails' => with_details,'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::ReplicationDetailsList.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_replication_details_with_http_info(service_name, filter: nil, with_details: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

are required or not. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The server property filter to apply.

  • with_details (Boolean) (defaults to: nil) —

    Indicates if InboundReplicationNeighbor details

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1155
1156
1157
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1155

def list_replication_details_with_http_info(service_name, filter:nil, with_details:nil, custom_headers:nil)
  list_replication_details_async(service_name, filter:filter, with_details:with_details, custom_headers:custom_headers).value!
end

#list_replication_summary(service_name, is_groupby_site, query, filter: nil, take_count: nil, custom_headers: nil) ⇒ ReplicationSummaryList

Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

site or not. elements that can be returned from a sequence. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • is_groupby_site (Boolean) —

    Indicates if the result should be grouped by

  • query (String) —

    The custom query.

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

    The server property filter to apply.

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    A hash of custom headers that

Returns:

  • (ReplicationSummaryList) —

    operation results.



1243
1244
1245
1246
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1243

def list_replication_summary(service_name, is_groupby_site, query, filter:nil, take_count:nil, custom_headers:nil)
  response = list_replication_summary_async(service_name, is_groupby_site, query, filter:filter, take_count:take_count, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#list_replication_summary_async(service_name, is_groupby_site, query, filter: nil, take_count: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

site or not. elements that can be returned from a sequence. to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • is_groupby_site (Boolean) —

    Indicates if the result should be grouped by

  • query (String) —

    The custom query.

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

    The server property filter to apply.

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1286

def list_replication_summary_async(service_name, is_groupby_site, query, filter:nil, take_count:nil, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'is_groupby_site is nil' if is_groupby_site.nil?
  fail ArgumentError, 'query is nil' if query.nil?
  next_partition_key = ''
  next_row_key = ''
  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}/replicationsummary'

  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,'isGroupbySite' => is_groupby_site,'query' => query,'nextPartitionKey' => next_partition_key,'nextRowKey' => next_row_key,'takeCount' => take_count,'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::ReplicationSummaryList.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_replication_summary_with_http_info(service_name, is_groupby_site, query, filter: nil, take_count: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets complete domain controller list along with replication details for a given Active Directory Domain Service, that is onboarded to Azure Active Directory Connect Health.

site or not. elements that can be returned from a sequence. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

  • is_groupby_site (Boolean) —

    Indicates if the result should be grouped by

  • query (String) —

    The custom query.

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

    The server property filter to apply.

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



1265
1266
1267
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1265

def list_replication_summary_with_http_info(service_name, is_groupby_site, query, filter:nil, take_count:nil, custom_headers:nil)
  list_replication_summary_async(service_name, is_groupby_site, query, filter:filter, take_count:take_count, custom_headers:custom_headers).value!
end

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

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

be queried. will be added to the HTTP request.

Parameters:

  • service_member_id —

    The server Id for which the alert details needs to

  • 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.



1359
1360
1361
1362
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1359

def list_server_alerts(service_member_id, service_name, filter:nil, state:nil, from:nil, to:nil, custom_headers:nil)
  first_page = list_server_alerts_as_lazy(service_member_id, service_name, filter:filter, state:state, from:from, to:to, custom_headers:custom_headers)
  first_page.get_all_items
end

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

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

be queried. will be added to the HTTP request.

Parameters:

  • service_member_id —

    The server Id for which the alert details needs to

  • 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.



2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 2244

def list_server_alerts_as_lazy(service_member_id, service_name, filter:nil, state:nil, from:nil, to:nil, custom_headers:nil)
  response = list_server_alerts_async(service_member_id, 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_server_alerts_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

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

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

be queried. to the HTTP request.

Parameters:

  • service_member_id —

    The server Id for which the alert details needs to

  • 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.



1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1400

def list_server_alerts_async(service_member_id, service_name, filter:nil, state:nil, from:nil, to:nil, custom_headers:nil)
  fail ArgumentError, 'service_member_id is nil' if service_member_id.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}/servicemembers/{serviceMemberId}/alerts'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'serviceMemberId' => service_member_id,'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_server_alerts_next(next_page_link, custom_headers: nil) ⇒ Alerts

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

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.



1951
1952
1953
1954
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1951

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

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

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

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.



1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1982

def list_server_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_server_alerts_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

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.



1967
1968
1969
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1967

def list_server_alerts_next_with_http_info(next_page_link, custom_headers:nil)
  list_server_alerts_next_async(next_page_link, custom_headers:custom_headers).value!
end

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

Gets the details of an alert for a given Active Directory Domain Controller service and server combination.

be queried. will be added to the HTTP request.

Parameters:

  • service_member_id —

    The server Id for which the alert details needs to

  • 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.



1380
1381
1382
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 1380

def list_server_alerts_with_http_info(service_member_id, service_name, filter:nil, state:nil, from:nil, to:nil, custom_headers:nil)
  list_server_alerts_async(service_member_id, service_name, filter:filter, state:state, from:from, to:to, custom_headers:custom_headers).value!
end

#list_with_http_info(filter: nil, service_type: nil, skip_count: nil, take_count: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of Active Directory Domain Service, for a tenant, that are onboarded to Azure Active Directory Connect Health.

Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. elements that can be bypassed from a sequence and then return the remaining elements. elements that can be returned from a sequence. will be added to the HTTP request.

Parameters:

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

    The service property filter to apply.

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

    The service type for the services onboarded to

  • skip_count (Integer) (defaults to: nil) —

    The skip count, which specifies the number of

  • take_count (Integer) (defaults to: nil) —

    The take count , which specifies the number of

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



67
68
69
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 67

def list_with_http_info(filter:nil, service_type:nil, skip_count:nil, take_count:nil, custom_headers:nil)
  list_async(filter:filter, service_type:service_type, skip_count:skip_count, take_count:take_count, custom_headers:custom_headers).value!
end

#update(service_name, service, custom_headers: nil) ⇒ ServiceProperties

Updates an Active Directory Domain Service properties of an onboarded service.

deleted. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service which needs to be

  • service (ServiceProperties) —

    The service object.

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

    A hash of custom headers that

Returns:

  • (ServiceProperties) —

    operation results.



442
443
444
445
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 442

def update(service_name, service, custom_headers:nil)
  response = update_async(service_name, service, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(service_name, service, custom_headers: nil) ⇒ Concurrent::Promise

Updates an Active Directory Domain Service properties of an onboarded service.

deleted. to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service which needs to be

  • service (ServiceProperties) —

    The service object.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 475

def update_async(service_name, service, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?
  fail ArgumentError, 'service is nil' if service.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?

  # Serialize Request
  request_mapper = Azure::ADHybridHealthService::Mgmt::V2014_01_01::Models::ServiceProperties.mapper()
  request_content = @client.serialize(request_mapper,  service)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}'

  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: {'api-version' => @client.api_version},
      body: request_content,
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = @client.make_request_async(:patch, 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::ServiceProperties.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

#update_with_http_info(service_name, service, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates an Active Directory Domain Service properties of an onboarded service.

deleted. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service which needs to be

  • service (ServiceProperties) —

    The service object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



459
460
461
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services.rb', line 459

def update_with_http_info(service_name, service, custom_headers:nil)
  update_async(service_name, service, custom_headers:custom_headers).value!
end