Class: Azure::Automation::Mgmt::V2015_10_31::RunbookOperations

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

Overview

Automation Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ RunbookOperations

Creates and initializes a new instance of the RunbookOperations class.

Parameters:

  • client —

    service class for accessing basic functionality.



17
18
19
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_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/runbook_operations.rb', line 22

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers: nil) ⇒ Runbook

Create the runbook identified by runbook name.

parameters for runbook. Provide either content link for a published runbook or draft, not both. 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.

  • runbook_name (String) —

    The runbook name.

  • parameters (RunbookCreateOrUpdateParameters) —

    The create or update

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

    A hash of custom headers that

Returns:

  • (Runbook) —

    operation results.



243
244
245
246
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 243

def create_or_update(resource_group_name, , runbook_name, parameters, custom_headers:nil)
  response = create_or_update_async(resource_group_name, , runbook_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#create_or_update_async(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Create the runbook identified by runbook name.

parameters for runbook. Provide either content link for a published runbook or draft, not both. 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.

  • runbook_name (String) —

    The runbook name.

  • parameters (RunbookCreateOrUpdateParameters) —

    The create or update

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
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
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 280

def create_or_update_async(resource_group_name, , runbook_name, parameters, 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, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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 = Azure::Automation::Mgmt::V2015_10_31::Models::RunbookCreateOrUpdateParameters.mapper()
  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.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}'

  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,'automationAccountName' => ,'runbookName' => runbook_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 || status_code == 201 || status_code == 400
      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::Runbook.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
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::Runbook.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, automation_account_name, runbook_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Create the runbook identified by runbook name.

parameters for runbook. Provide either content link for a published runbook or draft, not both. 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.

  • runbook_name (String) —

    The runbook name.

  • parameters (RunbookCreateOrUpdateParameters) —

    The create or update

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



262
263
264
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 262

def create_or_update_with_http_info(resource_group_name, , runbook_name, parameters, custom_headers:nil)
  create_or_update_async(resource_group_name, , runbook_name, parameters, custom_headers:custom_headers).value!
end

#delete(resource_group_name, automation_account_name, runbook_name, custom_headers: nil) ⇒ Object

Delete the runbook by 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.

  • runbook_name (String) —

    The runbook name.

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

    A hash of custom headers that



478
479
480
481
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 478

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

#delete_async(resource_group_name, automation_account_name, runbook_name, custom_headers: nil) ⇒ Concurrent::Promise

Delete the runbook by 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.

  • runbook_name (String) —

    The runbook name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 509

def delete_async(resource_group_name, , runbook_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, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.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}/runbooks/{runbookName}'

  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,'automationAccountName' => ,'runbookName' => runbook_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 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?

    result
  end

  promise.execute
end

#delete_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Delete the runbook by 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.

  • runbook_name (String) —

    The runbook name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



494
495
496
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 494

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

#get(resource_group_name, automation_account_name, runbook_name, custom_headers: nil) ⇒ Runbook

Retrieve the runbook identified by runbook 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.

  • runbook_name (String) —

    The runbook name.

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

    A hash of custom headers that

Returns:

  • (Runbook) —

    operation results.



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

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

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

Retrieve the runbook identified by runbook 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.

  • runbook_name (String) —

    The runbook name.

  • 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/runbook_operations.rb', line 172

def get_async(resource_group_name, , runbook_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, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.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}/runbooks/{runbookName}'

  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,'automationAccountName' => ,'runbookName' => runbook_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 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::Runbook.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_content(resource_group_name, automation_account_name, runbook_name, custom_headers: nil) ⇒ NOT_IMPLEMENTED

Retrieve the content of runbook identified by runbook 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.

  • runbook_name (String) —

    The runbook name.

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

    A hash of custom headers that

Returns:

  • (NOT_IMPLEMENTED) —

    operation results.



35
36
37
38
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 35

def get_content(resource_group_name, , runbook_name, custom_headers:nil)
  response = get_content_async(resource_group_name, , runbook_name, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#get_content_async(resource_group_name, automation_account_name, runbook_name, custom_headers: nil) ⇒ Concurrent::Promise

Retrieve the content of runbook identified by runbook 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.

  • runbook_name (String) —

    The runbook name.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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

def get_content_async(resource_group_name, , runbook_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, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.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}/runbooks/{runbookName}/content'

  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,'automationAccountName' => ,'runbookName' => runbook_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?
    # Deserialize Response
    if status_code == 200
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = {
          client_side_validation: true,
          required: false,
          serialized_name: 'parsed_response',
          type: {
            name: 'Stream'
          }
        }
        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_content_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the content of runbook identified by runbook 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.

  • runbook_name (String) —

    The runbook name.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



51
52
53
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 51

def get_content_with_http_info(resource_group_name, , runbook_name, custom_headers:nil)
  get_content_async(resource_group_name, , runbook_name, custom_headers:custom_headers).value!
end

#get_with_http_info(resource_group_name, automation_account_name, runbook_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the runbook identified by runbook 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.

  • runbook_name (String) —

    The runbook name.

  • 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/runbook_operations.rb', line 157

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

#list_by_automation_account(resource_group_name, automation_account_name, custom_headers: nil) ⇒ Array<Runbook>

Retrieve a list of runbooks.

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.

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

    A hash of custom headers that

Returns:

  • (Array<Runbook>) —

    operation results.



566
567
568
569
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 566

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

#list_by_automation_account_as_lazy(resource_group_name, automation_account_name, custom_headers: nil) ⇒ RunbookListResult

Retrieve a list of runbooks.

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.

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

    A hash of custom headers that

Returns:

  • (RunbookListResult) —

    which provide lazy access to pages of the



750
751
752
753
754
755
756
757
758
759
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 750

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

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

Retrieve a list of runbooks.

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.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 595

def (resource_group_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, 'automation_account_name is nil' if .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}/runbooks'

  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,'automationAccountName' => },
      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::RunbookListResult.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_automation_account_next(next_page_link, custom_headers: nil) ⇒ RunbookListResult

Retrieve a list of runbooks.

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:

  • (RunbookListResult) —

    operation results.



661
662
663
664
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 661

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

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

Retrieve a list of runbooks.

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.



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
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 690

def (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::RunbookListResult.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_automation_account_next_with_http_info(next_page_link, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve a list of runbooks.

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.



676
677
678
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 676

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

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

Retrieve a list of runbooks.

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.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



581
582
583
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 581

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

#update(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers: nil) ⇒ Runbook

Update the runbook identified by runbook name.

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

  • runbook_name (String) —

    The runbook name.

  • parameters (RunbookUpdateParameters) —

    The update parameters for

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

    A hash of custom headers that

Returns:

  • (Runbook) —

    operation results.



368
369
370
371
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 368

def update(resource_group_name, , runbook_name, parameters, custom_headers:nil)
  response = update_async(resource_group_name, , runbook_name, parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

#update_async(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers: nil) ⇒ Concurrent::Promise

Update the runbook identified by runbook name.

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

  • runbook_name (String) —

    The runbook name.

  • parameters (RunbookUpdateParameters) —

    The update parameters for

  • 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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 403

def update_async(resource_group_name, , runbook_name, parameters, 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, 'automation_account_name is nil' if .nil?
  fail ArgumentError, 'runbook_name is nil' if runbook_name.nil?
  fail ArgumentError, 'parameters is nil' if parameters.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 = Azure::Automation::Mgmt::V2015_10_31::Models::RunbookUpdateParameters.mapper()
  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.Automation/automationAccounts/{automationAccountName}/runbooks/{runbookName}'

  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,'automationAccountName' => ,'runbookName' => runbook_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(:patch, 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::Runbook.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

#update_with_http_info(resource_group_name, automation_account_name, runbook_name, parameters, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Update the runbook identified by runbook name.

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

  • runbook_name (String) —

    The runbook name.

  • parameters (RunbookUpdateParameters) —

    The update parameters for

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



386
387
388
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/runbook_operations.rb', line 386

def update_with_http_info(resource_group_name, , runbook_name, parameters, custom_headers:nil)
  update_async(resource_group_name, , runbook_name, parameters, custom_headers:custom_headers).value!
end