Class: Azure::ADHybridHealthService::Mgmt::V2014_01_01::AddsServicesServiceMembers

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

Overview

REST APIs for Azure Active Directory Connect Health

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AddsServicesServiceMembers

Creates and initializes a new instance of the AddsServicesServiceMembers class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#add(service_name, service_member, custom_headers: nil) ⇒ ServiceMember

Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.

is to be onboarded. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service under which the server

  • service_member (ServiceMember) —

    The server object.

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

    A hash of custom headers that

Returns:

  • (ServiceMember) —

    operation results.



140
141
142
143
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services_service_members.rb', line 140

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

#add_async(service_name, service_member, custom_headers: nil) ⇒ Concurrent::Promise

Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.

is to be onboarded. to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service under which the server

  • service_member (ServiceMember) —

    The server object.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services_service_members.rb', line 173

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

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

  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(: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::ServiceMember.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_name, service_member, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Onboards a server, for a given Active Directory Domain Controller service, to Azure Active Directory Connect Health Service.

is to be onboarded. will be added to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service under which the server

  • service_member (ServiceMember) —

    The server object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



157
158
159
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services_service_members.rb', line 157

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

#list(service_name, filter: nil, dimension_type: nil, dimension_signature: nil, custom_headers: nil) ⇒ Array<ServiceMember>

Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

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.

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

    The server specific dimension.

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

    The value of the dimension.

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

    A hash of custom headers that

Returns:

  • (Array<ServiceMember>) —

    operation results.



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

def list(service_name, filter:nil, dimension_type:nil, dimension_signature:nil, custom_headers:nil)
  first_page = list_as_lazy(service_name, filter:filter, dimension_type:dimension_type, dimension_signature:dimension_signature, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_as_lazy(service_name, filter: nil, dimension_type: nil, dimension_signature: nil, custom_headers: nil) ⇒ ServiceMembers

Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

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.

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

    The server specific dimension.

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

    The value of the dimension.

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

    A hash of custom headers that

Returns:

  • (ServiceMembers) —

    which provide lazy access to pages of the response.



344
345
346
347
348
349
350
351
352
353
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services_service_members.rb', line 344

def list_as_lazy(service_name, filter:nil, dimension_type:nil, dimension_signature:nil, custom_headers:nil)
  response = list_async(service_name, filter:filter, dimension_type:dimension_type, dimension_signature:dimension_signature, 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(service_name, filter: nil, dimension_type: nil, dimension_signature: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

to the HTTP request.

Parameters:

  • service_name (String) —

    The name of the service.

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

    The server property filter to apply.

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

    The server specific dimension.

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

    The value of the dimension.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services_service_members.rb', line 75

def list_async(service_name, filter:nil, dimension_type:nil, dimension_signature: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}/servicemembers'

  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,'dimensionType' => dimension_type,'dimensionSignature' => dimension_signature,'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::ServiceMembers.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(next_page_link, custom_headers: nil) ⇒ ServiceMembers

Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (ServiceMembers) —

    operation results.



246
247
248
249
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services_service_members.rb', line 246

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 the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

to List operation. to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

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::ServiceMembers.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 the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

to List operation. will be added to the HTTP request.

Parameters:

  • next_page_link (String) —

    The NextLink from the previous successful call

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



263
264
265
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services_service_members.rb', line 263

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_with_http_info(service_name, filter: nil, dimension_type: nil, dimension_signature: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the details of the servers, for a given Active Directory Domain Controller service, that are onboarded to Azure Active Directory Connect Health Service.

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.

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

    The server specific dimension.

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

    The value of the dimension.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



57
58
59
 
# File 'lib/2014-01-01/generated/azure_mgmt_adhybridhealth_service/adds_services_service_members.rb', line 57

def list_with_http_info(service_name, filter:nil, dimension_type:nil, dimension_signature:nil, custom_headers:nil)
  list_async(service_name, filter:filter, dimension_type:dimension_type, dimension_signature:dimension_signature, custom_headers:custom_headers).value!
end