Class: Azure::Automation::Mgmt::V2015_10_31::ActivityOperations

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb

Overview

Automation Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ ActivityOperations

Creates and initializes a new instance of the ActivityOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 17

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AutomationClient (readonly)

Returns reference to the AutomationClient.

Returns:



22
23
24
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 22

def client
  @client
end

Instance Method Details

#get(resource_group_name, automation_account_name, module_name, activity_name, custom_headers: nil) ⇒ Activity

Retrieve the activity in the module identified by module name and activity name.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of an Azure Resource group.

  • automation_account_name (String) —

    The name of the automation account.

  • module_name (String) —

    The name of module.

  • activity_name (String) —

    The name of activity.

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

    A hash of custom headers that

Returns:

  • (Activity) —

    operation results.



37
38
39
40
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 37

def get(resource_group_name, , module_name, activity_name, custom_headers:nil)
  response = get_async(resource_group_name, , module_name, activity_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_async(resource_group_name, automation_account_name, module_name, activity_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve the activity in the module identified by module name and activity name.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of an Azure Resource group.

  • automation_account_name (String) —

    The name of the automation account.

  • module_name (String) —

    The name of module.

  • activity_name (String) —

    The name of activity.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
124
125
126
127
128
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 72

def get_async(resource_group_name, , module_name, activity_name, custom_headers: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, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'module_name is nil' if module_name.nil?
  fail ArgumentError, 'activity_name is nil' if activity_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities/{activityName}'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'automationAccountName' => ,'moduleName' => module_name,'activityName' => activity_name,'subscriptionId' => @client.subscription_id},
      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 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::Automation::Mgmt::V2015_10_31::Models::Activity.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, automation_account_name, module_name, activity_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the activity in the module identified by module name and activity name.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of an Azure Resource group.

  • automation_account_name (String) —

    The name of the automation account.

  • module_name (String) —

    The name of module.

  • activity_name (String) —

    The name of activity.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



55
56
57
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 55

def get_with_http_info(resource_group_name, , module_name, activity_name, custom_headers:nil)
  get_async(resource_group_name, , module_name, activity_name, custom_headers:custom_headers).value!
end

#list_by_module(resource_group_name, automation_account_name, module_name, custom_headers: nil) ⇒ Array<Activity>

Retrieve a list of activities in the module identified by module name.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of an Azure Resource group.

  • automation_account_name (String) —

    The name of the automation account.

  • module_name (String) —

    The name of module.

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

    A hash of custom headers that

Returns:

  • (Array<Activity>) —

    operation results.



141
142
143
144
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 141

def list_by_module(resource_group_name, , module_name, custom_headers:nil)
  first_page = list_by_module_as_lazy(resource_group_name, , module_name, custom_headers:custom_headers)
  first_page.get_all_items
end

#list_by_module_as_lazy(resource_group_name, automation_account_name, module_name, custom_headers: nil) ⇒ ActivityListResult

Retrieve a list of activities in the module identified by module name.

will be added to the HTTP request.

response.

Parameters:

  • resource_group_name (String) —

    Name of an Azure Resource group.

  • automation_account_name (String) —

    The name of the automation account.

  • module_name (String) —

    The name of module.

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

    A hash of custom headers that

Returns:

  • (ActivityListResult) —

    which provide lazy access to pages of the



329
330
331
332
333
334
335
336
337
338
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 329

def list_by_module_as_lazy(resource_group_name, , module_name, custom_headers:nil)
  response = list_by_module_async(resource_group_name, , module_name, custom_headers:custom_headers).value!
  unless response.nil?
    page = response.body
    page.next_method = Proc.new do |next_page_link|
      list_by_module_next_async(next_page_link, custom_headers:custom_headers)
    end
    page
  end
end

#list_by_module_async(resource_group_name, automation_account_name, module_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve a list of activities in the module identified by module name.

to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of an Azure Resource group.

  • automation_account_name (String) —

    The name of the automation account.

  • module_name (String) —

    The name of module.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def list_by_module_async(resource_group_name, , module_name, custom_headers: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, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'module_name is nil' if module_name.nil?
  fail ArgumentError, '@client.subscription_id is nil' if @client.subscription_id.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.Automation/automationAccounts/{automationAccountName}/modules/{moduleName}/activities'

  request_url = @base_url || @client.base_url

  options = {
      middlewares: [[MsRest::RetryPolicyMiddleware, times: 3, retry: 0.02], [:cookie_jar]],
      path_params: {'resourceGroupName' => resource_group_name,'automationAccountName' => ,'moduleName' => module_name,'subscriptionId' => @client.subscription_id},
      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 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::Automation::Mgmt::V2015_10_31::Models::ActivityListResult.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_module_next(next_page_link, custom_headers: nil) ⇒ ActivityListResult

Retrieve a list of activities in the module identified by module name.

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:

  • (ActivityListResult) —

    operation results.



239
240
241
242
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 239

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

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

Retrieve a list of activities in the module identified by module name.

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.



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 268

def list_by_module_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 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::Automation::Mgmt::V2015_10_31::Models::ActivityListResult.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_module_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve a list of activities in the module identified by module name.

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.



254
255
256
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 254

def list_by_module_next_with_http_info(next_page_link, custom_headers:nil)
  list_by_module_next_async(next_page_link, custom_headers:custom_headers).value!
end

#list_by_module_with_http_info(resource_group_name, automation_account_name, module_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve a list of activities in the module identified by module name.

will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    Name of an Azure Resource group.

  • automation_account_name (String) —

    The name of the automation account.

  • module_name (String) —

    The name of module.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



157
158
159
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/activity_operations.rb', line 157

def list_by_module_with_http_info(resource_group_name, , module_name, custom_headers:nil)
  list_by_module_async(resource_group_name, , module_name, custom_headers:custom_headers).value!
end