Class: Azure::DataFactory::Mgmt::V2018_06_01::LinkedServices

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb

Overview

The Azure Data Factory V2 management API provides a RESTful set of web services that interact with Azure Data Factory V2 services.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ LinkedServices

Creates and initializes a new instance of the LinkedServices class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 18

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ DataFactoryManagementClient (readonly)

Returns reference to the DataFactoryManagementClient.

Returns:



23
24
25
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 23

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, factory_name, linked_service_name, linked_service, if_match: nil, custom_headers: nil) ⇒ LinkedServiceResource

Creates or updates a linked service.

definition. specified for update, for which it should match existing entity or can be * for unconditional update. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

  • linked_service (LinkedServiceResource) —

    Linked service resource

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

    ETag of the linkedService entity. Should only be

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

    A hash of custom headers that

Returns:

  • (LinkedServiceResource) —

    operation results.



141
142
143
144
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 141

def create_or_update(resource_group_name, factory_name, linked_service_name, linked_service, if_match:nil, custom_headers:nil)
  response = create_or_update_async(resource_group_name, factory_name, linked_service_name, linked_service, if_match:if_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, factory_name, linked_service_name, linked_service, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a linked service.

definition. specified for update, for which it should match existing entity or can be * for unconditional update. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

  • linked_service (LinkedServiceResource) —

    Linked service resource

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

    ETag of the linkedService entity. Should only be

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 182

def create_or_update_async(resource_group_name, factory_name, linked_service_name, linked_service, if_match:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'linked_service_name is nil' if linked_service_name.nil?
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'MaxLength': '260'" if !linked_service_name.nil? && linked_service_name.length > 260
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'MinLength': '1'" if !linked_service_name.nil? && linked_service_name.length < 1
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$'" if !linked_service_name.nil? && linked_service_name.match(Regexp.new('^^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'linked_service is nil' if linked_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['If-Match'] = if_match unless if_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?

  # Serialize Request
  request_mapper = Azure::DataFactory::Mgmt::V2018_06_01::Models::LinkedServiceResource.mapper()
  request_content = @client.serialize(request_mapper,  linked_service)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'factoryName' => factory_name,'linkedServiceName' => linked_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(:put, 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::DataFactory::Mgmt::V2018_06_01::Models::LinkedServiceResource.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

#create_or_update_with_http_info(resource_group_name, factory_name, linked_service_name, linked_service, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a linked service.

definition. specified for update, for which it should match existing entity or can be * for unconditional update. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

  • linked_service (LinkedServiceResource) —

    Linked service resource

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

    ETag of the linkedService entity. Should only be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



162
163
164
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 162

def create_or_update_with_http_info(resource_group_name, factory_name, linked_service_name, linked_service, if_match:nil, custom_headers:nil)
  create_or_update_async(resource_group_name, factory_name, linked_service_name, linked_service, if_match:if_match, custom_headers:custom_headers).value!
end

#delete(resource_group_name, factory_name, linked_service_name, custom_headers: nil) ⇒ Object

Deletes a linked service.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

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

    A hash of custom headers that



383
384
385
386
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 383

def delete(resource_group_name, factory_name, linked_service_name, custom_headers:nil)
  response = delete_async(resource_group_name, factory_name, linked_service_name, custom_headers:custom_headers).value!
  nil
end

#delete_async(resource_group_name, factory_name, linked_service_name, custom_headers: nil) ⇒ Concurrent::Promise

Deletes a linked service.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



414
415
416
417
418
419
420
421
422
423
424
425
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
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 414

def delete_async(resource_group_name, factory_name, linked_service_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'linked_service_name is nil' if linked_service_name.nil?
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'MaxLength': '260'" if !linked_service_name.nil? && linked_service_name.length > 260
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'MinLength': '1'" if !linked_service_name.nil? && linked_service_name.length < 1
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$'" if !linked_service_name.nil? && linked_service_name.match(Regexp.new('^^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$$')).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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'factoryName' => factory_name,'linkedServiceName' => linked_service_name},
      query_params: {'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 == 200 || 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(resource_group_name, factory_name, linked_service_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a linked service.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



399
400
401
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 399

def delete_with_http_info(resource_group_name, factory_name, linked_service_name, custom_headers:nil)
  delete_async(resource_group_name, factory_name, linked_service_name, custom_headers:custom_headers).value!
end

#get(resource_group_name, factory_name, linked_service_name, if_none_match: nil, custom_headers: nil) ⇒ LinkedServiceResource

Gets a linked service.

be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

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

    ETag of the linked service entity. Should only

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

    A hash of custom headers that

Returns:

  • (LinkedServiceResource) —

    operation results.



270
271
272
273
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 270

def get(resource_group_name, factory_name, linked_service_name, if_none_match:nil, custom_headers:nil)
  response = get_async(resource_group_name, factory_name, linked_service_name, if_none_match:if_none_match, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, factory_name, linked_service_name, if_none_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets a linked service.

be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

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

    ETag of the linked service entity. Should only

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 307

def get_async(resource_group_name, factory_name, linked_service_name, if_none_match:nil, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).nil?
  fail ArgumentError, 'linked_service_name is nil' if linked_service_name.nil?
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'MaxLength': '260'" if !linked_service_name.nil? && linked_service_name.length > 260
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'MinLength': '1'" if !linked_service_name.nil? && linked_service_name.length < 1
  fail ArgumentError, "'linked_service_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$'" if !linked_service_name.nil? && linked_service_name.match(Regexp.new('^^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$$')).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['If-None-Match'] = if_none_match unless if_none_match.nil?
  request_headers['accept-language'] = @client.accept_language unless @client.accept_language.nil?
  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices/{linkedServiceName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'factoryName' => factory_name,'linkedServiceName' => linked_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 || status_code == 304
      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::DataFactory::Mgmt::V2018_06_01::Models::LinkedServiceResource.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(resource_group_name, factory_name, linked_service_name, if_none_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a linked service.

be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • linked_service_name (String) —

    The linked service name.

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

    ETag of the linked service entity. Should only

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



289
290
291
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 289

def get_with_http_info(resource_group_name, factory_name, linked_service_name, if_none_match:nil, custom_headers:nil)
  get_async(resource_group_name, factory_name, linked_service_name, if_none_match:if_none_match, custom_headers:custom_headers).value!
end

#list_by_factory(resource_group_name, factory_name, custom_headers: nil) ⇒ Array<LinkedServiceResource>

Lists linked services.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

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

    A hash of custom headers that

Returns:

  • (Array<LinkedServiceResource>) —

    operation results.



35
36
37
38
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 35

def list_by_factory(resource_group_name, factory_name, custom_headers:nil)
  first_page = list_by_factory_as_lazy(resource_group_name, factory_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_factory_as_lazy(resource_group_name, factory_name, custom_headers: nil) ⇒ LinkedServiceListResponse

Lists linked services.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

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

    A hash of custom headers that

Returns:

  • (LinkedServiceListResponse) —

    which provide lazy access to pages of the



570
571
572
573
574
575
576
577
578
579
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 570

def list_by_factory_as_lazy(resource_group_name, factory_name, custom_headers:nil)
  response = list_by_factory_async(resource_group_name, factory_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_factory_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_factory_async(resource_group_name, factory_name, custom_headers: nil) ⇒ Concurrent::Promise

Lists linked services.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 64

def list_by_factory_async(resource_group_name, factory_name, custom_headers:nil)
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.nil?
  fail ArgumentError, 'resource_group_name is nil' if resource_group_name.nil?
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MaxLength': '90'" if !resource_group_name.nil? && resource_group_name.length > 90
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'MinLength': '1'" if !resource_group_name.nil? && resource_group_name.length < 1
  fail ArgumentError, "'resource_group_name' should satisfy the constraint - 'Pattern': '^[-\w\._\(\)]+$'" if !resource_group_name.nil? && resource_group_name.match(Regexp.new('^^[-\w\._\(\)]+$$')).nil?
  fail ArgumentError, 'factory_name is nil' if factory_name.nil?
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MaxLength': '63'" if !factory_name.nil? && factory_name.length > 63
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'MinLength': '3'" if !factory_name.nil? && factory_name.length < 3
  fail ArgumentError, "'factory_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$'" if !factory_name.nil? && factory_name.match(Regexp.new('^^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$$')).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 = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/linkedservices'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'subscriptionId' => @client.subscription_id,'resourceGroupName' => resource_group_name,'factoryName' => factory_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::DataFactory::Mgmt::V2018_06_01::Models::LinkedServiceListResponse.mapper()
        result.body = @client.deserialize(result_mapper, parsed_response)
      rescue Exception => e
        fail MsRest::DeserializationError.new('Error occurred in deserializing the response', e.message, e.backtrace, result)
      end
    end

    result
  end

  promise.execute
end

#list_by_factory_next(next_page_link, custom_headers: nil) ⇒ LinkedServiceListResponse

Lists linked services.

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:

  • (LinkedServiceListResponse) —

    operation results.



479
480
481
482
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 479

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

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

Lists linked services.

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.



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
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 508

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

    result
  end

  promise.execute
end

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

Lists linked services.

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.



494
495
496
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 494

def list_by_factory_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_factory_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_factory_with_http_info(resource_group_name, factory_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists linked services.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



50
51
52
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/linked_services.rb', line 50

def list_by_factory_with_http_info(resource_group_name, factory_name, custom_headers:nil)
  list_by_factory_async(resource_group_name, factory_name, custom_headers:custom_headers).value!
end