Class: Azure::ADHybridHealthService::Mgmt::V2014_01_01::Configuration

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

Overview

REST APIs for Azure Active Directory Connect Health

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Configuration

Creates and initializes a new instance of the Configuration class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#add(custom_headers: nil) ⇒ Tenant

Onboards a tenant in Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Tenant) —

    operation results.



123
124
125
126
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 123

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

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

Onboards a tenant in Azure Active Directory Connect Health.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 148

def add_async(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/configuration'

  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},
      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::Tenant.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(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Onboards a tenant in Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



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

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

#get(custom_headers: nil) ⇒ Tenant

Gets the details of a tenant onboarded to Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Tenant) —

    operation results.



208
209
210
211
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 208

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

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

Gets the details of a tenant onboarded to Azure Active Directory Connect Health.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 235

def get_async(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/configuration'

  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},
      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::Tenant.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

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

Gets the details of a tenant onboarded to Azure Active Directory Connect Health.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



222
223
224
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 222

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

#list_adds_configurations(service_name, grouping: nil, custom_headers: nil) ⇒ Array<Item>

Gets the service configurations.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The grouping for configurations.

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

    A hash of custom headers that

Returns:

  • (Array<Item>) —

    operation results.



34
35
36
37
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 34

def list_adds_configurations(service_name, grouping:nil, custom_headers:nil)
  first_page = list_adds_configurations_as_lazy(service_name, grouping:grouping, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_adds_configurations_as_lazy(service_name, grouping: nil, custom_headers: nil) ⇒ AddsConfiguration

Gets the service configurations.

will be added to the HTTP request.

response.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The grouping for configurations.

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

    A hash of custom headers that

Returns:

  • (AddsConfiguration) —

    which provide lazy access to pages of the



488
489
490
491
492
493
494
495
496
497
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 488

def list_adds_configurations_as_lazy(service_name, grouping:nil, custom_headers:nil)
  response = list_adds_configurations_async(service_name, grouping:grouping, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_adds_configurations_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_adds_configurations_async(service_name, grouping: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets the service configurations.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The grouping for configurations.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 63

def list_adds_configurations_async(service_name, grouping:nil, custom_headers:nil)
  fail ArgumentError, 'service_name is nil' if service_name.nil?


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'

  # Set Headers
  request_headers['x-ms-client-request-id'] = SecureRandom.uuid
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}/configuration'

  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: {'grouping' => grouping},
      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::AddsConfiguration.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_adds_configurations_next(next_page_link, custom_headers: nil) ⇒ AddsConfiguration

Gets the service configurations.

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:

  • (AddsConfiguration) —

    operation results.



397
398
399
400
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 397

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

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

Gets the service configurations.

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.



426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 426

def list_adds_configurations_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::AddsConfiguration.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_adds_configurations_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the service configurations.

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.



412
413
414
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 412

def list_adds_configurations_next_with_http_info(next_page_link, custom_headers:nil)
  list_adds_configurations_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_adds_configurations_with_http_info(service_name, grouping: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the service configurations.

will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The grouping for configurations.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



49
50
51
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 49

def list_adds_configurations_with_http_info(service_name, grouping:nil, custom_headers:nil)
  list_adds_configurations_async(service_name, grouping:grouping, custom_headers:custom_headers).value!
end

#update(tenant, custom_headers: nil) ⇒ Tenant

Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.

updated value. will be added to the HTTP request.

Parameters:

  • tenant (Tenant) —

    The tenant object with the properties set to the

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

    A hash of custom headers that

Returns:

  • (Tenant) —

    operation results.



297
298
299
300
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 297

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

#update_async(tenant, custom_headers: nil) ⇒ Concurrent::Promise

Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.

updated value. to the HTTP request.

Parameters:

  • tenant (Tenant) —

    The tenant object with the properties set to the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 328

def update_async(tenant, custom_headers:nil)
  fail ArgumentError, 'tenant is nil' if tenant.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::Tenant.mapper()
  request_content = @client.serialize(request_mapper,  tenant)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'providers/Microsoft.ADHybridHealthService/configuration'

  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(: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::Tenant.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(tenant, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Updates tenant properties for tenants onboarded to Azure Active Directory Connect Health.

updated value. will be added to the HTTP request.

Parameters:

  • tenant (Tenant) —

    The tenant object with the properties set to the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



313
314
315
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/configuration.rb', line 313

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