Class: Azure::Automation::Mgmt::V2015_10_31::AgentRegistrationInformation

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

Overview

Automation Client

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AgentRegistrationInformation

Creates and initializes a new instance of the AgentRegistrationInformation class.

Parameters:

  • client —

    service class for accessing basic functionality.



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

def client
  @client
end

Instance Method Details

#get(resource_group_name, automation_account_name, custom_headers: nil) ⇒ AgentRegistration

Retrieve the automation agent registration information.

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:

  • (AgentRegistration) —

    operation results.



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

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

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

Retrieve the automation agent registration information.

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.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/agent_registration_information.rb', line 63

def get_async(resource_group_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, '@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}/agentRegistrationInformation'

  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' => ,'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::AgentRegistration.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, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Retrieve the automation agent registration information.

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.



49
50
51
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/agent_registration_information.rb', line 49

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

#regenerate_key(resource_group_name, automation_account_name, parameters, custom_headers: nil) ⇒ AgentRegistration

Regenerate a primary or secondary agent registration key

agent registration key to be regenerated 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.

  • parameters (AgentRegistrationRegenerateKeyParameter) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (AgentRegistration) —

    operation results.



131
132
133
134
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/agent_registration_information.rb', line 131

def regenerate_key(resource_group_name, , parameters, custom_headers:nil)
  response = regenerate_key_async(resource_group_name, , parameters, custom_headers:custom_headers).value!
  response.body unless response.nil?
end

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

Regenerate a primary or secondary agent registration key

agent registration key to be regenerated 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.

  • parameters (AgentRegistrationRegenerateKeyParameter) —

    The name of the

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



164
165
166
167
168
169
170
171
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
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/agent_registration_information.rb', line 164

def regenerate_key_async(resource_group_name, , parameters, 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, 'parameters is nil' if parameters.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?

  # Serialize Request
  request_mapper = Azure::Automation::Mgmt::V2015_10_31::Models::AgentRegistrationRegenerateKeyParameter.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}/agentRegistrationInformation/regenerateKey'

  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' => ,'subscriptionId' => @client.subscription_id},
      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(:post, path_template, options)

  promise = promise.then do |result|
    http_response = result.response
    status_code = http_response.status
    response_content = http_response.body
    unless status_code == 200
      error_model = JSON.load(response_content)
      fail 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::AgentRegistration.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

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

Regenerate a primary or secondary agent registration key

agent registration key to be regenerated 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.

  • parameters (AgentRegistrationRegenerateKeyParameter) —

    The name of the

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



148
149
150
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/agent_registration_information.rb', line 148

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