Class: Azure::Logic::Mgmt::V2016_06_01::LogicManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, base_url = nil, options = nil) ⇒ LogicManagementClient

Creates initializes a new instance of the LogicManagementClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

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

    the base URI of the service.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 108

def initialize(credentials = nil, base_url = nil, options = nil)
  super(credentials, options)
  @base_url = base_url || 'https://management.azure.com'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @workflows = Workflows.new(self)
  @workflow_versions = WorkflowVersions.new(self)
  @workflow_triggers = WorkflowTriggers.new(self)
  @workflow_trigger_histories = WorkflowTriggerHistories.new(self)
  @workflow_runs = WorkflowRuns.new(self)
  @workflow_run_actions = WorkflowRunActions.new(self)
  @workflow_run_action_repetitions = WorkflowRunActionRepetitions.new(self)
  @workflow_run_action_repetitions_request_histories = WorkflowRunActionRepetitionsRequestHistories.new(self)
  @workflow_run_action_request_histories = WorkflowRunActionRequestHistories.new(self)
  @workflow_run_action_scoped_repetitions = WorkflowRunActionScopedRepetitions.new(self)
  @workflow_run_operations = WorkflowRunOperations.new(self)
  @integration_accounts = IntegrationAccounts.new(self)
  @integration_account_assemblies = IntegrationAccountAssemblies.new(self)
  @integration_account_batch_configurations = IntegrationAccountBatchConfigurations.new(self)
  @schemas = Schemas.new(self)
  @maps = Maps.new(self)
  @partners = Partners.new(self)
  @agreements = Agreements.new(self)
  @certificates = Certificates.new(self)
  @sessions = Sessions.new(self)
  @api_version = '2016-06-01'
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



27
28
29
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 27

def accept_language
  @accept_language
end

#agreements ⇒ Agreements (readonly)

Returns agreements.

Returns:



94
95
96
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 94

def agreements
  @agreements
end

#api_version ⇒ String (readonly)

Returns The API version.

Returns:

  • (String) —

    The API version.



24
25
26
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 24

def api_version
  @api_version
end

#base_url ⇒ String

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 15

def base_url
  @base_url
end

#certificates ⇒ Certificates (readonly)

Returns certificates.

Returns:



97
98
99
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 97

def certificates
  @certificates
end

#credentials ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



36
37
38
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 36

def generate_client_request_id
  @generate_client_request_id
end

#integration_account_assemblies ⇒ IntegrationAccountAssemblies (readonly)

Returns integration_account_assemblies.

Returns:



78
79
80
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 78

def 
  @integration_account_assemblies
end

#integration_account_batch_configurations ⇒ IntegrationAccountBatchConfigurations (readonly)

integration_account_batch_configurations

Returns:



82
83
84
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 82

def 
  @integration_account_batch_configurations
end

#integration_accounts ⇒ IntegrationAccounts (readonly)

Returns integration_accounts.

Returns:



75
76
77
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 75

def integration_accounts
  @integration_accounts
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



31
32
33
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 31

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#maps ⇒ Maps (readonly)

Returns maps.

Returns:



88
89
90
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 88

def maps
  @maps
end

#partners ⇒ Partners (readonly)

Returns partners.

Returns:



91
92
93
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 91

def partners
  @partners
end

#schemas ⇒ Schemas (readonly)

Returns schemas.

Returns:



85
86
87
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 85

def schemas
  @schemas
end

#sessions ⇒ Sessions (readonly)

Returns sessions.

Returns:



100
101
102
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 100

def sessions
  @sessions
end

#subscription_id ⇒ String

Returns The subscription id.

Returns:

  • (String) —

    The subscription id.



21
22
23
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 21

def subscription_id
  @subscription_id
end

#workflow_run_action_repetitions ⇒ WorkflowRunActionRepetitions (readonly)

Returns workflow_run_action_repetitions.

Returns:



57
58
59
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 57

def workflow_run_action_repetitions
  @workflow_run_action_repetitions
end

#workflow_run_action_repetitions_request_histories ⇒ WorkflowRunActionRepetitionsRequestHistories (readonly)

workflow_run_action_repetitions_request_histories

Returns:



61
62
63
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 61

def workflow_run_action_repetitions_request_histories
  @workflow_run_action_repetitions_request_histories
end

#workflow_run_action_request_histories ⇒ WorkflowRunActionRequestHistories (readonly)

workflow_run_action_request_histories

Returns:



65
66
67
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 65

def workflow_run_action_request_histories
  @workflow_run_action_request_histories
end

#workflow_run_action_scoped_repetitions ⇒ WorkflowRunActionScopedRepetitions (readonly)

workflow_run_action_scoped_repetitions

