Class: Azure::DeploymentManager::Mgmt::V2018_09_01_preview::Steps

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb

Overview

REST APIs for orchestrating deployments using the Azure Deployment Manager (ADM). See docs.microsoft.com/en-us/azure/azure-resource-manager/deployment-manager-overview for more information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Steps

Creates and initializes a new instance of the Steps class.

Parameters:

  • client —

    service class for accessing basic functionality.



20
21
22
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 20

def initialize(client)
  @client = client
end

Instance Attribute Details

#client ⇒ AzureDeploymentManager (readonly)

Returns reference to the AzureDeploymentManager.

Returns:



25
26
27
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 25

def client
  @client
end

Instance Method Details

#create_or_update(resource_group_name, step_name, step_info: nil, custom_headers: nil) ⇒ StepResource

Creates or updates a rollout step with the given step properties.

Synchronously creates a new step or updates an existing step.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

  • step_info (StepResource) (defaults to: nil) —

    The step object.

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

    A hash of custom headers that

Returns:

  • (StepResource) —

    operation results.



41
42
43
44
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 41

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

#create_or_update_async(resource_group_name, step_name, step_info: nil, custom_headers: nil) ⇒ Concurrent::Promise

Creates or updates a rollout step with the given step properties.

Synchronously creates a new step or updates an existing step.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

  • step_info (StepResource) (defaults to: nil) —

    The step object.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 78

def create_or_update_async(resource_group_name, step_name, step_info:nil, 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, 'step_name is nil' if step_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?

  # Serialize Request
  request_mapper = Azure::DeploymentManager::Mgmt::V2018_09_01_preview::Models::StepResource.mapper()
  request_content = @client.serialize(request_mapper,  step_info)
  request_content = request_content != nil ? JSON.generate(request_content, quirks_mode: true) : nil

  path_template = 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DeploymentManager/steps/{stepName}'

  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,'stepName' => step_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 == 201
      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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?
    # Deserialize Response
    if status_code == 201
      begin
        parsed_response = response_content.to_s.empty? ? nil : JSON.load(response_content)
        result_mapper = Azure::DeploymentManager::Mgmt::V2018_09_01_preview::Models::StepResource.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, step_name, step_info: nil, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Creates or updates a rollout step with the given step properties.

Synchronously creates a new step or updates an existing step.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

  • step_info (StepResource) (defaults to: nil) —

    The step object.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



60
61
62
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 60

def create_or_update_with_http_info(resource_group_name, step_name, step_info:nil, custom_headers:nil)
  create_or_update_async(resource_group_name, step_name, step_info:step_info, custom_headers:custom_headers).value!
end

#delete(resource_group_name, step_name, custom_headers: nil) ⇒ Object

Deletes the step.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

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

    A hash of custom headers that



253
254
255
256
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 253

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

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

Deletes the step.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

  • 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/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 284

def delete_async(resource_group_name, step_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, 'step_name is nil' if step_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.DeploymentManager/steps/{stepName}'

  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,'stepName' => step_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 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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-request-id'].nil?

    result
  end

  promise.execute
end

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

Deletes the step.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



269
270
271
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 269

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

#get(resource_group_name, step_name, custom_headers: nil) ⇒ StepResource

Gets the step.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

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

    A hash of custom headers that

Returns:

  • (StepResource) —

    operation results.



154
155
156
157
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 154

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

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

Gets the step.

is case insensitive. to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

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

    hash of custom headers that will be added

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 185

def get_async(resource_group_name, step_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, 'step_name is nil' if step_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.DeploymentManager/steps/{stepName}'

  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,'stepName' => step_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?
    result.correlation_request_id = http_response['x-ms-correlation-request-id'] unless http_response['x-ms-correlation-request-id'].nil?
    result.client_request_id = http_response['x-ms-client-request-id'] unless http_response['x-ms-client-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::DeploymentManager::Mgmt::V2018_09_01_preview::Models::StepResource.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, step_name, custom_headers: nil) ⇒ MsRestAzure::AzureOperationResponse

Gets the step.

is case insensitive. will be added to the HTTP request.

Parameters:

  • resource_group_name (String) —

    The name of the resource group. The name

  • step_name (String) —

    The name of the deployment step.

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

    A hash of custom headers that

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    HTTP response information.



170
171
172
 
# File 'lib/2018-09-01-preview/generated/azure_mgmt_deployment_manager/steps.rb', line 170

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