Class: Azure::ARM::Logic::LogicManagementClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/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.



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
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 82

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)
  @integration_accounts = IntegrationAccounts.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 Gets or sets the preferred language for the response.

Returns:

  • (String) —

    Gets or sets the preferred language for the response.



27
28
29
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 27

def accept_language
  @accept_language
end

#agreements ⇒ Agreements (readonly)

Returns agreements.

Returns:



68
69
70
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 68

def agreements
  @agreements
end

#api_version ⇒ String (readonly)

Returns The API version.

Returns:

  • (String) —

    The API version.



24
25
26
 
# File 'lib/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/generated/azure_mgmt_logic/logic_management_client.rb', line 15

def base_url
  @base_url
end

#certificates ⇒ Certificates (readonly)

Returns certificates.

Returns:



71
72
73
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 71

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/generated/azure_mgmt_logic/logic_management_client.rb', line 18

def credentials
  @credentials
end

#generate_client_request_id ⇒ Boolean

is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    When set to true a unique x-ms-client-request-id value



35
36
37
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 35

def generate_client_request_id
  @generate_client_request_id
end

#integration_accounts ⇒ IntegrationAccounts (readonly)

Returns integration_accounts.

Returns:



56
57
58
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 56

def integration_accounts
  @integration_accounts
end

#long_running_operation_retry_timeout ⇒ Integer

Running Operations. Default value is 30.

Returns:

  • (Integer) —

    Gets or sets the retry timeout in seconds for Long



31
32
33
 
# File 'lib/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:



62
63
64
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 62

def maps
  @maps
end

#partners ⇒ Partners (readonly)

Returns partners.

Returns:



65
66
67
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 65

def partners
  @partners
end

#schemas ⇒ Schemas (readonly)

Returns schemas.

Returns:



59
60
61
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 59

def schemas
  @schemas
end

#sessions ⇒ Sessions (readonly)

Returns sessions.

Returns:



74
75
76
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 74

def sessions
  @sessions
end

#subscription_id ⇒ String

Returns The subscription id.

Returns:

  • (String) —

    The subscription id.



21
22
23
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 21

def subscription_id
  @subscription_id
end

#workflow_run_actions ⇒ WorkflowRunActions (readonly)

Returns workflow_run_actions.

Returns:



53
54
55
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 53

def workflow_run_actions
  @workflow_run_actions
end

#workflow_runs ⇒ WorkflowRuns (readonly)

Returns workflow_runs.

Returns:



50
51
52
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 50

def workflow_runs
  @workflow_runs
end

#workflow_trigger_histories ⇒ WorkflowTriggerHistories (readonly)

Returns workflow_trigger_histories.

Returns:



47
48
49
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 47

def workflow_trigger_histories
  @workflow_trigger_histories
end

#workflow_triggers ⇒ WorkflowTriggers (readonly)

Returns workflow_triggers.

Returns:



44
45
46
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 44

def workflow_triggers
  @workflow_triggers
end

#workflow_versions ⇒ WorkflowVersions (readonly)

Returns workflow_versions.

Returns:



41
42
43
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 41

def workflow_versions
  @workflow_versions
end

#workflows ⇒ Workflows (readonly)

Returns workflows.

Returns:



38
39
40
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 38

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.



172
173
174
175
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 172

def list_operations(custom_headers = nil)
  first_page = list_operations_as_lazy(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.



340
341
342
343
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 340

def list_operations_as_lazy(custom_headers = nil)
  first_page = list_operations_as_lazy_as_lazy(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.



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 365

def list_operations_as_lazy_async(custom_headers = nil)


  request_headers = {}
  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::ARM::Logic::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.



353
354
355
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 353

def list_operations_as_lazy_with_http_info(custom_headers = nil)
  list_operations_as_lazy_async(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.



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
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 197

def list_operations_async(custom_headers = nil)
  fail ArgumentError, 'api_version is nil' if api_version.nil?


  request_headers = {}

  # 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::ARM::Logic::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.



255
256
257
258
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 255

def list_operations_next(next_page_link, custom_headers = nil)
  response = list_operations_next_async(next_page_link, 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.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 284

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 = {}

  # 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::ARM::Logic::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.



270
271
272
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 270

def list_operations_next_with_http_info(next_page_link, custom_headers = nil)
  list_operations_next_async(next_page_link, 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.



185
186
187
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 185

def list_operations_with_http_info(custom_headers = nil)
  list_operations_async(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.



125
126
127
128
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 125

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.



150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 150

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

  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.



137
138
139
140
141
 
# File 'lib/generated/azure_mgmt_logic/logic_management_client.rb', line 137

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