Returns:



69
70
71
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 69

def workflow_run_action_scoped_repetitions
  @workflow_run_action_scoped_repetitions
end

#workflow_run_actions ⇒ WorkflowRunActions (readonly)

Returns workflow_run_actions.

Returns:



54
55
56
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 54

def workflow_run_actions
  @workflow_run_actions
end

#workflow_run_operations ⇒ WorkflowRunOperations (readonly)

Returns workflow_run_operations.

Returns:



72
73
74
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 72

def workflow_run_operations
  @workflow_run_operations
end

#workflow_runs ⇒ WorkflowRuns (readonly)

Returns workflow_runs.

Returns:



51
52
53
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 51

def workflow_runs
  @workflow_runs
end

#workflow_trigger_histories ⇒ WorkflowTriggerHistories (readonly)

Returns workflow_trigger_histories.

Returns:



48
49
50
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 48

def workflow_trigger_histories
  @workflow_trigger_histories
end

#workflow_triggers ⇒ WorkflowTriggers (readonly)

Returns workflow_triggers.

Returns:



45
46
47
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 45

def workflow_triggers
  @workflow_triggers
end

#workflow_versions ⇒ WorkflowVersions (readonly)

Returns workflow_versions.

Returns:



42
43
44
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 42

def workflow_versions
  @workflow_versions
end

#workflows ⇒ Workflows (readonly)

Returns workflows.

Returns:



39
40
41
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 39

def workflows
  @workflows
end

Instance Method Details

#list_operations(custom_headers: nil) ⇒ Array<Operation>

Lists all of the available Logic REST API operations.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (Array<Operation>) —

    operation results.



208
209
210
211
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 208

def list_operations(custom_headers:nil)
  first_page = list_operations_as_lazy(custom_headers:custom_headers)
  first_page.get_all_items
end

#list_operations_as_lazy(custom_headers: nil) ⇒ OperationListResult

Lists all of the available Logic REST API operations.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (OperationListResult) —

    operation results.



378
379
380
381
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 378

def list_operations_as_lazy(custom_headers:nil)
  first_page = list_operations_as_lazy_async(custom_headers:custom_headers)
  first_page.get_all_items
end

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

Lists all of the available Logic REST API operations.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 403

def list_operations_as_lazy_async(custom_headers:nil)


  request_headers = {}
  request_headers['Content-Type'] = 'application/json; charset=utf-8'
  path_template = 'providers/Microsoft.Logic/operations'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 MsRest::HttpOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Logic::Mgmt::V2016_06_01::Models::OperationListResult.mapper()
        result.body = self.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_operations_as_lazy_with_http_info(custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the available Logic REST API operations.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



391
392
393
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 391

def list_operations_as_lazy_with_http_info(custom_headers:nil)
  list_operations_as_lazy_async(custom_headers:custom_headers).value!
end

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

Lists all of the available Logic REST API operations.

to the HTTP request.

Parameters:

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def list_operations_async(custom_headers:nil)
  fail ArgumentError, 'api_version is nil' if 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'] = accept_language unless accept_language.nil?
  path_template = 'providers/Microsoft.Logic/operations'

  request_url = @base_url || self.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      query_params: {'api-version' => api_version},
      headers: request_headers.merge(custom_headers || {}),
      base_url: request_url
  }
  promise = self.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 MsRest::HttpOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Logic::Mgmt::V2016_06_01::Models::OperationListResult.mapper()
        result.body = self.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_operations_next(next_page_link, custom_headers: nil) ⇒ OperationListResult

Lists all of the available Logic REST API operations.

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:

  • (OperationListResult) —

    operation results.



292
293
294
295
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 292

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

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

Lists all of the available Logic REST API operations.

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.



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/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 321

def list_operations_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'] = accept_language unless accept_language.nil?
  path_template = '{nextLink}'

  request_url = @base_url || self.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 = self.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 MsRest::HttpOperationError.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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Logic::Mgmt::V2016_06_01::Models::OperationListResult.mapper()
        result.body = self.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_operations_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Lists all of the available Logic REST API operations.

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.



307
308
309
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 307

def list_operations_next_with_http_info(next_page_link, custom_headers:nil)
  list_operations_next_async(next_page_link, custom_headers:custom_headers).value!
end

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

Lists all of the available Logic REST API operations.

will be added to the HTTP request.

Parameters:

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



221
222
223
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 221

def list_operations_with_http_info(custom_headers:nil)
  list_operations_async(custom_headers:custom_headers).value!
end

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



158
159
160
161
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 158

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 183

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

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

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



170
171
172
173
174
 
# File 'lib/2016-06-01/generated/azure_mgmt_logic/logic_management_client.rb', line 170

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end