Class: Azure::DataFactory::Mgmt::V2018_06_01::Pipelines

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.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) ⇒ Pipelines

Creates and initializes a new instance of the Pipelines class.

Parameters:

  • client —

    service class for accessing basic functionality.



18
19
20
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.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/pipelines.rb', line 23

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, factory_name, pipeline_name, pipeline, if_match: nil, custom_headers: nil) ⇒ PipelineResource

Creates or updates a pipeline.

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.

  • pipeline_name (String) —

    The pipeline name.

  • pipeline (PipelineResource) —

    Pipeline resource definition.

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

    ETag of the pipeline entity. Should only be

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

    A hash of custom headers that

Returns:

  • (PipelineResource) —

    operation results.



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

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

#create_or_update_async(resource_group_name, factory_name, pipeline_name, pipeline, if_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a pipeline.

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.

  • pipeline_name (String) —

    The pipeline name.

  • pipeline (PipelineResource) —

    Pipeline resource definition.

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

    ETag of the pipeline 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.



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
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 179

def create_or_update_async(resource_group_name, factory_name, pipeline_name, pipeline, 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, 'pipeline_name is nil' if pipeline_name.nil?
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'MaxLength': '260'" if !pipeline_name.nil? && pipeline_name.length > 260
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'MinLength': '1'" if !pipeline_name.nil? && pipeline_name.length < 1
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$'" if !pipeline_name.nil? && pipeline_name.match(Regexp.new('^^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$$')).nil?
  fail ArgumentError, '@client.api_version is nil' if @client.api_version.nil?
  fail ArgumentError, 'pipeline is nil' if pipeline.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::PipelineResource.mapper()
  request_content = @client.serialize(request_mapper,  pipeline)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

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

  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,'pipelineName' => pipeline_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::PipelineResource.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, pipeline_name, pipeline, if_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a pipeline.

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.

  • pipeline_name (String) —

    The pipeline name.

  • pipeline (PipelineResource) —

    Pipeline resource definition.

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

    ETag of the pipeline entity. Should only be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



160
161
162
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 160

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

#create_run(resource_group_name, factory_name, pipeline_name, reference_pipeline_run_id: nil, is_recovery: nil, start_activity_name: nil, start_from_failure: nil, parameters: nil, custom_headers: nil) ⇒ CreateRunResponse

Creates a run of a pipeline.

ID is specified the parameters of the specified run will be used to create a new run. true, the specified referenced pipeline run and the new run will be grouped under the same groupId. from this activity. If not specified, all activities will run. rerun will start from failed activities. The property will be used only if startActivityName is not specified. used only if the runId is not specified. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • pipeline_name (String) —

    The pipeline name.

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

    The pipeline run identifier. If run

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

    Recovery mode flag. If recovery mode is set to

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

    In recovery mode, the rerun will start

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

    In recovery mode, if set to true, the

  • parameters (defaults to: nil) —

    Parameters of the pipeline run. These parameters will be

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

    A hash of custom headers that

Returns:

  • (CreateRunResponse) —

    operation results.



490
491
492
493
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 490

def create_run(resource_group_name, factory_name, pipeline_name, reference_pipeline_run_id:nil, is_recovery:nil, start_activity_name:nil, start_from_failure:nil, parameters:nil, custom_headers:nil)
  response = create_run_async(resource_group_name, factory_name, pipeline_name, reference_pipeline_run_id:reference_pipeline_run_id, is_recovery:is_recovery, start_activity_name:start_activity_name, start_from_failure:start_from_failure, parameters:parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_run_async(resource_group_name, factory_name, pipeline_name, reference_pipeline_run_id: nil, is_recovery: nil, start_activity_name: nil, start_from_failure: nil, parameters: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates a run of a pipeline.

ID is specified the parameters of the specified run will be used to create a new run. true, the specified referenced pipeline run and the new run will be grouped under the same groupId. from this activity. If not specified, all activities will run. rerun will start from failed activities. The property will be used only if startActivityName is not specified. used only if the runId is not specified. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • pipeline_name (String) —

    The pipeline name.

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

    The pipeline run identifier. If run

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

    Recovery mode flag. If recovery mode is set to

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

    In recovery mode, the rerun will start

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

    In recovery mode, if set to true, the

  • parameters (defaults to: nil) —

    Parameters of the pipeline run. These parameters will be

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
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
627
628
629
630
631
632
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 547

def create_run_async(resource_group_name, factory_name, pipeline_name, reference_pipeline_run_id:nil, is_recovery:nil, start_activity_name:nil, start_from_failure:nil, parameters: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, 'pipeline_name is nil' if pipeline_name.nil?
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'MaxLength': '260'" if !pipeline_name.nil? && pipeline_name.length > 260
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'MinLength': '1'" if !pipeline_name.nil? && pipeline_name.length < 1
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$'" if !pipeline_name.nil? && pipeline_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?

  # Serialize Request
  request_mapper = {
    client_side_validation: true,
    required: false,
    serialized_name: 'parameters',
    type: {
      name: 'Dictionary',
      value: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ObjectElementType',
          type: {
            name: 'Object'
          }
      }
    }
  }
  request_content = @client.serialize(request_mapper,  parameters)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/pipelines/{pipelineName}/createRun'

  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,'pipelineName' => pipeline_name},
      query_params: {'api-version' => @client.api_version,'referencePipelineRunId' => reference_pipeline_run_id,'isRecovery' => is_recovery,'startActivityName' => start_activity_name,'startFromFailure' => start_from_failure},
      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::DataFactory::Mgmt::V2018_06_01::Models::CreateRunResponse.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_run_with_http_info(resource_group_name, factory_name, pipeline_name, reference_pipeline_run_id: nil, is_recovery: nil, start_activity_name: nil, start_from_failure: nil, parameters: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates a run of a pipeline.

ID is specified the parameters of the specified run will be used to create a new run. true, the specified referenced pipeline run and the new run will be grouped under the same groupId. from this activity. If not specified, all activities will run. rerun will start from failed activities. The property will be used only if startActivityName is not specified. used only if the runId is not specified. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • pipeline_name (String) —

    The pipeline name.

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

    The pipeline run identifier. If run

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

    Recovery mode flag. If recovery mode is set to

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

    In recovery mode, the rerun will start

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

    In recovery mode, if set to true, the

  • parameters (defaults to: nil) —

    Parameters of the pipeline run. These parameters will be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



519
520
521
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 519

def create_run_with_http_info(resource_group_name, factory_name, pipeline_name, reference_pipeline_run_id:nil, is_recovery:nil, start_activity_name:nil, start_from_failure:nil, parameters:nil, custom_headers:nil)
  create_run_async(resource_group_name, factory_name, pipeline_name, reference_pipeline_run_id:reference_pipeline_run_id, is_recovery:is_recovery, start_activity_name:start_activity_name, start_from_failure:start_from_failure, parameters:parameters, custom_headers:custom_headers).value!
end

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

Deletes a pipeline.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • pipeline_name (String) —

    The pipeline name.

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

    A hash of custom headers that



380
381
382
383
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 380

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

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

Deletes a pipeline.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • pipeline_name (String) —

    The pipeline name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



411
412
413
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
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 411

def delete_async(resource_group_name, factory_name, pipeline_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, 'pipeline_name is nil' if pipeline_name.nil?
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'MaxLength': '260'" if !pipeline_name.nil? && pipeline_name.length > 260
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'MinLength': '1'" if !pipeline_name.nil? && pipeline_name.length < 1
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$'" if !pipeline_name.nil? && pipeline_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}/pipelines/{pipelineName}'

  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,'pipelineName' => pipeline_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, pipeline_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Deletes a pipeline.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The resource group name.

  • factory_name (String) —

    The factory name.

  • pipeline_name (String) —

    The pipeline name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



396
397
398
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 396

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

#get(resource_group_name, factory_name, pipeline_name, if_none_match: nil, custom_headers: nil) ⇒ PipelineResource

Gets a pipeline.

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.

  • pipeline_name (String) —

    The pipeline name.

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

    ETag of the pipeline entity. Should only be

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

    A hash of custom headers that

Returns:

  • (PipelineResource) —

    operation results.



267
268
269
270
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 267

def get(resource_group_name, factory_name, pipeline_name, if_none_match:nil, custom_headers:nil)
  response = get_async(resource_group_name, factory_name, pipeline_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, pipeline_name, if_none_match: nil, custom_headers: nil) ⇒ Concurrent::Promise

Gets a pipeline.

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.

  • pipeline_name (String) —

    The pipeline name.

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

    ETag of the pipeline 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.



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

def get_async(resource_group_name, factory_name, pipeline_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, 'pipeline_name is nil' if pipeline_name.nil?
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'MaxLength': '260'" if !pipeline_name.nil? && pipeline_name.length > 260
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'MinLength': '1'" if !pipeline_name.nil? && pipeline_name.length < 1
  fail ArgumentError, "'pipeline_name' should satisfy the constraint - 'Pattern': '^[A-Za-z0-9_][^<>*#.%&:\\+?/]*$'" if !pipeline_name.nil? && pipeline_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}/pipelines/{pipelineName}'

  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,'pipelineName' => pipeline_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::PipelineResource.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, pipeline_name, if_none_match: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets a pipeline.

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.

  • pipeline_name (String) —

    The pipeline name.

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

    ETag of the pipeline entity. Should only be

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



286
287
288
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 286

def get_with_http_info(resource_group_name, factory_name, pipeline_name, if_none_match:nil, custom_headers:nil)
  get_async(resource_group_name, factory_name, pipeline_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<PipelineResource>

Lists pipelines.

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<PipelineResource>) —

    operation results.



35
36
37
38
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.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) ⇒ PipelineListResponse

Lists pipelines.

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:

  • (PipelineListResponse) —

    which provide lazy access to pages of the



735
736
737
738
739
740
741
742
743
744
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 735

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

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/pipelines.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}/pipelines'

  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::PipelineListResponse.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) ⇒ PipelineListResponse

Lists pipelines.

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:

  • (PipelineListResponse) —

    operation results.



644
645
646
647
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 644

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

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.



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

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::PipelineListResponse.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 pipelines.

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.



659
660
661
 
# File 'lib/2018-06-01/generated/azure_mgmt_data_factory/pipelines.rb', line 659

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

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/pipelines.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